EnergyPlus

Input Output Reference

The Encyclopedic Reference to EnergyPlus Input
and Output

Date: September 29, 2014

COPYRIGHT 1996-2014 The Board of Trustees of the University of Illinois and the Regents of the University of
California through the Ernest Orlando Lawrence Berkeley National Laboratory.
All Rights Reserved. No part of this material may be reproduced or transmitted in any form or by any means without
the prior written permission of the University of Illinois or the Ernest Orlando Lawrence Berkeley National Laboratory.
EnergyPlus is a Trademark of the US Department of Energy.

TABLE OF CONTENTS
Input-Output Reference ................................................................................................................... 1
Whats different about EnergyPlus Input and Output? ..................................................... 1
EnergyPlus Input Processing ..................................................................................... 1
General Input Rules................................................................................................... 2
EnergyPlus Output Processing .................................................................................. 2
IDD Conventions ............................................................................................................. 3
IDD IP Units............................................................................................................ 6
Input Output Descriptions (Document).......................................................................... 9
Input Descriptions ...................................................................................................... 9
Output Descriptions ................................................................................................. 10
Group -- Simulation Parameters .................................................................................... 11
Version .................................................................................................................... 11
Timestep ................................................................................................................. 11
ConvergenceLimits .................................................................................................. 13
Building ................................................................................................................... 14
SurfaceConvectionAlgorithm:Inside ......................................................................... 20
SurfaceConvectionAlgorithm:Outside ...................................................................... 21
HeatBalanceAlgorithm ............................................................................................. 22
HeatBalanceSettings:ConductionFiniteDifference ................................................... 23
ZoneAirHeatBalanceAlgorithm ................................................................................ 24
ZoneAirContaminantBalance ................................................................................... 24
Carbon Dioxide Outputs .......................................................................................... 25
Generic Contaminant Outputs ................................................................................. 25
ShadowCalculation .................................................................................................. 25
Output:Diagnostics .................................................................................................. 27
Output:DebuggingData ............................................................................................ 28

9/29/14

TABLE OF CONTENTS
Output:PreprocessorMessage ................................................................................. 28
ZoneCapacitanceMultiplier:ResearchSpecial........................................................... 29
SimulationControl .................................................................................................... 29
ProgramControl ....................................................................................................... 30
Meter:Custom .......................................................................................................... 31
Meter:CustomDecrement......................................................................................... 31
Custom Meter Examples ......................................................................................... 32
Simulation Parameter Outputs ................................................................................. 33
Group Compliance Objects ........................................................................................ 33
Compliance:Building ................................................................................................ 33
Group -- Location Climate Weather File Access ...................................................... 34
Site:Location............................................................................................................ 34
SizingPeriod:DesignDay .......................................................................................... 34
Sizing Period Design Day Outputs........................................................................... 41
Longer Design Periods ............................................................................................ 42
SizingPeriod:WeatherFileDays ................................................................................ 42
SizingPeriod:WeatherFileConditionType ................................................................. 43
RunPeriod ............................................................................................................... 44
RunPeriod:CustomRange ........................................................................................ 47
RunPeriodControl:SpecialDays ............................................................................... 49
RunPeriodControl:DaylightSavingTime.................................................................... 50
WeatherProperty:SkyTemperature .......................................................................... 51
Site:WeatherStation................................................................................................. 52
Site:HeightVariation ................................................................................................. 53
Site:GroundTemperature:BuildingSurface ............................................................... 54
Site:GroundTemperature:Shallow............................................................................ 55

9/29/14

ii

TABLE OF CONTENTS
Site:GroundTemperature:Deep ............................................................................... 55
Site:GroundDomain ................................................................................................. 55
Site:GroundDomain Outputs.................................................................................... 60
Site:GroundTemperature:FCfactorMethod ............................................................... 60
Site:GroundReflectance .......................................................................................... 60
Site:GroundReflectance:SnowModifier .................................................................... 61
Site:WaterMainsTemperature .................................................................................. 61
Site:Precipitation ..................................................................................................... 62
RoofIrrigation ........................................................................................................... 63
Solar and Visible Spectrum Objects ........................................................................ 64
Site:SolarAndVisibleSpectrum ................................................................................. 64
Site:SpectrumData .................................................................................................. 65
Climate Group Outputs ............................................................................................ 65
Weather Data Related Outputs ................................................................................ 65
Outputs for local temperature/wind speed calculations ............................................ 69
Group -- Schedules ....................................................................................................... 70
Day Type ................................................................................................................. 71
ScheduleTypeLimits ................................................................................................ 71
Day Schedules ........................................................................................................ 72
Schedule:Day:Hourly ............................................................................................... 72
Schedule:Day:Interval ............................................................................................. 73
Schedule:Day:List ................................................................................................... 73
Week Schedule(s) ................................................................................................... 74
Schedule:Week:Daily .............................................................................................. 74
Schedule:Week:Compact ........................................................................................ 75
Schedule:Year ......................................................................................................... 75

9/29/14

iii

TABLE OF CONTENTS
Schedule:Compact .................................................................................................. 76
Schedule:Constant .................................................................................................. 78
Schedule:File........................................................................................................... 78
Schedule Outputs .................................................................................................... 80
Group Surface Construction Elements ....................................................................... 81
Specifying the Building Envelope............................................................................. 81
Material and Material Properties .............................................................................. 81
Material ................................................................................................................... 82
Material:NoMass ..................................................................................................... 84
Material:InfraredTransparent ................................................................................... 85
Material:AirGap ....................................................................................................... 86
MaterialProperty:MoisturePenetrationDepth:Settings .............................................. 86
Moisture Penetration Depth (EMPD) Outputs .......................................................... 88
MaterialProperty:PhaseChange ............................................................................... 88
MaterialProperty:VariableThermalConductivity ........................................................ 90
Conduction Finite Difference (CondFD) Outputs ...................................................... 91
MaterialProperty:HeatAndMoistureTransfer:Settings ............................................... 91
MaterialProperty:HeatAndMoistureTransfer:SorptionIsotherm ................................. 92
MaterialProperty:HeatAndMoistureTransfer:Suction ................................................ 93
MaterialProperty:HeatAndMoistureTransfer:Redistribution ...................................... 94
MaterialProperty:HeatAndMoistureTransfer:Diffusion .............................................. 94
MaterialProperty:HeatAndMoistureTransfer:ThermalConductivity............................ 95
Heat and Moisture (HAMT) Outputs ........................................................................ 96
Materials for Glass Windows and Doors .................................................................. 97
WindowMaterial:Glazing .......................................................................................... 97
WindowMaterial:Glazing:RefractionExtinctionMethod ............................................ 101

9/29/14

iv

TABLE OF CONTENTS
Glass Optical Properties Conversion ..................................................................... 102
WindowMaterial:GlazingGroup:Thermochromic ..................................................... 103
WindowMaterial:GlazingGroup:Thermochromic Outputs ....................................... 108
WindowMaterial:Gas ............................................................................................. 108
WindowMaterial:GasMixture .................................................................................. 110
WindowMaterial:Gap ............................................................................................. 111
WindowGap:DeflectionState .................................................................................. 112
WindowGap:SupportPillar...................................................................................... 112
WindowMaterial:SimpleGlazingSystem ................................................................. 113
WindowMaterial:Shade .......................................................................................... 114
WindowMaterial:Blind ............................................................................................ 118
WindowMaterial:ComplexShade ............................................................................ 123
WindowMaterial:Screen ......................................................................................... 129
WindowMaterial:Shade:EquivalentLayer ............................................................... 134
WindowMaterial:Drape:EquivalentLayer ................................................................ 136
WindowMaterial:Blind:EquivalentLayer .................................................................. 138
WindowMaterial:Screen:EquivalentLayer .............................................................. 142
WindowMaterial:Glazing:EquivalentLayer .............................................................. 144
WindowMaterial:Gap:EquivalentLayer ................................................................... 147
Material:RoofVegetation ........................................................................................ 149
Ecoroof / RoofVegetation outputs .......................................................................... 152
MaterialProperty:GlazingSpectralData ................................................................... 153
Construction .......................................................................................................... 155
Site:GroundTemperature:FCfactorMethod ............................................................. 159
Constructions - Modeling Underground Walls and Ground Floors Defined
with C and F Factors for Building Energy Code Compliance .................................. 159
Construction:CfactorUndergroundWall .................................................................. 159
9/29/14

TABLE OF CONTENTS
Construction:FfactorGroundFloor .......................................................................... 160
Construction:InternalSource .................................................................................. 161
Composite Wall Constructions ............................................................................... 164
Construction:ComplexFenestrationState ............................................................... 164
WindowThermalModel:Params .............................................................................. 166
Matix:TwoDimension ............................................................................................. 168
Construction:WindowEquivalentLayer ................................................................... 168
Construction:WindowDataFile ............................................................................... 169
Construction Element Outputs ............................................................................... 170
Group Thermal Zone Description/Geometry ............................................................. 171
Zone ...................................................................................................................... 171
Zone Outputs......................................................................................................... 173
Zone Thermal Output(s) ........................................................................................ 174
ZoneList ................................................................................................................ 177
ZoneList Outputs ................................................................................................... 178
ZoneGroup ............................................................................................................ 178
ZoneGroup Outputs ............................................................................................... 179
Surface(s).............................................................................................................. 179
Interzone Surfaces ................................................................................................ 180
Surface View Factors ............................................................................................ 181
GlobalGeometryRules ........................................................................................... 181
Surfaces ................................................................................................................ 183
Walls ..................................................................................................................... 183
Wall:Exterior .......................................................................................................... 183
Wall:Adiabatic........................................................................................................ 184
Wall:Underground ................................................................................................. 185

9/29/14

vi

TABLE OF CONTENTS
Wall:Interzone ....................................................................................................... 186
Roofs/Ceilings ....................................................................................................... 187
Roof ...................................................................................................................... 187
Ceiling:Adiabatic .................................................................................................... 188
Ceiling:Interzone ................................................................................................... 189
Floors .................................................................................................................... 190
Floor:GroundContact ............................................................................................. 190
Floor:Adiabatic ...................................................................................................... 191
Floor:Interzone ...................................................................................................... 191
Windows/Doors ..................................................................................................... 192
Window ................................................................................................................. 193
Door ...................................................................................................................... 194
GlazedDoor ........................................................................................................... 195
Window:Interzone .................................................................................................. 197
Door:Interzone....................................................................................................... 198
GlazedDoor:Interzone ........................................................................................... 199
Surface Vertices .................................................................................................... 202
Building Surfaces - Detailed .................................................................................. 203
Wall:Detailed ......................................................................................................... 203
RoofCeiling:Detailed .............................................................................................. 206
Floor:Detailed ........................................................................................................ 209
BuildingSurface:Detailed ....................................................................................... 213
FenestrationSurface:Detailed ................................................................................ 217
Window Modeling Options ..................................................................................... 220
InternalMass .......................................................................................................... 222
Surface Output Variables/Reports ......................................................................... 224

9/29/14

vii

TABLE OF CONTENTS
Window Output Variables ...................................................................................... 226
Surface Output Variables (all heat transfer surfaces)............................................. 228
Surface Output Variables (exterior heat transfer surfaces) .................................... 232
Opaque Surface Output Variables ......................................................................... 234
Window Output Variables ...................................................................................... 237
Thermochomic Window Outputs ............................................................................ 247
Other Surface Outputs/Reports ............................................................................. 248
Shading Surfaces .................................................................................................. 248
Detached Shading Surfaces .................................................................................. 249
Shading:Site, Shading:Building ............................................................................. 249
Shading:Site:Detailed, Shading:Building:Detailed .................................................. 250
Attached Shading Surfaces ................................................................................... 252
Shading:Overhang ................................................................................................ 252
Shading:Overhang:Projection ................................................................................ 252
Shading:Fin ........................................................................................................... 253
Shading:Fin:Projection .......................................................................................... 254
Shading:Zone:Detailed .......................................................................................... 255
ShadingProperty:Reflectance ................................................................................ 258
WindowProperty:ShadingControl ........................................................................... 259
WindowProperty:FrameAndDivider ........................................................................ 268
WindowProperty:AirflowControl ............................................................................. 275
WindowProperty:StormWindow ............................................................................. 277
Importing Windows from WINDOW program ......................................................... 279
Zone Thermal Output(s) ........................................................................................ 281
Group Advanced Surface Concepts ......................................................................... 283
SurfaceProperty:HeatTransferAlgorithm ................................................................ 283

9/29/14

viii

TABLE OF CONTENTS
SurfaceProperty:HeatTransferAlgorithm:MultipleSurface ....................................... 283
SurfaceProperty:HeatTransferAlgorithm:SurfaceList ............................................. 284
SurfaceProperty:HeatTransferAlgorithm:Construction ........................................... 285
SurfaceControl:MoveableInsulation ....................................................................... 286
SurfaceProperty:OtherSideCoefficients ................................................................. 287
SurfaceProperty:OtherSideCoefficients Outputs .................................................... 290
SurfaceProperty:OtherSideConditionsModel ......................................................... 290
SurfaceProperty:OtherSideConditionsModel Outputs ............................................ 292
SurfaceConvectionAlgorithm:Inside:AdaptiveModelSelections .............................. 292
SurfaceConvectionAlgorithm:Outside:AdaptiveModelSelections............................ 300
SurfaceConvectionAlgorithm:Inside:UserCurve ..................................................... 301
SurfaceConvectionAlgorithm:Outside:UserCurve .................................................. 302
SurfaceProperty:ConvectionCoefficients ............................................................... 303
SurfaceProperty:ConvectionCoefficients:MultipleSurface ...................................... 306
Convection Coefficient Application Hierarchy ........................................................ 309
Convection Coefficients Outputs............................................................................ 309
SurfaceProperties:VaporCoefficients ..................................................................... 313
SurfaceProperty:ExteriorNaturalVentedCavity ....................................................... 314
SurfaceProperty:ExteriorNaturalVentedCavity Outputs .......................................... 316
SurfaceProperty:SolarIncidentInside ..................................................................... 317
ComplexFenestrationProperty:SolarAbsorbedLayers ............................................ 318
GeometryTransform .............................................................................................. 319
Zone Property View Factors .................................................................................. 320
ZoneProperty:UserViewFactors:bySurfaceName .................................................. 321
Group Detailed Ground Heat Transfer ...................................................................... 322
Detailed Ground Heat Transfer .............................................................................. 322

9/29/14

ix

TABLE OF CONTENTS
GroundHeatTransfer:Control ................................................................................. 322
Group Room Air Models ........................................................................................... 323
Room Air Models ................................................................................................... 323
RoomAirModelType ............................................................................................... 324
RoomAir:TemperaturePattern:UserDefined ........................................................... 325
RoomAir:TemperaturePattern:ConstantGradient ................................................... 326
RoomAir:TemperaturePattern:TwoGradient .......................................................... 327
RoomAir:TemperaturePattern:NondimensionalHeight ........................................... 329
RoomAir:TemperaturePattern:SurfaceMapping ..................................................... 331
RoomAir:Node ....................................................................................................... 332
RoomAirSettings:OneNodeDisplacementVentilation.............................................. 333
RoomAirSettings:ThreeNodeDisplacementVentilation ........................................... 334
RoomAirSettings:CrossVentilation ......................................................................... 336
CrossVentilation Model Outputs ............................................................................ 337
RoomAirSettings:UnderFloorAirDistributionInterior ................................................ 338
RoomAirSettings:UnderFloorAirDistributionExterior ............................................... 341
Room Air Model Outputs ....................................................................................... 344
RoomAir:TemperaturePattern:TwoGradient Outputs ............................................. 344
Mundt Model / OneNodeDisplacementVentilation Outputs .................................... 344
ThreeNodeDisplacementVentilation Outputs ......................................................... 344
CrossVentilation Model Outputs ............................................................................ 345
UnderFloorAirDistributionInterior/Exterior Model Outputs ...................................... 346
Group Internal Gains (People, Lights, Other internal zone equipment) ..................... 347
People ................................................................................................................... 347
People Outputs...................................................................................................... 354
Simplified ASHRAE 55-2004 Graph Related Outputs ............................................ 358

9/29/14

TABLE OF CONTENTS
Simplified ASHRAE 55 Warnings .......................................................................... 360
ComfortViewFactorAngles ..................................................................................... 361
Lights .................................................................................................................... 362
Lights Report Outputs............................................................................................ 367
Meters for Lights Outputs ...................................................................................... 369
ElectricEquipment ................................................................................................. 369
GasEquipment....................................................................................................... 371
HotWaterEquipment .............................................................................................. 374
SteamEquipment ................................................................................................... 376
OtherEquipment .................................................................................................... 378
Electric, Gas, Other, HotWater, Steam Equipment Outputs ................................... 380
ZoneContaminantSourceAndSink:CarbonDioxide ................................................. 383
ZoneContaminantSourceAndSink:CarbonDioxide Outputs .................................... 383
ZoneContaminantSourceAndSink:GenericContaminant:Constant ......................... 384
ZoneContaminantSourceAndSink:GenericContaminant:Constant Outputs ............ 385
SurfaceContaminantSourceAndSink:GenericContaminant:PressureDriven ........... 385
SurfaceContaminantSourceAndSink:GenericContaminant:PressureDriven
Outputs.................................................................................................................. 386
ZoneContaminantSourceAndSink:GenericContaminant:CutoffModel .................... 386
ZoneContaminantSourceAndSink:GenericContaminant:CutoffModel
Outputs.................................................................................................................. 387
ZoneContaminantSourceAndSink:GenericContaminant:DecaySource .................. 387
ZoneContaminantSourceAndSink:GenericContaminant:DecaySource
Outputs.................................................................................................................. 388
SurfaceContaminantSourceAndSink:GenericContaminant:BoudaryLayerD
iffusion ................................................................................................................... 388
SurfaceContaminantSourceAndSink:GenericContaminant:BoundaryLayer
Diffusion Outputs ................................................................................................... 389

9/29/14

xi

TABLE OF CONTENTS
SurfaceContaminantSourceAndSink:GenericContaminant:DepositionVelo
citySink .................................................................................................................. 390
SurfaceContaminantSourceAndSink:GenericContaminant:DepositionVelo
citySink Outputs .................................................................................................... 390
ZoneContaminantSourceAndSink:GenericContaminant:DepositionRateSi
nk .......................................................................................................................... 391
ZoneContaminantSourceAndSink:GenericContaminant:DepositionRateSi
nk Outputs ............................................................................................................. 391
ZoneBaseboard:OutdoorTemperatureControlled ................................................... 392
ZoneBaseboard:OutdoorTemperatureControlled Output ....................................... 393
Meters for Equipment Outputs ............................................................................... 395
Group Daylighting..................................................................................................... 395
Daylighting:Controls .............................................................................................. 396
Guidelines for Daylighting Modeling (Detailed Method) ......................................... 401
DElight Daylighting Method ................................................................................... 406
Daylighting:DELight:Controls ................................................................................. 407
Daylighting:DELight:ReferencePoint ...................................................................... 409
Daylighting:DELight:ComplexFenestration ............................................................ 411
DElight Output ....................................................................................................... 412
Daylighting Output ................................................................................................. 413
Output:IlluminanceMap .......................................................................................... 415
OutputControl:IlluminanceMap:Style ..................................................................... 416
Daylighting Devices ............................................................................................... 416
DaylightingDevice:Tubular ..................................................................................... 416
Tubular Daylighting Device Output ........................................................................ 419
DaylightingDevice:Shelf ......................................................................................... 421
Shelf Daylighting Device Output ............................................................................ 424
DaylightingDevice:LightWell .................................................................................. 425

9/29/14

xii

TABLE OF CONTENTS
Daylighting Modeling Options ................................................................................ 427
Group Exterior Energy Use Equipment..................................................................... 428
Exterior:Lights ....................................................................................................... 428
Exterior Lights Outputs .......................................................................................... 429
Exterior:FuelEquipment ......................................................................................... 429
Exterior:WaterEquipment....................................................................................... 430
Exterior Fuel Equipment, Exterior Water Equipment Outputs ................................ 430
Group Airflow ........................................................................................................... 431
ZoneInfiltration:DesignFlowRate ............................................................................ 431
ZoneInfiltration:EffectiveLeakageArea ................................................................... 434
ZoneInfiltration:FlowCoefficient.............................................................................. 436
ZoneInfiltration Outputs ......................................................................................... 438
ZoneVentilation:DesignFlowRate........................................................................... 439
ZoneVentilation:WindandStackOpenArea.............................................................. 445
ZoneVentilation Outputs ........................................................................................ 450
ZoneAirBalance:OutdoorAir ................................................................................... 451
ZoneAirBalance:OutdoorAir Outputs ..................................................................... 453
ZoneMixing ............................................................................................................ 454
Zone Mixing Outputs ............................................................................................. 457
ZoneCrossMixing .................................................................................................. 458
Zone Cross Mixing Outputs ................................................................................... 462
ZoneRefrigerationDoorMixing ................................................................................ 463
Refrigeration Door Mixing Outputs ......................................................................... 464
ZoneEarthtube (Earth Tube) .................................................................................. 465
ZoneEarthTube Outputs ........................................................................................ 469
ZoneCoolTower:Shower ........................................................................................ 470

9/29/14

xiii

TABLE OF CONTENTS
ZoneCoolTower:Shower Outputs........................................................................... 472
ZoneThermalChimney (Thermal Chimney) ............................................................ 474
ZoneThermalChimney Outputs .............................................................................. 476
ZoneAirMassFlowConservation ............................................................................. 477
ZoneAirMassFlowConservation Outputs................................................................ 478
Group Design Objects .............................................................................................. 480
Input for Design Calculations and Component Autosizing...................................... 480
DesignSpecification:OutdoorAir ............................................................................. 501
DesignSpecification:ZoneAirDistribution ................................................................ 502
Sizing:Parameters ................................................................................................. 504
Sizing Parameters Outputs .................................................................................... 504
OutputControl:Sizing:Style..................................................................................... 505
Sizing:Zone ........................................................................................................... 505
Zone Sizing Outputs .............................................................................................. 509
Sizing:System........................................................................................................ 510
System Sizing Outputs .......................................................................................... 515
Sizing:Plant ........................................................................................................... 516
Plant Sizing Outputs .............................................................................................. 516
HVAC: Primary and Secondary Systems..................................................................... 516
Group Node-Branch Management............................................................................ 518
NodeList ................................................................................................................ 518
Node List Outputs .................................................................................................. 519
BranchList ............................................................................................................. 522
Branch List Output ................................................................................................. 523
Branch ................................................................................................................... 523
Branch Output ....................................................................................................... 525

9/29/14

xiv

TABLE OF CONTENTS
ConnectorList ........................................................................................................ 526
Connector List Outputs .......................................................................................... 526
Pipe:Adiabatic ....................................................................................................... 526
Pipe Outputs.......................................................................................................... 527
Pipe:Adiabatic:Steam ............................................................................................ 527
Steam Pipe Outputs .............................................................................................. 527
Pipe:Indoor ............................................................................................................ 527
Pipe:Indoor Outputs............................................................................................... 528
Pipe:Outdoor ......................................................................................................... 529
Pipe:Outdoor Outputs ............................................................................................ 530
Pipe:Underground ................................................................................................. 530
Pipe:Underground Outputs .................................................................................... 532
PipingSystem:Underground Class Objects ............................................................ 532
PipingSystem:Underground:Domain ...................................................................... 533
PipingSystem:Underground:PipeCircuit ................................................................. 535
PipingSystem:Underground:PipeSegment ............................................................. 536
PipingSystem:Underground Outputs ..................................................................... 538
Duct ....................................................................................................................... 539
Duct Outputs ......................................................................................................... 539
Group Plant-Condenser Loops ................................................................................. 539
PlantLoop .............................................................................................................. 539
Plant Loop Outputs ................................................................................................ 543
CondenserLoop ..................................................................................................... 548
Condenser Loop Outputs ...................................................................................... 551
Group Plant-Condenser Control ............................................................................... 553
Operation Schemes (Plant and Condenser) .......................................................... 553

9/29/14

xv

TABLE OF CONTENTS
PlantEquipmentOperationSchemes ....................................................................... 554
CondenserEquipmentOperationSchemes .............................................................. 555
PlantEquipmentOperation:Uncontrolled ................................................................. 556
PlantEquipmentOperation:CoolingLoad ................................................................. 556
PlantEquipmentOperation:HeatingLoad................................................................. 556
PlantEquipmentOperation:OutdoorDryBulb ........................................................... 557
PlantEquipmentOperation:OutdoorWetBulb .......................................................... 557
PlantEquipmentOperation:OutdoorRelativeHumidity ............................................. 557
PlantEquipmentOperation:OutdoorDewpoint ......................................................... 557
PlantEquipmentOperation:OutdoorDryBulbDifference ........................................... 558
PlantEquipmentOperation:OutdoorWetBulbDifference .......................................... 558
PlantEquipmentOperation:OutdoorDewpointDifference ......................................... 558
PlantEquipmentOperation:ComponentSetpoint ..................................................... 558
PlantEquipmentList................................................................................................ 560
CondenserEquipmentList ...................................................................................... 560
Group Plant Equipment ............................................................................................ 560
Equipment Types .................................................................................................. 560
Generic Chiller Outputs ......................................................................................... 561
Chiller:Absorption .................................................................................................. 565
Absorption Chiller Outputs ..................................................................................... 568
Chiller:Absorption:Indirect...................................................................................... 569
Indirect Absorption Chiller Outputs ........................................................................ 572
Chiller:ConstantCOP ............................................................................................. 573
Constant COP Chiller Outputs ............................................................................... 575
Chiller:Electric ....................................................................................................... 576
Electric Chiller Outputs .......................................................................................... 584

9/29/14

xvi

TABLE OF CONTENTS
Chiller:Electric:EIR................................................................................................. 584
Electric EIR Chiller Outputs ................................................................................... 591
Chiller:Electric:ReformulatedEIR ........................................................................... 593
Electric Reformulated EIR Chiller Outputs ............................................................. 598
Chiller:EngineDriven .............................................................................................. 598
Engine Driven Chiller Outputs ............................................................................... 605
Chiller:CombustionTurbine .................................................................................... 607
Combustion Turbine Chiller Outputs ...................................................................... 615
ChillerHeater:Absorption:DirectFired ..................................................................... 616
Direct Fired Absorption Chiller Outputs.................................................................. 621
ChillerHeater:Absorption:DoubleEffect .................................................................. 624
Exhaust Fired Absorption Chiller Outputs .............................................................. 628
Boiler:HotWater ..................................................................................................... 632
Boiler:HotWater Outputs ........................................................................................ 635
Boiler:Steam .......................................................................................................... 637
Steam Boiler Outputs ............................................................................................ 638
Water to Water Heat Pumps .................................................................................. 639
HeatPump:WaterToWater:EquationFit:Cooling ...................................................... 640
Water to Water Heat Pump Equation Fit Outputs .................................................. 642
HeatPump:WaterToWater:EquationFit:Heating ..................................................... 643
HeatPump:WaterToWater:ParameterEstimation:Cooling....................................... 644
HeatPump:WaterToWater:ParameterEstimation:Heating ...................................... 646
Water to Water Heat Pump Parameter Estimation Outputs ................................... 649
DistrictCooling ....................................................................................................... 651
DistrictCooling Outputs .......................................................................................... 651
DistrictHeating ....................................................................................................... 652

9/29/14

xvii

TABLE OF CONTENTS
DistrictHeating Outputs .......................................................................................... 652
PlantComponent:TemperatureSource ................................................................... 653
PlantComponent:TemperatureSource Outputs ...................................................... 654
CentralHeatPumpSystem ...................................................................................... 654
Central Heat Pump System Outputs ...................................................................... 659
ChillerHeaterPerformance:EIectric:EIR.................................................................. 660
ChillerHeaterPerformance:Electric:EIR Outputs .................................................... 665
Thermal Storage Objects ....................................................................................... 668
ThermalStorage:Ice:Simple ................................................................................... 669
Simple Ice Storage Outputs ................................................................................... 669
ThermalStorage:Ice:Detailed ................................................................................. 670
Detailed Ice Storage Outputs................................................................................. 672
ThermalStorage:ChilledWater:Mixed ..................................................................... 674
Chilled Water Mixed Thermal Storage Outputs ...................................................... 677
ThermalStorage:ChilledWater:Stratified................................................................. 678
Chilled Water Stratified Thermal Storage Outputs ................................................. 683
Group Water Heaters ............................................................................................... 685
Standard Ratings ................................................................................................... 686
WaterHeater:Mixed................................................................................................ 686
Mixed Water Heater Outputs ................................................................................. 693
WaterHeater:Stratified ........................................................................................... 696
Stratified Water Heater Outputs ............................................................................. 703
WaterHeater:Sizing ............................................................................................... 705
WaterHeater:HeatPump ........................................................................................ 707
Heat Pump Water Heater Outputs ........................................................................ 717
Group Condenser Equipment ................................................................................... 717

9/29/14

xviii

TABLE OF CONTENTS
Equipment Types .................................................................................................. 717
CoolingTower:SingleSpeed ................................................................................... 717
Single Speed Cooling Tower Outputs .................................................................... 725
CoolingTower:TwoSpeed ...................................................................................... 727
Two Speed Cooling Tower Outputs ....................................................................... 735
CoolingTower:VariableSpeed:Merkel .................................................................... 737
CoolingTower:VariableSpeed:Merkel Outputs ....................................................... 744
CoolingTower:VariableSpeed ................................................................................ 746
Variable Speed Cooling Tower Outputs ................................................................. 752
CoolingTowerPerformance:CoolTools ................................................................... 754
CoolingTowerPerformance:CoolTools Outputs ...................................................... 757
CoolingTowerPerformance:YorkCalc ..................................................................... 757
CoolingTowerPerformance:YorkCalc Outputs ....................................................... 760
EvaporativeFluidCooler:SingleSpeed .................................................................... 760
Single Speed Evaporative Fluid Cooler Outputs .................................................... 765
EvaporativeFluidCooler:TwoSpeed ....................................................................... 767
Two Speed Evaporative Fluid Cooler Outputs ....................................................... 773
FluidCooler:SingleSpeed ....................................................................................... 774
Single Speed Fluid Cooler Outputs........................................................................ 776
FluidCooler:TwoSpeed .......................................................................................... 777
Two Speed Fluid Cooler Outputs ........................................................................... 780
GroundHeatExchanger:Vertical ............................................................................. 780
Vertical Ground Heat Exchanger Outputs .............................................................. 784
GroundHeatExchanger:Pond ................................................................................. 784
Pond Heat Exchanger Outputs .............................................................................. 786
GroundHeatExchanger:Surface ............................................................................. 787

9/29/14

xix

TABLE OF CONTENTS
Surface Ground Heat Exchanger Outputs ............................................................. 788
GroundHeatExchanger:HorizontalTrench .............................................................. 789
Horizontal Trench Ground Heat Exchanger Outputs .............................................. 791
HeatExchanger:FluidToFluid ................................................................................. 792
Fluid to Fluid Heat Exchanger Outputs .................................................................. 798
Group Plant-Condenser Flow Control ....................................................................... 799
Connector:Splitter, Connector:Mixer ...................................................................... 799
Connector:Splitter .................................................................................................. 799
Connector:Mixer .................................................................................................... 799
TemperingValve .................................................................................................... 800
Tempering Valve Outputs ...................................................................................... 802
Group Air Distribution ............................................................................................... 802
AirLoopHVAC ........................................................................................................ 802
AirLoopHVAC Outputs........................................................................................... 803
Outdoor Air Ventilation Outputs ............................................................................. 804
Systems Level Reporting ....................................................................................... 809
System Loads Outputs .......................................................................................... 809
System Energy Use Outputs ................................................................................. 810
System Component Loads Outputs ....................................................................... 810
System Component Energy Use Outputs .............................................................. 812
Overall Air Loop Syntax ......................................................................................... 813
AirLoopHVAC:ControllerList .................................................................................. 813
AvailabilityManagerAssignmentList ....................................................................... 814
AirLoopHVAC:OutdoorAirSystem .......................................................................... 815
Outdoor Air System Outputs .................................................................................. 816
AirLoopHVAC:OutdoorAirSystem:EquipmentList ................................................... 816

9/29/14

xx

TABLE OF CONTENTS
OutdoorAir:Node ................................................................................................... 817
Outdoor Air Node outputs: ..................................................................................... 817
OutdoorAir:NodeList .............................................................................................. 818
OutdoorAir:Mixer ................................................................................................... 818
Group Airflow Network ............................................................................................. 819
Overview ............................................................................................................... 819
Summary of Objects .............................................................................................. 819
Airflow Network Example Files (included in the installation)................................... 823
What the Airflow Network Model Can and Cannot Do ............................................ 824
AirflowNetwork:SimulationControl.......................................................................... 825
AirflowNetwork:Multizone:Zone ............................................................................. 829
AirflowNetwork:Multizone:Surface ......................................................................... 833
AirflowNetwork:MultiZone:ReferenceCrackConditions ........................................... 839
AirflowNetwork:MultiZone:Surface:Crack ............................................................... 839
AirflowNetwork:MultiZone:Surface:EffectiveLeakageArea ..................................... 840
AirflowNetwork:MultiZone:Component:DetailedOpening ....................................... 841
AirflowNetwork:MultiZone:Component:HorizontalOpening..................................... 845
AirflowNetwork:MultiZone:Component:SimpleOpening .......................................... 846
AirflowNetwork:MultiZone:Component:ZoneExhaustFan ....................................... 847
AirflowNetwork:MultiZone:ExternalNode ................................................................ 848
AirflowNetwork:MultiZone:WindPressureCoefficientArray ...................................... 849
AirflowNetwork:MultiZone:WindPressureCoefficientValues ................................... 850
AirflowNetwork:Distribution:Node .......................................................................... 851
AirflowNetwork:Distribution:Component:Leak ........................................................ 853
AirflowNetwork:Distribution:Component:LeakageRatio .......................................... 854
AirflowNetwork:Distribution:Component:Duct ........................................................ 856

9/29/14

xxi

TABLE OF CONTENTS
AirflowNetwork:Distribution:Component:Fan.......................................................... 858
AirflowNetwork:Distribution:Component:Coil.......................................................... 858
AirflowNetwork:Distribution:Component:HeatExchanger ....................................... 859
AirflowNetwork:Distribution:Component:TerminalUnit ............................................ 861
AirflowNetwork:Distribution:Component:ConstantPressureDrop ............................ 862
AirflowNetwork:Distribution:Linkage ...................................................................... 863
Airflow Network Outputs ........................................................................................ 863
Group Zone Equipment ............................................................................................ 877
ZoneHVAC:AirDistributionUnit ............................................................................... 881
ZoneHVAC:EquipmentConnections....................................................................... 882
ZoneHVAC:EquipmentList ..................................................................................... 883
Group Air Distribution Equipment ............................................................................. 885
AirTerminal:SingleDuct:Uncontrolled ..................................................................... 885
Single Duct Uncontrolled AirTerminal Outputs ....................................................... 886
AirTerminal:SingleDuct:ConstantVolume:Reheat .................................................. 886
Single Duct Constant Volume Reheat AirTerminal Outputs ................................... 888
AirTerminal:SingleDuct:VAV:Reheat ..................................................................... 888
Single Duct VAV Reheat AirTerminal Outputs ....................................................... 893
AirTerminal:SingleDuct:VAV:Reheat:VariableSpeedFan ....................................... 894
Single Duct VAV Reheat Variable Speed Fan AirTerminal Outputs ....................... 896
AirTerminal:SingleDuct:VAV:HeatAndCool:Reheat................................................ 897
Single Duct VAV Heat and Cool Reheat AirTerminal Outputs ................................ 899
AirTerminal:SingleDuct:VAV:NoReheat ................................................................. 899
Single Duct VAV NoReheat AirTerminal Outputs ................................................... 901
AirTerminal:SingleDuct:VAV:HeatAndCool:NoReheat ........................................... 901
Single Duct VAV Heat and Cool NoReheat AirTerminal Outputs ........................... 903

9/29/14

xxii

TABLE OF CONTENTS
AirTerminal:SingleDuct:SeriesPIU:Reheat ............................................................. 903
Single Duct Series PIU Reheat AirTerminal Outputs ............................................. 905
AirTerminal:SingleDuct:ParallelPIU:Reheat ........................................................... 906
Single Duct Parallel PIU Reheat AirTerminal Outputs............................................ 909
AirTerminal:SingleDuct:ConstantVolume:FourPipeInduction ................................. 910
Single Duct Constant Volume Four Pipe Induction AirTerminal Outputs ................ 913
AirTerminal:SingleDuct:ConstantVolume:CooledBeam ......................................... 913
Singled Duct Constant Volume Cooled Beam AirTerminal Outputs ....................... 916
AirTerminal:SingleDuct:InletSideMixer................................................................... 916
AirTerminal:SingleDuct:SupplySideMixer .............................................................. 917
AirTerminal:DualDuct:ConstantVolume ................................................................. 919
Dual Duct Constant Volume AirTerminal Outputs .................................................. 919
AirTerminal:DualDuct:VAV .................................................................................... 920
Dual Duct VAV AirTerminal Outputs ...................................................................... 921
AirTerminal:DualDuct:VAV:OutdoorAir .................................................................. 922
Dual Duct VAV Outdoor Air AirTerminal Outputs ................................................... 923
Group Zone Forced Air Units .................................................................................... 924
ZoneHVAC:IdealLoadsAirSystem .......................................................................... 924
ZoneHVAC:IdealLoadsAirSystem Outputs ............................................................ 928
ZoneHVAC:FourPipeFanCoil ................................................................................. 932
Fan Coil Outputs ................................................................................................... 938
ZoneHVAC:UnitVentilator ...................................................................................... 940
Unit Ventilator Outputs .......................................................................................... 947
ZoneHVAC:UnitHeater .......................................................................................... 949
Unit Heater Outputs ............................................................................................... 952
ZoneHVAC:EvaporativeCoolerUnit ........................................................................ 953

9/29/14

xxiii

TABLE OF CONTENTS
ZoneHVAC:EvaporativeCoolerUnit Outputs .......................................................... 956
ZoneHVAC:OutdoorAirUnit .................................................................................... 958
Outdoor Air Unit Outputs ....................................................................................... 962
ZoneHVAC:OutdoorAirUnit:EquipmentList ............................................................ 964
ZoneHVAC:WindowAirConditioner ........................................................................ 964
Window Air Conditioner Outputs ............................................................................ 968
ZoneHVAC:PackagedTerminalAirConditioner ....................................................... 969
Packaged Terminal Air Conditioner (PTAC) Outputs ............................................. 975
ZoneHVAC:PackagedTerminalHeatPump ............................................................. 978
Packaged Terminal Heat Pump (PTHP) Outputs ................................................... 985
ZoneHVAC:RefrigerationChillerSet ........................................................................ 988
ZoneHVAC:WaterToAirHeatPump......................................................................... 989
Water to Air Heat Pump (ZoneHVAC) Outputs ...................................................... 997
ZoneHVAC:Dehumidifier:DX ............................................................................... 1000
DX Dehumidifier (ZoneHVAC) Outputs ................................................................ 1003
ZoneHVAC:EnergyRecoveryVentilator ................................................................ 1005
Energy Recovery Ventilator (ERV) (ZoneHVAC) Outputs .................................... 1009
ZoneHVAC:TerminalUnit:VariableRefrigerantFlow .............................................. 1012
Variable Refrigerant Flow (VRF) Terminal Unit (ZoneHVAC) Outputs ................. 1015
DesignSpecification:ZoneHVAC:Sizing................................................................ 1018
Group Unitary Equipment ....................................................................................... 1025
Furnace and Unitary Systems ............................................................................. 1025
AirLoopHVAC:UnitarySystem .............................................................................. 1026
Unitary System (AirLoopHVAC) Outputs ............................................................. 1035
UnitarySystemPerformance:HeatPump:Multispeed ............................................. 1038
AirLoopHVAC:Unitary:Furnace:HeatCool ............................................................ 1039

9/29/14

xxiv

TABLE OF CONTENTS
Unitary System/Furnace Heat and Cool (AirLoopHVAC) Outputs ........................ 1044
AirLoopHVAC:UnitaryHeatCool ........................................................................... 1045
Unitary System Heat and Cool (AirLoopHVAC) Outputs ...................................... 1049
AirLoopHVAC:UnitaryHeatPump:AirToAir ........................................................... 1050
Unitary Air to Air Heat Pump (AirLoopHVAC) Outputs ......................................... 1055
AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed ......................................... 1056
Unitary Air to Air MultiSpeed Heat Pump (AirLoopHVAC) Outputs ...................... 1065
AirLoopHVAC:Unitary:Furnace:HeatOnly ............................................................ 1068
Unitary/Furnace Heat Only (AirLoopHVAC) Outputs............................................ 1072
AirLoopHVAC:UnitaryHeatOnly ........................................................................... 1072
Unitary Heat Only (AirLoopHVAC) Outputs ......................................................... 1076
AirLoopHVAC:UnitaryHeatPump:WaterToAir ...................................................... 1076
Unitary Water to Air Heat Pump (AirLoopHVAC) Outputs .................................... 1084
AirLoopHVAC:UnitaryHeatCool:VAVChangeoverBypass .................................... 1085
Unitary VAV Changeover Bypass Heat and Cool (AirLoopHVAC) Outputs .......... 1093
Group Variable Refrigerant Flow Equipment .......................................................... 1096
AirConditioner:VariableRefrigerantFlow ............................................................... 1096
Variable Refrigerant Flow (VRF) Air Conditioner Outputs .................................... 1114
ZoneTerminalUnitList .......................................................................................... 1119
Group Radiative / Convective Units ........................................................................ 1120
ZoneHVAC:Baseboard:RadiantConvective:Water ............................................... 1121
Baseboard (Water) Radiant Convective (ZoneHVAC) Outputs ............................ 1123
ZoneHVAC:Baseboard:RadiantConvective:Steam .............................................. 1125
Baseboard (Steam) Radiant Convective (ZoneHVAC) Outputs ........................... 1127
ZoneHVAC:Baseboard:RadiantConvective:Electric ............................................. 1128
Baseboard (Electric) Radiant Convective (ZoneHVAC) Outputs .......................... 1131

9/29/14

xxv

TABLE OF CONTENTS
ZoneHVAC:Baseboard:Convective:Water ........................................................... 1132
Baseboard (Water) Convective (ZoneHVAC) Outputs ......................................... 1134
ZoneHVAC:Baseboard:Convective:Electric ......................................................... 1134
Baseboard (Electric) Convective (ZoneHVAC) Outputs ....................................... 1136
ZoneHVAC:LowTemperatureRadiant:VariableFlow ............................................. 1136
Low Temperature Radiant Variable Flow (ZoneHVAC) Outputs .......................... 1142
ZoneHVAC:LowTemperatureRadiant:ConstantFlow ............................................ 1143
Low Temperature Radiant Constant Flow (ZoneHVAC) Outputs ......................... 1148
ZoneHVAC:LowTemperatureRadiant:Electric ...................................................... 1150
Low Temperature Radiant Electric (ZoneHVAC) Outputs .................................... 1153
ZoneHVAC:LowTemperatureRadiant:SurfaceGroup ........................................... 1153
ZoneHVAC:HighTemperatureRadiant ................................................................. 1154
High Temperature Radiant (ZoneHVAC) Outputs ................................................ 1157
ZoneHVAC:VentilatedSlab .................................................................................. 1158
Ventilated Slab (ZoneHVAC) Outputs .................................................................. 1165
ZoneHVAC:VentilatedSlab:SlabGroup................................................................. 1168
Group Refrigeration ................................................................................................ 1169
Refrigeration:CompressorRack............................................................................ 1170
Refrigeration Compressor Rack Outputs ............................................................. 1176
Refrigeration:Case............................................................................................... 1180
Refrigeration:Case Outputs ................................................................................. 1187
Refrigeration:CaseAndWalkInList ........................................................................ 1191
Refrigeration:WalkIn ............................................................................................ 1191
Refrigeration Case and WalkIn Outputs............................................................... 1196
Refrigeration:System ........................................................................................... 1198
Refrigeration System Outputs .............................................................................. 1202

9/29/14

xxvi

TABLE OF CONTENTS
Refrigeration:TranscriticalSystem ........................................................................ 1211
Refrigeration Transcritical System Outputs .......................................................... 1214
Refrigeration:Compressor.................................................................................... 1217
Refrigeration Compressor Outputs ...................................................................... 1219
Refrigeration:CompressorList .............................................................................. 1220
Refrigeration:Subcooler ....................................................................................... 1220
Refrigeration Subcooler Outputs.......................................................................... 1221
Refrigeration:Condenser:AirCooled ..................................................................... 1222
Refrigeration Condenser (AirCooled) Outputs ..................................................... 1223
Refrigeration:Condenser:EvaporativeCooled ....................................................... 1226
Refrigeration Condenser (EvaporativeCooled) Outputs ....................................... 1230
Refrigeration:Condenser:WaterCooled ................................................................ 1233
Refrigeration Condenser (WaterCooled) Outputs ................................................ 1235
Refrigeration:Condenser:Cascade....................................................................... 1237
Refrigeration Condenser (Cascade) Outputs ....................................................... 1238
Refrigeration:GasCooler:AirCooled ..................................................................... 1239
Refrigeration GasCooler (AirCooled) Outputs ...................................................... 1241
Refrigeration:TransferLoadList ............................................................................ 1242
Refrigeration:SecondarySystem .......................................................................... 1242
Refrigeration Secondary System Outputs ............................................................ 1247
Additional Refrigeration Outputs Available for Each Zone.................................... 1249
Additional Refrigeration Outputs for Each Zone ................................................... 1249
Refrigeration:AirChiller ........................................................................................ 1252
Refrigeration Air Chiller Outputs .......................................................................... 1257
Group Zone Controls Thermostats and Humidistats ............................................ 1260
ZoneControl:Thermostat ...................................................................................... 1261

9/29/14

xxvii

TABLE OF CONTENTS
ZoneControl Thermostat Outputs ........................................................................ 1263
Zone Thermostat Setpoints ................................................................................. 1266
ThermostatSetpoint:SingleHeating ...................................................................... 1266
ThermostatSetpoint:SingleCooling ...................................................................... 1266
ThermostatSetpoint:SingleHeatingOrCooling ...................................................... 1266
ThermostatSetpoint:DualSetpoint ........................................................................ 1267
ZoneControl:Thermostat:OperativeTemperature ................................................. 1267
Zone Control Themostatic Operative Temperature Outputs................................. 1269
ZoneControl:Thermostat:TemperatureAndHumidity............................................. 1269
ZoneControl:Thermostat:StagedDualSetpoint ..................................................... 1271
ZoneControl:Humidistat ....................................................................................... 1274
ZoneControl Humidistat Outputs.......................................................................... 1276
ZoneControl:Thermostat:ThermalComfort ........................................................... 1277
ZoneControl Thermostat ThermalComfort Outputs .............................................. 1279
Thermal Comfort Setpoints .................................................................................. 1280
ThermostatSetpoint:ThermalComfort:Fanger:SingleHeating ................................ 1281
ThermostatSetpoint:ThermalComfort:Fanger:SingleCooling ................................ 1281
ThermostatSetpoint:ThermalComfort:Fanger:SingleHeatingOrCooling ................ 1281
ThermostatSetpoint:ThermalComfort:Fanger:DualSetpoint ................................. 1281
ZoneControl:ContaminantController .................................................................... 1282
ZoneControl Contaminant Controller Outputs ...................................................... 1284
Group -- Air Path ....................................................................................................... 1284
AirLoopHVAC:SupplyPath, AirLoopHVAC:ReturnPath ........................................ 1284
AirLoopHVAC:SupplyPath ................................................................................... 1285
AirLoopHVAC:ReturnPath ................................................................................... 1285
AirLoopHVAC:ReturnPlenum .............................................................................. 1286

9/29/14

xxviii

TABLE OF CONTENTS
AirLoopHVAC:SupplyPlenum .............................................................................. 1288
AirLoopHVAC:ZoneSplitter .................................................................................. 1289
AirLoopHVAC:ZoneMixer .................................................................................... 1290
Group -- Non-Zone Equipment .................................................................................. 1290
LoadProfile:Plant ................................................................................................. 1291
LoadProfile Plant Outputs .................................................................................... 1291
Group Solar Collectors ........................................................................................... 1292
SolarCollector:FlatPlate:Water............................................................................. 1292
Solar Collector FlatPlate Water Output ................................................................ 1293
SolarCollectorPerformance:FlatPlate ................................................................... 1294
SolarCollectorPerformance:FlatPlate Output ....................................................... 1295
SolarCollector:IntegralCollectorStorage ............................................................... 1295
SolarCollectorPerformance:IntegralCollectorStorage........................................... 1297
Solar Collector Integral Collector Storage Outputs .............................................. 1299
SolarCollector:FlatPlate:PhotovoltaicThermal ...................................................... 1300
Solar Collector FlatPlate PhotovoltaicThermal Outputs ....................................... 1301
SolarCollectorPerformance:PhotovoltaicThermal:Simple ..................................... 1302
Solar Collector Heating System Plant Connections ............................................. 1303
Solar Heating System Control ............................................................................. 1306
SolarCollector:UnglazedTranspired ..................................................................... 1308
Solar Collector Unglazed Transpired Outputs ...................................................... 1313
SolarCollector:UnglazedTranspired:MultiSystem ................................................. 1314
Group Pumps ......................................................................................................... 1316
Pump:VariableSpeed........................................................................................... 1316
Variable Speed Pump Outputs ............................................................................ 1319
Pump:ConstantSpeed ......................................................................................... 1320

9/29/14

xxix

TABLE OF CONTENTS
Constant Speed Pump Outputs ........................................................................... 1322
Pump:VariableSpeed:Condensate....................................................................... 1323
Variable Speed Condensate Pump Outputs ........................................................ 1324
HeaderedPumps:ConstantSpeed ........................................................................ 1325
Constant Speed Headered Pumps Outputs ......................................................... 1327
HeaderedPumps:VariableSpeed ......................................................................... 1328
Variable Speed Headered Pumps Outputs .......................................................... 1330
Group Heating and Cooling Coils ........................................................................... 1331
Coil:Cooling:Water............................................................................................... 1332
Cooling Coil (Water) Outputs ............................................................................... 1334
Coil:Heating:Water .............................................................................................. 1335
Heating Coil (Water) Outputs ............................................................................... 1337
Coil:Heating:Steam.............................................................................................. 1337
Heating Coil (Steam) Outputs: ............................................................................. 1339
Coil:Heating:Electric ............................................................................................ 1339
Heating Coil (Electric) Outputs ............................................................................ 1340
Coil:Heating:Electric:MultiStage........................................................................... 1340
Heating Coil (Electric Multistage) Outputs ........................................................... 1342
Coil:Heating:Desuperheater ................................................................................ 1342
Heating Coil (Desuperheater) Outputs ................................................................. 1344
Coil:Cooling:DX:VariableRefrigerantFlow ............................................................ 1345
Cooling DX Coil (VariableRefrigerantFlow) Outputs............................................. 1347
Coil:Heating:DX:VariableRefrigerantFlow ............................................................ 1348
Heating DX Coil (VariableRefrigerantFlow) Outputs ............................................ 1350
Coil:Heating:Gas ................................................................................................. 1350
Heating Coil (Gas) Outputs.................................................................................. 1351

9/29/14

xxx

TABLE OF CONTENTS
Coil:Heating:Gas:MultiStage................................................................................ 1352
Heating Coil (Gas Multistage) Outputs................................................................. 1355
Coil:Cooling:Water:DetailedGeometry ................................................................. 1356
Detailed Geometry Cooling Coil (Water) Outputs ................................................ 1359
Coil:Cooling:DX:SingleSpeed .............................................................................. 1360
Coil:Cooling:DX:TwoSpeed ................................................................................. 1367
Coil:Cooling:DX:TwoStageWithHumidityControlMode ......................................... 1377
Coil:Cooling:DX:MultiSpeed ................................................................................ 1379
DX Cooling Coil Outputs ...................................................................................... 1388
Coil:Cooling:DX:VariableSpeed ........................................................................... 1391
Variable Speed DX Cooling Coil Outputs............................................................. 1398
CoilPerformance:DX:Cooling ............................................................................... 1401
Coil Performance DX Cooling Outputs................................................................. 1409
Coil:Heating:DX:SingleSpeed .............................................................................. 1409
DX Heating Coil Outputs ..................................................................................... 1415
Coil:Heating:DX:MultiSpeed ................................................................................ 1416
Coil:Heating:DX:MultiSpeed ................................................................................ 1416
MultiSpeed DX Heating Coil Outputs ................................................................... 1423
Coil:Heating:DX:VariableSpeed ........................................................................... 1425
Variable Speed DX Heating Coil Outputs ............................................................ 1431
Coil:WaterHeating:Desuperheater ....................................................................... 1433
WaterHeating Coil (Desuperheater) Outputs ....................................................... 1437
CoilSystem:Cooling:DX ....................................................................................... 1438
DX Cooling Coil System Outputs ......................................................................... 1441
CoilSystem:Heating:DX ....................................................................................... 1442
DX Heating Coil System Outputs ......................................................................... 1443

9/29/14

xxxi

TABLE OF CONTENTS
CoilSystem:Cooling:DX:HeatExchangerAssisted ................................................. 1443
CoilSystem:Cooling:DX:HeatExchangerAssisted Outputs ................................... 1446
CoilSystem:Cooling:Water:HeatExchangerAssisted ............................................ 1446
CoilSystem:Cooling:Water:HeatExchangerAssisted Outputs ............................... 1449
Coil:WaterHeating:AirToWaterHeatPump ............................................................ 1449
Coil:WaterHeating:AirToWaterHeatPump Outputs............................................... 1454
Coil:Cooling:WaterToAirHeatPump:ParameterEstimation.................................... 1456
Coil:Cooling:WaterToAirHeatPump:EquationFit ................................................... 1459
Water to Air Heat Pump Cooling Coil (Parameter Estimation and Equation
Fit) Outputs ......................................................................................................... 1461
Coil:Cooling:WaterToAirHeatPump:VariableSpeedEquationFit ........................... 1463
Variable Speed Water to Air Heat Pump Cooling Coil Outputs ............................ 1472
Coil:Heating:WaterToAirHeatPump:ParameterEstimation ................................... 1474
Coil:Heating:WaterToAirHeatPump:EquationFit .................................................. 1477
Water to Air Heat Pump Heating Coil (parameter Estimation and Equation
Fit) Outputs ......................................................................................................... 1478
Coil:Heating:WaterToAirHeatPump:VariableSpeedEquationFit ........................... 1480
Variable Speed Water to Air Heat Pump Heating Coil Outputs ............................ 1487
Coil:Cooling:DX:SingleSpeed:ThermalStorage .................................................... 1489
Coil:Cooling:DX:SingleSpeed:ThermalStorage Outputs ...................................... 1513
Group Fans ............................................................................................................ 1516
Fan:ConstantVolume ........................................................................................... 1516
Constant Volume Fan Outputs ............................................................................ 1518
Fan:OnOff ........................................................................................................... 1518
On Off Fan Outputs ............................................................................................. 1520
Fan:VariableVolume ............................................................................................ 1520
Variable Volume Fan Outputs.............................................................................. 1522

9/29/14

xxxii

TABLE OF CONTENTS
Fan:ZoneExhaust ................................................................................................ 1523
Zone Exhaust Fan Outputs .................................................................................. 1525
FanPerformance:NightVentilation ........................................................................ 1526
Fan:ComponentModel ......................................................................................... 1527
Component Model Fan Outputs ........................................................................... 1535
Group -- Humidifiers .................................................................................................. 1536
Humidifier:Steam:Electric .................................................................................... 1536
Steam Electric Humidfier Outputs ........................................................................ 1537
Group Desiccant Dehumidifiers .............................................................................. 1538
Dehumidifier:Desiccant:NoFans .......................................................................... 1538
Desiccant Dehumidifier (NoFans) Outputs ........................................................... 1542
Dehumidifier:Desiccant:System ........................................................................... 1543
Desiccant Dehumidifier Outputs .......................................................................... 1548
Group Energy Management System (EMS)............................................................ 1549
EnergyManagementSystem:Sensor .................................................................... 1549
EnergyManagementSystem:Actuator .................................................................. 1550
EnergyManagementSystem:ProgramCallingManager ......................................... 1551
EnergyManagementSystem:Program .................................................................. 1553
EnergyManagementSystem:Subroutine .............................................................. 1554
EnergyManagementSystem:GlobalVariable ........................................................ 1555
EnergyManagementSystem:OutputVariable ........................................................ 1556
EnergyManagementSystem:MeteredOutputVariable, .......................................... 1557
EnergyManagementSystem:TrendVariable ......................................................... 1559
EnergyManagementSystem:InternalVariable ....................................................... 1560
EnergyManagementSystem:CurveOrTableIndexVariable .................................... 1560
EnergyManagementSystem:ConstructionIndexVariable ...................................... 1561

9/29/14

xxxiii

TABLE OF CONTENTS
Group ExternalInterface ......................................................................................... 1561
ExternalInterface ................................................................................................. 1562
Building Controls Virtual Test Bed (BCVTB) ........................................................ 1562
ExternalInterface:Schedule.................................................................................. 1562
ExternalInterface:Actuator ................................................................................... 1562
ExternalInterface:Variable ................................................................................... 1563
Functional Mock-up Unit (FMU) Import ................................................................ 1564
ExternalInterface:FunctionalMockupUnitImport ................................................... 1564
ExternalInterface:FunctionalMockupUnitImport:From:Variable ............................ 1564
ExternalInterface:FunctionalMockupUnitImport:To:Schedule ............................... 1565
ExternalInterface:FunctionalMockupUnitImport:To:Actuator ................................ 1566
ExternalInterface:FunctionalMockupUnitImport:To:Variable ................................ 1567
Functional Mock-up Unit (FMU) Export ................................................................ 1568
ExternalInterface:FunctionalMockupUnitExport:From:Variable ............................ 1568
ExternalInterface:FunctionalMockupUnitExport:To:Schedule .............................. 1569
ExternalInterface:FunctionalMockupUnitExport:To:Actuator ................................ 1569
ExternalInterface:FunctionalMockupUnitExport:To:Variable ................................ 1570
Group User Defined HVAC and Plant Component Models ..................................... 1570
ZoneHVAC:ForcedAir:UserDefined ..................................................................... 1571
AirTerminal:SingleDuct:UserDefined ................................................................... 1573
Coil:UserDefined ................................................................................................. 1575
PlantComponent:UserDefined ............................................................................. 1577
PlantEquipmentOperation:UserDefined ............................................................... 1579
Group System Availability Managers ..................................................................... 1581
AvailabilityManager:Scheduled ............................................................................ 1582
AvailabilityManager:ScheduledOn ....................................................................... 1582

9/29/14

xxxiv

TABLE OF CONTENTS
AvailabilityManager:ScheduledOn Outputs .......................................................... 1583
AvailabilityManager:ScheduledOff ....................................................................... 1583
AvailabilityManager:ScheduledOff Outputs .......................................................... 1584
AvailabilityManager:NightCycle ........................................................................... 1584
AvailabilityManager:NightCycle Outputs .............................................................. 1585
AvailabilityManager:DifferentialThermostat .......................................................... 1585
AvailabilityManager:DifferentialThermostat Outputs ............................................ 1586
AvailabilityManager:HighTemperatureTurnOff ..................................................... 1586
AvailabilityManager:HighTemperatureTurnOff Outputs ........................................ 1586
AvailabilityManager:HighTemperatureTurnOn ..................................................... 1586
AvailabilityManager:HighTemperatureTurnOn Outputs ........................................ 1587
AvailabilityManager:LowTemperatureTurnOff ...................................................... 1587
AvailabilityManager:LowTemperatureTurnOff Outputs ........................................ 1587
AvailabilityManager:LowTemperatureTurnOn ...................................................... 1588
AvailabilityManager:LowTemperatureTurnOn Outputs ........................................ 1588
AvailabilityManager:NightVentilation .................................................................... 1588
System Availability Manager Night Ventilation Outputs ........................................ 1589
AvailabilityManager:HybridVentilation .................................................................. 1590
AvailabilityManager:HybridVentilation Outputs .................................................... 1593
AvailabilityManager:OptimumStart ....................................................................... 1593
AvailabilityManager:OptimumStart Outputs ......................................................... 1595
Group Setpoint Managers ...................................................................................... 1595
SetpointManager:Scheduled ............................................................................... 1597
SetpointManager:Scheduled:DualSetpoint .......................................................... 1598
SetpointManager:OutdoorAirReset ...................................................................... 1598
SetpointManager:SingleZone:Reheat .................................................................. 1600

9/29/14

xxxv

TABLE OF CONTENTS
SetpointManager:SingleZone:Heating ................................................................. 1601
SetpointManager:SingleZone:Cooling ................................................................. 1602
SetpointManager:SingleZone:Humidity:Minimum ................................................ 1603
SetpointManager:SingleZone:Humidity:Maximum ............................................... 1604
SetpointManager:MixedAir .................................................................................. 1605
SetpointManager:OutdoorAirPretreat .................................................................. 1606
SetpointManager:Warmest .................................................................................. 1608
SetpointManager:Coldest .................................................................................... 1609
SetpointManager:ReturnAirBypassFlow .............................................................. 1611
SetpointManager:WarmestTemperatureFlow ...................................................... 1612
SetpointManager:WarmestTemperatureFlow Outputs ......................................... 1613
SetpointManager:MultiZone:Cooling:Average...................................................... 1613
SetpointManager:MultiZone:Heating:Average ..................................................... 1614
SetpointManager:MultiZone:MinimumHumidity:Average...................................... 1615
SetpointManager:MultiZone:MaximumHumidity:Average..................................... 1616
SetpointManager:MultiZone:Humidity:Minimum ................................................... 1617
SetpointManager:MultiZone:Humidity:Maximum .................................................. 1618
SetpointManager:FollowOutdoorAirTemperature ................................................. 1619
SetpointManager:FollowSystemNodeTemperature ............................................. 1620
SetpointManager:FollowGroundTemperature ...................................................... 1621
SetpointManager:CondenserEnteringReset ........................................................ 1622
SetpointManager:CondenserEnteringReset:Ideal ................................................ 1624
SetpointManager:SingleZone:OneStageCooling ................................................. 1625
SetpointManager:SingleZoneOneStageHeating .................................................. 1625
Group Controllers ................................................................................................... 1626
Controls (Air Loop and Zone Equipment)............................................................. 1626

9/29/14

xxxvi

TABLE OF CONTENTS
Controller:WaterCoil ............................................................................................ 1626
Controller:OutdoorAir........................................................................................... 1628
Controller:OutdoorAir Outputs ............................................................................. 1634
Controller:MechanicalVentilation ......................................................................... 1636
ZoneHVAC:EnergyRecoveryVentilator:Controller ................................................ 1638
Group Evaporative Coolers .................................................................................... 1641
EvaporativeCooler:Direct:CelDekPad .................................................................. 1641
EvaporativeCooler:Direct:CelDekPad Outputs..................................................... 1643
EvaporativeCooler:Direct:ResearchSpecial ......................................................... 1644
EvaporativeCooler:Direct:ResearchSpecial Outputs ............................................ 1645
EvaporativeCooler:Indirect:CelDekPad................................................................ 1646
EvaporativeCooler:Indirect:CelDekPad Outputs .................................................. 1649
EvaporativeCooler:Indirect:WetCoil ..................................................................... 1650
EvaporativeCooler:Indirect:WetCoil Outputs ........................................................ 1653
EvaporativeCooler:Indirect:ResearchSpecial ....................................................... 1654
EvaporativeCooler:Indirect:ResearchSpecial Outputs ......................................... 1656
Group Heat Recovery............................................................................................. 1657
HeatExchanger:AirToAir:FlatPlate ....................................................................... 1657
HeatExchanger:AirToAir:FlatPlate Outputs .......................................................... 1659
HeatExchanger:AirToAir:SensibleAndLatent ....................................................... 1661
HeatExchanger:AirToAir:SensibleAndLatent Outputs .......................................... 1667
HeatExchanger:Desiccant:BalancedFlow ............................................................ 1669
HeatExchanger:Desiccant:BalancedFlow Outputs ............................................... 1671
HeatExchanger:Desiccant:BalancedFlow:PerformanceDataType1 ...................... 1672
HeatExchanger:Desiccant:BalancedFlow:PerformanceDataType1
Outputs................................................................................................................ 1679
Group Demand Limiting Controls ........................................................................... 1679
9/29/14

xxxvii

TABLE OF CONTENTS
DemandManagerAssignmentList ......................................................................... 1680
DemandManagerAssignmentList Outputs ........................................................... 1681
DemandManager:ExteriorLights .......................................................................... 1682
DemandManager:ExteriorLights Outputs ............................................................. 1683
DemandManager:Lights ...................................................................................... 1683
DemandManager:Lights Outputs ......................................................................... 1685
DemandManager:ElectricEquipment ................................................................... 1685
DemandManager:ElectricEquipment Outputs ...................................................... 1686
DemandManager:Thermostats ............................................................................ 1686
DemandManager:Thermostats Outputs ............................................................... 1688
Group -- Electric Load Center-Generator Specifications ............................................ 1688
ElectricLoadCenter:Transformer .......................................................................... 1688
ElectricLoadCenter:Transformer Outputs ............................................................ 1691
ElectricLoadCenter:Distribution ........................................................................... 1692
ElectricLoadCenter:Distribution Outputs .............................................................. 1695
ElectricLoadCenter:Generators ........................................................................... 1697
ElectricLoadCenter:Generators Outputs .............................................................. 1698
ElectricLoadCenter:Inverter:Simple ..................................................................... 1698
ElectricLoadCenter:Inverter:FunctionOfPower ..................................................... 1699
ElectricLoadCenter:Inverter:LookUpTable ........................................................... 1701
Electric Load Center Inverter Outputs .................................................................. 1702
ElectricLoadCenter:Storage:Simple ..................................................................... 1703
ElectricLoadCenter:Storage:Simple Outputs........................................................ 1704
ElectricLoadCenter:Storage: Battery ................................................................... 1705
ElectricLoadCenter: Storage:Battery Outputs ...................................................... 1709
Generator:InternalCombustionEngine ................................................................. 1710

9/29/14

xxxviii

TABLE OF CONTENTS
Generator:InternalCombustionEngine Outputs .................................................... 1714
Generator:CombustionTurbine ............................................................................ 1716
Generator:CombustionTurbine Outputs ............................................................... 1720
Generator:MicroTurbine ...................................................................................... 1721
Generator:MicroTurbine Outputs ......................................................................... 1728
Generator:MicroCHP ........................................................................................... 1731
Generator:MicroCHP:NonNormalizedParameters ............................................... 1732
Generator:MicroCHP Outputs .............................................................................. 1736
Generator:FuelCell .............................................................................................. 1738
Generator:FuelCell Outputs ................................................................................. 1740
Generator:FuelCell:PowerModule ........................................................................ 1745
Generator:FuelCell:StackCooler .......................................................................... 1750
Generator:FuelCell:AirSupply .............................................................................. 1752
Generator:FuelCell:WaterSupply ......................................................................... 1754
Generator:FuelCell:AuxiliaryHeater ..................................................................... 1756
Generator:FuelCell:ElectricalStorage .................................................................. 1762
Generator:FuelCell:Inverter ................................................................................. 1763
Generator:FuelSupply ......................................................................................... 1764
Generator:FuelSupply Outputs ............................................................................ 1765
Photovoltaic Generators ...................................................................................... 1766
Generator:Photovoltaic ........................................................................................ 1767
Generator:Photovoltaic Outputs........................................................................... 1768
PhotovoltaicPerformance:Simple ......................................................................... 1768
PhotovoltaicPerformance:EquivalentOne-Diode .................................................. 1769
PhotovoltaicPerformance:Sandia......................................................................... 1773
Generator:WindTurbine ....................................................................................... 1776

9/29/14

xxxix

TABLE OF CONTENTS
Generator:WindTurbine Outputs .......................................................................... 1781
Group Water Systems ............................................................................................ 1782
WaterUse:Equipment .......................................................................................... 1783
WaterUse:Equipment Outputs ............................................................................. 1785
WaterUse:Connections ........................................................................................ 1788
WaterUse:Connections Outputs .......................................................................... 1790
WaterUse:Storage ............................................................................................... 1792
WaterUse:Storage Outputs.................................................................................. 1794
WaterUse:RainCollector ...................................................................................... 1795
WaterUse:RainCollector Outputs ......................................................................... 1796
WaterUse:Well .................................................................................................... 1796
WaterUse:Well Outputs ....................................................................................... 1797
Group Operational Faults ....................................................................................... 1798
Introduction to Operational Faults Modeling ........................................................ 1798
Operational Fault Objects .................................................................................... 1798
FaultModel:TemperatureSensorOffset:OutdoorAir ............................................... 1798
FaultModel:HumiditySensorOffset:OutdoorAir ..................................................... 1799
FaultModel:EnthalpySensorOffset:OutdoorAir ..................................................... 1800
FaultModel:TemperatureSensorOffset:ReturnAir ................................................. 1800
FaultModel:EnthalpySensorOffset:ReturnAir ....................................................... 1801
FaultModel:Fouling:Coil ....................................................................................... 1802
Group Performance Curves .................................................................................... 1804
Curve:Linear ........................................................................................................ 1804
Curve:QuadLinear ............................................................................................... 1805
Curve:Quadratic .................................................................................................. 1808
Curve:Cubic......................................................................................................... 1810

9/29/14

xl

TABLE OF CONTENTS
Curve:Quartic ...................................................................................................... 1811
Curve:Exponent ................................................................................................... 1813
Curve:Bicubic ...................................................................................................... 1814
Curve:Biquadratic ................................................................................................ 1816
Curve:QuadraticLinear ........................................................................................ 1818
Curve:Triquadratic ............................................................................................... 1820
Curve:Functional:PressureDrop........................................................................... 1824
Curve:FanPressureRise ...................................................................................... 1825
Curve:ExponentialSkewNormal ........................................................................... 1826
Curve:Sigmoid ..................................................................................................... 1828
Curve:RectangularHyperbola1 ............................................................................ 1829
Curve:RectangularHyperbola2 ............................................................................ 1830
Curve:ExponentialDecay ..................................................................................... 1832
Curve:DoubleExponentialDecay .......................................................................... 1833
Curve:CubicLinear ............................................................................................... 1834
Performance Curve Outputs ................................................................................ 1836
Group Performance Tables .................................................................................... 1836
Table:OneIndependentVariable ........................................................................... 1837
Performance Table Outputs................................................................................. 1839
Table:TwoIndependentVariables ......................................................................... 1840
Two Independent Variable Performance Table Outputs ...................................... 1843
Lookup Tables ..................................................................................................... 1844
Table:MultiVariableLookup .................................................................................. 1844
Data Input Format ............................................................................................... 1849
Lookup Table Outputs ......................................................................................... 1853
Lookup Table Outputs ......................................................................................... 1853

9/29/14

xli

TABLE OF CONTENTS
Group Fluid Properties ........................................................................................... 1854
FluidProperties:Name .......................................................................................... 1854
FluidProperties:GlycolConcentration ................................................................... 1855
FluidProperties:Temperatures ............................................................................. 1856
FluidProperties:Saturated .................................................................................... 1856
FluidProperties:Superheated ............................................................................... 1857
Glycol Fluid Types ............................................................................................... 1858
FluidProperties:Concentration ............................................................................. 1858
HVAC Template Objects ...........................................................................................................1860
HVACTemplate Processing ....................................................................................... 1860
Group -- HVAC Templates ........................................................................................ 1860
HVACTemplate:Thermostat................................................................................. 1863
HVACTemplate:Zone:IdealLoadsAirSystem ........................................................ 1864
HVACTemplate:Zone:BaseboardHeat ................................................................. 1869
HVACTemplate:Zone:FanCoil ............................................................................. 1871
HVACTemplate:Zone:PTAC ................................................................................ 1876
HVACTemplate:Zone:PTHP ................................................................................ 1883
HVACTemplate:Zone:WaterToAirHeatPump ....................................................... 1891
HVACTemplate:Zone:VRF .................................................................................. 1898
HVACTemplate:Zone:Unitary .............................................................................. 1904
HVACTemplate:Zone:VAV .................................................................................. 1908
HVACTemplate:Zone:VAV:FanPowered ............................................................. 1914
HVACTemplate:Zone:VAV:HeatAndCool ............................................................ 1921
HVACTemplate:Zone:ConstantVolume ............................................................... 1925
HVACTemplate:Zone:DualDuct ........................................................................... 1930
HVACTemplate:System:VRF ............................................................................... 1934

9/29/14

xlii

TABLE OF CONTENTS
HVACTemplate:System:Unitary........................................................................... 1941
HVACTemplate:System:UnitaryHeatPump:AirToAir ............................................ 1949
HVACTemplate:System:UnitarySystem ............................................................... 1958
HVACTemplate:System:VAV ............................................................................... 1971
HVACTemplate:System:PackagedVAV ............................................................... 1981
HVACTemplate:System:ConstantVolume............................................................ 1991
HVACTemplate:System:DualDuct ....................................................................... 2003
HVACTemplate:System:DedicatedOutdoorAir ..................................................... 2018
HVACTemplate:Plant:ChilledWaterLoop ............................................................. 2027
HVACTemplate:Plant:Chiller ............................................................................... 2033
HVACTemplate:Plant:Chiller:ObjectReference .................................................... 2035
HVACTemplate:Plant:Tower ................................................................................ 2035
HVACTemplate:Plant:Tower:ObjectReference .................................................... 2037
HVACTemplate:Plant:HotWaterLoop ................................................................... 2038
HVACTemplate:Plant:Boiler ................................................................................ 2041
HVACTemplate:Plant:Boiler:ObjectReference ..................................................... 2043
HVACTemplate:Plant:MixedWaterLoop ............................................................... 2044
EnergyPlus Economics..............................................................................................................2048
Group Economics ................................................................................................... 2048
Introduction to Economics ......................................................................................... 2048
Conceptual Framework Variables and Hierarchy .................................................... 2049
UtilityCost:Tariff ......................................................................................................... 2051
UtilityCost:Qualify ...................................................................................................... 2055
UtilityCost:Charge:Simple.......................................................................................... 2056
UtilityCost:Charge:Block ............................................................................................ 2058
UtilityCost:Ratchet ..................................................................................................... 2059

9/29/14

xliii

TABLE OF CONTENTS
UtilityCost:Variable .................................................................................................... 2061
UtilityCost:Computation ............................................................................................. 2062
UtilityCost:Tariff Examples ........................................................................................ 2062
UtilityCost:Tariff Reporting......................................................................................... 2073
Economic Results Summary Report .......................................................................... 2073
Complex Tariff Modeling ........................................................................................... 2074
Cost Estimating ......................................................................................................... 2077
ComponentCost:LineItem .................................................................................... 2077
ComponentCost:Adjustments .............................................................................. 2081
ComponentCost:Reference ................................................................................. 2082
Economics Cost Estimate Reporting ................................................................... 2083
Life-Cycle Costing ..................................................................................................... 2085
LifeCycleCost:Parameters ......................................................................................... 2086
LifeCycleCost:RecurringCosts ................................................................................... 2089
LifeCycleCost:NonrecurringCost ............................................................................... 2091
LifeCycleCost:UsePriceEscalation ............................................................................ 2092
LifeCycleCost:UseAdjustment ................................................................................... 2094
CurrencyType ...................................................................................................... 2095
Parametric Objects ....................................................................................................................2097
Group Parametrics ................................................................................................. 2097
Expressions ......................................................................................................... 2098
Processing Order ................................................................................................ 2098
Parametric:SetValueForRun ................................................................................ 2098
Parametric:Logic ................................................................................................. 2099
Parametric:RunControl ........................................................................................ 2103
Parametric:FileNameSuffix .................................................................................. 2103

9/29/14

xliv

TABLE OF CONTENTS
Input for Output ..........................................................................................................................2104
Group Reports........................................................................................................ 2104
Variable Dictionary Reports ................................................................................. 2104
Surface Reports .................................................................................................. 2105
Output:Surfaces:List ............................................................................................ 2105
Output:Surfaces:Drawing..................................................................................... 2106
Output:Schedules ................................................................................................ 2107
Output:Constructions ........................................................................................... 2107
Output:DaylightFactors ........................................................................................ 2108
Output:EnergyManagementSystem ..................................................................... 2108
OutputControl:SurfaceColorScheme ................................................................... 2109
OutputControl:ReportingTolerances .................................................................... 2110
Output:Variable ................................................................................................... 2110
Output:Meter and Output:Meter:MeterFileOnly .................................................... 2111
Output:Meter:Cumulative and Output:Meter:Cumulative:MeterFileOnly ............... 2111
Output:EnvironmentalImpactFactors ................................................................... 2114
EnvironmentalImpactFactors ............................................................................... 2115
FuelFactors ......................................................................................................... 2116
Environmental Pollution Impact Outputs .............................................................. 2122
Output:SQLite...................................................................................................... 2135
Output ........................................................................................................................................2136
Using ReadVarsESO................................................................................................. 2137
Creating Charts and Spreadsheet files from Output Variables ............................. 2137
Standard Output Reports...........................................................................................................2140
Output:Table:TimeBins.............................................................................................. 2140
Output:Table:Monthly ................................................................................................ 2141

9/29/14

xlv

TABLE OF CONTENTS
Output:Table:SummaryReports ................................................................................. 2143
Predefined Annual Summary Reports.................................................................. 2143
Predefined Monthly Summary Reports ................................................................ 2151
OutputControl:Table:Style ......................................................................................... 2163
Weather Data .............................................................................................................................2165
Missing Weather File Data ........................................................................................ 2165
Weather Data Hourly Interpolation ............................................................................ 2166
Weather File Data Reporting (errors) during Simulation ............................................ 2167
Running EnergyPlus ..................................................................................................................2168
Energy+.ini ................................................................................................................ 2168
Errors ........................................................................................................................ 2169
EnergyPlus Execution Time ...................................................................................... 2173
Reducing Run Time Tips ..................................................................................... 2173
Appendix A. Units and Abbreviations ........................................................................................2175
Standard EnergyPlus Conditions ............................................................................... 2175
Standard Temperature and Pressure .................................................................. 2175
Standard EnergyPlus Units ....................................................................................... 2175

9/29/14

xlvi

Input-Output Reference

Whats different about EnergyPlus Input and Output?

Input-Output Reference
This document is intended to be an encyclopedic reference for the EnergyPlus Input Data
Dictionary (IDD), Input Data File (IDF) and potential resultant outputs (various output files).
The following descriptions are grouped by the elements in the IDD (ref: Getting Started
Document and the IDD Conventions). In some cases, the descriptions of reporting will be
done for an object (e.g. Lighting electrical consumption or thermal comfort value for a group
of people) and in some cases for the entire group (e.g., ambient condition reports).

Whats different about EnergyPlus Input and Output?

The usual procedure for non-interactive programs is to process all the input necessary to do
the job, perform the actions required by the input, and somewhere along the way produce
reports on the actions. Usually, there will be error messages on incorrect input statements
and/or incorrect conditions detected during processing. Usually, the input is echoed in its
entirety so that the context of errors is shown clearly.
Results are typically output into reports as well as a compilation of various inputs reformatted
into different groupings than were originally entered (defaults filled in, etc.)
EnergyPlus does all the above. However, some nuances are different from the usual actions.
EnergyPlus Input Processing
1) EnergyPlus reads the data dictionary (Energy+.idd) and the input data file (in.idf)
prior to doing anything else. Only after this is done does processing start.
HOWEVER, the input processor only knows as much as the data dictionary has told
it. It knows which fields should be alpha and which should be numeric. All of this
information (including the IDD) is echoed to the audit file (audit.out) in case errors
occur. Most of the errors show up (out of context) in the standard error file
(eplusout.err) there might be enough information to decipher where the error is or
you may have to look at the more inclusive audit file. Invalid numeric fields are
detected during this processing and default numeric fields are filled. For more
information on the IDD, its structure and implications, please see the IDD
Conventions discussion below.
2) The biggest difference between EnergyPlus and more traditional input processing is
that EnergyPlus is modular in its actual filling in the details for the simulation.
Because of the modular structure of EnergyPlus, each module is responsible for
getting its own input. It receives this input from the input processor in the form of
alpha and numeric fields. Each module typically gets all its input the first time it is
called. The implication for the user is that error messages may show up in somewhat
peculiar places. A further implication is that no order is needed in the input data file!
Data that is not needed by a particular simulation is not processed.
3) The data dictionary has the capability to do automatic range checking on numeric
fields as well as fill in numeric defaults. Both filling in defaults and automatic range
checking are done when the data is read. Other checks may need a combination of
fields and wont be done until the data is processed (after the simulation starts).
4) A couple of other differences that might not be true in other programs: Blanks are
significant in alpha fields SO DesignDay is not the same as Design Day (1 space
between Design and Day) nor Design Day (2 spaces between Design and Day).
Alpha objects, however, are case insensitive SO DesignDay is the same as
designday or SizingPeriod:DesignDay.

9/29/14

Input-Output Reference

Whats different about EnergyPlus Input and Output?

General Input Rules

Rules shown here are for the input data files. Rules about the Input Data Dictionary are
shown in the Interface Developers Guide (there is much similarity and overlap) but most
users dont need to touch the IDD (Input Data Dictionary).
The input data file is the primary file that EnergyPlus uses to create the building simulation.
The only additional files are referenced by certain objects (such as the Schedule:File object).
The input is order-independent; data can appear in any order and will be retrieved and sorted
as necessary by the EnergyPlus simulation modules. In addition, EnergyPlus allocates
everything dynamically, so there are no limitations as to number of zones, surfaces, etc.
The initial line of an input object MUST have a comma or semicolon.
Fields do not extend over line boundaries. Usually, if a comma or (as appropriate) semicolon is not the last field value on a line, one will be inserted. Of course, several fields
may appear on a single line as long as they are comma separated. (And the last could be
followed by a semi-colon).
Commas delimit fields therefore, no fields can have embedded commas. No error will
occur but you won't get what you want. You cannot surround a field with to
accommodate commas in the fields.
Blank lines are allowed.
The comment character is a exclamation !. Anything on a line after the exclamation is
ignored.
Input records (aka input line length) can be up to 500 characters in length. If you go over
that, no error will occur but you won't get what you want.
Each Alpha string in the input data file (aka alpha field length) can be up to 100
characters in length. Anything beyond that is truncated. This would apply to all names
(such as zone name, node name, schedule name) in fields.
Each Alpha string (including Section and Class/Object keywords) is mapped to UPPER
case during processing, unless the retaincase flag marks the field in the IDD. Get
routines from the EnergyPlus code that use the Section and Object keywords
automatically map to UPPER case for finding the item. The primary drawback with this is
that error messages coming out of the input processor will be in UPPER case and may
not appear exactly as input.
Special characters, such as tabs, should NOT be included in the file. However, tabs can
be accommodated and are turned into spaces.
All numbers can be flexibly input and are processed into single precision variables (i.e.
1.0, 1.000, 1, .1E+1 are all processed equally).
EnergyPlus Output Processing
1) Unlike the usual formatted output text formatted reports, EnergyPlus usual output is
either at the summary or at the detailed (variable) level. Summary reports exist for
many inputs as well as sizing results. The more detailed variable level reporting is
produced as stream of consciousness (as the simulation happens) and must be
post-processed for more sensible viewing. Note that the terms output variable and
output variable (accessed by the Output:Variable and/or Output:Meter objects) are
used interchangably in this document.
2) Most EnergyPlus reporting can be readily viewed in current spreadsheet programs
or other software that can process delimited variable reports. In these kind of
reports, each column is separated from the next by a delimiter. Typical delimiters
are comma and tab. Gradually, EnergyPlus reporting is moving from all comma
separated reports to allow the user to select the delimiter via style objects.

9/29/14

Input-Output Reference

IDD Conventions

3) Styled reports allow for more selectable output reporting but also increase the
number of output files as we have chosen to create the report names with extensions
that typify the actual reporting. Depending on the reporting, these can be:
Tab reports with a .tab extension have tabs as the delimiter. These report files
(directly from EnergyPlus) will be named something like eplus<xxx>.tab where
the <xxx> is a short name of the kind of report (e.g. Zsz for Zone Sizing, Map for
Daylighting Map)
Csv reports with a .csv extension have commas as the delimiter. These are
also specially formatted for use in spreadsheets (such as the compilation of
results from the eplusout.eso file into the eplusout.csv file using the default postprocessor program).
Txt reports with a .txt extension have spaces as the delimiter but only certain
of these are really formatted the way you might expect: where multiple spaces
make printing with a non-proportional font would produce readable output.
Html reports with a .html extension are web-browser ready.

IDD Conventions
The following is a basic description of the structure of the IDD (its actually taken directly from
the IDD file). As noted within, ! signifies a comment character as does the \. \ has also been
adopted as a convention for including more specific comments about each field in an object.
These have been used with success in the IDFEditor and it is hoped the flexibility will provide
other interface developers with useful information.
!IDD_Version VERSION NUMBER
! **************************************************************************
! This file is the Input Data Dictionary (IDD) for EnergyPlus.
! The IDD defines the syntax and data model for each type of input "Object."
! Lines in EnergyPlus input files (and IDD) are limited to 500 characters.
!
! Object Description
! -----------------! To define an object (a record with data), develop a key word that is unique
! Each data item to the object can be A (Alphanumeric string) or N (numeric)
! Number each A and N. This will show how the data items will be put into the
! arrays that are passed to the Input Processor "Get" (GetObjectItem) routines.
! All alpha fields are limited to 100 characters. Numeric fields should be
! valid numerics (can include such as 1.0E+05) and are placed into double
! precision variables.
!
! NOTE: Even though a field may be optional, a comma representing that field
!
must be included (unless it is the last field in the object). Since the
!
entire input is "field-oriented" and not "keyword-oriented", the EnergyPlus
!
Input Processor must have some representation (even if blank) for each
!
field.
!
! Object Documentation
! -------------------! In addition, the following special comments appear one per line and
! most are followed by a value. Comments may apply to a field or the object
! or a group of objects.
!
! Field-level comments:
!
! \field
Name of field
!
(should be succinct and readable, blanks are encouraged)
!
! \note
Note describing the field and its valid values. If multiple lines,
!
start each line with \note. Limit line length to 100 characters.
9/29/14

Input-Output Reference

IDD Conventions

!
! \required-field To flag fields which may not be left blank
!
(this comment has no "value")
!
! \begin-extensible Marks the first field at which the object accepts an extensible
!
field set. A fixed number of fields from this marker define the
!
extensible field set, see the object code \extensible for
!
more information.
!
! \units
Units (must be from EnergyPlus standard units list)
!
EnergyPlus units are standard SI units
!
! \ip-units
IP-Units (for use by input processors with IP units)
!
This is only used if the default conversion is not
!
appropriate.
!
! \unitsBasedOnField For fields that may have multiple possible units, indicates
!
the field in the object that can be used to determine
!
the units. The field reference is in the A2 form.
!
! \minimum
Minimum that includes the following value
!
! \minimum>
Minimum that must be > than the following value
!
! \maximum
Maximum that includes the following value
!
! \maximum<
Maximum that must be < than the following value
!
! \default
Default for the field (if N/A then omit entire line)
!
! \deprecated
This field is not really used and will be deleted from the object.
!
The required information is gotten internally or
!
not needed by the program.
!
! \autosizable
Flag to indicate that this field can be used with the Auto
!
Sizing routines to produce calculated results for the
!
field. If a value follows this, then that will be used
!
when the "Autosize" feature is flagged. To trigger
!
autosizing for a field, enter Autosize as the field's
!
value. Only applicable to numeric fields.
!
! \autocalculatable Flag to indicate that this field can be automatically
!
calculated. To trigger auto calculation for a field, enter
!
Autocalculate as the field's value. Only applicable to
!
numeric fields.
!
! \type
Type of data for the field !
integer
!
real
!
alpha
(arbitrary string),
!
choice
(alpha with specific list of choices, see
!
\key)
!
object-list (link to a list of objects defined elsewhere,
!
see \object-list and \reference)
!
external-list (uses a special list from an external source,
!
see \external-list)
!
node
(name used in connecting HVAC components)
!
! \retaincase
Retains the alphabetic case for alpha type fields
!
! \key
Possible value for "\type choice" (blanks are significant)
!
use multiple \key lines to indicate all valid choices
!
9/29/14

Input-Output Reference

IDD Conventions

! \object-list
Name of a list of user-provided object names that are valid
!
entries for this field (used with "\reference")
!
see Zone and BuildingSurface:Detailed objects below for
!
examples.
!
** Note that a field may have multiple \object-list commands.
!
! \external-list
The values for this field should be selected from a special
!
list generated outside of the IDD file. The choices for the
!
special lists are:
!
autoRDDvariable
!
autoRDDmeter
!
autoRDDvariableMeter
!
When one of these are selected the options for the field
!
are taken from the RDD or MDD file or both.
!
! \reference
Name of a list of names to which this object belongs
!
used with "\type object-list" and with "\object-list"
!
see Zone and BuildingSurface:Detailed objects below for
!
examples:
!
!
Zone,
!
A1 , \field Name
!
\type alpha
!
\reference ZoneNames
!
!
BuildingSurface:Detailed,
!
A4 , \field Zone Name
!
\note Zone the surface is a part of
!
\type object-list
!
\object-list ZoneNames
!
!
For each zone, the field "Name" may be referenced
!
by other objects, such as BuildingSurface:Detailed, so it is
!
commented with "\reference ZoneNames"
!
Fields that reference a zone name, such as BuildingSurface:Detailed's
!
"Zone Name", are commented as
!
"\type object-list" and "\object-list ZoneNames"
!
** Note that a field may have multiple \reference commands.
!
** This is useful if the object belongs to a small specific
!
object-list as well as a larger more general object-list.
!
! Object-level comments:
!
! \memo
Memo describing the object. If multiple lines, start each line
!
with \memo.
!
Limit line length to 100 characters.
!
! \unique-object
To flag objects which should appear only once in an idf
!
(this comment has no "value")
!
! \required-object To flag objects which are required in every idf
!
(this comment has no "value")
!
! \min-fields
Minimum number of fields that should be included in the
!
object. If appropriate, the Input Processor will fill
!
any missing fields with defaults (for numeric fields).
!
It will also supply that number of fields to the "get"
!
routines using blanks for alpha fields (note -- blanks
!
may not be allowable for some alpha fields).
!
! \obsolete
This object has been replaced though is kept (and is read)
!
in the current version. Please refer to documentation as
!
to the dispersal of the object. If this object is
9/29/14

Input-Output Reference
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!

IDD Conventions
encountered in an IDF, the InputProcessor will post an
appropriate message to the error file.
usage: \obsolete New=>[New object name]

\extensible:<#> This object is dynamically extensible -- meaning, if you

change the IDD appropriately (if the object has a simple list
structure -- just add items to the list arguments (i.e. BRANCH
LIST). These will be automatically redimensioned and used during
the simulation. <#> should be entered by the developer to signify
how many of the last fields are needed to be extended (and EnergyPlus
will attempt to auto-extend the object). The first field of the first
instance of the extensible field set is marked with \begin-extensible.
\begin-extensible See previous item, marks beginning of extensible fields in
an object.
\format

The object should have a special format when saved in

the IDF Editor with the special format option enabled.
The options include SingleLine, Vertices, CompactSchedule,
FluidProperties, ViewFactors, and Spectral.
The SingleLine option puts all the fields for the object
on a single line. The Vertices option is used in objects
that use X, Y and Z fields to format those three fields
on a single line.
The CompactSchedule formats that specific object.
The FluidProperty option formats long lists of fluid
properties to ten values per line.
The ViewFactor option formats three fields related to
view factors per line.
The Spectral option formats the four fields related to
window glass spectral data per line.

\reference-class-name Adds the name of the class to the reference list

similar to \reference.
Group-level comments:
\group

Name for a group of related objects

Notes on comments
----------------1. If a particular comment is not applicable (such as units, or default)
then simply omit the comment rather than indicating N/A.
2. Memos and notes should be brief (recommend 5 lines or less per block).
More extensive explanations are expected to be in the user documentation

IDD IP Units
In addition, the IDD contains indications of IP (inch-pound) units for the EnergyPlus standard
SI (Systems International) units. These may be used by input and output interfaces to display
values in the IP system. As noted, if the IP units are standard (first block below), then no \ipunits is expected in the field. Note that for some fields due to their multiple use (for
example, schedule values) there cannot be a ip-unit designation.
! Default IP conversions (no \ip-units necessary)
!
$/(m3/s)
=>
$/(ft3/min)
!
$/(W/K)
=>
$/(Btu/h-F)
!
$/kW
=>
$/(kBtuh/h)
!
$/m2
=>
$/ft2
!
$/m3
=>
$/ft3
9/29/14

0.000472000059660808
0.52667614683731
0.293083235638921
0.0928939733269818
0.0283127014102352
6

Input-Output Reference
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
9/29/14

(kg/s)/W
1/K
1/m
A/K
C
cm
cm2
deltaC
deltaJ/kg
g/GJ
g/kg
g/MJ
g/mol
g/m-s
g/m-s-K
GJ
J
J/K
J/kg
J/kg-K
J/kg-K2
J/kg-K3
J/m2-K
J/m3
J/m3-K
K
K/m
kg
kg/J
kg/kg-K
kg/m
kg/m2
kg/m3
kg/m-s
kg/m-s-K
kg/m-s-K2
kg/Pa-s-m2
kg/s
kg/s2
kg/s-m
kJ/kg
kPa
L/day
L/GJ
L/kWh
L/MJ
lux
m
m/hr
m/s
m/s
m/yr
m2
m2/m
m2/person
m2/s
m2-K/W
m3
m3
m3/GJ
m3/hr
m3/hr-m2
m3/hr-person

IDD Conventions
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>

(lbm/sec)/(Btu/hr)
1/F
1/ft
A/F
F
in
inch2
deltaF
deltaBtu/lb
lb/MWh
grains/lb
lb/MWh
lb/mol
lb/ft-s
lb/ft-s-F
ton-hrs
Wh
Btu/F
Btu/lb
Btu/lb-F
Btu/lb-F2
Btu/lb-F3
Btu/ft2-F
Btu/ft3
Btu/ft3-F
R
F/ft
lb
lb/Btu
lb/lb-F
lb/ft
lb/ft2
lb/ft3
lb/ft-s
lb/ft-s-F
lb/ft-s-F2
lb/psi-s-ft2
lb/s
lb/s2
lb/s-ft
Btu/lb
psi
pint/day
gal/kWh
pint/kWh
gal/kWh
foot-candles
ft
ft/hr
ft/min
miles/hr
inch/yr
ft2
ft2/ft
ft2/person
ft2/s
ft2-F-hr/Btu
ft3
gal
ft3/MWh
ft3/hr
ft3/hr-ft2
ft3/hr-person

0.646078115385742
0.555555555555556
0.3048
0.555555555555556
1.8 (plus 32)
0.3937
0.15500031000062
1.8
0.0004299
0.00793664091373665
7
7.93664091373665
0.0022046
0.000671968949659
0.000373574867724868
78.9889415481832
0.000277777777777778
526.565
0.00042986
0.000239005736137667
0.000132889924714692
7.38277359526066E-05
4.89224766847393E-05
2.68096514745308E-05
1.49237004739337E-05
1.8
0.54861322767449
2.2046
2325.83774250441
0.555555555555556
0.67196893069637
0.204794053596664
0.062428
0.67196893069637
0.373316072609094
0.207397818116164
1412.00523459398
2.20462247603796
2.2046
0.67196893069637
0.429925
0.145038
2.11337629827348
0.000951022349025202
2.11337629827348
0.951022349025202
0.092902267
3.28083989501312
3.28083989501312
196.850393700787
2.2369362920544
39.3700787401575
10.7639104167097
3.28083989501312
10.764961
10.7639104167097
5.678263
35.3146667214886
264.172037284185
127.13292
35.3146667214886
3.28083989501312
35.3146667214886
7

Input-Output Reference

IDD Conventions

!
m3/kg
=>
ft3/lb
16.018
!
m3/m2
=>
ft3/ft2
3.28083989501312
!
m3/MJ
=>
ft3/kWh
127.13292
!
m3/person
=>
ft3/person
35.3146667214886
!
m3/s
=>
ft3/min
2118.88000328931
!
m3/s-m
=>
ft3/min-ft
645.89
!
m3/s-m2
=>
ft3/min-ft2
196.85
!
m3/s-person
=>
ft3/min-person
2118.6438
!
m3/s-W
=>
(ft3/min)/(Btu/h)
621.099127332943
!
N-m
=>
lbf-in
8.85074900525547
!
N-s/m2
=>
lbf-s/ft2
0.0208857913669065
!
Pa
=>
psi
0.000145037743897283
!
percent/K
=>
percent/F
0.555555555555556
!
person/m2
=>
person/ft2
0.0928939733269818
!
s/m
=>
s/ft
0.3048
!
V/K
=>
V/F
0.555555555555556
!
W
=>
Btu/h
3.4121412858518
!
W/(m3/s)
=>
W/(ft3/min)
0.0004719475
!
W/K
=>
Btu/h-F
1.89563404769544
!
W/m
=>
Btu/h-ft
1.04072
!
W/m2
=>
Btu/h-ft2
0.316957210776545
!
W/m2
=>
W/ft2
0.09290304
!
W/m2-K
=>
Btu/h-ft2-F
0.176110194261872
!
W/m2-K2
=>
Btu/h-ft2-F2
0.097826
!
W/m-K
=>
Btu-in/h-ft2-F
6.93481276005548
!
W/m-K2
=>
Btu/h-F2-ft
0.321418310071648
!
W/m-K3
=>
Btu/h-F3-ft
0.178565727817582
!
W/person
=>
Btu/h-person
3.4121412858518
!
! Other conversions supported (needs the \ip-units code)
!
!
kPa
=>
inHg
0.29523
!
m
=>
in
39.3700787401575
!
m3/s
=>
gal/min
15850.3222370511
!
Pa
=>
ftH2O
0.00033455
!
Pa
=>
inH2O
0.00401463
!
Pa
=>
inHg
0.00029613
!
Pa
=>
Pa
1
!
W
=>
W
1
!
W/m2
=>
W/m2
1
!
W/m-K
=>
Btu/h-ft-F
0.577796066000163
!
W/person
=>
W/person
1
!
! Units fields that are not translated
!
$
!
1/hr
!
A
!
Ah
!
A/V
!
Availability
!
Control
!
cycles/hr
!
days
!
deg
!
dimensionless
!
eV
!
hr
!
J/J
!
kg/kg
!
kg-H2O/kg-air
!
kmol
!
kmol/s
!
m3/m3
9/29/14

Input-Output Reference

Input Output Descriptions (Document)

!
minutes
!
Mode
!
ms
!
ohms
!
percent
!
ppm
!
rev/min
!
s
!
V
!
VA
!
W/m2 or deg C
!
W/m2, W or deg C
!
W/s
!
W/W
!
years
! **************************************************************************

Input Output Descriptions (Document)

Input Descriptions
In the descriptions below, the fields for each input object will be described but the
Energy+.idd descriptions will not be shown. Refer to the actual Energy+.idd file for complete
specifications. Energy+.idd is a text file that can be viewed with many text editors or word
processors. The Site:Location object will serve as an example.
Site:Location,
\unique-object
\min-fields 5
A1 , \field Name
\required-field
\type alpha
N1 , \field Latitude
\units deg
\minimum -90.0
\maximum +90.0
\default 0.0
\note + is North, - is South, degree minutes represented in decimal (i.e. 30 minutes is .5)
\type real
N2 , \field Longitude
\units deg
\minimum -180.0
\maximum +180.0
\default 0.0
\note - is West, + is East, degree minutes represented in decimal (i.e. 30 minutes is .5)
\type real
N3 , \field Time Zone
\note basic these limits on the WorldTimeZone Map (2003)
\units hr
\minimum -12.0
\maximum +14.0
\default 0.0
\note Time relative to GMT. Decimal hours.
\type real
N4 ; \field Elevation
\units m
\minimum -300.0
\maximum< 8900.0
\default 0.0
\type real

The IDD excerpt above is the complete definition as seen in the IDD file.
First, the object name is given. (Site:Location) This is followed by a comma in both the
definition (IDD) and in an input file (IDF). In fact, all fields except the terminating field of an

9/29/14

Input-Output Reference

Input Output Descriptions (Document)

IDD class object and IDF object are followed by commas. The final field in an IDD class
object or in an IDF object is terminated by a semi-colon.
Next is an alpha field, the location name. As noted above, for input, spaces are significant in
this field. The main inputs for Site:Location are numeric fields. These are numbered (as is the
alpha field) for convenience. The \ designations will show various information about the
objects as described above in the IDD conventions discussion. Of importance for reading this
document are the units and possible minimum and maximum values for a field.
There is automatic processing of the \minimum, \maximum and \default data for numeric
fields. Any infractions of the \minimum, \maximum fields are automatically detected and
messages will appear in the standard error file. After all the input is checked, infractions will
cause program termination (before the bulk of the simulation is completed). Defaults are also
enforced if you leave the numeric field blank.
Some objects need all the parameters listed by the definition; some do not. In the
descriptions that follow, we will try to indicate which parts are optional. Usually, these will be
the last fields in the object input or definition. Even if items are not used for a particular object
(e.g. Multiplier in the FenestrationSurface:Detailed and type=Door), the field must be included
unless it is the last field in the object. So, for this instance, one must include a multiplier field
(must be numeric and would need to obey any \minimum, \maximum rules) for doors.
Two spreadsheet files are included with the installation:
ExampleFiles.xls shows many details about the included example files including
highlights of features.
ExampleFiles-ObjectsLink.xls shows, for each object, the first three occurrences of that
object in an example file.
Output Descriptions
In the descriptions below, we will endeavor to have each objects output displayed as well as
each of the outputs described. The output variables for a run are selected by choosing the
Output:VariableDictionary object. This object displays the available output variables for a run
on the eplusout.rdd (regular variables) and eplusout.mdd (meter variables) files. Two
significant styles are available for these displays and the descriptions below may have one
for some objects and another for other objects. The variables are the same but will look a bit
different. For clarity, the two displays are shown below:
Note that the IDF-Editor can interpret both sets of files and assist you in getting output
variables into your input files. But you will have to successfully run your input file first.
The Simple (or regular) display looks like the following figure and is interpreted:
Zone/HVAC when the output is produced at the Zone timestep (ref: number of timesteps
in each hour) or at the HVAC aka System timestep (which can vary for each hour).
Average/Sum whether this is a averaged value over the reporting period (such as a
temperature or rate) or whether this is a summed value over the reporting period. Reporting
periods are specified in the Output:Variable or Output:Meter objects.
<Variable Name> -- The variable name one uses for reporting is displayed (e.g., Site
Outdoor Drybulb Temperature) along with the units (e.g., [C]).
Example from the eplusout.rdd file:
Zone,Average,Site
Zone,Average,Site
Zone,Average,Site
Zone,Average,Site
Zone,Average,Site
Zone,Average,Site
Zone,Average,Wind
Zone,Average,Site
Zone,Average,Site
HVAC,Sum,Zone Air
9/29/14

Outdoor Air Drybulb Temperature [C]

Outdoor Air Dewpoint Temperature [C]
Outdoor Air Wetbulb Temperature [C]
Outdoor Air Humidity Ratio [kgWater/kgAir]
Outdoor Air Relative Humidity [%]
Outdoor Air Barometric Pressure [Pa]
Speed [m/s]
Wind Direction [deg]
Sky Temperature [C]
System Sensible Heating Energy [J]
10

Input-Output Reference
HVAC,Sum,Zone Air
HVAC,Average,Zone
HVAC,Average,Zone
HVAC,Average,Zone
HVAC,Average,Zone

Group -- Simulation Parameters

System Sensible Cooling Energy [J]
Air System Sensible Heating Rate [W]
Air System Sensible Cooling Rate [W]
Air Temperature [C]
Thermostat Air Temperature [C]

Note that the eplusout.mdd file is similar, but meters are only available at the Zone timestep.
Zone,Meter,Electricity:Facility [J]
Zone,Meter,ExteriorLights:Electricity [J]
Zone,Meter,Grounds Lights:ExteriorLights:Electricity [J]
Zone,Meter,EnergyTransfer:Facility [J]
Zone,Meter,EnergyTransfer:Building [J]
Zone,Meter,EnergyTransfer:Zone:R13WALL WALLS [J]

The IDF display has all the same information in an IDF-ready form (i.e., you could copy and
paste it into your input file using a text editor).
Example from the eplusout.rdd file:
Output:Variable,*,Site
Output:Variable,*,Site
Output:Variable,*,Site
Output:Variable,*,Site
Output:Variable,*,Site
Output:Variable,*,Site
Output:Variable,*,Zone
Output:Variable,*,Zone
Output:Variable,*,Zone
Output:Variable,*,Zone
Output:Variable,*,Zone
Output:Variable,*,Zone

Outdoor Air Drybulb Temperature,hourly; !- Zone Average [C]

Outdoor Air Dewpoint Temperature,hourly; !- Zone Average [C]
Outdoor Air Wetbulb Temperature,hourly; !- Zone Average [C]
Outdoor Air Humidity Ratio,hourly; !- Zone Average [kgWater/kgAir]
Outdoor Air Relative Humidity,hourly; !- Zone Average [%]
Outdoor Air Barometric Pressure,hourly; !- Zone Average [Pa]
Air System Sensible Heating Energy,hourly; !- HVAC Sum [J]
Air System Sensible Cooling Energy,hourly; !- HVAC Sum [J]
Air System Sensible Heating Rate,hourly; !- HVAC Average [W]
Air System Sensible Cooling Rate,hourly; !- HVAC Average [W]
Air Temperature,hourly; !- HVAC Average [C]
Thermostat Air Temperature,hourly; !- HVAC Average [C]

All of the same information appears in a slightly different form and defaults to hourly
reporting frequency (which, of course, can be changed when you put it into your input file).
The * is preselected so that you would be reporting for all those items.

Group -- Simulation Parameters

This group of objects influences the simulation in various ways.
Version
Field: Version Identifier
The Version object allows you to enter the proper version that your IDF was created for. This
is checked against the current version of EnergyPlus and a Severe error issued (nonterminating) if it does not match the current version string. Note that versions are often
significant and there is no guarantee that the older file will run in the newer versions of the
program. See IDF Version Updater (Auxiliary Programs Document) for methods of changing
the older files to newer versions.
Timestep
Field: Number of Timesteps per Hour
The Timestep object specifies the "basic" timestep for the simulation. The value entered here
is usually known as the Zone Timestep. This is used in the Zone Heat Balance Model
calculation as the driving timestep for heat transfer and load calculations. The value entered
here is the number of timesteps to use within an hour. Longer length timesteps have lower
values for Number of Timesteps per Hour. For example a value of 6 entered here directs the
program to use a zone timestep of 10 minutes and a value of 60 means a 1 minute timestep.
The users choice for Number of Timesteps per Hour must be evenly divisible into 60; the
allowable choices are 1, 2, 3, 4, 5, 6, 10, 12, 15, 20, 30, and 60.

9/29/14

11

Input-Output Reference

Group -- Simulation Parameters

The choice made for this field has important implications for modeling accuracy and the
overall time it takes to run a simulation. Here are some considerations when choosing a
value:
The solution technique used in EnergyPlus has been designed to be stable with zone
timesteps of up to sixty minutes (Number Timesteps in Hour = 1). However, 60
minutes is considered a long timestep and it should only be used in rare occasions
where there is no HVAC system, accuracy is not a concern, and short run times are
critical. Such long timesteps are not recommended to use because simulation results
are more accurate for shorter timesteps, of say 10 minutes or less (Number of
Timesteps per Hour of 6 or more). Shorter zone timesteps improve the numerical
solution of the Zone Heat Balance Model because they improve how models for
surface temperature and zone air temperature are coupled together. Longer
timesteps introduce more lag and lead to more a dampened dynamic response.
Simulation run time increases with shorter timesteps or larger values for Number of
Timesteps per Hour. The effect varies with the nature of the model. The user can
test out different values on their particular model to understand the implications for
his or her particular case. Sometimes large models with multizone HVAC and Plant
systems execute nearly as fast with 15 minute timesteps as with 60 minute timesteps
because fewer iterations are required in the system modeling since the prior
timesteps results are close to the final outcome of next timestep.
The weather data files usually have 60-minute (or hourly) data. However, it does not
follow that this should be used as the basis for choosing the zone timestep because:
o EnergyPlus carefully interpolates the weather data between data points for
use at shorter timesteps. This is discussed in a later section: Weather Data
Hourly Interpolation
o Many aspects of a model have time scales that differ from the that of the
weather data. A goal of the modeling is to predict how the building will
respond to the weather. However, the buildings response is not governed
by the time scale that the weather data are available at, but rather the time
scales of the dynamic performance of the thermal envelope as well as things
like schedules for internal gains, thermostats, and equipment availability.
If the model will include calculating the cost of electricity, then the user should be
aware that many electric utility tariffs base charges on demand windows of a
specified length of time. If the choice of Number of Timesteps per Hour is not
consistent with the demand window, then unexpected results may be obtained. For
reasonable prediction of the maximum rates for electricity use for in calculating
demand charges, the length of the zone timestep needs to be consistent with the
tariffs demand window. The following table lists what values are consistent with
various demand windows.
Demand Window

Applicable Number of Timesteps per

Hour

QuarterHour

4, 12, 20, or 60

HalfHour

2, 4, 6, 10, 12, 20, 30, or 60

FullHour, Day, Week

Any

There is also second type of timestep inside EnergyPlus that is known as the System
Timestep. This is a variable-length timestep that governs the driving timestep for HVAC and
Plant system modeling. The user cannot directly control the system timestep (except by use
of the ConvergenceLimits object). When the HVAC portion of the simulation begins its
solution for the current zone timestep, it uses the zone timestep as its maximum length but
then can reduce the timestep, as necessary, to improve the solution. The technical details of
the approach are explained in the Engineering Documentation under "Integrated Solution
Manager".
9/29/14

12

Input-Output Reference

Group -- Simulation Parameters

Users can see the system timestep used if they select the "detailed" frequency option on an
HVAC output variable (e.g. Zone Air Temperature). To contrast, the "Zone" variables will only
be reported on the zone timestep (e.g. Zone Mean Air Temperature).
And, the IDF example:
Timestep, 6;

!Suggested default for most system simulations

Suggested defaults are 4 for non-HVAC simulations, 6 for simulations with HVAC, 20 is the
minimum for ConductionFiniteDifference and HeatAndMoistureFiniteElement simulations.
Green roof (ref: Material:RoofVegetation) also may require more timesteps.
Note that hourly data (such as outdoor conditions expressed by Design Days or Weather data) are
interpolated to the Zone Timestep. This is discussed in a later section: Weather Data Hourly Interpolation

ConvergenceLimits
This item is an advanced feature that should be used only with caution. It is specifically
included to assist some users speed up calculations while not overly compromising
accuracy. The user must judge for him/herself whether the reduced run time is useful.
Field: Minimum System Timestep
Usually the minimum system timestep is allowed to vary from the zone timestep (as
maximum) to a minimum timestep of 1 minute during certain system calculations. This might
be when the system turns on or off, for example. Entering 0 in this field sets the minimum
system timestep to be the same as the zone timestep. Otherwise the units of the field are
minutes. Its probably a good idea to have any minimum entered be a divisor of the zone
timestep.
Field: Maximum HVAC Iterations
The HVAC Manager will iterate to a solution or up to a set number of iterations. If not
converged, then a warning error appears:
SimHVAC: Maximum iterations (20) exceeded for all HVAC loops, at CHICAGO IL USA TMY2-94846 WMO#=725300,
10/07 14:06 - 14:08

In order to reduce time used in simulating your building, you may choose to enter a lesser
number than the default of 20 for the maximum number of iterations to be used. Or, you may
wish to enter a bigger number for certain buildings. To get more information printed with a
max iteration message, you need to enter a Output:Diagnostics, DisplayExtraWarnings;
command (which may also generate other warnings than just this one).
Field: Minimum Plant Iterations
The plant system modeling includes a solver that iterates within a single HVAC manager
iteration. This input field and the next one provide some control over how the plant solver
iterates. This field sets a minimum threshold for plant interations. The default for this field is
the value 2 which indicates that a minimum of two full plant model interations will be
performed every time plant is called by the HVAC manager. For faster performance with
simple plant systems, this input field could be set to the value 1. For complicated plant
systems that present difficulties to solve, this value may need to be set higher to ensure
accuracy but at the expense of speed. Complicated plant systems include those with several
interconnected loops, sizing miss-matches such that plant components are starved of flow
compared to their desired flow, heat recovery systems, and thermal load following onsite
generators.
Field: Maximum Plant Iterations
The plant system solver iterates within a single HVAC manager iteration. This input field and
the previous one provide some control over how the plant model iterates. This field sets a
9/29/14

13

Input-Output Reference

Group -- Simulation Parameters

maximum limit for plant interations. The default for this field is the value 8 which indicates
that the plant solver will exit after having completed eight full iterations. This value can be
raised for better accuracy with complex plants or lowered for faster speed with simple plants.
The output variable called Plant Solver Sub Iteration Count (typically reported at the
detailed frequency) is useful for understanding how many plant solver iterations are actually
being used during a particular simulation. The lower limit of the value for this field is 2.
Use in an IDF:
ConvergenceLimits,
0,
!- Minimum
25,
!- Maximum
3,
!- Minimum
9;
!- Maximum

System Timestep (0=same as zone timestep)

HVAC Iterations
Plant Iterations
Plant Iterations

Building
The Building object describes parameters that are used during the simulation of the building.
There are necessary correlations between the entries for this object and some entries in the
Site:WeatherStation and Site:HeightVariation objects, specifically the Terrain field.
Field: Building Name
Building name is specified for output convenience.
Field: North Axis
The Building North Axis is specified relative to true North. Buildings frequently do not line up
with true north. For convenience, one may enter surfaces in a regular coordinate system
and then shift them via the use of the North Axis. The value is specified in degrees from true
north (clockwise is positive).
The figure below shows how the building north axis can be rotated to correspond with one of
the major axes of an actual building. The relevance of this field is described more completely
under GlobalGeometryRules; in particular, the value of North Axis is ignored if a
coordinate system other than relative is used.

9/29/14

14

Input-Output Reference

Group -- Simulation Parameters

Zone 4
Zone 3

Zone 1
Zone 2
BUILDING
NORTH
o

TRUE
NORTH

15

Figure 1. Illustration of Building North Axis

Field: Terrain
The sites terrain affects how the wind hits the building as does the building height. In
addition, the external conduction method usually has its own parameters for the calculation.
Please see the Engineering Documentation, External Conduction section for particulars. The
legal values for this field are shown in the following table.
Table 1. Values for "Terrain"
Terrain Type
Value

Terrain Description

Country

Flat, Open Country

Suburbs

Rough, Wooded Country, Suburbs

City

Towns, city outskirts, center of large

cities

Ocean

Ocean, Bayou flat country

Urban

Urban, Industrial, Forest

Warmup Convergence
The following two fields along with the minimum and maximum number of warmup days (also
in this object) define the user specified criteria for when EnergyPlus will converge at each
environment (each sizing period or run period set as Yes in the SimulationControl object).
EnergyPlus runs the first day of the environment (starting with a set of hard-coded initial
9/29/14

15

Input-Output Reference

Group -- Simulation Parameters

conditions) until the loads/temperature convergence tolerance values are satisfied (next two
fields) or until it reaches maximum number of warmup days. Note that setting the
convergence tolerance values too loose will cause the program to be satisifed too early and
you may not get the results you expect from the actual simulation.
Field: Loads Convergence Tolerance Value
This value represents the number at which the loads values must agree before
convergence is reached. Loads tolerance value is a fraction of the load.
Field: Temperature Convergence Tolerance Value
This value represents the number at which the zone temperatures must agree (from previous
iteration) before convergence is reached. (Units for this field is delta C).
Convergence of the simultaneous heat balance/HVAC solution is reached when either the
loads or temperature criterion is satisfied.
All tolerances have units so the temperature tolerance is in degrees C (or degrees K) and the
loads tolerance is in Watts. Both tolerances work the same way, just one looks at
temperatures and one looks at heating and cooling loads. After the second warm-up day, the
program compares the maximum temperature experienced in a space with the maximum
temperature from the previous day. If those two temperatures are within the tolerance, then it
has passed the first warm-up check.
It does a similar comparison with lowest temperatures experience within all the zones. If the
current simulation day and the previous day values are within the tolerance, then it has
passed the second warm-up check. Similar things are done with the loads tolerance and the
maximum heating and cooling loads that are experienced within the spaces. Those are
compared individually to the values for the previous day. If they are both in tolerance, then
the simulation has passed the third and fourth warm-up check. The simulation stays in the
warm-up period until ALL FOUR checks have been passed. See Engineering Reference and
Output Details document for further explanation and outputs.
Please note--other "convergence tolerance" inputs are required for certain HVAC equipment
(unit ventilator, unit heater, window AC, etc.). The purpose and units of these parameters are
different from "load convergence tolerance" and "temperature convergence tolerance" in the
BUILDING object.
Field: Solar Distribution
Setting this value determines how EnergyPlus treats beam solar radiation and reflectances
from exterior surfaces that strike the building and, ultimately, enter the zone. There are five
choices:
MinimalShadowing,
FullExterior
and
FullInteriorAndExterior,
FullExteriorWithReflections, FullInteriorAndExteriorWithReflections.
MinimalShadowing
In this case, there is no exterior shadowing except from window and door reveals. All beam
solar radiation entering the zone is assumed to fall on the floor, where it is absorbed
according to the floor's solar absorptance. Any reflected by the floor is added to the
transmitted diffuse radiation, which is assumed to be uniformly distributed on all interior
surfaces. If no floor is present in the zone, the incident beam solar radiation is absorbed on
all interior surfaces according to their absorptances. The zone heat balance is then applied at
each surface and on the zone's air with the absorbed radiation being treated as a flux on the
surface.
FullExterior, FullExteriorWithReflections
In this case, shadow patterns on exterior surfaces caused by detached shading, wings,
overhangs, and exterior surfaces of all zones are computed. As for MinimalShadowing,
shadowing by window and door reveals is also calculated. Beam solar radiation entering the
zone is treated as for MinimalShadowing -- All beam solar radiation entering the zone is
assumed to fall on the floor, where it is absorbed according to the floor's solar absorptance.
Any reflected by the floor is added to the transmitted diffuse radiation, which is assumed to
9/29/14

16

Input-Output Reference

Group -- Simulation Parameters

be uniformly distributed on all interior surfaces. If no floor is present in the zone, the incident
beam solar radiation is absorbed on all interior surfaces according to their absorptances. The
zone heat balance is then applied at each surface and on the zone's air with the absorbed
radiation being treated as a flux on the surface.
FullInteriorAndExterior, FullInteriorAndExteriorWithReflections
This is the same as FullExterior except that instead of assuming all transmitted beam solar
falls on the floor the program calculates the amount of beam radiation falling on each surface
in the zone, including floor, walls and windows, by projecting the sun's rays through the
exterior windows, taking into account the effect of exterior shadowing surfaces and window
shading devices.
If this option is used, you should be sure that the surfaces of the zone totally enclose a
space. This can be determined by viewing the eplusout.dxf file with a program like
AutoDesks Volo View Express. You should also be sure that the zone is convex. Examples
of convex and non-convex zones are shown in Figure 2. The most common non-convex zone
is an L-shaped zone. (A formal definition of convex is that any straight line passing through
the zone intercepts at most two surfaces.) If the zones surfaces do not enclose a space or if
the zone is not convex you should use Solar Distribution = FullExterior instead of
FullInteriorAndExterior.
If you use FullInteriorAndExterior the program will also calculate how much beam radiation
falling on the inside of an exterior window (from other windows in the zone) is absorbed by
the window, how much is reflected back into the zone, and how much is transmitted to the
outside. In this calculation the effect of a shading device, if present, is accounted for.

Convex zones

Non-Convex zones

Figure 2. Illustration of Convex and Non-convex Zones

Reflection calculations
Note: Using the reflection calculations can be very time-consuming. Even error-prone. As a possible
alleviation, you can use the Output:Diagnostics,DoNotMirrorDetachedShading; in many cases to get past a
fatal error.

If using reflections, the program calculates beam and sky solar radiation that is reflected from
exterior surfaces and then strikes the building. These reflecting surfaces fall into three
categories:
1) Shadowing surfaces. These are surfaces like overhangs or neighboring buildings

entered

9/29/14

with

Shading:Site,

Shading:Building,

Shading:Site:Detailed,

17

Input-Output Reference

Group -- Simulation Parameters

Shading:Building:Detailed,
Shading:Overhang,
Shading:Overhang:Projection,
Shading:Fin, Shading:Fin:Projection or Shading:Zone:Detailed objects. See Figure 3.
These surfaces can have diffuse and/or specular (beam-to-beam) reflectance values that
are specified with the ShadingProperty:Reflectance object which specifies those
parameters. They have a default value of .2 for both visible and diffuse reflection.
2) Exterior building surfaces. In this case one section of the building reflects solar

radiation onto another section (and vice-versa). See Figure 4.

The building surfaces are assumed to be diffusely reflecting if they are opaque (walls, for
example) and specularly reflecting if they are windows or glass doors. The reflectance
values for opaque surfaces are calculated by the program from the Solar Absorptance
and Visible Absorptance values of the outer material layer of the surfaces construction
(ref: Material object properties). The reflectance values for windows and glass doors are
calculated by the program from the reflectance properties of the individual glass layers
that make up surfaces construction assuming no shading device is present and taking
into account inter-reflections among the layers (ref: Window Properties).

3) The ground surface. Reflection from the ground is calculated even if reflections option is

not used;l but then the ground plane is considered unobstructed, i.e., the shadowing of
the ground by the building itself or by obstructions such as neighboring buildings is
ignored. Shadowing by the building itself or neighboring buildings is taken into account
when the with reflections option is used but then the view factor to ground is NOT
used. This is shown in Figure 5.

Solar Reflection from Obstructions

Beam

Sky diffuse
Beam
Beam

(a)

(b)

(c)

Figure 3. Solar reflection from shadowing surfaces. Solid arrows are beam solar radiation; dashed arrows
are diffuse solar radiation. (a) Diffuse reflection of beam solar radiation from the top of an overhang. (b)
Diffuse reflection of sky solar radiation from the top of an overhang. (c) Beam-to-beam (specular)
reflection from the faade of an adjacent highly-glazed building represented by a vertical shadowing
surface.

9/29/14

18

Input-Output Reference

Group -- Simulation Parameters

Wall
Window

Figure 4. Solar reflection from building surfaces onto other building surfaces. In this example beam solar
reflects from a vertical section of the building onto a roof section. The reflection from the window is
specular. The reflection from the wall is diffuse.

Beam

Ground

Beam

Ground

Figure 5. Shadowing from building affects beam solar reflection from the ground. Beam-to-diffuse
reflection from the ground onto the building occurs only for sunlit areas, A and C, not from shaded area,
B.
Field: Maximum Number of Warmup Days
This field specifies the number of warmup days that might be used in the simulation before
convergence is achieved. The default number, 25, is usually more than sufficient for this
task; however, some complex buildings (with complex constructions) may require more days.
If you enter less than 25 as a maximum, that is the number of maximum warmup days that
will be used. An error message will occur when the simulation runs out of days and has not
converged:
CheckWarmupConvergence: Loads Initialization, Zone="MAIN ZONE" did not converge after 30 warmup days.
See Warmup Convergence Information in .eio file for details
..Environment(SizingPeriod)="DENVER CENTENNIAL GOLDEN
N ANN CLG 1% CONDNS DB=>MWB"
..Max Temp Comparison = 2.06E-002 vs Temperature Convergence Tolerance=0.50 Pass Convergence
..Min Temp Comparison = 5.95E-003 vs Temperature Convergence Tolerance=0.50 Pass Convergence
..Max Cool Load Comparison = 9.5082E-002 vs Loads Convergence Tolerance=5.00E-002 Fail Convergence

As noted in the message, there will be more information in the .eio file. (Refer to Output
Details document as well for examples.)
You may be able to increase the Maximum Number of Warmup Days and get convergence,
but some anomalous buildings may still not converge. Simulation proceeds for x warmup

9/29/14

19

Input-Output Reference

Group -- Simulation Parameters

days until convergence is reached (see the discussion under the Temperature Convergence
Tolerance Value field in this object, just above).
Field: Minimum Number of Warmup Days
This field specifies the minimum number of warmup days before EnergyPlus will check if it
has achieved convergence and can thus start simulating the particular environment (design
day, annual run) in question. Research into the minimum number of warmup days indicates
that 6 warmup days is generally enough on the minimum end of the spectrum to avoid false
predictions of convergence and thus to produce enough temperature and flux history to start
EnergyPlus simulation. This was based on a study that used the benchmark reference
buildings. It also was observed that convergence performance improved when the number of
warmup days increased. As a result, the default value for the minimum warmup days has
been set to 6. Users should decrease this number only if they have knowledge that a specific
file converges more quickly than 6 days. Users may wish to increase the value in certain
situations when, based on the output variables described in the Output Details document, it is
determined that EnergyPlus has not converged. While this parameter should be less than the
previous parameter, a value greater than the value entered in the field Maximum Number of
Warmup Days above may be used when users wish to increase warmup days more than the
previous field. In this particular case, the previous field will be automatically reset to the value
entered in this field and EnergyPlus will run exactly the number of warmup days specified in
this field.
An example from an IDF:
Building,
PSI HOUSE DORM AND OFFICES, !- Name
36.87000,
!- North Axis {deg}
Suburbs,
!- Terrain
0.04,
!- Loads Convergence Tolerance Value
0.4000000,
!- Temperature Convergence Tolerance Value {deltaC}
FullInteriorAndExterior, !- Solar Distribution
40,
!- Maximum Number of Warmup Days
6;
!- Minimum Number of Warmup Days

SurfaceConvectionAlgorithm:Inside
This input object is used control the choice of models used for surface convection at the
inside face of all the heat transfer surfaces in the model. This object sets the selection for
convection correlations in a global way. The Zone Inside Convection Algorithm input field in
the Zone object may be used to selectively override this value on a zone-by-zone basis.
Further, individual surfaces can refine the choice by each surface or surface lists see
object
SurfaceProperty:ConvectionCoefficients
and
object
SurfaceProperty:ConvectionCoefficients:MultipleSurface.
Field: Algorithm
The model specified in this field is the default algorithm for the inside face all the surfaces..
The key choices are Simple, TARP, CeilingDiffuser, and AdaptiveConvectionAlgorithm.
The Simple model applies constant heat transfer coefficients depending on the surface
orientation.
The TARP model correlates the heat transfer coefficient to the temperature difference for
various orientations. This model is based on flat plate experiments.
The CeilingDiffuser model is a mixed and forced convection model for ceiling diffuser
configurations. The model correlates the heat transfer coefficient to the air change rate for
ceilings, walls and floors. These correlations are based on experiments performed in an
isothermal room with a cold ceiling jet. To avoid discontinuities in surface heat transfer rate
calculations, all of correlations have been extrapolated beyond the lower limit of the data set
(3 ACH) to a natural convection limit that is applied during the hours when the system is off.

9/29/14

20

Input-Output Reference

Group -- Simulation Parameters

The AdaptiveConvectionAlgorithm model is an dynamic algorithm that organizes a large

number of different convection models and automatically selects the one that best applies.
The
adaptive
convection
algorithm
can
also
be
customized
using
the
SurfaceConvectionAlgorithm:Inside:AdaptiveModelSelections input object. These models are
explained in detail in the EnergyPlus Engineering Reference Document.
The default is TARP.
IDF Example:
SurfaceConvectionAlgorithm:Inside,TARP;

SurfaceConvectionAlgorithm:Outside
Various exterior convection models may be selected for global use. The optional Zone
Outside Convection Algorithm input field in the Zone object may be used to selectively
override this value on a zone-by-zone basis. Further, individual surfaces can refine the choice
by each surface or surface lists see object SurfaceProperty:ConvectionCoefficients and
object SurfaceProperty:ConvectionCoefficients:MultipleSurface.
Field: Algorithm
The available key choices are SimpleCombined, TARP, MoWiTT, DOE-2, and
AdaptiveConvectionAlgorithm.
The Simple convection model applies heat transfer coefficients depending on the roughness
and windspeed. This is a combined heat transfer coefficient that includes radiation to sky,
ground, and air. The correlation is based on Figure 1, Page 25.1 (Thermal and Water Vapor
Transmission Data), 2001 ASHRAE Handbook of Fundamentals. Note that if Simple is
chosen here or in the Zone field and a SurfaceProperty:ConvectionCoefficients object
attempts to override the caulcation with a different choice, the action will still be one of
combined calculation. To change this, you must select one of the other methods for the
global default.
All other convection models apply heat transfer coefficients depending on the roughness,
windspeed, and terrain of the buildings location. These are convection only heat transfer
coefficients; radiation heat transfer coefficients are calculated automatically by the program.
The TARP algorithm was developed for the TARP software and combines natural and winddriven convection correlations from laboratory measurements on flat plates.
The DOE-2 and MoWiTT were derived from field measurements. DOE-2 uses a correlation
from measurements by Klems and Yazdanian for rough surfaces. MoWitt uses a correlation
from measurements by Klems and Yazdanian for smooth surfaces and, therefore, is most
appropriate for windows (see SurfaceProperty:ConvectionCoefficients:MultipleSurface for
how to apply to only windows).
The AdaptiveConvectionAlgorithm model is an dynamic algorithm that organizes a large
number of different convection models and automatically selects the one that best applies.
The
adaptive
convection
algorithm
can
also
be
customized
using
the
SurfaceConvectionAlgorithm:Outside:AdaptiveModelSelections input object. All algorithms
are described more fully in the Engineering Reference.
The default is DOE-2.
Note that when the surface is wet (i.e. it is raining and the surface is exposed to wind) then the convection
coefficient appears as a very large number (1000) and the surface is exposed to the Outdoor Wet-bulb
Temperature rather than the Outdoor Dry-bulb Temperature.

IDF Example:
SurfaceConvectionAlgorithm:Outside, AdaptiveConvectionAlgorithm;

9/29/14

21

Input-Output Reference

Group -- Simulation Parameters

HeatBalanceAlgorithm
The HeatBalanceAlgorithm object provides a way to select what type of heat and moisture
transfer algorithm will be used for calculating the performance of the buildings surface
assemblies. This input controls the overall algorithm used for all the surfaces unless one or
more of the SurfaceProperty:HeatTransferAlgorithm:* objects are used to alter the selection
for particular surfaces.
Field: Algorithm
Four values are allowed to select which solution will be used.
The ConductionTransferFunction selection is a sensible heat only solution and does
not take into account moisture storage or diffusion in the construction elements.
The MoisturePenetrationDepthConductionTransferFunction selection is a sensible
heat diffusion and an inside surface moisture storage algorithm that also needs additional
moisture material property information. Sometimes, this is referred to as the Effective
Moisture Penetration Depth or EMPD. See the moisture material property object for
additional information and description of outputs:
MaterialProperty:MoisturePenetrationDepth:Settings
Advanced/Research usage: The ConductionFiniteDifference selection is a sensible
heat only solution and does not take into account moisture storage or diffusion in the
construction elements. This solution technique uses a 1-D finite difference solution in the
construction elements. Outputs for the surfaces are described with the material property
objects. The Conduction Finite Difference (aka CondFD) property objects are:
MaterialProperty:PhaseChange
MaterialProperty:VariableThermalConductivity
Advanced/Research usage: The CombinedHeatAndMoistureFiniteElement is a
coupled heat and moisture transfer and storage solution. The solution technique uses a
one dimensional finite difference solution in the construction elements and requires
further material properties described in the Heat and Moisture Transfer material
properties objects. Outputs from the algorithm are described with these objects. The Heat
and Moisture Transfer property objects are:
MaterialProperty:HeatAndMoistureTransfer:Settings
MaterialProperty:HeatAndMoistureTransfer:SorptionIsotherm
MaterialProperty:HeatAndMoistureTransfer:Suction
MaterialProperty:HeatAndMoistureTransfer:Redistribution
MaterialProperty:HeatAndMoistureTransfer:Diffusion
MaterialProperty:HeatAndMoistureTransfer:ThermalConductivity
Field: Surface Temperature Upper Limit
This field is a bit advanced. It should only be used when the simulation fails AND you
cannot determine a cause for the failure. That is, you receive an error similar to:
** Severe
**
~~~
**
~~~
**
~~~
**
~~~
**
~~~
**
~~~
**
~~~

**
**
**
**
**
**
**
**

Temperature out of bounds (202.91) for surface=Wall1

in Zone=Zone01
Occurrence info=NEW YORK CITY NY SUMMER, 07/21 16:00 - 16:01
A temperature out of bounds problem can be caused by several things. The user
should check the weather environment, the level of internal gains with respect
to the zone, and the thermal properties of their materials among other things.
A common cause is a building with no thermal mass -- all materials with
Regular-R definitions.

And, after careful perusal, you cannot find a solution as suggested in the error description.
You may then want to enter a higher number than the default for this field.

9/29/14

22

Input-Output Reference

Group -- Simulation Parameters

Field: Minimum Surface Convection Heat Transfer Coefficient Value

This optional field is used to set an overall minimum for the value of the coefficient for surface
convection heat transfer (Hc) in W/m2-K. A minimum is necessary for numerical robustness
because some correlations for Hc can result in zero values and create numerical problems.
This field can be used to support specialized validation testing to suppress convection heat
transfer and to investigate the implications of different minimum Hc values. The default is 0.1.
Field: Maximum Surface Convection Heat Transfer Coefficient Value
This optional field is used to set an overall maximum for the value of the coefficient for
surface convection heat transfer (Hc) in W/m2-K. High Hc values are used in EnergyPlus to
approximate fixed surface temperature boundary conditions. This field can be used to alter
the accepted range of user-defined Hc values.
And, a default IDF example
HeatBalanceAlgorithm,ConductionTransferFunction;

! Solution Algorithm

HeatBalanceSettings:ConductionFiniteDifference
This object is used to control the behavior of the Conduction Finite Difference algorithm for
surface heat transfer. The settings are global and affect how the model behaves for all the
surfaces.
Field: Difference Scheme
This field determines the solution scheme used by the Conduction Finite Difference model.
There are two options CrankNicholsonSecondOrder and FullyImplicitFirstOrder. The
CrankNicholsonSecondOrder scheme is second order in time and may be faster. But it can
be unstable over time when boundary conditions change abruptly and severely. The
FullyImplicitFirstOrder scheme is first order in time and is more stable over time. But it may
be slower. The default is FullyImplicitFirstOrder when ConductionFiniteDifference is selected
as the Heat Balance Algorithm.
Field: Space Discretization Constant
This field controls the how the model determines spatial discretization, or the count of nodes
across each material layer in the construction. The model calculates the nominal distance
associated with a node, x , using

Where
is the thermal diffusivity of the material layer, in m 2/s
t is the length of the timestep in seconds.
C is a constant set by this field.
The default is 3. Typical values are from 1 to 3. Lower values for this constant lead to more
nodes and finer-grained space discretization.
Field: Relaxation Factor
The finite difference solver includes under-relaxation for improved stability for interactions
with the other surfaces. This input field can optionally be used to modify the starting value for
the relaxation factor. Larger numbers may solve faster, while smaller numbers may be more
stable. The default is 1.0. If the program detects numerical instability, it may reduce the
value entered here to something lower and more stable.
Field: Inside Face Surface Temperature Convergence Criteria
The surface heat balance model at the inside face has a numerical solver that uses a
convergence parameter for a maximum allowable differences in surface temperature. This
9/29/14

23

Input-Output Reference

Group -- Simulation Parameters

field can optionally be used to modify this convergence criteria. The default value is 0.002
and was selected for stability. Lower values may further increase stability at the expense of
longer runtimes, while higher values may decrease runtimes but lead to possible instabilities.
The units are in degrees Celsius.
An example IDF object follows.
HeatBalanceSettings:ConductionFiniteDifference,
FullyImplicitFirstOrder , !- Difference Scheme
3.0 , !- Space Discretization Constant
1.0,
!- Relaxation Factor
0.002 ;!- Inside Face Surface Temperature Convergence Criteria

ZoneAirHeatBalanceAlgorithm
The ZoneAirHeatBalanceAlgorithm object provides a way to select what type of solution
algorithm will be used to calculate zone air temperatures and humidity ratios. This object is
an optional object. If the default algorithm is used, this object is not required in an input file.
Field: Algorithm
Three choices are allowed to select which solution algorithm will be used. The
ThirdOrderBackwardDifference selection is the default selection and uses the third order
finite difference approximation to solve the zone air energy and moisture balance equations.
The AnalyticalSolution selection uses the integration approach to solve the zone air energy
and moisture balance equations. The EulerMethod selection uses the first order finite
backward difference approximation to solve the zone air energy and moisture balance
equations.
And, a default IDF example is shown below:
ZoneAirHeatBalanceAlgorithm, ThirdOrderBackwardDifference;

!- Algorithm

ZoneAirContaminantBalance
The ZoneAirContaminantBalance object provides a way to select which contaminant type will
be simulated. Although carbon dioxide is not considered as an indoor contaminant but it is

used as an indicator of indoor air quality in buildings. From modeling point of view
EnergyPlus treats carbon dioxide as a type of contaminant. In addition to carbon dioxide, a
generic contaminant type model was also added. This object is optional, only required in the
input data file if the user wishes to model contaminant concentration levels as part of their
simulation.
Field: Carbon Dioxide Concentration
Input is Yes or No. The default is No. If Yes, simulation of carbon dioxide concentration levels
will be performed. If No, simulation of carbon dioxide concentration levels will not be
performed.
Field: Outdoor Carbon Dioxide Schedule Name
This field specifies the name of a schedule that contains outdoor air carbon dioxide level
values in units of ppm. One source of monthly average CO 2 levels in the atmosphere is
available at a NOAA ftpsite as ftp://ftp.cmdl.noaa.gov/ccg/co2/trends/co2_mm_mlo.txt.
Field: Generic Contaminant Concentration
Input is Yes or No. The default is No. If Yes, simulation of generic contaminant concentration
levels will be performed. If No, simulation of generic contaminant concentration levels will not
be performed.

9/29/14

24

Input-Output Reference

Group -- Simulation Parameters

Field: Outdoor Generic Contaminant Schedule Name

This field specifies the name of a schedule that contains outdoor air generic contaminant
level values in units of ppm.
An IDF example:
ZoneAirContaminantBalance,
Yes,
!Outdoor CO2 Schedule,
!Yes,
!Generic Contaminant Schedule;

Carbon Dioxide Concentration

Outdoor Carbon Dioxide Schedule Name
Generic Contaminant Concentration
!- Outdoor Generic Contaminant Schedule Name

Carbon Dioxide Outputs

The following output variables are available when Carbon Dioxide Concentration = Yes.
HVAC,Average,Zone Air CO2 Internal Gain Volume Flow Rate
HVAC,Average,Zone Air CO2 Concentration [ppm]

Zone Air CO2 Concentration [ppm]

This output variable represents the carbon dioxide concentration level in parts per million
(ppm) for each zone. This is calculated and reported from the Correct step in the Zone Air
Contaminant Predictor-Corrector module.
Zone Air CO2 Internal Gain Volume Flow Rate [m3/s]
This is the rate of carbon dioxide added to a zone from all types of sources or sinks, in m 3/s.
Generic Contaminant Outputs
The following output variable is available when Generic Contaminant Concentration = Yes.
HVAC,Average,Zone Generic Air Contaminant Generation Volume Flow Rate [m3/s]
HVAC,Average,Zone Air Generic Air Contaminant Concentration [ppm]

Zone Air Generic Air Contaminant Concentration [ppm]

This output variable represents the generic contaminant concentration level in parts per
million (ppm) for each zone. This is calculated and reported from the Correct step in the Zone
Air Contaminant Predictor-Corrector module.
Zone Generic Air Contaminant Generation Volume Flow Rate [m3/s]
This is the rate of generic air contaminant added (or subtracted) to a zone from all types of
sources or sinks.
ShadowCalculation
This object is used to control some details of EnergyPluss solar, shadowing and daylighting
models. There are two basic methods available for the calculations. In order to speed up the
calculations, shadowing calculations (sun position, etc.) for the default method are performed
over a period of days. Note that this value may be very important for determining the amount
of sun entering your building and by inference the amount of cooling or heating load needed
for maintaining the building. Though termed shadowing calculations, it in affect determines
the sun position for a particular day in a weather file period simulation. (Each design day will
use the date of the design day object). Even though weather file data contains the amount of
solar radiation, the internal calculation of sun position will govern how that affects various
parts of the building. By default, the calculations are done for every 20 days throughout a
weather run period; an average solar position is chosen and the solar factors (such as sunlit
areas of surfaces) remain the same for that number of days. When more integrated

9/29/14

25

Input-Output Reference

Group -- Simulation Parameters

calculations are needed for controlling dynamic windows or shades, a secod method is
available where solar calculations are performed at each zone timestep.
Field: Calculation Method
This field is used to control how the solar, shading, and daylighting models are calculated
with respect to the time of calculations during the simulation. The default and fastest method
is selected using the keyword AverageOverDaysInFrequency. A more detailed and slower
method can be selected using the keyword DetailedTimestepIntegration. The later method is
useful modeling dynamic fenestration and shading surfaces.
Field: Calculation Frequency
This numeric field will cause the shadowing calculations to be done periodically using the
number in the field as the number of days in each period. This field is only used if the default
method AverageOverDaysInFrequency is used in the previous field. Using this field will allow
you to synchronize the shadowing calculations with changes in shading devices. Using the
default of 20 days in each period is the average number of days between significant changes
in solar position angles. For these shadowing calculations, an average (over the time
period) of solar angles, position, equation of time are also used.
Field: Maximum Figures in Shadow Overlap Calculations
This numeric field will allow you to increase the number of figures in shadow overlaps. Due to
the shadowing algorithm, the number of shadows in a figure may grow quite large even with
fairly reasonable looking structures. Of course, the inclusion of more allowed figures will
increase calculation time. Likewise, too few figures may not result in as accurate calculations
as you desire.
Field: Polygon Clipping Algorithm
This is an advanced feature. Prior to V7, the internal polygon clipping method was a special
case of the Weiler-Atherton method. Now, two options are available: SutherlandHodgman
(default) and ConvexWeilerAtherton. Theoretically, Sutherland-Hodgman is a simpler
algorithm but it works well in cases where receiving surfaces (of shadows) are non-convex.
The Weiler-Atherton implementation is only accurate where both casting and receiving
surfaces are convex. Warnings/severe errors are displayed when necessary. More details on
polygon clipping are contained in the Engineering Reference.
Field: Sky Diffuse Modeling Algorithm
Two choices are available here: SimpleSkyDiffuseModeling and DetailedSkyDiffuseModeling.
SimpleSkyDiffuseModeling (default) performs a one-time calculation for sky diffuse
properties. This has implications if you have shadowing surfaces with changing transmittance
(i.e. not all opaque or not all transparent) during the year. The program checks to see if this
might be the case and automatically selects DetailedSkyDiffuseModeling if the shading
transmittance varies. Even if the transmittance doesnt vary and the option for detailed
modeling is used, that option is retained (though it will increase execution time) because you
may be using EMS to vary the transmittance. When the detailed modeling is done, there will
be a warning posted if the Calculation Frequency (above) is > 1.
In general (and you should also read the previous field description), if shadowing surfaces
are used with the transmittance property, the user should be careful to synchronize this
calculation with the scheduled occurrence of the transmittance (if any) (or use 1, which will be
the most accurate but will cause more time in the calculations).
This field applies to the method called AverageOverDaysInFrequency. When the method
called DetailedTimestepIntegration is used the diffuse sky modeling always uses
DetailedSkyDiffuseModeling.
Examples of this object in IDF: (note this object must be unique in an IDF)
ShadowCalculation,AverageOverDaysInFrequency,1;

9/29/14

26

Input-Output Reference

Group -- Simulation Parameters

ShadowCalculation, AverageOverDaysInFrequency, 1, , SutherlandHodgman,

DetailedSkyDiffuseModeling;

Note that the use of 1 in the examples is NOT the same as using
DetailedTimestepIntegration 1 causes daily calculation of the sun position variables but
does not change the shadowing calculations more frequently than daily.
Output:Diagnostics
Sometimes, messages only confuse users especially new users. Likewise, sometimes
certain output variables exist for only a certain condition but some take them at face
value/name. Some features may be very important but under certain instances cause
problems. Thus, we have added the diagnostic output object to be able to turn on or off
certain messages, variables, and features depending on conditions.
Both fields of the Output:Diagnostics command can accept all the applicable keys. More than
one object may be entered.
Field: key1, key2
Allowable choices are:
DisplayAllWarnings use this to get all warnings (except the developer warnings
DisplayZoneAirHeatBalanceOffBalance). This key sets all other display warning values to
on.
DisplayExtraWarnings use this to get all extra warnings. An example of an extra warning
is when a user enters a ceiling height or volume with the Zone object and EnergyPlus
calculates something significantly different based on the entered zone geometry.
DisplayUnusedSchedules use this to have the unused schedules (by name) listed at the
end of the simulation.
DisplayUnusedObjects use this to have unused (orphan) objects (by name) listed at the
end of the simulation.
DisplayAdvancedReportVariables use this to be able to use certain advanced output
variables where the name may be misleading and you need to understand the concepts or
reasons for use. If you put in this field, then you will be able to report on these features. They
are noted in the descriptions of objects or output variables.
DisplayZoneAirHeatBalanceOffBalance this is a developer diagnostic which you can turn
on, if you desire.
DoNotMirrorDetachedShading use this to turn off the automatic mirroring of detached
shading surfaces. These surfaces are automatically mirrored so that the user does not need
to worry about facing direction of the surface and the shading surface will shade the building
as appropriate. Note that Shading:Zone:Detailed surfaces are also mirrored and there is no
way to turn that off.
DisplayWeatherMissingDataWarnings use this to turn on the missing data warnings from
the read of the weather file.
ReportDuringWarmup use this to allow reporting during warmup days. This can show you
exactly how your facility is converging (or not) during the initial warmup days of the
simulation. Generally, only developers or expert simulation users would need this kind of
detail.
ReportDetailedWarmupConvergence use this to produce detailed reporting (essentially
each warmup day for each zone) for warmup convergence.
In IDF use:
Output:Diagnostics,
DisplayExtraWarnings;

9/29/14

27

Input-Output Reference

Group -- Simulation Parameters

Output:DebuggingData
There may be times when a particular input file requires additional debugging. The
Output:DebuggingData object may be used to report all available node data (e.g.,
temperature, mass flow rate, set point, pressure, etc.). The debug data is reported to the
DBG text file. The debug file first reports the node number and name, and then all available
node information for each zone time step (Ref. Timestep).
The 2 fields of the Output:DebuggingData object can accept either a 1 (turn on) or any other
value (turn off). Only one object may be entered.
Field: Report Debugging Data
This field turns on debug reporting when a value of 1 is entered. Any other value (usually 0)
disables debug reporting.
Field: Report During Warmup
This field allows the debug data to be reported during the warmup period. When a value of 1
is entered the data is reported at all times, even during warmup. Any other value (usually 0)
disables reporting at all time and debug data is only reported for each environment
(RunPeriod or SizingPeriod:DesignDay).
In IDF use:
Output:DebuggingData,
1,1;

Output:PreprocessorMessage
The Output:PreprocessorMessage object can be used by preprocessor programs to
EnergyPlus for passing certain conditions/errors that might not be detected by scripts
executing the EnergyPlus system of programs. This allows EnergyPlus to intercept problems
and terminate gracefully rather than the user having to track down the exact conditions.
There is no reason for a user to enter an Output:PreprocessorMessage object but you should
encourage
interface
developers
to
use
this
feature.
More
than
one
Output:PreprocessorMessage objects may be entered. Of course, no preprocessor message
objects are necessary if there is no error information to be passed.
Field: Preprocessor Name
The preprocessor name (e.g. EPMacro, ExpandObjects) is entered here. Case is retained so
that messages from EnergyPlus look very similar to what a preprocessor would produce.
Field: Error Severity
This is the error severity. If Fatal, EnergyPlus will terminate after showing all preprocessor
messages.
Fields: Message Line 1 through Message Line 10
Each line is limited to 100 characters and an appropriate message can be composed.
An IDF Example:
Output:PreprocessorMessage,
No Preprocessor Used,
!Information,
!Illustrative Message,
!No problems for processing;

preprocessor name
error severity
message line 1
!- message line 2

And would appear in output:

Preprocessor="No Preprocessor Used" has the following Information messages:
Illustrative Message
No problems for processing

9/29/14

28

Input-Output Reference

Group -- Simulation Parameters

ZoneCapacitanceMultiplier:ResearchSpecial
This object is an advanced feature that can be used to control the effective storage capacity
of the zone. Capacitance multipliers of 1.0 indicate the capacitance is that of the (moist) air
in the volume of the specified zone. This multiplier can be increased if the zone air
capacitance needs to be increased for stability of the simulation or to allow modeling higher
or lower levels of damping of behavior over time. The multipliers are applied to the base
value corresponding to the total capacitance for the zones volume of air at current zone
(moist) conditions.
Field: Sensible Heat Capacity Multiplier
This field is used to alter the effective heat capacitance of the zone air volume. This affects
the transient calculations of zone air temperature. Values greater than 1.0 have the effect of
smoothing or damping the rate of change in the temperature of zone air from timestep to
timestep. Note that sensible heat capacity can also be modeled using internal mass
surfaces.
Field: Humidity Capacity Multiplier
This field is used to alter the effective moisture capacitance of the zone air volume. This
affects the transient calculations of zone air humidity ratio. Values greater than 1.0 have the
effect of smoothing, or damping, the rate of change in the water content of zone air from
timestep to timestep.
Field: Carbon Dioxide Capacity Multiplier
This field is used to alter the effective carbon dioxide capacitance of the zone air volume.
This affects the transient calculations of zone air carbon dioxide concentration. Values
greater than 1.0 have the effect of smoothing or damping the rate of change in the carbon
dioxide level of zone air from timestep to timestep.
Field: Generic Contaminant Capacity Multiplier
This field is used to alter the effective generic contaminant capacitance of the zone air
volume. This affects the transient calculations of zone air generic contaminant concentration.
Values greater than 1.0 have the effect of smoothing or damping the rate of change in the
generic contaminant level of zone air from timestep to timestep.
SimulationControl
The input for SimulationControl allows the user to specify what kind of calculations a given
EnergyPlus simulation will perform. For instance the user may want to perform one or more
of the sizing calculations but not proceed to an annual weather file simulation. Or the user
might have all flow rates and equipment sizes already specified and desire an annual
weather without any preceding sizing calculations. Sizing runs, even for large projects, are
quickly run they do not add much to the overall simulation time. The SimulationControl input
allows all permutations of run selection by means of 5 yes/no inputs.
Only one SimulationControl object is permitted for each EnergyPlus input file. While a SimulationControl is
needed to trigger sizing calculations, it is optional for other runs (design days, run periods). The actions will
still be shown in the eplusout.eio file (see Output Details and Examples Document).

Field: Do Zone Sizing Calculation

Input is Yes or No. The default is No. Zone Sizing (see Sizing:Zone object) performs a
special calculation, using a theoretical ideal zonal system, and determines the zone design
heating and cooling flow rates and loads, saving the results in the zone sizing arrays.

9/29/14

29

Input-Output Reference

Group -- Simulation Parameters

Field: Do System Sizing Calculation

Input is Yes or No. The default is No. System Sizing (see Sizing:System object) also
performs a special calculation that, to oversimplify, sums up the results of the zone sizing
calculation and saves the results in the system sizing arrays for reporting on component size
requirements. Thus, in order to perform the system sizing calculations, the zone sizing arrays
need to be filled and hence the zone sizing calculations must be performed in the same run.
(This requirement is enforced by the program).
Field: Do Plant Sizing Calculation
Input is Yes or No. The default is No. Unlike Zone and System Sizing, Plant Sizing does not
use the Zone or System sizing arrays. Plant Sizing uses the Sizing:Plant object fields and
data on the maximum component flow rates. The data on component (such as coil) flow rates
is saved and made available to the Plant code whether or not component autosizing is
performed and whether or not zone sizing and/or system sizing is performed. Therefore, you
can specify Plant Sizing without also specifying to do Zone Sizing or System Sizing
calculations.
Field: Run Simulation for Sizing Periods
Input is Yes or No. The default is Yes. Yes implies that the simulation will be run on all the
included SizingPeriod objects (i.e., SizingPeriod:DesignDay, SizingPeriod:WeatherFileDays,
and SizingPeriod:WeatherFileConditionType). Note that each SizingPeriod object constitutes
an environment and warmup convergence (see earlier topic under the Building object) will
occur for each.
Field: Run Simulation for Weather File Run Periods
Input is Yes or No. The default is Yes. Yes implies the simulation will be run on all the
included RunPeriod objects. Note that each RunPeriod object constitutes an environment
and warmup convergence (see earlier topic under the Building object) will occur for each.
An IDF example:
SimulationControl,
No,
No,
No,
Yes,
Yes;

!!!!!-

Do Zone Sizing Calculation

Do System Sizing Calculation
Do Plant Sizing Calculation
Run Simulation for Sizing Periods
Run Simulation for Weather File Run Periods

ProgramControl
The ProgramControl object can be used to control how the EnergyPlus program executes on
the computer. Portions of EnergyPlus have been programmed to use more than one
processor, or CPU core, at the same time during a single simulation. This multithreading
may not be desireable when running more than one simulation at a time on the same
computer (because it can actually run more slowly). This input object is optional and allows
controlling the number of threads (or cores, or processors) that EnergyPlus will use so that
conflicts can be managed. When this object is used, its input for the number of threads will
take precedent over the value of the environment variable EP_OMP_NUM_THREADS which
is an alternate method of controlling the programs threading. Since the primary method for
OpenMP simulations currently (V7.1 and V7.2) is the interior radiant exchange to solve for
inside surface temperatures, EnergyPlus sets the threads to 1 if the nominal number of
surfaces is <= 30.
Field: Number of Threads Allowed
This field is used to specify a limit on the number of threads EnergyPlus will use. If a zero is
entered then the program will set the number of threads to the maximum available on the

9/29/14

30

Input-Output Reference

Group -- Simulation Parameters

computer. If the number entered is larger than the number of processors or cores, then the
hardware limits will take precedent over this limit.
An example IDF object that sets the program to use only one thread follows.
ProgramControl,
1 ; !- Number of Threads Allowed

Meter:Custom
A custom meter allows the user to group variables or meters onto a virtual meter that can be
used just like a normal meter created by EnergyPlus. For consistency, the items being
grouped must all be similar.
Field: Name
This is a user defined name for the custom meter. Names for custom meters cannot duplicate
internal meter names.
Field: Fuel Type
A fuel type should be specified for the meter. All assignments to this meter will be checked to
assure that the same fuel type is used. Additionally, this may be used in other objects (such
as the Demand Limiting). Valid choices for this field are:
Electricity
NaturalGas
PropaneGas
FuelOil#1
FuelOil#2
Coal
Diesel
Gasoline
Water
Generic
OtherFuel1
OtherFuel2
Fuel types are generally self-explanatory. Generic is included for convenience when a
custom meter is defined that doesnt quite fit the fuel categories. See the examples below.
Field: group(s) Key Name-Output Variable/Meter Name
The rest of the object is filled with parameters of the key name/output variable or meter
names. When a meter name is used, the key name field is left blank.
Field: Key Name #
A key name field is used when the following field specifies an output variable. If the field is left
blank, then all the output variables in the following field are assigned to the meter.
Field: Output Variable or Meter Name #
This field must be a valid output variable name or a valid meter name.
Meter:CustomDecrement
The decrement custom meter is very similar to the custom meter specification but additionally
allows a predefined meter to be used as the source meter and the remaining items subtract
from that predefined meter.

9/29/14

31

Input-Output Reference

Group -- Simulation Parameters

Field: Name
This is a user defined name for the custom meter. Names for custom meters cannot duplicate
internal meter names.
Field: Fuel Type
A fuel type should be specified for the meter. All assignments to this meter will be checked to
assure that the same fuel type is used. Additionally, this may be used in other objects (such
as the Demand Limiting). Valid choices for this field are:
Electricity
NaturalGas
PropaneGas
FuelOil#1
FuelOil#2
Coal
Diesel
Gasoline
Water
Generic
OtherFuel1
OtherFuel2
Field: Source Meter Name
This name specifies the meter that will be used as the main source for the decrement custom
meter. The remainder of the fields are subtracted from the value of this meter to create the
meter value named above. The Source Meter is not changed in any way by including this
custom meter.
Field: group(s) Key Name-Output Variable/Meter Name
The rest of the object is filled with parameters of the key name/output variable or meter
names. When a meter name is used, the key name field is left blank.
Field: Key Name #
A key name field is used when the following field specifies an output variable. If the field is left
blank, then all the output variables in the following field are assigned to the meter.
Field: Output Variable or Meter Name #
This field must be a valid output variable name or a valid meter name. Additionally, it must be
contained on the Source Meter. Note that, if an error occurs, only the Variable in error will
show confusing things if what was entered was a meter name.
Custom Meter Examples
Details of the Meter:Custom/Meter:CustomDecrement are shown on the Meter Details file.
In the following examples, the custom meters are set up to illustrate the capabilities of custom
meters. Custom meter MyGeneralLights duplicates the InteriorLights:Electricity meter.
Custom meter MyBuildingElectric duplicates the Electricity:Building meter (by specifying
that meter). Custom Meter (Decrement) MyBuildingOther uses the Electricity:Building
meter as the source meter and subtracts out the values for MyGeneralLights (aka
InteriorLights:Electricity). The resultant value for the MyBuildingOther meter should be equal
to the value for the meters Electricity:Building InteriorLights:Electricity.
Meter:Custom,
9/29/14

32

Input-Output Reference
MyGeneralLights,
Electricity,
SPACE1-1,
Lights Electric Energy,
SPACE2-1,
Lights Electric Energy,
SPACE3-1,
Lights Electric Energy,
SPACE4-1,
Lights Electric Energy,
SPACE5-1,
Lights Electric Energy;

Group Compliance Objects

!!!!!!!!!!!!-

Name
Fuel Type
Key Name 1
Output Variable
Key Name 2
Output Variable
Key Name 3
Output Variable
Key Name 4
Output Variable
Key Name 5
Output Variable

Meter:Custom,
MyBuildingElectric,
Electricity,
,
Electricity:Building;

!!!!-

Name
Fuel Type
Key Name #1
Output Variable or Meter Name #1

Meter:CustomDecrement,
MyBuildingOther,
Electricity,
Electricity:Building,
,
MyGeneralLights;

!!!!!-

Name
Fuel Type
Source Meter Name
Key Name #1
Output Variable or Meter Name #1

or Meter Name 1
or Meter Name 2
or Meter Name 3
or Meter Name 4
or Meter Name 5

For an example of generic fuel type, one might put the Building Infiltration Heat Loss & Heat
Gain on a set of custom meters:
Meter:Custom,
Building Infiltration Heat Loss, !- Name
Generic,
!- Fuel Type
*,
!- Key Name 1
Zone Infiltration Total Heat Loss Energy;

!- Output Variable Name 1

Meter:Custom,
Building Infiltration Heat Gain, !- Name
Generic,
!- Fuel Type
*,
!- Key Name 1
Zone Infiltration Total Heat Gain Energy;

!- Output Variable Name 1

One can then report these values the same way one reports other standard meters.
Simulation Parameter Outputs
These appear in the eplusout.eio file. For details of the reporting, please see the Output
Details and Examples document.

Group Compliance Objects

Not necessarily related directly to simulation, the Compliance Object group provides a
repository for a group of objects that can be used directly or indirectly in reporting compliance
(such as ASHRAE 90.1) to building standards.
Compliance:Building
The Compliance:Building object describes parameters related to compliance to building
standards, building codes, and beyond energy code programs.

9/29/14

33

Input-Output Reference

Group -- Location Climate Weather File Access

Field: Building Rotation for Appendix G

Building Rotation for Appendix G allows for the building model to be rotated for use with
compliance such as ASHRAE 90.1 Appendix G. Appendix G requires the building to be
rotated 0, 90, 180 and 270 degrees and the values averaged to establish baseline energy
use. This input works with relative or world coordinate systems.
An example from an IDF:
Compliance:Building,
90;

Building Rotation for Appendix G

Group -- Location Climate Weather File Access

This group of objects describes the ambient conditions for the simulation.
Site:Location
The location class describes the parameters for the buildings location. Only one location is
allowed. Weather data file location, if it exists, will override any location data in the IDF. Thus,
for an annual simulation, a Location does not need to be entered.
Field: Name
This alpha field is used as an identifying field in output reports.
Field: Latitude
This field represents the latitude (in degrees) of the facility. By convention, North Latitude is
represented as positive; South Latitude as negative. Minutes should be represented in
decimal fractions of 60. (15 is 15/60 or .25)
Field: Longitude
This field represents the longitude (in degrees) of the facility. By convention, East Longitude
is represented as positive; West Longitude as negative. Minutes should be represented in
decimal fractions of 60. (15 is 15/60 or .25)
Field: Time Zone
This field represents the time zone of the facility (relative to Greenwich Mean Time or the 0 th
meridian). Time zones west of GMT (e.g. North America) are represented as negative; east
of GMT as positive. Non-whole hours can be represented in decimal (e.g. 6:30 is 6.5).
Field: Elevation
This field represents the elevation of the facility in meters (relative to sea level).
Units with their abbreviations are shown in Appendix A. And, as shown in an IDF:
Site:Location,
39.75000
-104.8700
-7.000000
1610.26;

DENVER COLORADO,
! Name
,
! Latitude {N+ S-}
,
! Longitude {W- E+}
,
! TimeZoneNumber {GMT+/-}
! Elevation {m}

Most examples in this document include the comment lines that illustrate each data fields
value. However, this is not necessary (though it makes the IDF more readable). The previous
example could also be:
Site:Location, DENVER COLORADO,39.75,-104.87,-7,1610.26;

SizingPeriod:DesignDay
The design day input describes the parameters to effect a design day simulation, often used
for load calculations or sizing equipment. Using the values in these fields, EnergyPlus
9/29/14

34

Input-Output Reference

Group -- Location Climate Weather File Access

creates a complete days worth of weather data (air temperatures, solar radiation, etc.)
Normal operation uses the default range multipliers as shown in Figure 6 though users may
choose to input their own multiplier schedule. Likewise, normal operation specifies one
humidity indicating condition which is used to calculate the humidity ratio at maximum
temperature this is used as the constant humidity ratio for the entire day. Again, this can be
overridden by specifying a relative humidity schedule or requesting generation of an hourly
wet-bulb temperature profile. Multiple design days may be specified.
We refer you to the ASHRAE Handbook of Fundamentals for philosophy of what parameters
are important for use as design conditions in sizing equipment.
In the install, the design day files are included for the weather file locations that are included
(weatherdata folder). All the design day definitions from the ASHRAE design conditions (latest publication
date) are included, grouped by WMO region, on the main web site with the weather data.
http://www.energyplus.gov/cfm/weather_data.cfm These files are in macro form but it is easy to cut and
paste the appropriate definition segments. These files include the location information as well as some
locations have RunPeriodControl:DaylightSavingTime objects.

Field: Name
This field, like the location name, is used simply for reporting and identification. This name
must be unique among the SizingPeriod names entered.
Field: Month
This numeric field specifies the month. That, in conjunction with the day of the month and
location information, determines the current solar position and solar radiation values for each
hour of the day.
Field: Day of Month
This numeric field specifies the day of the month. That, in conjunction with the month and
location information, determines the current solar position and solar radiation values for each
hour of the day.
Field: Day Type
This alpha field specifies the day type for the design day. This value indicates which day
profile to use in schedules. For further information, see the Schedule discussion later in this
document. (ref: Schedule) Note that two of the possible day types are SummerDesignDay
(for cooling) and WinterDesignDay (for heating) allowing the user to customize schedules
for the design conditions. That is, for design days tagged with a SummerDesignDay type, you
can set schedules to be worst or typical schedules for a cooling season.
Field: Maximum Dry-Bulb Temperature
This numeric field should contain the days maximum dry-bulb temperature in degrees
Celsius. (Reference Appendix A of this document for EnergyPlus standard units and
abbreviations). The MacroDataSets design day files show extreme temperature for locations
as indicated in the ASHRAE HOF design condition tables.
Field: Daily Dry-bulb Temperature Range
A design day can have a high temperature and a low temperature (or can be a constant
temperature for each hour of the day). If there is a difference between high and low
temperatures, this field should contain the difference from the high to the low. EnergyPlus, by
default, distributes this range over the 24 hours in the day as shown in the figure below:

9/29/14

35

Input-Output Reference

Group -- Location Climate Weather File Access

Daily Range Multipliers

1.2

Multiplier Value

1
0.8
0.6
0.4
0.2

AM

PM

0
12
:0

PM

0
11
:0

PM

0
10
:0

PM

00
9:

PM

00
8:

PM

00
7:

PM

00
6:

PM

00
5:

PM

00
4:

PM

00
3:

2:

00

PM

PM

00
1:

AM

12
:0

AM

0
11
:0

AM

0
10
:0

AM

00
9:

AM

00
8:

AM

00
7:

AM

00
6:

AM

00
5:

AM

00
4:

AM

00
3:

00
2:

1:

00

AM

Figure 6. Default Daily range Multiplier for Design Days

The multipliers are taken from the ASHRAE 2009 HOF. More explicitly, EnergyPlus creates
an air temperature for each timestep by using the entered maximum dry-bulb temperature in
conjunction with the entered daily range and the above multiplier values. The actual equation
used is shown below:

Tcurrent

TMax Trange TMultiplier

where
Tcurrent= Air temperature of current Hour of Day
TMax= User supplied Max Dry-bulb Temperature
Trange= User supplied Daily Temperature Range
TMultiplier= Range multiplier as shown on the above graph
The range multiplier values represent typical conditions of diurnal temperatures (i.e. the low
temperature for the day occurring about 5:00 AM and the maximum temperature for the day
occurring about 3:00 PM. Note that EnergyPlus does not shift the profile based on the time
of solar noon as is optionally allowed in ASHRAE procedures.
ASHRAE research indicates that dry-bulb and wet-bulb temperatures typically follow the
same profile, so EnergyPlus can use the default profile to generate humidity conditions (see
Humidity Indicating Type = WetBulbProfileDefaultMultipliers below).
Field: Dry-Bulb Temperature Range Modifier Type
If you are happy with lows at 5am and highs at 3pm, you can ignore this field. If you want to
specify your own temperature range multipliers (see earlier discussion at the Temperature
Range field description), you can specify a type here and create a day schedule which you
reference in the next field.
If you specify MultiplierSchedule in this field, then you need to create a day schedule that
specifies a multiplier applied to the temperature range field (above) to create the proper drybulb temperature range profile for your design day.
If you specify DifferenceSchedule in this field, then you need to create a day schedule that
specifies a number to be subtracted from dry-bulb maximum temperature for each timestep
in the day. Note that numbers in the delta schedules cannot be negative as that would result
in a higher maximum than the maximum previously specified.
If you specify TemperatureProfileSchedule in this field, then you need to create a day
schedule that specifies the actual dry-bulb temperatures throughout the day. You will not
need to include a Maximum Dry-Bulb Temperature in that field.
9/29/14

36

Input-Output Reference

Group -- Location Climate Weather File Access

If you leave this field blank or enter DefaultMultipliers, then the default multipliers will be
used as shown in the temperature range field above.
Field: Dry-Bulb Temperature Range Modifier Day Schedule Name
This field is the name of a day schedule (ref. Schedule:Day:Hourly, Schedule:Day:Interval,
Schedule:Day:List objects) with the values as specified in the Dry-Bulb Temperature Range
Modifier Type field above.
Field: Humidity Condition Type
The values/schedules indicated here and in subsequent fields create the humidity values in
the 24 hour design day conditions profile. Valid choices here are: WetBulb, Dewpoint,
WetBulbProfileDefaultMultipliers,
WetBulbProfileDifferenceSchedule,
WetBulbProfileMultiplierSchedule, HumidityRatio, Enthalpy, and Schedule.
The Humidity Condition Type fields have interacting uses and units, summarized as follows:
Table 2. Humidity Indicating Field Interactions - Design Day
Humidity Condition Type

Primary
Humidity
Indicating Field

Humidity Indicating
Day Schedule

WetBulb

Wetbulb or
DewPoint at
Maximum DryBulb

N/A (unused)

DewPoint

Wetbulb or
DewPoint at
Maximum DryBulb

N/A (unused)

HumidityRatio

Humidity Ratio
at Maximum
Dry-Bulb

N/A (unused)

Enthalpy

Enthalpy at
Maximum DryBulb

N/A (unused)

WetBulbProfileDefaultMultipliers

Wetbulb or
DewPoint at
Maximum DryBulb

N/A (unused)

WetBulbProfileMultiplierSchedule

Wetbulb or
DewPoint at
Maximum DryBulb

Fractions of wet-bulb
daily range (0 1)

WetBulbProfileDifferenceSchedule

Wetbulb or
DewPoint at
Maximum DryBulb

Difference between
maximum and
hour/timestep wet-bulb
temperature, C

RelativeHumiditySchedule

N/A

Relative humidity (%, 0

100)

Humidity conditions over the day are derived as follows:

WetBulb, DewPoint, HumidityRatio, or Enthalpy:
9/29/14

37

Input-Output Reference

Group -- Location Climate Weather File Access

These four methods assume constant absolute humidity over the day. Calculate W =
humidity ratio at Maximum Dry-Bulb Temperature and Humidity Indicating Conditions. Derive
hourly/timestep humidity conditions from W and hour/timestep dry-bulb temperature.
WetBulbProfileDefaultMultipliers
Generate the wet-bulb temperature profile using Default Daily Range Multiplier for Design
Days (shown in Figure 6 above) and Daily Wet-Bulb Temperature Range (below). This
method is analogous to DefaultMultiplier generation of the dry-bulb temperature profile and is
the procedure recommended in Chapter 14 of ASHRAE 2009 HOF.
WetBulbProfileMultiplierSchedule
Generate the wet-bulb profile using multipliers from the Humidity Indicating Day Schedule
and Daily Wet-Bulb Temperature Range (below). Analogous to dry-bulb MultiplierSchedule.
WetBulbProfileDifferenceSchedule
Generate the wet-bulb profile by subtracting Humidity Indicating Day Schedule values from
the daily maximum wet-bulb temperature (specified in Humidity Indicating Conditions at
Maximum Dry-Bulb). Analogous to dry-bulb DifferenceSchedule.
RelativeHumiditySchedule
Hourly relative humidity is specified in Humidity Indicating Day Schedule.
In all cases, the humidity ratio is limited to saturation at the hour/timestep dry-bulb (that is, the
dry-bulb temperature is used as specified, but the humidity ratio is modified as needed to be
physically possible). Once a valid air state is determined, a complete set of consistent
hour/timestep psychrometric values (dewpoint, wet-bulb, and enthalpy) is derived.
Field: Wetbulb or DewPoint at Maximum Dry-Bulb
If you choose Wetbulb or Dewpoint in the Humidity Condition Type field, then this numeric
field should contain that value. Note that this field is unnecessary when you put in a humidity
indicating day schedule (described later in this section).
Field: Humidity Condition Day Schedule Name
Allows specification a day schedule (ref. Schedule:Day:Hourly, Schedule:Day:Interval,
Schedule:Day:List objects) of values for relative humidity or wet-bulb profile per Humidity
Indicating Type field.
Field: Humidity Ratio at Maximum Dry-Bulb
If HumidityRatio is chosen for the Humidity Condition Type field, then this numeric field
should contain the desired humidity ratio at maximum dry-bulb temperature (units kg Water /
kg Dry Air).
Field: Enthalpy at Maximum Dry-Bulb
If Enthalpy is chosen for the Humidity Condition Type field, then this numeric field should
contain the desired enthalpy at maximum dry-bulb temperature (units Joules /kg).
Field: Daily Wet-Bulb Temperature Range
The difference between the maximum and minimum wet-bulb temperatures on the design
day (Celsius). Used for generating daily profiles of humidity conditions when Humidity
Condition
Type
field
(above)
is
WetBulbProfileDefaultMultipliers
or
WetBulbProfileMultiplierSchedule. Values for wet-bulb temperature range are tabulated
by month for 5564 locations worldwide on the CD that accompanies the ASHRAE 2009 HOF.
Field: Barometric Pressure
This numeric field is the constant barometric pressure (Pascals) for the entire day.

9/29/14

38

Input-Output Reference

Group -- Location Climate Weather File Access

Field: Wind Speed

This numeric field is the wind speed in meters/second (constant throughout the day) for the
day. The MacroDataSets design day files includes wind speed values (99.6% - heating, 1%
cooling) as indicated in ASHRAE HOF design condition tables. But, you should be aware that
traditional values for these are 6.7056 m/s (15 mph) for heating and 3.3528 m/s (7 mph) for
cooling. A reminder is shown in the comments for the wind speed values. The comments also
note the extreme wind speeds from the ASHRAE tables.
Field: Wind Direction
This numeric field is the source wind direction in degrees. By convention, winds from the
North would have a value of 0., from the East a value of 90.
Field: Rain Indicator
This field indicates whether or not the building surfaces are wet. If the value is Yes, then it is
assumed that the building surfaces are wet. Wet surfaces may change the conduction of heat
through the surface.
Field: Snow Indicator
This field indicates whether or not there is snow on the ground. If the value is Yes, then it is
assumed there is snow on the ground. Snow on the ground changes the ground reflectance
properties.
Field: Daylight Saving Time Indicator
This field specifies whether to consider this day to be a Daylight Saving Day. Yes in the field
indicates that daylight saving time is operational for this day. Yes essentially adds 1 hour to
the scheduling times used in items with schedules.
Field: Solar Model Indicator
This field allows the user to select ASHRAEClearSky, ASHRAETau, ZhangHuang, or
Schedule for solar modeling in the calculation of the solar radiation in the design day.
ASHRAEClearSky and ZhangHuang use the Clearness value as part of their calculations.
ASHRAETau invokes the revised model specified in Chapter 14 of the ASHRAE 2009 HOF
and uses Taub and Taud values (below). Technical details of the models are described in
the Engineering Reference. The Schedule choice allows you to enter schedule values for
the days profile (use the next two fields for the names).
Field: Beam Solar Day Schedule Name
This field allows the option for you to put in your own day profile of beam solar values
(wh/m2). These values will replace the calculated values during design day processing. Only
day schedules (ref. Schedule:Day:Hourly, Schedule:Day:Interval, Schedule:Day:List objects)
are used here.
Field: Diffuse Solar Day Schedule Name
This field allows the option for you to put in your own day profile of diffuse solar values
(wh/m2). These values will replace the calculated values during design day processing. Only
day schedules (ref. Schedule:Day:Hourly, Schedule:Day:Interval, Schedule:Day:List objects)
are used here.
Field: ASHRAE Clear Sky Optical Depth for Beam Irradiance (taub)
Optical depth for beam radiation, used only when Solar Model Indicator is ASHRAETau. See
next field.

9/29/14

39

Input-Output Reference

Group -- Location Climate Weather File Access

Field: ASHRAE Clear Sky Optical Depth for Diffuse Irradiance (taud)
Optical depth for diffuse radiation, used only when Solar Model Indicator is ASHRAETau.
Taub and Taud values are tabulated by month for 5564 locations worldwide on the CD that
accompanies the ASHRAE 2009 HOF.
Field: Sky Clearness
If the choice in the Solar Model Indicator field is ASHRAEClearSky or ZhangHuang, then this
numeric field should be entered. This value represents the clearness value for the day. This
value, along with the solar position as defined by the Location information and the date
entered for the design day, help define the solar radiation values for each hour of the day.
Clearness may range from 0.0 to 1.2, where 1.0 represents a clear sky at sea level. Values
greated than 1.0 may be used for high altitude locations. Traditionally, one uses 0.0
clearness for Winter Design Days. Note that this sky clearness does not have the same
meaning as output variable Site Daylighting Model Sky Clearness.
IDF Examples:
! Phoenix Sky Harbor Intl Ap_AZ_USA Annual Cooling (WB=>MDB)
!
.4%, MDB=35.8C WB=24.5C
SizingPeriod:DesignDay,
Phoenix Sky Harbor Intl Ap Ann Clg .4% Condns WB=>MDB,
!- Name
7,
!- Month
21,
!- Day of Month
SummerDesignDay,!- Day Type
35.8,
!- Maximum Dry-Bulb Temperature {C}
12,
!- Daily Dry-Bulb Temperature Range {C}
DefaultMultipliers, !- Dry-Bulb Temperature Range Modifier Type
,
!- Dry-Bulb Temperature Range Modifier Schedule Name
Wetbulb,
!- Humidity Condition Type
24.5,
!- Wetbulb at Maximum Dry-Bulb {C}
,
!- Humidity Indicating Day Schedule Name
,
!- Humidity Ratio at Maximum Dry-Bulb {kgWater/kgDryAir}
,
!- Enthalpy at Maximum Dry-Bulb {J/kg}
,
!- Daily Wet-Bulb Temperature Range {deltaC}
97342.,
!- Barometric Pressure {Pa}
4.1,
! Wind Speed {m/s}
260,
!- Wind Direction {Degrees; N=0, S=180}
No,
!- Rain {Yes/No}
No,
!- Snow on ground {Yes/No}
No,
!- Daylight Savings Time Indicator
ASHRAETau, !- Solar Model Indicator
,
!- Beam Solar Day Schedule Name
,
!- Diffuse Solar Day Schedule Name
0.588,
!- ASHRAE Clear Sky Optical Depth for Beam Irradiance (taub)
1.653; !- ASHRAE Clear Sky Optical Depth for Diffuse Irradiance (taud)
SizingPeriod:DesignDay,
Denver Centennial Golden Ann Htg 99% Condns DB - sched solar, !- Name
1,
!- Month
13,
!- Day of Month
WinterDesignDay,
!- Day Type
-16,
!- Maximum Dry-Bulb Temperature {C}
0.0,
!- Daily Dry-Bulb Temperature Range {deltaC}
,
!- Dry-Bulb Temperature Range Modifier Type
,
!- Dry-Bulb Temperature Range Modifier Schedule Name
Wetbulb,
!- Humidity Condition Type
-16,
!- Wetbulb or DewPoint at Maximum Dry-Bulb {C}
,
!- Humidity Indicating Day Schedule Name
,
!- Humidity Ratio at Maximum Dry-Bulb {kgWater/kgDryAir}
,
!- Enthalpy at Maximum Dry-Bulb {J/kg}
,
!- Daily Wet-Bulb Temperature Range {deltaC}
9/29/14

40

Input-Output Reference

Group -- Location Climate Weather File Access

83411.,
!- Barometric Pressure {Pa}
2.3,
!- Wind Speed {m/s}
180,
!- Wind Direction {deg}
No,
!- Rain Indicator
No,
!- Snow Indicator
No,
!- Daylight Saving Time Indicator
Schedule,
!- Solar Model Indicator
Winter (1/13) Beam Solar,!- Beam Solar Day Schedule Name
Winter (1/13) Diffuse Solar; !- Diffuse Solar Day Schedule Name
Schedule:Day:Hourly,
Winter (1/13) Beam Solar,
Any Number,
0,0,0,0,0,0,0,190,698,852,892,919,957,953,856,700,213,0,0,0,0,0,0,0;
Schedule:Day:Hourly,
Winter (1/13) Diffuse Solar,
Any Number,
0,0,0,0,0,0,0,35,118,116,92,65,40,14,0,0,5,0,0,0,0,0,0,0;

Look
at
the
example
files
1ZoneUncontrolled_DDChanges.idf
1ZoneUncontrolled_DD2009 for several examples of specifying Design Day inputs.

and

Sizing Period Design Day Outputs

For the schedule fields in the object, several output variables can be used:
Zone,Average,Sizing
Zone,Average,Sizing
Zone,Average,Sizing
Zone,Average,Sizing
Zone,Average,Sizing
Value []
Zone,Average,Sizing
Value [deltaC]
Zone,Average,Sizing
Value [C]
Zone,Average,Sizing
Zone,Average,Sizing

Period
Period
Period
Period
Period

Site
Site
Site
Site
Site

Beam Solar Schedule Value [W/m2]

Diffuse Solar Schedule Value [W/m2]
Humidity Condition Schedule Value [%]
Humidity Condition Schedule Value []
Drybulb Temperature Range Modifier Schedule

Period Site Drybulb Temperature Range Modifier Schedule

Period Site Drybulb Temperature Range Modifier Schedule
Period Site Sky Temperature Schedule Value [deltaC]
Period Site Sky Temperature Schedule Value [C]

Sizing Period Site Beam Solar Schedule Value [W/m2]

Sizing Period Site Diffuse Solar Schedule Value [W/m2]
This schedule value is active when any Design Day objects have / use the solar schedule
option. For those objects that dont have this option, the value will be displayed as -999.
Sizing Period Site Humidity Condition Schedule Value [%]
Sizing Period Site Humidity Condition Schedule Value []
This schedule value is active when any Design Day objects have / use the humidity schedule
option. For those objects that dont have this option, the value will be displayed as -999.
Sizing Period Site Drybulb Temperature Range Modifier Schedule Value []
Sizing Period Site Drybulb Temperature Range Modifier Schedule Value [deltaC]
Sizing Period Site Drybulb Temperature Range Modifier Schedule Value [C]
This schedule value is active when any Design Day objects have / use the drybulb
temperature range modifier chedule option. For those objects that dont have this option, the
value will be displayed as -999.

9/29/14

41

Input-Output Reference

Group -- Location Climate Weather File Access

Sizing Period Site Sky Temperature Schedule Value [deltaC]

Sizing Period Site Sky Temperature Schedule Value [C]
This schedule value is active when any Design Day objects have / use the
WeatherProperties:SkyTemperature schedule option. For those objects that dont have this
option, the value will be displayed as -999.
Longer Design Periods
Some features may benefit by using a longer design weather period for sizing or loads
calculations.
Longer
design
periods
may
be
created
by
using
the
SizingPeriod:WeatherFileDays or SizingPeriod:WeatherFileConditionType objects.
These two objects allow for selections from an attached weather file to be used in the sizing
calculations.
SizingPeriod:WeatherFileDays
The SizingPeriod:WeatherFileDays object describes using a selected period from the
attached weather file to be used in load calculations or sizing equipment. The period
selected can be as small as a single day or larger. Multiple periods may be input. While this
object may be used for sizing calculations, you should also consider using design days that
represent more long term extremes or conditions.
Field: Name
This field allows for an assigned name for this run period so it can be tracked easily in sizing
and other outputs.
Field: Begin Month
This numeric field should contain the starting month number (1=January, 2=February, etc.)
for the annual run period desired.
Field: Begin Day of Month
This numeric field should contain the starting day of the starting month (must be valid for
month) for the annual run period desired.
Field: End Month
This numeric field should contain the ending month number (1=January, 2=February, etc.) for
the annual run period desired.
Field: End Day of Month
This numeric field should contain the ending day of the ending month (must be valid for
month) for the annual run period desired.
Field: Day of Week for Start Day
For flexibility, the day of week indicated on the weather file can be overridden by this fields
value. Valid days of the week (Sunday, Monday, Tuesday, Wednesday, Thursday, Friday,
Saturday) or special days (SummerDesignDay, WinterDesignDay, CustomDay1,
CustomDay2) must be entered in this field. To clarify, this value will be used as the Start Day
(type) for this sizing period. When weekdays are used, each subsequent day in the period will
be incremented. When SummerDesignDay, WinterDesignDay, CustomDay1, CustomDay2
are used, the day type will be applied for the entire period.
Field: Use Weather File Daylight Saving Period
Weather files can contain indicators of Daylight Saving Period days. For flexibility, you may
want to ignore these designations on the weather file. This field should contain the word Yes
if you will accept daylight saving period days as contained on the weather file (note: not all

9/29/14

42

Input-Output Reference

Group -- Location Climate Weather File Access

weather files may actually have this period) or No if you wish to ignore Daylight Saving
Period days that may be on the weather file.
Note that a blank or null field in this field will indicate Yes.
Field: Use Weather File Rain and Snow Indicators
Weather files can contain rain and snow indicators. (EPW field Present Weather Codes
described in the AuxiliaryPrograms document). In turn, rain indicates wet surfaces which
changes the film convection coefficient for the surface. Other models may use rain as well
(Ground Heat Exchangers). Snow indicators can change the ground reflectance if there is
snow on the ground. Entering Yes in this field allows the weather file conditions to represent
Rain and Snow; entering No in the field turns off the rain/snow indicators for this
period. You might use this to be able to compare two same location weather files of different
years, origins, etc.
IDF Example:
SizingPeriod:WeatherFileDays,
Summer including Extreme Summer days, !- Name
7,18,7,25,
!- Begin/end Day/Month
SummerDesignDay,
!- Day type
No,
!- Use Weather File Daylight Saving Period
No;
!- Use Weather File Rain and Snow Indicators
SizingPeriod:WeatherFileDays,
Winter including Extreme Winter days, !- Name
1,25,2,1,
!- Begin/end Day/Month
WinterDesignDay,
!- Day type
No,
!- Use Weather File Daylight Saving Period
No;
!- Use Weather File Rain and Snow Indicators

SizingPeriod:WeatherFileConditionType
When the EPW files are created, a heuristic procedure identifies extreme and typical periods
in the actual weather file. This object will allow one of those periods to be selected for sizing
or load calculations (typically). Multiple objects may be input. While this object may be used
for sizing calculations, you should also consider using design days that represent more long
term extremes or conditions.
Field: Name
This field allows for an assigned name for this run period so it can be tracked easily in sizing
and other outputs.
Field: Period Selection
This field allows the generic period calculated from the weather file to be selected for this run
period. It is not completely generic as there may be extreme cold periods in some weather
files but extreme wet periods (tropical) in others. Not all weather files have all of the valid
choices. The choices for this field are:
SummerExtreme
SummerTypical
WinterExtreme
WinterTypical
AutumnTypical
SpringTypical
WetSeason
DrySeason
NoDrySeason
9/29/14

43

Input-Output Reference

Group -- Location Climate Weather File Access

NoWetSeason
TropicalHot
TropicalCold
Field: Day of Week for Start Day
For flexibility, the day of week indicated on the weather file can be overridden by this fields
value. Valid days of the week (Sunday, Monday, Tuesday, Wednesday, Thursday, Friday,
Saturday) or special days (SummerDesignDay, WinterDesignDay, CustomDay1,
CustomDay2) must be entered in this field. To clarify, this value will be used as the Start Day
(type) for this sizing period. When weekdays are used, each subsequent day in the period will
be incremented. When SummerDesignDay, WinterDesignDay, CustomDay1, CustomDay2
are used, the day type will be applied for the entire period.
Field: Use Weather File Daylight Saving Period
Weather files can contain indicators of Daylight Saving Period days. For flexibility, you may
want to ignore these designations on the weather file. This field should contain the word Yes
if you will accept daylight saving period days as contained on the weather file (note: not all
weather files may actually have this period) or No if you wish to ignore Daylight Saving
Period days that may be on the weather file.
Note that a blank or null field in this field will indicate Yes.
Field: Use Weather File Rain and Snow Indicators
Weather files can contain rain and snow indicators. (EPW field Present Weather Codes
described in the AuxiliaryPrograms document). In turn, rain indicates wet surfaces which
changes the film convection coefficient for the surface. Other models may use rain as well
(Ground Heat Exchangers). Snow indicators can change the ground reflectance if there is
snow on the ground. Entering Yes in this field allows the weather file conditions to represent
Rain and Snow; entering No in the field turns off the rain/snow indicators for this
period. You might use this to be able to compare two same location weather files of different
years, origins, etc.
IDF Example:
SizingPeriod:WeatherFileConditionType,
Extreme Summer Weather Period for Design, !- Name
SummerExtreme,
!- Period Selection
SummerDesignDay,
!- Day Type
No,
!- Use Weather File Daylight Saving Period
No;
!- Use Weather File Rain and Snow Indicators
SizingPeriod:WeatherFileConditionType,
Extreme Winter Weather Period for Design, !- Name
WinterExtreme,
!- Period Selection
WinterDesignDay,
!- Day Type
No,
!- Use Weather File Daylight Saving Period
No;
!- Use Weather File Rain and Snow Indicators

RunPeriod
The RunPeriod object describes the elements necessary to create a weather file simulation.
Multiple run periods may be input. EnergyPlus accepts weather files in the special
EnergyPlus weather format (described briefly below this document and in more detail in the
Auxiliary Programs document). These files can describe Daylight Saving Time periods as well
as holidays within their definitions. The RunPeriod object allows the user to override the use
of both the Daylight Saving Period (i.e. use or ignore) and holidays that are embedded within
the weather file. Note that the weather file also may contain design condition information,
typical and extreme period information, ground temperatures based on air temperature
calculations.
9/29/14

44

Input-Output Reference

Group -- Location Climate Weather File Access

Field: Name
This optional field allows the RunPeriod to be named for output reporting. When left blank,
the weather file location name is used. Note that the weather file location name will be
appened to this name in tabular/summary reports.
Field: Begin Month
This numeric field should contain the starting month number (1=January, 2=February, etc.)
for the annual run period desired.
Field: Begin Day of Month
This numeric field should contain the starting day of the starting month (must be valid for
month) for the annual run period desired.
Field: End Month
This numeric field should contain the ending month number (1=January, 2=February, etc.) for
the annual run period desired.
Field: End Day of Month
This numeric field should contain the ending day of the ending month (must be valid for
month) for the annual run period desired.
Field: Day of Week for Start Day
For flexibility, the day of week indicated on the weather file can be overridden by this fields
value. Valid days of the week (Sunday, Monday, Tuesday, Wednesday, Thursday, Friday,
Saturday) must be entered in this field. To clarify, this value will be used as the Start Day
(type) for this run period and subsequent days will be implemented. If a blank or
UseWeatherFile is entered here, then the starting day type will be calculated from the
weather file (ref: Auxiliary Programs document about Data Periods).
Field: Use Weather File Holidays and Special Days
Weather files can contain holiday designations or other kinds of special days. These day
types cause a corresponding days schedule (see SCHEDULE definitions below) to be used
during that day. This field should contain the word Yes if holidays or other special days
indicated directly on the weather file should retain their day type or No if holidays or other
special
days
on
the
weather
file
should
be
ignored.
Reference
the
RunPeriodControl:SpecialDays object below to enter your own special days and holidays.
Note that a blank or null field in this field will indicate Yes.
Field: Use Weather File Daylight Saving Period
Weather files can contain indicators of Daylight Saving period days. For flexibility, you may
want to ignore these designations on the weather file. This field should contain the word Yes
if you will accept daylight saving period days as contained on the weather file (note: not all
weather files may actually have this period) or No if you wish to ignore Daylight Saving period
days that may be on the weather file.
Note that a blank or null field in this field will indicate Yes.
Field: Apply Weekend Holiday Rule
In some countries (notably the US), when holidays fall on weekends, they are often observed
on a weekday close to the holiday day. (Usually if the specific day falls on a Saturday, the
observed day is Friday; if on a Sunday, the observed day is Monday). EnergyPlus will
represent this custom using the value in this field. If the field is Yes, then specific date
holidays that have a duration of one day, will be observed on the Monday after the day.
(Specific day holidays are such as January 1 a day-month combination). If the field is blank
or No, then the holiday will be shown on the day-month as entered. As this option is listed at
9/29/14

45

Input-Output Reference

Group -- Location Climate Weather File Access

the RunPeriod, all applicable special days for the run will use the rule there is no override
for individual special days.
Note that a blank or null field in this field will indicate No.
Note: EnergyPlus processed weather files available on the EnergyPlus web site:
http://www.energyplus.gov/cfm/weather_data.cfm have neither special days specified nor daylight saving
period. However, DDY (Design Day) files produced from the ASHRAE Design Conditions that accompany
the EPW files may include a DaylightSavingPeriod object for certain locations.

Field: Use Weather File Rain Indicators

Weather files can contain rain indicators. (EPW field Present Weather Codes described
in the AuxiliaryPrograms document). In turn, rain indicates wet surfaces which changes the
film convection coefficient for the surface. Other models may use rain as well (Ground Heat
Exchangers). Entering Yes in this field allows the weather file conditions to represent
Rain; entering No in the field turns off the rain indicator for this period. You might use
this to be able to compare two same location weather files of different years, origins, etc.
Field: Use Weather File Snow Indicators
Weather files can contain snow indicators. (EPW field Snow Depth > 0 indicates Snow on
the ground). In turn, snow changes the reflectivity of the ground and cascades changes of
this reflectivity. Entering Yes in this field allows the weather file conditions to represent
Snow; entering No in the field turns off the snow indicator for this period. You might use
this to be able to compare two same location weather files of different years, origins, etc.
Field: Number of Times Runperiod to be Repeated
This numeric field represents the number of times (usually years) the simulation has to be
carried out in a multi runperiod simulation. The default value is set to 1. The number of years
of simulation, in case of a Ground Loop Heat Exchanger (GLHE) simulation, should be equal
to the length of simulation field in GLHE object. Note that you can specify a number of
simulation years with a shorter run period (e.g. 1 week) and EnergyPlus will repeat the
simulation of the shorter run period for that many times. Note that repeating will work with any
weather file that contains the start date and end date in a Data Period (refer to Auxiliary
Programs document for more documentation on weather file contents).
Field: Increment Day of Week on Repeat
When repeating RunPeriods (see previous field), you can choose to increment the day of
week at the end of the period to have a more continuous day type. Enter Yes to increment
the day of the week (default). An entry of No will keep the same day of week values as in the
first time through.
Field: Start Year
When repeating a period, you might (for whatever reason), choose to have a specific year as
a starting year. Enter an appropriate 4 digit year in this field. Refer to Auxiliary Programs
document for more documentation on weather file contents, particularly in using leap year
data (or not) within weather files.
And, as shown in an IDF:
RunPeriod, ! Winter Simulation
Winter Simulation, !- Name
12, !- Begin Month
1, !- Begin Day of Month
3, !- End Month
31, !- End Day of Month
UseWeatherFile, !- Day of Week for Start Day
9/29/14

46

Input-Output Reference

Group -- Location Climate Weather File Access

Yes, !- Use Weather File Holidays and Special Days

Yes, !- Use Weather File Daylight Saving Period
No, !- Apply Weekend Holiday Rule
Yes, !- Use Weather File Rain Indicators
Yes; !- Use Weather File Snow Indicators

! Multiple year simulation example

RunPeriod,
Multiple Years, !- Name
1,
!- Begin Month
1,
!- Begin Day of Month
12,
!- End Month
31,
!- End Day of Month
UseWeatherFile, !- Day of Week for Start Day
Yes, !- Use Weather File Holidays and Special Days
Yes, !- Use Weather File Daylight Saving Period
No,
!- Apply Weekend Holiday Rule
Yes, !- Use Weather File Rain Indicators
Yes, !- Use Weather File Snow Indicators
3;
!- Number of Times Runperiod to be Repeated

RunPeriod:CustomRange
The RunPeriod:CustomRange object describes the elements necessary to use a specially
crafted (likely multiple year) weather file in a simulation. These kinds of weather files and
simulations might be useful for matching utility periods or simulating several years of differing
weather data. Multiple run periods may be input. EnergyPlus accepts weather files in the
special EnergyPlus weather format (described briefly below this document and in more detail
in the Auxiliary Programs document). In order to effectively use this object, however, you will
need to use a text editor (EnergyPlus weather files area simple text files) or possibly a
spreadsheet program and then save to a csv (comma separated variable) file. Weather files
can describe Daylight Saving Time periods as well as holidays within their definitions. The
RunPeriod:CustomRange object allows the user to override the use of both the Daylight
Saving Period (i.e. use or ignore) and holidays that are embedded within the weather file.
Note that the weather file also may contain design condition information, typical and extreme
period information, ground temperatures based on air temperature calculations.
Field: Name
This optional field allows the RunPeriod to be named for output reporting. When left blank,
the weather file location name is used. Note that the weather file location name will be
appened to this name in tabular/summary reports.
Field: Begin Month
This numeric field should contain the starting month number (1=January, 2=February, etc.)
for the annual run period desired.
Field: Begin Day of Month
This numeric field should contain the starting day of the starting month (must be valid for
month) for the annual run period desired.
Field: Begin Year
This numeric field should contain the beginning year for the custom range. Though all
EnergyPlus (EPW) weather files contain a year/year field, the RunPeriod object does not use
this field (previous object). The RunPeriod:CustomRange object causes the program to look
specifically for the begin date specified by these three fields (i.e. Begin Month, Begin Day of
Month, Begin Year).
9/29/14

47

Input-Output Reference

Group -- Location Climate Weather File Access

Field: End Month

This numeric field should contain the ending month number (1=January, 2=February, etc.) for
the annual run period desired.
Field: End Day of Month
This numeric field should contain the ending day of the ending month (must be valid for
month) for the annual run period desired.
Field: End Year
This numeric field should contain the end year for the custom range. Though all EnergyPlus
(EPW) weather files contain a year/year field, the RunPeriod object does not use this field
(previous object). The RunPeriod:CustomRange object causes the program to look
specifically for the end date specified by these three fields (i.e. End Month, End Day of
Month, End Year).
Field: Day of Week for Start Day
For flexibility, the day of week indicated on the weather file can be overridden by this fields
value. Valid days of the week (Sunday, Monday, Tuesday, Wednesday, Thursday, Friday,
Saturday) must be entered in this field. To clarify, this value will be used as the Start Day
(type) for this run period and subsequent days will be implemented. If a blank or
UseWeatherFile is entered here, then the starting day type will be calculated from the
weather file (ref: Auxiliary Programs document about Data Periods).
Field: Use Weather File Holidays and Special Days
Weather files can contain holiday designations or other kinds of special days. These day
types cause a corresponding days schedule (see SCHEDULE definitions below) to be used
during that day. This field should contain the word Yes if holidays or other special days
indicated directly on the weather file should retain their day type or No if holidays or other
special
days
on
the
weather
file
should
be
ignored.
Reference
the
RunPeriodControl:SpecialDays object below to enter your own special days and holidays.
Note that a blank or null field in this field will indicate Yes.
Field: Use Weather File Daylight Saving Period
Weather files can contain indicators of Daylight Saving period days. For flexibility, you may
want to ignore these designations on the weather file. This field should contain the word Yes
if you will accept daylight saving period days as contained on the weather file (note: not all
weather files may actually have this period) or No if you wish to ignore Daylight Saving period
days that may be on the weather file.
Note that a blank or null field in this field will indicate Yes.
Field: Apply Weekend Holiday Rule
In some countries (notably the US), when holidays fall on weekends, they are often observed
on a weekday close to the holiday day. (Usually if the specific day falls on a Saturday, the
observed day is Friday; if on a Sunday, the observed day is Monday). EnergyPlus will
represent this custom using the value in this field. If the field is Yes, then specific date
holidays that have a duration of one day, will be observed on the Monday after the day.
(Specific day holidays are such as January 1 a day-month combination). If the field is blank
or No, then the holiday will be shown on the day-month as entered. As this option is listed at
the RunPeriod, all applicable special days for the run will use the rule there is no override
for individual special days.
Note that a blank or null field in this field will indicate No.

9/29/14

48

Input-Output Reference

Group -- Location Climate Weather File Access

Note: EnergyPlus processed weather files available on the EnergyPlus web site:
http://www.energyplus.gov/cfm/weather_data.cfm have neither special days specified nor daylight saving
period. However, DDY (Design Day) files produced from the ASHRAE Design Conditions that accompany
the EPW files may include a DaylightSavingPeriod object for certain locations.

Field: Use Weather File Rain Indicators

Weather files can contain rain indicators. (EPW field Present Weather Codes described
in the AuxiliaryPrograms document). In turn, rain indicates wet surfaces which changes the
film convection coefficient for the surface. Other models may use rain as well (Ground Heat
Exchangers). Entering Yes in this field allows the weather file conditions to represent
Rain; entering No in the field turns off the rain indicator for this period. You might use
this to be able to compare two same location weather files of different years, origins, etc.
Field: Use Weather File Snow Indicators
Weather files can contain snow indicators. (EPW field Snow Depth > 0 indicates Snow on
the ground). In turn, snow changes the reflectivity of the ground and cascades changes of
this reflectivity. Entering Yes in this field allows the weather file conditions to represent
Snow; entering No in the field turns off the snow indicator for this period. You might use
this to be able to compare two same location weather files of different years, origins, etc.
RunPeriodControl:SpecialDays
For weather file run periods, special day run periods can be described. These will always be
in effect for the selected days in the run period. Depending on the Use Special Days value in
the RunPeriod:* object(s), these can augment any special days included on the weather file.
Note: EnergyPlus processed weather files available on the EnergyPlus web site:
http://www.energyplus.gov/cfm/weather_data.cfm have neither special days specified nor daylight saving
period. However, DDY (Design Day) files produced from the ASHRAE Design Conditions that accompany
the EPW files may include a DaylightSavingPeriod object for certain locations.

Field: Name
This alpha field is the title for the special day period. It must be unique among all the special
day period objects entered.
Field: Start Date
This field is the starting date for the special day period. Dates in this field can be entered in
several ways as shown in the accompanying table:
Table 3. Date Field Interpretation
Field Contents

Interpretation

<number> / <number>

Month / Day

<number> Month
Month <number>

Day and Month

Day and Month

<number> Weekday in Month

Numbered weekday of month

Last Weekday In Month

Last weekday of month

In the table, Month can be one of (January, February, March, April, May, June, July, August,
September, October, November, December). Abbreviations of the first three characters are
also valid.
9/29/14

49

Input-Output Reference

Group -- Location Climate Weather File Access

In the table, Weekday can be one of (Sunday, Monday, Tuesday, Wednesday, Thursday,
Friday, Saturday). Abbreviations of the first three characters are also valid.
Field: Duration
This numeric field specifies how long (number of days) the special day period lasts.
Field: Special Day Type
This alpha field designates the day type for schedule use during the special period. It must
be one of (Holiday, SummerDesignDay, WinterDesignDay, CustomDay1, CustomDay2).
An example in the IDF would be:
RunPeriodControl:SpecialDays,
February,1,Holiday;
RunPeriodControl:SpecialDays,
1,Holiday;
RunPeriodControl:SpecialDays,
RunPeriodControl:SpecialDays,

Presidents Day, 3rd Monday in

Thanksgiving, 4th Thursday in November,
Halloween, 10/31, 1, Holiday;
Vacation, 5/1, 14, CustomDay1;

RunPeriodControl:DaylightSavingTime
Similar to a special day period, a daylight saving period may be entered to be applied to
weather file run periods. These will always be in effect, regardless of the value entered on the
RunPeriod object. Note that this period will always override any daylight saving period
specified in a weather file.
Note: EnergyPlus processed weather files available on the EnergyPlus web site:
http://www.energyplus.gov/cfm/weather_data.cfm have neither special days specified nor daylight saving
period.
Note: For EnergyPlus Output:Variable and Output:Meter reporting, the time stamps are always in
standard time. When daylight saving time is active, scheduled loads and controls will shift one
hour relative to standard time.

Field: Start Date

This is the starting date of the daylight saving period. Note that it can be entered in several
formats as shown in Table 3. Date Field Interpretation.
Field: End Date
This is the ending date of the daylight saving period. Note that it can be entered in several
formats as shown in Table 3. Date Field Interpretation.
And in the IDF:
! U.S. Standard for Daylight Saving
RunPeriodControl:DaylightSavingTime,2nd Sunday in March, 1st Sunday in
November; !2007
! Brazil standard
RunPeriodControl:DaylightSavingTime,1st Sunday in October, Last Sunday in
February;
! European Standard
RunPeriodControl:DaylightSavingTime, Last Sunday in March, Last Sunday in
October;
! Syria Standard
RunPeriodControl:DaylightSavingTime, 4/1, 10/1;

Of course, these could not all appear in the same IDF as only one DaylightSavingPeriod
object per input file is allowed. More information on Daylight Saving Periods can be seen on
9/29/14

50

Input-Output Reference

Group -- Location Climate Weather File Access

the web at: http://www.webexhibits.org/daylightsaving/

The ASHRAE Handbook of
Fundamentals [ASHRAE 2005] also contains information about daylight saving periods and
their climatic information now includes start and end dates for many locations.
WeatherProperty:SkyTemperature
Sky Temperature, or radiative sky temperature, is internally calculated by EnergyPlus using
an algorithm using horizontal infrared radiation from sky, cloudiness factors and current
temperaure. The algorithm is fully described in the Engineering Reference document. For
flexibility, the following object can be entered to override the internal calculations. Much of the
literature describes the sky temperature as relative to either drybulb or dewpoint temperature.
Field: Name
This name references an existing design period (i.e., SizingPeriod:DesignDay,
SizingPeriod:WeatherFileDays, or SizingPeriod:WeatherFileConditionType) or run period (by
name or blank for all run periods).
Field: Calculation Type
Allowable entries here are: ScheduleValue, DifferenceScheduleDryBulbValue, or
DifferenceScheduleDewPointValue. In each case the following field must specify a valid
schedule name. ScheduleValue the values in the schedule are used as the sky
temperature. DifferenceScheduleDryBulbValue the values in the schedule are used as a
difference to the drybulb temperature value (+values would then be greater than the drybulb
temperature, -values would then be less than the drybulb temperature) for the resulting sky
temperature value. DifferenceScheduleDewPointValue the values in the schedule are
used as a difference to the dewpoint temperature value (+values would then be greater than
the dewpoint temperature, -values would then be less than the dewpoint temperature) for the
resulting sky temperature value.
Field: ScheduleName
This field specifies a schedule name to accomplish the sky temperature calculation from the
previous field. A Schedule:Day:* (i.e., Schedule:Day:Hourly, Schedule:Day:Interval,
Schedule:Day:List) should be specified if the name in the name field matches a
SizingPeriod:DesignDay object. If the name is one of the weather file period specifications
(i.e. matches a SizingPeriod:WeatherFileDays, SizingPeriod:WeatherFileConditionType or
RunPeriod), then the schedule name must match a full year schedule (i.e. Schedule:Year,
Schedule:Compact, Schedule:File, or Schedule:Constant).
An example of IDF usage (with DesignDay):
SizingPeriod:DesignDay,
DENVER_STAPLETON Ann Clg 1% Sky Temperature modfier, !- Name
32.6,
!- Maximum Dry-Bulb Temperature {C}
15.2,
!- Daily Temperature Range {deltaC}
15.5,
!- Humidity Indicating Conditions at Maximum Dry-Bulb
83411.,
!- Barometric Pressure {Pa}
4,
!- Wind Speed {m/s}
120,
!- Wind Direction {deg}
1.00,
!- Sky Clearness
0,
!- Rain Indicator
0,
!- Snow Indicator
25,
!- Day of Month
7,
!- Month
SummerDesignDay,
!- Day Type
0,
!- Daylight Saving Time Indicator
WetBulb,
!- Humidity Indicating Type
,
!- Relative Humidity Day Schedule Name
deltaschedule,
!- Dry-Bulb Temperature Range Modifier Type
temp range deltas; !Dry-Bulb Temperature Range Modifier Schedule Name

9/29/14

51

Input-Output Reference

Group -- Location Climate Weather File Access

WeatherProperty:SkyTemperature,
DENVER_STAPLETON Ann Clg 1% Sky Temperature modfier,
ScheduleValue,
!- Calculation Type
DaySchedule5;
!- Schedule Name
Schedule:Day:Interval,
DaySchedule5,
Temperature,
Yes,
until: 24:00,
5;

!!!!!-

!- Name

Name
Schedule Type Limits Name
Interpolate to Timestep
Time 1
Value Until Time 1

Site:WeatherStation
The Site:WeatherStation object is used to specify the measurement conditions for the climatic
data listed in the weather file. These conditions indicate the height above ground of the air
temperature sensor, the height above ground of the wind speed sensor, as well as
coefficients that describe the wind speed profile due to the terrain surrounding the weather
station. There are necessary correlations between the entries for this object and some entries
in the Building object, specifically the Terrain field.
Weather stations throughout the world (ref: WMO World Meteorological Organization) take
their measurements at standard conditions:
Air temperature is measured at approximately 1.5 m above ground
Wind speed is measured at 10 m above ground
Weather station is in a flat, open field with little protection from the wind.
When using weather data from standard sources (e.g., TMY2, IWEC, TMY, or ASHRAE
design day data), it is not necessary to use the Site:WeatherStation object. However, if you
are using custom weather data or real-time weather data, you may need to read and
understand the concepts in the Site:WeatherStation object.
The measurement conditions at the weather station (i.e., the weather file) are used by
EnergyPlus in conjunction with the Terrain field of the Building object, or optionally with the
Site:HeightVariation object (see below), to calculate the local variation in atmospheric
properties as a function of height above ground. Outdoor air temperature decreases with
height, while wind speed increases with height. The algorithms for this calculation are in the
Engineering Reference.
The Site:WeatherStation object is useful when working with a custom weather file that
includes data that were not measured at the WMO standard conditions. For example, the
weather data could be measured on site, or on the roof top of a nearby building. The wind
speed profile coefficients can be estimated from the table below or calculated beforehand
using more sophisticated techniques such as CFD modeling of the weather station terrain.
Table 4. Wind Speed Profile Coefficients (ASHRAE Fundamentals 2005).
Terrain Description

Exponent

Boundary Layer
Thickness (m)

Flat, open country

0.14

270

Rough, wooded country

0.22

370

Towns and cities

0.33

460

Ocean

0.10

210

Urban, industrial, forest

0.22
370
If the Site:WeatherStation object is omitted from the input file, the WMO standard
measurement conditions are assumed.

9/29/14

52

Input-Output Reference

Group -- Location Climate Weather File Access

Field: Wind Sensor Height Above Ground

The height [m] above ground for the wind speed sensor.
Field: Wind Speed Profile Exponent
The wind speed profile exponent for the terrain surrounding the weather station. The
exponent can be estimated from the table above or calculated beforehand using more
sophisticated techniques, such as CFD modeling of the weather station terrain.
Field: Wind Speed Profile Boundary Layer Thickness
The wind speed profile boundary layer thickness [m] for the terrain surrounding the weather
station. The boundary layer can be estimated from the table above or calculated beforehand
using more sophisticated techniques, such as CFD modeling of the weather station terrain.
Field: Air Temperature Sensor Height Above Ground
The height [m] above ground for the air temperature sensor.
For example, if you are using weather data measured on the top of your building, you should
set the Wind Sensor Height Above Ground and the Air Temperature Sensor Height Above
Ground to equal the height of your building (say 30 m). The Wind Speed Profile Exponent
and Wind Speed Profile Boundary Layer Thickness should be set to match the values
associated with the Terrain field of the Building object, or the equivalent fields of the
Site:HeightVariation object.
Or, in IDF terms, with a building in a town or city:
Site:WeatherStation,
30, !- Wind Sensor Height Above Ground {m}
0.33, !- Wind Speed Profile Exponent {}
460, !- Wind Speed Profile Boundary Layer Thickness {m}
30; !- Air Temperature Sensor Height Above Ground {m}

This would change if you had a different wind speed profile exponent or wind speed profile
boundary layer thickness at your site.
Site:HeightVariation
The Site:HeightVariation object is used to specify the local variation in atmospheric properties
at the site and should be used only if you require advanced control over the height-dependent
variations for wind speed and temperature. The coefficients set by this object are used by
EnergyPlus, in conjunction with the Site:WeatherStation object (see above), to calculate the
local variation in atmospheric properties as a function of height above ground. Outdoor air
temperature decreases with height, while wind speed increases with height. The local
outdoor air temperature and wind speed are calculated separately for all zones and surfaces,
and optionally for outdoor air nodes for which a height has been specified (see
OutdoorAir:Node object). With the default inputs, wind speed falls significantly at heights
lower than the weather station measurement height, and temperature increases slightly. The
algorithms for this calculation are in the Engineering Reference. There are necessary
correlations between the entries for this object and some entries in the Building object,
specifically the Terrain field.
Table 5. Atmospheric Variables at Two Different Heights Above Ground Level.
Variable

1.5 m

284 m

Absolute Diff

Percent Diff

Air Temperature

15C

13.15C

1.85C

12.3%

Barometric Pressure

101,325 Pa

97,960 Pa

3,365 Pa

3.3%

Wind Speed

2.46 m/s

7.75 m/s

5.29 m/s

215%

9/29/14

53

Input-Output Reference

Group -- Location Climate Weather File Access

Note that using this object overrides the wind speed profile coefficients implied by the Terrain
field of the Building object even if the wind speed profile fields are left blank. The wind speed
profile coefficients can be estimated from the table above (see Site:WeatherStation) or
calculated beforehand using more sophisticated techniques such as CFD modeling of the site
terrain.
Field: Wind Speed Profile Exponent
The wind speed profile exponent for the terrain surrounding the site. The exponent can be
estimated from the table above (see Site:WeatherStation) or calculated beforehand using
more sophisticated techniques, such as CFD modeling of the site terrain. Note that using this
object overrides the wind speed profile coefficients implied by the Terrain field of the
Building object even if this field is left blank.
Field: Wind Speed Profile Boundary Layer Thickness
The wind speed profile boundary layer thickness [m] for the terrain surrounding the site. The
boundary layer can be estimated from the table above (see Site:WeatherStation) or
calculated beforehand using more sophisticated techniques, such as CFD modeling of the
site terrain. Note that using this object overrides the wind speed profile coefficients implied by
the Terrain field of the Building object even if this field is left blank. This field can be set to
zero to turn off all wind dependence on height.
Field: Air Temperature Gradient Coefficient
The air temperature gradient coefficient [K/m] is a research option that allows the user to
control the variation in outdoor air temperature as a function of height above ground. The real
physical value is 0.0065 K/m. This field can be set to zero to turn off all temperature
dependence on height. Note that the Air Temperature Sensor Height in the
Site:WeatherStation object should also be set to zero in order to force the local outdoor air
temperatures to match the weather file outdoor air temperature. This change is required
because the Site:WeatherStation object assumes an air temperature gradient of 0.0065
K/m.
Site:HeightVariation,
0.22, !- Wind Speed Profile Exponent
370, !- Wind Speed Profile Boundary Layer Thickness {m}
0.0065; !- Air Temperature Gradient Coefficient {deltaC/m}

Site:GroundTemperature:BuildingSurface
Ground temperatures are used for the ground heat transfer model. There can be only one
ground temperature object included, and it is used as the outside surface temperature for all
surfaces with Outside Boundary Condition=Ground. The object is options if you have no
surfaces with ground contact. The outside surface temperature for individual surfaces can be
specified using the OtherSideCoefficients (ref: SurfaceProperty:OtherSideCoefficients) object
that allows Toutside to be set with a schedule. This permits using any number of different
outside face temperatures in addition to the ground temperature.
Caution: The undisturbed ground temperatures calculated by the weather converter should not be used in
building losses but are appropriate to be used in the Site:GroundTemperature:Shallow and
Site:GroundTemperature:Deep objects. The reasoning (for building losses) is that these values are too extreme
for the soil under a conditioned building. For best results, use the Slab or Basement program described in this
document to calculate custom monthly average ground temperatures (see the Ground Heat Transfer section).
This is especially important for residential applications and very small buildings. If one of these ground
temperature preprocessors is not used, for typical commercial buildings in the USA, a reasonable default value
is 2C less than the average indoor space temperature.

9/29/14

54

Input-Output Reference

Group -- Location Climate Weather File Access

More information about determining appropriate ground temperatures is given in the Auxiliary
Programs document.
Field: Month Temperature(s) 12 fields in all
Each numeric field is the monthly ground temperature (degrees Celsius) used for the
indicated month (January=1st field, February=2nd field, etc.)
An IDF example:
Site:GroundTemperature:BuildingSurface,19,20,20,20,20,20,20,20,20,20,20,20;

Site:GroundTemperature:Shallow
Site:GroundTemperature:Shallow are used by the Surface Ground Heat Exchanger (i.e.
object: GroundHeatExchanger:Surface). Only one shallow ground temperature object can be
included.
Note that the ground temperatures included in full year weather files may be suitable of being used for the
values in these fields namely, the .5 m depth temperatures that are calculated for undisturbed soil of
typical conditions. However, you may wish to use some other change effect based on the weather
conditions of the building location.

Field: Month Temperature(s) 12 fields in all

Each numeric field is the monthly surface ground temperature (degrees Celsius) used for the
indicated month (January=1st field, February=2nd field, etc.)
An IDF example:
Site:GroundTemperature:Shallow,

4,4,6,6,10,10,15,15,14,14,8,8;

Site:GroundTemperature:Deep
Site:GroundTemperature:Deep are used by the Pond Ground Heat Exchanger object (i.e.
object: GroundHeatExchanger:Pond). Only one deep ground temperature object can be
included.
Note that the ground temperatures included in full year weather files may be suitable of being used for the
values in these fields namely, the 4 m depth temperatures that are calculated for undisturbed soil of
typical conditions. However, you may wish to use some other change effect based on the weather
conditions or special knowledge of the building location.

Field: Month Temperature(s) 12 fields in all

Each numeric field is the monthly deep ground temperature (degrees Celsius) used for the
indicated month (January=1st field, February=2nd field, etc.)
An IDF example:
Site:GroundTemperature:Deep,

16,16,16,16,16,16,16,16,16,16,16,16;

Site:GroundDomain
This section documents the input object used to simulate ground coupled heat transfer with
horizontal building surfaces within EnergyPlus. Horizontal ground surfaces within EnergyPlus
interact
with
the
Site:GroundDomain
object
by
utilizing
the
SurfaceProperty:OtherSideConditionsModel object. By utilizing this object, multiple horizontal
surfaces can be coupled to the same Site:GroundDomain object. Each horizontal surface
may also have its unique ground domain, however, runtime will be adversely affected.

9/29/14

55

Input-Output Reference

Group -- Location Climate Weather File Access

Generally, there are two scenarios which Site:GroundDomain is equipped to model: in-grade
slabs, and on-grade slabs.

Figure 7In-grade configuration.

The in-grade slab option can be used to simulate situations when the upper slab surface is
near the ground surface level. For this situation, slabs upper surface must interact with the
zone via an OSCM boundary. Due to this, the FloorConstruction object for the zone floor
must include a thin layer of the upper floor material. Horizontal and vertical insulation are
modeled by the GroundDomain in this scenario. Horizontal insulation can be modeled as
covering the full horizontal surface, or it can be limited to the perimeter regions only. In the
latter case, the perimeter insulation width must be specified.

9/29/14

56

Input-Output Reference

Group -- Location Climate Weather File Access

Figure 8 On-grade configuration

The on-grade slab option can be used to simulate situations when the lower slab surface is
near the ground surface level. In this situation, the entire floor must be included within the
floor construction object. Vertical insulation is modeled by the GroundDomain in this scenario.
Horizontal insulation can only be modeled as covering the full horizontal surface.
Field: Name
Alpha field used as a unique identifier for each ground domain.
Field: Ground Domain Depth
Numeric field used to determine the depth of the simulation domain, in meters.
Field: Aspect Ratio
Numeric field used to define the height to width ratio of the slab.
Field: Perimeter Offset
Numeric field used to determine the distance from the slab perimeter to the domain
perimeter, in meters.
Field: Soil Thermal Conductivity
The thermal conductivity of the soil, in W/m-K.
Field: Soil Density
The bulk density of the soil, in kg/m3.
Field: Soil Specific Heat
The specific heat of dry soil, in J/kg-K. If moisture is defined in this object, moisture and
freezing effects are accounted for by varying the specific heat value.
Field: Soil Moisture Content Volume Fraction
A nominal value of soil moisture content to be used when evaluating soil thermal properties.
9/29/14

57

Input-Output Reference

Group -- Location Climate Weather File Access

Field: Soil Moisture Content Volume Fraction at Saturation

A nominal value of soil moisture content when the soil is saturated, this is used in evaluating
thermal properties of freezing soil.
Field: Kusuda-Achebach Average Surface Temperature
The annual average surface temperature to be applied to the Kusuda-Achenbach farfield
boundary temperature correlation, in C
Field: Kusuda-Achebach Average Amplitude of Surface Temperature
The annual mean surface temperature variation from average used in determining the farfield
boundary conditions.
Field: Kusuda-Achenbach Phase Shift of Minimum Surface Temperature
The phase shift of minimum surface temperature, or the day of the year when the minimum
surface temperature occurs.
Field: Evapotranspiration Ground Cover Parameter
Numeric field specifies the ground cover effects used in the evapotranspiration model at the
ground surface heat balance. The values range from 0 (solid, non-permeable ground surface)
to 1.5 (wild growth).
Field: Slab Boundary Condition Model Name
This is the name of the other side boundary condition model used.
Field: Slab Location
Alpha field indicates whether the slab is in-grade (top surface level with ground surface) or
on-grade (bottoms surface level with ground surface). Options include ONGRADE and
INGRADE.
Field: Slab Material Name
Name of the material object representing the slab material. Only applicable to in-grade
situations.
Field: Horizontal Insulation
Alpha field indicates whether horizontal insulation is present. Options include YES and
NO. Only applicable to in-grade situations.
Field: Horizontal Insulation Material Name
Name of material object representing the horizontal slab insulation. Optional argument only
required if horizontal insulation is present.
Field: Horizontal Insulation Extents
Alpha field indicates whether the horizontal slab insulation extends to cover the full horizontal
area of the slab, or only covers the slab perimeter. Optional argument only required if
horizontal insulation is present. Options include FULL and PERIMETER.
Field: Perimeter Insulation Width
Numeric field indicating the width of the perimeter insulation measured from the slab edge.
Valid range from > 0 to < half of smallest slab width.
Field: Vertical Insulation
Alpha field indicates whether vertical insulation is present. Options include YES and NO.

9/29/14

58

Input-Output Reference

Group -- Location Climate Weather File Access

Field: Vertical Insulation Name

Name of material object representing the vertical slab insulation. Optional argument only
required if vertical insulation is present.
Field: Vertical Insulation Depth
Numeric field indicates the depth measured in meters from the ground surface to which the
vertical perimeter insulation extends. Valid range from > Slab Thickness to < Domain Depth.
Field: Simulation Timestep
Alpha field indicating whether the domain will update temperatures at each zone timestep, or
at hourly intervals. Options include timestep and hourly.
An IDF example of an in-grade slab.
Site:GroundDomain,
IngradeCoupledSlab, !- Name
5,
!- Ground Domain Depth
1,
!- Aspect Ratio
5,
!- Domain Perimeter Offset
1.8,
!- Soil Thermal Conductivity
3200,
!- Soil Density
836,
!- Soil Specific Heat
30,
!- Soil Moisture Content Volume Fraction
50,
!- Soil Moisture Content Volume Fraction at Saturation
15.5, !- Kusuda-Achenbach Average Surface Temperature
12.8, !- Kusuda-Achenbach Average Amplitude of Surface Temperature
17.3, !- Kusuda-Achenbach Phase Shift of Minimum Surface Temperature
1,
!- Evapotranspiration Ground Cover Parameter
GroundCoupledOSCM,
!- Name of Floor Boundary Condition Model
InGrade,
!- Slab Location (InGrade/OnGrade)
Slab Material-In-grade, !- Slab Material Name
Yes,
!- Horizontal Insulation
Slab Insulation,
!- Horizontal Insulation Material Name
Perimeter,
!- Full Horizontal or Perimeter Only
1,
!- Perimeter insulation width
Yes,
!- Vertical Insulation
Slab Insulation,
!- Vertical Insulation Name
2,
!- Vertical perimeter insulation depth from surface
Hourly;
!- Simulation timestep

And IDF example of an on-grade slab

Site:GroundDomain,
OngradeCoupledSlab, !- Name
5,
!- Ground Domain Depth {m}
1,
!- Aspect Ratio
5,
!- Domain Perimeter Offset {m}
1.8,
!- Soil Thermal Conductivity {W/m-K}
3200,
!- Soil Density {kg/m3}
836,
!- Soil Specific Heat {J/kg-K}
30,
!- Soil Moisture Content Volume Fraction
50,
!- Soil Moisture Content Volume Fraction at Saturation
15.5,
!- Kusuda-Achenbach Average Surface Temperature
12.8,
!- Kusuda-Achenbach Average Amplitude of Surface Temperature
17.3,
!- Kusuda-Achenbach Phase Shift of Minimum Surface Temperature
1,
!- Evapotranspiration Ground Cover Parameter
GroundCoupledOSCM, !- Name of Floor Boundary Condition Model
OnGrade,
!- Slab Location (InGrade/OnGrade)
,
!- Slab Material Name
,
!- Horizontal Insulation (Yes/No)
9/29/14

59

Input-Output Reference
,
,
,
Yes,
Slab Insulation,
2,
Hourly;

Group -- Location Climate Weather File Access

!!!!!!!-

Horizontal Insulation Material Name

Full Horizontal or Perimeter Only
Perimeter insulation width (m)
Vertical Insulation (Yes/No)
Vertical Insulation Name
Vertical perimeter insulation depth from surface
Simulation timestep. (Timestep/Hourly)

Site:GroundDomain Outputs
The following output variables are available.
Zone, Average, Zone Coupled Surface Heat Flux [W/m2]
Zone, Average, Zone Coupled Surface Temperature [C]

Zone Coupled Surface Heat Flux [W/m2]

This is the value of the heat flux provided to the GroundDomain as a boundary condition
which is determined by taking the average of all surfaces coupled to the domains
OtherSideBoudaryCondition model.
Zone Coupled Surface Temperature [C]
This is the value of the OthersideConditionModel surface temperature. This is the
temperature provided to the ground coupled surfaces as an outside boundary condition.
Site:GroundTemperature:FCfactorMethod
Site:GroundTemperature:FCfactorMethod is used only by the underground walls or slabs-ongrade or underground floors defined with C-factor (Construction:CfactorUndergroundWall)
and F-factor (Construction:FfactorGroundFloor) method for code compliance calculations
where detailed construction layers are unknown. Only one such ground temperature object
can be included. The monthly ground temperatures for this object are close to the monthly
outside air temperatures delayed by three months. If user does not input this object in the IDF
file, it will be defaulted to the 0.5m set of monthly ground temperatures from the weather file if
they are available. Entering these will also overwrite any ground temperatures from the
weather file in the F and C factor usage. If neither is available, an error will result.
Field: Month Temperature(s) 12 fields in all
Each numeric field is the monthly ground temperature (degrees Celsius) used for the
indicated month (January=1st field, February=2nd field, etc.)
And, the IDF example:
Site:GroundTemperature:FCfactorMethod,
14, 18.2, 22.7, 21.2, 16.8;

9.5, 3.5, -0.7, -1.7, -0.6, 3.6, 9.3,

Site:GroundReflectance
Ground reflectance values are used to calculate the ground reflected solar amount. This
fractional amount (entered monthly) is used in this equation:

GroundReflectedSolar=(BeamSolar COS(SunZenithAngle)+DiffuseSolar) GroundReflectance

Of course, the Ground Reflected Solar is never allowed to be negative. The ground
reflectance can be further modified when snow is on the ground by the Snow Ground
Reflectance Modifier. To use no ground reflected solar in your simulation, enter 0.0 for each
month.
Field: Month Average Ground Reflectance(s) 12 fields in all
Each numeric field is the monthly average reflectivity of the ground used for the indicated
month (January=1st field, February=2nd field, etc.)
9/29/14

60

Input-Output Reference

Group -- Location Climate Weather File Access

And use in an IDF:

Site:GroundReflectance,
0.600,
!January Ground Reflectance
0.600,
!February Ground Reflectance
0.400,
!March Ground Reflectance
0.300,
!April Ground Reflectance
0.200,
!May Ground Reflectance
0.200,
!June Ground Reflectance
0.200,
!July Ground Reflectance
0.200,
!August Ground Reflectance
0.200,
!September Ground Reflectance
0.200,
!October Ground Reflectance
0.300,
!November Ground Reflectance
0.400;
!December Ground Reflectance

Site:GroundReflectance:SnowModifier
It is generally accepted that snow resident on the ground increases the basic ground
reflectance. EnergyPlus allows the user control over the snow ground reflectance for both
normal ground reflected solar calculations (see above) and snow ground reflected solar
modified for daylighting. These are entered under this object and both default to 1 (same as
normal ground reflectance no special case for snow which is a conservative approach).
Field: Ground Reflected Solar Modifier
This field is a decimal number which is used to modified the basic monthly ground reflectance
when snow is on the ground (from design day input or weather data values).

GroundReflectanceused

GroundReflectance ModifierSnow

The actual Ground Reflectance is limited to [0.0,1.0].

Field: Daylighting Ground Reflected Solar Modifier
This field is a decimal number which is used to modified the basic monthly ground reflectance
when snow is on the ground (from design day input or weather data values).

DaylightingGroundReflectanceused

GroundReflectance ModifierSnow

The actual Ground Reflectance is limited to [0.0,1.0].

An IDF example:
Site:GroundReflectance:SnowModifier,
1.0;
!- Ground Reflected Solar Modifier

Outputs will show both the inputs from the above object as well as monthly values for both
Snow Ground Reflectance and Snow Ground Reflectance for Daylighting.
Site:WaterMainsTemperature
The Site:WaterMainsTemperature object is used to calculate water temperatures delivered
by underground water main pipes. The mains temperatures are used as default, make-up
water temperature inputs for several plant objects, including: WaterUse:Equipment,
WaterUse:Connections, WaterHeater:Mixed and WaterHeater:Stratified. The mains
temperatures are also used in the water systems objects to model the temperature of cold
water supplies.
Water mains temperatures are a function of outdoor climate conditions and vary with time of
year. A correlation has been formulated to predict water mains temperatures based on two
weather inputs:

9/29/14

61

Input-Output Reference

Group -- Location Climate Weather File Access

average annual outdoor air temperature (dry-bulb)

maximum difference in monthly average outdoor air temperatures
These values can be easily calculated from annual weather data using a spreadsheet or from
the ".stat" file available with the EnergyPlus weather files at www.energyplus.gov. Monthly
statistics for dry-bulb temperatures are shown with daily averages. The daily averages are
averaged to obtain the annual average. The maximum and minimum daily average are
subtracted to obtain the maximum difference. For more information on the water mains
temperatures correlation, see the EnergyPlus Engineering Document.
Alternatively, the Site:WaterMainsTemperature object can read values from a schedule. This
is useful for measured data or when water comes from a source other than buried pipes, e.g.,
a river or lake.
If there is no Site:WaterMainsTemperature object in the input file, a default constant value of
10 C is assumed.
Field: Calculation Method
This field selects the calculation method and must have the keyword Schedule or Correlation.
Field: Schedule Name
If the calculation method is Schedule, the water mains temperatures are read from the
schedule referenced by this field. If the calculation method is Correlation, this field is ignored.
Field: Annual Average Outdoor Air Temperature
If the calculation method is Correlation, this field is used in the calculation as the annual
average outdoor air temperature (dry-bulb) [C]. If the calculation method is Schedule, this
field is ignored.
Field: Maximum Difference In Monthly Average Outdoor Air Temperatures
If the calculation method is Correlation, this field is used in the calculation as the maximum
difference in monthly average outdoor air temperatures [C]. If the calculation method is
Schedule, this field is ignored.
Site:WaterMainsTemperature,
Correlation, !- Calculation Method {SCHEDULE | CORRELATION}
, !- Schedule Name
9.69, !- Annual Average Outdoor Air Temperature {C}
28.1; !- Maximum Difference In Monthly Average Outdoor Air Temperatures
!- {deltaC}

Site:Precipitation
The Site:Precipitation object is used to describe the amount of water precipitation at the
building site over the course of the simulation run period. Precipitation includes both rain and
the equivalent water content of snow. Precipitation is not yet described well enough in the
many building weather data files. So this object can be used to provide the data using
Schedule objects that define rates of precipitation in meters per hour.
A set of schedules for site precipitation have been developed for USA weather locations and
are provided with EnergyPlus in the data set called PrecipitationSchedulesUSA.idf. The user
can develop schedules however they want. The schedules in the data set were developed
using EnergyPlus weather file (EPW) observations and the average monthly precipitation for
the closest weather site provided by NOAA. EPW files for the USA that were based on TMY
or TMY2 include weather observations for Light/Moderate/Heavy rainfall, however most
international locations do not include these observations. The values were modeled by taking
the middle of the ranges quoted in the EPW data dictionary. The assumed piecewise function
is shown below.

9/29/14

62

Input-Output Reference

Amount (m / hour )

Group -- Location Climate Weather File Access

Light 0.0125
Moderate 0.052
Heavy 0.1

The values were inserted on hour by hour basis for the month based on the observations.
Then each month was rescaled to meet the average precipitation for the month based on the
30-year average (1971-2000) provided by the NOAA/NCDC. Therefore, the flags in the EPW
file match the precipitation schedules for the USA. Note that summing the average monthly
precipitation values will not give you the average yearly precipitiation. The resulting value
may be lower or higher than the average yearly value.
Once the typical rainfall pattern and rates are scheduled, the Site:Precipitation object
provides a method of shifting the total rainfall up or down for design purposes. Wetter or drier
conditions can be modeled by changing the Design Annual Precipitation although the timing
of precipitation throughout the year will not be changed.
Field: Precipitation Model Type
Choose rainfall modeling options. Only available option is ScheduleAndDesignLevel.
Field: Design Level for Total Annual Precipitation
Magnitude of total precipitation for an annual period to be used in the model. Value selected
by the user to correspond with the amount of precipitation expected or being assumed for
design purposes. The units are in meters. This field works with the following two fields to
allow easily shifting the amounts without having to generate new schedules.
Field: Precipitation Rate Schedule Name
Name of a schedule defined elsewhere that describes the rate of precipitation. The
precipitation rate schedule is analogous to weather file data. However, weather files for
building simulation do not currently contain adequate data for such calculations. Therefore,
EnergyPlus schedules are used to enter the pattern of precipitation events. The values in this
schedule are the average rate of precipitation in meters per hour. The integration of these
values over an annual schedule should equal the nominal annual precipitation.
Field: Average Total Annual Precipitation
Magnitude of annual precipitation associated with the rate schedule. This value is used to
normalize the precipitation.
IDF example:
Site:Precipitation,
ScheduledAndDesignLevel,
0.75,
PrecipitationSchd,
0.80771;

!!!!-

Precipitation Model Type

Design Level Total Annual Precipitation {m/yr}
Schedule Name for Precipitation Rates
Average Total Annual Precipitation {m/yr}

RoofIrrigation
The RoofIrrigation object is used to describe the amount of irrigation on the ecoroof surface
over the course of the simulation runperiod. This object is used to provide irrigation data
using Schedule objects that define rates of irrigation in meters per hour. These schedules can
be one of two types: Schedule, or SmartSchedule.
Field: Irrigation Model Type
Choose irrigation modeling options. Available options are Schedule and SmartSchedule.
The Schedule type is used to force an irrigation schedule regardless of the current moisture
state of the soil. The SmartSchedule type allows the precipitation schedule to be overridden
if the current moisture state of the soil is greater than 40% saturated.
9/29/14

63

Input-Output Reference

Group -- Location Climate Weather File Access

Field: Irrigation Rate Schedule Name

Name of a schedule defined elsewhere that describes the rate of irrigation. The values in this
schedule are the average rate of irrigation in meters per hour.
Field: Irrigation Maximum Saturation Threshold
Used with the SmartSchedule option in the Irrigation Model Type field to override the default
40% saturation limit for turning off the irrigation: values of 0 to 100 (percent) can be entered
with 40% being the default.
IDF example:
RoofIrrigation,
Schedule, !- Irrigation Model Type
IrrigationSchd; !- Schedule Name for Irrigation Rates

Solar and Visible Spectrum Objects

The next two objects enable users to enter solar and visible spectrum which is used to
calculate the thermal and visual performance of windows if their glazings are defined with full
spectral data. EnergyPlus versions 8.0 and older hard-wired the solar and visible spectrum.
The solar spectrum assumes air mass 1.5 terrestrial solar global spectral irradiance values
(W/m2-micron) on a 37o tilted surface, based on ISO 9845-1 and ASTM E 892; derived from
Optics5 data file ISO-9845GlobalNorm.std, 10-14-99. The visible/photopic spectrum is based
on CIE 1931 observer; ISO/CIE 10527, CIE Standard Calorimetric Observers; derived from
Optics5 data file "CIE 1931 Color Match from E308.txt", which is the same as WINDOW4 file
Cie31t.dat.
Site:SolarAndVisibleSpectrum
The SolarAndVisibleSpectrum object is used to specify the solar and visible spectrum data
which is used as spectral weighting function to calculate the window performance
(transmittance and absorptance) in EnergyPlus. This is a unique object, if it is missing from
an IDF file, the default (same as EnergyPlus version 8.0) solar and visible spectrum data will
be used.
Field: Name
This field specifies the name of the SolarAndVisibleSpectrum object.
Field: Spectrum Data Method
This field specifies the method used to enter the spectrum data. Two choices are available:
Default and UserDefined. The choice Default will continue to use the hard-wired spectrum
data in EnergyPlus (for backward compatibility). The choice UserDefined allows users to
specify custom solar and visible spectrum data. The default choice is Default.
Field: Solar Spectrum Data Name
This field is required if the Spectrum Data Method is set to UserDefined. This field references
a spectrum dataset for solar.
Field: Visible Spectrum Data Name
This field is required if the Spectrum Data Method is set to UserDefined. This field references
a spectrum dataset for visible.
IDF example:
Site:SolarAndVisibleSpectrum,
LocalSpectrum,
!UserDefined,
!SolarSpectrum,
!VisibleSpectrum;
!-

9/29/14

Name
Spectrum Data Method: Default, UserDefined
Solar Spectrum Data Object Name
Visible Spectrum Data Object

64

Input-Output Reference

Group -- Location Climate Weather File Access

Site:SpectrumData
The Site:SpectrumData object holds the user defined solar or visible spectrum data. For solar
spectrum, up to 107 pairs of (wavelength, spectrum) can be entered. For visible spectrum, up
to 81 pairs can be entered.
Field: Name
This field specifies the name of the SpectrumData object. The name must be unique across
all SpectrumData objects.
Field: Spectrum Data Type
This field specifies the type of spectrum data. Choices are Solar and Visible.
Field: Wavelength <n>
This field specifies the nth wavelength in micron.
Field: Spectrum <n>
This field specifies the nth spectrum corresponding to the nth wavelength.
IDF example:
Site:SpectrumData,
SolarSpectrum,
Solar,
0.3,0,
0.305,3.4,
0.31,15.6,
0.315,41.1,
0.32,71.2,
0.325,100.2,
0.33,152.4,
0.335,155.6,
0.34,179.4,
0.345,186.7,
0.35,212,
0.36,240.5,
0.37,324,
0.38,362.4,
;

!- Name
!- Spectrum Data Type
!- up to 107 pair of (wavelength, spectrum)

Climate Group Outputs

Climate related variables appear in two places for EnergyPlus outputs. Certain objects that
are invariant throughout a simulation period have lines appear in the eplusout.eio file. For
descriptions of this reporting, please see the Output Details and Examples document.
Weather Data Related Outputs
Variables related to ambient environment data are available at timestep and higher
resolutions. Below is a variable dictionary of these variables and subsequent definitions:
Zone,Average,Site
Zone,Average,Site
Zone,Average,Site
Zone,Average,Site
Zone,Average,Site
Zone,Average,Site
Zone,Average,Site
Zone,Average,Site
Zone,Average,Site
Zone,Average,Site
Zone,Average,Site

9/29/14

Outdoor Air Drybulb Temperature [C]

Outdoor Air Dewpoint Temperature [C]
Outdoor Air Wetbulb Temperature [C]
Outdoor Air Humidity Ratio [kgWater/kgAir]
Outdoor Air Relative Humidity [%]
Outdoor Air Barometric Pressure [Pa]
Wind Speed [m/s]
Wind Direction [deg]
Sky Temperature [C]
Horizontal Infrared Radiation Rate per Area [W/m2]
Diffuse Solar Radiation Rate per Area [W/m2]

65

Input-Output Reference

Group -- Location Climate Weather File Access

Zone,Average,Site Direct Solar Radiation Rate per Area [W/m2]

Zone,Sum,Site Precipitation Depth [m]
Zone,Average,Site Ground Reflected Solar Radiation Rate per Area [W/m2]
Zone,Average,Site Ground Temperature [C]
Zone,Average,Site Surface Ground Temperature [C]
Zone,Average,Site Deep Ground Temperature [C]
Zone,Average,Site Simple Factor Model Ground Temperature [C]
Zone,Average,Site Outdoor Air Enthalpy [J/kg]
Zone,Average,Site Outdoor Air Density [kg/m3]
Zone,Average,Site Solar Azimuth Angle [deg]
Zone,Average,Site Solar Altitude Angle [deg]
Zone,Average,Site Solar Hour Angle [deg]
Zone,Average,Site Rain Status []
Zone,Average,Site Snow on Ground Status []
Zone,Average,Site Exterior Horizontal Sky Illuminance [lux]
Zone,Average,Site Exterior Horizontal Beam Illuminance [lux]
Zone,Average,Site Exterior Beam Normal Illuminance [lux]
Zone,Average,Site Sky Diffuse Solar Radiation Luminous Efficacy [lum/W]
Zone,Average,Site Beam Solar Radiation Luminous Efficacy [lum/W]
Zone,Average,Site Daylighting Model Sky Clearness []
Zone,Average,Sky Brightness for Daylighting Calculation []
Zone,Average,Site Daylight Saving Time Status []
Zone,Average,Site Day Type Index []
Zone,Average,Site Mains Water Temperature [C]
HVAC,Average,Site Precipitation Rate [m/s]
HVAC,Sum,Site Precipitation Depth [m]
HVAC,Sum,Water System Roof Irrigation Scheduled Depth[m]
HVAC,Sum,Water System Roof Irrigation Actual Depth[m]

Note that these data values may be interpolated from hour points (ref: Weather Data Hourly
Interpolation). Most of the data values represent the average over the reporting resolution period.

Site Outdoor Air Drybulb Temperature [C]

This is the outdoor dry-bulb temperature in degrees C.
Site Outdoor Air Dewpoint Temperature [C]
This is the outdoor dewpoint temperature in degrees C.
Site Outdoor Air Wetbulb Temperature [C]
The outdoor wet-bulb temperature is derived (at the timestep) from the values for dry-bulb
temperature, humidity ratio and barometric pressure.
Site Outdoor Air Humidity Ratio [kgWater/kgAir]
The outdoor humidity ratio is derived (at the timestep) from the dry-bulb temperature, relative
humidity and barometric pressure.
Site Outdoor Air Relative Humidity [%]
This is the outdoor relative humidity expressed in percent.
Site Outdoor Air Barometric Pressure [Pa]
This is the atmospheric/barometric pressure in Pa.
Site Wind Speed [m/s]
This is the outdoor wind speed in m/s.

9/29/14

66

Input-Output Reference

Group -- Location Climate Weather File Access

Site Wind Direction [deg]

This is the wind direction (N=0, E=90, S=180, W=270).
Site Sky Temperature [C]
The sky temperature is derived from horizontal infrared radiation intensity. It is expressed in
degrees C. The default calculation is shown below but this value may be modified by the
WeatherProperty:SkyTemperature object. Note that Sigma is the Stefan-Boltzmann constant
in the following equation:

Sky Temperature

Horizontal IR
Sigma

1
4

273.15Conversion from Kelvin to Centigrade

Site Horizontal Infrared Radiation Rate per Area [W/m2]

The horizontal infrared radiation intensity is expressed in W/m 2 based, if missing from the
weather file, on opaque sky cover, sky emissivity, temperature and other factors. The general
calculation of Site Horizontal Infrared Radiation Rate per Area is discussed in both the
Engineering Reference and the Auxiliary Programs document.
Site Diffuse Solar Radiation Rate per Area [W/m2]
Diffuse solar is the amount of solar radiation in W/m 2 received from the sky (excluding the
solar disk) on a horizontal surface.
Site Direct Solar Radiation Rate per Area [W/m2]
Site Direct Solar Radiation Rate per Area is amount of solar radiation in W/m 2 received within
a 5.7 field of view centered on the sun. This is also known as Beam Solar.
Site Precipitation Depth [m]
This is the amount of liquid precipitation (m). The source of this field may be the weather file
or the Site:Precipitation object. The weather file values are in millimeters, but the report here
is in meters. Two separate entities are displayed from the weather file the key value is
Environment; from the Site:Precipitation object the key value is Site:Precipitation.
If the weather file does not have a liquid precipitation field but does have the present weather
fields, then a heuristic calculation is attempted for both flagging when it is raining and the
amount of precipitation. If the weather file does have liquid precipitation fields, then the output
(e.g. monthly) can be compared with the weather file stat file.
Site Ground Reflected Solar Radiation Rate per Area [W/m2]
The ground reflected solar amount (W/m2) is derived from the Beam Solar, Diffuse Solar,
User specified Ground Reflectance (for month) and Solar Altitude Angle:

Groundreflectedsolar

Beamsolar COS ( SolarAltitudeAngle) Diffusesolar Groundreflectancemonth

where if the calculation returns a value < 0.0, then 0.0 will be reported.
Site Ground Temperature [C]
The ground temperature is reported in degrees C this is a user-specified input by month.
Site Surface Ground Temperature [C]
The ground temperature is reported in degrees C this is a user-specified input (object:
Site:GroundTemperature:Shallow) by month.

9/29/14

67

Input-Output Reference

Group -- Location Climate Weather File Access

Site Deep Ground Temperature [C]

The ground temperature is reported in degrees C this is a user-specified input (object:
Site:GroundTemperature:Deep) by month.
Site Simple Factor Model Ground Temperature [C]
The Site Simple Factor Model Ground Temperature is reported in degrees C this is a userspecified input (object: Site:GroundTemperature:FCfactorMethod) by month or gleaned from
the weather file as noted in the description of the object.
Site Outdoor Air Enthalpy [J/kg]
Outdoor enthalpy is derived at each timestep from the Site Outdoor Air Drybulb
Temperatureand the Site Outdoor Air Humidity Ratio. It is reported in J/kg.
Site Outdoor Air Density [kg/m3]
Outdoor air density is derived at each timestep from the Site Outdoor Air Barometric
Pressure, the Outdoor Dry-bulb temperature and the Outdoor Humidity Ratio. It is reported in
units kg/m3.
Site Solar Azimuth Angle [deg]
The Solar Azimuth Angle ( ) is measured from the North (clockwise) and is expressed in
degrees. This is shown more clearly in the following figure.

Figure 9. Solar Position Illustration

Site Solar Altitude Angle [deg]
The Solar Altitude Angle ( ) is the angle of the sun above the horizontal (degrees).
Site Solar Hour Angle [deg]
The Solar Hour Angle (H) gives the apparent solar time for the current time period (degrees).
It is common astronomical practice to express the hour angle in hours, minutes and seconds
of time rather than in degrees. You can convert the hour angle displayed from EnergyPlus to
time by dividing by 15. (Note that 1 hour is equivalent to 15 degrees; 360 of the Earths
rotation takes place every 24 hours.) The relationship of angles in degrees to time is shown
in the following table:
Table 6. Relationship of Angles (degrees) to Time
Unit of Angle

9/29/14

Equivalent time

68

Input-Output Reference

Group -- Location Climate Weather File Access

1 radian
1 degree
1 arcmin
1 arcsec

3.819719 hours
4 minutes
4 seconds
0.066667 seconds

Site Rain Status []

This field shows whether or not (1=yes, 0=no) the weather shows raining. For a Design
Day, one can denote rain for the entire day but not timestep by timestep. Weather files may
indicate rain for a single time interval. This is an averaged field thus a 1 shown for a time
period (e.g. daily reporting) means that it was raining during each timestep of that period.
Site Snow on Ground Status []
This field shows whether or not (1=yes, 0=no) the weather shows snow on the ground. For
a Design Day, one can denote snow for the entire day but not timestep by timestep. Weather
files may indicate snow (snow depth) for a single time interval. This is an averaged field
thus a 1 shown for a time period (e.g. daily reporting) means that there was snow on the
ground during each timestep of that period.
Site Daylight Saving Time Status []
This field shows when daylight saving time (1=yes, 0=no) is in effect. Though shown as an
average variable, this value is only set on a daily basis.
Site Day Type Index []
This field shows what day type the current day is. Daytypes are (1=Sunday, 2=Monday,
etc.) with Holiday=8, SummerDesignDay=9, WinterDesignDay=10, CustomDay1=11,
CustomDay2=12. Though shown as an average variable, this value is only set on a daily
basis.
Site Mains Water Temperature [C]
The value of the Water Mains Temperature is reported in C following the calculation shown in
the Water Mains Temperature object.
Site Precipitation Rate [m/s]
Site Precipitation Depth [m]
The rate and quantity of precipitation at the site. These outputs are only available if a Site
Precipication object is used. Precipitation is measured in meters.
Water System Roof Irrigation Scheduled Depth[m]
This is the scheduled amount of irrigation for the green roof (ecoroof) based on the user
input. Amount is measured in meters.
Water System Roof Irrigation Actual Depth[m]
This is the actual amount of irrigation for the green roof (ecoroof) based on the scheduled
user input and moisture state/saturation of the soil. Amount is measured in meters.
Outputs for local temperature/wind speed calculations
Local atmospheric properties for outdoor air temperature and wind speed are separately
calculated and reported for all zones, surfaces, and outdoor air nodes. The output variables
are associated with their respective objects:
Zone,Average,Zone Outdoor Air Drybulb Temperature [C]
Zone,Average,Zone Outdoor Air Wetbulb Temperature [C]
Zone,Average,Zone Outdoor Air Wind Speed [m/s]
Zone,Average,Surface Ext Outdoor Dry Bulb [C]
9/29/14

69

Input-Output Reference
Zone,Average,Surface Ext Outdoor Wet Bulb [C]
Zone,Average,Surface Ext Wind Speed [m/s]
HVAC,Average,System Node Temperature [C]

Group -- Schedules

(for OUTDOOR AIR NODE object)

Zone Outdoor Air Drybulb Temperature [C]

The outdoor air dry-bulb temperature calculated at the height above ground of the zone
centroid.
Zone Outdoor Air Wetbulb Temperature [C]
The outdoor air wet-bulb temperature calculated at the height above ground of the zone
centroid.
Zone Outdoor Air Wind Speed [m/s]
The outdoor wind speed calculated at the height above ground of the zone centroid.
Surface Ext Outdoor Dry Bulb [C]
The outdoor air dry-bulb temperature calculated at the height above ground of the surface
centroid.
Surface Ext Outdoor Wet Bulb [C]
The outdoor air wet-bulb temperature calculated at the height above ground of the surface
centroid.
Surface Ext Wind Speed [m/s]
The outdoor wind speed calculated at the height above ground of the surface centroid.
System Node Temperature [C]
When reporting for the OutdoorAir:Node object, this is the outdoor air dry-bulb temperature
calculated at the height above ground of the node, if height is specified in the input.

Group -- Schedules
This group of objects allows the user to influence scheduling of many items (such as
occupancy density, lighting, thermostatic controls, occupancy activity). In addition, schedules
are used to control shading element density on the building.
EnergyPlus schedules consist of three pieces: a day description, a week description, and an
annual description. An optional element is the schedule type. Each description level builds off
the previous sub-level. The day description is simply a name and the values that span the 24
hours in a day to be associated with that name. The week description also has an identifier
(name) and twelve additional names corresponding to previously defined day descriptions.
There are names for each individual day of the week plus holiday, summer design day, winter
design day and two more custom day designations. Finally, the annual schedule contains an
identifier and the names and FROM-THROUGH dates of the week schedules associate with
this annual schedule. The annual schedule can have several FROM-THROUGH date pairs.
One type of schedule reads the values from an external file to facilitate the incorporation of
monitored data or factors that change throughout the year.
Schedules are processed by the EnergyPlus Schedule Manager, stored within the Schedule
Manager and are accessed through module routines to get the basic values (timestep, hourly,
etc). Values are resolved at the Zone Timestep frequency and carry through any HVAC
timesteps.

9/29/14

70

Input-Output Reference

Group -- Schedules

Day Type
A brief description of Day Type which is used in the SizingPeriod objects,
RunPeriodControl:SpecialDays object, the Sizing objects and also used by reference in the
Schedule:Week:Daily object (discussed later in this section).
Schedules work on days of the week as well as certain specially designated days. Days of
the week are the normal Sunday, Monday, Tuesday, Wednesday, Thursday, Friday and
Saturday. Special day types that can be designated are: Holiday, SummerDesignDay,
WinterDesignDay, CustomDay1, CustomDay2. These day types can be used at the users
convenience to designate special scheduling (e.g. lights, electric equipment, set point
temperatures) using these days as reference.
For example, a normal office building may have normal occupancy rules during the
weekdays but significantly different use on weekend. For this, you would set up
rules/schedules based on the weekdays (Monday through Friday, in the US) and different
rules/schedules for the weekend (Saturday and Sunday, in the US). However, you could also
specially designate SummerDesignDay and WinterDesignDay schedules for sizing
calculations. These schedules can be activated by setting the Day Type field in the Design
Day object to the appropriate season (SummerDesignDay for cooling design calculations;
WinterDesignDay for heating design calculations).
In a different building, such as a theater/playhouse, the building may only have occupancy
during certain weeks of the year and/or certain hours of certain days. If it was every week,
you could designate the appropriate values during the regular days (Sunday through
Saturday). But this would also be an ideal application for the CustomDay1 and/or
CustomDay2. Here you would set the significant occupancy, lighting, and other schedules
for the custom days and use unoccupied values for the normal weekdays. Then, using a
weather file and setting special day periods as appropriate, you will get the picture of the
building usage during the appropriate periods.
ScheduleTypeLimits
Schedule types can be used to validate portions of the other schedules. Hourly day
schedules, for example, are validated by range -- minimum/maximum (if entered) -- as well as
numeric type (continuous or discrete). Annual schedules, on the other hand, are only
validated for range as the numeric type validation has already been done.
Field: Name
This alpha field should contain a unique (within the schedule types) designator. It is
referenced wherever Schedule Type Limits Names can be referenced.
Field: Lower Limit Value
In this field, the lower (minimum) limit value for the schedule type should be entered. If this
field is left blank, then the schedule type is not limited to a minimum/maximum value range.
Field: Upper Limit Value
In this field, the upper (maximum) limit value for the schedule type should be entered. If this
field is left blank, then the schedule type is not limited to a minimum/maximum value range.
Field: Numeric Type
This field designates how the range values are validated. Using Continuous in this field
allows for all numbers, including fractional amounts, within the range to be valid. Using
Discrete in this field allows only integer values between the minimum and maximum range
values to be valid.
Field: Unit Type
This field is used to indicate the kind of units that may be associated with the schedule that
references the ScheduleTypeLimits object. It is used by IDF Editor to display the appropriate
9/29/14

71

Input-Output Reference

Group -- Schedules

SI and IP units. This field is not used by EnergyPlus. The available options are shown below.
If none of these options are appropriate, select Dimensionless.
Dimensionless
Temperature
DeltaTemperature
PrecipitationRate
Angle
Convection Coefficient
Activity Level
Velocity
Capacity
Power
Availability
Percent
Control
Mode
Several IDF Examples will illustrate the use:
ScheduleTypeLimits,Any Number; ! Not limited
ScheduleTypeLimits,Fraction, 0.0 , 1.0 ,CONTINUOUS;
ScheduleTypeLimits,Temperature,-60,200,CONTINUOUS;
ScheduleTypeLimits,Control Type,0,4,DISCRETE;
ScheduleTypeLimits,On/Off,0,1,DISCRETE;

Day Schedules
The day schedules perform the assignment of pieces of information across a 24 hour day.
This can occur in various fashions including a 1-per hour assignment, a user specified
interval scheme or a list of values that represent an hour or portion of an hour.
Schedule:Day:Hourly
The Schedule:Day:Hourly contains an hour-by-hour profile for a single simulation day.
Field: Name
This field should contain a unique (within all DaySchedules) designation for this schedule. It
is referenced by WeekSchedules to define the appropriate schedule values.
Field: Schedule Type Limits Name
This field contains a reference to the Schedule Type Limits object. If found in a list of
Schedule Type Limits (see ScheduleTypeLimits object above), then the restrictions from the
referenced object will be used to validate the hourly field values (below).
Field: Hour Values (1-24)
These fields contain the hourly values for each of the 24 hours in a day. (Hour field 1
represents clock time 00:00:01 AM to 1:00:00 AM, hour field 2 is 1:00:01 AM to 2:00:00 AM,
etc.) The values in these fields will be passed to the simulation as indicated for scheduled
items.
An IDF example:
Schedule:Day:Hourly, Day On Peak, Fraction,
0.,0.,0.,0.,0.,0.,0.,0.,0.,1.,1.,1.,1.,1.,1.,1.,1.,1.,0.,0.,0.,0.,0.,0.;

9/29/14

72

Input-Output Reference

Group -- Schedules

Schedule:Day:Interval
The Schedule:Day:Interval introduces a slightly different way of entering the schedule values
for a day. Using the intervals, you can shorten the hourly input of the Schedule:Day:Hourly
object to 2 fields. And, more importantly, you can enter an interval that represents only a
portion of an hour. Schedule values are given to the simulation at the zone timestep, so
there is also a possibility of interpolation from the entries used in this object to the value
used in the simulation.
Field: Name
This field should contain a unique (within all DaySchedules) designation for this schedule. It
is referenced by WeekSchedules to define the appropriate schedule values.
Field: Schedule Type Limits Name
This field contains a reference to the Schedule Type Limits object. If found in a list of
Schedule Type Limits (see ScheduleTypeLimits object above), then the restrictions from the
referenced object will be used to validate the hourly field values (below).
Field: Interpolate to Timestep
The value contained in this field directs how to apply values that arent coincident with the
given timestep (ref: Timestep) intervals. If Yes is entered, then any intervals entered here
will be interpolated/averaged and that value will be used at the appropriate minute in the
hour. If No is entered, then the value that occurs on the appropriate minute in the hour will
be used as the schedule value.
For example, if yes is entered and the interval is every 15 minutes (say a value of 0 for the
first 15 minutes, then .5 for the second 15 minutes) AND there is a 10 minute timestep for the
simulation: the value at 10 minutes will be 0 and the value at 20 minutes will be .25. For the
same input entries but no for this field, the value at 10 minutes will be 0 and the value at 20
minutes will be .5.
Field-Set: Time and Value (extensible object)
To specify each interval, both an until time (which includes the designated time) and the
value must be given.
Field: Time
The value of each field should represent clock time (standard) in the format Until: HH:MM.
24 hour clock format (i.e. 1PM is 13:00) is used. Note that Until: 7:00 includes all times up
through 07:00 or 7am.
Field: Value
This represents the actual value to be passed to the simulation at the appropriate timestep.
(Using interpolation value as shown above). Limits on the values are indicated by the
Schedule Type Limits Name field of this object.
And an example of use:
Schedule:Day:Interval,
dd winter rel humidity,
Percent,
No,
until: 24:00,
74;

!- Name
!- Schedule Type Limits Name
!- Interpolate to Timestep
!- Time 1
!- Value Until Time 1

Schedule:Day:List
To facilitate possible matches to externally generated data intervals, this object has been
included. In similar fashion to the Schedule:Day:Interval object, this object can also include
sub-hourly values but must represent a complete day in its list of values.
9/29/14

73

Input-Output Reference

Group -- Schedules

Field: Name
This field should contain a unique (within all day schedules) designation for this schedule. It is
referenced by week schedules to define the appropriate schedule values.
Field: Schedule Type Limits Name
This field contains a reference to the Schedule Type Limits object. If found in a list of
Schedule Type Limits (see ScheduleTypeLimits object above), then the restrictions from the
referenced object will be used to validate the hourly field values (below).
Field: Interpolate to Timestep
The value contained in this field directs how to apply values that arent coincident with the
given timestep (ref: Timestep) intervals. If Yes is entered, then any intervals entered here
will be interpolated/averaged and that value will be used at the appropriate minute in the
hour. If No is entered, then the value that occurs on the appropriate minute in the hour will
be used as the schedule value.
For example, if yes is entered and the minutes per item is 15 minutes (say a value of 0 for
the first 15 minutes, then .5 for the second 15 minutes) AND there is a 10 minute timestep for
the simulation: the value at 10 minutes will be 0 and the value at 20 minutes will be .25. For
the same input entries but no for this field, the value at 10 minutes will be 0 and the value at
20 minutes will be .5.
Field: Minutes Per Item
This field allows the list interval to be specified in the number of minutes for each item. The
value here must be <= 60 and evenly divisible into 60 (same as the timestep limits).
Field Value 1 (same definition for each value up to 1440 (24*60) allowed)
This is the value to be used for the specified number of minutes.
For example:
Schedule:Day:List,
Myschedule, ! name
Fraction,
! Schedule type
No,
! Interpolate value
30,
! Minutes per item
0.0, ! from 00:01 to 00:30
0.5, ! from 00:31 to 01:00
<snipped>

Week Schedule(s)
The week schedule object(s) perform the task of assigning the day schedule to day types in
the simulation. The basic week schedule is shown next.
Schedule:Week:Daily
Field: Name
This field should contain a unique (within all WeekSchedules) designation for this schedule. It
is referenced by Schedules to define the appropriate schedule values.
Field: Schedule Day Name Fields (12 day types Sunday, Monday, )
These fields contain day schedule names for the appropriate day types. Days of the week (or
special days as described earlier) will then use the indicated hourly profile as the actual
schedule value.
An IDF example:
Schedule:Week:Daily, Week on Peak,
9/29/14

74

Input-Output Reference
Day
Day
Day
Day

Group -- Schedules
On
On
On
On

Peak,Day
Peak,Day
Peak,Day
Peak,Day

On
On
On
On

Peak,Day
Peak,Day
Peak,Day
Peak,Day

On
On
On
On

Peak,
Peak,
Peak,
Peak;

Schedule:Week:Compact
Further flexibility can be realized by using the Schedule:Week:Compact object. In this the
fields, after the name is given, a for field is given for the days to be assigned and then a
dayschedule name is used.
Field:Name
This field should contain a unique (within all WeekSchedules) designation for this schedule. It
is referenced by Schedules to define the appropriate schedule values.
Field-Set DayType List#, Schedule:Day Name #
Each assignment is made in a pair-wise fashion. First the days assignment and then the
dayschedule name to be assigned. The entire set of day types must be assigned or an error
will result.
Field: DayType List #
This field can optionally contain the prefix For for clarity. Multiple choices may then be
combined on the line. Choices are: Weekdays, Weekends, Holidays, Alldays,
SummerDesignDay, WinterDesignDay, Sunday, Monday, Tuesday, Wednesday, Thursday,
Friday, Saturday, CustomDay1, CustomDay2. In fields after the first for, AllOtherDays may
also be used. Note that the colon (:) after the For is optional but is suggested for readability.
Field: Schedule:Day Name #
This field contains the name of the day schedule (any of the Schedule:Day object names)
that is to be applied for the days referenced in the prior field.
Some IDF examples:
Schedule:Week:Compact, Week on Peak,
For: AllDays,
Day On Peak;
Schedule:Week:Compact, WeekDays on Peak,
WeekDays,
Day On Peak,
AllOtherDays
Day Off Peak;

Schedule:Year
The yearly schedule is used to cover the entire year using references to week schedules
(which in turn reference day schedules). If the entered schedule does not cover the entire
year, a fatal error will result.
Field: Name
This field should contain a unique (between Schedule:Year, Schedule:Compact, and
Schedule:File) designation for the schedule. It is referenced by various scheduled items
(e.g. Lights, People, Infiltration) to define the appropriate schedule values.
Field: Schedule Type Limits Name
This field contains a reference to the Schedule Type Limits object. If found in a list of
Schedule Type Limits (see ScheduleTypeLimits object above), then the restrictions from the
referenced object will be used to validate the hourly field values (below).

9/29/14

75

Input-Output Reference

Group -- Schedules

Field Set (WeekSchedule, Start Month and Day, End Month and Day)
Each of the designated fields is used to fully define the schedule values for the indicated time
period). Up to 53 sets can be used. An error will be noted and EnergyPlus will be terminated
if an incomplete set is entered. Missing time periods will also be noted as warning errors; for
these time periods a zero (0.0) value will be returned when a schedule value is requested.
Each of the sets has the following 5 fields:
Field: Schedule Week Name #
This field contains the appropriate WeekSchedule name for the designated time period.
Field: Start Month #
This numeric field is the starting month for the schedule time period.
Field: Start Day #
This numeric field is the starting day for the schedule time period.
Field: End Month #
This numeric field is the ending month for the schedule time period.
Field: End Day #
This numeric field is the ending day for the schedule time period.
Note that there are many possible periods to be described. An IDF example with a single
period:
Schedule:Year, On Peak, Fraction,
Week On Peak, 1,1, 12,31;

And a multiple period illustration:

Schedule:Year,CoolingCoilAvailSched,Fraction,
FanAndCoilAllOffWeekSched, 1,1, 3,31,
FanAndCoilSummerWeekSched, 4,1, 9,30,
FanAndCoilAllOffWeekSched, 10,1, 12,31;

The following definition will generate an error (if any scheduled items are used in the
simulation):
Schedule:Year,MySchedule,Fraction,4,1,9,30;

Schedule:Compact
For flexibility, a schedule can be entered in one fell swoop. Using the Schedule:Compact
object, all the features of the schedule components are accessed in a single command. Like
the regular schedule object, each schedule:compact entry must cover all the days for a
year. Additionally, the validations for DaySchedule (i.e. must have values for all 24 hours)
and WeekSchedule (i.e. must have values for all day types) will apply. Schedule values are
given to the simulation at the zone timestep, so there is also a possibility of interpolation
from the entries used in this object to the value used in the simulation.
This object is an unusual object for description. For the data the number of fields and position
are not set, they cannot really be described in the usual Field # manner. Thus, the following
description will list the fields and order in which they must be used in the object. The name
and schedule type are the exceptions:
Field: Name
This field should contain a unique (between Schedule:Year, Schedule:Compact, and
Schedule:File) designation for the schedule. It is referenced by various scheduled items
(e.g. Lights, People, Infiltration) to define the appropriate schedule values.
9/29/14

76

Input-Output Reference

Group -- Schedules

Field: Schedule Type Limits Name

This field contains a reference to the Schedule Type Limits object. If found in a list of
Schedule Type Limits (see ScheduleTypeLimits object above), then the restrictions from the
referenced object will be used to validate the hourly field values (below).
Field-Set (Through, For, Interpolate, Until, Value)
Each compact schedule must contain the elements Through (date), For (days), Interpolate
(optional), Until (time of day) and Value. In general, each of the titled fields must include the
title. Note that the colon (:) after these elements (Through, For, Until) is optional but is
suggested for readability.
Field: Through
This field starts with Through: and contains the ending date for the schedule period (may be
more than one). Refer to Table 3. Date Field Interpretation for information on date entry
note that only Month-Day combinations are allowed for this field. Each through field
generates a new WeekSchedule named Schedule Name_wk_# where # is the sequential
number for this compact schedule.
Field: For
This field starts with For: and contains the applicable days (reference the compact week
schedule object above for complete description) for the 24 hour period that must be
described. Each for field generates a new DaySchedule named Schedule Name_dy_#
where # is the sequential number for this compact schedule.
Field: Interpolate (optional)
This field, if used, starts with Interpolate: and contains the word Yes or No. If this field is
not used, it should not be blank rather just have the following field appear in this slot. The
definition of Interpolate in this context is shown in the interval day schedule above.
Field: Until
This field contains the ending time (again, reference the interval day schedule discussion
above) for the current days and day schedule being defined.
Field: Value
Finally, the value field is the schedule value for the specified time interval.

And, some IDF examples:

Schedule:Compact,
POFF,
!- Name
Fraction, !- Schedule Type Limits Name
Through: 4/30,
For: AllDays,
Until: 24:00, 1.0,
Through: 12/31,
For: Weekdays,
Until: 7:00,
.1,
Until: 17:00, 1.0,
Until: 24:00, .1,
For: Weekends Holidays,
Until: 24:00, .1,
For: AllOtherDays,
Until: 24:00, .1;
! Schedule Continuous
9/29/14

77

Input-Output Reference

Group -- Schedules

Schedule:Compact,
Continuous,
on/off,
Through: 12/31,
For: AllDays,
Until: 24:00, 1.0;
! Schedule Daytime Ventilation
Schedule:Compact,
Daytime Ventilation,
Fraction,
Through: 12/31,
For: Weekdays SummerDesignDay,
Until: 08:00, 0.0,
Until: 18:00, 1.0,
Until: 24:00, 0.0,
For: Weekends WinterDesignDay,
Until: 10:00, 0.0,
Until: 16:00, 1.0,
Until: 24:00, 0.0,
For: Holidays AllOtherDays,
Until: 24:00, 0.0;

Schedule:Constant
The constant schedule is used to assign a constant hourly value. This schedule is created
when a fixed hourly value is desired to represent a period of interest (e.g., always on
operation mode for supply air fan).
Field: Name
This field should contain a unique name designation for this schedule. It is referenced by
Schedules to define the appropriate schedule value.
Field: Schedule Type Limits Name
This field contains a reference to the Schedule Type Limits object. If found in a list of
Schedule Type Limits (see ScheduleTypeLimits object above), then the restrictions from the
referenced object will be used to validate the hourly field values (below).
Field: Hourly Value
This field contains a constant real value. A fixed value is assigned as an hourly value.
An IDF example:
Schedule:Constant,
AlwaysOn,
On/Off,
1.0;

!- Name
!- Schedule Type Limits Name
!- Hourly Value

ScheduleTypeLimits,
On/Off,
0,
1,
DISCRETE,
Availability;

!!!!!-

Name
Lower Limit Value
Upper Limit Value
Numeric Type
Unit Type

Schedule:File
At times, data is available from a building being monitored or for factors that change
throughout the year. The Schedule:File object allows this type of data to be used in

9/29/14

78

Input-Output Reference

Group -- Schedules

EnergyPlus as a schedule. Schedule:File can also be used to read in hourly or sub-hourly

schedules computed by other software or developed in a spreadsheet or other utility.
The format for the data file referenced is a text file with values separated by commas (or
other optional delimiters) with one line per hour. The file may contain header lines that are
skipped. The file should contain values for an entire year (8760 or 8784 hours of data) or a
warning message will be issued. Multiple schedules may be created using a single external
data file or multiple external data files may be used. The first row of data must be for January
1, hour 1 (or timestep 1 for subhourly files).
Schedule:File may be used along with the FuelFactors object and TDV files in the DataSets
directory to compute Time Dependent Valuation based source energy as used by the
California Energy Commissions Title 24 Energy Code. See Fuel Factor for more discussion
on Time Dependent Valuation.
Two optional fields: Interpolate to Timestep and Minutes per Item allow for the input of
sub-hourly schedules (similar to the Schedule:Day:List object).
Field: Name
This field should contain a unique (between Schedule:Year, Schedule:Compact, and
Schedule:File) designation for the schedule. It is referenced by various scheduled items
(e.g. Lights, People, Infiltration, FuelFactors) to define the appropriate schedule values.
Field: Schedule Type Limits Name
This field contains a reference to the Schedule Type Limits object. If found in a list of
Schedule Type Limits (see ScheduleTypeLimits object above), then the restrictions from the
referenced object will be used to validate the hourly field values (below).
Field: File Name
This field contains the name of the file that contains the data for the schedule. The field
should include a full path with file name, for best results. The field must be <= 100 characters.
The file name must not include commas or an exclamation point. A relative path or a simple
file name should work with version 7.0 or later when using EP-Launch even though EPLaunch uses temporary directories as part of the execution of EnergyPlus. If using
RunEPlus.bat to run EnergyPlus from the command line, a relative path or a simple file name
may work if RunEPlus.bat is run from the folder that contains EnergyPlus.exe.
Field: Column Number
The column that contains the value to be used in the schedule. The first column is column
one. If no data for a row appears for a referenced column the value of zero is used for the
schedule value for that hour.
Field: Rows to Skip at Top
Many times the data in a file contains rows (lines) that are describing the files or contain the
names of each column. These rows need to be skipped and the number of skipped rows
should be entered for this field. The next row after the skipped rows must contain data for
January 1, hour 1.
Field: Number of Hours of Data
The value entered in this field should be either 8760 or 8784 as the number of hours of data.
8760 does not include the extra 24 hours for a leap year (if needed). 8784 will include the
possibility of leap year data which can be processed according to leap year indicators in the
weather file or specified elsewhere. Note if the simulation does not have a leap year specified
but the schedule file contains 8784 hours of data, the first 8760 hours of data will be used.
The schedule manager will not know to skip the 24 hours representing Feburary 29.

9/29/14

79

Input-Output Reference

Group -- Schedules

Field: Column Separator

This field specifies the character used to separate columns of data if the file has more than
one column. The choices are: Comma, Tab, Fixed (spaces fill each column to a fixed width),
or Semicolon. The default is Comma.
Field: Interpolate to Timestep
The value contained in this field directs how to apply values that arent coincident with the
given timestep (ref: TimeStep object) intervals. If Yes is entered, then any intervals entered
here will be interpolated/averaged and that value will be used at the appropriate minute in the
hour. If No is entered, then the value that occurs on the appropriate minute in the hour will
be used as the schedule value.
For example, if yes is entered and the minutes per item is 15 minutes (say a value of 0 for
the first 15 minutes, then .5 for the second 15 minutes) AND there is a 10 minute timestep for
the simulation: the value at 10 minutes will be 0 and the value at 20 minutes will be .25. For
the same input entries but no for this field, the value at 10 minutes will be 0 and the value at
20 minutes will be .5.
Field: Minutes Per Item
This field represents the number of minutes for each item in this case each line of the file.
The value here must be <= 60 and evenly divisible into 60 (same as the timestep limits).
Here is an IDF example:
Schedule:File,
elecTDVfromCZ01res,
Any Number,
TDV_kBtu_CTZ01.csv,
2,
4,
8760,
Comma;

!!!!!!!-

Name
ScheduleType
Name of File
Column Number
Rows to Skip at Top
Number of Hours of Data
Column Separator

or with a relational path:

Schedule:File,
elecTDVfromCZ01res,
!- Name
Any Number,
!- ScheduleType
DataSets\TDV\TDV_kBtu_CTZ01.csv,
!- Name of File
2,
!- Column Number
4;
!- Rows to Skip at Top

A sub-hourly indication. Note that this is identical to an hourly file because there are 60
minutes per item the number of hours defaults to 8760 and the column separator defaults to
a comma. If the number of minutes per item had been, say, 15, then the file would need to
contain 8760*4 or 35,040 rows for this item.
Schedule:File,
elecTDVfromCZ06com,
!- Name
Any Number,
!- Schedule Type Limits Name
DataSets\TDV\TDV_2008_kBtu_CTZ06.csv, !- File Name
1,
!- Column Number
4,
!- Rows to Skip at Top
,
!- Number of Hours of Data
,
!- Column Separator
,
!- Interpolate to Timestep
60;
!- Minutes per Item

Schedule Outputs
An optional report can be used to gain the values described in the previous Schedule objects.
This is a condensed reporting that illustrates the full range of schedule values in the style of
input: DaySchedule, WeekSchedule, Annual Schedule.
9/29/14

80

Input-Output Reference

Group Surface Construction Elements

! will give them on hourly increments (day schedule resolution)

Output:Reports, Schedules, Hourly;
! will give them at the timestep of the simulation
Output:Reports, Schedules, Timestep;

This report is placed on the eplusout.eio file. Details of this reporting are shown in the Output
Details and Examples document.
Schedule Value Output
Zone,Average,Schedule Value []

Schedule Value
This is the schedule value (as given to whatever entity that uses it). It has no units in this
context because values may be many different units (i.e. temperatures, fractions, watts). For
best results, you may want to apply the schedule name when you use this output variable to
avoid output proliferation. For example, the following reporting should yield the values shown
above, depending on day of week and day type:
Output:Variable,People_Shopping_Sch,Schedule Value,hourly;
Output:Variable,Activity_Shopping_Sch,Schedule Value,hourly;

Group Surface Construction Elements

This group of objects describes the physical properties and configuration for the building
envelope and interior elements. That is, the walls, roofs, floors, windows, doors for the
building.
Specifying the Building Envelope
Building element constructions in EnergyPlus are built from the basic thermal and other
material property parameters in physical constructions. Materials are specified by types and
named. Constructions are defined by the composition of materials. Finally, surfaces are
specified for the building with geometric coordinates as well as referenced constructions.
Material and Material Properties
There are several material types which may be used to describe layers within opaque
construction elements. The choice of which of these types to use is left up to the user.
However, some guidance as to which material type to use is appropriate before describing
each in detail. The opaque types are:
Material
Material:NoMass
Material:AirGap
Material:RoofVegetation
Material:InfraredTransparent
Material is the preferred type of material. This requires knowledge of many of the thermal
properties of the material, but it allows EnergyPlus to take into account the thermal mass of
the material and thus allows the evaluation of transient conduction effects. Material:NoMass
is similar in nature but only requires the thermal resistance (R-value) rather than the
thickness, thermal conductivity, density, and specific heat. Note that using a simple R-value
only material forces EnergyPlus to assume steady state heat conduction through this material
layer. Finally, Material:AirGap should only be used for an air gap between other layers in a
construction. This type assumes that air is sufficiently lightweight to require only an R-value.
In addition, since it is not exposed to any external environment, surface properties such as
absorptance are not necessary. Material:RoofVegetation is used to help model green roofs.
Material:InfraredTransparent is used similarly to the NoMass materials. Each of these
materials is described in more detail below.
9/29/14

81

Input-Output Reference

Group Surface Construction Elements

There are several material additions that can be made to the basic material properties. These
additional material types are:
MaterialProperty:MoisturePenetrationDepth:Settings
MaterialProperty:HeatAndMoistureTransfer:SorptionIsotherm
MaterialProperty:HeatAndMoistureTransfer:Diffusion
MaterialProperty:HeatAndMoistureTransfer:Settings
MaterialProperty:HeatAndMoistureTransfer:Redistribution
MaterialProperty:HeatAndMoistureTransfer:Suction
MaterialProperty:HeatAndMoistureTransfer:ThermalConductivity
MaterialProperty:PhaseChange
These material property objects are used in conjunction with the basic material specification
and reference back to the name of the basic material type. Without the basic material type
specified the program, will give a severe error and terminate. For example, specifying the
moisture materials and changing the HeatBalanceAlgorithm to a moisture simulation will
allow the moisture simulation to take place.
Material
This definition should be used when the four main thermal properties (thickness, conductivity,
density, and specific heat) of the material are known. This syntax is used to describe opaque
construction elements only.
When a Material is used for the Construction of a building surface, care should be taken to
not attempt to model assemblies that were not included in the intended scope of applicability
for the underlying heat transfer models. The building surface models are for normal
applications to building energy efficiency where the main focus is on assemblies with some
thermal resistance. Extremely thin and/or highly conductive material layers should be
neglected from the Construction rather than included because they will not contribute to the
assemblys overall thermal resistance or heat capacity. For some cases, thin and/or highly
conductive materials are a serious problem for the heat transfer modeling and the values for
thickness, conductivity, density and specific heat are checked for appropriateness. This
check calculates the Materials thermal diffusivity from the inputs for conductivity, density, and
specific heat and compares it to a maximum threshold of 1.E-5 (m2/s). If the diffusivity is
above this threshold, then the program checks if the layer is sufficiently thick and may issue a
warning if it is too thin and highly conductive.
The absorptance values in this object impart surface properties to the construction and
should be applied to the thermally significant inner and outer layers in the overall assembly.
Attempting to trick the program by modeling thin paint layers to apply surface properties is
not a good idea; the models were not intended to support such strategies.
Field: Name
This field is a unique reference name that the user assigns to a particular material. This name
can then be referred to by other input data (ref: Construction object).
Field: Roughness
This alpha field defines the relative roughness of a particular material layer. This parameter
only influences the convection coefficients, more specifically the exterior convection
coefficient. A special keyword is expected in this field with the options being VeryRough,
Rough, MediumRough, MediumSmooth, Smooth, and VerySmooth in order of
roughest to smoothest options.
Field: Thickness
This field characterizes the thickness of the material layer in meters. This should be the
dimension of the layer in the direction perpendicular to the main path of heat conduction. This
9/29/14

82

Input-Output Reference

Group Surface Construction Elements

value must be a positive. Modeling layers thinner (less) than 0.003 m is not
recommended; rather, add those properties to one of the adjacent layers.
Field: Conductivity
This field is used to enter the thermal conductivity of the material layer. Units for this
parameter are W/(m-K). Thermal conductivity must be greater than zero. Modeling layers
with conductivity higher than 5.0 W/(m-K) is not recommended; however, this may be
appropriate for non-surfaces such as pipes and TDDs (ref. DaylightingDevice:Tubular
object).
Field: Density
This field is used to enter the density of the material layer in units of kg/m 3. Density must be a
positive quantity. In some cases textbooks and references may use g/m 3: be careful to
not confuse units.
Field: Specific Heat
This field represents the specific heat of the material layer in units of J/(kg-K). Note that these
units are most likely different than those reported in textbooks and references which tend to
use kJ/(kg-K) or J/(g-K). They were chosen for internal consistency within EnergyPlus. Only
values of specific heat of 100 or larger are allowed. Typical ranges are from 800 to
2000 J/(kg-K).
Field: Thermal Absorptance
The thermal absorptance field in the Material input syntax represents the fraction of incident
long wavelength radiation that is absorbed by the material. This parameter is used when
calculating the long wavelength radiant exchange between various surfaces and affects the
surface heat balances (both inside and outside as appropriate). For long wavelength radiant
exchange, thermal emissivity and thermal emittance are equal to thermal absorptance.
Values for this field must be between 0.0 and 1.0 (with 1.0 representing black body
conditions).
Field: Solar Absorptance
The solar absorptance field in the Material input syntax represents the fraction of incident
solar radiation that is absorbed by the material. Solar radiation includes the visible spectrum
as well as infrared and ultraviolet wavelengths. This parameter is used when calculating the
amount of incident solar radiation absorbed by various surfaces and affects the surface heat
balances (both inside and outside as appropriate). If solar reflectance (or reflectivity) data is
available, then absorptance is equal to 1.0 minus reflectance (for opaque materials). Values
for this field must be between 0.0 and 1.0.
Field: Visible Absorptance
The visible absorptance field in the Material input syntax represents the fraction of incident
visible wavelength radiation that is absorbed by the material. Visible wavelength radiation is
slightly different than solar radiation in that the visible band of wavelengths is much more
narrow while solar radiation includes the visible spectrum as well as infrared and ultraviolet
wavelengths. This parameter is used when calculating the amount of incident visible radiation
absorbed by various surfaces and affects the surface heat balances (both inside and outside
as appropriate) as well as the daylighting calculations. If visible reflectance (or reflectivity)
data is available, then absorptance is equal to 1.0 minus reflectance (for opaque materials).
Values for this field must be between 0.0 and 1.0.
An IDF example:
Material,A2 - 4 IN DENSE FACE BRICK, ! Material Name
Rough, ! Roughness
0.1014984
, ! Thickness {m}
1.245296
,
! Conductivity {W/M*K}
9/29/14

83

Input-Output Reference
2082.400
920.4800
0.9000000
0.9300000
0.9300000

Group Surface Construction Elements

,

,
,
;

! Density {Kg/M**3}
! Specific Heat {J/Kg*K}
! Thermal Absorptance
! Solar Absorptance
! Visible Absorptance

Material:NoMass
Use this definition when only the thermal resistance (R value) of the material is known. This
object is used to describe opaque construction elements.
Field: Name
This field is a unique reference name that the user assigns to a particular material. This name
can then be referred to by other input data (ref: Construction object).
Field: Roughness
This alpha field defines the relative roughness of a particular material layer. This parameter
only influences the convection coefficients, more specifically the exterior convection
coefficient. A keyword is expected in this field with the options being VeryRough, Rough,
MediumRough, MediumSmooth, Smooth, and VerySmooth in order of roughest to
smoothest options.
Field: Thermal Resistance
This field is used to enter the thermal resistance (R-value) of the material layer. Units for this
parameter are (m2-K)/W. Thermal resistance must be greater than zero. Note that most Rvalues in the USA are calculated in Inch-Pound units and must be converted to the SI
equivalent.
Field: Thermal Absorptance
The thermal absorptance field in the Material input syntax represents the fraction of incident
long wavelength radiation that is absorbed by the material. This parameter is used when
calculating the long wavelength radiant exchange between various surfaces and affects the
surface heat balances (both inside and outside as appropriate). For long wavelength radiant
exchange, thermal emissivity and thermal emittance are equal to thermal absorptance.
Values for this field must be between 0.0 and 1.0 (with 1.0 representing black body
conditions).
Field: Solar Absorptance
The solar absorptance field in the Material input syntax represents the fraction of incident
solar radiation that is absorbed by the material. Solar radiation includes the visible spectrum
as well as infrared and ultraviolet wavelengths. This parameter is used when calculating the
amount of incident solar radiation absorbed by various surfaces and affects the surface heat
balances (both inside and outside as appropriate). If solar reflectance (or reflectivity) data is
available, then absorptance is equal to 1.0 minus reflectance (for opaque materials). Values
for this field must be between 0.0 and 1.0.
Field: Visible Absorptance
The visible absorptance field in the Material input syntax represents the fraction of incident
visible wavelength radiation that is absorbed by the material. Visible wavelength radiation is
slightly different than solar radiation in that the visible band of wavelengths is much more
narrow while solar radiation includes the visible spectrum as well as infrared and ultraviolet
wavelengths. This parameter is used when calculating the amount of incident visible radiation
absorbed by various surfaces and affects the surface heat balances (both inside and outside
as appropriate) as well as the daylighting calculations. If visible reflectance (or reflectivity)
data is available, then absorptance is equal to 1.0 minus reflectance (for opaque materials).
Values for this field must be between 0.0 and 1.0.
9/29/14

84

Input-Output Reference

Group Surface Construction Elements

An IDF example:
Material:NoMass,R13LAYER, ! Material Name
Rough, ! Roughness
2.290965
, ! Resistance {M**2K/W}
0.9000000
,
! Thermal Absorptance
0.7500000
,
! Solar Absorptance
0.7500000
;
! Visible Absorptance

Material:InfraredTransparent
A Infrared Transparent surface is similar to a resistance-only surface. The idd object for this
type of surface is shown below. The surface will actually participate in the transfer of visible
and solar radiation by doing a wavelength transformation and making all short wave length
radiation that is incident on the surface into long wave length radiation and having it
participate in the long wavelength radiant exchange. Note the ConvectionCoefficient
instructions that follow the Infrared Transparent construction object below.
Field: Name
This field contains the unique name (across all Material objects) for the Infrared Transparent
material.
A Infrared Transparent surface should not participate in a convective/conductive exchange
between the zones it separates. In order to minimize this effect, the ConvectionCoefficients
object must be used for the surfaces referencing the Infrared Transparent (IRT) construction.
An example idf object specification for use with the IRT surface is shown below. Note that
surfaces are not described in this example
Material:InfraredTransparent,
IRTMaterial1;
!- Name
Construction,
IRTSurface,
IRTMaterial1;

!- Name
!- Outside Layer

SurfaceProperty:ConvectionCoefficients,
Bottom:Top,
!- SurfaceName
Outside,
!- Convection Type 1
value,
!- Convection Value Type 1
0.1,
!- Convection value 1 {W/m2-K}
,
!- Convection Schedule 1
Inside,
!- Convection Type 2
value,
!- Convection Value Type 2
0.1;
!- Convection value 2 {W/m2-K}
SurfaceProperty:ConvectionCoefficients,
SecondLevel:Bottom,
!- SurfaceName
Outside,
!- Convection Type 1
value,
!- Convection Value Type 1
0.1,
!- Convection value 1 {W/m2-K}
,
!- Convection Schedule 1
Inside,
!- Convection Type 2
value,
!- Convection Value Type 2
0.1;
!- Convection value 2 {W/m2-K}
SurfaceProperty:ConvectionCoefficients,
SecondLevel:Top,
!- SurfaceName
Outside,
!- Convection Type 1
value,
!- Convection Value Type 1
0.1,
!- Convection value 1 {W/m2-K}
,
!- Convection Schedule 1
9/29/14

85

Input-Output Reference
Inside,
value,
0.1;

Group Surface Construction Elements

!- Convection Type 2
!- Convection Value Type 2
!- Convection value 2 {W/m2-K}

SurfaceProperty:ConvectionCoefficients,
ThirdLevel:Bottom,
!- SurfaceName
Outside,
!- Convection Type 1
value,
!- Convection Value Type 1
0.1,
!- Convection value 1 {W/m2-K}
,
!- Convection Schedule 1
Inside,
!- Convection Type 2
value,
!- Convection Value Type 2
0.1;
!- Convection value 2 {W/m2-K}

Material:AirGap
This material is used to describe the air gap in an opaque construction element. Glass
elements use a different property (WindowGas) to describe the air between two glass layers.
Field: Name
This field is a unique reference name that the user assigns to a particular material. This name
can then be referred to by other input data (ref: Construction object).
Field: Thermal Resistance
This field is used to enter the thermal resistance (R-value) of the material layer. Units for this
parameter are (m 2-K)/W. Thermal resistance must be greater than zero. Note that most Rvalues in the USA are calculated in Inch-Pound units and must be converted to the SI
equivalent.
An IDF example:
Material:AirGap,B1 - AIRSPACE RESISTANCE,
0.1603675
; ! Resistance {M**2K/W}

! Material Name

MaterialProperty:MoisturePenetrationDepth:Settings
This material is used to describe the five moisture material properties that are used in the
EMPD (Effective Moisture Penetration Depth) heat balance solution algorithm (known there
as MoisturePenetrationDepthConductionTransferFunction). The EMPD algorithm is a
simplified, lumped moisture model that simulates moisture storage and release from interior
surfaces. The model uses "actual" convective mass transfer coefficients that are determined
by existing heat and mass transfer relationships, e.g. the Lewis relation. An effective moisture
penetration depth may be determined from either experimental or detailed simulation data by
using actual surface areas and moisture sorption isotherms.
This moisture model will be used when the appropriate EMPD moisture materials are
specified and the Solution Algorithm parameter is set to EMPD.
Field: Name
This field is a unique reference name that the user assigns to a particular material. This name
can then be referred to by other input data (ref: Construction object).
Field: Moisture Penetration Depth
This field is used to enter the effective moisture penetration depth of the material layer. Units
for this parameter are (m).
Field: Constants to Define Moisture Equilibrium Equation
The next four fields, coefficients a, b, c, and d, help define the sorption isotherm curve
used for building materials under equilibrium conditions. They are used to define the
9/29/14

86

Input-Output Reference

Group Surface Construction Elements

relationship between the materials moisture content and the surface air relative humidity (ref:
Effective Moisture Penetration Depth (EMPD) Model in the Engineering Reference):

where
a,b,c,d
= Coefficients to define the relationship between the materials moisture
content and the surface air relative humidity
U
= Moisture content defined as the mass fraction of water contained in a
material [kg/kg]
= Surface air relative humidity [0 to 1]
The next four fields are dimensionless coefficients:
Field: Moisture Equation Coefficient a
Field: Moisture Equation Coefficient b
Field: Moisture Equation Coefficient c
Field: Moisture Equation Coefficient d
Ann IDF example showing how it is used in conjunction with Material in synchronous pairs:
Material,
E1 - 3 / 4 IN PLASTER OR GYP BOARD, !- Name
Smooth,
!- Roughness
1.9050000E-02,
!- Thickness {m}
0.7264224,
!- Conductivity {W/m-K}
1601.846,
!- Density {kg/m3}
836.8000,
!- Specific Heat {J/kg-K}
0.9000000,
!- Thermal Absorptance
0.9200000,
!- Solar Absorptance
0.9200000;
!- Visible Absorptance

MaterialProperty:MoisturePenetrationDepth:Settings,
E1 - 3 / 4 IN PLASTER OR GYP BOARD, !- Name
0.004,
!- Effective Moisture Penetration Depth {m}
0.072549,
!- Moisture Equation Coefficient a {dimensionless}
0.397173,
!- Moisture Equation Coefficient b {dimensionless}
0.007774,
!- Moisture Equation Coefficient c {dimensionless}
11.7057;
!- Moisture Equation Coefficient d {dimensionless}
Material,
C10 - 8 IN HW CONCRETE,
MediumRough,
0.2033016,
1.729577,
2242.585,
836.8000,
0.9000000,
0.6500000,
0.6500000;

!!!!!!!!!-

Name
Roughness
Thickness {m}
Conductivity {W/m-K}
Density {kg/m3}
Specific Heat {J/kg-K}
Thermal Absorptance
Solar Absorptance
Visible Absorptance

MaterialProperty:MoisturePenetrationDepth:Settings,
C10 - 8 IN HW CONCRETE, !- Name
0.004,
!- Effective Moisture Penetration Depth {m}
9/29/14

87

Input-Output Reference

Group Surface Construction Elements

0.018062,
0.451879,
0.026178,
10.8356;

!!!!-

Moisture
Moisture
Moisture
Moisture

Equation
Equation
Equation
Equation

Coefficient
Coefficient
Coefficient
Coefficient

a
b
c
d

{dimensionless}
{dimensionless}
{dimensionless}
{dimensionless}

Moisture Penetration Depth (EMPD) Outputs

Output variables applicable to heat transfer surfaces using EMPD model:
Zone,Average,EMPD Surface Inside Face Water Vapor Density [kg/m3]
Zone,Average,EMPD Surface Inside Face Humidity Ratio [kgWater/kgDryAir]
Zone,Average,EMPD Surface Inside Face Relative Humidity [%]

The following variables apply only to surfaces, where the material assigned to the inside
layers is MaterialProperty:MoisturePenetrationDepth:Settings. The EMPD (Effective Moisture
Penetration Depth) moisture balance solution algorithm is used to calculate the inside surface
moisture levels.
EMPD Surface Inside Face Water Vapor Density [kg/m3]
The vapor density at the inside surface, where the EMPD moisture balance solution algorithm
is applied.
EMPD Surface Inside Face Humidity Ratio [kgWater/kgDryAir]
The humidity ratio at the inside surface, where the EMPD moisture balance solution algorithm
is applied.
EMPD Surface Inside Face Relative Humidity [%]
The relative humidity at the inside surface, where the EMPD moisture balance solution
algorithm is applied.
MaterialProperty:PhaseChange
Advanced/Research Usage: This material is used to describe the temperature dependent
material properties that are used in the Conduction Finite Difference solution algorithm. This
conduction model is done when the appropriate materials are specified and the Solution
Algorithm parameter is set to ConductionFiniteDifference. This permits simulating
temperature dependent thermal conductivity and phase change materials (PCM) in
EnergyPlus.
Field: Name
This field is a regular material name specifying the material with which this additional
temperature dependent property information will be associated.
Field: Temperature Coefficient for Thermal Conductivity
This field is used to enter the temperature dependent coefficient for thermal conductivity of
the material. Units for this parameter are (W/(m-K2). This is the thermal conductivity change
per unit temperature excursion from 20 C. The conductivity value at 20 C is the one specified
with the basic material properties of the regular material specified in the name field. The
thermal conductivity is obtained from:

ko

k1 (Ti

20)

where:
ko is the 20C value of thermal conductivity(normal idf input)
k1 is the change in conductivity per degree temperature difference from 20C
(this field).

9/29/14

88

Input-Output Reference

Group Surface Construction Elements

Field Set: Temperature-Enthalpy

The temperature enthalpy set of inputs specify a two column tabular temperature-enthalpy
function for the basic material. Sixteen pairs can be specified. Specify only the number of
pairs necessary. The tabular function must cover the entire temperature range that will be
seen by the material in the simulation. It is suggested that the function start at a low
temperature, and extend to 100C. Note that the function has no negative slopes and the
lowest slope that will occur is the base material specific heat. Temperature values should be
strictly increasing. Enthalpy contributions of the phase change are always added to the
enthalpy that would result from a constant specific heat base material. An example of a
simple enthalpy temperature function is shown below.

Field: Temperature x
This field is used to specify the temperature of the temperature-enthalpy function for the basic
material. Units are C.
Field: Enthalpy x
This field specifies the enthalpy that corresponds to the previous temperature of the
temperature-enthalpy function. Units are J/kg.
And, an IDF example showing how it is used in conjunction with the Material:
Note, the following Heat Balance Algorithm is necessary (only specified once). Also, when
using ConductionFiniteDifference, it is more efficient to set the zone timestep shorter than
those used for the ConductionTransferFunction solution algorithm. It should be set to 12
timesteps per hour or greater, and can range up to 60.
HeatBalanceAlgorithm,
ConductionFiniteDifference;
Timestep,
12;
Material,
E1 - 3 / 4 IN PLASTER OR GYP BOARD, !- Name
Smooth,
!- Roughness
1.9050000E-02,
!- Thickness {m}
0.7264224,
!- Conductivity {W/m-K}
1601.846,
!- Density {kg/m3}
836.8000,
!- Specific Heat {J/kg-K}
0.9000000,
!- Thermal Absorptance
0.9200000,
!- Solar Absorptance
0.9200000;
!- Visible Absorptance

9/29/14

89

Input-Output Reference

Group Surface Construction Elements

MaterialProperty:PhaseChange,
E1 - 3 / 4 IN PLASTER OR GYP BOARD, !- Name
0.0,
!- Temperature coefficient,thermal conductivity(W/m K2)
-20.,
!- Temperature 1, C
0.01,
!- Enthalpy 1 at 20C, (J/kg)
20.,
!- Temperature 2, C
33400,
!- Enthalpy 2, (J/kg)
20.5,
!- temperature 3, C
70000,
!- Ethalpy 3, (J/kg)
100.,
!- Temperature 4, C
137000;
!- Enthalpy 4, (J/kg)

MaterialProperty:VariableThermalConductivity
This object is used to describe the temperature dependent material properties that are used
in the CondFD (Conduction Finite Difference) solution algorithm. This conduction model is
used when the appropriate CondFD materials are specified and the Solution Algorithm
parameter is set to condFD.
Field: Name
This field is a regular material name specifying the material with which this additional
temperature dependent property information will be associated.
Field Set: Temperature-Thermal Conductivity
The temperature conductivity set of inputs specify a two column tabular temperaturethermal conductivity function for the basic material. Ten pairs can be specified. Specify only
the number of pairs necessary. Temperature values should be strictly increasing.
Field: Temperature x
This field is used to specify the temperature of the temperature-conductivity function for the
basic material. Units are C.
Field: Thermal Conductivity x
This field specifies the conductivity that corresponds to the temperature (previous field) of the
temperature-conductivity function. Units are W/m-K.
And, an IDF example showing how it is used in conjunction with the Materials:
Note, the following Heat Balance Algorithm is necessary (only specified once). Also, when
using Conduction Finite Difference, it is more efficient to set the zone time step shorter than
those used for the Conduction Transfer Function solution algorithm. It should be set to 12
time steps per hour or greater, and can range up to 60.
HeatBalanceAlgorithm,
ConductionFiniteDifference;
Timestep,
12;
Material,
PCMPlasterBoard ,
Smooth,
1.9050000E-02,
4.2,
1601.846,
836.8000,
0.9000000,
0.9200000,
0.9200000;

9/29/14

!- Name
!- Roughness
!- Thickness {m}
!- Conductivity {W/m-K}
!- Density {kg/m3}
!- Specific Heat {J/kg-K}
!- Thermal Absorptance
!- Solar Absorptance
!- Visible Absorptance

90

Input-Output Reference

Group Surface Construction Elements

MaterialProperty:VariableThermalConductivity,
PCMPlasterBoard,
!- Name
0,
!- Temperature 1 {C}
4.2,
!- Thermal Conductivity
22,
!- Temperature 2 {C}
4.2,
!- Thermal Conductivity
22.1,
!- Temperature 3 {C}
2.5,
!- Thermal Conductivity
100,
!- Temperature 4 {C}
2.5;
!- Thermal Conductivity

1 {W/m-K}
2 {W/m-K}
3 {W/m-K}
4 {W/m-K}

Conduction Finite Difference (CondFD) Outputs

The Conduction Finite Difference solution algorithm uses a finite difference solution
technique, the surfaces are divided into a nodal arrangement. The only output specific to
Conduction Finite Difference solution (that is not include in other surface outputs) is node
temperatures.
The following output variables are applicable to all opaque heat transfer surfaces when using
Solution Algorithms ConductionFiniteDifference:
Zone,Sum,CondFD Inner Solver Loop Iteration Count []
Zone,Average,CondFD Surface Temperature Node <1 N> [C]

CondFD Inner Solver Loop Iteration Count []

This outputs the count of iterations on the inner solver loop of CondFD for each surface.
CondFD Surface Temperature Node <X> [C]
This will output temperatures for a node in the surfaces being simulated with
ConductionFiniteDifference. The key values for this output variable are the surface name.
The nodes are numbered from outside to inside of the surface. The full listing will appear in
the RDD file
MaterialProperty:HeatAndMoistureTransfer:Settings
Advanced/Research Usage: This object is used to describe two of the seven additional
material properties needed for the CombinedHeatAndMoistureFiniteElement heat balance
solution algorithm. The settings object is used when the solutions algorithm is set to
CombinedHeatAndMoistureFiniteElement and the appropriate material properties are
assigned to each material. This permits the simulation of the moisture dependant thermal
properties of the material as well as the transfer of moisture through, into and out of the
material into the zone or exterior.
In addition to the Porosity and Initial Water content properties described here, five additional
properties, described by tabulated relationships between variables, are required. These
properties are;
MaterialProperty:HeatAndMoistureTransfer:SorptionIsotherm
MaterialProperty:HeatAndMoistureTransfer:Suction
MaterialProperty:HeatAndMoistureTransfer:Redistribution
MaterialProperty:HeatAndMoistureTransfer:Diffusion
MaterialProperty:HeatAndMoistureTransfer:ThermalConductivity
All materials in a construction are required to have all material properties defined for HAMT to
work.
Within the MaterialProperty:HeatAndMoistureTransfer:Settings object the following fields are
defined.

9/29/14

91

Input-Output Reference

Group Surface Construction Elements

Field: Material Name

This field is a unique reference name that the user assigns to a particular material. This name
can then be referred to by other input data.
Field: Porosity
The porosity of a material is the maximum fraction, by volume, of a material that can be taken
up with water. The units are [m3/m3].
Field: Initial Water Content Ratio
For this solution algorithm, the initial water content is assumed to be distributed evenly
through the depth of the material. The units are [kg/kg].
Below is an example input for the porosity and initial water content of a material.
MaterialProperty:HeatAndMoistureTransfer:Settings,
Concrete,
!- Name
0.76,
!- Porosity
0.2;
!- Initial (or typical) Water content

MaterialProperty:HeatAndMoistureTransfer:SorptionIsotherm
Advanced/Research Usage: This material property is used in conjunction with the
CombinedHeatAndMoistureFiniteElement heat balance solution algorithm.
The Isotherm data relates the moisture, or water content [kg/m3] of a material with the
relative humidity (RH). The water content is expected to increase as relative humidity
increases, starting at zero content at 0.0relative humidity fraction and reaching a maximum,
defined by the porosity, at 1.0 relative humidity fraction, which corresponds to 100% relatve
humidity. Relative humidities are entered as fraction for this object ranging from 0.0 to 1.0.
These two extremes (0.0 and 1.0) are automatically set by the HAMT solution. However, if
they are entered they will be used as extra data points. Data should be provided with
increasing RH and moisture content up to as high an RH as possible to provide a stable
solution. One possible reason for the following error message may be that a material has a
very rapid increase in water content for a small change in RH, which can happen if the last
entered water content point is at a low RH and the material has a very high porosity.
** Warning ** HeatAndMoistureTransfer: Large Latent Heat for Surface ROOF

Another potential reason for this error being generated is the use of inappropriate values for
Vapor Transfer Coefficients. See the SurfaceProperties:VaporCoefficients object in the
Advanced Surface Concepts group.
Field: Material Name
This field is a unique reference name that the user assigns to a particular material. This name
can then be referred to by other input data.
Field: Number of data Coordinates
A maximum of 25 coordinates can be specified.
Field Set: Relative Humidity-Moisture Content
Field: Relative Humidity Fraction x
The relative humidity of the xth coordinate. The relative humidity is entered as fraction, not in
percent.
Field: Moisture Content x
The Moisture Content of the xth coordinate. The units are [kg/m3]
Below is an example input for a material isotherm
MaterialProperty:HeatAndMoistureTransfer:SorptionIsotherm,
9/29/14

92

Input-Output Reference
Concrete,
10,
!0.2205,
22.31,
0.202,
19.665,
0.449,
40.02,
0.454,
36.915,
0.6506,
56.005,
0.655,
52.325,
0.824,
72.565,
0.8725,
85.1,
0.924,
91.08,
0.964,
100.28;

Group Surface Construction Elements

!- Name
Number of data Coordinates
!- Relative Humidity fraction
!- Moisture content #1
!- Relative Humidity fraction
!- Moisture content #2
!- Relative Humidity fraction
!- Moisture content #3
!- Relative Humidity fraction
!- Moisture content #4
!- Relative Humidity fraction
!- Moisture content #5
!- Relative Humidity fraction
!- Moisture content #6
!- Relative Humidity fraction
!- Moisture content #7
!- Relative Humidity fraction
!- Moisture content #8
!- Relative Humidity fraction
!- Moisture content #9
!- Relative Humidity fraction
!- Moisture content #10

#1
#2
#3
#4
#5
#6
#7
#8
#9
#10

MaterialProperty:HeatAndMoistureTransfer:Suction
Advanced/Research Usage: This material property is used in conjunction with the
CombinedHeatAndMoistureFiniteElement heat balance solution algorithm.
The suction data relates the liquid transport coefficient, under suction, to the water content of
a material. A data point at zero water content is required. The liquid transport coefficient at
the highest entered water content value is used for all liquid transport coefficient values
above this water content. These coefficients are used by HAMT when the rain flag is set in
the weather file.
Field: Material Name
This field is a unique reference name that the user assigns to a particular material. This name
can then be referred to by other input data.
Field: Number of Suction points
A maximum of 25 points can be specified.
Field Set: Moisture Content-Liquid Transport Coefficient
Field: Moisture Content x
The moisture content of the xth point. The units are [kg/m3].
Field: Liquid Transport Coefficient x
The Liquid Transport Coefficient of the xth point. The units are [m2/s].
Below is an example input for a material liquid transport coefficient under suction.
MaterialProperty:HeatAndMoistureTransfer:Suction,
Concrete,
!- Name
5,
!- Number of Suction points
0,
!- Moisture content 1
0,
!- Liquid Transport Coefficient 1
72,
!- Moisture content 2
0.0000000000741,
!- Liquid Transport Coefficient 2
85,
!- Moisture content 3
0.000000000253,
!- Liquid Transport Coefficient 3
100,
!- Moisture content 4
0.00000000101,
!- Liquid Transport Coefficient 4
9/29/14

93

Input-Output Reference

Group Surface Construction Elements

118,
!- Moisture content 5
0.00000000128;
!- Liquid Transport Coefficient 5

MaterialProperty:HeatAndMoistureTransfer:Redistribution
Advanced/Research Usage: This material property is used in conjunction with the
CombinedHeatAndMoistureFiniteElement heat balance solution algorithm.
The redistribution data relates the liquid transport coefficient to the water content of a material
under normal conditions. A data point at zero water content is required. The liquid transport
coefficient at the highest entered water content value is used for all liquid transport coefficient
values above this water content. These coefficients are used by the Heat and Moisture
Transfer algorithm when the rain flag is NOT set in the weather file.
Field: Material Name
This field is a unique reference name that the user assigns to a particular material. This name
can then be referred to by other input data.
Field: Number of Redistribution points
A maximum of 25 points can be specified.
Field Set: Moisture Content-- Liquid Transport Coefficient
Field: Moisture Content x
The moisture content of the xth point. The units are [kg/m3].
Field: Liquid Transport Coefficient x
The Liquid Transport Coefficient of the xth point. The units are [m2/s].
Below is an example input for the object.
MaterialProperty:HeatAndMoistureTransfer:Redistribution,
Concrete,
!- Name
5,
!- Number of Redistribution points
0,
!- Moisture content 1
0,
!- Liquid Transport Coefficient 1
72,
!- Moisture content 2
0.00000000000741,
!- Liquid Transport Coefficient 2
85,
!- Moisture content 3
0.0000000000253,
!- Liquid Transport Coefficient 3
100,
!- Moisture content 4
0.000000000101,
!- Liquid Transport Coefficient 4
118,
!- Moisture content 5
0.000000000128;
!- Liquid Transport Coefficient 5

MaterialProperty:HeatAndMoistureTransfer:Diffusion
Advanced/Research Usage: This material property is used in conjunction with the
CombinedHeatAndMoistureFiniteElement heat balance solution algorithm.
The MU data relates the vapor diffusion resistance factor (dimensionless) to the relative
humidity as fraction(RH). A data point at zero RH is required. The vapor diffusion resistance
factor at the highest entered relative humidity (RH) value is used for all vapor diffusion
resistance factor values above this RH. The relative humidity maximum value in fraction is
1.0.
Field: Material Name
This field is a unique reference name that the user assigns to a particular material. This name
can then be referred to by other input data.

9/29/14

94

Input-Output Reference

Group Surface Construction Elements

Field: Number of Data Pairs

A maximum of 25 pairs can be specified.
Field Set: Relative Humidity-Vapor Diffusion Resistance Factor
Field: Relative Humidity Fraction #x
The moisture content of the xth pair. The relative humidity is entered as fraction, not in
percent.
Field: Vapor Diffusion Resistance Factor #x
The Liquid Transport Coefficient of the xth pair.
Below are some examples of the values for materials.
MaterialProperty:HeatAndMoistureTransfer:Diffusion,
Plywood,
!- Name
3,
!- Number of data Points
0,
!- Relative Humidity Fraction 1
700,
!- Water Vapor Diffusion Resistance Factor 1
0.5,
!- Relative Humidity Fraction 2
200,
!- Water Vapor Diffusion Resistance Factor 2
1,
!- Relative Humidity Fraction 3
20;
!- Water Vapor Diffusion Resistance Factor 3
MaterialProperty:HeatAndMoistureTransfer:Diffusion,
Concrete,
!- Name
1,
!- Number of Mu Points
0,
!- Relative Humidity Fraction 1
180;
!- Water Vapor Diffusion Resistance Factor 1

MaterialProperty:HeatAndMoistureTransfer:ThermalConductivity
Advanced/Research Usage: This material property is used in conjunction with the
CombinedHeatAndMoistureFiniteElement heat balance solution algorithm.
The thermal data relates the thermal conductivity [W/m-K] of a material to the moisture or
water content [kg/m3]. A data point at zero water content is required. The thermal
conductivity at the highest entered water content value is used for all thermal conductivity
values above this water content. If this object is not defined for a material then the algorithm
will use a constant value entered in the Material object for all water contents.
Field: Material Name
This field is a unique reference name that the user assigns to a particular material. This name
can then be referred to by other input data.
Field: Number of Thermal Coordinates
A maximum of 25 coordinates can be specified.
Field Set: Moisture Content- Thermal Conductivity
Field: Moisture Content x
The moisture content of the xth coordinate. The units are [kg/m3]
Field: Thermal Conductivity x
The Thermal Conductivity of the xth coordinate. The units are [W/m-K]
Below is an example of values for a material.
MaterialProperty:HeatAndMoistureTransfer:ThermalConductivity
Concrete,
!- Name
2,
!- Number of Thermal Coordinates
0,
!- Moisture content #1
1.6,
!- Thermal Conductivity #1
9/29/14

95

Input-Output Reference
180,
2.602;

Group Surface Construction Elements

!- Moisture content #2
!- Thermal Conductivity #2

Heat and Moisture (HAMT) Outputs

Zone,Average,HAMT
Zone,Average,HAMT
Zone,Average,HAMT
Zone,Average,HAMT
Zone,Average,HAMT
Zone,Average,HAMT
Zone,Average,HAMT

Surface
Surface
Surface
Surface
Surface
Surface
Surface

Average Water Content Ratio [kg/kg]

Inside Face Temperature [C]
Inside Face Relative Humidity [%]
Inside Face Vapor Pressure [Pa]
Outside Face Temperature [C]
Outside Face Relative Humidity [%]
Inside Face Relative Humidity [%]

HAMT Surface Average Water Content Ratio [kg/kg]

This output is the summed water content [kg/kg] of all cells in a surface expressed as a
fraction of the mass of the water to the material mass.
HAMT Surface Inside Face Temperature [C]
This output is the temperature [C] on the internal surface of the surface.
HAMT Surface Inside Face Relative Humidity [%]
HAMT Surface Inside Face Relative Humidity [%]
This output is the relative humidity on the internal surface of the surface expressed as a
percentage.
HAMT Surface Inside Face Vapor Pressure [Pa]
This output is the vapor pressure [Pa] on the internal surface of the surface.
HAMT Surface Outside Face Temperature [C]
This output is the temperature on the external surface of the surface.
HAMT Surface Outside Face Relative Humidity [%]
This output is the relative humidity on the external surface of the surface.
Zone,Average,HAMT Surface Temperature Cell N [C]
Zone,Average,HAMT Surface Water Content Cell N [kg/kg]
Zone,Average,HAMT Surface Relative Humidity Cell N [%]

Detailed profile data for the variables Temperature [C], Relative Humidity [%] and Water
Content [kg/kg] within each surface can also be reported. To calculate the heat and moisture
transfer through surfaces HAMT splits up surfaces into discrete cells. Each cell is composed
of a single material and has a position within the surface. HAMT automatically assigns cells
to construction objects so that there are more cells closer to boundaries between materials
and also at the surfaces of the surface. It is not possible for users to define their own cells.
HAMT Surface Relative Humidity Cell <N> [%]
This is the relative humidity of the cell in the surface.
HAMT Surface Temperature Cell <N> [C]
This is the temperature of the cell in the surface.
HAMT Surface Water Content Cell <N> [kg/kg]
This is the relative water content of the cell in the surface.
Each surface is made from a particular construction. The construction-surface relationship is
output by HAMT to the eplusout.eio file with the following format.
! <HAMT cells>, Surface Name, Construction Name, Cell Numbers
! <HAMT origins>, Surface Name, Construction Name, Cell origins (m)

9/29/14

96

Input-Output Reference

Group Surface Construction Elements

The output also contains the HAMT cell origins and cell number for each construction
surface combination. The coordinate system origin is defined as the exterior surface of the
construction. Users can select any one of the Temperature, Relative Humidity or Water
Content variables for any cell to be reported, using the following naming scheme for the
output variable.
HAMT Profile Construction <Variable> Cell <Cell#>

It is better to specify the key or Surface Name in this output.

So for example to output the temperature of the 10th cell in a surface, eg East Wall would
require the following output variable.
Output:Variable,
East Wall,
!- Key Value
HAMT Profile Construction Temperature Cell 10, !- Variable Name
Hourly;
!- Reporting Frequency

By selecting a whole range of these reports and using the information in the eplusout.eio file
it is possible to build up a temperature profile of the surface.
Materials for Glass Windows and Doors
All the materials for glass windows and doors have the prefix WindowMaterial. The following
WindowMaterial
descriptions
(Glazing,
Glazing:RefractionExtinctionMethod,
Gas,
GasMixture, Shade, Screen and Blind) apply to glass windows and doors. The property
definitions described herein for Glazing, Gas and GasMixture are supported by the National
Fenestration Rating Council as standard.
Front side is the side of the layer opposite the zone in which the window is defined. Back
side is the side closest to the zone in which the window is defined. Therefore, for exterior
windows, front side is the side closest to the outdoors. For interior windows, front side is
the side closest to the zone adjacent to the zone in which the window is defined.
The solar radiation transmitted by the window layers enters the zone and is a component of
the zone load. The solar radiation absorbed in each solid layer (glass, shade, screen or blind)
participates in the window layer heat balance calculation. The visible transmittance and
reflectance properties of the window are used in the daylighting calculation.
WindowMaterial:Glazing
In the following, for exterior windows, front side is the side of the glass closest to the outside
air and back side is the side closest to the zone the window is defined in. For interzone
windows, front side is the side closest to the zone adjacent to the zone the window is
defined in and back side is the side closest to the zone the window is defined in.
Field: Name
The name of the glass layer. It corresponds to a layer in a window construction.
Field: Optical Data Type
Valid values for this field are SpectralAverage, Spectral, BSDF.
If Optical Data Type = SpectralAverage, the values you enter for solar transmittance and
reflectance are assumed to be averaged over the solar spectrum, and the values you enter
for visible transmittance and reflectance are assumed to be averaged over the solar spectrum
and weighted by the response of the human eye. There is an EnergyPlus Reference Data
Set for WindowMaterial:Glazing that contains spectral average properties for many different
types of glass.
If Optical Data Type = Spectral, then, in the following field, you must enter the name of a
spectral data set defined with the WindowGlassSpectralData object. In this case, the values
of solar and visible transmittance and reflectance in the fields below should be blank.
If Optical Data Type = BSDF, the Construction:ComplexFenestrationState object must be
used to define the window construction layers. The Construction:ComplexFenestrationState
9/29/14

97

Input-Output Reference

Group Surface Construction Elements

object contains references to the BSDF files which contain the optical properties of the
Complex Fenestration layers. In this case,
Field: Window Glass Spectral Data Set Name
If Optical Data Type = Spectral, this is the name of a spectral data set defined with a
WindowGlassSpectralData object.
Field: Thickness
The surface-to-surface thickness of the glass (m).
Field: Solar Transmittance at Normal Incidence
Transmittance at normal incidence averaged over the solar spectrum. Used only when
Optical Data Type = SpectralAverage.
For uncoated glass, when alternative optical properties are availablesuch as thickness,
solar index of refraction, and solar extinction coefficientthey can be converted to equivalent
solar transmittance and reflectance values using the equations given in Conversion from
Alternative Specification of Glass Optical Properties.)
Field: Front Side Solar Reflectance at Normal Incidence
Front-side reflectance at normal incidence averaged over the solar spectrum. Used only
when Optical Data Type = SpectralAverage.
Field: Back Side Solar Reflectance at Normal Incidence
Back-side reflectance at normal incidence averaged over the solar spectrum. Used only when
Optical Data Type = SpectralAverage.
Field: Visible Transmittance at Normal Incidence
Transmittance at normal incidence averaged over the solar spectrum and weighted by the
response of the human eye. Used only when Optical Data Type = SpectralAverage.
For uncoated glass, when alternative optical properties are availablesuch as thickness,
visible index of refraction, and visible extinction coefficientthey can be converted to
equivalent visible transmittance and reflectance values using the equations given in
Conversion from Alternative Specification of Glass Optical Properties.)
Field: Front Side Visible Reflectance at Normal Incidence
Front-side reflectance at normal incidence averaged over the solar spectrum and weighted by
the response of the human eye. Used only when Optical Data Type = SpectralAverage.
Field: Back Side Visible Reflectance at Normal Incidence
Back-side reflectance at normal incidence averaged over the solar spectrum and weighted by
the response of the human eye. Used only when Optical Data Type = SpectralAverage.
Field: Infrared Transmittance at Normal Incidence
Long-wave transmittance at normal incidence.
Field: Front Side Infrared Hemispherical Emissivity
Front-side long-wave emissivity.
Field: Back Side Infrared Hemispherical Emissivity
Back-side long-wave emissivity.
Field: Conductivity
Thermal conductivity (W/m-K).

9/29/14

98

Input-Output Reference

Group Surface Construction Elements

Field: Dirt Correction Factor for Solar and Visible Transmittance

This is a factor that corrects for the presence of dirt on the glass. The program multiplies the
fields Solar Transmittance at Normal Incidence and Visible Transmittance at Normal
Incidence by this factor if the material is used as the outer glass layer of an exterior window
or glass door.1 If the material is used as an inner glass layer (in double glazing, for example),
the dirt correction factor is not applied because inner glass layers are assumed to be clean.
Using a material with dirt correction factor < 1.0 in the construction for an interior window will
result in an error message.
Representative values of the dirt correction factor are shown in Table 7.
Table 7. Dirt Correction Factors
Type of Location

Angle of Glazing
Vertical

45O

Horizontal

Non-industrial

0.9

0.8

0.7

Industrial

0.7

0.6

0.5

Very Dirty

0.6

0.5

0.4

From Appendix A, Daylighting in Sports Halls, Report 2, SportScotland, Nov. 2002

(www.sportscotland.org.uk)

The default value of the dirt correction factor is 1.0, which means the glass is clean.
It is assumed that dirt, if present, has no effect on the IR properties of the glass.
Field: Solar Diffusing
Takes values No (the default) and Yes. If No, the glass is transparent and beam solar
radiation incident on the glass is transmitted as beam radiation with no diffuse component. If
Yes, the glass is translucent and beam solar radiation incident on the glass is transmitted as
hemispherically diffuse radiation with no beam component. 2 See Figure 10. Solar Diffusing =
Yes should only be used on the innermost pane of glass in an exterior window; it does not
apply to interior windows.
For both Solar Diffusing = No and Yes, beam is reflected as beam with no diffuse component
(see Figure 10). Solar Diffusing cannot be used with Window Shading Control devices
(except Switchable Glazing). When attempted, the window property will be set to No for Solar
Diffusing. The Surface Details report will reflect the override.
If, in the Building object, Solar Distribution = FullInteriorAndExterior, use of Solar Diffusing =
Yes for glass in an exterior window will change the distribution of interior solar radiation from
the window. The result is that beam solar radiation that would be transmitted by a transparent
window and get absorbed by particular interior surfaces will be diffused by a translucent
window and be spread over more interior surfaces. This can change the time dependence of
heating and cooling loads in the zone.
In a zone with Daylighting:Detailed, translucent glazing---which is often used in skylights---will
provide a more uniform daylight illuminance over the zone and will avoid patches of sunlight
on the floor.

If Optical Data Type = Spectral, the program multiplies the solar and visible transmittance at each wavelength by the dirt
correction factor.
2
EnergyPlus does not model the partially translucent case in which beam solar radiation incident on the glass is transmitted
as a combination of beam and diffuse.

9/29/14

99

Input-Output Reference

Group Surface Construction Elements

Incident
beam

Incident
beam
Transmitted
diffuse

Transmitted
beam
Reflected
beam
Transparent glass
(Solar Diffusing = No)

Reflected
beam
Translucent glass
(Solar Diffusing = Yes)

Figure 10. Comparison between transmittance properties of transparent glass (Solar Diffusing = No) and
translucent glass (Solar Diffusing = Yes).
Field: Youngs modulus
A measure of the stiffness of an elastic material. It is defined as the ratio of the unaxial stress
over the uniaxial strain in the range of stress in which Hookes Law holds. It is used only with
complex fenestration systems defined through the Construction:ComplexFenestrationState
object. The default value for glass is 7.2e10 Pa.
Field: Poissons ratio
The ratio, when a sample object is stretched, of the contraction or transverse strain
(perpendicular to the applied load), to the extension or axial strain (in the direction of the
applied load). This value is used only with complex fenestration systems defined through the
Construction:ComplexFenestrationState object. The default value for glass is 0.22.
IDF examples of Spectral average and using a Spectral data set:
MATERIAL:WINDOWGLASS, GLASS - CLEAR SHEET 1 / 8 IN,
SpectralAverage, ! Optical data type
0.003, ! Thickness {m} 1/8"
0.850, ! Solar transmittance at normal incidence
0.075, ! Solar reflectance at normal incidence: front side
0.075, ! Solar reflectance at normal incidence: back side
0.901, ! Visible transmittance at normal incidence
0.081, ! Visible reflectance at normal incidence: front side
0.081, ! Visible reflectance at normal incidence: back side
0.0,
! IR transmittance at normal incidence
0.84, ! IR hemispherical emissivity: front side
0.84, ! IR hemispherical emissivity: back side
0.9;
! Conductivity {W/m-K}
WindowMaterial:Glazing ,SPECTRAL GLASS INNER PANE, ! Material name
Spectral, ! Optical data type {SpectralAverage or Spectral}
TestSpectralDataSet, ! Name of spectral data set
0.0099, ! Thickness {m}
, ! Solar transmittance at normal incidence
, ! Solar reflectance at normal incidence: front side
, ! Solar reflectance at normal incidence: back side
, ! Visible transmittance at normal incidence
, ! Visible reflectance at normal incidence: front side
, ! Visible reflectance at normal incidence: back side
0.0,
! IR transmittance at normal incidence
0.84, ! IR emissivity: front side
0.84, ! IR emissivity: back side
9/29/14

100

Input-Output Reference

Group Surface Construction Elements

0.798; ! Conductivity {W/m-K}

IDF example of Spectral Data Type = BSDF

WindowMaterial:Glazing,
Glass_5012_Layer,
BSDF,
,
0.005664,
,
,
,
,
,
,
0.000000,
0.840000,
0.840000,
1.000000,
,
,
7.2e10,
0.22;

!- Layer name : CLEAR_6.PPG

!- Optical Data Type
!- Spectral Data name
!- Thickness
!- Solar Transmittance
!- Solar Front Reflectance
!- Solar Back Reflectance
!- Visible Transmittance
!- Visible Front Reflectance
!- Visible Back reflectance
!- IR Transmittance
!-Front Emissivity
!-Back Emissivity
!-Conductivity
!-Dirt Correction Factor for Sol/Vis Transmittance
!-Solar Diffusing
!-Youngs modulus
!-Poissons ratio

WindowMaterial:Glazing:RefractionExtinctionMethod
This is an alternative way of specifying glass properties. Index of refraction and extinction
coefficient are given instead of the transmittance and reflectance values used in
WindowMaterial:Glazing.
However,
unlike
WindowMaterial:Glazing,
WindowMaterial:Glazing:RefractionExtinctionMethod is restricted to cases where the front
and back optical properties of the glass are the same. This means it cannot be used for glass
with a coating on one side. In that case WindowMaterial:Glazing should be used. Also, unlike
WindowMaterial:Glazing, WindowMaterial:Glazing:RefractionExtinctionMethod does not allow
input of glass wavelength-by-wavelength (spectral) properties.
Field: Name
The name of the glass layer. It corresponds to a layer in a window construction.
Field: Thickness
The surface-to-surface thickness of the glass (m).
Field: Solar Index of Refraction
Index of refraction averaged over the solar spectrum.
Field: Solar Extinction Coefficient
Extinction coefficient averaged over the solar spectrum (m -1).
Field: Visible Index of Refraction
Index of refraction averaged over the solar spectrum and weighted by the response of the
human eye.
Field: Visible Extinction Coefficient
Extinction coefficient averaged over the solar spectrum and weighted by the response of the
human eye (m -1).
Field: Infrared Transmittance at Normal Incidence
Long-wave transmittance at normal incidence.

9/29/14

101

Input-Output Reference

Group Surface Construction Elements

Field: Infrared Hemispherical Emissivity

Long-wave hemispherical emissivity, assumed the same on both sides of the glass.
Field: Conductivity
Thermal conductivity (W/m-K).
Field: Dirt Correction Factor for Solar and Visible Transmittance
This is a factor that corrects for the presence of dirt on the glass. It multiplies the solar and
visible transmittance at normal Incidence (which the program calculates from the input values
of thickness, solar index of refraction, solar extinction coefficient, etc.) if the material is used
as the outer glass layer of an exterior window or glass door. If the material is used as an
inner glass layer (in double glazing, for example), the dirt correction factor is not applied
because inner glass layers are assumed to be clean. Using a material with dirt correction
factor < 1.0 in the construction for an interior window will result in an error message.
Representative values of the direct correction factor are shown in Table 7.
The default value of the dirt correction factor is 1.0, which means the glass is clean. It is
assumed that dirt, if present, has no effect on the IR properties of the glass.
Field: Solar Diffusing
Takes values No (the default) and Yes. If No, the glass is transparent. If Yes, the glass is
translucent and beam solar radiation incident on the glass is transmitted as hemispherically
diffuse radiation with no beam component. Solar Diffusing = Yes should only be used on the
innermost pane of glass in an exterior window; it does not apply to interior windows.
If, in the Building object, Solar Distribution = FullInteriorAndExterior, use of Solar Diffusing =
Yes for glass in an exterior window will change the distribution of interior solar radiation from
the window. The result is that beam solar radiation that would be transmitted by a transparent
window and get absorbed by particular interior surfaces will be diffused by a translucent
window and be spread over more interior surfaces. This can change the time dependence of
heating and cooling loads in the zone.
In a zone with Daylighting:Detailed, translucent glazing, which is often used in skylights, will
provide a more uniform daylight illuminance over the zone and will avoid patches of sunlight
on the floor.
An IDF example:
WindowMaterial:Glazing:RefractionExtinctionMethod,
4MM CLEAR GLASS, !- Material name
0.004, !- Thickness {m}
1.526, !- Solar index of refraction
30.0 , !- Solar extinction coefficient (1/m)
1.526, !- Visible index of refraction
30.0 , !- Visible extinction coefficient (1/m)
0.0,
!- IR transmittance at normal incidence
0.84, !- IR emissivity
0.9;
!- Conductivity {W/m-K}

Glass Optical Properties Conversion

Conversion from Glass Optical Properties Specified as Index of Refraction and
Transmittance at Normal Incidence
The optical properties of uncoated glass are sometimes specified by index of refraction, n,
and transmittance at normal incidence, T.
The following equations show how to convert from this set of values to the transmittance and
reflectance values required by WindowMaterial:Glazing. These equations apply only to
uncoated glass, and can be used to convert either spectral-average solar properties or
spectral-average visible properties (in general, n and T are different for the solar and visible).
9/29/14

102

Input-Output Reference

Group Surface Construction Elements

Note that since the glass is uncoated, the front and back reflectances are the same and equal
to the R that is solved for in the following equations.
Given n and T, find R:

n 1
n 1

(1 r ) 4

4r 2T 2

1/2

(1 r ) 2

2r 2T
R

(1 r ) 2 r
1 r2 2

Example:
T = 0.86156
n = 1.526

1.526 1
1.526 1
0.93974
R 0.07846

WindowMaterial:GlazingGroup:Thermochromic
Thermochromic (TC) materials have active, reversible optical properties that vary with
temperature. Thermochromic windows are adaptive window systems for incorporation into
building envelopes. Thermochromic windows respond by absorbing sunlight and turning the
sunlight energy into heat. As the thermochromic film warms it changes its light transmission
level from less absorbing to more absorbing. The more sunlight it absorbs the lower the light
level going through it. By using the suns own energy the window adapts based solely on the
directness and amount of sunlight. Thermochromic materials will normally reduce optical
transparency by absorption and/or reflection, and are specular (maintaining vision).
A thermochromic window is defined with a Construction object which references a special
layer defined with a WindowMaterial:GlazingGroup:Thermochromic object. The
WindowMaterial:GlazingGroup:Thermochromic object further references a series of
WindowMaterial:Glazing objects corresponding to each specification temperature of the TC
layer.
This object specifies a layer of thermochromic glass, part of a thermochromic window. An
example file ThermochromicWindow.idf is included in the EnergyPlus installation.
Field: Name
A unique user assigned name for a particular thermochromic glass material.
Field Set (Optical Data Temperature, Window Material Glazing Name) is extensible.
Field: Optical Data Temperature <N>
The temperature of the TC glass layer corresponding to the optical data of the TC layer. Unit
is C.

9/29/14

103

Input-Output Reference

Group Surface Construction Elements

Field: Window Material Glazing Name <N>

The window glazing (defined with WindowMaterial:Glazing) name that provides the TC glass
layer performance at the above specified temperature.
IDF Examples
Construction,
window_const,
Usual Glass,
AIR 6MM,
TCGlazings,
AIR 6MM,
Usual Glass;
WindowMaterial:Gas,
AIR 6MM,
Air,
0.0063;

!!!!!!-

Name
Layer
Layer
Layer
Layer
Layer

1
2
3
4
5

!- Name
!- Gas Type
!- Thickness {m}

! Added for thermochromic glazings

WindowMaterial:GlazingGroup:Thermochromic,
TCGlazings,
0 , TCGlazing0,
20, TCGlazing20,
25, TCGlazing25,
30, TCGlazing30,
35, TCGlazing35,
40, TCGlazing40,
45, TCGlazing45,
50, TCGlazing50,
55, TCGlazing55,
60, TCGlazing60,
65, TCGlazing65,
75, TCGlazing75,
85, TCGlazing85;
WindowMaterial:Glazing,
TCGlazing0, !- Name
SpectralAverage, !- Optical Data Type
,
!- Window Glass Spectral Data Set Name
0.0030, !- Thickness
0.2442, !- Solar Transmittance at Normal Incidence
0.7058, !- Front Side Solar Reflectance at Normal Incidence
0.7058, !- Back Side Solar Reflectance at Normal Incidence
0.3192, !- Visible Transmittance at Normal Incidence
0.6308, !- Front Side Visible Reflectance at Normal Incidence
0.6308, !- Back Side Visible Reflectance at Normal Incidence
0.0000, !- Infrared Transmittance at Normal Incidence
0.9000, !- Front Side Infrared Hemispherical Emissivity
0.9000, !- Back Side Infrared Hemispherical Emissivity
0.0199, !- Conductivity
1.0000, !- Dirt Correction Factor for Solar and Visible Transmittance
No;
!- Solar Diffusing
WindowMaterial:Glazing,
TCGlazing20, !- Name
SpectralAverage, !- Optical Data Type
,
!- Window Glass Spectral Data Set Name
0.0030, !- Thickness

9/29/14

104

Input-Output Reference
0.2442,
0.7058,
0.7058,
0.3192,
0.6308,
0.6308,
0.0000,
0.9000,
0.9000,
0.0199,
1.0000,
No;

Group Surface Construction Elements

!!!!!!!!!!!!-

Solar Transmittance at Normal Incidence

Front Side Solar Reflectance at Normal Incidence
Back Side Solar Reflectance at Normal Incidence
Visible Transmittance at Normal Incidence
Front Side Visible Reflectance at Normal Incidence
Back Side Visible Reflectance at Normal Incidence
Infrared Transmittance at Normal Incidence
Front Side Infrared Hemispherical Emissivity
Back Side Infrared Hemispherical Emissivity
Conductivity
Dirt Correction Factor for Solar and Visible Transmittance
Solar Diffusing

WindowMaterial:Glazing,
TCGlazing25, !- Name
SpectralAverage, !- Optical Data Type
,
!- Window Glass Spectral Data Set Name
0.0030, !- Thickness
0.2442, !- Solar Transmittance at Normal Incidence
0.7058, !- Front Side Solar Reflectance at Normal Incidence
0.7058, !- Back Side Solar Reflectance at Normal Incidence
0.3192, !- Visible Transmittance at Normal Incidence
0.6308, !- Front Side Visible Reflectance at Normal Incidence
0.6308, !- Back Side Visible Reflectance at Normal Incidence
0.0000, !- Infrared Transmittance at Normal Incidence
0.9000, !- Front Side Infrared Hemispherical Emissivity
0.9000, !- Back Side Infrared Hemispherical Emissivity
0.0199, !- Conductivity
1.0000, !- Dirt Correction Factor for Solar and Visible Transmittance
No;
!- Solar Diffusing
WindowMaterial:Glazing,
TCGlazing30, !- Name
SpectralAverage, !- Optical Data Type
,
!- Window Glass Spectral Data Set Name
0.0030, !- Thickness
0.2442, !- Solar Transmittance at Normal Incidence
0.7058, !- Front Side Solar Reflectance at Normal Incidence
0.7058, !- Back Side Solar Reflectance at Normal Incidence
0.3192, !- Visible Transmittance at Normal Incidence
0.6308, !- Front Side Visible Reflectance at Normal Incidence
0.6308, !- Back Side Visible Reflectance at Normal Incidence
0.0000, !- Infrared Transmittance at Normal Incidence
0.9000, !- Front Side Infrared Hemispherical Emissivity
0.9000, !- Back Side Infrared Hemispherical Emissivity
0.0199, !- Conductivity
1.0000, !- Dirt Correction Factor for Solar and Visible Transmittance
No;
!- Solar Diffusing
WindowMaterial:Glazing,
TCGlazing35, !- Name
SpectralAverage, !- Optical Data Type
,
!- Window Glass Spectral Data Set Name
0.0030, !- Thickness
0.2442, !- Solar Transmittance at Normal Incidence
0.7058, !- Front Side Solar Reflectance at Normal Incidence
0.7058, !- Back Side Solar Reflectance at Normal Incidence
0.3192, !- Visible Transmittance at Normal Incidence
0.6308, !- Front Side Visible Reflectance at Normal Incidence
0.6308, !- Back Side Visible Reflectance at Normal Incidence
0.0000, !- Infrared Transmittance at Normal Incidence
0.9000, !- Front Side Infrared Hemispherical Emissivity
9/29/14

105

Input-Output Reference
0.9000,
0.0199,
1.0000,
No;

Group Surface Construction Elements

!!!!-

Back Side Infrared Hemispherical Emissivity

Conductivity
Dirt Correction Factor for Solar and Visible Transmittance
Solar Diffusing

WindowMaterial:Glazing,
TCGlazing40, !- Name
SpectralAverage, !- Optical Data Type
,
!- Window Glass Spectral Data Set Name
0.0030, !- Thickness
0.2442, !- Solar Transmittance at Normal Incidence
0.7058, !- Front Side Solar Reflectance at Normal Incidence
0.7058, !- Back Side Solar Reflectance at Normal Incidence
0.3192, !- Visible Transmittance at Normal Incidence
0.6308, !- Front Side Visible Reflectance at Normal Incidence
0.6308, !- Back Side Visible Reflectance at Normal Incidence
0.0000, !- Infrared Transmittance at Normal Incidence
0.9000, !- Front Side Infrared Hemispherical Emissivity
0.9000, !- Back Side Infrared Hemispherical Emissivity
0.0199, !- Conductivity
1.0000, !- Dirt Correction Factor for Solar and Visible Transmittance
No;
!- Solar Diffusing
WindowMaterial:Glazing,
TCGlazing45, !- Name
SpectralAverage, !- Optical Data Type
,
!- Window Glass Spectral Data Set Name
0.0030, !- Thickness
0.2442, !- Solar Transmittance at Normal Incidence
0.7058, !- Front Side Solar Reflectance at Normal Incidence
0.7058, !- Back Side Solar Reflectance at Normal Incidence
0.3192, !- Visible Transmittance at Normal Incidence
0.6308, !- Front Side Visible Reflectance at Normal Incidence
0.6308, !- Back Side Visible Reflectance at Normal Incidence
0.0000, !- Infrared Transmittance at Normal Incidence
0.9000, !- Front Side Infrared Hemispherical Emissivity
0.9000, !- Back Side Infrared Hemispherical Emissivity
0.0199, !- Conductivity
1.0000, !- Dirt Correction Factor for Solar and Visible Transmittance
No;
!- Solar Diffusing
WindowMaterial:Glazing,
TCGlazing50, !- Name
SpectralAverage, !- Optical Data Type
,
!- Window Glass Spectral Data Set Name
0.0030, !- Thickness
0.2442, !- Solar Transmittance at Normal Incidence
0.7058, !- Front Side Solar Reflectance at Normal Incidence
0.7058, !- Back Side Solar Reflectance at Normal Incidence
0.3192, !- Visible Transmittance at Normal Incidence
0.6308, !- Front Side Visible Reflectance at Normal Incidence
0.6308, !- Back Side Visible Reflectance at Normal Incidence
0.0000, !- Infrared Transmittance at Normal Incidence
0.9000, !- Front Side Infrared Hemispherical Emissivity
0.9000, !- Back Side Infrared Hemispherical Emissivity
0.0199, !- Conductivity
1.0000, !- Dirt Correction Factor for Solar and Visible Transmittance
No;
!- Solar Diffusing
WindowMaterial:Glazing,
TCGlazing55, !- Name
9/29/14

106

Input-Output Reference

Group Surface Construction Elements

SpectralAverage, !- Optical Data Type

,
!- Window Glass Spectral Data Set Name
0.0030, !- Thickness
0.2442, !- Solar Transmittance at Normal Incidence
0.7058, !- Front Side Solar Reflectance at Normal Incidence
0.7058, !- Back Side Solar Reflectance at Normal Incidence
0.3192, !- Visible Transmittance at Normal Incidence
0.6308, !- Front Side Visible Reflectance at Normal Incidence
0.6308, !- Back Side Visible Reflectance at Normal Incidence
0.0000, !- Infrared Transmittance at Normal Incidence
0.9000, !- Front Side Infrared Hemispherical Emissivity
0.9000, !- Back Side Infrared Hemispherical Emissivity
0.0199, !- Conductivity
1.0000, !- Dirt Correction Factor for Solar and Visible Transmittance
No;
!- Solar Diffusing
WindowMaterial:Glazing,
TCGlazing60, !- Name
SpectralAverage, !- Optical Data Type
,
!- Window Glass Spectral Data Set Name
0.0030, !- Thickness
0.2442, !- Solar Transmittance at Normal Incidence
0.7058, !- Front Side Solar Reflectance at Normal Incidence
0.7058, !- Back Side Solar Reflectance at Normal Incidence
0.3192, !- Visible Transmittance at Normal Incidence
0.6308, !- Front Side Visible Reflectance at Normal Incidence
0.6308, !- Back Side Visible Reflectance at Normal Incidence
0.0000, !- Infrared Transmittance at Normal Incidence
0.9000, !- Front Side Infrared Hemispherical Emissivity
0.9000, !- Back Side Infrared Hemispherical Emissivity
0.0199, !- Conductivity
1.0000, !- Dirt Correction Factor for Solar and Visible Transmittance
No;
!- Solar Diffusing
WindowMaterial:Glazing,
TCGlazing65, !- Name
SpectralAverage, !- Optical Data Type
,
!- Window Glass Spectral Data Set Name
0.0030, !- Thickness
0.2442, !- Solar Transmittance at Normal Incidence
0.7058, !- Front Side Solar Reflectance at Normal Incidence
0.7058, !- Back Side Solar Reflectance at Normal Incidence
0.3192, !- Visible Transmittance at Normal Incidence
0.6308, !- Front Side Visible Reflectance at Normal Incidence
0.6308, !- Back Side Visible Reflectance at Normal Incidence
0.0000, !- Infrared Transmittance at Normal Incidence
0.9000, !- Front Side Infrared Hemispherical Emissivity
0.9000, !- Back Side Infrared Hemispherical Emissivity
0.0199, !- Conductivity
1.0000, !- Dirt Correction Factor for Solar and Visible Transmittance
No;
!- Solar Diffusing
WindowMaterial:Glazing,
TCGlazing75, !- Name
SpectralAverage, !- Optical Data Type
,
!- Window Glass Spectral Data Set Name
0.0030, !- Thickness
0.2442, !- Solar Transmittance at Normal Incidence
0.7058, !- Front Side Solar Reflectance at Normal Incidence
0.7058, !- Back Side Solar Reflectance at Normal Incidence
0.3192, !- Visible Transmittance at Normal Incidence
0.6308, !- Front Side Visible Reflectance at Normal Incidence
9/29/14

107

Input-Output Reference
0.6308,
0.0000,
0.9000,
0.9000,
0.0199,
1.0000,
No;

Group Surface Construction Elements

!!!!!!!-

Back Side Visible Reflectance at Normal Incidence

Infrared Transmittance at Normal Incidence
Front Side Infrared Hemispherical Emissivity
Back Side Infrared Hemispherical Emissivity
Conductivity
Dirt Correction Factor for Solar and Visible Transmittance
Solar Diffusing

WindowMaterial:Glazing,
TCGlazing85, !- Name
SpectralAverage, !- Optical Data Type
,
!- Window Glass Spectral Data Set Name
0.0030, !- Thickness
0.2442, !- Solar Transmittance at Normal Incidence
0.7058, !- Front Side Solar Reflectance at Normal Incidence
0.7058, !- Back Side Solar Reflectance at Normal Incidence
0.3192, !- Visible Transmittance at Normal Incidence
0.6308, !- Front Side Visible Reflectance at Normal Incidence
0.6308, !- Back Side Visible Reflectance at Normal Incidence
0.0000, !- Infrared Transmittance at Normal Incidence
0.9000, !- Front Side Infrared Hemispherical Emissivity
0.9000, !- Back Side Infrared Hemispherical Emissivity
0.0199, !- Conductivity
1.0000, !- Dirt Correction Factor for Solar and Visible Transmittance
No;
!- Solar Diffusing

WindowMaterial:GlazingGroup:Thermochromic Outputs
Surface Window Thermochromic Layer Temperature [C]
The temperature of the TC glass layer of a TC window at each time step.
Surface Window Thermochromic Layer Property Specification Temperature [C]
The temperature under which the optical data of the TC glass layer are specified.
The overall properties (U-factor/SHGC/VT) of the thermochromic windows at different
specification temperatures are reported in the EIO file. These window constructions are
created by EnergyPlus during run time. They have similar names with suffix _TC_XX where
XX represents a specification temperature.
WindowMaterial:Gas
This object specifies the properties of the gas between the panes of a multi-pane window.
Gas Type = Custom allows you to specify the properties of gases other than air, Argon,
Krypton or Xenon. There is an EnergyPlus Reference Data Set for Material:WindowGas that
contains several types of gas of different thicknesses. See Material:WindowGasMixture for
the case that the gas fill is a mixture of different gases.
Field: Name
The name of the gas fill. It refers to a layer in a window construction.
Field: Gas Type
The type of gas. The choices are Air, Argon, Krypton, or Xenon. If Gas Type = Custom you
can use Conductivity Coefficient A, etc. to specify the properties of a different type of gas.
Field: Thickness
The thickness (m) of the gas layer.

9/29/14

108

Input-Output Reference

Group Surface Construction Elements

Properties for Custom Gas Types

The following entries are used only if Gas Type = Custom. The A and B coefficients are those
in the following expression that gives a property value as a function of temperature in
degrees K:

Property Coefficient A CoefficientB *TemperatureK

Field: Conductivity Coefficient A
The A coefficient for gas conductivity (W/m-K). Used only if Gas Type = Custom.
Field: Conductivity Coefficient B
The B coefficient for gas conductivity (W/m-K2). Used only if Gas Type = Custom.
Field: Conductivity Coefficient C
The C coefficient for gas conductivity (W/m-K3). Used only if Gas Type = Custom.
Field: Viscosity Coefficient A
The A coefficient for gas viscosity (kg/m-s). Used only if Gas Type = Custom.
Field: Viscosity Coefficient B
The B coefficient for gas viscosity (kg/m-s-K). Used only if Gas Type = Custom.
Field: Viscosity Coefficient C
The C coefficient for gas viscosity (kg/m-s-K2). Used only if Gas Type = Custom.
Field: Specific Heat Coefficient A
The A coefficient for gas specific heat (J/kg-K). Used only if Gas Type = Custom.
Field: Specific Heat Coefficient B
The B coefficient for gas specific heat (J/kg-K2). Used only if Gas Type = Custom.
Field: Specific Heat Coefficient C
The C coefficient for gas specific heat (J/kg-K3). Used only if Gas Type = Custom.
Field: Specific Heat Ratio
The specific heat ratio for gas. Used only if Gas Type = Custom.
Field: Molecular Weight
The molecular weight for gas. The molecular weight is the mass of 1 mol of the substance.
This has a numerical value which is the average molecular mass of the molecules in the
substance multiplied by Avogadros constant. (kg/kmol) (Shown in the IDD as g/mol for
consistency)
Field: Specific Heat Ratio
The specific heat ratio for gas. The specific heat ratio of a gas is the ratio of the specific heat
at contant pressure, to the specific heat at constant volume. Used only if Gas Type =
Custom.
An IDF example:
WindowMaterial:Gas,AIRGAP,
AIR,
! Gas type (Air - Argon - Krypton - Xenon - Custom)]
0.0125;
! Thickness {m} 1/2 inch

An IDF example to be used with a WindowMaterial:Gap definition (see below)

9/29/14

109

Input-Output Reference

Group Surface Construction Elements

WindowMaterial:Gas,
Gas_1_W_0_0100,
Air,
0.0100;

!- gap name - Air

!- type
!- thickness

An IDF example for a Custom Gas

WindowMaterial:Gas,
Gas_16_W_0_0003,
Custom,
0.0003,
2.873000e-003,
7.760000e-005,
0.000000e+000,
3.723000e-006,
4.940000e-008,
0.000000e+000,
1002.737000,
0.012324,
0.000000,
28.969999,
1.400000;

!!!!!!!!!!!!!!-

gap name
type
thickness
Conductivity Coefficient A
Conductivity Coefficient B
Conductivity Coefficient C
Conductivity Viscosity A
Conductivity Viscosity B
Conductivity Viscosity C
Specific Heat Coefficient A
Specific Heat Coefficient B
Specific Heat Coefficient C
Molecular Weight
Specific Heat Ratio

WindowMaterial:GasMixture
This object allows you to specify the fill between the panes of a multi-pane window to be a
mixture of two, three or four different gases chosen from air, argon, krypton and xenon. It can
also be used if only one type of gas in the fill. In this case you can also use
WindowMaterial:Gas. Note that the fractions of gas types in the mixture should add up to 1.0.
Field: Name
The name of the gas mixture. It refers to a layer in a window construction.
Field: Thickness
The thickness (m) of the gas mixture layer.
Field: Number of Gases in Mixture
The number of different types of gas in the mixture ( a value from 1 to 4)
Set: Gas Type-Fraction (up to 4)
Field: Gas 1 Type
The type of the first gas in the mixture. Choices are Air, Argon, Krypton and Xenon.
Field: Gas 1 Fraction
The fraction of the first gas in the mixture.
An IDF example:
WindowMaterial:GasMixture,ArgonKryptonMix,
0.0125,
! Thickness {m} 1/2 inch
2,
! Number of Gases in Mixture
Argon,
! Gas 1 Type
0.6,
! Gas 1 Fraction
Krypton, ! Gas 2 Type
0.4;
! Gas 2 Fraction

9/29/14

110

Input-Output Reference

Group Surface Construction Elements

WindowMaterial:Gap
This input object is used to define the gap between two layers in a complex fenestration
system, where the Construction:ComplexFenestrationState object is used. It references the
gas or gas mixtures defined in the WindowMaterial:Gas and WindowMaterial:GasMixture
objects. It is referenced as a layer in the Construction:ComplexFenestrationState object ;it
cannot be referenced as a layer from the Construction object.
Field: Name
Unique name of the gap.
Field: Thickness
The thickness (m) of the gap layer.
Field: Pressure
The pressure (Pa) of the gas in the gap layer, used to calculate the gas properties of the
glazing system gap. Default is atmospheric pressure, 101325 Pa.When modeling vacuum
glazing, this value should represent the pressure in the evacuated glazing system. If this
pressure is less that the ThermalModelParams:PressureLimit value, the the glazing system
will be modeled as a vacuum glazing.
Field: Deflection State
This field is used when modeling the deflection of the glass layers in a window if the
WinodowThermalModel:Params value for deflection model is MeasuredDeflection.
Field: Support Pillar
References the support pillar of the gap layer if vacuum glazing is being modeled. If left
empty, then it is considered that gap layer does not have support pillars.
Field: Gas (or GasMixture)
References gas (WindowMaterial:Gas) or gas mixture (WindowMaterial:GasMixture) of the
gap layer.
An IDF example for simple glazing:
WindowMaterial:Gas,
Gas_1_W_0_0120,
Air,
0.0120;

!- gap name - Air

!- type
!- thickness

WindowMaterial:Gap,
Gap_1_Layer,
0.0120,
Gas_1_W_0_0120,
101325.0000;

!!!!-

gap name: Air

thickness
Gas (or Gas Mixture) name
pressure

An IDF example for vacuum glazing:

WindowMaterial:Gap,
Gap_16_Layer,
0.0003,
thicknessGas_16_W_0_0003,
Mixture) name
0.1333,
,
SupportPillar_16_Gap_1;
WindowGap:SupportPillar,
SupportPillar_16_Gap_1,
0.0508,
9/29/14

!- gap name: Vacuum_0.001_pr-0.5_ps-50.8

!!- Gas (or Gas
!- pressure
!- deflection state
!- SupportPillar
!- Name
!- spacing
111

Input-Output Reference

Group Surface Construction Elements

0.0005;

!- radius

WindowGap:DeflectionState
This input object is used to enter data describing deflection state of the gap. It is referenced
from WindowMaterial:Gap object only and it is used only when deflection model is set to
MeasuredDeflection (see WindowThermalModel:Params), otherwise it is ignored.
Field: Name
Unique name of the deflection state.
Field: Deflected Thickness
The thickness (m) of the gap in deflected state. It represents value of deflection at point of
maximum which is usualy at the center poing of glazing system. It is used only with tarcog
algorithm set to Measured Deflection (WindowThermalModel:Params), otherwise this field will
be ignored.
An IDF example where WindowThermalModel:Params Deflection Model =
MeasuredDeflection:
WindowMaterial:Gap,
Gap_1_Layer,
0.0120,
Gas_1_W_0_0120,
101325.0000,
Gap_1_Deflection;
WindowGap:DeflectionState,
Gap_1_Deflection,
0.011;

!!!!!-

gap name: Air

thickness
Gas (or Gas Mixture) name
pressure
deflection state

!- deflection state of gap

!- name
!- gap thickness in deflected state

WindowGap:SupportPillar
This input object is used to enter data describing support pillar of the gap. Support pillars are
used in vacuum glazing in order to prevent deflection of glass layers.

9/29/14

112

Input-Output Reference

Group Surface Construction Elements

Figure 11. Support Pillar

Field: Name
Unique name of the support pillar.
Field: Spacing
Distance (m) between support pillar centers (see the Engineering reference document for
more information).
Field: Radius
The radius (m) of the support pillar (see Engineering reference document for more
information).
An IDF example for vacuum glazing (see Vacuum Glazing example in WindowMaterial:Gap
above)
WindowGap:SupportPillar,
SupportPillar_16_Gap_1,
0.05,
0.005;

!!!!-

gap support pillar

basis matrix name
pillar spacing
pillar radius

WindowMaterial:SimpleGlazingSystem
This model should be used with caution. There may be significant differences in performance
between the simple window system and the usual more detailed model.
This input object differs from the other WindowMaterial objects in that it describes an entire
glazing system rather than individual layers. This object is used when only very limited
information is available on the glazing layers or when specific performance levels are being
targeted. The layer by layer description offers superior method of modeling windows that
should be used instead of this object when sufficient data are available. This object accesses
a model that turns simple performance indices into a fuller model of the glazing system.
The performance indices are U-factor and Solar Heat Gain Coefficient, and optionally Visible
Transmittance. The values for these performance indices can be selected by the user to
represent either glazing-only windows (with no frame) or an average window performance
that includes the frame. Inside the program the model produces an equivalent window glazing
layer with no frame. The properties of the modeled glazing layer are reported to the EIO file
9/29/14

113

Input-Output Reference

Group Surface Construction Elements

using the IDF input object syntax for the WindowMaterial:Glazing input object. This equivalent
layer could be reused in subsequent models if desired, however there will be important
differences in the modeled window performance because the simple glazing system model
includes its own special model for angular dependence when incident beam solar is not
normal to the plane of the window.
When this object is referenced in a Construction object, it cannot be used with other glazing
or gas material layers. Shades or blinds cannot be located between the glass, but these can
be used on the inside or the outside of the glazing system. If the glazing system does have
between-the-glass shades or blinds, then the U and SHGC values entered in this object
should include the impacts of those layers. Adding window treatment layers such as shades
or screens will alter the overall performance to be different than the performance levels
prescribed in this object.
Field: Name
The name of the glazing system. This value is unique across all constructions.
Field: U-Factor
This field describes the value for window system U-Factor, or overall heat transfer coefficient.
Units are in W/m 2K. This is the rated (NFRC) value for U-factor under winter heating
conditions. The U-factor is assumed to be for vertically mounted products. Although the
maximum allowable input is U-7.0 W/m2K, the effective upper limit of the glazings generated
by the underlying model is around U-5.8 W/m2K.
Field: Solar Heat Gain Coefficient
This field describes the value for SHGC, or solar heat gain coefficient. There are no units.
This is the rated (NFRC) value for SHGC under summer cooling conditions and represents
SHGC for normal incidence and vertical orientation.
Field: Visible Transmittance
This field is optional. If it is omitted, then the visible transmittance properties are taken from
the solar properties. If it is included then the model includes it when developing properties for
the glazing system. This is the rated (NFRC) value for visible transmittance at normal
incidence.
An example of this object.
WindowMaterial:SimpleGlazingSystem,
SimpleWindow:DOUBLE PANE WINDOW , !- Name
2.716 , !- U-Factor
0.763 , !- Solar Heat Gain Coefficient
0.812 ; !- Visible Transmittance

WindowMaterial:Shade
This object specifies the properties of window shade materials. Reflectance and emissivity
properties are assumed to be the same on both sides of the shade. Shades are considered to
be perfect diffusers (all transmitted and reflected radiation is hemispherically-diffuse) with
transmittance and reflectance independent of angle of incidence. There is an EnergyPlus
Reference Data Set for WindowMaterial:Shade that contains properties of generic window
shades.
Window shades can be on the inside of the window (interior shades), on the outside of the
window (exterior shades), or between glass layers (between-glass shades). When in
place, the shade is assumed to cover all of the glazed part of the window, including dividers;
it does not cover any of the window frame, if present. The plane of the shade is assumed to
be parallel to the glazing.
WindowMaterial:Shade can be used for diffusing materials such as drapery and translucent
roller shades. For slat-type shading devices, like Venetian blinds, that have a strong angular
9/29/14

114

Input-Output Reference

Group Surface Construction Elements

dependence of transmission, absorption and reflection, it is better to use

WindowMaterial:Blind. WindowMaterial:Screen should be used to model wire mesh insect
screens where the solar and visible transmission and reflection properties vary with the angle
of incidence of solar radiation.
Transmittance and reflectance values for drapery material with different color and openness
of weave can be obtained from manufacturers or determined from 2001 ASHRAE
Fundamentals, Chapter 30, Fig. 31.
There are two methods of assigning a shade to a window:
Method 1:
1) Define the construction of the window without the shade, the so-called bare

construction.

2) Reference the bare construction in the FenestrationSurface:Detailed for the window.

3) Define the WindowMaterial:Shade.
4) Define a WindowProperty:ShadingControl for the window in which you (a) specify that

this WindowMaterial:Shade is the windows shading device and (b) specify how the
shade is controlled.

Method 2:
1) Define the Construction of the window without the shade, the so-called bare

construction.

2) Reference the bare construction in the FenestrationSurface:Detailed for the window.

3) Define the WindowMaterial:Shade.
4) Define another Construction, called the shaded construction, that includes the

WindowMaterial:Shade.

5) Define a WindowProperty:ShadingControl for the window in which you (a) reference the

shaded construction and (b) specify how the shade is controlled.

Note that WindowProperty:ShadingControl has to be used with either method, even if the
shade is in place at all times. You will get an error message if you try to reference a shaded
construction directly from FenestrationSurface:Detailed.
Field: Name
Name of the shade. It is referenced as an inside or outside layer in a window construction.
Field: Solar Transmittance
Transmittance averaged over the solar spectrum. Assumed independent of incidence angle.
Field: Solar Reflectance
Reflectance averaged over the solar spectrum. Assumed same on both sides of shade and
independent of incidence angle.
Field: Visible Transmittance
Transmittance averaged over the solar spectrum and weighted by the response of the human
eye. Assumed independent of incidence angle.
Field: Visible Reflectance
Reflectance averaged over the solar spectrum and weighted by the response of the human
eye. Assumed same on both side of shade and independent of incidence angle.
Field: Thermal Hemispherical Emissivity
Effective long-wave emissivity. Assumed same on both sides of shade. We can approximate
this effective emissivity, eff, as follows. Let be the openness the shade, i.e., the ratio of
9/29/14

115

Input-Output Reference

Group Surface Construction Elements

the area of openings in the shade to the overall shade area (see Field: Air-Flow Permeability,
below). Let the emissivity of the shade material be . Then
eff

For most non-metallic materials

is about 0.9.

Field: Thermal Transmittance

Effective long-wave transmittance. Assumed independent of incidence angle. We can
approximate this effective long-wave transmittance, eff, as follows. Let be the openness
the shade, i.e., the ratio of the area of openings in the shade to the overall shade area. Let
the long-wave transmittance of the shade material be . Then

Teff

T 1

For most materials

is very close to zero, which gives

Teff
Field: Thickness
Thickness of the shade material (m). If the shade is not flat, such as for pleated pull-down
shades or folded drapery, the average thickness normal to the plane of the shade should be
used.
Field: Conductivity
Shade material conductivity (W/m-K).
Field: Shade to Glass Distance
Distance from shade to adjacent glass (m). This is denoted by s in Figure 12 and Figure 13,
below. If the shade is not flat, such as for pleated pull-down shades or folded drapery, the
average shade-to-glass distance should be used. (The shade-to-glass distance is used in
calculating the natural convective air flow between glass and shade produced by buoyancy
effects.). Note used for between-glass shades.
In the following, H is the glazing height and W is the glazing width.
Field: Top Opening Multiplier
Effective area for air flow at the top of the shade divided by sW, the horizontal area between
glass and shade (see Figures below).
Field: Bottom Opening Multiplier
Effective area for air flow at the bottom of the shade divided by sW, the horizontal area
between glass and shade (see Figures below).
Field: Left-Side Opening Multiplier
Effective area for air flow at the left side of the shade divided by sH, the vertical area between
glass and shade (see Figures below).
Field: Right-Side Opening Multiplier
Effective area for air flow at the right side of the shade divided by sH, the vertical area
between glass and shade (see Figures below).

9/29/14

116

Input-Output Reference

Group Surface Construction Elements

Field: Field: Air-Flow Permeability

The fraction of the shade surface that is open to air flow, i.e., the total area of openings
(holes) in the shade surface divided by the shade area, HW. If air cannot pass through the
shade material, Air-Flow Permeability = 0. For drapery fabric and screens the Air-Flow
Permeability can be taken as the openness of the fabric (see 2001 ASHRAE Fundamentals,
Chapter 30, Fig. 31), which is 0.0 to 0.07 for closed weave, 0.07 to 0.25 for semi-open
weave, and 0.25 and higher for open weave.
Air flow
(a)
Tgap,out

(b)
Atop
Inside

Outside

Shade

Glass

Tgap
v

Ar
H

H
Al
Ah

Tgl

Tsh

s
Glass

Abot

s
Shade
Tgap,in

Figure 12. Vertical section (a) and perspective view (b) of glass and interior shade layers showing
variables used in the gap air flow analysis. In (b), the air-flow opening areas Abot, Atop, Al, Ar and Ah are
shown schematically. See Engineering Manual for definition of thermal variables.
Atop = tW
(a)

(b)
Ar =
min(rH,sH)

s
Shade
Glass

Al =
min(lH,sH)

s
Shade
Glass

b
Abot = bW

Figure 13. Examples of air-flow openings for an interior shade covering glass of height H and width W.
Not to scale. (a) Horizontal section through shade with openings on the left and right sides (top view). (b)

9/29/14

117

Input-Output Reference

Group Surface Construction Elements

Vertical section through shade with openings at the top and bottom (side view). In (a) Left-Side Opening
Multiplier = Al /sH = min(l/s,1) and Right-Side Opening Multiplier = Ar /sH = min(r/s,1). In (b) Top Opening
Multiplier = Atop /sW = t/s and Bottom Opening Multiplier = Abot /sW = b/s.
An IDF example:
WindowMaterial:Shade,
DRAPES - CLOSE WEAVE MEDIUM, !- Name
0.05,
!- Solar transmittance
0.3000000,
!- Solar Reflectance
.05,
!- Visible transmittance
0.3000000,
!- Visible reflectance
0.9000000,
!- Thermal Hemispherical Emissivity
0.0,
!- Thermal Transmittance
0.003,
!- Thickness {m}
0.1,
!- Conductivity {W/m-K}
0.050,
!- Shade to glass distance {m}
1.0,
!- Top opening multiplier
1.0,
!- Bottom opening multiplier
0.0,
!- Left-side opening multiplier
0.0,
!- Right-side opening multiplier
0.0;
!- Air flow permeability

WindowMaterial:Blind
This object specifies the properties of a window blind consisting of flat, equally-spaced slats.
Unlike window shades, which are modeled as perfect diffusers, window blinds have solar and
visible transmission and reflection properties that strongly depend on slat angle and angle of
incidence of solar radiation. There is an EnergyPlus Reference Data Set for
WindowMaterial:Blind that contains properties of generic window blinds.
Blinds can be located on the inside of the window (interior blinds), on the outside of the
window (exterior blinds), or between two layers of glass (between-glass blinds). When in
place, the blind is assumed to cover all of the glazed part of the window, including dividers; it
does not cover any of the window frame, if present. The plane of the blind is assumed to be
parallel to the glazing. When the blind is retracted it is assumed to cover none of the window.
The solar and thermal effects of the blinds support strings, tapes or rods are ignored. Slat
curvature, if present, is ignored.
There are two methods of assigning a blind to a window:
Method 1:
1) Define the construction of the window without the blind, the so-called bare construction.
2) Reference the bare construction in the FenestrationSurface:Detailed for the window.
3) Define the WindowMaterial:Blind.
4) Define a WindowProperty:ShadingControl for the window in which you (a) specify that

this WindowMaterial:Blind is the windows shading device and (b) specify how the blind is
controlled.

Method 2:
1) Define the Construction of the window without the blind, the so-called bare construction.
2) Reference the bare construction in the FenestrationSurface:Detailed for the window.
3) Define the WindowMaterial:Blind.
4) Define another Construction, called the shaded construction, that includes the

WindowMaterial:Blind.

5) Define a WindowProperty:ShadingControl for the window in which you (a) reference the

shaded construction and (b) specify how the blind is controlled.

9/29/14

118

Input-Output Reference

Group Surface Construction Elements

Note that WindowProperty:ShadingControl has to be used with either method, even if the
blind is in place at all times. You will get an error message if you try to reference a
construction with a blind directly from Window objects (FenestrationSurface:Detailed or
Window).
Note also that WindowProperty:ShadingControl is used to determine not only when the blind
is in place, but how its slat angle is controlled.
Field: Name
Name of the blind. It is referenced as a layer in a window construction (ref: Construction
object) or as a Material Name of Shading Device in a WindowProperty:ShadingControl
object.
Field: Slat Orientation
The choices are Horizontal and Vertical. Horizontal means the slats are parallel to the
bottom of the window; this is the same as saying that the slats are parallel to the X-axis of the
window. Vertical means the slats are parallel to Y-axis of the window.
Field: Slat Width
The width of the slat measured from edge to edge (m). See Figure 14.
Field: Slat Separation
The distance between the front of a slat and the back of the adjacent slat (m). See Figure 14.
Field: Slat Thickness
The distance between the faces of a slat (m). See Figure 14.
Field: Slat Angle
The angle (degrees) between the glazing outward normal and the slat outward normal, where
the outward normal points away from the front face of the slat (degrees). See Figure 14.
If the WindowProperty:ShadingControl for the blind has Type of Slat Angle Control for Blinds
= FixedSlatAngle, the slat angle is fixed at Slat Angle.
If Type of Slat Angle Control for Blinds = BlockBeamSolar, the program automatically adjusts
the slat angle so as just block beam solar radiation. In this case the value of Slat Angle is
used only when the blind is in place and there is no beam solar radiation incident on the
blind.
If Type of Slat Angle Control for Blinds = ScheduledSlatAngle, the slat angle is variable. In
this case Slat Angle is not applicable and the field should be blank.
If Type of Slat Angle Control for Blinds = FixedSlatAngle and Slat Angle is less than the
minimum or greater than the maximum allowed by Slat Width, Slat Separation and Slat
Thickness, the slat angle will be reset to the corresponding minimum or maximum and a
warning will be issued.
Field: Slat Conductivity
The thermal conductivity of the slat (W/m-K).
Field: Slat Beam Solar Transmittance
The beam solar transmittance of the slat, assumed to be independent of angle of incidence
on the slat. Any transmitted beam radiation is assumed to be 100% diffuse (i.e., slats are
translucent).
Field: Front Side Slat Beam Solar Reflectance
The beam solar reflectance of the front side of the slat, assumed to be independent of angle
of incidence (matte finish). This means that slats with a large specularly-reflective component
(shiny slats) are not well modeled.
9/29/14

119

Input-Output Reference

Group Surface Construction Elements

Field: Back Side Slat Beam Solar Reflectance

The beam solar reflectance of the back side of the slat, assumed to be independent of angle
of incidence (matte finish). This means that slats with a large specularly-reflective component
(shiny slats) are not well modeled.
Field: Slat Diffuse Solar Transmittance
The slat transmittance for hemispherically diffuse solar radiation. This value should equal
Slat Beam Solar Transmittance.
Field: Front Side Slat Diffuse Solar Reflectance
The front-side slat reflectance for hemispherically diffuse solar radiation. This value should
equal Front Side Slat Beam Solar Reflectance.
Field: Back Side Slat Diffuse Solar Reflectance
The back-side slat reflectance for hemispherically diffuse solar radiation. This value should
equal Back Side Slat Beam Solar Reflectance.
Field: Slat Beam Visible Transmittance
The beam visible transmittance of the slat, assumed to be independent of angle of incidence
on the slat. Any transmitted visible radiation is assumed to be 100% diffuse (i.e., slats are
translucent).
Field: Front Side Slat Beam Visible Reflectance
The beam visible reflectance on the front side of the slat, assumed to be independent of
angle of incidence (matte finish). This means that slats with a large specularly-reflective
component (shiny slats) are not well modeled.
Field: Back Side Slat Beam Visible Reflectance
The beam visible reflectance on the front side of the slat, assumed to be independent of
angle of incidence (matte finish). This means that slats with a large specularly-reflective
component (shiny slats) are not well modeled.
Field: Slat Diffuse Visible Transmittance
The slat transmittance for hemispherically diffuse visible radiation. This value should equal
Slat Beam Visible Transmittance.
Field: Front Side Slat Diffuse Visible Reflectance
The front-side slat reflectance for hemispherically diffuse visible radiation. This value should
equal Front Side Slat Beam Visible Reflectance.
Field: Back Side Slat Diffuse Visible Reflectance
The back-side slat reflectance for hemispherically diffuse visible radiation. This value should
equal Back Side Slat Beam Visible Reflectance..
Field: Slat Infrared Hemispherical Transmittance
The slat Infrared transmittance. It is zero for solid metallic, wooden or glass slats, but may be
non-zero in some cases (e.g., thin plastic slats).
Field: Front Side Slat Infrared Hemispherical Emissivity
Front-side hemispherical emissivity of the slat. Approximately 0.9 for most materials. The
most common exception is bare (unpainted) metal slats or slats finished with a metallic paint.

9/29/14

120

Input-Output Reference

Group Surface Construction Elements

Field: Back Side Slat Infrared Hemispherical Emissivity

Back-side hemispherical emissivity of the slat. Approximately 0.9 for most materials. The
most common exception is bare (unpainted) metal slats or slats finished with a metallic paint.
Field: Blind to Glass Distance
For interior and exterior blinds, the distance from the mid-plane of the blind to the adjacent
glass (m). See Figure 14. Not used for between-glass blinds. As for window shades (ref:
WindowMaterial:Shade) this distance is used in calculating the natural convective air flow
between glass and blind that is produced by buoyancy effects.
Opening Multipliers
The following opening multipliers are defined in the same way as for window shades (see
WindowMaterial:Shade, Figure 12 and Figure 13). Note that, unlike window shades, there is
no input for Air-Flow Permeability; this is automatically calculated by the program from slat
angle, width and separation.
Field: Blind Top Opening Multiplier
Defined as for Material:WindowShade.
Field: Blind Bottom Opening Multiplier
Defined as for Material:WindowShade.
Field: Blind Left-Side Opening Multiplier
Defined as for Material:WindowShade.
Field: Blind Right-Side Opening Multiplier
Defined as for Material:WindowShade.
Field: Minimum Slat Angle
The minimum allowed slat angle (degrees). Used only if WindowProperty:ShadingControl (for
the window that incorporates this blind) varies the slat angle (i.e., the
WindowProperty:ShadingControl has Type of Slat Angle Control for Blinds =
ScheduledSlatAngle or BlockBeamSolar). In this case, if the program tries to select a slat
angle less than Minimum Slat Angle it will be reset to Minimum Slat Angle. (Note that if the
Minimum Slat Angle itself is less than the minimum allowed by Slat Width, Slat Separation
and Slat Thickness, it will be reset to that minimum.)
Field: Maximum Slat Angle
The maximum allowed slat angle (degrees). Used only if WindowProperty:ShadingControl
(for the window that incorporates this blind) varies the slat angle (i.e., the
WindowProperty:ShadingControl has Type of Slat Angle Control for Blinds =
ScheduledSlatAngle or BlockBeamSolar). In this case, if the program tries to select a slat
angle greater than Maximum Slat Angle the slat angle will be reset to Maximum Slat Angle.
(Note that if the Maximum Slat Angle itself is greater than the maximum allowed by Slat
Width, Slat Separation and Slat Thickness, it will be reset to that maximum.)
An IDF example:
WindowMaterial:Blind,
White Painted Metal Blind,
!- Name
HORIZONTAL, !- Slat orientation
0.025
, !- Slat width (m)
0.01875 , !- Slat separation (m)
0.001
, !- Slat thickness (m)
45.0
, !- Slat angle (deg)
44.9
, !- Slat conductivity (W/m-K)
0.0
, !- Slat beam solar transmittance
9/29/14

121

Input-Output Reference
0.8
0.8
0.0
0.8
0.8
0.0
0.7
0.7
0.0
0.7
0.7
0.0
0.9
0.9
0.050
0.0
0.0
0.5
0.5
,
;

9/29/14

Group Surface Construction Elements

,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,

!!!!!!!!!!!!!!!!!!!!!-

Front Side Slat beam solar reflectance

Back Side Slat beam solar reflectance
Slat diffuse solar transmittance
Front Side Slat diffuse solar reflectance
Back Side Slat diffuse solar reflectance
Slat beam visible transmittance
Front Side Slat beam visible reflectance
Back Side Slat beam visible reflectance
Slat diffuse visible transmittance
Front Side Slat diffuse visible reflectance
Back Side Slat diffuse visible reflectance
Slat Infrared hemispherical transmittance
Front Side Slat Infrared hemispherical emissivity
Back Side Slat Infrared hemispherical emissivity
Blind-to-glass distance
Blind top opening multiplier
Blind bottom opening multiplier
Blind left-side opening multiplier
Blind right-side opening multiplier
Minimum slat angle (deg)
Maximum slat angle (deg)

122

Input-Output Reference

Group Surface Construction Elements

(a)

(b)
Front of slat
30

Back of slat
Slat
Angle

Slat outward normal

o

60

Glazing
outward
normal

Slat Separation
90

Slat Width
Blind-to-Glass
Distance

Outside

Slat
Thickness
Inside

135

Outside

Figure 14. (a) Side view of a window blind with horizontal slats (or top view of blind with vertical slats)
showing slat geometry. The front face of a slat is shown by a heavy line. The slat angle is defined as the
angle between the glazing outward normal and the slat outward normal, where the outward normal points
away from the front face of the slat. (b) Slat orientations for representative slat angles. The slat angle
varies from 0O, when the front of the slat is parallel to the glazing and faces toward the outdoors, to 90 O,
when the slat is perpendicular to the glazing, to 180O, when the front of the slat is parallel to the glazing
and faces toward the indoors. The minimum and maximum slat angles are determined by the slat
thickness, width and separation.
WindowMaterial:ComplexShade
This
input
object
is
used
to
define
Construction:ComplexFenestrationState object.

shade

layers

used

in

the

Field: Name
Unique name of the shading layer.
Field: Shading Layer Type
The type of shading layer. The options are:
Venetian for modeling venetian blinds
Woven for modeling shading systems with a regular weave
Perforated for modeling perforated screens
BSDF for modeling shades whose properties are represented by a BSDF file
OtherShadingType for modeling shading systems which do not belong to the any of
the previous group

9/29/14

123

Input-Output Reference

Group Surface Construction Elements

Field: Thickness
The thickness (m) of the shading layer. This value is ignored for ShadingLayerType =
Venetian, because the program will calculate the thickness based on the slat angle. This
value is needed for ShadingLayerType = Woven and Perforated
Field: Conductivity
The conductivity (W/mK) of the shading layer material. Default: 1.0
Venetian the conductivity of the venetian blind slat material
Woven the conductivity of the woven shade material (such as the thread for a fabric
shade)
Perforated for modeling perforated screens
BSDF for modeling shades whose properties are represented by a BSDF file
OtherShadingType for modeling shading systems which do not belong to the any of
the previous group
Field: IR Transmittance
The IR transmittance of the shading layer. Minimum value: 0. Maximum value: 1. Default: 0.
Field: Front Emissivity
The front emissivity of the shading layer. Minimum value: 0. Maximum value: 1. Default: 0.90.
Field: Back Emissivity
The back emissivity of the shading layer. Minimum value: 0. Maximum value: 1. Default: 0.90.
Field: Top Opening Multiplier
The top opening multiplier value will depend on the location of the shading device within the
glazing system. There are several possible scenarios which can occur and they can be
divided into two groups:
Shading device on the indoor/outdoor side of the window
In this case the opening multiplier is calculated as the smallest distance between the shading
device and the frame (dtop), divided by the gap width (S). There are three possible cases for
the position of a shading device the on indoor/outdoor side (see Figure 15).

9/29/14

124

Input-Output Reference

Group Surface Construction Elements

Figure 15. Three cases for the Dtop calculation for an indoor/outdoor shade: Case a) A shading device
between the frame; Case b) A shading device outside the frame, covering the frame; Case c) a shading
device outside the frame, not covering the frame.
In the case where the distance between the frame and the shading device is bigger than the
gap width, the dtop multiplier is equal to one. Therefore, the calculation of the Dtop opening
multiplier is:
Atop = min(dtop/S, 1)
Shading device between glass layers
In this case the opening multiplier is calculated as the smallest distance between the shading
device and the frame or spacer (dtop), divided by the smaller gap width (the minimum of (S1
andS2)).

9/29/14

125

Input-Output Reference

Group Surface Construction Elements

Figure 16. Calculation of Dtop for a shading device between glass layers
The Dtop opening multiplier for a between glass shade is calculated as:
Atop = min(dtop/Smin, 1)
Where
Smin = min(S1, S2)
Field: Bottom Opening Multiplier
The bottom opening multiplier (dbot) is calculated in the same way as the top opening
multiplier, with the rules applied to the bottom of the shading device.
Field: Left Side Opening Multiplier
The left side opening multiplier (dleft) is calcuated in the same way as the top opening
multiplier, with the rules applied to the left side of the shading device.
Field: Right Side Opening Multiplier
The right side opening multiplier (dright) is calcuated in the same way as the top opening
multiplier, with the rules applied to the right side of the shading device.
Field: Front Opening Multiplier
The fraction of glazing system area that is open on the front of the shading layer (see Figure
17). This fraction is calculated as follows: Afront / (W * H), where Afront = Area of the front of
the glazing system that is not covered by the shading system, W = the width of the glazing
system (IGU) and H is height of the glazing system (IGU).

9/29/14

126

Input-Output Reference

Group Surface Construction Elements

Figure 17. Front view of shading layer openings.

Field: Slat Width
The width (m) of the venetian slats. Used only for ShadingLayerType = Venetian.
Field: Slat Spacing
The distance (m) between front sides of the venetian slats. Used only for ShadingLayerType
= Venetian.
Field: Slat Thickness
The thickness (m) of the venetian slats. Used only for ShadingLayerType = Venetian.
Field: Slat Angle
The slat tilt angle (degrees) of the venetian slats. Used only for ShadingLayerType =
Venetian. Range of slat angle is from -90 to 90 degrees.
Field: Slat Conductivity
The conductivity (W/mK) of the venetian slats. Used only for ShadingLayerType = Venetian.
Field: Slat Curve
The curvature radius (m) of the venetian slats. Setting this value to zero means there is no
curvature in the slat (it is flat), while a non-zero value is the radius of the slat curve. This
value cannot be smaller than Slat Width / 2. Used only for ShadingLayerType = Venetian.

9/29/14

127

Input-Output Reference

Group Surface Construction Elements

Figure 18. Side view of horizontal venetian blind slats or top view of blinds with vertical slats. Front face
of slats is marked with red line.
An IDF example for ShadingLayerType = Venetian
WindowMaterial:ComplexShade,
Shade_30001_Layer,
Venetian,
0.005,
160,
9/29/14

!!!!!-

venetian blind layer

name
shading layer type
thickness
layer conductivity
128

Input-Output Reference
0.0,
0.9,
0.9,
0.0,
0.0,
0.0,
0.0,
0.05,
0.016,
0.012,
0.0006,
-45.00,
160.00,
0.0000;

Group Surface Construction Elements

!!!!!!!!!!!!!!-

IR transmittance
front emissivity
back emissivity
top opening multiplier
bottom opening multiplier
left side opening multiplier
right side opening multiplier
front opening multiplier
venetian slat width
venetian slat spacing
venetian slat thickness
venetian slat angle
venetian slat conductivity
venetian slat curve

An IDF example for ShadingLayerType = Woven

(Note that it is not necessary to include blank lines for the venetian blind input for a Woven
shade definition).
WindowMaterial:ComplexShade,
Shade_30002_Layer,
Woven,
0.011,
1,
0.0,
0.9,
0.9,
0.0,
0.0,
0.0,
0.0,
0.17;

!!!!!!!!!!!!!-

woven shade layer

name
shading layer type
thickness
layer conductivity
IR transmittance
front emissivity
back emissivity
top opening multiplier
bottom opening multiplier
left side opening multiplier
right side opening multiplier
front opening multiplier

WindowMaterial:Screen
This object specifies the properties of exterior window screen materials. The window screen
model assumes the screen is made up of intersecting orthogonally-crossed cylinders. The
surface of the cylinders is assumed to be diffusely reflecting, having the optical properties of
a Lambertian surface.
The beam solar radiation transmitted through a window screen varies with sun angle and is
made up of two distinct elements: a direct beam component and a reflected beam
component. The direct beam transmittance component is modeled using the geometry of the
screen material and the incident angle of the sun to account for shadowing of the window by
the screen material. The reflected beam component is an empirical model that accounts for
the inward reflection of solar beam off the screen material surface. This component is both
highly directional and small in magnitude compared to the direct beam transmittance
component (except at higher incident angles, for which case the magnitude of the direct
beam component is small or zero and the reflected beam component, though small in
absolute terms can be many times larger than the direct beam component). For this reason,
the reflected beam transmittance component calculated by the model can be a. disregarded,
b. treated as an additive component to direct beam transmittance (and in the same direction),
or c. treated as hemispherically-diffuse transmittance based on a user input to the model.

9/29/14

129

Input-Output Reference

Group Surface Construction Elements

Figure 19. Direct beam and reflected beam transmittance components

The window screen assembly properties of overall beam solar reflectance and absorptance
(including the screen material cylinders and open area) also change with sun angle and are
calculated based on the values of the beam solar transmittance components (direct and
reflected components described above) and the physical properties of the screen material
(i.e., screen material diameter, spacing, and reflectance).
Transmittance, reflectance, and absorptance of diffuse solar radiation are considered
constant values and apply to both the front and back surfaces of the screen. These properties
are calculated by the model as an average value by integrating the screens beam solar
properties over a quarter hemisphere of incident radiation. Long-wave emissivity is also
assumed to be the same for both sides of the screen.
There is an EnergyPlus Reference Data Set for WindowMaterial:Screen that contains
properties for generic window screens. Window screens of this type can only be used on the
outside surface of the window (exterior screens). When in place, the screen is assumed to
cover all of the glazed part of the window, including dividers; it does not cover any of the
window frame, if present. The plane of the screen is assumed to be parallel to the glazing.
WindowMaterial:Screen can be used to model wire mesh insect screens where the solar and
visible transmission and reflection properties vary with the angle of incidence of solar
radiation. For diffusing materials such as drapery and translucent roller shades it is better to
use the WindowMaterial:Shade object. For slat-type shading devices like Venetian blinds,
which have solar and visible transmission and reflection properties that strongly depend on
slat angle and angle of incidence of solar radiation, it is better to use WindowMaterial:Blind.
There are two methods of assigning a screen to a window:
Method 1:
1) Define the construction of the window without the screen, the so-called bare

construction.

2) Reference the bare construction in the FenestrationSurface:Detailed for the window.

3) Define the WindowMaterial:Screen object.
4) Define a WindowProperty:ShadingControl for the window in which you (a) specify that

this Material:WindowScreen is the windows shading device, and (b) specify how the
screen is controlled.

9/29/14

130

Input-Output Reference

Group Surface Construction Elements

Method 2:
1) Define the Construction of the window without the screen, the so-called bare

construction.

2) Reference the bare construction in the FenestrationSurface:Detailed for the window.

3) Define the WindowMaterial:Screen object.
4) Define another Construction, called the shaded construction, that includes the

WindowMaterial:Screen.

5) Define a WindowProperty:ShadingControl for the window in which you (a) reference the

shaded construction, and (b) specify how the screen is controlled.

Note that WindowProperty:ShadingControl has to be used with either method, even if the
screen is in place at all times. You will get an error message if you try to reference a shaded
construction directly from a FenestrationSurface:Detailed object.
Field: Name
Enter a unique name for the screen. This name is referenced as an outside layer in a window
construction.
Field: Reflected Beam Transmittance Accounting Method
This input specifies the method used to account for screen-reflected beam solar radiation that
is transmitted through the window screen (as opposed to being reflected back outside the
building). Since this inward reflecting beam solar is highly directional and is not modeled in
the direction of the actual reflection, the user is given the option of how to account for the
directionality of this component of beam solar transmittance. Valid choices are DoNotModel,
ModelAsDirectBeam (i.e., model as an additive component to direct solar beam and in the
same direction), or ModelAsDiffuse (i.e., model as hemispherically-diffuse radiation). The
default value is ModelAsDiffuse.
Field: Diffuse Solar Reflectance
This input specifies the solar reflectance (beam-to-diffuse) of the screen material itself (not
the effective value for the overall screen assembly including open spaces between the
screen material). The outgoing diffuse radiation is assumed to be Lambertian (distributed
angularly according to Lamberts cosine law). The solar reflectance is assumed to be the
same for both sides of the screen. This value must be from 0 to less than 1.0. In the absence
of better information, the input value for diffuse solar reflectance should match the input value
for diffuse visible reflectance.
Field: Diffuse Visible Reflectance
This input specifies the visible reflectance (beam-to-diffuse) of the screen material itself (not
the effective value for the overall screen assembly including open spaces between the
screen material) averaged over the solar spectrum and weighted by the response of the
human eye. The outgoing diffuse radiation is assumed to be Lambertian (distributed angularly
according to Lamberts cosine law). The visible reflectance is assumed to be the same for
both sides of the screen. This value must be from 0 to less than 1.0.
If diffuse visible reflectance for the screen material is not available, then the following
guidelines can be used to estimate this value:
Dark-colored screen (e.g., charcoal):
0.08 0.10
Medium-colored screen (e.g., gray):
0.20 0.25
Light-colored screen (e.g., bright aluminum):
0.60 0.65
Commercially-available gray scale or grayscale reflecting chart references can be purchased
for improved accuracy in estimating visible reflectance (by visual comparison of screen
reflected brightness with that of various known-reflectance portions of the grayscale).

9/29/14

131

Input-Output Reference

Group Surface Construction Elements

Field: Thermal Hemispherical Emissivity

Long-wave emissivity of the screen material itself (not the effective value for the overall
screen assembly including open spaces between the screen material). The emissivity is
assumed to be the same for both sides of the screen.
For most non-metallic materials, is about 0.9. For metallic materials, is dependent on
material, its surface condition, and temperature. Typical values for metallic materials range
from 0.05 0.1 with lower values representing a more finished surface (e.g. low oxidation,
polished surface). Material emissivities may be found in Table 5 from the 2005 ASHRAE
Handbook of Fundamentals, page 3.9. The value for this input field must be between 0 and 1,
with a default value of 0.9 if this field is left blank.
Field: Conductivity
Screen material conductivity (W/m-K). This input value must be greater than 0. The default
value is 221 W/m-K (aluminum).
Field: Screen Material Spacing
The spacing, S, of the screen material (m) is the distance from the center of one strand of
screen to the center of the adjacent one. The spacing of the screen material is assumed to be
the same in both directions (e.g., vertical and horizontal). This input value must be greater
than the non-zero screen material diameter. If the spacing is different in the two directions,
use the average of the two values.

Figure 20. Screen Material Spacing and Diameter

Field: Screen Material Diameter
The diameter, D, of individual strands or wires of the screen material (m). The screen
material diameter is assumed to be the same in both directions (e.g., vertical and horizontal).
This input value must be greater than 0 and less than the screen material spacing. If the
diameter is different in the two directions, use the average of the two values.
Field: Screen to Glass Distance
Distance from the window screen to the adjacent glass surface (m). If the screen is not flat,
the average screen to glass distance should be used. The screen-to-glass distance is used in
calculating the natural convective air flow between the glass and the screen produced by
buoyancy effects. This input value must be from 0.001 m to 1 m, with a default value of 0.025
m if this field is left blank.

9/29/14

132

Input-Output Reference

Group Surface Construction Elements

Field: Top Opening Multiplier

Effective area for air flow at the top of the screen divided by the horizontal area between the
glass and screen (see the same field for the Material:WindowShade object for additional
description). The opening multiplier fields can be used to simulate a shading material that is
offset from the window frame. Since window screens are typically installed against the
window frame, the default value is equal to 0.This input value can range from 0 to 1.
Field: Bottom Opening Multiplier
Effective area for air flow at the bottom of the screen divided the horizontal area between the
glass and screen (see the same field for the Material:WindowShade object for additional
description). The opening multiplier fields can be used to simulate a shading material that is
offset from the window frame. Since window screens are typically installed against the
window frame, the default value is equal to 0. This input value can range from 0 to 1.
Field: Left-Side Opening Multiplier
Effective area for air flow at the left side of the screen divided the vertical area between the
glass and screen (see the same field for the Material:WindowShade object for additional
description). The opening multiplier fields can be used to simulate a shading material that is
offset from the window frame. Since window screens are typically installed against the
window frame, the default value is equal to 0. This input value can range from 0 to 1.
Field: Right-Side Opening Multiplier
Effective area for air flow at the right side of the screen divided the vertical area between the
glass and screen (see the same field for the Material:WindowShade object for additional
description). The opening multiplier fields can be used to simulate a shading material that is
offset from the window frame. Since window screens are typically installed against the
window frame, the default value is equal to 0. This input value can range from 0 to 1.
Field: Angle of Resolution for Screen Transmittance Output Map
Angle of resolution, in degrees, for the overall screen beam transmittance (direct and
reflected) output map. The comma-separated variable file eplusscreen.csv (Ref.
OutputDetailsandExamples.pdf) will contain the direct beam and reflected beam solar
radiation that is transmitted through the window screen as a function of incident sun angle (0
to 90 degrees relative solar azimuth and 0 to 90 degrees relative solar altitude) in sun angle
increments specified by this input field. The default value is 0, which means no transmittance
map is generated. Other valid choice inputs are 1, 2, 3 and 5 degrees.
An IDF example for this object, along with Construction and WindowProperty:ShadingControl
objects, is shown below:
WindowMaterial:Screen,
EXTERIOR SCREEN,
ModelAsDiffuse,
0.6,
0.6,
0.9,
221.0,
0.00154,
0.000254,
0.025,
0.0,
0.0,
0.0,
0.0,
0;

!- Name
!- Reflected Beam Transmittance Accounting Method
!- Diffuse Solar Reflectance
!- Diffuse Visible Reflectance
!- Thermal Hemispherical Emissivity
!- Conductivity {W/m-K}
!- Screen Material Spacing (m)
!- Screen Material Diameter (m)
!- Screen-to-Glass Distance {m}
!- Top Opening Multiplier
!- Bottom Opening Multiplier
!- Left-Side Opening Multiplier
!- Right-Side Opening Multiplier
!- Angle of Resolution for Output Map {deg}

Construction,
DOUBLE PANE WITHOUT SCREEN,

9/29/14

!- Name

133

Input-Output Reference

Group Surface Construction Elements

GLASS - CLEAR SHEET 1 / 8 IN,

!- Outside Layer
WinAirB1 - AIRSPACE RESISTANCE, !- Layer #2
GLASS - CLEAR SHEET 1 / 8 IN;
!- Layer #3
WindowProperty:ShadingControl,
DOUBLE PANE WITH SCREEN, !ExteriorScreen,
!,
!AlwaysOn,
!ScreenSchedule,
!20.0,
!YES,
!NO,
!EXTERIOR SCREEN,
!,
!;
!-

User Supplied Shading Control Name

Shading Type
Name of construction with shading
Shading Control Type
Schedule Name
SetPoint {W/m2, W or deg C}
Shading Control Is Scheduled
Glare Control Is Active
Material Name of Shading Device
Type of Slat Angle Control for Blinds
Slat Angle Schedule Name

WindowMaterial:Shade:EquivalentLayer
This object specifies the properties of Equivalent Layer window shade (roller blind) materials.
Shades are considered to be thin, flat and perfect diffusers (all transmitted and reflected
radiation is hemispherically-diffuse). However, shades can have beam-beam transmittance
by virtue of their material openness. The beam-beam transmittnec is assumed to be the
same for both sides of the shade and is the same as the openness area fraction. Beamdffuse transmittance and reflectance, and emissivity properties can be different for front and
back side of the shade. Window shades can be placed on the inside of the window, on the
outside of the window, or between glass layers. WindowMaterial:Shade:EquivalentLayer is
used for roller blinds. The off-normal solar property calculation of shades (roller blind) is
based on a set of correlations developed from measurement of samples of commercially
produced roller blind material with openness fraction less than 0.14. The model is not
intended for materials with unusually high values of openness and should be limited to a
mximum openness fraction of 0.20. The visible spectrum solar properties input fields are not
used currently hence can be left blank.
Field: Name
Name of the shade. It is referenced as an inside, inbetween or outside layer in an equivalent
layer window construction.
Field: Shade Beam-Beam Solar Transmittance
This value is the beam-beam transmittance of the shade at normal incidence and it is the same as
the openness area fraction of the shade material. Assumed to be the same for front and back
sides of the roller blinds. The minimum value is 0.0 and maximum value is less than 1.0. The
default value is 0.0. For most common shade materials (e.g. Roller Blinds) the material oppeness
fraction doesnt exceed 0.20.
Field: Front Side Shade Beam-Diffuse Solar Transmittance
This value is the front side beam-diffuse transmittance of the shade material at normal incidence
averaged over the entire spectrum of solar radiation. The minimum value is 0.0 and maximum
value is less than 1.0. The default value is 0.0.
Field: Back Side Shade Beam-Diffuse Solar Transmittance
This value is the back side beam-diffuse transmittance of the shade material at normal incidence
averaged over the entire spectrum of solar radiation. The minimum value is 0.0 and maximum
value is less than 1.0. The default value is 0.0.

9/29/14

134

Input-Output Reference

Group Surface Construction Elements

Field: Front Side Shade Beam-Diffuse Solar Reflectance

This value is the front side beam-diffuse reflectance of the shade material at normal incidence
averaged over the entire spectrum of solar radiation. The minimum value is 0.0 and maximum
value is less than 1.0.
Field: Back Side Shade Beam-Diffuse Solar Reflectance
This value is the back side beam-diffuse reflectance of the shade material at normal incidence
averaged over the entire spectrum of solar radiation. The minimum value is 0.0 and maximum
value is less than 1.0.
Field: Shade Beam-Beam Visible Transmittance
This value is the beam-beam transmittance at normal incidence averaged over the visible
spectrum of solar radiation. Assumed to be the same for front and back sides. The minimum
value is 0.0 and maximum value is less than 1.0. Currently this input field is not used.
Field: Shade Beam-Diffuse Visible Transmittance
This value is the beam-diffuse transmittance at normal incidence averaged over the visible
spectrum of solar radiation. Assumed to be the same for front and back sides. The minimum
value is 0.0 and maximum value is less than 1.0. Currently this input field is not used.
Field: Shade Beam-Diffuse Visible Reflectance
This value is the beam-diffuse reflectance at normal incidence averaged over the visible spectrum
of solar radiation. Assumed to be the same for front and back sides. The minimum value is 0.0
and maximum value is less than 1.0. Currently this input field is not used.
Field: Shade Material Infrared Transmittance
This value is the long-wave transmittance of the shade material and assumed to be the same for
front and back sides of the shade. The minimum value is 0.0 and maximum value is less than 1.0.
Default value is 0.05.
Field: Front Side Shade Material Infrared Emissivity
This value is the front side long-wave hemispherical emissivity of shade material. The minimum
value is 0.0 and maximum value is less than 1.0. Default value is 0.91. The front side effective
emissivity of the shade layer is calculated using this value and the material openness specified
above.
Field: Back Side Shade Material Infrared Emissivity
This value is the back side long-wave hemispherical emissivity of shade material. The minimum
value is 0.0 and maximum value is less than 1.0. Default value is 0.91. The back side effective
emissivity of the shade is calculated using this value and the material openness specified above.
An IDF example for this object is shown below:
WindowMaterial:Shade:EquivalentLayer,
Shade1,
!- Name
0.190,
!- Shade Beam-Beam Solar Transmittance
0.206,
!- Front Side Shade Beam-Diffuse Solar Transmittance
0.206,
!- Back Side Shade Beam-Diffuse Solar Transmittance
0.499,
!- Front Side Shade Beam-Diffuse Solar Reflectance
0.499,
!- Back Side Shade Beam-Diffuse Solar Reflectance
0.0,
!- Shade Beam-Beam Visible Transmittance
0.0,
!- Shade Beam-Diffuse Vissible Transmittance
0.0,
!- Shade Vissible Reflectance
0.0,
!- Shade Material Infrared Transmittance
0.84,
!- Front Side Shade Material Infrared Emissivity
0.84;
!- Back Side Shade Material Infrared Emissivity

9/29/14

135

Input-Output Reference

Group Surface Construction Elements

WindowMaterial:Drape:EquivalentLayer
Specifies the optical and thermal properties of equivalent layer window drape fabric materials.
Drapery fabric shades are commonly placed on the the inside of the window. The long-wave
(infrared) properties for commonly used drapery fabrics are assumed to be the same on both
sides but different values can be specified when required. Drape fabric shade layers are
considered to be perfect diffusers (reflected radiation is hemispherically-diffuse independent of
angle of incidence). Unpleated drape fabric is treated as thin and flat layer. The off-normal optical
properties of drapery fabric is determined from user specified optical properties at normal
incidence using empirical correlations. Pleated drape fabric requires entering the pleated
section average width and length as showsn in Figure 21. For pleated drapes the effective
beam-beam and beam-diffuse solar properties are determined by tracking both radiation
components, for a given incident angle solar radiation, through various interactions with a
fabric pleated in a rectangular geometry shown in Figure 21. The solar properties of the two
different pleat facets are evaluated on the basis of the local solar incidence angle. Therefore,
the effective layer properties are influenced not just by horizontal solar profile angle, but also
by incidence angle. The correlations used for drape fabrics optical property calculations
reqiure that the solar absorptance of the fabric, at normal incidence, is not less than 1%.

S
W

Figure 21. Geometry used for Pleated Drape Analysis

Field: Name
Name of the drape fabric shade layer. It is referenced as an inside, in between or outside
layer in an equivalent layer window construction.
Field: Drape Beam-Beam Solar Transmittance
This value is the drape fabric beam-beam transmittance at normal incidence, and it is the same
as the drape fabric openness area fraction. Assumed to be the same for front and back sides of
the drape fabric layer. The minimum value is 0.0 and maximum value is less than 1.0. For most
drape fabric materials the maximum frabric openness fraction do not exceed 0.2. The default
value is 0.0.
Field: Front Side Drape Beam-Diffuse Solar Transmittance
This value is the front side beam-diffuse solar transmittance of the drape fabric material at normal
incidence averaged over the entire spectrum of solar radiation. The minimum value is 0.0 and
maximum value is less than 1.0.

9/29/14

136

Input-Output Reference

Group Surface Construction Elements

Field: Back Side Drape Beam-Diffuse Solar Transmittance

This value is the back side beam-diffuse solar transmittance of the drape fabric material at normal
incidence averaged over the entire spectrum of solar radiation. The minimum value is 0.0 and
maximum value is less than 1.0.
Field: Front Side Drape Beam-Diffuse Solar Reflectance
This value is the front side beam-diffuse solar reflectance of the drape fabric material at normal
incidence averaged over the entire spectrum of solar radiation. The minimum value is 0.0 and
maximum value is less than 1.0.
Field: Back Side Drape Beam-Diffuse Solar Reflectance
This value is the back side beam-diffuse solar reflectance of the drape fabric material at normal
incidence averaged over the entire spectrum of solar radiation. The minimum value is 0.0 and
maximum value is less than 1.0.
Field: Drape Beam-Beam Visible Transmittance
This value is the drape fabric beam-beam visible transmittance at normal incidence averaged
over the visible spectrum range of solar radiation. Assumed to be the same for front and back
sides of the drape fabric layer. The minimum value is 0.0 and maximum value is less than 1.0.
The default value is 0.0. This input field is not used currently.
Field: Front Side Drape Beam-Diffuse Visible Reflectance
This value is the front side drape fabric beam-diffuse visible reflectance at normal incidence
averaged over the visible spectrum range of solar radiation. Assumed to be the same for front
and back sides of the drape. The minimum value is 0.0 and maximum value is less than 1.0. The
default value is 0.0. This input field is not used currently.
Field: Back Side Drape Diffuse-Diffuse Visible Reflectance
This value is the back side drape fabric diffuse-diffuse visible reflectance at normal incidence
averaged over the visible spectrum range of solar radiation. Assumed to be the same for front
and back sides of the drape. The minimum value is 0.0 and maximum value is less than 1.0. The
default value is 0.0. This input field is not used currently.
Field: Drape Material Infrared Transmittance
This value is the long-wave hemispherical transmittance of the fabric material at zero fabric
openness fraction. Assumed to be the same for front and back sides of the drape fabric material
layer. The minimum value is 0.0 and maximum value is less than 1.0. The default value is 0.05.
Field: Front Side Drape Material Infrared Emissivity
This value is the front side long-wave hemispherical emissivity of fabric material at zero shade
opennes. The minimum value is 0.0 and maximum value is less than 1.0. the default value is
0.87. The front side effective emissivity of the drape fabric layer is calculated using this value and
the fabric openness area fraction specified above.
Field: Back Side Drape Material Infrared Emissivity
This value is the back side long-wave hemispherical emissivity of fabric material at zero fabric
openness fraction. The minimum value is 0.0 and maximum value is less than 1.0. The default
value is 0.87. The back side effective emissivity of the drape fabric layer is calculated using this
value and the fabric openness area fraction specified above.
Field: Width of Pleated Fabric
This value is the width of the pleated section of the draped fabric, w(m). If the drape fabric is flat
(unpleated), then the pleated section width is set to zero. The default value is 0.0, i.e., assumes
flat drape fabric.

9/29/14

137

Input-Output Reference

Group Surface Construction Elements

Field: Length of Pleated Fabric

This value is the length of the pleated section of the draped fabric, s(m). If the drape fabric is flat
(unpleated), then the pleated section length is set to zero. The default value is 0.0, i.e., assumes
flat drape fabric.
An IDF example for this object is shown below:
WindowMaterial:Drape:EquivalentLayer,
Drape02,
!- Name
0.14,
!- Shade Beam-Beam Solar Transmittance
0.10,
!- Front Side Shade Beam-Diffuse Solar Transmittance
0.10,
!- Back Side Shade Beam-Diffuse Solar Transmittance
0.40,
!- Front Side Shade Beam-Diffuse Solar Reflectance
0.50,
!- Back Side Shade Beam-Diffuse Solar Reflectance
0.0,
!- Shade Beam-Beam Visible Transmittance
0.0,
!- Shade Beam-Diffuse Visible Transmittance
0.0,
!- Shade Beam-Diffuse Visible Reflectance
0.10,
!- Shade Material Infrared Transmittance
0.90,
!- Front Side Shade Material Infrared Emissivity
0.80,
!- Back Side Shade Material Infrared Emissivity
0.01,
!- Width of Pleated Fabric
0.025;
!- Length of Pleated Fabric

WindowMaterial:Blind:EquivalentLayer
This object specifies the properties of an Equivalent Layer window blind consisting of thin and equallyspaced slats. The the model assumes that slats are flat and thin, and applies correction for the slat curvature
effect based on the user specified slat crwon. Slats are assumed to transmit and reflect diffusely. The
effective shortwave optical and longwave optical properties of venetian blind layer is estimated
analytically. The Equivalent Layer blind model requires optical properties and geometry of the slats shown

S
W

Figure 22. Geometry and Properties used for venetian blind analysis
. Likewise, effective longwave properties are obtained for the layer knowing longwave
properties of the slats.

9/29/14

138

Input-Output Reference

Group Surface Construction Elements

S
W

Figure 22. Geometry and Properties used for venetian blind analysis
The input data required to characterize a venetian blind are: front and back side reflectance
and transmittance of the slat, geometry (Slat width, w, slat spacing, s, slat crown, c, and slat
angle, , and long wave emittance and transmittance of the slat. Blinds can be located on the
inside of the window, on the outside of the window, or between two layers of glass. The blind
is assumed to cover all of the glazed part of the window.
Field: Name
Name of the venetian blind. It is referenced as an inside, outside or in between layers in an
equivalent layer window construction.
Field: Slat Orientation
The choices are Horizontal and Vertical. Horizontal means the slats are parallel to the
bottom of the window; this is the same as saying that the slats are parallel to the X-axis of the
window. Vertical means the slats are parallel to Y-axis of the window. The default is
Horizontal.
Field: Slat Width
This value is the width of the slat measured from edge to edge (m). The default value is
0.0254.
Field: Slat Separation
The distance between the front of a slat and the back of the adjacent slat (m). The default
value is 0.025. The slat separation should not be greater than the slat width.
Field: Slat Crown
The perpendicular length between the slat cord and the curve (m). Crown=0.0625xSlat width.
Slat is assumed to be rectangular in cross section and flat. The crown accounts for curvature of
the slat. The minimum value is 0.0, and the default value is 0.0015m.
Field: Slat Angle
The angle (degrees) between the glazing outward normal and the slat outward normal, where
the outward normal points away from the front face of the slat (degrees). If the Slat Angle
Control input field below specified is FixedSlatAngle, then the slat angle is fixed at Slat
Angle value entered. Minimum value is zero, and the maximum value allowed is 180.0
degrees. The default value is 45 degrees.

9/29/14

139

Input-Output Reference

Group Surface Construction Elements

Field: Front Side Slat Beam-Diffuse Solar Transmittance

This value is the slat front side beam-diffuse solar transmittance at normal incidence
averaged over the entire spectrum of solar radiation. Any transmitted beam radiation is
assumed to be 100% diffuse (i.e., slats are translucent). Minimum value is 0.0, and the
maximum value is less than 1.0. The default value is 0.0.
Field: Back Side Slat Beam-Diffuse Solar Transmittance
This value is the slat back side beam-diffuse solar transmittance at normal incidence
averaged over the entire spectrum of solar radiation. Any transmitted beam radiation is
assumed to be 100% diffuse (i.e., slats are translucent). Minimum value is 0.0, and the
maximum value is less than 1.0. The default value is 0.0.
Field: Front Side Slat Beam-Diffuse Solar Reflectance
This value is slat front side beam-diffuse solar reflectance at normal incidence averaged over
the entire spectrum of solar radiation. All the reflected component is assumed to be diffuse.
Minimum value is 0.0, and the maximum value is less than 1.0.
Field: Back Side Slat Beam-Diffuse Solar Reflectance
This value is the slat back side beam-diffuse solar reflectance at normal incidence averaged
over the entire spectrum of solar radiation. All the reflected component is assumed to be
diffuse. Minimum value is 0.0, and the maximum value is less than 1.0.
Field: Front Side Slat Beam-Diffuse Visible Solar Transmittance
This value is the slat front side beam-diffuse visible transmittance at normal incidence
averaged over the visible spectrum range of solar radiation. Any transmitted beam radiation
is assumed to be 100% diffuse (i.e., slats are translucent). Minimum value is 0.0, and the
maximum value is less than 1.0. The default value is 0.0.
Field: Back Side Slat Beam-Diffuse Visible Solar Transmittance
This value is the slat back side beam-diffuse visible transmittance at normal incidence
averaged the visible spectrum range of solar radiation. Any transmitted beam radiation is
assumed to be 100% diffuse (i.e., slats are translucent). Minimum value is 0.0, and the
maximum value is less than 1.0. The default value is 0.0.
Field: Front Side Slat Beam-Diffuse Visible Solar Reflectance
This value is the slat front side beam-diffuse visible reflectance at normal incidence averaged
over the visible spectrum range of solar radiation. All the reflected component is assumed to
be diffuse. Minimum value is 0.0, and the maximum value is less than 1.0
Field: Back Side Slat Beam-Diffuse Visible Solar Reflectance
This value is the slat back side beam-diffuse visible reflectance at normal incidence averaged
over the visible spectrum range of solar radiation. All the reflected component is assumed to
be diffuse. Minimum value is 0.0, and the maximum value is less than 1.0
Field: Slat Diffuse-Diffuse Solar Transmittance
This value is the slat diffuse-diffuse solar transmittance for hemispherically diffuse solar
radiation. This value is the same for front and back side of the slat. Minimum value is 0.0,
and the maximum value is less than 1.0.
Field: Front Side Slat Diffuse-Diffuse Solar Reflectance
This value is the slat front side diffuse-diffuse solar reflectance for hemispherically diffuse
solar radiation. Minimum value is 0.0, and the maximum value is less than 1.0.

9/29/14

140

Input-Output Reference

Group Surface Construction Elements

Field: Back Side Slat Diffuse-Diffuse Solar Reflectance

This value is the slat back side diffuse-diffuse solar reflectance for hemispherically diffuse
solar radiation. Minimum value is 0.0, and the maximum value is less than 1.0.
Field: Slat Diffuse-Diffuse Visible Transmittance
This value is the slat diffuse-diffuse visible transmittance for hemispherically diffuse visible
spectrum range of solar radiation. This value is the same for front and back side of the slat.
Minimum value is 0.0, and the maximumvalue is less than 1.0. This input field is not used
currently.
Field: Front Side Slat Diffuse-Diffuse Visible Reflectance
This value is the slat front side diffuse-diffuse visible reflectance for hemispherically diffuse
visible spectrum range of solar radiation. Minimum value is 0.0, and the maximum value is
less than 1.0. This input field is not used currently.
Field: Back Side Slat Diffuse-Diffuse Visible Reflectance
This value is the slat back side diffuse-diffuse visible reflectance for hemispherically diffuse
visible spectrum range of solar radiation. Minimum value is 0.0, and the maximum value is
less than 1.0. This input field is not used currently.
Field: Slat Infrared Transmittance
This value is the long-wave hemispherical transmittance of the slat material. Assumed to be the
same for both sides of the slat. The minimum value is 0.0, the maximum value is less than 1.0.
The default value is 0.0.
Field: Front Side Slat Infrared Emissivity
This value is the front side long-wave hemispherical emissivity of the slat material. The minimum
value is 0.0, the maximum value is less than 1.0. The default value is 0.9.
Field: Back Side Slat Infrared Emissivity
This value is the back side long-wave hemispherical emissivity of the slat material. The minimum
value is 0.0, the maximum value is less than 1.0. The default value is 0.9.
Field: Slat Angle Control
This input field is used only if slat angle control is desired. The three key choice inputsallowed are
FixedSlatAngle, MaximizeSolar, and BlockBeamSolar. The default value is FixedSlatAngle.
If Type of Slat Angle Control for Blinds = MaximizeSolar the slat angle is adjusted to maximize
solar gain. If Type of Slat Angle Control for Blinds = BlockBeamSolar, the slat angle is adjusted
to maximize visibiity while eliminating beam solar radiation. If Type of Slat Angle Control for
Blinds = FixedSlatAngle, then the model uses a fixed slat angle specified above.
An IDF example for this object, is shown below:
WindowMaterial:Blind:EquivalentLayer,
VBU8D6+45SW1,
! - Name
Horizontal,
! - Slat Orientation
0.025,
! - Slat Width
0.025,
! - Slat Separation
0.0,
! - Slat Crown
45.0,
! - Slat Angle
0.0,
! - Front Side Slat Beam-Diffuse Solar Transmittance
0.0,
! - Back Side Slat Beam-Diffuse Solar Transmittance
0.0,
! - Front Side Slat Beam-Diffuse Solar Reflectance
0.0,
! - Back Side Slat Beam-Diffuse Solar Reflectance
0.0,
! - Front Side Slat Beam-Diffuse Visible Transmittance
0.0,
! - Back Side Slat Beam-Diffuse Visible Transmittance
0.0,
! - Front Side Slat Beam-Diffuse Visible Reflectance
0.0,
! - Back Side Slat Beam-Diffuse Visible Reflectance
9/29/14

141

Input-Output Reference

Group Surface Construction Elements

0.0,
0.80,
0.60,
0.0,
0.0,
0.0,
0.0,
0.90,
0.90,
FixedSlatAngle;

!
!
!
!
!
!
!
!
!
!

Slat Diffuse-Diffuse Solar Transmittance

Front Side Slat Diffuse-Diffuse Solar Reflectance
Back Side Slat Diffuse-Diffuse Solar Reflectance
Slat Diffuse-Diffuse Visible Transmittance
Front Side Slat Diffuse-Diffuse Visible Reflectance
Back Side Slat Diffuse-Diffuse Visible Reflectance
Slat Infrared Transmittance
Front Side Slat Infrared Emissivity
Back Side Slat Infrared Emissivity
Slat Angle Control

WindowMaterial:Screen:EquivalentLayer
This object specifies the optical and thermal properties of exterior screen materials for
Equivalent Layer Window. Can only be placed on the exterior side of window construction.
The window screen model assumes the screen is made up of intersecting orthogonallycrossed cylinders. The surface of the cylinders is assumed to be diffusely reflecting. The
beam solar radiation transmitted through an equivalent Layer window screen varies with sun
angle and is made up of two distinct elements: a beam-beam component and a beam-difuse
component. The beam-beam transmittance component is calculated using screen openness
area fraction determined from the geometry of the screen and the incident angle of the sun.
Empirical correlations are used to obtain the effective off-normal solar and longwave
properties of insect screens. Insect screen geometry is shown in Figure 23. The calculation
of effective solar properties requires a set of properties measured at normal incidence.

d
Figure 23. Geometry used for insect screen analysis
The formulation of the model, assumption and correlations used to calculate effective solar and
longwave properties of insect screens are described in the Engineering Reference.
Field: Name
Name of the insect screen. It is referenced as an outside layer in an equivalent layer window
construction.
Field: Screen Beam-Beam Solar Transmittance
This value is the beam-beam transmittance of the screen material at normal incidence. This value
is the same as the screen oppenness area fraction. This value can be autocalculated from the
wire spacing and wire diameter. It is the same for both sides of the screen. The minimum value is
0.0, and maximum value is less than 1.0.

9/29/14

142

Input-Output Reference

Group Surface Construction Elements

Field: Screen Beam-Diffuse Solar Transmittance

This value is the beam-diffuse solar transmittance of the screen material at normal incidence
averaged over the entire spectrum of solar radiation. Assumed to be the same for both sides of
the screen. The minimum value is 0.0, and the maximum value is less than 1.0.
Field: Screen Beam-Diffuse Solar Reflectance
This value is the beam-diffuse solar reflectance of the screen material at normal incidence
averaged over the entire spectrum of solar radiation. Assumed to be the same for both sides of
the screen. The minimum value is 0.0, and the maximum value is less than 1.0.
Field: Screen Beam-Beam Visible Transmittance
This value is the beam-beam visible transmittance of the screen material at normal incidence
averaged over the visible spectrum range of solar radiation. Assumed to be the same for both
sides of the screen. The minimum value is 0.0, and maximum value is less than 1.0. This input
input field is not used currently.
Field: Screen Beam-Diffuse Visible Transmittance
This value is the beam-diffuse visible reflectance of the screen material at normal incidence
averaged over the visible spectrum range of solar radiation. Assumed to be the same for both
sides of the screen. The minimum value is 0.0, and the maximum value is less than 1.0. This
input input field is not used currently.
Field: Screen Beam-Diffuse Visible Reflectance
This value is the beam-diffuse visible reflectance of the screen material at normal incidence
averaged over the visible spectrum range of solar radiation. Assumed to be the same for both
sides of the screen. The minimum value is 0.0, and the maximum value is less than 1.0. This
input input field is not used currently.
Field: Screen Infrared Transmittance
This value is the long-wave hemispherical transmittance of the the screen material. Assumed to
be the same for both sides of the screen material. The minimum value is 0.0, the maximum value
is less than 1.0. The default value is 0.02
Field: Screen Infrared Emissivity
This value is the long-wave hemispherical emissivity of the screen material. Assumed to be the
same for both sides of the screen material. The minimum value is 0.0, the maximum value is less
than 1.0. The default value is 0.93.
Field: Screen Wire Spacing
The spacing, S (m), of the screen material is the distance from the center of one strand of screen
to the center of the adjacent one. The spacing of the screen material is assumed to be the same
in both directions (e.g., vertical and horizontal). This input value must be greater than the non-zero
screen material diameter. If the spacing is different in the two directions, use the average of the
two values. Default value is 0.0025m.
Field: Screen Wire Diameter
The diameter, D (m), of individual strands or wires of the screen material. The screen material
diameter is assumed to be the same in both directions (e.g., vertical and horizontal). This input
value must be greater than 0 and less than the screen wire spacing. If the diameter is different in
the two directions, use the average of the two values. Default value is 0.005m.
An IDF example for this object, is shown below:
WindowMaterial:Screen:EquivalentLayer,
INSCRN,
!- Name
0.763,
!- Screen Beam-Beam Solar Transmittance
9/29/14

143

Input-Output Reference
0.052,
0.076,
0.0,
0.0,
0.0,
0.0,
0.84,
0.025,
0.005;

Group Surface Construction Elements

!!!!!!!!!-

Screen
Screen
Screen
Screen
Screen
Screen
Screen
Screen
Screen

Beam-Diffuse Solar Transmittance

Beam-Diffuse Solar Reflectance
Beam-Beam Visible Transmittance
Beam-Diffuse Visible Transmittance
Beam-Diffuse Visible Reflectance
Infrared Transmittance
Infrared Emissivity
Wire Spacing
Wire Diameter

WindowMaterial:Glazing:EquivalentLayer
Glass material properties for equivalent layer window model. Uses transmittance/reflectance
input method. For exterior windows, front side is the side of the glass closest to the outside
air and back side is the side closest to the zone the window is defined in. For interzone
windows, front side is the side closest to the zone adjacent to the zone the window is
defined in and back side is the side closest to the zone the window is defined in.
Field: Name
The name of the glass layer. It corresponds to a layer in an equivalent layer window
construction.
Field: Optical Data Type
Valid values for this field are SpectralAverage, or Spectral. If Optical Data Type =
SpectralAverage, the values you enter for solar transmittance and reflectance are assumed
to be averaged over the solar spectrum, and the values you enter for visible transmittance
and reflectance are assumed to be averaged over the solar spectrum and weighted by the
response of the human eye. The spectral data input is not supported now.
Field: Window Glass Spectral Data Set Name
This input field is not used currently.
Field: Front Side Beam-Beam Solar Transmittance
This value is the front side beam-beam solar transmittance of the glazing at normal incidence
averaged over the entire spectrum of solar radiation. Used only when Optical Data Type =
SpectralAverage. The minimum value is 0.0, and the maximum value is less than 1.0.
Field: Back Side Beam-Beam Solar Transmittance
This value is the back side beam-beam solar transmittance of the glazing at normal incidence
averaged over the entire spectrum of solar radiation. Used only when Optical Data Type =
SpectralAverage. The minimum value is 0.0, and the maximum value is less than 1.0.
Field: Front Side Beam-Beam Solar Reflectance
This value is the front side beam-beam solar reflectance of the glazing at normal incidence
averaged over the entire spectrum of solar radiation. Used only when Optical Data Type =
SpectralAverage. The minimum value is 0.0, and the maximum value is less than 1.0.
Field: Back Side Beam-Beam Solar Reflectance
This value is the back side beam-beam solar reflectance of the glazing at normal incidence
averaged over the entire spectrum of solar radiation. Used only when Optical Data Type =
SpectralAverage. The minimum value is 0.0, and the maximum value is less than 1.0.
Field: Front Side Beam-Beam Visible Transmittance
This value is the front side beam-beam visible transmittance of the glazing at normal incidence
averaged over the visible spectrum range of solar radiation. Used only when Optical Data Type =
SpectralAverage. The minimum value is 0.0, and the maximum value is less than 1.0.

9/29/14

144

Input-Output Reference

Group Surface Construction Elements

Field: Back Side Beam-Beam Visible Transmittance

This value is the back side beam-beam visible transmittance of the glazing at normal incidence
averaged over the visible spectrum range of solar radiation. Used only when Optical Data Type =
SpectralAverage. The minimum value is 0.0, and the maximum value is less than 1.0.
Field: Front Side Beam-Beam Visible Reflectance
This value is the front side beam-beam visible reflectance of the glazing at normal incidence
averaged over the visible spectrum range of solar radiation. Used only when Optical Data Type =
SpectralAverage. The minimum value is 0.0, and the maximum value is less than 1.0.
Field: Back Side Beam-Beam Visible Reflectance
This value is the back side beam-beam visible reflectance of the glazing at normal incidence
averaged over the visible spectrum range of solar radiation. Used only when Optical Data Type =
SpectralAverage. The minimum value is 0.0, and the maximum value is less than 1.0.
Field: Front Side Beam-Diffuse Solar Transmittance
This value is the front side beam-diffuse solar transmittance of the glazing at normal incidence
averaged over the entire spectrum of solar radiation. Used only when Optical Data Type =
SpectralAverage. For clear glazing the beam-diffuse transmittance is zero. The minimum value is
0.0, and the maximum value is less than 1.0. Default value is 0.0.
Field: Back Side Beam-Diffuse Solar Transmittance
This value is the back side beam-diffuse solar transmittance of the glazing at normal incidence
averaged over the entire spectrum of solar radiation. Used only when Optical Data Type =
SpectralAverage. For clear glazing the beam-diffuse solar transmittance is zero. The minimum
value is 0.0, and the maximum value is less than 1.0. Default value is 0.0.
Field: Front Side Beam-Diffuse Solar Reflectance
This value is the front side beam-diffuse solar reflectance of the glazing at normal incidence
averaged over the entire spectrum of solar radiation. Used only when Optical Data Type =
SpectralAverage. The minimum value is 0.0, and the maximum value is less than 1.0. Default
value is 0.0.
Field: Back Side Beam-Diffuse Solar Reflectance
This value is the back side beam-diffuse solar reflectance of the glazing at normal incidence
averaged over the entire spectrum of solar radiation. Used only when Optical Data Type =
SpectralAverage. The minimum value is 0.0, and the maximum value is less than 1.0. Default
value is 0.0.
Field: Front Side Beam-Diffuse Visible Transmittance
This value is the front side beam-diffuse visible transmittance of the glazing at normal incidence
averaged over the visible spectrum range of solar radiation. Used only when Optical Data Type =
SpectralAverage. For clear glazing the beam-diffuse visible transmittance is zero. The minimum
value is 0.0, and the maximum value is less than 1.0. Default value is 0.0. This input field is not
used currently.
Field: Back Side Beam-Diffuse Visible Transmittance
This value is the back side beam-diffuse visible transmittance of the glazing at normal incidence
averaged over the visible spectrum range of solar radiation. Used only when Optical Data Type =
SpectralAverage. For clear glazing the beam-diffuse visible transmittance is zero. The minimum
value is 0.0, and the maximum value is less than 1.0. Default value is 0.0. This input field is not
used currently.

9/29/14

145

Input-Output Reference

Group Surface Construction Elements

Field: Front Side Beam-Diffuse Visible Reflectance

This value is the front side beam-diffuse visible reflectance of the glazing at normal incidence
averaged over the visible spectrum range of solar radiation. Used only when Optical Data Type =
SpectralAverage. The minimum value is 0.0, and the maximum value is less than 1.0. Default
value is 0.0. This input field is not used currently.
Field: Back Side Beam-Diffuse Visible Reflectance
This value is the back side beam-diffuse visible reflectance of the glazing at normal incidence
averaged over the visible spectrum range of solar radiation. Used only when Optical Data Type =
SpectralAverage. The minimum value is 0.0, and the maximum value is less than 1.0. Default
value is 0.0. This input field is not used currently.
Field: Diffuse-Diffuse Solar Transmittance
This value is the diffuse-diffuse solar transmittance of the glazing averaged over the entire
spectrum of solar radiation. Used only when Optical Data Type = SpectralAverage. The diffusediffuse transmittance is assumed to be the same for both sides of the glazing. EnergyPlus
automatically estimates the diffuse-diffuse solar transmittance from other inputs. If this input field
is specified as Autocalculate, then the calculated transmittance will be used. The minimum value
is 0.0, and the maximum value is less than 1.0.
Field: Front Side Diffuse-Diffuse Solar Reflectance
This value is the front side diffuse-diffuse solar reflectance of the glazing averaged over the entire
spectrum of solar radiation. Used only when Optical Data Type = SpectralAverage. EnergyPlus
automatically estimates the diffuse-diffuse reflectance from other inputs. If this input field is
specified as Autocalculate, then the calculated reflectance will be used. The minimum value is
0.0, and the maximum value is less than 1.0.
Field: Back Side Diffuse-Diffuse Solar Reflectance
This value is the back side diffuse-diffuse solar reflectance of the glazing averaged over the entire
spectrum of solar radiation. Used only when Optical Data Type = SpectralAverage. EnergyPlus
automatically estimates the diffuse-diffuse reflectance from other inputs. If this input field is
specified as Autocalculate, then the calculated reflectance will be used. The minimum value is
0.0, and the maximum value is less than 1.0.
Field: Diffuse-Diffuse Visible Solar Transmittance
This value is the diffuse-diffuse visible transmittance of the glazing averaged over the visible
spectrum range of solar radiation. Used only when Optical Data Type = SpectralAverage. The
diffuse-diffuse visible transmittance is assumed to be the same for both sides of the glazing. If
this input field is specified as Autocalculate, then the calculated transmittance will be used. The
minimum value is 0.0, and the maximum value is less than 1.0. This input field is not used
currently.
Field: Front Side Diffuse-Diffuse Visible Reflectance
This value is the front side diffuse-diffuse visible reflectance of the glazing averaged over the
visible spectrum range of solar radiation. Used only when Optical Data Type = SpectralAverage.
EnergyPlus automatically estimates the front side diffuse-diffuse visible reflectance from front side
beam-beam visible reflectance at normal incidence specified above. If this input field is specified
as Autocalculate, then the calculated reflectance will be used. The minimum value is 0.0, and
the maximum value is less than 1.0. This input field is not used currently.
Field: Back Side Diffuse-Diffuse Visible Reflectance
This value is the back side diffuse-diffuse visible reflectance of the glazing averaged over the
visible spectrum range of solar radiation. Used only when Optical Data Type = SpectralAverage.
EnergyPlus automatically estimates the back side diffuse-diffuse visible reflectance from back
side beam-beam visible reflectance at normal incidence specified above. If this input field is
9/29/14

146

Input-Output Reference

Group Surface Construction Elements

specified as Autocalculate, then the calculated reflectance will be used. The minimum value is
0.0, and the maximum value is less than 1.0. This input field is not used currently.
Field: Infrared Transmittance (applies to front and back)
This value is the long-wave hemispherical transmittance of the glazing. Assumed to be the same
for both sides of the glazing. The minimum value is 0.0, the maximum value is less than 1.0. The
default value is 0.0.
Field: Front Side Infrared Emissivity
This value is the front side long-wave hemispherical emissivity of the glazing. The minimum value
is 0.0, the maximum value is less than 1.0. The default value is 0.84.
Field: Back Side Infrared Emissivity
This value is the back side long-wave hemispherical emissivity of the glazing. The minimum value
is 0.0, the maximum value is less than 1.0. The default value is 0.84.
An IDF example for this object, is shown below:
WindowMaterial:Glazing:EquivalentLayer,
GLZCLR,
!- Name
SpectralAverage,
!- Optical Data Type
,
!- Window Glass Spectral Data Set Name
0.83,
!- Front Side Beam-Beam Solar Transmittance
0.83,
!- Back Side Beam-Beam Solar Transmittance
0.08,
!- Front Side Beam-Beam Solar Reflectance
0.08,
!- Back Side Beam-Beam Solar Reflectance
0.0,
!- Front Side Beam-Beam Visible Transmittance
0.0,
!- Back Side Beam-Beam Visible Transmittance
0.0,
!- Front Side Beam-Beam Visible Reflectance
0.0,
!- Back Side Beam-Beam Visible Reflectance
0.0,
!- Front Side Beam-Diffuse Solar Transmittance
0.0,
!- Back Side Beam-Diffuse Solar Transmittance
0.0,
!- Front Side Beam-Diffuse Solar Reflectance
0.0,
!- Back Side Beam-Diffuse Solar Reflectance
0.0,
!- Front Side Beam-Diffuse Visible Transmittance
0.0,
!- Back Side Beam-Diffuse Visible Transmittance
0.0,
!- Front Side Beam-Diffuse Visible Reflectance
0.0,
!- Back Side Beam-Diffuse Visible Reflectance
0.76,
!- Diffuse-Diffuse Solar Transmittance
0.14,
!- Front Side Diffuse-Diffuse Solar Reflectance
0.14,
!- Back Side Diffuse-Diffuse Solar Reflectance
0.0,
!- Diffuse-Diffuse Visible Transmittance
0.0,
!- Front Side Diffuse-Diffuse Visible Reflectance
0.0,
!- Back Side Diffuse-Diffuse Visible Reflectance
0.0,
!- Infrared Transmittance
0.84,
!- Front Side Infrared Emissivity
0.84;
!- Back Side Infrared Emissivity

WindowMaterial:Gap:EquivalentLayer
This object is used in windows equivalent layer construction object and specifies the properties
of the gap between the layers in multi-layer equivalent layer window object. There is an
EnergyPlus Reference Data Set for Material:WindowGas that contains several types of gas.
This object uses the gas types: Air, Argon, Xenon, Crypton, and Custom. For Custom gas
type users are required to entering the thermophicial properties.
Field: Name
The name of the gap. It refers to a layer in a window construction equivalent layer.
Field: Gas Type
The type of gas. The choices allowed are AIR, ARGON, XENON, KRYPTON, or CUSTOM.
9/29/14

147

Input-Output Reference

Group Surface Construction Elements

Field: Thickness
The thickness (m) of the gap layer.
Field: Gap Vent Type
This inputfiled contains the valid key choice for gap vent type. The valid vent types are:
Sealed, VentedIndoor, and VentedOutdoor. Sealed means the gap is enclosed and gas tight,
i.e., no venting to indoor or outdoor environment. The gap types VentedIndoor and
VentedOutdoor are used with gas type Air only. VentedIndoor means the air in the gap is
naturally vented to indoor environment, and VentedOutdoor means the air in the gap is
naturally vented to the outdoor environment.
Properties for Custom Gas Types
The following entries are used only if Gas Type = Custom. The A, B and C coefficients are
those in the following expression that gives a property value as a function of temperature in
degrees K:

Property Coeff A Coeff B TemperatureK

CoeffC TemperatureK2

Field: Conductivity Coefficient A

The A coefficient for gas conductivity (W/m-K). Used only if Gas Type = Custom.
Field: Conductivity Coefficient B
The B coefficient for gas conductivity (W/m-K2). Used only if Gas Type = Custom.
Field: Conductivity Coefficient C
The C coefficient for gas conductivity (W/m-K3). Used only if Gas Type = Custom.
Field: Viscosity Coefficient A
The A coefficient for gas viscosity (kg/m-s). Used only if Gas Type = Custom.
Field: Viscosity Coefficient B
The B coefficient for gas viscosity (kg/m-s-K). Used only if Gas Type = Custom.
Field: Viscosity Coefficient C
The C coefficient for gas viscosity (kg/m-s-K2). Used only if Gas Type = Custom.
Field: Specific Heat Coefficient A
The A coefficient for gas specific heat (J/kg-K). Used only if Gas Type = Custom.
Field: Specific Heat Coefficient B
The B coefficient for gas specific heat (J/kg-K2). Used only if Gas Type = Custom.
Field: Specific Heat Coefficient C
The C coefficient for gas specific heat (J/kg-K2). Used only if Gas Type = Custom.
Field: Specific Heat Ratio
The specific heat ratio for gas. Used only if Gas Type = Custom.
Field: Molecular Weight
The molecular weight for gas. The molecular weight is the mass of 1 mol of the substance.
This has a numerical value which is the average molecular mass of the molecules in the
substance multiplied by Avogadros constant. (kg/kmol) (Shown in the IDD as g/mol for
consistency)

9/29/14

148

Input-Output Reference

Group Surface Construction Elements

Field: Specific Heat Ratio

The specific heat ratio for gas. The specific heat ratio of a gas is the ratio of the specific heat
at contant pressure, to the specific heat at constant volume. Used only if Gas Type =
Custom.
An IDF example for this object, is shown below:
WindowMaterial:Gap:EquivalentLayer,
Custom CO2 Sealed 12mm,
!- Name
CUSTOM,
!- Gas Type
0.0120,
!- Thickness {m}
Sealed,
!- Gap Vent Type
-5.8181E-3,
!- Conductivity Coefficient A {W/m-K}
7.4714E-5,
!- Conductivity Coefficient B {W/m-K2}
0.0,
!- Conductivity Coefficient C {W/m-K3}
8.5571E-7,
!- Viscosity Coefficient A {kg/m-s}
4.7143E-8,
!- Viscosity Coefficient B {kg/m-s-K}
0.0,
!- Viscosity Coefficient C {kg/m-s-K2}
5.76903E2,
!- Specific Heat Coefficient A {J/kg-K}
9.18088E-2,
!- Specific Heat Coefficient B {J/kg-K2}
0.0,
!- Specific Heat Coefficient C {J/kg-K3}
44.01;
!- Molecular Weight {g/mol}

Material:RoofVegetation
This definition must be used in order to simulate the green roof (ecoroof) model. The material
becomes the outside layer in a green roof construction (see example below). In the initial
release of the green roof model, only one material may be used as a green roof layer though,
of course, several constructions using that material may be used. In addition, the model has
only been tested with the ConductionTransferFunction solution algorithm a warning will be
issued for other solution algorithm choices. This model was developed for low-sloped exterior
surfaces (roofs). It is not recommended for high-sloped exterior surfaces (e.g., walls).
Field: Name
This field is a unique reference name that the user assigns to a particular ecoroof material.
This name can then be referred to by other input data.
Field: Height of Plants
This field defines the height of plants in units of meters. This field is limited to values in the
range 0.005 < Height < 1.00 m. Default is .2 m.
Field: Leaf Area Index
This is the projected leaf area per unit area of soil surface. This field is dimensionless and is
limited to values in the range of 0.001 < LAI < 5.0. Default is 1.0. At the present time the
fraction vegetation cover is calculated directly from LAI (Leaf Area Index) using an empirical
relation. The user may find it necessary to increase the specified value of LAI in order to
represent high fractional coverage of the surface by vegetation.
Field: Leaf Reflectivity
This field represents the fraction of incident solar radiation that is reflected by the individual
leaf surfaces (albedo). Solar radiation includes the visible spectrum as well as infrared and
ultraviolet wavelengths. Values for this field must be between 0.05 and 0.5. Default is .22.
Typical values are .18 to .25.
Field: Leaf Emissivity
This field is the ratio of thermal radiation emitted from leaf surfaces to that emitted by an ideal
black body at the same temperature. This parameter is used when calculating the long

9/29/14

149

Input-Output Reference

Group Surface Construction Elements

wavelength radiant exchange at the leaf surfaces. Values for this field must be between 0.8
and 1.0 (with 1.0 representing black body conditions). Default is .95.
Field: Minimum Stomatal Resistance
This field represents the resistance of the plants to moisture transport. It has units of s/m.
Plants with low values of stomatal resistance will result in higher evapotranspiration rates
than plants with high resistance. Values for this field must be in the range of 50.0 to 300.0.
Default is 180.
Field: Soil Layer Name
This field is a unique reference name that the user assigns to the soil layer for a particular
ecoroof. This name can then be referred to by other input data. Default is Green Roof Soil.
Field: Roughness
This alpha field defines the relative roughness of a particular material layer. This parameter
only influences the convection coefficients, more specifically the exterior convection
coefficient. A keyword is expected in this field with the options being VeryRough, Rough,
MediumRough, MediumSmooth, Smooth, and VerySmooth in order of roughest to
smoothest options. Default is MediumRough.
Field: Thickness
This field characterizes the thickness of the material layer in meters. This should be the
dimension of the layer in the direction perpendicular to the main path of heat conduction. This
value must be a positive number. Depths of .10m (4 inches) and .15m (6 inches) are
common. Default if this field is left blank is .1. Maximum is .7m. Must be greater than .05 m.
Field: Conductivity of Dry Soil
This field is used to enter the thermal conductivity of the material layer. Units for this
parameter are W/(m-K). Thermal conductivity must be greater than zero. Typical soils have
values from .3 to .5. Minimum is .2 (specified in IDD). Default is .35 and maximum (in IDD) is
1.5.
Field: Density of Dry Soil
This field is used to enter the density of the material layer in units of kg/m 3. Density must be a
positive quantity. Typical soils range from 400 to 1000 (dry to wet). Minimum is 300,
maximum is 2000 and default if field is left blank is 1100.
Field: Specific Heat of Dry Soil
This field represents the specific heat of the material layer in units of J/(kg-K). Note that these
units are most likely different than those reported in textbooks and references which tend to
use kJ/(kg-K) or J/(g-K). They were chosen for internal consistency within EnergyPlus. Only
positive values of specific heat are allowed.
Field: Thermal Absorptance
The thermal absorptance field in the Material input syntax represents the fraction of incident
long wavelength radiation that is absorbed by the material. This parameter is used when
calculating the long wavelength radiant exchange between various surfaces and affects the
surface heat balances (both inside and outside as appropriate). For long wavelength radiant
exchange, thermal emissivity and thermal emittance are equal to thermal absorptance.
Values for this field must be between 0.0 and 1.0 (with 1.0 representing black body
conditions). Typical values are from .9 to .98.
Field: Solar Absorptance
The solar absorptance field in the Material input syntax represents the fraction of incident
solar radiation that is absorbed by the material. Solar radiation includes the visible spectrum
9/29/14

150

Input-Output Reference

Group Surface Construction Elements

as well as infrared and ultraviolet wavelengths. This parameter is used when calculating the
amount of incident solar radiation absorbed by various surfaces and affects the surface heat
balances (both inside and outside as appropriate). If solar reflectance (or reflectivity) data is
available, then absorptance is equal to 1.0 minus reflectance (for opaque materials). Values
for this field must be between 0.0 and 1.0. Typical values are from .6 to .85.
Field: Visible Absorptance
The visible absorptance field in the Material input syntax represents the fraction of incident
visible wavelength radiation that is absorbed by the material. Visible wavelength radiation is
slightly different than solar radiation in that the visible band of wavelengths is much more
narrow while solar radiation includes the visible spectrum as well as infrared and ultraviolet
wavelengths. This parameter is used when calculating the amount of incident visible radiation
absorbed by various surfaces and affects the surface heat balances (both inside and outside
as appropriate) as well as the daylighting calculations. If visible reflectance (or reflectivity)
data is available, then absorptance is equal to 1.0 minus reflectance (for opaque materials).
Values for this field must be between 0.5 and 1.0.
Field: Saturation Volumetric Moisture Content of the Soil Layer
The field allows for user input of the saturation moisture content of the soil layer. Maximum
moisture content is typically less than .5. Range is [.1,.5] with the default being .3.
Field: Residual Volumetric Moisture Content of the Soil Layer
The field allows for user input of the residual moisture content of the soil layer. Default is .01,
range is [.01,.1].
Field: Initial Volumetric Moisture Content of the Soil Layer
The field allows for user input of the initial moisture content of the soil layer. Range is (.05, .5]
with the defaulte being .1.
Field: Moisture Diffusion Calculation Method
The field allows for two models to be selected: Simple or Advanced.
Simple is the original Ecoroof model - based on a constant diffusion of moisture through the
soil. This model starts with the soil in two layers. Every time the soil properties update is
called, it will look at the two soils moisture layers and asses which layer has more moisture in
it. It then takes moisture from the higher moisture layer and redistributes it to the lower
moisture layer at a constant rate.
Advanced is the later Ecoroof model. If you use it, you will need to increase your number of
timesteps in hour for the simulation with a recommended value of 20. This moisture transport
model is based on a project which looked at the way moisture transports through soil. It uses
a finite difference method to divide the soil into layers (nodes). It redistributes the soil
moisture according the model described in:
Marcel G Schaap and Martinus Th. van Genuchten, 2006, 'A modified Maulem-van
Genuchten Formulation for Improved Description of the Hydraulic Conductivity Near
Saturation, Vadose Zone Journal 5 (1), p 27-34.
An IDF example:
Material:RoofVegetation,
BaseEco,
0.5,
5,
0.2,
0.95,
180,
EcoRoofSoil,
MediumSmooth,
0.18,
9/29/14

!!!!!!!!!-

Name
Height of Plants {m}
Leaf Area Index {dimensionless}
Leaf Reflectivity {dimensionless}
Leaf Emissivity
Minimum Stomatal Resistance {s/m}
Soil Layer Name
Roughness
Thickness {m}
151

Input-Output Reference
0.4,
641,
1100,
0.95,
0.8,
0.7,
0.4,
Soil Layer
0.01,
Soil Layer
0.2,
Soil Layer
Advanced;

Group Surface Construction Elements

!!!!!!!-

Conductivity of Dry Soil {W/m-K}

Density of Dry Soil {kg/m3}
Specific Heat of Dry Soil {J/kg-K}
Thermal Absorptance
Solar Absorptance
Visible Absorptance
Saturation Volumetric Moisture Content of the

!- Residual Volumetric Moisture Content of the

!- Initial Volumetric Moisture Content of the
!- Moisture Diffusion Calculation Method

Material:RoofVegetation,
LowLAI,
!- Name
0.5,
!- Height of Plants {m}
0.5,
!- Leaf Area Index {dimensionless}
0.2,
!- Leaf Reflectivity {dimensionless}
0.95,
!- Leaf Emissivity
180,
!- Minimum Stomatal Resistance {s/m}
EcoRoofSoil,
!- Soil Layer Name
MediumSmooth,
!- Roughness
0.18,
!- Thickness {m}
0.4,
!- Conductivity of Dry Soil {W/m-K}
641,
!- Density of Dry Soil {kg/m3}
1100,
!- Specific Heat of Dry Soil {J/kg-K}
0.95,
!- Thermal Absorptance
0.8,
!- Solar Absorptance
0.7,
!- Visible Absorptance
0.4,
!- Saturation Volumetric Moisture Content of the Soil Layer
0.01,
!- Residual Volumetric Moisture Content of the Soil Layer
0.2,
!- Initial Volumetric Moisture Content of the Soil Layer
Advanced;
!- Moisture Diffusion Calculation Method

And construction using the ecoroof material:

Construction,
ASHRAE 90.1-2004_Sec 5.5-2_Roof, !- Name
BaseEco,
!- Outside Layer
ASHRAE 90.1-2004_Sec 5.5-2_Roof Insulation_1, !- Layer #2
ASHRAE 90.1-2004_Sec 5.5-2_MAT-METAL; !- Layer #3

Ecoroof / RoofVegetation outputs

The following outputs are available for the Roof Vegetation surface.
Zone,Average,Green Roof Soil Temperature [C]
Zone,Average,Green Roof Vegetation Temperature [C]
Zone,Average,Green Roof Soil Root Moisture Ratio []
Zone,Average,Green Roof Soil Near Surface Moisture Ratio []
Zone,Average,Green Roof Soil Sensible Heat Transfer Rate per Area [W/m2]
Zone,Average,Green Roof Vegetation Sensible Heat Transfer Rate per Area
[W/m2]
Zone,Average,Green Roof Vegetation Moisture Transfer Rate [m/s]
Zone,Average,Green Roof Soil Moisture Transfer Rate [m/s]
Zone,Average,Green Roof Vegetation Latent Heat Transfer Rate per Area [W/m2]
Zone,Average,Green Roof Soil Latent Heat Transfer Rate per Area [W/m2]
Zone,Sum,Green Roof Cumulative Precipitation Depth [m]
Zone,Sum,Green Roof Cumulative Irrigation Depth [m]
Zone,Sum,Green Roof Cumulative Runoff Depth [m]
Zone,Sum,Green Roof Cumulative Evapotranspiration Depth [m]
Zone,Sum,Green Roof Current Precipitation Depth [m]
Zone,Sum,Green Roof Current Irrigation Depth [m]
Zone,Sum,Green Roof Current Runoff Depth [m]
9/29/14

152

Input-Output Reference

Group Surface Construction Elements

Zone,Sum,Green Roof Current Evapotranspiration Depth [m]

Green Roof Soil Temperature [C]

Temperature of the Soil layer temperature in C.
Green Roof Vegetation Temperature [C]
Temperature of the Vegetation layer temperature in C.
Green Roof Soil Root Moisture Ratio []
Mean value of root moisture (m3/m3)
Green Roof Soil Near Surface Moisture Ratio []
The moisture content in the soil near the surface (m3/m3)
Green Roof Soil Sensible Heat Transfer Rate per Area [W/m2]
Sensible heat flux to ground (W/m2)
Green Roof Vegetation Sensible Heat Transfer Rate per Area [W/m2]
Sensible heat transfer to foliage (W/m2)
Green Roof Vegetation Moisture Transfer Rate [m/s]
Water evapotranspiration rate associated with latent heat from vegetation (m/s)
Green Roof Soil Moisture Transfer Rate [m/s]
Water evapotranspiration rate associated with latent heat from ground surface (m/s)
Green Roof Vegetation Latent Heat Transfer Rate per Area [W/m2]
Latent heat flux from vegetation (W/m2)
Green Roof Soil Latent Heat Transfer Rate per Area [W/m2]
Latent heat flux from ground surface (W/m2)
Green Roof Cumulative Precipitation Depth [m]
Green Roof Current Precipitation Depth [m]
Cumulative or current precipitation (m)
Green Roof Cumulative Irrigation Depth [m]
Green Roof Current Irrigation Depth [m]
Cumulative or current irrigation (m)
Green Roof Cumulative Runoff Depth [m]
Green Roof Current Runoff Depth [m]
Cumulative or current runoff (m). Multiply by roof area to get volume.
Green Roof Cumulative Evapotranspiration Depth [m]
Green Roof Current Evapotranspiration Depth [m]
Cumulative or current evapotranspiration from soil and plants (m).
MaterialProperty:GlazingSpectralData
With the MaterialProperty:GlazingSpectralData object, you can specify the wavelength-bywavelength transmittance and reflectance properties of a glass material. To determine the
overall optical properties of a glazing system (solar and visible transmittance and solar
9/29/14

153

Input-Output Reference

Group Surface Construction Elements

absorptance vs. angle of incidence) EnergyPlus first calculates transmittance and

absorptance vs. angle of incidence for each wavelength. This is then weighted by a standard
solar spectrum to get the solar transmittance and absorptance vs. angle of incidence (for use
in the solar heat gain calculations), and further weighted by the response of the human eye to
get the visible transmittance vs. angle of incidence (for use in the daylighting calculation).
MaterialProperty:GlazingSpectralData should be used for multi-pane windows when one or
more of the glass layers is spectrally selective, i.e., the transmittance depends strongly on
wavelength. An example is glass with a coating that gives high transmittance in the daylight
part of the solar spectrum (roughly 0.4 to 0.7 microns) and low transmittance at longer
wavelengths, thus providing better solar heat gain control than uncoated glass. If spectral
data is not used in case, the overall optical properties of the glazing system that EnergyPlus
calculates will not be correct.
You can input up to 450 sets of values for wavelengths covering the solar spectrum. Each set
consists of {wavelength (microns), transmittance, front reflectance, back reflectance}
Spectral data of this kind are routinely measured by glass manufacturers. Data sets for over
800 commercially available products are contained in an Optical Data Library maintained by
the Windows Group at Lawrence Berkeley National Laboratory. This library can be
downloaded from http://windows.lbl.gov/. You will have to edit entries from this library to put
them in the format required by the EnergyPlus WindowGlassSpectralData object.
An alternative to using the MaterialProperty:GlazingSpectralData object is to run the
WINDOW window analysis program. This program has built-in access to the Optical Data
Library and lets you easily create customized, multi-layer glazing systems that can be
exported for use in EnergyPlus. For more details, see StormWindow.
Field: Name
The name of the spectral data set. It is referenced by WindowMaterial:Glazing when Optical
Data Type = Spectral.
Fields 1-4 (repeated up to 450 times)
Sets of values for wavelengths covering the solar spectrum (from about 0.25 to 2.5 microns
[10-6 m]). Each set consists of
{wavelength (microns), transmittance, front reflectance, back reflectance}
The wavelength values must be in ascending order. The transmittance and reflectance
values are at normal incidence. Front reflectance is the reflectance for radiation striking the
glass from the outside, i.e., from the side opposite the zone in which the window is defined.
Back reflectance is the reflectance for radiation striking the glass from the inside, i.e., from
the zone in which the window is defined. Therefore, for exterior windows, front is the side
closest to the outdoors and back is the side closest to the zone in which the window is
defined. For interior windows, front is the side closest to the adjacent zone and back is the
side closest to the zone in which the window is defined.
An IDF example:
MaterialProperty:GlazingSpectralData,
TestSpectralDataSet,
! { from WINDOW 4 library }
! { actual 9.91mm clear laminate: 15_mil PVB, ID:37966/50032-39-9 }
10.38
! { conductivity PVB adjusted, W/M/K } 0.798
! { thermal IR transmittance, assumed } tir=0.00
! { thermal IR hemispherical emittance, assumed } emis= 0.84 0.84
! WL
.300,
.310,
.320,
.330,
9/29/14

T
0.000,
0.000,
0.000,
0.000,

Rfront
0.045,
0.044,
0.044,
0.042,

Rback
0.045,
0.044,
0.044,
0.042,
154

Input-Output Reference

Group Surface Construction Elements

.340, 0.000, 0.041, 0.041,

.350, 0.000, 0.040, 0.040,
<snip>
2.450, 0.200, 0.040, 0.040,
2.500, 0.214, 0.039, 0.039;

Construction
For walls, roofs, floors, windows, and doors, constructions are built from the included
materials. Each layer of the construction is a material name listed in order from outside to
inside. Up to ten layers (eight for windows) may be specified (one of the few limitations in
EnergyPlus!). Outside is the layer furthest away from the Zone air (not necessarily the
outside environment). Inside is the layer next to the Zone air. In the example floor below, for
example, the outside layer is the acoustic tile below the floor, the next layer is the air space
above the tile, and the inside layer is the concrete floor deck.
E5-Acoustic Tile
Ceiling Airspace
2 IN HW Concrete

Outside

Inside

Figure 24. Example Floor Construction illustration.

Window constructions are similarly built up from items in the Window Materials set using
similar layers.. See Figure 25. Illustration for material ordering in windows, which shows the
case where an interior shading layer such as a blind is present. The gap between the inside
glass layer (layer #3) and the interior shading layer is not entered. Similarly, for an exterior
shading layer, the gap between the outside glass layer and the shading layer is not entered.

9/29/14

155

Input-Output Reference

Group Surface Construction Elements

WindowMaterial:Glazing (layer #1)

WindowMaterial:Gas (layer #2)
WindowMaterial:Glazing (layer #3)
WindowMaterial:Shade (layer #4)

Outside

Inside

Figure 25. Illustration for material ordering in windows.

However, for a between-glass shading device the gaps on either side of the shading layer
must be entered and they must have the same gas type. In addition, the gap widths with and
without the between-glass shading layer must be consistent (see Figure 26).
A maximum of four glass layers and one shading layer is allowed. A gas layer must always
separate adjacent glass layers in a multi-pane glazing without a between-glass shading layer.

w
glass

glass

glass

g1

g2

glass
shade or blind

Window construction
with no shading layer

Window construction with

between-glass shading layer

Figure 26. Window construction with and without a between-glass shading layer. Shown are gap widths g,
g1 and g2, and shading layer width, w. An error will result if g1+g2+w is not equal to g, where w is zero for
a blind and greater than zero for a shade.
Outside and inside air film resistances are never given as part of a construction definitions
since they are calculated during the EnergyPlus simulation. Note also that constructions are
assumed to be one-dimensional in a direction perpendicular to the surface.

9/29/14

156

Input-Output Reference

Group Surface Construction Elements

Field: Name
This field is a user specified name that will be used as a reference by other input syntax. For
example, a heat transfer surface (ref: Building Surfaces) requires a construction name to
define what the make-up of the wall is. This name must be identical to one of the
Construction definitions in the input data file.
Field: Outside Layer
Each construction must have at least one layer. This field defines the
material name associated with the layer on the outside of the construction
outside referring to the side that is not exposed to the zone but rather the
opposite side environment, whether this is the outdoor environment or another
zone. Material layers are defined based on their thermal properties elsewhere
in the input file (ref: Material and Material Properties and
Zone,Average,HAMT Surface Average Water Content Ratio [kg/kg]
Zone,Average,HAMT Surface Inside Face Temperature [C]
Zone,Average,HAMT Surface Inside Face Relative Humidity [%]
Zone,Average,HAMT Surface Inside Face Vapor Pressure [Pa]
Zone,Average,HAMT Surface Outside Face Temperature [C]
Zone,Average,HAMT Surface Outside Face Relative Humidity [%]
Zone,Average,HAMT Surface Inside Face Relative Humidity [%]

HAMT Surface Average Water Content Ratio [kg/kg]

This output is the summed water content [kg/kg] of all cells in a surface expressed as a
fraction of the mass of the water to the material mass.
HAMT Surface Inside Face Temperature [C]
This output is the temperature [C] on the internal surface of the surface.
HAMT Surface Inside Face Relative Humidity [%]
HAMT Surface Inside Face Relative Humidity [%]
This output is the relative humidity on the internal surface of the surface expressed as a
percentage.
HAMT Surface Inside Face Vapor Pressure [Pa]
This output is the vapor pressure [Pa] on the internal surface of the surface.
HAMT Surface Outside Face Temperature [C]
This output is the temperature on the external surface of the surface.
HAMT Surface Outside Face Relative Humidity [%]
This output is the relative humidity on the external surface of the surface.
Zone,Average,HAMT Surface Temperature Cell N [C]
Zone,Average,HAMT Surface Water Content Cell N [kg/kg]
Zone,Average,HAMT Surface Relative Humidity Cell N [%]

Detailed profile data for the variables Temperature [C], Relative Humidity [%] and Water
Content [kg/kg] within each surface can also be reported. To calculate the heat and moisture
transfer through surfaces HAMT splits up surfaces into discrete cells. Each cell is composed
of a single material and has a position within the surface. HAMT automatically assigns cells
to construction objects so that there are more cells closer to boundaries between materials
and also at the surfaces of the surface. It is not possible for users to define their own cells.
HAMT Surface Relative Humidity Cell <N> [%]
This is the relative humidity of the cell in the surface.

9/29/14

157

Input-Output Reference

Group Surface Construction Elements

HAMT Surface Temperature Cell <N> [C]

This is the temperature of the cell in the surface.
HAMT Surface Water Content Cell <N> [kg/kg]
This is the relative water content of the cell in the surface.
Each surface is made from a particular construction. The construction-surface relationship is
output by HAMT to the eplusout.eio file with the following format.
! <HAMT cells>, Surface Name, Construction Name, Cell Numbers
! <HAMT origins>, Surface Name, Construction Name, Cell origins (m)

The output also contains the HAMT cell origins and cell number for each construction
surface combination. The coordinate system origin is defined as the exterior surface of the
construction. Users can select any one of the Temperature, Relative Humidity or Water
Content variables for any cell to be reported, using the following naming scheme for the
output variable.
HAMT Profile Construction <Variable> Cell <Cell#>

It is better to specify the key or Surface Name in this output.

So for example to output the temperature of the 10th cell in a surface, eg East Wall would
require the following output variable.
Output:Variable,
East Wall,
!- Key Value
HAMT Profile Construction Temperature Cell 10, !- Variable Name
Hourly;
!- Reporting Frequency

By selecting a whole range of these reports and using the information in the eplusout.eio file
it is possible to build up a temperature profile of the surface.
Materials for Glass Windows and Doors). As noted above, the outside layer should NOT be a
film coefficient since EnergyPlus will calculate outside convection and radiation heat transfer
more precisely.
Field(s) 2-10: Layers
The next fields are optional and the number of them showing up in a particular Construction
definition depends solely on the number of material layers present in that construction. The
data expected is identical to the outside layer field (see previous field description). The order
of the remaining layers is important and should be listed in order of occurrence from the one
just inside the outside layer until the inside layer is reached. As noted above, the inside layer
should NOT be a film coefficient since EnergyPlus will calculate inside convection and
radiation heat transfer more precisely.
IDF Example (floor construction):
Construction, FLOOR38, ! Material layer names follow:
E5 - ACOUSTIC TILE,
E4 - CEILING AIRSPACE,
C12 - 2 IN HW CONCRETE;

IDF Example (window construction, no shade):

Construction, DOUBLE PANE
GLASS - CLEAR SHEET
WinAirB1 - AIRSPACE
GLASS - CLEAR SHEET

WINDOW, !- Material layer names follow:

1 / 8 IN,
RESISTANCE,
1 / 8 IN;

IDF Example (window construction, with interior shade):

Construction, DOUBLE PANE
GLASS - CLEAR SHEET
WinAirB1 - AIRSPACE
GLASS - CLEAR SHEET
ROLL SHADE - LIGHT

9/29/14

WITH ROLL SHADE,

1 / 8 IN,
RESISTANCE,
1 / 8 IN,

!- Material layer names follow:

158

Input-Output Reference

Group Surface Construction Elements

Site:GroundTemperature:FCfactorMethod
Site:GroundTemperature:FCfactorMethod is used only by the underground walls or slabs-ongrade or underground floors defined with C-factor (Construction:CfactorUndergroundWall)
and F-factor (Construction:FfactorGroundFloor) method for code compliance calculations
where detailed construction layers are unknown. Only one such ground temperature object
can be included. The monthly ground temperatures for this object are close to the monthly
outside air temperatures delayed by three months. If user does not input this object in the IDF
file, it will be defaulted to the 0.5m set of monthly ground temperatures from the weather file if
they are available.
Field: Month Temperature(s) 12 fields in all
Each numeric field is the monthly ground temperature (degrees Celsius) used for the
indicated month (January=1st field, February=2nd field, etc.)
And, the IDF example:
Site:GroundTemperature:FCfactorMethod,

9.5,3.5,-0.7,-1.7,-0.6,3.6,9.3,14,18.2,22.7,21.2,16.8;

Constructions - Modeling Underground Walls and Ground Floors Defined with C and
F Factors for Building Energy Code Compliance
Building energy code and standards like ASHRAE 90.1, 90.2 and California Title 24 require
the underground wall constructions and slabs-on-grade or underground floors not to exceed
certain maximum values of C-factor and F-factor, which do not specify detailed layer-by-layer
materials for the constructions.
A simplified approach is introduced to create equivalent constructions and model the ground
heat transfer through underground walls and ground floors for the building energy code
compliance calculations. The approach is to create constructions based on the user defined
C or F factor with two layers: one concrete layer (0.15 m thick) with thermal mass, and one
fictitious insulation layer with no thermal mass. Three new objects were created for such
purpose: Construction:CfactorUndergroundWall, Construction:FfactorGroundFloor,
and Site:GroundTemperature:FCfactorMethod. Details of the approach are described in
the Engineering Reference document. The wall and floor construction objects are described
in this section; the ground temperature object is described with the other ground temperature
objects.
When a underground wall or ground floor surface (BuildingSurface:Detailed, Floor:Detailed,
and Wall:Detailed) references one of the two construction objects, its field Outside Boundary
Condition needs to be set to GroundFCfactorMethod. For simple (rectangular) wall and floor
objects, the outside boundary condition is inferred from the construction type.
The Site:GroundTemperature:FCfactorMethod is described in the section for ground
temperatures, the following section describes the two new construction objects.
Construction:CfactorUndergroundWall
This input object differs from the usual wall construction object in that it describes an entire
construction rather than individual layers. This object is used when only the wall height (depth
to the ground) and the C-factor are available. This object accesses a model that creates an
equivalent layer-by-layer construction for the underground wall to approximate the heat
transfer through the wall considering the thermal mass of the earth soil.
This object is referenced by underground wall surfaces with their fields Outside Boundary
Condition set to GroundFCfactorMethod.
Field: Name
The name of the underground wall construction.

9/29/14

159

Input-Output Reference

Group Surface Construction Elements

Field: C-Factor
C-Factor is the time rate of steady-state heat flow through unit area of the construction,
induced by a unit temperature difference between the body surfaces. The C-Factor unit is
W/m2K. The C-factor does not include soil or air films. ASHRAE Standard 90.1 and
California Title 24 specify maximum C-factors for underground walls depending on space
types and climate zones.
Field: Height
This field describes the height of the underground wall, i.e. the depth to the ground surface.
The unit is meters.
IDF Example:
Construction:CfactorUndergroundWall,
CfactorUGWall,
0.436,
! C-factor (W/m2K), does not include soil or air films
4.57;
! Height (m)
BuildingSurface:Detailed,
Zn001:Wall001,
Wall,
CfactorUGWall,
ZONE ONE,
GroundFCfactorMethod,
,
NoSun,
NoWind,
0.0,
4,
0.0,0.0,4.572,
0.0,0.0,0.0,
15.24,0.0,0.0,
15.24,0.0,4.572;

!!!!!!!!!!!!!!-

Name
Surface Type
Construction Name
Zone Name
Outside Boundary Condition
Outside Boundary Condition Object
Sun Exposure
Wind Exposure
View Factor to Ground
Number of Vertices
X,Y,Z ==> Vertex 1
X,Y,Z ==> Vertex 2
X,Y,Z ==> Vertex 3
X,Y,Z ==> Vertex 4

Construction:FfactorGroundFloor
This input object differs from the usual ground floor construction object in that it describes an
entire construction rather than individual layers. This object is used when only the floor area,
exposed perimeter, and the F-factor are available. This object accesses a model that creates
an equivalent layer-by-layer construction for the slab-on-grade or underground floor to
approximate the heat transfer through the floor considering the thermal mass of the earth soil.
This object is referenced by slab-on-grade or underground floor surfaces with their fields
Outside Boundary Condition set to GroundFCfactorMethod.
Field: Name
The name of the ground floor construction.
Field: F-Factor
F-Factor represents the heat transfer through the floor, induced by a unit temperature
difference between the outside and inside air temperature, on the per linear length of the
exposed perimeter of the floor. The unit for this input is W/mK. ASHRAE Standard 90.1 and
California Title 24 specify maximum F-factors for slab-on-grade or underground floors
depending on space types and climate zones.
Field: Area
This field describes the area (in square meters) of the slab-on-grade or underground floor.

9/29/14

160

Input-Output Reference

Group Surface Construction Elements

Field: PerimeterExposed
This field describes the exposed (direct contact with ambient air) perimeter (in meters) of the
slab-on-grade or underground floor.
IDF Example:
Construction:FfactorGroundFloor,
slabconst,
0.12,
!F-factor in W/m-K
232.26,
!Area in m2
61.0;
!Exposed perimeter in m
BuildingSurface:Detailed,
Zn001:Flr001,
Floor,
slabconst,
ZONE ONE,
GroundFCfactorMethod,
,
Zn001:Flr001
NoSun,
NoWind,
0,
4,
15.24,0.0,0.0,
0.0,0.0,0.0,
0.0,15.240,0.0,
15.24,15.24,0.0;

!!!!!!-

Name
Surface Type
Construction Name, FLOOR
Zone Name
Outside Boundary Condition, Surface
Outside Boundary Condition Object,

!!!!!!!!-

Sun Exposure
Wind Exposure
View Factor to Ground
Number of Vertices
X,Y,Z ==> Vertex 1
X,Y,Z ==> Vertex 2
X,Y,Z ==> Vertex 3
X,Y,Z ==> Vertex 4

Construction:InternalSource
In some cases such as radiant systems, a construction will actually have resistance wires or
hydronic tubing embedded within the construction. Heat is then either added or removed from
this building element to provide heating or cooling to the zone in question. In the case of
building-integrated photovoltaics, the energy removed in the form of electricity will form a
sink. It is possible to enter such constructions into EnergyPlus with the syntax described
below. The definition is similar to the Construction definition with a few additions related to
radiant or other systems that will lead to source/sink terms. The internal source capability is
available with both the ConductionTransferFunction and ConductionFiniteDifference
solution algorithms. The only difference is that the two dimensional pipe arrangements are
not available to ConductionFiniteDifference. Those fields are ignored in that implementation.
Field: Name
This field is a user specified name that will be used as a reference by other input syntax. For
example, a heat transfer surface (ref: Building Surfaces) requires a construction name to
define what the make-up of the wall is.
Field: Source Present After Layer Number
This field is an integer that relates the location of the heat source or sink. The integer refers
to the list of material layers that follow later in the syntax and determines the layer after which
the source is present. If a source is embedded within a single homogenous layer (such as
concrete), that layer should be split into two layers and the source added between them. For
example, a value of 2 in this field tells EnergyPlus that the source is located between the
second and third material layers listed later in the construction description (see layer fields
below).
Field: Temperature Calculation Requested After Layer Number
The nature of this field is similar to the source interface parameter (see previous field) in that
it is an integer, refers to the list of material layers that follow, and defines a location after the

9/29/14

161

Input-Output Reference

Group Surface Construction Elements

layer number identified by the user-defined number. In this case, the user is specifying the
location for a separate temperature calculation rather than the location of the heat
source/sink. This feature is intended to allow users to calculate a temperature within the
construction. This might be important in a radiant cooling system where condensation could
be a problem. This temperature calculation can assist users in making that determination in
absence of a full heat and mass balance calculation.
Field: Dimensions for the CTF Calculation
This field is also an integer and refers to the detail level of the calculation. A value of 1
states that the user is only interested in a one-dimensional calculation. This is appropriate for
electric resistance heating and for hydronic heating (when boiler/hot water heater
performance is not affected by return and supply water temperatures). A value of 2 will
trigger a two-dimensional solution for this surface only. This may be necessary for hydronic
radiant cooling situations since chiller performance is affected by the water temperatures
provided.
A few things should be noted about requesting two-dimensional solutions. First, the
calculation of the conduction transfer functions (CTF) is fairly intensive and will require a
significant amount of computing time. Second, the solution regime is two-dimensional
internally but it has a one-dimensional boundary condition imposed at the inside and outside
surface (i.e., surface temperatures are still isothermal is if the surface was one-dimensional).
Field: Tube Spacing
This field defines how far apart in meters the hydronic tubing or electrical resistance wires are
spaced in the direction perpendicular to the main direction of heat transfer. Note that this
parameter is only used for two-dimensional solutions (see previous field).
Field: Outside Layer
Each construction must have at least one layer. This field defines the
material name associated with the layer on the outside of this construction
outside referring to the side that is not exposed to the zone but rather the
opposite side environment, whether this is the outdoor environment or another
zone. Material layers are defined based on their thermal properties elsewhere
in the input file (ref: Material and Material Properties and
Zone,Average,HAMT Surface Average Water Content Ratio [kg/kg]
Zone,Average,HAMT Surface Inside Face Temperature [C]
Zone,Average,HAMT Surface Inside Face Relative Humidity [%]
Zone,Average,HAMT Surface Inside Face Vapor Pressure [Pa]
Zone,Average,HAMT Surface Outside Face Temperature [C]
Zone,Average,HAMT Surface Outside Face Relative Humidity [%]
Zone,Average,HAMT Surface Inside Face Relative Humidity [%]

HAMT Surface Average Water Content Ratio [kg/kg]

This output is the summed water content [kg/kg] of all cells in a surface expressed as a
fraction of the mass of the water to the material mass.
HAMT Surface Inside Face Temperature [C]
This output is the temperature [C] on the internal surface of the surface.
HAMT Surface Inside Face Relative Humidity [%]
HAMT Surface Inside Face Relative Humidity [%]
This output is the relative humidity on the internal surface of the surface expressed as a
percentage.
HAMT Surface Inside Face Vapor Pressure [Pa]
This output is the vapor pressure [Pa] on the internal surface of the surface.

9/29/14

162

Input-Output Reference

Group Surface Construction Elements

HAMT Surface Outside Face Temperature [C]

This output is the temperature on the external surface of the surface.
HAMT Surface Outside Face Relative Humidity [%]
This output is the relative humidity on the external surface of the surface.
Zone,Average,HAMT Surface Temperature Cell N [C]
Zone,Average,HAMT Surface Water Content Cell N [kg/kg]
Zone,Average,HAMT Surface Relative Humidity Cell N [%]

Detailed profile data for the variables Temperature [C], Relative Humidity [%] and Water
Content [kg/kg] within each surface can also be reported. To calculate the heat and moisture
transfer through surfaces HAMT splits up surfaces into discrete cells. Each cell is composed
of a single material and has a position within the surface. HAMT automatically assigns cells
to construction objects so that there are more cells closer to boundaries between materials
and also at the surfaces of the surface. It is not possible for users to define their own cells.
HAMT Surface Relative Humidity Cell <N> [%]
This is the relative humidity of the cell in the surface.
HAMT Surface Temperature Cell <N> [C]
This is the temperature of the cell in the surface.
HAMT Surface Water Content Cell <N> [kg/kg]
This is the relative water content of the cell in the surface.
Each surface is made from a particular construction. The construction-surface relationship is
output by HAMT to the eplusout.eio file with the following format.
! <HAMT cells>, Surface Name, Construction Name, Cell Numbers
! <HAMT origins>, Surface Name, Construction Name, Cell origins (m)

The output also contains the HAMT cell origins and cell number for each construction
surface combination. The coordinate system origin is defined as the exterior surface of the
construction. Users can select any one of the Temperature, Relative Humidity or Water
Content variables for any cell to be reported, using the following naming scheme for the
output variable.
HAMT Profile Construction <Variable> Cell <Cell#>

It is better to specify the key or Surface Name in this output.

So for example to output the temperature of the 10th cell in a surface, eg East Wall would
require the following output variable.
Output:Variable,
East Wall,
!- Key Value
HAMT Profile Construction Temperature Cell 10, !- Variable Name
Hourly;
!- Reporting Frequency

By selecting a whole range of these reports and using the information in the eplusout.eio file
it is possible to build up a temperature profile of the surface.
Materials for Glass Windows and Doors). As noted above, the outside layer should NOT be a
film coefficient since EnergyPlus will calculate convection and radiation heat transfer more
precisely.
Field(s) 2-10: Layers
The next fields are optional and the number of them showing up in a particular Construction
definition depends solely on the number of material layers present in that particular
construction. The data expected is identical to the outside layer field (see previous field
description). The order of the remaining layers is important and should be listed in order of
occurrence from the one just inside the outside layer until the inside layer is reached. As

9/29/14

163

Input-Output Reference

Group Surface Construction Elements

noted above, the inside layer should NOT be a film coefficient since EnergyPlus will calculate
convection and radiation heat transfer more precisely.
Composite Wall Constructions
Standard constructions in EnergyPlus are built with the materials and layers described
earlier. However, some configurations will not be adequately represented by using this
approach. The Reference Data Set CompositeWallConstructions.idf contains constructions
and associated materials for a set of composite walls. These are wallssuch as stud
wallsthat have complicated heat-flow paths so that the conduction is two- or threedimensional. Thermal bridges are one of the common terms for these complicated heat-flow
paths; this dataset will help you represent these in EnergyPlus.
The materials here are not real materials but are equivalent materials obtained from finitedifference modeling. (The thickness, conductivity, density and specific heat values of the
material layers for the different constructions have been taken from the ASHRAE report
Modeling Two- and Three-Dimensional Heat Transfer through Composite Wall and Roof
Assemblies in Hourly Energy Simulation Programs (1145-TRP), by Enermodal Engineering
Limited, Oak Ridge National Laboratory, and the Polish Academy of Sciences, January
2001.). EnergyPlus will calculate conduction transfer functions using these materials. The
heat transfer based on these conduction transfer functions will then be very close to what
would be calculated with a two- or three-dimensional heat transfer calculation.
For stud walls, using these composite constructions will give more accurate heat flow than
you would get by manually dividing the wall into a stud section and a non-stud section.
If your walls exterior or interior roughness or thermal, solar or visible absorptances are
different from those in the data set, you can make the appropriate changes to the first
material (the outside layer) or the third material (the inside layer). None of the other values
should be changed.
Complete description of the CompositeWallConstructions
OutputDetailsAndExamples document.

data

set

are

found

in

the

Construction:ComplexFenestrationState
This input object is used to describe the properties of a single state for complex fenestration.
There are two parts to the input, 1) layer-by-layer physical description of fenestration system
and 2) a set of matrices that describe overall system optical performance. Each layer also
has associated with it two matrices that give the layer absorptance (for front and back
incidence on the system.
The optical properties are given as a two-dimensional matrix describing the basis and four
two-dimensional matrices of system bidirectional optical properties.
These input objects will generally be exported directly from the WINDOW program and it is
expected that users usually will not develop the input themselves. However, this is an option
for users who prefer to use a different method (e.g., Monte-Carlo ray-trace or measurement)
of determining optical properties.
Multiple instances of this object are used to define the separate operating states of complex
fenestration. For example, blinds could be deployed or redirected to create a new state, or
electrochromic glazings could change transmittance. Each separate state defines the
materials present and the overall optical performance. If the glazing system has only one
state, then only one of these objects is needed.
If there is more than one complex fenestration state, it will be controlled using the EMS
actuator called Surface with the control type Construction State and the EMS input object
called EnergyManagementSystem:ConstructionIndexVariable.

9/29/14

164

Input-Output Reference

Group Surface Construction Elements

Field: Name
Unique name of this construction. Used to identify type of window in surface objects.
Field: Basis Type keyword
Only value currently implemented is LBNLWINDOW. More options may be added in the
future.
Field: Basis Symmetry, keyword
Only value currently implemented is None. More options will be added in the future.
Field: Thermal Parameters
This field gives the name of WindowThermalModel:Params object used to keep common
data necessary for thermal simulation.
Field: Basis Matrix Name
This field gives the name of an 2 x N matrix object that defines the basis For a fenestration
basis, N would be the number of theta (polar angle) values, the first of the two elements for
each of the i=1,..,N would be the theta value, and the second would be the number of phi
(azimuthal angle) values that 360 is divided into for that theta.
Field: Solar Optical Complex Front Transmittance Matrix Name
This field contains the name of matrix object that describes the solar transmittance at
different incident angles. This is from the outside toward the inside.
Field: Solar Optical Complex Back Reflectance Matrix Name
This field contains the name of matrix object that describes the solar back reflectance at
different incident angles. This is from the inside toward the outside.
Field: Visible Optical Complex Front Transmittance Matrix Name
This field contains the name of matrix object that describes the visible transmittance at
different incident angles. This is from the outside toward the inside.
Field: Visible Optical Complex Back Reflectance Matrix Name
This field contains the name of vector object that describes the visible back reflectance at
different incident angles. This is from the inside toward the outside.
Field: Outside Layer <x=1>
Each construction must have at least one layer. The layer order is from outside to inside, with
the first layer being either WindowMaterial:Glazing or WindowMaterial:ComplexShade. The
next layer is a WindowMaterial:Gap layer, and the following layers then alternate between
WindowMaterial:Glazing or WindowMaterial:ComplexShade and WindowMaterial:Gap. The
last layer cannot be WindowMaterial:Gap.
Field: Outside Layer Directional Front Absorptance Matrix Name
Points to an Nbasis x 1 matrix object.
Field: Outside Layer Directional Back Absorptance Matrix Name
Points to an Nbasis x 1 matrix object.
Above 3 fields are optionally repeated for layers 2-10
These layers include gaps, which do not need to have matrix data specified.
An IDF example of complex fenestration with single layer:
Construction:ComplexFenestrationState,
9/29/14

!- single layer example

165

Input-Output Reference
CFS_Glz_1,
LBNLWindow,
None,
ThermParam_1,
CFS_Glz_1_Basis,
CFS_Glz_1_TfSol,
CFS_Glz_1_RbSol,
CFS_Glz_1_Tfvis,
CFS_Glz_1_Tbvis,
Glass_102_Layer,
CFS_Glz_1_Layer_1_fAbs,
CFS_Glz_1_Layer_1_bAbs;

Group Surface Construction Elements

!!!!!!!!!!!!-

name
basis type
basis symmetry type
window thermal model
basis matrix name
Tfsol
Rbsol
Tfvis
Tbvis
layer 1 name
fAbs
bAbs

An complex fenestration IDF example with double layer (first layer is shading device):
Construction:ComplexFenestrationState,
!- double layer example
CFS_Glz_59,
!- name
LBNLWindow,
!- basis type
None,
!- basis symmetry type
ThermParam_59,
!- window thermal model
CFS_Glz_59_Basis,
!- basis matrix name
CFS_Glz_59_TfSol,
!- Tfsol
CFS_Glz_59_RbSol,
!- Rbsol
CFS_Glz_59_Tfvis,
!- Tfvis
CFS_Glz_59_Tbvis,
!- Tbvis
Shade_30001_Layer,
!- layer 1 name (shading device)
CFS_Glz_59_Layer_1_fAbs,
!- fAbs
CFS_Glz_59_Layer_1_bAbs,
!- bAbs
Gap_1_Layer,
!- layer 1 name
,
!- absorptance matrices for gaps should be empty for now
,
!- it is for future use
Glass_3110_Layer,
!- layer 2 name
CFS_Glz_59_Layer_3110_fAbs,
!- fAbs
CFS_Glz_59_Layer_3110_bAbs;
!- bAbs

WindowThermalModel:Params
This input object is used with the Construction:ComplexFenestrationState
Field: Name
Unique name of the window thermal model parameters.
Field: Calculation Standard
The type of the calculation standard. The choices are:
ISO15099
EN673Declared
EN673Design
The default is ISO15099.
Field: Thermal Model
The type of thermal model. The choices are:
ISO15099
ScaledCavityWidth
ConvectiveScalarModel_NoSDThickness
ConvectiveScalarModel_withSDThickness
The default is ISO15099.

9/29/14

166

Input-Output Reference

Group Surface Construction Elements

Field: SD Scalar
Shading Device Scalar Factor. Only used for Thermal Model = Convective Scalar Model.
Factor of venetian shading device layer contribution to convection. Real value between 0
(where the shading device contribution to convection is neglected) and 1 (where the shading
device treated as closed as if it is a glass layer with thermal properties of SD slat
material). Default: 1.0
Field: Deflection Model
The type of deflection model used to model deflection in windows and glass. The choices
are:
NoDeflection
TemperatureAndPressureInput
MeasuredDeflection
The default is NoDeflection.
Field: Vacuum Pressure Limit
The pressure (Pa) which will be considered to be the limit for vacuum glazing pressure. All
pressures less than or equal to this pressure will be considered to be vacuum. Default:
13.238 Pa.
Field: Initial Temperature
The temperature (oC) of the gap in the time of fabrication. It is used only when
WindowThermalModel:Params DeflectionModel =TemperatureAndPressureInput
Field: Initial Pressure
The pressure (Pa) of the gap at the time of fabrication of the sealed glazing system unitIt is
used
only
when
WindowThermalModel:Params
DeflectionModel
=TemperatureAndPressureInput.
An IDF example for WindowThermalModel:Params (without deflection):
WindowThermalModel:Params,
ThermParam_59,
ISO15099,
ISO15099,
1.00,
NoDeflection;

!!!!!-

name
standard
thermal model standard
SD scalar
deflection model

An IDF example for thermal paramters (with deflection):

WindowThermalModel:Params,
ThermParam_59,
ISO15099,
ISO15099,
1.00,
TemperatureAndPressureInput,
,
21.00,
10000.00;

!!!!!!!!-

name
standard
thermal model standard
SD scalar
deflection model
vacuum pressure limit
temperature at time of fabrication
pressure at time of fabrication

An IDF example for WindowThermalModel:Params for modeling vacuum glazing

WindowThermalModel:Params,
ThermParam_1006,
ISO15099,
ISO15099,
1.0000,
NoDeflection,
9/29/14

!!!!!-

name
standard
thermal model
SDScalar
deflection model
167

Input-Output Reference

Group Surface Construction Elements

13.238;

!- vacuum pressure limit

Matix:TwoDimension
This is input object is only used with Construction:ComplexFenestrationState object to enter a
two-dimensional matrix of values.
It is used to define the Basis Matrix for BSDF input data, and is also used to define the actual
BSDF matrices data for the complete fenestration definition as well as the individual layers of
the system.
The data are entered in row-major order: all the elements of row 1, followed by all the
elements of row 2, etc. The number of values to be entered depends on the number of rows
and the number of columns. Blank fields are treated as having been set to zero.
See example IDF file SmOff_ CmplxGlz_IntExtShading.idf for the definition of two complex
shading layers with matrix data defined.
Field: Name
Unique name of matrix input object.
Field: Number of Rows
This field is the number of rows in the matrix.
Field: Number of Columns
This field is the number of columns in the matrix
< Field Set: Value # N >
Repeat entering value exactly the same number of times as the number of rows times the
number of columns.
Field: Value # 1
This is the value of the matrix at the first row and first column.
Field: Value #2
This is the value of the matrix at the first row and the second column.
An IDF example of matrix for defining BSDF basis:
Matrix:TwoDimension,
CFS_Glz_1_Basis,
9,
2,
0.00000, 1.00000,
10.00000, 8.00000,
20.00000, 16.00000,
30.00000, 20.00000,
40.00000, 24.00000,
50.00000, 24.00000,
60.00000, 24.00000,
70.00000, 16.00000,
82.50000, 12.00000;

!!!!-

matrix for basis definition

basis matrix name
number of rows
number of colums

Construction:WindowEquivalentLayer
This object defines the construction for equivalent layer window (ASHWAT) model. This window
can model various mix of glazing and shading layers combination. Shadings are defined as an
integral part of the construction. The construction is defined by listing the layers name starting with
outside layer and work your way to the inside Layer. Up to six solid layers (glazing and shade)
and up to five gaps, i.e., a total of up to 11 layers maximum are allowed in equivalent layer
window object. The solid layer types allowed are: Glazing, Insect Screen, Roller Blinds, Venetian
Blind, and Drape Fabrics. This window model requires optical data of the individual glazing
9/29/14

168

Input-Output Reference

Group Surface Construction Elements

and shading layers to calculate the effective optical properties of the composite fenestration
construction. Venetian blinds in equivalent layer window model can be in a fixed slat angle or
has the option to control the slat angle in order to maximize visibility, or maximize solar gains.
An equivalent-layer concept can simulate wide range of multiple glazing and shading layers
combination and provides unlimited flexibility to combine different types of shading layers in a
fenestration. For the gap layer object any one of the five different Gas types can be specified:
AIR, ARGON, XENON, KRYPTON, or CUSTOM. This window object is referenced by
fenestration surfaces. For details of the model description refer to Equivalent Layer
Fenestration Model section in Engineering Reference. The various layer objects that can be
referenced in Equivalent Layer window model are:
WindowMaterial:Glass:EquivalentLayer
WindowMaterial:Shade:EquivalentLayer
WindowMaterial:Drape:EquivalentLayer
WindowMaterial:Blind:EquivalentLayer
WindowMaterial:Screen:EquivalentLayer
WindowMaterial:Gap:EquivalentLayer

Field: Name
This field is a user specified name that will be used as a reference by other input syntax. For
example, a heat transfer surface (ref: Fenestration) requires a construction name to define
what the make-up of the fenestration is. This name must be identical to one of the Window
Construction Equivalent Layer definitions in the input data file.
Field: Outside Layer
Each equivalent layer window construction must have at least one layer. This field defines the
material name associated with the layer on the outside of the constructionoutside referring
to the side that is exposed to the outdoor environment or another zone. Material layers for
equivalent layer window model are defined based on their thermal properties elsewhere in
the input file (ref: WindowEquivalentLayerMaterialNames)
Field: Layer 2 - Layer11
The next fields are optional and the number of them showing up in a particular equivalent
layer window construction definition depends solely on the number of material layers present
in that construction. The data expected is identical to the outside layer field (see previous
field description). The order of the remaining layers is important and should be listed in order
of occurrence from the one just inside the outside layer until the inside layer is reached. As
noted above, the inside layer should NOT be a film coefficient since EnergyPlus will calculate
inside convection and radiation heat transfer more precisely.
An IDF example for this object, is shown below:
Construction:WindowEquivalentLayer,
Six Solid Layers Window,
!- Name
INSCRN,
!- Outside Layer
Air GAP Outdoor 12.7mm,
!- Layer 2
GLZGRY,
!- Layer 3
Argon GAP Sealed 12.7mm,
!- Layer 4
FEP,
!- Layer 5
Xenon GAP Sealed 12.7mm,
!- Layer 6
LOF1436,
!- Layer 7
Krypton GAP Sealed 12.7mm, !- Layer 8
GLZCLR,
!- Layer 9
Air GAP Indoor 12.7mm,
!- Layer 10
ShadeTrns;
!- Layer 11

Construction:WindowDataFile
The WINDOW program, which does a thermal and optical analysis of a window under
different design conditions, writes a data file (Window data file) containing a description of
9/29/14

169

Input-Output Reference

Group Surface Construction Elements

the window that was analyzed. The Construction:WindowDataFile object allows a window to
be read in from the WINDOW data filesee Importing Windows from WINDOW. For
information
on
adding
a
shading
device
to
the
window
see
WindowProperty:ShadingControl.
Field: Name
This is the name of a window on the Window data file. An error will result if EnergyPlus
cannot find a window of this name on the file, or if the file, shown in the next field, is not
present. The location of the data file should be specified in the File Name field. For details on
what is done with the data if a matching window is found on the file see Importing Windows
from WINDOW.
Field: File Name
This is the file name of the Window data file that contains the Window referenced in the
previous field. The field may include a full path with file name, for precise results. The field
must be <= 100 characters. The file name must not include commas or an exclamation point.
A relative path or a simple file name should work with version 7.0 or later when using EPLaunch even though EP-Launch uses temporary directories as part of the execution of
EnergyPlus. If using RunEPlus.bat to run EnergyPlus from the command line, a relative path
or a simple file name may work if RunEPlus.bat is run from the folder that contains
EnergyPlus.exe.
If this field is left blank, the file name is defaulted to Window5DataFile.dat.
The IDD of the object:
Input Example
Construction:WindowDataFile,
DoubleClear;
!- Name of a Window on the Window Data File
! Note Window5DataFile.dat is presumed to be in the run folder where
EnergyPlus.exe is
FenestrationSurface:Detailed,
Zn001:Wall001:Win001, !- Name
Window,
!- Class
DoubleClear,
!- Construction Name
Zn001:Wall001,,
!- Base Surface Name, and Target (if applicable)
0.5,
!- View Factor to Ground
,
!- Window Shading Control name
,
!- Frame/Divider name
1.0,
!- Multiplier
4,
!- Number of vertices
0.548, 0.0, 2.5000,
!- X,Y,Z of Vertices
0.548, 0.0, 0.5000,
5.548, 0.0, 0.5000,
5.548, 0.0, 2.5000;

An example showing use of specific data file name and complete path location follows:
Construction:WindowDataFile,
DoubleClear,
!- Name of a Window on the Window Data File
C:\EnergyPlusData\DataSets\MyWindow.dat;

Construction Element Outputs

An optional report (contained in eplusout.eio) gives calculational elements for the materials
and constructions used in the input. These reports are explained fully in the Output Details
and Examples document.

9/29/14

170

Input-Output Reference

Group Thermal Zone Description/Geometry

Group Thermal Zone Description/Geometry

Without thermal zones and surfaces, the building cant be simulated. This group of objects
(Zone, BuildingSurface) describes the thermal zone characteristics as well as the details of
each surface to be modeled. Included here are shading surfaces.
Zone
This element sets up the parameters to simulate each thermal zone of the building.
Field: Direction of Relative North
The Zone North Axis is specified relative to the Building North Axis. This value is specified
in degrees (clockwise is positive). For more information, see the figure below as well as the
description under GlobalGeometryRules.
Field(s): (X,Y,Z) Origin
The X,Y,Z coordinates of a zone origin can be specified, for convenience in vertice entry.
Depending on the values in GlobalGeometryRules (see description later in this section),
these will be used to completely specify the building coordinates in world coordinate or not.
Zone Origin coordinates are specified relative to the Building Origin (which always 0,0,0).
The following figure illustrates the use of Zone North Axis as well as Zone Origin values.

Zone 4
Zone 3

Zone 1
Zone 2
Zone(s)
North Axis

(0,9,0)

(0,0,0)
BUILDING
NORTH

15

Figure 27. Illustration of Zone North Axis and Origins

Field: Type
Zone type is currently unused.

9/29/14

171

Input-Output Reference

Group Thermal Zone Description/Geometry

Field: Multiplier
Zone Multiplier is designed as a multiplier for floor area, zone loads, and energy consumed
by internal gains. It takes the calculated load for the zone and multiplies it, sending the
multiplied load to the attached HVAC system. The HVAC system size is specified to meet the
entire multiplied zone load and will report the amount of the load met in the Zone Air System
Sensible Heating or Cooling Energy/Rate output variable. Autosizing automatically accounts
for multipliers. Metered energy consumption by internal gains objects such as Lights or
Electric Equipment will be mutliplied. The default is 1.
Field: Ceiling Height
Zone ceiling height is used in several areas within EnergyPlus (such as various room models,
some convection coefficient calculations and, primarily, in calculating zone volume in the
absence of other parameters). Energyplus automatically calculates the zone ceiling height
(m) from the average height of the zone. If this field is 0.0, negative or autocalculate, then
the calculated zone ceiling height will be used in subsequent calculations. If this field is
positive, then the calculated zone ceiling height will not be used -- the number entered here
will be used as the zone ceiling height. If this number differs significantly from the calculated
ceiling height, then a warning message will be issued. If a zone ceiling height is entered, but
no Volume is entered, then the floor area (if there is one) times the zone ceiling height will be
used as the volume.
Note that the Zone Ceiling Height is the distance from the Floor to the Ceiling in the Zone, not
an absolute height from the ground.
Field: Volume
Zone volume is used in several areas within EnergyPlus (such as calculating air change rates
for reporting or flow when air change rates are chosen as input, daylighting calculations,
some convection coefficient calculations). EnergyPlus automatically calculates the zone
volume (m3) from the zone geometry given by the surfaces that belong to the zone. If this
field is 0.0, negative or autocalculate, then the calculated zone volume will be used in
subsequent calculations. If this field is positive, then it will be used as the zone volume. If this
number differs significantly from the calculated zone volume a warning message will be
issued. For autocalculate to work properly, the zone must be enclosed by the entered walls.
Note that indicating the volume to be calculated but entering a positive ceiling height in the
previous field will cause the volume to be calculated as the floor area (if > 0) times the
entered ceiling height; else the volume will be calculated from the described surfaces. If this
field is positive, any ceiling height positive value will not be used in volume calculations.
Field: Floor Area
Zone floor area is used in many places within EnergyPlus. EnergyPlus automatically
calculates the zone floor area (m 2) from the zone geometry given by the surfaces that belong
to the zone. If this field is 0.0, negative or autocalculate, then the calculated zone floor area
will be used in subsequent calculations. If this field is positive, then it will be used as the zone
floor area. If this number differs significantly from the calculated zone floor area a warning
message will be issued.
Field: Zone Inside Convection Algorithm
The Zone Inside Convection Algorithm field is optional. This field specifies the convection
model to be used for the inside face of heat transfer surfaes associated with this zone. The
choices are: Simple (constant natural convection - ASHRAE), Detailed (variable natural
convection based on temperature difference - ASHRAE), CeilingDiffuser (ACH based forced
and mixed convection correlations for ceiling diffuser configuration with simple natural
convection limit), AdaptiveConvectionAlgorithm (complex arrangement of various models
that adapt to various zone conditions and can be customized) and TrombeWall (variable
natural convection in an enclosed rectangular cavity). See the Inside Convection Algorithm
object for further descriptions of the available models.
9/29/14

172

Input-Output Reference

Group Thermal Zone Description/Geometry

If omitted or blank, the algorithm specified in the SurfaceConvectionAlgorithm:Inside object is

the default.
Field: Zone Outside Convection Algorithm
The Zone Outside Convection Algorithm field is optional. This field specifies the convection
model to be used for the outside face of heat transfer surfaces associated with this zone. The
choices
are:
SimpleCombined,
TARP,
DOE-2,
MoWiTT,
and
AdaptiveConvectionAlgorithm. The simple convection model applies heat transfer
coefficients depending on the roughness and windspeed. This is a combined heat transfer
coefficient that includes radiation to sky, ground, and air. The correlation is based on Figure
1, Page 25.1 (Thermal and Water Vapor Transmission Data), 2001 ASHRAE Handbook of
Fundamentals.
The other convection models apply heat transfer coefficients depending on the roughness,
windspeed, and terrain of the buildings location. These are convection only heat transfer
coefficients; radiation heat transfer coefficients are calculated automatically by the program.
The TARP algorithm was developed for the TARP software and combines natural and winddriven convection correlations from laboratory measurements on flat plates. The DOE-2 and
MoWiTT were derived from field measurements. The AdaptiveConvectionAlgorithm model is
an dynamic algorithm that organizes a large number of different convection models and
automatically selects the one that best applies. The adaptive convection algorithm can also
be customized using the SurfaceConvectionAlgorithm:Outside:AdaptiveModelSelections
input object. All algorithms are described more fully in the Engineering Reference.
If omitted or blank, the algorithm specified in the SurfaceConvectionAlgorithm:Outside object
is the default.
Field: Part of Total Floor Area
This optional field defaults to Yes if not specified. The field is used to show when a zone is
not part of the Total Floor Area as shown in the Annual Building Utility Performance Summary
tables. Specifically, when No is specified, the area is excluded from both the conditioned floor
area and the total floor area in the Building Area sub table and the Normalized Metrics sub
tables.
And, an IDF example:
Zone,
DORM ROOMS AND COMMON AREAS, !- Name
0.0000000E+00,
!- Direction of Relative North {deg}
0.0000000E+00,
!- X Origin {m}
6.096000,
!- Y Origin {m}
0.0000000E+00,
!- Z Origin {m}
1,
!- Type
1,
!- Multiplier
autocalculate,
!- Ceiling Height {m}
autocalculate;
!- Volume {m3}

Zone Outputs
Zone,Average,Zone Outdoor Air Drybulb Temperature [C]
Zone,Average,Zone Outdoor Air Wetbulb Temperature [C]
Zone,Average,Zone Outdoor Air Wind Speed [m/s]

Zone Outdoor Air Drybulb Temperature [C]

The outdoor air dry-bulb temperature calculated at the height above ground of the zone
centroid.

9/29/14

173

Input-Output Reference

Group Thermal Zone Description/Geometry

Zone Outdoor Air Wetbulb Temperature [C]

The outdoor air wet-bulb temperature calculated at the height above ground of the zone
centroid.
Zone Outdoor Air Wind Speed [m/s]
The outdoor wind speed calculated at the height above ground of the zone centroid.
Zone Thermal Output(s)
In addition to the canned Surface reports (view the Reports section later in this document)
and surface variables (above), the following variables are available for all zones:
Zone,Sum,Zone Total Internal Radiant Heating Energy [J]
Zone,Average,Zone Total Internal Radiant Heating Rate [W]
Zone,Sum,Zone Total Internal Visible Radiation Heating Energy [J]
Zone,Average,Zone Total Internal Visible Radiation Heating Rate [W]
Zone,Sum,Zone Total Internal Convective Heating Energy [J]
Zone,Average,Zone Total Internal Convective Heating Rate [W]
Zone,Sum,Zone Total Internal Latent Gain Energy [J]
Zone,Average,Zone Total Internal Latent Gain Rate [W]
Zone,Sum,Zone Total Internal Total Heating Energy [J]
Zone,Average,Zone Total Internal Total Heating Rate [W]
Zone,Average,Zone Mean Air Temperature [C]
HVAC,Average,Zone Air Temperature [C]
Zone,Average,Zone Mean Air Dewpoint Temperature [C]
Zone,Average,Zone Mean Radiant Temperature [C]
Zone,Average,Zone Operative Temperature [C]
HVAC,Average,Zone Air Heat Balance Internal Convective Heat Gain Rate [W]
HVAC,Average,Zone Air Heat Balance Surface Convection Rate [W]
HVAC,Average,Zone Air Heat Balance Interzone Air Transfer Rate [W]
HVAC,Average,Zone Air Heat Balance Outdoor Air Transfer Rate [W]
HVAC,Average,Zone Air Heat Balance System Air Transfer Rate [W]
HVAC,Average,Zone Air Heat Balance System Convective Heat Gain Rate [W]
HVAC,Average,Zone Air Heat Balance Air Energy Storage Rate [W]
HVAC,Average,Zone Air Heat Balance Deviation Rate [W]
HVAC,Sum,Zone Air System Sensible Heating Energy [J]
HVAC,Sum,Zone Air System Sensible Cooling Energy [J]
HVAC,Average,Zone Air System Sensible Heating Rate [W]
HVAC,Average,Zone Air System Sensible Cooling Rate [W]
HVAC,Average,Zone Air Humidity Ratio[kgWater/kgDryAir]
HVAC,Average,Zone Air Relative Humidity[%]

Two of these are of particular interest:

Zone,Average,Zone Mean Air Temperature [C]
HVAC,Average,Zone Air Temperature [C]

These two variable outputs are/should be identical. However, note that they can be reported
at different time intervals. Zone Mean Air Temperature is only available on the Zone/HB
timestep (Number of Timesteps per Hour) whereas Zone Air Temperature can be reported
at the HVAC timestep (which can vary).
Zone Mean Air Temperature [C]
From the code definition, the zone mean air temperature is the average temperature of the air
temperatures at the system timestep. Remember that the zone heat balance represents a
well stirred model for a zone, therefore there is only one mean air temperature to represent
the air temperature for the zone.
Zone Air Temperature [C]
This is very similar to the mean air temperature in the last field. The well stirred model for
the zone is the basis, but this temperature is also available at the detailed system timestep.

9/29/14

174

Input-Output Reference

Group Thermal Zone Description/Geometry

Zone Mean Air Dewpoint Temperature [C]

This is the dewpoint temperature of the zone calculated from the Zone Mean Air Temperature
(above), the Zone Air Humidity Ratio (below) and the outdoor barometric pressure.
Zone Thermostat Air Temperature [C]
This is the zone air node temperature for the well-mixed room air model, which is the default
room air model type (RoomAirModelType=Mixing). But for other types of Room Air Model
(the RoomAir:TemperaturePattern:* and RoomAirSettings:* objects) the zone thermostat air
temperature may depend on the Thermostat Height and Thermostat Offset.
Zone Mean Radiant Temperature [C]
The Mean Radiant Temperature (MRT) in degrees Celsius of a space is a measure of the
combined effects of temperatures of surfaces within that space. Specifically it is the surface
area emissivity weighted average of the zone inside surface temperatures (ref. Surface
Inside Temperature), where emissivity is the Thermal Absorptance of the inside material layer
of each surface.
Zone Operative Temperature [C]
Zone Operative Temperature (OT) is the average of the Zone Mean Air Temperature (MAT)
and Zone Mean Radiant Temperature (MRT), OT = 0.5*MAT + 0.5*MRT. This output
variable is not affected by the type of thermostat controls in the zone, and does not include
the direct effect of high temperature radiant systems. See also Zone Thermostat Operative
Temperature.
Zone Air Heat Balance Internal Convective Heat Gain Rate [W]
The Zone Air Heat Balance Internal Convective Heat Gain Rate is the sum, in watts, of heat
transferred to the zone air from all types of internal gains, including people, lights, equipment
etc. This and the following provide results on the load components of the zone air heat
balance. This field is not multiplied by zone or group multipliers.
Zone Air Heat Balance Surface Convection Rate [W]
The Zone Air Heat Balance Surface Convection Rate is the sum, in watts, of heat transferred
to the zone air from all the surfaces. This field is not multiplied by zone or group multipliers.
Zone Air Heat Balance Interzone Air Transfer Rate [W]
The Zone Air Heat Balance Interzone Air Transfer Rate is the sum, in watts, of heat
transferred to the zone air from all the transfers of air from other thermal zones. This field is
not multiplied by zone or group multipliers.
Zone Air Heat Balance Outdoor Air Transfer Rate [W]
The Zone Air Heat Balance Outdoor Air Transfer Rate is the sum, in watts, of heat transferred
to the zone air from all the transfers of air from the out side, such as infiltration. This field is
not multiplied by zone or group multipliers.
Zone Air Heat Balance System Air Transfer Rate [W]
The Zone Air Heat Balance System Air Transfer Rate is the sum, in watts, of heat transferred
to the zone air by HVAC forced-air systems and air terminal units. Such HVAC systems are
connected to the zone by an inlet node (see ZoneHVac:EquipmentConnections input field
called Zone Air Inlet Node or Node List Name) This field is not multiplied by zone or group
multipliers.
Zone Air Heat Balance System Convective Heat Gain Rate [W]
The Zone Air Heat Balance System Convective Heat Gain Rate is the sum, in watts, of heat
transferred directly to the zone air by non-air HVAC systems. Such HVAC systems are not
connected to the zone by an inlet node but rather add or subtract heat directly to the zone air
9/29/14

175

Input-Output Reference

Group Thermal Zone Description/Geometry

in a manner similar to internal gains. These include the convective fraction of zone HVAC
baseboards and high temperature radiant systems, zone HVAC refrigeration chiller set, and
the extra convective cooling provided by the cooled beam air terminal unit. This field is not
multiplied by zone or group multipliers.
Zone Air Heat Balance Air Energy Storage Rate [W]
The Zone Air Heat Balance Air Energy Storage Rate is the heat stored, in watts, in the zone
air as result of zone air temperature changing from one timestep to the next. This field is not
multiplied by zone or group multipliers.
Zone Air Heat Balance Deviation Rate [W]
The Zone Air Heat Balance Deviation Rate is the imbalance, in watts, in the energy balance
for zone air. The value should be near zero but will become non-zero if zone conditions are
changing rapidly or erratically. This field is not multiplied by zone or group multipliers. (This
output variable is only generated if the user has set a computer system environment variable
DisplayAdvancedReportVariables equal to yes.)
Zone Air System Sensible Heating Energy [J]
This output variable represents the sensible heating energy in Joules that is actually supplied
by the system to that zone for the timestep reported. This is the sensible heating rate
multiplied by the simulation timestep. This is calculated and reported from the Correct step in
the Zone Predictor-Corrector module. . This field is not multiplied by zone or group
multipliers.
Zone Air System Sensible Heating (and Cooling) Energy (and Rate) all report the heating or cooling
delivered by the HVAC system to a zone. These values are calculated by multiplying the supply air mass
flow rate by the difference between the supply air temperature and the zone air temperature. This does not
always indicate the operation of heating or cooling coils. For example, cooling will be reported if the supply
air is cooled due to the introduction of outside air, even if all coils are off.
Note that these variables are calculated at the system timestep. When reported at the "detailed" reporting
frequency, these variable will never show heating and cooling both in the same system timestep. If
reported at a frequency less than "Detailed" (for example, Hourly) values may appear in both the heating
and cooling variable for the same hour if the system cooled the zone for part of the reporting period and
heated the zone for another part of the reporting period.

Zone Air System Sensible Cooling Energy [J]

This output variable represents the sensible cooling energy in Joules that is actually supplied
by the system to that zone for the timestep reported. This is the sensible cooling rate
multiplied by the simulation timestep. This is calculated and reported from the Correct step in
the Zone Predictor-Corrector module.
This field is not multiplied by zone or group
multipliers.
Zone Air System Sensible Heating Rate [W]
This output variable represents the sensible heating rate in Watts that is actually supplied by
the system to that zone for the timestep reported. This is calculated and reported from the
Correct step in the Zone Predictor-Corrector module. This field is not multiplied by zone or
group multipliers.
Zone Air System Sensible Cooling Rate [W]
This output variable represents the sensible cooling rate in Watts that is actually supplied by
the system to that zone for the timestep reported. This is calculated and reported from the

9/29/14

176

Input-Output Reference

Group Thermal Zone Description/Geometry

Correct step in the Zone Predictor-Corrector module.

group multipliers.

This field is not multiplied by zone or

Zone Air Humidity Ratio [kgWater/kgDryAir]

This output variable represents the air humidity ratio after the correct step for each zone. The
humidity ratio is the mass of water vapor to the mass of dry air contained in the zone in (kg
water/kg air) and is unitless.
Zone Air Relative Humidity [%]
This output variable represents the air relative humidity after the correct step for each zone.
The relative humidity is in percent and uses the Zone Air Temperature, the Zone Air Humidity
Ratio and the Outside Barometric Pressure for calculation.
Zone Total Internal Radiant Heating Rate [W]
Zone Total Internal Radiant Heating Energy [J]
These output variables represent the sum of radiant gains from specific internal sources (e.g.
equipment) throughout the zone in Watts (for rate) or joules. This includes radiant gain from
People, Lights, Electric Equipment, Gas Equipment, Other Equipment, Hot Water Equipment,
and Steam Equipment.
Zone Total Internal Visible Radiation Heating Rate [W]
Zone Total Internal Visible Radiation Heating Energy [J]
These output variables expresse the sum of heat gain in Watts (for rate) or joules that is the
calculated short wavelength radiation gain from lights in the zones. This calculation uses the
total energy from lights and the fraction visible to realize this value, summed over the zones
in the simulation.
Zone Total Internal Convective Heating Rate [W]
Zone Total Internal Convective Heating Energy [J]
These output variables represent the sum of convective gains from specific sources (e.g.
equipment) throughout the zone in Watts (for rate) or joules. This includes convective gain
from People, Lights, Electric Equipment, Gas Equipment, Other Equipment, Hot Water
Equipment, and Steam Equipment.
Zone Total Internal Latent Gain Rate [W]
Zone Total Internal Latent Gain Energy [J]
These output variables represent the sum of latent gains from specific internal sources (e.g.
equipment) throughout the zone in Watts (for rate) or joules. This includes latent gain from
People, Electric Equipment, Gas Equipment, Other Equipment, Hot Water Equipment, and
Steam Equipment.
Zone Total Internal Total Heating Rate [W]
Zone Total Internal Total Heating Energy [J]
These output variables represent the sum of all heat gains throughout the zone in Watts (for
rate) or joules. This includes all heat gains from People, Lights, Electric Equipment, Gas
Equipment, Other Equipment, Hot Water Equipment, and Steam Equipment.
ZoneList
The ZoneList object defines a list of Zone objects. It is primarily used with the ZoneGroup
object to provide a generalized way for doing "Floor Multipliers". (See the ZoneGroup
description below.) The associated ZoneList output variables also provide a way to
aggregate and organize zone loads.
9/29/14

177

Input-Output Reference

Group Thermal Zone Description/Geometry

Zone lists are not exclusive. A zone can be referenced be more than one ZoneList object.
Field: Zone List Name
The name of the ZoneList object. Must be unique across ZoneLists.
Field: Zone 1 20 Name
Reference to a Zone object. This field is extensible; for greater than 20 zones, edit the IDD to
add more Zone Name fields.
ZoneList,
Mid Floor List, !- Name
Mid West Zone, !- Zone 1 Name
Mid Center Zone, !- Zone 2 Name
Mid East Zone; !- Zone 3 Name

ZoneList Outputs
The following output variables are reported by the ZoneList object:
HVAC,Average,Zone List Sensible Heating Rate [W]
HVAC,Average,Zone List Sensible Cooling Rate [W]
HVAC,Sum,Zone List Sensible Heating Energy [J]
HVAC,Sum,Zone List Sensible Cooling Energy [J]

All ZoneList variables are the sum of the corresponding Zone variables. Zone Multiplier fields
in the Zone objects are also taken into account.
ZoneGroup
The ZoneGroup object adds a multiplier to a ZoneList. This can be used to reduce the
amount of input necessary for simulating repetitive structures, such as the identical floors of a
multi-story building. To create a "Floor Multiplier", use the ZoneList object to organize several
zones into a typical floor. Then use the Zone List Multiplier field in the ZoneGroup object to
multiply the system load for the zones in the list will also be multiplied. Zones with a Multiplier
field greater than one in the Zone object are effectively double-multiplied.
NOTE: Although ZoneLists are not exclusive by themselves, ZoneLists used to form a ZoneGroup are
exclusive; the ZoneLists used with a ZoneGroup must not have any zones in common.

Tips for Multi-Story Simulations:

For floors that are multiplied, connect exterior boundary conditions of the floor to the
ceiling and vice versa.
Since exterior convection coefficients vary with elevation, locate the typical middle floor
zones midheight between the lowest and highest middle floors to be modeled.
Shading must be identical for all multiplied floors or less accurate results may be
obtained by using the zone list multiplier.
ZoneGroup and ZoneList can also be used to simulate other repetitive cases, such as
clusters of zones on the ground.
Field: Zone Group Name
The name of the ZoneGroup object. This must be unique across ZoneGroups.
Field: Zone List Name
Reference to a ZoneList object. The zones in the list constitute the zones in the group.

9/29/14

178

Input-Output Reference

Group Thermal Zone Description/Geometry

Field: Zone List Multiplier

An integer multiplier. Zone List Multiplier is designed as a multiplier for floor area, zone
loads, and energy consumed by internal gains. It takes the calculated load for the zone and
multiplies it, sending the multiplied load to the attached HVAC system. The HVAC system
size is specified to meet the entire multiplied zone load and will report the amount of the load
met in the Zone Air System Sensible Heating or Cooling Energy/Rate output variable.
Autosizing automatically accounts for multipliers. Metered energy consumption by internal
gains objects such as Lights or Electric Equipment will be mutliplied. The default is 1.
ZONE GROUP,
Mid Floor, !- Zone Group Name
Mid Floor List, !- Zone List Name
8; !- Zone List Multiplier

ZoneGroup Outputs
The following output variables are reported by the ZoneGroup object:
HVAC,Average,Zone Group Sensible Heating Rate [W]
HVAC,Average,Zone Group Sensible Cooling Rate [W]
HVAC,Sum,Zone Group Sensible Heating Energy [J]
HVAC,Sum,Zone Group Sensible Cooling Energy [J]

All ZoneGroup variables report the associated ZoneList value multiplied by the Zone List
Multiplier.
Surface(s)
Whats a building without surfaces?
EnergyPlus allows for several surface types:
BuildingSurface:Detailed
FenestrationSurface:Detailed
Shading:Site:Detailed
Shading:Building:Detailed
Shading:Zone:Detailed
Each of the preceding surfaces has correct geometry specifications. BuildingSurface and
Fenestration surfaces (heat transfer surfaces) are used to describe the important elements of
the building (walls, roofs, floors, windows, doors) that will determine the interactions of the
building surfaces with the outside environment parameters and the internal space
requirements. These surfaces are also used to represent interzone heat transfer. During
specification of surfaces, several outside environments may be chosen:
Ground when the surface is in touch with the ground (e.g. slab floors)
Outdoors when the surface is an external surface (e.g. walls, roofs, windows directly
exposed to the outdoor conditions)
Surface when the surface is
An adiabatic internal zone surface
A interzone surface
Zone when the surface is
A interzone surface in which the other surface is not put in the input file.
OtherSideCoefficients when using a custom profile to describe the external conditions
of
the
surface
(advanced
concept

covered
in
subject:
SurfaceProperty:OtherSideCoefficients)
OtherSideConditionsModel when using specially modeled components, such as
active solar systems, that cover the outside surface and modify the conditions it
experiences.
9/29/14

179

Input-Output Reference

Group Thermal Zone Description/Geometry

Surface items must also specify an outside face object. This is

Current surface name for adiabatic internal surfaces.
A surface name in another zone for interzone heat transfer.
An opposing surface name (in the current zone) for representing middle zones.
Zone items must also specify an outside face object. This is
The zone that contains the other surface that is adjactent to this surface but is not
entered in input.
Note that heat transfer surfaces are fully represented with each description. As stated earlier in the
Construction description, materials in the construction (outside to inside) are included but film coeffients
neither inside nor outside are used in the description these are automatically calculated during the
EnergyPlus run. Interzone surfaces which do not have a symmetrical construction (such as a ceiling/floor)
require two Construction objects with the layers in reverse order. For example, CEILING with carpet,
concrete, ceiling tile and FLOOR with ceiling tile, concrete, carpet. If interzone surfaces have a
symmetrical construction, the specification for the two surfaces can reference the same Construction.

Shading surfaces are used to describe aspects of the site which do not directly impact the
physical interactions of the environmental parameters but may significantly shade the building
during specific hours of the day or time so the year (e.g. trees, bushes, mountains, nearby
buildings which arent being simulated as part of this facility, etc.)
Note that surfaces which are part of the simulated building automatically shade other parts of the building
as geometry and time of day dictate there is no need on the users part to include surfaces that might be
in other zones for shading.

Another surface type:

InternalMass
is used to specify the construction/material parameters and area of items within the space
that are important to heat transfer calculations but not necessarily important geometrically.
(For example, furniture within the space particularly for large spaces). Internal mass can
also be used for internal walls that are not needed (when FullInteriorAndExterior Solar
Distribution is in effect) for solar distribution or to represent many, if not all, interior walls
when solar is distributed to the floors only.
Interzone Surfaces
EnergyPlus can quite accurately simulate the surface heat exchange between two zones.
However, this accuracy is not always required and using interzonal heat transfer does add to
the complexity of the calculations thus requiring more CPU time to simulate. More
information about interzonal heat transfer calculations is contained in the Engineering
Reference. Some simple guidelines are presented here for three cases: adiabatic surfaces,
surfaces in middle zones, and surfaces where heat transfer is expected (e.g. between a
residence and an unheated, attached garage).
Adiabatic Surfaces These surfaces would be represented as common surfaces
(between two zones) where both zones are typically the same temperature. Thus, no
transfer is expected in the surface from one zone to the next. These surfaces should be
described as simply internal surfaces for the zone referencing as their Outside Boundary
Condition Object (see later description in individual surface objects) their own surface
names.
Surfaces in Middle Zones Middle zones in a building can be simulated using a judicious
use of surfaces and zone multipliers to effect the correct loads for the building. Thus,
9/29/14

180

Input-Output Reference

Group Thermal Zone Description/Geometry

middle zone behavior can be simulated without modeling the adjacent zones. This is
done by specifying a surface within the zone. For example, a middle floor zone can be
modeled by making the floor the Outside Boundary Condition Object for the ceiling, and
the ceiling the Outside Boundary Condition Object for the floor.
Surfaces between Zones with differing temperatures These zones represent the true
use of interzone surfaces. In a residence that has an attached garage, the garage may
be unheated/uncooled or at least not conditioned to the same degree as the residence
interior. In this case, EnergyPlus can be used to accurately calculate the effects of the
differently conditioned space to the other spaces.
Surface View Factors
EnergyPlus uses an area weighted approximation to calculate "view factors" between
surfaces within a thermal zone. Each surface uses the total area that it can see among the
other surfaces. The approximate view factor from this surface to each other surface is then
the area of the receiving surface over the sum of areas that is visible to the sending surface.
In order to account in some limited way for the fact that certain surfaces will not see each
other, several assumptions have been built into this simple view factor approximation. First, a
surface cannot see itself. Second, surfaces with approximately the same azimuth (facing
direction) and tilt ("same" being within a built in limit) will not see each other. This means that
a window will not see the wall that it is placed on, for example. Third, floors cannot see each
other. Fourth, if the surface is a floor, ceiling, roof, or internal mass, the rule for the same
azimuth and tilt eliminating radiant exchange between surface is waived when the receiving
surface is floor, roof, ceiling, or internal mass as long as both surfaces are not floors.
Note that this does not take into account that surfaces may be "around the corner" from each
other and in reality not see each other at all. Rooms are assumed to be convex rather than
concave in this method.
To summarize, using the Surface Class, the approximate view factors have:

1. No surface sees itself.

2.
3.
4.
5.
6.
7.

No Floor sees another floor.

All other surface types see Internal Mass.
All other surface types see floors.
Floors always see ceilings.
Floors always see roofs.
All other surfaces whose tilt or facing angle differences are greater than 10 degrees see
each other.
If geometry is correct, conditions 1,3, and 7 should take care of all surfaces, but the other
conditions supply common sense when the geometry is incorrect. More information about the
EnergyPlus view factor calculation is contained in the Engineering Reference document.
GlobalGeometryRules
Before the surface objects are explained in detail, a description of geometric parameters
used in EnergyPlus will be given. Since the input of surface vertices is common to most of the
surface types, it will also be given a separate discussion.
Some flexibility is allowed in specifying surface vertices. This flexibility is embodied in the
GlobalGeometryRules class/object in the input file. Note that the parameters specified in this
statement are used for all surface vertice inputs there is no further flexibility allowed.
In order to perform shadowing calculations, the building surfaces must be specified.
EnergyPlus uses a three dimensional (3D) Cartesian coordinate system for surface vertex
specification. This Right Hand coordinate system has the X-axis pointing east, the Y-axis
pointing north, and the Z-axis pointing up. See figure below.

9/29/14

181

Input-Output Reference

Group Thermal Zone Description/Geometry

Zone North Axis

Z Axis

Y Axis

X Axis

Figure 28. EnergyPlus Coordinate System

Field: Starting Vertex Position
The shadowing algorithms in EnergyPlus rely on surfaces having vertices in a certain order
and positional structure. Thus, the surface translator needs to know the starting point for each
surface entry. The choices are: UpperLeftCorner, LowerLeftCorner , UpperRightCorner, or
LowerRightCorner. Since most surfaces will be 4 sided, the convention will specify this
position as though each surface were 4 sided. Extrapolate 3 sided figures to this convention.
For 5 and more sided figures, again, try to extrapolate the best corner starting position.
Field: Vertex Entry Direction
Surfaces are always specified as being viewed from the outside of the zone to which they
belong. (Shading surfaces are specified slightly differently and are discussed under the
particular types). EnergyPlus needs to know whether the surfaces are being specified in
counterclockwise or clockwise order (from the Starting Vertex Position). EnergyPlus uses this
to determine the outward facing normal for the surface (which is the facing angle of the
surface very important in shading and shadowing calculations.
Field: Coordinate System
Vertices can be specified in two ways: using Absolute/World coordinates, or a relative
coordinate specification. Relative coordinates allow flexibility of rapid change to observe
changes in building results due to orientation and position. World coordinates will facilitate
use within a CADD system structure.
Relative coordinates make use of both Building and Zone North Axis values as well as Zone
Origin values to locate the surface in 3D coordinate space. World coordinates do not use
these values.
Typically, all zone origin values for World coordinates will be (0,0,0) but Building and Zone
North Axis values may be used in certain instances (namely the Daylighting Coordinate
Location entries).
Field: Daylighting Reference Point Coordinate System
Daylighting reference points need to be specified as well. Again, there can be two flavors;
relative and world. Daylighting reference points must fit within the zone boundaries.

9/29/14

182

Input-Output Reference

Group Thermal Zone Description/Geometry

Relative coordinates make use of both Building and Zone North Axis values as well as Zone
Origin values to locate the reference point in 3D coordinate space. World coordinates do not
use these values.
Field: Rectangular Surface Coordinate System
Simple,
rectangular
surfaces
(Wall:Exterior,
Wall:Adiabatic,
Wall:Underground,
Wall:Interzone,
Roof,
Ceiling:Adiabatic,
Ceiling:Interzone,
Floor:GroundContact,
Floor:Adiabatic, Floor:Interzone) can be specified with their Lower Left Corner as relative or
world.
Relative (default) corners are specified relative to the Zone Origin for each surface. World
corners would specify the absolute/world coordinate for this corner.
Surfaces
Surfaces make up the buildings and the elements that shade buildings. There are several
methods to inputting surfaces, ranging from simple rectangular surfaces to detailed
descriptions that describe each vertex in the order specified in the GlobalGeometryRules
object. The simple, rectangular surface objects are described first with the more detailed
descriptions following.
Walls
Walls are usually vertical (tilt = 90 degrees). These objects are used to describe exterior
walls, interior walls (adiabatic), underground walls, and walls adjacent to other zones.
Wall:Exterior
The Wall:Exterior object is used to describe walls that are exposed to the external
environment. They receive sun, wind all the characteristics of the external world.
Field: Name
This is a unique name associated with the exterior wall. It is used in several other places as a
reference (e.g. as the base surface name for a Window or Door).
Field: Construction Name
This is the name of the construction (ref: Construction object) used in the surface. Regardless
of location in the building, the full construction (all layers) is used. For example, for an
interior wall separating two zones, zone x would have the outside layer (e.g. drywall) as the
material that shows in zone y and then the layers to the inside layer the material that shows
in zone x. For symmetric constructions, the same construction can be used in the surfaces
described in both zones.
Field: Zone Name
This is the zone name to which the surface belongs.
Field: Azimuth Angle
The Azimuth Angle indicates the direction that the wall faces (outward normal). The angle is
specified in degrees where East=90, South=180, West=270, North=0.
Field: Tilt Angle
The tilt angle is the angle (in degrees) that the wall is tilted from horizontal (or the ground).
Normally, walls are tilted 90 degrees and that is the default for this field.
Starting Corner for the surface
The rectangular surfaces specify the lower left corner of the surface for their starting
coordinate. This is specified with (x,y,z) and can be relative to the zone origin or in world

9/29/14

183

Input-Output Reference

coordinates, depending on
GlobalGeometryRules object.

Group Thermal Zone Description/Geometry

the

value

for

rectangular

surfaces

specified

in

the

Field: Starting X Coordinate

This field is the X coordinate (in meters).
Field: Starting Y Coordinate
This field is the Y coordinate (in meters).
Field: Starting Z Coordinate
This field is the Z coordinate (in meters).
Field: Length
This field is the length of the wall in meters.
Field: Height
This field is the height of the wall in meters.
Wall:Adiabatic
The Wall:Adiabatic object is used to describe interior walls and partitions. Adiabatic walls are
used to describe walls next to zones that have the same thermal conditions (thus, no heat
transfer).
Field: Name
This is a unique name associated with the interior wall. It is used in several other places as a
reference (e.g. as the base surface name for a Window or Door).
Field: Construction Name
This is the name of the construction (ref: Construction object) used in the surface. Regardless
of location in the building, the full construction (all layers) is used. For example, for an
interior wall separating two zones, zone x would have the outside layer (e.g. drywall) as the
material that shows in zone y and then the layers to the inside layer the material that shows
in zone x. For symmetric constructions, the same construction can be used in the surfaces
described in both zones.
Field: Zone Name
This is the zone name to which the surface belongs.
Field: Azimuth Angle
The Azimuth Angle indicates the direction that the wall faces (outward normal). The angle is
specified in degrees where East=90, South=180, West=270, North=0.
Field: Tilt Angle
The tilt angle is the angle (in degrees) that the wall is tilted from horizontal (or the ground).
Normally, walls are tilted 90 degrees and that is the default for this field.
Starting Corner for the surface
The rectangular surfaces specify the lower left corner of the surface for their starting
coordinate. This is specified with (x,y,z) and can be relative to the zone origin or in world
coordinates, depending on the value for rectangular surfaces specified in the
GlobalGeometryRules object.
Field: Starting X Coordinate
This field is the X coordinate (in meters).

9/29/14

184

Input-Output Reference

Group Thermal Zone Description/Geometry

Field: Starting Y Coordinate

This field is the Y coordinate (in meters).
Field: Starting Z Coordinate
This field is the Z coordinate (in meters).
Field: Length
This field is the length of the wall in meters.
Field: Height
This field is the height of the wall in meters.
Wall:Underground
The Wall:Underground object is used to describe walls with ground contact. The temperature
at the outside of the wall is the temperature in the GroundTemperature:BuildingSurface
object.
Field: Name
This is a unique name associated with the underground wall. It is used in several other places
as a reference (e.g. as the base surface name for a Window or Door).
Field: Construction Name
This is the name of the construction (ref: Construction object) used in the surface. Regardless
of location in the building, the full construction (all layers) is used. For example, for an
interior wall separating two zones, zone x would have the outside layer (e.g. drywall) as the
material that shows in zone y and then the layers to the inside layer the material that shows
in zone x. For symmetric constructions, the same construction can be used in the surfaces
described
in
both
zones.
Note
that
if
the
construction
is
Construction:CfactorUndergroundWall then the GroundFCfactoreMethod will be used for
this wall.
Field: Zone Name
This is the zone name to which the surface belongs.
Field: Azimuth Angle
The Azimuth Angle indicates the direction that the wall faces (outward normal). The angle is
specified in degrees where East=90, South=180, West=270, North=0.
Field: Tilt Angle
The tilt angle is the angle (in degrees) that the wall is tilted from horizontal (or the ground).
Normally, walls are tilted 90 degrees and that is the default for this field.
Starting Corner for the surface
The rectangular surfaces specify the lower left corner of the surface for their starting
coordinate. This is specified with (x,y,z) and can be relative to the zone origin or in world
coordinates, depending on the value for rectangular surfaces specified in the
GlobalGeometryRules object.
Field: Starting X Coordinate
This field is the X coordinate (in meters).
Field: Starting Y Coordinate
This field is the Y coordinate (in meters).

9/29/14

185

Input-Output Reference

Group Thermal Zone Description/Geometry

Field: Starting Z Coordinate

This field is the Z coordinate (in meters).
Field: Length
This field is the length of the wall in meters.
Field: Height
This field is the height of the wall in meters.
Wall:Interzone
The Wall:Interzone object is used to describe walls adjacent to zones that are significantly
different conditions than the zone with this wall.
Field: Name
This is a unique name associated with the interzone wall. It is used in several other places as
a reference (e.g. as the base surface name for a Window or Door).
Field: Construction Name
This is the name of the construction (ref: Construction object) used in the surface. Regardless
of location in the building, the full construction (all layers) is used. For example, for an
interior wall separating two zones, zone x would have the outside layer (e.g. drywall) as the
material that shows in zone y and then the layers to the inside layer the material that shows
in zone x. For symmetric constructions, the same construction can be used in the surfaces
described in both zones.
Field: Zone Name
This is the zone name to which the surface belongs.
Field: Outside Boundary Condition Object
The Outside Boundary Condition Object field is the name of a wall in an adjacent zone or the
name of the adjacent zone. If the adjacent zone option is used, the adjacent wall is
automatically generated in the adjacent zone. If the surface name is used, it must be in the
adjacent zone.
Field: Azimuth Angle
The Azimuth Angle indicates the direction that the wall faces (outward normal). The angle is
specified in degrees where East=90, South=180, West=270, North=0.
Field: Tilt Angle
The tilt angle is the angle (in degrees) that the wall is tilted from horizontal (or the ground).
Normally, walls are tilted 90 degrees and that is the default for this field.
Starting Corner for the surface
The rectangular surfaces specify the lower left corner of the surface for their starting
coordinate. This is specified with (x,y,z) and can be relative to the zone origin or in world
coordinates, depending on the value for rectangular surfaces specified in the
GlobalGeometryRules object.
Field: Starting X Coordinate
This field is the X coordinate (in meters).
Field: Starting Y Coordinate
This field is the Y coordinate (in meters).

9/29/14

186

Input-Output Reference

Group Thermal Zone Description/Geometry

Field: Starting Z Coordinate

This field is the Z coordinate (in meters).
Field: Length
This field is the length of the wall in meters.
Field: Height
This field is the height of the wall in meters.
Roofs/Ceilings
Roofs and ceilings are, by default, flat (tilt = 0 degrees). These objects are used to describe
roofs, interior ceilings (adiabatic) and ceilings adjacent to other zones.
Roof
The Roof object is used to describe roofs that are exposed to the external environment.
Field: Name
This is a unique name associated with the roof. It is used in several other places as a
reference (e.g. as the base surface name for a Window or Door).
Field: Construction Name
This is the name of the construction (ref: Construction object) used in the surface. Regardless
of location in the building, the full construction (all layers) is used. For example, for an
interior wall separating two zones, zone x would have the outside layer (e.g. drywall) as the
material that shows in zone y and then the layers to the inside layer the material that shows
in zone x. For symmetric constructions, the same construction can be used in the surfaces
described in both zones.
Field: Zone Name
This is the zone name to which the surface belongs.
Field: Azimuth Angle
The Azimuth Angle indicates the direction of the outward normal for the roof. The angle is
specified in degrees where East=90, South=180, West=270, North=0.
Field: Tilt Angle
The tilt angle is the angle (in degrees) that the wall is tilted from horizontal (or the ground).
Flat roofs are tilted 0 degrees and that is the default for this field.
Starting Corner for the surface
The rectangular surfaces specify the lower left corner of the surface for their starting
coordinate. This is specified with (x,y,z) and can be relative to the zone origin or in world
coordinates, depending on the value for rectangular surfaces specified in the
GlobalGeometryRules object.
Field: Starting X Coordinate
This field is the X coordinate (in meters).
Field: Starting Y Coordinate
This field is the Y coordinate (in meters).
Field: Starting Z Coordinate
This field is the Z coordinate (in meters).

9/29/14

187

Input-Output Reference

Group Thermal Zone Description/Geometry

Field: Length
This field is the length of the roof in meters.
Field: Width
This field is the width of the roof in meters.
Ceiling:Adiabatic
The Ceiling:Adiabatic object is used to describe interior ceilings that separate zones of like
conditions.
Field: Name
This is a unique name associated with the ceiling. It is used in several other places as a
reference (e.g. as the base surface name for a Window or Door).
Field: Construction Name
This is the name of the construction (ref: Construction object) used in the surface. Regardless
of location in the building, the full construction (all layers) is used. For example, for an
interior wall separating two zones, zone x would have the outside layer (e.g. drywall) as the
material that shows in zone y and then the layers to the inside layer the material that shows
in zone x. For symmetric constructions, the same construction can be used in the surfaces
described in both zones.
Field: Zone Name
This is the zone name to which the surface belongs.
Field: Azimuth Angle
The Azimuth Angle indicates the direction of the outward normal for the roof. The angle is
specified in degrees where East=90, South=180, West=270, North=0.
Field: Tilt Angle
The tilt angle is the angle (in degrees) that the wall is tilted from horizontal (or the ground).
Flat ceilings are tilted 0 degrees and that is the default for this field.
Starting Corner for the surface
The rectangular surfaces specify the lower left corner of the surface for their starting
coordinate. This is specified with (x,y,z) and can be relative to the zone origin or in world
coordinates, depending on the value for rectangular surfaces specified in the
GlobalGeometryRules object.
Field: Starting X Coordinate
This field is the X coordinate (in meters).
Field: Starting Y Coordinate
This field is the Y coordinate (in meters).
Field: Starting Z Coordinate
This field is the Z coordinate (in meters).
Field: Length
This field is the length of the ceiling in meters.
Field: Width
This field is the width of the ceiling in meters.

9/29/14

188

Input-Output Reference

Group Thermal Zone Description/Geometry

Ceiling:Interzone
The Ceiling:Interzone object is used to describe interior ceilings that separate zones of
differing conditions (and expect heat transfer through the ceiling from the adjacent zone).
Field: Name
This is a unique name associated with the interzone ceiling. It is used in several other places
as a reference (e.g. as the base surface name for a Window or Door).
Field: Construction Name
This is the name of the construction (ref: Construction object) used in the surface. Regardless
of location in the building, the full construction (all layers) is used. For example, for an
interior wall separating two zones, zone x would have the outside layer (e.g. drywall) as the
material that shows in zone y and then the layers to the inside layer the material that shows
in zone x. For symmetric constructions, the same construction can be used in the surfaces
described in both zones.
Field: Zone Name
This is the zone name to which the surface belongs.
Field: Outside Boundary Condition Object
The Outside Boundary Condition Object field is the name of a floor in an adjacent zone or the
name of the adjacent zone. If the adjacent zone option is used, the adjacent floor is
automatically generated in the adjacent zone. If the surface name is used, it must be in the
adjacent zone.
Field: Azimuth Angle
The Azimuth Angle indicates the direction of the outward normal for the roof. The angle is
specified in degrees where East=90, South=180, West=270, North=0.
Field: Tilt Angle
The tilt angle is the angle (in degrees) that the wall is tilted from horizontal (or the ground).
Flat ceilings are tilted 0 degrees and that is the default for this field.
Starting Corner for the surface
The rectangular surfaces specify the lower left corner of the surface for their starting
coordinate. This is specified with (x,y,z) and can be relative to the zone origin or in world
coordinates, depending on the value for rectangular surfaces specified in the
GlobalGeometryRules object.
Field: Starting X Coordinate
This field is the X coordinate (in meters).
Field: Starting Y Coordinate
This field is the Y coordinate (in meters).
Field: Starting Z Coordinate
This field is the Z coordinate (in meters).
Field: Length
This field is the length of the ceiling in meters.
Field: Width
This field is the width of the ceiling in meters.

9/29/14

189

Input-Output Reference

Group Thermal Zone Description/Geometry

Floors
Floors are, by default, flat (tilt = 180 degrees). These objects are used to describe floors on
the ground, interior floors (adiabatic) and floors adjacent to other zones.
Floor:GroundContact
The Floor:GroundContact object is used to describe floors that have ground contact (usually
called slabs). The temperature at the outside of the floor is the temperature in the
GroundTemperature:BuildingSurface object.
Field: Name
This is a unique name associated with the floor.
Field: Construction Name
This is the name of the construction (ref: Construction object) used in the surface. Regardless
of location in the building, the full construction (all layers) is used. For example, for an
interior wall separating two zones, zone x would have the outside layer (e.g. drywall) as the
material that shows in zone y and then the layers to the inside layer the material that shows
in zone x. For symmetric constructions, the same construction can be used in the surfaces
described in both zones. Note that if the construction is Construction:FfactorGroundFloor,
then the GroundFCfactorMethod will be used with this floor.
Field: Zone Name
This is the zone name to which the surface belongs.
Field: Azimuth Angle
The Azimuth Angle indicates the direction of the outward normal for the roof. The angle is
specified in degrees where East=90, South=180, West=270, North=0.
Field: Tilt Angle
The tilt angle is the angle (in degrees) that the wall is tilted from horizontal (or the ground).
Flat floors are tilted 180 degrees and that is the default for this field.
Starting Corner for the surface
The rectangular surfaces specify the lower left corner of the surface for their starting
coordinate. This is specified with (x,y,z) and can be relative to the zone origin or in world
coordinates, depending on the value for rectangular surfaces specified in the
GlobalGeometryRules object.
Field: Starting X Coordinate
This field is the X coordinate (in meters).
Field: Starting Y Coordinate
This field is the Y coordinate (in meters).
Field: Starting Z Coordinate
This field is the Z coordinate (in meters).
Field: Length
This field is the length of the floor in meters.
Field: Width
This field is the width of the floor in meters.

9/29/14

190

Input-Output Reference

Group Thermal Zone Description/Geometry

Floor:Adiabatic
The Floor:Adiabatict object is used to describe interior floors or floors that you wish to model
with no heat transfer from the exterior to the floor.
Field: Name
This is a unique name associated with the floor.
Field: Construction Name
This is the name of the construction (ref: Construction object) used in the surface. Regardless
of location in the building, the full construction (all layers) is used. For example, for an
interior wall separating two zones, zone x would have the outside layer (e.g. drywall) as the
material that shows in zone y and then the layers to the inside layer the material that shows
in zone x. For symmetric constructions, the same construction can be used in the surfaces
described in both zones.
Field: Zone Name
This is the zone name to which the surface belongs.
Field: Azimuth Angle
The Azimuth Angle indicates the direction of the outward normal for the roof. The angle is
specified in degrees where East=90, South=180, West=270, North=0.
Field: Tilt Angle
The tilt angle is the angle (in degrees) that the wall is tilted from horizontal (or the ground).
Flat floors are tilted 180 degrees and that is the default for this field.
Starting Corner for the surface
The rectangular surfaces specify the lower left corner of the surface for their starting
coordinate. This is specified with (x,y,z) and can be relative to the zone origin or in world
coordinates, depending on the value for rectangular surfaces specified in the
GlobalGeometryRules object.
Field: Starting X Coordinate
This field is the X coordinate (in meters).
Field: Starting Y Coordinate
This field is the Y coordinate (in meters).
Field: Starting Z Coordinate
This field is the Z coordinate (in meters).
Field: Length
This field is the length of the floor in meters.
Field: Width
This field is the width of the floor in meters.
Floor:Interzone
The Floor:Interzone object is used to describe floors that are adjacent to other zones that
have differing conditions and you wish to model the heat transfer through the floor.
Field: Name
This is a unique name associated with the floor.

9/29/14

191

Input-Output Reference

Group Thermal Zone Description/Geometry

Field: Construction Name

This is the name of the construction (ref: Construction object) used in the surface. Regardless
of location in the building, the full construction (all layers) is used. For example, for an
interior wall separating two zones, zone x would have the outside layer (e.g. drywall) as the
material that shows in zone y and then the layers to the inside layer the material that shows
in zone x. For symmetric constructions, the same construction can be used in the surfaces
described in both zones.
Field: Zone Name
This is the zone name to which the surface belongs.
Field: Outside Boundary Condition Object
The Outside Boundary Condition Object field is the name of a ceiling in an adjacent zone or
the name of the adjacent zone. If the adjacent zone option is used, the adjacent ceiling is
automatically generated in the adjacent zone. If the surface name is used, it must be in the
adjacent zone.
Field: Azimuth Angle
The Azimuth Angle indicates the direction of the outward normal for the roof. The angle is
specified in degrees where East=90, South=180, West=270, North=0.
Field: Tilt Angle
The tilt angle is the angle (in degrees) that the wall is tilted from horizontal (or the ground).
Flat floors are tilted 180 degrees and that is the default for this field.
Starting Corner for the surface
The rectangular surfaces specify the lower left corner of the surface for their starting
coordinate. This is specified with (x,y,z) and can be relative to the zone origin or in world
coordinates, depending on the value for rectangular surfaces specified in the
GlobalGeometryRules object.
Field: Starting X Coordinate
This field is the X coordinate (in meters).
Field: Starting Y Coordinate
This field is the Y coordinate (in meters).
Field: Starting Z Coordinate
This field is the Z coordinate (in meters).
Field: Length
This field is the length of the floor in meters.
Field: Width
This field is the width of the floor in meters.
Windows/Doors
The following window and door objects can be used to specify simple, rectangular doors and
windows. In each case, the lower left corner (locator coordinate) of the window or door is
specified relative to the surface it is on. Viewing the base surface as a planar surface, base
the relative location from the lower left corner of the base surface. Vertex entry description as
well as provisions for a few other surface types can be entered with the
FenestrationSurface:Detailed object.

9/29/14

192

Input-Output Reference

Group Thermal Zone Description/Geometry

Window
The Window object is used to place windows on surfaces that can have windows, including
exterior walls, interior walls, interzone walls, roofs, floors that are exposed to outdoor
conditions, interzone ceiling/floors. These, of course, can be entered using the simple
rectangular objects or the more detailed vertex entry objects.
Field: Name
This is a unique name associated with the window.
Field: Construction Name
This is the name of the subsurfaces construction (ref: objects: Construction,
Construction:WindowDataFile, Construction:CompexFenestrationState).
For windows, if Construction Name is not found among the constructions on the input (.idf)
file, the Window Data File (ref. Construction:WindowDataFile object) will be searched for that
Construction Name (see Importing Windows from WINDOW). If that file is not present or if
the Construction Name does not match the name of an entry on the file, an error will result. If
there is a match, a window construction and its corresponding glass and gas materials will be
created from the information read from the file.
Field: Building Surface Name
This is the name of a surface that contains this subsurface. Certain kinds of surfaces may not
be allowed to have subsurfaces. For example, a surface in contact with the ground (e.g.,
Outside Boundary Condition = Ground) cannot contain a window. The window assumes the
outward facing angle as well as the tilt angle of the base surface.
Field: Shading Control Name
This field, if not blank, is the name of the window shading control (ref:
WindowProperty:ShadingControl object) for this subsurface. It is used for Surface Type =
Window and GlassDoor. To assign a shade to a window or glass door, see WindowMaterial:
Shade. To assign a screen, see WindowMaterial:Screen. To assign a blind, see
WindowMaterial:Blind. To assign switchable glazing, such as electrochromic glazing, see
WindowProperty:ShadingControl.
Field: Frame and Divider Name
This field, if not blank, can be used to specify window frame, divider and reveal-surface data
(ref: WindowProperty:FrameAndDivider object). It is used only for exterior GlassDoors and
rectangular exterior Windows, i.e., those with OutsideFaceEnvironment = Outdoors.
This field should be blank for triangular windows.
Field: Multiplier
This field is the number of identical items on the base surface. Using Multiplier can save input
effort and calculation time. In the calculation the area (and area of frame and divider, if
present and surface type is a window) is multiplied by Multiplier. The calculation of shadowing
on the subsurfaces (and the calculation of the interior distribution of beam solar radiation
transmitted by windows and glass doors) are done for the specified subsurface position and
dimensions.
Multiplier should be used with caution. Multiplier > 1 can give inaccurate or nonsensical
results in situations where the results are sensitive to window or glass door position. This
includes shadowing on the window/glass door, daylighting from the window/glass door, and
interior distribution of solar radiation from the window/glass door. In these cases, the results
for the single input window/glass door, after multiplication, may not be representative of the
results you would get if you entered each of the multiple subsurfaces separately.
If Multiplier > 1, you will get

9/29/14

193

Input-Output Reference

Group Thermal Zone Description/Geometry

--a warning if Solar Distribution = FullExterior or FullInteriorAndExterior (ref: Building - Field:

Solar Distribution), indicating that the shadowing on the input window or the interior solar
radiation distribution from the input window may not be representative of the actual group of
windows. No warning is issued if Solar Distribution = MinimalShadowing.
--an error if the window is an exterior window/glass door in a zone that has a detailed
daylighting calculation (Daylighting:Detailed specified for the zone). Since a single window
with a multiplier can never give the same daylight illuminance as the actual set of windows,
you are not allowed to use Multiplier in this situation.
Starting Corner for the surface
The rectangular subsurfaces specify the lower left corner of the surface for their starting
coordinate. This corner is specifed relative to the lower left corner of the base surface by
specifying the X and Z values from that corner.
Field: Starting X Coordinate
This field is the X coordinate (in meters).
Field: Starting Z Coordinate
This field is the Z coordinate (in meters).
Field: Length
This field is the length of the window in meters.
Field: Height
This field is the height of the window in meters.
Door
The Door object is used to place opaque doors on surfaces that can have doors, including
exterior walls, interior walls, interzone walls, roofs, floors that are exposed to outdoor
conditions, interzone ceiling/floors. These, of course, can be entered using the simple
rectangular objects or the more detailed vertex entry objects.
Field: Name
This is a unique name associated with the door.
Field: Construction Name
This is the name of the subsurfaces construction (ref: Construction object)
Field: Building Surface Name
This is the name of a surface that contains this subsurface. Certain kinds of surfaces may not
be allowed to have subsurfaces. The door assumes the outward facing angle as well as the
tilt angle of the base surface.
Field: Multiplier
This field is the number of identical items on the base surface. Using Multiplier can save input
effort and calculation time. In the calculation the area (and area of frame and divider, if
present and surface type is a window) is multiplied by Multiplier. The calculation of shadowing
on the subsurfaces (and the calculation of the interior distribution of beam solar radiation
transmitted by windows and glass doors) are done for the specified subsurface position and
dimensions.
Multiplier should be used with caution. Multiplier > 1 can give inaccurate or nonsensical
results in situations where the results are sensitive to window or glass door position. This
includes shadowing on the window/glass door, daylighting from the window/glass door, and
interior distribution of solar radiation from the window/glass door. In these cases, the results
9/29/14

194

Input-Output Reference

Group Thermal Zone Description/Geometry

for the single input window/glass door, after multiplication, may not be representative of the
results you would get if you entered each of the multiple subsurfaces separately.
If Multiplier > 1, you will get
--a warning if Solar Distribution = FullExterior or FullInteriorAndExterior (ref: Building - Field:
Solar Distribution), indicating that the shadowing on the input window or the interior solar
radiation distribution from the input window may not be representative of the actual group of
windows. No warning is issued if Solar Distribution = MinimalShadowing.
--an error if the window is an exterior window/glass door in a zone that has a detailed
daylighting calculation (Daylighting:Detailed specified for the zone). Since a single window
with a multiplier can never give the same daylight illuminance as the actual set of windows,
you are not allowed to use Multiplier in this situation.
Starting Corner for the surface
The rectangular subsurfaces specify the lower left corner of the surface for their starting
coordinate. This corner is specifed relative to the lower left corner of the base surface by
specifying the X and Z values from that corner.
Field: Starting X Coordinate
This field is the X coordinate (in meters).
Field: Starting Z Coordinate
This field is the Z coordinate (in meters).
Field: Length
This field is the length of the door in meters.
Field: Height
This field is the height of the door in meters.
GlazedDoor
The GlazedDoor object is used to place doors on surfaces that can have doors, including
exterior walls, interior walls, interzone walls, roofs, floors that are exposed to outdoor
conditions, interzone ceiling/floors. These, of course, can be entered using the simple
rectangular objects or the more detailed vertex entry objects.
Field: Name
This is a unique name associated with the glass door.
Field: Construction Name
This is the name of the subsurfaces construction (ref: objects: Construction,
Construction:WindowDataFile, Construction:CompexFenestrationState).
For windows, if Construction Name is not found among the constructions on the input (.idf)
file, the Window Data File (ref. Construction:WindowDataFile object) will be searched for that
Construction Name (see Importing Windows from WINDOW). If that file is not present or if
the Construction Name does not match the name of an entry on the file, an error will result. If
there is a match, a window construction and its corresponding glass and gas materials will be
created from the information read from the file.
Field: Building Surface Name
This is the name of a surface that contains this subsurface. Certain kinds of surfaces may not
be allowed to have subsurfaces. For example, a surface in contact with the ground (Outside
Boundary Condition = Ground) cannot contain a window. The door assumes the outward
facing angle as well as the tilt angle of the base surface.

9/29/14

195

Input-Output Reference

Group Thermal Zone Description/Geometry

Field: Shading Control Name

This field, if not blank, is the name of the window shading control (ref:
WindowProperty:ShadingControl object) for this subsurface. It is used for Surface Type =
Window and GlassDoor. To assign a shade to a window or glass door, see WindowMaterial:
Shade. To assign a screen, see WindowMaterial:Screen. To assign a blind, see
WindowMaterial:Blind. To assign switchable glazing, such as electrochromic glazing, see
WindowProperty:ShadingControl.
Field: Frame and Divider Name
This field, if not blank, can be used to specify window frame, divider and reveal-surface data
(ref: WindowProperty:FrameAndDivider object). It is used only for exterior GlassDoors and
rectangular exterior Windows, i.e., those with OutsideFaceEnvironment = Outdoors.
This field should be blank for triangular windows.
Field: Multiplier
This field is the number of identical items on the base surface. Using Multiplier can save input
effort and calculation time. In the calculation the area (and area of frame and divider, if
present and surface type is a window) is multiplied by Multiplier. The calculation of shadowing
on the subsurfaces (and the calculation of the interior distribution of beam solar radiation
transmitted by windows and glass doors) are done for the specified subsurface position and
dimensions.
Multiplier should be used with caution. Multiplier > 1 can give inaccurate or nonsensical
results in situations where the results are sensitive to window or glass door position. This
includes shadowing on the window/glass door, daylighting from the window/glass door, and
interior distribution of solar radiation from the window/glass door. In these cases, the results
for the single input window/glass door, after multiplication, may not be representative of the
results you would get if you entered each of the multiple subsurfaces separately.
If Multiplier > 1, you will get
--a warning if Solar Distribution = FullExterior or FullInteriorAndExterior (ref: Building - Field:
Solar Distribution), indicating that the shadowing on the input window or the interior solar
radiation distribution from the input window may not be representative of the actual group of
windows. No warning is issued if Solar Distribution = MinimalShadowing.
--an error if the window is an exterior window/glass door in a zone that has a detailed
daylighting calculation (Daylighting:Detailed specified for the zone). Since a single window
with a multiplier can never give the same daylight illuminance as the actual set of windows,
you are not allowed to use Multiplier in this situation.
Starting Corner for the surface
The rectangular subsurfaces specify the lower left corner of the surface for their starting
coordinate. This corner is specifed relative to the lower left corner of the base surface by
specifying the X and Z values from that corner.
Field: Starting X Coordinate
This field is the X coordinate (in meters).
Field: Starting Z Coordinate
This field is the Z coordinate (in meters).
Field: Length
This field is the length of the door in meters.
Field: Height
This field is the height of the door in meters.
9/29/14

196

Input-Output Reference

Group Thermal Zone Description/Geometry

Window:Interzone
The Window:Interzone object is used to place windows on surfaces that can have windows,
including interzone walls, interzone ceiling/floors. These, of course, can be entered using the
simple rectangular objects or the more detailed vertex entry objects.
Field: Name
This is a unique name associated with the window.
Field: Construction Name
This is the name of the subsurfaces construction (ref: objects: Construction,
Construction:WindowDataFile, Construction:CompexFenestrationState).
For windows, if Construction Name is not found among the constructions on the input (.idf)
file, the Window Data File (ref. Construction:WindowDataFile object) will be searched for that
Construction Name (see Importing Windows from WINDOW). If that file is not present or if
the Construction Name does not match the name of an entry on the file, an error will result. If
there is a match, a window construction and its corresponding glass and gas materials will be
created from the information read from the file.
Field: Building Surface Name
This is the name of a surface that contains this subsurface. Certain kinds of surfaces may not
be allowed to have subsurfaces. For example, a surface in contact with the ground (Outside
Boundary Condition = Ground) cannot contain a window. The window assumes the outward
facing angle as well as the tilt angle of the base surface.
Field: Outside Boundary Condition Object
The Outside Boundary Condition Object field is the name of a window in an adjacent zone or
the name of the adjacent zone. If the adjacent zone option is used, the adjacent ceiling is
automatically generated in the adjacent zone. If the surface name is used, it must be in the
adjacent zone.
Field: Multiplier
This field is the number of identical items on the base surface. Using Multiplier can save input
effort and calculation time. In the calculation the area (and area of frame and divider, if
present and surface type is a window) is multiplied by Multiplier. The calculation of shadowing
on the subsurfaces (and the calculation of the interior distribution of beam solar radiation
transmitted by windows and glass doors) are done for the specified subsurface position and
dimensions.
Multiplier should be used with caution. Multiplier > 1 can give inaccurate or nonsensical
results in situations where the results are sensitive to window or glass door position. This
includes shadowing on the window/glass door, daylighting from the window/glass door, and
interior distribution of solar radiation from the window/glass door. In these cases, the results
for the single input window/glass door, after multiplication, may not be representative of the
results you would get if you entered each of the multiple subsurfaces separately.
If Multiplier > 1, you will get
--a warning if Solar Distribution = FullExterior or FullInteriorAndExterior (ref: Building - Field:
Solar Distribution), indicating that the shadowing on the input window or the interior solar
radiation distribution from the input window may not be representative of the actual group of
windows. No warning is issued if Solar Distribution = MinimalShadowing.
--an error if the window is an exterior window/glass door in a zone that has a detailed
daylighting calculation (Daylighting:Detailed specified for the zone). Since a single window
with a multiplier can never give the same daylight illuminance as the actual set of windows,
you are not allowed to use Multiplier in this situation.

9/29/14

197

Input-Output Reference

Group Thermal Zone Description/Geometry

Starting Corner for the surface

The rectangular subsurfaces specify the lower left corner of the surface for their starting
coordinate. This corner is specifed relative to the lower left corner of the base surface by
specifying the X and Z values from that corner.
Field: Starting X Coordinate
This field is the X coordinate (in meters).
Field: Starting Z Coordinate
This field is the Z coordinate (in meters).
Field: Length
This field is the length of the window in meters.
Field: Height
This field is the height of the window in meters.
Door:Interzone
The Door:Interzone object is used to place opaque doors on surfaces that can have doors,
including interzone walls, interzone ceiling/floors. These, of course, can be entered using the
simple rectangular objects or the more detailed vertex entry objects.
Field: Name
This is a unique name associated with the door.
Field: Construction Name
This is the name of the subsurfaces construction (ref: Construction object).
Field: Building Surface Name
This is the name of a surface that contains this subsurface. Certain kinds of surfaces may not
be allowed to have subsurfaces. The door assumes the outward facing angle as well as the
tilt angle of the base surface.
Field: Outside Boundary Condition Object
The Outside Boundary Condition Object field is the name of a door in an adjacent zone or the
name of the adjacent zone. If the adjacent zone option is used, the adjacent ceiling is
automatically generated in the adjacent zone. If the surface name is used, it must be in the
adjacent zone.
Field: Multiplier
This field is the number of identical items on the base surface. Using Multiplier can save input
effort and calculation time. In the calculation the area (and area of frame and divider, if
present and surface type is a window) is multiplied by Multiplier. The calculation of shadowing
on the subsurfaces (and the calculation of the interior distribution of beam solar radiation
transmitted by windows and glass doors) are done for the specified subsurface position and
dimensions.
Multiplier should be used with caution. Multiplier > 1 can give inaccurate or nonsensical
results in situations where the results are sensitive to window or glass door position. This
includes shadowing on the window/glass door, daylighting from the window/glass door, and
interior distribution of solar radiation from the window/glass door. In these cases, the results
for the single input window/glass door, after multiplication, may not be representative of the
results you would get if you entered each of the multiple subsurfaces separately.
If Multiplier > 1, you will get

9/29/14

198

Input-Output Reference

Group Thermal Zone Description/Geometry

--a warning if Solar Distribution = FullExterior or FullInteriorAndExterior (ref: Building - Field:

Solar Distribution), indicating that the shadowing on the input window or the interior solar
radiation distribution from the input window may not be representative of the actual group of
windows. No warning is issued if Solar Distribution = MinimalShadowing.
--an error if the window is an exterior window/glass door in a zone that has a detailed
daylighting calculation (Daylighting:Detailed specified for the zone). Since a single window
with a multiplier can never give the same daylight illuminance as the actual set of windows,
you are not allowed to use Multiplier in this situation.
Starting Corner for the surface
The rectangular subsurfaces specify the lower left corner of the surface for their starting
coordinate. This corner is specifed relative to the lower left corner of the base surface by
specifying the X and Z values from that corner.
Field: Starting X Coordinate
This field is the X coordinate (in meters).
Field: Starting Z Coordinate
This field is the Z coordinate (in meters).
Field: Length
This field is the length of the door in meters.
Field: Height
This field is the height of the door in meters.
GlazedDoor:Interzone
The GlazedDoor:Interzone object is used to place doors on surfaces that can have doors,
including interzone walls, interzone ceiling/floors. These, of course, can be entered using the
simple rectangular objects or the more detailed vertex entry objects.
Field: Name
This is a unique name associated with the glass door.
Field: Construction Name
This is the name of the subsurfaces construction (ref: objects: Construction,
Construction:WindowDataFile, Construction:ComplexFenestrationState).
For windows, if Construction Name is not found among the constructions on the input (.idf)
file, the Window Data File (ref. Construction:WindowDataFile object) will be searched for that
Construction Name (see Importing Windows from WINDOW). If that file is not present or if
the Construction Name does not match the name of an entry on the file, an error will result. If
there is a match, a window construction and its corresponding glass and gas materials will be
created from the information read from the file.
Field: Building Surface Name
This is the name of a surface that contains this subsurface. Certain kinds of surfaces may not
be allowed to have subsurfaces. For example, a surface in contact with the ground (Outside
Boundary Condition = Ground) cannot contain a window. The door assumes the outward
facing angle as well as the tilt angle of the base surface.
Field: Outside Boundary Condition Object
The Outside Boundary Condition Object field is the name of a glazed (glass) door in an
adjacent zone or the name of the adjacent zone. If the adjacent zone option is used, the

9/29/14

199

Input-Output Reference

Group Thermal Zone Description/Geometry

adjacent ceiling is automatically generated in the adjacent zone. If the surface name is used,
it must be in the adjacent zone.
Field: Multiplier
This field is the number of identical items on the base surface. Using Multiplier can save input
effort and calculation time. In the calculation the area (and area of frame and divider, if
present and surface type is a window) is multiplied by Multiplier. The calculation of shadowing
on the subsurfaces (and the calculation of the interior distribution of beam solar radiation
transmitted by windows and glass doors) are done for the specified subsurface position and
dimensions.
Multiplier should be used with caution. Multiplier > 1 can give inaccurate or nonsensical
results in situations where the results are sensitive to window or glass door position. This
includes shadowing on the window/glass door, daylighting from the window/glass door, and
interior distribution of solar radiation from the window/glass door. In these cases, the results
for the single input window/glass door, after multiplication, may not be representative of the
results you would get if you entered each of the multiple subsurfaces separately.
If Multiplier > 1, you will get
--a warning if Solar Distribution = FullExterior or FullInteriorAndExterior (ref: Building - Field:
Solar Distribution), indicating that the shadowing on the input window or the interior solar
radiation distribution from the input window may not be representative of the actual group of
windows. No warning is issued if Solar Distribution = MinimalShadowing.
--an error if the window is an exterior window/glass door in a zone that has a detailed
daylighting calculation (Daylighting:Detailed specified for the zone). Since a single window
with a multiplier can never give the same daylight illuminance as the actual set of windows,
you are not allowed to use Multiplier in this situation.
Starting Corner for the surface
The rectangular subsurfaces specify the lower left corner of the surface for their starting
coordinate. This corner is specifed relative to the lower left corner of the base surface by
specifying the X and Z values from that corner.
Field: Starting X Coordinate
This field is the X coordinate (in meters).
Field: Starting Z Coordinate
This field is the Z coordinate (in meters).
Field: Length
This field is the length of the door in meters.
Field: Height
This field is the height of the door in meters.
Examples of the rectangular surfaces are found in the example
4ZoneWithShading_Simple_1.idf and 4ZoneWithShading_Simple_2. Some examples:
Wall:Exterior,
Zn001:Wall001,
EXTERIOR,
ZONE 1,
180,
90,
0,
0,
0,
20,
10;
9/29/14

!!!!!!!!!!-

files

Name
Construction Name
Zone Name
Azimuth Angle {deg}
Tilt Angle {deg}
Starting X Coordinate {m}
Starting Y Coordinate {m}
Starting Z Coordinate {m}
Length {m}
Height {m}
200

Input-Output Reference

Window,
Zn001:Wall001:Win001,
SINGLE PANE HW WINDOW,
Zn001:Wall001,
,
,
1,
4,
3,
3,
5;

!!!!!!!!!!-

Name
Construction Name
Building Surface Name
Shading Control Name
Frame and Divider Name
Multiplier
Starting X Coordinate {m}
Starting Z Coordinate {m}
Length {m}
Height {m}

!!!!!!!!-

Name
Construction Name
Building Surface Name
Multiplier
Starting X Coordinate {m}
Starting Z Coordinate {m}
Length {m}
Height {m}

!!!!!!!!!!-

Name
Construction Name
Zone Name
Azimuth Angle {deg}
Tilt Angle {deg}
Starting X Coordinate {m}
Starting Y Coordinate {m}
Starting Z Coordinate {m}
Length {m}
Height {m}

Floor:Adiabatic,
Zn001:Flr001,
FLOOR,
ZONE 1,
90,
180,
0,
0,
0,
20,
20;

!!!!!!!!!!-

Name
Construction Name
Zone Name
Azimuth Angle {deg}
Tilt Angle {deg}
Starting X Coordinate {m}
Starting Y Coordinate {m}
Starting Z Coordinate {m}
Length {m}
Width {m}

Ceiling:Interzone,
Zn001:Roof001,
CEILING34,
ZONE 1,
Zn003:Flr001,
180,
0,
0,
0,
10,
20,
20;

!!!!!!!!!!!-

Name
Construction Name
Zone Name
Outside Boundary Condition Object
Azimuth Angle {deg}
Tilt Angle {deg}
Starting X Coordinate {m}
Starting Y Coordinate {m}
Starting Z Coordinate {m}
Length {m}
Width {m}

Door,
Zn001:Wall001:Door001,
HOLLOW WOOD DOOR,
Zn001:Wall001,
1,
14,
0,
3,
5;
Wall:Adiabatic,
Zn001:Wall004,
INTERIOR,
ZONE 1,
90,
90,
20,
0,
0,
20,
10;

9/29/14

Group Thermal Zone Description/Geometry

201

Input-Output Reference
Window,
Zn002:Wall001:Win001,
SINGLE PANE HW WINDOW,
Zn002:Wall001,
,
,
1,
4,
3,
3,
5;

Group Thermal Zone Description/Geometry

!!!!!!!!!!-

Name
Construction Name
Building Surface Name
Shading Control Name
Frame and Divider Name
Multiplier
Starting X Coordinate {m}
Starting Z Coordinate {m}
Length {m}
Height {m}

Surface Vertices
Each of the following surfaces:
BuildingSurface:Detailed
Wall:Detailed
RoofCeiling:Detailed
Floor:Detailed
FenstrationSurface:Detailed
Shading:Site:Detailed
Shading:Building:Detailed
Shading:Zone:Detailed
use the same vertex input. The numeric parameters indicated below are taken from the
BuildingSurface:Detailed definition; the others may not be exactly the same but are identical
in configuration. They are also extensible so, if you want more vertices for these surfaces,
you may add to the IDD definition as indicated in the extensible comment or, as EnergyPlus
is auto-extensible just add the number of vertices into your input file.. Note that
FenestrationSurface:Detailed is not extensible and is limited to 4 (max) vertices. If you leave
the Number of Surface Vertex groups blank or enter autocalculate, EnergyPlus looks at the
number of groups entered and figures out how many coordinate groups are entered.
Note that the resolution on the surface vertex input is 1 millimeter (.001 meter). Therefore, using
vertices that are very close together (<1 mm) may result in invalid dot product and fatal errors
during shading calculations.

9/29/14

202

Input-Output Reference

Group Thermal Zone Description/Geometry

Figure 29. Illustration for Surface Vertices

The figure above will help illustrate Surface Vertex entry. The convention used in
GlobalGeometryRules dictates the order of the vertices (ref: GlobalGeometryRules). In this
example, the conventions used are Starting Vertex Position = UpperLeftCorner and Vertex
Entry Direction= CounterClockwise. The surfaces for this single zone are:
4,0,0,H, 0,0,0, A,0,0, A,0,H; ! (4 vertices, South Wall)
4,A,0,H,A,0,0,A,B,0,A,B,H; ! (4 vertices, East Wall)
ignore other walls that are not shown in this figure
4,C,0,J,A,0,H,A,B,H,C,B,J; ! (4 vertices, roof)
3,C,0,J,0,0,H,A,0,H; ! (3 vertices, gable end)
4,0,0,H, 0,0,0, A,0,0, A,0,H; ! (4 vertices, South Wall)

Note that in this example, point 1 of the entry is the Upper Left Corner of the rectangular
surfaces and the point of the triangle for the 3 sided surface. The east wall shows the order of
vertex entry. For horizontal surfaces, any vertex may be chosen as the starting position, but
the Vertex Entry Direction convention must be followed. The surface details report (Output:
Surfaces:List, Details;) is very useful for reviewing the accuracy of surface geometry inputs
(ref: Surface Output Variables/Reports and Variable Dictionary Reports).
From the detailed vertices, EnergyPlus tries to determine the height and width of the
surface. Obviously, this doesnt work well for >4 sided surfaces; for these, if the calculated
height and width are not close to the gross area for the surface, the height and width shown
will be the square root of the area (and thus a square).
Building Surfaces - Detailed
A building surface is necessary for all calculations. There must be at least one building
surface per zone. You can use the detailed descriptions as shown below or the simpler,
rectangular surface descriptions shown earlier.
Wall:Detailed
The Wall:Detailed object is used to describe walls.
Field: Name
This is a unique name associated with each building surface. It is used in several other
places as a reference (e.g. as the base surface name for a Window or Door).

9/29/14

203

Input-Output Reference

Group Thermal Zone Description/Geometry

Field: Construction Name

This is the name of the construction (ref: Construction object) used in the surface. Regardless
of location in the building, the full construction (all layers) is used. For example, for an
interior wall separating two zones, zone x would have the outside layer (e.g. drywall) as the
material that shows in zone y and then the layers to the inside layer the material that shows
in zone x. For symmetric constructions, the same construction can be used in the surfaces
described in both zones.
Field: Zone Name
This is the zone name to which the surface belongs.
Field: Outside Boundary Condition
This value can be one of several things depending on the actual kind of surface.
1) Surface if this surface is an internal surface, then this is the choice. The value will
either be a surface in the base zone or a surface in another zone. The heat balance
between two zones can be accurately simulated by specifying a surface in an adjacent
zone. EnergyPlus will simulate a group of zones simultaneously and will include the heat
transfer between zones. However, as this increases the complexity of the calculations, it
is not necessary to specify the other zone unless the two zones will have a significant
temperature difference. If the two zones will not be very different (temperature wise), then
the surface should use itself as the outside environment or specify this field as Adiabatic.
The surface name on the outside of this surface (adjacent to) is placed in the next field.
2) Adiabatic an internal surface in the same Zone. This surface will not transfer heat out
of the zone, but will still store heat in thermal mass. Only the inside face of the surface
will exchange heat with the zone (i.e. two adiabatic surfaces are required to model
internal partitions where both sides of the surface are exchanging heat with the zone).
The Outside Boundary Condition Object can be left blank.
3) Zone this is similar to Surface but EnergyPlus will automatically create the required
surface in the adjacent zone when this is entered for the surface. If there are windows or
doors on the surface, EnergyPlus automatically creates appropriate sub-surfaces as well.
4) Outdoors if this surface is exposed to outside temperature conditions, then this is the
choice. See Sun Exposure and Wind Exposure below for further specifications on this
kind of surface.
5) Ground if this surface is exposed to the ground, then this is the usual choice. The
temperature on the outside of this surface will be the Site:GroundTemperature:Surface
value for the month. For more information on ground contact surfaces, reference the
Auxiliary Programs document section on Ground Heat Transfer in EnergyPlus.
6) GroundFCfactorMethod if this surface is exposed to the ground and using the
Construction:CfactorUndergroundWall, then this is the choice. The temperature on
the outside of this surface will be the Site:GroundTemperature:FcfactorMethod value for
the month.
7) OtherSideCoefficients if this surface has a custom, user specified temperature or
other parameters (See SurfaceProperty:OtherSideCoefficients specification), then this is
the choice. The outside boundary condition will be the name of the
SurfaceProperty:OtherSideCoefficients specification.
8) OtherSideConditionsModel if this surface has a specially-modeled multi-skin
component, such as a transpired collector or vented photovoltaic panel, attached to the
outside (See SurfaceProperty:OtherSideConditionsModel specification), then this the
choice.
The
outside
face
environment
will
be
the
name
of
the
SurfaceProperty:OtherSideConditionsModelspecification.
9) GroundSlabPreprocessorAverage uses the average results from the Slab
preprocessor calculations.

9/29/14

204

Input-Output Reference

Group Thermal Zone Description/Geometry

10) GroundSlabPreprocessorCore uses the core results from the Slab preprocessor
calculations.
11) GroundSlabPreprocessorPerimeter uses the perimeter results from the Slab
preprocessor calculations.
12) GroundBasementPreprocessorAverageWall uses the average wall results from the
Basement preprocessor calculations.
13) GroundBasementPreprocessorAverageFloor uses the average floor results from the
Basement preprocessor calculations.
14) GroundBasementPreprocessorUpperWall uses the upper wall results from the
Basement preprocessor calculations.
15) GroundBasementPreprocessorLowerWall uses the lower wall results from the
Basement preprocessor calculations.
Field: Outside Boundary Condition Object
If neither Surface, OtherSideCoefficients, or OtherSideConditionsModel are specified for the
Outside Boundary Condition (previous field), then this field should be left blank.
As stated above, if the Outside Boundary Condition is Surface, then this fields value must
be the surface name whose inside face temperature will be forced on the outside face of the
base surface. This permits heat exchange between adjacent zones (interzone heat transfer)
when multiple zones are simulated, but can also be used to simulate middle zone behavior
without modeling the adjacent zones. This is done by specifying a surface within the zone.
For example, a middle floor zone can be modeled by making the floor the Outside Boundary
Condition Object for the ceiling, and the ceiling the Outside Boundary Condition Object for the
floor.
If the Outside Boundary Condition is Zone, then this field should contain the zone name of
the adjacent zone for the surface.
Note: Zones with interzone heat transfer are not adiabatic and the internal surfaces contribute to gains or
losses. Adiabatic surfaces are modeled by specifying the base surface itself in this field. Also, for
interzone heat transfer, both surfaces must be represented for example, if you want interzone heat
transfer to an attic space, the ceiling in the lower zone must have a surface object with the outside face
environment as the floor in the attic and, likewise, there must be a floor surface object in the attic that
references the ceiling surface name in the lower zone.

Equally, if the Outside Boundary Condition is OtherSideCoefficients, then this fields value
must be the SurfaceProperty:OtherSideCoefficients name. Or if the Outside Boundary
Condition is OtherSideConditionsModel then this fields value must be the
SurfaceProperty:OtherSideConditionsModel name.
Field: Sun Exposure
If the surface is exposed to the sun, then SunExposed should be entered in this field.
Otherwise, NoSun should be entered.
Note, a cantilevered floor could have Outdoors but NoSun exposure.
Field: Wind Exposure
If the surface is exposed to the Wind, then WindExposed should be entered in this field.
Otherwise, NoWind should be entered.
Note: When a surface is specified with NoWind, this has several implications. Within the
heat balance code, this surface will default to using the simple ASHRAE exterior convection
coefficient correlation with a zero wind speed. In addition, since the ASHRAE simple method
does not have a separate value for equivalent long wavelength radiation to the sky and
ground, using NoWind also eliminates long wavelength radiant exchange from the exterior
9/29/14

205

Input-Output Reference

Group Thermal Zone Description/Geometry

of the surface to both the sky and the ground. Thus, only simple convection takes place at the
exterior face of a surface specified with NoWind.
Field: View Factor to Ground
The fraction of the ground plane (assumed horizontal) that is visible from a heat-transfer
surface. It is used to calculate the diffuse solar radiation from the ground that is incident on
the surface.
For example, if there are no obstructions, a vertical surface sees half of the ground plane and
so View Factor to Ground = 0.5. A horizontal downward-facing surface sees the entire ground
plane, so View Factor to Ground = 1.0. A horizontal upward-facing surface (horizontal roof)
does not see the ground at all, so View Factor to Ground = 0.0.
Unused if reflections option in Solar Distribution field in Building object input unless a
DaylightingDevice:Shelf or DaylightingDevice:Tubular has been specified.
If you do not use the reflections option in the Solar Distribution field in your Building object
input, you are responsible for entering the View Factor to Ground for each heat-transfer
surface. Typical values for a surface that is not shadowed are obtained by the simple
equation:
View Factor to Ground = (1-cos(SurfTilt))/2
For example, this gives 0.5 for a wall of tilt 90. If the tilt of the wall changes, then the View
Factor to Ground must also change.
If you enter autocalculate in this field, EnergyPlus will automatically calculate the view factor
to ground based on the tilt of the surface.
If you do use the reflections option in the Solar Distribution field in your Building object
input, you do not have to enter View Factor to Ground values. In this case the program will
automatically calculate the value to use for each exterior surface taking into account solar
shadowing (including shadowing of the ground by the building) and reflections from
obstructions (ref: Building, Field: Solar Distribution).
However, if you do use the reflections option AND you are modeling a
DaylightingDevice:Shelf or DaylightingDevice:Tubular, then you still need to enter some
values of View Factor to Ground. For DaylightingDevice:Shelf you need to enter View Factor
to Ground for the window associated with the shelf. And for DaylightingDevice:Tubular you
need to enter the View Factor to Ground for the FenestrationSurface:Detailed corresponding
to the dome of the tubular device.
Note 1: The corresponding view factor to the sky for diffuse solar radiation is not a user input;
it is calculated within EnergyPlus based on surface orientation, sky solar radiance
distribution, and shadowing surfaces.
Note 2: The view factors to the sky and ground for thermal infrared (long-wave) radiation are
not user inputs; they are calculated within EnergyPlus based on surface tilt and shadowing
surfaces. Shadowing surfaces are considered to have the same emissivity and temperature
as the ground, so they are lumped together with the ground in calculating the ground IR view
factor.
Field: Number of Vertices
This field specifies the number of sides in the surface (number of X,Y,Z vertex groups). For
further information, see the discussion on Surface Vertices above.
RoofCeiling:Detailed
The RoofCeiling:Detailed object is used to describe walls.
Field: Name
This is a unique name associated with each building surface. It is used in several other
places as a reference (e.g. as the base surface name for a Window or Door).

9/29/14

206

Input-Output Reference

Group Thermal Zone Description/Geometry

Field: Construction Name

This is the name of the construction (ref: Construction object) used in the surface. Regardless
of location in the building, the full construction (all layers) is used. For example, for an
interior wall separating two zones, zone x would have the outside layer (e.g. drywall) as the
material that shows in zone y and then the layers to the inside layer the material that shows
in zone x. For symmetric constructions, the same construction can be used in the surfaces
described in both zones.
Field: Zone Name
This is the zone name to which the surface belongs.
Field: Outside Boundary Condition
This value can be one of several things depending on the actual kind of surface.
1) Surface if this surface is an internal surface, then this is the choice. The value will

either be a surface in the base zone or a surface in another zone. The heat balance
between two zones can be accurately simulated by specifying a surface in an adjacent
zone. EnergyPlus will simulate a group of zones simultaneously and will include the heat
transfer between zones. However, as this increases the complexity of the calculations, it
is not necessary to specify the other zone unless the two zones will have a significant
temperature difference. If the two zones will not be very different (temperature wise), then
the surface should use itself as the outside environment or specify this field as Adiabatic.
The surface name on the outside of this surface (adjacent to) is placed in the next field.
2) Adiabatic an internal surface in the same Zone. This surface will not transfer heat out
of the zone, but will still store heat in thermal mass. Only the inside face of the surface
will exchange heat with the zone (i.e. two adiabatic surfaces are required to model
internal partitions where both sides of the surface are exchanging heat with the zone).
The Outside Boundary Condition Object can be left blank.
3) Zone this is similar to Surface but EnergyPlus will automatically create the required

surface in the adjacent zone when this is entered for the surface. If there are windows or
doors on the surface, EnergyPlus automatically creates appropriate sub-surfaces as well.

4) Outdoors if this surface is exposed to outside temperature conditions, then this is the

choice. See Sun Exposure and Wind Exposure below for further specifications on this
kind of surface.

5) Ground if this surface is exposed to the ground, then this is the choice. The

temperature on the outside of this surface will be the Ground Temperature.

6) OtherSideCoefficients if this surface has a custom, user specified temperature or

other parameters (See SurfaceProperty:OtherSideCoefficients specification), then this is

the choice. The outside boundary condition will be the name of the
SurfaceProperty:OtherSideCoefficients specification.
7) OtherSideConditionsModel if this surface has a specially-modeled multi-skin
component, such as a transpired collector or vented photovoltaic panel, attached to the
outside (See SurfaceProperty:OtherSideConditionsModel specification), then this the
choice.
The
outside
face
environment
will
be
the
name
of
the
SurfaceProperty:OtherSideConditionsModelspecification.
8) GroundSlabPreprocessorAverage

uses the average results from the Slab

preprocessor calculations.

9) GroundSlabPreprocessorCore uses the core results from the Slab preprocessor

calculations.

10) GroundSlabPreprocessorPerimeter uses the perimeter results from the Slab

preprocessor calculations.

11) GroundBasementPreprocessorAverageWall uses the average wall results from the

Basement preprocessor calculations.

9/29/14

207

Input-Output Reference

Group Thermal Zone Description/Geometry

12) GroundBasementPreprocessorAverageFloor uses the average floor results from the

Basement preprocessor calculations.

13) GroundBasementPreprocessorUpperWall uses the upper wall results from the

Basement preprocessor calculations.

14) GroundBasementPreprocessorLowerWall uses the lower wall results from the

Basement preprocessor calculations.

Field: Outside Boundary Condition Object

If neither Surface, OtherSideCoefficients, or OtherSideConditionsModel are specified for the
Outside Boundary Condition (previous field), then this field should be left blank.
As stated above, if the Outside Boundary Condition is Surface, then this fields value must
be the surface name whose inside face temperature will be forced on the outside face of the
base surface. This permits heat exchange between adjacent zones (interzone heat transfer)
when multiple zones are simulated, but can also be used to simulate middle zone behavior
without modeling the adjacent zones. This is done by specifying a surface within the zone.
For example, a middle floor zone can be modeled by making the floor the Outside Boundary
Condition Object for the ceiling, and the ceiling the Outside Boundary Condition Object for the
floor.
If the Outside Boundary Condition is Zone, then this field should contain the zone name of
the adjacent zone for the surface.
Note: Zones with interzone heat transfer are not adiabatic and the internal surfaces contribute to gains or
losses. Adiabatic surfaces are modeled by specifying the base surface itself in this field. Also, for
interzone heat transfer, both surfaces must be represented for example, if you want interzone heat
transfer to an attic space, the ceiling in the lower zone must have a surface object with the outside face
environment as the floor in the attic and, likewise, there must be a floor surface object in the attic that
references the ceiling surface name in the lower zone.

Equally, if the Outside Boundary Condition is OtherSideCoefficients, then this fields value
must be the SurfaceProperty:OtherSideCoefficients name. Or if the Outside Boundary
Condition is OtherSideConditionsModel then this fields value must be the
SurfaceProperty:OtherSideConditionsModel name.
Field: Sun Exposure
If the surface is exposed to the sun, then SunExposed should be entered in this field.
Otherwise, NoSun should be entered.
Note, a cantilevered floor could have Outdoors but NoSun exposure.
Field: Wind Exposure
If the surface is exposed to the Wind, then WindExposed should be entered in this field.
Otherwise, NoWind should be entered.
Note: When a surface is specified with NoWind, this has several implications. Within the
heat balance code, this surface will default to using the simple ASHRAE exterior convection
coefficient correlation with a zero wind speed. In addition, since the ASHRAE simple method
does not have a separate value for equivalent long wavelength radiation to the sky and
ground, using NoWind also eliminates long wavelength radiant exchange from the exterior
of the surface to both the sky and the ground. Thus, only simple convection takes place at the
exterior face of a surface specified with NoWind.

9/29/14

208

Input-Output Reference

Group Thermal Zone Description/Geometry

Field: View Factor to Ground

The fraction of the ground plane (assumed horizontal) that is visible from a heat-transfer
surface. It is used to calculate the diffuse solar radiation from the ground that is incident on
the surface.
For example, if there are no obstructions, a vertical surface sees half of the ground plane and
so View Factor to Ground = 0.5. A horizontal downward-facing surface sees the entire ground
plane, so View Factor to Ground = 1.0. A horizontal upward-facing surface (horizontal roof)
does not see the ground at all, so View Factor to Ground = 0.0.
Unused if reflections option in Solar Distribution field in Building object input unless a
DaylightingDevice:Shelf or DaylightingDevice:Tubular has been specified.
If you do not use the reflections option in the Solar Distribution field in your Building object
input, you are responsible for entering the View Factor to Ground for each heat-transfer
surface. Typical values for a surface that is not shadowed are obtained by the simple
equation:
View Factor to Ground = (1-cos(SurfTilt))/2
For example, this gives 0.5 for a wall of tilt 90. If the tilt of the wall changes, then the View
Factor to Ground must also change.
If you enter autocalculate in this field, EnergyPlus will automatically calculate the view factor
to ground based on the tilt of the surface.
If you do use the reflections option in the Solar Distribution field in your Building object
input, you do not have to enter View Factor to Ground values. In this case the program will
automatically calculate the value to use for each exterior surface taking into account solar
shadowing (including shadowing of the ground by the building) and reflections from
obstructions (ref: Building, Field: Solar Distribution).
However, if you do use the reflections option AND you are modeling a
DaylightingDevice:Shelf or DaylightingDevice:Tubular, then you still need to enter some
values of View Factor to Ground. For DaylightingDevice:Shelf you need to enter View Factor
to Ground for the window associated with the shelf. And for DaylightingDevice:Tubular you
need to enter the View Factor to Ground for the FenestrationSurface:Detailed corresponding
to the dome of the tubular device.
Note 1: The corresponding view factor to the sky for diffuse solar radiation is not a user input;
it is calculated within EnergyPlus based on surface orientation, sky solar radiance
distribution, and shadowing surfaces.
Note 2: The view factors to the sky and ground for thermal infrared (long-wave) radiation are
not user inputs; they are calculated within EnergyPlus based on surface tilt and shadowing
surfaces. Shadowing surfaces are considered to have the same emissivity and temperature
as the ground, so they are lumped together with the ground in calculating the ground IR view
factor.
Field: Number of Vertices
This field specifies the number of sides in the surface (number of X,Y,Z vertex groups). For
further information, see the discussion on Surface Vertices above.
Floor:Detailed
The Floor:Detailed object is used to describe walls.
Field: Name
This is a unique name associated with each building surface. It is used in several other
places as a reference (e.g. as the base surface name for a Window or Door).

9/29/14

209

Input-Output Reference

Group Thermal Zone Description/Geometry

Field: Construction Name

This is the name of the construction (ref: Construction object) used in the surface. Regardless
of location in the building, the full construction (all layers) is used. For example, for an
interior wall separating two zones, zone x would have the outside layer (e.g. drywall) as the
material that shows in zone y and then the layers to the inside layer the material that shows
in zone x. For symmetric constructions, the same construction can be used in the surfaces
described in both zones.
Field: Zone Name
This is the zone name to which the surface belongs.
Field: Outside Boundary Condition
This value can be one of several things depending on the actual kind of surface.
1) Surface if this surface is an internal surface, then this is the choice. The value will

either be a surface in the base zone or a surface in another zone. The heat balance
between two zones can be accurately simulated by specifying a surface in an adjacent
zone. EnergyPlus will simulate a group of zones simultaneously and will include the heat
transfer between zones. However, as this increases the complexity of the calculations, it
is not necessary to specify the other zone unless the two zones will have a significant
temperature difference. If the two zones will not be very different (temperature wise), then
the surface should use itself as the outside environment or specify this field as Adiabatic.
The surface name on the outside of this surface (adjacent to) is placed in the next field.
2) Adiabatic an internal surface in the same Zone. This surface will not transfer heat out
of the zone, but will still store heat in thermal mass. Only the inside face of the surface
will exchange heat with the zone (i.e. two adiabatic surfaces are required to model
internal partitions where both sides of the surface are exchanging heat with the zone).
The Outside Boundary Condition Object can be left blank.
3) Zone this is similar to Surface but EnergyPlus will automatically create the required

surface in the adjacent zone when this is entered for the surface. If there are windows or
doors on the surface, EnergyPlus automatically creates appropriate sub-surfaces as well.

4) Outdoors if this surface is exposed to outside temperature conditions, then this is the

choice. See Sun Exposure and Wind Exposure below for further specifications on this
kind of surface.

5) Ground if this surface is exposed to the ground, then this is the usual choice. The

temperature on the outside of this surface will be the Site:GroundTemperature:Surface

value for the month. For more information on ground contact surfaces, reference the
Auxiliary Programs document section on Ground Heat Transfer in EnergyPlus.

6) GroundFCfactorMethod if this surface is exposed to the ground and using the

Construction:FfactorGroundFloor, then this is the choice. The temperature on the

outside of this surface will be the Site:GroundTemperature:FcfactorMethod value for the
month.

7) OtherSideCoefficients if this surface has a custom, user specified temperature or

other parameters (See SurfaceProperty:OtherSideCoefficients specification), then this is

the choice. The outside boundary condition will be the name of the
SurfaceProperty:OtherSideCoefficients specification.

8) OtherSideConditionsModel if this surface has a specially-modeled multi-skin

component, such as a transpired collector or vented photovoltaic panel, attached to the

outside (See SurfaceProperty:OtherSideConditionsModel specification), then this the
choice.
The
outside
face
environment
will
be
the
name
of
the
SurfaceProperty:OtherSideConditionsModelspecification.

9) GroundSlabPreprocessorAverage

uses the average results from the Slab

preprocessor calculations.

9/29/14

210

Input-Output Reference

Group Thermal Zone Description/Geometry

10) GroundSlabPreprocessorCore uses the core results from the Slab preprocessor

calculations.

11) GroundSlabPreprocessorPerimeter uses the perimeter results from the Slab

preprocessor calculations.

12) GroundBasementPreprocessorAverageWall uses the average wall results from the

Basement preprocessor calculations.

13) GroundBasementPreprocessorAverageFloor uses the average floor results from the

Basement preprocessor calculations.

14) GroundBasementPreprocessorUpperWall uses the upper wall results from the

Basement preprocessor calculations.

15) GroundBasementPreprocessorLowerWall uses the lower wall results from the

Basement preprocessor calculations.

Field: Outside Boundary Condition Object

If neither Surface, OtherSideCoefficients, or OtherSideConditionsModel are specified for the
Outside Boundary Condition (previous field), then this field should be left blank.
As stated above, if the Outside Boundary Condition is Surface, then this fields value must
be the surface name whose inside face temperature will be forced on the outside face of the
base surface. This permits heat exchange between adjacent zones (interzone heat transfer)
when multiple zones are simulated, but can also be used to simulate middle zone behavior
without modeling the adjacent zones. This is done by specifying a surface within the zone.
For example, a middle floor zone can be modeled by making the floor the Outside Boundary
Condition Object for the ceiling, and the ceiling the Outside Boundary Condition Object for the
floor.
If the Outside Boundary Condition is Zone, then this field should contain the zone name of
the adjacent zone for the surface.
Note: Zones with interzone heat transfer are not adiabatic and the internal surfaces contribute to gains or
losses. Adiabatic surfaces are modeled by specifying the base surface itself in this field. Also, for
interzone heat transfer, both surfaces must be represented for example, if you want interzone heat
transfer to an attic space, the ceiling in the lower zone must have a surface object with the outside face
environment as the floor in the attic and, likewise, there must be a floor surface object in the attic that
references the ceiling surface name in the lower zone.

Equally, if the Outside Boundary Condition is OtherSideCoefficients, then this fields value
must be the SurfaceProperty:OtherSideCoefficients name. Or if the Outside Boundary
Condition is OtherSideConditionsModel then this fields value must be the
SurfaceProperty:OtherSideConditionsModel name.
Field: Sun Exposure
If the surface is exposed to the sun, then SunExposed should be entered in this field.
Otherwise, NoSun should be entered.
Note, a cantilevered floor could have Outdoors but NoSun exposure.
Field: Wind Exposure
If the surface is exposed to the Wind, then WindExposed should be entered in this field.
Otherwise, NoWind should be entered.
Note: When a surface is specified with NoWind, this has several implications. Within the
heat balance code, this surface will default to using the simple ASHRAE exterior convection
coefficient correlation with a zero wind speed. In addition, since the ASHRAE simple method
does not have a separate value for equivalent long wavelength radiation to the sky and
9/29/14

211

Input-Output Reference

Group Thermal Zone Description/Geometry

ground, using NoWind also eliminates long wavelength radiant exchange from the exterior
of the surface to both the sky and the ground. Thus, only simple convection takes place at the
exterior face of a surface specified with NoWind.
Field: View Factor to Ground
The fraction of the ground plane (assumed horizontal) that is visible from a heat-transfer
surface. It is used to calculate the diffuse solar radiation from the ground that is incident on
the surface.
For example, if there are no obstructions, a vertical surface sees half of the ground plane and
so View Factor to Ground = 0.5. A horizontal downward-facing surface sees the entire ground
plane, so View Factor to Ground = 1.0. A horizontal upward-facing surface (horizontal roof)
does not see the ground at all, so View Factor to Ground = 0.0.
Unused if reflections option in Solar Distribution field in Building object input unless a
DaylightingDevice:Shelf or DaylightingDevice:Tubular has been specified.
If you do not use the reflections option in the Solar Distribution field in your Building object
input, you are responsible for entering the View Factor to Ground for each heat-transfer
surface. Typical values for a surface that is not shadowed are obtained by the simple
equation:
View Factor to Ground = (1-cos(SurfTilt))/2
For example, this gives 0.5 for a wall of tilt 90. If the tilt of the wall changes, then the View
Factor to Ground must also change.
If you enter autocalculate in this field, EnergyPlus will automatically calculate the view factor
to ground based on the tilt of the surface.
If you do use the reflections option in the Solar Distribution field in your Building object
input, you do not have to enter View Factor to Ground values. In this case the program will
automatically calculate the value to use for each exterior surface taking into account solar
shadowing (including shadowing of the ground by the building) and reflections from
obstructions (ref: Building, Field: Solar Distribution).
However, if you do use the reflections option AND you are modeling a
DaylightingDevice:Shelf or DaylightingDevice:Tubular, then you still need to enter some
values of View Factor to Ground. For DaylightingDevice:Shelf you need to enter View Factor
to Ground for the window associated with the shelf. And for DaylightingDevice:Tubular you
need to enter the View Factor to Ground for the FenestrationSurface:Detailed corresponding
to the dome of the tubular device.
Note 1: The corresponding view factor to the sky for diffuse solar radiation is not a user input;
it is calculated within EnergyPlus based on surface orientation, sky solar radiance
distribution, and shadowing surfaces.
Note 2: The view factors to the sky and ground for thermal infrared (long-wave) radiation are
not user inputs; they are calculated within EnergyPlus based on surface tilt and shadowing
surfaces. Shadowing surfaces are considered to have the same emissivity and temperature
as the ground, so they are lumped together with the ground in calculating the ground IR view
factor.
Field: Number of Vertices
This field specifies the number of sides in the surface (number of X,Y,Z vertex groups). For
further information, see the discussion on Surface Vertices above.
Some examples of using these objects:
Floor:Detailed,
Floor_NorthZone_1stFloor,!FLOOR-SLAB-ASSEMBLY,
!NorthZone_1stFloor,
!Ground,
!,
!9/29/14

Name
Construction Name
Zone Name
Outside Boundary Condition
Outside Boundary Condition Object
212

Input-Output Reference
NoSun,
NoWind,
0.0,
4,
0, 11, 0,
25, 11, 0,
25, 5.5, 0,
0, 5.5, 0;

Group Thermal Zone Description/Geometry

!!!!-

RoofCeiling:Detailed,
Ceiling_SouthZone_1stFloor,
CEILING-FLOOR-ASSEMBLY, !SouthZone_1stFloor,
!Surface,
!Floor_SouthZone_2ndFloor,!NoSun,
!NoWind,
!0.0,
!4,
!0, 0, 3.4,
25, 0, 3.4,
25, 5.5, 3.4,
0, 5.5, 3.4;

Sun Exposure
Wind Exposure
View Factor to Ground
Number of Vertices
!- X,Y,Z 1 {m}
!- X,Y,Z 2 {m}
!- X,Y,Z 3 {m}
!- X,Y,Z 4 {m}
!- Name
Construction Name
Zone Name
Outside Boundary Condition
Outside Boundary Condition Object
Sun Exposure
Wind Exposure
View Factor to Ground
Number of Vertices
!- X,Y,Z 1 {m}
!- X,Y,Z 2 {m}
!- X,Y,Z 3 {m}
!- X,Y,Z 4 {m}

Wall:Detailed,
InteriorWall_SouthZone_1stFloor, !- Name
INTERIOR-WALL-ASSEMBLY, !- Construction Name
SouthZone_1stFloor,
!- Zone Name
Surface,
!- Outside Boundary Condition
InteriorWall_NorthZone_1stFloor, !- Outside Boundary Condition Object
NoSun,
!- Sun Exposure
NoWind,
!- Wind Exposure
0,
!- View Factor to Ground
4,
!- Number of Vertices
25, 5.5, 3.7,
!- X,Y,Z 1 {m}
25, 5.5, 0,
!- X,Y,Z 2 {m}
0, 5.5, 0,
!- X,Y,Z 3 {m}
0, 5.5, 3.7;
!- X,Y,Z 4 {m}

BuildingSurface:Detailed
The BuildingSurface:Detailed object can more generally describe each of the surfaces.
Field: Name
This is a unique name associated with each building surface. It is used in several other
places as a reference (e.g. as the base surface name for a Window or Door).
Field: Surface Type
Used primarily for convenience, the surface type can be one of the choices illustrated above
Wall, Floor, Ceiling, Roof. Azimuth (facing) and Tilt are determined from the vertex
coordinates. Note that normal floors will be tilted 180 whereas flat roofs/ceilings will be
tilted 0. EnergyPlus uses this fields designation, along with the calculated tilt of the surface,
to issue warning messages when tilts are out of range. Calculations in EnergyPlus use the
actual calculated tilt values for the actual heat balance calculations. Note, however, that a
floor tilted 0 is really facing into the zone and is not what you will desire for the calculations
even though the coordinate may appear correct in the viewed DXF display.
Normal tilt for walls is 90 -- here you may use the calculated Azimuth to make sure your
walls are facing away from the zones interior.

9/29/14

213

Input-Output Reference

Group Thermal Zone Description/Geometry

Field: Construction Name

This is the name of the construction (ref: Construction object) used in the surface. Regardless
of location in the building, the full construction (all layers) is used. For example, for an
interior wall separating two zones, zone x would have the outside layer (e.g. drywall) as the
material that shows in zone y and then the layers to the inside layer the material that shows
in zone x. For symmetric constructions, the same construction can be used in the surfaces
described in both zones.
Field: Zone Name
This is the zone name to which the surface belongs.
Field: Outside Boundary Condition
This value can be one of several things depending on the actual kind of surface.
1) Surface if this surface is an internal surface, then this is the choice. The value will

either be a surface in the base zone or a surface in another zone. The heat balance
between two zones can be accurately simulated by specifying a surface in an adjacent
zone. EnergyPlus will simulate a group of zones simultaneously and will include the heat
transfer between zones. However, as this increases the complexity of the calculations, it
is not necessary to specify the other zone unless the two zones will have a significant
temperature difference. If the two zones will not be very different (temperature wise), then
the surface should use itself as the outside environment or specify this field as Adiabatic.
In either case, the surface name on the outside of this surface (adjacent to) is placed in
the next field.

2) Adiabatic an internal surface in the same Zone. This surface will not transfer heat out

of the zone, but will still store heat in thermal mass. Only the inside face of the surface
will exchange heat with the zone (i.e. two adiabatic surfaces are required to model
internal partitions where both sides of the surface are exchanging heat with the zone).
The Outside Boundary Condition Object can be left blank.

3) Zone this is similar to Surface but EnergyPlus will automatically create the required

surface in the adjacent zone when this is entered for the surface. If there are windows or
doors on the surface, EnergyPlus automatically creates appropriate sub-surfaces as well.

4) Outdoors if this surface is exposed to outside temperature conditions, then this is the

choice. See Sun Exposure and Wind Exposure below for further specifications on this
kind of surface.
5) Ground if this surface is exposed to the ground, then this is the usual choice. The
temperature on the outside of this surface will be the Site:GroundTemperature:Surface
value for the month. For more information on ground contact surfaces, reference the
Auxiliary Programs document section on Ground Heat Transfer in EnergyPlus.
6) GroundFCfactorMethod if this surface is exposed to the ground and using the

Construction:CfactorUndergroundWall
or
Construction:FfactorGroundFloor
(depending on surface type), then this is the choice. The temperature on the outside of
this surface will be the Site:GroundTemperature:FcfactorMethod value for the month.

7) OtherSideCoefficients if this surface has a custom, user specified temperature or

other parameters (See SurfaceProperty:OtherSideCoefficients specification), then this is

the choice. The outside boundary condition will be the name of the
SurfaceProperty:OtherSideCoefficients specification.
8) OtherSideConditionsModel if this surface has a specially-modeled multi-skin
component, such as a transpired collector or vented photovoltaic panel, attached to the
outside (See SurfaceProperty:OtherSideConditionsModel specification), then this the
choice.
The
outside
face
environment
will
be
the
name
of
the
SurfaceProperty:OtherSideConditionsModelspecification.

9/29/14

214

Input-Output Reference
9) GroundSlabPreprocessorAverage

Group Thermal Zone Description/Geometry

uses the average results from the Slab

preprocessor calculations.

10) GroundSlabPreprocessorCore uses the core results from the Slab preprocessor

calculations.

11) GroundSlabPreprocessorPerimeter uses the perimeter results from the Slab

preprocessor calculations.

12) GroundBasementPreprocessorAverageWall uses the average wall results from the

Basement preprocessor calculations.

13) GroundBasementPreprocessorAverageFloor uses the average floor results from the

Basement preprocessor calculations.

14) GroundBasementPreprocessorUpperWall uses the upper wall results from the

Basement preprocessor calculations.

15) GroundBasementPreprocessorLowerWall uses the lower wall results from the

Basement preprocessor calculations.

Field: Outside Boundary Condition Object

If neither Surface, OtherSideCoefficients, or OtherSideConditionsModel are specified for the
Outside Boundary Condition (previous field), then this field should be left blank.
As stated above, if the Outside Boundary Condition is Surface, then this fields value must
be the surface name whose inside face temperature will be forced on the outside face of the
base surface. This permits heat exchange between adjacent zones (interzone heat transfer)
when multiple zones are simulated, but can also be used to simulate middle zone behavior
without modeling the adjacent zones. This is done by specifying a surface within the zone.
For example, a middle floor zone can be modeled by making the floor the Outside Boundary
Condition Object for the ceiling, and the ceiling the Outside Boundary Condition Object for the
floor.
If the Outside Boundary Condition is Zone, then this field should contain the zone name of
the adjacent zone for the surface.
Note: Zones with interzone heat transfer are not adiabatic and the internal surfaces contribute to gains or
losses. Adiabatic surfaces are modeled by specifying the base surface itself in this field. Also, for
interzone heat transfer, both surfaces must be represented for example, if you want interzone heat
transfer to an attic space, the ceiling in the lower zone must have a surface object with the outside face
environment as the floor in the attic and, likewise, there must be a floor surface object in the attic that
references the ceiling surface name in the lower zone.

Equally, if the Outside Boundary Condition is OtherSideCoefficients, then this fields value
must be the SurfaceProperty:OtherSideCoefficients name. Or if the Outside Boundary
Condition is OtherSideConditionsModel then this fields value must be the
SurfaceProperty:OtherSideConditionsModel name.
Field: Sun Exposure
If the surface is exposed to the sun, then SunExposed should be entered in this field.
Otherwise, NoSun should be entered.
Note, a cantilevered floor could have Outdoors but NoSun exposure.
Field: Wind Exposure
If the surface is exposed to the Wind, then WindExposed should be entered in this field.
Otherwise, NoWind should be entered.
Note: When a surface is specified with NoWind, this has several implications. Within the
heat balance code, this surface will default to using the simple ASHRAE exterior convection
9/29/14

215

Input-Output Reference

Group Thermal Zone Description/Geometry

coefficient correlation with a zero wind speed. In addition, since the ASHRAE simple method
does not have a separate value for equivalent long wavelength radiation to the sky and
ground, using NoWind also eliminates long wavelength radiant exchange from the exterior
of the surface to both the sky and the ground. Thus, only simple convection takes place at the
exterior face of a surface specified with NoWind.
Field: View Factor to Ground
The fraction of the ground plane (assumed horizontal) that is visible from a heat-transfer
surface. It is used to calculate the diffuse solar radiation from the ground that is incident on
the surface.
For example, if there are no obstructions, a vertical surface sees half of the ground plane and
so View Factor to Ground = 0.5. A horizontal downward-facing surface sees the entire ground
plane, so View Factor to Ground = 1.0. A horizontal upward-facing surface (horizontal roof)
does not see the ground at all, so View Factor to Ground = 0.0.
Unused if reflections option in Solar Distribution field in Building object input unless a
DaylightingDevice:Shelf or DaylightingDevice:Tubular has been specified.
If you do not use the reflections option in the Solar Distribution field in your Building object
input, you are responsible for entering the View Factor to Ground for each heat-transfer
surface. Typical values for a surface that is not shadowed are obtained by the simple
equation:
View Factor to Ground = (1-cos(SurfTilt))/2
For example, this gives 0.5 for a wall of tilt 90. If the tilt of the wall changes, then the View
Factor to Ground must also change.
If you enter autocalculate in this field, EnergyPlus will automatically calculate the view factor
to ground based on the tilt of the surface.
If you do use the reflections option in the Solar Distribution field in your Building object
input, you do not have to enter View Factor to Ground values. In this case the program will
automatically calculate the value to use for each exterior surface taking into account solar
shadowing (including shadowing of the ground by the building) and reflections from
obstructions (ref: Building, Field: Solar Distribution).
However, if you do use the reflections option AND you are modeling a
DaylightingDevice:Shelf or DaylightingDevice:Tubular, then you still need to enter some
values of View Factor to Ground. For DaylightingDevice:Shelf you need to enter View Factor
to Ground for the window associated with the shelf. And for DaylightingDevice:Tubular you
need to enter the View Factor to Ground for the FenestrationSurface:Detailed corresponding
to the dome of the tubular device.
Note 1: The corresponding view factor to the sky for diffuse solar radiation is not a user input;
it is calculated within EnergyPlus based on surface orientation, sky solar radiance
distribution, and shadowing surfaces.
Note 2: The view factors to the sky and ground for thermal infrared (long-wave) radiation are
not user inputs; they are calculated within EnergyPlus based on surface tilt and shadowing
surfaces. Shadowing surfaces are considered to have the same emissivity and temperature
as the ground, so they are lumped together with the ground in calculating the ground IR view
factor.
Field: Number of Vertices
This field specifies the number of sides in the surface (number of X,Y,Z vertex groups). For
further information, see the discussion on Surface Vertices above.
IDF example of three walls (first is an exterior wall, second and third are interzone partitions):
BuildingSurface:Detailed,Zn001:Wall001, !- Base Surface Name
Wall,EXTERIOR, !- Class and Construction Name
ZONE 1 @ 200 601 0 T, !- Zone
Outdoors,, !- Outside Boundary Condition and Target (if applicable)
9/29/14

216

Input-Output Reference

Group Thermal Zone Description/Geometry

SunExposed, !- Solar Exposure

WindExposed, !- Wind Exposure
0.5000000
, !- VF to Ground
4, !-Rectangle
0.0000000E+00, 0.0000000E+00,
3.048000
,
0.0000000E+00, 0.0000000E+00, 0.0000000E+00,
6.096000
, 0.0000000E+00, 0.0000000E+00,
6.096000
, 0.0000000E+00,
3.048000
;
BuildingSurface:Detailed,Zn001:Wall006, !- Base Surface Name
Wall,INTERIOR, !- Class and Construction Name
HEARTLAND AREA, !- Zone
Surface,Zn004:Wall005, !- Outside Boundary Conditions and Target (if
applicable)
NoSun, !- Solar Exposure
NoWind, !- Wind Exposure
0.5000000
, !- VF to Ground
4, !-Rectangle
38.01000
,
28.25000
,
10.00000
,
38.01000
,
28.25000
, 0.0000000E+00,
38.01000
,
18.25000
, 0.0000000E+00,
38.01000
,
18.25000
,
10.00000
;
BuildingSurface:Detailed,Zn001:Wall007, !- Base Surface Name
Wall,INTERIOR, !- Class and Construction Name
HEARTLAND AREA, !- Zone
Surface,Zn003:Wall006, !- Outside Boundary Conditions and Target (if
applicable)
NoSun, !- Solar Exposure
NoWind, !- Wind Exposure
0.5000000
, !- VF to Ground
4, !-Rectangle
58.01000
,
18.25000
,
10.00000
,
58.01000
,
18.25000
, 0.0000000E+00,
58.01000
,
28.25000
, 0.0000000E+00,
58.01000
,
28.25000
,
10.00000
;

FenestrationSurface:Detailed
This surface class is used for subsurfaces, which can be of five different types: Windows,
Doors, GlassDoors, TubularDaylightDomes, and TubularDaylightDiffusers. A subsurface
(such as a window) of a base surface (such as a wall) inherits several of the properties (such
as Outside Boundary Condition, Sun Exposure, etc.) of the base surface. Windows,
GlassDoors, TubularDaylightDomes, and TubularDaylightDiffusers are considered to have
one or more glass layers and so transmit solar radiation. Doors are considered to be opaque.
Field: Name
This is a unique name associated with the heat transfer subsurface. It may be used in other
places as a reference (e.g. as the opposing subsurface of an interzone window or door).
Field: Surface Type
The choices for Surface Type are Window, Door, GlassDoor, TubularDaylightDome, and
TubularDaylightDiffuser. Doors are assumed to be opaque (do not transmit solar radiation)
whereas the other surface types do transmit solar radiation. Windows and Glass Doors are
treated identically in the calculation of conduction heat transfer, solar gain, daylighting, etc. A
Window or GlassDoor, but not a Door, can have a movable interior, exterior or between-glass
shading device, such as blinds (ref: WindowMaterial:Blind object), and can have a frame
and/or a divider (ref: WindowProperty:FrameAndDivider object). TubularDaylightDomes and
TubularDaylightDomes
are
specialized
subsurfaces
for
use
with
the
DaylightingDevice:Tubular object to simulate Tubular Daylighting Devices (TDDs).
9/29/14

217

Input-Output Reference

Group Thermal Zone Description/Geometry

TubularDaylightDomes and TubularDaylightDomes cannot have shades, screens or blinds. In

the following, the term window applies to Window, GlassDoor, TubularDaylightDome, and
TubularDaylightDome, if not otherwise explicitly mentioned.
As noted in the description of the BuildingSurface:Detailed, Azimuth (facing angle) and Tilt
are calculated from the entered vertices. Tilts of subsurfaces will normally be the same as
their base surface. If these are significantly beyond the normals for the base surface,
warning messages may be issued. If the facing angles are not correct, you may have a
window pointing into the zone rather than out of it this would cause problems in the
calculations. Note, too, that a reveal (inset or outset) may occur if the plane of the
subsurface is not coincident with the base surface; the reveal has an effect on shading of the
subsurface.
Field: Construction Name
This is the name of the subsurfaces construction (ref: Construction object [for Door] and
Construction, Construction:ComplexFenestrationState, Construction:WindowDataFile objects
[for Window and GlassDoor]).
For windows, if Construction Name is not found among the constructions on the input (.idf)
file, the Window Data File (ref. Construction:WindowDataFile object) will be searched for that
Construction Name (see Importing Windows from WINDOW). If that file is not present or if
the Construction Name does not match the name of an entry on the file, an error will result. If
there is a match, a window construction and its corresponding glass and gas materials will be
created from the information read from the file.
Field: Building Surface Name
This is the name of a surface that contains this subsurface. Certain kinds of surfaces may not
be allowed to have subsurfaces. For example, a surface in contact with the ground (Outside
Boundary Condition = Ground) cannot contain a window.
Field: Outside Boundary Condition Object
If the base surface has Outside Boundary Condition = Surface or OtherSideCoefficients, then
this field must also be specified for the subsurface. Otherwise, it can be left blank.
If the base surface has Outside Boundary Condition = Zone, then this surface retains that
characteristic and uses the same zone of the base surface. It can be entered here for clarity
or it can be left blank.
If Outside Boundary Condition for the base surface is Surface, this field should specify the
subsurface in the opposing zone that is the counterpart to this subsurface. The constructions
of the subsurface and opposing subsurface must match, except that, for multi-layer
constructions, the layer order of the opposing subsurfaces construction must be the reverse
of that of the subsurface.
If Outside Boundary Condition for the base surface is OtherSideCoefficients, this field could
specify the set of SurfaceProperty:OtherSideCoefficients for this subsurface. If this is left
blank, then the Other Side Coefficients of the base surface will be used for this subsurface.
Windows and GlassDoors are not allowed to have Other Side Coefficients.
Field: View Factor to Ground
The fraction of the ground plane (assumed horizontal) that is visible from a heat-transfer
surface. It is used to calculate the diffuse solar radiation from the ground that is incident on
the surface.
For example, if there are no obstructions, a vertical surface sees half of the ground plane and
so View Factor to Ground = 0.5. A horizontal downward-facing surface sees the entire ground
plane, so View Factor to Ground = 1.0. A horizontal upward-facing surface (horizontal roof)
does not see the ground at all, so View Factor to Ground = 0.0.
Unused if reflections option in Solar Distribution field in Building object input unless a
Daylighting Device:Shelf or Daylighting Device:Tubular has been specified.
9/29/14

218

Input-Output Reference

Group Thermal Zone Description/Geometry

If you do not use the reflections option in the Solar Distribution field in your Building object
input, you are responsible for entering the View Factor to Ground for each heat-transfer
surface. Typical values for a surface that is not shadowed are obtained by the simple
equation:
View Factor to Ground = (1-cos(SurfTilt))/2
For example, this gives 0.5 for a wall of tilt 90. If the tilt of the wall changes, then the View
Factor to Ground must also change.
If you enter autocalculate in this field, EnergyPlus will automatically calculate the view factor
to ground based on the tilt of the surface.
If you do use the reflections option in the Solar Distribution field in your BUILDING
object input, you do not have to enter View Factor to Ground values. In this case the program
will automatically calculate the value to use for each exterior surface taking into account solar
shadowing (including shadowing of the ground by the building) and reflections from
obstructions (ref: Building, Field: Solar Distribution).
However, if you do use the reflections option AND you are modeling a
DaylightingDevice:Shelf or DaylightingDevice:Tubular, then you still need to enter some
values of View Factor to Ground. For DaylightingDevice:Shelf you need to enter View Factor
to Ground for the window associated with the shelf. And for DaylightingDevice:Tubular you
need to enter the View Factor to Ground for the FenestrationSurface:Detailed corresponding
to the dome of the tubular device (ref: DaylightingDevice:Tubular).
Note 1: The corresponding view factor to the sky for diffuse solar radiation is not a user input;
it is calculated within EnergyPlus based on surface orientation, sky solar radiance
distribution, and shadowing surfaces.
Note 2: The view factors to the sky and ground for thermal infrared (long-wave) radiation are
not user inputs; they are calculated within EnergyPlus based on surface tilt and shadowing
surfaces. Shadowing surfaces are considered to have the same emissivity and temperature
as the ground, so they are lumped together with the ground in calculating the ground infrared
view factor.
Field: Shading Control Name
This field, if not blank, is the name of the window shading control (ref:
WindowProperty:ShadingControl object) for this subsurface. It is used for Surface Type =
Window and GlassDoor. To assign a shade to a window or glass door, see WindowMaterial:
Shade. To assign a screen, see WindowMaterial:Screen. To assign a blind, see
WindowMaterial:Blind. To assign switchable glazing, such as electrochromic glazing, see
WindowProperty:ShadingControl.
Field: Frame and Divider Name
This field, if not blank, can be used to specify window frame, divider and reveal-surface data
(ref: WindowProperty:FrameAndDivider object). It is used only for exterior GlassDoors and
rectangular exterior Windows, i.e., those with OutsideFaceEnvironment = Outdoors.
This field should be blank for triangular windows.
Field: Multiplier
Used only for Surface Type = Window, Door or Glass Door. It is the number of identical items
on the base surface. Using Multiplier can save input effort and calculation time. In the
calculation the area (and area of frame and divider, if present and surface type is a window)
is multiplied by Multiplier. The calculation of shadowing on the subsurfaces (and the
calculation of the interior distribution of beam solar radiation transmitted by windows and
glass doors) are done for the specified subsurface position and dimensions.
Multiplier should be used with caution. Multiplier > 1 can give inaccurate or nonsensical
results in situations where the results are sensitive to window or glass door position. This
includes shadowing on the window/glass door, daylighting from the window/glass door, and
9/29/14

219

Input-Output Reference

Group Thermal Zone Description/Geometry

interior distribution of solar radiation from the window/glass door. In these cases, the results
for the single input window/glass door, after multiplication, may not be representative of the
results you would get if you entered each of the multiple subsurfaces separately.
If Multiplier > 1, you will get
--a warning if Solar Distribution = FullExterior or FullInteriorAndExterior (ref: Building - Field:
Solar Distribution), indicating that the shadowing on the input window or the interior solar
radiation distribution from the input window may not be representative of the actual group of
windows. No warning is issued if Solar Distribution = MinimalShadowing.
--an error if the window is an exterior window/glass door in a zone that has a detailed
daylighting calculation (Daylighting:Detailed specified for the zone). Since a single window
with a multiplier can never give the same daylight illuminance as the actual set of windows,
you are not allowed to use Multiplier in this situation.
Field: Number of Vertices
The number of sides the surface has (number of X,Y,Z vertex groups). For further
information, see the discussion on Surface Vertices above. Door and GlassDoor
subsurfaces are rectangular and therefore have four vertices. Window subsurfaces can be
rectangular or triangular and therefore have four or three vertices, respectively.
Fields: Vertex Coordinates
This is a total of twelve fields giving the x,y,z coordinate values of the four vertices of
rectangular subsurfaces [m], or a total of nine fields giving the x,y,z coordinate values of the
three vertices of triangular windows.
For triangular windows the first vertex listed can be any of the three vertices, but the order of
the vertices should be counter-clockwise if VertexEntry is CounterClockWise and clockwise if
VertexEntry is ClockWise (ref: GlobalGeometryRules).
An IDF example of a rectangular subsurface (Window):
FenestrationSurface:Detailed,
Zn001:Wall001:Win001, !- SubSurface Name
Window,SINGLE PANE HW WINDOW, !- Class and Construction Name
Zn001:Wall001,,
!- Base Surface Name and Target (if applicable)
0.5000000
,
!- VF to Ground
WINDOW-CONTROL-DRAPES, !- Window Shading Control
TestFrameAndDivider,
!- Frame/Divider name
5,
!- Multiplier
4,
!- Rectangle (number of sides)
1.524000
, 0.1520000
,
2.743000
,
1.524000
, 0.1520000
, 0.3050000
,
4.572000
, 0.1520000
, 0.3050000
,
4.572000
, 0.1520000
,
2.743000
;

Window Modeling Options

The following table shows what input objects/fields to use to model different window options.
It also gives the name of an example input, if available, that demonstrates the option.
Table 8. Window Modeling Options
Option
Build up a window from layers

9/29/14

Object/Field or
Output Variable
WindowMaterial:Glazing,
WindowMaterial:Gas,
WindowMaterial:Shade,
WindowMaterial:Screen,

Input File (distributed

with install)
WindowTests.idf

220

Input-Output Reference

Group Thermal Zone Description/Geometry

WindowMaterial:Blind,
Construction

9/29/14

Add an overhang

Shading:Zone:Detailed

5ZoneAirCooled.idf

Add a shading device

WindowMaterial:Shade,
WindowMaterial:Screen or
WindowMaterial:Blind;
WindowProperty:ShadingCon
trol

WindowTests.idf,
PurchAirWindowBlind.idf

Control a shading device

WindowProperty:ShadingCon
trol

PurchAirWindowBlind.idf

Determine when a shading device

is on in a particular timestep

Print the variable Surface

Shading Device Is On Time
Fraction

PurchAirWindowBlind.idf

Control the slat angle of a blind

WindowProperty:ShadingCon
trol

PurchAirWindowBlind.idf

Add a frame

WindowProperty:FrameAndDi
vider

PurchAirWithDaylighting.idf

Add a divider

WindowProperty:FrameAndDi
vider

PurchAirWithDaylighting.idf

Allow window to daylight a zone

Daylighting:Controls,
Daylighting:DELight:Controls

PurchAirWithDaylighting.idf,
DElight-Detailed-Comparison.idf

Find solar reflected onto window

from neighboring buildings
Model switchable glazing (e.g.,
electrochromic glass)
Add an interior window

Building/SolarDistribution field
uses WithReflections

ReflectiveAdjacentBuilding.idf

WindowProperty:ShadingCon
trol

PurchAirWithDaylighting.idf

Define two
FenestrationSurface:Detailed
s, one for each associated
interior wall

PurchAirWithDoubleFacadeDaylig
hting.idf

Track how beam solar falls on

interior surfaces
Track beam solar transmitted
through interior windows

Building/Solar Distribution =
FullInteriorAndExterior

PurchAirWithDoubleFacadeDaylig
hting.idf

Building/Solar Distribution =
FullInteriorAndExterior

PurchAirWithDoubleFacadeDaylig
hting.idf

Add a shading device on an

interior window

Not allowed

Model an airflow window (aka,

heat extract window)
Add a storm window glass layer

WindowProperty:AirflowContr
ol

AirflowWindowsAndBetweenGlass
Blinds.idf

WindowProperty:StormWindo
w

StormWindow.idf

Add natural ventilation through an

open window

Ventilation or AirflowNetwork
objects
(AirflowNetwork:Multizone:Su
rface,
AirflowNetwork:MultiZone:Co
mponent:DetailedOpening,
etc.)

AirflowNetwork3zvent.idf

Add diffusing glass

WindowMaterial:Glazing/Sola
r Diffusing = Yes

Add dirt on window

WindowMaterial:Glazing/Dirt
Correction Factor for Solar
221

Input-Output Reference

Group Thermal Zone Description/Geometry

and Visible Transmittance

Import window (and frame/divider if
present) from WINDOW program

See Importing Windows from

WINDOW program

Find daylighting through interior

windows

See Double Facades:

Daylighting through Interior
Windows

Determine when condensation

occurs

Print the variables Surface

Window Inside Face Glazing
Condensation Status,
Surface Window Inside Face
Frame Condensation Status,
Surface Window Inside Face
Divider Condensation Status

PurchAirWithDoubleFacadeDaylig
hting.idf

InternalMass
Any surface that would logically be described as an interior wall, floor or ceiling can just as
easily be described as Internal Mass. Internal Mass surface types only exchange energy with
the zone in which they are described; they do not see any other zones. There are two
approaches to using internal mass. The first approach is to have several pieces of internal
mass with each piece having a different construction type. The other approach is to choose
an average construction type and combine all of the interior surfaces into a single internal
mass. Similar to internal surfaces with an adiabatic boundary condtion, the zone will only
exchange energy with the inside of the Internal Mass construction. If both sides of the surface
exchange energy with the zone then the user should input twice the area when defining the
Internal Mass object. Note that furniture and other large objects within a zone can be
described using internal mass. However, simplifying calculations using internal mass must be
used
with
caution
when
the
FullInteriorAndExterior
or
FullInteriorAndExteriorWithReflections Solar Distribution model (see Building parameters) is
chosen.
Example
When zoning an office building, five west-facing offices have been combined into one zone.
All of the offices have interior walls made of the same materials. As shown in the figure
below, this zone may be described with 5 exterior walls and 11 internal walls or 1 exterior wall
and 1 internal mass. Note that fewer surfaces will speed up the EnergyPlus calculations.

9/29/14

222

Input-Output Reference

Group Thermal Zone Description/Geometry

OFFICE A

OFFICES A-E

OFFICE B
INTERNAL
MASS

OFFICE C
OFFICE D
OFFICE E

Figure 30. Representing 11 internal walls as internal mass

Example
A five-story building has the same ceiling/floor construction separating each of the levels.
Zones that are on floors 2 through 4 may be described using a single piece of internal mass
to represent both the floor and ceiling. The construction for this internal mass would be
identical to the ceiling/floor construction that would be used to describe separate surfaces
and the area of the internal mass surface would be the total surface area of the combined
ceilings/floors (i.e. twice the total floor area).
Field: Name
This is a unique character string associated with the internal mass surface. Though it must be
unique from other surface names, it is used primarily for convenience with internal mass
surfaces.
Field: Construction Name
This is the name of the construction (ref: Construction object) used in the surface.
Field: Zone Name
This is the name of the zone in which the internal mass is represented.
Field: Surface Area
This field is the surface area of the internal mass. The area that is specified must be the
entire surface area that is exposed to the zone. If both sides of a wall are completely within
the same zone, then the area of both sides must be included when describing that internal
wall.
IDF examples of Internal Mass surfaces:
InternalMass,Zn002:IntM001, !- Surface
INTERIOR, !- Construction Name
DORM ROOMS AND COMMON AREAS, !- Zone
408.7734
; !- Total area exposed
InternalMass,Zn002:IntM002, !- Surface
PARTITION02, !- Construction Name
DORM ROOMS AND COMMON AREAS, !- Zone
371.6122
; !- Total area exposed

9/29/14

Name
to Zone {m2}
Name
to Zone {m2}

223

Input-Output Reference

Group Thermal Zone Description/Geometry

Surface Output Variables/Reports

Note that Surface Outputs from specialized algorithms (such as Effective Moisture
Penetration Depth (EMPD), Combined Heat and Moisture Transport (HAMT) and Conduction
Finite Difference (CondFD) are discussed under the objects that describe the specialized
inputs for these algorithms). You can access them via these links:
Moisture Penetration Depth (EMPD) Outputs
Conduction Finite Difference (CondFD) Outputs
Heat and Moisture (HAMT) Outputs
Additionally, the output variables applicable to all heat transfer surfaces:
Zone,Sum,Surface Inside Face Heat Balance Calculation Iteration Count []
Zone,Average,Surface Inside Face Temperature [C]
Zone,Average,Surface Outside Face Temperature [C]
Zone,Average,Surface Inside Face Adjacent Air Temperature [C]
Zone,Average,Surface Inside Face Convection Heat Transfer Coefficient [W/m2-K]
Zone,Average,Surface Inside Face Convection Heat Gain Rate [W]
Zone,Average,Surface Inside Face Convection Heat Gain Rate per Area [W/m2]
Zone,Sum,Surface Inside Face Convection Heat Gain Energy [J]
Zone,Average,Surface Inside Face Net Surface Thermal Radiation Heat Gain Rate [W]
Zone,Average,Surface Inside Face Net Surface Thermal Radiation Heat Gain Rate per Area [W/m2]
Zone,Sum,Surface Inside Face Net Surface Thermal Radiation Heat Gain Energy [J]
Zone,Average,Surface Inside Face Solar Radiation Heat Gain Rate [W]
Zone,Average,Surface Inside Face Solar Radiation Heat Gain Rate per Area [W/m2]
Zone,Sum,Surface Inside Face Solar Radiation Heat Gain Energy [J]
Zone,Average,Surface Inside Face Lights Radiation Heat Gain Rate [W]
Zone,Average,Surface Inside Face Lights Radiation Heat Gain Rate per Area [W/m2]
Zone,Sum,Surface Inside Face Lights Radiation Heat Gain Energy [J]
Zone,Average,Surface Inside Face Internal Gains Radiation Heat Gain Rate [W]
Zone,Average,Surface Inside Face Internal Gains Radiation Heat Gain Rate per Area [W/m2]
Zone,Sum,Surface Inside Face Internal Gains Radiation Heat Gain Energy [J]
Zone,Average,Surface Inside Face System Radiation Heat Gain Rate [W]
Zone,Average,Surface Inside Face System Radiation Heat Gain Rate per Area [W/m2]
Zone,Sum,Surface Inside Face System Radiation Heat Gain Energy [J]
Zone,Average,Surface Outside Face Convection Heat Transfer Coefficient [W/m2-K]
Zone,Average,Surface Outside Face Convection Heat Gain Rate [W]
Zone,Average,Surface Outside Face Convection Heat Gain Rate per Area [W/m2]
Zone,Sum,Surface Outside Face Convection Heat Gain Energy [J]
Zone,Average,Surface Outside Face Net Thermal Radiation Heat Gain Rate [W]
Zone,Average,Surface Outside Face Net Thermal Radiation Heat Gain Rate per Area [W/m2]
Zone,Sum,Surface Outside Face Net Thermal Radiation Heat Gain Energy [J]
Zone,Average,Surface Outside Face Thermal Radiation to Air Heat Transfer Coefficient [W/m2-K]
Zone,Average,Surface Outside Face Thermal Radiation to Sky Heat Transfer Coefficient [W/m2-K]
Zone,Average,Surface Outside Face Thermal Radiation to Ground Heat Transfer Coefficient [W/m2-K]
Zone,Average,Surface Inside Face Exterior Windows Incident Beam Solar Radiation Rate [W]
Zone,Sum,Surface Inside Face Exterior Windows Incident Beam Solar Radiation Energy [J]
Zone,Average,Surface Inside Face Exterior Windows Incident Beam Solar Radiation Rate per Area[W/m2]
Zone,Average,Surface Inside Face Interior Windows Incident Beam Solar Radiation Rate [W]
Zone,Average,Surface Inside Face Interior Windows Incident Beam Solar Radiation Rate per Area[W/m2]
Zone, Sum,Surface Inside Face Interior Windows Incident Beam Solar Radiation Energy [J]
Zone,Average,Surface Inside Face Initial Transmitted Diffuse Absorbed Solar Radiation Rate [W]
Zone,Average,Surface Inside Face Initial Transmitted Diffuse Transmitted Out Window Solar Radiation Rate
[W]
Zone,Average,Surface Inside Face Absorbed Shortwave Radiation Rate [W]

Output variables applicable to all exterior heat transfer surfaces:

9/29/14

224

Input-Output Reference

Group Thermal Zone Description/Geometry

Zone,Average,Surface Outside Face Outdoor Air Drybulb Temperature [C]

Zone,Average,Surface Outside Face Outdoor Air Wetbulb Temperature [C]
Zone,Average,Surface Outside Face Outdoor Air Wind Speed [m/s]
Zone,Average,Surface Outside Face Sunlit Area [m2]
Zone,Average,Surface Outside Face Sunlit Fraction []
Zone,Average,Surface Outside Face Incident Solar Radiation Rate per Area[W/m2]
Zone,Average,Surface Outside Face Solar Radiation Heat Gain Rate [W]
Zone,Average,Surface Outside Face Solar Radiation Heat Gain Rate per Area [W/m2]
Zone,Sum,Surface Outside Face Solar Radiation Heat Gain Energy [J]

Zone,Average,Surface
Zone,Average,Surface
Zone,Average,Surface
Zone,Average,Surface
Zone,Average,Surface
Area[W/m2]
Zone,Average,Surface
Area[W/m2]
Zone,Average,Surface
Area[W/m2]
Zone,Average,Surface
Area[W/m2]
Zone,Average,Surface
Zone,Average,Surface
Zone,Average,Surface
Zone,Average,Surface
Zone,Average,Surface

Outside Face
Outside Face
Outside Face
Ext Diff Sol
Outside Face

Incident Beam Solar Radiation Rate per Area[W/m2]

Incident Sky Diffuse Solar Radiation Rate per Area[W/m2]
Incident Ground Diffuse Solar Radiation Rate per Area[W/m2]
From Bm-To-Diff Refl From Ground[W/m2]
Incident Sky Diffuse Ground Reflected Solar Radiation Rate per

Outside Face Incident Sky Diffuse Surface Reflected Solar Radiation Rate per
Outside Face Incident Beam To Beam Surface Reflected Solar Radiation Rate per
Outside Face Incident Beam To Diffuse Surface Reflected Solar Radiation Rate per
Outside Face Beam Solar Incident Angle Cosine Value[]
Anisotropic Sky Multiplier []
Window BSDF Beam Direction Number []
Window BSDF Beam Theta Angle [rad]
Window BSDF Beam Phi Angle [rad]

Output variables applicable to opaque heat transfer surfaces (FLOOR, WALL, ROOF,
DOOR). Note these are advanced variables you must read the descriptions and
understand before use then you must use the Diagnostics object to allow reporting.

9/29/14

225

Input-Output Reference

Group Thermal Zone Description/Geometry

Zone,Average,Surface Inside Face Solar Radiation Heat Gain Rate [W]

Zone,Average,Surface Inside Face Solar Radiation Heat Gain Rate per Area [W/m2]
Zone,Sum,Surface Inside Face Solar Radiation Heat Gain Energy [J]
Zone,Average,Surface Inside Face Lights Radiation Heat Gain Rate [W]
Zone,Average,Surface Inside Face Lights Radiation Heat Gain Rate per Area [W/m2]
Zone,Sum,Surface Inside Face Lights Radiation Heat Gain Energy [J]
Zone,Average,Surface Inside Face Conduction Heat Transfer Rate [W]
Zone,Average,Surface Inside Face Conduction Heat Gain Rate [W]
Zone,Average,Surface Inside Face Conduction Heat Loss Rate [W]
Zone,Average,Surface Inside Face Conduction Heat Transfer Rate per Area [W/m2]
Zone,Sum,Surface Inside Face Conduction Heat Transfer Energy [J]
Zone,Average,Surface Outside Face Conduction Heat Transfer Rate [W]
Zone,Average,Surface Outside Face Conduction Heat Gain Rate [W]
Zone,Average,Surface Outside Face Conduction Heat Loss Rate [W]
Zone,Average,Surface Outside Face Conduction Heat Transfer Rate per Area [W/m2]
Zone,Sum,Surface Outside Face Conduction Heat Transfer Energy [J]
Zone,Average,Surface Average Face Conduction Heat Transfer Rate [W]
Zone,Average,Surface Average Face Conduction Heat Gain Rate [W]
Zone,Average,Surface Average Face Conduction Heat Loss Rate [W]
Zone,Average,Surface Average Face Conduction Heat Transfer Rate per Area [W/m2]
Zone,Sum,Surface Average Face Conduction Heat Transfer Energy [J]
Zone,Average,Surface Heat Storage Rate [W]
Zone,Average,Surface Heat Storage Gain Rate [W]
Zone,Average,Surface Heat Storage Loss Rate [W]
Zone,Average,Surface Heat Storage Rate per Area [W/m2]
Zone,Sum,Surface Heat Storage Energy [J]
Zone,Average,Surface Internal Source Location Temperature [C]
Zone,Average,Zone Opaque Surface Inside Face Conduction [W]
Zone,Average,Zone Opaque Surface Inside Faces Total Conduction Heat Gain Rate [W]
Zone,Average,Zone Opaque Surface Inside Faces Total Conduction Heat Loss Rate [W]
Zone,Sum,Zone Opaque Surface Inside Faces Total Conduction Heat Gain Energy [J]
Zone,Sum,Zone Opaque Surface Inside Faces Total Conduction Heat Loss Energy [J]
Zone,Average,Zone Opaque Surface Outside Face Conduction [W]
Zone,Average,Zone Opaque Surface Outside Face Conduction Gain[W]
Zone,Average,Zone Opaque Surface Outside Face Conduction Loss[W]
Zone,Average, Surface Inside Face Beam Solar Radiation Heat Gain Rate [W]

Window Output Variables

Output variables applicable only to exterior windows and glass doors:

9/29/14

226

Input-Output Reference

Group Thermal Zone Description/Geometry

Zone,Average,Zone Windows Total Transmitted Solar Radiation Rate [W]

Zone,Sum,Zone Transmitted Solar Energy [J]
Zone,Average,Zone Windows Total Heat Gain Rate [W]
Zone,Sum,Zone Windows Total Heat Gain Energy [J]
Zone,Average,Zone Windows Total Heat Loss Rate [W]
Zone,Sum,Zone Windows Total Heat Loss Energy [J]
Zone,Average,Zone Exterior Windows Total Transmitted Beam Solar Radiation Rate [W]
Zone,Sum,Zone Exterior Windows Total Transmitted Beam Solar Radiation Energy [J]
Zone,Average,Zone Interior Windows Total Transmitted Beam Solar Radiation Rate [W]
Zone,Sum,Zone Interior Windows Total Transmitted Beam Solar Radiation Energy [J]
Zone,Average,Zone Exterior Windows Total Transmitted Diffuse Solar Radiation Rate [W]
Zone,Sum,Zone Exterior Windows Total Transmitted Diffuse Solar Radiation Energy [J]
Zone,Average,Zone Interior Windows Total Transmitted Diffuse Solar Radiation Rate [W]
Zone,Average,Surface Window Total Glazing Layers Absorbed Solar Radiation Rate [W]
Zone,Average,Surface Window Total Glazing Layers Absorbed Shortwave Radiation Rate [W]
Zone,Sum,Surface Window Total Glazing Layers Absorbed Solar Radiation Energy [J]
Zone,Average,Surface Window Shading Device Absorbed Solar Radiation Rate [W]
Zone,Sum,Surface Window Shading Device Absorbed Solar Radiation Energy [J]
Zone,Average, Surface Window Transmitted Solar Radiation Rate [W]
Zone,Sum,Surface Window Transmitted Solar Radiation Energy [J]
Zone,Average,Surface Window Transmitted Beam Solar Radiation Rate [W]
Zone,Average,Surface Window Transmitted Beam To Beam Solar Radiation Rate [W]
Zone,Average,Surface Window Transmitted Beam To Diffuse Solar Radiation Rate [W]
Zone,Sum,Surface Window Transmitted Beam Solar Radiation Energy [J]
Zone,Sum,Surface Window Transmitted Beam To Beam Solar Radiation Energy [J]
Zone,Sum,Surface Window Transmitted Beam To Diffuse Solar Radiation Energy [J]
Zone,Average,Surface Window Transmitted Diffuse Solar Radiation Rate [W]
Zone,Sum,Surface Window Transmitted Diffuse Solar Radiation Energy [J]
Zone,Average,Surface Window System Solar Transmittance []
Zone,Average,Surface Window System Solar Absorptance []
Zone,Average,Surface Window System Solar Reflectance []
Zone,Average,Surface Window Gap Convective Heat Transfer Rate [W]
Zone,Sum,Surface Window Gap Convective Heat Transfer Energy [J]
Zone,Average,Surface Window Heat Gain Rate [W]
Zone,Sum,Surface Window Heat Gain Energy [J]
Zone,Average,Surface Window Heat Loss Rate [W]
Zone,Sum,Surface Window Heat Loss Energy [J]
Zone,Average,Surface Window Glazing Beam to Beam Solar Transmittance[]
Zone,Average,Surface Window Glazing Beam to Diffuse Solar Transmittance []
Zone,Average,Surface Window Glazing Diffuse to Diffuse Solar Transmittance[]
Zone,Average,Surface Window Model Solver Iteration Count []
Zone,Average,Surface Window Solar Horizontal Profile Angle[deg]
Zone,Average,Surface Window Solar Vertical Profile Angle[deg]
Zone,Average,Surface Window Outside Reveal Reflected Beam Solar Radiation Rate [W]
Zone,Sum,Surface Window Outside Reveal Reflected Beam Solar Radiation Energy
Zone,Average,Surface Window Inside Reveal Reflected Beam Solar Radiation Rate [W]
Zone,Sum,Surface Window Inside Reveal Reflected Beam Solar Radiation Energy [J]
Zone,Average,Surface Window Inside Reveal Absorbed Beam Solar Radiation Rate [W]

Zone,Average,Surface Window Inside Face Glazing Condensation Status []

Zone,Average,Surface Window Inside Face Frame Condensation Status []
Zone,Average,Surface Window Inside Face Divider Condensation Status []
Zone,Average,Surface Shading Device Is On Time Fraction[]
Zone,Average,Surface Window Blind Slat Angle [deg]
Zone,Average,Surface Window Blind Beam to Beam Solar Transmittance[]
Zone,Average,Surface Window Blind Beam to Diffuse Solar Transmittance[]
Zone,Average,Surface Window Blind Diffuse to Diffuse Solar Transmittance[]
Zone,Average,Surface Window Blind and Glazing System Beam Solar Transmittance[]
Zone,Average,Surface Window Blind and Glazing System Diffuse Solar Transmittance[]
Zone,Average,Surface Window Screen Beam to Beam Solar Transmittance []
Zone,Average,Surface Window Screen Beam to Diffuse Solar Transmittance []
Zone,Average,Surface Window Screen Diffuse to Diffuse Solar Transmittance []
Zone,Average,Surface Window Screen and Glazing System Beam Solar Transmittance []
Zone,Average,Surface Window Screen and Glazing System Diffuse Solar Transmittance []
Zone,State,Surface Storm Window On Off Status []
Zone,Average,Surface Window Inside Face Frame and Divider Zone Heat Gain Rate [W]
Zone,Average,Surface Window Frame Heat Gain Rate [W]
Zone,Average,Surface Window Frame Heat Loss Rate [W]
Zone,Average,Surface Window Divider Heat Gain Rate [W]

9/29/14

227

Input-Output Reference
Zone,Average,Surface
Zone,Average,Surface
Zone,Average,Surface
Zone,Average,Surface
Zone,Average,Surface

Window
Window
Window
Window
Window

Group Thermal Zone Description/Geometry

Divider Heat Loss Rate [W]
Frame Inside Temperature [C]
Frame Outside Temperature [C]
Divider Inside Temperature [C]
Divider Outside Temperature [C]

If the user requests to display advanced report/output variables (e.g. see Output:Diagnostics
keyword DisplayAdvancedReportVariables) the the following additional output variables are
available for exterior windows and glass doors
Zone,Average,Surface
Zone,Average,Surface
Zone,Average,Surface
Zone,Average,Surface
Zone,Average,Surface
Zone,Average,Surface
Zone,Average,Surface

Window
Window
Window
Window
Window
Window
Window

Inside Face Glazing Zone Convection Heat Gain Rate [W]

Inside Face Glazing Net Infrared Heat Transfer Rate [W]
Shortwave from Zone Back Out Window Heat Transfer Rate [W]
Inside Face Frame and Divider Zone Heat Gain Rate [W]
Inside Face Gap between Shade and Glazing Zone Convection Heat Gain Rate [W]
Inside Face Shade Zone Convection Heat Gain Rate [W]
Inside Face Shade Net Infrared Heat Transfer Rate [W]

Output variables applicable only to interior windows and glass doors:

Zone,Average, Surface Window Transmitted Beam Solar Radiation Rate [W]
Zone,Sum,Surface Window Transmitted Beam Solar Radiation Energy [J]

If the user requests to display advanced report/output variables (e.g. see Output:Diagnostics
keyword DisplayAdvancedReportVariables) the the following additional output variable is
available for Equivalent Layer Window;
Zone,Average, Surface Window Inside Face Other Convection Heat Gain Rate [W]

Output variables applicable to interior and exterior windows and doors are:
Zone,Average,Surface Window Total Absorbed Shortwave Radiation Rate Layer <x> [W]
Zone,Average,Surface Window Front Face Temperature Layer <x> [C]
Zone,Average,Surface Window Back Face Temperature Layer <x> [C]

Surface Window Total Absorbed Shortwave Radiation Rate Layer <x> [W]
This will output shortwave radiation absorbed in a window layer. The key values for this
output variable are the surface name. Layers are numbered from the outside to the inside of
the surface. The full listing will appear in the RDD file.
Surface Window Front Face Temperature Layer <x> [C]
This will output a temperature for the front face of the layer. The layer front face is considered
to be the face closest to the outside environment. The full listing will appear in the RDD file.
Surface Window Back Face Temperature Layer <x> [C]
This will output a temperature for the back face of the layer. The layer back face is
considered to be the face closest to the inside environment. The full listing will appear in the
RDD file.
Surface Output Variables (all heat transfer surfaces)
The various output variables related to surface heat transfer are organized around the inside
and outside face of each surface. The zone heat balance model draws energy balances at
each side, or face, of a surface and so each surface essentially has two sets of results. The
inside face is the side of a heat transfer surface that faces toward the thermal zone. The
outside face is the side of a heat transfer surface that faces away from the thermal zone,
typically facing outdoors. The Key Value for these is generally the user-defined name of the
surface.
Surface Inside Face Heat Balance Calculation Iteration Count []
This output is the number of iterations used in a part of the solution for surface heat transfer
that accounts for thermal radiation heat transfer between zone surfaces. This is simply a
counter on the iteration loop for inside face surface modeling. There is only one instance of
this output in a given run and the Key Value is Simulation.
9/29/14

228

Input-Output Reference

Group Thermal Zone Description/Geometry

Surface Inside Face Temperature [C]

This is the temperature of the surfaces inside face, in degrees Celsius. Former Name: Prior
to version 7.1 this output was called Surface Inside Temperature.
Surface Outside Face Temperature [C]
This is the temperature of the surfaces outside face, in degrees Celsius. Former Name:
Prior to version 7.1, this output was called Surface Outside Temperature.
Surface Inside Face Adjacent Air Temperature [C]
This is the effective bulk air temperature used for modeling the inside surface convection heat
transfer. This is the same as the zone mean air temperature when using the mixing model for
roomair. However, if more advanced roomair models are used, this variable will report the air
temperature predicted by the roomair model as it was used in the surface heat balance model
calculations. Former Name: Prior to version 7.1, this output was called Surface Int Adjacent
Air Temperature.
Surface Inside Face Convection Heat Gain Rate [W]
Surface Inside Face Convection Heat Gain Rate per Area [W/m2]
Surface Inside Face Convection Heat Gain Energy [J]
These inside face convection heat gain output variables describe the heat transferred by
convection between the inside face and the zone air. The values can be positive or negative
with positive indicating heat is being added to the surfaces face by convection. Different
versions of the report are available including the basic heat gain rate (W), and a per unit area
flux (W/m2), and an energy version (J).
Former Name: Prior to version 7.1, these outputs were called Surface Int Convection Heat *
and had used the opposite sign convention.
Surface Inside Face Convection Heat Transfer Coefficient [W/m2-K]
This is the coefficient that describes the convection heat transfer. It is the value of Hc in the
classic convection model Q = Hc* A* (T T). This is the result of the surface convection
algorithm used for the inside face. Former Name: Prior to version 7.1, this output was called
Surface Int Convection Coeff.
Surface Inside Face Net Surface Thermal Radiation Heat Gain Rate [W]
Surface Inside Face Net Surface Thermal Radiation Heat Gain Rate per Area [W/m2]
Surface Inside Face Net Surface Thermal Radiation Heat Gain Energy [J]
These inside face net surface thermal radiation heat gain output variables describe the heat
transferred by longwave infrared thermal radiation exchanges between the inside faces of
other surfaces in the zone. The values can be positive or negative with positive indicating
heat is being added to the surfaces face by thermal radiation. Different versions of the report
are available including the basic heat gain rate (W), and a per unit area flux (W/m2), and an
energy version (J).
Surface Inside Face Solar Radiation Heat Gain Rate [W]
Surface Inside Face Solar Radiation Heat Gain Rate per Area [W/m2]
Surface Inside Face Solar Radiation Heat Gain Energy [J]
These inside face solar radiation heat gain output variables describe the heat transferred by
solar radiation onto the inside face. The values are always positive and indicate heat is being
added to the surfaces face by solar radiation. This is sunlight that has entered the zone
through a window and been absorbed on the inside face of the surface. Different versions of

9/29/14

229

Input-Output Reference

Group Thermal Zone Description/Geometry

the report are available including the basic heat gain rate (W), and a per unit area flux
(W/m2), and an energy version (J).
Surface Inside Face Lights Radiation Heat Gain Rate [W]
Surface Inside Face Lights Radiation Heat Gain Rate per Area [W/m2]
Surface Inside Face Lights Radiation Heat Gain Energy [J]
These inside face lights radiation heat gain output variables describe the heat transferred by
shortwave radiation onto the inside face. The values are always positive and indicate heat is
being added to the surfaces face by shortwave radiation that emanated from electric lighting
equipment and was absorbed by the surface. Different versions of the report are available
including the basic heat gain rate (W), and a per unit area flux (W/m2), and an energy version
(J).
Surface Inside Face Internal Gains Radiation Heat Gain Rate [W]
Surface Inside Face Internal Gains Radiation Heat Gain Rate per Area [W/m2]
Surface Inside Face Internal Gains Radiation Heat Gain Energy [J]
These inside face internal gains radiation heat gain output variables describe the heat
transferred by longwave infrared thermal radiation onto the inside face that emanated from
internal gains such as lights, electric equipment, and people. The values are always positive
and indicate heat is being added to the surfaces face by the absorption of longwave thermal
radiation. Different versions of the report are available including the basic heat gain rate (W),
and a per unit area flux (W/m2), and an energy version (J).
Surface Inside Face System Radiation Heat Gain Rate [W]
Surface Inside Face System Radiation Heat Gain Rate per Area [W/m2]
Surface Inside Face System Radiation Heat Gain Energy [J]
These inside face system radiation heat gain output variables describe the heat transferred
by infrared thermal radiation onto the inside face that emanated from HVAC equipment such
as baseboard heaters or high-temperature radiant heating panels. The values are always
positive and indicate heat is being added to the surfaces face by the absorption of thermal
radiation. Different versions of the report are available including the basic heat gain rate (W),
and a per unit area flux (W/m2), and an energy version (J).
Surface Outside Face Convection Heat Gain Rate [W]
Surface Outside Face Convection Heat Gain Rate per Area [W/m2]
Surface Outside Face Convection Heat Gain Energy [J]
These outside face convection output variables describe heat transferred by convection
between the outside face and the surrounding air. The values can be positive or negative
with positive values indicating heat is added to the surface face by convection heat transfer.
Different versions of the report are available including the basic heat gain rate (W), and a per
unit area flux (W/m2), and an energy version (J).
Former Name: Prior to version 7.1, these outputs were called Surface Ext Convection Heat
* and used the opposite sign convention.
Surface Outside Face Convection Heat Transfer Coefficient [W/m2-K]
This is the coefficient that describes the convection heat transfer. It is the value of Hc in the
classic convection model Q = Hc* A* (T T). This is the result of the surface convection
algorithm used for the outside face. Former Name: Prior to Version 7.1, this output was called
Surface Ext Convection Coeff.

9/29/14

230

Input-Output Reference

Group Thermal Zone Description/Geometry

Surface Outside Face Net Thermal Radiation Heat Gain Rate [W]
Surface Outside Face Net Thermal Radiation Heat Gain Rate per Area [W/m2]
Surface Outside Face Net Thermal Radiation Heat Gain Energy [J]
These outside face net thermal radiation output variables describe the heat transferred by
longwave infrared thermal radiation exchanges between the surface and the surroundings of
the outside face. This is the net of all forms of longwave thermal infrared radiation heat
transfer. The values can be positive or negative with positive indicating the net addition of
heat to the outside face. Different versions of the report are available including the basic heat
gain rate (W), and a per unit area flux (W/m2), and an energy version (J).
Former Name: Prior to version 7.1, these outputs were called Surface Ext Thermal Radiation
Heat * and used the opposite sign convention.
Surface Inside Face Exterior Windows Incident Beam Solar Radiation Rate [W]
Surface Inside Face Exterior Windows Incident Beam Solar Radiation Rate per Area
[W/m2]
Surface Inside Face Exterior Windows Incident Beam Solar Radiation Energy [J]
Beam solar radiation from the exterior windows in a zone incident on the inside face of a
surface in the zone. If Solar Distribution in the BUILDING object is equal to
MinimalShadowing or FullExterior, it is assumed that all beam solar from exterior windows
falls on the floor. In this case the value of this output variable can be greater than zero only
for floor surfaces. If Solar Distribution equals FullInteriorExterior the program tracks where
beam solar from exterior windows falls inside the zone, in which case the value of this
variable can be greater than zero for floor as well as wall surfaces. Different versions of the
report are available including the basic incident rate (W), a per unit area flux (W/m2), and an
energy version (J).

Surface Inside Face Interior Windows Incident Beam Solar Radiation Rate [W]
Surface Inside Face Interior Windows Incident Beam Solar Radiation Rate per Area [W/m2]
Surface Inside Face Interior Windows Incident Beam Solar Radiation Energy [J]
Beam solar radiation from the interior (i.e., interzone) windows in a zone incident on the
inside face of a surface in the zone. This value is calculated only if Solar Distribution in the
BUILDING object is equal to FullInteriorExterior. However, the program does not track where
this radiation falls. Instead, it is treated by the program as though it were diffuse radiation
uniformly distributed over all of the zone surfaces. See Figure 31. Different versions of the
report are available including the basic incident rate (W), a per unit area flux (W/m2), and an
energy version (J).

9/29/14

231

Input-Output Reference

Group Thermal Zone Description/Geometry

Interior window
Beam solar
radiation

Treated as
diffuse

Figure 31. Beam solar radiation entering a zone through an interior window is distributed inside the zone
as though it were diffuse radiation.

Surface Inside Face Initial Transmitted Diffuse Absorbed Solar Radiation Rate [W]
As of Version 2.1, diffuse solar transmitted through exterior and interior windows is no longer
uniformly distributed. Instead, it is distributed according to the approximate view factors
between the transmitting window and all other heat transfer surfaces in the zone. This
variable is the amount of transmitted diffuse solar that is initially absorbed on the inside of
each heat transfer surface. The portion of this diffuse solar that is reflected by all surfaces in
the zone is subsequently redistributed uniformly to all heat transfer surfaces in the zone,
along with interior reflected beam solar and shortwave radiation from lights. The total
absorbed shortwave radiation is given by the next variable.
Surface Inside Face Absorbed Shortwave Radiation Rate [W]
As of Version 2.1, the previous variable plus absorbed shortwave radiation from uniformly
distributed initially-reflected diffuse solar, reflected beam solar, and shortwave radiation from
lights. This sum is the power of all sources of solar and visible radiation absorbed by the
surface at the inside face.
Surface Output Variables (exterior heat transfer surfaces)
Surface Outside Face Outdoor Air Drybulb Temperature [C]
The outdoor air dry-bulb temperature calculated at the height above ground of the surface
centroid. Former Name: Prior to version 7.1, this output was called Surface Ext Outdoor Dry
Bulb.
Surface Outside Face Outdoor Air Wetbulb Temperature [C]
The outdoor air wet-bulb temperature calculated at the height above ground of the surface
centroid. Former Name: Prior to version 7.1, this output was called Surface Ext Outdoor Wet
Bulb.
Surface Outside Face Outdoor Air Wind Speed [m/s]
The outdoor wind speed calculated at the height above ground of the surface centroid.
Former Name: Prior to version 7.1, this output was called Surface Ext Wind Speed.
Surface Outside Face Sunlit Area [m2]
The outside area of an exterior surface that is illuminated by (unreflected) beam solar
radiation.
Surface Outside Face Sunlit Fraction []
The fraction of the outside area of an exterior surface that is illuminated by (unreflected)
beam solar radiation. Equals Surface Outside Face Sunlit Area divided by total surface area.
Surface Outside Face Thermal Radiation to Air Heat Transfer Coefficient [W/m2-K]
This is the coefficient that describes thermal radiation heat transfer between the outside face
and the air mass surrounding the surface. It is the value of Hr in the classic linearized
model for thermal radiation Q = Hr * A * (T T) when applied to the ambient air. Former
Name: Prior to version 7.1, this output was called Surface Ext Rad to Air Coeff.
9/29/14

232

Input-Output Reference

Group Thermal Zone Description/Geometry

Surface Outside Face Thermal Radiation to Sky Heat Transfer Coefficient [W/m2-K]
This is the coefficient that describes thermal radiation heat transfer between the outside face
and the sky surrounding the surface. It is the value of Hr in the classic linearized model for
thermal radiation Q = Hr * A * (T T) when applied to the sky. Former Name: Prior to version
7.1, this output was called Surface Ext Rad to Sky Coeff.
Surface Outside Face Thermal Radiation to Ground Heat Transfer Coefficient [W/m2-K]
This is the coefficient that describes thermal radiation heat transfer between the outside face
and the ground surrounding the surface. It is the value of Hr in the classic linearized model
for thermal radiation Q = Hr * A * (T T) when applied to the ground. Former Name: Prior to
version 7.1, this output was called Surface Ext Rad to Ground Coeff.
Surface Outside Face Solar Radiation Heat Gain Rate [W]
Surface Outside Face Solar Radiation Heat Gain Rate per Area [W/m2]
Surface Outside Face Solar Radiation Heat Gain Energy [J]
These outside face solar radiation output variables describe the heat transferred by the
absorption of solar radiation at the outside face. This is the result of incident solar radiation
being absorbed at the surface face. The values are always positive.
Surface Outside Face Incident Solar Radiation Rate per Area [W/m2]
The total solar radiation incident on the outside of an exterior surface. It is the sum of:
Surface Outside Face Incident Beam Solar Radiation Rate per Area
Surface Outside Face Incident Sky Diffuse Solar Radiation Rate per Area
Surface Outside Face Incident Ground Diffuse Solar Radiation Rate per Area
Surface Outside Face Incident Sky Diffuse Surface Reflected Solar Radiation Rate per
Area
Surface Outside Face Incident Beam To Beam Surface Reflected Solar Radiation Rate
per Area
Surface Outside Face Incident Sky Diffuse Surface Reflected Solar Radiation Rate per
Area
Surface Outside Face Incident Beam Solar Radiation Rate per Area [W/m2]
The solar beam radiation incident on the outside of an exterior surface, including the effects
of shadowing, if present. The beam here is that directly from the sun; it excludes beam
specularly reflected from obstructions.
Surface Outside Face Incident Sky Diffuse Solar Radiation Rate per Area [W/m2]
The solar diffuse radiation from the sky incident on the outside of an exterior surface,
including the effects of shadowing, if present.
Surface Outside Face Incident Ground Diffuse Solar Radiation Rate per Area [W/m2]
The solar diffuse radiation incident on the outside of an exterior surface that arises from
reflection of beam solar and sky diffuse solar from the ground. This is the sum of the next two
output variables, Surface Outside Face Incident Beam To Diffuse Ground Reflected Solar
Radiation Rate per Area and Surface Outside Face Incident Sky Diffuse Ground Reflected
Solar Radiation Rate per Area. The reflected solar radiation from the ground is assumed to
be diffuse and isotropic (there is no specular component).
If Reflections option is not chosen in the Solar Distribution Field in the BUILDING object, the
effects of shadowing are accounted for by the user-specified value of View Factor to Ground
for the surface. If Reflections option is chosen, the program determines the effects of
shadowing, including time-varying shadowing of the ground plane by the building itself.

9/29/14

233

Input-Output Reference

Group Thermal Zone Description/Geometry

Surface Outside Face Incident Beam To Diffuse Ground Reflected Solar Radiation Rate per
Area [W/m2]
The solar diffuse radiation incident on the outside of an exterior surface that arises from
beam-to-diffuse reflection from the ground. It is assumed that there is no beam-to-beam
(specular) component. The beam here is that directly from the sun; it excludes beam
specularly reflected from obstructions.
Surface Outside Face Incident Sky Diffuse Ground Reflected Solar Radiation Rate per Area
[W/m2]
The solar diffuse radiation incident on the outside of an exterior surface that arises from sky
diffuse solar reflection from the ground. The sky diffuse here is that directly from the sky; it
excludes reflection of sky diffuse from obstructions.
Surface Outside Face Incident Sky Diffuse Surface Reflected Solar Radiation Rate per
Area [W/m2]
The solar diffuse radiation incident on the outside of an exterior surface that arises from sky
diffuse reflection from one or more obstructions. This value will be non-zero only if
Reflections option is chosen in the BUILDING object.
Surface Outside Face Incident Beam To Beam Surface Reflected Solar Radiation Rate per
Area [W/m2]
The solar beam radiation incident on the outside of an exterior surface that arises from beamto-beam (specular) reflection from one or more obstructions. This value will be non-zero only
if Reflections option is chosen in the BUILDING object. For windows, the program treats this
beam radiation as diffuse radiation in calculating its transmission and absorption.
Surface Outside Face Incident Beam To Diffuse Surface Reflected Solar Radiation Rate per
Area [W/m2]
The solar diffuse radiation incident on the outside of an exterior surface that arises from
beam-to-diffuse reflection from building shades or building surfaces. This value will be nonzero only if Reflections option is chosen in the BUILDING object.
Surface Outside Face Beam Solar Incident Angle Cosine Value []
The cosine of the angle of incidence of (unreflected) beam solar radiation on the outside of
an exterior surface. The value varies from 0.0 for beam parallel to the surface (incidence
angle = 90O) to 1.0 for beam perpendicular to the surface (incidence angle = 0 O). Negative
values indicate the sun is behind the surface, i.e the surface does not see the sun.
Surface Anisotropic Sky Multiplier []
This is the view factor multiplier for diffuse sky irradiance on exterior surfaces taking into
account the anisotropic radiance of the sky. The diffuse sky irradiance on a surface is given
by Anisotropic Sky Multiplier * Diffuse Solar Irradiance.
Surface Window BSDF Beam Direction Number []
Surface Window BSDF Beam Phi Angle [rad]
Surface Window BSDF Beam Theta Angle [rad]
Opaque Surface Output Variables
The following variables apply only to opaque surfaces, where an opaque surface is
considered here to be an exterior or interzone heat transfer surface of class FLOOR, WALL,
ROOF or DOOR. Note these are advanced variables you must read the descriptions
and understand before use then you must use the Output:Diagnostics object to allow
reporting.

9/29/14

234

Input-Output Reference

Group Thermal Zone Description/Geometry

Surface Inside Face Conduction Heat Transfer Rate [W]

Surface Inside Face Conduction Heat Transfer Rate per Area [W/m2]
Surface Inside Face Conduction Heat Gain Rate [W]
Surface Inside Face Conduction Heat Loss Rate [W]
These inside face conduction output variables describe heat flow by conduction right at the
inside face of an opaque heat transfer surface. A positive value means that the conduction is
from just inside the inside face toward the inside face. A negative value means that the
conduction is from the inside face into the core of the heat transfer surface.
Note that Inside Face Conduction, when positive, does not indicate the heat flow from the
surface to the zone air, which is governed by the inside face convection coefficient and the
difference in temperature between the inside face and the zone air.
Different versions of the reports are available. The basic heat gain rate (W) and a per unit
area flux (W/m2) can have positive or negative values with the sign convention that positive
indicates heat flowing toward the face itself. There are also directed gain and loss
versions that have only positive values or zero when the heat flow direction opposes.
Former Name: Prior to version 7.1, these outputs were called Opaque Surface Inside Face
Conduction *.
Former Name: For Conduction Finite Difference simulations (CondFD), CondFD Inside
Surface Heat Flux is replaced with Surface Inside Face Conduction Heat Transfer Rate Per
Area. Likewise for CondFD Inside Heat Flux to Surface.
Surface Outside Face Conduction Heat Transfer Rate [W]
Surface Outside Face Conduction Heat Transfer Rate per Area [W/m2]
Surface Outside Face Conduction Heat Gain Rate [W]
Surface Outside Face Conduction Heat Loss Rate [W]
These outside face conduction output variables describe heat flow by conduction right at the
outside face of an opaque heat transfer surface. A positive value means that the conduction
is from just inside the outside face toward the outside face. A negative value means that the
conduction is from the outside face into the core of the heat transfer surface.
Note that outside face conduction, when positive, does not indicate the heat flow from the
surface to the surrounding air, which is governed by the outside face convection coefficient
and the difference in temperature between the inside face and the surrounding air.
Different versions of the reports are available. The basic heat transfer rate (W) and a per unit
area flux (W/m2) can have positive or negative values with the sign convention that positive
indicates heat flowing toward the face itself. There are also directed gain and loss
versions that have only positive values or zero when the heat flow direction opposes.
Former Name: For Conduction Finite Difference simulations (CondFD), CondFD Outside
Surface Heat Flux is replaced with Surface Outside Face Conduction Heat Transfer Rate Per
Area. Likewise for CondFD Outside Heat Flux to Surface.
Surface Average Face Conduction Heat Transfer Rate [W]
Surface Average Face Conduction Heat Transfer Rate per Area [W/m2]
Surface Average Face Conduction Heat Gain Rate [W]
Surface Average Face Conduction Heat Loss Rate [W]
Surface Average Face Conduction Heat Transfer Energy [J]
These average face conduction output variables combine the inside face conduction and
outside face conduction reports together to describe the conduction situation in a heat
transfer surface in a nominal way. This is simply the average of the inside and outside face
9/29/14

235

Input-Output Reference

Group Thermal Zone Description/Geometry

conduction rates, but with the sign convention for the outside face switched to match the
inside face so that positive values here indicate heat flowing into the thermal zone.
Different versions of the reports are available. The basic heat conduction rate (W) and a per
unit area flux (W/m2) can have positive or negative values with the sign convention that
positive indicates heat flowing toward the thermal zone. There are also directed gain and
loss versions that have only positive values or zero when the heat flow direction opposes
(W). Finally there is a version for total energy transfer (J).
Surface Heat Storage Rate [W]
Surface Heat Storage Rate per Area [W/m2]
Surface Heat Storage Gain Rate [W]
Surface Heat Storage Loss Rate [W]
Surface Heat Storage Energy [J]
These heat storage output variables combine the inside face conduction and outside face
conduction reports together to describe the thermal storage situation in a heat transfer
surface in a nominal way. This is simply the difference between the inside and outside face
conduction, but with the sign convention arranged so that positive values indicate heat being
added to the core of the surface.
Different versions of the reports are available. The basic heat storage rate (W) and a per unit
area flux (W/m2) can have positive or negative values with the sign convention that positive
indicates heat being added to the surfaces mass. There are also directed gain and loss
versions that have only positive values or zero when the heat storage direction opposes (W).
Finally there is a version for total energy stored (J).
Surface Internal Source Location Temperature [C]
When a surface has an internal source or sink (defined using Construction:InternalSource)
then this output is available for the temperature within the surface at the location of the
source/sink.
Zone Opaque Surface Inside Face Conduction [W]
The sum of the Opaque Surface Inside Face Conduction values for all opaque surfaces in a
zone for both positive and negative sums. For example, assume a zone has six opaque
surfaces with Opaque Surface Inside Face Conduction values of 100, -200, 400, 50, 150 and
300 W. Then Zone Opaque Surface Inside Face Conduction = 700 - 500 = 200 W. Or if a
zone has six opaque surfaces with Opaque Surface Inside Face Conduction values of -100, 200, 400, -50, 150 and 300W. Then Zone Opaque Surface Inside Face Conduction = 550
650 = -100 W.
Zone Opaque Surface Inside Faces Total Conduction Heat Gain Rate [W]
Zone Opaque Surface Inside Faces Total Conduction Heat Gain Energy [J]
These are the power and energy sums for the Opaque Surface Inside Face Conduction
values for all opaque surfaces in a zone when that sum is positive. For example, assume a
zone has six opaque surfaces with Opaque Surface Inside Face Conduction values of 100, 200, 400, 50, 150 and 300 W. Then Zone Opaque Surface Inside Faces Total Conduction
Heat Gain Rate = 700 - 500 = 200 W.
Zone Opaque Surface Inside Faces Total Conduction Heat Loss Rate [W]
Zone Opaque Surface Inside Faces Total Conduction Heat Loss Energy [J]
These are the power and energy absolute value for the sums of the Opaque Surface Inside
Face Conduction values for all opaque surfaces in a zone when that sum is negative. For
example, assume a zone has six opaque surfaces with Opaque Surface Inside Face
Conduction
values
of
-100,
-200,
400,
9/29/14

236

Input-Output Reference

Group Thermal Zone Description/Geometry

-50, 150 and 300W. Then Zone Opaque Surface Inside Faces Total Conduction Heat Loss
Rate = |550 650| = |-100| = 100 W.
Zone Opaque Surface Outside Face Conduction [W]
The sum of the Opaque Surface Outside Face Conduction values for all opaque surfaces in a
zone for both positive and negative sums. For example, assume a zone has six opaque
surfaces with Opaque Surface Outside Face Conduction values of 100, -200, 400, 50, 150
and 300 W. Then Zone Opaque Surface Outside Face Conduction = 700 - 500 = 200 W. Or
if a zone has six opaque surfaces with Opaque Surface Outside Face Conduction values of 100, -200, 400, -50, 150 and 300W. Then Zone Opaque Surface Outside Face Conduction
= 550 650 = -100 W.
Zone Opaque Surface Outside Face Conduction Gain [W]
Zone Opaque Surface Outside Face Conduction Gain Energy [J]
These are the power and energy sums for the Opaque Surface Outside Face Conduction
values for all opaque surfaces in a zone when that sum is positive. For example, assume a
zone has six opaque surfaces with Opaque Surface Outside Face Conduction values of 100,
-200, 400, 50, 150 and 300 W. Then Zone Opaque Surface Outside Face Conduction Gain
= 700 - 500 = 200 W.
Zone Opaque Surface Outside Face Conduction Loss [W]
Zone Opaque Surface Outside Face Conduction Loss Energy [J]
These are the power and energy absolute value for the sums of the Opaque Surface Outside
Face Conduction values for all opaque surfaces in a zone when that sum is negative. For
example, assume a zone has six opaque surfaces with Opaque Surface Outside Face
Conduction
values
of
-100,
-200,
400,
-50, 150 and 300W. Then Zone Opaque Surface Outside Face Conduction Loss = |550
650| = |-100| = 100 W.
Surface Inside Face Beam Solar Radiation Heat Gain Rate [W]
Beam solar radiation from exterior windows absorbed on the inside face of an opaque heat
transfer surface. For Solar Distribution = FullInteriorAndExterior, this quantity can be non-zero
for both floor and wall surfaces. Otherwise, for Solar Distribution = FullExterior or
MinimalShadowing, it can be non-zero only for floor surfaces since in this case all entering
beam solar is assumed to fall on the floor. Note that this variable will not be operational (have
a real value) unless there are exterior windows in the zone.
Window Output Variables
The following output variables apply to subsurfaces that are windows or glass doors. These
two subsurface types are called window here. Exterior window means that the base
surface of the window is an exterior wall, floor, roof or ceiling (i.e., the base surface is a
BuildingSurface:Detailed with OutsideFaceEnvironment = ExteriorEnvironment). Interior
window means that the base surface of the window is an inter-zone wall, floor or ceiling.
Glass means a transparent solid layer, usually glass, but possibly plastic or other
transparent material. Shading device means an interior, exterior or between-glass shade or
blind, or an exterior screen (only exterior windows can have a shading device).
Zone Windows Total Transmitted Solar Radiation Rate [W]
Zone Windows Total Transmitted Solar Radiation Energy [J]
The total Surface Window Transmitted Solar Radiation Rate of all the exterior windows in a
zone.

9/29/14

237

Input-Output Reference

Group Thermal Zone Description/Geometry

Zone Windows Total Heat Gain Rate [W]

Zone Windows Total Heat Gain Energy [J]
The sum of the heat flow from all of the exterior windows in a zone when that sum is positive.
(See definition of heat flow under Window Heat Gain, below.)
Zone Windows Total Heat Loss Rate [W]
Zone Windows Total Heat Loss Energy [J]
The absolute value of the sum of the heat flow from all of the exterior windows in a zone
when that sum is negative.
Surface Window Total Glazing Layers Absorbed Shortwave Radiation Rate [W]
Surface Window Total Glazing Layers Absorbed Solar Radiation Rate [W]
Surface Window Total Glazing Layers Absorbed Solar Radiation Energy [J]
The total exterior beam and diffuse solar radiation absorbed in all of the glass layers of an
exterior window.
Surface Window Shading Device Absorbed Solar Radiation Rate [W]
Surface Window Shading Device Absorbed Solar Radiation Energy [J]
The exterior beam and diffuse solar radiation absorbed in the shading device, if present, of
an exterior window.
Surface Window Transmitted Solar Radiation Rate [W]
Surface Window Transmitted Solar Radiation Energy [J]
The amount of beam and diffuse solar radiation entering a zone through an exterior window.
It is the sum of the following two variables, Surface Window Transmitted Beam Solar
Radiation Rate and Surface Window Transmitted Diffuse Solar Radiation Rate.
Surface Window Transmitted Beam Solar Radiation Rate [W]
Surface Window Transmitted Beam Solar Radiation Energy [J]
The solar radiation transmitted by an exterior window whose source is beam solar incident on
the outside of the window. For a bare window, this transmitted radiation consists of beam
radiation passing through the glass (assumed transparent) and diffuse radiation from beam
reflected from the outside window reveal, if present. For a window with a shade, this
transmitted radiation is totally diffuse (shades are assumed to be perfect diffusers). For a
window with a blind, this transmitted radiation consists of beam radiation that passes
between the slats and diffuse radiation from beam-to-diffuse reflection from the slats. For a
window with a screen, this value consists of direct beam radiation that is transmitted through
the screen (gaps between the screen material) and diffuse radiation from beam-to-diffuse
reflection from the screen material.
For each zone time step,
Surface Window Transmitted Beam Solar Radiation Rate = Surface Window Transmitted
Beam To Beam Solar Radiation Rate + Surface Window Transmitted Beam To Diffuse
Solar Radiation Rate
Surface Window Transmitted Beam Solar Radiation Energy = Surface Window
Transmitted Beam To Beam Solar Radiation Energy + Surface Window Transmitted
Beam To Diffuse Solar Radiation Energy

9/29/14

238

Input-Output Reference

Group Thermal Zone Description/Geometry

Surface Window Transmitted Beam To Beam Solar Radiation Rate [W]

Surface Window Transmitted Beam To Beam Solar Radiation Energy [J]
For a window with a blind, this transmitted radiation consists of beam radiation that passes
between the slats. For a window with a screen, this value consists of direct beam radiation
that is transmitted through the screen (gaps between the screen material).
Surface Window Transmitted Beam To Diffuse Solar Radiation Rate [W]
Surface Window Transmitted Beam To Diffuse Solar Radiation Energy [J]
For a window with a blind, this transmitted radiation consists of diffuse radiation reflected
from beam by the slats. For a window with a screen, this value consists of diffuse radiation
reflected by the screen material.
Zone Exterior Windows Total Transmitted Beam Solar Radiation Rate [W]
Zone Exterior Windows Total Transmitted Beam Solar Radiation Energy [J]
The sum of the Surface Window Transmitted Beam Solar Radiation Rate (see definition
above) from all exterior windows in a zone.
Zone Interior Windows Total Transmitted Beam Solar Radiation Rate [W]
Zone Interior Windows Total Transmitted Beam Solar Radiation Energy [J]
The sum of the Surface Window Transmitted Beam Solar Radiation Rate (see definition
above) from all interior windows in a zone.
Surface Window Transmitted Diffuse Solar Radiation Rate [W]
Surface Window Transmitted Diffuse Solar Radiation Energy [J]
The solar radiation transmitted by an exterior window whose source is diffuse solar incident
on the outside of the window. For a bare window, this transmitted radiation consists of diffuse
radiation passing through the glass. For a window with a shade, this transmitted radiation is
totally diffuse (shades are assumed to be perfect diffusers). For a window with a blind, this
transmitted radiation consists of diffuse radiation that passes between the slats and diffuse
radiation from diffuse-to-diffuse reflection from the slats. For a window with a screen, this
value consists of diffuse radiation transmitted through the screen (gaps between the screen
material) and diffuse radiation from diffuse-to-diffuse reflection from the screen material.
Zone Exterior Windows Total Transmitted Diffuse Solar Radiation Rate [W]
Zone Exterior Windows Total Transmitted Diffuse Solar Radiation Energy [J]
The combined beam and diffuse solar that first entered adjacent zones through exterior
windows in the adjacent zones, was subsequently reflected from interior surfaces in those
zones (becoming diffuse through that reflection), and was then transmitted through interior
windows into the current zone.
Zone Interior Windows Total Transmitted Diffuse Solar Radiation Rate [W]
Zone Interior Windows Total Transmitted Diffuse Solar Radiation Energy [J]
The sum of the Surface Window Transmitted Diffuse Solar Radiation Rate (see definition
above) from all interior windows in a zone.
Surface Window System Solar Transmittance []
Effective solar transmittance of an exterior window, including effect of shading device, if
present. Equal to Surface Window Transmitted Solar Radiation Rate divided by total
exterior beam plus diffuse solar radiation incident on the window (excluding frame, if present).

9/29/14

239

Input-Output Reference

Group Thermal Zone Description/Geometry

Surface Window System Solar Absorptance []

Effective solar absorptance of an exterior window, including effect of shading device, if
present. Equal to Window Solar Absorbed: All Glass Layers plus Window Solar Absorbed:
Shading Device divided by total exterior beam plus diffuse solar radiation incident on window
(excluding frame, if present)
Surface Window System Solar Reflectance []
Effective solar reflectance of an exterior window, including effect of shading device, if
present. Equal to: [1.0 Surface Window System Solar Transmittance Surface Window
System Solar Absorptance].
Surface Window Gap Convective Heat Transfer Rate [W]
Surface Window Gap Convective Heat Transfer Energy [J]
For an airflow window, the forced convective heat flow from the gap through which airflow
occurs. This is the heat gained (or lost) by the air from the glass surfaces (and between-glass
shading device surfaces, if present) that the air comes in contact with as it flows through the
gap. If the gap airflow goes to the zone indoor air, the gap convective heat flow is added to
the zone load. Applicable to exterior windows only.
Surface Window Heat Gain Rate [W]
Surface Window Heat Gain Energy [J]
The total heat flow to the zone from the glazing, frame and divider of an exterior window
when the total heat flow is positive.
For a window without an interior shading device, this heat flow is equal to:
[Surface Window Transmitted Solar Radiation Rate (see definition, above)]
+ [Convective heat flow to the zone from the zone side of the glazing]
+ [Net IR heat flow to the zone from zone side of the glazing]
[Short-wave radiation from zone transmitted back out the window]
+ [Conduction to zone from window frame and divider, if present]
Here, short-wave radiation is that from lights and diffuse interior solar radiation.
For a window with an interior shading device, this heat flow is equal to:
[Surface Window Transmitted Solar Radiation Rate]
+ [Convective heat flow to the zone from the air flowing through the gap between glazing
and shading device]
+ [Convective heat flow to the zone from the zone side of the shading device]
+ [Net IR heat flow to the zone from the zone side of the glazing]
+ [Net IR heat flow to the zone from the zone side of the shading device]
[Short-wave radiation from zone transmitted back out the window]
+ [Conduction to zone from window frame and divider, if present]
The total window heat flow can also be thought of as the sum of the solar and conductive
gain from the window glazing.
Surface Window Heat Loss Rate [W]
Surface Window Heat Loss Energy [J]
The absolute value of the total heat flow through an exterior window when the total heat flow
is negative. (See definition of total heat flow under Surface Window Heat Gain Rate,
above.)

9/29/14

240

Input-Output Reference

Group Thermal Zone Description/Geometry

Surface Window Glazing Beam to Beam Solar Transmittance []

The fraction of exterior beam solar radiation incident on the glass of an exterior window that
is transmitted through the glazing as beam radiation. This is for the base window without
shading. Takes into account the angle of incidence of beam solar radiation on the glass.
Surface Window Glazing Beam to Diffuse Solar Transmittance []
The fraction of exterior beam solar radiation incident on the glazing of an exterior window that
is transmitted through the glazing as diffuse radiation.
Surface Window Glazing Diffuse to Diffuse Solar Transmittance []
The fraction of exterior diffuse solar radiation incident on the glass of an exterior window that
is transmitted through the glass assuming that the window has no shading device. It is
assumed that incident diffuse solar is transmitted only as diffuse with no beam component.
Surface Window Model Solver Iteration Count []
The number of iterations needed by the window-layer heat balance solution to converge.
Surface Window Solar Horizontal Profile Angle [deg]
For a vertical exterior window, this is an angle appropriate for calculating beam solar
quantities appropriate to horizontal window elements such as horizontal reveal surfaces,
horizontal frame and divider elements and horizontal slats of window blinds. It is defined as
the angle between the window outward normal and the projection of the suns ray on the
vertical plane containing the outward normal. See Figure 32.
For an exterior window of arbitrary tilt, it is defined as the angle between the window outward
normal the projection of the suns ray on the plane that contains the outward normal and is
perpendicular to the ground.
If the sun is behind the window, the horizontal profile angle is not defined and is reported as
0.0.
Note that in most texts what we call horizontal profile angle is called vertical profile angle.
Surface Window Solar Vertical Profile Angle [deg]
For a vertical exterior window, this is an angle appropriate for calculating beam solar
quantities appropriate to vertical window elements such as vertical reveal surfaces, vertical
frame and divider elements and vertical slats of window blinds. It is defined as the angle
between the window outward normal and the projection of the suns ray on the horizontal
plane containing the outward normal. See Figure 32.
For an exterior window of arbitrary tilt, it is defined as the angle between the window outward
normal the projection of the suns ray on the plane that contains the outward normal and is
perpendicular to the plane defined above for Surface Window Solar Horizontal Profile Angle
for a window of arbitrary tilt.
If the sun is behind the window, the vertical profile angle is not defined and is reported as 0.0.
Note that in most texts what we call vertical profile angle is called horizontal profile angle.

9/29/14

241

Input-Output Reference

Group Thermal Zone Description/Geometry

Sun
Incidence
angle
Window
Horizontal
profile angle
Window
outward
normal

Vertical
profile angle

Figure 32. Vertical exterior window showing solar horizontal profile angle, solar vertical profile angle and
solar incidence angle.
Surface Window Outside Reveal Reflected Beam Solar Radiation Rate [W]
Surface Window Outside Reveal Reflected Beam Solar Radiation Energy [J]
Beam solar radiation reflected from the outside reveal surfaces of a window (ref: Reveal
Surfaces under WindowProperty:FrameAndDivider object). There are both rate and energy
versions.
Surface Window Inside Reveal Reflected Beam Solar Radiation Rate [W]
Surface Window Inside Reveal Reflected Beam Solar Radiation Energy [J]
Beam solar radiation reflected from the inside reveal surfaces of a window (ref: Reveal
Surfaces under WindowProperty:FrameAndDivider object). There are both rate and energy
versions.
Surface Window Inside Reveal Absorbed Beam Solar Radiation Rate [W]
Beam solar radiation absorbed at the inside reveal surfaces of a window, in Watts.
Surface Window Inside Reveal Reflected Diffuse Zone Solar Radiation Rate [W]
Diffuse solar radiation reflected from inside reveal surfaces of a window into the zone, in
Watts.
Surface Window Inside Reveal Reflected Diffuse Frame Solar Radiation Rate [W]
Diffuse solar radiation reflected from inside reveal surfaces onto the frame surfaces of a
window, in Watts.
Surface Window Inside Reveal Reflected Diffuse Glazing Solar Radiation Rate [W]
Diffuse solar radiation reflected from inside reveal surfaces onto the glazing surfaces of a
window, in Watts.

9/29/14

242

Input-Output Reference

Group Thermal Zone Description/Geometry

Surface Window Inside Face Glazing Condensation Status []

A value of 1 means that moisture condensation will occur on the innermost glass face of an
exterior window (i.e., on the glass face in contact with the zone air). Otherwise the value is 0.
The condition for condensation is glass inside face temperature < zone air dewpoint
temperature.
For airflow exterior windows, in which forced air passes between adjacent glass faces in
double- and triple-pane windows, a value of 1 means that condensation will occur on one or
both of the glass faces in contact with the airflow. In this case the condition for condensation
is:
For airflow source = indoorair, temperature of either face in contact with airflow < zone air
dewpoint temperature.
For airflow source = outdoorair, temperature of either face in contact with airflow <
outside air dewpoint temperature.
As for regular windows, the value will also be 1 if condensation occurs on the innermost glass
face.
Surface Window Inside Face Frame Condensation Status []
If an exterior window has a frame and the value of this flag is 1, condensation will occur on
the inside surface of the frame. The condition for condensation is frame inside surface
temperature < zone air dewpoint temperature.
Surface Window Inside Face Divider Condensation Status []
If an exterior window has a divider and the value of this flag is 1, condensation will occur on
the inside surface of the divider. The condition for condensation is divider inside surface
temperature < zone air dewpoint temperature.
Surface Shading Device Is On Time Fraction []
The fraction of time that a shading device is on an exterior window. For a particular simulation
timestep, the value is 0.0 if the shading device is off (or there is no shading device) and the
value is 1.0 if the shading device is on. (It is assumed that the shading device, if present, is
either on or off for the entire timestep.) If the shading device is switchable glazing, a value of
0.0 means that the glazing is in the unswitched (light colored) state, and a value of 1.0 means
that the glazing is in the switched (dark colored) state.
For a time interval longer a timestep, this is the fraction of the time interval that the shading
device is on. For example, take the case where the time interval is one hour and the timestep
is 10 minutes. Then if the shading device is on for two timesteps in the hour and off for the
other four timesteps, then the fraction of time that the shading device is on = 2/6 = 0.3333.
Surface Window Blind Slat Angle [deg]
For an exterior window with a blind, this is the angle in degrees between the glazing outward
normal and the blind slat angle outward normal, where the outward normal points away from
the front face of the slat. The slat angle varies from 0 to 180 deg. If the slat angle is 0 deg or
180 deg, the slats are parallel to the glazing and the slats are said to be closed. If the slat
angle is 90 deg, the slats are perpendicular to the glazing and the slats are said to be fully
open. See illustrations under WindowMaterial:Blind. For blinds with a fixed slat angle, the
value reported here will be constant.
Surface Window Blind Beam to Beam Solar Transmittance []
For an exterior window with a blind, this is the fraction of exterior beam solar radiation
incident on the blind that is transmitted through the blind as beam solar radiation when the
blind is isolated (i.e., as though the window glass were not present). Depends on various
factors, including slat angle, width, separation, and thickness, and horizontal solar profile
angle (for blinds with horizontal slats) or vertical solar profile angle (for blinds with vertical

9/29/14

243

Input-Output Reference

Group Thermal Zone Description/Geometry

slats). The transmittance value reported here will be non-zero only when some beam solar
can pass through the blind without hitting the slats.
Surface Window Blind Beam to Diffuse Solar Transmittance []
For an exterior window with a blind, the fraction of exterior beam solar radiation incident on
the blind that is transmitted through the blind as diffuse solar radiation when the blind is
isolated (i.e., as though the window glass were not present). Depends on various factors,
including slat angle, width, separation, thickness and reflectance, and horizontal solar profile
angle (for blinds with horizontal slats) or vertical solar profile angle (for blinds with vertical
slats).
Surface Window Blind Diffuse to Diffuse Solar Transmittance []
For an exterior window with a blind, the fraction of exterior diffuse solar radiation incident on
the blind that is transmitted through the blind as diffuse solar radiation when the blind is
isolated (i.e., as though the window glass were not present). Depends on various factors,
including slat angle, width, separation, thickness and reflectance. For blinds with a fixed slat
angle the transmittance value reported here will be constant.
Surface Window Blind and Glazing System Beam Solar Transmittance []
The fraction of exterior beam solar radiation incident on an exterior window with a blind
(excluding window frame, if present) that is transmitted through the blind/glass system as
beam solar radiation. Depends on various factors, including type of glass; solar incidence
angle; slat angle, width, separation, and thickness; and horizontal solar profile angle (for
blinds with horizontal slats) or vertical solar profile angle (for blinds with vertical slats).
Surface Window Blind and Glazing System Diffuse Solar Transmittance []
The fraction of exterior diffuse solar radiation incident on an exterior window with a blind
(excluding window frame, if present) that is transmitted through the blind/glass system as
diffuse solar radiation. Depends on various factors, including type of glass and slat angle,
width, separation, thickness and reflectance. For blinds with a fixed slat angle the
transmittance value reported here will be constant.
Surface Window Screen Beam to Beam Solar Transmittance []
For an exterior window with a screen, this is the fraction of exterior beam solar radiation
incident on the screen that is transmitted through the screen as beam solar radiation when
the screen is isolated (i.e., as though the window glass were not present). Depends on
various factors, including the screen reflectance and the relative angle of the incident beam
with respect to the screen. This value will include the amount of inward reflection of solar
beam off the screen material surface if the user specifies this modeling option (i.e., Material:
WindowScreen, field Reflected Beam Transmittance Accounting Method = Model as Direct
Beam).
Surface Window Screen Beam to Diffuse Solar Transmittance[]
For an exterior window with a screen, the fraction of exterior beam solar radiation incident on
the screen that is transmitted through the screen as diffuse solar radiation when the screen is
isolated (i.e., as though the window glass were not present). Depends on various factors,
including the screen reflectance and the relative angle of the incident beam with respect to
the screen. This value is the amount of inward reflection of solar beam off the screen material
surface if the user specifies this modeling option (i.e., Material: WindowScreen, field
Reflected Beam Transmittance Accounting Method = Model as Diffuse); otherwise, this value
will be zero.
Surface Window Screen Diffuse to Diffuse Solar Transmittance[]
For an exterior window with a screen, the fraction of exterior diffuse solar radiation incident
on the screen that is transmitted through the screen as diffuse solar radiation when the
9/29/14

244

Input-Output Reference

Group Thermal Zone Description/Geometry

screen is isolated (i.e., as though the window glass were not present). Depends on various
factors including screen material geometry and reflectance. This value is calculated as an
average, constant For a window with a screen, this value consists of diffuse radiation
transmitted through the screen (gaps between the screen material) and diffuse radiation from
diffuse-to-diffuse reflection from the screen material. For a window with a screen, this value
consists of diffuse radiation transmitted through the screen (gaps between the screen
material) and diffuse radiation from diffuse-to-diffuse reflection from the screen material.
Surface Window Screen and Glazing System Beam Solar Transmittance[]
The fraction of exterior beam solar radiation incident on an exterior window with a screen
(excluding window frame, if present) that is transmitted through the screen/glass system as
beam solar radiation. Depends on various factors, including the screen reflectance and the
relative angle of the incident beam with respect to the screen. This value will include the
amount of inward reflection of solar beam off the screen material surface if the user specifies
this modeling option (i.e., Material: WindowScreen, field Reflected Beam Transmittance
Accounting Method = Model as Direct Beam).
Surface Window Screen and Glazing System Diffuse Solar Transmittance []
The fraction of exterior diffuse solar radiation incident on an exterior window with a screen
(excluding window frame, if present) that is transmitted through the screen/glass system as
diffuse solar radiation. Depends on various factors including screen material geometry and
reflectance.
Surface Window Transmitted Beam Solar Radiation Rate [W]
Surface Window Transmitted Beam Solar Radiation Energy [J]
The beam solar radiation transmitted through an interior window. Calculated only if Solar
Distribution = FullInteriorAndExterior in your Building input. The origin of this radiation is
beam solar that enters through an exterior window in a zone and then passes through an
interior window into the adjacent zone. The amount of this radiation depends on several
factors, including sun position, intensity of beam solar incident on the exterior window
(including effects of shadowing, if present), relative position of the exterior and interior
window, and the size and transmittance of the windows. Note that if there are two or more
exterior windows in a zone, then beam solar from one or more of them may pass through the
same interior window. Likewise, if there are more than two or more interior windows in a zone
then beam solar from a single exterior window may pass through one or more of the interior
windows. There are both rate and energy versions of the output.
Surface Storm Window On Off Status [ ]
Indicates whether a storm window glass layer is present (ref: StormWindow object). The
value is 0 if the storm window glass layer is off, 1 if it is on, and 1 if the window does not
have an associated storm window. Applicable only to exterior windows and glass doors.
Surface Inside Face Initial Transmitted Diffuse Transmitted Out Window Solar Radiation
Rate [W]
As of Version 2.1, the diffuse solar transmitted through exterior windows that is initially
distributed to another window in the zone and transmitted out of the zone through that
window. For exterior windows, this transmitted diffuse solar is lost to the exterior
environment For interior windows, this transmitted diffuse solar is distributed to heat transfer
surfaces in the adjacent zone, and is part of the Surface Inside Face Initial Transmitted
Diffuse Absorbed Solar Radiation Rate for these adjacent zone surfaces.
Additional Window Outputs (Advanced)
The following output variables for windows or glass doors are available when the user
requests to display advanced output variables. These seven reports show the individual

9/29/14

245

Input-Output Reference

Group Thermal Zone Description/Geometry

components that are combined to determine overall Surface Window Heat Gain Rate and/or
Surface Window Heat Loss Rate (described above).
Surface Window Inside Face Glazing Zone Convection Heat Gain Rate [W]
The surface convection heat transfer from the glazing to the zone in watts. This output
variable is the term called [Convective heat flow to the zone from the zone side of the
glazing] under the description above for Surface Window Heat Gain Rate output variable. If
the window has an interior shade or blind, then this is zero and the glazings convection is
included in the report called Surface Window Inside Face Gap between Shade and Glazing
Zone Convection Heat Gain Rate.
Surface Window Inside Face Glazing Net Infrared Heat Transfer Rate [W]
The net exchange of infrared radiation heat transfer from the glazing to the zone in watts.
This output variable is the term called [Net IR heat flow to the zone from zone side of the
glazing] under the description above for Surface Window Heat Gain Rate output variable.
Surface Window Shortwave from Zone Back Out Window Heat Transfer Rate [W]
This is the short-wave radiation heat transfer from the zone back out the window in watts.
This is a measure of the diffuse short-wave light (from reflected solar and electric lighting)
that leave the zone through the window. This output variable is the term called [Short-wave
radiation from zone transmitted back out the window] under the description above for
Surface Window Heat Gain Rate output variable.
Surface Window Inside Face Frame and Divider Zone Heat Gain Rate [W]
This is the heat transfer from any frames and/or dividers to the zone in watts. This output
variable is the term called [Conduction to zone from window frame and divider, if present]
under the description above for Surface Window Heat Gain Rate output variable. (The word
conduction here is used because the models is simplified compared to the complexities of
surface convection and radiation.)
Surface Window Frame Heat Gain Rate [W]
This is the positive heat flow from window frames to the zone in watts. This is part of the
Surface Window Inside Face Frame and Divider Zone Heat Gain Rate.
Surface Window Frame Heat Loss Rate [W]
This is the negative heat flow from window frames to the zone in watts. This is part of the
Surface Window Inside Face Frame and Divider Zone Heat Gain Rate.
Surface Window Frame Inside Temperature [C]
This is the temperature of the inside surface of the window frames.
Surface Window Frame Outside Temperature [C]
This is the temperature of the outside surface of the window frames.
Surface Window Divider Heat Gain Rate [W]
This is the positive heat flow from window dividers to the zone in watts. This is part of the
Surface Window Inside Face Frame and Divider Zone Heat Gain Rate.
Surface Window Divider Heat Loss Rate [W]
This is the negative heat flow from window dividers to the zone in watts. This is part of the
Surface Window Inside Face Frame and Divider Zone Heat Gain Rate.
Surface Window Divider Inside Temperature [C]
This is the temperature of the inside surface of the window dividers.

9/29/14

246

Input-Output Reference

Group Thermal Zone Description/Geometry

Surface Window Divider Outside Temperature [C]

This is the temperature of the outside surface of the window dividers.
Surface Window Inside Face Gap between Shade and Glazing Zone Convection Heat Gain
Rate [W]
This is the convection surface heat transfer from the both the glazing and the shades back
face to the zone in Watts. This output variable is the term called [Convective heat flow to the
zone from the air flowing through the gap between glazing and shading device] under the
description above for Surface Window Heat Gain Rate output variable. For Equivalent Layer
window this output variable is the convection heat gain from vented interior air gap to the
zone in Watts.
Surface Window Inside Face Shade Zone Convection Heat Gain Rate [W]
This is the convection surface heat transfer from the front side of any interior shade or blind
to the zone in Watts. This output variable is the term called [Convective heat flow to the
zone from the zone side of the shading device] under the description above for Surface
Window Heat Gain Rate output variable. For equivalent Layer window this output variable is
the convection heat gain rate from the inside face of a glazing or a shade to the zone in
Watts.
Surface Window Inside Face Shade Net Infrared Heat Transfer Rate [W]
The net exchange of infrared radiation heat transfer from the shade or blind to the zone in
watts. This output variable is the term called [Net IR heat flow to the zone from the zone
side of the shading device] under the description above for Surface Window Heat Gain Rate
output variable.
Surface Window Inside Face Other Convection Heat Gain Rate [W]
The other (extra) convection heat transfer rate from the inside face of a an equivalent layer
window. This output is computed from the difference in convection flux when using equivalent
inside surface temperature of a window instead of the inside surface temperature from the
standard surface heat balance calculation.
Thermochomic Window Outputs
Window Thermochromic Layer Temperature [C]
The temperature of the TC glass layer of a TC window at each time step.
Surface Window Thermochromic Layer Property Specification Temperature [C]
The temperature under which the optical data of the TC glass layer are specified.
The overall properties (U-factor/SHGC/VT) of the thermochromic windows at different
specification temperatures are reported in the .eio file. These window constructions are
created by EnergyPlus during run time. They have similar names with suffix _TC_XX where
XX represents a specification temperature.
Switchable Window Outputs
Surface Window Switchable Glazing Switching Factor[]
The switching factor (tint level) of the switchable window: 0 means no switching clear state;
1 means fully switched dark state.
Surface Window Switchable Glazing Visible Transmittance[]
The visible transmittance of the switchable window.

9/29/14

247

Input-Output Reference

Group Thermal Zone Description/Geometry

Other Surface Outputs/Reports

Several reports can be selected for Surfaces. (See Group Report for details on how to
specify). Examples are:
DXF
This report produces a special file (eplusout.dxf) in the industry standard DXF (Drawing
Interchange Format) for drawings. It is produced and accepted by many popular, commercial
CAD programs. Detailed reference can be found on the AutoCAD website at:
http://www.autodesk.com/techpubs/autocad/acadr14/dxf/index.htm
EnergyPlus produces this file from the Report command:
Output:Reports, Surfaces, DXF;

Details, Vertices, DetailsWithVertices

This version of the report creates lines in the eplusout.eio file for each surface (except
internal mass surfaces). Details of this reporting is shown in the Output Details and Examples
document.
Shading Surfaces
Shading surfaces are entities outside of the building that may cast shadows on the buildings
heat transfer surfaces. These entities do not typically have enough thermal mass to be
described as part of the buildings thermal makeup.
The most important effect of shading surfaces is to reduce solar gain in windows that are
shadowed. (However, in some cases, shading surfaces can reflect solar onto a wall or
window and increase solar gain.)
There are two kinds of shading surfaces in EnergyPlus: detached and attached. A detached
shading surface, such as a tree or neighboring building, is not connected to the building. An
attached shading surface is typically an overhang or fin that is attached to a particular base
surface of the building, usually a wall; attached shading surfaces are usually designed to
shade specific windows.
Objects for detached shading surfaces:
Shading:Site
Shading:Building
Shading:Site:Detailed
Shading:Building:Detailed
Similarly to the surfaces, the detailed objects use vertex entry whereas the other objects are
limited to rectangular representation.
Objects for attached shading surfaces:
Shading:Overhang
Shading:Overhang:Projection
Shading:Fin
Shading:Fin:Projection
Shading:Zone:Detailed
EnergyPlus creates bi-directional shades from each shading surface entered. This means
that the shade you input will cast a shadow no matter which side of the shade the sun is on.

9/29/14

248

Input-Output Reference

Group Thermal Zone Description/Geometry

For example, a vertical fin will cast a shadow whether the sun is on the left side or right side
of the fin.3
It is important to note that EnergyPlus will automatically account for self-shading effects
such as in L-shaped buildingsin which some of the buildings wall and roof surfaces shade
other parts of the building, especially windows. This means that you only need to describe
shading elements that arent building heat-transfer surfaces.
Shading surfaces can also reflect solar radiation onto the building. This feature is simulated if
you choose FullExteriorWithReflections or FullInteriorAndExteriorWithReflections in the
Building object (ref: Building - Field: Solar Distribution). In this case, you may specify the
reflectance properties of a shading surface with the ShadingProperty:Reflectance object.
Note: If no ShadingProperty:Reflectance object is defined, then the shading surface
reflectance values are assumed to be 0.2 and the fraction of shading surface that is glazed is
assumed to be 0.0.
Shading surfaces also automatically shade diffuse solar radiation (and long-wave radiation)
from the sky. And they will automically shade diffuse solar radiation from the ground if Solar
Distribution Field = FullExteriorWithReflections or FullInteriorAndExteriorWithReflections in
the Building object.4 Otherwise, shading surfaces will not shade diffuse radiation from the
ground unless you enter a reduced value for View Factor to Ground for those building
surfaces that are shaded (ref: BuildingSurface:Detailed - Field: View Factor to Ground and
FenestrationSurface:Detailed - Field: View Factor to Ground).
Detached Shading Surfaces
Shading:Site, Shading:Building
These objects are used to describe rectangular shading elements that are external to the
building. Examples are trees, high fences, near-by hills, and neighboring buildings.
If relative coordinates are used (ref: Field: Coordinate System in GlobalGeometryRules),
shading surfaces entered with Shading:Site remain stationary if the building is rotated,
whereas those entered with Shading:Building rotate with the building. If world coordinates are
used Shading:Site and Shading:Building are equivalent.
These shading elements are always opaque.
Field: Name
This is a unique character string associated with the detached shading surface. Though it
must be unique from other surface names, it is used primarily for convenience with detached
shading surfaces.
Field: Azimuth Angle
Theoretically, this should face to the surface it is shading (i.e. if a south wall, this should be a
north facing shade) but since EnergyPlus automatically generates the mirror image, the
facing angle per se is not so important.
Field: Tilt Angle
The tilt angle is the angle (in degrees) that the shade is tilted from horizontal (or the ground).
Default for this field is 90 degrees.

Prior to V1.0.2, a shading surface cast a shadow only in the hemisphere toward which the surface faced. This hemisphere is
the one pointed to by the shading surfaces outward normal vector, which is the cross product V23 x V21, where V23 is the
vector from vertex 2 to vertex 3 of the shading surface and V21 is the vector from vertex 2 to vertex 1. Beginning with V1.0.2,
the shades in EnergyPlus are bi-directional so that they can cast shadows in both hemispheres depending on the timevarying position of the sun relative to the shading surface.
4
If the reflections option for Solar Distribution is used, the program also takes into account the reduction of solar radiation
reflected from the ground due to shading of the ground by shading surfaces and by the building itself.

9/29/14

249

Input-Output Reference

Group Thermal Zone Description/Geometry

Starting Corner for the surface

The rectangular surfaces specify the lower left corner of the surface for their starting
coordinate. See the introductory paragraph for rules on this entry.
Field: Starting X Coordinate
This field is the X coordinate (in meters).
Field: Starting Y Coordinate
This field is the Y coordinate (in meters).
Field: Starting Z Coordinate
This field is the Z coordinate (in meters).
Field: Length
This field is the length of the shade in meters.
Field: Height
This field is the width of the shade in meters.
Examples of these (can be found in example files 4ZoneWithShading_Simple_1.idf and
4ZoneWithShading_Simple_2.idf)
Shading:Building,
Bushes-East,
90,
90,
45,
0,
0,
50,
1;

!!!!!!!!-

Name
Azimuth Angle {deg}
Tilt Angle {deg}
Starting X Coordinate {m}
Starting Y Coordinate {m}
Starting Z Coordinate {m}
Length {m}
Height {m}

Shading:Site,
Bushes-North,
0,
90,
45,
50,
0,
50,
1;

!!!!!!!!-

Name
Azimuth Angle {deg}
Tilt Angle {deg}
Starting X Coordinate {m}
Starting Y Coordinate {m}
Starting Z Coordinate {m}
Length {m}
Height {m}

Shading:Site:Detailed, Shading:Building:Detailed
These objects are used to describe shading elements that are external to the building.
Examples are trees, high fences, near-by hills, and neighboring buildings.
If relative coordinates are used (ref: Field: Coordinate System in GlobalGeometryRules),
shading surfaces entered with Shading:Site:Detailed remain stationary if the building is
rotated, whereas those entered with Shading:Building:Detailed rotate with the building. If
world coordinates are used Shading:Site:Detailed and Shading:Building:Detailed are
equivalent.
While "detached" implies that shading surfaces are not part of the building, the detached
shading sequence can be used to describe attached shading surfaces that may shade heat
transfer surfaces in more than one zone. For example, wing A of a building might shade
several zones of wing B but wing A (for whatever reason) is not described in the geometry for
the simulation so it is represented by a detached shade to get its shadowing effect.

9/29/14

250

Input-Output Reference

Group Thermal Zone Description/Geometry

Field: Name
This is a unique character string associated with the detached shading surface. Though it
must be unique from other surface names, it is used primarily for convenience with detached
shading surfaces.
Field: Transmittance Schedule Name
The name of a schedule of solar transmittance values from 0.0 to 1.0 for the shading surface.
If a blank is entered in this field, the transmittance value defaults to 0.0, i.e., the shading
surface is opaque at all times. This scheduling can be used to allow for seasonal
transmittance change, such as for deciduous trees that have a higher transmittance in winter
than in summer. Transmittance based on time of day can also be useda movable awning,
for example, where the transmittance is some value less than 1.0 when the awning is in place
and is 1.0 when the awning is retracted.
The following assumptions are made in the shading surface transmittance calculation:
Both sides of the shading surface have the same transmittance properties.
The transmittance is the same for both beam and diffuse solar radiation.
Beam solar transmittance is independent of angle of incidence on the shading
surface.
Beam radiation incident on a shading surface is transmitted as beam radiation with
no change in direction, i.e., there is no beam-to-diffuse component.
If two shading surfaces with non-zero transmittance overlap, the net transmittance is
the product of the individual transmittances. Inter-reflection between the shading
surfaces (and between the shading surfaces and the building) is ignored.
For the daylighting calculation (ref: Group Daylighting) the shading surfaces visible
transmittance is assumed to be the same as its solar transmittance.
Shading devices are assumed to be opaque to long-wave radiation no matter what
the solar transmittance value is.
Note that shading devices only shade solar radiation when the sun is up, which is
automatically determined by EnergyPlus from latitude, time of year, etc. The user need only
account for the time-varying transmittance of the shading device in the transmittance
schedule, not whether the sun is up or not.
Field: Number Vertices
The number of sides in the surface (number of X,Y,Z vertex groups). For further information,
see the discussion on Surface Vertices above.
IDF example of Detached Shading Surfaces:
Shading:Building:Detailed,
EAST SIDE TREE, !- Detached Shading
ShadingTransmittance:0002, !- Shadowing Transmittance & Schedule
3, !-Triangle
33.52800
,
10.66800
,
10.05800
,
33.52800
,
13.71600
, 0.9140000
,
33.52800
,
4.572000
, 0.9140000
;
Shading:Building:Detailed,
WEST SIDE TREE, !- Detached Shading
ShadingTransmittance:0002, !- Shadowing Transmittance & Schedule
3, !-Triangle
-3.048000
,
7.620000
,
10.05800
,
-3.048000
,
4.572000
, 0.9140000
,
-3.048000
,
13.71600
, 0.9140000
;

9/29/14

251

Input-Output Reference

Group Thermal Zone Description/Geometry

Attached Shading Surfaces

Overhangs are usually horizontal devices that are used to shade windows. Fins are usually
vertical devices that similarly shade windows.
Shading:Overhang
An overhang typically is used to shade a window in a building.
Field: Name
This is the name of the overhang. It must be different from other surface names.
Field: Window or Door Name
The name of a window or door that this overhang shades.
Field: Height above Window or Door
This field is the height (meters) above the top of the door for the overhang.
Field Tilt Angle from Window/Door
This field is the tilt angle from the Window/Door. For a flat overhang, this would be 90
(degrees).
Field: Left Extension from Window/Door Width
This field is the width from the left edge of the window/door to the start of the overhang
(meters).
Field: Right Extension from Window/Door Width
This field is the width from the right edge of the window/door to the start of the overhang
(meters).
Field: Depth
This field is the depth of the overhang (meters) projecting out from the wall.
Shading:Overhang:Projection
An overhang typically is used to shade a window in a building. This object allows for
specifying the depth of the overhang as a fraction of the window or doors height.
Field: Name
This is the name of the overhang. It must be different from other surface names.
Field: Window or Door Name
The name of a window or door that this overhang shades.
Field: Height above Window or Door
This field is the height (meters) above the top of the door for the overhang.
Field Tilt Angle from Window/Door
This field is the tilt angle from the Window/Door. For a flat overhang, this would be 90
(degrees).
Field: Left Extension from Window/Door Width
This field is the width from the left edge of the window/door to the start of the overhang
(meters).

9/29/14

252

Input-Output Reference

Group Thermal Zone Description/Geometry

Field: Right Extension from Window/Door Width

This field is the width from the right edge of the window/door to the start of the overhang
(meters).
Field: Depth as Fraction of Window/Door Height
This field is the fraction of the window/door height to specify as the depth of the overhang
(meters) projecting out from the wall.
Shading:Fin
Fins shade either side of windows/doors in a building. This object allows for specification of
both fins for the window. Fin placement is relative to the edge of the glass and user must
include the frame width when a frame is present.
Field: Name
This is the name of the overhang. It must be different from other surface names.
Field: Window or Door Name
The name of a window or door that this overhang shades.
Field: Left Fin Extension from Window/Door
This field is the width from the left edge of the window/door to the plane of the left fin
(meters). The extension width is relative to the edge of the glass and includes the frame width
when a frame is present.
Field: Left Fin Distance Above Top of Window
This field is the distance from the top of the window to the top of the left fin (meters) and is
relative to the edge of the glass and includes the frame width when a frame is present.
Field: Left Fin Distance Below Bottom of Window
This field is the distance from the bottom of the window to the bottom of the left fin (meters)
and is relative to the edge of the glass and includes the frame width when a frame is present.
Field: Left Fin Tilt Angle from Window/Door
This field is the tilt angle from the window / door for the left fin. Typically, a fin is 90 degrees
(default) from its associated window/door.
Field: Left Fin Depth
This field is the depth (meters) of the left fin (projecting out from the wall).
Field: Right Fin Extension from Window/Door
This field is the width from the right edge of the window/door to the plane of the right fin
(meters). The extension width is relative to the edge of the glass and includes the frame width
when a frame is present.
Field: Right Fin Distance Above Top of Window
This field is the distance from the top of the window to the top of the right fin (meters) and is
relative to the edge of the glass and includes the frame width when a frame is present.
Field: Right Fin Distance Below Bottom of Window
This field is the distance from the bottom of the window to the bottom of the right fin (meters)
and is relative to the edge of the glass and includes the frame width.

9/29/14

253

Input-Output Reference

Group Thermal Zone Description/Geometry

Field: Right Fin Tilt Angle from Window/Door

This field is the tilt angle from the window / door for the right fin.. Typically, a fin is 90
degrees (default) from its associated window/door.
Field: Right Fin Depth
This field is the depth (meters) of the right fin (projecting out from the wall).
Shading:Fin:Projection
Fins shade either side of windows/doors in a building. This object allows for specification of
both fins for the window. This object allows for specifying the depth of the overhang as a
fraction of the window or doors width. Fin placement is relative to the edge of the glass and
user must include the frame width when a frame is present.
Field: Name
This is the name of the overhang. It must be different from other surface names.
Field: Window or Door Name
The name of a window or door that this overhang shades.
Field: Left Fin Extension from Window/Door
This field is the width from the left edge of the window/door to the plane of the left fin
(meters). The extension width is relative to the edge of the glass and includes the frame width
when a frame is present.
Field: Left Fin Distance Above Top of Window
This field is the distance from the top of the window to the top of the left fin (meters) and is
relative to the edge of the glass and includes the frame width when a frame is present.
Field: Left Fin Distance Below Bottom of Window
This field is the distance from the bottom of the window to the bottom of the left fin (meters)
and is relative to the edge of the glass and includes the frame width when a frame is present.
Field: Left Fin Tilt Angle from Window/Door
This field is the tilt angle from the window / door for the left fin. Typically, a fin is 90 degrees
(default) from its associated window/door.
Field: Left Fin Depth as Fraction of Window/Door Width
This field is the fraction of the window/door width to specify as the depth of the left fin
(meters) projecting out from the wall.
Field: Right Fin Extension from Window/Door
This field is the width from the right edge of the window/door to the plane of the right fin
(meters).. The extension width is relative to the edge of the glass and includes the frame
width when a frame is present.
Field: Right Fin Distance Above Top of Window
This field is the distance from the top of the window to the top of the right fin (meters) and is
relative to the edge of the glass and includes the frame width when a frame is present.
Field: Right Fin Distance Below Bottom of Window
This field is the distance from the bottom of the window to the bottom of the right fin (meters)
and is relative to the edge of the glass and includes the frame width when a frame is present.

9/29/14

254

Input-Output Reference

Group Thermal Zone Description/Geometry

Field: Right Fin Tilt Angle from Window/Door

This field is the tilt angle from the window / door for the right fin.. Typically, a fin is 90
degrees (default) from its associated window/door.
Field: Right Fin Depth as Fraction of Window/Door Width
This field is the fraction of the window/door width to specify as the depth of the right fin
(meters) projecting out from the wall.
zone.
Examples of these (can be found in example files 4ZoneWithShading_Simple_1.idf and
4ZoneWithShading_Simple_2.idf)
Shading:Overhang:Projection,
Zn001:Wall001:Win001:Shade001, !- Name
Zn001:Wall001:Win001,
!- Window or Door Name
.7,
!- Height above Window or Door {m}
90,
!- Tilt Angle from Window/Door {deg}
.2,
!- Left extension from Window/Door Width {m}
.2,
!- Right extension from Window/Door Width {m}
.6;
!- Depth as Fraction of Window/Door Height {m}
Shading:Overhang,
Zn001:Wall001:Door001:Shade001, !- Name
Zn001:Wall001:Door001,
!- Window or Door Name
.6,
!- Height above Window or Door {m}
90,
!- Tilt Angle from Window/Door {deg}
0,
!- Left extension from Window/Door Width {m}
0,
!- Right extension from Window/Door Width {m}
3;
!- Depth {m}
Shading:Fin:Projection,
Zn001:Wall001:Shade003,
Zn001:Wall001:Win001,
.1,
.1,
!.1,
!90,
!.6,
!.1,
!.1,
!.1,
!90,
!.6;
!-

!- Name
!- Window or Door Name
!- Left Extension from Window/Door {m}
Left Distance Above Top of Window {m}
Left Distance Below Bottom of Window {m}
Left Tilt Angle from Window/Door {deg}
Left Depth as Fraction of Window/Door Width {m}
Right Extension from Window/Door {m}
Right Distance Above Top of Window {m}
Right Distance Below Bottom of Window {m}
Right Tilt Angle from Window/Door {deg}
Right Depth as Fraction of Window/Door Width {m}

Shading:Zone:Detailed
This object is used to describe attached subsurfaces such as overhangs, wings or fins that
project outward from a base surface. This classification is used for convenience; actually, a
device of this type can cast shadows on the surface to which it is attached as well as on
adjacent surfaces. For example, a fin may shade its parent wall as well as adjacent walls.
Note that a zone surface can cast shadows on other zone surfaces. However, you dont have
to worry about such effectsfor example, one wall of an L-shaped building shading another
wall--because EnergyPlus will automatically check for this kind of self shadowing and do the
proper calculations.
Unlike attached (or detached) shading surfaces, building surfaces can only cast shadows in
the hemisphere towards which they face. This means, for example, that a roof that faces
upward will not cast a shadow downward. (Thus, specifying an oversized roof in an attempt to
account for the shading effects of overhangs will not work). Interior surfaces do not cast
shadows of any kind.

9/29/14

255

Input-Output Reference

Group Thermal Zone Description/Geometry

Field: Name
This is the name of the attached shading surface. It must be different from other surface
names.
Field: Base Surface Name
This is the name of the surface to which this shading device is attached. This surface can be
a wall (or roof) but not a window or door.
Field: Transmittance Schedule Name
The name of a schedule of solar transmittance values from 0.0 to 1.0 for the shading surface.
If a blank is entered in this field, the transmittance value defaults to 0.0, i.e., the shading
surface is opaque at all times. This scheduling can be used to allow for seasonal
transmittance change, such as for deciduous trees that have a higher transmittance in winter
than in summer. Transmittance based on time of day can also be useda movable awning,
for example, where the transmittance is some value less than 1.0 when the awning is in place
and is 1.0 when the awning is retracted.
The following assumptions are made in the shading surface transmittance calculation:
Both sides of the shading surface have the same transmittance properties.
The transmittance is the same for both beam and diffuse solar radiation.
Beam solar transmittance is independent of angle of incidence on the shading
surface.
Beam radiation incident on a shading surface is transmitted as beam radiation with
no change in direction, i.e., there is no beam-to-diffuse component.
If two shading surfaces with non-zero transmittance overlap, the net transmittance is
the product of the individual transmittances. Inter-reflection between the shading
surfaces (and between the shading surfaces and the building) is ignored.
For the daylighting calculation (ref: Group Daylighting) the shading surfaces visible
transmittance is assumed to be the same as its solar transmittance.
Shading devices are assumed to be opaque to long-wave radiation no matter what
the solar transmittance value is.
Note that shading devices only shade solar radiation when the sun is up, which is
automatically determined by EnergyPlus from latitude, time of year, etc. The user need only
account for the time-varying transmittance of the shading device in the transmittance
schedule, not whether the sun is up or not.
Field: Number Vertices
The number of sides in the surface (number of X,Y,Z vertex groups). For further information,
see the discussion on Surface Vertices above. The example below shows the correct input
for an overhang (to shade the appropriate portion of the base wall and window).

9/29/14

256

Input-Output Reference

Group Thermal Zone Description/Geometry

Upper Left Corner Vertex for

Overhang

A
C

(0,0,0)

Figure 33. Illustration for Attached Shading Surface

Proper specification for this overhang (facing up) is:
4,(C,0,D),(C,-B,D),(C+A,-B,D),(C+A,0,D); () used to illustrate each vertex.
Note that for horizontal surfaces, any corner may be chosen as the starting corner. The order of vertices
determines whether the surface is facing up or down. Shading surfaces are mirrored automatically unless
the user specifies "DoNotMirrorDetachedShading", so each shading surface need only be described once.

Thus, another shading surface will be created (facing down):

4,(C+A,-B,D),(C+A,0,D),(C,0,D),(C,-B,D);
IDF example of attached shading surfaces (overhang, fin):
Shading:Zone:Detailed,
Zn001:Wall001:Shade001, !- Surface Name
Zn001:Wall001, !- Base Surface Name
ShadingTransmittance:0001, !- Shadowing Transmittance Schedule
4, !-RectangularOverhang
1.524000
, -0.3050000
,
2.865000
,
1.524000
, 0.0000000E+00,
2.865000
,
4.572000
, 0.0000000E+00,
2.865000
,
4.572000
, -0.3050000
,
2.865000
;
Shading:Zone:Detailed,
Zn003:Wall001:Shade001, !- Surface Name
Zn003:Wall001, !- Base Surface Name
ShadingTransmittance:0001, !- Shadowing Transmittance Schedule
4, !-RectangularLeftFin
9/29/14

257

Input-Output Reference

Group Thermal Zone Description/Geometry

57.97000
,
8.450000
,
10.00000
,
57.97000
,
8.450000
, 0.0000000E+00,
57.97000
,
6.450000
, 0.0000000E+00,
57.97000
,
6.450000
,
10.00000
;
Shading:Zone:Detailed,Zn003:Wall001:Shade002, !- Surface Name
Zn003:Wall001, !- Base Surface Name
ShadingTransmittance:0003, !- Shadowing Transmittance Schedule
4, !-RectangularRightFin
77.97000
,
6.450000
,
10.00000
,
77.97000
,
6.450000
, 0.0000000E+00,
77.97000
,
8.450000
, 0.0000000E+00,
77.97000
,
8.450000
,
10.00000
;

ShadingProperty:Reflectance
Specifies the reflectance properties of a shading surface when the solar reflection calculation
has requested, i.e., when if WithReflections option is chosen in the Building object (ref:
Building - Field: Solar Distribution). It is assumed that shading surfaces are divided into an
unglazed, diffusely reflecting portion and a glazed, specularly-reflecting portion, either of
which may be zero. The reflectance properties are assumed to be the same on both sides of
the shading surface.
Note that a shadowing transmittance schedule (ref: Shading Surfaces, Field: Transmittance
Schedule Name) can be used with a reflective shading surface. However, EnergyPlus
assumes that the reflectance properties of the shading surface are constant even if the
transmittance varies.
If no ShadingProperty:Reflectance objects are entered, the default values shown here will be
used for shading surfaces. Other surfaces have their reflectance properties defined by the
materials in the outer layers of the constructions.
Field: Shading Surface Name
The
name
of
the
Shading:Site,
Shading:Building,
Shading:Site:Detailed,
Shading:Building:Detailed, Shading:Overhang, Shading:Overhang:Projection, Shading:Fin,
Shading:Fin:Projection or Shading:Zone:Detailed object to which the following fields apply.
If this ShadingProperty:Reflectance object is not defined for a shading surface the default
values listed in each of the following fields will be used in the solar reflection calculation.
Field: Diffuse Solar Reflectance of Unglazed Part of Shading Surface
The diffuse solar reflectance of the unglazed part of the shading surface (default = 0.2). This
reflectance is assumed to be the same for beam-to-diffuse and diffuse-to-diffuse reflection.
Beam-to-diffuse reflection is assumed to be independent of angle of incidence of beam
radiation. Diffuse-to-diffuse reflection is assumed to be independent of angular distribution of
the incident of diffuse radiation. The outgoing diffuse radiation is assumed to be isotropic
(hemispherically uniform).
The sum of this reflectance and the shading surface transmittance should be less than or
equal to 1.0.
Field: Diffuse Visible Reflectance of Unglazed Part of Shading Surface
The diffuse visible reflectance of the unglazed part of the shading surface (default = 0.2). This
reflectance is assumed to be the same for beam-to-diffuse and diffuse-to-diffuse reflection.
Beam-to-diffuse reflection is assumed to be independent of angle of incidence of beam
radiation. Diffuse-to-diffuse reflection is assumed to be independent of angular distribution of
the incident of diffuse radiation. The outgoing diffuse radiation is assumed to be isotropic
(hemispherically uniform).
This value if used only for the daylighting calculation (ref: Daylighting:Controls). The sum of
this reflectance and the shading surface transmittance should be less than or equal to 1.0.

9/29/14

258

Input-Output Reference

Group Thermal Zone Description/Geometry

Field: Fraction of Shading Surface That Is Glazed

The fraction of the area of the shading surface that consists of windows (default = 0.0). It is
assumed that the windows are evenly distributed over the surface and have the same glazing
construction (see following Name of Glazing Construction). This might be the case, for
example, for reflection from the faade of a neighboring, highly-glazed building. For the
reflection calculation the possible presence of shades, screens or blinds on the windows of
the shading surface is ignored. Beam-to-beam (specular) reflection is assumed to occur only
from the glazed portion of the shading surface. This reflection depends on angle of incidence
as determined by the program from the glazing construction. Beam-to-diffuse reflection from
the glazed portion is assumed to be zero. The diffuse-to-diffuse reflectance of the glazed
portion is determined by the program from the glazing construction.
Field: Glazing Construction Name
The name of the construction of the windows on the shading surface. Required if Fraction of
Shading Surface That Is Glazed is greater than 0.0.
IDF example of Shading Surface Reflectance for shading surface with specular reflection
Shading:Site:Detailed,
Adjacent Glazed Facade, !- User Supplied Surface Name
,
!- Shadowing Transmittance Schedule
4, !- Number of Surface Vertex Groups -- Number of (X,Y,Z) groups
0,-24,30, !- Vertex 1 X,Y,Z coordinates
0,-24,0, !- Vertex 2 X,Y,Z coordinates
0,0,0,
!- Vertex 3 X,Y,Z coordinates
0,0,30;
!- Vertex 3 X,Y,Z coordinates
ShadingProperty:Reflectance,
Adjacent Glazed Facade, !- Name of Surface:Shading Object
0.3, !- Diffuse Solar Reflectance of Unglazed Part of Shading Surface
0.3, !- Diffuse Visible Reflectance of Unglazed Part of Shading Surface
0.7, !- Fraction of Shading Surface That Is Glazed
GlassCon-1; !- Name of Glazing Construction

IDF example of Shading Surface Reflectance for shading surface without specular reflection
Shading:Site:Detailed,
Adjacent Blank Facade, !- User Supplied Surface Name
,
!- Shadowing Transmittance Schedule
4, !- Number of Surface Vertex Groups -- Number of (X,Y,Z) groups
0,-24,30,
0,-24,0,
0,0,0,
0,0,30;
ShadingProperty:Reflectance,
Adjacent Blank Facade, !- Name of Surface:Shading Object
0.4, !- Diffuse Solar Reflectance of Unglazed Part of Shading Surface
0.4, !- Diffuse Visible Reflectance of Unglazed Part of Shading Surface
0.0, !- Fraction of Shading Surface That Is Glazed
;
!- Name of glazing construction

WindowProperty:ShadingControl
Window shading with coverings like drapes, blinds, screens or pull-down shades can be used
to reduce the amount of solar radiation entering the window or reduce daylighting glare. It can
also be used to reduce heat loss through the window (movable insulation). Leaving the

9/29/14

259

Input-Output Reference

Group Thermal Zone Description/Geometry

window covering open in the winter can maximize solar heat gain and thereby reduce heating
loads.
With WindowProperty:ShadingControlwhich is referenced by windows and glass doors (ref:
FenestrationSurface:Detailed with Type = Window or GlassDoor)--you specify the type and
location of the shading device, what variable or combination of variables controls deployment
of the shading device, and what the control setpoint is. If the shading device is a blind, you
also specify how the slat angle is controlled.
NOTE: WindowProperty:ShadingControl does not work with complex fenestration systems.
Controlled complex fenestration systems can be made only with Energy Management
Systems objects. Inserting WindowProperty:ShadingControl in FenestrationSurface:Detailed
while using complex fenestration systems will be ignored by program.
As shown in Figure 34, a shading device can be inside the window (Shading Type =
InteriorShade or InteriorBlind), outside the window (Shading Type = ExteriorShade or
ExteriorBlind), or between panes of glass (Shading Type = BetweenGlassShade or
BetweenGlassBlind). The exception is window screens which can only be outside the window
(Shading Type = ExteriorScreen).

Interior

Exterior

Between-glass

Figure 34. Allowed locations of a window shading device.

When a shading device is present it is either retracted or activated. When it is retracted it
covers none of the window. When it is activated it covers the entire glazed part of the window
(but not the frame). Whether the shading device is retracted or activated in a particular
timestep depends on the control mechanism: see Shading Control Type, below. To model a
case in which the shading device, when activated, covers only part of the window you will
have to divide the window into two separate windows, one with the shading device and one
without the shading device.
A shading device can also be of a kind in which the optical properties of the glazing switch
from one set of values to another in order to increase or decrease solar or visible
transmittance (Shading Type = SwitchableGlazing).
There are two ways of specifying the actual shading device:
Specify Name of Construction with Shading
This is the name of a window Construction that has the shading device as one of its
layers. The thermal and solar-optical properties of the shading device are given by the
shading
material
referenced
in
that
Construction
(ref:
Construction,
WindowMaterial:Shade, WindowMaterial:Screen and WindowMaterial:Blind). To use this

9/29/14

260

Input-Output Reference

Group Thermal Zone Description/Geometry

method you have to define two Constructions for the window, one without the shading
device and one with it. See Example 1, below.
The
Construction
without
the
shading
device
is
referenced
in
the
FenestrationSurface:Detailed input for the window (see IDF example, below). The
Construction with the shading device is referenced by the windows
WindowProperty:ShadingControl.
For Shading Type = InteriorShade, InteriorBlind, ExteriorShade, ExteriorScreen and
ExteriorBlind these two Constructions must be identical expect for the presence of the
shading layer in the shaded Construction, otherwise you will get an error message. You
will also get an error message if the Construction referenced by the window has a
shading layer.
Specify the Material Name of the Shading Device
This is the name of a WindowMaterial:Shade, WindowMaterial:Screen or
WindowMaterial:Blind. This method can be used with Shading Type = InteriorShade,
InteriorBlind, ExteriorShade and ExteriorBlind. It cannot be used with Shading Type =
BetweenGlassShade, BetweenGlassBlind, or SwitchableGlazing. If Shading Type =
InteriorShade or ExteriorShade, then you specify the name of a WindowMaterial:Shade.
If Shading Type = InteriorBlind or ExteriorBlind, then you specify the name of a
WindowMaterial:Blind. If Shading Type = ExteriorScreen, then you specify the name of a
WindowMaterial:Screen. See Example 2, below. This method is simpler to use since you
dont have to specify two Constructions that differ only by the shading layer.
When this method is used, the program will automatically create a shaded window
construction by adding a shading layer to the outside or inside of the construction
corresponding to the window referencing the WindowProperty:ShadingControl. The
name, created by the program, of this shaded construction is composed as follows: if the
name of the window construction is CCC and the material name of the shading device is
DDD, then the shaded construction name is CCC:DDD:INT for an interior shading device
and CCC:DDD:EXT for an exterior shading device.
This method is the required if you want to add a shading device to a construction brought
in from a WINDOW Data File (ref:Construction:WindowDataFile).
Note that if both Name of Construction with Shading and Material Name of Shading
Device are specified, the former takes precedence.
Most Shading Control Types allow you to specify a schedule that determines when the
control is active. One example is a control that is active seasonally. For example, to deploy
shading only in the summer when the incident solar is high enough, use Shading Control
Type = OnIfHighSolarOnWindow with a schedule that is 1 during the summer months and 0
otherwise and specify Shading Control Is Scheduled = YES.
In addition, most Shading Control Types also allow you to specify that glare control is active
in addition to the specified Control Type. For example, you might want to deploy shading
when the solar incident on a window is too high OR the glare from the window is too high.
This type of joint control requires that the window be in a daylit zone, that the maximum
allowed glare be specified in the Daylighting object for the zone, and that Glare Control Is
Active = YES in WindowProperty:ShadingControl.
If Shading Type = InteriorBlind, ExteriorBlind or BetweenGlassBlind you can use
WindowProperty:ShadingControl to specify how the slat angle of the blind is controlled when
the blind is in place.
A special type of WindowProperty:ShadingControl is SwitchableGlazing. An example is
electrochromic glazing in which the transmittance and reflectance of the glass is controlled
electronically. For example, you could have electrochromic glazing switch from clear (high
transmittance) to dark (low transmittance) to control solar gain. If you choose the Shading
Type = SwitchableGlazing option for WindowProperty:ShadingControl, the unswitched (clear)
state is specified by the Construction referenced by the window and the switched (dark) state
9/29/14

261

Input-Output Reference

Group Thermal Zone Description/Geometry

is specified by the Construction referenced by WindowProperty:ShadingControl for that

window. For example, if you specify Shading Type = SwitchableGlazing and Shading Control
Type = OnIfHighSolarOnWindow, then the glazing will switch to the dark state whenever the
solar radiation striking the window exceeds the Setpoint value.
For Shading Type = SwitchableGlazing the state of the window is either clear (unswitched) or
dark (fully switched) for all Shading Control Types except MeetDaylightIlluminanceSetpoint.
In this case, the transmittance of the glazing is adjusted to just meet the daylight illuminance
set point at the first daylighting reference point (see Daylighting). This type of control assures
that there is just enough solar gain to meet the daylighting requirements in a zone, and no
more, thus reducing the cooling load.
Field: Name
Name of the window shading control. It is referenced by a window (ref: Field: Shading Control
Name).
Field: Shading Type
The type of shading device. The choices are:
InteriorShade: A diffusing shade is on the inside of the window. (In the shaded Construction
the shading layer must be a WindowMaterial:Shade.)
ExteriorShade: A diffusing shade is on the outside of the window. (In the shaded Construction
the shading layer must be a WindowMaterial:Shade.)
BetweenGlassShade: A diffusing shade is between two glass layers. (In the shaded
Construction the shading layer must be a WindowMaterial:Shade.) This shading type is
allowed only for double- and triple-glazing. For triple-glazing the shade must be between the
two inner glass layers.
ExteriorScreen: An insect screen is on the outside of the window. (In the shaded Construction
the shadling layer must be a WindowMaterial:Screen.)
InteriorBlind: A slat-type shading device, such as a Venetian blind, is on the inside of the
window. (In the shaded Construction the shading layer must be a WindowMaterial:Blind.)
ExteriorBlind: A slat-type shading device is on the outside of the window. (In the shaded
Construction the shading layer must be a WindowMaterial:Blind.)
BetweenGlassBlind: A slat-type shading device is between two glass layers. (In the shaded
Construction the shading layer must be a WindowMaterial:Blind.) This shading type is
allowed only for double- and triple-glazing. For triple-glazing the blind must be between the
two inner glass layers.
SwitchableGlazing: Shading is achieved by changing the characteristics of the window glass,
such as by darkening it.
Field: Construction with Shading Name
Name of the window Construction that has the shading in place. The properties of the
shading device are given by the shading material referenced in that Construction (ref:
Construction, WindowMaterial:Shade, WindowMaterial:Screen and WindowMaterial:Blind).
For Shading Type = SwitchableGlazing, this is the name of the Construction that corresponds
to the window in its fully-switched (darkest) state.
Specifying Name of Construction with Shading is required if Shading Type =
BetweenGlassShade, BetweenGlassBlind, or SwitchableGlazing. For other Shading Types,
you may alternatively specify Material Name of Shading Device (see below).
Field: Shading Control Type
Specifies how the shading device is controlled, i.e., it determines whether the shading device
is on or off. For blinds, screens and shades, when the device is on it is assumed to cover
all of the window except its frame; when the device is off it is assumed to cover none of the

9/29/14

262

Input-Output Reference

Group Thermal Zone Description/Geometry

window (whether on or off the shading device is assumed to cover none of the wall that
the window is on).
For switchable glazing, on means that the glazing is in the fully-switched state and off
means that it is in the unswitched state; for example, for electrochromic glazing, on means
the glazing is in its darkest state and off means it is in its lightest state.
The choices for Shading Control Type are the following. If SetPoint is applicable its units are
shown in parentheses.
AlwaysOn: Shading is always on.
AlwaysOff: Shading is always off.
The following six control types are used primarily to reduce zone cooling load due to
window solar gain.
OnIfScheduleAllows: Shading is on if schedule value is non-zero. Requires that Schedule
Name be specified and Shading Control Is Scheduled = Yes.
Note: For exterior window screens AlwaysOn, AlwaysOff, and OnIfScheduleAllows are the
only valid shading control types.
OnIfHighSolarOnWindow: Shading is on if beam plus diffuse solar radiation incident on the
window exceeds SetPoint (W/m2) and schedule, if specified, allows shading.
OnIfHighHorizontalSolar: Shading is on if total (beam plus diffuse) horizontal solar irradiance
exceeds SetPoint (W/m 2) and schedule, if specified, allows shading.
OnIfHighOutdoorAirTemperature: Shading is on if outside air temperature exceeds SetPoint
(C) and schedule, if specified, allows shading.
OnIfHighZoneAirTemperature: Shading is on if zone air temperature in the previous timestep
exceeds SetPoint (C) and schedule, if specified, allows shading.
OnIfHighZoneCooling: Shading is on if zone cooling rate in the previous timestep exceeds
SetPoint (W) and schedule, if specified, allows shading.
OnIfHighGlare: Shading is on if the total daylight glare index at the zones first daylighting
reference point from all of the exterior windows in the zone exceeds the maximum glare index
specified in the daylighting input for zone (ref: Group Daylighting). Applicable only to
windows in zones with daylighting.
Note: Unlike other Shading Control Types, glare control is active whether or not a schedule is
specified.
MeetDaylightIlluminanceSetpoint: Used only with ShadingType = SwitchableGlazing in zones
with daylighting controls. In this case the transmittance of the glazing is adjusted to just meet
the daylight illuminance set point at the first daylighting reference point. Note that the daylight
illuminance set point is specified in the Daylighting:Controls object for the Zone; it is not
specified as a WindowProperty:ShadingControl SetPoint. When the glare control is active, if
meeting the daylight illuminance set point at the first daylighting reference point results in
higher discomfort glare index (DGI) than the specified zones maximum allowable DGI for
either of the daylight reference points, the glazing will be further dimmed until the DGI equals
the specified maximum allowable value.
The following three control types can be used to reduce zone heating load during the
winter by reducing window conductive heat loss at night and leaving the window
unshaded during the day to maximize solar gain. They are applicable to any Shading
Type except ExteriorScreen but are most appropriate for interior or exterior shades with
high insulating value ("movable insulation"). Night means the sun is down and day
means the sun is up.
OnNightIfLowOutdoorTempAndOffDay: Shading is on at night if the outside air temperature is
less than SetPoint (C) and schedule, if specified, allows shading. Shading is off during the
day.

9/29/14

263

Input-Output Reference

Group Thermal Zone Description/Geometry

OnNightIfLowInsideTempAndOffDay: Shading is on at night if the zone air temperature in the

previous timestep is less than SetPoint (C) and schedule, if specified, allows shading.
Shading is off during the day.
OnNightIfHeatingAndOffDay: Shading is on at night if the zone heating rate in the previous
timestep exceeds SetPoint (W) and schedule, if specified, allows shading. Shading is off
during the day.
The following two control types can be used to reduce zone heating and cooling load.
They are applicable to any Shading Type except ExteriorScreen but are most appropriate
for translucent interior or exterior shades with high insulating value ("translucent movable
insulation").
OnNightIfLowOutdoorTempAndOnDayIfCooling: Shading is on at night if the outside air
temperature is less than SetPoint (C). Shading is on during the day if the zone cooling rate in
the previous timestep is non-zero. Night and day shading is subject to schedule, if specified.
OnNightIfHeatingAndOnDayIfCooling: Shading is on at night if the zone heating rate in the
previous timestep exceeds SetPoint (W). Shading is on during the day if the zone cooling rate
in the previous timestep is non-zero. Night and day shading is subject to schedule, if
specified.
The following control types can be used to reduce zone cooling load. They are applicable
to any Shading Type except ExteriorScreen but are most appropriate for interior or
exterior blinds, interior or exterior shades with low insulating value, or switchable glazing.
OffNightAndOnDayIfCoolingAndHighSolarOnWindow: Shading is off at night. Shading is on
during the day if the solar radiation incident on the window exceeds SetPoint (W/m 2) and if
the zone cooling rate in the previous timestep is non-zero. Daytime shading is subject to
schedule, if specified.
OnNightAndOnDayIfCoolingAndHighSolarOnWindow: Shading is on at night. Shading is on
during the day if the solar radiation incident on the window exceeds SetPoint (W/m 2) and if
the zone cooling rate in the previous timestep is non-zero. Day and night shading is subject
to schedule, if specified. (This Shading Control Type is the same as the previous one, except
the shading is on at night rather than off.)
OnIfHighOutdoorAirTempAndHighSolarOnWindow: Shading is on if the outside air
temperature exceeds the Setpoint (C) and if if the solar radiation incident on the window
exceeds SetPoint 2 (W/m2).
OnIfHighOutdoorAirTempAndHighHorizontalSolar: Shading is on if the outside air
temperature exceeds the Setpoint (C) and if if the horizontal solar radiation exceeds SetPoint
2 (W/m2).
Field: Schedule Name
Required if Shading Control Is Scheduled = Yes. If schedule value > 0 , shading control is
active, i.e., shading can be on only if the shading control test passes. If schedule value = 0,
shading is off whether or not the control test passes. If Schedule Name is not specified,
shading control is assumed to be active at all times.
Field: Setpoint
The setpoint for activating window shading. The units depend on the type of trigger:
W/m2 for solar-based controls
W for cooling- or heating-based controls
Degrees C for temperature-based controls
SetPoint is unused for Shading Control Type = OnIfScheduleAllows, OnIfHighGlare and
DaylightIlluminance.

9/29/14

264

Input-Output Reference

Group Thermal Zone Description/Geometry

Field: Shading Control Is Scheduled

Accepts values YES and NO. The default is NO. Not applicable for Shading Control Type =
OnIfHighGlare and should be blank in that case.
If YES, Schedule Name is required and that schedule determines whether the shading
control specified by Shading Control Type is active or inactive (see Schedule Name, above).
If NO, Schedule Name is not applicable (should be blank) and the shading control is
unscheduled.
Shading Control Is Scheduled = YES is required if Shading Control Type =
OnIfScheduleAllows.
Field: Glare Control Is Active
Accepts values YES and NO. The default is NO.
If YES and the window is in a daylit zone, shading is on if the zone's discomfort glare index
exceeds the maximum discomfort glare index specified in the Daylighting object referenced
by the zone. For switchable windows with MeetDaylightIlluminanceSetpoint shading control, if
Glare Control is active, the windows are always continuously dimmed as necessary to meet
the zones maximum allowable DGI while providing appropriate amount of daylight for the
zone.
The glare test is OR'ed with the test specified by Shading Control Type. For example, if Glare
Control Is Active = YES and Shading Control Type = OnIfHighZoneAirTemp, then shading is
on if glare is too high OR if the zone air temperature is too high.
Glare Control Is Active = YES is required if Shading Control Type = OnIfHighGlare.
Field: Shading Device Material Name
The name of a WindowMaterial:Shade, WindowMaterial:Screen or WindowMaterial:Blind.
Required if "Name of Construction with Shading" is not specified. Not applicable if Shading
Type = BetweenGlassShade, BetweenGlassBlind or SwitchableGlazing and should be blank
in this case. If both "Name of Construction with Shading" and "Material Name of Shading
Device" are entered the former takes precedence.
Field: Type of Slat Angle Control for Blinds
Applies only to Shading Type = InteriorBlind, ExteriorBlind or BetweenGlassBlind. Specifies
how the slat angle is controlled. The choices are FixedSlatAngle, ScheduledSlatAngle and
BlockBeamSolar.
If FixedSlatAngle (the default), the angle of the slat is fixed at the value input for the
WindowMaterial:Blind that is contained in the construction specified by Name of Construction
with Shading or is specified by Material Name of Shading Device.
If ScheduledSlatAngle, the slat angle varies according to the schedule specified by Slat Angle
Schedule Name, below.
If BlockBeamSolar, the slat angle is set each timestep to just block beam solar radiation. If
there is no beam solar on the window the slat angle is set to the value input for the
WindowMaterial:Blind that is contained in the construction specified by Name of Construction
with Shading or is specified by Material Name of Shading Device. The BlockBeamSolar
option prevents beam solar from entering the window and causing possible unwanted glare if
the beam falls on work surfaces while at the same time allowing near-optimal indirect
radiation for daylighting.
Field: Slat Angle Schedule Name
This is the name of a schedule of slat angles that is used when Type of Slat Angle Control for
Blinds = ScheduledSlatAngle. You should be sure that the schedule values fall within the
range given by the Minimum Slat Angle and Maximum Slat Angle values entered in the
corresponding WindowMaterial:Blind. If not, the program will force them into this range.

9/29/14

265

Input-Output Reference

Group Thermal Zone Description/Geometry

Field: Setpoint 2
Used only as the second setpoint for the following two-setpoint control types:
OnIfHighOutdoorAirTempAndHighSolarOnWindow,
OnIfHighOutdoorAirTempAndHighHorizontalSolar,
OnIfHighZoneAirTempAndHighSolarOnWindow,
and OnIfHighZoneAirTempAndHighHorizontalSolar
An IDF example: window with interior roll shade that is deployed when solar incident on the
window exceeds 50 W/m2.
! Example 1: Interior movable shade specified by giving name of shaded construction
! in WindowProperty:ShadingControl
WindowMaterial:Glazing, GLASS - CLEAR SHEET 1 / 8 IN, !- Material Name
SpectralAverage,! Optical data type {SpectralAverage or Spectral}
,
! Name of spectral data set when Optical Data Type = Spectral
0.003
, !- Thickness {m}
0.837
, !- Solar Transmittance at Normal Incidence
0.075
, !- Solar Reflectance at Normal Incidence: Front Side
0.075
, !- Solar Reflectance at Normal Incidence: Back Side
0.898
, !- Visible Transmittance at Normal Incidence
0.081
, !- Visible Reflectance at Normal Incidence: Front Side
0.081
, !- Visible Reflectance at Normal Incidence: Back Side
0.0
, !- IR Transmittance
0.8400000
, !- IR Emissivity: Front Side
0.8400000
, !- IR Emissivity: Back Side
0.9000000
; !- Conductivity {W/m-K}
WindowMaterial:Shade, ROLL SHADE, !- Material Name
0.3
,
!- Solar Transmittance at normal incidence
0.5000000
,
!- Solar Reflectance (same for front and back side)
0.3
,
!- Visible Transmittance at normal incidence
0.5000000
,
!- Visible reflectance (same for front and back side)
0.9000000
,
!- IR Emissivity (same for front and back side)
0.05
,
!- IR Transmittance
0.003
,
!- Thickness
0.1
,
!- Conductivity {W/m-K}
0.0
,
!- Top Opening Multiplier
0.0
,
!- Bottom Opening Multiplier
0.5
,
!- Left-Side Opening Multiplier
0.5
,
!- Right-Side Opening Multiplier
0.0
;
!- Air-Flow Permeability
Construction, SINGLE PANE WITH NO SHADE, ! Name of construction without shade
GLASS - CLEAR SHEET 1 / 8 IN; !- First material layer
Construction, SINGLE PANE WITH INT SHADE, ! Name of construction with shade
GLASS - CLEAR SHEET 1 / 8 IN, !- First material layer
ROLL SHADE
; !- Second material layer
WindowProperty:ShadingControl, CONTROL ON INCIDENT SOLAR, !- Name of Shading Control
InteriorShade,
!- Shading Type
SINGLE PANE WITH INT SHADE,
!- Name of construction with shading device
OnIfHighSolarOnWindow,
!- Shading Control Type
,
!- Schedule name
50.0,
!- Setpoint {W/m2}
NO,
!- Shading Control Is Scheduled
NO,
!- Glare Control Is Active
,
!- Material Name of Shading Device
,
!- Type of Slat Angle Control for Blinds
;
!- Slat Angle Schedule Name

9/29/14

266

Input-Output Reference

Group Thermal Zone Description/Geometry

FenestrationSurface:Detailed, Zn001:Wall001:Win001, !- SubSurface Name

Window
,
!- Class
SINGLE PANE WITH NO SHADE,
!- Name of construction without shading device
Zn001:Wall001
,
!- Base Surface Name
,
!- Target
0.5000000
,
!- VF to Ground
CONTROL ON INCIDENT SOLAR,
!- Window Shading Control name
,
!- Frame/Divider name
1.0
,
!- Multiplier
4
,
!- Number of vertices (assumed rectangular)
0.548 , 0.0 ,
2.5
,
!- x,y,z of vertices {m}
0.548 , 0.0 ,
0.5
,
5.548 , 0.0 ,
0.5
,
5.548 , 0.0 ,
2.5
;

! Example 2: Interior movable shade specified by giving name of shading device in

WindowProperty:ShadingControl
WindowMaterial:Glazing, GLASS - CLEAR SHEET 1 / 8 IN, !- Material Name
SpectralAverage,! Optical data type {SpectralAverage or Spectral}
,
! Name of spectral data set when Optical Data Type = Spectral
0.003
, !- Thickness {m}
0.837
, !- Solar Transmittance at Normal Incidence
0.075
, !- Solar Reflectance at Normal Incidence: Front Side
0.075
, !- Solar Reflectance at Normal Incidence: Back Side
0.898
, !- Visible Transmittance at Normal Incidence
0.081
, !- Visible Reflectance at Normal Incidence: Front Side
0.081
, !- Visible Reflectance at Normal Incidence: Back Side
0.0
, !- IR Transmittance
0.8400000
, !- IR Emissivity: Front Side
0.8400000
, !- IR Emissivity: Back Side
0.9000000
; !- Conductivity {W/m-K}
WindowMaterial:Shade, ROLL SHADE, !- Material Name
0.3
,
!- Solar Transmittance at normal incidence
0.5000000
,
!- Solar Reflectance (same for front and back side)
0.3
,
!- Visible Transmittance at normal incidence
0.5000000
,
!- Visible reflectance (same for front and back side)
0.9000000
,
!- IR Emissivity (same for front and back side)
0.05
,
!- IR Transmittance
0.003
,
!- Thickness
0.1
,
!- Conductivity {W/m-K}
0.0
,
!- Top Opening Multiplier
0.0
,
!- Bottom Opening Multiplier
0.5
,
!- Left-Side Opening Multiplier
0.5
,
!- Right-Side Opening Multiplier
0.0
;
!- Air-Flow Permeability
Construction, SINGLE PANE WITH NO SHADE, ! Name of construction without shade
GLASS - CLEAR SHEET 1 / 8 IN; !- First material layer

9/29/14

267

Input-Output Reference

Group Thermal Zone Description/Geometry

WINDOWPROPERTY:SHADINGCONTROL, CONTROL ON INCIDENT SOLAR, !- Name of Shading Control

InteriorShade,
!- Shading Type
,
!- Name of shaded construction
OnIfHighSolarOnWindow,
!- Shading Control Type
,
!- Schedule name
50.0,
!- Setpoint {W/m2}
NO,
!- Shading Control Is Scheduled
NO,
!- Glare Control Is Active
ROLL SHADE,
!- Material Name of Shading Device
,
!- Type of Slat Angle Control for Blinds
;
!- Slat Angle Schedule Name
FenestrationSurface:Detailed, Zn001:Wall001:Win001, !- SubSurface Name
Window
,
!- Class
SINGLE PANE WITH NO SHADE,
!- Name of construction without shade
Zn001:Wall001
,
!- Base Surface Name
,
!- Target
0.5000000
,
!- VF to Ground
CONTROL ON INCIDENT SOLAR,
!- Window Shading Control name
,
!- Frame/Divider name
1.0
,
!- Multiplier
4
,
!- Number of vertices (assumed rectangular)
0.548 , 0.0 ,
2.5
,
!- x,y,z of vertices {m}
0.548 , 0.0 ,
0.5
,
5.548 , 0.0 ,
0.5
,
5.548 , 0.0 ,
2.5
;

WindowProperty:FrameAndDivider
The WindowProperty:FrameAndDivider object is referenced by exterior windows that have
a frame, and/or
a divider, and/or
reveal surfaces that reflect beam solar radiation.
A frame surrounds the glazing in a window (see Figure 35 and Figure 36). It is assumed that
all frame characteristicssuch as width, conductance and solar absorptanceare the same
for the top, bottom and side elements of the frame. If the frame elements are not the same
then you should enter area-weighted average values for the frame characteristics.
The window vertices that you specify in the FenestrationSurface:Detailed object are those of
the glazed part of the window, not the frame. EnergyPlus automatically subtracts the area of
the framedetermined from the glazing dimensions and the frame widthfrom the area of
the wall containing the window.
A divider, as shown in Figure 35, Figure 36 and Figure 37, divides the glazing up into
separate lites. It is assumed that all divider elements have the same characteristics. If not,
area-weighted average values should be used. EnergyPlus automatically subtracts the
divider area from the glazed area of the window.
Reveal surfaces, as shown in Figure 38, are associated with the setback of the glazing from
the outside and/or inside surface of the parent wall. If the depth and solar absorptance of
these surfaces are specified, the program will calculate the reflection of beam solar radiation
from these surfaces. The program also calculates the shadowing (onto the window) of beam
and diffuse solar radiation by outside reveal surfaces.
In EnergyPlus, a window can have any combination of frame, divider and reveal surfaces, or
none of these.
The best source of frame and divider characteristics is the WINDOW program, which will
calculate the values required by EnergyPlus for different frame and divider types. In
particular, the THERM program within the WINDOW program will calculate the effective
conductance of frames and dividers; this is the conductance taking 2-D heat transfer effects
into account.
Note that a windows frame and divider characteristics, along with other window information,
can be read in from the Window Data File (see Importing Windows from the WINDOW
9/29/14

268

Input-Output Reference

Group Thermal Zone Description/Geometry

program
and
Construction:WindowDataFile
object).
In
this
case
the
WindowProperty:FrameAndDivider referenced by the window is not applicable and should be
blank unless you want to specify reveal surfaces for beam solar reflection.

Divider
width

Frame
width

Frame
Glazing
Divider

One of
the four
window
vertices
Figure 35. A window with a frame and divider.
In the illustration above, the divider has two horizontal elements and one vertical element.
Field: Name
The name of the frame/divider object. It is referenced by WindowProperty:FrameAndDivider
Name in FenestrationSurface:Detailed.
Frame Fields
Field: Frame Width
The width of the frame elements when projected onto the plane of the window. It is assumed
that the top, bottom and side elements of the frame have the same width. If not, an average
frame width should be entered such that the projected frame area calculated using the
average value equals the sum of the areas of the frame elements.
Field: Frame Outside Projection
The amount by which the frame projects outward from the outside surface of the window
glazing. If the outer surface of the frame is flush with the glazing, Frame Outside Projection =
0.0. Used to calculate shadowing of frame onto glass, solar absorbed by frame, IR emitted
and absorbed by frame, and convection from frame.
Field: Frame Inside Projection
The amount by which the frame projects inward from the inside surface of the window
glazing. If the inner surface of the frame is flush with the glazing, Frame Inside Projection =
0.0. Used to calculate solar absorbed by frame, IR emitted and absorbed by frame, and
convection from frame.

9/29/14

269

Input-Output Reference

Group Thermal Zone Description/Geometry

Figure 36. Illustration showing frame and divider dimensioning.

Field: Frame Conductance
The effective thermal conductance of the frame measured from inside to outside frame
surface (no air films) and taking 2-D conduction effects into account. Obtained from the
WINDOW program or other 2-D calculation.
Field: Ratio of Frame-Edge Glass Conductance to Center-Of-Glass Conductance
The glass conductance near the frame (excluding air films) divided by the glass conductance
at the center of the glazing (excluding air films). Used only for multi-pane glazing
constructions. This ratio is greater than 1.0 because of thermal bridging from the glazing
across the frame and across the spacer that separates the glass panes. Values can be
obtained from the WINDOW program the user-selected glazing construction and frame
characteristics.
Field: Frame Solar Absorptance
The solar absorptance of the frame. The value is assumed to be the same on the inside and
outside of the frame and to be independent of angle of incidence of solar radiation. If solar
reflectance (or reflectivity) data is available, then absorptance is equal to 1.0 minus
reflectance (for opaque materials).
Field: Frame Visible Absorptance
The visible absorptance of the frame. The value is assumed to be the same on the inside and
outside of the frame and to be independent of angle of incidence of solar radiation. If visible
reflectance (or reflectivity) data is available, then absorptance is equal to 1.0 minus
reflectance (for opaque materials).
Field: Frame Thermal Hemispherical Emissivity
The thermal emissivity of the frame, assumed the same on the inside and outside.
9/29/14

270

Input-Output Reference

Group Thermal Zone Description/Geometry

Divider Fields
Field: Divider Type
The type of divider (see figure below). Divider Type = Suspended is applicable only to multipane glazing. It means that the divider is suspended between the panes. (If there are more
than two glass layers, the divider is assumed to be placed between the two outermost
layers.)
Divider Type = DividedLite means that the divider elements project out from the outside and
inside surfaces of the glazing and divide the glazing into individual lites. For multi-pane
glazing, this type of divider also has between-glass elements that separate the panes.

Glass
layers
Divider

Divider Type =
DividedLite

Divider Type =
Suspended

Figure 37. Illustration showing divider types.

Field: Divider Width
The width of the divider elements when projected onto the plane of the window. It is assumed
that the horizontal and vertical divider elements have the same width. If not, an average
divider width should be entered such that the projected divider area calculated using the
average value equals the sum of the areas of the divider elements.
Field: Number of Horizontal Dividers
The number of divider elements parallel to the top and bottom of the window.
Field: Number of Vertical Dividers
The number of divider elements parallel to the sides of the window.
Field: Divider Outside Projection
The amount by which the divider projects out from the outside surface of the window glazing.
For Divider Type = Suspended, Divider Projection = 0.0. Used to calculate shadowing of
divider onto glass, solar absorbed by divider, IR emitted and absorbed by divider, and
convection from divider.
Field: Divider Inside Projection
The amount by which the divider projects inward from the inside surface of the window
glazing. If the inner surface of the divider is flush with the glazing, Divider Inside Projection =
0.0. Used to calculate solar absorbed by divider, IR emitted and absorbed by divider, and
convection from divider.
9/29/14

271

Input-Output Reference

Group Thermal Zone Description/Geometry

Field: Divider Conductance

The effective thermal conductance of the divider measured from inside to outside divider
surface (no air films) and taking 2-D conduction effects into account. Obtained from the
WINDOW program or other 2-D calculation.
Field: Ratio of Divider-Edge Glass Conductance to Center-Of-Glass Conductance
The glass conductance near the divider (excluding air films) divided by the glass conductance
at the center of the glazing (excluding air films). Used only for multi-pane glazing
constructions. This ratio is greater than 1.0 because of thermal bridging from the glazing
across the divider and across the spacer that separates the glass panes. Values can be
obtained from the WINDOW program for the user-selected glazing construction and divider
characteristics.
Field: Divider Solar Absorptance
The solar absorptance of the divider. The value is assumed to be the same on the inside and
outside of the divider and to be independent of angle of incidence of solar radiation. If solar
reflectance (or reflectivity) data is available, then absorptance is equal to 1.0 minus
reflectance (for opaque materials).
Field: Divider Visible Absorptance
The visible absorptance of the divider. The value is assumed to be the same on the inside
and outside of the divider and to be independent of angle of incidence of solar radiation. If
visible reflectance (or reflectivity) data is available, then absorptance is equal to 1.0 minus
reflectance (for opaque materials).
Field: Divider Thermal Hemispherical Emissivity
The thermal emissivity of the divider, assumed the same on the inside and outside.
Reveal Surface Fields
The following fields specify the properties of the window reveal surfaces (reveals occur when
the window is not in the same plane as the base surface). From this information and from the
geometry of the window and the sun position, the program calculates beam solar radiation
absorbed and reflected by the top, bottom, right and left sides of outside and inside window
reveal surfaces. In doing this calculation, the shadowing on a reveal surface by other reveal
surfaces is determined using the orientation of the reveal surfaces and the sun position.
It is assumed that:
The window is an exterior window.
The reveal surfaces are perpendicular to the window plane.
If an exterior shade, screen or blind is in place it shades exterior and interior reveal
surfaces so that in this case there is no beam solar on these surfaces.
If an interior shade or blind is in place it shades the interior reveal surfaces so that in this
case there is no beam solar on these surfaces.
The possible shadowing on inside reveal surfaces by a window divider is ignored.
The outside reveal surfaces (top, bottom, left, right) have the same solar absorptance
and depth. This depth is not input here but is automatically determined by the program
from window and wall vertices--as the distance between the plane of the outside face of
the glazing and plane of the outside face of the parent wall.
The inside reveal surfaces are divided into two categories: (1) the bottom reveal surface,
called here the "inside sill;" and (2) the other reveal surfaces (left, right and top).
The left, right and top inside reveal surfaces have the same depth and solar absorptance.
The inside sill is allowed to have depth and solar absorptance values that are different
from the corresponding values for the other inside reveal surfaces.
9/29/14

272

Input-Output Reference

Group Thermal Zone Description/Geometry

The inside sill depth is required to be greater than or equal to the depth of the other
inside reveal surfaces. If the inside sill depth is greater than zero the depth of the other
inside reveal surfaces is required to be greater than zero.
The reflection of beam solar radiation from all reveal surfaces is assumed to be isotropic
diffuse; there is no specular component.
Half of the beam solar reflected from outside reveal surfaces is goes towards the window;
the other half goes back to the exterior environment (i.e., reflection of this outward-going
component from other outside reveal surfaces is not considered).
The half that goes towards the window is added to the other solar radiation incident on
the window. Correspondingly, half of the beam solar reflected from inside reveal surfaces
goes towards the window, with the other half going into the zone. The portion going
towards the window that is not reflected is absorbed in the glazing or is transmitted back
out into the exterior environment.
The beam solar that is absorbed by outside reveal surfaces is added to the solar
absorbed by the outside surface of the window's parent wall; similarly, the beam solar
absorbed by the inside reveal surfaces is added to the solar absorbed by the inside
surface of the parent wall.
The net effect of beam solar reflected from outside reveal surfaces is to increase the heat
gain to the zone, whereas the effect of beam solar reflected from inside reveal surfaces is to
decrease the heat gain to the zone since part of this reflected solar is transmitted back out
the window.
If the window has a frame, the absorption of reflected beam solar by the inside and outside
surfaces of the frame is considered. The shadowing of the frame onto interior reveal surfaces
is also considered.
Field: Outside Reveal Solar Absorptance
The solar absorptance of outside reveal surfaces.
Field: Inside Sill Depth
The depth of the inside sill, measured from the inside surface of the glazing to the edge of the
sill (see Figure 38).
Field: Inside Sill Solar Absorptance
The solar absorptance of the inside sill.
Field: Inside Reveal Depth
The depth of the inside reveal surfaces other than the sill, measured from the inside surface
of the glazing to the edge of the reveal surface (see Figure 38).
Field: Inside Reveal Solar Absorptance
The solar absorptance of the inside reveal surfaces other than the sill.

9/29/14

273

Input-Output Reference

Group Thermal Zone Description/Geometry

(a)
(b)
Wall
Outside
Reveal
Surface

Inside
Reveal
Surface

Outside
Reveal
Depth

Inside
Reveal
Depth

Outside
Reveal
Depth

Inside
Reveal
Depth

Glazing

Glazing
Frame

Inside Sill
Depth
Sill

Wall

Inside Sill
Depth

Wall

Figure 38. (a) Vertical section through a window (with frame) showing outside and inside
reveal surfaces and inside sill. (b) Perspective view looking from the outside of a window
(without frame) showing reveal surfaces. Note that Outside Reveal Depth is not a user
input; it is calculated by the program from the window and wall vertices.
An IDF example:

9/29/14

274

Input-Output Reference

Group Thermal Zone Description/Geometry

WindowProperty:FrameAndDivider,
TestFrameAndDivider, ! Frame/Divider Name
0.05, ! Frame Width
0.04, ! Frame Outside Projection
0.03, ! Frame Inside Projection
5.0, ! Frame Conductance
1.3, ! Ratio of Frame-Edge Glass Conductance to Center-Of-Glass Conductance
0.8, ! Frame Solar Absorptance
0.8, ! Frame Visible Absorptance
0.9, ! Frame Thermal Emissivity
DividedLite, ! Divider Type
0.03, ! Divider Width
2,
! Number of Horizontal Dividers
2,
! Number of Vertical Dividers
0.03, ! Divider Outside Projection
0.03, ! Divider Inside Projection
5.0, ! Divider Conductance
1.3, ! Ratio of Divider-Edge Glass Conductance to Center-Of-Glass Conductance
0.8, ! Divider Solar Absorptance
0.8, ! Divider Visible Absorptance
0.9, ! Divider Thermal Emissivity
0.7, ! Outside Reveal Solar Absorptance
0.25, ! Inside Sill Depth (m)
0.6, ! Inside Sill Solar Absorptance
0.2, ! Inside Reveal Depth (m)
0.5; ! Inside Reveal Solar Absorptance

WindowProperty:AirflowControl
This object is used to specify the control mechanism for windows in which forced air flows in
the gap between adjacent layers of glass. Such windows are called airflow windows. They
are also known as heat-extract windows or climate windows.
A common application is to reduce the zone load by exhausting indoor air through the
window. In the cooling season this picks up and expels some of the solar heat absorbed by
the window glass (and by the between-glass shade or blind, if present). In the heating season
this warms the window, reducing the heat loss from the window. A side benefit is increased
thermal comfort. This is because the inside surface of the window will generally be cooler in
summer and warmer in winter.
The surface output variable Surface Window Gap Convective Heat Transfer Rate gives the
heat picked up (or lost) by the gap airflow.
Field: Name
Name of the window that this WindowProperty:AirflowControl refers to. It must be a window
with two or three glass layers, i.e., double- or triple-glazing. For triple-glazing the airflow is
assumed to be between the two inner glass layers.
An error will result if the gas in the airflow gap is other than air. If an airflow window has a
between-glass shade or blind, the gas in the gap on either side of the shade or blind must be
air.
Field: Airflow Source
The source of the gap airflow. The choices are:
IndoorAir: Indoor air from the windows zone is passed through the window.
OutdoorAir: Outdoor air is passed through the window.
Field: Airflow Destination
This is where the gap air goes after passing through the window. The choices are:
IndoorAir: The gap air goes to the indoor air of the windows zone.
OutdoorAir: The gap air goes to the outside air.

9/29/14

275

Input-Output Reference

Group Thermal Zone Description/Geometry

ReturnAir. The gap air goes to the return air for the windows zone. This choice is allowed
only if Airflow Source = InsideAir. If the return air flow is zero, the gap air goes to the indoor
air of the windows zone. If the sum of the gap airflow for all of the windows in a zone with
Airflow Destination = ReturnAir exceeds the return airflow, then the difference between this
sum and the return airflow goes to the indoor air.
Figure 39 shows the allowed combinations of Airflow Source and Airflow Destination. The
allowed combinations of Airflow Source and Airflow Destination are:
IndoorAir
OutdoorAir
IndoorAir
IndoorAir
IndoorAir
ReturnAir
OutdoorAir
IndoorAir
OutdoorAir
OutdoorAir
Field: Maximum Flow Rate
The maximum value of the airflow, in m 3/s per m of glazing width. The value is typically 0.006
to 0.009 m3/s-m (4 to 6 cfm/ft).
The airflow can be modulated by specifying Airflow Has Multiplier Schedule = Yes and giving
the name of the Airflow Multiplier Schedule (see below).
The fan energy used to move the air through the gap is generally very small and so is
ignored.
Field: Airflow Control Type
Specifies how the airflow is controlled. The choices are:
AlwaysOnAtMaximumFlow. The airflow is always equal to Maximum Airflow.
AlwaysOff. The airflow is always zero.
ScheduledOnly. The airflow in a particular timestep equals Maximum Airflow times the value
of the Airflow Multiplier Schedule for that timestep.
Field: Airflow Is Scheduled
Specifies if the airflow is scheduled. The choices are:
Yes. The airflow is scheduled.
No. The airflow is not scheduled.
If Yes, Airflow Multiplier Schedule Name is required.
Field: Airflow Multiplier Schedule Name
The name of a schedule with values between 0.0 and 1.0. The timestep value of the airflow is
Maximum Airflow times the schedule value. Required if Airflow Is Scheduled = Yes. Unused if
Airflow Is Scheduled = No. This schedule should have a ScheduleType with Numeric Type =
Continuous and Range = 0.0 : 1.0.

9/29/14

276

Input-Output Reference

(a)

Group Thermal Zone Description/Geometry

(b)

Outside

Inside

Air exhaust

(c)

Outside

Inside

(d)

Outside

Indoor air curtain

Inside

Air supply

Outside

Inside

Outdoor air curtain

To zone return air

(e)

Outside

Inside

Airflow to return air

Figure 39. Gap airflow configurations for airflow windows. (a) Air exhaust window: Airflow Source =
InsideAir, Airflow Destination = OutsideAir; (b) Indoor air curtain window: Airflow Source = InsideAir,
Airflow Destination = InsideAir; (c) Air supply window: Airflow Source = OutsideAir, Airflow Destination =
InsideAir; (d) Outdoor air curtain window: Airflow Source = OutsideAir, Airflow Destination = OutsideAir;
(e) Airflow to Return Air: Airflow Source = InsideAir, Airflow Destination = ReturnAir. Based on Active
facades, Version no. 1, Belgian Building Research Institute, June 2002.
An IDF example: window with a constant airflow from inside to outside at 0.008 m 3/s-m.
WindowProperty:AirflowControl,
!- Used to control forced airflow through a gap between glass layers
Zn001:Wall001:Win002,
!- Name of Associated Window
InsideAir,
!- Airflow Source
OutsideAir,
!- Airflow Destination
0.008,
!- Maximum Airflow (m3/s per m of glazing width)
AlwaysOnAtMaxFlow,
!- Airflow Control Type
No,
!- Airflow Has Multiplier Schedule?
;
!- Name of Airflow Multiplier Schedule

WindowProperty:StormWindow
This object allows you to assign a movable exterior glass layer (storm window or storm
glass) that is usually applied to a window in the winter to reduce heat loss and removed in
the summer. A WindowProperty:StormWindow object is required for each window that has an
associated storm window. It is assumed that:
When the storm glass is in place it is the outermost layer of the window, it covers only the
glazed part of the window and not the frame, and it forms a tight seal. See Figure 40.
9/29/14

277

Input-Output Reference

Group Thermal Zone Description/Geometry

When the storm glass is not in place it is completely removed and has no effect on
window heat transfer.
The gap between the storm glass and rest of the glazing is filled with air.

Storm
glass

Air

Distance between
storm glass and
adjacent glass

Storm window off

Storm window on

Figure 40. Section through a single-glazed window without (left) and with (right) a storm glass layer. Not
to scale.
With the addition of a storm window, single glazing effectively becomes double glazing,
double glazing becomes triple glazing, etc.
The presence of a storm window is indicated by the output variable Surface Storm Window
On Off Status (see Window Output Variables). This flag is 0 if the storm window is off, 1 if it
is on, and 1 if the window does not have an associated storm window.
The program automatically creates a window construction (ref: Construction) that consists of
the storm window glass layer and its adjacent air layer added to the original (unshaded, or
bare) window construction. In the eplusout.eio file this construction is called
BARECONSTRUCTIONWITHSTORMWIN:n, where n is the number of the associated
StormWin object. If the window has a shaded construction, the program creates a
construction called SHADEDCONSTRUCTIONWITHSTORMWIN:n that consists of the storm
window glass layer and its adjacent air layer added to the original shaded window
construction.
The program also creates a WindowMaterial:Gas layer corresponding to the air layer
adjacent to the storm glass. In the eplusout.eio file this layer is called AIR:STORMWIN:kMM,
where k is the thickness of the air layer expressed as an integer number of millimeters.
Field: Window Name
This is the name of a window (or glass door) to which the storm glass is applied. Not all
windows can accept WindowProperty:StormWindow. The rules are:
The window must be an exterior window. WindowProperty:StormWindow is not
applicable to interior (interzone) windows.
The window construction (without the storm glass layer) can have up to three glass
layers.
If
the
window
has
an
associated
shaded
construction
(ref:
WindowProperty:ShadingControl), that construction can have an interior shade or blind
and up to three glass layers, or a between-glass shade or blind and two glass layers. The

9/29/14

278

Input-Output Reference

Group Thermal Zone Description/Geometry

shaded construction cannot have an exterior shade or blind, cannot have a betweenglass shade or blind and three glass layers, and cannot be switchable glazing.
The window cannot be an airflow window, i.e., a window that has an associated
WindowProperty:AirflowControl.
Field: Storm Glass Layer Name
This is the name of a window glass material. Storm windows are assumed to consist of a
single layer of glass. A storm window frame, if present, is ignored.
Field: Distance Between Storm Glass Layer and Adjacent Glass
The separation between the storm glass and the rest of the window (Figure 40). It is
measured from the inside of the storm glass layer to the outside of the adjacent glass layer.
Field: Month that Storm Glass Layer Is Put On
The number of the month (January = 1, February = 2, etc.) during which the storm window is
put in place.
Field: Day of Month that Storm Glass Layer Is Put On
The day of the month that the storm window is put in place. It is assumed that the storm
window is put in place at the beginning of this day, i.e., during the first simulation timestep of
the day, and remains in place until that month and day given by the following two fields.
Field: Month that Storm Glass Layer Is Taken Off
The number of the month (January = 1, February = 2, etc.) during which the storm window is
removed.
Field: Day of Month that Storm Glass Layer Is Taken Off
The day of the month that the storm window is removed. It is assumed that the storm window
is removed at the beginning of this day, i.e., during the first simulation timestep of the day,
and stays off until the month and day given by Month that Storm Glass Layer Is Put On, Day
of Month that Storm Glass Layer Is Put On.
In the northern hemisphere, the month the storm window is put on is generally greater than
the month it is taken off (for example put on in month 10, when it starts to get cold, and taken
off in month 5, when it starts to warm up). In the southern hemisphere this is reversed: month
on is less than month off.
An IDF example of WindowProperty:StormWindow. The storm window is put in place on
October 15 and removed on May 1.
WindowProperty:StormWindow,
Window1, !- Name of Window to Which Storm Window Glass Layer is Applied
GlassA, !- Name of Material:WindowGlass or MATERIAL:WindowGlass:AltInput that is the storm window layer
0.060,
!- Distance from storm window to adjacent glass (m)
10,
!- Month that Storm Window Is Put On
15,
!- Day of Month that Storm Window Is Put On
5,
!- Month that Storm Window Is Taken Off
1;
!- Day of Month that Storm Window Is Taken Off

Importing Windows from WINDOW program

WINDOW v6.3 and later is capable of writing IDF excerpts for Window data. This is the
preferred method as no external file is necessary. See the Tips document for details on
obtaining the IDF excerpt.
The WINDOW program calculates the U-value, Solar Heat Gain Coefficient, solar
transmission/absorption characteristics, visible transmission characteristics and other
properties of a window under standard indoor and outdoor conditions. WINDOW treats the
whole window systemglazing, frame and divider. A sub-program of WINDOW called
THERM uses a 2-D finite element calculation to determine the effective conductance of
9/29/14

279

Input-Output Reference

Group Thermal Zone Description/Geometry

frame, divider and edge-of-glass elements. Another sub-program, OPTICS, determines the
solar-optical properties of glazing, including laminates and coated glass.
WINDOW can write a data file containing a description of the window that was analyzed. An
example of this file (which is no longer the preferred method) is shown in the Tips document
under WINDOW generated files. is shown below. This file, which can be named by the user,
can be read by EnergyPlus. For more complete description and examples, see the object
description -- Construction:WindowDataFile.
In this way, the same window that was created in WINDOW can be imported into EnergyPlus
for annual energy analysis without having to re-input the window data. To obtain WINDOW,
THERM, or OPTICS go to http://windows.lbl.gov and choose the software link. A major
advantage of using WINDOW to create window input for EnergyPlus is that you will have
direct access to WINDOWs expanding database of over 1000 different glass types; and you
will be able to browse through this database according to different criteria (color,
transmittance, solar heat gain coefficient, etc.) to help you select the best glass type for your
application.
Although WINDOW writes only one window entry on the WINDOW data file, EnergyPlus
users can combine two or more of these files to end up with a single data file with multiple
window entries of different types. In this way a library of windows from WINDOW can be built
up if so desired. If you combine files like this you should be sure not to leave out or change
any of lines from the original files.
There are four methods for inputting window constructions in EnergyPlus:
1) input full spectral data for each layer in the IDF,
2) input spectral average data for each layer in the IDF,
3) items 1 and 2 can be accomplished by reporting the IDF excerpt method from WINDOW
4) import WINDOW report containing layer-by-layer calculated values and overall glazing

system angular values.

Note: When using method 4, the overall glazing system angular dependent properties, including
Tsol, Abs, Rfsol, Rbsol, Tvis, Rfvis, and Rbvis, are not used by EnergyPlus. Therefore, methods 1
and 2 and preferably 3 are recommended.

The SHGC calculations in EnergyPlus for window layers input using full spectral data use
a spectral weighting data set (derived from Optics5 data file ISO-9845GlobalNorm.std)
that is different from the WINDOW default spectral weighting data set
(W5_NFRC_2003.std). This difference accounts for most of the variation in SHGC
values reported by EnergyPlus and WINDOW for full spectral data window layer input.
This variation is more pronounced for window constructions of three glass layers or more.
Users intending to select a window construction based on SHGC value for energy code
compliance should base their selection on the value reported by WINDOW since this is
the officially recognized value.
In EnergyPlus, the Window data file is searched for each Construction:WindowDataFile
object in the EnergyPlus input. This object has a very simple form:
Construction:WindowDataFile,
ConstructionName,
FileName; ! Default is Window5DataFile.dat in the run folder.

If there is a window called ConstructionName on the Window data file, the data for that
window is read from the file and the following EnergyPlus objects and their names are
created. The W5 prefixed to these names indicates that the object originated in the Window
data file.

9/29/14

280

Input-Output Reference

Group Thermal Zone Description/Geometry

Zone Thermal Output(s)

In addition to the canned Surface reports (view the Reports section later in this document)
and surface variables (above), the following variables are available for all zones:
Zone,Sum,Zone Total Internal Radiant Heating Energy [J]
Zone,Sum,Zone Total Internal Visible Radiation Heating Energy [J]
Zone,Sum,Zone Total Internal Convective Heating Energy [J]
Zone,Sum,Zone Total Internal Latent Gain Energy [J]
Zone,Sum,Zone Total Internal Total Heating Energy [J]
Zone,Average,Zone Mean Air Temperature [C]
HVAC,Average,Zone Air Temperature [C]
Zone,Average,Zone Mean Radiant Temperature [C]
Zone,Average,Zone Operative Temperature [C]
HVAC,Sum,Zone Air System Sensible Heating Energy [J]
HVAC,Sum,Zone Air System Sensible Cooling Energy [J]
HVAC,Average,Zone Air System Sensible Heating Rate [W]
HVAC,Average,Zone Air System Sensible Cooling Rate [W]
HVAC,Average,Zone Air Humidity Ratio[kgWater/kgDryAir]
HVAC,Average,Zone Air Relative Humidity[%]

Two of these are of particular interest:

Zone,Average,Zone Mean Air Temperature [C]
HVAC,Average,Zone Air Temperature [C]

These two variable outputs are/should be identical. However, note that they can be reported
at different time intervals. Zone Mean Air Temperature is only available on the Zone/HB
timestep (Number of Timesteps per Hour) whereas Zone Air Temperature can be reported
at the HVAC timestep (which can vary).
Zone Mean Air Temperature [C]
From the code definition, the zone mean air temperature is the average temperature of the air
temperatures at the system timestep. Remember that the zone heat balance represents a
well stirred model for a zone, therefore there is only one mean air temperature to represent
the air temperature for the zone.
Zone Air Temperature [C]
This is very similar to the mean air temperature in the last field. The well stirred model for
the zone is the basis, but this temperature is also available at the detailed system timestep.
Zone Mean Radiant Temperature [C]
The Mean Radiant Temperature (MRT) in degrees Celsius of a space is really the measure of
the combined effects of temperatures of surfaces within that space. The larger the surface
area and the closer one is to it, the more effect the surface temperature of that surface has
on each other. The MRT is the measure of all these surface areas and temperatures.
Zone Operative Temperature [C]
Zone Operative Temperature (OT) is the average of the Zone Mean Air Temperature (MAT)
and Zone Mean Radiant Temperature (MRT), OT = 0.5*MAT + 0.5*MRT. This output
variable is not affected by the type of thermostat controls in the zone, and does not include
the direct effect of high temperature radiant systems. See also Zone Thermostat Operative
Temperature.
Zone Air System Sensible Heating Energy [J]
This field represents the sensible heating energy in Joules that is actually supplied by the
system to that zone for the timestep reported. This is the sensible heating rate multiplied by
the simulation timestep. This is calculated and reported from the Correct step in the Zone
Predictor-Corrector module. . This field is not multiplied by zone or group multipliers.

9/29/14

281

Input-Output Reference

Group Thermal Zone Description/Geometry

Zone Air System Sensible Heating (and Cooling) Energy (and Rate) all report the heating or cooling
delivered by the HVAC system to a zone. These values are calculated by multiplying the supply air mass
flow rate by the difference between the supply air temperature and the zone air temperature. This does not
always indicate the operation of heating or cooling coils. For example, cooling will be reported if the supply
air is cooled due to the introduction of outside air, even if all coils are off.
Note that these variables are calculated at the system timestep. When reported at the "detailed" reporting
frequency, these variable will never show heating and cooling both in the same system timestep. If
reported at a frequency less than "Detailed" (for example, Hourly) values may appear in both the heating
and cooling variable for the same hour if the system cooled the zone for part of the reporting period and
heated the zone for another part of the reporting period.

Zone Air System Sensible Cooling Energy [J]

This field represents the sensible cooling energy in Joules that is actually supplied by the
system to that zone for the timestep reported. This is the sensible cooling rate multiplied by
the simulation timestep. This is calculated and reported from the Correct step in the Zone
Predictor-Corrector module. This field is not multiplied by zone or group multipliers.
Zone Air System Sensible Heating Rate [W]
This field represents the sensible heating rate in Watts that is actually supplied by the system
to that zone for the timestep reported. This is calculated and reported from the Correct step in
the Zone Predictor-Corrector module.
This field is not multiplied by zone or group
multipliers.
Zone Air System Sensible Cooling Rate [W]
This field represents the sensible cooling rate in Watts that is actually supplied by the system
to that zone for the timestep reported. This is calculated and reported from the Correct step in
the Zone Predictor-Corrector module.
This field is not multiplied by zone or group
multipliers.
Zone Air Humidity Ratio[kgWater/kgDryAir]
This field represents the air humidity ratio after the correct step for each zone. The humidity
ratio is the mass of water vapor to the mass of dry air contained in the zone in (kg water/kg
air) and is unitless.
Zone Air Relative Humidity[%]
This field represents the air relative humidity ratio after the correct step for each zone. The
relative humidity is in percent and uses the Zone Air Temperature, the Zone Air Humidity
Ratio and the Outside Barometric Pressure for calculation.
Zone Total Internal Radiant Heating Energy [J]
This field represents the sum of radiant gains from specific internal sources (e.g. equipment)
throughout the zone in joules. This includes radiant gain from People, Lights, Electric
Equipment, Gas Equipment, Other Equipment, Hot Water Equipment, and Steam Equipment.
Zone-Total Internal Visible Heat Gain [J]
This field expresses the sum of heat gain in joules that is the calculated short wavelength
radiation gain from lights in the zones. This calculation uses the total energy from lights and
the fraction visible to realize this value, summed over the zones in the simulation.

9/29/14

282

Input-Output Reference

Group Advanced Surface Concepts

Zone Total Internal Convective Heating Energy [J]

This field represents the sum of convective gains from specific sources (e.g. equipment)
throughout the zone in joules. This includes convective gain from People, Lights, Electric
Equipment, Gas Equipment, Other Equipment, Hot Water Equipment, and Steam Equipment.
Zone Total Internal Latent Gain Energy [J]
This field represents the sum of latent gains from specific internal sources (e.g. equipment)
throughout the zone in joules. This includes latent gain from People, Electric Equipment, Gas
Equipment, Other Equipment, Hot Water Equipment, and Steam Equipment.
Zone Total Internal Total Heating Energy [J]
This field represents the sum of all heat gains throughout the zone in joules. This includes all
heat gains from People, Lights, Electric Equipment, Gas Equipment, Other Equipment, Hot
Water Equipment, and Steam Equipment.

Group Advanced Surface Concepts

This group of objects describe concepts applied to heat transfer surfaces that are of an
advanced nature. Careful consideration must be given before using these.
SurfaceProperty:HeatTransferAlgorithm
This object, and three other related objects, can be used to control which surface heat
transfer model is used on specific surfaces.
The separate object called
HeatBalanceAlgorithm is used to control the heat transfer model in an overall way while this
object can be used to revise the algorithm selections for specific surfaces. This object allows
selectively overriding the global setting in HeatBalanceAlgorithm to choose one of the
following models for a particular surface:
CTF (Conduction Transfer Functions),
EMPD (Effective Moisture Penetration Depth with Conduction Transfer Functions).
CondFD (Conduction Finite Difference)
HAMT (Combined Heat And Moisture Finite Element)
Field: Surface Name
This is the name of the surface that will be assigned to use the heat transfer algorithm
selected in the next field. This should be a name of a surface defined elsewhere.
Field: Algorithm
This field is used to determine the heat transfer algorithm that is to be applied to the surface
named in the previous field. The allowable choices are:
ConductionTransferFunction
MoisturePenetrationDepthConductionTransferFunction
ConductionFiniteDifference
CombinedHeatAndMoistureFiniteElement
SurfaceProperty:HeatTransferAlgorithm:MultipleSurface
This object can be used to control the surface heat transfer model used for specific types of
surfaces. The separate object called HeatBalanceAlgorithm is used to control the heat
transfer model in an overall way while this object can be used to revise the algorithm
selections for specific types of surfaces. This object allows selectively overriding the global
setting in HeatBalanceAlgorithm to choose one of the following models for all surfaces of a
particular type:
9/29/14

283

Input-Output Reference

Group Advanced Surface Concepts

CTF (Conduction Transfer Functions),

EMPD (Effective Moisture Penetration Depth with Conduction Transfer Functions).
CondFD (Conduction Finite Difference)
HAMT (Combined Heat And Moisture Finite Element)
Field: Name
This is a unique, user-defined name for the object.
Field: Surface Type
This field is selects the type of surfaces that are all assigned to use the heat transfer
algorithm selected in the next field. This field is used with one of the following allowable
keywords:
AllExteriorSurfacesall surfaces that have Outdoors outside boundary condition
AllExteriorWallsall walls that have Outdoors outside boundary condition
AllExteriorRoofsall roofs that have Outdoors outside boundary condition
AllExteriorFloorsall floors that have Outdoors outside boundary condition
AllGroundContactSurfacesall surfaces that have Ground outside boundary
condition
AllInteriorSurfacesall surfaces that are internal partition-type surfaces
AllInteriorWallsall walls that are internal surfaces
AllInteriorCeilingsall ceilings that are internal surfaces
AllInteriorFloorsall floors that are are internal surfaces
Field: Algorithm
This field is used to determine the heat transfer algorithm that is to be applied to the surface
types in the previous field. The allowable choices are:
ConductionTransferFunction
MoisturePenetrationDepthConductionTransferFunction
ConductionFiniteDifference
CombinedHeatAndMoistureFiniteElement
SurfaceProperty:HeatTransferAlgorithm:MultipleSurface,
my exterior wall override,
AllExteriorWalls,
ConductionFiniteDifference;

SurfaceProperty:HeatTransferAlgorithm:SurfaceList
This object can be used to control the surface heat transfer model used for a list of surfaces.
The separate object called HeatBalanceAlgorithm is used to control the heat transfer model
in an overall way while this object can be used to revise the algorithm selections for a list of
specific surfaces.
This object allows selectively overriding the global setting in
HeatBalanceAlgorithm to choose one of the following models for listed:
CTF (Conduction Transfer Functions),
EMPD (Effective Moisture Penetration Depth with Conduction Transfer Functions).
CondFD (Conduction Finite Difference)
HAMT (Combined Heat And Moisture Finite Element)
Field: Name
This is a unique, user-defined name for the object.

9/29/14

284

Input-Output Reference

Group Advanced Surface Concepts

Field: Algorithm
This field is used to determine the heat transfer algorithm that is to be applied to the surface
listed in the remaining fields. The allowable choices are:
ConductionTransferFunction
MoisturePenetrationDepthConductionTransferFunction
ConductionFiniteDifference
CombinedHeatAndMoistureFiniteElement
Field: Surface Name N
This is the name of the Nth surface that will be assigned to use the heat transfer algorithm
selected in this object. These should be the names of surfaces defined elsewhere. This
object is extensible. Additional surfaces can be added to extend the object.
An example IDF object follows.
SurfaceProperty:HeatTransferAlgorithm:SurfaceList,
my wall construct override,
!- Name
ConductionFiniteDifference,
!- Algorithm
Zn001:Wall001,
!- Surface Name 1
Zn001:Wall002,
!- Surface Name 2
Zn001:Wall003,
!- Surface Name 3
Zn001:Wall004;
!- Surface Name 4

SurfaceProperty:HeatTransferAlgorithm:Construction
This object can be used to control the surface heat transfer model used for surfaces that
have a specific type of construction. The separate object called HeatBalanceAlgorithm is
used to control the heat transfer model in an overall way while this object can be used to
revise the algorithm selections for specific constructions. This object allows selectively
overriding the global setting in HeatBalanceAlgorithm to choose one of the following models
for all surfaces with particular type of construction:
CTF (Conduction Transfer Functions),
EMPD (Effective Moisture Penetration Depth with Conduction Transfer Functions).
CondFD (Conduction Finite Difference)
HAMT (Combined Heat And Moisture Finite Element)
Field: Name
This is a unique, user-defined name for the object.
Field: Algorithm
This field is used to determine the heat transfer algorithm that is to be applied to the surfaces
with the type of of construction listed in the next field. The allowable choices are:
ConductionTransferFunction
MoisturePenetrationDepthConductionTransferFunction
ConductionFiniteDifference
CombinedHeatAndMoistureFiniteElement
Field: Construction Name
This field is the name of a Construction object defined elsewhere. All the surfaces in the
model that are assigned this type of construction will be assigned to use the heat transfer
algorithm slected in the previous field.
An example IDF object follows.
SurfaceProperty:HeatTransferAlgorithm:Construction,

9/29/14

285

Input-Output Reference
my wall construct override,
ConductionFiniteDifference,
R13WALL;

Group Advanced Surface Concepts

!- Name
!- Algorithm
!- Construction Name

SurfaceControl:MoveableInsulation
Movable insulation can be used/scheduled on any surface regular surface (such as a wall,
floor, roof, etc.) but not on a subsurface (such as a window, use
WindowProperty:ShadingControl instead). With movable insulation, no reference is made in
the surface that is using the insulation rather the movable insulation statement references
the surface to which it is applied.
Exterior and interior movable insulation have undergone some testing and appears to
producing expected results. The underlying principle has been implemented in EnergyPlus
for both interior and exterior movable insulation with the possibility for exterior movable
insulation to be transparent (transparent insulation material or TIM).
TIM exterior layers can be used with the ConductionFiniteDifference (CondFD) solution
algorithm. With this addition, TIM layers can be used in conjunction with wall layers that have
phase change materials (PCM) included, or any other advanced capability of the CondFD
algorithm such as variable conductivity. The input requirements are exactly the same as
when used with the CTF algorithm. The Solution Algorithm needs to be changed to CondFD,
and as with CTF, the SurfaceControl:MovableInsulation object must be completed to specify
the insulated surface and the WindowMaterial:Glazing object is needed to provide the TIM
layer properties.
Basically, the addition of movable insulation allows the user to schedule an extra amount of
insulation on either the inside or outside surface of a wall (or both). The insulation must be a
simple, homogenous material layer (linked to a material definition within the input data file).
Note that EnergyPlus allows the exterior movable insulation layer to be transparent to short
wavelength radiation (solar). In this case, incident solar is split between the plane between
the movable insulation and the surface and the plane between the movable insulation and the
surrounding air. This calculation is fairly basic and based on the solar transmittance of the
insulation layer (material properties). Using transparent layers for exterior movable insulation
allows solar energy to penetrate deeper into a construction where it can be stored for later
use in the building (similar in concept to a Trombe Wall).
Field: Insulation Type
This field determines whether the movable insulation is applied to the inside or the outside of
the surface by entering either Inside or Outside, respectively.
Field: Surface Name
This field refers the movable insulation back to a particular surface (ref: Building Surfaces) via
its user assigned name so that EnergyPlus knows where to apply this extra layer of
insulation. This will affect either the inside or outside surface heat balance of this surface
depending on the value in the insulation type field (see previous field).
Field: Material Name
This field refers to a material layer (e.g., Material, Material:NoMass, or
WindowMaterial:Glazing; transparent layers are only valid for outside movable insulation) via
its user assigned name. This provides the program with a full complement of material
properties so that the effect of the insulation (R-value and solar transmittance) can be
correctly taken into account by EnergyPlus.
Field: Schedule Name
This field is a schedule that theoretically can be any positive real number but was originally
intended to be a parameter between 0.0 and 1.0. Its purpose is to act as a fractional modifier
on the resistance of the material layer. The actual thermal resistance of the movable
insulation is equal to the resistance of the material layer times the current value in the
9/29/14

286

Input-Output Reference

Group Advanced Surface Concepts

movable insulation schedule. A value of 0.0 simply means that the movable insulation is not
present.
An example of this syntax implemented in an input file is:
SurfaceControl:MoveableInsulation,
Exterior,
!
Zone001:Wall001,
!
TransparentInsulationMaterial, !
PresentInWinterSchedule;
!

Insulation Type
Surface Name
Material Name
Schedule Name

SurfaceProperty:OtherSideCoefficients
By referencing the Other Side Coefficients statement in the surface statements (i.e. Outside
Boundary Condition), the temperature of the outer plane of a surface (see Figure 41) can be
directly controlled. Other side coefficients can also be used to control the exterior convective
heat transfer coefficient of a surface and the corresponding exterior air temperature. It should
be noted that solar effects are not accounted for when other side coefficients are used. In
addition, if other side coefficients are specified for a surface, they also hold for subsurfaces of
that surface (though subsurfaces can have their own coefficient set).
Other side coefficients have the same effect on all types of heat transfer surfaces. In other
words, an interior surface with other side coefficients specified and an exterior wall with
identical other side coefficients specified are simulated exactly the same. A surface that uses
other side coefficients should be thought of as a new or separate type of surface. All heat
transfer surfaces are simulated in the same manner through conduction transfer functions.
The only difference between the various types of heat transfer surfaces is the environment on
the other side of the surface. For example, the other side environment of an exterior surface
is the outdoor environment. For an interior surface, the temperature of the outer plane of the
surface is set equal to the temperature of the inner plane of the surface. Similarly, a surface
with other side coefficients specified will allow the user to control the other side environment.
Heat transfer through a surface is an extremely important component in the calculation of
zone loads. The information to calculate this heat transfer is readily available if the surface is
exposed to the outdoor environment or to another zone that is being simulated. Occasionally,
a user will want to model the heat transfer through a surface that is adjacent to an area that is
not included in the EnergyPlus model. For example, an office area is attached to a
warehouse and the user is only interested in simulating the office area. An interior surface
with other side coefficients specified could be used to control the environment on the other
side of the surface, thereby accounting for the heat transfer through the adjoining surface.
Other Side Coefficients affects the "other side" of a surface as described below. Each
coefficient has a special meaning. You may enter a 0 or blank if you are not using a particular
coefficient. Note that there are two potential ways to use other side coefficients. Either they
are used to set the temperature of the exterior side surface directly (if the combined
convective/radiative coefficient below is less than or equal to zero) or to set both the film
coefficient (positive value for the combined convective/radiative coefficient below) and the
outside air temperature.
Field: Name
This, of course, is the string referenced in the Surface statement that is using
OtherSideCoefficients as the Outside Boundary Condition.
Field: Combined Convective/Radiative Film Coefficient
This is a trigger value. If the value is greater than zero, then it is taken to be the combined
convective/radiative film coefficient. In this case (value > 0), the remaining fields are used first
to calculate the outside air temperature for the surface and then to calculate the outside
surface temperature based on the outside air temperature and the film coefficient. If this field
is less than or equal to zero, then the remaining fields are used to calculate the surface
temperature (not the outside air temperature). The units for this field are the same as for a

9/29/14

287

Input-Output Reference

Group Advanced Surface Concepts

convective heat transfer coefficient: W/(m 2*K). This is referred to as C1 in the reference
below.
Field: Constant Temperature
This field defines a temperature term that is a constant part of the calculation either of the
surface or outside air temperature. This parameter is shown as C2 in the equation below.
The units for this parameter are degrees C. If a schedule name is included as the second
parameter, the value of this parameter will be overridden by the value from the schedule. The
default for this field is 0.0.
Field: Constant Temperature Coefficient
This field defines a constant coefficient that is applied to the constant temperature (see
previous field). This parameter is shown as C3 in the equation below. This parameter is
dimensionless. The value of this parameter is usually 1.0 if a schedule is used to set C2. This
field is ignored if Sinusoidal Variation of Constant Temperature Coefficient = Yes. The default
for this field is 1.0.
Field: External Dry-Bulb Temperature Coefficient
This field defines a constant coefficient that is applied to the outside air dry-bulb temperature.
This parameter is shown as C4 in the equation below. This parameter is dimensionless. The
default for this field is 0.0.
Field: Ground Temperature Coefficient
This field defines a constant coefficient that is applied to the ground temperature (ref.
Site:GroundTemperature:BuildingSurface). This parameter is shown as C5 in the equation
below. This parameter is dimensionless.
Field: Wind Speed Coefficient
This field defines a constant coefficient that is applied to the product of the outside air drybulb temperature and the wind speed. This parameter is shown as C6 in the equation
below. This parameter has dimensions of inverse velocity or s/m. The default for this field is
0.0.
Field: Zone Air Temperature Coefficient
This field defines a constant coefficient that is applied to the temperature of the zone to which
this surface belongs. This parameter is shown as C7 in the equation below. This parameter
is dimensionless. The default for this field is 0.0.
Field: Constant Temperature Schedule Name
This field is used to supply a schedule name. That schedule will supply the constant
temperature value C2. Note that the value of the C3 field should normally be 1.0 if a schedule
is used for C2. If not blank, this field must be a valid schedule name.
Field: Sinusoidal Variation of Constant Temperature Coefficient
This field is optional and can be used to define an alternate method of prescribing the
coefficient that is applied to the constant temperature (see the fields Constant Temperature
and Constant Temperature Coefficient). This parameter is shown as C2 in the equation
below. If this field is omitted, left blank, or set to No, then C2 is a constant (defined in the
field Constant Temperature Coefficient). However if this is set to Yes, then the value of C2
varies with a unitary sine wave in the following way:

C2

9/29/14

Sin 2

time of day
period

288

Input-Output Reference

Group Advanced Surface Concepts

The value for period is controlled in the following field. The value for time of day is based
on the zone timestep and is in units of hours. The sine function here uses input as radians.
When using this option, the value for C2 will vary between -1.0 and 1.0 and the value put in
the field Constant Temperature Coefficient is not used. This option cannot be used at the
same time as scheduling a constant temperature with the previous field.
Field: Period of Sinusoidal Variation
This field is used to define the period of the sine wave when using the Sinusodial Variation of
Constant Temperature Coefficient capability selected in the previous field. This field is the
time period of the sine wave in units of hours. The default is 24 hours and provides a diurnal
sine wave. The value entered here is period in the equation in the previous field.
Field: Previous Other Side Temperature Coefficient
This field defines a constant coefficient that is applied to the other side temperature
computed by this object from the previous zone time step. This parameter is shown as C8 in
the equation below. This parameter is dimensionless. The default for this field is 0.0.
Field: Minimum Other Side Temperature Limit
This field specifies a lower limit for the other side temperature result in degrees C. If blank,
there is no lower limit.
Field: Maximum Other Side Temperature Limit
This field specifies an upper limit for the other side temperature result in degrees C. If blank,
there is no upper limit.
The coefficients listed above are used in the following equation:

C 2* C3 C 4*Toadb C5*Tgrnd C6*Wspd *Toadb C7*Tzone C8*Tpast

where:
T = Outside Air Temperature when C1 (Combined convective/radiative film Coeff) > 0
T = Exterior Surface Temperature when C1 (Combined convective/radiative film Coeff) <= 0
Tzone = Temperature of the zone being simulated (C)
Toadb = Dry-bulb temperature of the outdoor air (C)
Tgrnd = Temperature of the ground (C) from Site:GroundTemperature:BuildingSurface
Wspd = Outdoor wind speed (m/sec)
Tpast = Other side temperature from previous zone timestep (C)

9/29/14

289

Input-Output Reference

Group Advanced Surface Concepts

Heat Transfer
Surface
Outer Plane
of Surface

Exterior Air

Zone Air

Figure 41. Illustration for Other Side Coefficients

! Example input using temperature schedule
SurfaceProperty:OtherSideCoefficients,
OSCCoef:Zn005:Wall003,
!- Name
0,
!- Combined Convective/Radiative Film Coefficient {W/m2-K}
0.000000,
!- Constant Temperature {C}
1.000000,
!- Constant Temperature Coefficient
0.000000,
!- External Dry-Bulb Temperature Coefficient
0.000000,
!- Ground Temperature Coefficient
0.000000,
!- Wind Speed Coefficient
0.000000,
!- Zone Air Temperature Coefficient
Zn005Wall003OtherSideTempSched; !- Constant Temperature Schedule Name

! Example input for outside heat transfer coefficient of 1.23, using Tosdb
SurfaceProperty:OtherSideCoefficients,
OSCCoef:Zn005:Wall004,
!- Name
1.230000,
!- Combined Convective/Radiative Film Coefficient {W/m2-K}
0.000000,
!- Constant Temperature {C}
0.000000,
!- Constant Temperature Coefficient
1.000000,
!- External Dry-Bulb Temperature Coefficient
0.000000,
!- Ground Temperature Coefficient
0.000000,
!- Wind Speed Coefficient
0.000000,
!- Zone Air Temperature Coefficient
,
!- Constant Temperature Schedule Name
No,
!- Sinusoidal Variation of Constant Temperature Coefficient
24,
!- Period of Sinusoidal Variation {hr}
0.,
!- Previous Other Side Temperature Coefficient
,
!- Minimum Other Side Temperature Limit {C}
;
!- Maximum Other Side Temperature Limit {C}

SurfaceProperty:OtherSideCoefficients Outputs
Zone,Average,Surface Other Side Coefficients Exterior Air Drybulb Temperature

Surface Other Side Coefficients Exterior Air Drybulb Temperature [C]

This is the air temperature applied to the other side of the surface.
SurfaceProperty:OtherSideConditionsModel
By referencing the Other Side Conditions Model statement in the surface statements (i.e.
Outside Boundary Condition), the boundary conditions for the outer plane of the mass wall
can be connected to the appropriate model for various multi-skin components. The types of
multi-skin components that use this object include systems that are mounted to the outside
surface using standoffs that create a small air gap see Figure 42. This type of modeling
allows using the usual heat transfer calculations for the underlying surface with other types of
multi-skin component models that are available including: unglazed transpired solar
collectors, ventilated photovoltaic panels, and naturally ventilated facades.
9/29/14

290

Input-Output Reference

Group Advanced Surface Concepts

The boundary condition values are determined dynamically by the program using internal
component models. If you want to define other side surface temperatures or convection
conditions, then use SurfaceProperty:OtherSideCoefficients instead of this object.
It should be noted that when other side conditions models are used, solar effects are
removed from the surfaces outside face heat balance, but are used in modeling the
component adjacent to that surface.
In addition, the other side conditions model has been modified to include underground piping
system interaction. The PipingSystem:Underground:Domain object represents a mass of
ground which may include interaction with, for example, basement surfaces. In this case, the
ground model will internally use the other side condition model hook to update boundary
conditions for those surfaces which use that other side condition model name reference.
Field: Name
This is the string referenced in the Surface statement that is using OtherSideModel as the
Exterior Environment.
Field: Type of Modeling
This is a string key selection used to identify the type of model that will be used to determine
boundary conditions. The only available choices are GapConvectionRadiation or
UndergroundPipingSystemSurface.

Figure 42. Illustration for Other Side Conditions Model

An example specification is:
SurfaceProperty:OtherSideConditionsModel,
UTSC OSCM ZN11,
! OtherSideConditionsModel Name
GapConvectionRadiation; ! Type of Modeling used to determine Boundary Conditions

9/29/14

291

Input-Output Reference

Group Advanced Surface Concepts

SurfaceProperty:OtherSideConditionsModel Outputs
Zone,Average,Surface
[C]
Zone,Average,Surface
Coefficient [W/m2-K]
Zone,Average,Surface
Zone,Average,Surface
Coefficient [W/m2-K]

Other Side Conditions Modeled Convection Air Temperature

Other Side Conditions Modeled Convection Heat Transfer
Other Side Conditions Modeled Radiation Temperature [C]
Other Side Conditions Modeled Radiation Heat Transfer

Surface Other Side Conditions Modeled Convection Air Temperature [C]

This is the air temperature exposed to the other side of the surface by the model and used in
convection heat transfer calculations.
Surface Other Side Conditions Modeled Convection Heat Transfer Coefficient [W/m2-K]
This is the surface convection heat transfer coefficient applied to the other side of the surface
by the model.
Surface Other Side Conditions Modeled Radiation Temperature [C]
This is the effective temperature exposed to the other side of the surface for thermal radiation
heat transfer calculations.
Surface Other Side Conditions Modeled Radiation Heat Transfer Coefficient [W/m2-K]
This is the effective (Iinearized) radiation heat transfer coefficient applied to the other side of
the surface by the model.
SurfaceConvectionAlgorithm:Inside:AdaptiveModelSelections
This object provides options to change the individual convection model equations for dynamic
selection when using AdaptiveConvectionAlgorithm. 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: Name
A unique name for the object.
Field: Simple Bouyancy Vertical Wall Equation Source
Applies to zone with no HVAC or when HVAC is off. This is for vertical walls. The key choice
options
include:
FohannoPolidoriVerticalWall,
ASHRAEVerticalWall,
AlamdariHammondVerticalWall, KhalifaEq3WallAwayFromHeat, KhalifaEq6NonHeatedWalls
FohannoPolidoriVerticalWall, ISO15099Windows, or UserCurve
Field: Simple Bouyancy Vertical Wall User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve
Field: Simple Bouyancy Stable Horizontal Equation Source
Applies to zone with no HVAC or when HVAC is off. This is for horizontal surfaces with heat
flow directed for stable thermal stratification.
The key choice options include:
WaltonStableHorizontalOrTilt, AlamdariHammondStableHorizontal, or UserCurve
Field: Simple Bouyancy Stable Horizontal Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve

9/29/14

292

Input-Output Reference

Group Advanced Surface Concepts

Field: Simple Bouyancy Unstable Horizontal Equation Source

Applies to zone with no HVAC or when HVAC is off. This is for passive horizontal surfaces
with heat flow for unstable thermal stratification.
The key choice options include:
WaltonUnstableHorizontalOrTilt, AlamdariHammondUnstableHorizontal, or UserCurve.
Field: Simple Bouyancy Unstable Horizontal Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
Field: Simple Bouyancy Stable Tilted Equation Source
Applies to zone with no HVAC or when HVAC is off. This is for tilted surfaces with heat flow
for
stable
thermal
stratification.
The
key
choice
options
include:
WaltonStableHorizontalOrTilt, AlamdariHammondStableHorizontal, or UserCurve
Field: Simple Bouyancy Stable Tilted Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
Field: Simple Bouyancy Unstable Tilted Equation Source
Applies to zone with no HVAC or when HVAC is off. This is for tilted surfaces with heat flow
for unstable thermal stratification. The key choices include: WaltonUnstableHorizontalOrTilt,
AlamdariHammondUnstableHorizontal, or UserCurve.
Field: Simple Bouyancy Unstable Tilted Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
Field: Simple Bouyancy Windows Equation Source
Applies to zone with no HVAC or when HVAC is off. This is for all window surfaces. The key
choice
options
include:
ASHRAEVerticalWall,
AlamdariHammondVerticalWall,
FohannoPolidoriVerticalWall, KaradagChilledCeiling, ISO15099Windows, or UserCurve.
Field: Simple Bouyancy Windows Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
Field: Floor Heat Ceiling Cool Vertical Wall Equation Source
Applies to zone with in-floor heating and/or in-ceiling cooling. This is for vertical walls. The
key choice options include:
ASHRAEVerticalWall, AlamdariHammondVerticalWall,
KhalifaEq3WallAwayFromHeat,
FohannoPolidoriVerticalWall,
ISO15099Windows,
or
UserCurve.
Field: Floor Heat Ceiling Cool Vertical Wall Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
Field: Floor Heat Ceiling Cool Stable Horizontal Equation Source
Applies to zone with in-floor heating and/or in-ceiling cooling. This is for passive horizontal
surfaces with heat flow for stable thermal stratification. The key choice options include:
WaltonStableHorizontalOrTilt, AlamdariHammondStableHorizontal, or UserCurve.
Field: Floor Heat Ceiling Cool Stable Horizontal Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
9/29/14

293

Input-Output Reference

Group Advanced Surface Concepts

Field: Floor Heat Ceiling Cool Unstable Horizontal Equation Source

Applies to zone with in-floor heating and/or in-ceiling cooling. This is for passive horizontal
surfaces with heat flow for unstable thermal stratification. The key choice options include:
WaltonUnstableHorizontalOrTilt,
AlamdariHammondUnstableHorizontal,
KhalifaEq4CeilingAwayFromHeat, or UserCurve.
Field: Floor Heat Ceiling Cool Unstable Horizontal Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
Field: Floor Heat Ceiling Cool Heated Floor Equation Source
Applies to zone with in-floor heating and/or in-ceiling cooling. This is for a floor with active
heating elements. The key choice options include: WaltonUnstableHorizontalOrTilt,
AlamdariHammondUnstableHorizontal, AwbiHattonHeatedFloor, or UserCurve
Field: Floor Heat Ceiling Cool Heated Floor Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
Field: Floor Heat Ceiling Cool Chilled Ceiling Equation Source
Applies to zone with in-floor heating and/or in-ceiling cooling. This is for a ceiling with active
cooling elements. The key choice options include:
WaltonUnstableHorizontalOrTilt,
AlamdariHammondUnstableHorizontal, KaradagChilledCeiling, or UserCurve.
Field: Floor Heat Ceiling Cool Chilled Ceiling Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve
Field: Floor Heat Ceiling Cool Stable Tilted Equation Source
Applies to zone with in-floor heating and/or in-ceiling cooling. This is for tilted surfaces with
heat flow for stable thermal stratification.
The key choice options include:
WaltonStableHorizontalOrTilt, AlamdariHammondStableHorizontal, ISO15099Windows, or
UserCurve.
Field: Floor Heat Ceiling Cool Stable Tilted Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
Field: Floor Heat Ceiling Cool Unstable Tilted Equation Source
Applies to zone with in-floor heating and/or in-ceiling cooling. This is for tilted surfaces with
heat flow for unstable thermal stratification.
The key choice options include:
WaltonUnstableHorizontalOrTilt, AlamdariHammondUnstableHorizontal, ISO15099Windows,
or UserCurve.
Field: Floor Heat Ceiling Cool Unstable Tilted Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
Field: Floor Heat Ceiling Cool Window Equation Source
Applies to zone with in-floor heating and/or in-ceiling cooling. This is for all window surfaces.
The key choice options include: ASHRAEVerticalWall, AlamdariHammondVerticalWall,
ISO15099Windows, or UserCurve.

9/29/14

294

Input-Output Reference

Group Advanced Surface Concepts

Field: Floor Heat Ceiling Cool Window Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
Field: Wall Panel Heating Vertical Wall Equation Source
Applies to zone with in-wall panel heating. This is for vertical walls that are not actively
heated.
The
key
choice
options
include:
ASHRAEVerticalWall,
AlamdariHammondVerticalWall, KhalifaEq6NonHeatedWalls, FohannoPolidoriVerticalWall,
AlamdariHammondVerticalWall, ISO15099Windows, or UserCurve.
Field: Wall Panel Heating Vertical Wall Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
Field: Wall Panel Heating Heated Wall Equation Source
Applies to zone with in-wall panel heating. This is for vertical walls that are being actively
heated.
The
key
choice
options
include:
ASHRAEVerticalWall,
AlamdariHammondVerticalWall,
KhalifaEq5WallNearHeat,
AwbiHattonHeatedWall,
FohannoPolidoriVerticalWall, AlamdariHammondVerticalWall, or UserCurve.
Field: Wall Panel Heating Heated Wall Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
Field: Wall Panel Heating Stable Horizontal Equation Source
Applies to zone with in-wall panel heating. This is for horizontal surfaces with heat flow
directed for stable thermal stratification. The key choice options include:
WaltonStableHorizontalOrTilt, AlamdariHammondStableHorizontal, or UserCurve.
Field: Wall Panel Heating Stable Horizontal Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
Field: Wall Panel Heating Unstable Horizontal Equation Source
Applies to zone with in-wall panel heating. This is for horizontal surfaces with heat flow
directed for unstable thermal stratification. The key choice options include:
ASHRAEVerticalWall,
WaltonUnstableHorizontalOrTilt,
AlamdariHammondUnstableHorizontal, KhalifaEq7Ceiling, or UserCurve
Field: Wall Panel Heating Unstable Horizontal Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
Field: Wall Panel Heating Stable Tilted Equation Source
Applies to zone with in-wall panel heating. This is for tilted surfaces with heat flow for stable
thermal stratification. The key choice options include: WaltonStableHorizontalOrTilt,
AlamdariHammondStableHorizontal, ISO15099Windows, or UserCurve.
Field: Wall Panel Heating Stable Tilted Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve

9/29/14

295

Input-Output Reference

Group Advanced Surface Concepts

Field: Wall Panel Heating Unstable Tilted Equation Source

Applies to zone with in-wall panel heating. This is for tilted surfaces with heat flow for
unstable
thermal
stratification.
The
key
choice
options
include:
WaltonUnstableHorizontalOrTilt, AlamdariHammondUnstableHorizontal, ISO15099Windows,
or UserCurve.
Field: Wall Panel Heating Unstable Tilted Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
Field: Wall Panel Heating Window Equation Source
Applies to zone with in-wall panel heating. This is for all window surfaces. The key choice
options
include:
ASHRAEVerticalWall,
AlamdariHammondVerticalWall,
FohannoPolidoriVerticalWall, ISO15099Windows, or UserCurve.
Field: Wall Panel Heating Window Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
Field: Convective Zone Heater Vertical Wall Equation Source
Applies to zone with convective heater. This is for vertical walls not directly affected by
heater.
The
key
choice
options
include:
ASHRAEVerticalWall,
AlamdariHammondVerticalWall, KhalifaEq3WallAwayFromHeat, KhalifaEq6NonHeatedWalls,
FohannoPolidoriVerticalWall, ISO15099Windows, or UserCurve
Field: Convective Zone Heater Vertical Wall Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
Field: Convective Zone Heater Vertical Walls Near Heater Equation Source
Applies to zone with convective heater. This is for vertical walls that are directly affected by
heater. Walls are considered "near" when listed in field set for Fraction of Radiant Energy to
Surface.
The
key
choice
options
include:
ASHRAEVerticalWall,
AlamdariHammondVerticalWall,
KhalifaEq5WallNearHeat,
AwbiHattonHeatedWall,
FohannoPolidoriVerticalWall, ISO15099Windows, or UserCurve.
Field: Convective Zone Heater Vertical Walls Near Heater Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
Field: Convective Zone Heater Stable Horizontal Equation Source
Applies to zone with convective heater. This is for horizontal surfaces with heat flow directed
for
stable
thermal
stratification.
The
key
choice
options
include:
WaltonStableHorizontalOrTilt, AlamdariHammondStableHorizontal, or UserCurve.
Field: Convective Zone Heater Stable Horizontal Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve
Field: Convective Zone Heater Unstable Horizontal Equation Source
Applies to zone with convective heater. This is for horizontal surfaces with heat flow directed
for
unstable
thermal
stratification.
The
key
choice
options
include:
WaltonUnstableHorizontalOrTilt,
AlamdariHammondUnstableHorizontal,
KhalifaEq4CeilingAwayFromHeat, KhalifaEq7Ceiling, or UserCurve.
9/29/14

296

Input-Output Reference

Group Advanced Surface Concepts

Field: Convective Zone Heater Unstable Horizontal Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
Field: Convective Zone Heater Stable Tilted Equation Source
Applies to zone with convective heater. This is for tilted surfaces with heat flow for stable
thermal stratification. The key choice options include:
WaltonStableHorizontalOrTilt,
AlamdariHammondStableHorizontal, or UserCurve.
Field: Convective Zone Heater Stable Tilted Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
Field: Convective Zone Heater Unstable Tilted Equation Source
Applies to zone with convective heater. This is for tilted surfaces with heat flow for unstable
thermal stratification. The key choice options include: WaltonUnstableHorizontalOrTilt,
AlamdariHammondUnstableHorizontal, or UserCurve.
Field: Convective Zone Heater Unstable Tilted Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
Field: Convective Zone Heater Windows Equation Source
Applies to zone with convective heater. This is for all window surfaces. The key choice
options
include:
ASHRAEVerticalWall,
AlamdariHammondVerticalWall,
KhalifaEq3WallAwayFromHeat,
FohannoPolidoriVerticalWall,
ISO15099Windows,
or
UserCurve.
Field: Convective Zone Heater Windows Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
Field: Central Air Diffuser Wall Equation Source
Applies to zone with mechanical forced central air with diffusers. This is for all wall surfaces.
The key choice options include: ASHRAEVerticalWall, FisherPedersenCeilingDiffuserWalls,
AlamdariHammondVerticalWall,
BeausoleilMorrisonMixedAssistedWall,
BeausoleilMorrisonMixedOpposingWall, FohannoPolidoriVerticalWall, ISO15099Windows,
GoldsteinNovoselacCeilingDiffuserWalls, or UserCurve
Field: Central Air Diffuser Wall Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
Field: Central Air Diffuser Ceiling Equation Source
Applies to zone with mechanical forced central air with diffusers. This is for all ceiling
surfaces.
The key choice options include:
FisherPedersenCeilingDiffuserCeiling,
BeausoleilMorrisonMixedStableCeiling,
BeausoleilMorrisonMixedUnstableCeiling,
or
UserCurve.
Field: Central Air Diffuser Ceiling Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.

9/29/14

297

Input-Output Reference

Group Advanced Surface Concepts

Field: Central Air Diffuser Floor Equation Source

Applies to zone with mechanical forced central air with diffusers. This is for all floor surfaces.
The
key
choice
options
include:
FisherPedersenCeilingDiffuserFloor,
BeausoleilMorrisonMixedStableFloor,
BeausoleilMorrisonMixedUnstableFloor,
GoldsteinNovoselacCeilingDiffuserFloor, or UserCurve.
Field: Central Air Diffuser Floor Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
Field: Central Air Diffuser Window Equation Source
Applies to zone with mechanical forced central air with diffusers. This is for all window
surfaces.
The
key
choice
options
include:
ASHRAEVerticalWall,
FisherPedersenCeilingDiffuserWalls,
BeausoleilMorrisonMixedAssistedWall,
BeausoleilMorrisonMixedOpposingWall,
FohannoPolidoriVerticalWall,
AlamdariHammondVerticalWall,
ISO15099Windows,
GoldsteinNovoselacCeilingDiffuserWindow, or UserCurve.
Field: Central Air Diffuser Window Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve
Field: Mechanical Zone Fan Circulation Vertical Wall Equation Source
The key choice options include: KhalifaEq3WallAwayFromHeat, ASHRAEVerticalWall,
FisherPedersenCeilingDiffuserWalls,
AlamdariHammondVerticalWall,
BeausoleilMorrisonMixedAssistedWall,
BeausoleilMorrisonMixedOpposingWall,
FohannoPolidoriVerticalWall, ISO15099Windows, GoldsteinNovoselacCeilingDiffuserWalls,
or UserCurve.
Field: Mechanical Zone Fan Circulation Vertical Wall Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve
Field: Mechanical Zone Fan Circulation Stable Horizontal Equation Source
The
key
choice
options
include:
AlamdariHammondStableHorizontal, or UserCurve.

WaltonStableHorizontalOrTilt,

Field: Mechanical Zone Fan Circulation Stable Horizontal Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
Field: Mechanical Zone Fan Circulation Unstable Horizontal Equation Source
The
key
choice
options
include:
KhalifaEq4CeilingAwayFromHeat,
WaltonUnstableHorizontalOrTilt, AlamdariHammondUnstableHorizontal, or UserCurve.
Field: Mechanical Zone Fan Circulation Unstable Horizontal Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
Field: Mechanical Zone Fan Circulation Stable Tilted Equation Source
The key choice options include: WaltonStableHorizontalOrTilt or UserCurve

9/29/14

298

Input-Output Reference

Group Advanced Surface Concepts

Field Mechanical Zone Fan Circulation Stable Tilted Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
Field: Mechanical Zone Fan Circulation Unstable Tilted Equation Source
The
key
choice
options
include:
AlamdariHammondUnstableHorizontal, or UserCurve.

WaltonUnstableHorizontalOrTilt,

Field: Mechanical Zone Fan Circulation Unstable Tilted Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
Field: Mechanical Zone Fan Circulation Window Equation Source
The key choice options include: ASHRAEVerticalWall, AlamdariHammondVerticalWall,
FohannoPolidoriVerticalWall,
ISO15099Windows,
GoldsteinNovoselacCeilingDiffuserWindow, or UserCurve.
Field: Mechanical Zone Fan Circulation Unstable Tilted Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve
Field: Mixed Regime Bouyancy Assisting Flow on Walls Equation Source
The
key
choice
options
include:
BeausoleilMorrisonMixedAssistedWall,
AlamdariHammondVerticalWall,
FohannoPolidoriVerticalWall,
ASHRAEVerticalWall,
FisherPedersenCeilingDiffuserWalls, GoldsteinNovoselacCeilingDiffuserWalls, or UserCurve.
Field: Mixed Regime Bouyancy Assisting Flow on Walls Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
Field: Mixed Regime Bouyancy Oppossing Flow on Walls Equation Source
The
key
choice
options
include:
BeausoleilMorrisonMixedOpposingWall,
AlamdariHammondVerticalWall,
FohannoPolidoriVerticalWall,
ASHRAEVerticalWall,
FisherPedersenCeilingDiffuserWalls, GoldsteinNovoselacCeilingDiffuserWalls, or UserCurve
Field: Mixed Regime Bouyancy Oppossing Flow on Walls Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve
Field: Mixed Regime Stable Floor Equation Source
The
key
choice
options
include:
BeausoleilMorrisonMixedStableFloor,
WaltonStableHorizontalOrTilt, AlamdariHammondStableHorizontal, or UserCurve
Field: Mixed Regime Stable Floor Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
Field: Mixed Regime Unstable Floor Equation Source
The
key
choice
options
include:
BeausoleilMorrisonMixedUnstableFloor,
WaltonUnstableHorizontalOrTilt, AlamdariHammondUnstableHorizontal, or UserCurve.
Field: Mixed Regime Unstable Floor Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
9/29/14

299

Input-Output Reference

Group Advanced Surface Concepts

Field: Mixed Regime Stable Ceiling Equation Source

The
key
choice
options
include:
BeausoleilMorrisonMixedStableCeiling,
WaltonStableHorizontalOrTilt, AlamdariHammondStableHorizontal, or UserCurve.
Field: Mixed Regime Stable Ceiling Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
Field: Mixed Regime Unstable Ceiling Equation Source
The
key
choice
options
include:
BeausoleilMorrisonMixedUnstableCeiling,
WaltonUnstableHorizontalOrTilt, AlamdariHammondUnstableHorizontal, or UserCurve.
Field: Mixed Regime Unstable Ceiling Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
Field: Mixed Regime Window Equation Source
The
key
choice
options
include:
ISO15099Windows, or UserCurve.

GoldsteinNovoselacCeilingDiffuserWindow,

Field: Mixed Regime Window Equation User Curve Name

The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
SurfaceConvectionAlgorithm:Outside:AdaptiveModelSelections
Options to change the individual convection model equations for dynamic selection when
using AdaptiveConvectionAlgorithm. 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: Name
A unique name for the object
Field: Wind Convection Windward Vertical Wall Equation Source
This is for just the wind-driven component of the total convection coefficient. The key choice
options include: SimpleCombined, TARPWindward, MoWiTTWindward, DOE2Windward,
NusseltJurges, McAdams, Mitchell, Blocken, Emmel, or UserCurve.
Field: Wind Convection Windward Equation Vertical Wall User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
Field: Wind Convection Leeward Vertical Wall Equation Source
This is for just the wind-driven component of the total convection coefficient. The key choice
options include:
SimpleCombined, TARPLeeward, MoWiTTLeeward, DOE2Leeward,
Emmel, NusseltJurges, McAdams, Mitchell, or UserCurve.
Field: Wind Convection Leeward Vertical Wall Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.

9/29/14

300

Input-Output Reference

Group Advanced Surface Concepts

Field: Wind Convection Horizontal Roof Equation Source

This is for just the wind-driven component of the total convection coefficient. The key choice
options include: SimpleCombined, TARPWindward, MoWiTTWindward, DOE2Windward,
NusseltJurges, McAdams, Mitchell, Blocken, Emmel, ClearRoof, or UserCurve.
Field: Wind Convection Horizontal Roof User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
Field: Natural Convection Vertical Wall Equation Source
This is for just the natural convection portion of the total film coefficient. This is for vertical
walls. The key choice options include: ASHRAEVerticalWall, AlamdariHammondVerticalWall,
FohannoPolidoriVerticalWall, ISO15099Windows, UserCurve, or None.
Field: Natural Convection Vertical Wall Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
Field: Natural Convection Stable Horizontal Equation Source
This is for just the natural convection portion of the total film coefficient. This is for horizontal
surfaces with heat flow directed for stable thermal stratification. The key choice options
include: WaltonStableHorizontalOrTilt, AlamdariHammondStableHorizontal, UserCurve, or
None.
Field: Natural Convection Stable Horizontal Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
Field: Natural Convection Unstable Horizontal Equation Source
This is for just the natural convection portion of the total film coefficient. This is for horizontal
surfaces with heat flow directed for unstable thermal stratification. The key choice optios
include: WaltonUnstableHorizontalOrTilt, AlamdariHammondUnstableHorizontal, UserCurve,
or None
Field: Natural Convection Unstable Horizontal Equation User Curve Name
The SurfaceConvectionAlgorithm:UserCurve named in this field is used when the previous
field is set to UserCurve.
SurfaceConvectionAlgorithm:Inside:UserCurve
This object is used to describe a custom model equation for surface convection heat transfer
coefficients. If more than one curve is referenced, or non-blank, then they are all used and
the result is the simple addition of all the curve results.
Field: Name
Unique name of input object.
Field: Reference Temperature for Convection Heat Transfer
This field controls the nature of the reference temperature used with convection coefficient
when calculating the heat flow at the surface. Select one of the three choices:
MeanAirTemperature,
AdjacentAirTemperature,
SupplyAirTemperature.
MeanAirTemperature is the typical application for the classic convection model used with the
complete mixing of room air. AdjacentAirTemperature applies when used with Roomair
models that account for temperature variations within the zone air and directs the model to
use the temperature near the surface rather than the average for the entire zone.
9/29/14

301

Input-Output Reference

Group Advanced Surface Concepts

SupplyAirTemperature directs the model to use the supply air conditions for the heat transfer
conditions.
Field: Hc Function of Temperature Difference Curve Name
This field contains the name of separate performance curve or table object that describes hc,
the convection coefficient, as a function of temperature difference. The curve's "x" is absolute
value of delta-T (Surface temperature minus air temperature, (C))
Field: Hc Function of Temperature Difference Divided by Height Curve Name
This field contains the name of separate performance curve or table object that describes hc,
the convection coefficient, as a function of temperature difference divided by height. The
curve's "x" is absolute value of delta-T/Height (Surface temp minus Air temp)/(vertical length
scale), (C/m). For an inside face, the vertical length scale is the zone's interior height.
Field: Hc Function of Air Change Rate Curve Name
This field contains the name of separate performance curve or table object that describes hc,
the convection coefficient, as a function of air change rate. The curve's "x" is mechanical
ACH (Air Changes per hour from mechanical air system), (1/hr)
Field: Hc Function of Air System Volume Flow Rate Divided by Zone Perimeter Length
Curve Name
This field contains the name of separate performance curve or table object that describes hc,
the convection coefficient, as a function of air change rate divided perimeter scale. Curve's
"x" is mechanical system air flow rate (m 3/s) divided by zone's length along exterior walls (m).
SurfaceConvectionAlgorithm:Outside:UserCurve
This object is used to describe a custom model equation for surface convection heat transfer
coefficients. If more than one curve is referenced, or non-blank, then they are all used and
the result is the simple addition of all the curve results.
Field: Name
Unique name of input object.
Field: Wind Speed Type for Curve
This field specifies what sort of wind velocity data should be used in when evaluating the
curve in the following field. There are for key choice options. WeatherFile directs using the
unmodified value from the epw file or design weather data. HeightAdjust uses the value
from the epw file modified for height above ground, as determined by the z cooridinate, using
the site terrain and weather station information. ParallelComponent uses the value from the
epw file modified to take just the velocity component that is parallel to the surface.
ParallelComponentHeightAdjust uses the height adjusted wind velocity and then computes
the parallel component.
Field: Hf Function of Wind Speed Curve Name
This field contains the name of separate performance curve or table object that describes hf,
the forced convection coefficient, as a function of wind speed. The curve's "x" is wind speed
as defined by the method chosen in the previous field.
Field: Hn Function of Temperature Difference Curve Name
This field contains the name of separate performance curve or table object that describes hn,
the natural convection coefficient, as a function of temperature difference. Curve's "x" is
absolute value of delta-T (Surface temperature minus air temperature, (C))

9/29/14

302

Input-Output Reference

Group Advanced Surface Concepts

Field: Hc Function of Temperature Difference Divided by Height Curve Name

This field contains the name of separate performance curve or table object that describes hn,
the natural convection coefficient, as a function of temperature difference divided by height.
Curve's "x" is absolute value of delta-T/Height (Surface temp minus Air temp)/(vertical length
scale), (C/m). For an outside face the vertical length scale is the exterior facade's overall
height.
SurfaceProperty:ConvectionCoefficients
The convection coefficients of each surface, both exterior and interior, are automatically
calculated during EnergyPlus execution. These calculations are governed by other objects
such as the SurfaceConvectionAlgorithm:Inside (overall default), the Zone objects field called
Zone
Inside
Convection
Algorithm
(Zone
Default),
the
and
the
SurfaceConvectionAlgorithm:Outside (overall default), and/or the Zone objects field called
Zone Outside Convection Algorithm (Zone Default). Usually, that will be enough flexibility for
most users. However, if you need to match pre-existing convection coefficients (from another
program) or are trying to match a test suite of results, you may wish to use the override
convection coefficients in the following object. This object allows for a single surface to be
given specific convection coefficients.
Note that using these in conjunction, in particular, the Simple option on either the Outside
Convection Algorithm or the Zone Outside Convection Algorithm field will result in a
combined coefficient regardless of choice chosen here.
Note that surfaces with SurfaceProperty:OtherSideCoefficients cannot use this object with the outside
coefficient attempting to do so will cause a severe error; SurfaceProperty:OtherSideCoefficients surfaces
can apply an inside coefficient. And, surfaces with Ground exposure do not use the outside coefficient
that might be supplied here. Note, too, that some lower boundaries are used regardless by certain surface
types (i.e. Window) or certain algorithm types.

Field: Surface Name

This field is the applicable surface name for the user supplied convection coefficient.
Fields (Convection Location, Type, Coefficient & Schedule Name)
For simplicity, the descriptions of these field occur together however, the fields are used
sequentially when put into the IDF file (reference the IDF examples following the
descriptions).
Field: Convection Coefficient 1 Location
Field: Convection Coefficient 2 Location
This field contains the word Outside or Inside depending on which location is being
described.
Field: Convection Coefficient 1 Type
Field: Convection Coefficient 2 Type
The entries can be of several types: Value (simple numeric value), Schedule (name of
schedule with the values), the usual key choices for overall models for Outside or Inside
(Simple, SimpleCombined, TARP, AdaptiveConvectionAlgorithm etc.), the key choices for
individual convection equations used for customizing the adaptive algorithm, or a custom
user defined correlation. The field should contain one of the keys listed in the table below
along with face they can be applied. The definitions of the models and key choices are
discussed under SurfaceConvectionAlgorithm:Inside , SurfaceConvectionAlgorithm:Outside,

9/29/14

303

Input-Output Reference

Group Advanced Surface Concepts

SurfaceConvectionAlgorithm:Inside:AdaptiveModelSelections,
SurfaceConvectionAlgorithm:Outside:AdaptiveModelSelections.

9/29/14

Key choice

Applies to Inside
or Outside

Value

Both

Schedule

Both

Simple

Inside

SimpleCombined

Outside

TARP

Both

DOE-2

Outside

MoWitt

Outside

AdaptiveConvectionAlgorithm

Both

ASHRAEVerticalWall

Both

WaltonUnstableHorizontalOrTilt

Both

WaltonStableHorizontalOrTilt

Both

FisherPedersenCeilingDiffuserWalls

Inside

FisherPedersenCeilingDiffuserCeiling

Inside

FisherPedersenCeilingDiffuserFloor

Inside

AlamdariHammondStableHorizontal

Both

AlamdariHammondUnstableHorizontal

Both

AlamdariHammondVerticalWall

Both

KhalifaEq3WallAwayFromHeat

Inside

KhalifaEq4CeilingAwayFromHeat

Inside

KhalifaEq5WallNearHeat

Inside

KhalifaEq6NonHeatedWalls

Inside

KhalifaEq7Ceiling

Inside

AwbiHattonHeatedFloor

Inside

AwbiHattonHeatedWall

Inside

BeausoleilMorrisonMixedAssistedWall

Inside

BeausoleilMorrisonMixedOpposingWall

Inside

BeausoleilMorrisonMixedStableFloor

Inside

BeausoleilMorrisonMixedUnstableFloor

Inside

BeausoleilMorrisonMixedStableCeiling

Inside

BeausoleilMorrisonMixedUnstableCeiling

Inside

FohannoPolidoriVerticalWall

Both

KaradagChilledCeiling

Inside

and

304

Input-Output Reference

Group Advanced Surface Concepts

ISO15099Windows

Inside

GoldsteinNovoselacCeilingDiffuserWindow

Inside

GoldsteinNovoselacCeilingDiffuserWalls

Inside

GoldsteinNovoselacCeilingDiffuserFloor

Inside

SimpleCombined

Outside

NusseltJurges

Outside

McAdams

Outside

Mitchell

Outside

BlockenWindard

Outside

Emmel

Outside

ClearRoof

Outside

UserCurve

Both

Field: Convection Coefficient 1

Field: Convection Coefficient 2
If the Convection type was Value, then this field is filled and contains the simple value to be
used. Otherwise, this can be blank.
Field: Convection Coefficient 1 Schedule Name
Field: Convection Coefficient 2 Schedule Name
If the Convection type was Schedule, then this field contains the name of a schedule
describing the value to be used during the time intervals for the schedule.
The complete IDD definition for the ConvectionCoefficients object follows:
Field: Convection Coefficient 1 User Curve Name
Field: Convection Coefficient 2 User Curve Name
If the Convection type was UserCurve, then this field contains the name of a
SurfaceConvectionAlgorithm:UserCurve input objct describing the model equations to be
used during the time intervals for the schedule.
In IDF usage:
SurfaceProperty:ConvectionCoefficients,
Zn001:Wall001, ! Surface Name
Outside,
! Convection Coefficient
Value,
! Convection Coefficient
9.8,
! Convection Coefficient
,
! Convection Coefficient
,
! Convection Coefficient
Inside,
! Convection Coefficient
Schedule,
! Convection Coefficient
,
! Convection Coefficient
MyInteriorCC,
! Convection Coefficient
;
! Convection Coefficient

1
1
1
1
1
2
2
2
2
2

Location
Type
Schedule Name
User Curve Name
Location
Type
{blank because using schedule}
Schedule Name
User Curve Name

SurfaceProperty:ConvectionCoefficients,
Zn001:Wall002, ! Surface Name
Inside,
! Convection Coefficient 1 Location
Value,
! Convection Coefficient 1 Type
9/29/14

305

Input-Output Reference
.8,
,
,
Outside,
Value,
5.5,
;

Group Advanced Surface Concepts

!
!
!
!
!
!
!

Convection
Convection
Convection
Convection
Convection
Convection
Convection

Coefficient
Coefficient
Coefficient
Coefficient
Coefficient
Coefficient
Coefficient

1
1
1
2
2
2
2

Schedule Name
User Curve Name
Location
Type
User Curve Name

SurfaceProperty:ConvectionCoefficients,
Zn001:Wall003, ! Surface Name
Outside,
! Convection Coefficient 1 Location
Value,
! Convection Coefficient 1 Type
9.8;
! Convection Coefficient 1

SurfaceProperty:ConvectionCoefficients:MultipleSurface
The convection coefficients of each surface, both outside and inside, are automatically
calculated during EnergyPlus execution. These calculations are governed by other objects
such as the Inside Convection Algorithm (overall default) and the Zone Inside Convection
Algorithm (Zone Default) and the Outside Convection Algorithm (overall default) and/or the
Zone Outside Convection Algorithm (Zone Default). Usually, that will be enough flexibility for
most users. However, if you need to match pre-existing convection coefficients (from another
program) or are trying to match a test suite of results, you may wish to use the override
convection coefficients in the following object. This object is similar to the preceding
ConvectionCoefficients object but allows multiple surfaces to be assigned a type with one
object entry.
Note that using these in conjunction, in particular, the Simple option on either the Outside
Convection Algorithm or the Zone Outside Convection Algorithm field will result in a
combined coefficient regardless of choice chosen here.
Note that surfaces with SurfaceProperty:OtherSideCoefficients cannot use this object with the outside
coefficient attempting to do so will ignore OSC surfaces during a multiple surface apply;
SurfaceProperty:OtherSideCoefficients surfaces can apply an inside coefficient. And, surfaces with
Ground exposure do not use the outside coefficient that might be supplied here. Note, too, that some
lower boundaries are used regardless by certain surface types (i.e. Window) or certain algorithm types.

Field: Surface Type

This field is the applicable surface name for the user supplied convection coefficient. The
allowable surface types are:
AllExteriorSurfaces (all surfaces that are external environment surfaces)
AllExteriorWindows (all windows that are external environment surfaces)
AllExteriorWalls
AllExteriorRoofs
AllExteriorFloors
AllInteriorSurface (all surfaces that are internal surfaces)
AllInteriorWindows
AllInteriorCeilings
AllInteriorFloors
Fields (Convection Location, Type, Coefficient & Schedule Name)
For simplicity, the descriptions of these field occur together however, the fields are used
sequentially when put into the IDF file (reference the IDF examples following the
descriptions).
9/29/14

306

Input-Output Reference

Group Advanced Surface Concepts

Field: Convection Coefficient 1 Location

Field: Convection Coefficient 2 Location
This field contains the word Outside or Inside depending on which location is being
described.
Field: Convection Coefficient 1 Type
Field: Convection Coefficient 2 Type
The entries can be of several types: Value (simple numeric value), Schedule (name of
schedule with the values), the usual key choices for overall models for Outside or Inside
(Simple, SimpleCombined, TARP, AdaptiveConvectionAlgorithm etc.), the key choices for
individual convection equations used for customizing the adaptive algorithm, or a custom
user defined correlation. The field should contain one of the keys listed in the table below
along with face they can be applied. The definitions of the models and key choices are
discussed under SurfaceConvectionAlgorithm:Inside , SurfaceConvectionAlgorithm:Outside,
SurfaceConvectionAlgorithm:Inside:AdaptiveModelSelections,
and
SurfaceConvectionAlgorithm:Outside:AdaptiveModelSelections.

9/29/14

Key choice

Applies to Inside
or Outside

Value

Both

Schedule

Both

Simple

Inside

SimpleCombined

Outside

TARP

Both

DOE-2

Outside

MoWitt

Outside

AdaptiveConvectionAlgorithm

Both

ASHRAEVerticalWall

Both

WaltonUnstableHorizontalOrTilt

Both

WaltonStableHorizontalOrTilt

Both

FisherPedersenCeilingDiffuserWalls

Inside

FisherPedersenCeilingDiffuserCeiling

Inside

FisherPedersenCeilingDiffuserFloor

Inside

AlamdariHammondStableHorizontal

Both

AlamdariHammondUnstableHorizontal

Both

AlamdariHammondVerticalWall

Both

KhalifaEq3WallAwayFromHeat

Inside

KhalifaEq4CeilingAwayFromHeat

Inside

KhalifaEq5WallNearHeat

Inside

KhalifaEq6NonHeatedWalls

Inside

KhalifaEq7Ceiling

Inside

307

Input-Output Reference

Group Advanced Surface Concepts

AwbiHattonHeatedFloor

Inside

AwbiHattonHeatedWall

Inside

BeausoleilMorrisonMixedAssistedWall

Inside

BeausoleilMorrisonMixedOpposingWall

Inside

BeausoleilMorrisonMixedStableFloor

Inside

BeausoleilMorrisonMixedUnstableFloor

Inside

BeausoleilMorrisonMixedStableCeiling

Inside

BeausoleilMorrisonMixedUnstableCeiling

Inside

FohannoPolidoriVerticalWall

Both

KaradagChilledCeiling

Inside

ISO15099Windows

Inside

GoldsteinNovoselacCeilingDiffuserWindow

Inside

GoldsteinNovoselacCeilingDiffuserWalls

Inside

GoldsteinNovoselacCeilingDiffuserFloor

Inside

SimpleCombined

Outside

NusseltJurges

Outside

McAdams

Outside

Mitchell

Outside

BlockenWindard

Outside

Emmel

Outside

ClearRoof

Outside

UserCurve

Both

Field: Convection Coefficient 1

Field: Convection Coefficient 2
If the Convection type was Value, then this field is filled and contains the simple value to be
used. Otherwise, this can be blank.
Field: Convection Coefficient 1 Schedule Name
Field: Convection Coefficient 2 Schedule Name
If the Convection type was Schedule, then this field contains the name of a schedule
describing the value to be used during the time intervals for the schedule.
Field: Convection Coefficient 1 User Curve Name
Field: Convection Coefficient 2 User Curve Name
If the Convection type was UserCurve, then this field contains the name of a
SurfaceConvectionAlgorithm:UserCurve input objct describing the model equations to be
used during the time intervals for the schedule.
In IDF usage:
SurfaceProperty:ConvectionCoefficients:MultipleSurface,
AllExteriorWindows, ! Surface Types
9/29/14

308

Input-Output Reference
Outside,
MoWitt;

Group Advanced Surface Concepts

! Convection Coefficient 1 Location
! Convection Coefficient 1 Type

Convection Coefficient Application Hierarchy

Ultimate flexibility and possibly ultimate user confusion can result from the convection
coefficient possibilties in EnergyPlus. The objects that control how convection models are
assigned to individual surfaces are:
SurfaceConvectionAlgorithm:Inside
SurfaceConvectionAlgorithm:Outside
Zone, Field: Zone Inside Convection Algorithm
Zone, Field: Zone Outside Convection Algorithm
SurfaceProperty:ConvectionCoefficients
SurfaceProperty:ConvectionCoefficients:MultipleSurface
General to Specific, they are assigned in this order:
Table 9. Convection Coefficient Assignment Hierarchy
Objects/Description

Action

SurfaceConvectionAlgorithm:*

Assigns for all surfaces in the run.

Zone, Fields: Zone * Convection Algorithm

Trumps global assignment and assigns for

all surfaces in Zone.

SurfaceProperty:...:MultipleSurfaces

Trumps above and assigns for specific

types of surfaces.

Two Multiple Surface Assignments overlapping

(such as AllExteriorSurfaces vs
AllExteriorWalls)

Order in IDF is now important. Whichever

is first gets the cookie and the second gets
a warning.

Specific Surface Assignment

Trumps all Above.

There are additional objects that provide fine control over the models that get assigned.
SurfaceConvectionAlgorithm:Inside:AdaptiveModelSelections
SurfaceConvectionAlgorithm:Outside:AdaptiveModelSelections
SurfaceConvectionAlgorithm:Inside:UserCurve
SurfaceConvectionAlgorithm:Outside:UserCurve
Convection Coefficients Outputs
Outputs for the User Supplied Convection Coefficients appear as values in the Surface
Output Variables (Surface Inside Face Convection Heat Transfer Coefficient and Surface
Outside Face Convection Heat Transfer Coefficient). What the program expects to use is
shown in the Surface Details report (Output:Surfaces:List, Details;)
When EnergyPlus is set to Display Advanced Variables (Output:Diagnostics,
DisplayAdvancedVariables;), then additional output variables are available that indicate the
status of convection modeling by identifying which models are in effect at a given time. The
adaptive convection algorithms may switch between models over time and the following
output variables provide a way to monitor this behavior. These outputs are integer codes and
the integer values are explained in tables.
Surface Inside Face Convection Classification Index
This variable reports how the surface was classified as part of the adaptive convection
algorithm for the inside face. The algorithm examines probable flow regimes, heat flow
directions, orientations, HVAC equipment connections, and current operating status to assign

9/29/14

309

Input-Output Reference

Group Advanced Surface Concepts

each surface a category. The numbers in this report are integer codes that correspond to
surface categories as described in the following table.

9/29/14

Code

Zone Airflow Regime

Type of surface

Heat Flow

A1 Radiant Heated Floor or

Chilled Ceiling

Vertical Wall

Any

A1 Radiant Heated Floor or

Chilled Ceiling

Horizontal

Stable

A1 Radiant Heated Floor or

Chilled Ceiling

Horizontal

Unstable

A1 Radiant Heated Floor or

Chilled Ceiling

Heated Floor

Unstable

A1 Radiant Heated Floor or

Chilled Ceiling

Chilled Ceiling

Unstable

A1 Radiant Heated Floor or

Chilled Ceiling

Tilted

Stable

A1 Radiant Heated Floor or

Chilled Ceiling

Tilted

Unstable

A1 Radiant Heated Floor or

Chilled Ceiling

Window

Any

A2 Radiant Wall Heat

Non-heated Vertical Wall

Any

10

A2 Radiant Wall Heat

Heated wall

Any

11

A2 Radiant Wall Heat

Horizontal

Stable

12

A2 Radiant Wall Heat

Horizontal

Unstable

13

A2 Radiant Wall Heat

Tilted

Stable

14

A2 Radiant Wall Heat

Tilted

Unstable

15

A2 Radiant Wall Heat

Windows

Any

16

A3 Simple Bouyancy

Vertical Walls

Any

17

A3 Simple Bouyancy

Horizontal

Stable

18

A3 Simple Bouyancy

Horizontal

Unstable

19

A3 Simple Bouyancy

Tilted

Stable

20

A3 Simple Bouyancy

Tilted

Unstable

21

A3 Simple Bouyancy

Windows

Any

22

B Convective Zone Heat

Vertical Walls

Any

23

B Convective Zone Heat

Vertical Walls near heater

Any

24

B Convective Zone Heat

Horizontal

Stable

25

B Convective Zone Heat

Horizontal

Unstable

26

B Convective Zone Heat

Tilted

Stable

27

B Convective Zone Heat

Tilted

Unstable

28

B Convective Zone Heat

Windows

Any
310

Input-Output Reference

Group Advanced Surface Concepts

29

C Central Air Diffuser

Walls

Any

30

C Central Air Diffuser

Ceiling

Any

31

C Central Air Diffuser

Floor

Any

32

C Central Air Diffuser

Windows

Any

33

D Zone Fan Unit

Walls

Any

34

D Zone Fan Unit

Horizontal

Stable

35

D Zone Fan Unit

Horizontal

Unstable

36

D Zone Fan Unit

Tilted

Stable

37

D Zone Fan Unit

Tilted

Unstable

38

D Zone Fan Unit

Windows

Any

39

E Mixed Forced and Bouyancy

Walls

Assisting

40

E Mixed Forced and Bouyancy

Walls

Opposing

41

E Mixed Forced and Bouyancy

Floor

Stable

42

E Mixed Forced and Bouyancy

Floor

Unstable

43

E Mixed Forced and Bouyancy

Ceiling

Stable

44

E Mixed Forced and Bouyancy

Ceiling

Unstable

45

E Mixed Forced and Bouyancy

Windows

Any

Surface Inside Face Convection Model Equation Index

This variable reports the specific model equation used to calculate the inside face convection
coefficient. This can vary when using the adaptive convection algorithm and so the result of
that selection algorithm is reported here. The following table lists the models associated with
specific interger codes reported here. The models correspond to key words used in input
objects.

9/29/14

Report Code

Related key and model

200

UserValue

201

UserSchedule

202

UserCurve

203

ASHRAEVerticalWall

204

WaltonUnstableHorizontalOrTilt

205

WaltonStableHorizontalOrTilt

206

FisherPedersenCeilDiffuserFloor

207

FisherPedersenCeilDiffuserCeiling

208

FisherPedersenCeilDiffuserWalls

209

AlamdariHammondStableHorizontal

210

AlamdariHammondVerticalWall

211

AlamdariHammondUnstableHorizontal

212

KhalifaEq3WallAwayFromHeat

213

KhalifaEq4CeilingAwayFromHeat

214

KhalifaEq5WallNearHeat

215

KhalifaEq6NonHeatedWalls
311

Input-Output Reference

Group Advanced Surface Concepts

216

KhalifaEq7Ceiling

217

AwbiHattonHeatedFloor

218

AwbiHattonHeatedWall

219

BeausoleilMorrisonMixedAssistingWall

220

BeausoleilMorrisonMixedOppossingWall

221

BeausoleilMorrisonMixedStableCeiling

222

BeausoleilMorrisonMixedUnstableCeiling

223

BeausoleilMorrisonMixedStableFloor

224

BeausoleilMorrisonMixedUnstableFloor

225

FohannoPolidoriVerticalWall

226

KaradagChilledCeiling

227

ISO15099Windows

228

GoldsteinNovoselacCeilingDiffuserWindow

229

GoldsteinNovoselacCeilingDiffuserWalls

230

GoldsteinNovoselacCeilingDiffuserFloor

Surface Inside Face Convection Reference Air Index

The inside face convection heat transfer calculations can be based on different reference air
temperatures. This reference air temperature can vary during the simulation when the
adaptive algorithm selects models that use different references. The following table lists the
meaning of the integer codes.
Report Code

Reference Air Temperature Method

Zone mean air temperature

Surface adjacent air temperature

Supply air temperature

Surface Outside Face Convection Classification Index

This variable reports how the surface was classified as part of the adaptive convection
algorithm for the outside face. The algorithm examines the wind direction, heat flow
directions and orientations to assign each surface a category. The numbers in this report are
integer codes that correspond to surface categories as described in the following table.
Report Code

Surface Classification

101

Vertical Wall, Windward

102

Vertical Wall, Leeward

103

Roof, stable heat flow direction

104

Roof, unstable heat flow direction

Surface Outside Face Forced Convection Model Equation Index

Surface Outside Face Natural Convection Model Equation Index
These variables report the specific model equation used to calculate the outside faces
convection coefficient. They can vary when using the adaptive convection algorithm and so
the results of that selection algorithm are reported in these variables. The following table lists
the models associated with specific integer codes that might be reported here. The models
correspond to key words used in input objects.

9/29/14

312

Input-Output Reference

Group Advanced Surface Concepts

Report Code

Related key and model

300

None

301

UserValue

302

UserSchedule

303

UserCurve

304

ASHRAESimpleCombined

305

NaturalASHRAEVerticalWall

306

NaturalWaltonUnstableHorizontalOrTilt

307

NaturalWaltonStableHorizontalOrTilt

308

SparrowWindward

309

SparrowLeeward

310

MoWiTTWindward

311

MoWiTTLeeward

312

DOE2Windward

313

DOE2Leeward

314

NusseltJurges

315

McAdams

316

Mitchell

317

ClearRoof

318

BlockenWindward

319

EmmelVertical

320

EmmelRoof

321

AlamdariHammondVerticalWall

322

FohannoPolidoriVerticalWall

323

ISO15099Windows

324

AlamdariHammondStableHorizontal

325

AlamdariHammondUnstableHorizontal

SurfaceProperties:VaporCoefficients
Advanced/Research Usage:. The internal and external vapor transfer coefficients that are
used by the CombinedHeatAndMoistureFiniteElement model are automatically calculated
during EnergyPlus execution using information on the convection coefficients. However it is
sometimes useful to be able to override the calculation and set fixed values of vapor
transfer coefficient for a single surface. These coefficients are only used by the
CombinedHeatAndMoistureFiniteElement model and will be ignored by other solution
algorithms.
Field: Surface Name
This field is the applicable surface name for the user supplied vapor transfer coefficient.
Field: Constant External Vapor Transfer Coefficient
Select yes to use the value supplied as the external vapor transfer coefficient
Field: External Vapor Coefficient Value
HAMT will use this value to calculate the vapour transfer into and out off the external surface
of this surface. Units are kg/Pa.s.m2.

9/29/14

313

Input-Output Reference

Group Advanced Surface Concepts

Field: Constant Internal vapor Transfer Coefficient

Select yes to use the value supplied as the internal vapor transfer coefficient
Field: Internal Vapor Coefficient Value
The CombinedHeatAndMoistureFiniteElement algorithm will use this value to calculate the
vapor transfer into and out of the internal surface of this surface. Units are kg/Pa.s.m2.
Below is an example input of vapor transfer coefficients for a surface.
SurfaceProperties:VaporCoefficients,
South wall,
!- Surface Name
Yes,
!- Constant External Vapor Transfer Coefficient
0.0000000625,
!- External Vapor Coefficient Value
Yes,
!- Constant Internal vapor Transfer Coefficient
0.00000002;
!- Internal Vapor Coefficient Value

SurfaceProperty:ExteriorNaturalVentedCavity
This object is used to model a multi-skin exterior heat transfer surface. This is a special case
where the outside face is a slightly detached layer forming a naturally ventilated cavity. The
actual outer surface is referred to as the baffle. The modeling here assumes that the heat
capacity in the outer baffle can be neglected since it is much lower than the underlying mass
surface. This object is used with the BuildingSurface:Detailed object where the Heat Transfer
surfaces are referred to as the underlying surfaces. The constructions and materials for the
BuildingSurface:Detailed object should reflect the construction of just the underlying surface.
The SurfaceProperty:ExteriorNaturalVentedCavity object is used to describe the decoupled
layer, or baffle, and the characteristics of the cavity and openings for natural ventilation. This
object is also used in conjunction with the OtherSideConditionsModel.
The area and orientation are obtained from BuildingSurface:Detailed objects, which are
referenced by name. This object can be used to model certain types of photovoltaic mounting
configurations such as interlocking roof pavers. If the baffle covers only part of a surface,
then that surface should be split into separate BuildingSurface:Detailed objects where one
matches the size of the baffle. A single baffle can be associated with as many
BuildingSurface:Detailed objects as desired (although if you need to use more than 10
surfaces, then the IDD will need to be extended). The base heat transfer surfaces need not
be contiguous nor have the same orientation, but the program will issue warnings if surfaces
have widely ranging tilts and azimuths.
Note that the model involves predicting the rates that ambient air moves in and out of the
cavity. Accurate modeling of these air flows would be extremely challenging and so the
models provided through this object are simplistic engineering models based on discharge
coefficients that are sensitive to wind and bouancy effects. The accuracy depends on the
values for, and applicability of, the discharge coefficients and unfortunately little research is
available to help characterize these. The models should be considered rudimentary and the
user is encouraged to explore different values for the coefficients in attempts to bound the
importance of natural ventilation for the cavities. See the Engineering Reference for more
details.
Field: Name
This field contains a unique name for the ventilated cavity.
Field: Boundary Conditions Model Name
This field contains the name of an SurfaceProperty:OtherSideConditionsModel object
declared elsewhere in the input file. This will connect the baffle and ventilated cavity to the
exterior boundary conditions for the underlying heat transfer surface.

9/29/14

314

Input-Output Reference

Group Advanced Surface Concepts

Field: Area Fraction of Openings

This field is used to enter an area fraction for what part of the baffle consists of openings. The
area of the openings will set to the product of this field and the sum of the area of the
underlying surfaces.
Field: Thermal Emissivity of Exterior Baffle Material
This field is used to enter the thermal emissivity of the baffler. This surface property is for
longwave infrared radiation. The property is used for both sides of collector. Most painted
materials have an emissivity of 0.9.
Field: Solar Absorptivity of Exterior Baffle
This field is used to enter the solar absorbtivity of the baffle. This surface property is for
shortwave, solar radiation. The property is used for the front side of the baffle that faces the
environment. Darker colors have a higher absorptivity. While black is the highest
performance, other colors might be used to match the color scheme of the rest of the faade.
Field: Height Scale for Buoyancy-Driven Ventilation
This field is used to enter a nominal height scale (m) for prediction of ventilation induced by
bouancy. This value ( H NPL ) is defined as the height from the midpoint of the lower opening
to the neutral pressure level. Increasing the value will increase the ventilation rate due to
buoyancy.
Field: Effective Thickness of Cavity Behind Exterior Baffle
This field is used to enter a nominal gap thickness (m) for the collector. If the baffle is
corrugated, use the average depth. This distance value is only used when the collector is
near horizontal to determine a length scale in the vertical direction for buoyancy calculations.
For example, if the collector is mounted on a flat roof, its tilt-adjusted height is zero and the
program will use this gap thickness as a length scale rather than the height from the previous
field.
Field: Ratio of Actual Surface Area to Projected Surface Area
This field is used to enter a factor that accounts for the extra surface area resulting from and
uneven baffle surface. Corrugations may be present to help stiffen the baffle or ventilated
roofing tiles may have more surface are for convection heat transfer than the underlying
surface. The projected surface area is obtained by the program from the (flat) underlying
surfaces. If the baffle is flat then this ratio is 1.0. If the baffle is corrugated, then this ratio will
be greater than one with a typical value might be 1.165.
Field: Roughness of Exterior Surface
This field is used to describe the relative roughness of the baffle material. This field is similar
to one in the Material object. This parameter only influences the convection coefficients,
more specifically the exterior convection coefficient. A special keyword is expected in this
field with the options being VeryRough, Rough, MediumRough, MediumSmooth,
Smooth, and VerySmooth in order of roughest to smoothest options.
Field: Effectiveness for Perforations with Respect to Wind
This field is used to enter a value for the coefficient used to determine natural air exchanges
from wind. Wind will cause exterior air to move in and out of the cavity. Cv is an arbitrary
coefficient used to model the effectiveness of openings and depends on opening geometry
and the orientation with respect to the wind. Cv should probably be in the range 0.05 to 0.65.
Increasing Cv will increase the amount of natural ventilation. The following equation shows
how Cv is used in the program to predict the volumetric flow rate due to wind:

9/29/14

315

Input-Output Reference

Vwind

Group Advanced Surface Concepts

Cv AinU

Field: Discharge Coefficient for Openings with Respect to Buoyancy Driven Flow
This field is used to enter a value for the coefficient used to determine natural air exchanges
from buoyancy. Stack or buoyancy effects will cause exterior air to move in and out of the
cavity. Cd is an arbitrary discharge coefficient that depends on the geometry of the opening.
Cd should probably be in the range 0.1 to 1.0. Increasing Cd will increase the amount of
natural ventilation. The following equations show how Cd is used in the program to predict
the volume flow rate due to buoyancy:

Vthermal

CD Ain 2 g H NPL Ta ,cav Tamb / Ta ,cav (if Ta ,cav

Vthermal

CD Ain 2 g H NPL Tamb Ta ,cav / Tamb (if Tamb

where

Tamb )
Ta ,cav and baffle is vertical)

H NPL is the value input into the field above for the height scale for bouyancy-driven

ventilation.
Field(s): Surface <1 thru x> Name
The remaining fields are used to name the BuildingSurface:Detailed objects that are
associated with the exterior naturally vented cavity. These are the underlying heat transfer
surfaces and are defined elsewhere in the input file. These surfaces should all specify
OtherSideConditionsModel as their exterior environment. The input object can currently
accommodate up to ten surfaces, but it is extensible by modifying the Energy+.idd entry.
An example IDF entry is
SurfaceProperty:ExteriorNaturalVentedCavity,
PVRoofPaverExtVentCav1 ,
! Name
PVRoofPaverSystem1,
! OtherSideConditionsModel Object Name
0.02,
! Area Fraction of Openings
0.9,
! Thermal Emissivity of Exterior Baffle Material
0.92,
! Solar Absorbtivity of Exterior Baffle
0.05,
! Height scale for bouyancy-driven ventilation
0.05,
! Effective Thickness of Cavity Behind Exterior Baffle
0.97,
! Ratio of Actual surface area to projected surface area
Smooth , ! Roughness of collector
0.1 ,
! Cv, Effectiveness for perforations with respect to Wind
0.5 ,
! Cd, Discharge Coefficient for Openings with respect to
bouyancy-driven flow
Zn001:Roof001 ;
! Surface Name

SurfaceProperty:ExteriorNaturalVentedCavity Outputs
In addition to related output that can be obtained for all surfaces, these outputs are available
for exterior naturally vented cavity configurations:
HVAC,Average,
HVAC,Average,
HVAC,Average,
HVAC,Average,
HVAC,Average,
HVAC,Average,

Surface
Surface
Surface
Surface
Surface
Surface

Exterior
Exterior
Exterior
Exterior
Exterior
Exterior

Cavity
Cavity
Cavity
Cavity
Cavity
Cavity

Air Drybulb Temperature [C]

Baffle Surface Temperature [C]
Total Natural Ventilation Air Change Rate [ACH]
Total Natural Ventilation Mass Flow Rate [kg/s]
Natural Ventilation from Wind Mass Flow Rate [kg/s]
Natural Ventilation from Buoyancy Mass Flow Rate [kg/s]

Surface Exterior Cavity Air Drybulb Temperature [C]

The temperature of air inside the cavity behind the baffle.
Surface Exterior Cavity Baffle Surface Temperature [C]
The surface temperature of the exterior baffle material itself.

9/29/14

316

Input-Output Reference

Group Advanced Surface Concepts

Surface Exterior Cavity Total Natural Ventilation Air Change Rate [ACH]
The rate of natural ventilation air exchange between the plenum and ambient when the
collector is inactive in Air Changes per Hour.
Surface Exterior Cavity Total Natural Ventilation Mass Flow Rate [kg/s]
The mass flow rate of natural ventilation air exchange between the plenum and ambient
when the collector is inactive.
Surface Exterior Cavity Natural Ventilation from Wind Mass Flow Rate [kg/s]
The part of mass flow rate of natural ventilation air exchange between the plenum and
ambient when the collector is inactive due to wind-driven forces.
Surface Exterior Cavity Natural Ventilation from Buoyancy Mass Flow Rate [kg/s]
The part of mass flow rate of natural ventilation air exchange between the plenum and
ambient when the collector is inactive due to bouyancy-driven forces.
SurfaceProperty:SolarIncidentInside
This object can be used as an alternative to the standard (automatic) EnergyPlus calculation
of the solar radiation incident on interior surfaces of the building. Using this method, the
normal EnergyPlus calculation is replaced with a schedule of solar incidence values that are
calculated outside the program.
Field: Name
The name of the SurfaceProperty:SolarIncidentInside object Must be unique between all
SurfaceProperty:SolarIncidentInside objects.
Field: Surface Name
The building surface associated with this object (ref BuildingSurface:Detailed). Solar
absorptance values in the schedule file will be applied to the inside of this surface.
Field: Construction Name
The building construction associated with this object (ref Construction). It is possible that the
Energy Management System will change the construction associated with the surface; if the
construction is changed, a new set of data may need to be applied to the current surface.
Field: Inside Surface Incident Sun Solar Radiation Schedule Name
This field specifies the name of a schedule that contains the values for incident solar
radiation. Values from the schedule data will be used to replace the absorbed solar radiation
that would normally be calculated by EnergyPlus. Units in the external schedule file must be
W/m2.
Example for SurfaceProperty:SolarIncidentInside using a compact schedule:
Schedule:Compact,
North Wall SSG,
Positive Number,
Through: 12/31,
For: AllDays,
Until: 07:00,10,
Until: 17:00,20,
Until: 24:00,15;

!!!!!!!-

Name
Schedule Type Limits Name
Field 1
Field 2
Field 3
Field 5
Field 7

SurfaceProperty:SolarIncidentInside,
North Wall Solar Incident, !- Name
Room102 North Wall,
!- Surface Name
Room Wall - North,
!- Construction Name
North Wall SSG;
!- Schedule Name

9/29/14

317

Input-Output Reference

Group Advanced Surface Concepts

ComplexFenestrationProperty:SolarAbsorbedLayers
This object can be used as an alternative to the standard (automatic) EnergyPlus calculation
of the solar radiation absorbed by fenestration systems in the building. Using this method,
the normal EnergyPlus calculation is replaced with a schedule of solar absorptance values
that are calculated outside the program.
Field: Name
The name of the ComplexFenestrationProperty:SolarAbsorbedLayers object Must be unique
between all ComplexFenestrationProperty:SolarAbsorbedLayers objects.
Field: Fenestration Surface
The fenestration surface associated with this object (ref FenestrationSurface:Detailed).
Values from the schedule data will be used to replace the absorbed solar radiation in the
fenestration layers that would normally be calculated by EnergyPlus. Value units in the
schedule must be W/m 2.
Field: Construction Name
The building construction associated with this object (ref Construction). It is possible that the
Energy Management System will change the construction associated with the surface; if the
construction is changed, a new set of data may need to be applied to the current surface.
Field: Layer 1 Solar Radiation Absorbed Schedule Name
Specifies the name of a schedule that contains the absorbed solar radiation values in units of
W/m2. Values from the schedule are used for the absorbed solar radiation of the first
(outside) layer .
Field: Layer 2 Solar Radiation Absorbed Schedule Name
Specifies the name of a schedule that contains absorbed solar radiation values in units of
W/m2. Values from the schedule are used for the absorbed solar radiation of the second
layer .
Field: Layer 3 Solar Radiation Absorbed Schedule Name
Specifies the name of a schedule that contains absorbed solar radiation values in units of
W/m2. Values from the schedule are used for the absorbed solar radiation for the third layer .
Field: Layer 4 Solar Radiation Absorbed Schedule Name
Specifies the name of a schedule that contains absorbed solar radiation values in units of
W/m2. Values from the schedule are used for the absorbed solar radiation of the fourth layer.
Field: Layer 5 Solar Radiation Absorbed Schedule Name
Specifies the name of a schedule that contains absorbed solar radiation values in units of
W/m2. Values from the schedule are used for the absorbed solar radiation of the fifth layer .
Example for ComplexFenestrationProperty:SolarAbsorbedLayers with compact schedules:
Schedule:Compact,
Layer 1,
Positive Number,
Through: 12/31,
For: AllDays,
Until: 07:00,1,
Until: 17:00,2,
Until: 24:00,1.5;
Schedule:Compact,
Layer 2,
Positive Number,
9/29/14

!- Name
!- Schedule Type Limits Name
!- Field 1
!- Field 2
!- Field 3
!- Field 5
!- Field 7
!- Name
!- Schedule Type Limits Name
318

Input-Output Reference

Group Advanced Surface Concepts

Through: 12/31,
For: AllDays,
Until: 07:00,0.8,
Until: 17:00,1.2,
Until: 24:00,1.0;

!!!!!-

Field
Field
Field
Field
Field

1
2
3
5
7

Schedule:Compact,
Layer 3,
Positive Number,
Through: 12/31,
For: AllDays,
Until: 07:00,1,
Until: 17:00,2.1,
Until: 24:00,1.7;

!!!!!!!-

Name
Schedule Type Limits Name
Field 1
Field 2
Field 3
Field 5
Field 7

ComplexFenestrationProperty:SolarAbsorbedLayers,
South Window Solar Absorbed Layers, !- Name
Room 102 South Window,
!- Fenestration surface name
CFS_Glz_2,
!- Construction Surface name
Layer 1,
!- Absorbed solar energy in layer 1
Layer 2,
!- Absorbed solar energy in layer 2
Layer 3;
!- Absorbed solar energy in layer 3

GeometryTransform
This object provides a simple method of altering the footprint geometry of a model. The intent
is to provide a single parameter that can be used to reshape the building description
contained in the rest of the input file. This object was implemented for use in parametric
massing studies and with the optimization program GenOpt. Although building footprint is
often constrained in practice, analysts may find this object useful for investigating how
building form impacts daylighting and solar gains on the east and west facades with out
having to change all of the surface geometry input.
Aspect Ratio is defined as the overall length in the East-West direction divided by the overall
length in the North-South direction.
This object should be used with considerable care since it will completely alter the geometry
modeled by EnergyPlus and may have unintended side effects. The surface areas of all
horizontal surfaces may change radically with corresponding changes in Zone floor areas.
The total floor area will not change but individual horizontal surfaces will gain and loose area.
Vertical surfaces will have the same height but will gain and lose length. Lighting and
electrical equipment design levels for individual zones will likely have a different energy per
unit area in the transformed geometry.
The surface geometry must be set to Relative, see GlobalGeometryRules. Of course, the
coordinates must be entered in relative coordinates as well.
Since windows in EnergyPlus need to be rectangular, it is possible to define a horizontal
window (skylight) that once transformed is no longer rectangular and will cause EnergyPlus
to halt. To avoid this problem, horizontal windows should be defined orthogonal to the
Cardinal directions and building rotation (see Building) used to orient the final form with
respect to North.
The object doesnt create any specific output, but the results of using it can be understood by
viewing DXF output files. Figure 43 shows an example of a building that has been morphed
using the Aspect Ratio Transform object. Using this object allowed the same geometry input
to generate both of the models represented in by their DXF output files.

9/29/14

319

Input-Output Reference

Group Advanced Surface Concepts

Figure 43. Example of Geometry Transform -- Aspect Ratio

Field: Plane of Transform
This field specifies the plane that the geometry transform should act on. It is currently
restricted to altering the horizontal footprint of a building and must be set to XY.
Field: Current Aspect Ratio
This field specifies the aspect ratio of the building geometry described in the rest of the input
file. It is used to scale the new aspect ratio. If this field is set to 1.0, then the altered building
will not necessarily have the new aspect ratio defined in the next field.
Field: New Aspect Ratio
This field specifies the aspect ratio that the building described in the rest of the input file will
be changed to.
Zone Property View Factors
EnergyPlus has two options for specifying the thermal radiation exchange view factors
between surfaces in a zone: the approximate option and the user input option. Because the
actual geometric arrangement within a zone is very complex, the approximate method of
including thermal mass and other forced exchanges is more realistic than trying to come up
with exact view factors. However, in some research situations it might be desirable to have
control of the view factors used. For this reason, a user input mode has been included in
EnergyPlus. The two modes are described in the next sections.
Approximate Option
The first option produces approximate results and uses an area weighted scheme to
calculate "view factors" between surfaces within a thermal zone. Each surface uses the total
area that it can see among the other surfaces. The approximate view factor from this
surface to each other surface is then the area of the receiving surface over the sum of areas
that are visible to the sending surface.

9/29/14

320

Input-Output Reference

Group Advanced Surface Concepts

In order to account in some limited way for the fact that certain surfaces will not see each
other, several assumptions have been built into this view factor approximation. First, a
surface cannot see itself. Second, surfaces with approximately the same azimuth (facing
direction) and tilt ("same" being within a built in limit) will not see each other. This means that
a window will not see the wall that it is placed on, for example. Third, floors cannot see each
other. Fourth, if the surface is a floor, ceiling, roof, or internal mass, the rule for the same
azimuth and tilt eliminating radiant exchange between surfaces is waived when the receiving
surface is floor, roof, ceiling, or internal mass as long as both surfaces are not floors.
Note that this does not take into account that surfaces may be "around the corner" from each
other and in reality not see each other at all. Rooms are assumed to be convex rather than
concave in this method.
To summarize, using the Surface Class, the approximate view factors have:

1. No surface sees itself.

2.
3.
4.
5.
6.
7.

No Floor sees another floor.

All other surface types see Internal Mass.
All other surface types see floors.
Floors always see ceilings.
Floors always see roofs.
All other surfaces whose tilt or facing angle differences are greater than 10 degrees see
each other.
If geometry is correct, conditions 1,3, and 7 should take care of all surfaces, but the other
conditions supply common sense when the geometry is incorrect. More information about the
EnergyPlus view factor calculation is contained in the Engineering Reference document.
User Input View Factors
The second option for specifying view factors requires user input values. These should be
used with care in research or special situations. The object available for this is
ZoneProperty:UserViewFactors:bySurfaceName.
ZoneProperty:UserViewFactors:bySurfaceName
The method of entering user view factors is to entere each surface name and its view factor
value to other surfaces in the zone
Field: Zone Name
This field is the zone name for the view factors.
Field: From Surface 1
This field specifies the name of the from surface.
Field: To Surface 1
This field specifies the name of the to surface.
Field: Factor 1
This value is the view factor for from Surface to to Surface.
An IDF Example:

9/29/14

321

Input-Output Reference

Group Detailed Ground Heat Transfer

ZoneProperty:UserViewFactors:bySurfaceName,Lshaped Zone,
Lshaped Zone:South Wall,Lshaped Zone:South Wall,0.000000,
Lshaped Zone:South Wall,Lshaped Zone:East Wall,0.101310,
<snip>

Group Detailed Ground Heat Transfer

Detailed Ground Heat Transfer
The following objects may be included in an EnergyPlus input IDF file but are handled by the
Slab preprocessor:
GroundHeatTransfer:Slab:Materials
GroundHeatTransfer:Slab:MatlProps
GroundHeatTransfer:Slab:BoundConds
GroundHeatTransfer:Slab:BldgProps
GroundHeatTransfer:Slab:Insulation
GroundHeatTransfer:Slab:EquivalentSlab
GroundHeatTransfer:Slab:AutoGrid
GroundHeatTransfer:Slab:ManualGrid
GroundHeatTransfer:Slab:XFACE
GroundHeatTransfer:Slab:YFACE
GroundHeatTransfer:Slab:ZFACE
The following objects may be included in an EnergyPlus input IDF file but are handled by the
Basement preprocessor:
GroundHeatTransfer:Basement:SimParameters
GroundHeatTransfer:Basement:MatlProps
GroundHeatTransfer:Basement:Insulation
GroundHeatTransfer:Basement:SurfaceProps
GroundHeatTransfer:Basement:BldgData
GroundHeatTransfer:Basement:Interior
GroundHeatTransfer:Basement:ComBldg
GroundHeatTransfer:Basement:EquivSlab
GroundHeatTransfer:Basement:EquivAutoGrid
GroundHeatTransfer:Basement:AutoGrid
GroundHeatTransfer:Basement:ManualGrid
GroundHeatTransfer:Basement:XFACE
GroundHeatTransfer:Basement:YFACE
GroundHeatTransfer:Basement:ZFACE
The documentation both the Slab and Basement objects appear in the AuxiliaryPrograms
document under the Ground Heat Transfer in EnergyPlus heading.
The only object described in this section is the control object which activates the use of the
preprocessor.
GroundHeatTransfer:Control
The GroundHeatTransfer:Control object determines if the Slab and Basement preprocessors
are going to be executed. When a Slab or Basement run is performed the results are saved
in files with extensions .SLAB or .BSMT so that they do not need to be rerun if no input
changes are made to the GroundHeatTransfer:Slab or GroundHeatTransfer:Basement
objects.
9/29/14

322

Input-Output Reference

Group Room Air Models

Field: Name
This alpha field is the name of the GroundHeatTransfer:Control object. It is used as an
identifier.
Field: Run Basement Preprocessor
The field can either be Yes or No and defaults to No. It is used to control whether the
Basement preprocessor program is executed. If it has been previously executed the results
are stored in the .BSMT file and do not necessary need to be run again unless the
GroundHeatTransfer:Basement objects have changed.
Field: Run Slab Preprocessor
The field can either be Yes or No and defaults to No. It is used to control whether the Slab
preprocessor program is executed. If it has been previously executed the results are stored in
the .SLAB file and do not necessary need to be run again unless the
GroundHeatTransfer:Slab objects have changed.

Group Room Air Models

Room Air Models
The group of input objects described in this section is used to account for non-uniform room
air temperatures that may occur within the interior air volume of a zone. Room air modeling
was added to EnergyPlus starting with Version 1.2. Although there are many types of
analyses (comfort, indoor air quality, etc) that might benefit from localized modeling of how
room air varies across space, only the temperature distribution of room air within the zone is
currently addressed in EnergyPlus. This allows surface heat transfer and air system heat
balance calculations to be made taking into account natural thermal stratification of air and
different types of intentional air distribution designs such as under-floor and side-wall
displacement ventilation that purport to extract room air at higher-than-mean temperatures.
Note that EnergyPlus does not have completely general methods of modeling room air that
are applicable to every conceivable type of airflow that might occur in a zone. Such models
(e.g. RANS-CFD) are too computationally expensive to use with EnergyPlus for the
foreseeable future. The models that are available in EnergyPlus offer only limited modeling
capabilities for select room airflow configurations. Also note that because the complete
mixing model for room air has long been the standard in building energy simulation, there is
not currently a consensus on how to best model non-uniform air temperatures in buildings.
Therefore, it is up to the user to have a good understanding of when, where, and how to
apply the room air models available in EnergyPlus. The rest of this section provides some
guidance in the way of examples and further discussion of the models available in
EnergyPlus.
EnergyPlus offers the different types of air models listed in the table below along with the
input objects associated with the use of that model.
Table 10. Summary of Room Air Models

Air Model Key

Air model Algorithm

Applicability

Input Objects Required

Mixing

Well-Mixed

All zones

None, default

UserDefined

User Defined

All zones

RoomAirModelType,
RoomAir:TemperaturePattern
:UserDefined,
RoomAir:TemperaturePattern:
***

9/29/14

323

Input-Output Reference

Group Room Air Models

OneNodeDisplaceme
ntVentilation

Mundt

displacement
ventilation

RoomAirModelType,
RoomAirSettings:OneNodeDi
splacementVentilation,
RoomAir:Node

ThreeNodeDisplacem
entVentilation

UCSD Displacement
Ventilation

displacement
ventilation

RoomAirModelType ,
RoomAirSettings:ThreeNode
DisplacementVentilation

UnderFloorAirDistribu
tionInterior

UCSD UFAD Interior

Model

Interior zones
served by a
UFAD system

RoomAirModelType,
RoomAirSettings:UnderFloor
AirDistributionInterior

UnderFloorAirDistribu
tionExterior

UCSD UFAD Exterior

Model

Exterior zones
served by a
UFAD system

RoomAirModelType,,
RoomAirSettings:UnderFloorA
irDistributionExterior

CrossVentilation

UCSD Cross
Ventilation

cross ventilation

RoomAirModelType ,
RoomAirSettings:CrossVentil
ation

RoomAirModelType
EnergyPlus uses the RoomAirModelType object to determine which air model is available for
use in a given zone during the simulation. If no RoomAirModelType object is specified (for
each zone or the whole building), then EnergyPlus will run with the conventional, completely
mixing air model (for each zone or the whole building). Include a RoomAirModelType for
each zone that the user wants modeled using a more detailed method. Currently only a single
RoomAirModelType object can be specified for each zone; you cannot switch between
models during a simulation. However, the UCSD Displacement, Cross Ventilation and UFAD
models switch from displacement to mixing ventilation when the operating conditions do not
give rise to unmixed flow. The following parameters are fields required by the
RoomAirModelType object.
Field: Name
This alpha field is the air model name selected by user. It is used as an identifier
Field: Zone Name
This alpha field indicates the unique name of a Zone object defined elsewhere in the input
file. The type of room air model selected will be applied to this zone.
Field: Room-Air Modeling Type
This alpha field indicates the room-air model used for the specified zone. Currently, there are
three options for different air models. Entering the keyword Mixing
specifies the
conventional complete-mixing air model. Note that Mixing is the default and no
RoomAirModelType object would be needed to use the complete-mixing model. Entering the
keyword UserDefined specifies the User Defined Room Air Temperature Patterns. Entering
the keyword OneNodeDisplacementVentilation specifies the Mundt one node displacement
ventilation
air
model
for
displacement
ventilation.
Entering
the
keyword
ThreeNodeDisplacementVentilation specifies the three-node displacement ventilation model
developed by the University of California, San Diego (UCSD DV). Entering the keyword
CrossVentilation specifies the two-zone cross ventilation model developed by the University
of California, San Diego (UCSD CV). Entering the keyword UnderFloorAirDistributionInterior
specifies the two-node interior zone under floor air distribution model developed by the
University of California, San Diego (UCSD UFI). Entering the keyword

9/29/14

324

Input-Output Reference

Group Room Air Models

UnderFloorAirDistributionExterior specifies the two-node exterior zone under floor air

distribution model developed by the University of California, San Diego (UCSD UFE).
Field: Air Temperature Coupling Strategy
This alpha field indicates how air temperatures predicted by the air models are used by the
surface heat balance calculation. Two different coupling schemes are available: Direct (also
known as T-couple) or Indirect (DT-couple). In general, indirect coupling is more suited to
situations where room air is well controlled and/or the room air model is less robust. Direct
coupling is more suited for floating zone air temperatures and/or accurate room air models.
The Mundt model can use either coupling scheme; the UCSD DV, UCSD CV, UCSD UFI,
and UCSD UFE models ignore this field and use direct coupling.
Input either Direct or Indirect
An example idf entry follows
RoomAirModelType,
MOD1,
!- Room-Air Model Name
ZONE ONE, !- Zone Name
ThreeNodeDisplacementVentilation, !- Room-Air Modeling Type
Direct;
!- Air Temperature Coupling Strategy

RoomAir:TemperaturePattern:UserDefined
This object is used to explicitly define temperature patterns that are to be applied to the mean
air temperature within a thermal zone. This Room Air modeling option is made available for a
number of reasons. It allows modeling the consequences of air temperature variations during
the design phase when little information is available about the specifics of the air distribution
system or positioning of various loads. This option can be used to evaluate the energy
implications of different design targets for the temperature patterns. It also provides a method
of modeling the annual energy use implications for air temperature distributions determined
using separate analyses or measurements. For example, this option could be used to
understand the annual energy implications of an air distribution system that has been
previously analyzed using Computational Fluid Dynamics.
This approach differs from the other Room Air modeling in that the static temperature pattern
is not really modeled so that it will respond to conditions that develop during the simulation.
More sophisticated dynamic Room Air models will adjust the temperature pattern based on
various factors, such as air system flow rate, floor temperature, or rates of internal heat gains.
The user-defined temperature distribution patterns are fixed at the beginning and EnergyPlus
simply provides results that include the implications of those patterns. This user-defined
distribution option may also be useful for checking dynamic Room Air models by using
bounding analysis.
Note that using this object carries a certain degree of responsibility. It would be very easy to
define a pattern that is non-physical and will lead to erroneous results. The user-defined
temperature distributions should (probably) be balanced about the mean so that basic
conservation of energy laws are not violated.
Field: Name
This field provides a unique name for this object.
Field: Zone Name
This field provides the unique name of a zone described elsewhere in the file.
Field: Availability Schedule Name
This field provides the name of a schedule that will determine if this model is available. When
not available the room air is modeled as completely mixed. When it is available, then a userdefined temperature distribution will be applied. This schedule should be set to 1.0 when

9/29/14

325

Input-Output Reference

Group Room Air Models

model is available and 0.0 when the model is not to be used. If this field is blank, the
schedule has values of 1 for all time periods.
Field: Pattern Control Schedule Name
This field provides the name of schedule that will be used to control which user-defined
RoomAir temperature pattern will be applied at any given time. This schedule needs to have
integer values that are closely coordinated with those defined as the second field in one of
the RoomAir:TemperaturePattern:* objects described below. These schedule values provide
the link to the actual patterns to be used throughout the day. This allows controlling which
user-defined pattern is used at different times during the simulation. For example, one could
use one pattern when the air system is scheduled to be on, and a different pattern when the
air system is schedule to be off. Or if the user has knowledge of how the air temperature
pattern changes over the course of day in response to changing thermal loads, then this
schedule can be used to control when individual patterns are used. For example, a control
schedule could use a pattern designated as number 100 from 18:00 to 6:00, pattern number
200 from 6:00 to 12:00, and pattern number 300 from 12:00 to 18:00.
An example of this object is
RoomAir:TemperaturePattern:UserDefined,
Ground Floor South Air Temp Contrls , ! Name
ZN2_S_1 ,
! Zone Name
Always_on ,
! Availability Schedule Name
Roomair Pattern 1; ! Pattern Control Schedule Name

RoomAir:TemperaturePattern:ConstantGradient
This object is used to model room air with a fixed temperature gradient in the vertical
direction. This fixed-slope method is about the simplest distribution pattern.
In addition to the vertical temperature gradient, there are three other parameters included in
the pattern that are important. The first two might affect how the air system conditioning the
room is operated. The first describes the temperature difference between the mean air
temperature and the point where the sensor of a drybulb thermostat is situated. The second
describes the temperature difference between the mean and the point where system air is
being extracted from the zone. This is considered important because the changes in
temperature difference between supply and return can affect how an air system is controlled
to meet the loads. The third parameter can affect the zone air heat balance by altering the
temperature of the air leaving the zone through exhaust fans.
One example of a source of input data for the vertical temperature gradient is ANSI/ASHRAE
Standard 55-2004 Thermal Environmental Conditions for Human Occupancy. Table 5.2.4.3 in
this Standard specifies an allowable vertical temperature difference between head level and
ankle level of 3C (5F). If we assume a head to ankle length scale of 1.5 m (5 ft), this leads
to a temperature gradient of 3C/1.5m, or 2.0 C/m.
Field: Name
This field provides a unique name for this object.
Field: Control Integer for Pattern Control Schedule Name
This field should contain an integer value that is unique among all other
RoomAir:TemperaturePattern:* objects. The value used here needs to be in the Pattern
Control Schedule for those times when this pattern is to be used for the Room Air
Temperature Distribution.
Field: Thermostat Offset
This field specifies the temperature difference between where the thermostat is situated and
the mean air temperature.

9/29/14

326

Input-Output Reference

Group Room Air Models

Field: Return Air Offset

This field specifies the temperature difference between the air leaving the zone and returning
to the air system and the mean air temperature.
Field: Exhaust Air Offset
This field specifies the temperature difference between the air leaving the zone and being
exhausted out of the building and the mean air temperature.
Field: Temperature Gradient
This field specifies the gradient, or slope, of temperature changes in the vertical direction in
K/m.
An example of this object is:
RoomAir:TemperaturePattern:ConstantGradient,
half C per Meter,
! Name
10005,
! Control Integer for Pattern Control Schedule Name
0.0,
! Thermostat Offset (Temp at thermostat- Mean Air Temp) [C]
1.0,
! Return Air Offset (Tleaving - Mean Air Temp ) [C]
1.0,
! Exhaust Air Offset (Texhaust - Mean Air Temp) [C]
0.5;
! Temperature Gradient [K/m]

RoomAir:TemperaturePattern:TwoGradient
This object provides various controls over the value of the gradient used for determining the
pattern
of
room
air
temperatures.
It
is
similar
to
previous
object
RoomAir:TemperaturePattern:ConstantGradient object but simplifies the potentially arduous
task of preparing and scheduling a large number of those objects. With this object, two
different gradients are entered and user is given several options for controlling how the
program will interpolate between the two bounds. The user inputs the height of the location of
thermostat, return air, and exhaust air in meters rather than the temperature offset.
Field: Name
This field provides a unique name for this object.
Field: Control Integer for Pattern Control Schedule Name
This field should contain an integer value that is unique among all other
RoomAir:TemperaturePattern:* objects. The value used here needs to be in the Pattern
Control Schedule for those times when this pattern is to be used for the Room Air
Temperature Distribution.
Field: Thermostat Height
This field specifies the distance above the floor where the thermostat is situated. This height
is used by the model to determine the thermostat temperature relative to the mean air
temperature by applying the gradient.
Field: Return Air Height
This field specifies the distance above the floor where the air leaves the zone and returns to
the air system. and the mean air temperature. This height is used by the model to determine
the return air temperature relative to the mean air temperature by applying the gradient.
Field: Exhaust Air Height
This field specifies the distance above the floor where the air leaves the zone and enters and
exhaust device such as an exhaust fan. This height is used by the model to determine the
exhaust air temperature relative to the mean air temperature by applying the gradient.

9/29/14

327

Input-Output Reference

Group Room Air Models

Field: Temperature Gradient Lower Bound

This field specifies the gradient, or slope, of temperature changes in the vertical direction in
C/m.
Field: Temperature Gradient Upper Bound
This field specifies the gradient, or slope, of temperature changes in the vertical direction in
C/m.
Field: Gradient Interpolation Mode
This field specifics how the program will vary between the two gradients. Select one of the
following keywords to choose the simulation data used to scale: Outdoor Environment
Drybulb Temperature, Zone Drybulb Temperature, Delta Outdoor and Zone Temperature,
Sensible Cooling Load, and Sensible Heating Load. These are explained in detail below. All
of these options have several things in common. They are essentially hard-coded. There is
no support for a general method. The interpolation scheme is based on some variable that
might reasonably be expected to correlate with gradient changes. This variables current
value is used to continually adjust the value of the vertical gradient for room air temperature.
OutdoorDryBulbTemperature: This key directs the program to interpolate between upper
and lower values of the vertical gradient based on the outdoor air temperature. If the outdoor
temperature exceeds the upper limit set in the next field, then the gradient entered in the
Temperature Gradient Upper Bound field is used. Similarly if the outdoor air temperature is
below the value set in the Lower Temperature field, then the gradient entered in the
Temperature Gradient Lower Bound is used. For outdoor temperatures that lie between the
upper and lower bounds, the gradient is determined by linear interpolation between the two.
ZoneDryBulbTemperature: This key directs the program to interpolate between upper and
lower values of the vertical gradient based on the mean zone air temperature. If the mean
zone air temperature exceeds the upper limit set in the next field, then the gradient entered in
the Temperature Gradient Upper Bound field is used. Similarly if the mean zone air
temperature is below the value set in the Lower Temperature field, then the gradient entered
in the Temperature Gradient Lower Bound is used. For mean zone air temperatures that lie
between the upper and lower bounds, the gradient is determined by linear interpolation
between the two.
ZoneAndOutdoorTemperatureDifference: This key directs the program to interpolate
between upper and lower values of the vertical gradient based on the difference between the
outdoor environment and the mean zone air temperature. If the temperature difference
exceeds the upper limit set in the next field, then the gradient entered in the Temperature
Gradient Upper Bound field is used. Similarly if the temperature difference is below the value
set in the Lower Temperature field, then the gradient entered in the Temperature Gradient
Lower Bound is used. For temperature differences that lie between the upper and lower
bounds, the gradient is determined by linear interpolation between the two.
SensibleCoolingLoad: This key directs the program to interpolate between upper and lower
values of the vertical gradient based on the sensible cooling load. If the cooling load exceeds
the upper limit set in the next field, then the gradient entered in the Temperature Gradient
Upper Bound field is used. Similarly if the cooling load is below the value set in the Lower
Temperature field, then the gradient entered in the Temperature Gradient Lower Bound is
used. For cooling loads that lie between the upper and lower bounds, the gradient is
determined by linear interpolation between the two.
SensibleHeatingLoad: This key directs the program to interpolate between upper and lower
values of the vertical gradient based on the sensible heating load. If the heating load exceeds
the upper limit set in the next field, then the gradient entered in the Temperature Gradient
Upper Bound field is used. Similarly if the heating load is below the value set in the Lower
Temperature field, then the gradient entered in the Temperature Gradient Lower Bound is
used. For heating loads that lie between the upper and lower bounds, the gradient is
determined by linear interpolation between the two.
9/29/14

328

Input-Output Reference

Group Room Air Models

Field: Upper Temperature Bound

This field is used to enter the upper bound on temperature values in Celsius. It is required for
the interpolation modes based on temperature.
Field: Lower Temperature Bound
This field is used to enter the lower bound on temperature values in Celsius. It is required for
the interpolation modes based on temperature.
Field: Upper Heat Rate Bound
This field is used to enter the upper bound on heat rate values. It is required for the
interpolation modes based on load. Both heating and cooling loads are entered as positive
numbers (in watts).
Field: Lower Heat Rate Bound
This field is used to enter the lower bound on heat rate values. It is required for the
interpolation modes based on load. Both heating and cooling loads are entered as positive
numbers (in watts).
An example of this object follows. This pattern will apply no gradient (effectively the mixing
model) if zone air temperatures are 22.5 C or lower. It will apply a gradient of 1 K/m if zone
temperatures are 26.0 C or higher. For zone air temperatures between 22.5 and 26.0 it will
determine the gradient by linear interpolation and use a gradient between 0.0 and 1.0 K/m
depending on where the zone air temperature is in the range.
RoomAir:TemperaturePattern:TwoGradient,
Mixed to one C per M by Zone DB, ! Name
2002,
! Control Integer for Pattern Control Schedule
1.1,
! Thermostat Height meters
4.5,
! Return Air Height
3.5,
! Exhaust Air Height
0.0, ! Temperature Gradient Lower Bound K/m
1.0, ! Temperature Gradient Upper Bound K/m
ZoneDrybulbTemperature, ! Gradient Interpolation Mode
26.0,
! Upper Temperature [C]
22.5,
! Lower Temperature [C]
, ! Upper Heat Rate [W]
; ! Lower Heat Rate [W]

RoomAir:TemperaturePattern:NondimensionalHeight
This object defines a distribution pattern for air temperatures relative to the current mean air
temperature as a function of height. The height, referred to as Zeta, is non-dimensional by
normalizing with the zone ceiling height. (The actual zone ceiling height can be explicitly
entered in the Zone object but if not it is calculated by EnergyPlus from the surfaces
attached to the zone.) The temperature differences are not non-dimensional and remain in
units of degrees Celsius.
An example of a vertical temperature pattern is shown in the figure below. The pattern itself is
treated as a piecewise, linear model of air temperature as a function of height. This ZetaDeltaTai curve, or lookup table, is then mapped to surfaces defined elsewhere in the file. The
centroid of each surface and zone ceiling height are used to automatically assign Zeta values
within
the
program.
The
zone
named
in
the
referencing
RoomAir:TemperaturePattern:UserDefined object is used to determine which surfaces will be
associated with the pattern when it is applied. A single pattern object can be reused for
multiple zones and times.
In addition to the vertical temperature pattern there are three other parameters included in the
pattern that are important. The first two might affect how the air system conditioning the room
is operated. The first describes the temperature difference between the mean air temperature
and the point where the sensor of a drybulb thermostat is situated. The second describes the
9/29/14

329

Input-Output Reference

Group Room Air Models

Zeta (non-dimensional height)

temperature difference between the mean and the point where system air is being extracted
from the zone. This is considered important because the changes in temperature difference
between supply and return can affect how an air system is controlled to meet the loads. The
third parameter can affect the zone air heat balance by altering the temperature of the air
leaving the zone through exhaust fans.

1
0.9

zeta
Thermostat
Return Air
Exhaust

0.8
0.7
0.6
0.5
0.4
0.3
0.2
0.1
0
-2.0

-1.0

0.0

1.0

2.0

DeltaTai = (Tair,i - MeanAirTemp) [Deg. C]

Figure 44. Example of a Vertical Air Temperature Pattern
Field: Name
This field provides a unique name for this object.
Field: Control Integer for Pattern Control Schedule Name
This field should contain an integer value that is unique among all other RoomAir
Temperature Pattern objects. The value used here needs to be in the Pattern Control
Schedule for those times when this pattern is to be used for the Room Air Temperature
Distribution.
Field: Thermostat Offset
This field specifies the temperature difference between where the thermostat is situated and
the mean air temperature.
Field: Return Air Offset
This field specifies the temperature difference between the air leaving the zone and returning
to the air system and the mean air temperature.
Field: Exhaust Air Offset
This field specifies the temperature difference between the air leaving the zone and being
exhausted out of the building and the mean air temperature.
Field Set Zeta and Temperature Difference
The remaining fields contain pairs of values that define a lookup table for the temperature
pattern in the vertical direction. The first value is Zeta and the second value is DeltaTai. This
9/29/14

330

Input-Output Reference

Group Room Air Models

object is extensible, by duplicating the last two fields and revising the IDD note that you will
have to replace inner semi-colons with commas.
Field: Pair <#> Zeta non-dimensional Height
Zeta is the normalized height and should be a fractional value from 0.0 to 1.0. A value of 0.0
corresponds to the floor and a value of 1.0 corresponds to the ceiling. The Zeta values need
to be in increasing value.
Field: Pair <#> Delta Adjacent Air Temperature
DeltaTai is the temperature difference between the air temperature at the associated Zeta
(Tai) and the mean air temperature and is given in degrees Celsius.
An example of this object corresponding to the figure above is:
RoomAir:TemperaturePattern:NondimensionalHeight,
Rough UFAD Approx , ! Name
3001 , ! Control Integer for Pattern Control Schedule
! note reference this entry in Schedule
-1.0 ,
! Thermostat Offset
1.5 , ! Return Air Offset (Tleaving - Mean Air Temp ) deg C
1.75,
! Exhaust Air Offset (Texhaust - Mean Air Temp) deg C
0.05, -1.8,
! pair 1 (Zeta , DeltaTai)
0.1,
-1.7 , ! pair 2 (Zeta , DeltaTai)
0.2,
-0.8 , ! pair 3 (Zeta , DeltaTai)
0.3,
-0.2,
! pair 4 (Zeta , DeltaTai)
0.4,
0.5,
! pair 5 (Zeta , DeltaTai)
0.5,
0.8,
! pair 6 (Zeta , DeltaTai)
0.6,
1.2,
! pair 7 (Zeta , DeltaTai)
0.7,
1.4,
! pair 8 (Zeta , DeltaTai)
0.8,
1.4,
! pair 9 (Zeta , DeltaTai)
0.9,
1.42,
! pair 10 (Zeta , DeltaTai)
0.95, 1.44;
! pair 11 (Zeta , DeltaTai)

RoomAir:TemperaturePattern:SurfaceMapping
This object defines a distribution pattern for the air temperatures adjacent to individual
surfaces. This object uses the specific names of individual surfaces defined elsewhere in the
model. This pattern allows controlling the adjacent air temperature on a surface-by-surface
basis rather than by height. This allows modeling different adjacent air temperatures on the
opposite sides of the zone.
In addition to the surface mappings there are three other parameters included in the pattern
that are important. The first two might affect how the air system conditioning the room is
operated. The first describes the temperature difference between the mean air temperature
and the point where the sensor of a drybulb thermostat is situated. The second describes the
temperature difference between the mean and the point where system air is being extracted
from the zone. This is considered important because the changes in temperature difference
between supply and return can affect how an air system is controlled to meet the loads. The
third parameter can affect the zone air heat balance by altering the temperature of the air
leaving the zone through exhaust fans.
Field: Name
This field provides a unique name for this object.
Field: Control Integer for Pattern Control Schedule Name
This field should contain an integer value that is unique among all other RoomAir
Temperature Pattern objects. The value used here needs to be in the Pattern Control
Schedule for those times when this pattern is to be used for the RoomAir Temperature
Distribution.
9/29/14

331

Input-Output Reference

Group Room Air Models

Field: Thermostat Offset

This field specifies the temperature difference between where the thermostat is situated and
the mean air temperature.
Field: Return Air Offset
This field specifies the temperature difference between the air leaving the zone and returning
to the air system and the mean air temperature.
Field: Exhaust Air Offset
This field specifies the temperature difference between the air leaving the zone and being
exhausted out of the building and the mean air temperature.
Field Set: Surface Name, Temperature Difference
Fields (6 and on): Pairs of Surface Names and Temperature Differences
The remaining fields contain pairs that define a lookup table for the temperature pattern on a
surface-by-surface basis. This object is extensible, by duplicating the last two fields and
revising the IDD note that you will have to replace inner semi-colons with commas.
Field: Surface Name Pair <#>
The name of a surface defined elsewhere in the input file.
Field: Delta Adjacent Air Temperature Pair <#>
DeltaTai is the temperature difference between the air temperature adjacent to the associated
surface (Tai) and the mean air temperature and is given in degrees Celsius.
An example of this object, which might be used to elevate temperatures near west windows
in the afternoon, is:
RoomAir:TemperaturePattern:SurfaceMapping,
GroundFloor SW Corner Hot Near West Wall, ! Name
4001, ! Control Integer for Pattern Control Schedule Name
0.0, ! Thermostat Offset(Temp at thermostat- Mean Air Temp)
0.0, ! Return Air Offset deg C
0.0, ! Exhaust Air Offset
ZN1_SW_1:W_ExtWall:1 , 0.8, ! pair 1 (Surface Name , DeltaTai)
ZN1_SW_1:W_ExtWall:2 , 0.9, ! pair 2 (Surface Name , DeltaTai)
ZN1_SW_1:W_ExtWall:3 , 1.0, ! pair 3 (Surface Name , DeltaTai)
ZN1_SW_1:W_ExtWall:4,
1.1, ! pair 4 (Surface Name , DeltaTai)
ZN1_SW_1:W_ExtWall:5,
1.3, ! pair 5 (Surface Name , DeltaTai)
ZN1_SW_1:W_ExtWall:6,
1.5, ! pair 6 (Surface Name , DeltaTai)
ZN1_SW_1:W_ExtWall:7,
1.7, ! pair 7 (Surface Name , DeltaTai)
ZN1_SW_1:W_ExtWall:8,
2.1, ! pair 8 (Surface Name , DeltaTai)
ZN1_SW_1:W_ExtWall:9,
2.4 ; ! pair 8 (Surface Name , DeltaTai)

RoomAir:Node
The RoomAir:Node object is used to define air nodes for a nodal air model. The number of air
node objects that need to be specified depends on the nodal air model selected. (However,
currently only the Mundt model uses this object). In order to use the Mundt model, the user
must specify six or more RoomAir:Node objects of different types for each zone. The exact
number of RoomAir:Node in the model will vary based on the resolution of walls. If walls (heat
transfer surfaces) are split into separate segments in the vertical direction, then more air
nodes of type MundtRoom will be useful. At a minimum, for the Mundt model RoomAir
Nodes of the following type are required: Inlet, Floor, Control, Ceiling, MundtRoom, and
Return.
Field: Name
This alpha field is a name for the air node. It should be unique and is used as an identifier
9/29/14

332

Input-Output Reference

Group Room Air Models

Field: Node Type

This alpha field indicates the type of this air node. The following explains options available for
use with the Mundt nodal air model.
Inlet is specified for the air node located where the system air enters the zone.
Floor is specified for the air node located near the floor.
Control is specified for the air node located near the thermostat.
Ceiling is specified for the air node located near the ceiling.
MundtRoom is specified for the air node located adjacent to the wall(s).
Return is specified for the air node located where the system air leaves the zone.
Field: Zone Name
This field indicates the name of the zone (Ref: Zone) that this air node belongs to. This
should be the unique name of a zone object defined elsewhere in the input file.
Field: Height of Nodal Control Volume Center
This numeric field indicates the height of the air node center. Air models such as the Mundt
model compute the air temperature as a function of height and the value entered here will be
used to determine a result for this node. The value should be specified in meters and relative
to the floor of the zone.
Field: Surface <#> Name
These remaining alpha fields indicate the names of the surfaces (Ref: Surface) that are
interacting convectively with this air node. This field is optional and related to the previous
field. Currently, at most 20 surfaces are allowed to interact with a single air node. Only those
nodes that interact with the inside faces of surfaces need to specify surface names. Each
surface should couple to no more than 1 node.
An IDF example:
RoomAir:Node,
WESTZN:FLOORAIR,
!- Node Name
Floor,
!- Node Type
WEST ZONE, !- Name of Zone to Which the Air Node Belongs
0.1,
!- Height of Nodal Control Volume Center {m}
WESTZN:FLOOR:LEFF, !- surface name
WESTZN:FLOOR:RIGHT; !- surface name

RoomAirSettings:OneNodeDisplacementVentilation
The RoomAirSettings:OneNodeDisplacementVentilation object is used to specify additional
input parameters required by the Mundt model that are not available in other input objects in
EnergyPlus. A single object will be used for the zone.
Field: Zone Name
This alpha field indicates the name of the zone (Ref: Zone) for the required input parameters
as specified in the following fields.
Field: Fraction of Convective Internal Loads Added to Floor Air
This numeric field indicates what fraction of the convective part of the internal gains is added
to the air near the floor in the zone specified.
Field: Fraction of Infiltration Internal Loads Added to Floor Air
This numeric field indicates what fraction of the infiltration air enters near the floor in the zone
specified.
An IDF example:

9/29/14

333

Input-Output Reference

Group Room Air Models

RoomAirSettings:OneNodeDisplacementVentilation,
WEST ZONE, !- Zone Name
0.1, !- Fraction of internal loads from the convective Floor Air
0.1; !- Fraction of internal loads from the Infiltration Air

RoomAirSettings:ThreeNodeDisplacementVentilation
This model is applicable to spaces that are served by a low velocity floor-level displacement
ventilation air distribution system. Furthermore, the dominant sources of heat gain should be
from people and other localized sources located in the occupied part of the room. The model
should be used with caution in zones which have large heat gains or losses through exterior
walls or windows or which have considerable direct solar gain. The model predicts three
temperatures in the room:
A foot level temperature (T FLOOR). The floor region is 0.2 meters deep and T FLOOR
represents the temperature at the mid-point of the region.
An occupied subzone temperature (T OC), representing the temperature in the region
between the floor layer and the upper, mixed layer.
An upper node representing the mixed-layer/outflow temperature (T MX) essential for
overall energy budget calculations and for modeling comfort effects of the upper layer
temperature.

Figure 45. Schematic representation of the three temperature points and temperature gradients

The following fields are used to define an instance of the UCSD Displacement Ventilation
Model Controls object.
Field: Zone Name
This field provides the unique name of a zone described elsewhere in the file. A single
instance of the UCSD Displacement Ventilation Model Controls object is needed for each
zone that is to be modeled using this method.
Field: Gain Distribution Schedule Name
This field specifies the unique name of schedule defined elsewhere in the input file. The
schedule values are the fractions of the convective portion of the internal gains in the
occupied subzone that remain in the occupied subzone. The remainder of the convective
portion of the internal gains in the occupied subzone enters the plumes and is carried to the
9/29/14

334

Input-Output Reference

Group Room Air Models

upper subzone. The types of internal gains that are assumed to be located in the occupied
subzone are:
people
task lights
electric equipment
gas equipment
hot water equipment
steam equipment
other equipment
baseboard heat
Types of internal gains that are assumed to be in the upper subzone are:
general lights
tubular daylighting devices
high temperature radiant heaters
The schedule values should be between 0 and 1. A value of 1 means that all the convection
gains from equipment, task lights and people are dispersed in the lower occupied subzone.
Conversely a value of 0 puts all the lower subzone convective gains into the plumes rising
into the upper well-mixed subzone.
Field: Number of Plumes per Occupant
This field specifies number of plumes per occupant. Plumes are associated with localized
sources of convective heat gain from people and equipment. For example, a value of 2.0
would be used if each occupant has a computer that generates a separate plume that does
not merge with the plume from the occupant in the lower, occupied, subzone.
Field: Thermostat Height
This field is the height in meters of the thermostat/temperature control sensor above the floor.
Field: Comfort Height
The height in meters above the floor at which air temperature is calculated for comfort
purposes. The air temperature at this height is used in calculating the available measures of
comfort: Fanger, Pierce or KSU. The default is 1.1 meters.
Field: Temperature Difference Threshold for Reporting
This field specifies a minimum temperature difference between the upper mixed subzone and
the occupied subzone that will be used to trigger whether or not the displacement ventilation
auxiliary outputs will be calculated. These outputs are Room Air Zone Transition Height,
Room Air Zone Recommended Minimum Flow Fraction, Room Air Zone Average
Temperature Gradient and Room Air Zone Maximum Temperature Gradient. They are set to
negative values when the temperature difference is less than the threshold and the output
Room Air Zone Is Mixed Status is set to 1.
The value should be greater than or equal to zero and is in units of degrees Centigrade. The
default value is 0.4 degrees C.
An example input:
RoomAirSettings:ThreeNodeDisplacementVentilation,
ZONE ONE, !- Zone Name
Constant - .2, !- Gain Distribution Schedule Name
1, !- Number of Plumes per Occupant
, !- Thermostat Height
, !- Comfort Height
.3; !- Temp. Difference Threshold for Displacement Ventilation

9/29/14

335

Input-Output Reference

Group Room Air Models

RoomAirSettings:CrossVentilation
The UCSD Cross Ventilation Room Air Model provides a simple model for heat transfer and
temperature prediction in cross ventilated rooms. Cross Ventilation (CV) is common in many
naturally ventilated buildings, with air flowing through windows, open doorways and large
internal apertures across rooms and corridors in the building.
The CV model is used in EnergyPlus in the context of natural ventilation simulations using the
AirflowNetwork airflow prediction model. Typical CV room flows are characterized by two
clearly distinguishable flow regions that have different airflow velocities and temperature:
Jet regions in front of the inflow windows
Recirculation regions in the portions of the room that are not directly in front of the
windows.
Each inflow aperture has one jet region while the recirculation regions are treated as a whole,
with a single temperature and characteristic velocity. The default EnergyPlus perfectly mixed
single temperature node room air approach is not suitable for these partially mixed flows. The
proposed CV model uses multiple nodes with distinct air temperature and airflow velocity
(one node for the recirculations plus one additional node for each inflow aperture).

Figure 46. Schematic representation of room air geometry a) schematic representation of

a room geometry that generates cross ventilation airflow. b) the proposed model
distinguishes two regions in the flow: jet and recirculation (shown here in a CFD
simulation of one half of a symmetrical room).

9/29/14

336

Input-Output Reference

Group Room Air Models

Figure 47. Schematic top view possible airflow patterns in cross-ventilation.

The following fields are used to define an instance of the UCSD Cross Ventilation Model
Controls object.
Field: Zone Name
This field provides the name of the zone to which this object applies. A single instance of the
UCSD Cross Ventilation Model Controls object is needed for each zone modeled using this
method.
Field: Gain Distribution Schedule Name
This field specifies the unique name of schedule defined elsewhere in the input file. The
schedule values define the fractions of the convective portion of the internal gains in the jet
and recirculation regions.
The schedule values should be between 0 and 1. A value of 1 means that all the convective
gains are dispersed in the jet region. Conversely a value of 0 puts all the convective gains
into the recirculation region.
Field: Airflow Region Used for Thermal Comfort Evaluation
Required field whenever thermal comfort is predicted. Defines air temperature and mean
airflow velocity that will be used in the Fanger model. Conditions must refer to one of the two
regions defined in the model: jet or recirculation.
Possible choices: Jet or Recirculation.
CrossVentilation Model Outputs
Zone,Average,Room Air Zone Jet Region Temperature [C]
Zone,Average,Room Air Zone Recirculation Region Temperature [C]

9/29/14

337

Input-Output Reference
Zone,Average,Room
Zone,Average,Room
Zone,Average,Room
Zone,Average,Room
Zone,Average,Room
Zone,Average,Room
Zone,Average,Room
Zone,Average,Room

Group Room Air Models

Air
Air
Air
Air
Air
Air
Air
Air

Zone Jet Region Average Air Velocity [m/s]

Zone Recirculation Region Average Air Velocity [m/s]
Window Jet Region Average Air Velocity [m/s]
Zone Recirculation and Inflow Rate Ratio []
Zone Inflow Opening Area [m2]
Zone Room Length [m]
Zone Is Mixing Status []
Zone Is Recirculating Status []

Room Air Zone Jet Region Temperature [C]

Average air temperature in the jet region of the flow in degrees C. If there is more than one
inflow window this output will be the inflow-area-weighted average of the jet region
temperature.
Room Air Zone Recirculation Region Temperature [C]
Average air temperature in the recirculation region of the flow in degrees C.
Room Air Zone Jet Region Average Air Velocity [m/s]
Average airflow velocity in the jet region of the flow in meters per second. If there is more
than one inflow window this output will be the inflow area weighted area of the jet inflow
velocities.
Room Air Window Jet Region Average Air Velocity [m/s]
Average airflow velocity in the jet region in front of the window, in meters per second.
Room Air Zone Recirculation Region Average Air Velocity [m/s]
Average airflow velocity in the recirculation region of the flow in meters per second.
Room Air Zone Recirculation and Inflow Rate Ratio []
Ratio between airflow rate in the recirculation regions and the total inflow rate, nondimensional.
Room Air Zone Inflow Opening Area [m2]
Area of the inflow aperture in square meters. This area can change due to variation in wind
direction (as inflow aperture changes) or variations in the opening schedule.
Room Air Zone Room Length [m]
Length of the room along the cross ventilation direction, in meters.
Room Air Zone Is Mixing Status []
An integer flag that indicates whether the zone is mixed (single node well-mixed zone model
used) or significant momentum conservation is occurring (UCSD CV model used). The value
1 means well-mixed; 0 means cross ventilation is present. Transition to mixed flow can occur
due to three mechanism: reduction in inflow velocity, reduction in inflow aperture area and
dominance of buoyancy effects. A value of 1 is yes, a value of 0 is no.
Room Air Zone Is Recirculating Status []
An integer flag that indicates whether recirculations are present in the flow. A cross
ventilation flow does not have recirculations whenever the inflow area is similar to the room
cross section area (such as airflow in a typical corridor). A value of 1 is yes, a value of 0 is
no.
RoomAirSettings:UnderFloorAirDistributionInterior
This model is applicable to interior spaces that are served by an underfloor air distribution
system. The dominant sources of heat gain should be from people, equipment, and other
9/29/14

338

Input-Output Reference

Group Room Air Models

localized sources located in the occupied part of the room. The model should be used with
caution in zones which have large heat gains or losses through exterior walls or windows or
which have considerable direct solar gain. The model predicts two temperatures in the room:
An occupied subzone temperature (T OC), representing the temperature in the region
between the floor and the boundary of the upper subzone..
An upper subzone temperature (T MX) essential for overall energy budget calculations and
for modeling comfort effects of the upper layer temperature.
The following fields are used to define an instance of the UCSD UFAD Interior Model
Controls object.
Field: Zone Name
This field provides the unique name of a zone described elsewhere in the file. A single
instance of the RoomAirSettings:UnderFloorAirDistributionInterior object is needed for each
zone that is to be modeled using this method.
Field: Number of Diffusers
The total number of diffusers in this zone. This field can allowed to Autocalculate (in which
case it is set to the design occupancy level; i.e., number of people). If the design occupancy
is low or zero but there are still heat sources that could generate buoyancy driven plumes,
the user should input a value based on the design supply air flow rate of the zone and the
design flow rate of an individual diffuser. In the absence of any other information, divide the
zone area by 100 ft2. The default for this field is Autocalculate.
Field: Power per Plume
The power in watts incorporated in a buoyancy driven thermal plume. Normally we assume
all the loads of a workstation create a single plume so that this represents the convective
heat gain from a workstation 1 person, 1 computer terminal, plus any task lighting. A typical
value would be 220 watts. However, the model assumes an equivalent plume derived from
the zone extraction rate normalized to the number of workstations/occupants. This field
should be allowed to default the program will calculate a value based upon the occupancy
and the extraction rate. The default is Autocalculate.
Field: Design Effective Area of Diffuser
This is the design air flow opening area in square meters of a single diffuser. The default
value depends on the diffuser type. For swirl diffusers it is 0075 m2, for variable area diffusers
0.035 m2, for horizontal swirl diffusers 0.006 m 2, and for linear bar grilles 0.03 m 2. The default
is Autocalculate..
Field: Diffuser Slot Angle from Vertical
This input describes the angle at which air emerges from the diffusers. It should be the angle
in degrees between the vertical and the diffuser slots. The defaults depend on the diffuser
type: for swirl diffusers it is 28 degrees, for variable area diffusers 45 degrees, for DV
diffusers 73 degrees, and for linear bar grilles 15 degrees.
Field: Thermostat Height
This field is the height in meters of the thermostat/temperature control sensor above the floor.
The default is 1.2 meters.
Field: Comfort Height
The height in meters above the floor at which air temperature is calculated for comfort
purposes. The air temperature at this height is used in calculating the available measures of
comfort: Fanger, Pierce or KSU. The default is 1.1 meters.

9/29/14

339

Input-Output Reference

Group Room Air Models

Field: Temperature Difference Threshold for Reporting

This field specifies a minimum temperature difference between the upper subzone and the
occupied subzone that will be used to trigger whether or not the UFAD auxiliary outputs will
be calculated. These outputs are Room Air Zone Transition Height and Room Air Zone
Average Temperature Gradient. They are set to zero when the temperature difference is less
than the threshold and the output Room Air Zone Is Mixed Status is set to 1.
The value should be greater than or equal to zero and is in units of degrees Centigrade. The
default value is 0.4 degrees C.
Field: Diffuser Type
The choices for this alpha field are Swirl | VariableArea | HorizontalSwirl | LinearBarGrille
| Custom. The swirl and displacement diffusers are fixed area diffusers. The variable area
diffusers maintain an approximately constant exit velocity. Linear bar grilles are normally
used in exterior zonesand are fixed area diffusers. Custom is used to signify that the user
intends to input the coefficients A E (see below) rather than let the program set the
coefficients based on diffuser type. The default is Swirl.
Field: Transition Height
An optional field to allow the user to specify the transition height (meters above floor) rather
than have the program calculate it. The default is 1.7 meters.
Field: Coefficient A
The coefficient A in the formula: Kc = A*Gamma**B + C + D*Gamma + E*Gamma**2.
Gamma is a variable that characterizes the amount of stratification in a UFAD zone. Kc is the
fraction of the total internal convective heat gain that is assigned to the lower (occupied)
subzone. The coefficients in the formula are defaulted based upon diffuser type. A user would
normally allow this field to default. The default is autocalculate.
Field: Coefficient B
The coefficient B in the formula: Kc = A*Gamma**B + C + D*Gamma + E*Gamma**2.
Gamma is a variable that characterizes the amount of stratification in a UFAD zone. Kc is the
fraction of the total internal convective heat gain that is assigned to the lower (occupied)
subzone. The coefficients in the formula are defaulted based upon diffuser type. A user would
normally allow this field to default. The default is autocalculate.
Field: Coefficient C
The coefficient C in the formula: Kc = A*Gamma**B + C + D*Gamma + E*Gamma**2.
Gamma is a variable that characterizes the amount of stratification in a UFAD zone. Kc is the
fraction of the total internal convective heat gain that is assigned to the lower (occupied)
subzone. The coefficients in the formula are defaulted based upon diffuser type. A user would
normally allow this field to default. The default is autocalculate.
Field: Coefficient D
The coefficient D in the formula: Kc = A*Gamma**B + C + D*Gamma + E*Gamma**2.
Gamma is a variable that characterizes the amount of stratification in a UFAD zone. Kc is the
fraction of the total internal convective heat gain that is assigned to the lower (occupied)
subzone. The coefficients in the formula are defaulted based upon diffuser type. A user would
normally allow this field to default. The default is autocalculate.
Field: Coefficient E
The coefficient E in the formula: Kc = A*Gamma**B + C + D*Gamma + E*Gamma**2.
Gamma is a variable that characterizes the amount of stratification in a UFAD zone. Kc is the
fraction of the total internal convective heat gain that is assigned to the lower (occupied)

9/29/14

340

Input-Output Reference

Group Room Air Models

subzone. The coefficients in the formula are defaulted based upon diffuser type. A user would
normally allow this field to default. The default is autocalculate.
An example input is:
RoomAirModelType,
SPACE5-1 RoomAir Model, !- Name
SPACE5-1,
!- Zone Name
UnderFloorAirDistributionInterior, !- Room-Air Modeling Type
DIRECT;
!- Air Temperature Coupling Strategy
RoomAirSettings:UnderFloorAirDistributionInterior,
SPACE5-1,
!- Zone Name
Autocalculate,
!- Number of Diffusers
Autocalculate,
!- Power per Plume
Autocalculate,
!- Design Effective Area of Diffuser {m2}
Autocalculate,
!- Diffuser Slot Angle from Vertical {deg}
,
!- Thermostat Height {m}
,
!- Comfort Height {m}
0.001,
!- Temperature Difference Threshold for Reporting {deltaC}
Swirl,
!- Diffuser Type
1.7,
!- Transition Height {m}
Autocalculate,
!- Coefficient A
Autocalculate,
!- Coefficient B
Autocalculate,
!- Coefficient C
Autocalculate,
!- Coefficient D
Autocalculate;
!- Coefficient E

RoomAirSettings:UnderFloorAirDistributionExterior
This model is applicable to exterior spaces that are served by an underfloor air distribution
system. The dominant sources of heat gain should be from people, equipment, and other
localized sources located in the occupied part of the room, as well as convective gain coming
from a warm window. The model predicts two temperatures in the room:
An occupied subzone temperature (T OC), representing the temperature in the region
between the floor and the boundary of the upper subzone..
An upper subzone temperature (T MX) essential for overall energy budget calculations and
for modeling comfort effects of the upper layer temperature.
The following fields are used to define an instance of the UCSD UFAD Exterior Model
Controls object.
Field: Zone Name
This field provides the unique name of a zone described elsewhere in the file. A single
instance of the RoomAirSettings:UnderFloorAirDistributionExterior object is needed for each
zone that is to be modeled using this method.

9/29/14

341

Input-Output Reference

Group Room Air Models

Field: Number of Diffusers

The total number of diffusers in this zone. This field can allowed to Autocalculate (in which case it
is set to the design occupancy level; i.e., number of people). If the design occupancy is low or
zero but there are still heat sources that could generate buoyancy driven plumes, the user should
input a value based on the design supply air flow rate of the zone and the design flow rate of an
individual diffuser. In the absence of any other information, divide the zone area by 100 ft2. The
default for this field is Autocalculate.
Field: Power per Plume
The power in watts incorporated in a buoyancy driven thermal plume. Normally we assume all the
loads of a workstation create a single plume so that this represents the convective heat gain from
a workstation 1 person, 1 computer terminal, plus any task lighting. A typical value would be 220
watts. However, the model assumes an equivalent plume derived from the zone extraction rate
normalized to the number of workstations/occupants. This field should be allowed to default the
program will calculate a value based upon the occupancy and the extraction rate. The default is
Autocalculate.
Field: Design Effective Area of Diffuser
This is the design air flow opening area in square meters of a single diffuser. The default
value depends on the diffuser type. For swirl diffusers it is 0075 m2, for variable area diffusers
0.035 m2, for horizontal swirl diffusers 0.006 m 2, and for linear bar grilles 0.03 m 2. The default
is Autocalculate..
Field: Diffuser Slot Angle from Vertical
This input describes the angle at which air emerges from the diffusers. It should be the angle
in degrees between the vertical and the diffuser slots. The defaults depend on the diffuser
type: for swirl diffusers it is 28 degrees, for variable area diffusers 45 degrees, for DV
diffusers 73 degrees, and for linear bar grilles 15 degrees.
Field: Thermostat Height
This field is the height in meters of the thermostat/temperature control sensor above the floor.
The default is 1.2 meters.
Field: Comfort Height
The height in meters above the floor at which air temperature is calculated for comfort
purposes. The air temperature at this height is used in calculating the available measures of
comfort: Fanger, Pierce or KSU. The default is 1.1 meters.
Field: Temperature Difference Threshold for Reporting
This field specifies a minimum temperature difference between the upper subzone and the
occupied subzone that will be used to trigger whether or not the UFAD auxiliary outputs will
be calculated. These outputs are Room Air Zone Transition Height and Room Air Zone
Average Temperature Gradient. They are set to zero when the temperature difference is less
than the threshold and the output Room Air Zone Is Mixed Status is set to 1.
The value should be greater than or equal to zero and is in units of degrees Centigrade. The
default value is 0.4 degrees C.
The value should be greater than or equal to zero and is in units of degrees Centigrade. The
default value is 0.4 degrees C.
Field: Diffuser Type
The choices for this alpha field are Swirl | VariableArea | HorizontalSwirl | LinearBarGrille
| Custom. The swirl and displacement diffusers are fixed area diffusers. The variable area
diffusers maintain an approximately constant exit velocity. Linear bar grilles are normally
used in exterior zonesand are fixed area diffusers. Custom is used to signify that the user
9/29/14

342

Input-Output Reference

Group Room Air Models

intends to input the coefficients A E (see below) rather than let the program set the
coefficients based on diffuser type. The default is Swirl.
Field: Transition Height
An optional field to allow the user to specify the transition height (meters above floor) rather
than have the program calculate it. The default is 1.7 meters.
Field: Coefficient A
The coefficient A in the formula: Kc = A*Gamma**B + C + D*Gamma + E*Gamma**2.
Gamma is a variable that characterizes the amount of stratification in a UFAD zone. Kc is the
fraction of the total internal convective heat gain that is assigned to the lower (occupied)
subzone. The coefficients in the formula are defaulted based upon diffuser type. A user would
normally allow this field to default. The default is autocalculate.
Field: Coefficient B
The coefficient B in the formula: Kc = A*Gamma**B + C + D*Gamma + E*Gamma**2.
Gamma is a variable that characterizes the amount of stratification in a UFAD zone. Kc is the
fraction of the total internal convective heat gain that is assigned to the lower (occupied)
subzone. The coefficients in the formula are defaulted based upon diffuser type. A user would
normally allow this field to default. The default is autocalculate.
Field: Coefficient C
The coefficient C in the formula: Kc = A*Gamma**B + C + D*Gamma + E*Gamma**2.
Gamma is a variable that characterizes the amount of stratification in a UFAD zone. Kc is the
fraction of the total internal convective heat gain that is assigned to the lower (occupied)
subzone. The coefficients in the formula are defaulted based upon diffuser type. A user would
normally allow this field to default. The default is autocalculate.
Field: Coefficient D
The coefficient D in the formula: Kc = A*Gamma**B + C + D*Gamma + E*Gamma**2.
Gamma is a variable that characterizes the amount of stratification in a UFAD zone. Kc is the
fraction of the total internal convective heat gain that is assigned to the lower (occupied)
subzone. The coefficients in the formula are defaulted based upon diffuser type. A user would
normally allow this field to default. The default is autocalculate.
Field: Coefficient E
The coefficient E in the formula: Kc = A*Gamma**B + C + D*Gamma + E*Gamma**2.
Gamma is a variable that characterizes the amount of stratification in a UFAD zone. Kc is the
fraction of the total internal convective heat gain that is assigned to the lower (occupied)
subzone. The coefficients in the formula are defaulted based upon diffuser type. A user would
normally allow this field to default. The default is autocalculate.
An example input is:
RoomAirSettings:UnderFloorAirDistributionExterior,
SPACE1-1,
!- Zone Name
Autocalculate,
!- Number of Diffusers per Zone
Autocalculate,
!- Power per Plume
Autocalculate,
!- Design Effective Area of Diffuser {m2}
Autocalculate,
!- Diffuser Slot Angle from Vertical {deg}
,
!- Thermostat Height {m}
,
!- Comfort Height {m}
0.001,
!- Temperature Difference Threshold for
Reporting {deltaC}
LinearBarGrille,
!- Diffuser Type
1.7,
!- Transition Height {m}
Autocalculate,
!- Coefficient A
Autocalculate,
!- Coefficient B
9/29/14

343

Input-Output Reference

Group Room Air Models

Autocalculate,
Autocalculate,
Autocalculate;

!- Coefficient C
!- Coefficient D
!- Coefficient E

Room Air Model Outputs

Each room air model sets up outputs specific to that model. The effect of room air modeling is
usually to adjust the adjacent air temperature along the inside surface of heat transfer
surfaces. The output report Surface Int Adjacent Air Temperature [C] is provided for this and
described under Surface Outputs.
Zone Predicted Sensible Load Room Air Correction Factor
This output variable provides the value of the correction factor applied to the predicted zone
loads. Predicted zone load to setpoint is (usually) used to control HVAC air systems and the
presence of a room air model has an impact on the loads. The predicited loads are multiplied
by the factor in this output variable. The value is always 1.0 when there is no Room Air
model. When there is a Room Air model, this output shows how that model is increasing or
decreasing overall zone loads experienced by the air system.
RoomAir:TemperaturePattern:TwoGradient Outputs
The user-defined air temperature pattern that interpolates between two gradients produces
the following output variable.
HVAC,Average,Room Air Zone Vertical Temperature Gradient [K/m]

Room Air Zone Vertical Temperature Gradient [K/m]

This output variable is the result of the interpolation performed by the user-defined roomair
model using RoomAir:TemperaturePattern:TwoGradient. This is the temperature gradient in
the vertical direction. The units are degrees Kelvin per meter.
Mundt Model / OneNodeDisplacementVentilation Outputs
The following output is available for the Mundt model.
Room Air Node Air Temperature [C]

Room Air Node Air Temperature [C]

This output variable provides the drybulb air temperature used in, or calculated by, the Mundt
model. The selection key is the name of an air node defined in a ROOMAIR Node object.
ThreeNodeDisplacementVentilation Outputs
HVAC,Average,Room
HVAC,Average,Room
HVAC,Average,Room
HVAC,Average,Room
HVAC,Average,Room
HVAC,Average,Room
HVAC,Average,Room
HVAC,Average,Room
HVAC,Average,Room
HVAC,Average,Room

Air
Air
Air
Air
Air
Air
Air
Air
Air
Air

Zone
Zone
Zone
Zone
Zone
Zone
Zone
Zone
Zone
Zone

Mixed Subzone Temperature [C]

Occupied Subzone Temperature [C]
Floor Subzone Temperature [C]
Transition Height [m]
Recommended Minimum Flow Fraction
Is Mixed Status []
Average Temperature Gradient [K/m]
Maximum Temperature Gradient [K/m]
Thermal Comfort Effective Air Temperature [C]
Thermostat Temperature [C]

Room Air Zone Mixed Subzone Temperature [C]

The temperature of the upper well-mixed subzone in degrees C.
Room Air Zone Occupied Subzone Temperature [C]
The average temperature of the lower, stratified, occupied subzone in degrees C.

9/29/14

344

Input-Output Reference

Group Room Air Models

Room Air Zone Floor Subzone Temperature [C]

The temperature of the region near the floor in degrees C.
Room Air Zone Transition Height [m]
The height above the floor, in meters, of the boundary between the lower occupied subzone
and the upper well-mixed subzone.
Room Air Zone Recommended Minimum Flow Fraction []
The ratio of the minimum recommended flow rate to the actual flow rate. Here flow rate
means the sum of infiltration, ventilation, mixing and system air flow rates. The minimum flow
is the flow needed to establish the boundary between the occupied and mixed subzones at
1.5 meters.
Room Air Zone Is Mixed Status []
An integer flag that indicates whether the zone is mixed (single node well-mixed zone model
used) or stratified (UCSD DV model used). The value 1 means well-mixed; 0 means
stratified.
Room Air Zone Average Temperature Gradient [K/m]
The temperature gradient between the middle of the floor region and the middle of the wellmixed upper subzone in degrees Kelvin per meter.
Room Air Zone Maximum Temperature Gradient [K/m]
The maximum of the temperature gradient between the middle of the floor region and the
middle of the occupied subzone and the temperature gradient between the middle of the
occupied subzone and the middle of the well-mixed subzone. The gradient is in degrees
Kelvin per meter.
Room Air Zone Thermal Comfort Effective Air Temperature [C]
The temperature at the user specified comfort height in degrees C.
Room Air Zone Thermostat Temperature [C]
The temperature at the height of the thermostat (specified by user input) in degrees C.
CrossVentilation Model Outputs
Zone,Average,Room
Zone,Average,Room
Zone,Average,Room
Zone,Average,Room
Zone,Average,Room
Zone,Average,Room
Zone,Average,Room
Zone,Average,Room
Zone,Average,Room

Air
Air
Air
Air
Air
Air
Air
Air
Air

Zone
Zone
Zone
Zone
Zone
Zone
Zone
Zone
Zone

Jet Region Temperature [C]

Recirculation Region Temperature [C]
Jet Region Average Air Velocity [m/s]
Recirculation Region Average Air Velocity [m/s]
Inflow Opening Area[m2]
Room Length [m]
Recirculation and Inflow Rate Ratio []
Is Mixing Status []
Is Recirculating Status []

Room Air Zone Jet Region Temperature [C]

Average air temperature in the jet region of the flow in degrees C.
Room Air Zone Recirculation Region Temperature [C]
Average air temperature in the recirculation region of the flow in degrees C.
Room Air Zone Jet Region Average Air Velocity [m/s]
Average airflow velocity in the jet region of the flow in meters per second.

9/29/14

345

Input-Output Reference

Group Room Air Models

Room Air Zone Recirculation Region Average Air Velocity [m/s]

Average airflow velocity in the recirculation region of the flow in meters per second.
Room Air Zone Inflow Opening Area [m2]
Area of the inflow aperture in square meters. This area can change due to variation in wind
direction (as inflow aperture changes) or variations in the opening schedule.
Room Air Zone Room Length [m]
Length of the room along the cross ventilation direction, in meters.
Room Air Zone Recirculation and Inflow Rate Ratio []
Ratio between airflow rate in the recirculation region and inflow rate, non-dimensional.
Room Air Zone Is Mixing Status []
An integer flag that indicates whether the zone is mixed (single node well-mixed zone model
used) or significant momentum conservation is occurring (UCSD CV model used). The value
1 means well-mixed; 0 means cross ventilation is present. Transition to mixed flow can occur
due to three mechanism: reduction in inflow velocity, reduction in inflow aperture area and
dominance of buoyancy effects. A value of 1 is yes, a value of 0 is no.
Room Air Zone Is Recirculating Status []
An integer flag that indicates whether recirculations are present in the flow. A cross
ventilation flow does not have recirculations whenever the inflow area is similar to the room
cross section area (such as airflow in a typical corridor). A value of 1 is yes, a value of 0 is
no.
UnderFloorAirDistributionInterior/Exterior Model Outputs
HVAC,Average,Room
HVAC,Average,Room
HVAC,Average,Room
HVAC,Average,Room
HVAC,Average,Room
HVAC,Average,Room
HVAC,Average,Room
HVAC,Average,Room
HVAC,Average,Room
HVAC,Average,Room
HVAC,Average,Room

Air
Air
Air
Air
Air
Air
Air
Air
Air
Air
Air

Zone
Zone
Zone
Zone
Zone
Zone
Zone
Zone
Zone
Zone
Zone

Mixed Subzone Temperature [C]

Occupied Subzone Temperature [C]
Transition Height [m]
Is Mixed Status []
Average Temperature Gradient [K/m]
Effective Comfort Air Temperature [C]
Thermostat Temperature [C]
Transition Height Gamma Value [ ]
Plume Heat Transfer Rate [W]
Temperature Stratification Fraction []
Window Plume Heat Transfer Rate [W]

Room Air Zone Mixed Subzone Temperature [C]

The temperature of the upper subzone in degrees C.
Room Air Zone Occupied Subzone Temperature [C]
The temperature of the lower, occupied subzone in degrees C.
Room Air Zone Transition Height [m]
The height above the floor, in meters, of the boundary between the lower occupied subzone
and the upper subzone..
Room Air Zone Is Mixed Status []
An integer flag that indicates whether the zone is mixed (single node well-mixed zone model
used) or stratified (UCSD UFI model used). The value 1 means well-mixed; 0 means
stratified.

9/29/14

346

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

Room Air Zone Average Temperature Gradient [K/m]

The temperature gradient between the middle of the occupied subzone and the middle of the
upper subzone in degrees Kelvin per meter.
Room Air Zone Effective Comfort Air Temperature [C]
The temperature at the user specified comfort height in degrees C.
Room Air Zone Thermostat Temperature [C]
The temperature at the height of the thermostat (specified by user input) in degrees C.
Room Air Zone Transition Height Gamma Value []
Value of gamma a dimensionless height used in calculating the transition height. Lower
values of gamma indicate increased stratification, higher values less. Generally the values
should be between 2 and 30.
Room Air Zone Plume Heat Transfer Rate [W]
The heat in watts driving the plumes in the occupied subzone.
Room Air Zone Window Plume Heat Transfer Rate [W]
The convective heat gain from windows in an UnderFloorAirDistributionExterior zone.
Room Air Zone Temperature Stratification Fraction []
This output, (Phi) is a measure of temperature stratification in the space. It is the difference
between the occupied subzone temperature and the supply temperature divided by difference
between the return temperature and the supply temperature. Technically it is equal to Kc. As
phi approaches 1, the space is fully mixed. As phi approaches 0, the space becomes fully
stratified. Expressed as an equation:
(Tocc Tsup) / (Tret - Tsup)

Group Internal Gains (People, Lights, Other internal zone equipment)

Not all the influence for energy consumption in the building is due to envelope and ambient
conditions. This group of objects describes other internal gains that may come into play
(People, Lights, Various Equipment Types).
People
The people statement is used to model the occupants effect on the space conditions. The
following definition addresses the basic affects as well as providing information that can be
used to report the thermal comfort of a group of occupants. The Fanger, Pierce Two-Node,
and Kansas State University Two-Node thermal comfort models are available in EnergyPlus.
A user may select any of these models for each People statement by simply adding the
appropriate choice keyword after the air velocity schedule name. Thermal comfort
calculations will only be made for people statements that include specific requests for these
thermal comfort models. . This object also requires input of carbon dioxide generation rate
based on people activity level for zone carbon dioxide simulations.
Field: Name
The name of the People object. Must be unique across all People objects.
Field: Zone or ZoneList Name
This field is the name of the zone (ref: Zone) or ZoneList (ref: ZoneList) and links a particular
people statement to a thermal zone or set of thermal zones in the building. When the
ZoneList option is used then this people definition is applied to each of the zones in the zone
list effecting a global definition for the number of people in the zone. The Zonelist option can
9/29/14

347

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

be used effectively with the people/area and area/person options of the Number of People
Calculation Method.
The name of the actual people object becomes <Zone Name> <People Object Name> and
should be less than the standard length (100 characters) for a name field. If it is greater than
this standard length, it may be difficult to specify in output reporting as it will be truncated. A
warning will be shown if the generated name is greater than 100 characters. If it duplicates
another such concatenated name, there will be a severe error and terminate the run.
Field: Number of People Schedule Name
This field is the name of the schedule (ref: Schedules) that modifies the number of people
parameter (see Number of People Calculation Method and related fields). The schedule
values can be any positive number. The actual number of people in a zone as defined by this
statement is the product of the number of people field and the value of the schedule specified
by name in this field.
Field: Number of People Calculation Method
This field is a key/choice field that tells which of the next three fields are filled and is
descriptive of the method for calculating the nominal number of occupants (people) in the
Zone. The key/choices are:
People
With this choice, the method used will be a straight insertion of the number of occupants
(people). (The Number of People field should be filled.)
People/Area
With this choice, the method used will be a factor per floor area of the zone. (The People per
Zone Floor Area field should be filled).
Area/Person
With this choice, the method used will be a factor of floor area per person. (The Zone Floor
Area per Person field should be filled).
Field: Number of People
This field is used to represent the maximum number of people in a zone that is then
multiplied by a schedule fraction (see schedule field). In EnergyPlus, this is slightly more
flexible in that the number of people could be a diversity factor applied to a schedule of real
numbers. Note that while the schedule value can vary from hour to hour, the number of
people field is constant for all simulation environments.
Field: People per Zone Floor Area
This factor (person/m2) is used, along with the Zone Floor Area to determine the maximum
number of people as described in the Number of People field. The choice from the method
field should be people/area.
Field: Zone Floor Area per Person
This factor (m 2/person) is used, along with the Zone Floor Area to determine the maximum
number of people as described in the Number of People field. The choice from the method
field should be area/person.
Field: Fraction Radiant
This field is a decimal number between 0.0 and 1.0 and is used to characterize the type of
heat being given off by people in a zone. The number specified in this field will be multiplied
by the total sensible energy emitted by people to give the amount of long wavelength
radiation gain from human beings in a zone. The remainder of the sensible load is assumed
to be convective heat gain. Note that latent gains from people are not included in either the
radiant or convective heat gains. See the Engineering Reference document for more details.

9/29/14

348

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

Field: Sensible Heat Fraction

The user can use this field to specify a fixed sensible fraction for the heat gain due to this
PEOPLE object. Normally the program calculates the sensible/latent split; this field gives the
user control over this split. This field is autocalculated: if the field is blank or autocalculate,
the program will calculate the sensible/latent split; if a value is entered, it will be used as the
sensible fraction of the current total heat gain.
Field: Activity Level Schedule Name
This field is the name of the schedule that determines the amount of heat gain per person in
the zone under design conditions. This value is modified somewhat based on a correlation to
account for variations in space temperature. The schedule values may be any positive
number and the units for this parameter is Watts per person. This schedule represents the
total heat gain per person including convective, radiant, and latent. An internal algorithm is
used to determine what fraction of the total is sensible and what fraction is latent. Then, the
sensible portion is divided into radiant and convective portions using the value specified for
Fraction Radiant (above). See the Engineering Reference document for more details.
Values for activity level can range anywhere from approximately 100-150 Watts per person
for most office activities up to over 900 Watts per person for strenuous physical activities
such as competitive wrestling. The following table (Table 11) is based on Table 4 from the
2005 ASHRAE Handbook of Fundamentals, page 8.6. In addition to the information from the
ASHRAE HOF, there is an added column of values in W/Person such as necessary for the
activity level schedule values. This column uses the standard adult body surface area of 1.8
m2 to multiply the activity levels in W/m 2 that are used in the table. Warnings are produced
when the activity level schedule values fall outside normal ranges. Having too low or too high
values can also skew thermal comfort reporting values.
Field: Carbon Dioxide Generation Rate
This numeric input field specifies carbon dioxide generation rate per person with units of
m3/s-W. The total carbon dioxide generation rate from this object is:
Number of People * People Schedule * People Activity * Carbon Dioxide Generation Rate.
The default value is 3.82E-8 m3/s-W (obtained from ASHRAE Standard 62.1-2007 value at
0.0084 cfm/met/person over the general adult population). The maximum value can be 10
times the default value.
Field: Enable ASHRAE 55 comfort warnings
This field accepts either Yes or No as values. When Yes is specified, warnings are
generated when the space conditions are outside of the ASHRAE 55 comfort range as
discussed in the sections that follow titled Simplified ASHRAE 55-2004 Graph Related
Outputs and Simplified ASHRAE 55 Warnings. The default is not to provide these warnings
so if you want to know if your space is outside this comfort range you must set this field to
Yes.
Table 11. Metabolic Rates for Various Activities
Activity

Activity Level
W/Person
EnergyPlus
Schedule
Value

Activity Level
W/m2

met*

Resting

9/29/14

Sleeping

72

40

0.7

Reclining

81

45

0.8

349

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

Activity

Activity Level
W/Person
EnergyPlus
Schedule
Value

Activity Level
W/m2

met*

Seated, quiet

108

60

Standing, relaxed

126

70

1.2

3.2 km/h (0.9 m/s)

207

115

4.3 km/h (1.2 m/s)

270

150

2.6

6.4 km/h (1.8 m/s)

396

220

3.8

Reading, seated

99

55

Writing

108

60

Typing

117

65

1.1

Filing, seated

126

70

1.2

Filing, standing

144

80

1.4

Walking about

180

100

1.7

Lifting/packing

216

120

2.1

Walking (on level surface)

Office Activities

Miscellaneous Occupational Activities

Cooking

171 to 207

95 to 115

1.6 to 2.0

Housecleaning

207 to 360

115 to 200

2.0 to 3.4

Seated, heavy limb

movement

234

130

2.2

sawing (table saw)

189

105

1.8

light (electrical industry)

207 to 252

115 to 140

2.0 to 2.4

heavy

423

235

Handling 50 kg bags

423

235

Pick and shovel work

423 to 504

235 to 280

4.0 to 4.8

Dancing, social

252 to 459

140 to 255

2.4 to 4.4

Calisthenics/exercise

315 to 423

175 to 235

3.0 to 4.0

Tennis, singles

378 to 486

210 to 270

3.6 to 4.0

Basketball

522 to 792

290 to 440

5.0 to 7.6

Wrestling, competitive

738 to 909

410 to 505

7.0 to 8.7

Machine work

Miscellaneous Leisure Activities

*Note that one met = 58.1 W/m

Field: Mean Radiant Temperature Calculation Type

This field specifies the type of Mean Radiant Temperature (MRT) calculation the user wishes
to use for the thermal comfort model. At the present time, there are two options for MRT
calculation type: zone averaged and surface weighted. The default calculation is
ZoneAveraged. In the zone averaged MRT calculation, the MRT used for the thermal
comfort calculations is for an average point in the zone. MRT is calculated based on an
9/29/14

350

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

area-emissivity weighted average of all of the surfaces in the zone. In cases where the
emissivity of all of the surfaces are sufficiently small (near zero), the mean radiant
temperature will be set to the mean air temperature of the space to avoid divide by zero
errors. The other MRT calculation type is SurfaceWeighted. The goal of this calculation type
is to estimate a person in the space close to a particular surface without having to define
exact view factors for all of the surfaces and the location of the person in the space. The MRT
used in the thermal comfort calculations when the surface weighted calculation type is
selected is actually the average of the temperature of the surface to which the person is
closest (defined by the next field Surface Name) and the zone averaged MRT (defined
above). The surface temperature alone is not used because in theory the maximum view
factor from a person to any flat surface is roughly 0.5. In the surfaceweighted calculation,
the surface in question actually gets slightly more weighting than 50% since the surface
selected is still a part of the zone average MRT calculation. Again, this simplification was
made to avoid the specification of view factors and the exact location of the person.
A third option is to use anglefactor. This option allows for more explicit positioning of the
person within the space by defining the angle factors from the person to the various surfaces
in the zone. This option requires the user to list the surfaces that the person can see from a
radiation standpoint and also define the angle (or view) factor for each surface. The
AngleFactorList object (see next object description) is intended to give the user this
opportunity.
Field: Surface Name/Angle Factor List Name
This field is only valid when the user selects surfaceweighted for the MRT calculation type
(see the previous input field description). In this case, the field is the name of a surface within
the zone the people are residing. This surface will be used in the MRT calculation as defined
above to come up with a more representative MRT for a person near a particular surface.
The MRT used for thermal comfort calculations using the surface weighted MRT calculation
method is the average of the temperature of the surface specified in this field and the zone
averaged MRT (see the Mean Radiant Temperature calculation type field above).
Field: Work Efficiency Schedule Name
This field is the name of the schedule that determines the efficiency of energy usage within
the human body that will be used for thermal comfort calculations. Note that all energy
produced by the body is assumed to be converted to heat for the zone heat balance
calculation. A value of zero corresponds to all of the energy produced in the body being
converted to heat. A value of unity corresponds to all of the energy produced in the body
being converted to mechanical energy. The values for this parameter defined in the schedule
must be between 0.0 and 1.0. Any value greater than zero will result in a reduction of heat
that impacts the thermal comfort energy balance of a person within the space, resulting in
PMV results appearing lower than expected. Ensure that if this value is non-zero, the base
activity level is chosen to ensure that the net activity converted to heat and zone conditions
are sufficient to maintain thermal comfort..
Field: Clothing Insulation Calculation Method
This field is a key/choice field that tells which of the next two fields are filled and is descriptive
of the method for calculating the clothing insulation value of occupants (people) in the Zone.
The key/choices are:
ClothingInsulationSchedule
With this choice, the method used will be a straight insertion of the scheduled clothing
insulation values of occupants (people). (The Clothing Insulation Schedule Name
field should be filled.)
DynamicClothingModelASHRAE55
With this choice, the method used will be the dynamic predictive clothing insulation model
developed by Schiavon and Lee (2013) based on 6,333 selected observations taken
9/29/14

351

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

from ASHRAE RP-884 and RP-921 databases. It varies the clothing insulation as a
function of outdoor air temperature measured at 6am as illustrated below.
CalculationMethodSchedule
With this choice, the method used can be either the ClothingInsulationSchedule or the
DynamicClothingModelASHRAE55, depending on a schedule (to be entered as the
next field) that determines which method to use in different time of a day. When this
option is chosen, the next field Clothing Insulation Calculation Method Schedule
Name is a required input.

Figure 48. Graphical representation fo the dynamic predictive clothing insulation model
Field: Clothing Insulation Calculation Method Schedule Name
This field specifies which clothing insulation method (ClothingInsulationSchedule or
DynamicClothingModelASHRAE55) to use at a particular time of the day. A schedule value of
1
means
the
ClothingInsulationSchedule
method,
and
2
means
the
DynamicClothingModelASHRAE55 method. This field is only required when the Clothing
Insulation Calculation Method field is set to CalculationMethodSchedule. If this field is left
blank, the specified clothing insulation calculation method will be used and not changed
during the simulation.
Field: Clothing Insulation Schedule Name
This field is the name of the schedule that defines the amount of clothing being worn by a
typical zone occupant during various times in the simulation period. The choice from the
Clothing Insulation Calculation Method field should be ClothingInsulationSchedule. This
parameter must be a positive real number and has units of Clo. Typical values for Clo can be
seen in the ASHRAE 2009 HOF Table 7, page 9.8 (for clothing ensembles) and Table 8,
page 9.9 (for garment values) ) or www.cbe.berkeley.edu/comforttool/.
Field: Air Velocity Schedule Name
This field is the name of the schedule that approximates the amount of air movement in the
space as a function of time throughout the simulation period. The user has control over this
parameter through the schedule that requires the individual numbers in the schedule to be
positive real numbers having units of meters per second.
Field: Thermal Comfort Model Type (up to 5 allowed)
The final one to five fields are optional and are intended to trigger various thermal comfort
models within EnergyPlus. By entering the keywords Fanger, Pierce, KSU, AdaptiveASH55,,
and AdaptiveCEN15251, the user can request the Fanger, Pierce Two-Node, Kansas State
9/29/14

352

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

UniversityTwo-Node, and the adaptive comfort models of the ASHRAE Standard 55 and CEN
Standard 15251 results for this particular people statement. Note that since up to five models
may be specified, the user may opt to have EnergyPlus calculate the thermal comfort for
people identified with this people statement using all five models if desired. Note that the KSU
model is computationally intensive and may noticeably increase the execution time of the
simulation. For descriptions of the thermal comfort calculations, see the Engineering
Reference document.
The following IDF example allows for a maximum of 31 people with scheduled occupancy of
Office Occupancy, 60% radiant using an Activity Schedule of Activity Sch. The example
allows for thermal comfort reporting.
People,
Kitchen_ZN_1_FLR_1, !- Name
Kitchen_ZN_1_FLR_1, !- Zone or ZoneList Name
BLDG_OCC_SCH, !- Number of People Schedule Name
People, !- Number of People Calculation Method
25.2000,,, !- Number of People, People per Zone Floor Area, Zone Floor
Area per Person
0.3000, !- Fraction Radiant
AUTOCALCULATE, !- Sensible Heat Fraction
ACTIVITY_SCH, !- Activity Level Schedule Name
3.82E-8
!- Carbon Dioxide Generation Rate {m3/s-W}
No, !- Enable ASHRAE 55 Comfort Warnings
ZoneAveraged, !- Mean Radiant Temperature Calculation Type
, !- Surface Name/Angle Factor List Name
WORK_EFF_SCH, !- Work Efficiency Schedule Name
CLOTHING_SCH, !- Clothing Insulation Schedule Name
AIR_VELO_SCH, !- Air Velocity Schedule Name
Fanger; !- Thermal Comfort Model 1 Type

A simpler example, without using the thermal comfort reporting option:

People,
RIGHT FORK,
RIGHT FORK,
Dorm Occupancy,
people,
8.00000,
,
,
0.6000000,
Autocalculate,
Activity Sch,

!!!!!!!!!!-

Name
Zone or ZoneList Name
Number of People Schedule Name
Number of People Calculation Method
Number of People,
People per Zone Floor Area
Zone Floor Area per Person
Fraction Radiant
Sensible Heat Fraction
Activity level Schedule Name

And with the sensible fraction specified:

People,
SPACE1-1 People 1,
SPACE1-1,
OCCUPY-1,
people,
11,
,
,
0.3,
0.55,
ActSchd;

!!!!!!!!!!-

Name
Zone or ZoneList Name
Number of People Schedule Name
Number of People Calculation Method
Number of People
People per Zone Floor Area
Zone Floor Area per Person
Fraction Radiant
Sensible Heat Fraction
Activity level Schedule Name

Global People Object:

ZoneList,AllOccupiedZones,SPACE1-1,SPACE2-1,SPACE3-1,SPACE4-1,SPACE5-1;
People,
AllZones with People,
AllOccupiedZones,
9/29/14

!- Name
!- Zone or ZoneList Name
353

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

OCCUPY-1,
People/Area,
,
.11,
,
0.3,
,
ActSchd;

!!!!!!!!-

Number of People Schedule Name

Number of People Calculation Method
Number of People
People per Zone Floor Area {person/m2}
Zone Floor Area per Person {m2/person}
Fraction Radiant
Sensible Heat Fraction
Activity Level Schedule Name

People Outputs
People objects have output variables for individual objects and for zone totals.
People specific outputs include:
Zone,Average,People Occupant Count []
Zone,Sum,People Radiant Heating Energy [J]
Zone,Average,People Radiant Heating Rate [W]
Zone,Sum,People Convective Heating Energy [J]
Zone,Average,People Convective Heating Rate [W]
Zone,Sum,People Sensible Heating Energy [J]
Zone,Average,People Sensible Heating Rate [W]
Zone,Sum,People Latent Gain Energy [J]
Zone,Average,People Latent Gain Rate [W]
Zone,Sum,People Total Heating Energy [J]
Zone,Average,People Total Heating Rate [W]
Zone,Average,Zone People Occupant Count []
Zone,Sum,Zone People Radiant Heating Energy [J]
Zone,Average,Zone People Radiant Heating Rate [W]
Zone,Sum,Zone People Convective Heating Energy [J]
Zone,Average,Zone People Convective Heating Rate [W]
Zone,Sum,Zone People Sensible Heating Energy [J]
Zone,Average,Zone People Sensible Heating Rate [W]
Zone,Sum,Zone People Latent Gain Energy [J]
Zone,Average,Zone People Latent Gain Rate [W]
Zone,Sum,Zone People Total Heating Energy [J]
Zone,Average,People Air Temperature [C]
Zone,Average,People Air Relative Humidity [%]
Zone,Average,Zone People Total Heating Rate [W]
Zone,Average,Zone Thermal Comfort Mean Radiant Temperature [C]
Zone,Average,Zone Thermal Comfort Operative Temperature [C]
Zone,Average,Zone Thermal Comfort Fanger Model PMV []
Zone,Average,Zone Thermal Comfort Fanger Model PPD [%]
Zone,Average,Zone Thermal Comfort Clothing Surface Temperature [C]
Zone,Average,Zone Thermal Comfort Pierce Model Effective Temperature PMV []
Zone,Average,Zone Thermal Comfort Pierce Model Standard Effective Temperature PMV []
Zone,Average,Zone Thermal Comfort Pierce Model Discomfort Index []
Zone,Average,Zone Thermal Comfort Pierce Model Thermal Sensation Index []
Zone,Average,Zone Thermal Comfort KSU Model Thermal Sensation Index []
Zone,Average,Zone Thermal Comfort ASHRAE 55 Adaptive Model 80% Acceptability Status []
Zone,Average,Zone Thermal Comfort ASHRAE 55 Adaptive Model 90% Acceptability Status []
Zone,Average,Zone Thermal Comfort ASHRAE 55 Adaptive Model Running Average Outdoor Air Temperature [C]
Zone,Average,Zone Thermal Comfort ASHRAE 55 Adaptive Model Temperature [C]
Zone,Average,Zone Thermal Comfort CEN 15251 Adaptive Model Category I Status []
Zone,Average,Zone Thermal Comfort CEN 15251 Adaptive Model Category II Status []
Zone,Average,Zone Thermal Comfort CEN 15251 Adaptive Model Category III Status
Zone,Average,Zone Thermal Comfort CEN 15251 Adaptive Model Running Average Outdoor Air Temperature [C]
Zone,Average,Zone Thermal Comfort CEN 15251 Adaptive Model Temperature [C]

People Occupant Count []

This field is the number of people for this PEOPLE object during the timestep in question.
People Radiant Heating Rate [W]
People Radiant Heating Energy [J]
These output variables are the amount of radiant heat gain for this People object in Watts (for
rate) or Joules. This is determined by the current sensible heat gain from people to the zone

9/29/14

354

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

and the Fraction Radiant specified in the input. The radiant gains from people are
distributed to the surfaces using an area weighting scheme.
People Convective Heating Rate [W]
People Convective Heating Energy [J]
These output variables are the amount of convective heat gain for this People object in Watts
(for rate) or Joules. This is determined by the current sensible heat gain from people to the
zone and the Fraction Radiant specified in input. Note that the radiant and convective gains
should add up to the sensible heat gain from people. The convective heat gain from people is
added to the zone air heat balance directly.
People Latent Gain Rate [W]
People Latent Gain Energy [J]
These output variables are the amount of latent heat gain for this People object in Watts (for
rate) or Joules. This amount is based on the number of people in the space as well as the
total amount of energy produced by a typical person defined by the activity schedule in the
input. An internal algorithm is used to determine what fraction of the total is sensible and what
fraction is latent. Details about this split are included in the Engineering Reference document.
People Sensible Heating Rate [W]
People Sensible Heating Energy [J]
These output variables are the amount of sensible heat gain for this People object in Watts
(for rate) or Joules. This amount is based on the number of people in the space as well as the
total amount of energy produced by a typical person defined by the activity schedule in the
input. An internal algorithm (described in the Engineering Reference document) is used to
determine what fraction of the total is sensible and what fraction is latent. The sensible plus
the latent heat gain from people equals the total gain specified in the input.
People Total Heating Rate [W]
People Total Heating Energy [J]
These output variables are the total amount of heat gain for this People object in Watts (for
rate) or Joules. This is derived from the activity level times the number of occupants.
People Air Temperature [C]
This output variable represents the zone air temperature based on the Fanger thermal
comfort model. If there is a ZoneControl:Thermostat:ThermalComfort object specified and
the thermal zone is occupied, then the value of People Air Temperature is determined
based on the thermal comfort hat satisfies the thermal comfort setpoint PMV value specified;
othwesie, it is set to average zone air temperature.
People Air Relative Humidity [%]
This output variable represents the zone air relative humidity based on the Fanger thermal
comfort model. If there is a ZoneControl:Thermostat:ThermalComfort object specified and
the thermal zone is occupied, then the value of People Air Relative Humidity is determined
from the mean zone air temperature and zone air humidity ratio that satisfies the thermal
comfort setpoint PMV value specified; othwesie, it is calculated from the zone air temperature
and humidity ratio averaged over the time step.
Zone People Occupant Count []
This field is the total number of people within the zone during the timestep in question.

9/29/14

355

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

Zone People Radiant Heating Rate [W]

Zone People Radiant Heating Energy [J]
These output variables are the amount of radiant heat gain from people within the zone in
Watts (for rate) or Joules. This is determined by the current sensible heat gain from people to
the zone and the Fraction Radiant specified in the input. The radiant gains from people are
distributed to the surfaces using an area weighting scheme.
Zone People Convective Heating Rate [W]
Zone People Convective Heating Energy [J]
These output variables are the amount of convective heat gain from people within the zone in
Watts (for rate) or Joules. This is determined by the current sensible heat gain from people to
the zone and the Fraction Radiant specified in input. Note that the radiant and convective
gains should add up to the sensible heat gain from people. The convective heat gain from
people is added to the zone air heat balance directly.
Zone People Latent Gain Rate [W]
Zone People Latent Gain Energy [J]
These output variables are the amount of latent heat gain from people within the zone in
Watts (for rate) or Joules. This amount is based on the number of people in the space as well
as the total amount of energy produced by a typical person defined by the activity schedule in
the input. An internal algorithm is used to determine what fraction of the total is sensible and
what fraction is latent. Details about this split are included in the Engineering Reference
document.
Zone People Sensible Heating Rate [W]
Zone People Sensible Heating Energy [J]
These output variables are the amount of sensible heat gain from people within the zone in
Watts (for rate) or Joules. This amount is based on the number of people in the space as well
as the total amount of energy produced by a typical person defined by the activity schedule in
the input. An internal algorithm (described in the Engineering Reference document) is used to
determine what fraction of the total is sensible and what fraction is latent. The sensible plus
the latent heat gain from people equals the total gain specified in the input.
Zone People Total Heating Rate [W]
Zone People Total Heating Energy [J]
These output variables are the total amount of heat gain from people within the zone in Watts
(for rate) or Joules. Derived from the activity level times the number of occupants, this is
summed for each people object within a zone.
Zone Thermal Comfort Mean Radiant Temperature [C]
This output variable is the mean radiant temperature used in the thermal comfort calculations.
This value is computed according to the "MRT Calculation Type" specified in the PEOPLE
object. If a high temperature radiant system is present in the zone, this value will be adjusted
according to the current heater operation and the "Fraction of radiant energy incident on
people" specified in the HIGH TEMP RADIANT SYSTEM object.
Zone Thermal Comfort Operative Temperature [C]
This output variable is the operative temperature as defined by the thermal comfort
operations. Specifically, it is the average of the thermal comfort mean radiant temperature
and the zone air temperature.

9/29/14

356

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

Note for all Thermal Comfort reporting: Though the published values for thermal comfort vote have a
discrete scale (e.g. 3 to +3 or 4 to +4), the calculations in EnergyPlus are carried out on a continuous
scale and, thus, reporting may be off the scale with specific conditions encountered in the space. This is
not necessarily an error in EnergyPlus rather a different approach that does not take the limits of the
discrete scale values into account.

Zone Thermal Comfort Fanger Model PMV []

This field is the predicted mean vote (PMV) calculated using the Fanger thermal comfort
model.
Zone Thermal Comfort Fanger Model PPD [%]
This field is the predicted percentage of dissatisfied (PPD) calculated using the Fanger
thermal comfort model.
Zone Thermal Comfort Clothing Surface Temperature [C]
This output variable is the calculation of the clothing surface temperature using the Fanger
thermal comfort model.
Zone Thermal Comfort Pierce Model Effective Temperature PMV []
This field is the predicted mean vote (PMV) calculated using the effective temperature and
the Pierce two-node thermal comfort model.
Zone Thermal Comfort Pierce Model Standard Effective Temperature PMV []
This field is the predicted mean vote (PMV) calculated using the standard effective
temperature and the Pierce two-node thermal comfort model.
Zone Thermal Comfort Pierce Model Discomfort Index []
This field is the discomfort index calculated using the the Pierce two-node thermal comfort
model.
Zone Thermal Comfort Pierce Model Thermal Sensation Index []
This field is the thermal sensation index (PMV) calculated using the Pierce two-node
thermal comfort model.
Zone Thermal Comfort KSU Model Thermal Sensation Vote []
This field is the thermal sensation vote (TSV) calculated using the KSU two-node thermal
comfort model.
Zone Thermal Comfort ASHRAE 55 Adaptive Model 90% Acceptability Status []
This field is to report whether the operative temperature falls into the 90% acceptability limits
of the adaptive comfort in ASHRAE 55-2010. A value of 1 means within (inclusive) the limits,
a value of 0 means outside the limits, and a value of -1 means not applicable.
Zone Thermal Comfort ASHRAE 55 Adaptive Model 80% Acceptability Status [ ]
This field is to report whether the operative temperature falls into the 80% acceptability limits
of the adaptive comfort in ASHRAE 55-2010. A value of 1 means within (inclusive) the limits,
a value of 0 means outside the limits, and a value of -1 means not applicable.

9/29/14

357

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

Zone Thermal Comfort ASHRAE 55 Adaptive Model Running Average Outdoor Air
Temperature [C]
This field reports the mean monthly outdoor air temperature, an input parameter for the
ASHRAE-55 adaptive comfort model. This can be computed in two ways. If the .stat file is
provided for the simulation, this field will reflect the monthly daily average temperature.
If the .epw file is used, the field reports the simple running average of the daily average
outdoor dry-bulb temperatures of the previous 30 days.
Zone Thermal Comfort ASHRAE 55 Adaptive Model Temperature [C]
This field reports the ideal indoor operative temperature, or comfort temperature, as
determined by the ASHRAE-55 adaptive comfort model. The 80% acceptability limits for
indoor operative temperature are defined as no greater than 2.5 degrees C from the adaptive
comfort temperature. The 90% acceptability limits are defined as no greater than 3.5 degrees
C from the adaptive comfort temperature.
Zone Thermal Comfort CEN 15251 Adaptive Model Category I Status
This field is to report whether the operative temperature falls into the Category I (90%
acceptability) limits of the adaptive comfort in the European Standard EN15251-2007. A
value of 1 means within (inclusive) the limits, a value of 0 means outside the limits, and a
value of -1 means not applicable.
Zone Thermal Comfort CEN 15251 Adaptive Model Category II Status
This field is to report whether the operative temperature falls into the Category II (80%
acceptability) limits of the adaptive comfort in the European Standard EN15251-2007. A
value of 1 means within (inclusive) the limits, a value of 0 means outside the limits, and a
value of -1 means not applicable.
Zone Thermal Comfort CEN 15251 Adaptive Model Category III Status
This field is to report whether the operative temperature falls into the Category III (65%
acceptability) limits of the adaptive comfort in the European Standard EN15251-2007. A
value of 1 means within (inclusive) the limits, a value of 0 means outside the limits, and a
value of -1 means not applicable.
Zone Thermal Comfort CEN 15251 Adaptive Model Running Average Outdoor Air
Temperature
This field reports the weighted average of the outdoor air temperature of the previous five
days, an input parameter for the CEN-15251 adaptive comfort model.
Zone Thermal Comfort CEN 15251 Adaptive Model Temperature
This field reports the ideal indoor operative temperature, or comfort temperature, as
determined by the CEN-15251 adaptive comfort model. Category I, II, and II limits for indoor
operative temperature are defined as no greater than 2, 3, and 4 degrees C from this value
respectively.
Simplified ASHRAE 55-2004 Graph Related Outputs
The following output variables are all based on whether the humidity ratio and the operative
temperature is within the region shown in ASHRAE Standard 55-2004 in Figure 5.2.1.1. For
these outputs the operative temperature is simplified to be the average of the air temperature
and the mean radiant temperature. For summer, the 0.5 Clo level is used and, for winter, the
1.0 Clo level is used. The graphs below are based on the following tables which extend the
ASHRAE values to zero humidity ratio.
Table 12. Winter Clothes (1.0 Clo)

9/29/14

358

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

Operative
Temperature
(C)

Humidity Ratio
(kgWater/kgDryAir)

19.6

0.012

23.9

0.012

26.3

0.000

21.7

0.000

Winter (1.0 Clo)

0.014
0.012

Humidity Ratio

0.01
0.008
0.006
0.004
0.002
0
10

13

16

19

22

25

28

31

34

37

Operative Temperature (C)

Figure 49. Winter Comfort Range

Table 13. Summer Clothes (0.5 Clo)

9/29/14

Operative
Temperature
(C)

Humidity Ratio
(kgWater/kgDryAir)

23.6

0.012

26.8

0.012

28.3

0.000

25.1

0.000

359

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

Summer (0.5 Clo)

0.014
0.012

Humidity Ratio

0.01
0.008
0.006
0.004
0.002
0
10

13

16

19

22

25

28

31

34

37

Operative Temperature (C)

Figure 50. Summer Comfort Range

Zone Thermal Comfort ASHRAE 55 Simple Model Summer Clothes Not Comfortable
Time[hr]
The time when the zone is occupied that the combination of humidity ratio and operative
temperature is not in the ASHRAE 55-2004 summer clothes region (see above)
Zone Thermal Comfort ASHRAE 55 Simple Model Winter Clothes Not Comfortable Time[hr]
The time when the zone is occupied that the combination of humidity ratio and operative
temperature is not in the ASHRAE 55-2004 winter clothes region (see above)
Zone Thermal Comfort ASHRAE 55 Simple Model Summer or Winter Clothes Not
Comfortable Time[hr]
The time when the zone is occupied that the combination of humidity ratio and operative
temperature is not in the ASHRAE 55-2004 summer or winter clothes region (see above)
Facility Thermal Comfort ASHRAE 55 Simple Model Summer Clothes Not Comfortable
Time[hr]
The time when any zone is occupied that the combination of humidity ratio and operative
temperature is not in the ASHRAE 55-2004 summer clothes region (see above)
Facility Thermal Comfort ASHRAE 55 Simple Model Winter Clothes Not Comfortable Time
[hr]
The time when any zone is occupied that the combination of humidity ratio and operative
temperature is not in the ASHRAE 55-2004 winter clothes region (see above)
Facility Thermal Comfort ASHRAE 55 Simple Model Summer Clothes Not Comfortable
Time [hr]
The time when any zone is occupied that the combination of humidity ratio and operative
temperature is not in the ASHRAE 55-2004 summer or winter clothes region (see above)
Simplified ASHRAE 55 Warnings
The simplified ASHRAE 55 calculations may be computed for occupied zones and, possibly,
warnings are shown on the .err file at the end of each simulated environment. To enable this
option set the Enable ASHRAE 55 comfort warnings field of the People object to Yes.
These warnings will not be generated by default.

9/29/14

360

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

If you enable the warnings, the simplified ASHRAE 55 calculations are done for occupied
zones and, possibly, warnings are shown on the .err file at the end of each simulated
environment.
**
**
**
**
**
**
**
**
**
**
**
**

Warning
~~~
~~~
Warning
~~~
~~~
Warning
~~~
~~~
Warning
~~~
~~~

**
**
**
**
**
**
**
**
**
**
**
**

More than 4% of time (350.4 hours) uncomfortable in zone ZSF1

553.0 hours were uncomfortable based on ASHRAE 55-2004 graph (Section 5.2.1.1)
During Environment [10/01 - 09/30]: CHICAGO IL USA TMY2-94846 WMO#=725300
More than 4% of time (350.4 hours) uncomfortable in zone ZNF1
827.8 hours were uncomfortable based on ASHRAE 55-2004 graph (Section 5.2.1.1)
During Environment [10/01 - 09/30]: CHICAGO IL USA TMY2-94846 WMO#=725300
More than 4% of time (350.4 hours) uncomfortable in zone ZSF2
593.5 hours were uncomfortable based on ASHRAE 55-2004 graph (Section 5.2.1.1)
During Environment [10/01 - 09/30]: CHICAGO IL USA TMY2-94846 WMO#=725300
More than 4% of time (350.4 hours) uncomfortable in zone ZNF2
875.8 hours were uncomfortable based on ASHRAE 55-2004 graph (Section 5.2.1.1)
During Environment [10/01 - 09/30]: CHICAGO IL USA TMY2-94846 WMO#=725300

You may decide if you need to change parameters to reduce these uncomfortable hours.
The individual output variables shown previously may help you get more details on when
these are occurring.
Following are some suggestions that might be applicable:
Eliminate occupancy when conditioning equipment is off.
Note that the ASHRAE graph lower limit is (19.6C to 21.7C) heating setpoints may
need to be nearer 22.2C (72F) than 21.1C (70F).
Unoccupied heating setpoint should be nearer 16.7C (62F) rather than 12.8C (55F) to
reduce the start up recovery.
Start the occupied setpoint schedule, fan availability schedule, cooling pump availability
schedule, reheat coil availability, one hour before occupancy. Seasonal turn on and off of
equipment may cause more warnings (but potentially more energy consumption).
Unoccupied cooling setpoint should be nearer 29.4C (85F) rather than 40.0 (104F) to
reduce the start up recovery.
ComfortViewFactorAngles
When requesting EnergyPlus to do a thermal comfort calculation, the program user has three
options for defining how the mean radiant temperature will be calculated. The user may
select zoneaveraged which results in a mean radiant temperature that is characteristic of an
average location near the center of the zone. The user may also elect to place the person
near a particular surface by selecting surfaceweighted in the People statement. This takes
the average of the zone mean radiant temperature and the temperature of the surface that
the person is near and uses this value as the mean radiant temperature when calculating
thermal comfort.
The third option is for the user to more explicitly position the person within the space by
defining the angle factors from the person to the various surfaces in the zone. This option
requires the user to list the surfaces that the person can see from a radiation standpoint and
also define the angle (or view) factor for each surface. The AngleFactorList input line is
intended to give the user this opportunity.
Field: Name
This field is an unique user assigned name for the list of surfaces that can be seen radiantly
by the person for whom thermal comfort is to be evaluated. Any reference to this list by a
People statement will use this name.
Field: Zone Name
Zone Name for this surface list. Each of the surfaces listed must be in this zone.

9/29/14

361

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

Field: Surface <#> Name

This field is the name of a surface in the zone seen by the person.
Field: Angle Factor <#>
This field is the fraction that this surface contributes to the total mean radiant temperature.
This can be thought of as a weighting factor for this surface and the actual mean radiant
temperature used in the thermal comfort model is simply the sum of all angle factors
multiplied by the corresponding inside surface temperature. Note that the Surface
Name/Angle Factor pair can be repeated up to 20 times. The sum of all angle factors within
any angle factor list must equal unity, otherwise the program will not accept the input as valid.
An example IDF with an electric low temperature radiant system is shown below.
ComfortViewFactorAngles,
South Zone Angle Factors,
Sourth Zone,
Zn001:Flr001,
0.75,
Zn001:Wall001,
0.15,
Zn001:Roof001,
0.10;

!!!!!!!!-

name of angle factor list

Zone Name
Surface name 1
Angle factor for surface 1
Surface name 2
Angle factor for surface 2
Surface name 3
Angle factor for surface 3

Lights
The Lights statement allows you to specify information about a zones electric lighting
system, including design power level and operation schedule, and how the heat from lights is
distributed thermally.
A zone may have multiple Lights statements. For example, one statement may describe the
general lighting in the zone and another the task lighting. Or you can use multiple Lights
statements for a zone that has two or more general lighting systems that differ in design level,
schedule, etc.
Field: Name
The name of the Lights object.
Field: Zone or ZoneList Name
The field is the name of the thermal zone (ref: Zone) or ZoneList (ref: ZoneLIst) and links this
Lights statement to a thermal zone or set of thermal zones in the buidling. When the ZoneList
option is used then this lights definition is applied to each of the zones in the zone list
effecting a global definition for the amount of light wattage in the zone. The Zonelist option
can be used effectively with the watts/area and watts/person options of the Design Level
Calculation Method.
The name of the actual lights object becomes <Zone Name> <Lights Object Name> and
should be less than the standard length (100 characters) for a name field. If it is greater than
this standard length, it may be difficult to specify in output reporting as it will be truncated. A
warning will be shown if the generated name is greater than 100 characters. If it duplicates
another such concatenated name, there will be a severe error and terminate the run.
Field: Schedule Name
The name of the schedule that modifies the lighting power design level (see Design Level
Calculation Method field and related subsequent fields). The schedule values can be any
positive number. The electrical input for lighting in a particular timestep is the product of the
design level and the value of this schedule in that timestep. If the design level is the
maximum lighting power input the schedule should contain values between 0.0 and 1.0.

9/29/14

362

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

Field: Design Level Calculation Method

This field is a key/choice field that tells which of the next three fields are filled and is
descriptive of the method for calculating the nominal lighting level in the Zone. The
key/choices are:
LightingLevel
With this choice, the method used will be a straight insertion of the lighting level (Watts) for
the Zone. (The Lighting Level field should be filled.)
Watts/Area
With this choice, the method used will be a factor per floor area of the zone. (The Watts per
Zone Floor Area field should be filled).
Watts/Person
With this choice, the method used will be a factor of lighting level (watts) per person. (The
Watts per person field should be filled).
Field: Lighting Level
This is typically the maximum electrical power input (in Watts) to lighting in a zone, including
ballasts, if present. This value is multiplied by a schedule fraction (see previous field) to get
the lighting power in a particular timestep. In EnergyPlus, this is slightly more flexible in that
the lighting design level could be a diversity factor applied to a schedule of real numbers.
Field: Watts per Zone Floor Area
This factor (watts/m2) is used, along with the Zone Floor Area to determine the maximum
lighting level as described in the Lighting Level field. The choice from the method field should
be watts/area.
Field: Watts per Person
This factor (watts/person) is used, along with the number of occupants (people) to determine
the maximum lighting level as described in the Lighting Level field. The choice from the
method field should be watts/person.
Heat Gains from Lights:
The electrical input to lighting ultimately appears as heat that contributes to zone loads or to
return air heat gains. In EnergyPlus this heat is divided into four different fractions. Three of
these are given by the input fields Return Air Fraction, Fraction Radiant and Fraction Visible.
A fourth, defined as the fraction of the heat from lights convected to the zone air, is calculated
by the program as:
fconvected = 1.0 (Return Air Fraction + Fraction Radiant + Fraction Visible)
You will get an error message if Return Air Fraction + Fraction Radiant + Fraction Visible
exceeds 1.0.
These fractions depend on the type of lamp and luminaire, whether the luminaire is vented to
the return air, etc.
Field: Return Air Fraction
The fraction of the heat from lights that goes into the zone return air (i.e., into the zone outlet
node). If the return air flow is zero or the zone has no return air system, the program will put
this fraction into the zone air. Return Air Fraction should be non-zero only for luminaires that
are return-air ducted (see Table 14 and Figure 51). (However, see the field Return Air
Fraction Is Calculated from Plenum Temperature, below, for an approach to modeling the
case where Return Air Fraction is caused by conduction between a luminaire that is in
contact with a return-air plenum.)

9/29/14

363

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

Field: Fraction Radiant

The fraction of heat from lights that goes into the zone as long-wave (thermal) radiation. The
program calculates how much of this radiation is absorbed by the inside surfaces of the zone
according the area times thermal absorptance product of these surfaces.
Field: Fraction Visible
The fraction of heat from lights that goes into the zone as visible (short-wave) radiation. The
program calculates how much of this radiation is absorbed by the inside surfaces of the zone
according the area times solar absorptance product of these surfaces.
Approximate values of Return Air Fraction, Fraction Radiant and Fraction Visible are given in
Table 14 for overhead fluorescent lighting for the luminaire configurations shown in Figure 51.
Table 14. Approximate values of Return Air Fraction, Fraction Radiant and Fraction Visible for overhead
fluorescent lighting for different luminaire configurations. These values assume that no light heat goes
into an adjacent zone. Source: Lighting Handbook: Reference & Application, 8th Edition, Illuminating
Engineering Society of North America, New York, 1993, p. 355.
Field Name

Luminaire Configuration, Fluorescent Lighting

Suspended

Surface
mount

Recessed

Luminous
and louvered
ceiling

Return-air
ducted

0.0

0.0

0.0

0.0

0.54

Fraction Radiant

0.42

0.72

0.37

0.37

0.18

Fraction Visible

0.18

0.18

0.18

0.18

0.18

fconvected

0.40

0.10

0.45

0.45

0.10

Return
Fraction

Air

Suspended

Surface Mount

Luminous and
Louvered Ceiling

Recessed

Return-Air Ducted

Figure 51. Overhead fluorescent luminaire configurations.

Field: Fraction Replaceable
This field defines the daylighting control for the LIGHTS object.

9/29/14

364

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

If Daylighting:Controls or Daylighting:DELight:Controls is specified for the zone, this field

is used as an on/off flag for dimming controls. If set to 0.0, the lights are not dimmed by the
daylighting controls. If set to 1.0, the lights are allowed to be dimmed by the daylighting
controls.
Field: End-Use Subcategory
Allows you to specify a user-defined end-use subcategory, e.g., "Task Lights", "Hall Lights",
etc. A new meter for reporting is created for each unique subcategory (ref: Output:Meter
objects). Subcategories are also reported in the ABUPS table. If this field is omitted or blank,
the lights will be assigned to the "General" end-use subcategory.
Field: Return Air Fraction Calculated from Plenum Temperature
Accepts values Yes or No (the default). Yes is for advanced used only. In this case the
program will calculate the return air fraction by assuming that it is due to conduction of some
of the light heat into the zones return air plenum and that the amount of the conduction
depends on the plenum air temperature. A Yes value should only be used for luminaires that
are recessed and non-vented, as shown in Figure 52.
The value you enter for the Return Air Fraction field will be ignored and you can enter, for
fluorescent lighting, Fraction Radiant = 0.37 and Fraction Visible = 0.18, as indicated in Table
14.
This feature requires that the coefficients described below be determined from
measurements or detailed calculations since they are very sensitive to the luminaire type,
lamp type, thermal resistance between fixture and plenum, etc.
If Return Air Fraction Is Calculated from Plenum Temperature = Yes, the return air fraction
is calculated each timestep from the following empirical correlation:
(Return Air Fraction)calculated = C1 C2 x Tplenum
where Tplenum is the previous-time-step value of the return plenum air temperature (C),
and C1 and C2 are the values of the coefficients entered in the next two fields.
To compensate for the change in the return air fraction relative to its input value, the program
modifies Fraction Radiant and fconvected by a scale factor such that
(Return Air Fraction)calculated + (Fraction Radiant)modified + (fconvected)modified + (Fraction
Visible)input = 1.0
It is assumed that Fraction Visible is a constant equal to its input value.
Field: Return Air Fraction Function of Plenum Temperature Coefficient 1
The coefficient C1 in the equation for (Return Air Fraction)calculated.
Field: Return Air Fraction Function of Plenum Temperature Coefficient 2
The coefficient C2 in the equation for (Return Air Fraction)calculated. Its units are 1/OC.

9/29/14

365

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

ReturnAirFraction

Return air plenum

Ceiling

Recessed, non-vented
lighting fixture and lamps
FractionRadiant
FractionVisible
FractionConvected

Zone

Figure 52. Vertical section through a zone and its return air plenum showing recessed lighting (not to
scale). The heat from lights is divided into four fractions, three of whichReturnAirFraction,
FractionRadiant and FractionConvecteddepend on plenum air temperature.
An IDF example:
Lights,
RIGHT FORK Lights 1,
RIGHT FORK,
Office Lighting,
LightingLevel,
1039.706,,,
0.0000000E+00,
0.4000000,
0.2000000,
1.0,
GeneralLights;

!- Name
!- Zone Name
!- SCHEDULE Name
!- Design Level calculation method
!- Lighting Level {W}
!- Return Air Fraction
!- Fraction Radiant
!- Fraction Visible
!- Fraction Replaceable
!- End-Use Subcategory

Global Lights Object:

ZoneList,AllOccupiedZones,SPACE1-1,SPACE2-1,SPACE3-1,SPACE4-1,SPACE5-1;
Lights,
AllZones with Lights,
AllOccupiedZones,
LIGHTS-1,
Watts/Area,
,
16,
,
0.2,
0.59,
0.2,
0,
GeneralLights;

9/29/14

!!!!!!!!!!!-

!- Name
Zone or ZoneList Name
Schedule Name
Design Level Calculation Method
Lighting Level {W}
Watts per Zone Floor Area {W/m2}
Watts per Person {W/person}
Return Air Fraction
Fraction Radiant
Fraction Visible
Fraction Replaceable
End-Use Subcategory

366

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

Lights Report Outputs

If daylighting controls are operating in the zone, all of the Lights objects with a Fraction
Replaceble greater than zero will be reduced by a multiplicative factor that accounts for how
much the electric lighting is lowered due to daylighting.
Lights objects have output variables for individual objects and for zone totals.
Zone,Average,Lights Electric Power [W]
Zone,Sum,Lights Radiant Heat Gain [J]
Zone,Average,Lights Radiant Heating Rate [W]
Zone,Sum,Lights Visible Radiation Heating Energy [J]
Zone,Average,Lights Visible Radiation Heating Rate [W]
Zone,Sum,Lights Convective Heating Energy [J]
Zone,Average,Lights Convective Heating Rate [W]
Zone,Sum,Lights Return Air Heating Energy [J]
Zone,Average,Lights Return Air Heating Rate [W]
Zone,Sum,Lights Total Heating Energy [J]
Zone,Average,Lights Total Heating Rate [W]
Zone,Sum,Lights Electric Energy [J]
Zone,Average,Zone Lights Electric Power [W]
Zone,Sum,Zone Lights Radiant Heating Energy [J]
Zone,Average,Zone Lights Radiant Heating Rate [W]
Zone,Sum,Zone Lights Visible Radiation Heating Energy [J]
Zone,Average,Zone Lights Visible Radiation Heating Rate [W]
Zone,Sum,Zone Lights Convective Heating Energy [J]
Zone,Average,Zone Lights Convective Heating Rate [W]
Zone,Sum,Zone Lights Return Air Heating Energy [J]
Zone,Average,Zone Lights Return Air Heating Rate [W]
Zone,Sum,Zone Lights Total Heating Energy [J]
Zone,Average,Zone Lights Total Heating Rate [W]
Zone,Sum,Zone Lights Electric Energy [J]

Lights Electric Power [W]

The electric power input for the lights.
Lights Radiant Heating Rate [W]
Lights Radiant Heating Energy [J]
The amount of heat gain from lights that is in the form of long-wave (thermal) radiation
entering the zone. This heat is absorbed by the inside surfaces of the zone according to an
area times long-wave absorptance weighting scheme.
Lights Visible Radiation Heating Rate [W]
Lights Visible Radiation Heating Energy [J]
The amount of heat gain from lights that is in the form of visible (short-wave) radiation
entering the zone. This heat is absorbed by the inside surfaces of the zone according to an
area times short-wave absorptance weighting scheme.
Lights Convective Heating Rate [W]
Lights Convective Heating Energy [J]
The amount of heat gain from lights that is convected to the zone air.
Lights Return Air Heating Rate [W]
Lights Return Air Heating Energy [J]
The amount of heat gain from lights that goes into the zones return air (and, therefore, does
not directly contribute to the zone load). If the zone has no return air system or the zones air
system is off, this heat will be added to the zone air.

9/29/14

367

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

Lights Total Heating Rate [W]

Lights Total Heating Energy [J]
The total heat gain from lights. It is the sum of the following four outputs, i.e., Total Heat Gain
= Return Air Heat Gain + Radiant Heat Gain + Visible Heat Gain + Convective Heat Gain. It is
also equal to the electrical input to the lights.
Lights Electric Energy [J]
The lighting electrical consumption including ballasts, if present. These will have the same
value as Lights Total Heating Energy (above).
Zone Lights Electric Power [W]
The electric power input for all lights in the zone.
Zone Lights Radiant Heating Rate [W]
Zone Lights Radiant Heating Energy [J]
The amount of heat gain from all lights in the zone that is in the form of long-wave (thermal)
radiation entering the zone. This heat is absorbed by the inside surfaces of the zone
according to an area times long-wave absorptance weighting scheme.
Zone Lights Visible Radiation Heating Rate [W]
Zone Lights Visible Radiation Heating Energy [J]
The amount of heat gain from all lights in the zone that is in the form of visible (short-wave)
radiation entering the zone. This heat is absorbed by the inside surfaces of the zone
according to an area times short-wave absorptance weighting scheme.
Zone Lights Convective Heating Rate [W]
Zone Lights Convective Heating Energy [J]
The amount of heat gain from all lights in the zone that is convected to the zone air.
Zone Lights Return Air Heating Rate [W]
Zone Lights Return Air Heating Energy [J]
The amount of heat gain from all lights in the zone that goes into the zones return air (and,
therefore, does not directly contribute to the zone load). If the zone has no return air system
or the zones air system is off, this heat will be added to the zone air.
Zone Lights Total Heating Rate [W]
Zone Lights Total Heating Energy [J]
The total heat gain from all lights in the zone. It is the sum of the following four outputs, i.e.,
Total Heat Gain = Return Air Heat Gain + Radiant Heat Gain + Visible Heat Gain +
Convective Heat Gain. It is also equal to the electrical input to the lights.
Zone Lights Electric Energy [J]
The lighting electrical consumption for all lights in the zone including ballasts, if present. This
will have the same value as Zone Lights Total Heating Energy (above). However, this amount
is also shown in the Electricity meters that are associated with the zone:
Electricity:Facility,
Electricity:Building,
Electricity:Zone:<Zone Name>.
In addition, depending on use, it will be shown in:
InteriorLights: Electricity and
InteriorLights:Electricity:Zone :<Zone Name>.
9/29/14

368

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

Meters for Lights Outputs

As described in the Lights Outputs, values for lights will show up on the following meters:
Table 15. Distribution of Lights to Meters
Meter Name
Electricity:Facility
Electricity:Building
Electricity:Zone:<Zone Name>
InteriorLights:Electricity
InteriorLights:Electricity:Zone:<Zone Name>
<End-Use
Subcategory>:InteriorLights:Electricity

Scope
Entire Facility
All Zones
Specific Zone
All Zones
Specific Zone
Specific
Subcategory

Lights Specfics
All
All
All
Lights Use
Lights Use
Lights Use

ElectricEquipment
The object models equipment in the zone which consumes electricity, such as computers,
televisions, and cooking equipment, also known as plug loads. All of the energy consumed
by the equipment becomes a heat gain in the zone or is lost (exhausted) as specified below.
Field: Name
The name of the ElectricEquipment object.
Field: Zone or ZoneList Name
This field is the name of the zone (ref: Zone) or ZoneList (ref: ZoneList) and attaches a
particular electric equipment statement to a thermal zone or set of thermal zones in the
building. When the ZoneList option is used then this electric equipment definition is applied to
each of the zones in the zone list effecting a global definition for the amount of electric
wattage in the zone. The Zonelist option can be used effectively with the watts/area and
watts/person options of the Design Level Calculation Method.
The name of the actual electric equipment object becomes <Zone Name>
<ElectricEquipment Object Name> and should be less than the standard length (100
characters) for a name field. If it is greater than this standard length, it may be difficult to
specify in output reporting as it will be truncated. A warning will be shown if the generated
name is greater than 100 characters. If it duplicates another such concatenated name, there
will be a severe error and terminate the run.
Field: Schedule Name
This field is the name of the schedule that modifies the design level parameter for electric
equipment (see Design Level Calculation Method field and related subsequent fields). The
schedule values can be any positive number. The actual electrical input for equipment in a
zone as defined by this statement is the product of the design level field and the value of the
schedule specified by name in this field.
Field: Design Level Calculation Method
This field is a key/choice field that tells which of the next three fields are filled and is
descriptive of the method for calculating the nominal electric equipment level in the Zone. The
key/choices are:
EquipmentLevel
With this choice, the method used will be a straight insertion of the electric equipment level
(Watts) for the Zone. (The Design Level field should be filled.)
Watts/Area

9/29/14

369

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

With this choice, the method used will be a factor per floor area of the zone. (The Watts per
Zone Floor Area field should be filled).
Watts/Person
With this choice, the method used will be a factor of equipment level (watts) per person. (The
Watts per Person field should be filled).
Field: Design Level
This field (in Watts) is typically used to represent the maximum electrical input to equipment
in a zone that is then multiplied by a schedule fraction (see previous field). In EnergyPlus, this
is slightly more flexible in that the electric equipment design level could be a diversity factor
applied to a schedule of real numbers. Note that while the schedule value can vary from hour
to hour, the design level field is constant for all simulation environments.
Field: Watts per Zone Floor Area
This factor (watts/m2) is used, along with the Zone Area to determine the maximum
equipment level as described in the Design Level field. The choice from the method field
should be Watts/Area.
Field: Watts per Person
This factor (watts/person) is used, along with the number of occupants (people) to determine
the maximum equipment level as described in the Design Level field. The choice from the
method field should be Watts/Person.
Heat Gains from Electric Equipment:
The electrical input to the equipment ultimately appears as heat that contributes to zone
loads. In EnergyPlus this heat is divided into four different fractions. Three of these are given
by the input fields Fraction Latent, Fraction Radiant and Fraction Lost. A fourth, defined as
the fraction of the heat from electric equipment convected to the zone air, is calculated by the
program as:
fconvected = 1.0 (Fraction Latent + Fraction Radiant + Fraction Lost)
You will get an error message if Fraction Latent + Fraction Radiant + Fraction Lost exceeds
1.0.
Field: Fraction Latent
This field is a decimal number between 0.0 and 1.0 and is used to characterize the amount of
latent heat given off by electric equipment in a zone. The number specified in this field will be
multiplied by the total energy consumed by electric equipment to give the amount of latent
energy produced by the electric equipment. This energy affects the moisture balance within
the zone.
Field: Fraction Radiant
This field is a decimal number between 0.0 and 1.0 and is used to characterize the amount of
long-wave radiant heat being given off by electric equipment in a zone. The number specified
in this field will be multiplied by the total energy consumed by electric equipment to give the
amount of long wavelength radiation gain from electric equipment in a zone.
Field: Fraction Lost
This field is a decimal number between 0.0 and 1.0 and is used to characterize the amount of
lost heat being given off by electric equipment in a zone. The number specified in this field
will be multiplied by the total energy consumed by electric equipment to give the amount of
heat which is lost and does not impact the zone energy balances. This might correspond to
electrical energy converted to mechanical work or heat that is vented to the atmosphere.

9/29/14

370

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

Field: End-Use Subcategory

Allows you to specify a user-defined end-use subcategory, e.g., "Computers", "Copy
Machines", etc. A new meter for reporting is created for each unique subcategory (ref:
Output:Meter objects). Subcategories are also reported in the ABUPS table. If this field is
omitted or blank, the equipment will be assigned to the "General" end-use subcategory.
An IDF example:
ElectricEquipment,
DORM ROOMS AND COMMON AREAS ElecEq 1, !- Name
DORM ROOMS AND COMMON AREAS, !- Zone Name
Residence Equipment,
!- SCHEDULE Name
EquipmentLevel,
!- Design Level calculation method
9210.921,
!- Design Level {W}
,
!- Watts per Zone Floor Area {watts/m2}
,
!- Watts per Person {watts/person}
0.0000000E+00,
!- Fraction Latent
0.3000000,
!- Fraction Radiant
0.0000000E+00,
!- Fraction Lost
Computers;
!- End-use Subcategory

Global ElectricEquipment example:

ZoneList,AllOccupiedZones,SPACE1-1,SPACE2-1,SPACE3-1,SPACE4-1,SPACE5-1;
ElectricEquipment,
AllZones with Electric Equipment,
!- Name
AllOccupiedZones,
!- Zone or ZoneList Name
EQUIP-1,
!- Schedule Name
Watts/Person,
!- Design Level Calculation Method
,
!- Design Level {W}
,
!- Watts per Zone Floor Area {W/m2}
96,
!- Watts per Person {W/person}
0,
!- Fraction Latent
0.3,
!- Fraction Radiant
0;
!- Fraction Lost

GasEquipment
The object models equipment in the zone which consumes natural gas, such as cooking
equipment or a gas fireplace. All of the energy consumed by the equipment becomes a heat
gain in the zone or is lost (exhausted) as specified below.
Field: Name
The name of the GasEquipment object.
Field: Zone or ZoneList Name
This field is the name of the thermal zone (ref: Zone) or ZoneList (ref: ZoneList) and attaches
a particular gas equipment statement to a thermal zone or set of thermal zones in the
building. When the ZoneList option is used then this gas equipment definition is applied to
each of the zones in the zone list effecting a global definition for the amount of gas in the
zone. The Zonelist option can be used effectively with the watts/area and watts/person
options of the Design Level Calculation Method.
The name of the actual gas equipment object becomes <Zone Name> <GasEquipment
Object Name> and should be less than the standard length (100 characters) for a name field.
If it is greater than this standard length, it may be difficult to specify in output reporting as it
will be truncated. A warning will be shown if the generated name is greater than 100
characters. If it duplicates another such concatenated name, there will be a severe error and
terminate the run.

9/29/14

371

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

Field: Schedule Name

This field is the name of the schedule that modifies the design level parameter for gas
equipment (see Design Level Calculation Method field and related subsequent fields). The
schedule values can be any positive number. The actual energy input for gas equipment in a
zone as defined by this statement is the product of the design level field and the value of the
schedule specified by name in this field.
Field: Design Level Calculation Method
This field is a key/choice field that tells which of the next three fields are filled and is
descriptive of the method for calculating the nominal gas equipment level in the Zone. The
key/choices are:
EquipmentLevel
With this choice, the method used will be a straight insertion of the gas equipment level
(Watts) for the Zone. (The Design Level field should be filled.)
Watts/Area or Power/Area
With this choice, the method used will be a factor per floor area of the zone. (The Power per
Zone Floor Area field should be filled).
Watts/Person or Power/Person
With this choice, the method used will be a factor of equipment level (watts) per person. (The
Power per Person field should be filled).
Field: Design Level
This field (in Watts) is typically used to represent the maximum energy input to gas
equipment in a zone that is then multiplied by a schedule fraction (see previous field). In
EnergyPlus, this is slightly more flexible in that the gas equipment design level could be a
diversity factor applied to a schedule of real numbers. Note that while the schedule value
can vary from hour to hour, the design level field is constant for all simulation environments.
Field: Power per Zone Floor Area
This factor (watts/m2) is used, along with the Zone Area to determine the maximum
equipment level as described in the Design Level field. The choice from the method field
should be Watts/Area or Power/Area.
Field: Power per Person
This factor (watts/person) is used, along with the number of occupants (people) to determine
the maximum equipment level as described in the Design Level field. The choice from the
method field should be Watts/Person or Power/Person.
Heat Gains from Gas Equipment:
The fuel input to the equipment ultimately appears as heat that contributes to zone loads. In
EnergyPlus this heat is divided into four different fractions. Three of these are given by the
input fields Fraction Latent, Fraction Radiant and Fraction Lost. A fourth, defined as the
fraction of the heat from gas equipment convected to the zone air, is calculated by the
program as:
fconvected = 1.0 (Fraction Latent + Fraction Radiant + Fraction Lost)
You will get an error message if Fraction Latent + Fraction Radiant + Fraction Lost exceeds
1.0.
Field: Fraction Latent
This field is a decimal number between 0.0 and 1.0 and is used to characterize the amount of
latent heat given off by gas equipment in a zone. The number specified in this field will be
multiplied by the total energy consumed by gas equipment to give the amount of latent

9/29/14

372

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

energy produced by the gas equipment. This energy affects the moisture balance within the
zone.
Field: Fraction Radiant
This field is a decimal number between 0.0 and 1.0 and is used to characterize the amount of
long-wave radiant heat being given off by gas equipment in a zone. The number specified in
this field will be multiplied by the total energy consumed by gas equipment to give the amount
of long wavelength radiation gain from gas equipment in a zone.
Field: Fraction Lost
This field is a decimal number between 0.0 and 1.0 and is used to characterize the amount of
lost heat being given off by gas equipment in a zone. The number specified in this field will
be multiplied by the total energy consumed by gas equipment to give the amount of heat
which is lost and does not impact the zone energy balances. This might correspond to input
energy converted to mechanical work or heat that is vented to the atmosphere.
Field: Carbon Dioxide Generation Rate
This numeric input field specifies carbon dioxide generation rate with units of m3/s-W. The
default value of 0.0 assumes the equipment is fully vented to outdoors. In the absence of
better information, the user might consider using a value of 3.45E-8 m3/s-W which assumes
the equipment is not vented to outdoors. This value is converted from natural gas CO 2
emission rate at 11.7 lbs CO2 per therm. The CO2 emission rate is provided by U.S. Energy
Information Administration, "Frequently Asked Questions - Environment, Questions About
Environmental
Emissions",
http://tonto.eia.doe.gov/ask/environment_faqs.asp#CO2_quantity,
January
2010.
The
maximum value for this input field is 3.45E-7 m3/s-W.
Field: End-Use Subcategory
Allows you to specify a user-defined end-use subcategory, e.g., "Cooking", "Clothes Drying",
etc. A new meter for reporting is created for each unique subcategory (ref: Output:Meter
objects). Subcategories are also reported in the ABUPS table. If this field is omitted or blank,
the equipment will be assigned to the "General" end-use subcategory.
An IDF example:
GasEquipment,
DORM ROOMS AND COMMON AREAS GasEq 1, !- Name
DORM ROOMS AND COMMON AREAS, !- Zone Name
Gas Eq Sch,
!- Schedule Name
EquipmentLevel,
!- Design Level Calculation Method
29287.51,
!- Design Level {W}
,
!- Power per Zone Floor Area {W/m2}
,
!- Power per Person {W/Person}
0,
!- Fraction Latent
0.3,
!- Fraction Radiant
0,
!- Fraction Lost
0,
!- Carbon Dioxide Generation Rate {m3/s-W}
Cooking;
!- End-Use Subcategory

Global Gas Equipment example:

ZoneList,OfficeZones,Left Fork, Middle Fork, Right Fork;
GasEquipment,
Office Zones with Gas Equipment,
!- Name
OfficeZones,
!- Zone Name
Gas Eq Sch,
!- Schedule Name
Watts/Area,
!- Design Level Calculation Method
,
!- Design Level {W}
197,
!- Power per Zone Floor Area {W/m2}
,
!- Power per Person {W/Person}
9/29/14

373

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

0.0000000E+00,
0.3000000,
0.0000000E+00;

!- Fraction Latent
!- Fraction Radiant
!- Fraction Lost

HotWaterEquipment
The object models hot water equipment in the zone which consumes district heating, such as
cooking equipment or process loads. All of the energy consumed by the equipment becomes
a heat gain in the zone or is lost (exhausted) as specified below. This object consumes
district heating energy directly and does not cause a load on a hot water plant loop or water
heater. For domestic hot water uses, such as sinks and showers, see WaterUse:Equipment.
Field: Name
The name of the HotWaterEquipment object.
Field: Zone or ZoneList Name
This field is the name of the thermal zone (ref: Zone) or ZoneList (ref: ZoneList) and attaches
a particular hot water equipment statement to a thermal zone or set of thermal zones in the
building. When the ZoneList option is used then this hot water equipment definition is applied
to each of the zones in the zone list effecting a global definition for the amount of hot water in
the zone. The Zonelist option can be used effectively with the watts/area and watts/person
options of the Design Level Calculation Method.
The name of the actual hot water equipment object becomes <Zone Name>
<HotWaterEquipment Object Name> and should be less than the standard length (100
characters) for a name field. If it is greater than this standard length, it may be difficult to
specify in output reporting as it will be truncated. A warning will be shown if the generated
name is greater than 100 characters. If it duplicates another such concatenated name, there
will be a severe error and terminate the run.
Field: Schedule Name
This field is the name of the schedule that modifies the design level parameter for hot water
equipment (see Design Level Calculation Method field and related subsequent fields). The
schedule values can be any positive number. The actual energy input for hot water
equipment in a zone as defined by this statement is the product of the design level field and
the value of the schedule specified by name in this field.
Field: Design Level Calculation Method
This field is a key/choice field that tells which of the next three fields are filled and is
descriptive of the method for calculating the nominal hot water equipment level in the Zone.
The key/choices are:
EquipmentLevel
With this choice, the method used will be a straight insertion of the hot water equipment level
(Watts) for the Zone. (The Design Level field should be filled.)
Watts/Area or Power/Area
With this choice, the method used will be a factor per floor area of the zone. (The Power per
Zone Floor Area field should be filled).
Watts/Person or Power/Person
With this choice, the method used will be a factor of equipment level (watts) per person. (The
Power per Person field should be filled).
Field: Design Level
This field (in Watts) is typically used to represent the maximum energy input to hot water
equipment in a zone that is then multiplied by a schedule fraction (see previous field). In
EnergyPlus, this is slightly more flexible in that the hot water equipment design level could be
9/29/14

374

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

a diversity factor applied to a schedule of real numbers. Note that while the schedule value
can vary from hour to hour, the design level field is constant for all simulation environments.
Field: Power per Zone Floor Area
This factor (watts/m2) is used, along with the Zone Area to determine the maximum
equipment level as described in the Design Level field. The choice from the method field
should be Watts/Area or Power/Area.
Field: Power per Person
This factor (watts/person) is used, along with the number of occupants (people) to determine
the maximum equipment level as described in the Design Level field. The choice from the
method field should be Watts/Person or Power/Person.
Heat Gains from Hot Water Equipment:
The fuel input to the equipment ultimately appears as heat that contributes to zone loads. In
EnergyPlus this heat is divided into four different fractions. Three of these are given by the
input fields Fraction Latent, Fraction Radiant and Fraction Lost. A fourth, defined as the
fraction of the heat from hot water equipment convected to the zone air, is calculated by the
program as:
fconvected = 1.0 (Fraction Latent + Fraction Radiant + Fraction Lost)
You will get an error message if Fraction Latent + Fraction Radiant + Fraction Lost exceeds
1.0.
Field: Fraction Latent
This field is a decimal number between 0.0 and 1.0 and is used to characterize the amount of
latent heat given off by hot water equipment in a zone. The number specified in this field will
be multiplied by the total energy consumed by hot water equipment to give the amount of
latent energy produced by the hot water equipment. This energy affects the moisture balance
within the zone.
Field: Fraction Radiant
This field is a decimal number between 0.0 and 1.0 and is used to characterize the amount of
long-wave radiant heat being given off by hot water equipment in a zone. The number
specified in this field will be multiplied by the total energy consumed by hot water equipment
to give the amount of long wavelength radiation gain from hot water equipment in a zone.
Field: Fraction Lost
This field is a decimal number between 0.0 and 1.0 and is used to characterize the amount of
lost heat being given off by hot water equipment in a zone. The number specified in this
field will be multiplied by the total energy consumed by hot water equipment to give the
amount of heat which is lost and does not impact the zone energy balances. This might
correspond to input energy converted to mechanical work or heat that is vented to the
atmosphere.
Field: End-Use Subcategory
Allows you to specify a user-defined end-use subcategory, e.g., "Cooking", "Clothes Drying",
etc. A new meter for reporting is created for each unique subcategory (ref: Output:Meter
obejct). Subcategories are also reported in the ABUPS table. If this field is omitted or blank,
the equipment will be assigned to the "General" end-use subcategory.
IDF Examples:
HotWaterEquipment,
SPACE2-1 HWEq 1,
SPACE2-1,
EQUIP-1,

9/29/14

!- Name
!- Zone Name
!- SCHEDULE Name

375

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

EquipmentLevel,
300,
,
,
0.2,
0.1,
0.5,
Dishwashing;

!- Design Level calculation method

!- Design Level {W}
!- Power per Zone Floor Area {watts/m2}
!- Power per Person {watts/person}
!- Fraction Latent
!- Fraction Radiant
!- Fraction Lost
!- End-Use Subcategory

Global Hot Water Equipment example:

ZoneList,OfficeZones,Left Fork, Middle Fork, Right Fork;
HotWaterEquipment,
Office Zones with Hot Water Equipment,
!- Name
OfficeZones,
!- Zone Name
HotWater Eq Sch,
!- Schedule Name
Watts/Area,
!- Design Level Calculation Method
,
!- Design Level {W}
50,
!- Power per Zone Floor Area {W/m2}
,
!- Power per Person {W/Person}
0.0000000E+00,
!- Fraction Latent
0.3000000,
!- Fraction Radiant
0.0000000E+00;
!- Fraction Lost

SteamEquipment
The object models steam equipment in the zone which consumes district heating, such as
cooking equipment or process loads. All of the energy consumed by the equipment becomes
a heat gain in the zone or is lost (exhausted) as specified below. This object consumes
district heating energy directly and does not cause a load on a steam plant loop.
Field: Name
The name of the SteamEquipment object.
Field: Zone or ZoneList Name
This field is the name of the thermal zone (ref: Zone) and attaches a particular steam
equipment statement to a thermal zone or set of thermal zones in the building. When the
ZoneList option is used then this steam equipment definition is applied to each of the zones
in the zone list effecting a global definition for the amount of steam in the zone. This option
can be used effectively with the watts/area and watts/person options of the Design Level
Calculation Method.
Field: Schedule Name
This field is the name of the schedule that modifies the design level parameter for steam
equipment (see Design Level Calculation Method field and related subsequent fields). The
schedule values can be any positive number. The actual energy input for steam equipment in
a zone as defined by this statement is the product of the design level field and the value of
the schedule specified by name in this field.
Field: Design Level Calculation Method
This field is a key/choice field that tells which of the next three fields are filled and is
descriptive of the method for calculating the nominal steam equipment level in the Zone. The
key/choices are:
EquipmentLevel
With this choice, the method used will be a straight insertion of the steam equipment level
(Watts) for the Zone. (The Design Level field should be filled.)
Watts/Area or Power/Area

9/29/14

376

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

With this choice, the method used will be a factor per floor area of the zone. (The Power per
Zone Floor Area field should be filled).
Watts/Person or Power/Person
With this choice, the method used will be a factor of equipment level (watts) per person. (The
Power per Person field should be filled).
Field: Design Level
This field (in Watts) is typically used to represent the maximum energy input to steam
equipment in a zone that is then multiplied by a schedule fraction (see previous field). In
EnergyPlus, this is slightly more flexible in that the steam equipment design level could be a
diversity factor applied to a schedule of real numbers. Note that while the schedule value
can vary from hour to hour, the design level field is constant for all simulation environments.
Field: Power per Zone Floor Area
This factor (watts/m2) is used, along with the Zone Area to determine the maximum
equipment level as described in the Design Level field. The choice from the method field
should be Watts/Area or Power/Area.
Field: Power per Person
This factor (watts/person) is used, along with the number of occupants (people) to determine
the maximum equipment level as described in the Design Level field. The choice from the
method field should be Watts/Person or Power/Person.
Heat Gains from Steam Equipment:
The fuel input to the equipment ultimately appears as heat that contributes to zone loads. In
EnergyPlus this heat is divided into four different fractions. Three of these are given by the
input fields Fraction Latent, Fraction Radiant and Fraction Lost. A fourth, defined as the
fraction of the heat from steam equipment convected to the zone air, is calculated by the
program as:
fconvected = 1.0 (Fraction Latent + Fraction Radiant + Fraction Lost)
You will get an error message if Fraction Latent + Fraction Radiant + Fraction Lost exceeds
1.0.
Field: Fraction Latent
This field is a decimal number between 0.0 and 1.0 and is used to characterize the amount of
latent heat given off by steam equipment in a zone. The number specified in this field will be
multiplied by the total energy consumed by steam equipment to give the amount of latent
energy produced by the steam equipment. This energy affects the moisture balance within
the zone.
Field: Fraction Radiant
This field is a decimal number between 0.0 and 1.0 and is used to characterize the amount of
long-wave radiant heat being given off by steam equipment in a zone. The number specified
in this field will be multiplied by the total energy consumed by steam equipment to give the
amount of long wavelength radiation gain from steam equipment in a zone.
Field: Fraction Lost
This field is a decimal number between 0.0 and 1.0 and is used to characterize the amount of
lost heat being given off by steam equipment in a zone. The number specified in this field
will be multiplied by the total energy consumed by steam equipment to give the amount of
heat which is lost and does not impact the zone energy balances. This might correspond to
input energy converted to mechanical work or heat that is vented to the atmosphere.

9/29/14

377

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

Field: End-Use Subcategory

Allows you to specify a user-defined end-use subcategory, e.g., "Cooking", "Clothes Drying",
etc. A new meter for reporting is created for each unique subcategory (ref: Output:Meter
objects). Subcategories are also reported in the ABUPS table. If this field is omitted or blank,
the equipment will be assigned to the "General" end-use subcategory.
IDF Examples:
SteamEquipment,
SPACE4-1 ElecEq 1,
SPACE4-1,
EQUIP-1,
EquipmentLevel,
1050,
,
,
0.5,
0.3,
0,
Laundry;

!!!!!!!!!!!-

Name
Zone Name
SCHEDULE Name
Design Level calculation method
Design Level {W}
Power per Zone Floor Area {watts/m2}
Power per Person {watts/person}
Fraction Latent
Fraction Radiant
Fraction Lost
End-Use Subcategory

OtherEquipment
Other Equipment object is provided as an additional source for heat gains or losses directly to
the zone. That is to say, a loss can be entered by putting a negative value into the Design
Level field(s). Note, too, that this object does not have an end-use component gains or
losses do not show up in the bottom energy lines (except as influencing overall zone gains or
losses).
Field: Name
The name of the OtherEquipment object.
Field: Zone or ZoneList Name
This field is the name of the thermal zone (ref: Zone) and attaches a particular other
equipment statement to a thermal zone or set of thermal zones in the building. When the
ZoneList option is used then this other equipment definition is applied to each of the zones in
the zone list effecting a global definition for the amount of other in the zone. This option can
be used effectively with the watts/area and watts/person options of the Design Level
Calculation Method.
Field: Schedule Name
This field is the name of the schedule that modifies the design level parameter for other
equipment (see Design Level Calculation Method field and related subsequent fields). The
schedule values can be any positive number. The actual energy input for other equipment in
a zone as defined by this statement is the product of the design level field and the value of
the schedule specified by name in this field.
Field: Design Level Calculation Method
This field is a key/choice field that tells which of the next three fields are filled and is
descriptive of the method for calculating the nominal other equipment level in the Zone. The
key/choices are:
EquipmentLevel
With this choice, the method used will be a straight insertion of the other equipment level
(Watts) for the Zone. (The Design Level field should be filled.)
Watts/Area or Power/Area
With this choice, the method used will be a factor per floor area of the zone. (The Power per
Zone Floor Area field should be filled).
9/29/14

378

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

Watts/Person or Power/Person
With this choice, the method used will be a factor of equipment level (watts) per person. (The
Power per Person field should be filled).
Field: Design Level
This field (in Watts) is typically used to represent the maximum energy input to other
equipment in a zone that is then multiplied by a schedule fraction (see previous field). In
EnergyPlus, this is slightly more flexible in that the other equipment design level could be a
diversity factor applied to a schedule of real numbers. This value can be negative to denote
a loss. Note that while the schedule value can vary from hour to hour, the design level field is
constant for all simulation environments.
Field: Power per Zone Floor Area
This factor (watts/m2) is used, along with the Zone Area to determine the maximum
equipment level as described in the Design Level field. This value can be negative to denote
a loss. The choice from the method field should be Watts/Area or Power/Area.
Field: Power per Person
This factor (watts/person) is used, along with the number of occupants (people) to determine
the maximum equipment level as described in the Design Level field. This value can be
negative to denote a loss. The choice from the method field should be Watts/Person or
Power/Person.
Heat Gains/Losses from Other Equipment:
The fuel input to the equipment ultimately appears as heat that contributes to zone loads. In
EnergyPlus this heat is divided into four different fractions. Three of these are given by the
input fields Fraction Latent, Fraction Radiant and Fraction Lost. A fourth, defined as the
fraction of the heat from other equipment convected to the zone air, is calculated by the
program as:
fconvected = 1.0 (Fraction Latent + Fraction Radiant + Fraction Lost)
You will get an error message if Fraction Latent + Fraction Radiant + Fraction Lost exceeds
1.0.
Field: Fraction Latent
This field is a decimal number between 0.0 and 1.0 and is used to characterize the amount of
latent heat given off by other equipment in a zone. The number specified in this field will be
multiplied by the total energy consumed by other equipment to give the amount of latent
energy produced by the other equipment. This energy affects the moisture balance within the
zone.
Field: Fraction Radiant
This field is a decimal number between 0.0 and 1.0 and is used to characterize the amount of
long-wave radiant heat being given off by other equipment in a zone. The number specified in
this field will be multiplied by the total energy consumed by other equipment to give the
amount of long wavelength radiation gain from other equipment in a zone.
Field: Fraction Lost
This field is a decimal number between 0.0 and 1.0 and is used to characterize the amount of
lost heat being given off by other equipment in a zone. The number specified in this field will
be multiplied by the total energy consumed by other equipment to give the amount of heat
which is lost and does not impact the zone energy balances. This might correspond to input
energy converted to mechanical work or heat that is vented to the atmosphere.
IDF Examples
OtherEquipment,
9/29/14

379

Input-Output Reference
BASE-1 OthEq 1,
BASE-1,
ALWAYSON,
EquipmentLevel,
6766.,
,
,
0,
0.3,
0;

Group Internal Gains (People, Lights, Other internal zone equipment)

!!!!!!!!!!-

Name
Zone Name
SCHEDULE Name
Design Level calculation method
Design Level {W}
Power per Zone Floor Area {watts/m2}
Power per Person {watts/person}
Fraction Latent
Fraction Radiant
Fraction Lost

Electric, Gas, Other, HotWater, Steam Equipment Outputs

Each type of equipment object has output variables for individual objects and for zone totals.
Electric Equipment
Zone,Average,Electric Equipment Electric Power [W]
Zone,Sum,Electric Equipment Electric Energy [J]
Zone,Sum,Electric Equipment Radiant Heating Energy [J]
Zone,Average,Electric Equipment Radiant Heating Rate [W]
Zone,Sum,Electric Equipment Convective Heating Energy [J]
Zone,Average,Electric Equipment Convective Heating Rate [W]
Zone,Sum,Electric Equipment Latent Gain Energy [J]
Zone,Average,Electric Equipment Latent Gain Rate [W]
Zone,Sum,Electric Equipment Lost Heat Energy [J]
Zone,Average,Electric Equipment Lost Heat Rate [W]
Zone,Sum,Electric Equipment Total Heating Energy [J]
Zone,Average,Electric Equipment Total Heating Rate [W]
Zone,Average,Zone Electric Equipment Electric Power [W]
Zone,Sum,Zone Electric Equipment Electric Energy [J]
Zone,Sum,Zone Electric Equipment Radiant Heating Energy [J]
Zone,Average,Zone Electric Equipment Radiant Heating Rate [W]
Zone,Sum,Zone Electric Equipment Convective Heating Energy [J]
Zone,Average,Zone Electric Equipment Convective Heating Rate [W]
Zone,Sum,Zone Electric Equipment Latent Gain Energy [J]
Zone,Average,Zone Electric Equipment Latent Gain Rate [W]
Zone,Sum,Zone Electric Equipment Lost Heat Energy [J]
Zone,Average,Zone Electric Equipment Lost Heat Rate [W]
Zone,Sum,Zone Electric Equipment Total Heating Energy [J]
Zone,Average,Zone Electric Equipment Total Heating Rate [W]

Gas Equipment
Zone,Average,Gas Equipment Gas Rate [W]
Zone,Sum,Gas Equipment Gas Energy [J]
Zone,Sum,Gas Equipment Radiant Heating Energy [J]
Zone,Sum,Gas Equipment Convective Heating Energy [J]
Zone,Sum,Gas Equipment Latent Gain Energy [J]
Zone,Sum,Gas Equipment Lost Heat Energy [J]
Zone,Sum,Gas Equipment Total Heating Energy [J]
Zone,Average,Gas Equipment Radiant Heating Rate [W]
Zone,Average,Gas Equipment Convective Heating Rate [W]
Zone,Average,Gas Equipment Latent Gain Rate [W]
Zone,Average,Gas Equipment Lost Heat Rate [W]
Zone,Average,Gas Equipment Total Heating Rate [W]
Zone,Average,Zone Gas Equipment Gas Rate [W]
Zone,Sum,Zone Gas Equipment Gas Energy [J]
Zone,Sum,Zone Gas Equipment Radiant Heating Energy [J]
Zone,Average,Zone Gas Equipment Radiant Heating Rate [W]
Zone,Sum,Zone Gas Equipment Convective Heating Energy [J]
Zone,Average,Zone Gas Equipment Convective Heating Rate [W]
Zone,Sum,Zone Gas Equipment Latent Gain Energy [J]
Zone,Average,Zone Gas Equipment Latent Gain Rate [W]
Zone,Sum,Zone Gas Equipment Lost Heat Energy [J]
Zone,Average,Zone Gas Equipment Lost Heat Rate [W]
Zone,Sum,Zone Gas Equipment Total Heating Energy [J]
Zone,Average,Zone Gas Equipment Total Heating Rate [W]

9/29/14

380

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

HotWater Equipment
Zone,Average,Hot Water Equipment District Heating Rate [W]
Zone,Sum,Hot Water Equipment District Heating Energy [J]
Zone,Sum,Hot Water Equipment Radiant Heating Energy [J]
Zone,Average,Hot Water Equipment Radiant Heating Rate [W]
Zone,Sum,Hot Water Equipment Convective Heating Energy [J]
Zone,Average,Hot Water Equipment Convective Heating Rate [W]
Zone,Sum,Hot Water Equipment Latent Gain Energy [J]
Zone,Average,Hot Water Equipment Latent Gain Rate [W]
Zone,Sum,Hot Water Equipment Lost Heat Energy [J]
Zone,Average,Hot Water Equipment Lost Heat Rate [W]
Zone,Sum,Hot Water Equipment Total Heating Energy [J]
Zone,Average,Hot Water Equipment Total Heating Rate [W]
Zone,Average,Zone Hot Water Equipment District Heating Rate [W]
Zone,Sum,Zone Hot Water Equipment District Heating Energy [J]
Zone,Sum,Zone Hot Water Equipment Radiant Heating Energy [J]
Zone,Average,Zone Hot Water Equipment Radiant Heating Rate [W]
Zone,Sum,Zone Hot Water Equipment Convective Heating Energy [J]
Zone,Average,Zone Hot Water Equipment Convective Heating Rate [W]
Zone,Sum,Zone Hot Water Equipment Latent Gain Energy [J]
Zone,Average,Zone Hot Water Equipment Latent Gain Rate [W]
Zone,Sum,Zone Hot Water Equipment Lost Heat Energy [J]
Zone,Average,Zone Hot Water Equipment Lost Heat Rate [W]
Zone,Sum,Zone Hot Water Equipment Total Heating Energy [J]
Zone,Average,Zone Hot Water Equipment Total Heating Rate [W]

Steam Equipment
Zone,Average,Steam Equipment District Heating Rate [W]
Zone,Sum,Steam Equipment District Heating Energy [J]
Zone,Sum,Steam Equipment Radiant Heating Energy [J]
Zone,Average,Steam Equipment Radiant Heating Rate [W]
Zone,Sum,Steam Equipment Convective Heating Energy [J]
Zone,Average,Steam Equipment Convective Heating Rate [W]
Zone,Sum,Steam Equipment Latent Gain Energy [J]
Zone,Average,Steam Equipment Latent Gain Rate [W]
Zone,Sum,Steam Equipment Lost Heat Energy [J]
Zone,Average,Steam Equipment Lost Heat Rate [W]
Zone,Sum,Steam Equipment Total Heating Energy [J]
Zone,Average,Steam Equipment Total Heating Rate [W]
Zone,Average,Zone Steam Equipment District Heating Rate [W]
Zone,Sum,Zone Steam Equipment District Heating Energy [J]
Zone,Sum,Zone Steam Equipment Radiant Heating Energy [J]
Zone,Average,Zone Steam Equipment Radiant Heating Rate [W]
Zone,Sum,Zone Steam Equipment Convective Heating Energy [J]
Zone,Average,Zone Steam Equipment Convective Heating Rate [W]
Zone,Sum,Zone Steam Equipment Latent Gain Energy [J]
Zone,Average,Zone Steam Equipment Latent Gain Rate [W]
Zone,Sum,Zone Steam Equipment Lost Heat Energy [J]
Zone,Average,Zone Steam Equipment Lost Heat Rate [W]
Zone,Sum,Zone Steam Equipment Total Heating Energy [J]
Zone,Average,Zone Steam Equipment Total Heating Rate [W]

9/29/14

381

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

Other Equipment
Zone,Sum,Other Equipment Radiant Heating Energy [J]
Zone,Average,Other Equipment Radiant Heating Rate [W]
Zone,Sum,Other Equipment Convective Heating Energy [J]
Zone,Average,Other Equipment Convective Heating Rate [W]
Zone,Sum,Other Equipment Latent Gain Energy [J]
Zone,Average,Other Equipment Latent Gain Rate [W]
Zone,Sum,Other Equipment Lost Heat Energy [J]
Zone,Average,Other Equipment Lost Heat Rate [W]
Zone,Sum,Other Equipment Total Heating Energy [J]
Zone,Average,Other Equipment Total Heating Rate [W]
Zone,Sum,Zone Other Equipment Radiant Heating Energy [J]
Zone,Average,Zone Other Equipment Radiant Heating Rate [W]
Zone,Sum,Zone Other Equipment Convective Heating Energy [J]
Zone,Average,Zone Other Equipment Convective Heating Rate [W]
Zone,Sum,Zone Other Equipment Latent Gain Energy [J]
Zone,Average,Zone Other Equipment Latent Gain Rate [W]
Zone,Sum,Zone Other Equipment Lost Heat Energy [J]
Zone,Average,Zone Other Equipment Lost Heat Rate [W]
Zone,Sum,Zone Other Equipment Total Heating Energy [J]
Zone,Average,Zone Other Equipment Total Heating Rate [W]

Electric Equipment Electric Power [W]

Electric Equipment Electric Energy [J]
The electric equipment electric power consumption in Watts (for power) or Joules (for
energy). It is the sum of the radiant, convective, latent and lost components. This energy use
is added to the electricity meters that are associated with the zone Electricity:Facility,
Electricity:Buidling,
Electricity:Zone:<Zone
Name>,
InteriorEquipment:Electricity:
:Zone:<Zone Name>, and <End-Use Subcategory>:InteriorEquipment:Electricity.
Gas Equipment Gas Rate [W]
Gas Equipment Gas Energy [J]
The gas equipment natural gas consumption in Watts (for power) or Joules (for energy). It is
the sum of the radiant, convective, latent and lost components. This energy use is added to
the electricity meters that are associated with the zone Gas:Facility, Gas:Buidling,
Gas:Zone:<Zone Name>, InteriorEquipment:Gas: :Zone:<Zone Name>, and <End-Use
Subcategory>:InteriorEquipment:Gas.
Hot Water Equipment District Heating Rate [W]
Hot Water Equipment District Heating Energy [J]
The hot water equipment district heating consumption in Watts (for power) or Joules (for
energy). It is the sum of the radiant, convective, latent and lost components. This energy use
is added to the district heating meters that are associated with the zone
DistrictHeating:Facility,
DistrictHeating:Buidling,
DistrictHeating:Zone:<Zone
Name>,
InteriorEquipment:
DistrictHeating:
:Zone:<Zone
Name>,
and
<End-Use
Subcategory>:InteriorEquipment: DistrictHeating.
Steam Equipment District Heating Rate [W]
Steam Equipment District Heating Energy [J]
The steam equipment district heating consumption in Watts (for power) or Joules (for
energy). It is the sum of the radiant, convective, latent and lost components. This energy use
is added to the district heating meters that are associated with the zone
DistrictHeating:Facility,
DistrictHeating:Buidling,
DistrictHeating:Zone:<Zone
Name>,
InteriorEquipment:
DistrictHeating:
:Zone:<Zone
Name>,
and
<End-Use
Subcategory>:InteriorEquipment: DistrictHeating.

9/29/14

382

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

Note that zone energy consumption is not reported for OTHER EQUIPMENT and does not go on any
meter.

ZoneContaminantSourceAndSink:CarbonDioxide
The ZoneContaminantSourceAndSink:CarbonDioxide object allows users to input carbon
dioxide sources or sinks in a zone. Note that carbon dioxide generation within a zone can
also
be
specified
using
People
and
GasEquipment
objects.
Multiple
ZoneContaminantSourceAndSink:CarbonDioxide objects can be specified for the same
zone.
Field: Name
The name of the ZoneContaminantSourceAndSink:CarbonDioxide object. The name for each
ZoneContaminantSourceAndSink:CarbonDioxide object must be unique.
Field: Zone Name
This field is the name of the zone (ref: Zone) and links a particular
ZoneContaminantSourceAndSink:CarbonDioxide object to a thermal zone in the building.
Field: Design Generation Rate
This field denotes the design carbon dioxide generation rate (m 3/s). The design value is
modified by the schedule fraction (see Field: Schedule Name). The resulting volumetric
generation rate is converted to mass generation rate using the current zone indoor air density
at each time step. The rate can be either positive or negative. A positive value represents a
source rate (CO2 addition to the zone air) and a negative value represents a sink rate (CO 2
removal from the zone air).
Field: Schedule Name
This field is the name of the schedule (ref: Schedules) that modifies the design carbon
dioxide generation rate (see previous field). The schedule values can be any positive number
between 0.0 and 1.0. For each simulation time step, the actual CO 2 generation rate in a zone
is the product of the Design Generation Rate field (above) and the value specified by this
schedule.
An IDF example is provided below:
ZoneContaminantSourceAndSink:CarbonDioxide,
NORTH_ZONE CO2,
!- Name
NORTH_ZONE,
!- Zone Name
1.e-6,
!- Design Generation Rate {m3/s}
CO2 Source Schedule;
!- Schedule Name

ZoneContaminantSourceAndSink:CarbonDioxide Outputs
HVAC,Average, Contaminant Source or Sink CO2 Gain Volume Flow Rate [m3/s]
HVAC,Average, Zone Contaminant Source or Sink CO2 Gain Volume Flow Rate
[m3/s]

Contaminant Source or Sink CO2 Gain Volume Flow Rate [m3/s]

This output is the net carbond dioxide internal gain/loss in m3/s for an individual
ZoneContaminantSourceAndSink:CarbonDioxide object.
Zone Contaminant Source or Sink CO2 Gain Volume Flow Rate [m3/s]
This output variable reports the total (net) carbon dioxide internal gains/losses in cubic
meters per second for a zone, including impacts from three objects:
ZoneContaminantSourceAndSink:CarbonDioxide, People, and GasEquipment. Positive
9/29/14

383

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

values denote carbon dioxide generation (gain or source), while negative values denote
carbon dioxide removal (loss or sink).
ZoneContaminantSourceAndSink:GenericContaminant:Constant
The ZoneContaminantSourceAndSink:GenericContaminant:Constant object specifies the
generic contaminant generation rate and removal rate coefficient in a zone. The associated
fraction schedules are required for allowing users to change the magnitude of sources and
sinks. The object is equivalent to the combination of the constant coefficient model and the
burst source model defined in the sources and sinks element types of CONTAM 3.0. The
basic equation used to calculate generic contaminant source and sink for the constant model
is given below:

S f (t ) G f (t )* FG

R f (t )C f (t )*1.0E 6* FR

where
Sf = Contaminant generic contaminant source strength [m 3/s]
Gf = Generic contaminant generation rate [m3/s]
FG = Fraction value from the source fraction schedule at a given time [dimensionless]
Rf = Generic contaminant effective removal rate [m 3/s]
FR = Fraction value from the sink fraction schedule at a given time [dimensionless]
Cf = Generic contaminant concentration value at a given previous time step [ppm]
Field: Name
This field represents a unique
contaminantSourceAndSinkNames.

identifying

name

in

group

referring

Generic

Field: Zone Name

This field signifies the Name of the zone with constant generic contaminant source and sink.
Field: Maximum Generation Rate
This field denotes the full generic contaminant maximum generation rate (m 3/s). The design
generation rate is the maximum amount of generic contaminant expected at design
conditions. The design value is modified by the schedule fraction (see Field:Generation
Schedule Name).
Field: Generation Schedule Name
This field is the name of the schedule (ref: Schedule) that modifies the maximum design
generation rate (Gf). This fraction between 0.0 and 1.0 is noted as FG in the above equation.
Field: Design Removal Coefficient
This field denotes the full generic contaminant design removal coefficient (m 3/s). The design
removal rate is the maximum amount of generic contaminant expected at design conditions
times the generic contaminant concentration in the same zone. The design value is modified
by the schedule fraction (see Field:Removal Schedule Name).
Field: Removal Schedule Name
This field is the name of the schedule (ref: Schedule) that modifies the maximum design
generation rate (Rf). This fraction between 0.0 and 1.0 is noted as FR in the above equation.
An IDF example is provided below:
ZoneContaminantSourceAndSink:GenericContaminant:Constant,
NORTH ZONE GC,
!- Name
9/29/14

384

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

NORTH ZONE,
1.0E-6,
GC Source Schedule,
1.0E-7,
GC Removal Schedule;

!!!!!-

Zone Name
Design Generation Rate {m3/s}
Schedule Name
Design Removal Coefficient {m3/s}
Removal Schedule Name

ZoneContaminantSourceAndSink:GenericContaminant:Constant Outputs
When a ZoneContaminantSourceAndSink:GenericContaminant:Constant object is specified,
the following output variables are available:
ZONE,Average, Generic Air Contaminant Constant Source Generation Volume Flow
Rate [m3/s]

Generic Air Contaminant Constant Source Generation Volume Flow Rate [m3/s]
This output is the average generic contaminant generation rate from each
ZoneContaminantSourceAndSink:GenericContaminant:Constant object. The generation rate
is a sum of generation and removal rates. The zone air generic contaminant level at the
previous zone time step is used in the removal rate calculation.
SurfaceContaminantSourceAndSink:GenericContaminant:PressureDriven
The
SurfaceContaminantSourceAndSink:GenericContaminant:PressureDriven
object
specifies the generic contaminant generation rate coefficient, which is used to calculate the
generation rate due to the pressure difference across the surface. The object is equivalent to
the pressure driven model defined in the sources and sinks element types of CONTAM 3.0.
This object assumes to work with the AirflowNetwork model. The surface has to be defined in
the AirflowNetwork:Multizone:Surface. Although the model is designed to be applied to radon
and soil gas entry, it is expanded to be applied to all contaminant transport, including generic
contaminant. However, it should be used in caution. The basic equation used to calculate
generic contaminant source for the pressure driven constant model is provided below:

S f (t )

H f (t )* FG * Pj

Pi

where
Sf = Generic contaminant source strength [m3/s]
Hf = Generic contaminant generation rate coefficient [m 3/s]
FG = Fraction value from the source fraction schedule at a given time [dimensionless]
n = Flow power exponent
Pi = Zone pressure [Pa]
Pj = Pressure in an adjacent zone for a interior surface or outdoor for an exterior surface
[Pa]
Field: Name
The
field
signifies
the
unique
identifying
GenericContaminantSourceAndSinkNames.

name

in

group

referring

Field: Surface Name

This field represents the name of the surface as a generic contaminant source using the
pressure driven model.
Field: Design Generation Rate Coefficient
This field denotes the generic contaminant design generation coefficient (m3/s). The design
generation rate is the maximum amount of generic contaminant expected at design

9/29/14

385

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

conditions times the pressure difference with a power exponent across a surface. The design
value is modified by the schedule fraction (see Field:Generation Schedule Name).
Field: Generation Schedule Name
This field is the name of the schedule (ref: Schedule) that modifies the maximum design
generation rate. This fraction between 0.0 and 1.0 is noted as F G in the above equation.
An IDF example is provided below:
SurfaceContaminantSourceAndSink:GenericContaminant:PressureDriven,
WEST ZONE GC BLD,
!- Name
Zn001:Wall001,
!- Surface Name
1.0E-6,
!- Design Generation Rate Coefficient {m3/s}
GC Source Schedule,
!- Generation Schedule Name
0.5;
!- Generation Exponent

SurfaceContaminantSourceAndSink:GenericContaminant:PressureDriven Outputs
When a SurfaceContaminantSourceAndSink:GenericContaminant:PressureDriven object is
specified, the following output variables are available:
ZONE,Average,Generic Air Contaminant Pressure Driven Generation Volume Flow
Rate [m3/s]

Generic Air Contaminant Pressure Driven Generation Volume Flow Rate [m3/s]
This output is the average generic contaminant generation rate from
SurfaceContaminantSourceAndSink:GenericContaminant:PressureDriven object.

each

ZoneContaminantSourceAndSink:GenericContaminant:CutoffModel
The ZoneContaminantSourceAndSink:Generic contaminant:CutoffModel object specifies the
generic contaminant generation rate based on the cutoff concentration model. The basic
equation used to calculate generic contaminant source for the pressure driven constant
model is given below:

S f (t )

G f (t )* FG * 1
0

C f (t )
Ccutoff

Cf

Ccutoff

Cf

Ccutoff

where
Sf = Generic contaminant source strength [m 3/s]
Gf = Generic contaminant generation rate [m3/s]
FG = Fraction value from the source fraction schedule at a given time [dimensionless]
Ccutoff
= Cutoff concentration at which emission ceases [ppm]
Cf = Generic contaminant concentration value at a given previous time step [ppm]
Field: Name
The
field
signifies
the
unique
identifying
GenericContaminantSourceAndSinkNames.

name

in

group

referring

Field: Zone Name

This field represents the name of the zone with generic contaminant source and sink using
the cutoff model.

9/29/14

386

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

Field: Design Generation Rate

This field denotes the full generic contaminant design generation rate (m 3/s). The design
generation rate is the maximum amount of generic contaminant expected at design
conditions. The design value is modified by the schedule fraction (see Field:Generation
Schedule Name).
Field: Generation Schedule Name
This field is the name of the schedule (ref: Schedule) that modifies the maximum design
generation rate (Gf). This fraction between 0.0 and 1.0 is noted as FG in the above equation.
Field: Cutoff Concentration
This field is the generic contaminant cutoff concentration level where the source ceases its
emission.
An IDF example is provided below:
ZoneContaminantSourceAndSink:GenericContaminant:CutoffModel,
NORTH ZONE GC CutoffModel,
!- Name
NORTH ZONE,
!- Zone Name
1.0E-5,
!- Design Generation Rate {m3/s}
GC Source Schedule,
!- Schedule Name
100000;
!- Cutoff Concentration {ppm}

ZoneContaminantSourceAndSink:GenericContaminant:CutoffModel Outputs
When a ZoneContaminantSourceAndSink:GenericContaminant:CutoffModel
specified, the following output variables are available:

object

is

ZONE,Average, Generic Air Contaminant Cutoff Model Generation Volume Flow

Rate [m3/s]

Generic Air Contaminant Cutoff Model Generation Volume Flow Rate [m3/s]
This output is the average generic contaminant generation rate
SurfaceContaminantSourceAndSink:GenericContaminant: CutoffModel object.

from

each

ZoneContaminantSourceAndSink:GenericContaminant:DecaySource
The ZoneContaminantSourceAndSink:GenericContaminant:DecaySource object specifies the
generic contaminant generation rate based on the decay source model. The basic equation
used to calculate generic contaminant source for the decay source model is given below:

S f (t ) G f (t ) FG exp( t / tc )
where
Sf = Generic contaminant source strength [m 3/s]
Gf = Initial generic contaminant generation rate [m3/s]
FG = Fraction value from the source fraction schedule at a given time [dimensionless]
t
= Time since the start of emission [second]
tc = Decay time constant [second]
Field: Name
This
field
is
the
unique
identifying
GenericContaminantSourceAndSinkNames.

9/29/14

name

in

group

referring

387

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

Field: Zone Name

This field represents the name of the zone with a generic contaminant decaying source.
Field: Initial Generation Rate
This field denotes the initial generic contaminant design generation rate (m 3/s). The
generation is controlled by a schedule, as defined in the next field. Generic contaminant
generation begins when the schedule changes from a zero to a non-zero value (between
zero and one). The initial generation rate is equal to the schedule value times the initial
generation rate. A single schedule may be used to initiate several emissions at different
times. (see Field:Generation Schedule Name).
Field: Generation Schedule Name
This field is the name of the schedule (ref: Schedule) that modifies the maximum design
generation rate (Gf). This fraction between 0.0 and 1.0 is noted as F G in the above equation.
When the value is equal to 1, the generation rate is used and time is reset to zero. When the
value is equal to zero, the schedule value is ignored in the equation.
Field: Decay Time Constant
This field is the time at which the generation rate reaches 0.37 of the original rate.
Note: The variable t, time since the start of emission, will be reset to zero, when a new run period starts, or
the generation schedule value is equal to zero.

An IDF example is provided below:

ZoneContaminantSourceAndSink:GenericContaminant:DecaySource,
WEST ZONE GC DecaySource,
!- Name
WEST ZONE,
!- Zone Name
1.0E-5,
!- Initial Emission Rate {m3/s}
GC Source Schedule,
!- Schedule Name
100000;
!- Delay Time Constant {s}

ZoneContaminantSourceAndSink:GenericContaminant:DecaySource Outputs
When a ZoneContaminantSourceAndSink:GenericContaminant:DecaySource
specified, the following output variables are available:

object

is

Zone,Average,Generic Air Contaminant Decay Model Generation Volume Flow Rate

[m3/s]
Zone,Average,Generic Air Contaminant Decay Model Generation Emission Start
Elapsed Time [s]

Generic Air Contaminant Decay Model Generation Volume Flow Rate [m3/s]
This output is the average generic contaminant decay rate from
SurfaceContaminantSourceAndSink:GenericContaminant:DecaySource object.

each

Generic Air Contaminant Decay Model Generation Emission Start Elapsed Time [s]
This output is the decay time since the start of emission. The start time is either at the
beginning of each run period, including design day simulations, or the time when the
egenration schedule value is zero.
SurfaceContaminantSourceAndSink:GenericContaminant:BoudaryLayerDiffusion
The SurfaceContaminantSourceAndSink:GenericContaminant:BoudaryLayerDiffusion object
specifies the generic contaminant generation rate from surface diffusion. The object is
equivalent to the boundary layer diffusion model driven model defined in the sources and
sinks element types of CONTAM 3.0.
9/29/14

388

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

The boundary layer diffusion controlled reversible sink/source model with a linear sorption
isotherm follows the descriptions presented in [Axley 1991]. The boundary layer refers to the
region above the surface of a material through which a concentration gradient exists between
the near-surface concentration and the air-phase concentration. The rate at which a
contaminant is transferred onto a surface (sink) is defined as:

Sf

h* * A Cf

Cs
*1.0 E 6
k

where
h = Average film mass transfer coefficient over the sink [m/s]
A
Cf
Cs
k

= Film density of air [kg/m 3]

= Surface area of the adsorbent [m2]
= Concentration in the air at the previous time step [ppm]
= Concentration in the adsorbent [ppm]
= Henry adsorption constant or partition coefficient [dimensionless]

Field: Name
This
field
signifies
a
unique
identifying
GenericContaminanteSourceAndSinkNames.

name

in

group

referring

Field: Surface Name

This field denotes the name of the surface as a generic contaminant reversible source or sink
using the boundary layer diffusion model.
Field: Film Transfer Coefficient
This field specifies the average mass transfer coefficient of the contaminant generic
contaminant within the boundary layer (or film) above the surface of the adsorbent.
Field: Henry Partition Coefficient
This field denotes the generic contaminant Henry partition coefficient in the units of
dimensionless. The coefficient relates the concentration of the contaminant generic
contaminant in the bulk-air to that at the surface of the adsorption material.
An IDF example is provided below:
SurfaceContaminantSourceAndSink:GenericContaminant:BoudaryLayerDiffusion,
WEST ZONE GC BLD,
!- Name
Zn001:Wall001,
!- Surface Name
1.0E-2,
!- Mass Transfer Coefficient {m/s}
GC Source Schedule,
!- Schedule Name
2.0;
!- Henry adsorption constant or partition
coefficient
SurfaceContaminantSourceAndSink:GenericContaminant:BoundaryLayerDiffusion Outputs
When a SurfaceContaminantSourceAndSink:GenericContaminant:BoudaryLayerDiffusion object is
specified, the following output variables are available:
ZONE,Average, Generic Air Contaminant Boundary Layer Diffusion Generation Volume Flow
Rate [m3/s]
ZONE,Average, Generic Air Contaminant Boundary Layer Diffusion Inside Face
Concentration [ppm]

9/29/14

389

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

Generic Air Contaminant Boundary Layer Diffusion Generation Volume Flow Rate [m3/s]
This
output
is
the
average
generic
contaminant
generation
rate
SurfaceContaminantSourceAndSink:GenericContaminant:BoudaryLayerDiffusion object.

from

each

Generic Air Contaminant Boundary Layer Diffusion Inside Face Concentration [ppm]
This output is the average generic contaminant level at the interior surface .

SurfaceContaminantSourceAndSink:GenericContaminant:DepositionVelocitySink
The SurfaceContaminantSourceAndSink:GenericContaminant:DepositionVelocitySink object
specifies the generic contaminant removal rate from a surface. The object is equivalent to the
deposition velocity sink model defined in CONTAM 3.0 sources and sinks element types.
The deposition velocity model provides for the input of a sinks characteristic in the familiar
term of deposition velocity. The removal stops when the sink concentration level is higher
than the zone air concentration level. The deposition velocity model equation is:

S f (t )
where
Sf(t)

As m * C f (t )*1.0E 6* F R

= Removal rate at time t [m3/s]

= Deposition velocity [m/s]

As = Deposition surface area [m 2]
m = Element multiplier [dimensionless]
Cf(t)
= Concentration of contaminant generic contaminant at the previous time step
[ppm]
FR = Schedule or control signal value at time t [-]
d

Field: Name
This field denotes a unique identifying name in a group referring GenericContaminant
SourceAndSinkNames.
Field: Surface Name
This field represents the name of the surface as a generic contaminant sink using the
deposition velocity sink model.
Field: Deposition Velocity
This field specifies the deposition velocity to the surface of the adsorbent in the units of m/s.
Field: Removal Schedule Name
This field is the name of the schedule (ref: Schedule) that modifies the maximum design
removal rate (Sf). This fraction between 0.0 and 1.0 is noted as FR in the above equation.
An IDF example is provided below:
SurfaceContaminantSourceAndSink:GenericContaminant:DepositionVelocitySink,
EAST ZONE GC DVS,
!- Name
Zn002:Wall001,
!- Surface Name
1.0E-3,
!- Deposition Velocity {m/s}
GC Source Schedule;
!- Schedule Name
SurfaceContaminantSourceAndSink:GenericContaminant:DepositionVelocitySink Outputs
The
following
output
variables
are
available
SurfaceContaminantSourceAndSink:GenericContaminant:DepositionVelocitySink
object is specified.

9/29/14

when

the

390

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

ZONE,Average, Generic Air Contaminant Deposition Velocity Removal Volume Flow Rate
[m3/s]

Generic Air Contaminant Deposition Velocity Removal Volume Flow Rate [m3/s]
This
output
is
the
average
generic
contaminant
generation
rate
SurfaceContaminantSourceAndSink:GenericContaminant:DepositionVelocitySink object.

from

each

ZoneContaminantSourceAndSink:GenericContaminant:DepositionRateSink
The
ZoneContaminantSourceAndSink:GenericContaminant:DepositionRateSink
object
specifies the generic contaminant removal rate from a zone. The object is equivalent to the
deposition rate sink model defined in CONTAM 3.0 sources and sinks element types.
The deposition rate model provides for the input of a sinks characteristic in the familiar term
of deposition rate in a zone. The removal stops when the sink concentration level is higher
than the zone air concentration level. The deposition rate model equation is:

S f (t )

kdVz * C f (t )*1.0E 6* FR m

Where
Sf(t)
= Removal rate at time t [m3/s]
kd = Deposition rate [1/T]
Vz = Zone volume [m 3]
m = Element multiplier [dimensionless]
Cf(t)
= Concentration of generic contaminant at the previous time step [ppm]
FR = Schedule or control signal value at time t [dimensionless]
Field: Name
This
field
denotes
a
unique
identifying
GenericContaminantSourceAndSinkNames.

name

in

group

referring

Field: Zone Name

This field represents the name of the zone as a generic contaminant sink using the deposition
rate sink model.
Field: Deposition Rate
This field specifies the deposition rate to the zone in the units of 1/s.
Field: Removal Schedule Name
This field is the name of the schedule (ref: Schedule) that modifies the maximum design
removal rate (Sf). This fraction between 0.0 and 1.0 is noted as FR in the above equation.
An IDF example is provided below:
ZoneContaminantSourceAndSink:GenericContaminant:DepositionRateSink,
NORTH ZONE GC DRS,
!- Name
NORTH ZONE,
!- Zone Name
1.0E-5,
!- Deposition Rate {m3/s}
GC Source Schedule;
!- Schedule Name
ZoneContaminantSourceAndSink:GenericContaminant:DepositionRateSink Outputs
When the ZoneContaminantSourceAndSink:GenericContaminant:DepositionRateSink
specified, the following output variables are available:

object

is

ZONE,Average, Generic Air Contaminant Deposition Rate Removal Volume Flow Rate [m3/s]

9/29/14

391

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

Generic Air Contaminant Deposition Rate Removal Volume Flow Rate [m3/s]
This
output
is
the
average
generic
contaminant
generation
rate
ZoneContaminantSourceAndSink:GenericContaminant:DepositionRateSink object.

from

each

ZoneBaseboard:OutdoorTemperatureControlled
This object specifies outside temperature-controlled (OTC) baseboard heating. The
capacities (high and low) are specified in W at the temperatures specified. The schedule
allows both capacities to change hourly on a proportional basis. This baseboard heater does
not operate if the outdoor dry-bulb is above the high temperature limit. Between the high
temperature and the low temperature, the capacity is interpolated (linear) between the high
and the low capacity values. Below the low temperature, the capacity is set at the low
capacity value. This allows the user to add baseboard heat to a perimeter zone starting at a
prescribed temperature and then slowly increases this capacity to a max value.
Example:
Temperature High = 10 C Capacity High = 100,000 W
Temperature Low = 0 C
Capacity Low = 500,000 W
Table 16. Outdoor Temperature Controlled Baseboard Heat Temperature vs. Capacity
Outdoor Dry-bulb(C)

Baseboard Output

>10

10

100,000

180,000

260,000

340,000

420,000

500,000

<0

500,000

Field: Name
The name of the ZoneBaseboard:OutdoorTemperatureControlled object.
Field: Zone Name
This field is the name of the zone and attaches the baseboard heat equipment statement to a
thermal zone in the building.
Field: Schedule Name
This field is the name of the schedule that modifies the capacities (high and low) for
baseboard heat equipment (see next four fields). The schedule values can be any positive
number. The actual energy input for the baseboard equipment in a zone as defined by this
statement depends on the actual outdoor temperature and where that temperature is in the
range of Low Temperature to High Temperature..
Field: Capacity at Low Temperature
This is the baseboard equipment capacity (Watts) at the low temperature limit. This is the
maximum capacity of the baseboard equipment in full load operation. This field is
autosizable.

9/29/14

392

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

Field: Low Temperature

If the outdoor dry-bulb temperature (degrees Celsius) is at or below the low temperature the
baseboard heater operates at the low temperature capacity. This field is autosizable. The
lowest design outdoor dry bulb temperature is chosen, if autosized.
Field: Capacity at High Temperature
This is the baseboard equipment capacity (Watts) at the high temperature limit. This field is
autosizable. The capacity at low temperature is prorated against the reference low and high
temperature fields, if autosized.
Field: High Temperature
If the outdoor dry-bulb temperature (degrees Celsius) is greater than the high temperature
the baseboard heater will not operate. This field is autosizable. If autosized, this is equal to
the design zone heating setpoint temperature described below, so that the capacity at high
temperature is zero.
Field: Fraction Radiant
This field is a decimal number between 0.0 and 1.0 and is used to characterize the type of
heat being given off by baseboard heat equipment in a zone. The number specified in this
field will be multiplied by the total energy consumed by the baseboard heat equipment to give
the amount of long wavelength radiation gain to the zone.
Field: End-Use Subcategory
Allows you to specify a user-defined end-use subcategory, e.g., "Perimeter Baseboards", etc.
A new meter for reporting is created for each unique subcategory (ref: Output:Meter objects).
Subcategories are also reported in the ABUPS table. If this field is omitted or blank, the
baseboard equipment will be assigned to the "General" end-use subcategory.
Field: Design Zone Heating Setpoint
This is heating setpoint temperature in the zone where the unit serves. This is used to
autosize high temperature and capacity at high temperature fields. The default value is 20C.
An IDF example:
ZoneBaseboard:OutdoorTemperatureControlled,
SPACE4-1 BBHeat 1,
!- Name
SPACE4-1,
!- Zone Name
EQUIP-1,
!- SCHEDULE Name
1500,
!- Capacity at low temperature {W}
0,
!- Low Temperature {C}
500,
!- Capacity at high temperature {W}
10,
!- High Temperature {C}
0.5,
!- Fraction Radiant
Baseboard Heat,
!- End-Use Subcategory
20;
!- Design Zone Heating Setpoint {C}

ZoneBaseboard:OutdoorTemperatureControlled Output
ZoneBaseboard:OutdoorTemperatureControlled objects have output variables for individual
objects and for zone totals. The following outputs are available:
Zone,Average,Baseboard Electric Power [W]
Zone,Sum,Baseboard Electric Energy [J]
Zone,Sum,Baseboard Radiant Heating Energy [J]
Zone,Average,Baseboard Radiant Heating Rate [W]
Zone,Sum,Baseboard Convective Heating Energy [J]
Zone,Average,Baseboard Convective Heating Rate [W]
Zone,Sum,Baseboard Total Heating Energy [J]
Zone,Average,Baseboard Total Heating Rate [W]

9/29/14

393

Input-Output Reference

Group Internal Gains (People, Lights, Other internal zone equipment)

Zone,Average,Zone Baseboard Electric Power [W]

Zone,Sum,Zone Baseboard Electric Energy [J]
Zone,Sum,Zone Baseboard Radiant Heating Energy [J]
Zone,Average,Zone Baseboard Radiant Heating Rate [W]
Zone,Sum,Zone Baseboard Convective Heating Energy [J]
Zone,Average,Zone Baseboard Convective Heating Rate [W]
Zone,Sum,Zone Baseboard Total Heating Energy [J]
Zone,Average,Zone Baseboard Total Heating Rate [W]

Baseboard Electric Power [W]

This field is the electric power for the ZoneBaseboard:OutdoorTemperatureControlled object
in Watts.
Baseboard Electric Energy [J]
The outdoor temperature controlled baseboard heat option is assumed to be fueled by
electricity. This field is the same as the Baseboard Total Heating Energy (above) in joules.
Baseboard Radiant Heating Rate [W]
Baseboard Radiant Heating Energy [J]
These output variables are the amount of radiant heat gain for the
ZoneBaseboard:OutdoorTemperatureControlled object in Watts (for rate) or Joules. This is
determined by the current heat gain from the heater to the zone and the Fraction Radiant
specified in the input. The radiant gains (long wavelength) are distributed to the surfaces
using an area weighting scheme.
Baseboard Convective Heating Rate [W]
Baseboard Convective Heating Energy [J]
These output variables are the amount of convective heat gain for the
ZoneBaseboard:OutdoorTemperatureControlled object in Watts (for rate) or Joules. This is
determined by the current heat gain from the heater to the zone and the Fraction Radiant
specified in input (1-FractionRadiant = FractionConvected). The convective heat gain is
added to the zone air heat balance directly.
Baseboard Total Heating Rate [W]
Baseboard Total Heating Energy [J]
These
output
variables
are
the
amount
of
heat
gain
for
the
ZoneBaseboard:OutdoorTemperatureControlled object in Watts (for rate) or Joules. This is
determined by the sum of the radiant and convective heat gains from the baseboard heat.
Zone Baseboard Electric Power [W]
This field is the electric power for all ZoneBaseboard:OutdoorTemperatureControlled objects
within the zone in Watts.
Zone Baseboard Electric Energy [J]
The outdoor temperature controlled baseboard heat option is assumed to be fueled by
electricity. This field is the same as the Baseboard Total Heating Energy (above) in joules.
However, this amount is also shown in the Electricity meters that are associated with the
zone Electricity:Facility, Electricity:Buidling, Electricity:Zone:<Zone Name>, and
InteriorEquipment:Electricity.
Zone Baseboard Radiant Heating Rate [W]
Zone Baseboard Radiant Heating Energy [J]
These output variables are the amount of radiant heat gain for all
ZoneBaseboard:OutdoorTemperatureControlled objects within the zone in Watts (for rate) or
9/29/14

394

Input-Output Reference

Group Daylighting

Joules. This is determined by the current heat gain from the heater to the zone and the
Fraction Radiant specified in the input. The radiant gains (long wavelength) are distributed
to the surfaces using an area weighting scheme.
Zone Baseboard Convective Heating Rate [W]
Zone Baseboard Convective Heating Energy [J]
These output variables are the amount of convective heat gain for all
ZoneBaseboard:OutdoorTemperatureControlled objects within the zone in Watts (for rate) or
Joules. This is determined by the current heat gain from the heater to the zone and the
Fraction Radiant specified in input (1-FractionRadiant = FractionConvected). The
convective heat gain is added to the zone air heat balance directly.
Zone Baseboard Total Heating Rate [W]
Zone Baseboard Total Heating Energy [J]
These
output
variables
are
the
amount
of
heat
gain
for
all
ZoneBaseboard:OutdoorTemperatureControlled objects within the zone in Watts (for rate) or
Joules. This is determined by the sum of the radiant and convective heat gains from the
baseboard heat.
Meters for Equipment Outputs
As described in each of the equipment sections, values for specific equipments will show up
on the following meters:
Table 17. Distribution of Equipment to Meters
Meter Name

Scope

Equipment
Specfics

Electricity:Facility

Entire Facility

Electric Equipment,
OTC Baseboard Heat

Electricity:Building

All Zones

Electric Equipment,
OTC Baseboard Heat

Electricity:Zone:<Zone Name>

Specific Zone

Electric Equipment,
OTC Baseboard Heat

InteriorEquipment:Electricity

AllZones

Electric Equipment,
OTC Baseboard Heat

<End-Use
Subcategory>:InteriorEquipment:Electricity

Specific
Subcategory

Electric Equipment,
OTC Baseboard Heat

Gas:Facility

Entire Facility

Gas Equipment

Gas:Building

All Zones

Gas Equipment

Gas:Zone:<Zone Name>

Specific Zone

Gas Equipment

InteriorEquipment:Gas

AllZones

Gas Equipment

<End-Use Subcategory>:InteriorEquipment:Gas

Specific
Subcategory

Gas Equipment

Group Daylighting
Daylighting can be invoked in EnergyPlus by the use of two objects: Daylighting:Controls
and Daylighting:DELight:Controls. These are described in the following object
descriptions.
9/29/14

395

Input-Output Reference

Group Daylighting

Note that Daylighting:Controls and Daylighting:DELight:Controls objects may be intermixed in a single IDF
but may not be used in the same zone.

Daylighting:Controls
In this method daylighting illuminance levels are calculated and then used to determine how
much the electric lighting can be reduced. The daylight illuminance level in a zone depends
on many factors, including sky condition; sun position; calculation point; location, size, and
glass transmittance of windows; window shading devices; and reflectance of interior surfaces.
Reduction of electric lighting depends on daylight illuminance level, illuminance set point,
fraction of zone controlled and type of lighting control.
Field: Zone name
The name of the zone to which the following daylighting-related input applies.
Field: Total Daylighting Reference Points
Allowed values are 1 or 2. This the number of reference points in the zone at which horizontal
daylighting illuminance will be calculated based on input for the following fields. It is assumed
that the photocells that control the overhead electric lighting respond to the light levels at the
specified reference points.
Fields: (X,Y,Z) of First Reference Point
Required if Total Daylighting Reference Points = 1 or 2. These three fields are the X, Y and Z
values of the First Reference point in the coordinate system you specified for daylighting
reference points in the GlobalGeometryRules object. Figure 53 shows an example using the
relative coordinate (to zone) system. Z is typically at desk height (0.8 m).
If you want to divide a thermal zone into two independently-controlled lighting zones, then
Total Daylighting Reference Points should be set to 2 and (X,Y,Z) of the Second Reference
Point (see following input fields) should also be specified.
Fields: (X,Y,Z) of Second Reference Point
The X, Y, and Z coordinates, in the same coordinate system, of the second daylighting
reference point. Required if Total Daylighting Reference Points = 2. See Figure 53 for an
example.

9/29/14

396

Input-Output Reference

Group Daylighting

Zzone
First
Reference
Point, at
(5,5,0.8)

Second
Reference
Point, at
(5,15,0.8)
Window

(a)

5 0.8

0.8

Yzone

5
10

15
20

Xzone
Yzone

(b)

Second
Reference
Point, at
(5,15,0.8)

Window

Zzone

20

15

First
Reference
Point, at
(5,5,0.8)

(c)
15
5

0.8

0.8

Yzone

20
5

Xzone
10

Figure 53. Example showing location of daylighting reference points in the zone coordinate system
(relative) of a rectangular zone with three windows. (a) Perspective view, (b) plan view, (c) elevation view.
All dimensions are in meters.
Field: Fraction of Zone Controlled by First Reference Point
The fraction of the zones floor-area whose electric lighting is controlled by the daylight
illuminance at the First Reference Point. If there is only one reference point then a fraction
equal to
1.0 - (Fraction of Zone Controlled by First Reference Point)
is assumed to have no lighting control.
Field: Fraction of Zone Controlled by Second Reference Point
The fraction of the zones floor-area whose electric lighting is controlled by the daylight
illuminance at the Second Reference Point. Required if Total Daylighting Reference Points =
2. A fraction equal to

9/29/14

397

Input-Output Reference

Group Daylighting

1.0 ([Fraction of Zone Controlled by First Reference Point] + [Fraction of Zone

Controlled by Second Reference Point])
is assumed to have no lighting control.
Field: Illuminance SetPoint at First Reference Point
The desired lighting level (in lux) at the First Reference Point. This is the lighting level that
would be produced at this reference point at night if the overhead electric lighting were
operating at full input power. Recommended values depend on type of activity; they may be
found, for example, in the Lighting Handbook of the Illuminating Engineering Society of North
America. A typical value for general office work (excluding computer terminals) is 500 lux.
Field: Illuminance SetPoint at Second Reference Point
The desired lighting level (in lux) at the Second Reference Point. Required if Total Daylighting
Reference Points = 2. This is the lighting level that would be produced at this reference point
at night if the overhead electric lighting were operating at full input power.
Field: Lighting Control Type
The type of overhead electric lighting control. All reference points specified are assumed to
have this type of control.
For Lighting Control Type = 1 (continuous), the overhead lights dim continuously and linearly
from (maximum electric power, maximum light output) to (minimum electric power, minimum
light output) as the daylight illuminance increases. The lights stay on at the minimum point
with further increase in the daylight illuminance.
For Lighting Control Type = 2 (stepped), the electric power input and light output vary in
discrete, equally spaced steps. The number of steps is given by Number of Steps (Excluding
Off) of Stepped Control. For example, if Number of Steps = 3 and Illuminance Setpoint = 600,
then the following table shows the fraction of the lights that are on vs. daylight illuminance.
Table 18. Stepped Lighting Control Example
Example of a Stepped Lighting Control System with Three Steps
Daylight illuminance

Fraction of lights that are on

0-200

1.0

200-400

2/3

400-600

1/3

600 and above

0.0

Lighting Control Type = 3 (continuous/off) is the same as Lighting Control Type = 1 except
that the lights switch off completely when the minimum dimming point is reached.
Field: Glare Calculation Azimuth Angle of View Direction Clockwise from Zone y-Axis
Daylight glare from a window depends on occupant view direction. It is highest when you look
directly at a window and decreases as you look away from a window. This field specifies the
view direction for calculating glare. It is the angle, measured clockwise in the horizontal
plane, between the zone y-axis and the occupant view direction.
Field: Maximum Allowable Discomfort Glare Index
If a daylit zone has windows with shading devices (except exterior screens), the shades will
be deployed if the daylight glare at the First Reference Point exceeds the value of this field.
To get this type of glare control you have to specify Trigger = Glare, GlareOrSolarOnWindow,
GlareOrHorizontalSolar, GlareOrOutsideAirTemp, GlareOrZoneAirTemp or
GlareOrZoneLoad in WindowProperty:ShadingControl for one or more windows in the zone
(see WindowProperty:ShadingControl).
9/29/14

398

Input-Output Reference

Group Daylighting

If a zone has two or more windows with glare control, the shading devices will be deployed
one by one in the order in which the windows are input until the glare level at each reference
point falls below Maximum Allowable Discomfort Glare Index or is as close as possible to it.
The following table gives recommended values of Maximum Allowable Discomfort Glare
Index.
Table 19. Recommended Values -- Discomfort Glare Index
Recommended Values of Maximum Allowable Discomfort Glare Index
Activity or zone type
Art Galleries
Factories

Maximum Allowable Discomfort Glare

Index
16

Rough work

28

Engine assembly

26

Fine assembly

24

Instrument assembly

22

Hospital wards

18

Laboratories

22

Museums

20

Offices

22

School classrooms

20

Field: Minimum Input Power Fraction for Continuous Dimming Control

For Lighting Control Type = 1 (continuous), the lowest power the lighting system can dim
down to, expressed as a fraction of maximum input power (see figure, below). For Lighting
Control Type = 3 (continuous/off) this is the power fraction reached just before the lights
switch off completely.
1.0
Increasing daylight
illuminance

Zero daylight
illuminance

Fractional
light output

Minimum light
output fraction
0
0

1.0
Fractional input power
Minimum input power fraction

Figure 54. Illustration of continuous dimming relationship

The figure above shows the relationship between electric light output and electrical input.
Field: Minimum Light Output Fraction for Continuous Dimming Control
For Lighting Control Type = 1 (continuous), the lowest lighting output the lighting system can
dim down to, expressed as a fraction of maximum light output (see figure, above). This is the
9/29/14

399

Input-Output Reference

Group Daylighting

fractional light output that the system produces at minimum input power. For Lighting Control
Type = 3 (continuous/off) this is the light output fraction reached just before the lights switch
off completely.
Field: Number of Stepped Control Steps
The number of steps, excluding off, in a stepped lighting control system (see figure, below).
Required and must be >0 if Lighting Control Type = 2. The steps are assumed to be equally
spaced.
Step 1
1.0
Step 2
Fractional
input power

Step 3

0
0

Daylight illuminance
Illuminance set point

Figure 55. Stepped lighting control with Number of Steps = 3.

Field: Probability Lighting will be Reset When Needed in Manual Stepped Control
May be specified if a stepped lighting control system (Lighting Control Type = 2) is manually
operated, such as in a simple, one-step (on-off) system. Gives the probability the occupants
of a daylit zone will set the electric lights to the correct level to obtain the required
illuminance. The rest of the time the lights are assumed to be set one step too high. For
example, consider an on-off lighting system (Number of Steps = 1) with a set point of 600 lux
and 0.7 reset probability. Then, when daylighting exceeds 600 lux, the electric lights will be
off 70% of the time and on 30% of the time.
Field: Availability Schedule Name
This alpha field is optional and may be used to define the name of a schedule that denotes
whether or not the control is available to operate during a given time period. If the schedule
value is greater than zero, then the controls will be available to operate for that time period. If
the schedule value is zero or less, then the controls will not be available. If this field is left
blank, the controls will be always available. For example, this can be useful for scheduling the
daylighting controls off during design days so that the daylighting controls do not affect
lighting power during sizing.
An IDF example:

9/29/14

400

Input-Output Reference
Daylighting:Controls,
1,
3.048,3.048,0.9,
0.0,0.0,0.0,
0.99,
0.0,
500.,
500.,
1,
180.0,
20.0,
0.3,
0.2,
0,
1.0;

!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!

Group Daylighting

Zone Name
Total Daylighting Reference Points
X,Y,Z coordinates of first reference point {m}
X,Y,Z coordinates of second reference point, if present {m}
Fraction of zone controlled by first reference point
Fraction of zone controlled by second reference point, if present
Illuminance setpoint at first reference point {lux}
Illuminance setpoint at second reference point, if present {lux}
Lighting control type {1=continuous,2=stepped,3=continuous/off}
Azimuth angle of view direction for glare calculation {deg},
measured clockwise from zone y-axis. Value of 180 gives view
(from reference point) that is directly at window, maximizing glare.
Maximum discomfort glare index for window shade control
Minimum input power fraction for continuous dimming control
Minimum light output fraction for continuous dimming control
Number of steps, excluding off, for stepped control
Probability electric lighting will be reset when needed (used only
for stepped control, to simulate manual on/off control)

Guidelines for Daylighting Modeling (Detailed Method)

Following are some guidelines for preparing EnergyPlus input to model the effects of
daylighting. Before studying these guidelines, however, you should read the description of
each input field under Daylighting:Controls, and review the IDF example, above, and the
sample daylighting input, PurchAirWithDaylighting.idf.
Use of Window Multipliers
If an exterior wall in a daylit zone has a number of identical windows, the windows should be
entered separately rather than using a window multiplier (ref: FenestrationSurface:Detailed).
Using a multiplier would give an incorrect illuminance calculation since individual windows
would not be positioned correctly on the wall.
Use of Zone Multipliers
A zone multiplier should not be used on a daylit zone if the windows in the zone are
shadowed by exterior obstructions like trees or neighboring buildings, or by obstructions
caused by other parts of building. The reason for this is that the shadowing on the windows of
the multiplied zone may be different from zone to zone depending on exactly how the
shadows fall on the zones. However, a zone multiplier may be used on a daylit zone if the
shadowing is by overhangs, fins and/or window setback.
Thermal Zoning for Daylighting
To correctly calculate both direct and inter-reflected daylight illuminance you should try to
model a thermal zone consisting of several similar rooms separated by interior walls as a
representative room with a zone multiplier (ref: Zone). An example of this is shown in Figure
56. Room-1 is the representative room, with a zone multiplier = 4.
Interior walls IW-1, IW-2 and IW-3 should be treated as adiabatic, i.e., they should have
Outside Boundary Condition = Surface and Outside Boundary Condition Object = IW-1, IW-2,
or IW-3, respectively (ref: BuildingSurface:Detailed). Similarly, if the ceiling and floor of
Room-1 are interior surfaces, they should be treated as adiabatic.

9/29/14

401

Input-Output Reference

Group Daylighting

Zone Multiplier = 4
IW-3

IW-1

IW-2
Room-1

Figure 56. For daylighting purposes the thermal zone enclosed by the dashed boundary line should be
modeled as a typical zone (Room-1) with a zone multiplier of 4.
Sometimes a representative room cannot be found. Figure 57 shows a section of a building
with four rooms having different daylighting characteristics because of different floor area,
orientation and/or window size. In this case lumping the rooms into a single thermal zone
would give nonsensical daylighting illuminance values because of the presence of the interior
walls, which EnergyPlus ignores when calculating illuminance reaching a reference point
directly from a window (i.e., without reflection). The solution in this case is to describe each
room as a separate thermal zone with its own daylighting reference points, and input the
interior walls because these will participate in the calculation of inter-reflected illuminance.

A
C

B
Figure 57. Rooms A, B, C and D have different daylighting characteristics. If lumped into a single thermal
zone the daylighting calculation will be less accurate because the blockage of direct light by the interior
walls between these rooms is modeled with some simplifications (see Interior Obstructions below). To get
a good daylighting calculation each room should be input as a separate thermal zone.
Multiple Lighting Zones
The detailed daylighting calculation allows a thermal zone to be divided into two
independently-controlled lighting zones. (See the fields: Fraction of Zone Controlled by First
Reference Point, Fraction of Zone Controlled by Second Reference Point, Illuminance
SetPoint at First Reference Point, and Illuminance SetPoint at Second Reference Point.) An
example is shown in Figure 58, where a relatively deep thermal zone has two lighting zones
of equal area.

9/29/14

402

Input-Output Reference

Group Daylighting

Second Reference Point

Fraction of Zone Controlled by
Second Reference Point = 0.5
First Reference Point
Fraction of Zone Controlled by
First Reference Point = 0.5
Figure 58. Two independently-controlled lighting zones, each with 50% of the area of the thermal zone.
Fins, Overhangs and Other Exterior Obstructions
The daylighting calculation accounts for the presence of exterior obstructions in determining
the amount of light that strikes the windows. For daylighting purposes exterior obstructions
fall into three categories:
(1) Fins, overhangs, trees, neighboring buildings, etc., entered with the objects
Shading:Zone:Detailed,
Shading:Site:Detailed, or
Shading:Building:Detailed.
(2) Building surfaces like walls and roofs (in an L-shaped building, for example).
(3) Surfaces associated with window setback.
Category (1) obstructions can have an associated solar transmittance schedule (see
description of the field Transmittance Schedule Name for these shading surfaces). If this
schedule is not specified, the surface is opaque (has zero transmittance).
The daylighting calculation takes the transmittance into account in determining, for example,
how much light enters a window through a translucent awning. It is assumed that the solar
and visible transmittance is the same and that the surfaces are non-diffusing, i.e., they do not
change the direction of transmitted light. Ref:Daylighting:Controls.
Category (2) and (3) surfaces are assumed to be opaque.
Surfaces in all three categories are assumed to be black, i.e., they do not reflect light, unless
you set if Reflections option is chosen in the Building object. Then obstructions can reflect
light, such as the top of an overhang reflecting light onto the window above. Ref: Building,
Field: Solar Distribution (with reflections options).
Interior Obstructions
The daylighting calculation accounts for the presence of interior obstructions that lie between
a window and a reference point. Unlike exterior obstructions, which can be light transmitting,
interior obstructions are assumed to be opaque. Interior obstructions can reduce or eliminate
the light directly reaching the reference point through a window.
However, interior obstructions that are walls, ceilings or floors are reflecting so they
contribute to the inter-reflected component of daylight illuminance as do the non-obstructing
zone surfaces.
Interior obstructions can belong to the Shading object series. This type of obstruction is
assumed to be non-reflecting so does not contribute to the inter-reflected component of
daylight illuminance.
An example of an interior obstruction that is a wall in an L-shaped room is shown in Figure
59. Here, wall A (or, equivalently, Wall B) prevents light from directly getting to the Reference
Point from the window.

9/29/14

403

Input-Output Reference

Group Daylighting

Window

Reference
point

Wall B
Wall A

Figure 59. Wall A (or Wall B) is an interior obstruction that prevents light from directly reaching the
daylighting reference point from the window.
Double Faades: Daylighting through Interior Windows
The Daylighting:Controls method, with no additional user input, calculates the contribution of
daylight that passes into a target zone through interior windows. 5 The origin of this daylight is
exterior windows in adjacent zones that share interior windows with the target zone. This
capability is aimed at daylighting through a double faade (also called double envelope or
double skin.)
This is illustrated in Figure 60, which shows a double-faade buffer zone, Z0, with exterior
windows EW1 and EW2. Z0 shares interior windows IW1, IW2 and IW3 with daylit occupied
zones ZD1, ZD2 and ZD3, respectively (daylit here means the zone has an associated
Daylighting:Controls object). The daylight illuminance at reference points RP1, RP2 and RP3
comes from the interior windows and has two main sources:
1. Daylight that passes through both an exterior window and an interior window in Z0
and reaches a reference point without reflection. This is called direct illuminance.
2. Daylight from Z0 that passes through an interior window and reaches a reference
point by inter-reflection in the daylit zone. Because the program calculates this
source from the interior solar distribution in Z0 it is recommended that the most
accurate calculation of this distribution be made, which occurs if Solar Distribution =
FullInteriorAndExterior in the Building object.
A third possible source is neglected because it is generally small in double-faade cases.
This is daylight that is reflected from the surfaces of Z0, passes through an interior window
and then reaches a reference point without inter-reflection in the daylit zone.
PurchAirWithDoubleFacadeDaylighting.idf is an input example of daylighting through an
interior window.

9/29/14

Formerly, only the exterior windows in a zone could provide daylight to that zone.

404

Input-Output Reference

Group Daylighting

Buffer
zone
IW3
RP3

ZD3

EW2
IW2
EW1

Z0

IW1

RP2

ZD2

RP1

ZD1

Daylit
occupied
zones

Figure 60. Vertical section through a double-faade building showing daylighting through interior
windows. The dashed lines show that (1) reference point RP1 receives direct light from exterior window
EW1 via interior window IW1; (2) RP2 receives direct light from EW1 and EW2 via IW2; and (3) RP3
receives direct light from EW2 via IW3.
Interior Window Daylighting Configurations that EnergyPlus Can Calculate
Figure 61 shows schematically the general configuration of daylighting through interior
windows that can be calculated with EnergyPlus. Here, daylit zone ZD has one or more
interior windows that are adjacent to other zones, each of which has one or more exterior
windows. ZD itself may or may not have exterior windows. If it does, than the daylight
illuminance from its exterior and interior windows will be additive. The zones adjacent to ZD
may or may not be daylit and may or may not have other interior windows that are not
adjacent to ZD. (The program does not consider the illuminance in ZD from electric lighting in
adjacent zones.)

EW

EW

IW
IW

ZD
Daylit
zone

EW
IW
EW

Figure 61. General configuration of daylighting through interior windows that can be calculated with
EnergyPlus. IW = interior window, EW = exterior window.
Interior Window Daylighting Configurations that EnergyPlus Cannot Calculate
Figure 62 shows schematically a configuration of daylighting through interior windows that
cannot be calculated with EnergyPlus. Here, zone Z has an interior window that is adjacent to
zone Z1 which in turn has an interior window adjacent to zone Z2. However, the daylight from
the exterior window in Z2 that enters Z after passing through Z1 is not calculated because Z2
is not adjacent to Z.

9/29/14

405

Input-Output Reference

Group Daylighting

IW

EW

IW

Z1

Z2

Figure 62. Configuration in which daylighting of zone Z through its interior window cannot
be calculated with EnergyPlus. IW = interior window, EW = exterior window.
Restrictions on Shading Devices
There are two restrictions on the use of exterior-window shading devices when a daylit zone
has interior windows:
1) If two daylit zones share an interior window, neither zone can have an exterior window

whose shading device does glare control (i.e., the WindowProperty:ShadingControl for
the exterior window has Glare Control Is Active = Yes).

2) If two daylit zones share an interior window, neither zone can have an exterior window

with a WindowProperty:ShadingControl
MeetDaylightIlluminanceSetpoint.

that

has

Shading

Control

Type

DElight Daylighting Method

The DElight method of analyzing daylighting in buildings is very similar to that used in the
Detailed method. For each point in time, DElight calculates the interior daylighting illuminance
at specified reference points and then determines how much the electric lighting can be
reduced while still achieving a combined daylighting and electric lighting illuminance target.
The daylight illuminance level in a zone depends on many factors, including exterior light
sources; location, size, and visible light transmittance of simple and complex fenestration
systems; reflectance of interior surfaces; and location of calculation reference points. The
subsequent reduction of electric lighting depends on daylight illuminance level, illuminance
set point, fraction of zone controlled, and type of lighting control.
There are two primary differences between the Detailed and DElight methods of calculating
interior illuminance levels. The first is that DElight includes the capability of analyzing
complex fenestration systems that include geometrically complicated shading systems (e.g.,
roof monitors) and/or optically complicated glazings (e.g., prismatic or holographic glass).
The second key difference is that DElight uses a radiosity method to calculate the effects of
light reflection inside a zone. These methods are discussed in more detail in the engineering
documentation.
There are other important differences between the two methods. One is the inability of
DElight to perform the type of dynamic shading controls possible using the Detailed method
at each point in time during the thermal simulation (e.g., changes in electrochromic glazing
transmittances and blind slat angles). Another is the DElight ability to include more than two
reference points in its interior illuminance and electric lighting reduction calculations. A third is
the current lack of visual quality (e.g., glare) calculations performed by DElight. Fourth, the
modeling of interior obstructions is different in the two methods. In the DElight method interior
obstructions block interreflections but do not block the intial direct illuminance. In the Detailed
method, interior obstructions block the initial direct illuminance but do not block
interreflections. See the engineering documentation for more details.
Input
for
invoking
the
DElight
method
involves
three
object
types:
Daylighting:DELight:Controls,
Daylighting:DELight:ReferencePoint,
and
Daylighting:DELight:ComplexFenestration. Each of these objects is described below.

9/29/14

406

Input-Output Reference

Group Daylighting

Daylighting:DELight:Controls
The first input object required for invoking the DElight method is the
Daylighting:DELight:Controls object, which defines the parameters of each daylighting zone
within a building. This object must be associated with a specific thermal zone within the
building for which the reduction in electric lighting due to daylight illuminance will be
accounted.
Field: Name
User name of the DElight daylighting zone to which the following input applies.
Field: Zone Name
The name of the thermal Zone hosting this DElight daylighting zone. This must be a valid
name that has been associated with a thermal Zone contained in the same EnergyPlus input
data file.
Field: Lighting Control Type
The type of overhead electric lighting control. All reference points specified are assumed to
have this type of control.
For Lighting Control Type = 1 (continuous), the overhead lights dim continuously and linearly
from (maximum electric power, maximum light output) to (minimum electric power, minimum
light output) as the daylight illuminance increases. The lights stay on at the minimum point
with further increase in the daylight illuminance.
For Lighting Control Type = 2 (stepped), the electric power input and light output vary in
discrete, equally spaced steps. The number of steps is given by Number of Steps (Excluding
Off) of Stepped Control. For example, if Number of Steps = 3 and Illuminance Setpoint = 600,
then the following table shows the fraction of the lights that are on vs. daylight illuminance.
Table 20. Stepped Lighting Control Example
Example of a Stepped Lighting Control System with Three Steps
Daylight illuminance

Fraction of lights that are on

0-200

1.0

200-400

2/3

400-600

1/3

600 and above

0.0

Lighting Control Type = 3 (continuous/off) is the same as Lighting Control Type = 1 except
that the lights switch off completely when the minimum dimming point is reached.
Field: Minimum Input Power Fraction for Continuous Dimming Control
For Lighting Control Type = 1 (continuous), the lowest power the lighting system can dim
down to, expressed as a fraction of maximum input power (see figure, below). For Lighting
Control Type = 3 (continuous/off) this is the power fraction reached just before the lights
switch off completely.

9/29/14

407

Input-Output Reference

Group Daylighting
1.0

Zero daylight
illuminance

Increasing daylight
illuminance
Fractional
light output

Minimum light
output fraction
0
0

1.0
Fractional input power
Minimum input power fraction

Figure 63. Illustration of continuous dimming relationship

The figure above shows the relationship between electric light output and electrical input.
Field: Minimum Light Output Fraction for Continuous Dimming Control
For Lighting Control Type = 1 (continuous), the lowest lighting output the lighting system can
dim down to, expressed as a fraction of maximum light output (see figure, above). This is the
fractional light output that the system produces at minimum input power. For Lighting Control
Type = 3 (continuous/off) this is the power fraction reached just before the lights switch off
completely.
Field: Number of Steps (Excluding Off) for Stepped Control
The number of steps, excluding off, in a stepped lighting control system (see figure, below).
Required and must be >0 if Lighting Control Type = 2. The steps are assumed to be equally
spaced.
Step 1
1.0
Step 2
Fractional
input power

Step 3

0
0

Daylight illuminance
Illuminance set point

Figure 64. Stepped lighting control with Number of Steps = 3.

Field: Probability Lighting Will Be Reset When Needed in Manual Stepped Control
May be specified if a stepped lighting control system (Lighting Control Type = 2) is manually
operated, such as in a simple, one-step (on-off) system. Gives the probability the occupants
of a daylit zone will set the electric lights to the correct level to obtain the required
illuminance. The rest of the time the lights are assumed to be set one step too high. For
9/29/14

408

Input-Output Reference

Group Daylighting

example, consider an on-off lighting system (Number of Steps = 1) with a set point of 600 lux
and 0.7 reset probability. Then, when daylighting exceeds 600 lux, the electric lights will be
off 70% of the time and on 30% of the time.
Field: Gridding Resolution
The maximum surface area for nodes in gridding (subdividing) all surfaces in the DElight
zone. All reflective and transmitting surfaces will be subdivided into approximately square
nodes that do not exceed this maximum. Higher resolution subdivisions require greater
calculation times, but generally produce more accurate results. This same gridding resolution
is also used to subdivide any Complex Fenestration System surfaces. It is advisable to
perform at least one simulation of new input using a small gridding resolution such as 0.1m2
to compare these results against simulation runs at lower resolution (i.e., higher maximum
area nodal grids) to get a sense of possible levels of error.
An IDF example:
Daylighting:DELight:Controls,
DElight NORTH ZONE, !- DElight Zone Name
NORTH ZONE,
!- Zone Name
1,
!- Lighting control type
0.3,
!- Minimum input power fraction for continuous dimming control
0.2,
!- Minimum light output fraction for continuous dimming control
0,
!- Number of steps (excluding off) for stepped control
1.0,
!- Probability lighting will be reset when needed in manual stepped control
1.0;
!- Gridding Resolution {m2}

Daylighting:DELight:ReferencePoint
The second input object required for invoking the DElight method is the
Daylighting:DELight:ReferencePoint object, which defines the parameters of each Reference
Point within the associated DElight daylighting zone. This object must be associated with a
specific Daylighting:DELight:Controls object instance. There may be up to a maximum of 100
Reference Points for each DElight daylighting zone. Each Reference Point that is input does
NOT need to be included in the control of the electric lighting system within the zone. This is
determined by the fraction of the zone controlled by each Reference Point, which can be
input as 0. Note that the sum of all Reference Point control fractions must equal 1 to obtain
correct overall results.
Field: Name
User name of the DElight daylighting Reference Point to which the following input applies.
Field: DElight Name
The name of the Daylighting:DELight:Controls object instance hosting this Reference Point.
This must be a valid name that has been associated with a DElight daylighting Zone
contained in the same EnergyPlus input data file.
Fields: (X,Y,Z) of Reference Point
These three fields are the X, Y and Z values of the Reference point in the coordinate system
you specified for daylighting reference points in the GlobalGeometryRules object. Figure 65
shows an example using the relative coordinate (to zone) system. Z is typically at work
surface height (e.g., 0.8m for a desk).

9/29/14

409

Input-Output Reference

Group Daylighting

Zzone
First
Reference
Point, at
(5,5,0.8)

Second
Reference
Point, at
(5,15,0.8)
Window

(a)

5 0.8

0.8

Yzone

5
10

15
20

Xzone
Yzone

(b)

Second
Reference
Point, at
(5,15,0.8)

Window

Zzone

20

15

First
Reference
Point, at
(5,5,0.8)

(c)
15
5

0.8

0.8

Yzone

20
5

Xzone
10

Figure 65. Example showing location of two daylighting reference points in the zone coordinate system
(relative) of a rectangular zone with three windows. (a) Perspective view, (b) plan view, (c) elevation view.
All dimensions are in meters.
Field: Fraction of Zone Controlled by Reference Point
The zone floor-area fraction of the electric lighting that is controlled by the daylight
illuminance at this Reference Point. If the sum of the values for this field for all Reference
Points input for a given daylighting zone is less than 1.0, then the remaining fraction (i.e., 1.0
Sum) is assumed to not have lighting control.
Note that Reference Points may be input with a 0.0 value for this fraction. In this case,
daylight factors and interior illuminance values will be calculated for the Reference Point, but
it will play no role in controlling the electric lighting within the daylighting zone to which it
belongs.

9/29/14

410

Input-Output Reference

Group Daylighting

Field: Illuminance Setpoint at Reference Point

The desired lighting level (in lux) at this Reference Point. This is assumed to be the lighting
level that would be produced at this reference point at night if the overhead electric lighting
were operating at full input power. Recommended values depend on the type of activity and
may be found, for example, in the Lighting Handbook of the Illuminating Engineering Society
of North America. A typical value for general office work (excluding computer terminals) is
500 lux.
An IDF example:
Daylighting:DELight:ReferencePoint,
RefPt 2,
!- Reference Point Name
DElight NORTH ZONE, !- DElight Zone Name
5.0, !- X-coordinate of reference point {m}
3.0, !- Y-coordinate of reference point {m}
0.9, !- Z-coordinate of reference point {m}
0.5, !- Fraction of zone controlled by reference point
500.; !- Illuminance setpoint at reference point {lux}

Daylighting:DELight:ComplexFenestration
The third input object related to the DElight method is the Daylighting:DElight: Complex
Fenestration object. The DElight daylighting analysis method can be applied to daylighting
zones that contain only simple fenestration systems such as windows and skylights that are
standard EnergyPlus sub-surfaces. In this situation, no Daylighting:DElight: Complex
Fenestration object would be input.
In addition to analyzing simple fenestration systems, DElight includes the capability of
analyzing complex fenestration systems such as geometrically complicated static shading
systems (e.g., roof monitors) and/or optically complicated glazings (e.g., prismatic or
holographic glass). This capability is based on characterizing these complex fenestration
systems (CFS) using bi-directional transmittance distribution functions (BTDF). In general,
BTDF data for a specific CFS must be either measured or simulated (e.g., using ray-tracing
techniques) prior to employing DElight to analyze it within EnergyPlus. The current
implementation of DElight CFS calculations within EnergyPlus supports two approaches to
the input of BTDF, an analytical approach and a file-based approach. The details of inputting
these two approaches are described below under the User Complex Fenestration Type field.
Two analytical CFS BTDF types are currently supported, window and light shelf. The filebased approach requires that a user has access to a data file containing raw BTDF data that
DElight reads as additional input during its analysis calculations. BTDF data files are
described separately since it is anticipated that individual EnergyPlus users will not create
these data files themselves.
The methods related to characterizing and analyzing CFS using BTDF are still evolving.
DElight is an early implementation of CFS analysis methods. These methods, and the input
associated with them here, will likely change in the future.
Field: User Name
User name of the DElight daylighting Complex Fenestration to which the following input
applies.
Field: Complex Fenestration Type
Type name of the DElight daylighting Complex Fenestration system to be analyzed. This type
name must take one of the following two forms.
BTDF^GEN^Analytical Type^Normal Visible Transmittance^Dispersion Angle
BTDF^FILE^Filename

9/29/14

411

Input-Output Reference

Group Daylighting

The first form above is for supported analytical CFS types which currently include WINDOW
and LIGHTSHELF. While these analytical types are relatively simple, they represent flexible
ways to explore diffusing CFS systems and the impact of light shelves in redirecting light
through an aperture. Each of these types also requires the visible transmittance of the CFS at
normal incidence angle, and a dispersion angle (in degrees) that represents the spread of
transmitted light. A small dispersion angle of 10 corresponds to clear glazing while a large
angle of 90 corresponds to perfectly diffusing glazing. The ^ symbol must be used as a
delimiter between sub-fields within this Complex Fenestration type name string as shown in
the IDF example for WINDOW below, and in the DElight sample input data files.
The second form above is for CFS types for which there is pre-measured or pre-simulated
BTDF data. In this case the Filename sub-field must be a valid data file name that is
associated with an existing BTDF dataset that DElight can use in its calculations.
Field: Building Surface Name
The name of the heat transfer surface object instance hosting this Complex Fenestration,
analogous to the Building Surface Name field for subsurfaces such as Windows. This must
be a valid name that has been associated with a heat transfer surface contained in the same
EnergyPlus input data file.
Field: Window Name
The name of the Window (ref: FenestrationSurface:Detailed object) instance that will be used
to account for the geometry, and the solar/thermal gains/losses, of the Complex Fenestration
system surface. This must be a valid name that has been associated with a Window
contained in the same EnergyPlus input data file. The geometry for the Complex Fenestration
is taken from the geometry input for this standard EnergyPlus subsurface, hence the term
Doppelganger.
Note that DElight only deals with the visible spectrum of light transmitted through a Complex
Fenestration. To account for the solar/thermal influences of a Complex Fenestration, a
geometrically coincident subsurface that will be accounted for by methods already within
EnergyPlus must be defined in the input data file. This is an interim solution to the issue of
accounting for solar/thermal influences that will likely change as techniques analogous to the
daylighting analysis of BTDF are developed.
Field: Fenestration Rotation
The in-plane counter-clockwise rotation angle between the Complex Fenestration optical
reference direction and the base edge of the Doppelganger Surface geometry. The Complex
Fenestration optical reference direction is the direction of the zero azimuth angle for the
BDTF dataset. This Rotation angle will typically be zero when the Doppelganger surface is
rectangular and its width edge is aligned with the Complex Fenestration optical reference
direction.
An IDF example for an analytical WINDOW type CFS:
Daylighting:DELight:ComplexFenestration,
Window CFS,
!- DElight Complex Fenestration User Name
BTDF^GEN^WINDOW^1.0^20.0,
!- Complex Fenestration Type
ZN003:WALL001, !- Complex Fenestration Host Surface
Zn003:Wall001:Doppel001, !- Doppelganger Surface Name
0.0;
!- Fenestration Rotation {deg}

DElight Output
In addition to the daylighting-specific outputs for DElight listed below, two ASCII text files are
created during an EnergyPlus run that includes DElight analysis. Following completion of an
EnergyPlus run, these files are given names that consist of the project name appended with
DElight.in and DElight.out. The format of these files is described in the Output Details and
Examples document.
Zone,Average,Daylighting Reference Point Illuminance [lux]
9/29/14

412

Input-Output Reference

Group Daylighting

Zone,Average,Daylighting Lighting Power Multiplier []

Daylighting Reference Point Illuminance [lux]

The total daylight illuminance at a DElight reference point from all of the exterior windows in a
daylit zone.
Daylighting Lighting Power Multiplier []
The amount by which the overhead electric lighting power in a zone is multiplied due to
usage of DElight calculated daylighting to dim or switch electric lights. For example, if the
multiplier is M and the electric power without dimming is P, then the electric power with
dimming is M*P. The multiplier varies from 0.0, which corresponds to maximum dimming
(zero electric lighting), to 1.0, which corresponds to no dimming.
Daylighting Output
The following daylighting-specific outputs are available for Daylighting:Controls:
Zone,Average,Site Exterior Beam Normal Illuminance [lux]
Zone,Average,Site Exterior Horizontal Beam Illuminance [lux]
Zone,Average,Site Exterior Horizontal Sky Illuminance [lux]
Zone,Average,Site Beam Solar Radiation Luminous Efficacy [lum/W]
Zone,Average,Site Sky Diffuse Solar Radiation Luminous Efficacy [lum/W]
Zone,Average,Site Daylighting Model Sky Clearness []
Zone,Average,Site Daylighting Model Sky Brightness []
Surface,Average,Daylighting Window Reference Point 1 View Luminance [cd/m2]
Surface,Average,Daylighting Window Reference Point 1 Illuminance [lux]
Zone,Average,Daylighting Reference Point 1 Illuminance [lux]
Zone,Average,Daylighting Reference Point 1 Glare Index []
Zone,Sum,Daylighting Reference Point 1 Glare Index Setpoint Exceeded Time [hr]
Zone,Sum,Daylighting Reference Point 1 Daylight Illuminance Setpoint Exceeded Time
[hr]
Surface,Average,Daylighting Window Reference Point 2 View Luminance [cd/m2]
Surface,Average,Daylighting Window Reference Point 2 Illuminance [lux]
Zone,Average,Daylighting Reference Point 2 Illuminance [lux], if applicable
Zone,Average,Daylighting Reference Point 2 Glare Index [], if applicable
Zone,Sum,Daylighting Reference Point 2 Glare Index Setpoint Exceeded Time [hr]
Zone,Sum,Daylighting Reference Point 2 Daylight Illuminance Setpoint Exceeded Time
[hr]
Zone,Average,Daylighting Lighting Power Multiplier []

Site Exterior Beam Normal Illuminance [lux]

Beam normal illuminance of the sun at the earths surface, measured in lux (lumens/m 2)
Site Exterior Horizontal Beam Illuminance [lux]
Beam illuminance on an unobstructed horizontal plane at the earths surface. Equals Site
Exterior Beam Normal Illuminance times sine of solar altitude.
Site Exterior Horizontal Sky Illuminance [lux]
Illuminance from sky solar radiation on an unobstructed horizontal plane at the earths
surface. The total exterior horizontal illuminance is the sum of Site Exterior Horizontal Beam
Illuminance and Site Exterior Horizontal Sky Illuminance.
Site Beam Solar Radiation Luminous Efficacy [lum/W]
A measure of the visible light content of beam solar radiation; equal to the number of lumens
per watt of beam solar radiation. Depends on atmospheric conditions (moisture, turbidity,
cloudiness) and solar altitude.
Site Sky Diffuse Solar Radiation Luminous Efficacy [lum/W]
A measure of the visible light content of sky diffuse solar radiation; equal to the number of
lumens per watt of sky diffuse solar radiation. Depends on atmospheric conditions (moisture,
turbidity, cloudiness) and solar altitude.
9/29/14

413

Input-Output Reference

Group Daylighting

Site Daylighting Model Sky Clearness [ ]

Clearness of sky. One of the factors used to determine sky type and luminous efficacy of
solar radiation (see EnergyPlus Engineering Document). Sky Clearness close to 1.0
corresponds to an overcast sky. Sky Clearness > 6 is a clear sky.
Site Daylighting Model Sky Brightness [ ]
Brightness of sky. One of the factors used to determine sky type and luminous efficacy of
solar radiation (see EnergyPlus Engineering Document).
Daylighting Window Reference Point 1 View Luminance [cd/m2]
The area-averaged luminance of an exterior window as viewed from the first reference point
in the daylit zone containing the window. In general, higher window luminance values are
associated with higher daylight glare values. (Printed only for exterior windows in daylit zones
without interior windows.)
Daylighting Window Reference Point 1 Illuminance [lux]
The contribution from a particular exterior window to the daylight illuminance at the first
reference point in the daylit zone containing the window. (Not printed for exterior windows in
daylit zones with interior windows.)
Daylighting Reference Point 1 Illuminance [lux]
The total daylight illuminance at the first reference point from all of the windows in a daylit
zone.
Daylighting Reference Point 1 Glare Index []
The daylight glare index at the first reference point in a daylit zone.
Daylighting Reference Point 1 Glare Index Setpoint Exceeded Time [hr]
The number of hours when the calculated daylight glare index at the first reference point
exceeds the glare index setpoint.
Daylighting Reference Point 1 Daylight Illuminance Setpoint Exceeded Time [hr]
The number of hours when the calculated daylight illuminance at the first reference point
exceeds the daylight illuminance setpoint.
Daylighting Reference Point 2 Illuminance [lux]
The total daylight illuminance at the second reference point from all of the windows in a daylit
zone.
Daylighting Window Reference Point 2 View Luminance [cd/m2]
The area-averaged luminance of an exterior window as viewed from the second reference
point, if present, in the daylit zone containing the window. Note that, for a bare window, this
value can be different from the corresponding value at the first reference point since different
regions of the sky and ground will be visible from the two reference points, and different
ranges of angles of incidence and associated glass transmittance values will be involved.
(Not printed for exterior windows in daylit zones with interior windows.)
Daylighting Window Reference Point 2 Illuminance [lux]
The contribution from a particular exterior window to the daylight illuminance at the second
reference point, if present, in the daylit zone containing the window. (Not printed for exterior
windows in daylit zones with interior windows.)
Daylighting Reference Point 2 Glare Index []
The daylight glare index at the second reference point, if present, in a daylit zone.
9/29/14

414

Input-Output Reference

Group Daylighting

Daylighting Reference Point 2 Glare Index Setpoint Exceeded Time [hr]

The number of hours when the calculated daylight glare index at the second reference point
exceeds the glare index setpoint.
Daylighting Reference Point 2 Daylight Illuminance Setpoint Exceeded Time [hr]
The number of hours when the calculated daylight illuminance at the second reference point
exceeds the daylight illuminance setpoint.
Daylighting Lighting Power Multiplier []
The amount by which the overhead electric lighting power in a zone is multiplied due to
usage of daylighting to dim or switch electric lights. For example, if the multiplier is M and the
electric power without dimming is P, then the electric power with dimming is M*P. The
multiplier varies from 0.0, which corresponds to maximum dimming (zero electric lighting), to
1.0, which corresponds to no dimming.
Output:IlluminanceMap
The Output:IlluminanceMap object expands on the reporting capabilities of the daylighting
simulation. For any zone simulated with Daylighting:Controls, the illuminance map can
generate up to 2,500 points of additional daylighting illuminance values. The resulting map is
output as a comma delimited text file that can be imported into a spreadsheet program for
rapid visualization of the daylighting illuminance patterns in a zone. The values are produced
on an hourly basis. The Z height of the map is constant (parallel to a flat floor). More than one
illuminance map can be created for a zone.
Field: Name
The name of the map object.
Field: Zone Name
Reference to a zone with Daylighting:Controls.
Field: Z Height
The height or elevation of the grid of daylighting points.
Field: X Minimum Coordinate
The minimum X coordinate boundary for the map.
Field: X Maximum Coordinate
The maximum X coordinate boundary for the map.
Field: Number of X Grid Points
The number of daylighting reference points in the X direction from the minimum to the
maximum boundaries. The maximum number of points that can be generated is 2500
(Number of X Grid Points X Number of Y Grid Points).
Field: Y Minimum Coordinate
The minimum Y coordinate boundary for the map.
Field: Y Maximum Coordinate
The maximum Y coordinate boundary for the map.
Field: Number of Y Grid Points
The number of daylighting reference points in the Y direction from the minimum to the
maximum boundaries. The maximum number of points that can be generated is 2500
(Number of X Grid Points X Number of Y Grid Points).
9/29/14

415

Input-Output Reference

Group Daylighting

Note: Daylighting factors cannot be accurately calculated for reference points that are very close to a wall
or window (less than 0.15 m or 6 inches). An error is reported for a reference point that is too close to a
window, but no error is reported for a point that is too close to a wall.

Output:IlluminanceMap,
Daylit Map,
! Map Name
Daylit Zone,
! Zone Name
0,
! Z Height [m]
0.1,
! X Minimum Coordinate [m]
4.9,
! X Maximum Coordinate [m]
10,
! Number of X Grid Points
0.1,
! Y Minimum Coordinate [m]
9.9,
! Y Maximum Coordinate [m]
10;
! Number of Y grid Points

Since not all zones are rectangular, it is possible to have map points that are outside the
zone. Any illuminance registered at these points is inaccurate and, additionally, a * marks
these values for easy observance.
OutputControl:IlluminanceMap:Style
This object specifies the style for the illuminance map output (described in the Output
Details and Examples document). As described early in the document (see: EnergyPlus
Output Processing), the user may select the style for the daylighting illuminance map output
file (eplusmap.<ext>).
Field: Column Separator
For this field, the desired separator for columns is entered. Comma creates comma
separated fields/columns in the outputs (eplusmap.csv file is created). Tab creates tab
separated fields/columns in the outputs (eplusmap.tab file is created). Fixed creates space
separated fields/columns in the outputs (eplusmap.txt file is created) but these are not
necessarily lined up for easy printing.
Note that both tab and comma separated files easily import into Excel or other spreadsheet
programs. The tab delimited files can also be viewed by text editors, word processing
programs and easily converted to tables within those programs.
Daylighting Devices
Daylighting devices work in conjunction with the Daylighting:Controls object to simulate
components that can improve daylighting in a zone.
Daylighting devices are also tightly integrated into the zone heat balance. The thermal effects
of these devices are simulated with or without the use of a Daylighting:Controls object.
There are two types of daylighting device in EnergyPlus: tubular daylighting devices and
daylighting shelves.
DaylightingDevice:Tubular
Tubular daylighting devices (TDDs), also known as tubular skylights or light pipes, are used
to bring natural exterior daylight into the hard-to-reach, interior spaces of a building.
TDDs consist of three components: a dome, a pipe, and a diffuser.

9/29/14

416

Input-Output Reference

Group Daylighting

Figure 66. Tubular daylighting device diagram.

In EnergyPlus each of these components corresponds to an object in the input file.
The dome and diffuser are defined in the same way as windows using the
FenestrationSurface:Detailed object. The Surface Type field must be specified as
TubularDaylightDome or TubularDaylightDiffuser accordingly.
The location and orientation of the dome surface affect the total amount of daylight collected.
The Base Surface of the diffuser object determines to which zone the daylighting is delivered.
The location and orientation of the diffuser surface affect the amount of daylight received at
the Daylighting:Controls reference points.
Although the object definition is the same as for a window, there are several restrictions on
TubularDaylightDome and TubularDaylightDiffuser objects:
Shading control devices are not allowed.
Frames and dividers are not allowed.
Multipliers must be 1.0.
Dome, diffuser, and pipe areas (as given by diameter) must be approximately equal.
Outside face environment objects are not allowed.
Dome and diffuser constructions cannot be more than one layer.
Since commercial TDDs are assumed to be cylindrical in shape, it is recommended that the
circular areas of the actual dome and diffuser be approximated with a square of equivalent
area for the TubularDaylightDome and TubularDaylightDiffuser objects. Although it is
possible to use a triangular surface instead, a square is a much better geometric
approximation of a circle.
Note that the TubularDaylightDome surface is allowed to have a different position and tilt
from the roof base surface. If the actual TDD projects some height above the roof surface,
the TubularDaylightDome coordinates should be located accordingly.

9/29/14

417

Input-Output Reference

Group Daylighting

Figure 67. Tubular daylighting device DXF output.

The TubularDaylightDome surface automatically casts a shadow on the roof base surface.
However, since the pipe is not represented by a surface, it will not cast a shadow. If this
effect must be simulated, one or more SURFACE:SHADING objects can be used.
The dome and diffuser objects are connected by the DAYLIGHTING DEVICE:TUBULAR
object:
Field: Name
The name of the TDD object.
Field: Dome Name
Reference to a FenestrationSurface:Detailed object with Surface Type TubularDaylightDome.
Field: Diffuser Name
Reference
to
a
FenestrationSurface:Detailed
TubularDaylightDiffuser.

object

with

Surface

Type

Field: Construction Name

The construction of the TDD pipe. The visible and solar absorptance of the inside material
layer determines the reflectivity of the inner mirrored surface of the TDD. This is very
important for the overall transmittance of the TDD.
Field: Diameter
The diameter [m] of the TDD pipe. The area of the pipe must match the areas of the dome
and diffuser.
Field: Total Length
The total length [m] of the TDD pipe between the dome and the diffuser, including the exterior
part above the roof. The exterior length is determined internally by subtracting the transition
zone lengths from the total length.
Field: Effective Thermal Resistance
The effective thermal resistance [m 2-K/W], i.e. R-value, of the TDD between the exterior
dome surface and the interior diffuser surface.

9/29/14

418

Input-Output Reference

Group Daylighting

Field: Transition Zone<#> Name

Name of zone that the TDD pipe passes through before reaching the delivery zone.
Field: Transition Zone <#> Length
Length of pipe [m] in the transition zone. This is used for determining heat gains due to solar
absorbed by the pipe in each transition zone. The distribution of absorbed solar gains can be
customized by adjusting the length of pipe in each transition zone. The transition zone gain
is proportional to the length of pipe in the zone. If no transition zones are specified, all solar
absorbed by the pipe is lost to the exterior environment.
The Transition Zone Name and Transition Zone Length fields can be repeated for additional
transition zones.
DaylightingDevice:Tubular,
Pipe1,
Dome1,
Diffuser1,
Reflective Aluminum,
0.3556,
1.4,
0.28,
!
Attic Zone,
1.1;

!!!!!!!-

Object Name
Dome Name
Diffuser Name
Construction Name
Diameter [m] (approximately 14", a standard size)
Total Length [m] (subtract zone lengths to get outdoor exposed length)
Effective Thermal Resistance [m2-K/W] between TubularDaylightDome and
TubularDaylightDiffuser
!- Transition Zone 1 Name
!- Transition Zone 1 Length [m]

FenestrationSurface:Detailed,
Dome1, !- Subsurface Name
TubularDaylightDome, !- Surface Type
Clear Acrylic Dome, !- Construction Name (only 1 layer allowed in construction)
Attic Roof, !- Base Surface Name
, !- Outside Face Environment (not allowed for TubularDaylightDome)
0.0, !- VF to Ground
, !- Window Shading Control (not allowed for TubularDaylightDome)
, !- Frame/Divider Name (not allowed for TubularDaylightDome)
1.0, !- Multiplier (must be 1.0 for TubularDaylightDome)
4, !- Number of Vertices
2.3425, 3.1575, 3.9,
2.3425, 2.8425, 3.9,
2.6575, 2.8425, 3.9,
2.6575, 3.1575, 3.9;
FenestrationSurface:Detailed,
Diffuser1, !- Subsurface Name
TubularDaylightDiffuser, !- Surface Type
Frosted Acrylic Diffuser, !- Construction Name (only 1 layer allowed in construction)
Daylit Zone Ceiling, !- Base Surface Name
, !- Outside Face Environment (not allowed for TubularDaylightDiffuser)
0.0, !- VF to Ground
, !- Window Shading Control (not allowed for TubularDaylightDiffuser)
, !- Frame/Divider Name (not allowed for TubularDaylightDiffuser)
1.0, !- Multiplier (must be 1.0 for TubularDaylightDiffuser)
4, !- Number of Vertices
2.3425, 3.1575, 2.5,
2.3425, 2.8425, 2.5,
2.6575, 2.8425, 2.5,
2.6575, 3.1575, 2.5;

Tubular Daylighting Device Output

Zone,Average,Tubular
Zone,Average,Tubular
[W]
Zone,Average,Tubular
Zone,Average,Tubular
Zone,Average,Tubular
Zone,Average,Tubular
Zone,Average,Tubular
9/29/14

Daylighting Device Transmitted Solar Radiation Rate [W]

Daylighting Device Pipe Absorbed Solar Radiation Rate
Daylighting
Daylighting
Daylighting
Daylighting
Daylighting

Device
Device
Device
Device
Device

Heat Gain Rate [W]

Heat Loss Rate [W]
Beam Solar Transmittance []
Beam Visible Transmittance []
Diffuse Solar Transmittance []
419

Input-Output Reference

Group Daylighting

Zone,Average,Tubular Daylighting Device Diffuse Visible Transmittance []

Tubular Daylighting Device Beam Solar Transmittance []

This is the transmittance of beam solar radiation through the TDD.
Tubular Daylighting Device Beam Visible Transmittance []
This is the transmittance of beam visible radiation, or daylight, through the TDD.
Tubular Daylighting Device Diffuse Solar Transmittance []
This is the transmittance of diffuse solar radiation through the TDD.
Tubular Daylighting Device Diffuse Visible Transmittance []
This is the transmittance of diffuse visible radiation, or daylight, through the TDD.
Tubular Daylighting Device Heat Gain Rate [W]
This is the rate of heat gain to the zone by the TDD, in Watts.
Tubular Daylighting Device Heat Loss Rate [W]
This is the rate of heat loss from the zone by the TDD, in Watts.
Tubular Daylighting Device Pipe Absorbed Solar Radiation Rate [W]
This is the rate at which solar radiation is absorbed by the pipe in the TDD, in Watts.
Tubular Daylighting Device Transmitted Solar Radiation Rate [W]
This is the rate at which solar radiation is transmitted by the TDD, in Watts.
In addition, several surface and window variables are also reported for the
TubularDaylightDome and TubularDaylightDiffuser objects. For the TubularDaylightDome:
Zone,Average,Surface
Zone,Average,Surface
Zone,Average,Surface
Area[W/m2]
Zone,Average,Surface
Area[W/m2]
Zone,Average,Surface
per Area[W/m2]
Zone,Average,Surface
Rate per Area[W/m2]
Zone,Average,Surface
Zone,Average,Surface
Zone,Average,Surface
Rate [W]

Outside Face Sunlit Area [m2]

Outside Face Sunlit Fraction []
Outside Face Incident Solar Radiation Rate per
Outside Face Incident Beam Solar Radiation Rate per
Outside Face Incident Sky Diffuse Solar Radiation Rate
Outside Face Incident Ground Diffuse Solar Radiation
Outside Face Beam Solar Incident Angle Cosine Value[]
Window Transmitted Solar Radiation Rate [W]
Window Total Glazing Layers Absorbed Solar Radiation

For the TubularDaylightDiffuser:

Zone,Average,Surface Outside Face Incident Solar Radiation Rate per
Area[W/m2] (incident inside of pipe)
Zone,Average,Surface Window Transmitted Solar Radiation Rate [W] (same as
Tubular Daylighting Device Transmitted Solar Radiation Rate)
Zone,Average,Surface Window Total Glazing Layers Absorbed Solar Radiation
Rate [W]

9/29/14

420

Input-Output Reference

Group Daylighting

DaylightingDevice:Shelf
Daylighting shelves, or simply light shelves, are another device for bringing more daylight into
a building. Installed as an accessory to a window, daylighting shelves work by reflecting
exterior light onto the ceiling of a room. Daylighting shelves can have an inside shelf, an
outside shelf, or both.

Figure 68. Daylighting shelf diagram.

The inside shelf redistributes light that would have entered the zone anyway. Instead of
entering as a beam, all light is reflected onto the zone ceiling and is converted to diffuse
shortwave radiation.
The outside shelf changes the amount of light entering the zone. If the shelf surface is more
reflective than the ground, it can increase the amount of light incident on the upper part of the
window. However, the shading effect of the outside shelf on the lower part of the window
must also be considered as it can easily negate any gain achieved in the upper part of the
window. All light reflected from the outside shelf that enters the upper window is assumed to
strike the ceiling.

9/29/14

421

Input-Output Reference

Group Daylighting

Figure 69. Daylighting shelf DXF output.

In EnergyPlus a daylighting shelf is simulated using a DaylightingDevice:Shelf object in
combination with up to three other objects: a window, a heat transfer surface, and an
attached shading surface.
The window must be divided into two window surfaces: an upper window and a lower
window. The upper window interacts directly with the daylighting shelf object and is not
allowed to have any shading control devices or frames or dividers. The lower window does
not interact with the daylighting shelf object, but does receive shading from the outside shelf.
There are no restrictions on the lower window.
The inside shelf is defined as a regular heat transfer surface in the zone. However, the
surface must have the Outside Boundary Condition field set to Surface with itself as the other
zone surface. Shading and thermal mass effects are taken into account.
The outside shelf is defined as a Shading:Zone:Detailed object. The visible and solar
absorptance of the outside material layer determines the reflectivity of the shelf.
NOTE: Unlike a regular Shading:Zone:Detailed object, the vertices of the outside shelf surface must be
ordered so that the outward normal vector points upward, i.e. toward the upper window. This is necessary
in order for the outside shelf to properly receive sunlight and shading from other surfaces. A mirror shading
surface with the outward normal vector pointing in the opposite direction is automatically created by the
program to shade the lower window.

The inside shelf and outside shelf are both optional. However, if neither shelf is specified, the
daylighting shelf object has no effect on the simulation.
Field: Name
The name of the daylighting shelf object.
Field: Window Name
Reference to a FenestrationSurface:Detailed object with Surface Type WINDOW.
Field: Inside Shelf Name
Reference to a BuildingSurface:Detailed object. This field is optional. If used, this surface
must have OTHERZONESURFACE specified for the Outside Face Environment field and the
referenced other zone surface must be itself. The number of vertices of this surface object
must be 4.

9/29/14

422

Input-Output Reference

Group Daylighting

Field: Outside Shelf Name

Reference to a Shading:Zone:Detailed object. This field is optional. If used, the number of
vertices of this surface object must be 4.
Field: Outside Shelf Construction Name
Reference to a CONSTRUCTION object. This field is required if an outside shelf is specified.
The visible and solar absorptance of the outside material layer determines the shelf
reflectivity.
Field: View Factor To Outside Shelf
User defined value for the view factor from the window to the outside shelf. This field is
optional. If not specified, an exact view factor is calculated for two perpendicular rectangles of
the same width having a shared edge. If the given surfaces do not meet these geometric
requirements, it is necessary to specify a value here.
NOTE: It is up to the user to adjust the view factor to ground of the upper window to account for the part of
the view blocked by the outside shelf. The calculated View Factor To Outside Shelf is reported in the eio
file for this purpose. For the typical case where the shelf is parallel to the ground and the upper window is
perpendicular to the ground, the view factor to ground is simply: 0.5 View Factor To Outside Shelf.

9/29/14

423

Input-Output Reference

Group Daylighting

DaylightingDevice:Shelf,
Shelf, !- Name
Daylit Upper Window, !- Window Name
Inside Shelf, !- Inside Shelf Name
Outside Shelf, !- Outside Shelf Name
Shelf Construction; !- Outside Shelf Construction Name (required if outside shelf specified)
! 0.29; !- View Factor To Outside Shelf (optional)
FenestrationSurface:Detailed,
Daylit Upper Window, !- Subsurface Name
Window, !- Surface Type
Standard Window, !- Construction Name
Daylit South Wall, !- Base Surface Name
, !- Outside Face Environment
0.211, !- VF to Ground (user must adjust to account for view factor to outside shelf)
, !- Window Shading Control (not allowed)
, !- Frame/Divider Name (not allowed)
1.0, !- Multiplier (must be 1.0)
4, !- Number of Vertices
1.0, 0.0, 2.8,
1.0, 0.0, 2.0,
4.0, 0.0, 2.0,
4.0, 0.0, 2.8;
BuildingSurface:Detailed,
Inside Shelf, !- Surface Name
Wall, !- Surface Type
Shelf Construction, !- Construction Name
Daylit Zone, !- Zone Name
OtherZoneSurface, !- Exterior Conditions (must be OtherZoneSurface)
Inside Shelf, !- Target (must be itself)
NoSun, !- Solar Exposure
NoWind, !- Wind Exposure
0.0, !- VF to Ground
4, !- Number of Vertices
1.0, 0.0, 2.0,
4.0, 0.0, 2.0,
4.0, 1.0, 2.0,
1.0, 1.0, 2.0;
Shading:Zone:Detailed,
Outside Shelf, !- Surface Name
Daylit South Wall, !- Base Surface Name
, !- Shading Transmittance Schedule (default is always opaque)
4, !- Number of Vertices
1.0, 0.0, 2.0, !- Outward normal vector must point up toward the upper window
1.0, -1.0, 2.0,
4.0, -1.0, 2.0,
4.0, 0.0, 2.0;

Shelf Daylighting Device Output

The view factor to outside shelf calculation shows up in the .eio file along with the associated
window and window view factors to sky and ground:
! <Shelf Details>,Name,View Factor to Outside Shelf,Window Name,Window View
Factor to Sky,Window View Factor to Ground
SHELF,0.29,DAYLIT UPPER WINDOW,0.50,0.21

This variable reports the calculated View Factor To Outside Shelf so that the user can
correctly adjust the view factor to ground of the upper window.
The usual window and surface variables are relevant for the upper window:
Zone,Average,Surface
Zone,Average,Surface
Zone,Average,Surface
Area[W/m2]
Zone,Average,Surface
Area[W/m2]

9/29/14

Outside Face Sunlit Area [m2]

Outside Face Sunlit Fraction []
Outside Face Incident Solar Radiation Rate per
Outside Face Incident Beam Solar Radiation Rate per

424

Input-Output Reference
Zone,Average,Surface
per Area[W/m2]
Zone,Average,Surface
Rate per Area[W/m2]
Zone,Average,Surface
Zone,Average,Surface
Zone,Average,Surface
Rate [W]
Zone,Average,Surface
Zone,Average,Surface

Group Daylighting
Outside Face Incident Sky Diffuse Solar Radiation Rate
Outside Face Incident Ground Diffuse Solar Radiation
Outside Face Beam Solar Incident Angle Cosine Value[]
Window Transmitted Solar Radiation Rate [W]
Window Total Glazing Layers Absorbed Solar Radiation
Window Heat Gain Rate [W]
Window Heat Loss Rate [W]

The following surface variables are reported for the outside shelf surface, if specified:
Zone,Average,Surface
Zone,Average,Surface
Zone,Average,Surface
Area[W/m2]
Zone,Average,Surface
Area[W/m2]
Zone,Average,Surface
per Area[W/m2]
Zone,Average,Surface
Rate per Area[W/m2]
Zone,Average,Surface

Outside Face Sunlit Area [m2]

Outside Face Sunlit Fraction []
Outside Face Incident Solar Radiation Rate per
Outside Face Incident Beam Solar Radiation Rate per
Outside Face Incident Sky Diffuse Solar Radiation Rate
Outside Face Incident Ground Diffuse Solar Radiation
Outside Face Beam Solar Incident Angle Cosine Value[]

DaylightingDevice:LightWell
This object is used to model the impacts on daylighting of a light well that might be
associated with exterior windows such as skylights. The light well model attenuates the light
transmitted by the skylight. The attenuation is characterized by the well efficiency, which is
the ratio of the amount of light leaving the well to the amount of light entering the well. The
well efficiency varies from close to 1.0 to close to zero if there is high attenuation. The well
efficiency is used only in the EnergyPlus detailed daylighting calculation, where it multiplies
the beam and diffuse light transmitted by the skylight. (The well efficiency is not used in
calculating the solar gain through the skylight.)
The input object describes the light well using basic characteristics of the geometry along
with the visible reflectance of the wells side walls. The following figure diagrams how the
geometry is characterized.

9/29/14

425

Input-Output Reference

Group Daylighting
Roof
Frame

Skylight
Curb
Roof line

(a)

(b)
d

Skylight

Roof

Ceiling line

c
Light well

Well height
Bottom opening of well

Ceiling
Light well

Figure 70. Skylight with light well: (a) perspective view, (b) vertical section.
If the bottom of the light well is a rectangle of side lengths c and d, as shown in (a), then the perimeter of
the bottom of the well = 2(c+d) and the area = cd (see description of field names for the Light Well object).
Field: Exterior Window Name
The name of the exterior window that this Light Well is associated with. Generally this is a
skylight in a roof. However, light wells can be applied to an exterior window of any slope.
Light wells can be assigned to both rectangular and triangular exterior windows, but they
should not be assigned to interior windows. Note that the sides of the light well can be sloped
and the bottom of the light well can be any shape, not just rectangular.
Field: Height of Well
The distance from the bottom of the skylight to the bottom of the well. If the skylight and well
bottom are not coplanar, this is the distance from the center of the bottom of the skylight to
center of the bottom of the well. See Figure 70.
Field: Perimeter of Bottom of Well
The perimeter of the bottom opening of the well. See Figure 70.
Field: Area of Bottom of Well
The area of the bottom opening of the well. A warning will be issued if this area is less that
the area of the skylight, including frame if present. See Figure 70.
Field: Visible Reflectance of Well Walls
The visible reflectance of the side walls of the well. If the walls do not all have the same
reflectance, an area-weighted average value can be used. This is the well-wall reflectance
expressed as a fraction.
An IDF example:
DaylightingDevice:LightWell, ! The well is 60% reflecting, is 1.2m high and has a 2.5m x 5.5m
bottom opening.
Skylight-1, !- Name of Exterior Window that this Light Well Applies To
1.2,
!- Height of Well(m)
16.0,
!- Perimeter of Bottom of Well (m)
13.75,
!- Area of Bottom of Well (m2)
0.60;
!- Visible Reflectance of Well Walls

9/29/14

426

Input-Output Reference

Group Daylighting

Daylighting Modeling Options

The following table shows what input objects/fields to use to model different daylighting
options. It also gives the name of an example input, if available, that demonstrates the option.

Table 21. Daylighting Modeling Options

Option

9/29/14

Object/Field or
Output Variable

Input File

Allow a thermal zone to be daylit

Daylighting:Controls,
Daylighting:DELight:Controls

PurchAirWithDaylighting.idf,
DElight-DetailedComparison.idf

Specify visible transmittance of the

glazing

WindowMaterial:Glazing

PurchAirWithDaylighting.idf

Specify the visible transmittance of a

shading device

WindowMaterial:Shade,
WindowMaterial:Screen or
WindowMaterial:Blind

PurchAirWindowBlind.idf

Use a shading device to control glare

WindowMaterial:Shade or
WindowMaterial:Blind;
WindowProperty:ShadingControl*

PurchAirWindowBlind.idf

Use electrochromic glazing to control

glare

WindowProperty:ShadingControl/Sh
ading Type = SwitchableGlazing,
Shading Control Type = On If High
Glare, Glare Control Is Active = Yes*

PurchAirWithDaylighting.idf

Adjust electrochromic glazing to just

meet daylighting illuminance setpoint

WindowProperty:ShadingControl/Sh
ading Type = SwitchableGlazing,
Shading Control Type =
MeetDaylightIlluminanceSetpoint*

Print an illuminance map

Daylighting:Illuminance Map*

Control electric lighting response to

daylight illuminance level

Daylighting:Controls/Lighting Control
Type = Continuous, Stepped or
Continuous/Off, plus other fields; or
.
Daylighting:DELight:Controls/Lightin
g Control Type = Continuous,
Stepped or Continuous/Off, plus
other fields

PurchAirWithDaylighting.idf;
DElight-DetailedComparison.idf

Add a light shelf (with

Daylighting:Controls)

DaylightingDevice:Shelf *

DaylightingDeviceShelf.idf

Add a light shelf (with

Daylighting:DELight:Controls)

Daylighting:DELight:Controls

DElightCFSLightShelf.idf

Add a light pipe

DaylightingDevice:Tubular *

DaylightingDeviceTubular.idf

Model a skylight having a light well

DaylightingDevice:LightWell *

Model daylighting through double facade

See Double Facades: Daylighting

through Interior Windows*

Add diffusing (translucent) glass

WindowMaterial:Glazing/Solar
Diffusing = Yes*

Model complex fenestration

Daylighting:DELight:Controls

DElightCFSWindow.idf

Get a radiosity-based interior light interreflection calculation

Daylighting:DELight:Controls

DElight-DetailedComparison.idf

Find effect on daylighting of solar

reflected from overhangs, neighboring

Building/SolarDistribution uses
withReflections option

PurchAirWithDoubleFacade
Daylighting.idf

427

Input-Output Reference

Group Exterior Energy Use Equipment

buildings, etc.
Find visible transmittance effect of dirt on
window

WindowMaterial:Glazing/Dirt
Correction Factor for Solar and
Visible Transmittance*

*Used only with Daylighting:Controls

Group Exterior Energy Use Equipment

To facilitate the reporting of exterior consumption (to the buildings heat balance/loads
considerations), several objects have been included. The consumption related to these items
will appear on meters specific to the items.
Exterior:Lights
Field: Name
This descriptive name allows the values of exterior lights consumption to appear in the
normal output variable list as well as the meters. It cannot be blank nor can it be duplicated
by other Exterior:Lights statements.
Field: Schedule Name
A schedule will allow the exterior lights consumption to be operationally different, hour to hour
as well as seasonally. Fractional values in the basic schedule will be applied to the design
level field below.
Field: Design Level
This field (in Watts) is typically used to represent the maximum electrical input to exterior
lighting fixtures that is then multiplied by a schedule fraction (see previous field). In
EnergyPlus, this is slightly more flexible in that the lighting design level could be a diversity
factor applied to a schedule of real numbers. Note that while the schedule value can vary
from hour to hour and seasonally, the design level field is constant for all simulation
environments.
Field: Control Option
This field is used to determine how the exterior lights are controlled. There are currently two
options, ScheduleNameOnly and AstronomicalClock. If this field is omitted or left blank
then the program will default to Schedule Name Only mode. The ScheduleNameOnly mode
dictates that the exterior lights always follow the schedule named in the field above. The
AstronomicalClock mode dictates that despite what the schedule indicates, the exterior
lights will not run when the sun is up. Using the Astronomical Clock mode makes it simple to
model exterior lights that are controlled by a photocell or other controller that ensures that
outdoor lights will not run during the daytime. However, the Astronomical Clock control works
off of the position of the sun and therefore does not operate exactly like a photocell. During
the night, the schedule values are still applied in the usual way.
Field: End-Use Subcategory
Allows you to specify a user-defined end-use subcategory, e.g., "Grounds Lights", "Facade
Lights", etc. A new meter for reporting is created for each unique subcategory (ref:
Output:Meter objects). Subcategories are also reported in the ABUPS table. If this field is
omitted or blank, the lights will be assigned to the "General" end-use subcategory.
An IDF Example:

9/29/14

428

Input-Output Reference
Exterior:Lights,
OutsideLights,
ON,
1000,
AstronomicalClock,
Grounds Lights;

Group Exterior Energy Use Equipment

!- Name
!- SCHEDULE Name
!- Design Level
!- Control Option
!- End-Use Subcategory

Exterior Lights Outputs

Output for exterior lights appears in three possible places. It will
(Electricity:Facility and ExteriorLights:Electricity) as well as in its own
standard output file.
Output for exterior lights appears in three possible places. It will
(Electricity:Facility and ExteriorLights:Electricity) as well as in its own
standard output file.

appear on two meters

designated value in the
appear on two meters
designated value in the

Zone,Average,Exterior Lights Electric Power [W]

Zone,Sum,Exterior Lights Electric Energy [J]

Exterior Lights Electric Power [W]

Exterior Lights Electric Energy [J]
These are the electric power and energy consumed by the exterior lights.
Exterior:FuelEquipment
Field: Name
This descriptive name allows the values of exterior equipment consumption to appear in the
normal output variable list as well as the meters. It cannot be blank nor can it be duplicated
by other Exterior:FuelEquipment or Exterior:WaterEquipment statements.
Field: Fuel Use Type
This field designates the appropriate meter for the exterior fuel equipment. Valid fuel types
are: Electricity, NaturalGas, PropaneGas, FuelOil#1, FuelOil#2, Diesel, Gasoline, Coal,
Steam, DistrictHeating, DistrictCooling, OtherFuel1 and OtherFuel2. The fuel type triggers the
application of consumption amounts to the appropriate energy meters.
Field: Schedule Name
A schedule will allow the exterior lights consumption to be operationally different, hour to hour
as well as seasonally. Fractional values in the basic schedule will be applied to the design
level field below.
Field: Design Level
This field (Watts) is typically used to represent the maximum input to exterior fixtures that is
then multiplied by a schedule fraction (see previous field). In EnergyPlus, this is slightly more
flexible in that the design level could be a diversity factor applied to a schedule of real
numbers. Note that while the schedule value can vary from hour to hour and seasonally, the
design level field is constant for all simulation environments.
Field: End-Use Subcategory
Allows you to specify a user-defined end-use subcategory, e.g., "Fountains", etc. A new
meter for reporting is created for each unique subcategory (ref: Output:Meter objects).
Subcategories are also reported in the ABUPS table. If this field is omitted or blank, the
equipment will be assigned to the "General" end-use subcategory.
IDF Examples:
Exterior:FuelEquipment,OutsideGasEq,Gas,ON,1000;
Exterior:FuelEquipment,OutsideCoalEq,Coal,ON,1000;
9/29/14

429

Input-Output Reference

Group Exterior Energy Use Equipment

Exterior:FuelEquipment,OutsideFuelOil1Eq,FuelOil#1,ON,1000;
Exterior:FuelEquipment,OutsideFuelOil2Eq,FuelOil#2,ON,1000;
Exterior:FuelEquipment,OutsideLPGEq,PropaneGas,ON,1000;

Exterior:WaterEquipment
Field: Name
This descriptive name allows the values of exterior equipment consumption to appear in the
normal output variable list as well as the meters. It cannot be blank nor can it be duplicated
by other Exterior:FuelEquipment or Exterior:WaterEquipment statements.
Field: FuelUseType
For Exterior:WaterEquipment, only Water is current allowed for this field.
Field: Schedule Name
A schedule will allow the exterior water consumption to be operationally different, hour to
hour as well as seasonally. Fractional values in the basic schedule will be applied to the
design level field below.
Field: Design Level
This field (in m3/s) is typically used to represent the maximum volumetric flow for water
fixtures that is then multiplied by a schedule fraction (see previous field). In EnergyPlus, this
is slightly more flexible in that the exterior water equipment design level could be a diversity
factor applied to a schedule of real numbers. Note that while the schedule value can vary
from hour to hour and seasonally, the design level field is constant for all simulation
environments.
Field: End-Use Subcategory
Allows you to specify a user-defined end-use subcategory, e.g., "Landscaping", etc. A new
meter for reporting is created for each unique subcategory (ref: Output:Meter objects).
Subcategories are also reported in the ABUPS table. If this field is omitted or blank, the
equipment will be assigned to the "General" end-use subcategory.
IDF Example:
Exterior:WaterEquipment,OutsideWaterEq,Water,ON,10000;

Exterior Fuel Equipment, Exterior Water Equipment Outputs

Output for exterior equipment consumption appears in three possible places. It will appear on
two meters (<Fuel Type>:Facility and ExteriorEquipment:<Fuel Type>) as well as in its own
designated value in the standard output file, Exterior Equipment <Fuel Type> Energy.
Consumption also appears on any user-defined end-use subcategory meters, i.e., <End-Use
Subcategory>:ExteriorEquipment:<Fuel Type>. All outputs are in [J] except water
consumption which is in [m3]. There are also rate versions
Zone, Average, Exterior Equipment Fuel Rate [W]
Zone,Sum, Exterior Equipment Electric Energy [J]
Zone,Sum, Exterior Equipment Gas Energy [J]
Zone,Average, Exterior Equipment Water Volume Flow Rate [m3/s]
Zone,Sum, Exterior Equipment Water Volume [m3]
Zone,Sum, Exterior Equipment Mains Water Volume [m3]
Zone,Sum, Exterior Equipment Coal Energy [J]
Zone,Sum, Exterior Equipment FuelOil#1 Energy [J]
Zone,Sum, Exterior Equipment FuelOil#2 Energy [J]
Zone,Sum, Exterior Equipment Propane Energy [J]

9/29/14

430

Input-Output Reference

Group Airflow

Zone,Sum, Exterior Equipment Gasoline Energy [J]

Zone,Sum,
Zone,Sum,
Zone,Sum,
Zone,Sum,
Zone,Sum,
Zone,Sum,

Exterior
Exterior
Exterior
Exterior
Exterior
Exterior

Equipment
Equipment
Equipment
Equipment
Equipment
Equipment

Diesel Energy [J]

Steam Energy [J]
OtherFuel1 Energy [J]
OtherFuel2 Energy [J]
District Heating Energy [J]
District Cooling Energy [J]

Exterior Equipment Fuel Rate [W]

Exterior Equipment <Fuel Type> Energy [J]
These are the fuel consumption rate and energy for the exterior equipment.
Exterior Equipment Water Volume Flow Rate [m3/s]
Exterior Equipment Water Volume [m3]
These are the water consumption rate and volume for the exterior equipment.
Exterior Equipment Mains Water Volume [m3]This is the water volume drawn for the mains
water service to serve the exterior equipment.

Group Airflow
An important characteristic of energy consumption in buildings is the airflow between zones
and airflow due to natural ventilation (e.g., open windows) or mechanically-induced ventilation
(e.g., exhaust air fans). This group of objects describes those elements.
The AirflowNetwork model can also be used to model infiltration and mixing (zone-to-zone air
flow) with or without the HVAC air distribution system operating (see Group Airflow
Network).
ZoneInfiltration:DesignFlowRate
Infiltration is the unintended flow of air from the outdoor environment directly into a thermal
zone. Infiltration is generally caused by the opening and closing of exterior doors, cracks
around windows, and even in very small amounts through building elements. The basic
equation used to calculate infiltration with this object is:

Infiltration

I design

Fschedule

A B Tzone Todb

C WindSpeed

D Windspeed 2

More advanced infiltration calculations are possible using the EnergyPlus AirflowNetwork
model for natural infiltration driven by wind and/or by forced air. Infiltration described by the
equation shown above is entered into EnergyPlus using the following syntax. Exfiltration (the
leakage of zone air to the outside) is generally handled better as zone exhaust air in the zone
equipment description. The equation must always yield a non-negative results; negative
values are set to 0.0.
The question of typical values for these coefficients is subject to debate. Ideally, one should
do a detailed analysis of the infiltration situation and then determine a custom set of
coefficients using methods such as those laid out in Chapter 26 of the ASHRAE Handbook of
Fundamentals. The EnergyPlus defaults are 1,0,0,0 which give a constant volume flow of
infiltration under all conditions.
BLAST (one of the EnergyPlus predecessors) used the following values as defaults: 0.606,
0.03636, 0.1177, 0. These coefficients produce a value of 1.0 at 0C deltaT and 3.35 m/s (7.5
mph) windspeed, which corresponds to a typical summer condition. At a winter condition of
40C deltaT and 6 m/s (13.4 mph) windspeed, these coefficients would increase the infiltration
rate by a factor of 2.75.
9/29/14

431

Input-Output Reference

Group Airflow

In DOE-2 (the other EnergyPlus predecessor), the air change method defaults are (adjusted
to SI units) 0, 0, 0.224 (windspeed), 0. With these coefficients, the summer conditions above
would give a factor of 0.75, and the winter conditions would give 1.34. A windspeed of 4.47
m/s (10 mph) gives a factor of 1.0.
The source of the BLAST defaults is noted in the BLAST documentation as:
"Empirical equation and the coefficient default were determined from ASHRAE journal articles
and other data on the effects of outdoor weather conditions."
The source of the DOE-2 defaults is based on examining the infiltration relationships
described in the ASHRAE Handbook of Fundamentals.
The EnergyPlus example files use all of the above, the BLAST defaults in some (e.g.,
GeometryTest), the DOE-2 defaults in some (e.g., 5ZoneAirCooled), and the EnergyPlus
defaults in some (e.g., LgOffVAVDetCoil).
The local outdoor dry-bulb temperature used in the above basic equation (T odb) is typically a
function of the height of the zone centroid above ground. The corresponding zone name is
given in the second field. The local outdoor dry-bulb temperature calculation procedure is
given in the section of Local Outdoor Air Temperature Calculation in the Engineering
Reference.
The local outdoor wind speed used in the above basic equation (WindSpeed) is also a
function of the height of the zone centroid above ground. The corresponding zone name is
given in the second filed. The local outdoor wind speed calculation procedure is given in the
section of Local Wind Speed Calculation in the Engineering Reference.
Note: When the value of the Wind Speed Profile Exponent field in the Site:HeightVariation is equal to 0.0.
The local wind speed is always equal to the wind speed given in the weather data and will not be
dependent on zone centroid height. Similarly, if the value of the Air Temperature Gradient Coefficient is
set equal to 0 the local air dry-bulb temperature is also always equal to the air dry-bulb temperature given
in the weather data and will not be dependent on zone centroid height.

One or more infiltration objects can be defined for each zone, and the resulting infiltration rate
for the zone will simply be the summation of the flow rates specified by the infiltration objects.
Field: Name
The name of the ZoneInfiltration:DesignFlowRate object. This needs to be unique across all
different ZoneInfiltration objects.
Field: Zone or ZoneList Name
This field is the name of the zone (ref: Zone) or ZoneList (ref: ZoneLIst) and attaches a
particular infiltration statement to a thermal zone or set of thermal zones in the building.
When the ZoneList option is used then this infiltration definition is applied to each of the
zones in the zone list effecting a global definition for the amount of infiltration flow rate in the
zone. The Zonelist option can be used effectively with the flow/area, flow/exteriorarea,
flow/exteriorwallarea, or airchanges/hour of the Design Flow Rate Calculation Method.
The
name
of
the
actual
infiltration
object
becomes
<Zone
Name>
<ZoneInfiltration:DesignFlowRate Object Name> and should be less than the standard length
(100 characters) for a name field. If it is greater than this standard length, it may be difficult to
specify in output reporting as it will be truncated. A warning will be shown if the generated
name is greater than 100 characters. If it duplicates another such concatenated name, there
will be a severe error and terminate the run.
Field: Schedule Name
This field is the name of the schedule (ref: Schedule) that modifies the maximum design
volume flow rate (Idesign) (see Design Flow Rate Calculation Method field and related
9/29/14

432

Input-Output Reference

Group Airflow

subsequent fields). This fraction between 0.0 and 1.0 is noted as F schedule in the above
equation.
Field: Design Flow Rate Calculation Method
This field is a key/choice field that tells which of the next four fields are filled and is
descriptive of the method for calculating the design volume flow rate. The key/choices are:
Flow/Zone
With this choice, the method used will be a straight insertion of the design volume flow rate.
(The Design Flow Rate field should be filled.)
Flow/Area
With this choice, the method used will be a factor per floor area of the zone. (The flow per
Zone Area field should be filled).
Flow/ExteriorArea
With this choice, the method used will be a factor per exterior surface area of the zone. (The
flow per Exterior Surface Area field should be filled).
Flow/ExteriorWallArea
With this choice, the method used will be a factor per exterior wall surface area of the zone.
(The flow per Exterior Surface Area field should be filled).
AirChanges/Hour
With this choice, the method used will be the number of air changes per hour for the
infiltration amount. This factor, along with the Zone Volume, will be used to determine the
Design Flow Rate. (The Air Changes per Hour field should be filled).
Field: Design Flow Rate
This field denotes the full design volume flow rate (m 3/s). The previous field should choose
flow/zone as the choice. The design volume flow rate (noted as I design in the above equation)
is the maximum amount of infiltration expected at design conditions. The design value is
modified by the schedule fraction (see Field:Schedule Name) and user specified coefficients
(see coefficient fields below). The resulting volume flow rate is converted to mass flow using
the current outdoor air density at each time step.
Field: Flow per Zone Floor Area
This factor (m3/s-m2) is used, along with the Zone Area to determine the maximum Design
Flow Rate as described in the Design Flow Rate field. The choice from the method field
should be Flow/Area.
Field: Flow per Exterior Surface Area
This factor (m3/s-m2) is used, along with the Exterior Surface Area in the Zone to determine
the maximum Design Flow Rate as described in the Design Flow Rate field. The choice from
the method field should be Flow/Exteriorarea or Flow/ExteriorWallArea.
Field: Air Changes per Hour
This factor is used, along with the Zone Volume to determine the maximum Design Flow Rate
as described in the Design Flow Rate field. The choice from the method field should be
AirChanges/Hour.
Field: Constant Term Coefficient
This number is the A parameter in the above infiltration equation. It is part of the user
specified modifying parameters that are a function of environmental factors. This parameter,
however, is a constant under all conditions and is not modified by any environmental effect.
As a result, it is dimensionless.

9/29/14

433

Input-Output Reference

Group Airflow

Field: Temperature Term Coefficient

This number is the B parameter in the above infiltration equation. It is part of the user
specified modifying parameters that are a function of environmental factors. This parameter is
modified by the temperature difference between the outdoor and indoor air dry-bulb
temperatures. The units for this parameter are inverse Celsius.
Field: Velocity Term Coefficient
This number is the C parameter in the above infiltration equation. It is part of the user
specified modifying parameters that are a function of environmental factors. This parameter is
modified by the speed of wind being experienced outside the building. The units for this
parameter are s/m.
Field: Velocity Squared Term Coefficient
This number is the D parameter in the above infiltration equation. It is part of the user
specified modifying parameters that are a function of environmental factors. This parameter is
modified by square of the speed of wind being experienced outside the building. The units for
this parameter are s2/m2.
An IDF example:
ZoneInfiltration:DesignFlowRate,
Infiltration 1,
!- Name
DORM ROOMS AND COMMON AREAS, !- Zone Name
Infiltration Sch, !- Schedule Name
Flow/Zone,
!- Design Flow Rate Calculation Method
2.831685,
!- Design Flow Rate {m3/s}
,
!- Flow per Zone Floor Area {m3/s/m2}
,
!- Flow per Exterior Surface Area {m3/s/m2}
,
!- Air Changes per Hour
0.6060000
, !- Constant Term Coefficient
3.6359996E-02, !- Temperature Term Coefficient
0.1177165
, !- Velocity Term Coefficient
0.0000000E+00; !- Velocity Squared Term Coefficient

Global Infiltration example:

ZoneList,OfficeZones,Left Fork, Middle Fork, Right Fork;
ZoneInfiltration:DesignFlowRate,
OfficeZones Infiltration,
!- Name
OfficeZones,
!- Zone or ZoneList Name
Infiltration Sch,
!- Schedule Name
AirChanges/Hour,
!- Design Flow Rate Calculation Method
,
!- Design Flow Rate {m3/s}
,
!- Flow per Zone Floor Area {m3/s-m2}
,
!- Flow per Exterior Surface Area {m3/s-m2}
4.7,
!- Air Changes per Hour
0.6060000,
!- Constant Term Coefficient
3.6359996E-02,
!- Temperature Term Coefficient
0.1177165,
!- Velocity Term Coefficient
0.0000000E+00;
!- Velocity Squared Term Coefficient

ZoneInfiltration:EffectiveLeakageArea
ZoneInfiltration:EffectiveLeakageArea model is similar to the other infiltration objects but uses
a different equation to model the unintended flow of air from the outdoor environment directly
into a thermal zone. Infiltration is generally caused by the opening and closing of exterior
doors, cracks around windows, and even in very small amounts through building elements.
This model is based on work by Sherman and Grimsrud (1980) and is appropriate for smaller,
residential-type buildings. The equation used to calculate infiltration in the effective leakage
area model is:

9/29/14

434

Input-Output Reference

Group Airflow

Infiltration

FSchedule

AL
Cs T Cw WindSpeed
1000

where T is the average difference between zone air temperature and the outdoor air
temperature and the other coefficients are described below.
Note that the coefficients for the EffectiveLeakageArea model are not interchangeable with
the
similarly
named
coefficients
in
the
FlowCoefficient
model
(see
ZoneInfiltration:FlowCoefficient object).
One or more infiltration objects of different types can be defined for each zone, and the
resulting infiltration rate for the zone will simply be the summation of the flow rates specified
by the infiltration objects.
Field: Name
The name of the ZoneInfiltration:EffectiveLeakageArea object.
across all different ZoneInfiltration objects.

This needs to be unique

Field: Zone Name

This field is the name of the zone (ref: Zone) and attaches a particular infiltration statement to
a thermal zone in the building.
Field: Schedule Name
This field is the name of a schedule (ref: Schedule) that modifies the volume flow rate
calculated by the model. This fraction between 0.0 and 1.0 is noted as F schedule in the above
equation.
Field: Effective Air Leakage Area
This field is the effective air leakage area, in cm 2, at 4 Pa. This is the value

AL in the

equation above. Effective leakage area data can be obtained from a whole-building pressure
test (eg. blower door test). ASHRAE Handbook of Fundamentals also lists typical values
component leakage areas for low-rise residential (e.g. Table 1 in Chapter 26 of HoF 2001).
The value should correspond to a pressure difference of 4 Pa.
Field: Stack Coefficient

Cs in the equation above. The coefficient has

This field is the value of the stack coefficient,

(L/s)2/(cm4K).

units of
Values for the Basic Model Stack Coefficient listed in the ASHRAE
Handbook of Fundamentals (2005 and 2001) are:
One story house
0.000145

Two story house

0.000290

Three story house

0.000435

Field: Wind Coefficient

This field is the value of the wind coefficient,

Cw in the equation above. The coefficient has

(L/s)2/(cm4(m/s)2).

units of
Values for the Basic Model Wind Coefficient listed in the
ASHRAE Handbook of Fundamentals (2005 chapter 27; 2001, Chapter 26) depend on the
type of shelter and are listed in the following tables.
Shelter
class
1
2
3
4
9/29/14

One story
house
0.000319
0.000246
0.000174
0.000104

Two story
house
0.000420
0.000325
0.000231
0.000137

Three story
house
0.000494
0.000382
0.000271
0.000161
435

Input-Output Reference

Group Airflow

5
Shelter class
1
2
3
4
5

0.000032

0.000042

0.000049

Description
No obstructions or local shielding
Typical shelter for an isolated rural house
Typical shelter caused by other buildings across the street
Typical shelter for urban buildings on larger lots
Typical shelter produced by buildings that are immediately adjacent.

An example IDF object is

ZoneInfiltration:EffectiveLeakageArea,
LIVING ZONE Infil 1,
!- Name
LIVING ZONE,
!- Zone Name
INF-SCHED,
!- Schedule Name
500.0,
!- Effective Air Leakage Area
0.000145,
!- Stack Coefficient
0.000174 ;
!- Wind Coefficient

ZoneInfiltration:FlowCoefficient
ZoneInfiltration:FlowCoefficient model is similar to the other infiltration objects but uses a
different equation to model the unintended flow of air from the outdoor environment directly
into a thermal zone. Infiltration is generally caused by the opening and closing of exterior
doors, cracks around windows, and even in very small amounts through building elements.
This reformulated model is based on the AIM-2 model by Walker and Wilson (1998) and is
appropriate for smaller, residential-type buildings. The equation used to calculate infiltration
in the flow coefficient model is:

Infiltration

FSchedule

c Cs T n

c Cw s WindSpeed

2n 2

Where T is the average difference between zone air temperature and the outdoor air
temperature and the other coefficients are described below.
Note that the coefficients for the Flow Coefficient model are not interchangeable with the
similarly named coefficients in the Effective Leakage Area model (see
ZoneInfiltration:EffectiveLeakageArea object).
One or more infiltration objects of different types can be defined for each zone, and the
resulting infiltration rate for the zone will simply be the summation of the flow rates specified
by the infiltration objects.
Field: Name
The name of the ZoneInfiltration:FlowCoefficient object. This needs to be unique across all
different ZoneInfiltration objects.
Field: Zone Name
This field is the name of the zone (ref: Zone) and attaches a particular infiltration statement to
a thermal zone in the building.
Field: Schedule Name
This field is the name of a schedule (ref: Schedule) that modifies the volume flow rate
calculated by the model. This fraction between 0.0 and 1.0 is noted as F schedule in the above
equation.

9/29/14

436

Input-Output Reference

Group Airflow

Field: Flow Coefficient

This field is the flow coefficient in m 3/(sPan). This is the value c in the equation above. The
flow coefficient can be determined from the effective leakage area and whole-building
pressure tests (eg. blower door test).
Field: Stack Coefficient
This field is the value of the stack coefficient,

Cs in the equation above. The coefficient has

(Pa/K)n.

units of
Values for the Enhanced Model Stack Coefficient listed in the ASHRAE
Handbook of Fundamentals (2005 and 2001) are:

With Flue
No Flue

One story
house
0.069
0.054

Two story
house
0.089
0.078

Three story
house
0.107
0.098

Field: Pressure Exponent

This field is the value of the pressure exponent, n in the equation above. The pressure
exponent generally lies between 0.6 and 0.7 with a typical value of n = 0.67 for the enhanced
model.
Field: Wind Coefficient
This field is the value of the wind coefficient,

Cw in the equation above. The coefficient has

(Pas2/m2)n .

units of
Values for the Enhanced Model Wind Coefficient listed in the ASHRAE
Handbook of Fundamentals (2005 and 2001) are:

Basement/slab;
With Flue
Basement/slab;
No Flue
Crawlspace;
With Flue
Crawlspace;
No Flue

One story
house
0.142

Two story
house
0.156

Three story
house
0.167

0.156

0.170

0.170

0.128

0.142

0.154

0.128

0.142

0.151

Field: Shelter Factor

This field is the value of the wind coefficient, s in the equation above. The coefficient is
dimensionless. Values for the Enhanced Model Shelter Factor listed in the ASHRAE
Handbook of Fundamentals (2005 and 2001) are:
Shelter
No Flue
One story
Two story
Three story
class
house with
house with
house with flue
flue
flue
1
1.00
1.10
1.07
1.06
2
0.90
1.02
0.98
0.97
3
0.70
0.86
0.81
0.79
4
0.50
0.70
0.64
0.61
5
0.30
0.54
0.47
0.43
Shelter
9/29/14

Description
437

Input-Output Reference

Group Airflow

class
1
2
3
4
5

No obstructions or local shielding

Typical shelter for an isolated rural house
Typical shelter caused by other buildings across the street
Typical shelter for urban buildings on larger lots
Typical shelter produced by buildings that are immediately
adjacent.
An Example IDF object is:
ZoneInfiltration:FlowCoefficient,
LIVING ZONE Infil 1,
!- Name
LIVING ZONE,
!- Zone Name
INF-SCHED,
!- Schedule Name
0.05,
!- Flow Coefficient
0.089,
!- Stack Coefficient
0.67 ,
!- Pressure Exponent
0.156 ,
!- Wind Coefficient
0.64;
!- Shelter Factor

ZoneInfiltration Outputs
HVAC,Sum,Zone Infiltration Sensible Heat Loss Energy [J]
HVAC,Sum,Zone Infiltration Sensible Heat Gain Energy [J]
HVAC,Sum,Zone Infiltration Latent Heat Loss Energy [J]
HVAC,Sum,Zone Infiltration Latent Heat Gain Energy [J]
HVAC,Sum,Zone Infiltration Total Heat Loss Energy [J]
HVAC,Sum,Zone Infiltration Total Heat Gain Energy [J]
HVAC,Average,Zone Infiltration Current Density Volume Flow Rate [m3/s]
HVAC,Average,Zone Infiltration Standard Density Volume Flow Rate [m3/s]
HVAC,Sum,Zone Infiltration Current Density Volume [m3]
HVAC,Sum,Zone Infiltration Standard Density Volume [m3]
HVAC,Sum,Zone Infiltration Mass [kg]
HVAC,Sum,Zone Infiltration Mass Flow Rate [kg/s]
HVAC,Average,Zone Infiltration Air Change Rate [ach]

Note: If ZoneInfiltration:* objects and ZoneAirBalance:OutdoorAir (with Air Balance Method = Quadrature)
objects reference the same Zone Name, the above infiltration output variables will not be reported for that
zone. Instead, output variables for zone outdoor air flow will be reported by the corresponding
ZoneAirBalance:OutdoorAir object.

Zone Infiltration Sensible Heat Loss Energy [J]

The sensible (temperature) heat loss that occurs when the infiltration air temperature
(outdoor) < zone air temperature.
Zone Infiltration Sensible Heat Gain Energy [J]
The sensible (temperature) heat gain that occurs when the infiltration air temperature
(outdoor) >= zone air temperature.
Zone Infiltration Latent Heat Loss Energy [J]
The latent heat loss that occurs when the infiltration air humidity ratio (outdoor) < zone air
humidity ratio.
Zone Infiltration Latent Heat Gain Energy [J]
The latent heat gain that occurs when the infiltration air humidity ratio (outdoor) >= zone air
humidity ratio.

9/29/14

438

Input-Output Reference

Group Airflow

Zone Infiltration Total Heat Loss Energy [J]

The total heat loss that occurs when the sum of Zone Infiltration Sensible Heat Gain Energy
and Zone Infiltration Latent Heat Gain Energy < the sum of Zone Infiltration Sensible Heat
Loss Energy and Zone Infiltration Latent Heat Loss Energy.
Zone Infiltration Total Heat Gain Energy [J]
The total heat gain that occurs when the sum of Zone Infiltration Sensible Heat Gain Energy
and Zone Infiltration Latent Heat Gain Energy >= the sum of Zone Infiltration Sensible Heat
Loss Energy and Zone Infiltration Latent Heat Loss Energy.
Zone Infiltration Current Density Volume [m3]
Zone Infiltration Current Density Volume Flow Rate [m3/s]
These outputs are the total volume and volume flow rate of infiltration air based on the
current density of zone air.
Zone Infiltration Standard Density Volume [m3]
Zone Infiltration Standard Density Volume Flow Rate [m3/s]
These outputs are the total volume and volume flow rate of infiltration air based on the
standard density of air. Standard density in EnergyPlus corresponds to 20C drybulb, dry air,
and nominally adjusted for elevation.
Zone Infiltration Mass [kg]
The mass flow of the Infiltration air.
Zone Infiltration Mass Flow Rate [kg/s]
The mass flow rate of the Infiltration air.
Zone Infiltration Air Change Rate [ach]
The rate of infiltration in air changes per hour.
ZoneVentilation:DesignFlowRate
Ventilation is the purposeful flow of air from the outdoor environment directly into a thermal
zone in order to provide some amount of non-mechanical cooling. Ventilation, as specified by
the input syntax for the ZoneVentilation:DesignFlowRate object, is intended to model simple
ventilation as opposed to the more detailed ventilation investigations that can be performed
with the AirflowNetwork model or with air systems that have outdoor air mixers. Zone
ventilation, as specified via this input object, can be controlled by a schedule and through the
specification of minimum, maximum and delta temperatures as described below. The
temperatures can be either single constant values for the entire simulation or schedules
which can vary over time. As with infiltration, the actual flow rate of ventilation air can be
modified by the temperature difference between the inside and outside environment and the
wind speed. The basic equation used to calculate ventilation with this model is:

Ventilation

Vdesign

Fschedule

A B Tzone Todb

C WindSpeed

D WindSpeed 2

Similar to infiltration, the question of typical values for these coefficients is subject to debate.
Ideally, one should do a detailed analysis of the ventilation situation and then determine a
custom set of coefficients using methods such as those laid out in Chapter 26 of the
ASHRAE Handbook of Fundamentals. The EnergyPlus defaults are 1,0,0,0 which give a
constant volume flow of ventilation under all conditions. The following discussion is duplicated
from the infiltration design flow rate object. The equation must always yield a non-negative
results; negative values are set to 0.0.

9/29/14

439

Input-Output Reference

Group Airflow

BLAST (one of the EnergyPlus predecessors) used the following values as defaults: 0.606,
0.03636, 0.1177, 0. These coefficients produce a value of 1.0 at 0C deltaT and 3.35 m/s (7.5
mph) windspeed, which corresponds to a typical summer condition. At a winter condition of
40C deltaT and 6 m/s (13.4 mph) windspeed, these coefficients would increase the infiltration
rate by a factor of 2.75.
In DOE-2 (the other EnergyPlus predecessor), the air change method defaults are (adjusted
to SI units) 0, 0, 0.224 (windspeed), 0. With these coefficients, the summer conditions above
would give a factor of 0.75, and the winter conditions would give 1.34. A windspeed of 4.47
m/s (10 mph) gives a factor of 1.0.
The source of the BLAST defaults is noted in the BLAST documentation as:
"Empirical equation and the coefficient default were determined from ASHRAE journal articles
and other data on the effects of outdoor weather conditions."
The source of the DOE-2 defaults is based on examining the infiltration relationships
described in the ASHRAE Handbook of Fundamentals.
The local outdoor dry-bulb temperature used in the above basic equation (T odb) is typically a
function of the height of the zone centroid above ground. The corresponding zone name is
given in the second field. The local outdoor dry-bulb temperature calculation procedure is
described in the Local Outdoor Air Temperature Calculation section of the Engineering
Reference.
The local outdoor wind speed used in the above basic equation (WindSpeed) is also a
function of the height of the zone centroid above ground. The corresponding zone name is
given in the second field. The local outdoor wind speed calculation procedure is described in
the Local Wind Speed Calculation section of the Engineering Reference.
Note: When the value of the Wind Speed Profile Exponent field in the Site:HeightVariation object is equal
to 0.0, the local wind speed is always equal to the wind speed given in the weather data and will not be
dependent on zone centroid height. Similarly, if the value of the Air Temperature Gradient Coefficient is
set equal to 0, the local air dry-bulb temperature is also always equal to the air dry-bulb temperature given
in the weather data and will not be dependent on zone centroid height.

One or more ventilation objects (i.e., ZoneVentilation:DesignFlowRate and/or

ZoneVentilation:WindandStackOpenArea) can be defined for each zone, and the resulting
ventilation rate for the zone will simply be the summation of the flow rates specified by the
ventilation objects.
More advanced ventilation calculations are possible using the EnergyPlus AirflowNetwork
model.
Field: Name
The name of the ZoneVentilation:DesignFlowRate object.
Field: Zone or ZoneList Name
This field is the name of the zone (ref: Zone) or ZoneList (ref: ZoneList) and attaches a
particular ventilation statement to a thermal zone or set of thermal zones in the building.
When the ZoneList option is used then this ventilation definition is applied to each of the
zones in the zone list effecting a global definition for the amount of infiltration flow rate in the
zone. The Zonelist option can be used effectively with the flow/area, flow/person, or
airchanges/hour of the Design Flow Rate Calculation Method.
The
name
of
the
actual
ventilation
object
becomes
<Zone
Name>
<ZoneVentilation:DesignFlowRate Object Name> and should be less than the standard
length (100 characters) for a name field. If it is greater than this standard length, it may be
difficult to specify in output reporting as it will be truncated. A warning will be shown if the

9/29/14

440

Input-Output Reference

Group Airflow

generated name is greater than 100 characters. If it duplicates another such concatenated
name, there will be a severe error and terminate the run.
Field: Schedule Name
This field is the name of the schedule (ref: Schedule) that modifies the maximum design
volume flow rate (Vdesign) (see Design Flow Rate Calculation Method field and related
subsequent fields). This fraction between 0.0 and 1.0 is noted as Fschedule in the above
equation.
Field: Design Flow Rate Calculation Method
This field is a key/choice field that tells which of the next four fields are filled and is
descriptive of the method for calculating the design volume flow rate. The key/choices are:
Flow/Zone
With this choice, the method used will be a straight insertion of the design volume flow rate.
(The Design Flow Rate field should be filled.)
Flow/Area
With this choice, the method used will be a factor per floor area of the zone. (The Flow per
Zone Floor Area field should be filled).
Flow/Person
With this choice, the method used will be a factor per nominal number of people in the zone.
(The Flow per Person field should be filled).
AirChanges/Hour
With this choice, the method used will be the number of air changes per hour for the
infiltration amount. This factor, along with the Zone Volume, will be used to determine the
Design Flow Rate. (The Air Changes per Hour field should be filled).
Field: Design Flow Rate
This field denotes the full design volume flow rate (m 3/s). The previous field should choose
flow/zone as the choice. The design volume flow rate (noted as V design in the above
equation) is the maximum amount of ventilation expected at design conditions. The design
value is modified by the schedule fraction (see Field: Schedule Name) and user specified
coefficients (see four coefficient fields below).
Field: Flow Rate per Zone Floor Area
This factor (m3/s-m2) is used, along with the Zone Area to determine the maximum Design
Volume Flow Rate as described in the Design Volume Flow Rate field. The choice from the
method field should be flow/area.
Field: Flow Rate per Person
This factor (m3/s-person) is used, along with the nominal (maximum) number of occupants
(people) in the Zone to determine the maximum Design Volume Flow Rate as described in
the Design Volume Flow Rate field. The choice from the method field should be
flow/person.
Field: Air Changes per Hour
With this choice, the method used will be the number of air changes per hour for the
ventilation amount. This factor, along with the Zone Volume, will be used to determine the
Design Flow Rate. The choice from the method field should be AirChanges/Hour.
Field: Ventilation Type
This alpha character string defines the type of ventilation as one of the following options:
Natural, Exhaust, Intake, or Balanced. Natural ventilation is assumed to be air
movement/exchange as a result of openings in the building faade and will not consume any
9/29/14

441

Input-Output Reference

Group Airflow

fan energy. Values for fan pressure and efficiency for natural ventilation are ignored. For
either Exhaust or Intake, values for fan pressure and efficiency define the fan electric
consumption. For Natural and Exhaust ventilation, the conditions of the air entering the space
are assumed to be equivalent to outside air conditions. For Intake and Balanced ventilation,
an appropriate amount of fan heat is added to the entering air stream. For Balanced
ventilation, both an intake fan and an exhaust fan are assumed to co-exist, both having the
same flow rate and power consumption (using the entered values for fan pressure rise and
fan total efficiency). Thus, the fan electric consumption for Balanced ventilation is twice that
for the Exhaust or Intake ventilation types which employ only a single fan.
Field: Fan Pressure Rise
This is the pressure rise experienced across the fan in Pascals (N/m 2). This is a function of
the fan and plays a role in determining the amount of energy consumed by the fan.
Field: Fan Total Efficiency
This value is the overall efficiency of the fan, i.e., the ratio of the power delivered to the fluid
to the electrical input power. It is the product of the motor efficiency and the impeller
efficiency. The motor efficiency is the power delivered to the shaft divided by the electrical
power input to the motor. The impeller efficiency is power delivered to the fluid (air) divided by
the shaft power. The power delivered to the fluid is the mass flow rate of the air multiplied by
the pressure rise divided by the air density. This input value must be between 0 and 1."
Field: Constant Term Coefficient
This number is the A parameter in the above ventilation equation. It is part of the user
specified modifying parameters that are a function of environmental factors. This parameter,
however, is a constant under all conditions and is not modified by any environmental effect.
As a result, it is dimensionless.
Field: Temperature Term Coefficient
This number is the B parameter in the above ventilation equation. It is part of the user
specified modifying parameters that are a function of environmental factors. This parameter is
modified by the temperature difference between the outdoor and indoor air dry-bulb
temperatures. The units for this parameter are inverse Celsius.
Field: Velocity Term Coefficient
This number is the C parameter in the above ventilation equation. It is part of the user
specified modifying parameters that are a function of environmental factors. This parameter is
modified by the speed of wind being experienced outside the building. The units for this
parameter are s/m.
Field: Velocity Squared Term Coefficient
This number is the D parameter in the above ventilation equation. It is part of the user
specified modifying parameters that are a function of environmental factors. This parameter is
modified by square of the speed of wind being experienced outside the building. The units for
this parameter are s2/m2.
Field: Minimum Indoor Temperature
This is the indoor temperature (in Celsius) below which ventilation is shutoff. The minimum
value for this field is -100.0 C and the maximum value is 100.0 C. The default value is 100.0 C if the field is left blank. This lower temperature limit is intended to avoid overcooling
a space and thus result in a heating load. For example, if the user specifies a minimum
temperature of 20 C, ventilation is assumed to be available if the zone air temperature is
above 20 C. If the zone air temperature drops below 20 C, then ventilation is automatically
turned off.

9/29/14

442

Input-Output Reference

Group Airflow

Field: Minimum Indoor Temperature Schedule Name

This alpha field defines the name of a schedule (ref. Schedule objects) which contains the
minimum indoor temperature (in Celsius) below which ventilation is shutoff as a function of
time. The minimum temperature value in the schedule can be -100 C and the maximum
value can be 100 C. This field is an optional field and has the same functionality as the
Minimum Indoor Temperature field. If the user enters a valid schedule name, the minimum
temperature values specified in this schedule will override the constant value specified in the
Minimum Indoor Temperature field.
Field: Maximum Indoor Temperature
This is the indoor temperature (in Celsius) above which ventilation is shutoff. The minimum
value for this field is -100.0 C and the maximum value is 100.0 C. The default value is
100.0 C if the field is left blank. This upper temperature limit is intended to avoid overheating
a space and thus result in a cooling load. For example, if the user specifies a maximum
temperature of 28 C, ventilation is assumed to be available if the zone air temperature is
below 28 C. If the zone air temperature increases to 28 C, then ventilation is automatically
turned off.
Field: Maximum Indoor Temperature Schedule Name
This alpha field defines the name of a schedule (ref. Schedule objects) which contains the
maximum indoor temperature (in Celsius) above which ventilation is shutoff as a function of
time. The minimum temperature value in the schedule can be -100 C and the maximum
value can be 100 C. This field is an optional field and has the same functionality as the
Maximum Indoor Temperature field. If the user enters a valid schedule name, the maximum
temperature values specified in this schedule will override the constant value specified in the
Maximum Indoor Temperature field.
Field: Delta Temperature
This is the temperature difference (in Celsius) between the indoor and outdoor air dry-bulb
temperatures below which ventilation is shutoff. The minimum value for this field is -100.0 C
and the default value is also -100.0 C if the field is left blank. This field allows ventilation to be
stopped if the temperature outside is too warm and could potentially heat the space. For
example, if the user specifies a delta temperature of 2 C, ventilation is assumed to be
available if the outside air temperature is at least 2 C cooler than the zone air temperature. If
the outside air dry-bulb temperature is less than 2 C cooler than the indoor dry-bulb
temperature, then ventilation is automatically turned off.
The values for this field can include negative numbers. This allows ventilation to occur even if
the outdoor temperature is above the indoor temperature. The Delta Temperature is used in
the code in the following way:
IF ((IndoorTemp - OutdoorTemp) < DeltaTemperature) Then ventilation is not allowed.

Thus, if a large negative number is input for DeltaTemperature, the ventilation can be kept on
even if the outdoor temperature is greater than the indoor temperature. This is useful for
uncontrolled natural ventilation (open windows) or as a way to estimate the effect of required
ventilation air for load calculations.
Field: Delta Temperature Schedule Name
This alpha field contains the name of a schedule (ref. Schedule objects) which contains the
temperature difference (in Celsius) between the indoor and outdoor air dry-bulb temperatures
below which ventilation is shutoff as a function of time. The minimum temperature difference
value in the schedule can be -100 C. This field is an optional field and has the same
functionality as the Delta Temperature field. If the user enters a valid schedule name, the
delta temperature values specified in this schedule will override the constant value specified
in the Delta Temperature field.
9/29/14

443

Input-Output Reference

Group Airflow

Field: Minimum Outdoor Temperature

This is the outdoor temperature (in Celsius) below which ventilation is shut off. The minimum
value for this field is -100.0 C and the maximum value is 100.0 C. The default value is
-100.0 C if the field is left blank. This lower temperature limit is intended to avoid overcooling
a space, which could result in a heating load.
Field: Minimum Outdoor Temperature Schedule Name
This alpha field contains the name of a schedule (ref. Schedule objects) which contains the
minimum outdoor temperature (in Celsius) below which ventilation is shutoff as a function of
time. The minimum temperature value in the schedule can be -100 C and the maximum
value can be 100 C. This field is an optional field and has the same functionality as the
Minimum Outdoor Temperature field. If the user enters a valid schedule name, the
temperature values in this schedule will override the constant value specified in the Minimum
Outdoor Temperature field.
Field: Maximum Outdoor Temperature
This is the outdoor temperature (in Celsius) above which ventilation is shut off. The minimum
value for this field is -100.0 C and the maximum value is 100.0 C. The default value is
100.0 C if the field is left blank. This upper temperature limit is intended to avoid overheating
a space, which could result in a cooling load.
Field: Maximum Outdoor Temperature Schedule Name
This alpha field contains the name of a schedule (ref. Schedule objects) which contains the
minimum outdoor temperature (in Celsius) above which ventilation is shutoff as a function of
time. The minimum temperature value in the schedule can be -100 C and the maximum
value can be 100 C. This field is an optional field and has the same functionality as the
Maximum Outdoor Temperature field. If the user enters a valid schedule name, the
temperature values in this schedule will override the constant value specified in the Maximum
Outdoor Temperature field.
Field: Maximum Wind Speed
This is the wind speed (m/s) above which ventilation is shut off. This can help simulate
conditions where one would normally close windows to avoid chaos in a space (papers
blowing around, etc.).
Two IDF examples are provided below:
ZoneVentilation:DesignFlowRate,
Ventilation 1, !- Name
ZONE 2,
!- Zone Name
Simple Vent,
!- Schedule Name
Flow/Zone,
!- Design Volume Flow Rate calculation method
6.131944,
!- Design Volume Flow Rate {m3/s}
,
!- Volume Flow Rate per area {m3/s/m2}
,
!- Volume Flow Rate per person {m3/s/person}
,
!- Air Changes Per Hour
INTAKE,
!- Ventilation Type
400.0,
!- Fan Pressure Rise{Pa}
0.9,
!- Fan Total Efficiency
0.6060000
, !- Constant Term Coefficient
2.0199999E-02, !- Temperature Term Coefficient
5.9800001E-04, !- Velocity Term Coefficient
0.0000000E+00!- Velocity Squared Term Coefficient
18.0,
!- Minimum Indoor Temperature {C}
,
!- Minimum Indoor Temperature Schedule Name
,
!- Maximum Indoor Temperature {C}
,
!- Maximum Indoor Temperature Schedule Name
1.0;
!- Delta temperature {C}

9/29/14

444

Input-Output Reference
ZoneVentilation:DesignFlowRate,
SPACE1-1 Ventl 1,
!SPACE1-1,
!NightVentSched,
!Flow/Zone,
!.05295,
!,
!,
!,
!Intake,
!67.,
!.7,
!1,
!0,
!0,
!0,
!,
!MinIndoorTemp,
!,
!MaxIndoorTemp,
!,
!DeltaTemp,
!,
!MinOutdoorTemp,
!,
!MaxOutdoorTemp,
!40;
!-

Group Airflow

Name
Zone Name
SCHEDULE Name
Design Volume Flow Rate calculation method
Design Volume Flow Rate {m3/s}
Volume Flow Rate per area {m3/s/m2}
Volume Flow Rate per person {m3/s/person}
Air Changes Per Hour
Ventilation Type
Fan Pressure Rise
Fan Total Efficiency
Constant Term Coefficient
Temperature Term Coefficient
Velocity Term Coefficient
Velocity Squared Term Coefficient
Minimum Indoor Temperature {C}
Minimum Indoor Temperature Schedule Name
Maximum Indoor Temperature {C}
Maximum Indoor Temperature Schedule Name
Delta Temperature {deltaC}
Delta Temperature Schedule Name
Minimum Outdoor Temperature {C}
Minimum Outdoor Temperature Schedule Name
Maximum Outdoor Temperature {C}
Maximum Outdoor Temperature Schedule Name
Maximum WindSpeed {m/s}

Global Ventilation example:

Zonelist, West-East Zones, West Zone, East Zone;
ZoneVentilation:DesignFlowRate,
West-East Zones Ventilation,
!- Name
West-East Zones,
!- Zone or ZoneList Name
VentSched,
!- Schedule Name
AirChanges/Hour,
!- Design Flow Rate Calculation Method
,
!- Design Flow Rate {m3/s}
,
!- Flow Rate per Zone Floor Area {m3/s-m2}
,
!- Flow Rate per Person {m3/s-person}
1.7,
!- Air Changes per Hour
Intake,
!- Ventilation Type
67.,
!- Fan Pressure Rise {Pa}
0.7,
!- Fan Total Efficiency
1,
!- Constant Term Coefficient
0,
!- Temperature Term Coefficient
0,
!- Velocity Term Coefficient
0,
!- Velocity Squared Term Coefficient
,
!- Minimum Indoor Temperature {C}
MinIndoorTemp,
!- Minimum Indoor Temperature Schedule Name
,
!- Maximum Indoor Temperature {C}
MaxIndoorTemp,
!- Maximum Indoor Temperature Schedule Name
,
!- Delta Temperature {deltaC}
DeltaTemp,
!- Delta Temperature Schedule Name
,
!- Minimum Outdoor Temperature {C}
MinOutdoorTemp,
!- Minimum Outdoor Temperature Schedule Name
,
!- Maximum Outdoor Temperature {C}
MaxOutdoorTemp,
!- Maximum Outdoor Temperature Schedule Name
40;
!- Maximum Wind Speed {m/s}

ZoneVentilation:WindandStackOpenArea
For this model, the ventilation air flow rate is a function of wind speed and thermal stack
effect, along with the area of the opening being modeled. This object can be used alone or in
combination with ZoneVentilation:DesignFlowRate objects. This model is intended for
simplified ventilation calculations as opposed to the more detailed ventilation investigations
that can be performed with the AirflowNetwork model. Using the Wind and Stack with Open
Area model, the natural ventilation flow rate can be controlled by a multiplier fraction
9/29/14

445

Input-Output Reference

Group Airflow

schedule applied to the user-defined opening area and through the specification of minimum,
maximum and delta temperatures. The temperatures can be either single constant values for
the entire simulation or schedules which can vary over time. The equation used to calculate
the ventilation rate driven by wind is:

Qw

Cw Aopening FscheduleV

where,

Qw
= Volumetric air flow rate driven by wind [m 3/s]
Cw
= Opening effectiveness [dimensionless]
Aopening = Opening area [m2]
Fschedule = Open area fraction [user-defined schedule value, dimensionless]
V
= Local wind speed [m/s]
The equation used to calculate the ventilation rate due to stack effect is:

Qs

CD Aopening Fschedule 2 g H NPL (| Tzone Todb | /Tzone )

where,

Qs
= Volumetric air flow rate due to stack effect [m 3/s]
CD
= Discharge coefficient for opening [dimensionless]
Aopening = Opening area [m2]
Fschedule = Open area fraction [user-defined schedule value, dimensionless]
HNPL = Height from midpoint of lower opening to the neutral pressure level [m].
Estimation of this value is difficult; refer to Chapter 16 of the 2009 ASHRAE
Handbook of Fundamentals for guidance.

Tzone
Todb

= Zone air dry-bulb temperature [K]

= Local outdoor air dry-bulb temperature [K]

The total ventilation rate calculated by this model is the quadrature sum of the wind and stack
air flow components:

VentilationWindAndStack

Qs 2 Qw2

The local outdoor air dry-bulb temperature used in the stack effect equation (Todb) is typically
a function of the height of the zone centroid above ground. The corresponding zone name is
given in the second field. The local outdoor air dry-bulb temperature calculation procedure is
described in the Local Outdoor Air Temperature Calculation section of the Engineering
Reference.
The local outdoor wind speed used in the above wind-driven equation (V) is also a function of
the height of the zone centroid above ground. The corresponding zone name is given in the
second field. The local outdoor wind speed calculation procedure is described in the Local
Wind Speed Calculation section of the Engineering Reference.
Note: When the value of the Wind Speed Profile Exponent field in the Site:HeightVariation object is equal
to 0.0, the local wind speed is always equal to the wind speed given in the weather data and will not be
dependent on zone centroid height. Similarly, if the value of the Air Temperature Gradient Coefficient is

9/29/14

446

Input-Output Reference

Group Airflow

set equal to 0, the local air dry-bulb temperature is also always equal to the air dry-bulb temperature given
in the weather data and will not be dependent on zone centroid height.

One or more ventilation objects (i.e., ZoneVentilation:DesignFlowRate and/or

ZoneVentilation:WindandStackOpenArea) can be defined for each zone, and the resulting
ventilation rate for the zone will simply be the summation of the flow rates specified by the
ventilation objects.
More advanced ventilation calculations are possible using the EnergyPlus AirflowNetwork
model.
Field: Name
The name of the ZoneVentilation:WindandStackOpenArea object.
Field: Zone Name
This field is the name of the zone (ref: Zone) and attaches a particular ventilation statement
to a thermal zone in the building.
Field: Opening Area
This is the opening area exposed to outdoors (m 2) in a zone.
Field: Opening Area Fraction Schedule Name
This field is the name of the schedule (ref: Schedule) which modifies the Opening Area value
(see previous field). The schedule values must be any positive number between 0 and 1 as a
fraction. The actual opening area in a zone for a particular simulation time step is defined as
the product of the Opening Area input field and the value specified by the schedule named in
this input field.
Field: Opening Effectiveness
This field is the opening effectiveness (Cw). The value must be between 0.0 and 1.0 or the
value can be autocalculated. If a real value is input, that constant value will be used in the
calculations. Otherwise, this field can be left blank (default = Autocalculate) or the user can
input Autocalculate. Based on recommended values provided in Chapter 16 of the 2009
ASHRAE Handbook of Fundamentals, Cw = 0.55 for perpendicular winds and Cw = 0.3 for
diagonal winds. For Autocalculate, any angles between perpendicular and diagonal are
linearly interpolated between 0.3 and 0.55 by the model.
Field: Effective Angle
This is the angle in degrees counting from the North clockwise to the opening outward
normal. The value must be between 0 and 360, with the default being 0 if this input field is left
blank. The Effective Angle is 0 if the opening outward normal faces North, 90 if faces East,
180 if faces South, and 270 if faces West. The value is fixed and independent of coordinate
system defined in the GlobalGeometryRules object. This input field value is used to calculate
the angle between the wind direction and the opening outward normal to determine the
opening effectiveness values when the input field Opening Effectiveness = Autocalculate.
Field: Height Difference
This is the height difference between the midpoint of the lower opening and the neutral
pressure level in meters. This value is a required user input.
Note: Estimation of the height difference is difficult for natural ventilated buildings. Chapter 16 of the 2009
ASHRAE Handbook of Fundamentals may provide guidance for estimating the height difference.

9/29/14

447

Input-Output Reference

Group Airflow

Field: Discharge Coefficient for Opening

This is the discharge coefficient for the opening (CD). The value must be between 0.0 and
1.0, or the value can be autocalculated. If a real value is input, that constant value will be
used in the calculations. Otherwise, this field can be left blank (default = Autocalculate) or the
user can input Autocalculate. For Autocalculate, the program will determine the discharge
coefficient based on the following equation:

CD

0.40 0.0045 Tzone Todb

Field: Minimum Indoor Temperature

This is the indoor temperature (in Celsius) below which ventilation is shutoff. The minimum
value for this field is -100.0 C and the maximum value is 100.0 C. The default value is
-100.0 C if the field is left blank. This lower temperature limit is intended to avoid overcooling
a space and thus result in a heating load. For example, if the user specifies a minimum
temperature of 20 C, ventilation is assumed to be available if the zone air temperature is
above 20 C. If the zone air temperature drops below 20 C, then ventilation is automatically
turned off.
Field: Minimum Indoor Temperature Schedule Name
This alpha field defines the name of a schedule (ref. Schedule objects) which contains the
minimum indoor temperature (in Celsius) below which ventilation is shutoff as a function of
time. The minimum temperature value in the schedule can be -100 C and the maximum
value can be 100 C. This field is an optional field and has the same functionality as the
Minimum Indoor Temperature field. If the user enters a valid schedule name, the minimum
temperature values specified in this schedule will override the constant value specified in the
Minimum Indoor Temperature field.
Field: Maximum Indoor Temperature
This is the indoor temperature (in Celsius) above which ventilation is shutoff. The minimum
value for this field is -100.0 C and the maximum value is 100.0 C. The default value is
100.0 C if the field is left blank. This upper temperature limit is intended to avoid overheating
a space and thus result in a cooling load. For example, if the user specifies a maximum
temperature of 28 C, ventilation is assumed to be available if the zone air temperature is
below 28 C. If the zone air temperature increases to 28 C, then ventilation is automatically
turned off.
Field: Maximum Indoor Temperature Schedule Name
This alpha field defines the name of a schedule (ref. Schedule objects) which contains the
maximum indoor temperature (in Celsius) above which ventilation is shutoff as a function of
time. The minimum temperature value in the schedule can be -100 C and the maximum
value can be 100 C. This field is an optional field and has the same functionality as the
Maximum Indoor Temperature field. If the user enters a valid schedule name, the maximum
temperature values specified in this schedule will override the constant value specified in the
Maximum Indoor Temperature field.
Field: Delta Temperature
This is the temperature difference (in Celsius) between the indoor and outdoor air dry-bulb
temperatures below which ventilation is shutoff. The minimum value for this field is -100.0 C
and the default value is also -100.0 C if the field is left blank. This field allows ventilation to be
stopped if the temperature outside is too warm and could potentially heat the space. For
example, if the user specifies a delta temperature of 2 C, ventilation is assumed to be
available if the outside air temperature is at least 2 C cooler than the zone air temperature. If

9/29/14

448

Input-Output Reference

Group Airflow

the outside air dry-bulb temperature is less than 2 C cooler than the indoor dry-bulb
temperature, then ventilation is automatically turned off.
The values for this field can include negative numbers. This allows ventilation to occur even if
the outdoor temperature is above the indoor temperature. The Delta Temperature is used in
the code in the following way:
IF ((IndoorTemp - OutdoorTemp) < DeltaTemperature) Then ventilation is not allowed.

Thus, if a large negative number is input for DeltaTemperature, the ventilation can be kept on
even if the outdoor temperature is greater than the indoor temperature. This is useful for
uncontrolled natural ventilation (open windows) or as a way to estimate the effect of required
ventilation air for load calculations.
Field: Delta Temperature Schedule Name
This alpha field contains the name of a schedule (ref. Schedule objects) which contains the
temperature difference (in Celsius) between the indoor and outdoor air dry-bulb temperatures
below which ventilation is shutoff as a function of time. The minimum temperature difference
value in the schedule can be -100 C. This field is an optional field and has the same
functionality as the Delta Temperature field. If the user enters a valid schedule name, the
delta temperature values specified in this schedule will override the constant value specified
in the Delta Temperature field.
Field: Minimum Outdoor Temperature
This is the outdoor temperature (in Celsius) below which ventilation is shut off. The minimum
value for this field is -100.0 C and the maximum value is 100.0 C. The default value is
-100.0 C if the field is left blank. This lower temperature limit is intended to avoid overcooling
a space, which could result in a heating load.
Field: Minimum Outdoor Temperature Schedule Name
This alpha field contains the name of a schedule (ref. Schedule objects) which contains the
minimum outdoor temperature (in Celsius) below which ventilation is shutoff as a function of
time. The minimum temperature value in the schedule can be -100 C and the maximum
value can be 100 C. This field is an optional field and has the same functionality as the
Minimum Outdoor Temperature field. If the user enters a valid schedule name, the
temperature values in this schedule will override the constant value specified in the Minimum
Outdoor Temperature field.
Field: Maximum Outdoor Temperature
This is the outdoor temperature (in Celsius) above which ventilation is shut off. The minimum
value for this field is -100.0 C and the maximum value is 100.0 C. The default value is
100.0 C if the field is left blank. This upper temperature limit is intended to avoid overheating
a space, which could result in a cooling load.
Field: Maximum Outdoor Temperature Schedule Name
This alpha field contains the name of a schedule (ref. Schedule objects) which contains the
minimum outdoor temperature (in Celsius) above which ventilation is shutoff as a function of
time. The minimum temperature value in the schedule can be -100 C and the maximum
value can be 100 C. This field is an optional field and has the same functionality as the
Maximum Outdoor Temperature field. If the user enters a valid schedule name, the
temperature values in this schedule will override the constant value specified in the Maximum
Outdoor Temperature field.
Field: Maximum Wind Speed
This is the wind speed (m/s) above which ventilation is shut off. This can help simulate
conditions where one would normally close windows to avoid chaos in a space (papers
blowing around, etc.).
9/29/14

449

Input-Output Reference

Group Airflow

An IDF example is provided below:

ZoneVentilation:WindandStackOpenArea,
ZONE 3 Ventl 1,
!- Name
ZONE 3,
!- Zone Name
0.5,
!- Opening Area {m2}
Constant,
!- Opening Area Fraction Schedule Name
AutoCalculate,
!- Opening Effectiveness
0.0,
!- Effective Angle {deg}
1.0,
!- Height Difference {m}
AutoCalculate,
!- Discharge Coefficient for Opening
18.0,
!- Minimum Indoor Temperature {C}
,
!- Minimum Indoor Temperature Schedule Name
,
!- Maximum Indoor Temperature {C}
,
!- Maximum Indoor Temperature Schedule Name
1.0;
!- Delta Temperature {deltaC}

ZoneVentilation Outputs
Current ventilation output variables:
HVAC,Sum,Zone Ventilation Sensible Heat Loss Energy [J]
HVAC,Sum,Zone Ventilation Sensible Heat Gain Energy [J]
HVAC,Sum,Zone Ventilation Latent Heat Loss Energy [J]
HVAC,Sum,Zone Ventilation Latent Heat Gain Energy [J]
HVAC,Sum,Zone Ventilation Total Heat Loss Energy [J]
HVAC,Sum,Zone Ventilation Total Heat Gain Energy [J]
HVAC,Average,Zone Ventilation Current Density Volume Flow Rate [m3/s]
HVAC,Average,Zone Ventilation Standard Density Volume Flow Rate [m3/s]
HVAC,Sum,Zone Ventilation Current Density Volume [m3]
HVAC,Sum,Zone Ventilation Standard Density Volume [m3]
HVAC,Sum,Zone Ventilation Mass [kg]
HVAC,Sum,Zone Ventilation Mass Flow Rate [kg/s]
HVAC,Average,Zone Ventilation Air Change Rate [ach]
HVAC,Sum,Zone Ventilation Fan Electric Energy [J]
HVAC,Average,Zone Ventilation Air Inlet Temperature [C]

Note: If ZoneVentilation:* objects and ZoneAirBalance:OutdoorAir (with Air Balance Method = Quadrature)
objects reference the same Zone Name, the above ventilation output variables will not be reported for that
zone. Instead, output variables for zone outdoor air flow will be reported by the corresponding
ZoneAirBalance:OutdoorAir object.

Zone Ventilation Sensible Heat Loss Energy [J]

The sensible (temperature) heat loss that occurs when the ventilation inlet air temperature <
zone air temperature. If multiple ventilation objects are specified for a particular zone, the
ventilation inlet air temperature is from all ZoneVentilation:DesignFlowRate and
ZoneVentilation:WindandStackOpenArea objects specified for the zone.
Zone Ventilation Sensible Heat Gain Energy [J]
The sensible (temperature) heat gain that occurs when the ventilation inlet air temperature >=
zone air temperature. If multiple ventilation objects are specified for a particular zone, the
ventilation inlet air temperature is from all ZoneVentilation:DesignFlowRate and
ZoneVentilation:WindandStackOpenArea objects specified for the zone.
Zone Ventilation Latent Heat Loss Energy [J]
The latent heat loss that occurs when the Ventilation air humidity ratio (outdoor) < zone air
humidity
ratio
from
all
ZoneVentilation:DesignFlowRate
and
ZoneVentilation:WindandStackOpenArea objects specified for the zone.

9/29/14

450

Input-Output Reference

Group Airflow

Zone Ventilation Latent Heat Gain Energy [J]

The latent heat gain that occurs when the Ventilation air humidity ratio (outdoor) >= zone air
humidity
ratio
from
all
ZoneVentilation:DesignFlowRate
and
ZoneVentilation:WindandStackOpenArea objects specified for the zone.
Zone Ventilation Total Heat Loss Energy [J]
The total heat loss that occurs when the sum of Zone Ventilation Sensible Heat Gain Energy
and Zone Ventilation Latent Heat Gain Energy < the sum of Zone Ventilation Sensible Heat
Loss Energy and Zone Ventilation Latent Heat Loss Energy.
Zone Ventilation Total Heat Gain Energy [J]
The total heat gain that occurs when the sum of Zone Ventilation Sensible Heat Gain Energy
and Zone Ventilation Latent Heat Gain Energy >= the sum of Zone Ventilation Sensible Heat
Loss Energy and Zone Ventilation Latent Heat Loss Energy.
Zone Ventilation Current Density Volume [m3]
Zone Ventilation Current Density Volume Flow Rate [m3/s]
These outputs are the total volume and volume flow rate of ventilation air based on the
current density of zone air.
Zone Ventilation Standard Density Volume [m3]
Zone Ventilation Standard Density Volume Flow Rate [m3/s]
These outputs are the total volume and volume flow rate of ventilation air based on the
standard density of air. Standard density in EnergyPlus corresponds to 20C drybulb, dry air,
and nominally adjusted for elevation.
Zone Ventilation Mass [kg]
This output is the total mass flow into a particular zone from outdoors.
Zone Ventilation Mass Flow Rate [kg/s]
This output is the total mass flow rate into a particular zone from outdoors.
Zone Ventilation Air Change Rate [ach]
The volume flow rate of the ventilation air in air changes per hour.
Zone Ventilation Fan Electric Energy [J]
The fan electrical consumption for Intake
ZoneVentilation:DesignFlowRate objects only).

or

Exhaust

ventilation

types

(for

Zone Ventilation Air Inlet Temperature [C]

This is equal to the outdoor air temperature except when INTAKE fan power is included (for
ZoneVentilation:DesignFlowRate objects only). When intake fan power is used, then the
additional heat due to the fan is added to the outdoor temperature and this will be reported as
the inlet air temperature. If multiple ventilation objects are specified for a particular zone, the
reported value is the mass flow weighted temperature for the multiple ventilation objects
specified for this zone.
ZoneAirBalance:OutdoorAir
This model calculates a combined zone outdoor airflow by including interactions between
mechanical ventilation, infiltration and duct leakage. It is mainly applied to a single zone (e.g.,
residential) building. The model combines all outdoor airflows from ZoneInfiltration and
ZoneVentilation objects in the same zone. This object also includes the induced outdoor
airflows due to unbalanced duct leakage, and unbalanced outdoor airflows introduced by
9/29/14

451

Input-Output Reference

Group Airflow

unbalanced airflows from ZoneHVAC:EnergyRecoveryVentilator objects when the exhaust

airflow is greater than the supply outdoor airflow. This model is intended for simplified outdoor
airflow calculations as opposed to the more detailed outdoor airflow investigations that can be
performed with the AirflowNetwork model. The equation used to calculate the combined zone
outdoor airflow is:

Qn 2 Qu ,v 2 Qu ,l 2

Qb,v

where,
Q = Combined outdoor airflow with infiltration, balanced and unbalanced outdoor air flows,
and unbalanced duct leakage [m 3/s]
Qn = Natural infiltration airflow from ZoneInfiltration:* objects [m3/s]
Qb,v = Balanced ventilation airflow, excluding infiltration [m 3/s]
Qu,v = Unbalanced ventilation airflow, excluding infiltration [m 3/s]
Qu,l = Unbalanced duct leakage: the difference between supply and return leaks [m 3/s]
This object cannot be used simultaneously with the EnergyPlus AirflowNetwork model. If the
AirflowNetwork model is active for a simulation time step, the Air Balance Method is reset to
None for that time step. More advanced outdoor airflow calculations are possible using the
EnergyPlus AirflowNetwork model.
This object does not combine any airflows from Fan:ZoneExhaust objects and is independent
of HVAC equipment operation.
This object will not work with the AvailabilityManager:HybridVentilation object in the same
zone, when the Simple Airflow Control Type Schedule Name is provided in the
HybridVentilation object. For this case, the Air Balance Method is reset to None.
Field: Name
The name of the ZoneOutdoorAir:Combined object.
Field: Zone Name
This field is the name of the zone (ref: Zone) and attaches a combined outdoor airflow
statement to a thermal zone in the building.
Field: Air Balance Method
This choice field determines the air balance method. Two choices are Quadrature and None.
If Quadrature, the combined zone outdoor air flow is calculated based on the above equation.
If None, no combining of outdoor air will be performed (i.e., any ZoneInfiltration:* and
ZoneVentilation:* objects specified for this zone are simulated individually).
Field: Induced Outdoor Air Due to Unbalanced Duct Leakage
This is the induced outdoor airflow rate, in m 3/s, due to unbalanced duct leakage. If left blank,
the default value is 0.
Field: Induced Outdoor Air Schedule Name
This field is the name of the schedule (ref: Schedule) which modifies the induced outdoor
airflow rate value (see previous field). The schedule values must be any positive number
between 0 and 1 as a fraction. The actual induced outdoor airflow rate in a zone for a
particular simulation time step is defined as the product of the Induced Outdoor Air Due to
Unbalanced Duct Leakage input field and the value specified by the schedule named in this
input field.

9/29/14

452

Input-Output Reference

Group Airflow

Note: Since this object is independent of HVAC operation, the inputs for the last two fields should be
carefully selected to match HVAC system operation schedules.

An IDF example is provided below:

ZoneAirBalance:OutdoorAir,
ZONE 2 Balance 1,
ZONE 2,
Quadrature,
0.00,
Constant;

!!!!!-

Name
Zone Name
Air Balance Method
Induced Outdoor Air Due to Unbalanced Duct Leakage {m3/s}
Induced Outdoor Air Schedule Name

ZoneAirBalance:OutdoorAir Outputs
ZoneAirBalance:OutdoorAir output variables will be provided when the Air Balance Method is
Quadrature. Output variables from the associated ZoneVentilation:* and ZoneInfiltration:*
objects for the same zone will not be produced when ZoneAirBalance:OutdoorAir output
variables are available. If the Air Balance Method = None, then no ZoneAirBalance:OutputAir
outputs will be produced and the associated ZoneVentilation:* and ZoneInfiltration:* objects
will specify their output variables for the zone.
HVAC,Sum,Zone Combined Outdoor Air Sensible Heat Loss Energy [J]
HVAC,Sum,Zone Combined Outdoor Air Sensible Heat Gain Energy [J]
HVAC,Sum,Zone Combined Outdoor Air Latent Heat Loss Energy [J]
HVAC,Sum,Zone Combined Outdoor Air Latent Heat Gain Energy [J]
HVAC,Sum,Zone Combined Outdoor Air Total Heat Loss Energy [J]
HVAC,Sum,Zone Combined Outdoor Air Total Heat Gain Energy [J]
HVAC,Average,Zone Combined Outdoor Air Current Density Volume Flow Rate [m3/s]
HVAC,Average,Zone Combined Outdoor Air Standard Density Volume Flow Rate [m3/s]
HVAC,Sum,Zone Combined Outdoor Air Current Density Volume [m3]
HVAC,Sum,Zone Combined Outdoor Air Standard Density Volume [m3]
HVAC,Sum,Zone Combined Outdoor Air Mass [kg]
HVAC,Sum,Zone Combined Outdoor Air Mass Flow Rate [kg/s]
HVAC,Average, Zone Combined Outdoor Air Changes per Hour [ach]
HVAC,Sum, Zone Combined Outdoor Air Fan Electric Energy [J]

Zone Combined Outdoor Air Sensible Heat Loss Energy [J]

The sensible (temperature) heat loss that occurs when the outdoor air temperature < zone air
temperature.
Zone Combined Outdoor Air Sensible Heat Gain Energy [J]
The sensible (temperature) heat gain that occurs when the outdoor air temperature >= zone
air temperature.
Zone Combined Outdoor Air Latent Heat Loss Energy [J]
The latent heat loss that occurs when the outdoor air humidity ratio < zone air humidity ratio.
Zone Combined Outdoor Air Latent Heat Gain Energy [J]
The latent heat gain that occurs when the outdoor air humidity ratio >= zone air humidity
ratio.
Zone Combined Outdoor Air Total Heat Loss Energy [J]
The total heat loss that occurs when the sum of Zone Combined Outdoor Air Sensible Heat
Gain Energy and Zone Combined Outdoor Air Latent Heat Gain Energy < the sum of Zone
Combined Outdoor Air Sensible Heat Loss Energy and Zone Combined Outdoor Air Latent
Heat Loss Energy.

9/29/14

453

Input-Output Reference

Group Airflow

Zone Combined Outdoor Air Total Heat Gain Energy [J]

The total heat gain that occurs when the sum of Zone Combined Outdoor Air Sensible Heat
Gain Energy and Zone Combined Outdoor Air Latent Heat Gain Energy >= the sum of Zone
Combined Outdoor Air Sensible Heat Loss Energy and Zone Combined Outdoor Air Latent
Heat Loss Energy.
Zone Combined Outdoor Air Current Density Volume [m3]
Zone Combined Outdoor Air Current Density Volume Flow Rate [m3/s]
These outputs are the total volume and volume flow rate of outdoor air based on the current
density of zone air.
Zone Combined Outdoor Air Standard Density Volume [m3]
Zone Combined Outdoor Air Standard Density Volume Flow Rate [m3/s]
These outputs are the total volume and volume flow rate of outdoor air based on the standard
density of air. Standard density in EnergyPlus corresponds to 20C drybulb, dry air, and
nominally adjusted for elevation.
Zone Combined Outdoor Air Mass [kg]
This output is the total mass flow into a particular zone from outdoors.
Zone Combined Outdoor Air Mass Flow Rate [kg/s]
This output is the total mass flow rate into a particular zone from outdoors.
Zone Combined Outdoor Air Changes per Hour [ach]
The volume flow rate of the ventilation air in air changes per hour.
Zone Combined Outdoor Air Fan Electric Energy [J]
The fan electrical consumption for Intake, Exhaust, or Balanced ventilation types (for
ZoneVentilation:DesignFlowRate objects used to calculate a combined zone outdoor airflow).
ZoneMixing
In EnergyPlus, the ZoneMixing syntax is intended to allow simplified treatment of air
exchange between zones. Note that this statement only affects the energy balance of the
receiving zone and that this statement will not produce any effect on the source zone.
Mixing statements can be complementary and include multiple zones, but the balancing of
flows between zones is left to the users discretion. The use of the Cross Mixing syntax (ref:
Cross Mixing) can allow for automatic balancing of flows and energy flow rates between
zones but is hindered by the limitation of only a single cross mixing statement per zone. The
use of Refrigeration Door Mixing syntax (ref: Refrigeration Door Mixing) automatically
balances the flow and energy between two zones and allows multiple mixing statements per
zone. More advanced mixing calculations are possible using the EnergyPlus AirflowNetwork
model for multi-zone airflow with or without HVAC system operation. Mixing is entered using
the following syntax.
Field: Name
The name of the ZoneMixing object.
Field: Zone Name
This field is the name of the zone (ref: Zone) receiving the amount of air being exchanged
and attaches a particular mixing statement to a thermal zone in the building.

9/29/14

454

Input-Output Reference

Group Airflow

Field: Schedule Name

This field is the name of the schedule (ref: Schedule) that modifies the maximum design
volume flow rate parameter (see next field). This fraction between 0.0 and 1.0 modifies the
design level parameter.
Field: Design Flow Rate Calculation Method
This field is a key/choice field that tells which of the next four fields are filled and is
descriptive of the method for calculating the design volume flow rate. The key/choices are:
Flow/Zone
With this choice, the method used will be a straight insertion of the design volume flow rate.
(The Design Flow Rate field should be filled.)
Flow/Area
With this choice, the method used will be a factor per floor area of the zone. (The Flow per
Zone Floor Area field should be filled).
Flow/Person
With this choice, the method used will be a factor per nominal number of people in the zone.
(The Flow per Person field should be filled).
AirChanges/Hour
With this choice, the method used will be the number of air changes per hour for the
infiltration amount. This factor, along with the Zone Volume, will be used to determine the
Design Flow Rate. (The Air Changes per Hour field should be filled).
Field: Design Flow Rate
This field denotes the full design volume flow rate (m 3/s). The previous field should choose
flow/zone as the choice. The design volume flow rate is the maximum amount of mixing air
expected. The design value is modified by the schedule fraction (see Field: Schedule Name)
and user specified coefficients (see four coefficient fields below).
Field: Flow Rate per Zone Floor Area
This factor (m3/s-m2) is used, along with the Zone Area to determine the maximum Design
Volume Flow Rate as described in the Design Volume Flow Rate field. The choice from the
method field should be Flow/Area.
Field: Flow Rate per Person
This factor (m3/s-person) is used, along with the nominal (maximum) number of occupants
(people) in the Zone to determine the maximum Design Volume Flow Rate as described in
the Design Volume Flow Rate field. The choice from the method field should be
Flow/Person.
Field: Air Changes per Hour
With this choice, the method used will be the number of air changes per hour for the mixing
amount. This factor, along with the Zone Volume, will be used to determine the Design Flow
Rate. The choice from the method field should be AirChanges/Hour.
Field: Source Zone Name
This field is the name of the source zone (ref: Zone) that exhausts the amount of air
specified by the design level and schedule fields to the zone named in the zone name field.
Field: Delta Temperature
This number controls when mixing air from the source zone is sent to the receiving zone. This
parameter is a temperature and is expressed in units of Celsius. If this field is positive, the
temperature of the zone from which the air is being drawn (source zone) must be Delta
Temperature warmer than the receiving zone air or else no mixing occurs. If this field is
9/29/14

455

Input-Output Reference

Group Airflow

negative, the temperature of the source zone must be Delta Temperature cooler than the
receiving zone air or else no mixing occurs. If this parameter is zero, mixing occurs
regardless of the relative zone temperatures.
Field: Delta Temperature Schedule Name
This alpha field contains the name of a schedule (ref. Schedule objects) which contains the
temperature difference (in Celsius) between the source zone and receiving zone air dry-bulb
temperatures as a function of time. This field is an optional field and has the same
functionality as the Delta Temperature field. If the user enters a valid schedule name, the
delta temperature values specified in this schedule will supersede the constant value
specified in the Delta Temperature field.
Field: Minimum Zone Temperature Schedule Name
This alpha field contains the name of a schedule (ref. Schedule objects) which contains the
minimum receiving zone temperature (in Celsius) below which mixing is shutoff as a function
of time. The minimum temperature value in the schedule can be -100 C and the maximum
value can be 100 C. This field is an optional field. If this field is not entered, the minimum
zone temperature control is not applied.
Field: Maximum Zone Temperature Schedule Name
This alpha field contains the name of a schedule (ref. Schedule objects) which contains the
maximum receiving zone temperature (in Celsius) above which mixing is shutoff as a function
of time. The maximum temperature value in the schedule can be -100 C and the maximum
value can be 100 C. This field is an optional field. If this field is not entered, the maximum
zone temperature control is not applied.
Note: The maximum zone temperature when mixing is shutoff must be greater than or equal to the
minimum zone temperature when mixing is shutoff at any given time. Otherwise, warnings will be issued
and the maximum zone shutoff temperature will be set to the minimum zone shutoff temperature.

Field: Minimum Source Zone Temperature Schedule Name

This alpha field contains the name of a schedule (ref. Schedule objects) which contains the
minimum source zone temperature (in Celsius) below which mixing is shutoff as a function of
time. The minimum temperature value in the schedule can be -100 C and the maximum
value can be 100 C. This field is an optional field. If this field is not entered, the minimum
source zone temperature control is not applied.
Field: Maximum Source Zone Temperature Schedule Name
This alpha field contains the name of a schedule (ref. Schedule objects) which contains the
maximum source zone temperature (in Celsius) above which mixing is shutoff as a function of
time. The maximum temperature value in the schedule can be -100 C and the maximum
value can be 100 C. This field is an optional field. If this field is not entered, the maximum
source zone temperature control is not applied.
Note: The maximum source zone temperature when mixing is shutoff must be greater than or equal to the
minimum source zone temperature when mixing is shutoff at any given time. Otherwise, warnings will be
issued and the maximum source zone shutoff temperature will be set to the minimum source zone shutoff
temperature.

9/29/14

456

Input-Output Reference

Group Airflow

Field: Minimum Outdoor Temperature Schedule Name

This alpha field contains the name of a schedule (ref. Schedule objects) which contains the
minimum outdoor temperature (in Celsius) below which mixing is shutoff as a function of time.
The minimum temperature value in the schedule can be -100 C and the maximum value can
be 100 C. This field is an optional field. If this field is not entered, the minimum outdoor
temperature control is not applied.
Field: Maximum Outdoor Temperature Schedule Name
This alpha field contains the name of a schedule (ref. Schedule objects) which contains the
maximum outdoor temperature (in Celsius) above which mixing is shutoff as a function of
time. The maximum temperature value in the schedule can be -100 C and the maximum
value can be 100 C. This field is an optional field. If this field is not entered, the maximum
outdoor temperature control is not applied.
Note: The maximum outdoor temperature when mixing is shutoff must be greater than or equal to the
minimum outdoor temperature which mixing is shutoff at any given time. Otherwise, a warning will be
issued and the maximum outdoor shutoff temperature will be set to the minimum outdoor shutoff
temperature.

An IDF Example:
ZoneMixing,
Kitchen_ZN_1_FLR_1 Exhaust Fanmixing_0, !- Name
Kitchen_ZN_1_FLR_1, !- Zone Name
Hours_of_operation, !- Schedule Name
Flow/Zone, !- Design Flow Rate Calculation Method
1.4540, !- Design Level
, !- Volume Flow Rate per Area {m3/s/m2}
, !- Volume Flow Rate Per Person {m3/s/person}
, !- Air Changes per Hour {ACH}
CAFETERIA_ZN_1_FLR_1, !- Source Zone Name
0.0; !- Delta Temperature

Zone Mixing Outputs

HVAC,Sum,Zone
HVAC,Sum,Zone
HVAC,Sum,Zone
HVAC,Sum,Zone
HVAC,Sum,Zone
HVAC,Sum,Zone
HVAC,Sum,Zone
HVAC,Sum,Zone
HVAC,Sum,Zone
HVAC,Sum,Zone
HVAC,Sum,Zone

Mixing
Mixing
Mixing
Mixing
Mixing
Mixing
Mixing
Mixing
Mixing
Mixing
Mixing

Volume [m3]
Current Density Volumetric Flow Rate [m3/s]
Standard Density Volumetric Flow Rate [m3/s]
Mass [kg]
Mass Flow Rate [kg/s]
Sensible Heat Loss Energy [J]
Sensible Heat Gain Energy [J]
Latent Heat Loss Energy [J]
Latent Heat Gain Energy [J]
Total Heat Loss [J]
Total Heat Gain Energy [J]

Zone Mixing Volume [m3]

The air volume in m 3 entering the zone due to the sum of mixing, cross-mixing, and
refrigeration-door mixing during the hour or timestep.
Zone Mixing Current Density Volumetric Flow Rate [m3/s]
The air volumetric flow rate in m 3/s entering the zone due to the sum of mixing, cross-mixing,
and refrigeration-door mixing during the hour or timestep using the density of air evaluated at
current zone air conditions.

9/29/14

457

Input-Output Reference

Group Airflow

Zone Mixing Standard Density Volumetric Flow Rate [m3/s]

The air volumetric flow rate in m 3/s entering the zone due to the sum of mixing, cross-mixing,
and refrigeration-door mixing during the hour or timestep using the density of air evaluated at
standard conditions.
Zone Mixing Mass [kg]
The air mass in kg entering the zone due to the sum of mixing, cross-mixing, and
refrigeration-door mixing during the hour or timestep. The air mass is calculated using the air
volume flow from each source zone and the density of air calculated for the average
conditions (temperature and humidity) between the source and receiving zones.
Zone Mixing Mass Flow Rate [kg/s]
The air mass flow rate in kg/s entering the zone due to the sum of mixing, cross-mixing, and
refrigeration-door mixing during the hour or timestep.
Zone Mixing Sensible Heat Loss Energy [J]
Zone Mixing Sensible Heat Gain Energy [J]
The sensible (temperature) heat transfer due to the sum of mixing, cross-mixing, and
refrigeration-door mixing in the host (receiving) zone is the sum of all the incoming air mass
flow rates multiplied by the elapsed time, the specific heat (calculated for the average
conditions (temperature and humidity) between the source and receiving zones) and the
temperature differences between the host zone and corresponding source zones. If the heat
transfer is negative, the heat transfer is considered to be a zone mixing sensible heat loss. If
the heat transfer is positive, the heat transfer is considered to be a zone mixing sensible heat
gain.
Zone Mixing Latent Heat Loss Energy [J]
Zone Mixing Latent Heat Gain Energy [J]
The latent heat transfer due to the sum of mixing, cross-mixing, and refrigeration-door mixing
in the host (receiving) zone is the sum of all the incoming air mass flow rates multiplied by the
elapsed time, the heat of vaporization (calculated for the average conditions (temperature
and humidity) between the source and receiving zones) and the humidity ratio differences
between the host zone and corresponding source zones. If the heat transfer is negative, the
heat transfer is considered to be a zone mixing latent heat loss. If the heat transfer is positive,
the heat transfer is considered to be a zone mixing latent heat gain.
Zone Mixing Total Heat Loss Energy [J]
The total heat loss due to the sum of mixing, cross-mixing, and refrigeration-door mixing that
occurs when the sum of Zone Mixing Sensible Heat Gain Energy and Zone Mixing Latent
Heat Gain Energy < the sum of Zone Mixing Sensible Heat Loss Energy and Zone Mixing
Latent Heat Loss Energy.
Zone Mixing Total Heat Gain Energy [J]
The total heat gain due to the sum of mixing, cross-mixing, and refrigeration-door mixing that
occurs when the sum of Zone Mixing Sensible Heat Gain Energy and Zone Mixing Latent
Heat Gain Energy >= the sum of Zone Mixing Sensible Heat Loss Energy and Zone Mixing
Latent Heat Loss Energy.
ZoneCrossMixing
The ZoneCrossMixing syntax is ideally suited for two zones that exchange an equal amount
of air between each other and do not have any air exchange with other zones. As with Mixing
(ref: Mixing), this is a simplified view of interzone airflow in EnergyPlus. The main difference
between Mixing and Cross Mixing is that Cross Mixing has an energy effect on both the
9/29/14

458

Input-Output Reference

Group Airflow

source and the receiving zone, thus maintaining both the air mass and energy balances in
the two zones.
Cross Mixing can be entered once, in one of the mixing zones; or twice, once for each zone.
The object should be entered once if Delta Temperature > 0.0 and it is desirable to have
mixing only when the source zone is warmer than the receiving zone. This might be the case
when the warmer zone is below the colder zone and the mixing is buoyancy driven. If the
zones are next to each other, separated by an open doorway, it would be more suitable to
input a cross mixing object for each zone. Then mixing would occur if the zone temperatures
differed by Delta Temperature or greater regardless of which is the warmer zone.
If Delta Temperature = 0.0, Cross Mixing can be entered either once or twice: the effect is
exactly the same.
Cross Mixing is entered using the following syntax.
Field: Name
The name of the ZoneCrossMixing object.
Field: Zone Name
This field is the name of the zone (ref: Zone) receiving the amount of air being exchanged
and attaches a particular cross mixing statement to a thermal zone in the building.
Field: Schedule Name
This field is the name of the schedule (ref: Schedule) that modifies the maximum design
volume flow rate parameter (see next field). This fraction between 0.0 and 1.0 modifies the
design level parameter.
Field: Design Flow Rate Calculation Method
This field is a key/choice field that tells which of the next four fields are filled and is
descriptive of the method for calculating the design volume flow rate. The key/choices are:
Flow/Zone
With this choice, the method used will be a straight insertion of the design volume flow rate.
(The Design Flow Rate field should be filled.)
Flow/Area
With this choice, the method used will be a factor per floor area of the zone. (The Flow per
Zone Floor Area field should be filled).
Flow/Person
With this choice, the method used will be a factor per nominal number of people in the zone.
(The flow per person field should be filled).
AirChanges/Hour
With this choice, the method used will be the number of air changes per hour for the
infiltration amount. This factor, along with the Zone Volume, will be used to determine the
Design Flow Rate. (The Air Changes per Hour field should be filled).
Field: Design Flow Rate
This field denotes the full design volume flow rate (m 3/s). The previous field should choose
flow/zone as the choice. The design volume flow rate is the maximum amount of mixing air
expected. The design value is modified by the schedule fraction (see Field: Schedule Name)
and user specified coefficients (see four coefficient fields below).
Field: Flow Rate per Zone Floor Area
This factor (m3/s-m2) is used, along with the Zone Area to determine the maximum Design
Volume Flow Rate as described in the Design Volume Flow Rate field. The choice from the
method field should be Flow/Area.
9/29/14

459

Input-Output Reference

Group Airflow

Field: Flow Rate per Person

This factor (m3/s-person) is used, along with the nominal (maximum) number of occupants
(people) in the Zone to determine the maximum Design Volume Flow Rate as described in
the Design Volume Flow Rate field. The choice from the method field should be
Flow/Person.
Field: Air Changes per Hour
With this choice, the method used will be the number of air changes per hour for the mixing
amount. This factor, along with the Zone Volume, will be used to determine the Design Flow
Rate. The choice from the method field should be AirChanges/Hour.
Field: Source Zone Name
This field is the name of the source zone (ref: Zone) that exhausts the amount of air
specified by the design level and schedule fields to the zone named in the zone name field. In
reality, the source and receiving zones are interchangeable since the cross-mixed air
affects both zones.
Field: Delta Temperature
This number controls when mixing air from the source zone is sent to the receiving zone. This
parameter is a temperature and is expressed in units of Celsius. If this field is positive, the
temperature of the zone from which air is being drawn (source zone) must be Delta
Temperature warmer than the zone air or no mixing occurs. If this field is zero, mixing occurs
regardless of the relative air temperatures. Negative values for Delta Temperature are not
permitted.
Field: Delta Temperature Schedule Name
This alpha field contains the name of a schedule (ref. Schedule objects) which contains the
temperature difference (in Celsius) between the source zone and receiving zone air dry-bulb
temperatures as a function of time. This field is an optional field and has the same
functionality as the Delta Temperature field. If the user enters a valid schedule name, the
delta temperature values specified in this schedule will supersede the constant value
specified in the Delta Temperature field.
Field: Minimum Zone Temperature Schedule Name
This alpha field contains the name of a schedule (ref. Schedule objects) which contains the
minimum receiving zone temperature (in Celsius) below which cross mixing is shutoff as a
function of time. The minimum temperature value in the schedule can be -100 C and the
maximum value can be 100 C. This field is an optional field. If this field is not entered, the
minimum zone temperature control is not applied.
Field: Maximum Zone Temperature Schedule Name
This alpha field contains the name of a schedule (ref. Schedule objects) which contains the
maximum receiving zone temperature (in Celsius) above which cross mixing is shutoff as a
function of time. The maximum temperature value in the schedule can be -100 C and the
maximum value can be 100 C. This field is an optional field. If this field is not entered, the
maximum zone temperature control is not applied.
Note: The maximum zone temperature when cross mixing is shutoff must be greater than or equal to the
minimum zone temperature when cross mixing is shutoff at any given time. Otherwise, warnings will be
issued and the maximum zone shutoff temperature will be set to the minimum zone shutoff temperature.

9/29/14

460

Input-Output Reference

Group Airflow

Field: Minimum Source Zone Temperature Schedule Name

This alpha field contains the name of a schedule (ref. Schedule objects) which contains the
minimum source zone temperature (in Celsius) below which cross mixing is shutoff as a
function of time. The minimum temperature value in the schedule can be -100 C and the
maximum value can be 100 C. This field is an optional field. If this field is not entered, the
minimum source zone temperature control is not applied.
Field: Maximum Source Zone Temperature Schedule Name
This alpha field contains the name of a schedule (ref. Schedule objects) which contains the
maximum source zone temperature (in Celsius) above which cross mixing is shutoff as a
function of time. The maximum temperature value in the schedule can be -100 C and the
maximum value can be 100 C. This field is an optional field. If this field is not entered, the
maximum source zone temperature control is not applied.
Note: The maximum source zone temperature when cross mixing is shutoff must be greater than or equal
to the minimum source zone temperature when cross mixing is shutoff at any given time. Otherwise,
warnings will be issued and the maximum source zone shutoff temperature will be set to the minimum
source zone shutoff temperature.

Field: Minimum Outdoor Temperature Schedule Name

This alpha field contains the name of a schedule (ref. Schedule objects) which contains the
minimum outdoor temperature (in Celsius) below which cross mixing is shutoff as a function
of time. The minimum temperature value in the schedule can be -100 C and the maximum
value can be 100 C. This field is an optional field. If this field is not entered, the minimum
outdoor temperature control is not applied.
Field: Maximum Outdoor Temperature Schedule Name
This alpha field contains the name of a schedule (ref. Schedule objects) which contains the
maximum outdoor temperature (in Celsius) above which cross mixing is shutoff as a function
of time. The maximum temperature value in the schedule can be -100 C and the maximum
value can be 100 C. This field is an optional field. If this field is not entered, the maximum
outdoor temperature control is not applied.
Note: The maximum outdoor temperature when cross mixing is shutoff must be greater than or equal to
the minimum outdoor temperature which cross mixing is shutoff at any given time. Otherwise, a warning
will be issued and the maximum outdoor shutoff temperature will be set to the minimum outdoor shutoff
temperature.

An IDF Example:
ZoneCrossMixing,
1stFloor-Garage, !- Name
GARAGE,
!- Zone Name
Always On,
!- SCHEDULE Name
Flow/Zone,
!- Design Flow Rate calculation method
0.1,
!- Design Flow Rate {m3/s}
,
!- Flow Rate per Area {m3/s/m2}
,
!- Flow Rate per Person {m3/s/person}
,
!- Air Changes Per Hour
1ST-FLOOR,
!- Source Zone Name
1.0;
!- Delta temp
ZoneCrossMixing,
Garage-1stFloor, !- Name
9/29/14

461

Input-Output Reference
1ST-FLOOR,
Always On,
flow/zone,
0.1,
,
,
,
GARAGE,
1.0;

Group Airflow
! Zone Name
!- SCHEDULE Name
!- Design Flow Rate calculation method
!- Design Flow Rate {m3/s}
!- Flow Rate per area {m3/s/m2}
!- Flow Rate per person {m3/s/person}
!- Air Changes Per Hour
! Source Zone Name
! Delta temp

Zone Cross Mixing Outputs

HVAC,Sum,Zone
HVAC,Sum,Zone
HVAC,Sum,Zone
HVAC,Sum,Zone
HVAC,Sum,Zone
HVAC,Sum,Zone
HVAC,Sum,Zone
HVAC,Sum,Zone
HVAC,Sum,Zone
HVAC,Sum,Zone
HVAC,Sum,Zone

Mixing
Mixing
Mixing
Mixing
Mixing
Mixing
Mixing
Mixing
Mixing
Mixing
Mixing

Volume [m3]
Current Density Volumetric Flow Rate [m3/s]
Standard Density Volumetric Flow Rate [m3/s]
Mass [kg]
Mass Flow Rate [kg/s]
Sensible Heat Loss Energy [J]
Sensible Heat Gain Energy [J]
Latent Heat Loss Energy [J]
Latent Heat Gain Energy [J]
Total Heat Loss Energy [J]
Total Heat Gain Energy [J]

Zone Mixing Volume [m3]

The air volume in m 3 entering the zone due to the sum of mixing, cross-mixing, and
refrigeration-door mixing during the hour or timestep.
Zone Mixing Current Density Volumetric Flow Rate [m3/s]
The air volumetric flow rate in m 3/s entering the zone due to the sum of mixing, cross-mixing,
and refrigeration-door mixing during the hour or timestep using the density of air evaluated at
current zone air conditions.
Zone Mixing Standard Density Volumetric Flow Rate [m3/s]
The air volumetric flow rate in m 3/s entering the zone due to the sum of mixing, cross-mixing,
and refrigeration-door mixing during the hour or timestep using the density of air evaluated at
standard conditions.
Zone Mixing Mass [kg]
The air mass in kg entering the zone due to the sum of mixing, cross-mixing, and
refrigeration-door mixing during the hour or timestep. The air mass is calculated using the air
volume flow from each source zone and the density of air calculated for the average
conditions (temperature and humidity) between the source and receiving zones.
Zone Mixing Mass Flow Rate [kg/s]
The air mass flow rate in kg/s entering the zone due to the sum of mixing, cross-mixing, and
refrigeration-door mixing during the hour or timestep.
Zone Mixing Sensible Heat Loss Energy [J]
Zone Mixing Sensible Heat Gain Energy [J]
The sensible (temperature) heat transfer due to the sum of mixing, cross-mixing, and
refrigeration-door mixing in the host (receiving) zone is the sum of all the incoming air mass
flow rates multiplied by the elapsed time, the specific heat (calculated for the average
conditions (temperature and humidity) between the source and receiving zones) and the
temperature differences between the host zone and corresponding source zones. If the heat
transfer is negative, the heat transfer is considered to be a zone mixing sensible heat loss. If

9/29/14

462

Input-Output Reference

Group Airflow

the heat transfer is positive, the heat transfer is considered to be a zone mixing sensible heat
gain.
Zone Mixing Latent Heat Loss Energy [J]
Zone Mixing Latent Heat Gain Energy [J]
The latent heat transfer due to the sum of mixing, cross-mixing, and refrigeration-door mixing in
the host (receiving) zone is the sum of all the incoming air mass flow rates multiplied by the
elapsed time, the heat of vaporization (calculated for the average conditions (temperature
and humidity) between the source and receiving zones) and the humidity ratio
differences between the host zone and corresponding source zones. If the heat transfer is
negative, the heat transfer is considered to be a zone mixing latent heat loss. If the heat transfer is
positive, the heat transfer is considered to be a zone mixing latent heat gain.
Zone Mixing Total Heat Loss Energy [J]
The total heat loss due to the sum of mixing, cross-mixing, and refrigeration-door mixing that
occurs when the sum of Zone Mixing Sensible Heat Gain Energy and Zone Mixing Latent
Heat Gain Energy < the sum of Zone Mixing Sensible Heat Loss Energy and Zone Mixing
Latent Heat Loss Energy.
Zone Mixing Total Heat Gain Energy [J]
The total heat gain due to the sum of mixing, cross-mixing, and refrigeration-door mixing that
occurs when the sum of Zone Mixing Sensible Heat Gain Energy and Zone Mixing Latent
Heat Gain Energy >= the sum of Zone Mixing Sensible Heat Loss Energy and Zone Mixing
Latent Heat Loss Energy.
ZoneRefrigerationDoorMixing
The ZoneRefrigerationDoorMixing syntax is ideally suited for two zones, at least one of which
is refrigerated, that exchange an equal amount of dry air. They may also have mixed air from
other zones, but only one object should be entered for any one pair of zones. As with Mixing
(ref: Mixing), this is a simplified view of interzone airflow in EnergyPlus. The
ZoneRefrigerationDoorMixing approach shares some features of both Mixing and Cross
Mixing. Like Cross Mixing, RefrigerationDoorMixing has an energy effect on both the source
and the receiving zone, thus maintaining both the air mass and energy balances in the two
zones. Like Mixing, the refrigerated zone can exchange air with multiple zones. Unlike either
of the other two mixing objects, the RefrigeratedDoorMixing always calculates the air
exchange based on the zone temperature and relative humidity. That is, the user does not
specify the air flow rate. The user can moderate the flow through a door-opening schedule.
Unlike, Cross Mixing, Refrigeration Door Mixing can only be entered once for any unique pair
of zones. It doesnt matter which zone is listed first and the zones will automatically switch
back and forth between source and receiving zones depending upon which zone is colder.
Refrigeration Door Mixing is entered using the following syntax.
Field: Name
The name of the ZoneRefrigerationDoorMixing object.
Field: Zone 1 Name
This field is the name of one of the two zones (ref: Zone) exchanging air and attaches a
particular refrigeration door mixing statement to both thermal zones in the building.
Field: Zone 2 Name
This field is the name of the other zone (ref: Zone) exchanging air and attaches a particular
refrigeration door mixing statement to both thermal zones in the building.

9/29/14

463

Input-Output Reference

Group Airflow

Field: Schedule Name

This field is the name of the schedule (ref: Schedule) that modifies the door opening between
the two zones and should contain values between 0.0 and 1.0.
Field: Door Height
This field denotes the door opening height (m). The default value is 3 m.
Field: Door Area
This field denotes the door opening area (m 2). The default value is 9 m2.
Field: Door Protection Type
This field is a key/choice field that tells how the door is protected. The impact of this choice is
decribed in the Engineering Reference. The key/choices are:
None
None, or no door protection is the default choice
AirCurtain
StripCurtain
An IDF Example:
ZoneRefrigerationDoorMixing,
Freezer1_Cooler1, !- Name
Freezer1,
!- Zone 1 Name
Cooler1,
!- Zone 2 Name
Freezer1DoorSched, !- Schedule Name
1.8,
!- Door height {m}
2.3,
!- Door area {m2}
StripCurtain;
!- Door protection type

Refrigeration Door Mixing Outputs

HVAC,Sum,Zone
HVAC,Sum,Zone
HVAC,Sum,Zone
HVAC,Sum,Zone
HVAC,Sum,Zone
HVAC,Sum,Zone
HVAC,Sum,Zone
HVAC,Sum,Zone
HVAC,Sum,Zone
HVAC,Sum,Zone
HVAC,Sum,Zone

Mixing
Mixing
Mixing
Mixing
Mixing
Mixing
Mixing
Mixing
Mixing
Mixing
Mixing

Volume [m3]
Current Density Volumetric Flow Rate [m3/s]
Standard Density Volumetric Flow Rate [m3/s]
Mass [kg]
Mass Flow Rate [kg/s]
Sensible Heat Loss Energy [J]
Sensible Heat Gain Energy [J]
Latent Heat Loss Energy [J]
Latent Heat Gain Energy [J]
Total Heat Loss Energy [J]
Total Heat Gain Energy [J]

Zone Mixing Volume [m3]

The air volume in m 3 entering the zone due to the sum of mixing, cross-mixing, and
refrigeration-door mixing during the hour or timestep.
Zone Mixing Current Density Volumetric Flow Rate [m3/s]
The air volumetric flow rate in m 3/s entering the zone due to the sum of mixing, cross-mixing,
and refrigeration-door mixing during the hour or timestep using the density of air evaluated at
current zone air conditions.
Zone Mixing Standard Density Volumetric Flow Rate [m3/s]
The air volumetric flow rate in m 3/s entering the zone due to the sum of mixing, cross-mixing,
and refrigeration-door mixing during the hour or timestep using the density of air evaluated at
standard conditions.

9/29/14

464

Input-Output Reference

Group Airflow

Zone Mixing Mass [kg]

The air mass in kg entering the zone due to the sum of mixing, cross-mixing, and
refrigeration-door mixing during the hour or timestep. The air mass is calculated using the air
volume flow from each source zone and the density of air calculated for the average
conditions (temperature and humidity) between the source and receiving zones.
Zone Mixing Mass Flow Rate [kg/s]
The air mass flow rate in kg/s entering the zone due to the sum of mixing, cross-mixing, and
refrigeration-door mixing during the hour or timestep.
Zone Mixing Sensible Heat Loss Energy [J]
Zone Mixing Sensible Heat Gain Energy [J]
The sensible (temperature) heat transfer due to the sum of mixing, cross-mixing, and
refrigeration-door mixing in the host (receiving) zone is the sum of all the incoming air mass
flow rates multiplied by the elapsed time, the specific heat (calculated for the average
conditions (temperature and humidity) between the source and receiving zones) and the
temperature differences between the host zone and corresponding source zones. If the heat
transfer is negative, the heat transfer is considered to be a zone mixing sensible heat loss. If
the heat transfer is positive, the heat transfer is considered to be a zone mixing sensible heat
gain.
Zone Mixing Latent Heat Loss Energy [J]
Zone Mixing Latent Heat Gain Energy [J]
The latent heat transfer due to the sum of mixing, cross-mixing, and refrigeration-door mixing in
the host (receiving) zone is the sum of all the incoming air mass flow rates multiplied by the
elapsed time, the heat of vaporization (calculated for the average conditions (temperature
and humidity) between the source and receiving zones) and the humidity ratio
differences between the host zone and corresponding source zones. If the heat transfer is
negative, the heat transfer is considered to be a zone mixing latent heat loss. If the heat transfer is
positive, the heat transfer is considered to be a zone mixing latent heat gain.
Zone Mixing Total Heat Loss Energy [J]
The total heat loss due to the sum of mixing, cross-mixing, and refrigeration-door mixing that
occurs when the sum of Zone Mixing Sensible Heat Gain Energy and Zone Mixing Latent
Heat Gain Energy < the sum of Zone Mixing Sensible Heat Loss Energy and Zone Mixing
Latent Heat Loss Energy.
Zone Mixing Total Heat Gain Energy [J]
The total heat gain due to the sum of mixing, cross-mixing, and refrigeration-door mixing that
occurs when the sum of Zone Mixing Sensible Heat Gain Energy and Zone Mixing Latent
Heat Gain Energy >= the sum of Zone Mixing Sensible Heat Loss Energy and Zone Mixing
Latent Heat Loss Energy.
ZoneEarthtube (Earth Tube)
An earth tube is a long, underground metal or plastic pipe through which air is drawn. During
cooling season, as air travels through the pipe, it gives up some of its heat to the surrounding
soil and enters the room as cooler air. Similarly, during heating season, as air travels through
the pipe, it receives some of its heat from the soil and enters the room as warmer air. Simple
earth tubes in EnergyPlus can be controlled by a schedule and through the specification of
minimum, maximum, and delta temperatures as described below. As with infiltration and
ventilation, the actual flow rate of air through the earth tube can be modified by the
temperature difference between the inside and outside environment and the wind speed. The
basic equation used to calculate air flow rate of earth tube in EnergyPlus is:
9/29/14

465

Input-Output Reference

EarthTubeFlowRate

Group Airflow

Edesign

Fschedule

A B Tzone Todb

C WindSpeed

D WindSpeed 2

For the simulation of the earth tube, a weather data file is required and, therefore, the earth
tube cannot run without weather data file. The required input fields to simulate the earth tube
include the average soil surface temperature, the amplitude of soil surface temperature, and
the phase constant of soil surface temperature. These fields should be calculated in advance
by using a separate stand-alone program (CalcSoilSurfTemp) and should be input into earth
tube.
CalcSoilSurfTemp Auxiliary Programs Document
The CalcSoilSurfTemp program is simple and requires only two input fields : soil condition
and soil surface condition in addition to a valid weather file. For soil condition, the user should
select the number corresponding to the actual condition of the soil surrounding the earth tube
from the four following options: 1. HEAVY AND SATURATED, 2. HEAVY AND DAMP, 3.
HEAVY AND DRY and 4. LIGHT AND DRY. This determines the thermal diffusivity and
thermal conductivity of the surrounding soil. For soil surface conditions, the user should
select the number corresponding to the actual condition of the ground surface above the
earth tube from the eight following options: 1. BARE AND WET, 2. BARE AND MOIST, 3.
BARE AND ARID, 4. BARE AND DRY, 5. COVERED AND WET, 6. COVERED AND MOIST,
7. COVERED AND ARID and 8. COVERED AND DRY. This determines the absorption
coefficient and the fraction of evaporation rate of the ground surface.
From this information and an analysis of the weather for the location selected, the
CalcSoilSurfTemp program (ref. Auxiliary Programs document) calculates the three
parameters listed above. The user must then add these parameters as input into EnergyPlus.
The full input description of an earth tube in EnergyPlus is given below.
Field: Zone Name
This field is the name of the zone (ref: Zone) and attaches a particular earth tube statement
to a thermal zone in the building.
Field: Schedule Name
This field is the name of the schedule (ref: Schedule) that modifies the maximum design
volume flow rate parameter (see next field). This fraction between 0.0 and 1.0 is noted as
Fschedule in the above equation.
Field: Design Flow Rate
This number (noted as Edesign in the above equation) is the maximum amount of air mass flow
rate of the earth tube expected at design conditions. The flow rate is expressed in units of
m3/s. The design value is modified by the schedule fraction (see previous field) and user
specified coefficients (see last four fields).
Field: Minimum Zone Temperature when Cooling
This is the indoor temperature (in Celsius) below which the earth tube is shut off. This lower
temperature limit is intended to avoid overcooling a space and thus result in a heating load.
For example, if the user specifies a minimum temperature of 20 C, earth tube is assumed to
be available if the zone air temperature is above 20 C. If the zone air temperature drops
below 20 C, then earth tube is automatically turned off.
Field: Maximum Zone Temperature when Heating
This is the indoor temperature (in Celsius) above which the earth tube is shut off. This higher
temperature limit is intended to avoid overheating a space and thus result in a cooling load.
For example, if the user specifies a maximum temperature of 20 C, earth tube is assumed to
be available if the zone air temperature is below 20 C. If the zone air temperature rises above
20 C, then earth tube is automatically turned off.
9/29/14

466

Input-Output Reference

Group Airflow

Field: Delta Temperature

This is the temperature difference (in Celsius) between the indoor and outdoor air dry-bulb
temperatures below which the earth tube is shut off. This is to allow the earth tube to be
stopped either if the temperature outside is too warm and could potentially heat the space or
if the temperature outside is too cold and could potentially cool the space. For example, if the
user specifies a delta temperature of 2 C, earth tube is assumed to be available if the
temperature difference between indoor and outdoor temperature is at least 2 C. If the outside
air dry-bulb temperature is less than 2 C cooler or warmer than the indoor dry-bulb
temperature, then the earth tube is automatically turned off.
Field: Earthtube Type
This alpha character string defines the type of earth tube as one of the following options:
Natural, Exhaust, or Intake. A natural earth tube is assumed to be air movement/exchange
that will not consume any fan energy or is the result of natural air flow through the tube and
into the building. Values for fan pressure and efficiency for a natural flow earth tube are
ignored. For either EXHAUST or Intake, values for fan pressure and efficiency define the fan
electric consumption. For Natural and Exhaustearth tubes, the conditions of the air entering
the space are assumed to be equivalent to the air which is cooled or heated by passing along
the pipe. For Intake earth tubes, an appropriate amount of fan heat is added to the air stream.
Field: Fan Pressure Rise
This is the pressure rise experienced across the fan in Pascals (N/m 2). This is a function of
the fan and plays a role in determining the amount of energy consumed by the fan.
Field: Fan Total Efficiency
This is the total fan efficiency (a decimal number between 0.0 and 1.0). This is a function of
the fan and plays a role in determining the amount of energy consumed by the fan.
Field: Pipe Radius
This is the radius of the earth tube/pipe (in meters). This plays a role in determining the
amount of heat transferred from the surrounding soil to the air passing along the pipe. If the
pipe has non-circular cross section, user can use the concept of hydraulic diameter as
follows.

D 4 Area / Perimeter
However, since this field requires the pipe radius, hydraulic diameter should be divided by
two.
Field: Pipe Thickness
This is the thickness of the pipe wall (in meters). This plays a role in determining the amount
of heat transferred from the surrounding soil to the air passing along the pipe.
Field: Pipe Length
This is the total length of the pipe (in meters). This plays a role in determining the amount of
heat transferred from the surrounding soil to the air passing along the pipe. As the length of
the pipe becomes longer, the amount of the heat transfer becomes larger.
Field: Pipe Thermal Conductivity
This is the thermal conductivity of the pipe (in W/m C). This plays a role in determining the
amount of heat transferred from the surrounding soil to the air passing along the pipe.

9/29/14

467

Input-Output Reference

Group Airflow

Field: Pipe Depth Under Ground Surface

This is the depth of the pipe under the ground surface (in meters). This plays a role in
determining the temperature of the soil surrounding the pipe.
Field: Soil Condition
This alpha character string defines the actual condition of the soil surrounding the earth tube
and can be one of any of the following options: HeavyAndSaturated, HeavyAndDamp,
HeavyAndDry or LightAndDry. This determines the thermal diffusivity and thermal
conductivity of the surrounding soil, which play a role in determining the amount of heat
transferred from the surrounding soil to the air passing along the pipe.
Field: Average Soil Surface Temperature
This is the annual average soil surface temperature straight above the earth tube, which
plays a role in determining the temperature of the soil surrounding the pipe. This field should
be calculated in advance using the separate CalcSoilSurfTemp program.
Field: Amplitude of Soil Surface Temperature
This is the amplitude of soil surface temperature above the earth tube, which plays a role in
determining the temperature of the soil surrounding the pipe. This is the difference between
the maximum and minimum soil surface temperature for the whole year divided by two. This
field should be calculated in advance using the separate CalcSoilSurfTemp program.
Field: Phase Constant of Soil Surface Temperature
This is the phase constant of the soil surface temperature straight above the earth tube,
which play a role in determining the temperature of the soil surrounding the pipe at particular
time. This is the time elapsed from the beginning of the year until the soil surface temperature
reaches the minimum value of the year. This field should be calculated in advance using the
separate CalcSoilSurfTemp program.
Field: Constant Term Flow Coefficient
This number is the A parameter in the above earth tube equation. It is part of the user
specified modifying parameters that are a function of environmental factors. This parameter,
however, is a constant under all conditions and is not modified by any environmental effect.
As a result, it is dimensionless.
Field: Temperature Term Flow Coefficient
This number is the B parameter in the above earth tube equation. It is part of the user
specified modifying parameters that are a function of environmental factors. This parameter is
modified by the temperature difference between the outdoor and indoor air dry-bulb
temperatures. The units for this parameter are inverse Celsius.
Field: Velocity Term Flow Coefficient
This number is the C parameter in the above earth tube equation. It is part of the user
specified modifying parameters that are a function of environmental factors. This parameter is
modified by the speed of wind being experienced outside the building. The units for this
parameter are s/m.
Field: Velocity Squared Term Flow Coefficient
This number is the D parameter in the above earth tube equation. It is part of the user
specified modifying parameters that are a function of environmental factors. This parameter is
modified by square of the speed of wind being experienced outside the building. The units for
this parameter are s2/m2.
An IDF example:

9/29/14

468

Input-Output Reference
EARTHTUBE,
Zone 2,
Simple EarthTube,
3.425198,
10.0,
30.0,
1.0,
NATURAL,
350.0,
0.9,
0.25,
0.2,
15.0,
200.0,
3.5,
HeavyAndDamp,
15.0,
5.6,
0.0,
0.6060000
,
2.0199999E-02,
5.9800001E-04,
0.0000000E+00;

!!!!!!!!!!!!!!!!!!!!!!-

Group Airflow

Zone Name
Schedule Name
Design Volume Flow Rate
Minimum Zone Temperature when Cooling
Maximum Zone Temperature when Heating
Delta Temperature
EarthTube Type
Fan Pressure Rise
Fan Total Efficiency
Pipe Radius
Pipe Thickness
Pipe Length
Pipe Thermal Conductivity
Pipe Depth Under Ground Surface
Soil Condition
Average Soil Surface Temperature
Amplitude of Soil Surface Temperature
Phase Constant of Soil Surface Temperature
Constant Term Flow Coef
Temp Term Flow Coef
Velocity Term Flow Coef
Velocity**2 Term Flow Coef

ZoneEarthTube Outputs
Current Earth Tube output variables:
HVAC,Sum,Earth Tube Zone Sensible Cooling Energy [J]
HVAC,Average,Earth Tube Zone Sensible Cooling Rate [W]
HVAC,Sum,Earth Tube Zone Sensible Heating Energy [J]
HVAC,Average,Earth Tube Zone Sensible Heating Rate [W]
HVAC,Sum,Earth Tube Air Flow Volume [m3]
HVAC,Average,Earth Tube Air Current Density Volumetric Flow Rate [m3/s]
HVAC,Average,Earth Tube Air Standard Density Volumetric Flow Rate [m3/s]
HVAC,Sum,Earth Tube Air Flow Mass [kg]
HVAC,Average,Earth Tube Air Mass Flow Rate [kg/s]
HVAC,Sum,Earth Tube Fan Electric Energy [J]
HVAC,Average,Earth Tube Fan Electric Power [W]
HVAC,Average,Earth Tube Zone Inlet Air Temperature [C]
HVAC,Average,Earth Tube Ground Interface Temperature [C]
HVAC,Average,Earth Tube Outdoor Air Heat Transfer Rate [W]

Earth Tube Zone Sensible Cooling Energy [J]

Earth Tube Zone Sensible Cooling Rate [W]
These are the energy and rate associated with the zone cooling provided by the air from the
earth tube. This occurs when the earth tube outlet air temperature is less than zone air
temperature.
Earth Tube Zone Sensible Heating Energy [J]
Earth Tube Zone Sensible Heating Rate [W]
These are the energy and rate associated with the zone heating provided by the air from the
earth tube. This occurs when the earth tube outlet air temperature is greater than the zone
air temperature.
Earth Tube Air Flow Volume [m3]
The volume flow of air through the earth tube.
Earth Tube Air Current Density Volumetric Flow Rate [m3/s]
The volume flow rate of air through the earth tube evaluating density at current zone
conditions.

9/29/14

469

Input-Output Reference

Group Airflow

Earth Tube Air Standard Density Volumetric Flow Rate [m3/s]

The volume flow rate of air through the earth tube evaluating density at standard conditions.
Earth Tube Air Flow Mass [kg]
The mass flow of air through the earth tube.
Earth Tube Air Mass Flow Rate [kg/s]
The mass flow rate of air through the earth tube.
Earth Tube Fan Electric Energy [J]
Earth Tube Fan Electric Power [W]
These are the fan electricity consumption and power for intake or exhaust earth tube types.
Earth Tube Zone Inlet Air Temperature [C]
This is the temperature of the air entering the zone after passing through the earth tube [C].
This temperature includes the cooling or heating of outdoor air as it passes along the pipe.
When intake fan assist is used, then the additional heat due to the fan is included in the inlet
air temperature.
Earth Tube Ground Interface Temperature [C]
This is the average temperature of the ground along the outer surface of the earth tube [C].
Earth Tube Outdoor Air Heat Transfer Rate [W]
This is the rate of heat transfer from the earth tube to the outdoor air [W]. Positive values
indicate the rate at which outdoor air is preheated; negative values indicate the rate of
precooling.
ZoneCoolTower:Shower
A cooltower (which is sometimes referred to as a wind tower or a shower cooling tower) is a
component that is intended to model a passive downdraught evaporative cooling (PDEC) that
is designed to capture the wind at the top of a tower and cool the outside air using water
evaporation before delivering it to a space. The air flow in these systems is natural as the
evaporation process increases the density of the air causing it to fall through the tower and
into the space without the aid of a fan. A cooltower typically consists of a water spray or an
evaporative pad, a shaft, and a water tank or reservoir. Wind catchers to improve the winddriven performance at the top of the tower are optional. Water is pumped over an
evaporative device by water pump which is the only component consumed power for this
system. This water cools and humidifies incoming air and then the cool, dense air naturally
falls down through shaft and leaves through large openings at the bottom of cooltowers.
The shower cooling tower can be controlled by a schedule and the specification of maximum
water flow rate and volume flow rate as well as minimum indoor temperature. The actual flow
rate of water and air can be controlled as users specify the fractions of water loss and flow
schedule. The required input fields include effective tower height and exit area to obtain the
temperature and flow rate of the air exiting the tower. A schedule and rated power for the
water pump are also required to determine the power consumed. The component typically
has a stand alone water system that is not added to the water consumption from mains.
However, users are required to specify the water source through an optional field, the name
of water supply storage tank, in case any water comes from a water main. The model is
described more fully in the Engineering Reference document.
This model requires weather information obtained from either design day or weather file
specifications. The control is accomplished by either specifying the water flow rate or
obtaining the velocity at the outlet with inputs and weather conditions when the water flow

9/29/14

470

Input-Output Reference

Group Airflow

rate is unknown. As with infiltration, ventilation, and earth tubes, the component is treated in
a similar fashion to natural ventilation in EnergyPlus.
Field: Name
This field is a unique user assigned name for each cooltower. Any reference to this unit by
another object will use this name.
Field: Availability Schedule Name
This field is the name of the schedule that denotes whether the cooltower can run during a
given time period. A schedule value greater than 0 (usually 1 is used) indicates that the
cooltower is available and can be on during the time period. A value less than or equal to 0
(usually 0 is used) denotes that the cooltower is not available and must be off for the time
period. If this field is blank, the schedule has values of 1 for all time periods.
Field: Zone Name
This field is the name of the zone (ref: Zone) and attaches a particular cooltower statement to
a thermal zone in the building.
Field: Water Supply Storage Tank Name
This field is optional. It is used to describe where the cooltower obtains water used for
evaporative cooling. If blank or omitted, then the cooltower will obtain water directly from
local water main. If the name of a Water Storage Tank object is used here, then the
cooltower will obtain its water from that tank. If a tank is specified, the cooltower will attempt
to obtain all the water it uses from the tank. However, if the tank cannot provide all the water
the cooltower needs, then the cooltower will still operate and obtain the rest of the water it
needs from the mains (referred to as Starved water).
Field: Flow Control Type
This field specifies how the user wishes to control the cooltower. The air flow from the
cooltower may be controlled by either the water flow rate along with the water pump schedule
or naturally driven by wind flow. The user must select from the following options:
WaterFlowSchedule and WindDrivenFlow. If the user either wishes to control the water
flow rate or has information about the water flow rate, WaterFlowSchedule must be
selected. WindDrivenFlow for cooltower flow control must be selected when the water flow
rate is unknown and the user wishes to have the flow rate of both air and water controlled by
the external weather conditions (wind speed). If the user does not select a control type,
WindDrivenFlow is assumed as a flow control type.
Field: Pump Flow Rate Schedule Name
This field modifies the maximum flow rate of water through the cooltower in m3/sec. This
input is optional. If the user does not enter a schedule, the flow rate through the cooltower is
assumed to be constant during all hours that it is operating based on the value entered in the
previous input field. Note that the values for this schedule must be between zero and one.
Field: Maximum Water Flow Rate
This field is the maximum water flow rate distributed to the tower in m3/s. This limit is
intended to avoid over estimation of water flow rate, which leads higher air flow rate and exit
temperature of the air.
Field: Effective Tower Height
This field is the effective tower height for evaporative cooling, from the water spray to the top
of the exit in m.

9/29/14

471

Input-Output Reference

Group Airflow

Field: Airflow Outlet Area

This field is the area at the exit of the tower in m2. This field is used to determine the air flow
rate leaving the tower with the velocity of the air flow.
Field: Maximum Air Flow Rate
This field is the maximum volumetric flow rate of the air leaving the tower in m3/s. This
airflow maximum allows the cooltower performance to be limited if the outside wind speed
and the tower height are relatively high and thus result in high airflow supplied to the space.
Field: Minimum Indoor Temperature
This field is the minimum indoor temperature in Celsius below which cooltower is shutoff.
This lower temperature limit is intended to avoid overcooling a space and thus result in a
heating load. For example, if the user specifies a minimum temperature of 20C, cooltower is
assumed to be available if the zone air temperature is above 20C. If the zone air
temperature drops below 20C, then cooltower is automatically turned off.
Field: Fraction of Water Loss
This field specifies the fraction of the loss of water during either operation or transient
operation. If the user does not enter a fraction, no loss of water is assumed and the cooltower
water consumption includes only evaporation. Note that the fraction must be between zero
and one.
Field: Fraction of Flow Schedule
This field specifies the fraction of the airflow that actually goes to the outside. The user who
wishes to control the actual flow to the inside of the building must specify the value of the
fraction. If the user does not enter a fraction, the calculated flow rate is the zone cooltower
volume flow rate. Note that the fraction must be between zero and one.
Field: Rated Power Consumption
This field is the pumps rated power consumption in Watts.
Below is an example input for a cooltower.
ZoneCoolTower:Shower
Cool Tower 1,
Zone 1,
Simple Vent,
,
WindDrivenFlow,
0.0005,
,
5.0,
1.0,
10.0,
18.0,
0.05,
0.05,
250.0;

!!!!!!!!!!!!!!-

Name of cooltowers
Zone name
Schedule
Name of water supply storage tanks
Flow control type
Water flow rate from the spray in m3/s
schedule for flow rate (optional, non-existent means constant)
Effective tower height in m
Exit area in m2
Maximum supply air volume flow rate in m3/s
Minimum indoor temperature to prevent overcooling in C
Fraction of Water loss
Fraction of flow that goes to outside
Rated power consumption in W

ZoneCoolTower:Shower Outputs
HVAC,Sum,Zone Cooltower Sensible Heat Loss Energy [J]
HVAC,Average,Zone Cooltower Sensible Heat Loss Rate [W]
HVAC,Sum,Zone Cooltower Latent Heat Loss Energy [J]
HVAC,Average,Zone Cooltower Latent Heat Loss Rate [W]
HVAC,Sum,Zone Cooltower Air Volume [m3]
HVAC,Average,Zone Cooltower Air Current Density Volumetric Flow Rate [m3/s]
HVAC,Average,Zone Cooltower Air Standard Density Volumetric Flow Rate [m3/s]
HVAC,Sum,Zone Cooltower Air Mass [kg]
HVAC,Average,Zone Cooltower Air Mass Flow Rate [kg/s]
9/29/14

472

Input-Output Reference

Group Airflow

HVAC,Average,Zone Cooltower Air Inlet Temperature [C]

HVAC,Average,Zone Cooltower Air Inlet Humidity Ratio [kgWater/kgDryAir]
HVAC,Average,Zone Cooltower Air Outlet Temperature [C]
HVAC,Average,Zone Cooltower Air Outlet Humidity Ratio [kgWater/kgDryAir]
HVAC,Average,Zone Cooltower Pump Electric Power [W]
HVAC,Sum,Zone Cooltower Pump Electric Energy [J]
HVAC,Sum,Zone Cooltower Water Volume [m3]
HVAC,Sum,Zone Cooltower Mains Water Volume [m3]
HVAC,Sum,Zone Cooltower Storage Tank Water Volume [m3]
HVAC,Sum,Zone Cooltower Starved Mains Water Volume [m3]

Zone Cooltower Sensible Heat Loss Energy [J]

Zone Cooltower Sensible Heat Loss Rate [W]
The sensible heat loss that occurs when the temperature at the exit of the cooltower is less
than that of the zone.
Zone Cooltower Latent Heat Loss Energy [J]
Zone Cooltower Latent Heat Loss Rate [W]
The latent heat loss that occurs when the humidity ratio at the exit of the cooltower is greater
than that of the zone.
Zone Cooltower Air Current Density Volumetric Flow Rate [m3/s]
The volumetric flow rate of the air leaving the cooltower evaluating density at current zone
conditions.
Zone Cooltower Air Standard Density Volumetric Flow Rate [m3/s]
The volumetric flow rate of the air leaving the cooltower evaluating density at standard
conditions.
Zone Cooltower Air Volume [m3]
The sum of actual volumetric flow of the air leaving cooltower
Zone Cooltower Air Mass Flow Rate [kg/s]
The mass flow rate of the air leaving the cooltower
Zone Cooltower Air Mass [kg]
The sum of actual mass flow of the air leaving the cooltower
Zone Cooltower Air Inlet Temperature [C]
The dry-bulb temperature of the outdoor air the inlet of the cooltower
Zone Cooltower Air Inlet Humidity Ratio [kgWater/kgDryAir]
The humidity ratio of the outdoorair at the inlet of the cooltower
Zone Cooltower Air Outlet Temperature [C]
The temperature at the exit of the cooltower.
Zone Cooltower Air Outlet Humidity Ratio [kgWater/kgDryAir]
The humidity ratio of the air at the exit of the cooltower.
Zone Cooltower Water Volume [m3]
The water consumption includes not only the direct thermodynamics of water evaporation but
also other sources of consumption such as drift or concentration blow down specified by
users throughout all processes during the operation.

9/29/14

473

Input-Output Reference

Group Airflow

Zone Cooltower Mains Water Volume [m3]

This is the water consumed by the cooltower that actually be met by the mains water. This
output variable appears only when the water comes from mains.
Zone Cooltower Storage Tank Water Volume [m3]
This is the water consumed by the cooltower that actually be met by the water storage tank.
If any amount of the water is starved from mains, this water consumption is the difference
between the Zone Cooltower Water Volume and the following output. This output variable
appears only when the water comes from storage tank waters.
Zone Cooltower Starved Mains Water Volume [m3]
This is the source (mains) of water consumed by the cooltower that could not actually be met
by the storage tank. This output variable appears only when the water comes from storage
tank waters.
Zone Cooltower Pump Electric Power [W]
The power consumed by the recirculating pump in Watts.
Zone Cooltower Pump Electric Energy [J]
The energy consumed by the recirculating pump in Joules.
ZoneThermalChimney (Thermal Chimney)
A thermal chimney is a vertical shaft utilizing solar radiation to enhance the natural ventilation
in buildings. It consists of a absorber wall, air gap and glass cover with high solar
transmissivity. For the high solar absorption, it is usually south facing.
The key output parameter in the thermal chimney model is the enhanced amount of natural
ventilation rate caused by the presence of a thermal chimney. In order to determine the
enhanced ventilation, the discharge air temperature from a thermal chimney should be
calculated, which, in turn, should be computed based on the information on the absorber wall
temperature, glass cover temperature and the vertical air temperature distribution within the
thermal chimney. Among them, energy balances for the absorber wall and the glass cover
are carried out using the existing algorithm currently available in EnergyPlus, which has the
similar approach to the Trombe wall. As stated in the Trombe wall object as well, this
approach allows the flexibility for users to specify the various wall parameters and to explore
unusual configurations. On the other hand, the vertical air temperature distribution and the
resultant discharge air temperature of the thermal chimney are computed using the separate
thermal chimney algorithm described in the Engineering Reference document.
Similar to the Trombe wall model, a zone is coupled to the desired surface via an interzone
partition. To simulate the thermal chimney, the Solar Distribution field in the Building object
should be set to FullInteriorAndExterior so that the majority of the solar flux is directed on the
absorber wall. For a normal sized thermal chimney zone, the user can set the Zone Inside
Convection Algorithm to Detailed, which takes into account natural convection effects
intended for a normal zone. For a narrow cavity zone having high aspect ratios, there is no
built-in algorithm for calculating the correct convection coefficients on the inside of thermal
chimney zone walls. One option is to use the Detailed convection algorithm similar to the
Trombe wall model. However, some error may be incurred when used with a narrow zone.
Another option is to use the SurfaceProperty:ConvectionCoefficients object to schedule
coefficients that have been determined beforehand by the user. In addition, the wall
construction of the adjoining zone must be the mirror image of the wall construction in the
thermal chimney zone.
The full input description of a thermal chimney in EnergyPlus is given below.
Field: Name
This field is a unique user assigned name for an instance of the thermal chimney system.
9/29/14

474

Input-Output Reference

Group Airflow

Field: Zone Name

This field is the name of the thermal chimney zone (ref: Zone). Since the thermal chimney is
not only a system component but also a zone itself, this field is also necessary. It should be
differentiated from the Zone name field described later.
Field: Availability Schedule Name
This field is the name of the schedule (ref: Schedule) that denotes whether the thermal
chimney can operate during a given time period. A schedule value greater than 0 (usually 1 is
used) indicates that the system is available and can be on during the time period. A value
less than or equal to 0 (usually 0 is used) denotes that the system is not available and must
be off for the time period. If this field is blank, the schedule has values of 1 for all time
periods.
Field: Width of the Absorber Wall
This number is the width of the absorber wall in the thermal chimney. The width is expressed
in units of m. Even though this value is specified in Surface objects as well, this value is used
to compute the discharge air temperature and the enhanced ventilation rate caused by the
thermal chimney.
Field: Cross Sectional Area of Air Channel Outlet
This number is the cross sectional area of air channel outlet. The area is expressed in units
of m2. The enhanced air flow rate by the thermal chimney is dependent on cross sectional
areas of air channel inlet and outlet. Cross sectional areas of air channel inlet will be
described later in conjunction with the distance from the top of thermal chimney to each inlet
and relative ratios of air flow rates passing through each inlet.
Field: Discharge Coefficient
This dimensionless number is the discharge coefficient of the thermal chimney. The
ventilation rate enhanced by the thermal chimney is also dependent on the discharge
coefficient.
Field: Zone <#> Name
This field is the name of the zone (ref: Zone) to which the thermal chimney is attached. It is
used in conjunction with the next three fields. Note that up to 20 sets of zone name, distance
from the top of the thermal chimney to each inlet, relative ratios of air flow rates passing
through each zone and cross sectional areas of each air channel inlet may be entered for a
single thermal chimney if multiple zones share the common thermal chimney.
Field: Distance from Top of Thermal Chimney to Inlet <#>
This field is the distance from the top of the thermal chimney to each inlet corresponding to
each zone. It is used in conjunction with the zone name, relative ratios of air flow rates
passing through each zone and cross sectional areas of each air channel inlet. The distance
is expressed in units of m. The air flow rate enhanced by the thermal chimney is dependent
on the distance between the thermal chimney outlet and inlet.
Field: Relative Ratios of Air Flow Rates Passing through Zone <#>
This dimensionless number is the relative ratio of air flow rates enhanced by the thermal
chimney passing through each zone. The total air flow rate enhanced by the thermal chimney
is distributed to each zone based on this number if multiple zones share the common thermal
chimney. It is used in conjunction with the zone name, the distance from the top of the
thermal chimney to each inlet and cross sectional areas of each air channel inlet. Note that
the sum of all ratios must be equal to 1.0.

9/29/14

475

Input-Output Reference

Group Airflow

Field: Cross Sectional Areas of Air Channel Inlet <#>

This field is the cross sectional areas of each air channel inlet corresponding to each zone. It
is used in conjunction with the zone name, the distance from the top of the thermal chimney
to each inlet and relative ratios of air flow rates passing through each zone. The area is
expressed in units of m 2. The air flow rate enhanced by the thermal chimney is dependent on
cross sectional areas of air channel inlet and outlet.
An IDF example:
ZoneThermalChimney,
ThermalChimney1,
ThermalChimneyZone,
ThermalChimneyAvail,
3.5,
0.04,
0.8,
Zone1,
8.0,
0.8,
0.02,
Zone2,
5.0,
0.2,
0.02;

!!!!!!!!!!!!!!-

Name of Thermal Chimney System

Name of Thermal Chimney Zone
Availability Schedule Name
Width of the Absorber Wall
Cross Sectional Area of Air Channel Outlet
Discharge Coefficient
Zone Name 1
Distance from the Top of the Thermal Chimney to Inlet 1
Relative Ratios of Air Flow Rates Passing through Zone 1
Cross Sectional Areas of Air Channel Inlet 1
Zone Name 2
Distance from the Top of the Thermal Chimney to Inlet 2
Relative Ratios of Air Flow Rates Passing through Zone 2
Cross Sectional Areas of Air Channel Inlet 2

ZoneThermalChimney Outputs
Current ThermalChimney output variables:
HVAC,Average,Zone Thermal Chimney Current Density Volumetric Flow Rate [m3/s]
HVAC,Average,Zone Thermal Chimney Standard Density Volumetric Flow Rate
[m3/s]
HVAC,Average,Zone Thermal Chimney Mass Flow Rate [kg/s]
HVAC,Average,Zone Thermal Chimney Outlet Temperature [C]
HVAC,Sum,Zone Thermal Chimney Heat Loss Energy [J]
HVAC,Sum,Zone Thermal Chimney Heat Gain Energy [J]
HVAC,Sum,Zone Thermal Chimney Volume [m3]
HVAC,Sum,Zone Thermal Chimney Mass [kg]

Zone Thermal Chimney Heat Loss Energy [J]

The sensible (temperature) heat loss of each zone that occurs when the thermal chimney
cools the zone air.
Zone Thermal Chimney Heat Gain Energy [J]
The sensible (temperature) heat gain of each zone that occurs when the thermal chimney
heats the zone air.
Zone Thermal Chimney Volume [m3]
The air volumetric flow of each zone enhanced by the thermal chimney.
Zone Thermal Chimney Mass [kg]
The air mass flow of each zone enhanced by the thermal chimney.
Zone Thermal Chimney Current Density Volumetric Flow Rate [m3/s]
The total air volumetric flow rate caused by the thermal chimney evaluating density at the
current zone conditions.
Zone Thermal Chimney Standard Density Volumetric Flow Rate [m3/s]
The total air volumetric flow rate caused by the thermal chimney evaluating density at
standard conditions.
9/29/14

476

Input-Output Reference

Group Airflow

Zone Thermal Chimney Mass Flow Rate [kg/s]

The total air mass flow rate caused by the thermal chimney.
Zone Thermal Chimney Outlet Temperature [C]
The temperature of the air which is discharged from the thermal chimney through the outlet.
ZoneAirMassFlowConservation
This global object allows users to trigger the zone air mass flow conservation calculation
when desired. This object has two input fields; the first choice input field allows the user
whether to enforce or not to enforce the zone air mass flow conservation; and the second
input field allows the user to specify how infiltration object mass flow rate is calculated for
zone air mass flow balance calculation. The first input field of this object has two choice
KEYs: Yes and No. If this input is specified as Yes, then energy plus attempts to enforce
the zone mass conservation, or else if it is specified as No, then EnergyPlus calculation
defaults to zone air flow balance calculation that does not include zone mixing objects and
that assumes self-balanced simple flow objects procedure, which may not necessarily
enforce zone air mass flow conservation unless the user has specified a balanced flow to
begin with. The zone air mass flow conservation primarily accounts for the zonemixing
objects air flow in the zone air flow mass balance calculation. In additional to the zonemixing
object flow, the procedure accounts for zone exhaust fan flows by providing additional
infiltration air flows when required in order to balance the zone air mass flow. Hence,
zonemixing object must to be defined to trigger zone air mass flow conservation calculation,
whereas infiltration object is required only for zones which are used as a source zone of the
zone mixing object. Zone air mass flow balance calculation is enforced both for the receiving
and source zones of every mixing object defined. The zone air mass flow conservation
calculation uses two steps procedure.
First, the ZoneMixing object mass flow rate is adjusted or modified in order to balance zone
air mass flow while assuming the zone infiltration object air mass flow self-balanced. This
step will always results in balanced zone air mass for receiving zones of ZoneMixing object
but it may not necessarily result in a balanced air mass flow for source zones. Infiltration
objects air mass flow rate defined for receiving zones are always calculated based on user
inputs and assumed to be self-balanced. The infiltration mass flow rate of zones that serve
only as a source zone may require adjusting base infiltration flow, which is calculated based
on user inputs in the infiltration objects, in order to balance the zone air mass flow, i.e., the
second calculation step replenishes the source zones with additional infiltration air mass flow
when required. This second step is required in zones which serve as a source zone for zone
mixing objects and when the zone mixing source mass flow rate exceeds the supply air mass
flow rate. There are two calculation procedures that users can choose from on how the
infiltration flow rate is calculated for source zones that need infiltration object mass flow in
order to balance the zone air mass flow. The second optional input field Source Zone
Infiltration Treatment provides two Key choice inputs: AddInfiltrationFlow and
AdjustInfiltrationFlow.
AddInfiltrationFlow: Energyplus adds infiltration air mass flow rate on top of the base
infiltration flow, which is calculated using the infiltration object user inputs, in order to balance
the zone air mass flow. This additional infiltration air mass flow is not self-balanced, i.e., it is
always assumed incoming flow. If no infiltration air is required in order to be balance the zone
air mass flow, then the additional infiltration air mass flow rate is set to zero. The base
infiltration flow calculated using the infiltration object user inputs is always assumed to be
self-balanced.
AdjustInfiltrationFlow: Energyplus may adjust the base flow calculated using the infiltration
object user inputs if it is required in order to balance the zone air mass flow. If it is not
required to adjust the base infiltration air flow, then the base infiltration air mass flow, which is
calculated from user input of the infiltration object, is retained and assumed self-balanced.
The report variable Zone Infiltration Air Mass Flow Balance Status indicates whether
9/29/14

477

Input-Output Reference

Group Airflow

the infiltration object air mass flow is adjusted or not. If the value of this report variable is 0,
then the zone infiltration object mass flow rate is not included in the zone mass flow balance
hence the infiltration air flow rate calculated based on the user specified inputs is manintained
as is and assumed self-balanced for current timestep. If the value of this report variable is 1,
then the zone infiltration object mass flow rate is included in the zone mass flow balance,
hence the user specified infiltration rate is modified and it is considered as incoming flow to
the zone, i.e., self-balanced assumption is not valid for current time step.
This object is optional, only required in the input data file if the user wishes to enforce the
zone air mass flow balance calculation that includes zonemixing and infiltration objects.
Field: Adjust Zone Mixing For Zone Air Mass Flow Balance
It has two choice KEYs: Yes and No. If this input is specified as Yes, then Energyplus
attempts to enforce the zone mass conservation, or else if it is specified as No, then
EnergyPlus calculation defaults to the existing procedure, which may not necessarily enforce
zone mass conservation unless the user specified a balanced flow to begin with. The default
input is No. Note that No input may also results in balanced flow depending on the system
specified. If this input field is specified as No, then the next input field it not used.
Field: Source Zone Infiltration Treatment
It has two choice KEYs: AddInfiltrationFlow and AdjustInfiltrationFlow. If this input is
specified as AddInfiltrationFlow, then Energyplus adds infiltration air mass flow on top of the
base infiltration flow calculated using the infiltration object user inputs in order to balance the
zone air mass flow. The additional infiltration air mass flow is not self-balanced. If this input
is specified as AdjustInfiltrationFlow, then Energyplus may adjust the base flow calculated
using the infiltration object user inputs if it is required inorder to balance the zone air mass
flow. If it not required to adjust the base infiltration flow calculated using the user specified
infiltration object inputs, then the base infiltration air mass flow is assumed self-balanced.
And, a default IDF example is shown below:
ZoneAirMassFlowConservation,
Yes,
!- Adjust Zone Mixing For Zone Air Mass Flow Balance
AdjustInfiltrationFlow;
!- Source Zone Infiltration Treatment

ZoneAirMassFlowConservation Outputs
Current ZoneAirMassFlowConservation output variables:
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,

Average,
Average,
Average,
Average,
Average,
Average,
Average,

Zone
Zone
Zone
Zone
Zone
Zone
Zone

Supply Air Mass Flow Rate [kg/s]

Exhaust Air Mass Flow Rate [kg/s]
Return Air Mass Flow Rate [kg/s]
Mixing Receiving Air Mass Flow Rate [kg/s]
Mixing Source Air Mass Flow Rate [kg/s]
Infiltration Air Mass Flow Balance Status, []
Mass Balance Infiltration Air Mass Flow Rate, [kg/s]

Zone Supply Air Mass Flow Rate [kg/s]

This output variable represents the total supply air mass flow rate of a zone. The value is
determined by summing the supply air mass flow rates contributions from all supply air inlet
nodes of a zone.

9/29/14

478

Input-Output Reference

Group Airflow

Zone Exhaust Air Mass Flow Rate [kg/s]

This output variable represents the total exhaust air mass flow rate of a zone. The value is
determined by summing the exhaust air mass flow rates contributions from all exhaust air
nodes of a zone.
Zone Return Air Mass Flow Rate [kg/s]
This output variable represents the total return air mass flow rate of a zone. The value is
determined by summing the return air mass flow rates contributions from return air nodes of a
zone.
Zone Mixing Receiving Air Mass Flow Rate [kg/s]
This output variable represents the total zone mixing air mass flow rate of a receiving zone
from one or more mixing objects. The value is determined by summing the air mass flow
contributions from all zone mixing objects connected to a single receiving zone.
Zone Mixing Source Air Mass Flow Rate [kg/s]
This output variable represents the total zone mixing source air mass flow rate of a source
zone feeding one or more mixing objects. The value is determined by summing the air mass
flow contributions from all zone mixing objects connected to a single source zone.
Zone Infiltration Air Mass Flow Balance Status []
This output variable indicates the status of the infiltration object mass flow rate use for
balancing the zone mass flow at each time step. It has values of either 0 or 1. If the value of
this report variable is 0 then the zone infiltration object mass flow rate is not used in the zone
mass conservation calculation, hence the infiltration rate calculated based on the user
specified inputs is manintained and the infiltration rate is assumed as self-balanced for
current timestep. If the value is 1 then the zone infiltration object mass flow rate is included in
the zone air mass flow balance calculation, hence the user specified infiltration rate is
modified and it is considered as incoming flow to the zone, i.e., self-balanced assumption is
not valid for this zone and current time step.
Zone Mass Balance Infiltration Air Mass Flow Rate [kg/s]
This output variable represents the zone infiltration air mass flow rate in kg/s. This output
variable is reported only for source zones and when the zone air mass flow balance flag is
set to Yes and its value depends on the Source Zone Infiltration Treatment method
specified. When the infiltration treatment method selected is AddInfiltrationFlow this report
variable represents additional infiltration air mass flow rate added on top of the base
infiltration air flow calculated using the user inputs inroder to balance the zone air mass flow.
In this case, the base infiltration air mass flow calculated using the user specified input is
assumed self-balanced.
When the infiltration treatment method selected is
AdjustInfiltrationFlow this report variable represents the base infiltration air mass flow
calculated using the user inputs and can be adjuted as needed in roder to balance the zone
air mass flow. If the value of the output variable Zone Infiltration Air Mass Flow Balance
Status is 0, then the infiltration air mass flow rate calculated based on the user specified
inputs is manintained and the infiltration rate is assumed as self-balanced for current
timestep, or else if Zone Infiltration Air Mass Flow Balance Status is 1, then user specified
infiltration rate is adjusted and it is considered as incoming flow to the zone, i.e., selfbalanced assumption is not valid for this zone and current time step.

9/29/14

479

Input-Output Reference

Group Design Objects

Group Design Objects

Input for Design Calculations and Component Autosizing
Overview
In order for EnergyPlus to successfully calculate zone design heating and cooling loads and
air flow rates and for the program to use these results to automatically size the HVAC
components a number of input objects must be present and certain object input fields must
be entered.
The input file should contain a SimulationControl object. The 1st field Do Zone Sizing
Calculation should be entered as Yes. This will cause a zone sizing simulation to be done
using all the sizing periods in the input file as weather. If there are no air or water loops in
the HVAC input fields 2 and 3 can be set to No. If there are one or more air loops (i.e.,
there is at least one AirLoopHVAC object in the input file) then the 2nd field Do System
Sizing Calculation should be entered as Yes. If there are one or more water loops (Plant
Loop objects) then the 3rd field Do Plant Sizing Calculation should be set to Yes. Finally
either the 4th field (Run Simulation for Sizing Periods) or the 5th field (Run Simulation for
Weather File Run Periods) should be set to Yes in order to autosize the components and
do a real simulation using the autosized components. The component autosizing
calculations are done on the first pass through the HVAC system in the real simulation.
There must be at least 2 (up to any number) SizingPeriod objects present. Normally one
will be for summer conditions and one for winter. The summer day should normally have
the field Day Type set to SummerDesignDay. The winter design day should normally
have Day Type set to WinterDesignDay.
To apply a global sizing factor include the Sizing:Parameters object.
For each controlled zone in the input file there should be a corresponding Sizing:Zone
object. Similarly for each AirLoopHVAC there should be a Sizing:System object. And for
each Plant or Condenser Loop there should be a Sizing:Plant object. Note however that if
a controlled zone has no corresponding Zone Sizing object the data from the first Zone
Sizing object will be used. Thus if all the zone sizing information is the same only one
Zone Sizing object need be entered.
Only controlled zones are included in the zone and system sizing calculations. Thus for a
design air flow rate to be calculated for a zone, it must contain a thermostat even though
it might not need or have a thermostat in the full simulation. An illustration would be a
three zone building with a packaged single zone system and a thermostat in one of the
zones. In order for the two slave zones to be included in the design air flow calculations
they must be treated as if they have a thermostat: there must be a
ZoneControl:Thermostat for each of the slave zones.
Some attention should be paid to schedules. In a weekly schedule object the 9th and 10th
day schedules are for summer and winter design days respectively. This means that if a
SizingPeriod object has field Day Type set to SummerDesignDay the day schedule for
summer sizing periods will be in effect. Similarly if a SizingPeriod object has field Day
Type set to WinterDesignDay the day schedule for winter sizing periods will be in effect.
Some possible applications of this capability are:
1) setting internal loads (lights, equipment, occupancy) to maximum all day for cooling

and to zero all day for heating;

2) setting heating and cooling thermostat set points to constant values (no set up or set

back);

3) setting heating and cooling equipment to be always on.

None of these applications are necessarily recommended but these and other uses of the
special summer/winter design day schedules may prove useful for specific situations.

9/29/14

480

Input-Output Reference

Group Design Objects

Other than zone thermostat setpoints, the sizing calculations generally know nothing
about the system control inputs such as setpoints and availability schedules. The user
must coordinate sizing inputs with the actual simulation control inputs.
The sizing calculations only recognize the presence of central heating and cooling coils,
preheat and precool coils and reheat coils. These are assumed to deliver the various
supply temperatures specified in the Sizing:System and Sizing:Zone objects. The impact
of ther components such as heat recovery, dehumidifiers, fans, and pumps are not
accounted for in the sizing calculations.
Component Autosizing
For autosizing to occur at the component level the user must enter the special value autosize
in the numeric fields for which autosizing is available. Those fields can be found by looking at
the Energy+.idd data dictionary file or under individual object details in this document. Fields
that can be autosized are denoted with the comment \autosizable. The components and
fields that are autosizable are listed in the following table. Note that spaces may be inserted
in object names to facilitate readability.
Table 22. Details of Autosizable Objects/Fields
Component /
Object Name

Autosizable Fields

AirConditioner:VariableRefrigerantFlow
Gross Rated Total Cooling Capacity
Gross Rated Heating Capacity
Resistive Defrost Heater Capacity
Water Condenser Volume Flow Rate
Evaporative Condenser Air Flow Rate
Evaporative Condenser Pump Rated Power Consumption
AirLoopHVAC
Design Supply Air Flow Rate
AirLoopHVAC:Unitary:Furnace:HeatCool
Maximum Supply Air Temperature
Supply Air Flow Rate During Cooling Operation
Supply Air Flow Rate During Heating Operation
Supply Air Flow Rate When No Cooling or Heating is Needed
AirLoopHVAC:Unitary:Furnace:HeatOnly
Maximum Supply Air Temperature
Supply Air Flow Rate
AirLoopHVAC:UnitaryHeatCool
Maximum Supply Air Temperature
Supply Air Flow Rate During Cooling Operation
Supply Air Flow Rate During Heating Operation
Supply Air Flow Rate When No Cooling or Heating is Needed
AirLoopHVAC:UnitaryHeatCool:VAVChangeoverBypass
System Air Flow Rate During Cooling Operation
System Air Flow Rate During Heating Operation

9/29/14

481

Input-Output Reference

Group Design Objects

Component /
Object Name

Autosizable Fields
System Air Flow Rate When No Cooling or Heating is Needed
Outdoor Air Flow Rate During Cooling Operation
Outdoor Air Flow Rate During Heating Operation

Outdoor Air Flow Rate When No Cooling or Heating is Needed

AirLoopHVAC:UnitaryHeatOnly
Maximum Supply Air Temperature
Supply Air Flow Rate
AirLoopHVAC:UnitaryHeatPump:AirToAir
Supply Air Flow Rate During Cooling Operation
Supply Air Flow Rate During Heating Operation
Supply Air Flow Rate When No Cooling or Heating is Needed
Maximum Supply Air Temperature from Supplemental Heater
AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed
Maximum Supply Air Temperature from Supplemental Heater
Supply Air Flow Rate When No Cooling or Heating is Needed
Speed 1 Supply Air Flow Rate During Heating Operation
Speed 2 Supply Air Flow Rate During Heating Operation
Speed 3 Supply Air Flow Rate During Heating Operation
Speed 4 Supply Air Flow Rate During Heating Operation
Speed 1 Supply Air Flow Rate During Cooling Operation
Speed 2 Supply Air Flow Rate During Cooling Operation
Speed 3 Supply Air Flow Rate During Cooling Operation
Speed 4 Supply Air Flow Rate During Cooling Operation
AirLoopHVAC:UnitaryHeatPump:WaterToAir
Supply Air Flow Rate
Maximum Supply Air Temperature from Supplemental Heater
AirLoopHVAC:UnitarySystem
Supply Air Flow Rate During Cooling Operation
Supply Air Flow Rate During Heating Operation
Supply Air Flow Rate When No Cooling or Heating is Required
Maximum Supply Air Temperature
AirTerminal:DualDuct:ConstantVolume
Maximum Air Flow Rate
AirTerminal:DualDuct:VAV
Maximum Damper Air Flow Rate
AirTerminal:DualDuct:VAV:OutdoorAir
Maximum Terminal Air Flow Rate
AirTerminal:SingleDuct:ConstantVolume:CooledBeam
Supply Air Volumetric Flow Rate
Maximum Total Chilled Water Volumetric Flow Rate
Number of Beams
9/29/14

482

Input-Output Reference

Group Design Objects

Component /
Object Name

Autosizable Fields

Beam Length
AirTerminal:SingleDuct:ConstantVolume:FourPipeInduction
Maximum Total Air Flow Rate
Maximum Hot Water Flow Rate
Maximum Cold Water Flow Rate
AirTerminal:SingleDuct:ConstantVolume:Reheat
Maximum Air Flow Rate
Maximum Hot Water or Steam Flow Rate
AirTerminal:SingleDuct:ParallelPIU:Reheat
Maximum Primary Air Flow Rate
Maximum Secondary Air Flow Rate
Minimum Primary Air Flow Fraction
Fan On Flow Fraction
Maximum Hot Water or Steam Flow Rate
AirTerminal:SingleDuct:SeriesPIU:Reheat
Maximum Air Flow Rate
Maximum Primary Air Flow Rate
Minimum Primary Air Flow Fraction
Maximum Hot Water or Steam Flow Rate
AirTerminal:SingleDuct:Uncontrolled
Maximum Air Flow Rate
AirTerminal:SingleDuct:VAV:HeatAndCool:NoReheat
Maximum Air Flow Rate
AirTerminal:SingleDuct:VAV:HeatAndCool:Reheat
Maximum Air Flow Rate
Maximum Hot Water or Steam Flow Rate
AirTerminal:SingleDuct:VAV:NoReheat
Maximum Air Flow Rate
AirTerminal:SingleDuct:VAV:Reheat
Maximum Air Flow Rate
Maximum Hot Water or Steam Flow Rate
AirTerminal:SingleDuct:VAV:Reheat:VariableSpeedFan
Maximum Cooling Air Flow Rate
Maximum Heating Air Flow Rate
Maximum Hot Water or Steam Flow Rate
Boiler:HotWater
Nominal Capacity
Design Water Flow Rate
Boiler:Steam
Nominal Capacity
Branch
9/29/14

483

Input-Output Reference

Group Design Objects

Component /
Object Name

Autosizable Fields
Maximum Flow Rate

Chiller:Absorption
Nominal Capacity
Nominal Pumping Power
Design Chilled Water Flow Rate
Design Condenser Water Flow Rate
Design Generator Fluid Flow Rate
Chiller:Absorption:Indirect
Nominal Capacity
Nominal Pumping Power
Design Chilled Water Flow Rate
Design Condenser Water Flow Rate
Design Generator Fluid Flow Rate
Chiller:CombustionTurbine
Nominal Capacity
Design Chilled Water Flow Rate
Design Condenser Water Flow Rate
Gas Turbine Engine Capacity
Chiller:ConstantCOP
Nominal Capacity
Design Chilled Water Flow Rate
Design Condenser Water Flow Rate
Chiller:Electric
Nominal Capacity
Design Chilled Water Flow Rate
Design Condenser Fluid Flow Rate
Design Heat Recovery Water Flow Rate
Chiller:Electric:EIR
Reference Capacity
Reference Chilled Water Flow Rate
Reference Condenser Fluid Flow Rate
Design Heat Recovery Water Flow Rate
Chiller:Electric:ReformulatedEIR
Reference Capacity
Reference Chilled Water Flow Rate
Reference Condenser Water Flow Rate
Design Heat Recovery Water Flow Rate
Chiller:EngineDriven
Nominal Capacity
Design Chilled Water Flow Rate
Design Condenser Water Flow Rate
9/29/14

484

Input-Output Reference

Group Design Objects

Component /
Object Name

Autosizable Fields

ChillerHeater:Absorption:DirectFired
Nominal Cooling Capacity
Design Chilled Water Flow Rate
Design Condenser Water Flow Rate
Design Hot Water Flow Rate
ChillerHeater:Absorption:DoubleEffect
Nominal Cooling Capacity
Design Chilled Water Flow Rate
Design Condenser Water Flow Rate
Design Hot Water Flow Rate
ChillerHeaterPerformance:Electric:EIR
Reference Cooling Mode Evaporator Capacity
Design Chilled Water Flow Rate
Design Condenser Water Flow Rate
Coil:Cooling:DX:MultiSpeed
Speed 1 Gross Rated Total Cooling Capacity
Speed 1 Gross Rated Sensible Heat Ratio
Speed 1 Rated Air Flow Rate
Speed 1 Evaporative Condenser Air Flow Rate
Speed 1 Rated Evaporative Condenser Pump Power Consumption
Speed 2 Gross Rated Total Cooling Capacity
Speed 2 Gross Rated Sensible Heat Ratio
Speed 2 Rated Air Flow Rate
Speed 2 Evaporative Condenser Air Flow Rate
Speed 2 Rated Evaporative Condenser Pump Power Consumption
Speed 3 Gross Rated Total Cooling Capacity
Speed 3 Gross Rated Sensible Heat Ratio
Speed 3 Rated Air Flow Rate
Speed 3 Evaporative Condenser Air Flow Rate
Speed 3 Rated Evaporative Condenser Pump Power Consumption
Speed 4 Gross Rated Total Cooling Capacity
Speed 4 Gross Rated Sensible Heat Ratio
Speed 4 Rated Air Flow Rate
Speed 4 Evaporative Condenser Air Flow Rate
Speed 4 Rated Evaporative Condenser Pump Power Consumption
Coil:Cooling:DX:SingleSpeed
Gross Rated Total Cooling Capacity
Gross Rated Sensible Heat Ratio
Rated Air Flow Rate
Evaporative Condenser Air Flow Rate
Evaporative Condenser Pump Rated Power Consumption
9/29/14

485

Input-Output Reference

Group Design Objects

Component /
Object Name

Autosizable Fields

Coil:Cooling:DX:SingleSpeed:ThermalStorage
Rated Evaporator Air Flow Rate
Cooling Only Mode Rated Total Evaporator Cooling Capacity
Evaporative Condenser Pump Rated Power Consumption
Coil:Cooling:DX:TwoSpeed
High Speed Gross Rated Total Cooling Capacity
High Speed Rated Sensible Heat Ratio
High Speed Rated Air Flow Rate
Low Speed Gross Rated Total Cooling Capacity
Low Speed Gross Rated Sensible Heat Ratio
Low Speed Rated Air Flow Rate
High Speed Evaporative Condenser Air Flow Rate
High Speed Evaporative Condenser Pump Rated Power Consumption
Low Speed Evaporative Condenser Air Flow Rate
Low Speed Evaporative Condenser Pump Rated Power Consumption
Coil:Cooling:DX:VariableRefrigerantFlow
Gross Rated Total Cooling Capacity
Gross Rated Sensible Heat Ratio
Rated Air Flow Rate
Coil:Cooling:DX:VariableSpeed
Gross Rated Total Cooling Capacity At Selected Nominal Speed Level
Rated Air Flow Rate At Selected Nominal Speed Level
Evaporative Condenser Pump Rated Power Consumption
Coil:Cooling:Water
Design Water Flow Rate
Design Air Flow Rate
Design Inlet Water Temperature
Design Inlet Air Temperature
Design Outlet Air Temperature
Design Inlet Air Humidity Ratio
Design Outlet Air Humidity Ratio
Coil:Cooling:Water:DetailedGeometry
Maximum Water Flow Rate
Tube Outside Surface Area
Total Tube Inside Area
Fin Surface Area
Minimum Airflow Area
Coil Depth
Fin Diameter
Number of Tubes per Row
Coil:Cooling:WaterToAirHeatPump:EquationFit
9/29/14

486

Input-Output Reference

Group Design Objects

Component /
Object Name

Autosizable Fields
Rated Air Flow Rate
Rated Water Flow Rate
Gross Rated Total Cooling Capacity

Gross Rated Sensible Cooling Capacity

Coil:Cooling:WaterToAirHeatPump:VariableSpeedEquationFit
Gross Rated Total Cooling Capacity At Selected Nominal Speed Level
Rated Air Flow Rate At Selected Nominal Speed Level
Rated Water Flow Rate At Selected Nominal Speed Level
Coil:Heating:DX:MultiSpeed
Resistive Defrost Heater Capacity
Speed 1 Gross Rated Heating Capacity
Speed 1 Rated Air Flow Rate
Speed 2 Gross Rated Heating Capacity
Speed 2 Rated Air Flow Rate
Speed 3 Gross Rated Heating Capacity
Speed 3 Rated Air Flow Rate
Speed 4 Gross Rated Heating Capacity
Speed 4 Rated Air Flow Rate
Coil:Heating:DX:SingleSpeed
Gross Rated Heating Capacity
Rated Air Flow Rate
Resistive Defrost Heater Capacity
Coil:Heating:DX:VariableRefrigerantFlow
Gross Rated Heating Capacity
Rated Air Flow Rate
Coil:Heating:DX:VariableSpeed
Rated Heating Capacity At Selected Nominal Speed Level
Rated Air Flow Rate At Selected Nominal Speed Level
Resistive Defrost Heater Capacity
Coil:Heating:Electric
Nominal Capacity
Coil:Heating:Electric:MultiStage
Stage 1 Nominal Capacity
Stage 2 Nominal Capacity
Stage 3 Nominal Capacity
Stage 4 Nominal Capacity
Coil:Heating:Gas
Nominal Capacity
Coil:Heating:Gas:MultiStage
Stage 1 Nominal Capacity
Stage 2 Nominal Capacity
9/29/14

487

Input-Output Reference

Group Design Objects

Component /
Object Name

Autosizable Fields
Stage 3 Nominal Capacity
Stage 4 Nominal Capacity

Coil:Heating:Steam
Maximum Steam Flow Rate
Coil:Heating:Water
U-Factor Times Area Value
Maximum Water Flow Rate
Rated Capacity
Coil:Heating:WaterToAirHeatPump:EquationFit
Rated Air Flow Rate
Rated Water Flow Rate
Gross Rated Heating Capacity
Coil:Heating:WaterToAirHeatPump:VariableSpeedEquationFit
Rated Heating Capacity At Selected Nominal Speed Level
Rated Air Flow Rate At Selected Nominal Speed Level
Rated Water Flow Rate At Selected Nominal Speed Level
CoilPerformance:DX:Cooling
Gross Rated Total Cooling Capacity
Gross Rated Sensible Heat Ratio
Rated Air Flow Rate
Evaporative Condenser Air Flow Rate
Evaporative Condenser Pump Rated Power Consumption
CondenserLoop
Maximum Loop Flow Rate
Controller:OutdoorAir
Minimum Outdoor Air Flow Rate
Maximum Outdoor Air Flow Rate
Controller:WaterCoil
Controller Convergence Tolerance
Maximum Actuated Flow
CoolingTower:SingleSpeed
Design Water Flow Rate
Design Air Flow Rate
Design Fan Power
Design U-Factor Times Area Value
CoolingTower:TwoSpeed
Design Water Flow Rate
High Fan Speed Air Flow Rate
High Fan Speed Fan Power
High Fan Speed U-Factor Times Area Value
CoolingTower:VariableSpeed
9/29/14

488

Input-Output Reference

Group Design Objects

Component /
Object Name

Autosizable Fields
Design Water Flow Rate
Design Air Flow Rate

Design Fan Power

CoolingTower:VariableSpeed:Merkel
Nominal Capacity
Design Water Flow Rate
Design Air Flow Rate U-Factor Times Area Value
EvaporativeCooler:Indirect:ResearchSpecial
Secondary Fan Flow Rate
EvaporativeFluidCooler:SingleSpeed
Design Air Flow Rate
Design Air Flow Rate Fan Power
Design Air Flow Rate U-factor Times Area Value
Design Water Flow Rate
EvaporativeFluidCooler:TwoSpeed
High Fan Speed Air Flow Rate
High Fan Speed Fan Power
High Fan Speed U-factor Times Area Value
Design Water Flow Rate
Fan:ComponentModel
Maximum Flow Rate
Minimum Flow Rate
Motor Fan Pulley Ratio
Belt Maximum Torque
Maximum Motor Output Power
Maximum VFD Output Power
Fan:ConstantVolume
Maximum Flow Rate
Fan:OnOff
Maximum Flow Rate
FanPerformance:NightVentilation
Maximum Flow Rate
Fan:VariableVolume
Maximum Flow Rate
FluidCooler:SingleSpeed
Design Air Flow Rate U-factor Times Area Value
Design Water Flow Rate
Design Air Flow Rate
Design Air Flow Rate Fan Power
FluidCooler:TwoSpeed
High Fan Speed U-factor Times Area Value
9/29/14

489

Input-Output Reference

Group Design Objects

Component /
Object Name

Autosizable Fields
Design Water Flow Rate
High Fan Speed Air Flow Rate

High Fan Speed Fan Power

HeaderedPumps:ConstantSpeed
Total Rated Flow Rate
Rated Power Consumption
HeaderedPumps:VariableSpeed
Total Rated Flow Rate
Rated Power Consumption
HeatExchanger:AirToAir:SensibleAndLatent
Nominal Supply Air Flow Rate
HeatExchanger:FluidToFluid
Loop Demand Side Design Flow Rate
Loop Supply Side Design Flow Rate
Heat Exchanger U-Factor Times Area Value
Humidifier:Steam:Electric
Rated Power
HVACTemplate:Plant:Boiler
Capacity
HVACTemplate:Plant:Chiller
Capacity
HVACTemplate:Plant:Tower
High Speed Nominal Capacity
High Speed Fan Power
Low Speed Nominal Capacity
Low Speed Fan Power
Free Convection Capacity
HVACTemplate:System:ConstantVolume
Supply Fan Maximum Flow Rate
Heating Coil Capacity
Maximum Outdoor Air Flow Rate
Minimum Outdoor Air Flow Rate
Humidifier Rated Electric Power
HVACTemplate:System:DedicatedOutdoorAir
Supply Fan Flow Rate
DX Cooling Coil Gross Rated Total Capacity
DX Cooling Coil Gross Rated Sensible Heat Ratio
Humidifier Rated Electric Power
HVACTemplate:System:DualDuct
Main Supply Fan Maximum Flow Rate
Cold Duct Supply Fan Maximum Flow Rate
9/29/14

490

Input-Output Reference

Group Design Objects

Component /
Object Name

Autosizable Fields
Hot Duct Supply Fan Maximum Flow Rate
Heating Coil Capacity
Maximum Outdoor Air Flow Rate
Minimum Outdoor Air Flow Rate

Humidifier Rated Electric Power

HVACTemplate:System:PackagedVAV
Supply Fan Maximum Flow Rate
Supply Fan Minimum Flow Rate
Cooling Coil Gross Rated Total Capacity
Cooling Coil Gross Rated Sensible Heat Ratio
Heating Coil Capacity
Maximum Outdoor Air Flow Rate
Minimum Outdoor Air Flow Rate
Humidifier Rated Electric Power
HVACTemplate:System:Unitary
Supply Fan Maximum Flow Rate
Cooling Coil Gross Rated Total Capacity
Cooling Coil Gross Rated Sensible Heat Ratio
Heating Coil Capacity
Maximum Outdoor Air Flow Rate
Minimum Outdoor Air Flow Rate
Humidifier Rated Electric Power
HVACTemplate:System:UnitaryHeatPump:AirToAir
Cooling Supply Air Flow Rate
Heating Supply Air Flow Rate
No Load Supply Air Flow Rate
Cooling Coil Gross Rated Total Capacity
Cooling Coil Gross Rated Sensible Heat Ratio
Heat Pump Heating Coil Gross Rated Capacity
Supplemental Heating Coil Capacity
Maximum Outdoor Air Flow Rate
Minimum Outdoor Air Flow Rate
Humidifier Rated Electric Power
HVACTemplate:System:UnitarySystem
Cooling Supply Air Flow Rate
Heating Supply Air Flow Rate
No Load Supply Air Flow Rate
DX Cooling Coil Gross Rated Total Capacity
DX Cooling Coil Gross Rated Sensible Heat Ratio
Heating Coil Gross Rated Capacity
Supplemental Heating or Reheat Coil Capacity
9/29/14

491

Input-Output Reference

Group Design Objects

Component /
Object Name

Autosizable Fields
Maximum Outdoor Air Flow Rate
Minimum Outdoor Air Flow Rate

Humidifier Rated Electric Power

HVACTemplate:System:VAV
Supply Fan Maximum Flow Rate
Supply Fan Minimum Flow Rate
Maximum Outdoor Air Flow Rate
Minimum Outdoor Air Flow Rate
Humidifier Rated Electric Power
HVACTemplate:System:VRF
Gross Rated Total Cooling Capacity
Gross Rated Heating Capacity
Resistive Defrost Heater Capacity
Water Condenser Volume Flow Rate
Evaporative Condenser Air Flow Rate
Evaporative Condenser Pump Rated Power Consumption
HVACTemplate:Zone:BaseboardHeat
Baseboard Heating Capacity
HVACTemplate:Zone:ConstantVolume
Supply Air Maximum Flow Rate
Baseboard Heating Capacity
HVACTemplate:Zone:DualDuct
Supply Air Maximum Flow Rate
Baseboard Heating Capacity
HVACTemplate:Zone:FanCoil
Supply Air Maximum Flow Rate
Baseboard Heating Capacity
HVACTemplate:Zone:IdealLoadsAirSystem
Maximum Heating Air Flow Rate
Maximum Sensible Heating Capacity
Maximum Cooling Air Flow Rate
Maximum Total Cooling Capacity
HVACTemplate:Zone:PTAC
Cooling Supply Air Flow Rate
Heating Supply Air Flow Rate
No Load Supply Air Flow Rate
Cooling Coil Gross Rated Total Capacity
Cooling Coil Gross Rated Sensible Heat Ratio
Heating Coil Capacity
Baseboard Heating Capacity
HVACTemplate:Zone:PTHP
9/29/14

492

Input-Output Reference

Component /
Object Name

Group Design Objects

Autosizable Fields
Cooling Supply Air Flow Rate
Heating Supply Air Flow Rate
No Load Supply Air Flow Rate
Cooling Coil Gross Rated Total Capacity
Cooling Coil Gross Rated Sensible Heat Ratio
Heat Pump Heating Coil Gross Rated Capacity
Supplemental Heating Coil Capacity

Baseboard Heating Capacity

HVACTemplate:Zone:Unitary
Supply Air Maximum Flow Rate
Baseboard Heating Capacity
HVACTemplate:Zone:VAV
Supply Air Maximum Flow Rate
Baseboard Heating Capacity
HVACTemplate:Zone:VAV:FanPowered
Primary Supply Air Maximum Flow Rate
Primary Supply Air Minimum Flow Fraction
Secondary Supply Air Maximum Flow Rate
Parallel Fan On Flow Fraction
Baseboard Heating Capacity
HVACTemplate:Zone:VAV:HeatAndCool
Supply Air Maximum Flow Rate
Baseboard Heating Capacity
HVACTemplate:Zone:VRF
Supply Air Flow Rate During Cooling Operation
Supply Air Flow Rate When No Cooling is Needed
Supply Air Flow Rate During Heating Operation
Supply Air Flow Rate When No Heating is Needed
Outdoor Air Flow Rate During Cooling Operation
Outdoor Air Flow Rate During Heating Operation
Outdoor Air Flow Rate When No Cooling or Heating is Needed
Cooling Coil Gross Rated Total Capacity
Cooling Coil Gross Rated Sensible Heat Ratio
Heat Pump Heating Coil Gross Rated Capacity
Baseboard Heating Capacity
HVACTemplate:Zone:WaterToAirHeatPump
Cooling Supply Air Flow Rate
Heating Supply Air Flow Rate
No Load Supply Air Flow Rate
Cooling Coil Gross Rated Total Capacity
Cooling Coil Gross Rated Sensible Heat Ratio
9/29/14

493

Input-Output Reference

Group Design Objects

Component /
Object Name

Autosizable Fields
Heat Pump Heating Coil Gross Rated Capacity
Supplemental Heating Coil Capacity

Baseboard Heating Capacity

PlantComponent:TemperatureSource
Design Volume Flow Rate
PlantEquipmentOperation:ComponentSetpoint
Component 1 Flow Rate
Component 2 Flow Rate
Component 3 Flow Rate
Component 4 Flow Rate
Component 5 Flow Rate
Component 6 Flow Rate
Component 7 Flow Rate
Component 8 Flow Rate
Component 9 Flow Rate
Component 10 Flow Rate
PlantLoop
Maximum Loop Flow Rate
Pump:ConstantSpeed
Rated Flow Rate
Rated Power Consumption
Pump:VariableSpeed
Rated Flow Rate
Rated Power Consumption
Pump:VariableSpeed:Condensate
Rated Flow Rate
Rated Power Consumption
Sizing:System
Design Outdoor Air Flow Rate
SolarCollector:FlatPlate:PhotovoltaicThermal
Design Flow Rate
ThermalStorage:ChilledWater:Mixed
Use Side Design Flow Rate
Source Side Design Flow Rate
ThermalStorage:ChilledWater:Stratified
Use Side Design Flow Rate
Source Side Design Flow Rate
UnitarySystemPerformance:HeatPump:Multispeed
Speed 1 Supply Air Flow Ratio During Heating Operation
Speed 1 Supply Air Flow Ratio During Cooling Operation
Speed 2 Supply Air Flow Ratio During Heating Operation
9/29/14

494

Input-Output Reference

Group Design Objects

Component /
Object Name

Autosizable Fields
Speed 2 Supply Air Flow Ratio During Cooling Operation
Speed 3 Supply Air Flow Ratio During Heating Operation
Speed 3 Supply Air Flow Ratio During Cooling Operation
Speed 4 Supply Air Flow Ratio During Heating Operation
Speed 4 Supply Air Flow Ratio During Cooling Operation

WaterHeater:Mixed
Tank Volume
Heater Maximum Capacity
Use Side Design Flow Rate
Source Side Design Flow Rate
WaterHeater:Stratified
Tank Volume
Tank Height
Heater 1 Capacity
Use Side Design Flow Rate
Source Side Design Flow Rate
ZoneHVAC:Baseboard:Convective:Electric
Nominal Capacity
ZoneHVAC:Baseboard:Convective:Water
U-Factor Times Area Value
Maximum Water Flow Rate
ZoneHVAC:Baseboard:RadiantConvective:Electric
Nominal Capacity
ZoneHVAC:Baseboard:RadiantConvective:Steam
Maximum Steam Flow Rate
ZoneHVAC:Baseboard:RadiantConvective:Water
Rated Capacity
Maximum Water Flow Rate
ZoneHVAC:EnergyRecoveryVentilator
Supply Air Flow Rate
Exhaust Air Flow Rate
ZoneHVAC:EvaporativeCoolerUnit
Design Supply Air Flow Rate
ZoneHVAC:FourPipeFanCoil
Maximum Supply Air Flow Rate
Maximum Outdoor Air Flow Rate
Maximum Cold Water Flow Rate
Maximum Hot Water Flow Rate
ZoneHVAC:HighTemperatureRadiant
Maximum Power Input
ZoneHVAC:IdealLoadsAirSystem
9/29/14

495

Input-Output Reference

Group Design Objects

Component /
Object Name

Autosizable Fields
Maximum Heating Air Flow Rate
Maximum Sensible Heating Capacity
Maximum Cooling Air Flow Rate

Maximum Total Cooling Capacity

ZoneHVAC:LowTemperatureRadiant:Electric
Maximum Electrical Power to Panel
ZoneHVAC:LowTemperatureRadiant:VariableFlow
Hydronic Tubing Length
Maximum Hot Water Flow
Maximum Cold Water Flow
ZoneHVAC:OutdoorAirUnit
Outdoor Air Flow Rate
Exhaust Air Flow Rate
ZoneHVAC:PackagedTerminalAirConditioner
Supply Air Flow Rate During Cooling Operation
Supply Air Flow Rate During Heating Operation
Supply Air Flow Rate When No Cooling or Heating is Needed
Outdoor Air Flow Rate During Cooling Operation
Outdoor Air Flow Rate During Heating Operation
Outdoor Air Flow Rate When No Cooling or Heating is Needed
ZoneHVAC:PackagedTerminalHeatPump
Supply Air Flow Rate During Cooling Operation
Supply Air Flow Rate During Heating Operation
Supply Air Flow Rate When No Cooling or Heating is Needed
Outdoor Air Flow Rate During Cooling Operation
Outdoor Air Flow Rate During Heating Operation
Outdoor Air Flow Rate When No Cooling or Heating is Needed
Maximum Supply Air Temperature from Supplemental Heater
ZoneHVAC:TerminalUnit:VariableRefrigerantFlow
Supply Air Flow Rate During Cooling Operation
Supply Air Flow Rate When No Cooling is Needed
Supply Air Flow Rate During Heating Operation
Supply Air Flow Rate When No Heating is Needed
Outdoor Air Flow Rate During Cooling Operation
Outdoor Air Flow Rate During Heating Operation
Outdoor Air Flow Rate When No Cooling or Heating is Needed
ZoneHVAC:UnitHeater
Maximum Supply Air Flow Rate
Maximum Hot Water or Steam Flow Rate
ZoneHVAC:UnitVentilator
Maximum Supply Air Flow Rate
9/29/14

496

Input-Output Reference

Group Design Objects

Component /
Object Name

Autosizable Fields
Minimum Outdoor Air Flow Rate

Maximum Outdoor Air Flow Rate

ZoneHVAC:VentilatedSlab
Maximum Air Flow Rate
Minimum Outdoor Air Flow Rate
Maximum Outdoor Air Flow Rate
ZoneHVAC:WaterToAirHeatPump
Supply Air Flow Rate During Cooling Operation
Supply Air Flow Rate During Heating Operation
Supply Air Flow Rate When No Cooling or Heating is Needed
Outdoor Air Flow Rate During Cooling Operation
Outdoor Air Flow Rate During Heating Operation
Outdoor Air Flow Rate When No Cooling or Heating is Needed
Maximum Supply Air Temperature from Supplemental Heater
ZoneHVAC:WindowAirConditioner
Maximum Supply Air Flow Rate
Maximum Outdoor Air Flow Rate
There are 3 places in the input where the user can impose sizing factors.
1. In Sizing Parameters (object: Sizing:Parameters), the user can specify an over-all
sizing factor. This factor is applied to all the zone design loads and air flow rates
resulting from the zone sizing calculations.
2. In Zone Sizing (object: Sizing:Zone), the user can specify a sizing factor for a specific
zone. The factor is applied to the calculated zone design loads and air flow rates for
the zone named in the Sizing:Zone object. This sizing factor overrides the global
sizing factor. That is, a zone sizing factor, if specified, replaces the global sizing
factor for the named zone.
3. For some plant components (basically all central chillers, boilers and cooling towers)
the user can specify a sizing factor that modifies the autosized component capacity
and flow rates. These factors are applied after the application of global or zone sizing
factors. They are primarily used to split the design load between multiple
components. These sizing factors can change the autosizing of the associated loops
and pumps. The following rules are followed the effect of plant component sizing
factors on loops and pumps.
a. For supply side branches, the sizing factors of all components in series on
the branch are summed and the result becomes the branch sizing factor. If
there is a branch pump its autosized design flow rate is multiplied by the
branch sizing factor.
b. For each loop, if the average of the branch sizing factors is less than 1, the
loop sizing factor is set equal to the sum of the branch sizing factors. If the
average is greater than 1, the loop sizing factor is set equal to the maximum
of the branch sizing factors. The loop sizing factor is applied to the loop
design flow rate (if autosized) and to the loop pump flow rate (if autosized).
Mixing User-Specified and Autosized Inputs
Mixed user-specified and autosized inputs can be successfully used if the following points
and suggestions are followed.
9/29/14

497

Input-Output Reference

Group Design Objects

1. Each component is autosized independently. Thus user input for a flow rate in one
component will have no effect on other components autosized flow rates. For
instance, specifying the chilled water loop pumps rated flow rate will have no effect
on the autosizing of the chillers design evaporator flow rate or on the plant loops
autosized maximum loop flow rate.
2. Within a component it is best to autosize all inputs are enter specified values for all
inputs. For example, in a chiller, if only the nominal capaciity is user-specified, the
autosized chilled water flow rate may not be consistent with the specified capacity.
3. Sizing information flows only from the sizing objects to the components. The sizing
calculations have no knowledge of user-specified values in a component. The only
exception to this rule is that plant loop sizing will collect all component design water
flow rates whether autosized or user-specified.
4. If the user wants to specify a zone or system air flow rate it should be done using the
Sizing:Zone and Sizing:System
objects rather than done in the individual
components.
5. The plant loop flow rates are sized from the total design demand of the components
connected to each loop. The components demanding water need not be autosized
for the plant loop autosizing to work successfully. So the user could specify all the air
side components and autosize all the plant loops and plant components. Or specify
the chilled water loop flow rate, chilled water pump inputs and chiller inputs and let
the condenser loop and tower autosize.
Component Sizing Output
The results of the component autosizing calculations are reported on the eplusout.eio file. For
each component field that has been autosized the object type, object name, field description
with unit, and value are printed out as comma separated data on a line beginning with
Component Sizing. Examples of this are shown in the Output Details and Examples
document.
The complete list of objects that have autosized fields is shown in the following table. Note
that spaces may be inserted in object names to facilitate readability.
Table 23. Complete list of Objects with autosized Fields
Object Name

9/29/14

Object Name

AirConditioner:VariableRefrigerantFlow

AirLoopHVAC

AirLoopHVAC:Unitary:Furnace:HeatCool

AirLoopHVAC:Unitary:Furnace:HeatOnly

AirLoopHVAC:UnitaryHeatCool

AirLoopHVAC:UnitaryHeatCool:VAVChange
overBypass

AirLoopHVAC:UnitaryHeatOnly

AirLoopHVAC:UnitaryHeatPump:AirToAir

AirLoopHVAC:UnitaryHeatPump:AirToAir:Mult
iSpeed

AirLoopHVAC:UnitaryHeatPump:WaterToAir

AirLoopHVAC:UnitarySystem

AirTerminal:DualDuct:ConstantVolume

AirTerminal:DualDuct:VAV

AirTerminal:DualDuct:VAV:OutdoorAir

AirTerminal:SingleDuct:ConstantVolume:Cool
edBeam

AirTerminal:SingleDuct:ConstantVolume:Fo
urPipeInduction

AirTerminal:SingleDuct:ConstantVolume:Rehe
at

AirTerminal:SingleDuct:ParallelPIU:Reheat

AirTerminal:SingleDuct:SeriesPIU:Reheat

AirTerminal:SingleDuct:Uncontrolled

AirTerminal:SingleDuct:VAV:HeatAndCool:No
Reheat

AirTerminal:SingleDuct:VAV:HeatAndCool:R
eheat

AirTerminal:SingleDuct:VAV:NoReheat

AirTerminal:SingleDuct:VAV:Reheat
498

Input-Output Reference

Group Design Objects

Object Name

9/29/14

Object Name

AirTerminal:SingleDuct:VAV:Reheat:Variable
SpeedFan

Boiler:HotWater

Boiler:Steam

Branch

Chiller:Absorption

Chiller:Absorption:Indirect

Chiller:CombustionTurbine

Chiller:ConstantCOP

Chiller:Electric

Chiller:Electric:EIR

Chiller:Electric:ReformulatedEIR

Chiller:EngineDriven

ChillerHeater:Absorption:DirectFired

ChillerHeater:Absorption:DoubleEffect

ChillerHeaterPerformance:Electric:EIR

Coil:Cooling:DX:MultiSpeed

Coil:Cooling:DX:SingleSpeed

Coil:Cooling:DX:SingleSpeed:ThermalStora
ge

Coil:Cooling:DX:TwoSpeed

Coil:Cooling:DX:VariableRefrigerantFlow

Coil:Cooling:DX:VariableSpeed

Coil:Cooling:Water

Coil:Cooling:Water:DetailedGeometry

Coil:Cooling:WaterToAirHeatPump:Equation
Fit

Coil:Cooling:WaterToAirHeatPump:VariableS
peedEquationFit

Coil:Heating:DX:MultiSpeed

Coil:Heating:DX:SingleSpeed

Coil:Heating:DX:VariableRefrigerantFlow

Coil:Heating:DX:VariableSpeed

Coil:Heating:Electric

Coil:Heating:Electric:MultiStage

Coil:Heating:Gas

Coil:Heating:Gas:MultiStage

Coil:Heating:Steam

Coil:Heating:Water

Coil:Heating:WaterToAirHeatPump:Equation
Fit

Coil:Heating:WaterToAirHeatPump:VariableS
peedEquationFit

CoilPerformance:DX:Cooling

CondenserLoop

Controller:OutdoorAir

Controller:WaterCoil

CoolingTower:SingleSpeed

CoolingTower:TwoSpeed

CoolingTower:VariableSpeed

CoolingTower:VariableSpeed:Merkel

EvaporativeCooler:Indirect:ResearchSpecial

EvaporativeFluidCooler:SingleSpeed

EvaporativeFluidCooler:TwoSpeed

Fan:ComponentModel

Fan:ConstantVolume

Fan:OnOff

FanPerformance:NightVentilation

Fan:VariableVolume

FluidCooler:SingleSpeed

FluidCooler:TwoSpeed

HeaderedPumps:ConstantSpeed

HeaderedPumps:VariableSpeed

HeatExchanger:AirToAir:SensibleAndLatent

HeatExchanger:FluidToFluid

Humidifier:Steam:Electric

HVACTemplate:Plant:Boiler

HVACTemplate:Plant:Chiller

HVACTemplate:Plant:Tower

HVACTemplate:System:ConstantVolume

HVACTemplate:System:DedicatedOutdoorAir

HVACTemplate:System:DualDuct

HVACTemplate:System:PackagedVAV

HVACTemplate:System:Unitary

HVACTemplate:System:UnitaryHeatPump:Air
ToAir

HVACTemplate:System:UnitarySystem

HVACTemplate:System:VAV

HVACTemplate:System:VRF
499

Input-Output Reference

Group Design Objects

Object Name

Object Name

HVACTemplate:Zone:BaseboardHeat

HVACTemplate:Zone:ConstantVolume

HVACTemplate:Zone:DualDuct

HVACTemplate:Zone:FanCoil

HVACTemplate:Zone:IdealLoadsAirSystem

HVACTemplate:Zone:PTAC

HVACTemplate:Zone:PTHP

HVACTemplate:Zone:Unitary

HVACTemplate:Zone:VAV

HVACTemplate:Zone:VAV:FanPowered

HVACTemplate:Zone:VAV:HeatAndCool

HVACTemplate:Zone:VRF

HVACTemplate:Zone:WaterToAirHeatPump

PlantComponent:TemperatureSource

PlantEquipmentOperation:ComponentSetpoint

PlantLoop

Pump:ConstantSpeed

Pump:VariableSpeed

Pump:VariableSpeed:Condensate

Sizing:System

SolarCollector:FlatPlate:PhotovoltaicThermal

ThermalStorage:ChilledWater:Mixed

ThermalStorage:ChilledWater:Stratified

UnitarySystemPerformance:HeatPump:Multi
speed

WaterHeater:Mixed

WaterHeater:Stratified

ZoneHVAC:Baseboard:Convective:Electric

ZoneHVAC:Baseboard:Convective:Water

ZoneHVAC:Baseboard:RadiantConvective:Ele
ctric

ZoneHVAC:Baseboard:RadiantConvective:
Steam

ZoneHVAC:Baseboard:RadiantConvective:W
ater

ZoneHVAC:EnergyRecoveryVentilator

ZoneHVAC:EvaporativeCoolerUnit

ZoneHVAC:FourPipeFanCoil

ZoneHVAC:HighTemperatureRadiant

ZoneHVAC:IdealLoadsAirSystem

ZoneHVAC:LowTemperatureRadiant:Electric

ZoneHVAC:LowTemperatureRadiant:Variabl
eFlow

ZoneHVAC:OutdoorAirUnit

ZoneHVAC:PackagedTerminalAirConditione
r

ZoneHVAC:PackagedTerminalHeatPump

ZoneHVAC:TerminalUnit:VariableRefrigeran
tFlow

ZoneHVAC:UnitHeater

ZoneHVAC:UnitVentilator

ZoneHVAC:VentilatedSlab

ZoneHVAC:WaterToAirHeatPump

ZoneHVAC:WindowAirConditioner
User or External Zone Design Flow Rate Inputs
In EnergyPlus the autosizing calculations start with a calculation of the zone design air flow
rates using zone by zone design day simulations. The resulting zone design air flow rates
and daily air flow sequences are used in the subsequent HVAC and central plant air and fluid
flow design calculations and in the component autosizing calculations. The user can override
or change the calculated zone design air flow rates in several ways.
1) The user can enter a value for Sizing Factor in the Sizing:Parameters object (see
description below).
2) The user can specify a zone level Zone Sizing Factor in each Sizing:Zone object.
3) For each zone the user can input a Cooling Design Air Flow Rate and/or a Heating
Design Air Flow Rate (and specify Cooling Design Air Flow Method = Flow/Zone and
Heating Design Air Flow Method = Flow/Zone). These user inputs override the calculated
values. The program divides the user input cooling or heating design air flow rate by the
calculated values and uses the result as a zone sizing factor to multiply all the elements

9/29/14

500

Input-Output Reference

Group Design Objects

in the design heating and cooling air flow and load sequences. From this point the design
calculations proceed as usual.
User or External System Design Flow Rate Inputs
Using the results of the zone design air flow rate calculation (including any user input or
altered flow rates) EnergyPlus proceeds to calculate central air system flow rates and cooling
and heating loads. The results of this calculation can be overridden in the following way.
For each system (AirLoopHVAC), in the corresponding Sizing:System object, specify Cooling
Design Air Flow Method to be Flow/System and input a value for Cooling Design Air Flow
Rate. Similarly for heating specify Heating Design Air Flow Method to be Flow/System and
input a value for Heating Design Air Flow Rate.
DesignSpecification:OutdoorAir
This object allows for the outdoor air requirements to be defined in a common location for use
by other objects. This object may be referenced by name from other objects (e.g., VAV
terminal units) as required to identify an outdoor air quantity for use by that object. Note that a
zone name Is not included as an input to this zone outdoor air definition and the number of
people in a zone, zone floor area, and zone volume can only be determined after this object
has been referenced by another. A single zone outdoor air definition may be referenced by
multiple objects to specify that the same outdoor air requirements are used by those objects
or multiple zone outdoor air objects may be defined and referenced by other objects as
needed. If multiple zone outdoor air definitions are used, each outdoor air definition must
have a unique name.
Field: Name
Unique identifying name. Any reference to this name by other objects will denote that the
following outdoor air requirements will be used.
Field: Outdoor Air Method
The input must be either Flow/Person, Flow/Area, Flow/Zone, AirChanges/Hour, Sum, or
Maximum. Flow/Person means the program will use the input from the field Outdoor Air Flow
per Person and the actual zone occupancy to calculate a zone outdoor air flow rate.
Flow/Area means that the program will use the input from the field Outdoor Air Flow per Zone
Floor Area and the actual zone floor area as the zone outdoor air flow rate. Flow/Zone means
that the program will use the input of the field Outdoor Air Flow per Zone as the zone outdoor
air flow rate. AirChanges/Hour means that the program will use the input from the field Air
Changes per Hour and the actual zone volume (divided by 3600 seconds per hour) as the
zone outdoor air flow rate. Sum means that the flows calculated from the fields Outdoor Air
Flow per Person, Outdoor Air Flow per Area, Outdoor Air Flow per Zone, and Air Changes
per Hour (using the associated conversions to m 3/s for each field) will be added to obtain the
zone outdoor air flow rate. Maximum means that the maximum flow derived from Outdoor Air
Flow per Person, Outdoor Air Flow per Area, Outdoor Air Flow per Zone, and Air Changes
per Hour (using the associated conversions to m3/s for each field) will be used as the zone
outdoor air flow rate. The default is Flow/Person.
Field: Outdoor Air Flow per Person
The design outdoor air volume flow rate per person for this zone in cubic meters per second
per person. The default is 0.00944 (20 cfm per person). An outdoor air flow rate is calculated
based on the total number of people for all People statements assigned to the zone.
Occupancy schedule values are not applied during sizing calculations and are applied during
the remainder of the simulation. This input is used if Outdoor Air Method is one of Outdoor Air
Flow per Person, Sum, or Maximum.

9/29/14

501

Input-Output Reference

Group Design Objects

Field: Outdoor Air Flow per Zone Floor Area

The design outdoor air volume flow rate per square meter of floor area (units are m 3/s-m2).
This input is used if Outdoor Air Method is Flow/Area, Sum or Maximum. The default value
for this field is 0.
Field: Outdoor Air Flow per Zone
The design outdoor air flow rate for this zone in cubic meters per second. This input field is
used if Outdoor Air Method is Flow/Zone, Sum or Maximum. The default value for this field is
0.
Field: Outdoor Air Flow Changes per Hour
The design outdoor air volume flow rate in air changes per hour. This factor is used along
with the Zone Volume and converted to cubic meters per second. This input field is used if
Outdoor Air Method is AirChanges/Hour, Sum or Maximum. The default value for this field is
0.
Field: Outdoor Air Flow Rate Fraction Schedule Name
This field is the name of schedule that defines how outdoor air requirements change over
time. The field is optional. If used, then the schedule values are multiplied by the outdoor air
flow rate defined by the previous fields. The schedule values must be between 0 and 1,
inclusive.
An IDF example:
DesignSpecification:OutdoorAir
ZoneOAData,
!- Name
Sum,
!- Outdoor
0.00944,
!- Outdoor
0.00305,
!- Outdoor
,
!- Outdoor
,
!- Outdoor
OARequirements Sched; !- Outdoor

Air
Air
Air
Air
Air
Air

Method
Flow per Person {m3/s}
Flow per Zone Floor Area {m3/s-m2}
Flow per Zone {m3/s}
Flow Air Changes per Hour
Flow Rate Fraction Schedule Name

Schedule:Compact,
OARequirements Sched,
!- Name
Any Number,
!- Schedule Type Limits Name
Through: 12/31,
!- Field 1
For: Weekdays SummerDesignDay WinterDesignDay, !- Field 2
Until: 24:00, 1.0,
!- Field 4
For: AllOtherDays,
!- Field 5
Until: 24:00, 0.5;
!- Field 7

DesignSpecification:ZoneAirDistribution
This object is used to describe the air distribution effectiveness and fraction of secondary
recirculation air (return air not directly mixed with outdoor air) of a zone. It is referenced by
the Sizing:Zone and Controller:MechanicalVentilation objects.
Field: Name
The unique user assigned name for an instance of this object. Any other object referencing
this object will use this name.
Field: Zone Air Distribution Effectiveness in Cooling Mode
The positive numeric input for this field is the zone air distribution effectiveness when the
zone is in cooling mode. Default value of this field is 1.0. ASHRAE Standard 62.1-2010
provides typical values.

9/29/14

502

Input-Output Reference

Group Design Objects

Field: Zone Air Distribution Effectiveness in Heating Mode

The positive numeric input for this field is the zone air distribution effectiveness when the
zone is in heating mode. Default value of this field is 1.0. ASHRAE Standard 62.1-2010
provides typical values as follows:

Figure 71. Zone Air Distribution Effectiveness (Source: ASHRAE Standard 62.1-2010)
Field: Zone Air Distribution Effectiveness Schedule Name
This optional field input points to a schedule with values of zone air distribution effectiveness.
It provides a more flexible way of specifying zone air distribution effectiveness if it changes
with time and/or system operating status and controls. If the schedule is specified, the zone
air distribution effectiveness in cooling mode and heating mode will be ignored.
Field: Zone Secondary Recirculation Fraction
The non-negative numeric input for this field is the fraction of a zones recirculation air that
does not directly mix with the outdoor air. The zone secondary recirculation fraction Er is
determined by the designer based on system configuration. For plenum return systems with
secondary recirculation (e.g., fan-powered VAV with plenum return) Er is usually less than
1.0, although values may range from 0.1 to 1.2 depending upon the location of the ventilation
zone relative to other zones and the air handler. For ducted return systems with secondary
recirculation (e.g., fan-powered VAV with ducted return), Er is typically 0.0, while for those
with system-level recirculation (e.g, dual-fan dual-duct systems with ducted return) Er is
typically 1.0. For other system types, Er is typically 0.75. Minimum is 0.0, and default is 0.0
for single-path systems (also to maintain backward compatibility). For parallel fan-powered
VAV systems, the secondary ventilation path only functions (Er > 0.0) when the fans in the
VAV boxes operate, which is during heating. The local ventilation path and the benefits of
secondary recirculation disappear during cooling, when the local parallel fans are off (Er =
0.0).

9/29/14

503

Input-Output Reference

Group Design Objects

An example of this in an IDF context is shown:

DesignSpecification:ZoneAirDistribution,
CM DSZAD ZN_1_FLR_1_SEC_1, !- Name
1,
!- Zone Air Distribution Effectiveness in Cooling Mode {dimensionless}
1,
!- Zone Air Distribution Effectiveness in Heating Mode {dimensionless}
;
!- Zone Air Distribution Effectiveness Schedule Name

Sizing:Parameters
This object allows the user to specify global heating and cooling sizing ratios. These ratios
will be applied at the zone level to all of the zone heating and cooling loads and air flow rates.
These new loads and air flow rates are then used to calculate the system level flow rates and
capacities and are used in all component sizing calculations.
The user can also specify the width (in load timesteps) of a moving average window which
can be used to smooth the calculated zone design flow sequences. The use of this parameter
is described below.
Field: Heating Sizing Factor
The global heating sizing ratio applied to all of the zone design heating loads and air flow
rates.
Field: Cooling Sizing Factor
The global cooling sizing ratio applied to all of the zone design cooling loads and air flow
rates
Field: Timesteps in Averaging Window
The number of load timesteps in the zone design flow sequence averaging window. The
default is 1, in which case the calculated zone design flow rates are averaged over the load
timestep.
The zone design air flow rate calculation is performed assuming a potentially infinite supply of
heating or cooling air at a fixed temperature. Thus the calculated design air flow rate will
always be able to meet any load or change in load no matter how large or abrupt. In reality air
flow rates are limited by duct sizes and fan capacities. The idealized zone design flow
calculation may result in unrealistically large flow rates, especially if the user is performing the
sizing calculations using thermostat schedules with night setup or setback. The calculated
zone design flow rates are always averaged over the load timestep. The user may want to
perform a broader average to mitigate the effect of thermostat setup and setback and prevent
the warm up or cool down flow rates from dominating the design flow rate calculation..
Specifying the width of the averaging window allows the user to do this.
For example, if the load calculation timestep is 15 minutes and the user specifies the
Timesteps in Averaging Window to be 4, the zone design air flows will be averaged over a
time period of 1 hour. Specifying 8 would result in averaging over a 2 hour period.
Sizing Parameters Outputs
The sizing factors and the averaging window size are reported out on the eplusout.eio file. An
example is:

9/29/14

504

Input-Output Reference

Group Design Objects

! <Load Timesteps in Zone Design Calculation Averaging Window>, Value

Timesteps in Averaging Window,
1
! <Heating Sizing Factor Information>, Sizing Factor ID, Value
Heating Sizing Factor, Global,
1.3000
Heating Sizing Factor, Zone SPACE1-1,
1.3000
Heating Sizing Factor, Zone SPACE2-1,
1.3000
Heating Sizing Factor, Zone SPACE3-1,
1.3000
Heating Sizing Factor, Zone SPACE4-1,
1.3000
Heating Sizing Factor, Zone SPACE5-1,
1.3000
! <Cooling Sizing Factor Information>, Sizing Factor ID, Value
Cooling Sizing Factor, Global,
1.3000
Cooling Sizing Factor, Zone SPACE1-1,
1.3000
Cooling Sizing Factor, Zone SPACE2-1,
1.3000
Cooling Sizing Factor, Zone SPACE3-1,
1.3000
Cooling Sizing Factor, Zone SPACE4-1,
1.3000
Cooling Sizing Factor, Zone SPACE5-1,
1.3000

OutputControl:Sizing:Style
As described early in the document (see: EnergyPlus Output Processing), the user may
select the style for the sizing result files (epluszsz.<ext>, eplusssz.<ext>). This object
applies to all sizing output files.
OutputControl:Sizing:Style,
\memo default style for the Sizing output files is comma -- this works well for
\memo importing into spreadsheet programs such as Excel(tm) but not so well for word
\memo processing progams -- there tab may be a better choice. fixed puts spaces between
\memo the "columns"
\unique-object
A1; \field Column Separator
\required-field
\type choice
\key Comma
\key Tab
\key Fixed

Field: Column Separator

For this field, the desired separator for columns is entered. Comma creates comma
separated fields/columns in the outputs (eplus<sizing type>.csv files are created). Tab
creates tab separated fields/columns in the outputs (eplus<sizing type>.tab files are created).
Fixed creates space separated fields/columns in the outputs (eplus<sizing type>.txt files are
created) but these are not necessarily lined up for easy printing.
Note that both tab and comma separated files easily import into Excel or other spreadsheet
programs. The tab delimited files can also be viewed by text editors, word processing
programs and easily converted to tables within those programs.
Sizing:Zone
The Sizing:Zone object provides the data needed to perform a zone design air flow
calculation for a single zone. This calculation assumes a variable amount of supply air at a
fixed temperature and humidity. The information needed consists of the zone inlet supply air
conditions: temperature and humidity ratio for heating and cooling. The calculation is done for
every design day included in the input. The maximum cooling load and air flow and the
maximum heating load and air flow are then saved for the system level design calculations
and for the component automatic sizing calculations.
The Sizing:Zone object is also the place where the user can specify the design outdoor air
flow rate by referencing the name of a design specification outdoor air object. This can be
specified in a number of ways (ref. DesignSpecification:OutdoorAir).This data is saved for
use in the system sizing calculation or for sizing zone components that use outdoor air.
The user can also place limits on the heating and design cooling air flow rates. See Heating
Design Air Flow Method and Cooling Design Air Flow Method below and the explanations of
the various heating and cooling flow input fields.

9/29/14

505

Input-Output Reference

Group Design Objects

Field: Zone Name

The name of the Zone corresponding to this Sizing:Zone object. This is the zone for which
the design air flow calculation will be made using the input data of this Sizing:Zone Object.
Field: Zone Cooling Design Supply Air Temperature Input Method
The input must be either
SupplyAirTemperature or TemperatureDifference.
SupplyAirTemperature means that the user inputs from the fields of Zone Cooling Design
Supply Air Temperature will be used to determine the zone cooling design air flow rates.
TemperatureDifference means that the user inputs from the fields of Zone Cooling Design
Supply Air Temperature Difference will be used to determine the zone cooling design air flow
rates.
Field: Zone Cooling Design Supply Air Temperature
The supply air temperature in degrees Celsius for the zone cooling design air flow rate
calculation. Air is supplied to the zone at this temperature during the cooling design day
simulation, The zone load is met by varying the zone air flow rate. The maximum zone flow
rate is saved as the zone cooling design air flow rate. This field is only used when Zone
Cooling Design Supply Air Temperature Input Method = SupplyAirTemperature.
Field: Zone Cooling Design Supply Air Temperature Difference
The temperature difference between cooling design supply air temperature and room air
temperature in degrees Celsius for the zone cooling design air flow rate calculation. Air is
supplied to the zone at this temperature during the cooling design day simulation. The zone
load is met by varying the zone air flow rate. The maximum zone flow rate is saved as the
zone cooling design air flow rate. This field is only used when Zone Cooling Design Supply
Air Temperature Input Method = TemperatureDifference.
Field: Zone Heating Design Supply Air Temperature Input Method
The input must be either
SupplyAirTemperature or TemperatureDifference.
SupplyAirTemperature means that the user inputs from the fields of Zone Heating Design
Supply Air Temperature will be used to determine the zone heating design air flow rates.
TemperatureDifference means that the user inputs from the fields of Zone Heating Design
Supply Air Temperature Difference will be used to determine the zone heating design air flow
rates.
Field: Zone Heating Design Supply Air Temperature
The supply air temperature in degrees Celsius for the zone heating design air flow rate
calculation. Air is supplied to the zone at this temperature during the heating design day
simulation, The zone load is met by varying the zone air flow rate. The maximum zone flow
rate is saved as the zone heating design air flow rate. This field is only used when Zone
Heating Design Supply Air Temperature Input Method = SupplyAirTemperature.
Field: Zone Heating Design Supply Air Temperature Difference
The temperature difference between heating design supply air temperature and room air
temperature in degrees Celsius for the zone heating design air flow rate calculation. Air is
supplied to the zone at this temperature during the heating design day simulation. The zone
load is met by varying the zone air flow rate. The maximum zone flow rate is saved as the
zone heating design air flow rate. This field is only used when Zone Heating Design Supply
Air Temperature Input Method = TemperatureDifference.
Field: Zone Cooling Design Supply Air Humidity Ratio
The humidity ratio in kilograms of water per kilogram of dry air of the supply air in the zone
cooling design air flow rate calculation.

9/29/14

506

Input-Output Reference

Group Design Objects

Field: Zone Heating Design Supply Air Humidity Ratio

The humidity ratio in kilograms of water per kilogram of dry air of the supply air in the zone
heating design air flow rate calculation.
Field: Design Specification Outdoor Air Object Name
This alpha field specifies the name of a DesignSpecification:OutdoorAir object which
specifies the design outdoor air flow rate for the zone.
Field: Zone Heating Sizing Factor
This input is a zone level heating sizing ratio. The zone design heating air flow rates and
loads will be multiplied by the number input in this field. This input overrides the building level
sizing factor input in the Sizing:Parameters object. And, of course, if this field is blank or zero,
the global heating sizing factor from the Sizing:Parameters object is used.
Field: Zone Cooling Sizing Factor
This input is a zone level cooling sizing ratio. The zone design cooling air flow rates and
loads will be multiplied by the number input in this field. This input overrides the building level
sizing factor input in the Sizing:Parameters object. And, of course, if this field is blank or zero,
the global cooling sizing factor from the Sizing:Parameters object is used.
Field: Cooling Design Air Flow Method
The input must be either Flow/Zone, DesignDay, or DesignDayWithLimit. Flow/Zone means
that the program will use the input of the field Cooling Design Air Flow Rate as the zone
design cooling air flow rate. DesignDay means the program will calculate the zone design
cooling air flow rate using the Sizing:Zone input data and a design day simulation without
imposing any limits other than those set by the minimum outside air requirements.
DesignDayWithLimit means that the maximum from Cooling Minimum Air Flow per Zone
Floor Area and Cooling Minimum Air Flow will set a lower limit on the design maximum
cooling air flow rate. The default method is DesignDay: i.e., the program uses the calculated
design values subject to ventilation requirements.
Field: Cooling Design Air Flow Rate
The design zone cooling air flow rate in cubic meters per second. This input is used if Cooling
Design Air Flow Method is specified as Flow/Zone. This value will be multiplied by the global
or zone sizing factor and by zone multipliers.
Field: Cooling Minimum Air Flow per Zone Floor Area
The minimum zone cooling volumetric flow rate per square meter (units are m 3/s-m2). This
field is used when Cooling Design Air Flow Method is specified as DesignDayWithLimit. In
this case it sets a lower bound on the zone design cooling air flow rate. In all cases the
maximum flow derived from Cooling Minimum Air Flow per Zone Floor Area, Cooling
Minimum Air Flow, and Cooling Minimum Air Flow Fraction is used to set a minimum supply
air flow rate for the zone for VAV systems. The default is .000762, corresponding to .15
cfm/ft2. The applicable sizing factor is not applied to this value.
Field: Cooling Minimum Air Flow
The minimum zone cooling volumetric flow rate in m 3/s. This field is used when Cooling
Design Air Flow Method is specified as DesignDayWithLimit. In this case it sets a lower
bound on the zone design cooling air flow rate. In all cases the maximum flow derived from
Cooling Minimum Air Flow per Zone Floor Area, Cooling Minimum Air Flow, and Cooling
Minimum Air Flow Fraction is used to set a minimum supply air flow rate for the zone for VAV
systems. The default is zero. The applicable sizing factor is not applied to this value.

9/29/14

507

Input-Output Reference

Group Design Objects

Field: Cooling Minimum Air Flow Fraction

The minimum zone design cooling volumetric flow rate expressed as a fraction of the zone
design cooling volumetric flow rate. . In all cases the maximum flow derived from Cooling
Minimum Air Flow per Zone Floor Area, Cooling Minimum Air Flow, and Cooling Minimum Air
Flow Fraction is used to set a minimum supply air flow rate for the zone for VAV systems.
The default is zero. This input is currently used in sizing the fan minimum flow rate. It does
not currently affect other component autosizing.
Field: Heating Design Air Flow Method
The input must be either Flow/Zone, DesignDay, or DesignDayWithLimit. Flow/Zone means
that the program will use the input of the field Heating Design Air Flow Rate as the zone
design heating air flow rate. DesignDay means the program will calculate the zone design
heating air flow rate using the Sizing:Zone input data and a design day simulation without
imposing any limits other than those set by the minimum outside air requirements.
DesignDayWithLimit means that the maximum from Heating Maximum Air Flow per Zone
Floor Area and Heating Maximum Air Flow will set a lower limit on the design maximum
heating air flow rate. The default method is DesignDay: i.e., the program uses the calculated
design values subject to ventilation requirements.
Field: Heating Design Air Flow Rate
The design zone heating air flow rate in cubic meters per second. This input is used if
Heating Design Air Flow Method is specified as Flow/Zone. This value will be multiplied by
the global or zone sizing factor and by zone multipliers.
Field: Heating Maximum Air Flow per Zone Floor Area
The maximum zone heating volumetric flow rate per square meter (units are m 3/s-m2). This
field is used when Heating Design Air Flow Method is specified as DesignDayWithLimit. In
this case it sets an upper bound on the zone design heating air flow rate. For this and the
next two input fields, the maximum flow derived from Heating Maximum Air Flow per Zone
Floor Area, Heating Maximum Air Flow, and Heating Maximum Air Flow Fraction is used to
set a maximum heating supply air flow rate for the zone for VAV systems. The default is
.002032, corresponding to .40 cfm/ft2. If the maximum heating design flow rate calculated
using these input fields is greater than the design heating flow rate calculated during sizing,
these input fields have no impact on sizing. It may be more appropriate to select only one of
these three fields to calculate the maximum heating design flow rate (i.e., if one ore more of
these three fields is 0, it will not be used in calculating the maximum heating design flow
rate).
Field: Heating Maximum Air Flow
The maximum zone heating volumetric flow rate in m 3/s. This field is used when Heating
Design Air Flow Method is specified as DesignDayWithLimit. In this case it sets an upper
bound on the zone design heating air flow rate. For this field and the two input fields just prior
to and after this field,,the maximum flow derived from Heating Maximum Air Flow per Zone
Floor Area, Heating Maximum Air Flow, and Heating Maximum Air Flow Fraction is used to
set a maximum heating supply air flow rate for the zone for VAV systems. The default is
.1415762, corresponding to 300 cfm. If the maximum heating design flow rate calculated
using these input fields is greater than the design heating flow rate calculated during sizing,
these input fields have no impact on sizing. It may be more appropriate to select only one of
these three fields to calculate the maximum heating design flow rate (i.e., if one ore more of
these three fields is 0, it will not be used in calculating the maximum heating design flow
rate).
Field: Heating Maximum Air Flow Fraction
The maximum zone design heating volumetric flow rate expressed as a fraction of the zone
design cooling volumetric flow rate. For this and the previous two input fields, the maximum
9/29/14

508

Input-Output Reference

Group Design Objects

flow derived from Heating Maximum Air Flow per Zone Floor Area, Heating Maximum Air
Flow, and Heating Maximum Air Flow Fraction is used to set a maximum heating supply air
flow rate for the zone for VAV systems. The default is 0.3. If the maximum heating design
flow rate calculated using these input fields is greater than the design heating flow rate
calculated during sizing, these input fields have no impact on sizing. It may be more
appropriate to select only one of these three fields to calculate the maximum heating design
flow rate (i.e., if one ore more of these three fields is 0, it will not be used in calculating the
maximum heating design flow rate).
Field: Design Specification Zone Air Distribution Object Name
The name of the DesignSpecification:ZoneAirDistribution object, defining the air distribution
effectiveness and secondary recirculation air fraction, that applies to the zone or zone list.
This object may be used for the same zone in the Controller:MechanicalVentilation object if
no such DesignSpecification:ZoneAirDistribution object is specified.
An IDF example:
Sizing:Zone,
SPACE5-1,
14.,
50.,
0.009,
0.004,
DSOA1,
0.0,
0.0,
designdaywithlimit,
,
,
,
,
designday,
,
,
,
,
DSZADO1;

!!!!!!!!!!!!!!!!!!!-

DesignSpecification:OutdoorAir,
DSOA1,
!SUM,
!0.00236,
!0.000305,
!0.0,
!0.0,
!;
!-

Name of a zone
Zone cooling design supply air temperature {C}
Zone heating design supply air temperature {C}
Zone cooling design supply air humidity ratio {kg-H2O/kg-air}
Zone heating design supply air humidity ratio {kg-H2O/kg-air}
Design Specification Outdoor Air Object Name
zone heating sizing factor
zone cooling sizing factor
Cooling Design Air Flow Method
cooling design air flow rate {m3/s}
Cooling Minimum Air Flow per zone area {m3/s-m2}
Cooling Minimum Air Flow {m3/s}
fraction of the cooling design air flow rate
Heating Design Air Flow Method
heating design air flow rate {m3/s}
heating max air flow per zone area {m3/s-m2}
heating max air flow {m3/s}
fraction of the cooling design air flow rate
Design Specification Zone Air Distribution Object Name
Name
Outdoor
Outdoor
Outdoor
Outdoor
Outdoor
Outdoor

Air
Air
Air
Air
Air
Air

Method
Flow per Person
Flow per Zone Floor Area
Flow per Zone
Flow Air Changes per Hour
Flow Rate Fraction Schedule Name

DesignSpecification:ZoneAirDistribution,
DSZADO1,
!- Name
1.0,
!- Zone Air Distribution Effectiveness in Cooling Mode
1.0,
!- Zone Air Distribution Effectiveness in Heating Mode
,
!- Zone Air Distribution Effectiveness Schedule Name
0.3;
!- Zone Secondary Recirculation Fraction

Zone Sizing Outputs

The zone design air flow rates and loads are output onto the local file epluszsz.<ext> where
<ext> is the extension from the sizing style object (default is csv a comma separated file
epluszsz.csv). The columns are clearly labeled. It will easily import into Excel or other
spreadsheet program that accepts delimited files. All of these values are design air flow rates
and loads calculated by the program. No sizing factors have been applied.
The calculated zone design air flow rates and the user input or altered zone design air flow
rates are also reported on the eplusout.eio file. The values are printed out for each zone as
comma separated records beginning with Zone Sizing. Items output on the eio file are: zone
name, load type (heating or cooling), design load, calculated design air flow rate, user design
9/29/14

509

Input-Output Reference

Group Design Objects

air flow rate, design day name, time of peak, outside temperature at peak, outside humidity
ratio at peak.
Sizing:System
The Sizing:System object contains the input needed to perform a central forced air system
design air flow, heating capacity, and cooling capacity calculation for a system serving one or
more zones. The information needed consists of the outside environmental conditions and
the design supply air temperatures, outdoor air flow rate, and minimum system air flow ratio.
The outside conditions come from the design days in the input. A system sizing calculation is
performed for every design day in the input file and the resulting maximum heating and
cooling air flow rates and capacities are saved for use in the component sizing calculations.
Supply air conditions are specified by inputting a supply air temperature for cooling, a supply
air temperature for heating, and a preheat temperature.
The system sizing calculation sums the zone design air flow rates to obtain a system supply
air flow rate. The design conditions and the outdoor air flow rate are used to calculate a
design mixed air temperature. The temperature plus the design supply air temperatures
allows the calculation of system design heating and cooling capacities.
Field: AirLoop Name
The name of the AirLoopHVAC corresponding to this Sizing:System object. This is the air
system for which the design calculation will be made using the input data of this
Sizing:System Object.
Field: Type of Load to Size On
The user specified type of load on which to size the central system. The choices are
Sensible,
Latent,
Total
and
VentilationRequirement.
Only
Sensible
and
VentilationRequirement are operational. Sensible means that the central system supply air
flow rate will be determined by combining the zone design air flow rates, which have been
calculated to meet the zone sensible loads from the design days. VentilationRequirement
means that the central system supply air flow rate will be determined by the system
ventilation requirement.
Field: Design Outdoor Air Flow Rate
The design outdoor air flow rate in cubic meters per second. Generally this should be the
minimum outdoor air flow. It is used for both heating and cooling design calculations. The
assumption for cooling is that any outdoor air economizer will be closed. If Autosize is input
the outdoor air flow rate will be taken from the sum of the zone outdoor air flow rates or
calculated based on the System Outdoor Air Method selection (field below).
Field: Minimum System Air Flow Ratio
The design minimum central air flow ratio. This ratio is the minimum system air flow rate
divided by the maximum system air flow rate. The value must be between 0 and 1. For
constant volume systems the ratio should be set to 1. Note that this ratio should be set to
reflect what the user expects the system flow rate to be when maximum heating demand
occurs. This ratio is used in calculating the central system heating capacity. Thus if the
system is VAV with the zone VAV dampers held at minimum flow when there is a zone
heating demand, this ratio should be set to the minimum flow ratio. If the zone VAV dampers
are reverse action and can open to full flow to meet heating demand, this ratio should be set
to 1.
Field: Preheat Design Temperature
The design air temperature exiting the preheat coil (if any) in degrees Celsius.

9/29/14

510

Input-Output Reference

Group Design Objects

Field: Preheat Design Humidity Ratio

The design humidity ratio exiting the preheat coil (if any) in kilograms of water per kilogram of
dry air. (kgWater/kgDryAir)
Field: Precool Design Temperature
The design air temperature exiting the precooling coil (if any) in degrees Celsius.
Field: Precool Design Humidity Ratio
The design humidity ratio exiting the precooling coil (if any) in kilograms of water per kilogram
of dry air. (kgWater/kgDryAir)
Field: Central Cooling Design Supply Air Temperature
The design supply air temperature for cooling in degrees Celsius. This should be the
temperature of the air exiting the central cooling coil.
Field: Central Heating Design Supply Air Temperature
The design supply air temperature for heating in degrees Celsius. This can be either the reset
temperature for a single duct system or the actual hot duct supply air temperature for dual
duct systems. It should be the temperature at the exit of the main heating coil.
Field: Sizing Option
If the input is coincident the central system air flow rate will be sized on the sum of the
coincident zone air flow rates. If the input is noncoincident the central system air flow rate will
be sized on the sum of the noncoincident zone air flow rates. The default is noncoincident.
Field: 100% Outdoor Air in Cooling
Entering Yes means the system will be sized for cooling using 100% outdoor air. Entering No
means the system will be sized for cooling using minimum outside air (the default).
Field: 100% Outdoor Air in Heating
Entering Yes means the system will be sized for heating using 100% outdoor air. Entering No
means the system will be sized for heating using minimum outside air (the default).
Field: Central Cooling Design Supply Air Humidity Ratio
The design humidity ratio in kilograms of water per kilogram of dry air at the exit of the central
cooling coil. (kgWater/kgDryAir) The default is .008.
Field: Central Heating Design Supply Air Humidity Ratio
The design humidity ratio in kilograms of water per kilogram of dry air at the exit of the central
heating coil. (kgWater/kgDryAir) The default is .008.
Field: Cooling Design Air Flow Method
The input of this field must be the method used to determine the airloop cooling supply air
volume flow rate or the cooling supply air flow rate value. The input allowed must be is either,
DesignDay, Flow/System, FlowPerFloorArea, FractionOfAutosizedCoolingAirflow, or
FlowPerCoolingCapacity. DesignDay means the program will calculate the system design
cooling air flow rate using the System Sizing input data and a design day simulation.
Flow/System means that the the program will use the input of the field Cooling Design Air
Flow Rate as the system design cooling air flow rate. FlowPerFloorArea means the program
calculates the cooling supply air volume flow rate from zone floor area served by the airloop
and user specified Flow Per Floor Area value. FractionOfAutosizedCoolingAirflow means the
program calculates the cooling supply air volume flow rate from user specified fraction and
the autosized design cooling supply air volume flow rate value determined by the simulation.
FlowPerCoolingCapacity means the supply air volume is calculated from user specified flow
9/29/14

511

Input-Output Reference

Group Design Objects

per cooling capacity and design cooling capacity determined by the simulation. The default
method is DesignDay: i.e., the program uses the calculated design values.
Field: Cooling Design Air Flow Rate
The design system cooling air flow rate in cubic meters per second. This input is an
alternative to using the program autocalculated value. This input is used if Cooling Design Air
Flow Method is Flow/System. This value will not be multiplied by any sizing factor or by zone
multipliers. If using zone multipliers, this value must be large enough to serve the multiplied
zones.
Field: Cooling Design Supply Air Flow Rate Per Floor Area {m3/s-m2}
Enter the cooling supply air volume flow rate per zone conditioned floor area in m3/s-m2. This
field is required field when the Cooling Design air Flow Method is FlowPerFloorArea. This
field may be left blank if a cooling coil is not included in the airloop or the Cooling Design Air
Flow Method is not FlowPerFloorArea. The program calculates the cooling supply air volume
flow rate from the cooled floor area served by the air loop and the Flow Per Unit Area value
specified by the user.
Field: Fraction of Autosized Cooling Design Supply Air Flow Rate {-}
Enter the cooling supply air volume flow rate as a fraction of the airloop autosized cooling
supply air flow rate. This input field is required when the Cooling Design air Flow Method is
FractionOfAutosizedCoolingAirflow. This input field may be left blank if a cooling coil is not
included in the airloop or the Cooling Design air Flow Method is not
FractionOfAutosizedCoolingAirflow. The program calculates the cooling supply air volume
flow rate from the design autosized cooling supply air flow rate and user specified fraction.
Field: Cooling Design Supply Air Flow Rate Per Unit Cooling Capacity {m3/s-W}
Enter the cooling supply air volume flow rate per unit cooling capacity in m3/s-W. This input
field is required when the Cooling Design air Flow Method is FlowPerCoolingCapacity. This
field may be left blank if a cooling coil is not included in the airloop or the Cooling Design air
Flow Method is not FlowPerCoolingCapacity. The program calculates the airloop cooling
supply air volume flow rate from the design autosized cooling capacity and user specified
Flow Per Cooling Capacity value.
Field: Heating Design Air Flow Method
The input of this field must be the method used to determine the airloop heating supply air
volume flow rate or the heating supply air flow rate value. The input allowed must be is either,
DesignDay,
Flow/System,
FlowPerFloorArea,
FractionOfAutosizedHeatingAirflow,
FractionOfAutosizedCoolingAirflow or FlowPerHeatingCapacity. DesignDay means the
program will calculate the system design heating air flow rate using the System Sizing input
data and a design day simulation. Flow/System means that the program will use the input of
the field Heating Design Air Flow Rate as the system design heating air flow rate.
FlowPerFloorArea means the program calculates the system heating supply air volume flow
rate from zone floor area served by the airloop and user specified Flow Per Floor Area value.
FractionOfAutosizedHeatingAirflow means the program calculates the system heating supply
air volume flow rate from user specified fraction and the autosized system design heating
supply
air
volume
flow
rate
value
determined
by
the
simulation.
FractionOfAutosizedCoolingAirflow means the program calculates the system heating supply
air volume flow rate from user specified fraction and the autosized system design cooling
supply air volume flow rate value determined by the simulation. FlowPerHeatingCapacity
means the system heating supply air volume is calculated from user specified flow per
heating capacity and design heating capacity determined by the simulation. The default
method is DesignDay: i.e., the program uses the calculated design values.

9/29/14

512

Input-Output Reference

Group Design Objects

Field: Heating Design Air Flow Rate

The design system heating air flow rate in cubic meters per second. This input is an
alternative to using the program autocalculated value. This input is used if Heating Design Air
Flow Method is Flow/System. This value will not be multiplied by any sizing factor or by zone
multipliers. If using zone multipliers, this value must be large enough to serve the multiplied
zones.
Field: Heating Design Supply Air Flow Rate Per Floor Area {m3/s-m2}
Enter the heating supply air volume flow rate per zone conditioned floor area in m3/s-m2.
This field is required field when the Heating Design air Flow Method is FlowPerFloorArea.
This field may be left blank if a heating coil is not included in the airloop or the Heating
Design Air Flow Method is not FlowPerFloorArea. The program calculates the heating supply
air volume flow rate from the heated or cooled floor area served by the air loop and the Flow
Per Unit Area value specified by the user.
Field: Fraction of Autosized Heating Design Supply Air Flow Rate {-}
Enter the heating supply air volume flow rate as a fraction of the airloop autosized heating
supply air flow rate. This input field is required when the Heating Design air Flow Method is
FractionOfAutosizedHeatingAirflow. This input field may be left blank if heating coil is not
included in the airloop or the Heatng Design air Flow Method is not
FractionOfAutosizedHeatingAirflow. The program calculates the heating supply air volume
flow rate from the design autosized heating supply air flow rate and user specified fraction.
Field: Fraction of Autosized Cooling Design Supply Air Flow Rate {-}
Enter the heating supply air volume flow rate as a fraction of the airloop autosized cooling
supply air flow rate. This input field is required when the Heating Design air Flow Method is
FractionOfAutosizedCoolingAirflow. This input field may be left blank if heating coil is not
included in the airloop or the Heatng Design air Flow Method is not
FractionOfAutosizedCoolingAirflow. The program calculates the heating supply air volume
flow rate from the design autosized cooling supply air flow rate and user specified fraction.
Field: Heating Design Supply Air Flow Rate Per Unit Heating Capacity {m3/s-W}
Enter the heating supply air volume flow rate per unit heating capacity in m3/s-W. This input
field is required when the Heating Design air Flow Method is FlowPerCoolingCapacity. This
field may be left blank if a heating coil is not included in the airloop or the Heating Design air
Flow Method is not FlowPerHeatingCapacity. The program calculates the airloop heating
supply air volume flow rate from the design autosized heating capacity and user specified
Flow Per Heating Capacity value.
Field: System Outdoor Air Method
The method used to calculate the system minimum outdoor air flow. The two choices are
ZoneSum and VentilationRateProcedure (VRP). ZoneSum sums the outdoor air flows across
all zones served by the system. VRP uses the multi-zone equations defined in 62.1-2007 to
calculate the system outdoor air flow. VRP considers zone air distribution effectiveness and
zone diversification of outdoor air fractions.
Field: Zone Maximum Outdoor Air Fraction
This positive numeric input is the zone maximum outdoor air fraction. For an air loop, when a
zone requires outdoor air higher than the user specified Zone Maximum Outdoor Air Fraction,
the zone supply air flow will be increased to cap the outdoor air fraction at the maximum
value. This allows the system level outdoor air flow to be reduced while the total supply air
flow increases. Valid values are from 0 to 1.0. Default is 1.0 which indicates zones can have
100% outdoor air maintaining backward compatibility. This inputs work for constant volume
air systems, single and dual duct VAV systems.

9/29/14

513

Input-Output Reference

Group Design Objects

Field Cooling Design Capacity Method

Enter the method used to determine the cooling design capacity for scalable sizing. Input
allowed
is
either
None,
CoolingDesignCapacity,
CapacityPerFloorArea,
and
FractionOfAutosizedCoolingCapacity. None is used when a cooling coil is not included in the
airloop. If this input field is left blank, or None is specified, then the autosized design cooling
capacity determined by the program is used. CoolingDesignCapacity means user specifies
the magnitude of cooling capacity or the program calculates the design cooling capacity if
autosize is specified. CapacityPerFloorArea means the program calculates the design cooling
capacity from user specified cooling capacity per floor area and floor area of the zones
served by the airloop. FractionOfAutosizedCoolingCapacity means the program calculates
the design cooling capacity from user specified fraction and the auto-sized design cooling
capacity. If the value this input field is blank or specified as None, then the next three input
fields are not required. The default method is CoolingDesignCapacity.
Field: Cooling Design Capacity {W}
Enter the magnitude of the cooling capacity in Watts. This input is an alternative to using the
program auto-calculated cooling capacity value. This input is a required field when the
Cooling Design Capacity Method is CoolingDesignCapacity. This field may be left blank if a
cooling coil is not included in the air loop or alternative method is specified. This input field is
autosizable.
Field: Cooling Design Capacity Per Floor Area {W/m2}
Enter the cooling capacity per unit floor area in m3/s-m2. This field is required field when the
Cooling Design Capacity Method is CapacityPerFloorArea. This field may be left blank if a
cooling coil is not included in the airloop or the Cooling Design Capacity Method is not
CapacityPerFloorArea. The program calculates the cooling capacity from floor area of the
zones served by the airloop and the cooling capacity per unit floor area value specified by the
user.
Field: Fraction of Autosized Cooling Design Capacity {-}
Enter the cooling capacity as a fraction of the autosized cooling capacity. This input field is
required when the Cooling Design Capacity Method is FractionOfAutosizedCoolingCapacity.
This input field may be left blank if a cooling coil is not included in the zone HVAC equipment
or the Cooling Design Capacity Method is not FractionOfAutosizedCoolingCapacity. The
program calculates the cooling capacity from the design autosized cooling capacity and user
specified fraction. Design day sizing run must be specified.
Field: Heating Design Capacity Method
Enter the method used to determine the heating design capacity for scalable sizing. Input
allowed
is
either
None,
HeatingDesignCapacity,
CapacityPerFloorArea,
and
FractionOfAutosizedHeatingCapacity. None is used when a heating coil is not included in the
airloop. If this input field is left blank, then the autosized design heating capacity determined
by the program is used. HeatingDesignCapacity means user specifies the magnitude of
heating capacity or the program calculates the design heating capacity if autosize is
specified. CapacityPerFloorArea means the program calculates the design heating capacity
from user specified heating capacity per floor area and floor area of the zones served by the
airllop. FractionOfAutosizedHeatingCapacity means the program calculates the design
heating capacity from user specified fraction and the auto-sized design heating capacity. If
the value this input field is blank or specified as None, then the next three input fields are not
required. The default method is HeatingDesignCapacity.
Field: Heating Design Capacity {W}
Enter the magnitude of the heating capacity in Watts. This input is an alternative to using the
program auto-calculated heating capacity value. This input is a required field when the
Heating Design Capacity Method is HeatingDesignCapacity. This field may be left blank if a
9/29/14

514

Input-Output Reference

Group Design Objects

heating coil is not included in the airloop or alternative method is specified. This input field is
autosizable.
Field: Heating Design Capacity Per Floor Area {W/m2}
Enter the heating capacity per unit floor area in m3/s-m2. This field is required field when the
Heating Design Capacity Method is CapacityPerFloorArea. This field may be left blank if a
heating coil is not included in the airloop or the Heating Design Capacity Method is not
CapacityPerFloorArea. The program calculates the heating capacity from floor area of the
zones served by the airloop and the heating capacity per unit floor area value specified by the
user.
Field: Fraction of Autosized Heating Design Capacity {-}
Enter the heating capacity as a fraction of the autosized heating capacity. This input field is
required when the Heating Design Capacity Method is FractionOfAutosizedHeatingCapacity.
This input field may be left blank if heating coil is not included in the airloop or the Heating
Design Capacity Method is not FractionOfAutosizedHeatingCapacity. The program calculates
the heating capacity from the design autosized cooling capacity and user specified fraction.
An IDF example:
Sizing:System,
VAV Sys 1,
sensible,
autosize,
0.3,
4.5,
.008,
11.0,
.008,
12.8,
16.7,
noncoincident,
no,
no,
0.008,
0.008,
designday,
0,
,
,
,
designday,
0,
,
,
,
,
ZoneSum,
0.5,
CoolingDesignCapacity,
autosize,
,
,
HeatingDesignCapacity,
autosize,
,
;

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!-

name of an AirLoopHVAC object

type of load to size on
Design (minimum) outside air volumetric flow rate {m3/s}
minimum system air flow ratio
Preheat design temperature {C}
Preheat design humidity ratio {kgWater/kgDryAir}
Precool design temperature {C}
Precool design humidity ratio {kgWater/kgDryAir}
Central cooling design supply air temperature {C}
Central heating design supply air temperature {C}
Sizing Option
Cooling 100% Outside Air
Heating 100% Outside Air
Central cooling design supply air humidity ratio {kgWater/kgDryAir}
Central heating design supply air humidity ratio {kgWater/kgDryAir}
Cooling Design Air Flow Method
cooling design air flow rate {m3/s}
Supply Air Flow Rate Per Floor Area During Cooling Operation {m3/s-m2}
Fraction of Autosized Design Cooling Supply Air Flow Rate {-}
Design Supply Air Flow Rate Per Unit Cooling Capacity {m3/s-W}
Heating Design Air Flow Method
heating design air flow rate {m3/s}
Supply Air Flow Rate Per Floor Area During Heating Operation {m3/s-m2}
Fraction of Autosized Design Heating Supply Air Flow Rate {-}
Fraction of Autosized Design Cooling Supply Air Flow Rate {-}
Design Supply Air Flow Rate Per Unit Heating Capacity {m3/s-W}
System Outdoor Air Method
Zone Maximum Outdoor Air Fraction
Cooling Design Capacity Method
Cooling Design Capacity {W}
Cooling Design Capacity Per Floor Area {W/m2}
Fraction of Autosized Cooling Design Capacity {-}
Heating Design Capacity Method
Heating Design Capacity {W}
Heating Design Capacity Per Floor Area {W/m2}
Fraction of Autosized Cooling Design Capacity {-}

System Sizing Outputs

The system design air flow rates and heating and cooling capacities are output onto the local
file eplusssz.<ext> where <ext> is the extension from the sizing style object (default is csv
a comma separated file eplusssz.csv). The columns are clearly labeled. It will easily import
9/29/14

515

Input-Output Reference

HVAC: Primary and Secondary Systems

into Excel or other spreadsheet program that accepts delimited files. The results are
calculated values and do not include any user input system flow rates.
The calculated system design air flow rates and the user input system design air flow rates
are also reported on the eplusout.eio file. The values are printed out for each system as
comma separated records beginning with System Sizing. An example is:
! <System Sizing Information>, System Name, Field Description, Value
System Sizing, VAV SYS 1, Calculated Cooling Design Air Flow Rate [m3/s],
1.3194
System Sizing, VAV SYS 1, User Cooling Design Air Flow Rate [m3/s],
1.5000
System Sizing, VAV SYS 1, Calculated Heating Design Air Flow Rate [m3/s], 0.90363
System Sizing, VAV SYS 1, User Heating Design Air Flow Rate [m3/s],
1.0000

Sizing:Plant
The Sizing:Plant object contains the input needed for the program to calculate plant loop flow
rates and equipment capacities when autosizing. This information is initially used by
components that use water for heating or cooling such as hot or chilled water coils to
calculate their maximum water flow rates. These flow rates are then summed for use in
calculating the Plant Loop flow rates.
The program will size any number of chilled water, hot water, condenser water and other
plant loops. There should be one Sizing:Plant object for each plant loop that is to be
autosized.
Field: Plant or Condenser Loop Name
The name of a Plant Loop or Condenser Loop object corresponding to this Sizing:Plant
object. This is the plant loop for which this data will be used for calculating the loop flow rate.
Field: Loop Type
The possible inputs are Heating, Steam, Cooling, or Condenser.
Field: Design Loop Exit Temperature
The water temperature in degrees Celsius at the exit of the supply side of the plant loop,
Thus this is the temperature of the water supplied to the inlet of chilled or hot water coils and
other equipment that places loads on a plant loop.
Field: Loop Design Temperature Difference
The design temperature rise (for cooling or condenser loops) or fall (for heating loops) in
degrees Celsius across the demand side of a plant loop. This temperature difference is used
by component models to determine flow rates required to meet design capacities. Larger
values lead to smaller design flow rates.
An IDF example:
Sizing:Plant,
Chilled Water Loop, ! name of loop
Cooling,
! type of loop
7.22,
! chilled water supply temperature
6.67;
! chilled water delta T

Plant Sizing Outputs

The loop flow rates are reported on the eplusout.eio file along with the component sizing
results.

HVAC: Primary and Secondary Systems

The HVAC and equipment section of the EnergyPlus input data dictionary and input data file
are slightly more complex than the description of building geometry, internal gains, etc.
because of the interconnections of the various parts of an HVAC system. In EnergyPlus,
9/29/14

516

Input-Output Reference

HVAC: Primary and Secondary Systems

there are several portions to the HVAC simulation. All of these parts must be correctly
specified in order to arrive at a valid simulation model. The goal of this section is to provide
interface developers and advanced users with guidelines on what input is expected and also
provide some background on basic EnergyPlus simulation methodology.
An EnergyPlus HVAC simulation consists of various components that are connected
physically in the actual system by ducts, piping, etc. Every component in an HVAC system
must have an inlet and outlet node. In the actual system, a node might be a point in the
system at which fluid properties can be measured. In an EnergyPlus simulation, the nodes
are points at which fluid properties are evaluated and passed on to subsequent equipment.
Components are linked together to form various loops within the simulation. Thus, the output
node from one component also serves as the inlet node to the next component. Loops are
constructed by defining these loops and also defining the components on the loops. The
figure below shows a generic example of the loop-node concept.
Loop nodes are a key defining feature in EnergyPlus. As a result, it is recommended that one
of the first steps taken in defining an HVAC system in EnergyPlus be the definition of a node
diagram or map. This is helpful for visualization of the entire system. Such a map could be
created electronically within an interface or could be kept in the background out of the sight of
the user.
2
1

Return Fan
5

Mixed Air System

Manager
4

Mixed Air Damper

10
2

12

Heat Recovery
6

11

13

Desiccant Wheel
9
8

Supply Fan
9

Zone

10

12

Splitter
10

11

Heating Coil
12

13

Cooling Coil

Figure 72. Example Node Diagram

So that these loops are manageable and more clearly defined both in the input and in the
simulation, four different loop sections can be defined in an EnergyPlus input file. In general,
these four types are in essence two pairs of loop sections that make up two distinct types of
9/29/14

517

Input-Output Reference

Group Node-Branch Management

loops: a zone/air loop and a plant loop. As of Version 7, plant loops and condenser loops
have been consolidated to be largely the same. The four loop section types are defined
below.
Air Loop Supply Side: The air loop is defined by the section of the zone/air loop that starts
after the zone return streams are combined and continues on until just before any air
stream(s) are branched off to individual zones. The starting point of the air loop is fairly
straightforward. The ending point is slightly more complex but can be understood with some
examples. For instance, in a terminal reheat system, the end of the air loop would typically be
considered the node following the cooling coil. In a dual duct system, the air loop would have
two ending points that would correspond to the nodes after the cooling coil and after the
heating coil/humidifier. In most cases, the air loop has a single starting point and up to two
ending points (for a 2 deck system). An outdoor air subsystem can be included in the supply
side for ventilation and relief air.
Air Loop Zone Equipment: The zone equipment section of the input file is defined as more
or less the rest of the zone/air loop (outside air is handled separately as a subset of the air
loop). This includes everything from where the ducts are split to serve various zones up
through where the return ducts from various zones are mixed into a single return duct. Zone
equipment can include dampers and reheat coils as well as zone specific conditioning
systems such as thermostatic baseboard or a window air conditioner. Most control issues are
typically dealt with in the zone equipment section of the simulation.
Plant Loop Demand Side: One side of the plant is where energy is demanded by various
components that make up the air loop or zone equipment. Typically, this is the water side of
equipment such as coils, baseboard, radiant heating and cooling, etc. In the case of a
condenser loop, energy is typically demanded by a chiller condenser or other water source
heat pump. The demand side of this loop can also include mixers, flow splitters, and a
bypass.
Plant Loop Supply Side: The other side of the plant loop is where energy is supplied by
various components. The components typically found on the supply side include pumps,
boilers, chillers, purchased heating and cooling, ice storage, etc. In the case of a condenser,
the components would be cooling tower, fluid cooler, or ground source heat exchanger, etc.
As with the demand side, this loop can also include mixers, flow splitters, and a bypass.
The section of the input file for describing the HVAC system tends to follow this structure
presented above. Both plant and condenser loops are defined with a master description and
then branch off into supply and demand side details. Linkage between the two sides is done
using node names in the master statement. The air loop and zone equipment descriptions
are slightly more complex due to the wide range of potential systems that are anticipated.
Note that in every section controls become a key element and must be addressed. Each of
the following sections details either a loop, a portion of a loop, or controls.

Group Node-Branch Management

Nodes, Branch Lists and Branches define the topography of the HVAC connections.
NodeList
For convenience, the NodeList object can be used to identify all the nodes for a particular
use. A node list is not always required. The advantage of listing all the nodes in this manner
is that input fields in other objects that ask for a node name can refer to either a single node
or a list of nodes using this object. .
There are other lines of input syntax that require the use of a NodeList as part of the input.
These syntax items include: OutdoorAir:NodeList and the SetpointManager objects. In these
two cases, the use of a NodeList statement is mandatory if there is more than one node in
this particular list. For example, if the outside air only has a single inlet node, then the name
of that node can replace the node list name in the input syntax. As a result of this mandatory

9/29/14

518

Input-Output Reference

Group Node-Branch Management

specification of node lists for certain types of input, nodes can, obviously, and may be
members of more than one list.
Field: Name
This alpha designation must be unique among all the Node List Names. It is used as
reference in various objects (e.g. OutdoorAir:NodeList).
Field: Node <#> Name (up to 25 allowed)
Each unique Node identifier creates a Node structure with various attributes depending on
the type of node. Typical values include Temperature, Mass Flow Rate, and Temperature Set
Point. The alpha designators are associated with a particular node.
Though each NodeList is limited to 25 nodes, several node lists may be entered if you
choose to identify all the nodes up front. For example:
NodeList, Nodes1-25,
NODE_1,NODE_2,NODE_3,NODE_4,NODE_5,NODE_6,NODE_7,NODE_8,NODE_9,NODE_10,
NODE_11,NODE_12,NODE_13,NODE_14,NODE_15,NODE_16,NODE_17,NODE_18,NODE_19,NODE_20,
NODE_21,NODE_22,NODE_23,NODE_24,NODE_25;
NodeList, Nodes26-49,NODE_26,NODE_27,NODE_28,NODE_29,NODE_30,
NODE_31,NODE_32,NODE_33,NODE_34,NODE_35,NODE_36,NODE_37,NODE_38,NODE_39,NODE_40,
NODE_41,NODE_42,NODE_43,NODE_44,NODE_45,NODE_46,NODE_47,NODE_48,NODE_49;

Node List Outputs

A simple detail of Nodes and numbers assigned appears in the eplusout.bnd file:
! <Node>,<NodeNumber>,<Node Name>,<Node Fluid Type>,<# Times Node Referenced After Definition>
Node,1,OUTSIDE AIR INLET NODE 1,Air,2
Node,2,VAV SYS 1 INLET NODE,Air,3
Node,3,MIXED AIR NODE 1,Air,5
Node,4,MAIN COOLING COIL 1 OUTLET NODE,Air,3
Node,5,MAIN HEATING COIL 1 OUTLET NODE,Air,4
Node,6,VAV SYS 1 OUTLET NODE,Air,7

In addition, properties of each node is available during the simulation:

HVAC,Average,System
HVAC,Average,System
HVAC,Average,System
HVAC,Average,System
HVAC,Average,System
HVAC,Average,System
HVAC,Average,System
HVAC,Average,System
HVAC,Average,System
HVAC,Average,System
HVAC,Average,System
HVAC,Average,System
HVAC,Average,System
HVAC,Average,System
HVAC,Average,System
HVAC,Average,System
HVAC,Average,System
HVAC,Average,System
HVAC,Average,System

Node
Node
Node
Node
Node
Node
Node
Node
Node
Node
Node
Node
Node
Node
Node
Node
Node
Node
Node

Temperature [C]
Last Timestep Temperature [C]
Mass Flow Rate [kg/s]
Humidity Ratio [kgWater/kgDryAir]
Setpoint Temperature [C]
Setpoint High Temperature [C]
Setpoint Low Temperature [C]
Setpoint Humidity Ratio [kgWater/kgDryAir]
Setpoint Minimum Humidity Ratio [kgWater/kgDryAir]
Setpoint Maximum Humidity Ratio [kgWater/kgDryAir]
Relative Humidity [%]
Pressure [Pa]
Standard Density Volume Flow Rate [m3/s]
Enthalpy [J/kg]
Last Timestep Enthalpy [J/kg]
Wetbulb Temperature [C]
Dewpoint Temperature [C]
Quality []
Height [m]

The following node variable is also available for system nodes that are for
air:
HVAC, Average, System Node Current Density Volume Flow Rate [m3/s]
HVAC, Average, System Node Current Density [kg/m3]

9/29/14

519

Input-Output Reference

Group Node-Branch Management

The following node variables are advanced and normally used for debugging
unusual cases:
HVAC,Average,System Node Minimum Temperature [C]
HVAC,Average,System Node Maximum Temperature [C]
HVAC,Average,System Node Minimum Limit Mass Flow Rate [kg/s]
HVAC,Average,System Node Maximum Limit Mass Flow Rate [kg/s]
HVAC,Average,System Node Minimum Available Mass Flow Rate [kg/s]
HVAC,Average,System Node Maximum Available Mass Flow Rate [kg/s]
HVAC,Averge,System Node Requested Mass Flow Rate [kg/s]
HVAC,Average,System Node Setpoint Mass Flow Rate [kg/s]
The following node variable reports node carbon dioxide concentration when
carbon dioxide is simulated (ref. ZoneAirContaminantBalance):
HVAC,Average,System Node CO2 Concentration [ppm]
The following node variable reports node generic contaminant concentration
when generic contaminant is simulated (ref. ZoneAirContaminantBalance):
HVAC,Average,System Node Generic Air Contaminant Concentration [ppm]

System Node Temperature [C]

The current temperature at a system node in degrees C. For air nodes, this is the dry-bulb
temperature.
System Node Last Timestep Temperature [C]
The temperature at a system node for the previous timestep.
System Node Mass Flow Rate [kg/s]
The current mass flow rate at a system node in kg/s.
System Node Humidity Ratio [kgWater/kgDryAir]
The current humidity ratio at a system node in kg-water/kg-dry-air. Not applicable for liquid
nodes.
System Node Setpoint Temperature [C]
The current setpoint temperature at a system node in degrees C. Some controllers and
equipment types sense this single setpoint.
System Node Setpoint High Temperature [C]
The current upper setpoint temperature at a system node in degrees C. Some controllers and
equipment types use dual setpoints at a single node.
System Node Setpoint Low Temperature [C]
The current upper setpoint temperature at a system node in degrees C. Some controllers and
equipment types use dual setpoints at a single node.
System Node Setpoint Humidity Ratio [kgWater/kgDryAir]
The current humidity ratio setpoint at a system node in kg-water/kg-dry-air. Some controllers
and equipment types sense this single setpoint. Not applicable for liquid nodes.
System Node Setpoint Minimum Humidity Ratio [kgWater/kgDryAir]
The current minimum desired humidity ratio at a system node in kg-water/kg-dry-air. Some
controllers and equipment types use the min/max values as dual setpoints at a single node.
Not applicable for liquid nodes.

9/29/14

520

Input-Output Reference

Group Node-Branch Management

System Node Setpoint Maximum Humidity Ratio [kgWater/kgDryAir]

The current maximum desired humidity ratio at a system node in kg-water/kg-dry-air. Some
controllers and equipment types use the min/max values as dual setpoints at a single node.
Not applicable for liquid nodes.
System Node Relative Humidity [%]
The current relative humidity (calculated from the node temperature, node humidity ratio and
standard barometric pressure for the location). Not applicable for liquid nodes.
System Node Pressure [Pa]
The current pressure at a system node in Pa.
System Node Standard Density Volume Flow Rate [m3/s]
The current volume flow rate at a system node in m 3/s. This is report is calculated from the
mass flow using standardized values for density that do not vary over time (except for steam
which varies with quality). For water nodes this density is determined at a temperature of
5.05C. For air nodes this density is determined for dry air at the standard barometric
pressure for the locations elevation, and a temperature of 20.0C. For air nodes, also see
the report System Node Current Density Volume Flow Rate.
System Node Enthalpy [J/kg]
The current enthalpy at a system node in J/kg.
System Node Last Timestep Enthalpy [J/kg]
The enthalpy at the system node for the previous timestep in Joules per kilogram.
System Node Wetbulb Temperature [C]
The current wet-bulb temperature at a system node in degrees C. Not applicable for liquid
nodes.
System Node Dewpoint Temperature [C]
The current dewpoint temperature at a system node in degrees C. It is calculated from the
System Node Temperature, the System Node Humidity Ratio and the Site Outdoor Air
Barometric Pressure. Not applicable for liquid nodes.
System Node Quality []
The current system node vapor fraction/percent {0.0-1.0}.
System Node Height [m]
The current system node height {m}. Only applicable to outdoor air nodes.
Additional Node Reporting for Air Nodes
The following system node variable is available for nodes with a fluid type of air.
System Node Current Density Volume Flow Rate [m3/s]
The current volume flow rate at a system node in m 3/s based on the current density. This
report differs from the one called System Node Standard Density Volume Flow Rate in that
it uses an air density calculated for the current moist air conditions rather than a standard
density.
System Node Current Density [kg/m3]
The current air density at a system node in kg/m3. This is the density used to calculate the
volume flow rate above. The density is calculated using current outdoor air barometric
pressure and the drybulb temperature and humidity ratio at the air node.
Advanced Node Reporting
9/29/14

521

Input-Output Reference

Group Node-Branch Management

The following system node variables are available when you request Diagnostics,
DisplayAdvancedReportVariable;. They are normally used for debugging unusual system
cases and may not be available for all systems. Also, their definitions may change based on
the usage in the system.
System Node Minimum Temperature [C]
System Node Maximum Temperature [C]
These node variables represent the min/max of loops or branches.
System Node Minimum Limit Mass Flow Rate [kg/s]
System Node Maximum Limit Mass Flow Rate [kg/s]
These node variables hold the maximum possible and the minimum allowable flow rates for a
particular component. As such, they represent the hardware limit on the flow rate for the
component. By convention, these variables are stored at the component inlet node. Since
components share their nodes (the outlet node of one component is the inlet node of the next
component), the protocol must be strictly followed. These variables are set by each
component based on the design flow limits of the equipment.
System Node Minimum Available Mass Flow Rate [kg/s]
System Node Maximum Available Mass Flow Rate [kg/s]
These node variables represent the loop or branch maximum and minimum flow rate for the
current configuration of the loop on which the component resides. The central plant routines
manage these variables dynamically to resolve flow rates through branches located inside
splitters and mixers.
System Node Setpoint Mass Flow Rate [kg/s]
The current mass flow rate setpoint at a system node in kg/s. Some controllers and
equipment types sense this single setpoint.
System Node Requested Mass Flow Rate [kg/s]
This output is the current mass flow rate request at a system node in kg/s. Only used for
plant simulations and nodes. This is the mass flow rate requested by a component. This is
a record of what the component wanted which can be useful for diagnostics when the actual
simulated flow is different than expected. This value is also used to determine overall loop
flow rates.
System Node CO2 Concentration [ppm]
The average carbon dioxide concentration, in parts per million (ppm), at a system node for
the timestep being reported.
System Node Generic Air Contaminant Concentration [ppm]
The average generic contaminant concentration, in parts per million (ppm), at a system node
for the timestep being reported.
BranchList
A branch list is intended to define the branches or portions of a particular loop that are
present on an individual plant or condenser loop. Thus, the BranchList syntax simply provides
a list of branch names (see Branch syntax) that then refer to more detailed syntax in another
part of the input file. The syntax for describing a list of branches is given below.
Branches in BranchList objects should be listed in flow order: inlet branch, then parallel branches, then
outlet branch. Branches (within a splitter/mixer) are simulated in the order listed.

9/29/14

522

Input-Output Reference

Group Node-Branch Management

Field: Name
A unique name to identify the branch list.
Field: Branch <#> Name
Branch name in the list. As noted above, Branches in BranchList objects MUST be listed in
flow order: inlet branch, then parallel branches, then outlet branch. Branches are simulated in
the order listed.
An example of this statement in an IDF is:
BranchList, Cooling Supply Side Branches,
CW Pump Branch,
Little Chiller Branch,
Big Chiller Branch,
Purchased Cooling Branch,
Supply Bypass Branch,
Cooling Supply Outlet;

Branch List Output

No output directly related to Branch Lists current is presented.
Branch
Branches can be considered the mid-level grouping of items in the EnergyPlus HVAC loop
scheme. Components are the lowest level of information. A collection of components in
series forms a branch. Every branch must have at least one component, but it may have
several components in series. The air loop also has unitary objects that are compound
objects that wrap components and when they are used it is the unitary objects that appear on
the Branch and not the child components. The Branch defines the order that components
appear on the branch. Moreover, a collection of branches and their connecting information
form a loop. Therefore, a branch is a collection of components while a loop is a collection of
branches. Thus, components are specified for particular HVAC loops by assigning them to
branches and then connecting those branches together to form a loop.
For hydronic plant systems, the Branch object is used on both the demand side and the
supply side of the plant loop. For HVAC air systems, the Branch object is only used to
describe the components on the supply side of an air loop. The demand side of the air loop
does not use the Branch object. The outside air system appears on a Branch object but it
does not use a Branch object itself to describe the components that included in the outside
air system. So-called ZoneHVAC:* equipment, HVAC equipment directly associated with a
zone, do not use the Branch object.
It should be noted that each component also has at least two nodes associated with itan
inlet node and an outlet node. These nodes, by default, are also part of the branch to which
their components are assigned. Although it may appear redundant to list the node names in
both the Branch and in the component object being referenced, this is needed because many
components are connected to more than one loop at a time and the node names are needed
here to distinguish which portion of the component is being attached to this particular branch
and its loop. It should be noted that each branch must have at least one component on it. A
null branch such as one where the first component on the loop is in reality a splitter or mixer
should be defined as a single Pipe component for plant, or a single Duct component for air
systems.
Field: Name
This alpha field is the unique, user-defined name that allows the branch to be referenced by
other elements such as the PlantLoop and CondenserLoop statements.

9/29/14

523

Input-Output Reference

Group Node-Branch Management

Field: Maximum Flow Rate

This field is the maximum flow rate (m 3/sec) allowed on a particular branch. This number will
set an absolute maximum flow rate for all components on the loop. Even if components are
defined with a higher flow rate, EnergyPlus will limit the flow on this particular branch to the
value entered here by the user. Currently this is used in the Air Loop and is not a required
field in the Plant and Condenser Loop. The example files for the Plant and Condenser Loops
leave this field blank to simplify flow input.
Field: Pressure Drop Curve Name
This is an optional field used to specify pressure drop information for this particular branch.
Currently this is only available in plant/condenser fluid loops: PlantLoop and CondenserLoop.
Air loops require a full airflow network, so this field is ignored if found on an air loop. The
value entered for this field must match a pressure curve object also found in the input. This
curve can be of the type: Curve:Linear, Curve:Quadratic, Curve:Cubic, Curve:Exponent, or
Curve:Functional:PressureDrop. In order to then perform a pressure simulation for the loop
that this branch is located on, a flag must be set in the loop object. Reference the PlantLoop
and CondenserLoop field Pressure Simulation Type for allowable settings. See the
Engineering Reference document for further information on pressure simulation in plant
loops.
Field Set (Branch Specifications)
Following the two introductory items, there are groups of 5 repeated items: a type, a name,
inlet and outlet node names, and a branch control type. All of these items refer to one
particular component on the branch. The first component defined by these items will be the
first component on this branch, etc. through the end of the list. This object is extensible and
can use as many field sets as needed.
Field: Component <#> Object Type
This field is the component object type (object class name). The component type refers to
other elements within the input file and specifies what kind of component this is. The objects
in the Group Plant Equipment section are valid here when the Branch is used in Plant
specifications. Fans, coils, unitary systems, and Outside Air Systems are also valid
component types for the Branch object. Pipes or Ducts are also valid for this field. No splitter
or mixer type objects are allowed.
Field: Component <#> Name
The component name is the unique, user-defined reference name to distinguish between
potentially multiple occurrences of a particular component type in an input file. The set of
component type and component name must be unique. (You can only have 1 Boiler object
with name MYBOILER).
Field: Component <#> Inlet Node Name
This field references an inlet node name that will be found in the actual component
specification. The inlet node, and the outlet node specified in the next field, should
correspond to component models connections that are intended for the loop that this Branch
is assigned to. For example a water-cooled chiller will have two inlet nodes, one for chilled
water return and one for condenser water return and so the chiller will appear on two Branch
objects accordingly.
Field: Component <#> Outlet Node Name
This field references an outlet node name that will be found in the actual component
specification.

9/29/14

524

Input-Output Reference

Group Node-Branch Management

Field: Component <#> Branch Control Type

This field is being deprecated and is no longer used or required. Prior to version 7 it was used
by plant to resolve branch flow rates but now this is handled automatically by the program.
The field will be removed in a future version.
An example of this statement in an IDF is:
Branch,
Air Loop Main Branch,
!- Branch Name
1.75,
!- Maximum Branch Flow Rate {m3/s}
,
!- Pressure Drop Curve Name
AirLoopHVAC:UnitaryHeatCool:VAVChangeoverBypass, !- Comp1 Type
GasHeat CBVAV System,
!- Comp1 Name
Air Loop Inlet Node,
!- Comp1 Inlet Node Name
Air Loop Outlet Node,
!- Comp1 Outlet Node Name
;
!- Comp1 Branch Control Type

And a more complex one:

BRANCH,
Air Loop Main Branch,
!- Branch Name
1.3,
!- Maximum Branch Flow Rate {m3/s}
,
!- Pressure Drop Curve Name
FAN:SIMPLE:ConstVolume, !- Comp1 Type
Supply Fan 1,
!- Comp1 Name
Air Loop Inlet Node,
!- Comp1 Inlet Node Name
Cooling Coil Air Inlet Node, !- Comp1 Outlet Node Name
,
!- Comp1 Branch Control Type
COIL:Water:DetailedFlatCooling, !- Comp2 Type
Detailed Cooling Coil,
!- Comp2 Name
Cooling Coil Air Inlet Node, !- Comp2 Inlet Node Name
Air Loop Outlet Node,
!- Comp2 Outlet Node Name
;
!- Comp2 Branch Control Type

Branch Output
The components on a branch are in series and that list is in simulation and connection order.
Each branch must obey the rules: the outlet for component 1 has to have the same node
name as the inlet for component 2, and so forth.
Eplusout.err contains the test for individual branch integrity:
*************
*************
*************
*************
*************
*************
*************
*************
*************
*************
*************
*************
*************

Testing Individual Branch Integrity

Testing Branch=AIR LOOP MAIN BRANCH
....passed
Testing Branch=COOLING DEMAND INLET
....passed
Testing Branch=COOLING COIL BRANCH
....passed
Testing Branch=DEMAND BYPASS BRANCH
....passed
Testing Branch=COOLING DEMAND OUTLET
....passed
Testing Branch=COOLING SUPPLY OUTLET
....passed

The addition of pressure simulation for branches in fluid loops brings a new output at the
branch level:
HVAC,Average,Plant Branch Pressure Difference [Pa]

Plant Branch Pressure Difference [Pa]

This field allows the user to output the pressure drop of a particular branch on a plant loop or
condenser loop. This output is only recognized if a valid pressure simulation is being
performed. To do this, the user must specify a pressure simulation type as an input in the
PlantLoop or CondenserLoop object.

9/29/14

525

Input-Output Reference

Group Node-Branch Management

ConnectorList
A connector list is a collection of either one or two connection devices (Connector:Mixer or
Connector:Splitter). Due to the definition of a loop in EnergyPlus, there is a maximum of one
mixer and one splitter allowed for each loop segment. This limitation still allows a tremendous
amount of flexibility to the user and can also still be solved within a reasonable amount of
time and without a complex solver routine. The connection list simply allows the specification
of the types and names of these devices. This allows the main loop statements to have the
flexibility to have multiple lists that can have one or more item.
Field: Name
This field is an identifying name that will be referenced to main loop statements using this
connector list. The name must be unique among connector list names.
Field-Set: Connection Object Type and Identifying Name (up to 2 allowed)
Depending on the loop, either one or two of the connectors will be specified. If this particular
loop only has a single connector (either Connector:Mixer or Connector:Splitter), then only the
first two items (type of connection and identifying name of connector) are included. If both a
mixer and splitter are present, the additional type of connection and identifying name must be
included. Note that the order that the items appear is inconsequentialeither the
Connector:Mixer or the Connector:Splitter may appear first. This will not affect the simulation.
Field: Connector 1 Object Type
This field contains the connector type Connector:Mixer or Connector:Splitter.
Field: Connector 1 Name
This field is an identifying name for the connector. It will be used by other objects in the input
file.
Field: Connector 2 Object Type (optional)
This field contains the connector type Connector:Mixer or Connector:Splitter.
Field: Connector 2 Name (optional)
This field is an identifying name for the connector. It will be used by other objects in the input
file.
An example of this statement in an IDF is:
ConnectorList LIST, Cooling Supply Side Connectors,
Connector:Splitter, CW Loop Splitter,
Connector:Mixer, CW Loop Mixer;

Connector List Outputs

No output directly related to Connector Lists is currently presented.
Pipe:Adiabatic
In reality, every component is connected to its closest neighbors via a pipe or a duct. At the
current time, such detail is not needed in EnergyPlus. Thus, the Pipe:Adiabatic component is
currently used more as a connection device (for branches that really do not have any
components associated with them) or as a bypass than anything else. As such, its input is
very simple and its algorithm is equally simple. The current algorithm for a pipe is simply to
pass the inlet conditions to the outlet of the pipe component.
Field: Name
This alpha field is used as an identifying field for the pipe.

9/29/14

526

Input-Output Reference

Group Node-Branch Management

Field: Inlet Node Name

This alpha field is used as an identifying field for the pipe inlet node.
Field: Outlet Node Name
This alpha field is used as an identifying field for the pipe outlet node.
An example of this statement in an IDF is:
Pipe:Adiabatic,
Demand Side Inlet Pipe,
CW Demand Inlet Node,
CW Demand Entrance Pipe Outlet Node;

Pipe Outputs
There are no outputs directly related to Pipes.
Pipe:Adiabatic:Steam
To connect the various components in a steam system regardless of it being the condensate
or the steam side of the loop steam pipe needs to be used. In reality, every component is
connected to its closest neighbors via a pipe or a duct. At the current time, such detail is not
needed in EnergyPlus. Thus, the Pipe:Adiabatic:Steam component is currently used more as
a connection device (for branches that really do not have any components associated with
them). As such, its input is very simple and its algorithm is equally simple. The current
algorithm for a pipe is simply to pass the inlet conditions to the outlet of the pipe component.
Field: Name
This alpha field is used as an identifying field for the steam pipe.
Field: Inlet Node Name
This alpha field is used as an identifying field for the steam pipe inlet node.
Field: Outlet Node Name
This alpha field is used as an identifying field for the steampipe outlet node.
An example of this statement in an IDF is:
Pipe:Adiabatic:Steam,
Steam Demand 1 Steam Inlet Pipe,
!- PipeName
Steam Demand 1 Steam Demand Inlet Node,
!- Inlet Node Name
Steam Demand 1 Steam Demand Entrance Pipe Outlet Node; !- Outlet Node Name

Steam Pipe Outputs

There are no outputs directly related to Steam Pipes.
Pipe:Indoor
This object specifies inputs which are used to simulate the heat transfer from a plant loop
pipe placed in a zone or when a user schedule is used to specify an environment.
The data definition for object is shown below.
Field: Name
This alpha field is used as an identifying field for the pipe.
Field: Construction Name
This alpha field references a 'wall' construction object that gives a layer-by-layer description
of the pipe wall and its insulation. The construction object follows standard conventions,

9/29/14

527

Input-Output Reference

Group Node-Branch Management

describing material properties for each layer beginning with the outermost insulation layer
and ending with the pipe wall layer.
Field: Fluid Inlet Node Name
This alpha field contains the name of the pipe fluid inlet node.
Field: Fluid Outlet Node Name
This alpha field contains the name of the pipe fluid outlet node.
Field: Environment Type
Environment type is the environment in which the pipe is placed. It can be either Zone or
Schedule. If specified as Zone, a zone name must be specified in the next field. If specified
as Schedule, the Ambient Temperature Zone can be left blank, while a schedule must be
specified for the temperature and air velocity.
Field: Ambient Temperature Zone Name
If Zone is specified as the environment type, this field is used to specify the name of the zone
in which the pipe is located. The zone temperature is used to calculate the heat transfer rate
from the pipe.
Field: Ambient Temperature Schedule Name
If Schedule is specified as the environment type, this field is used to specify the name of the
temperature schedule that gives the ambient air temperature surrounding the pipe. This
temperature is used as the outside boundary condition to calculate heat transfer from the
pipe.
Field: Ambient Air Velocity Schedule Name
If Schedule is specified as the environment type, this field is used to specify the name of the
velocity schedule that gives the air velocity near the pipe. This velocity is used to calculate
the convection heat transfer coefficient used in the pipe heat transfer calculation.
Field: Pipe Inside Diameter
This field is used to enter the inside diameter of the pipe in units of m. Pipe inside diameter
must be a positive number.
Field: Pipe Length
This field is used to enter the length of the pipe in units of m. Pipe length must be a positive
number.
An example of this object in an IDF is:
Pipe:Indoor,
Pipe Heat Transfer Towers,
Insulated Pipe,
Condenser Tower Outlet Node,
HTPipe Outlet Node,
Water,
Zone,
0.05,
100.0;

!!!!!!!!-

name of outside panel heat exchanger

Construction name
Comp1 Inlet Node Name
Comp1 Outlet Node Name
Fluid name
field Ambient Temperature Outside Air Node name
Pipe Inside Diameter (thickness in construction data)
pipe length

Pipe:Indoor Outputs
HVAC,Average, Pipe Fluid Heat Transfer Rate [W]
HVAC,Average, Pipe Ambient Heat Transfer Rate [W]
HVAC,SUM, Pipe Fluid Heat Transfer Energy [J]
HVAC,SUM, Pipe Ambient Heat Transfer Energy [J]
HVAC,Average, Pipe Mass Flow Rate [kg/s]
HVAC,Average, Pipe Inlet Temperature [C]
HVAC,Average, Pipe Outlet Temperature [C]
9/29/14

528

Input-Output Reference

Group Node-Branch Management

HVAC,Average, Pipe Volume Flow Rate [m3/s]

Pipe Fluid Heat Transfer Rate [W]

The output provides the total amount of heat loss/gain in the fluid from pipe inlet to outlet.
Pipe Ambient Heat Transfer Rate [W]
The output provides the amount of heat loss/gain from pipe wall to the environment.
Pipe Fluid Heat Transfer Energy [J]
Total energy fluid has lost/gained between pipe inlet and outlet. It is metered on
EnergyTransfer with an end use of Pipes.
Pipe Ambient Heat Transfer Energy [J]
Total energy lost from the external pipe surface.
Pipe Mass Flow Rate [kg/s]
Mass flow rate of the fluid in the pipe.
Pipe Inlet Temperature [C]
Pipe Outlet Temperature [C]
Temperature of fluid at entering and exiting of pipe.
Pipe Volume Flow Rate [m3/s]
Fluid volumetric flow rate, (mass flow rate / density)
Pipe:Outdoor
This object specifies inputs which are used to simulate the heat transfer from a plant loop
pipe placed in an outdoor environment.
Field: Name
This alpha field is used as an identifying field for the pipe.
Field: Construction Name
This alpha field references a 'wall' construction object that gives a layer-by-layer description
of the pipe wall and its insulation. The construction object follows standard conventions,
describing material properties for each layer beginning with the outermost insulation layer
and ending with the pipe wall layer.
Field: Fluid Inlet Node Name
This alpha field contains the name of the pipe fluid inlet node.
Field: Fluid Outlet Node Name
This alpha field contains the name of the pipe fluid outlet node.
Field: Ambient Temperature Outside Air Node Name
Ambient temperature outdoor air node is a node representing outdoor air with which pipe
transfers heat. The node should be included in an outdoor air node list.
Field: Pipe Inside Diameter
This field is used to enter the inside diameter of the pipe in units of m. Pipe inside diameter
must be a positive quantity.

9/29/14

529

Input-Output Reference

Group Node-Branch Management

Field: Pipe Length

This field is used to enter the length of the pipe in units of m. Pipe length must be a positive
quantity.
An example of this statement in an IDF is:
Pipe:Outdoor,
Pipe Heat Transfer Towers,
!- name of outside panel heat exchanger
Insulated Pipe,
!- Construction name
Condenser Tower Outlet Node,
!- Comp1 Inlet Node Name
HTPipe Outlet Node,
!- Comp1 Outlet Node Name
Water,
!- Fluid name
PipeHeatTransfer Inlet Node,
!- field Ambient Temperature Outside Air Node name
0.05,
!- Pipe Inside Diameter (thickness given in construction data)
100.0;
!- pipe length

Pipe:Outdoor Outputs
HVAC,Average, Pipe Fluid Heat Transfer Rate [W]
HVAC,SUM, Pipe Fluid Heat Transfer Energy [J]
HVAC,Average, Pipe Mass Flow Rate [kg/s]
HVAC,Average, Pipe Inlet Temperature [T]
HVAC,Average, Pipe Outlet Temperature [T]
HVAC,Average, Pipe Volume Flow Rate [m3/s]

Pipe Fluid Heat Transfer Rate [W]

The output provides the total amount of heat loss/gain in the fluid from pipe inlet to outlet.
Pipe Fluid Heat Transfer Energy [J]
Total energy fluid has lost/gained between pipe inlet and outlet. It is metered on
EnergyTransfer with an end use of Pipes.
Pipe Mass Flow Rate [kg/s]
Mass flow rate of the fluid in the pipe.
Pipe Inlet Temperature [C]
Pipe Outlet Temperature [C]
Temperature of fluid at entering and exiting of pipe.
Pipe Volume Flow Rate [m3/s]
Fluid volumetric flow rate, (mass flow rate / density)
Pipe:Underground
This object specifies inputs which are used to simulate the heat transfer from a plant loop
pipe placed underground.
Field: Name
This alpha field is used as an identifying field for the pipe.
Field: Construction Name
This alpha field references a basic construction object that gives a layer-by-layer description
of the pipe wall and insulation. The construction object follows standard conventions,
describing material properties for each layer beginning with the outermost layer, the
insulation, if it exists, and ending with the pipe wall layer. The construction object may have
either one or two layers. If only one, then the material must be the pipe wall. If two, then
insulation is utilized.

9/29/14

530

Input-Output Reference

Group Node-Branch Management

Field: Fluid Inlet Node Name

This alpha field contains the name of the pipe fluid inlet node.
Field: Fluid Outlet Node Name
This alpha field contains the name of the pipe fluid outlet node.
Field: Sun Exposure
This alpha field allows the user to specify one of two options: NoSun or SunExposed. For
SunExposed, the simulation includes diffuse and beam solar effects on the ground surface.
For NoSun, no solar effects are included.
Field: Pipe Inside Diameter
This field is used to enter the inside diameter of the pipe in units of m. Pipe inside diameter
must be a positive quantity.
Field: Pipe Length
This field is used to enter the length of the pipe in units of {m}. Pipe length must be a positive
quantity.
Field: Soil Material Name
This references a Material object that contains the soil properties and thickness. Note that
when defining the soil layer, the thickness should be the thickness of soil between the pipe
wall and the ground surface.
Field: Average Soil Surface Temperature
If a GroundTemperatures:Surface object is not given in the input, this is #1 of 3 inputs that
must be given directly. This represents the annual average soil temperature above the pipe.
This field can be calculated in advance using the separate CalcSoilSurfTemp program.
Field: Amplitude of Soil Surface Temperature
If a GroundTemperatures:Surface object is not given in the input, this is #2 of 3 inputs that
must be given directly. This represents the annual average soil temperature variation from
the average temperature itself. For example, if this were represented as a sine wave, this
would simply be the amplitude of the curve. This field can be calculated in advance using the
separate CalcSoilSurfTemp program.
Field: Phase Constant of Soil Surface Temperature
If a GroundTemperatures:Surface object is not given in the input, this is #3 of 3 inputs that
must be given directly. This represents the time elapsed from the beginning of the year to the
date of minimum surface temperature. For example, if this were represented as a sine wave,
this would simply be the phase shift of the curve. This field can be calculated in advance
using the separate CalcSoilSurfTemp program
In order to avoid having to run the preprocessor program to generate soil temperature, the
user may choose to simply input a GroundTemperatures:Surface object. This object inputs
average monthly surface temperatures. These temperatures are then used within the model
to develop average ground surface data. This ground surface data can then be used as part
of the model boundary condition set. Without a set of surface ground temperatures, the
model will require user input of the three last input fields.
An example of this object in an IDF is:

9/29/14

531

Input-Output Reference
Pipe:Underground,
Pipe Heat Transfer Towers,
Insulated Buried Pipe,
Condenser Tower Outlet Node,
HTPipe Outlet Node,
Water,
SunExposed,
0.05,
20.0,
Buried Pipe Soil,
13,
1.5,
30;

Group Node-Branch Management

!!!!!!!!!!!!-

Name of Pipe
Construction Name
Inlet Node Name
Outlet Node Name
Fluid Name
Sun Exposure
Pipe Inside Diameter
pipe Length
Soil Material
Average Soil Surface Temperature
Amplitude of Soil Surface Temperature
Phase Constant of Soil Surface Temperature

Construction,
Insulated Buried Pipe,
Buried Pipe Insulation,
Buried Pipe Steel;

!- Name
!- Layer #1
!- Layer #2

Material,
Buried Pipe Soil,
Smooth,
1.5,
0.36,
2000.0,
1200.0,
0.9,
0.5,
0.5;

!!!!!!!!!-

Name
Roughness
Thickness {m}
Conductivity {W/m-K}
Density {kg/m3}
Specific Heat {J/kg-K}
Thermal Absorptance
Solar Absorptance
Visible Absorptance

Pipe:Underground Outputs
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,

Average, Pipe Fluid Heat Transfer Rate [W]

SUM, Pipe Fluid Heat Transfer Energy [J]
Average, Pipe Mass Flow Rate [kg/s]
Average, Pipe Volume Flow Rate [m3/s]
Average, Pipe Inlet Temperature [C]
Average, Pipe Outlet Temperature [C]

Pipe Fluid Heat Transfer Rate [W]

The output provides the total amount of heat loss/gain in the fluid from pipe inlet to outlet.
Pipe Fluid Heat Transfer Energy [J]
Total energy fluid has lost/gained between pipe inlet and outlet. It is metered on
EnergyTransfer with an end use of Pipes.
Pipe Mass Flow Rate [kg/s]
Mass flow rate of the fluid in the pipe.
Pipe Volume Flow Rate [m3/s]
Fluid volumetric flow rate, (mass flow rate / density)
Pipe Inlet Temperature [C]
Pipe Outlet Temperature [C]
Temperature of fluid at entrance and exit of pipe.
PipingSystem:Underground Class Objects
Objects in this class are used to simulate the heat transfer processes of a piping system
placed underground, which may or may not be in contact with a number of zone surfaces.
There are three related objects, all of which are prefixed with PipingSystem:Underground :
9/29/14

532

Input-Output Reference

Group Node-Branch Management

PipingSystem:Underground:Domain
PipingSystem:Underground:PipeCircuit
PipingSystem:Underground:PipeSegment
PipingSystem:Underground:Domain
This section documents the domain object, which is used to specify information for the overall
ground domain, including thermal properties, mesh parameters, and surface interaction.
Field: Name
This alpha field is used as an identifying field for the ground domain.
Field: XMax, YMax, ZMax
These numeric fields are used to specify the overall domain size, in each of the three
Cartesian dimensions. The domain will be meshed from {x, y, z} = {0, 0, 0} to {Xmax, Ymax,
Zmax}.
Note that for this object, the x-z plane lies parallel to the ground surface, such that the ydimension can be thought of as representing the burial depth. This is in contrast to the way
building surface coordinates are defined with the x-y plane lying parallel to the ground. Also
note that any pipe segments that end up being used in a ground domain will be placed axially
in the z-dimension. Thus, pipe flow will always be in either the positive z or negative z
direction.
Field: X-Direction Mesh Density Parameter
This numeric integer field represents the number of cells to be placed between any two
domain partitions during mesh development. A domain partition may be thought of as a
basement wall/floor, or a pipe. Once these components are laid out in the domain, this field
number of cells are placed between the partitions. Further information on this is found in the
engineering reference manual.
Field: X-Direction Mesh Type
This alpha field represents the type of mesh to create when placing cells between domain
partitions. Two options are available: uniform and symmetricgeometric. For uniform, the
cells are placed in the region with all cells having equal size. For symmetric-geometric, the
cells are compressed toward the partitions so that there are more cells on either side of the
mesh region. This can help focus computational intensity on the boundary areas where it is
likely more desired. For symmetric-geometric mesh distribution, the mesh density parameter
should be an even number to provide the symmetric condition.
Field: X-Direction Geometric Coefficient
This numeric field represents the compression of cell distribution if the x-direction mesh type
is set to symmetricgeometric. If the mesh type is uniform, this field is not interpreted. For
symmetric geometric, a value in this field equal to 1 would result in a uniform distribution,
while a value of 2 would provide a highly skewed distribution.
Field: Y-Direction Mesh Density Parameter
See Field: X-Direction Mesh Density Parameter.
Field: Y-Direction Mesh Type
See Field: X-Direction Mesh Type.
Field: Y-Direction Geometric Coefficient
See Field: X-Direction Geometric Coefficient.

9/29/14

533

Input-Output Reference

Group Node-Branch Management

Field: Z-Direction Mesh Density Parameter

See Field: X-Direction Mesh Density Parameter.
Field: Z-Direction Mesh Type
See Field: X-Direction Mesh Type.
Field: Z-Direction Geometric Coefficient
See Field: X-Direction Geometric Coefficient.
Field: Soil Thermal Conductivity
The thermal conductivity of the soil, in W/m-K.
Field: Soil Density
The bulk density of the soil, in kg/m3.
Field: Soil Specific Heat
The specific heat of dry soil, in J/kg-K. If moisture is defined in this object, moisture and
freezing effects are accounted for by varying the specific heat value.
Field: Soil Moisture Content Volume Fraction
A nominal value of soil moisture content to be used when evaluating soil thermal properties.
Field: Soil Moisture Content Volume Fraction at Saturation
A nominal value of soil moisture content when the soil is saturated, this is used in evaluating
thermal properties of freezing soil
Field: Kusuda-Achenbach Average Surface Temperature
The annual average surface temperature to be applied to the Kusuda-Achenbach farfield
boundary temperature correlation.
Field: Kusuda-Achenbach Average Amplitude of Surface Temperature
The annual average surface temperature variation from average. This is also used in the
Kusuda-Achenbach temperature correlation.
Field: Kusuda-Achenbach Phase Shift of Minimum Surface Temperature
The phase shift of minimum surface temperature, or the day of the year when the minimum
surface temperature occurs.
Field: This Domain Includes Basement Surface Interaction
A yes/no field stating whether zone surfaces should be coupled to this domain.
Field: Width of Basement Floor in Ground Domain
If this domain does include basement interaction, this represents the width of the domain
cutaway to include the basement. In essence, this is the width of basement floor to include in
the ground simulation. This width should include the basement wall thickness.
Field: Width of Basement Floor in Ground Domain
If this domain does include basement interaction, this represents the depth of the domain
cutaway to include the basement. In essence, this is the burial depth of the basement to
include in the ground simulation. This depth should include the basement floor thickness.
Field: Shift Pipe X Coordinates By Basement Width
If this domain does include basement interaction, this flag specifies whether the pipe segment
X-values should then be shifted by the basement width. In essence, this specifies the
9/29/14

534

Input-Output Reference

Group Node-Branch Management

reference point for pipe segment x-values: if NO then the reference is domain x=0, if YES
then the reference is the basement width point.
Field: Name of Basement Wall Boundary Condition Model
The name of an OtherSideConditions model defined in the input file and referenced by the
surfaces which should be included as wall surfaces for the basement interaction part of the
ground heat transfer model.
Field: Name of Basement Wall Boundary Condition Model
The name of an OtherSideConditions model defined in the input file and referenced by the
surfaces which should be included as floor surfaces for the basement interaction part of the
ground heat transfer model.
Field: Convergence Criterion for the Outer Cartesian Domain Iteration Loop
The maximum temperature deviation within any cell between one iteration and another to
decide that the Cartesian domain has converged to within tolerance. A smaller value will
improve accuracy and computation time. A smaller value should be accompanied by a
higher number of iterations if maximum accuracy is desired.
Field: Maximum Iterations in the Outer Cartesian Domain Iteration Loop
The maximum number of iterations to make when performing temperature updates of the
Cartesian coordinate system. The actual number of iterations made will of course depend on
transient conditions and convergence tolerance.
Field: Number of Pipe Circuits Entered for this Domain
The number of pipe circuit objects which will be defined in the following fields.
Field: Pipe Circuit 1 { to N; extensible}
A PipingSystem:Underground:PipeCircuit to be included in this domain. This indicates that
the pipe circuit and all of the underlying pipe segments will be included during mesh
development and heat transfer calculations within this domain. Any number of pipe circuits
can be added, assuming all underlying pipe segments do not cause any conflicts for the
mesh development engine (overlapping pipes, etc.).
PipingSystem:Underground:PipeCircuit
This section documents the pipe circuit object, which is used to specify information for the
plant loop topology, such as inlet and outlet connections. This object also groups together
pipe segments to define flow paths within a given pipe circuit.
Field: Name
This alpha field is used as an identifying field for the pipe circuit.
Field: Pipe Thermal Conductivity
The thermal conductivity of the pipe, in W/m-K.
Field: Pipe Density
The bulk density of the pipe, in kg/m3.
Field: Pipe Specific Heat
The specific heat of the pipe, in J/kg-K.
Field: Pipe Inner Diameter
The inner diameter of the pipe, in m.

9/29/14

535

Input-Output Reference

Group Node-Branch Management

Field: Pipe Outer Diameter

The outer diameter of the pipe, in m.
Field: Design Flow Rate
The design flow in this pipe circuit, in m3/s. This is the flow which this component will
request during the simulation. Of course, other components and overall plant management
will decide the flow actually given to this component.
Field: Circuit Inlet Node Name
The inlet node name for this circuit, which is used when placing this circuit on a branch on a
plant or condenser loop.
Field: Circuit Outlet Node Name
The outlet node name for this circuit, which is used when placing this circuit on a branch on a
plant or condenser loop.
Field: Convergence Criterion for the Inner Radial Iteration Loop
The maximum temperature deviation within any cell between one iteration and another to
decide that the radial domain has converged to within tolerance. A smaller value will improve
accuracy and computation time. A smaller value should be accompanied by a higher number
of iterations if maximum accuracy is desired.
Field: Maximum Iterations in the Inner Radial Iteration Loop
The maximum number of iterations to make when performing temperature updates of the
radial coordinate system. The actual number of iterations made will of course depend on
transient conditions and convergence tolerance.
Field: Number of Soil Nodes in the Inner Radial Near Pipe Mesh Region
The number of soil nodes to discretize pipe cells. More information on mesh development is
provided in the engineering reference manual.
Field: Radial Thickness of Inner Radial Near Pipe Mesh Region
The radial distance used to discretize pipe cells. More information on mesh development is
provided in the engineering reference manual.
Field: Number of Pipe Segments Entered for this Pipe Circuit
The number of pipe segment objects which will be defined in the following fields.
Field: Pipe Segment 1 { to N; extensible}
A PipingSystem:Underground:PipeSegment to be included in this pipe circuit. The circuit is
set up so that flow passes through the N segments in the order they are entered here.
PipingSystem:Underground:PipeSegment
This section documents the pipe segment object, which is used to specify information for a
single pipe segment placed at some x, y coordinate in the ground. The flow direction is also
defined in this object to allow for careful description of varying flow paths. This can be useful
for accounting for short circuiting effects if two pipes are placed in counterflow vs. parallel
flow.
Field: Name
This alpha field is used as an identifying field for the pipe segment.

9/29/14

536

Input-Output Reference

Group Node-Branch Management

Field: X Position
This numeric field represents the x-direction placement of the pipe. If no basement is
included in the simulation, this is measured from x=0. If a basement is included, and the
domain object specifies that pipes should be shifted, this is measured from the basement
wall.
Field: Y Position
This numeric field represents the burial depth of the pipe, measured from the ground surface.
This will always be a positive number.
Field: Flow Direction
This alpha field is used to define the flow direction within this pipe segment. The choices are
increasing or decreasing. These can be chosen carefully to encapsulate specific shortcircuiting effects due to varying flow configurations (circuiting).
An example of this object in an IDF is offered here for a foundation heat exchanger
PipingSystem:Underground:Domain,
My Piping System,
!- Name
12,
!- Xmax
4.5,
!- Ymax
36.84,
!- Zmax
2,
!- XMeshCount
Uniform,
!- XMeshType
,
!- XGeometricCoeff
2,
!- YMeshCount
Uniform,
!- YMeshType
,
!- YGeometricCoeff
6,
!- ZMeshCount
Uniform,
!- ZMeshType
,
!- ZGeometricCoeff
1.08,
!- GroundThermalConductivity
962,
!- GroundDensity
2576,
!- GroundSpecificHeat
30,
!- MoistureContent
50,
!- MoistureContentAtSaturation
15.5,
!- KusudaGroundTemp
12.8,
!- KusudaGroundTempAmplitude
17.3,
!- KusudaPhaseShift
Yes,
!- DomainHasBasement
6,
!- BasementWidthInDomain
2.5,
!- BasementDepthInDomain
Yes,
!- ShiftPipeXValuesByBasementWidth
BasementWallOSCM,
!- BasementWallBoundaryConditionModel
BasementFloorOSCM,
!- BasementFloorBoundaryConditionModel
0.005,
!- CartesianIterationConvergenceCriterion
100,
!- CartesianMaxIterations
0.408,
!- EvapotranspirationGroundCoverParameter
1,
!- NumPipeCircuits
My Pipe Circuit;
!- PipeCircuit
PipingSystem:Underground:PipeCircuit,
My Pipe Circuit,
!- Name
0.3895,
!- PipeThermalConductivity
641,
!- PipeDensity
2405,
!- PipeSpecificHeat
0.016,
!- PipeInnerDiameter
0.02667,
!- PipeOuterDiameter
0.004,
!- DesignFlowRate
Piping System Inlet Node, !- InletNode
Piping System Outlet Node, !- OutletNode
0.001,
!- RadialIterationConvergenceCriterion
9/29/14

537

Input-Output Reference
100,
2,
0.03,
6,
Segment
Segment
Segment
Segment
Segment
Segment

Group Node-Branch Management

!!!!!!!!!!-

1,
2,
3,
4,
5,
6;

RadialMaxIterations
RadialMeshCount
RadialMeshThickness
NumSegments
Segment1
Segment2
Segment3
Segment4
Segment5
Segment6

PipingSystem:Underground:PipeSegment,
Segment 1,
!- Name
0.67,
!- X
2.20,
!- Burial Depth
IncreasingZ;
!- Flow Direction
PipingSystem:Underground:PipeSegment,
Segment 2,
!- Name
0.95,
!- X
2.20,
!- Burial Depth
IncreasingZ;
!- Flow Direction
PipingSystem:Underground:PipeSegment,
Segment 3,
!- Name
1.23,
!- X
2.20,
!- Burial Depth
IncreasingZ;
!- Flow Direction
PipingSystem:Underground:PipeSegment,
Segment 4,
!- Name
1.40,
!- X
1.94,
!- Burial Depth
DecreasingZ;
!- Flow Direction
PipingSystem:Underground:PipeSegment,
Segment 5,
!- Name
1.40,
!- X
1.66,
!- Burial Depth
DecreasingZ;
!- Flow Direction
PipingSystem:Underground:PipeSegment,
Segment 6,
!- Name
1.40,
!- X
1.39,
!- Burial Depth
DecreasingZ;
!- Flow Direction

PipingSystem:Underground Outputs
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,

Average,
Average,
Average,
Average,
Average,
Average,
Average,

Pipe
Pipe
Pipe
Pipe
Pipe
Pipe
Pipe

Circuit
Circuit
Circuit
Segment
Segment
Circuit
Segment

Mass Flow Rate [kg/s]

Inlet Temperature [C]
Outlet Temperature [C]
Inlet Temperature [C]
Outlet Temperature [C]
Fluid Heat Transfer Rate [W]
Fluid Heat Transfer Rate [W]

Pipe Circuit Mass Flow Rate [kg/s]

The output provides the mass flow rate currently being sent through the pipe circuit.

9/29/14

538

Input-Output Reference

Group Plant-Condenser Loops

Pipe Circuit Inlet Temperature [C]

Pipe Circuit Outlet Temperature [C]
Temperature of fluid at the inlet and outlet of a given pipe circuit.
Pipe Segment Inlet Temperature [C]
Pipe Segment Outlet Temperature [C]
Temperature of fluid at the inlet and outlet of a given pipe segment.
Pipe Circuit Fluid Heat Transfer Rate [W]
This is the fluid heat gain or loss in the pipe circuit, in Watts.
Pipe Segment Fluid Heat Transfer Rate [W]
This is the fluid heat gain or loss in the pipe segment, in Watts.
Duct
The Duct object is a component for air systems that is a direct analogue for Pipe:Adiabatic in
the fluid loops. It is used when it is necessary (due to the HVAC system configuration) to
have a branch that has no functional components. This case most often arises for a bypass
branch. Since every branch must have at least one component, the Duct component is used
for this situation. The duct is an adiabatic, pass-through component; all of its inlet conditions
are passed through unchanged to its outlet.
Field: Name
This is the unique name for this component. Any reference to this component (in a
BranchList, for instance) will refer to it by this name.
Field: Inlet Node Name
The name of the components air inlet node.
Field: Outlet Node Name
The name of the components air outlet node.
Below is an example input for Duct.
DUCT,
VAV Sys 1 Bypass Duct,
!- Name
VAV Sys 1 Bypass Duct Inlet Node, !- Inlet Node Name
VAV Sys 1 Bypass Duct Outlet Node;!- Outlet Node Name

Duct Outputs
There are no outputs for Duct.

Group Plant-Condenser Loops

PlantLoop
The main elements of the PlantLoop syntax are described in further detail below. A map of
how the input for this portion of the HVAC input fits together is provided in the following
diagram.

9/29/14

539

Input-Output Reference

Group Plant-Condenser Loops

Figure 73. Plant Loop Input Syntax Map

Field: Name
This alpha field is used as an identifying field for the plant loop.
Field: Fluid Type
This alpha field must be a keyword selected from the list of available fluids for an EnergyPlus
plant loop. Either Water, Steam or UserDefinedFluidType may be used. If the
UserDefinedFluidType keyword is used, the following input field i.e. User Defined Fluid Type
must have a value (namely the name of a FluidProperties:GlycolConcentration object).
Field: User Defined Fluid Type
This alpha field must be specified when the previous field is set to UserDefinedFluidType
otherwise it could be left blank. Water, EthyleneGlycol, PropoleneGlycol and Steam are all
built-in fluids for EnergyPlus (that is, all of the appropriate properties are contained within
the program). If the fluid specified here is a mixture of water and ethylene or propylene glycol,
then only FluidProperties:GlycolConcentration objects need to be specified and the name of
the appropriate one is used here. For another water/glycol mixture, a complete set of fluid
property data (FluidProperties:Name and FluidProperties:Temperature objects plus multiple
FluidProperties:Concentration objects for specific heat, density, etc.) must be specified (Ref
dataset: GlycolPropertiesRefData.idf).
Field: Plant Equipment Operation Scheme Name
This alpha field is used as an identifying field for the plant operation scheme. This field ties to
the PlantEquipmentOperationSchemes input structure, which must also be defined.
Field: Loop Temperature Setpoint Node Name
This alpha field is used to identify the node which the Loop Manager will access the
temperature setpoint that it will try to maintain. This is typically the Plant Loop Supply Side

9/29/14

540

Input-Output Reference

Group Plant-Condenser Loops

Outlet Node so that it will not interfere with component temperature setpoints. An associated
temperature setpoint manager will need to be defined.
Field: Maximum Loop Temperature
This numeric field contains the maximum allowable temperature in Celsius for this loop.
Field: Minimum Loop Temperature
This numeric field contains the minimum allowable temperature in Celsius for this loop.
Field: Maximum Loop Flow Rate
This numeric field contains the maximum loop flow rate in cubic meters per second. This
parameter is also used when the user chooses to autocalculate the loop volume. See Volume
of the Plant Loop below and the Engineering Manual for more details. This field is
autosizable.
Field: Minimum Loop Flow Rate
This numeric field contains the minimum loop flow rate in cubic meters per second.
Field: Plant Loop Volume
Volume of the plant loop in m 3. This numeric field contains the loop volume for the entire loop,
i.e. both the demand side and the supply side. This is used for the loop capacitance
calculation.. Loop volume (m3) could be calculated from pipe size data but this is not usually
known. If zero volume is specified the loop has no fluid heat capacity. If a very large
capacitance is specified unrealistic time delay may result and there may be poor response to
changes in loop setpoint temperature. The loop capacitance autocalculate option gives
reasonable values for most system sizes. This calculation is described in the Engineering
Reference manual.
Field: Plant Side Inlet Node Name
This required alpha field contains the identifying name given to the Plant Side Inlet Node.
This node is the inlet to the supply side of the loop.
Field: Plant Side Outlet Node Name
This required alpha field contains the identifying name given to the Plant Side Outlet Node.
This node is the outlet of the supply side of the loop.
Field: Plant Side Branch List Name
This required alpha field contains the identifying name given to the Plant Side Branch List.
The list referenced here should list all the branches on the supply side of the loop.
Field: Plant Side Connector List Name
This alpha field contains the identifying name given to the Plant Side Connector List. The list
referenced here should list the splitter and mixer on the supply side of the loop.
Field: Demand Side Inlet Node Name
This required alpha field contains the identifying name given to the Demand Side Inlet Node.
This node is the inlet to the demand side of the loop.
Field: Demand Side Outlet Node Name
This required alpha field contains the identifying name given to the Demand Side Outlet
Node. This node is the outlet of the demand side of the loop.
Field: Demand Side Branch List Name
This required alpha field contains the identifying name given to the Demand Side Branch List.
The list referenced here should list all the branches on the demand side of the loop.
9/29/14

541

Input-Output Reference

Group Plant-Condenser Loops

Field: Demand Side Connector List Name

This alpha field contains the identifying name given to the Demand Side Connector List. The
list referenced here should list the splitter and mixer on the demand side of the loop.
Field: Load Distribution Scheme
This alpha field contains the Load Distribution Scheme Keyword. The Load Distribution
Scheme selects the algorithm used to sequence equipment operation in order to meet the
plant loop demand. Currently, five schemes are functional. Optimal operates each piece of
equipment at its optimal part load ratio and will operate the last component between its
minimum and maximum part load ratio in order to meet the loop demand. SequentialLoad
loads each piece of equipment sequentially in the order specified in the PlantEquipmentList
to its maximum part load ratio and will operate the last required piece of equipment between
its minimum and maximum part load ratio in order to meet the loop demand. UniformLoad
evenly distributes the loop demand among all available components on the equipment list for
a given load range. SequentialUniformPLR loads all equipment on the PlantEquipmentList
to a uniform part load ratio (PLR). Components are loaded sequentially based on the order
specified in the PlantEquipmentList until each component is fully loaded, at which point the
next subsequent component is added and the load is distributed uniformly based on PLR
between the components. UniformPLR will load all equipment on the PlantEquipmentList to
a uniform part load ratio (PLR). No equipment will be loaded below its minimum PLR. If the
total load is less than the sum of all equipment on the PlantEquipmentList operating at their
respective minimum PLRs, then the last item in the equipment list is dropped and the load is
distributed based on a uniform PLR for the remaining plant equipment.
Note: For all schemes, if the load for any individual component is less than the component
load at the minimum PLR, the individual component model will false load or reduce duty cycle
while operating at the minimum part load ratio until the load is met.
Field: Availability Manager List Name
This alpha field contains the identifying name given to the System Availability Manager List.
Field: Plant Loop Demand Calculation Scheme
There are two plant loop demand calculations schemes in EnergyPlus. There is a
SingleSetpoint and a DualSetpointDeadband; the SingleSetpoint is the default if this field is
left blank. In the SingleSetpoint scheme the Plant Loop requires that a Setpoint Manager set
a single setpoint value (on Node%TempSetpoint). Examples of this setpoint manager would
be:
SetpointManager:Scheduled,
SetpointManager:OutsideAir,
etc.
For
the
DualSetPointDeadband scheme the Plant Loop requires that a Setpoint Manager set the high
and low setpoint values (for Node%TempSetPointHi and Node%TempSetPointLo). Examples
of this Setpoint manager would be: SetpointManager:Scheduled:DualSetpoint.
The plant loop demand calculation scheme determines the amount of heating or cooling
necessary to bring the temperature of the Plant Loop to its setpoint(s). When this value is
determined then the load distribution scheme explained in the previous section takes this
value and distributes the load to the appropriate equipment. The demand calculation scheme
determines how the load is calculated. See more information in the Engineering Document.
Field: Common Pipe Simulation
This field specifies a primary-secondary plant loop simulation. When a common pipe option is
specified, the plant side of the loop is the primary loop and the demand side of the loop is the
secondary loop, and a pump object must be placed on the demand side inlet branch. The
three options are None, CommonPipe and TwoWayCommonPipe. None means that
there is no secondary loop and the plant loop is modeled as a single primary loop.
CommonPipe means that the common pipe interface does not attempt any temperature
control, it only satisfies secondary (demand side) flow requests. TwoWayCommonPipe
allows control of the secondary (demand side) inlet temperature or the primary (plant side)
9/29/14

542

Input-Output Reference

Group Plant-Condenser Loops

inlet temperature by placing a setpoint on the corresponding node. If this field is left blank, it
will default to None. If the field is set to None and the program finds a pump on the
demand side it will result in a fatal error. If the field is set to CommonPipe or
TwoWayCommonPipe and the program does not find a pump on the demand side it will
result in a fatal error. The common pipe simulation is currently limited to simulating loop
pumps, i.e. each pump should be placed on the inlet branch of the plant side or demand side
of the loop.
Field: Pressure Simulation Type
This field lets user to choose if this plant loop will be involved in a pressure drop calculation.
This requires that at least one branch on the loop have pressure drop data. If not, an error
will be thrown due to the input mismatch. Currently there are two pressure drop simulation
types: PumpPowerCorrection and LoopFlowCorrection. In both of these methods, branch
pressure drop data is used to calculate a dynamic loop pressure drop and is used to update
pumping power accordingly. The flow correction method allows the user to enter information
regarding the pressure curve of a constant speed pump so that the simulation can
dynamically resolve the pressure vs. flow relationship in the plant loop. This is limited to
constant speed pumps, as the variable speed pumps are expected to resolve as if it were
controlled by a variable drive, so that they can inherently meet any pressure and flow
demand required by the loop. This is also limited to loop pumps, where there is a single
pump on the plant loop. Common pipe simulations and branch pump simulations are not
compatible with this level of pressure simulation.
See the documentation for the
Pump:ConstantSpeed in order to determine required inputs for this pressure simulation
method to be performed. In the pressure drop system, parallel flow rates are not resolved (to
match the pressure drop for the parallel system). Enhancements to this calculation are
planned which will allow parallel branch flow resolution. See the Engineering Reference
document for more information on how this works.
An example of this statement used in an IDF is:
PlantLoop,
Hot Water Loop,
!- Plant Loop Name
Water,
!- Fluid Type
,
!- User Defined Fluid Type
Hot Loop Operation,
!- Plant Operation Scheme List Name
HW Loop Outlet Node,
!- Loop Temperature Setpoint Schedule Name
100,
!- Maximum Loop Temperature {C}
10,
!- Minimum Loop Temperature {C}
autosize,
!- Maximum Loop Volumetric Flow Rate {m3/s}
0.0,
!- Minimum Loop Volumetric Flow Rate {m3/s}
autosize,
!- volume of the plant loop {m3}
HW Supply Inlet Node,
!- Plant Side Inlet Node Name
HW Supply Outlet Node, !- Plant Side Outlet Node Name
Heating Supply Side Branches,
!- Plant Side Branch List Name
Heating Supply Side Connectors, !- Plant Side Connector List Name
HW Demand Inlet Node,
!- Demand Side Inlet Node Name
HW Demand Outlet Node, !- Demand Side Outlet Nodes Name
Heating Demand Side Branches,
!- Demand Side Branch List Name
Heating Demand Side Connectors, !- Demand Side Connector List Name
Optimal;
!- Load Distribution Scheme

In the above example input there is no system availability manager specified and the
Demand Calculation Scheme will default to SingleSetpoint using a single setpoint manager.
Common pipe simulation field in the above example will default to NONE since it is not
specified.
Plant Loop Outputs
In the following output variables, Debug denotes variables that are used primarily by the
developers and whose names and application may be cryptic to users. .

9/29/14

543

Input-Output Reference

Group Plant-Condenser Loops

HVAC,Average,Plant Supply Side Cooling Demand Rate [W]

HVAC,Average,Plant Supply Side Heating Demand Rate [W]
HVAC,Average,Plant Supply Side Inlet Mass Flow Rate [kg/s]
HVAC,Average,Plant Supply Side Inlet Temperature [C]
HVAC,Average,Plant Supply Side Outlet Temperature [C]
HVAC,Average,Plant Supply Side Not Distributed Demand Rate [W]
HVAC,Average,Plant Supply Side Unmet Demand Rate [W]
HVAC,Sum,Plant Solver Sub Iteration Count []
HVAC,Sum,Plant Solver Half Loop Calls Count []
HVAC,Average,Debug Plant Loop Bypass Fraction
HVAC,Average,Debug Plant Last Simulated Loop Side [-]
HVAC,Average,Plant Common Pipe Mass Flow Rate [Kg/s]
HVAC,Average,Plant Common Pipe Temperature [C]
HVAC,Average,Plant Common Pipe Flow Direction Status []
HVAC,Average,Plant Common Pipe Primary Mass Flow Rate [Kg/s]
HVAC,Average,Plant Common Pipe Secondary Mass Flow Rate [Kg/s]
HVAC,Average,Primary Side Common Pipe Flow Direction []
HVAC,Average,Secondary Side Common Pipe Flow Direction []
HVAC,Average,Plant Common Pipe Primary to Secondary Mass Flow Rate [Kg/s]
HVAC,Average,Plant Common Pipe Secondary to Primary Mass Flow Rate [Kg/s]
HVAC,Average,Plant System Cycle On Off Status []
HVAC,Average,Plant Demand Side Loop Pressure Difference [Pa]
HVAC,Average,Plant Supply Side Loop Pressure Difference [Pa]
HVAC,Average,Plant Loop Pressure Difference [Pa]

Plant Supply Side Cooling Demand Rate [W]

This is the value of the net demand required to meet the cooling setpoint of the loop. If the
loop setpoint is met for the current HVAC timestep, Plant Supply Side Cooling Demand Rate
will equal sum of the total cooling demand from the demand side coils on the loop. It will also
equal the cooling output of all chillers (or other cooling equipment) on the loop less any pump
heat added to the fluid. For example, for a chilled water loop with one chiller and one pump
serving one chilled water coil: Plant Supply Side Cooling Demand Rate will equal the chiller
evaporator heat transfer less the pump heat to fluid, and it will also equal the chilled water
coil total cooling output.
If the plant loop setpoint is not met, Plant Supply Side Cooling Demand Rate will equal the
sum of the total cooling demand from the demand side coils on the loop plus the additional
cooling required to bring the loop flow to setpoint. If the loop remains off setpoint for
successive timesteps, the demand required to return to setpoint will repeat in each timestep
until the loop reaches setpoint. For this reason, Plant Supply Side Cooling Demand Rate
should not be summed over time, because it will overstate the demand whenever the loop is
off setpoint.

9/29/14

544

Input-Output Reference

Group Plant-Condenser Loops

Plant Supply Side Heating Demand Rate [W]

This is the value of the net demand required to meet the heating setpoint of the loop. If the
loop setpoint is met for the current HVAC timestep, Plant Supply Side Heating Demand Rate
will equal sum of the total heating demand from the demand side coils on the loop. It will also
equal the heating output of all boilers (or other cooling equipment) on the loop plus any pump
heat added to the fluid. For example, for a hot water loop with one boiler and one pump
serving one hot water coil: Plant Supply Side Heating Demand Rate will equal the boiler heat
transfer plus the pump heat to fluid, and it will also equal the hot water coil total heating
output.
If the plant loop setpoint is not met, Plant Supply Side Heating Demand Rate will equal the
sum of the total heating demand from the demand side coils on the loop plus the additional
heating required to bring the loop flow to setpoint. If the loop remains off setpoint for
successive timesteps, the demand required to return to setpoint will repeat in each timestep
until the loop reaches setpoint. For this reason, Plant Supply Side Heating Demand Rate
should not be summed over time, because it will overstate the demand whenever the loop is
off setpoint.
Plant Supply Side Inlet Mass Flow Rate [kg/s]
This is the value of the mass flow rate at the Inlet to Plant Loop on the supply side. There is
not an associated Plant Loop outlet node flow rate since continuity must be maintained in the
loop and the outlet must be the same.
Plant Supply Side Inlet Temperature [C]
This is the value of the temperature at the Inlet to the plant loop on the supply side.
Plant Supply Side Outlet Temperature [C]
This is the value of the temperature at the outlet to the plant loop on the supply side.
Plant Supply Side Not Distributed Demand Rate [W]
This is the value of the demand that could not be distributed to the plant equipment because
of some constraint in the plant operation scheme. This is a record of the loop operation
scheme supervisory controls after attempting to distribute the load. For example it would be
non-zero in situations where the load is larger than the upper limit of capacities set for the
plant equipment controls. This output is for before the equipment has actually been
simulated whereas the separate output Plant Supply Side Unmet Demand Rate is for after
the equipment has simulated.
Plant Supply Side Unmet Demand Rate [W]
This is the value of the demand NOT provided by the plant equipment to meet the heating or
cooling setpoint of the loop. The value is positive when the plant equipment cannot meet the
setpoint, and the value is negative when the plant equipment provides more than enough
heating or cooling to meet the setpoint. A negative value can happen when the amount of
demand is smaller than the minimum capacity of the equipment using the minimum part load
ratio.
Plant Solver Sub Iteration Count [ ]
This is the count of iterations that the overall plant simulation used over the period of time
being reported. This high-level output is from the plant solver used for all the plant loops and
condenser loops in the model.
Plant Solver Half Loop Calls Count
This is the count of calls to model individual half-loops that occurred during the overall plant
simulation over the period of time being reported. This includes all the half-loops for both
plant loops and condenser loops.
9/29/14

545

Input-Output Reference

Group Plant-Condenser Loops

Plant Common Pipe Mass Flow Rate [Kg/s]

This output gives the magnitude of the flow through common pipe. The value is averaged
over the reporting interval.
Plant Common Pipe Temperature [C]
This output gives the value of the temperature of the fluid flowing through common pipe. This
value is averaged over the reporting interval.
Plant Common Pipe Flow Direction Status []
This output gives the direction of flow in common pipe. The value is an integer and can be 0,
1 or 2. Since the output value is averaged over reporting interval, a non-integer value may be
shown as an output when the reporting interval is not detailed. An output value of 0 means
that there was no flow in common pipe. An output value of 1 means that the secondary flow is
greater than primary flow, whereas a value of 2 means that primary flow is greater than
secondary flow.
Plant Common Pipe Primary Mass Flow Rate [Kg/s]
This output variable gives the mass flow in the primary side common pipe leg in a Two-Way
common pipe simulation. Value is averaged over the reporting interval.
Plant Common Pipe Secondary Mass Flow Rate [Kg/s]
This output variable gives the mass flow in the secondary side common pipe leg in a TwoWay common pipe simulation. Value is averaged over the reporting interval.
Primary Side Common Pipe Flow Direction []
This output variable gives the direction of flow in a primary side common pipe leg in a TwoWay Common Pipe Simulation. A value of zero means there was no flow in the pipe. A value
of 1 means the flow was from top to bottom in EnergyPlus loop schematic. So for primary
side, a value of 1 means the flow is from Primary side inlet to Primary side outlet and a value
of 2 means flow is from Primary side outlet to Primary side inlet.
Secondary Side Common Pipe Flow Direction []
This output variable gives the direction of flow in a Secondary side common pipe leg in a
Two-Way Common Pipe Simulation. A value of zero means there was no flow in the pipe. A
value of 1 means the flow was from top to bottom in EnergyPlus loop schematic. So for
Secondary side, a value of 1 means the flow is from Secondary side outlet to Secondary side
inlet and a value of 2 means flow is from Secondary side inlet to Secondary side outlet. Note
that this is opposite to the primary side common pipe.
Plant Common Pipe Primary to Secondary Mass Flow Rate [Kg/s]
This output variable gives the mass flow from primary to secondary side in a Two-Way
common pipe simulation. Value is averaged over the reporting interval.
Plant Common Pipe Secondary to Primary Mass Flow Rate [Kg/s]
This output variable gives the mass flow from secondary to primary side in a Two-Way
common pipe simulation. Value is averaged over the reporting interval.
Plant System Cycle On Off Status
This field is the availability status of a Plant Loop. This status flag is a result of the
calculations made by the System Availability Manager(s) listed in a System Availability
Manager List. When a single availability manager is used in a System Availability Manager
List, this is also the availability status reported by the specific availability manager (Ref.
System Availability Manager Outputs). When multiple availability managers are used in a
System Availability Manager List, the loop availability status is determine by the rules
associated with Plant Loops (see rules described for Group System Availability Managers).
9/29/14

546

Input-Output Reference

Group Plant-Condenser Loops

The control status outputs are represented using integers 0 through 2.. These integers
represent NoAction (0), ForceOff (1), and CycleOn (2). Since the status output is averaged,
the output result may not correspond to the values described here when output variable
frequencies other than detailed are used. Use the detailed reporting frequency (Ref.
Output:Variable object) to view the availability status at each simulation timestep.
Plant Demand Side Loop Pressure Difference [Pa]
This field allows the user to output the demand side pressure drop of a plant loop. This
output is only recognized if a valid pressure simulation is being performed. To do this, the
user must specify a pressure simulation type as an input in the PlantLoop object, and input at
least one pressure drop curve on a branch of the plant loop. This particular output is only
relevant if the user puts that curve on the demand side of the loop.
Plant Supply Side Loop Pressure Difference [Pa]
This field allows the user to output the supply side pressure drop of a plant loop. This output
is only recognized if a valid pressure simulation is being performed. To do this, the user must
specify a pressure simulation type as an input in the PlantLoop object, and input at least one
pressure drop curve on a branch of the plant loop. This particular output is only relevant if
the user puts that curve on the supply side of the loop.
Plant Loop Pressure Difference [Pa]
This output is the total pressure drop of a plant loop. This output is only recognized if a valid
pressure simulation is being performed. To do this, the user must specify a pressure
simulation type as an input in the PlantLoop object, and input at least one pressure drop
curve on a branch of the plant loop. This particular output is relevant regardless of the
location of pressure drop curves: demand side, supply side, or both.
The following advanced output variables are also available for plant loops (and condenser
loops) when advanced output variables are requested (e.g. Output:Diagnostics,
DisplayAdvancedReportVariable;).
HVAC,Average,Plant Demand Side Lumped Capacitance Temperature [C]
HVAC,Average,Plant Supply Side Lumped Capacitance Temperature [C]
HVAC,Average,Plant Component Distributed Demand Rate [W]

Plant Demand Side Lumped Capacitance Temperature [C]

Plant Supply Side Lumped Capacitance Temperature [C]
These two outputs are the temperature of the plant (or condenser) loops working fluid where
the two half-loops interface together. The program models heat capacitance in the volume of
fluid inside the plant loop itself using two simple models for well-stirred tanks located at
each of the half-loop inlet and outlet pairs. These tank models also receive the heat
transferred to the fluid by the work done by pumping and resulting friction heating. One
output is for the point where the fluid leaves the supply side and enters the demand side.
The other output is for the point where the fluid leaves the demand side and enters the supply
side.
Plant Component Distributed Demand Rate [W]
This output is available for every component on every branch in a plant (or condenser) loop
and shows the outcome of the load dispatch performed by the operation schemes. This the
load in watts passed from the supervisor routines to the equipment component models. This
provides a record of what a particular component was asked to do by the supervisory
routines. This can be useful for diagnosing issues in operation schemes when a component
or loop is failing to meet the load.

9/29/14

547

Input-Output Reference

Group Plant-Condenser Loops

CondenserLoop
The condenser loop input is very similar to that for the plant loop. As of version 7, the two
loops are modeled the same way and inside the program all condenser loops are just plant
loops. (In future versions of the program, this CondenserLoop object might be deprecated
and these loops will be described using the PlantLoop object.) The main differences are the
applicable components and operation schemes. This is depicted in the following diagram.

Figure 74. Condenser Loop Input Syntax Map

Field: Name
This alpha field is used as an identifying field for the condenser loop.
Field: Fluid Type
This alpha field must be a keyword selected from the list of available fluids for an EnergyPlus
plant loop. Either Water or UserDefinedFluidType may be used. If the
UserDefinedFluidType keyword is used, the following input field i.e. User Defined Fluid Type
must have a value (namely the name of a FluidProperties:GlycolConcentration object).
Field: User Defined Fluid Type
This alpha field must be specified when the previous field is set to UserDefinedFluidType
otherwise it could be left blank. Water, EthyleneGlycol, and PropoleneGlycol are all builtin fluids for EnergyPlus (that is, all of the appropriate properties are contained within the
program). If the fluid specified here is a mixture of water and ethylene or propylene glycol,
then only FluidProperties:GlycolConcentration objects need to be specified and the name of
the appropriate one is used here. For another water/glycol mixture, a complete set of fluid
property data (FluidProperties:Name and FluidProperties:Temperature objects plus multiple
FluidProperties:Concentration objects for specific heat, density, etc.) must be specified (Ref
dataset: GlycolPropertiesRefData.idf).

9/29/14

548

Input-Output Reference

Group Plant-Condenser Loops

Field: Condenser Equipment Operation Scheme Name

This alpha field is used as an identifying field for the condenser operation scheme. This field
ties to the Condenser Operation Schemes input structure, which must also be defined.
Field: Condenser Loop Temperature Setpoint Node Name
This alpha field is used to identify the node which the Loop Manager will access the
temperature setpoint that it will try to maintain. This is typically the Condenser Loop Supply
Side Outlet Node so that it will not interfere with component temperature setpoints. An
associated temperature setpoint manager will need to be defined.
Field: Maximum Loop Temperature
This numeric field contains the maximum allowable temperature in Celsius for this loop.
Field: Minimum Loop Temperature
This numeric field contains the minimum allowable temperature in Celsius for this loop. This
minimum loop temperature is used by the cooling towers to make sure that the minimum is
not violated to keep the equipment safe. The minimum is also used to trigger the minimum
temperature warning and will notify the user if it gets too low.
Field: Maximum Loop Flow Rate
This numeric field contains the maximum loop flow rate in cubic meters per second. This field
is autosizable.
Field: Minimum Loop Flow Rate
This numeric field contains the minimum loop flow rate in cubic meters per second.
Field: Condenser Loop Volume
Volume of the condenser loop in m 3. This numeric field contains the loop volume for the
entire loop, i.e., both the demand side and the supply side. This is used for the loop
capacitance calculation. Loop volume (m 3) could be calculated from pipe size data but this is
not usually known. If zero volume is specified the loop has no fluid heat capacity. If a very
large capacitance is specified unrealistic time delay may result and there may be poor
response to changes in loop setpoint temperature. The loop capacitance autocalculate
option gives reasonable values for most system sizes. This calculation is described in the
Engineering Reference manual.
Field: Condenser Side Inlet Node Name
This required alpha field contains the identifying name given to the Condenser Side Inlet
Node. This node is the inlet to the supply side of the loop.
Field: Condenser Side Outlet Node Name
This required alpha field contains the identifying name given to the Condenser Side Outlet
Node. This node is the outlet of the supply side of the loop.
Field: Condenser Side Branch List Name
This required alpha field contains the identifying name given to the Condenser Side Branch
List. The list referenced here should list all the branches on the supply side of the loop.
Field: Condenser Side Connector List Name
This required alpha field contains the identifying name given to the Condenser Side
Connector List. The list referenced here should list the splitter and mixer on the supply side
of the loop.

9/29/14

549

Input-Output Reference

Group Plant-Condenser Loops

Field: Demand Side Inlet Node Name

This required alpha field contains the identifying name given to the Demand Side Inlet Node.
This node is the inlet to the demand side of the loop.
Field: Demand Side Outlet Nodes Name
This required alpha field contains the identifying name given to the Demand Side Outlet
Node. This node is the outlet of the demand side of the loop.
Field: Condenser Demand Side Branch List Name
This required alpha field contains the identifying name given to the Demand Side Branch List.
The list referenced here should list all the branches on the demand side of the loop.
Field: Condenser Demand Side Connector List Name
This required alpha field contains the identifying name given to the Demand Side Connector
List. The list referenced here should list the splitter and mixer on the demand side of the loop.
Field: Load Distribution Scheme
This alpha field contains the Load Distribution Scheme Keyword. The Load Distribution
Scheme selects the algorithm used to sequence equipment operation in order to meet the
plant loop demand. Currently, five schemes are functional. Optimal operates each piece of
equipment at its optimal part load ratio and will operate the last component between its
minimum and maximum part load ratio in order to meet the loop demand. SequentialLoad
loads each piece of equipment sequentially in the order specified in the PlantEquipmentList
to its maximum part load ratio and will operate the last required piece of equipment between
its minimum and maximum part load ratio in order to meet the loop demand. UniformLoad
evenly distributes the loop demand among all available components on the equipment list for
a given load range. SequentialUniformPLR loads all equipment on the PlantEquipmentList
to a uniform part load ratio (PLR). Components are loaded sequentially based on the order
specified in the PlantEquipmentList until each component is fully loaded, at which point the
next subsequent component is added and the load is distributed uniformly based on PLR
between the components. UniformPLR will load all equipment on the PlantEquipmentList to
a uniform part load ratio (PLR). No equipment will be loaded below its minimum PLR. If the
total load is less than the sum of all equipment on the PlantEquipmentList operating at their
respective minimum PLRs, then the last item in the equipment list is dropped and the load is
distributed based on a uniform PLR for the remaining plant equipment.
Note: For all schemes, if the load for any individual component is less than the component
load at the minimum PLR, the individual component model will false load or reduce duty cycle
while operating at the minimum part load ratio until the load is met.
Field: Pressure Simulation Type
This field lets user to choose if this plant loop will be involved in a pressure drop calculation.
This requires that at least one branch on the loop have pressure drop data. If not, an error
will be thrown due to the input mismatch. Currently there are two pressure drop simulation
types: PumpPowerCorrection and LoopFlowCorrection. In both of these methods, branch
pressure drop data is used to calculate a dynamic loop pressure drop and is used to update
pumping power accordingly. The flow correction method allows the user to enter information
regarding the pressure curve of a constant speed pump so that the simulation can
dynamically resolve the pressure vs. flow relationship in the plant loop. This is limited to
constant speed pumps, as the variable speed pumps are expected to resolve as if it were
controlled by a variable drive, so that they can inherently meet any pressure and flow
demand required by the loop. This is also limited to loop pumps, where there is a single
pump on the plant loop. Common pipe simulations and branch pump simulations are not
compatible with this level of pressure simulation.
See the documentation for the
Pump:ConstantSpeed in order to determine required inputs for this pressure simulation
method to be performed. In the pressure drop system, parallel flow rates are not resolved (to
9/29/14

550

Input-Output Reference

Group Plant-Condenser Loops

match the pressure drop for the parallel system). Enhancements to this calculation are
planned which will allow parallel branch flow resolution. See the Engineering Reference
document for more information on how this works.
An example of this statement used in an IDF is:
CondenserLoop,
Condenser Water Loop,
!- Name
Water,
!- Fluid Type
,
!- User Defined Fluid Type
Tower Loop Operation,
!- Condenser Equipment Operation Scheme Name
Condenser Supply Outlet Node, !- Condenser Loop Temperature Setpoint Node Name
80,
!- Maximum Loop Temperature {C}
10,
!- Minimum Loop Temperature {C}
autosize,
!- Maximum Loop Flow Rate {m3/s}
0.0,
!- Minimum Loop Flow Rate {m3/s}
autocalculate,
!- Condenser Loop Volume {m3}
Condenser Supply Inlet Node, !- Condenser Side Inlet Node Name
Condenser Supply Outlet Node, !- Condenser Side Outlet Node Name
Condenser Supply Side Branches, !- Condenser Side Branch List Name
Condenser Supply Side Connectors, !- Condenser Side Connector List Name
Condenser Demand Inlet Node, !- Demand Side Inlet Node Name
Condenser Demand Outlet Node, !- Demand Side Outlet Node Name
Condenser Demand Side Branches, !- Condenser Demand Side Branch List Name
Condenser Demand Side Connectors, !- Condenser Demand Side Connector List Name
Sequential;
!- Load Distribution Scheme
SetpointManager:FollowOutdoorAirTemperature,
MyCondenserControl,
!- Name
Temperature,
!- Control Variable
OutdoorAirWetBulb,
!- Reference Temperature Type
0,
!- Offset Temperature Difference {deltaC}
80,
!- Maximum Setpoint Temperature {C}
10,
!- Minimum Setpoint Temperature {C}
Condenser Supply Outlet Node; !- Setpoint Node or NodeList Name

CondenserLoop,
Chilled Water Condenser Loop, !- Name
UserDefinedFluidType,
!- Fluid Type
PropyleneGlycol15Percent,!- User Defined Fluid Type
Tower Loop Operation,
!- Condenser Equipment Operation Scheme Name
Condenser Supply Outlet Node, !- Condenser Loop Temperature Setpoint Node Name
80,
!- Maximum Loop Temperature {C}
10,
!- Minimum Loop Temperature {C}
0.00330000,
!- Maximum Loop Flow Rate {m3/s}
0,
!- Minimum Loop Flow Rate {m3/s}
autocalculate,
!- Condenser Loop Volume {m3}
Condenser Supply Inlet Node, !- Condenser Side Inlet Node Name
Condenser Supply Outlet Node, !- Condenser Side Outlet Node Name
Condenser Supply Side Branches, !- Condenser Side Branch List Name
Condenser Supply Side Connectors, !- Condenser Side Connector List Name
Condenser Demand Inlet Node, !- Demand Side Inlet Node Name
Condenser Demand Outlet Node, !- Demand Side Outlet Node Name
Condenser Demand Side Branches, !- Condenser Demand Side Branch List Name
Condenser Demand Side Connectors, !- Condenser Demand Side Connector List Name
Sequential;
!- Load Distribution Scheme

Condenser Loop Outputs

HVAC,Average,Plant Supply Side Cooling Demand Rate [W]
HVAC,Average,Plant Supply Side Heating Demand Rate [W]
HVAC,Average,Plant Supply Side Inlet Mass Flow Rate [kg/s]
HVAC,Average,Plant Supply Side Inlet Temperature [C]
HVAC,Average,Plant Supply Side Outlet Temperature [C]
HVAC,Average,Cond Loop Demand Not Distributed [W]
HVAC,Average,Plant Supply Side Unmet Demand Rate [W]
HVAC,Average,Plant Demand Side Loop Pressure Difference [Pa]
HVAC,Average,Plant Supply Side Loop Pressure Difference [Pa]

9/29/14

551

Input-Output Reference

Group Plant-Condenser Loops

HVAC,Average,Plant Loop Pressure Difference [Pa]

Plant Supply Side Cooling Demand Rate [W]

This is the value of the net demand required to meet the cooling setpoint of the loop. If the
loop setpoint is met for the current HVAC timestep, Plant Supply Side Cooling Demand Rate
will equal sum of the total cooling demand from the demand side components on the loop
(typically condenser coils of chillers, etc.). It will also equal the cooling output of all
condensing equipment such as cooling towers on the loop less any pump heat added to the
fluid. For example, for a condenser loop with one tower and one pump serving one chiller,
Plant Supply Side Cooling Demand Rate will equal the tower water-side heat transfer less the
pump heat to fluid, and it will also equal the chiller condenser heat transfer rate.
If the condenser loop setpoint is not met, Plant Supply Side Cooling Demand Rate will equal
the sum of the total cooling demand from the demand side components on the loop plus the
additional cooling required to bring the loop flow to setpoint. If the loop remains off setpoint
for successive timesteps, the demand required to return to setpoint will repeat in each
timestep until the loop reaches setpoint. For this reason, Plant Supply Side Cooling Demand
Rate should not be summed over time, because it will overstate the demand whenever the
loop is off setpoint.
Plant Supply Side Heating Demand Rate [W]
This is the value of the net demand required to meet the heating setpoint of the loop. If the
loop setpoint is met for the current HVAC timestep, Plant Supply Side Heating Demand Rate
will equal sum of the total heating demand from the demand side components on the loop. It
will also equal the heating output of all heating equipment on the supply side of the loop plus
any pump heat added to the fluid. For example, for a condenser loop with one ground loop
heat exchanger and one pump serving one water-to-water heat pump, Plant Supply Side
Heating Demand Rate will equal the ground loop heat transfer plus the pump heat to fluid,
and it will also equal the heat pump condenser side heat transfer rate.
If the condenser loop setpoint is not met, Plant Supply Side Heating Demand Rate will equal
the sum of the total heating demand from the demand side components on the loop plus the
additional heating required to bring the loop flow to setpoint. If the loop remains off setpoint
for successive timesteps, the demand required to return to setpoint will repeat in each
timestep until the loop reaches setpoint. For this reason, Plant Supply Side Heating Demand
Rate should not be summed over time, because it will overstate the demand whenever the
loop is off setpoint.
Plant Supply Side Inlet Mass Flow Rate [kg/s]
This is the value of the mass flow rate at the Inlet to Condenser Loop on the supply side.
There is not an associated Condenser Loop outlet node flow rate since continuity must be
maintained in the loop and the outlet must be the same.
Plant Supply Side Inlet Temperature [C]
This is the value of the temperature at the Inlet to the condenser loop on the supply side.
Cond Loop OutletNode Temperature [C]
This is the value of the temperature at the outlet to the condenser loop on the supply side.
Cond Loop Demand Not Distributed [W]
This is the value of the demand that could not be distributed to the condenser equipment
because of some constraint in the operation scheme. This is a record of the loop operation
scheme supervisory controls after attempting to distribute the load. For example it would be
non-zero in situations where the load is larger than the upper limit of capacities set for the
condenser equipment controls. This output is for before the equipment has actually been

9/29/14

552

Input-Output Reference

Group Plant-Condenser Control

simulated whereas the separate output Plant Supply Side Unmet Demand Rate is for after
the equipment has simulated.
Plant Supply Side Unmet Demand Rate [W]
This is the value of the demand NOT provided by the condenser equipment to meet the
heating or cooling setpoint of the loop. The value is positive when the condenser equipment
cannot meet the setpoint, and the value is negative when the condenser equipment provides
more than enough heating or cooling to meet the setpoint. A negative value can happen
when the amount of demand is smaller than the minimum capacity of the equipment using
the minimum part load ratio.
Plant Demand Side Loop Pressure Difference [Pa]
This field is the demand side pressure drop of a condenser loop. This output is only
recognized if a valid pressure simulation is being performed. To do this, the user must
specify a pressure simulation type as an input in the CondenserLoop object, and input at
least one pressure drop curve on a branch of the plant/condenser loop. This particular output
is only relevant if the user puts that curve on the demand side of the loop.
Plant Supply Side Loop Pressure Difference [Pa]
This field is the supply side pressure drop of a condenser loop. This output is only
recognized if a valid pressure simulation is being performed. To do this, the user must
specify a pressure simulation type as an input in the CondenserLoop object, and input at
least one pressure drop curve on a branch of the plant/condenser loop. This particular output
is only relevant if the user puts that curve on the supply side of the loop.
Plant Loop Pressure Difference [Pa]
This field is the total pressure drop of a condenser loop. This output is only recognized if a
valid pressure simulation is being performed. To do this, the user must specify a pressure
simulation type as an input in the CondenserLoop object, and input at least one pressure
drop curve on a branch of the plant/condenser loop. This particular output is relevant
regardless of the location of pressure drop curves: demand side, supply side, or both.

Group Plant-Condenser Control

Operation Schemes (Plant and Condenser)
Plants and condenser loops must have some mechanism for controlling the operation of the
loop and which equipment is available under what conditions. Since there may be multiple
control schemes that are assigned various priorities associated with each loop, an overall
operation scheme must be defined. The overall scheme consists of the object name, an
identifying name that is referenced in the main plant or condenser loop statement, and a list
of operation schemes. Each operation scheme must have the type of operation scheme, its
identifying name, and the schedule that defines its availability. Note that the order in which
the individual operation schemes appear in this list defines its priority versus the others with
the same scheduled availability. The first scheme appearing in the list is given the highest
priority, the second scheme has second highest priority, etc. In other words, if according to its
schedule, the first operation scheme is available, then it is used by the simulation to define
how the plant or condenser loop operates. If it is not available, the second operation scheme
in the list is checked to see if it is available until the highest priority scheme that is also
available is found. To allow for simultaneous heating and cooling, there is one configuration
where multiple operation schemes are available at a given timestep. This is allowed if a user
inputs both a heating range based operation and a cooling range based operation with
overlapping schedules. The simulation will look at the current loop demand to determine if
the cooling scheme should be used or the heating scheme. In other cases, if two schemes
overlap (are available at the same time), a fatal error will be encountered.
9/29/14

553

Input-Output Reference

Group Plant-Condenser Control

PlantEquipmentOperationSchemes
Field: Name
This alpha field contains the identifying name given to the Plant Operation Scheme. This
name is placed in the Plant Loop object to select this scheme.
Field Set: (Component Object Type, Name, Schedule) up to 8
Operation schemes are listed in "priority" order. Note that each scheme must address the
entire load and/or condition ranges for the simulation. The actual one selected for use will be
the first that is "Scheduled" on. That is, if control scheme 1 is not "on" and control scheme 2
is -- then control scheme 2 is selected. Only plant equipment should be listed on a Control
Scheme for this item.
Field: Control Scheme <#> Object Type
This alpha field contains the keyword for the type of control scheme used. The options for
plant control schemes are:
PlantEquipmentOperation:Uncontrolled
PlantEquipmentOperation:CoolingLoad
PlantEquipmentOperation:HeatingLoad
PlantEquipmentOperation:ComponentSetpoint
PlantEquipmentOperation:UserDefined
Field: Control Scheme <#> Name
This alpha field contains the identifying name given to the control scheme. These must be the
named versions of the referenced Control Scheme (e.g.. a Uncontrolled Loop Operation with
this name or a Cooling or Heating Load Range Based Operation with this name).
Field: Control Scheme <#> Schedule
This alpha field contains the schedule name for the control scheme. This schedule consists of
weeks and days, with the days containing 0 or 1 for each hour of the day. This binary
schedule (0 for off, 1 for on) determines if the control scheme is operating for that hour of day
or not.
Examples of this statement in two different IDFs:
PlantEquipmentOperationSchemes,
CW Loop Operation,
!- Name
PlantEquipmentOperation:CoolingLoad, ! Control Scheme 1 Object Type
Peak Operation,
!- Control Scheme 1 Name
On Peak,
!- Control Scheme 1 Schedule
PlantEquipmentOperation:CoolingLoad, ! Control Scheme 2 Object Type
Off Peak Operation,
!- Control Scheme 2 Name
Off Peak;
!- Control Scheme 2 Schedule
PlantEquipmentOperationSchemes,
CW Loop Operation,
!- Name
PlantEquipmentOperation:CoolingLoad, ! Control Scheme 1 Object Type
Central Chiller Only,
!- Control Scheme 1 Name
PlantOnSched;
!- Control Scheme 1 Schedule

In the first IDF example, PlantEquipmentOperation:CoolingLoad is the type of control

scheme. Peak Operation and Off Peak Operation are the names of two different load
range based controls defined separately (see below -- ). On Peak and Off Peak are
schedules defined elsewhere in the input file.
The load range based operation scheme has two statements associated with it: a main
statement that defines the ranges that individual priority settings are valid and the lists of
equipment that may be used for each range.

9/29/14

554

Input-Output Reference

Group Plant-Condenser Control

CondenserEquipmentOperationSchemes
Field: Name
This alpha field contains the identifying name given to the Condenser Operation Scheme.
Field Set: (Component Object Type, Name, Schedule) up to 8
Operation schemes are listed in "priority" order. Note that each scheme must address the
entire load and/or condition ranges for the simulation. The actual one selected for use will be
the first that is "Scheduled" on. That is, if control scheme 1 is not "on" and control scheme 2
is -- then control scheme 2 is selected. Only condenser equipment should be listed on a
Control Scheme for this item.
Field: Control Scheme <#> Object Type
This alpha field contains the keyword for the type of control scheme used. The options for
plant control schemes are:
This alpha field contains the keyword for the type of control scheme used. Currently, the
available options are:
PlantEquipmentOperation:Uncontrolled
PlantEquipmentOperation:CoolingLoad
PlantEquipmentOperation:HeatingLoad
PlantEquipmentOperation:OutdoorDryBulb
PlantEquipmentOperation:OutdoorWetBulb
PlantEquipmentOperation:OutdoorDewpoint
PlantEquipmentOperation:OutdoorRelativeHumidity
PlantEquipmentOperation:OutdoorDryBulbDifference
PlantEquipmentOperation:OutdoorWetBulbDifference
PlantEquipmentOperation:OutdoorDewpointDifference
PlantEquipmentOperation:UserDefined
The condenser operation schemes apply to the equipment on the supply side of the
condenser looppumps, cooling towers, ground coupled heat exchangers, etc. The
keywords select the algorithm that will be used to determine which equipment is available for
each timestep. The Load Schemes schemes select a user specified set of equipment for
each user specified range of a particular simulation variable. Load schemes compare the
demand on the condenser supply side with specified load ranges and associated equipment
lists. Outdoor schemes compare the current value of an environmental parameter with user
specified ranges of that parameter.
Field: Control Scheme <#> Name
This alpha field contains the identifying name given to the control scheme.
Field: Control Scheme <#> Schedule
This alpha field contains the schedule name for the control scheme. This schedule consists of
weeks and days, with the days containing 0 or 1 for each hour of the day. This binary
schedule (0 for off, 1 for on) determines which control scheme is operating for a particular
hour. The schedule facilitates daily or seasonal changes in control schemes to meet demand
side management or energy conservation goals.
Scheduling conflicts are handled by selecting the first available scheme in order of
appearance in the list.
Examples of this statement in two IDFs:

9/29/14

555

Input-Output Reference

Group Plant-Condenser Control

CondenserEquipmentOperationSchemes,
Tower Loop Operation,
!- CondenserOperationSchemeName
PlantEquipmentOperation:CoolingLoad, Control Scheme 1 Object Type
Year Round Tower Operation, !- Control Scheme 1 Name
PlantOnSched;
!- Control Scheme 1 Schedule
CondenserEquipmentOperationSchemes,Tower Loop Operation,
PlantEquipmentOperation:CoolingLoad, Peak Load Operation, AFTERNOONSCHEDULE,
PlantEquipmentOperation:CoolingLoad, OffPeak Load Operation, MORNINGSCHEDULE,
PlantEquipmentOperation:OutdoorWetBulb, NightOperation, NIGHTSCHEDULE;

Each schedule (AFTERNOONSCHEDULE, MORNINGSCHEDULE, NIGHTSCHEDULE)

invokes its associated operation scheme (Peak Load Operation, OffPeak Load Operation,
NightOperation). The type of operation scheme and its name references the input syntax
associated with the range specification and the associated equipment.
PlantEquipmentOperation:Uncontrolled
Uncontrolled loop operation simply specifies a group of equipment that runs uncontrolled. If
the loop runs, this equipment will run also, unless turned off by the loop flow resolver to
maintain continuity in the fluid loop.
Field: Name
This alpha field contains the identifying name for the control scheme.
Field: Equipment List Name
This alpha field contains the identifying name for the Equipment List. This field ties to the
Load Range Equipment List input structure, which must also be defined.
Field: Equipment List Name
This alpha field contains the identifying name for the Equipment List. This field ties to the
PlantEquipmentList or CondenserEquipmentList input structure, which must also be defined.
PlantEquipmentOperation:CoolingLoad
PlantEquipmentOperation:HeatingLoad
The PlantEquipmentOperation:CoolingLoad
and PlantEquipmentOperation:HeatingLoad
objects define the different ranges and which equipment list is valid for each range. After the
keyword and the identifying name, a series of data trios is expected. In each trio, there is a
lower limit for the load range, an upper limit for the load range, and a name that links to an
equipment availability list (the PlantEquipmentList or CondenserEquipmentList objects).
Field: Name
This alpha field contains the identifying name for the control scheme.
Field Set: (Lower limit, Upper Limit, Equip List name) up to 10
Field: Load Range <#> Lower Limit
This numeric field contains the lower demand range (W) for the equipment list. If demand is
below this value, then this equipment list will not turn on to meet the demand.
Field: Load Range <#> Upper Limit
This numeric field contains the upper demand range (W) for the equipment list. If demand is
above this value, then this equipment list will not turn on to meet the demand.
Field: Range <#> Equipment List Name
This alpha field contains the identifying name for the Equipment List (i.e., the name of a
PlantEquipmentList or CondenserEquipmentList object).

9/29/14

556

Input-Output Reference

Group Plant-Condenser Control

An example of these statements in an IDF is:

PlantEquipmentOperation:CoolingLoad, Peak Operation,
0,7000,
Chiller Plant,
7000,24500,
Chiller Plant and Purchased,
24500,500000, Purchased Only;

This particular load based operation scheme (above) has three different ranges. Chiller
Plant, Chiller Plant and Purchased, and Purchased Only are names which link to various
PlantEquipmentList or CondenserEquipmentList objects as described below. Gaps may be
left in the load ranges specified, but to operate equipment over the entire range the upper
limit of a given range must equal the lower limit of the next range as shown in the example. If
gaps are left in the load ranges specified, a warning message will be issued when the load to
be met falls within a load range gap. If the user wishes to leave a load range gap for a
specific reason (no equipment to operate on this plant [or condenser] loop within this load
range) and does not want the warning messages to be generated, then specify a lower limit,
upper limit and equipment list name for the gap and do not specify any equipment in the
associated equipment list, as shown below.
PlantEquipmentOperation:CoolingLoad, Peak Operation,
0,7000,
Chiller Plant,
7000,7100, NoEquipmentOperationOnThisPlantLoop,
7100,24500,
Chiller Plant and Purchased,
24500,500000, Purchased Only;
PlantEquipmentList,
Chiller Plant,
Chiller:Electric,
Big Chiller;

!- Name
!- Equipment 1 Object Type
!- Equipment 1 Name

PlantEquipmentList,
NoEquipmentOperationOnThisPlantLoop;
PlantEquipmentList,
Chiller Plant and Purchased, !- Name
Chiller:Electric,
!- Equipment
Big Chiller,
!- Equipment
DistrictCooling,
!- Equipment
Purchased Cooling;
!- Equipment
PlantEquipmentList,
Purchased Only,
DistrictCooling,
Purchased Cooling;

!- Name

1
1
2
2

Object Type
Name
Object Type
Name

!- Name
!- Equipment 1 Object Type
!- Equipment 1 Name

PlantEquipmentOperation:OutdoorDryBulb
PlantEquipmentOperation:OutdoorWetBulb
PlantEquipmentOperation:OutdoorRelativeHumidity
PlantEquipmentOperation:OutdoorDewpoint
The outdoor operation objects define the different ranges of the various environmental
parameters and which equipment list is valid for each range. After the keyword and the
identifying name, a series of data trios is expected. In each trio, there is a lower limit for the
load range, an upper limit for the load range, and a name that links to an equipment
availability list (the CondenserEquipmentList).
The fields for each of these are:
Field: Name
This alpha field contains the identifying name for the control scheme.

9/29/14

557

Input-Output Reference

Group Plant-Condenser Control

Field Set: (Lower limit, Upper Limit, Equip List name) up to 10

Field: <specfic type> Range <#> Lower Limit
This numeric field contains the lower limit (C for temperature operations, Percent for relative
humidity operations) for the equipment list. If specific value is below this value, then this
equipment list will not turn on to meet the demand.
Field: <specific type> Range <#> Upper Limit
This numeric field contains the lower limit (C for temperature operations, Percent for relative
humidity operations) for the equipment list. If specific value is above this value, then this
equipment list will not turn on to meet the demand.
Field: Range <#> Equipment List Name
This alpha field contains the identifying name for the Equipment List (i.e., the name of a
CondenserEquipmentList object).
PlantEquipmentOperation:OutdoorDryBulbDifference
PlantEquipmentOperation:OutdoorWetBulbDifference
PlantEquipmentOperation:OutdoorDewpointDifference
The Delta Temperature based control strategies help to control any condenser equipment
based on the difference between a reference node temperature and any environmental
temperature. For example a cooling tower can be controlled by a strategy, which looks at the
difference between the tower inlet temperature and wet-bulb temperature. A difference range
is specified for each equipment list. IDD excerpts are shown below:
Field: Name
This alpha value contains the identifying name of the control strategy. This name appears as
control scheme name in Condenser Operation Scheme object.
Field: Reference Temperature Node Name
This alpha value specifies the reference node for the operation scheme identified in the first
field.
Field Set: (Lower limit, Upper limit, Equipment List)
Field: <specfic type> Range <#> Lower Limit
This numeric field specifies the minimum temperature difference required for the equipment
specified in the equipment list to operate.
Field: <specfic type> Range <#> Upper Limit
This numeric field specifies the maximum temperature difference below which the equipment
specified in the equipment list is available.
Field: Range <#> Equipment List Name
This alpha field contains the identifying name for the Equipment List (i.e., the name of a
CondenserEquipmentList object).
PlantEquipmentOperation:ComponentSetpoint
In addition to load range based control on the plant loop, sequencing the plant components
based on the outlet temperature of individual equipment is allowed. This scheme is common
to many present-day Energy Management Systems sequencing. In this scheme, the
sequencing is done based on the order specified in the control object described below.

9/29/14

558

Input-Output Reference

Group Plant-Condenser Control

Field: Name
This field specifies the name of the operation scheme.
Field Set: Equipment Object Type, Name, Demand Calculation Node, Setpoint Node, Flow
Rate, Operation Type)
Field: Equipment <#> Object Type
This field specifies the type of equipment controlled by scheme.
Field: Equipment <#> Name
This field specifies the name of the controlled equipment.
Field: Demand Calculation <#> Node Name
The component demand will be calculated using the difference between the temperature at
the demand node and the component set point temperature.
Field: Setpoint <#> Node Name
Each component controlled under temperature based control will have its own set point
different from the loop set point. This field specifies component set point node (Generally its
outlet temperatures). This node is acted upon by a SetpointManager in order to obtain the
setpoint at any simulation timestep.
Field: Component <#> Flow Rate
This numeric field specifies the design flow rate for the component specified in earlier fields.
This flow rate is used to calculate the component demand. The field can be set to autosize, if
the user wants the program to calculate the design flow. This would generally be set to
autosize when the user does not know the component flow rate and does a sizing calculation
for the corresponding component.
Field: Operation<#> Type
This alpha field specifies the operation mode for the equipment. The equipment can be in any
of the three modes viz. Cooling, Heating and Dual. Dual is used when the components both
as heating and cooling equipment (for example heat pumps).

And, as an example in an IDF:

PlantEquipmentOperationSchemes,
CW Loop Operation,
!- PlantOperationSchemeName
PlantEquipmentOperation:ComponentSetpoint, ! Control Scheme 1 Object Type
Test Scheme,
!- Control Scheme 1 Name
On;
!- Control Scheme 1 Schedule
PlantEquipmentOperation:ComponentSetpoint,
Test Scheme,
CHILLER:ELECTRIC,
!- Equipment 1 Object Type
Little Chiller,
!- Equipment 1 Name
Little Chiller Inlet Node, !- Demand Calculation 1 Node Name
Little Chiller Outlet Node, !- Setpoint 1 Node Name
0.0011,
!- Component 1 Flow Rate
COOLING,
!- Operation 1 Type
CHILLER:ELECTRIC,
!- Equipment 2 Object Type
Big Chiller,
!- Equipment 2 Name
Big Chiller Inlet Node, !- Demand Calculation 2 Node Name
Big Chiller Outlet Node, !- Setpoint 2 Node Name
0.0011,
!- Component 2 Flow Rate
COOLING;
!- Operation 2 Type
9/29/14

559

Input-Output Reference

Group Plant Equipment

PlantEquipmentList
CondenserEquipmentList
The PlantEquipmentList
and CondenserEquipmentList
specify available plant and
condenser loop equipment respectively for any loop operation scheme. Each statement
contains the object name, an identifying name (which links the definition back to one of the
operation scheme statements) and a variable length of data pairs. These pairs refer to a plant
equipment type and an identifying name. The type in this list of pairs must correspond to a
valid plant object as described in the next subsection.
Note: If a PlantEquipmentList or CondenserEquipmentList object is specified with no equipment object
types or equipment names, then the corresponding PlantEquipmentOperation:* object will assume all
available equipment on this plant (or condenser) loop should be OFF (not operate) within the specified
lower/upper limit.

Field: Name
This alpha field contains the identifying name for the Equipment List.
Field Set: (Object Type, Name) up to 10
Remember the order of equipment on this list determines operation priority. Equipment on the
list first will try to meet demand first. These fields tie to the Equipment Definition input
structure, which must also be defined.
Field: Equipment <#> Object Type
This alpha field contains the keyword for the type of equipment in operation. Example:
(Chiller:Electric, DistrictCooling). The full list of allowable plant equipment is valid plant
objects as described in the next subsection.
Field: Equipment <#> Name
This alpha field contains the identifying name for the equipment in operation. This
distinguishes between two different pieces of equipment of the same type.
An example of this statement in an IDF is:
PlantEquipmentList, Chiller Plant and Purchased,
Chiller:Electric, Big Chiller,
DistrictCooling, Purchased Cooling;

Note that this list is the middle range defined in the PlantEquipmentOperation:CoolingLoad
statement named Peak Operation above. This defines the equipment available when the
load encountered by the plant (chiller water demand, for example) is between 7000 W and
24500 W. EnergyPlus will run the Big Chiller first up to its capacity and then attempt to meet
the remaining load (while in that range) with the next piece of equipment (in this case,
Purchased:Cooling) in the list.

Group Plant Equipment

Equipment Types
In each PlantEquipmentList described using the above syntax, various equipment types
and names must be given. Each type-name pair must then have a corresponding equipment
definition. This subsection lists the various equipment types that are available and examples
from an IDF. Where appropriate, notes and comments on the input structure are provided.

9/29/14

560

Input-Output Reference

Group Plant Equipment

Generic Chiller Outputs

Many output variable names are common across all chiller types. These generic chiller output
names all begin with the word "Chiller". Certain chiller types have additional output variables
which are specific to that type of chiller. Chiller energy use is added to the appropriate plantlevel meters as a cooling end-use.
HVAC,Average,Chiller Electric Power [W]
HVAC,Sum,Chiller Electric Energy [J]
Zone,Meter,Electricity:Plant [J]
Zone,Meter,Cooling:Electricity [J]
HVAC,Average,Chiller Evaporator Cooling Rate [W]
HVAC,Sum,Chiller Evaporator Cooling Energy [J]
Zone,Meter,EnergyTransfer:Plant [J]
Zone,Meter,Chillers:EnergyTransfer [J]
HVAC,Average,Chiller Evaporator Inlet Temperature [C]
HVAC,Average,Chiller Evaporator Outlet Temperature [C]
HVAC,Average,Chiller Evaporator Mass Flow Rate [kg/s]
HVAC,Average,Chiller Condenser Heat Transfer Rate [W]
HVAC,Sum,Chiller Condenser Heat Transfer Energy [J]
Zone,Meter,HeatRejection:EnergyTransfer [J]
HVAC,Average,Chiller COP [W/W]
The following output is applicable only for air-cooled or evap-cooled
chillers
HVAC,Average,Chiller Condenser Inlet Temperature [C]
The following outputs are applicable only for evap-cooled chillers
HVAC,Average,Chiller Basin Heater Electric Power [W]
HVAC,Average,Chiller Basin Heater Electric Energy [J]
The following three outputs are only available for water-cooled chillers
HVAC,Average,Chiller Condenser Inlet Temperature [C]
HVAC,Average,Chiller Condenser Outlet Temperature [C]
HVAC,Average,Chiller Condenser Mass Flow Rate [kg/s]
HVAC,Average,Chiller Drive Shaft Power [W]
HVAC,Sum,Chiller Drive Shaft Energy [J]
Zone,Meter,HeatRecovery:EnergyTransfer [J]
HVAC,Average,Chiller Lube Recovered Heat Rate [W]
HVAC,Sum,Chiller Lube Recovered Heat Energy [J]
HVAC,Average,Chiller Jacket Recovered Heat Rate [W]
HVAC,Sum,Chiller Jacket Recovered Heat Energy [J]
HVAC,Average, Chiller Exhaust Recovered Heat Rate [W]
HVAC,Sum,Chiller Exhaust Recovered Heat Energy [J]
HVAC,Average,Chiller Total Recovered Heat Rate [W]
HVAC,Sum,Chiller Total Recovered Heat Energy [J]
HVAC,Average,Chiller Exhaust Temperature [C]
HVAC,Average,Chiller Heat Recovery Inlet Temperature [C]
HVAC,Average,Chiller Heat Recovery Outlet Temperature [C]
HVAC,Average,Chiller Heat Recovery Mass Flow Rate [kg/s]
HVAC,Average,Chiller Effective Heat Rejection Temperature [C]
The following blocks of outputs are for steam and fuel-driven chillers
HVAC,Average,Chiller Gas Rate [W]
HVAC,Sum,Chiller Gas Energy [J]
HVAC,Average,Chiller Gas Mass Flow Rate [kg/s]
9/29/14

561

Input-Output Reference

Group Plant Equipment

HVAC,Sum,Chiller Gas Mass [kg]

For steam absorption chillers:
HVAC,Average,Chiller Source Steam Rate [W]
HVAC,Sum, Chiller Source Steam Energy [J]
HVAC,Average,Chiller Steam Mass Flow Rate [kg/s]
For hot water absorption chillers:
HVAC,Average,Chiller Source Hot Water Rate [W]
HVAC,Sum,Chiller Source Hot Water Energy [J]
Zone,Meter,Steam:Plant [J]
Zone,Meter,Cooling:EnergyTransfer [J]
HVAC,Average,Chiller Hot Water Mass Flow Rate [kg/s]
The following output is applicable only for indirect absorption chillers
HVAC,Average,Chiller Part Load Ratio
HVAC,Average,Chiller Cycling Ratio []
HVAC,Average,Chiller Propane Rate [W]
HVAC,Sum,Chiller Propane Energy [J]
HVAC,Average,Chiller Propane Mass Flow Rate [kg/s]
HVAC,Average,Chiller Diesel Rate [W]
HVAC,Sum,Chiller Diesel Energy [J]
HVAC,Average,Chiller Diesel Mass Flow Rate [kg/s]
HVAC,Average,Chiller Gasoline Rate [W]
HVAC,Sum,Chiller Gasoline Energy [J]
HVAC,Average,Chiller Gasoline Mass Flow Rate [kg/s]
HVAC,Average,Chiller FuelOil#1 Rate [W]
HVAC,Sum,Chiller FuelOil#1 Energy [J]
HVAC,Average,Chiller FuelOil#1 Mass Flow Rate [kg/s]
HVAC,Average,Chiller FuelOil#2 Rate [W]
HVAC,Sum,Chiller FuelOil#2 Energy [J]
HVAC,Average,Chiller FuelOil#2 Mass Flow Rate [kg/s]
HVAC,Average,Chiller OtherFuel1 Rate [W]
HVAC,Sum,Chiller OtherFuel1 Energy [J]
HVAC,Average,Chiller OtherFuel1 Mass Flow Rate [kg/s]
HVAC,Average,Chiller OtherFuel2 Rate [W]
HVAC,Sum,Chiller OtherFuel2 Energy [J]
HVAC,Average,Chiller OtherFuel2 Mass Flow Rate [kg/s]

Chiller Electric Power [W]

Chiller Electric Energy [J]
These outputs are the electric power input to the chiller. In the case of steam or fuel-powered
chillers, this repesents the internal chiller pumps and other electric power consumption.
Consumption is metered on Cooling:Electricity, Electricity:Plant, and Electricity:Facility.
Chiller Evaporator Cooling Rate [W]
Chiller Evaporator Cooling Energy [J]
These outputs are the evaporator heat transfer which is the cooling delivered by the chiller.
Chiller
Evaporator
Cooling
Energy
is
metered
on
Chillers:EnergyTransfer,
EnergyTransfer:Plant, and EnergyTransfer:Facility.

9/29/14

562

Input-Output Reference

Group Plant Equipment

Chiller Evaporator Inlet Temperature [C]

Chiller Evaporator Outlet Temperature [C]
Chiller Evaporator Mass Flow Rate [kg/s]
These outputs are the evaporator (chilled water) inlet and outlet temperatures and flow rate.
Chiller COP [W/W]
This output is the coefficient of performance for the chiller during cooling operation. It is
calculated as the evaporator heat transfer rate (Chiller Evaporator Cooling Rate) divided by
the fuel consumption rate by the chiller. For the constant COP and electric chillers, the fuel
is electricity so the divisor is Chiller Electric Power [W]. For the absorption chiller, the fuel is
steam so the divisor is Steam Consumption Rate [W].
Note that this variable is reported as zero when the chiller is not operating. When reported for
frequencies longer than "detailed" (such as timestep, hourly, daily, monthly or environment),
this output will only be meaningful when the chiller is operating for the entire reporting period.
To determine an average COP for a longer time period, compute the COP based on total
evaporator heat transfer divided by total electric or fuel input over the desired period.
Chiller Part Load Ratio
This output is the operating part-load ratio of the indirect absorption chiller. This output may
fall below the minimum part-load ratio specified in the input. For this case, the Chiller Cycling
Ratio is used to further define the performance of the indirect absorption chiller.
Chiller Cycling Ratio
This output is the fraction of the timestep the indirect absorption chiller operates. When the
chiller operates above the minimum part-load ratio, a Chiller Cycling Ratio of 1 is reported.
When the chiller operates below the minimum part-load ratio, the Chiller Cycling Ratio reports
the fraction of the timestep the indirect absorption chiller operates.
Chiller Condenser Heat Transfer Rate [W]
Chiller Condenser Heat Transfer Energy [J]
These outputs are the condenser heat transfer which is the heat rejected from the chiller to
either a condenser water loop or through an air-cooled condenser. Chiller Condenser Heat
Transfer Energy is metered on HeatRejection:EnergyTransfer, EnergyTransfer:Plant, and
EnergyTransfer:Facility.
Chiller Condenser Inlet Temperature [C]
This output is the condenser (heat rejection) inlet temperature for air-cooled or evap-cooled
chillers. For an air-cooled chiller, this output would be the dry-bulb temperature of the air
entering the condenser coil. For an evap-cooled chiller, this output would be the wet-bulb
temperature of the air entering the evaporatively-cooled condenser coil.
Chiller Basin Heater Electric Power [W]
Chiller Basin Heater Electric Energy [J]
These outputs are the electric power input to the chillers basin heater (for evaporativelycooled condenser type). Consumption is metered on Chillers:Electricity, Electricity:Plant, and
Electricity:Facility

9/29/14

563

Input-Output Reference

Group Plant Equipment

Chiller Condenser Inlet Temperature [C]

Chiller Condenser Outlet Temperature [C]
Chiller Condenser Mass Flow Rate [kg/s]
These outputs are the condenser (heat rejection) inlet and outlet temperatures and flow rate
for water-cooled chillers.
Chiller Drive Shaft Power [W]
Chiller Drive Shaft Energy [J]
For engine-driven and turbine-driven chillers, these outputs are the shaft power produced by
the prime mover and transferred to the chiller compressor.
Chiller Lube Recovered Heat Rate [W]
Chiller Lube Recovered Heat Energy [J]
Chiller Jacket Recovered Heat Rate [W]
Chiller Jacket Recovered Heat Energy [J]
Chiller Exhaust Recovered Heat Rate [W]
Chiller Exhaust Recovered Heat Energy [J]
Chiller Total Recovered Heat Rate [W]
Chiller Total Recovered Heat Energy [J]
For chillers with heat recovery, such as engine-driven chillers, these outputs are the
components of recoverable energy available. For a given chiller type, one or more of the
following components may be applicable: Lube (engine lubricant), Jacket (engine coolant),
Exhaust (engine exhaust), and Total. Chiller Lube Recovered Heat Energy, Chiller Jacket
Recovered Heat Energy, and Chiller Exhaust Heat Recovery Energy are metered on
HeatRecovery:EnergyTransfer, EnergyTransfer:Plant, and EnergyTransfer:Facility.
Chiller Exhaust Temperature [C]
This is the exhaust temperature leaving an engine chiller.
Chiller Heat Recovery Inlet Temperature [C]
Chiller Heat Recovery Outlet Temperature [C]
Chiller Heat Recovery Mass Flow Rate [kg/s]
These outputs are the heat recovery inlet and outlet temperatures and flow rate for chillers
with heat recovery such as engine-driven and gas turbine chillers.
Chiller Effective Heat Rejection Temperature [C]
This output variable is available for heat recovery chillers that model split bundle condenser.
The condenser fluid temperatures used to characterize chiller performance are modified to
account for the temperature of the heat recovery fluid. This output is the resulting
temperature used for characterizing chiller performance and is a blend of the temperatures in
the condenser and heat recovery fluid streams.
For the Chiller:Electric and
Chiller:Electric:EIR models, this is an effective inlet temperature while for the
Chiller:Electric:ReformulatedEIR model, this is an effective outlet temperature.

9/29/14

564

Input-Output Reference

Group Plant Equipment

Chiller <Fuel Type> Rate [W]

Chiller <Fuel Type> Energy [J]
Chiller <Fuel Type> Mass Flow Rate [kg/s]
Chiller Gas Mass [kg] (Gas Turbine Chiller only)
These outputs are the steam or fuel input for steam or fuel-fired chillers. Valid fuel types
depend on the type of chiller. <Fuel Type> may be one of: Gas (natural gas), Steam,
Propane, Diesel, Gasoline, FuelOil#1, FuelOil#2, OtherFuel1 and OtherFuel2. Consumption
is metered on Cooling:<Fuel Type>, <Fuel Type>:Plant, and <Fuel Type>:Facility.
Chiller Source Hot Water Rate [W]
Chiller Source Hot Water Energy [J]
Chiller Source Steam Rate [W]
Chiller:Absorption
Field: Name
This alpha field contains the identifying name for the absorption chiller.
Field: Nominal Capacity
This numeric field contains the nominal cooling capability of the chiller in Watts.
Field: Nominal Pumping Power
This numeric field contains the nominal pumping power of the absorber in Watts.
Field: Chilled Water Inlet Node Name
This required alpha field contains the identifying name for the absorption chiller plant side
inlet node.
Field: Chilled Water Outlet Node Name
This required alpha field contains the identifying name for the absorption chiller plant side
outlet node.
Field: Condenser Inlet Node Name
This required alpha field contains the identifying name for the absorption chiller condenser
side inlet node.
Field: Condenser Outlet Node Name
This required alpha field contains the identifying name given to the Heat Recovery Loop
Component Outlet Node.
Field: Minimum Part Load Ratio
This numeric field contains the absorption chillers minimum part load ratio. The expected
range is between 0 and 1. The minimum part load is not the load where the machine shuts
off, but where the amount of power remains constant to produce smaller loads than this
fraction.
Field: Maximum Part Load Ratio
This numeric field contains the absorption chillers maximum part load ratio. This value may
exceed 1, but the normal range is between 0 and 1.1.

9/29/14

565

Input-Output Reference

Group Plant Equipment

Field: Optimum Part Load Ratio

This numeric field contains the absorption chillers optimum part load ratio. This is the part
load ratio at which the chiller performs at its maximum COP.
Field: Design Condenser Inlet Temperature
This numeric field contains the absorption chillers condenser inlet design temperature in
Celsius.
Field: Design Chilled Water Flow Rate
For variable volume chiller this is the maximum flow and for constant flow chiller this is the
design flow rate. The units are in cubic meters per second.
Field: Design Condenser Water Flow Rate
This numeric field contains the absorption chillers design condenser water flow rate in cubic
meters per second.
Generator Heat Input Part Load Ratio Curve
The Generator Heat Input Part Load Ratio Curve is a quadratic equation that determines the
Ratio of the generator load on the absorber to the demand on the chiller. The defining
equation is:

SteamInputRatio

C1
C 2 C 3 PLR
PLR

The following three fields contain the coefficients for the equation.
Field: Coefficient 1 of the Steam Use Part Load Ratio Curve
C1 in the Generator Heat Input Part Load Ratio Curve. This value is obtained by fitting
manufacturers performance data to the curve.
Field: Coefficient 2 of the Steam Use Part Load Ratio Curve
C2 in the Generator Heat Input Part Load Ratio Curve. This value is obtained by fitting
manufacturers performance data to the curve.
Field: Coefficient 3 of the Steam Use Part Load Ratio Curve
C3 in the Generator Heat Input Part Load Ratio Curve. This value is obtained by fitting
manufacturers performance data to the curve.
Pump Electric Use Part Load Ratio Curve
The Pump Electric Use Part Load Ratio Curve is a quadratic equation that determines the
Ratio of the actual absorber pumping power to the nominal pumping power. The defining
equation is:

ElectricInputRatio C1 C 2 PLR C3 PLR 2

The following three fields contain the coefficients for the equation.
Field: Coefficient 1 of the Pump Electric Use Part Load Ratio Curve
C1 in the Pump Electric Use Part Load Ratio Curve. This value is obtained by fitting
manufacturers performance data to the curve.
Field: Coefficient 2 of the Pump Electric Use Part Load Ratio Curve
C2 in the Pump Electric Use Part Load Ratio Curve. This value is obtained by fitting
manufacturers performance data to the curve.

9/29/14

566

Input-Output Reference

Group Plant Equipment

Field: Coefficient 3 of the Pump Electric Use Part Load Ratio Curve
C3 in the Pump Electric Use Part Load Ratio Curve. This value is obtained by fitting
manufacturers performance data to the curve.
Field: Chilled Water Outlet Temperature Lower Limit
This numeric field contains the lower limit for the evaporator outlet temperature. This
temperature acts as a cut off for heat transfer in the evaporator, so that the fluid doesnt get
too cold.
Field: Generator Inlet Node Name
This alpha field contains the identifying name given to the Generator Inlet Node. A steam or
hot water loop is not required to simulate an absorption chiller. If a steam/hot water loop is
used, enter the name of the generator inlet node.
Field: Generator Outlet Node Name
This alpha field contains the identifying name given to the Generator Outlet Node. A steam or
hot water loop is not required to simulate an absorption chiller. If a steam/hot water loop is
used, enter the name of the generator outlet node.
Field: Chiller Flow Mode
This choice field determines how the chiller operates with respect to the intended fluid flow
through the devices evaporator. There are three different choices for specifying operating
modes for the intended flow behavior:
NotModulated, ConstantFlow, and
LeavingSetpointModulated. NotModulated is useful for either variable or constant speed
pumping arrangements where the chiller is passive in the sense that although it makes a
nominal request for its design flow rate it can operate at varying flow rates. ConstantFlow is
useful for constant speed pumping arrangements where the chillers request for flow is
stricter and can increase the overall loop flow. LeavingSetpointModulated changes the chiller
model to internally vary the flow rate so that the temperature leaving the chiller matches a
setpoint at the evaporator outlet. For this absorption chiller, this mode also affects the flow
rate on the generator connection. In all cases the operation of the external plant system can
also impact the flow through the chiller -- for example if the relative sizes and operation are
such that flow is restricted and the requests cannot be met. The default, if not specified, is
NotModulated. This flow mode does not impact the condenser loop connection.
Field: Generator Fluid Type
This choice field specifies the type of fluid used to heat the generator solution. The valid
choices are HotWater or Steam. This field should be specified as Steam or left blank if the
generator inlet/outlet nodes are not specified.
Field: Design Generator Fluid Flow Rate
This numeric field contains the absorption chillers design condenser fluid flow rate in cubic
meters per second.
Field: Degree of Subcooling in Steam Generator
Ideally, the steam trap located at the outlet of the generator should remove all the
condensate immediately, however, there is a delay in this process in actual systems which
causes the condensate to SubCool by a certain amount before leaving the generator. This
amount of subcooling is included in the heat transferred to the solution in the generator. The
minimum value is 0 Celsius and default is 5 Celsius. This field is not used when the
generator inlet/outlet node are not specified or the generator is connected to a hot water loop.
Field: Sizing Factor
This optional numeric field allows the user to specify a sizing factor for this component. The
sizing factor is used when the component design inputs are autosized: the autosizing
9/29/14

567

Input-Output Reference

Group Plant Equipment

calculations are performed as usual and the results are multiplied by the sizing factor. For this
component the inputs that would be altered by the sizing factor are: Nominal Capacity,
Nominal Pumping Power, Design Chilled Water Flow Rate, Design Condenser Water Flow
Rate and Design Generator Fluid Flow Rate. Sizing factor allows the user to size a
component to meet part of the design load while continuing to use the autosizing feature.
Following is an example input for an Absorption Chiller.
Chiller:Absorption,
Big Chiller,
!- Chiller Name
50000,
!- Nominal Capacity {W}
250,
!- Nominal Pumping Power {W}
Big Chiller Inlet Node, !- Plant_Side_Inlet_Node
Big Chiller Outlet Node, !- Plant_Side_Outlet_Node
Big Chiller Condenser Inlet Node, !- Condenser_Side_Inlet_Node
Big Chiller Condenser Outlet Node, !- Condenser_Side_Outlet_Node
0.15,
!- Minimum Part Load Ratio
1.0,
!- Maximum Part Load Ratio
0.65,
!- Opt Part Load Ratio
35.0,
!- Temp Design Condenser Inlet {C}
0.0011,
!- Design Chilled Water Flow Rate {m3/s}
0.0011,
!- Design Condenser Water Flow Rate {m3/s}
0.03303,
!- Coefficient1 of the steam use part load ratio curve
0.6852,
!- Coefficient2 of the steam use part load ratio curve
0.2818,
!- Coefficient3 of the steam use part load ratio curve
1.0,
!- Coefficient1 of the pump electric use part load ratio curve
0,
!- Coefficient2 of the pump electric part load ratio curve
0,
!- Coefficient3 of the pump electric use part load ratio curve
5,
!- Chilled Water Outlet Temperature Lower Limit {C}
AbsorberSteamInletNode, !- Generator Inlet Node Name
AbsorberSteamOutletNode, !- Generator Outlet Node Name
VariableFlow,
!- Chiller Flow Mode
Steam,
!- Generator Fluid Type
autosize,
!- Design Generator Volumetric Fluid Flow Rate {m3/s}
2.0;
!- Degree of Subcooling in Steam Generator {C}

Absorption Chiller Outputs

HVAC,Average,Chiller Electric Power [W]
HVAC,Sum,Chiller Electric Energy [J]
Zone,Meter,Electricity:Plant [J]
Zone,Meter,Cooling:Electricity [J]
HVAC,Average,Chiller Evaporator Cooling Rate [W]
HVAC,Sum,Chiller Evaporator Cooling Energy [J]
Zone,Meter,EnergyTransfer:Plant [J]
Zone,Meter,Chillers:EnergyTransfer [J]
HVAC,Average,Chiller Evaporator Inlet Temperature [C]
HVAC,Average,Chiller Evaporator Outlet Temperature [C]
HVAC,Average,Chiller Evaporator Mass Flow Rate [kg/s]
HVAC,Average,Chiller Condenser Heat Transfer Rate [W]
HVAC,Sum,Chiller Condenser Heat Transfer Energy [J]
Zone,Meter,HeatRejection:EnergyTransfer [J]
HVAC,Average,Chiller Condenser Inlet Temperature [C]
HVAC,Average,Chiller Condenser Outlet Temperature [C]
HVAC,Average,Chiller Condenser Mass Flow Rate [kg/s]
HVAC,Average,Chiller COP [W/W]
For Chillers with Steam Generators:
HVAC,Average, Chiller Source Steam Rate [W]
HVAC,Sum, Chiller Source Steam Energy [J]
HVAC,Average,Chiller Steam Mass Flow Rate [kg/s]
For Chillers with Hot Water Generators:
HVAC,Average,Chiller Source Hot Water Rate [W]
9/29/14

568

Input-Output Reference

Group Plant Equipment

HVAC,Sum,Chiller Source Hot Water Energy [J]

HVAC,Average,Chiller Hot Water Mass Flow Rate [kg/s]

These chiller output variables are defined above under "Generic Chiller Outputs."
Chiller:Absorption:Indirect
The Chiller:Absorption:Indirect object is an enhanced version of the absorption chiller model
found in the Building Loads and System Thermodynamics (BLAST) program. This enhanced
model is nearly identical to the existing absorption chiller model (Ref. Chiller:Absorption) with
the exceptions that: 1) the enhanced indirect absorption chiller model provides more flexible
performance curves and 2) chiller performance now includes the impact of varying
evaporator, condenser, and generator temperatures. Since these absorption chiller models
are nearly identical (i.e., the performance curves of the enhanced model can be manipulated
to produce similar results to the previous model), it is quite probable that the
Chiller:Absorption model will be deprecated in a future release of EnergyPlus.
Field: Name
This required alpha field contains the identifying name for the indirect absorption chiller.
Field: Nominal Capacity
This required numeric field contains the nominal cooling capability of the chiller in Watts. This
field must be greater than 0 and is autosizable.
Field: Nominal Pumping Power
This required numeric field contains the nominal pumping power of the chiller in Watts. The
minimum value for this field is 0 and is autosizable.
Field: Chilled Water Inlet Node Name
This required alpha field contains the identifying name for the chiller chilled water inlet node.
Field: Chilled Water Outlet Node Name
This required alpha field contains the identifying name for the chiller chilled water outlet node.
Field: Condenser Inlet Node Name
This required alpha field contains the identifying name for the chiller condenser inlet node.
Field: Condenser Outlet Node Name
This required alpha field contains the identifying name given to the chiller outlet node.
Field: Minimum Part Load Ratio
This numeric field contains the chillers minimum part-load ratio. The expected range is
between 0 and 1. The minimum part load is not the load where the machine shuts off, but
where the amount of power remains constant to produce smaller loads than this fraction.
Field: Maximum Part Load Ratio
This numeric field contains the chillers maximum part-load ratio. This value may exceed 1,
but the normal range is between 0 and 1.1.
Field: Optimum Part Load Ratio
This numeric field contains the chillers optimum part-load ratio. This is the part-load ratio at
which the chiller performs at its maximum COP.

9/29/14

569

Input-Output Reference

Group Plant Equipment

Field: Design Condenser Inlet Temperature

This numeric field contains the chillers condenser inlet design temperature in Celsius. The
default value for this field is 30 C and is only used when the Design Chilled Water Flow Rate
is autosized.
Field: Condenser Inlet Temperature Lower Limit
This numeric field contains the chillers lower limit for the condenser entering water
temperature in Celsius. The default value for this field is 15 C. If this limit is exceeded, a
warning message will report the incident. No correction to chiller capacity is made for low
condenser entering water temperatures.
Field: Chilled Water Outlet Temperature Lower Limit
This numeric field contains the chillers lower limit for the evaporator leaving water
temperature in Celsius. The default value for this field is 5 C. If this limit is exceeded, a
warning message will report the incident. No correction to chiller capacity is made for low
evaporator leaving water temperatures.
Field: Design Chilled Water Flow Rate
This numeric input specifies the design evaporator volumetric flow rate in cubic meters per
second. The value specified must be greater than 0 or this field is autosizable. For variable
volume chiller this is the maximum flow and for constant flow chiller this is the design flow
rate.
Field: Design Condenser Water Flow Rate
This numeric field specifies the chillers design condenser water flow rate in cubic meters per
second. The value specified must be greater than 0 or this field is autosizable.
Field: Chiller Flow Mode
This choice field determines how the chiller operates with respect to the intended fluid flow
through the devices evaporator. There are three different choices for specifying operating
modes for the intended flow behavior:
NotModulated, ConstantFlow, and
LeavingSetpointModulated. NotModulated is useful for either variable or constant speed
pumping arrangements where the chiller is passive in the sense that although it makes a
nominal request for its design flow rate it can operate at varying flow rates. ConstantFlow is
useful for constant speed pumping arrangements where the chillers request for flow is
stricter and can increase the overall loop flow. LeavingSetpointModulated changes the chiller
model to internally vary the flow rate so that the temperature leaving the chiller matches a
setpoint at the evaporator outlet. For this absorption chiller, this mode also affects the flow
rate on the generator connection. In all cases the operation of the external plant system can
also impact the flow through the chiller -- for example if the relative sizes and operation are
such that flow is restricted and the requests cannot be met. The default, if not specified, is
NotModulated. This flow mode does not impact the condenser loop connection.
Field: Generator Heat Input Function of Part Load Ratio Curve Name
This required alpha field specifies the name of the curve used to determine the heat input to
the chiller. The curve is a quadratic or cubic curve which characterizes the heat input as a
function of chiller part-load ratio. The curve output is multiplied by the chillers nominal
capacity and operating part-load ratio or minimum part-load ratio, whichever is greater, to
determine the amount of heat input required for the given operating conditons.
Field: Pump Electric Input Function of Part Load Ratio Curve Name
This alpha field specifies the name of the curve used to determine the pump electrical input to
the chiller. The curve is a quadratic or cubic curve which characterizes the pump electrical
power as a function of chiller part-load ratio. The curve output is multiplied by the chillers
nominal pumping power and operating part-load ratio or minimum part-load ratio, whichever
9/29/14

570

Input-Output Reference

Group Plant Equipment

is greater, to determine the amount of pumping power required for the given operating
conditons.
Field: Generator Inlet Node Name
This alpha field contains the identifying name given to the Generator Inlet Node. A steam or
hot water loop is not required to simulate an indirect absorption chiller. If a steam/hot water
loop is used, enter the name of the generator inlet node.
Field: Generator Outlet Node Name
This alpha field contains the identifying name given to the Generator Outlet Node. A steam or
hot water loop is not required to simulate an indirect absorption chiller. If a steam/hot water
loop is used, enter the name of the generator outlet node.
Field: Capacity Correction Function of Condenser Temperature Curve Name
This alpha field specifies the name of a quadratic or cubic curve which correlates the chillers
evaporator capacity as a function of condenser entering water temperature. This curve is
used to correct nominal capacity at off-design condensing temperatures.
Field: Capacity Correction Function of Chilled Water Temperature Curve Name
This alpha field specifies the name of a quadratic or cubic curve which correlates the chillers
evaporator capacity as a function of evaporator leaving water temperature. This curve is used
to correct nominal capacity at off-design evaporator temperatures.
Field: Capacity Correction Function of Generator Temperature Curve Name
This alpha field specifies the name of a quadratic or cubic curve which correlates the chillers
evaporator capacity as a function of generator entering water temperature. This curve is used
to correct nominal capacity at off-design evaporator temperatures and is only used when the
Generator Fluid Type is specified as Hot Water.
Field: Generator Heat Input Correction Function of Condenser Temperature Curve Name
This alpha field specifies the name of a quadratic or cubic curve which correlates the chillers
heat input as a function of condenser entering water temperature. This curve is used to
correct generator heat input at off-design condensing temperatures.
Field: Generator Heat Input Correction Function of Chilled Water Temperature Curve Name
This alpha field specifies the name of a quadratic or cubic curve which correlates the chillers
heat input as a function of evaporator leaving water temperature. This curve is used to
correct generator heat input at off-design evaporator temperatures.
Field: Generator Heat Source Type
This choice field specifies the type of fluid used to heat the generator solution. The valid
choices are HotWater or Steam. This input is used to identify the method used to calculate
the generator mass flow rate. This field is not used if the generator inlet/outlet nodes are not
specified. The default value is Steam.
Field: Design Generator Fluid Flow Rate
This numeric field specifies the chillers design generator fluid flow rate in cubic meters per
second. The value specified must be greater than 0 or this field is autosizable. For variable
flow chillers this is the maximum generator flow rate, for constant flow chillers this is the flow
rate.
Field: Temperature Lower Limit Generator Inlet
This numeric field specifies the lower limit of the generators entering water temperature. This
field is not used iif the Generator Fluid Type is specified as steam.

9/29/14

571

Input-Output Reference

Group Plant Equipment

Field: Degree of Subcooling in Steam Generator

Ideally the steam trap located at the outlet of generator should remove all the condensate
immediately, however there is a delay in this process in actual systems which causes the
condensate to SubCool by a certain degree before leaving the generator. This amount of
subcooling is included in the heat transferred to the solution in the generator. The minimum
value is 0 Celsius, the maximum value is 20 Celsius, and the default is 1 Celsius.
Field: Degree of Subcooling in Steam Condensate Loop
This essentially represents the heat loss to the atmosphere due to uninsulated condensate
return piping to the boiler. Condensate return piping operates at atmospheric pressure and is
not insulated. The condensate sub cools to certain degree before it is pumped back to the
boiler. The minimum value is 0 Celsius and the default is 0 Celsius.
Field: Sizing Factor
This optional numeric field allows the user to specify a sizing factor for this component. The
sizing factor is used when the component design inputs are autosized: the autosizing
calculations are performed as usual and the results are multiplied by the sizing factor. For this
component the inputs that would be altered by the sizing factor are: Nominal Capacity,
Nominal Pumping Power, Design Chilled Water Flow Rate, Design Condenser Water Flow
Rate and Design Generator Fluid Flow Rate. Sizing factor allows the user to size a
component to meet part of the design load while continuing to use the autosizing feature.
Following is an example input for an Absorption Chiller.
Chiller:Absorption:Indirect,
Big Chiller,
!- Chiller Name
100000,
!- Nominal Capacity {W}
250,
!- Nominal Pumping Power {W}
Big Chiller Inlet Node, !- Evaporator Inlet Node Name
Big Chiller Outlet Node, !- Evaporator Outlet Node Name
Big Chiller Condenser Inlet Node, !- Condenser Inlet Node Name
Big Chiller Condenser Outlet Node, !- Condenser Outlet Node Name
0.15,
!- Minimum Part Load Ratio
1.0,
!- Maximum Part Load Ratio
0.65,
!- Opt Part Load Ratio
35.0,
!- Temp Design Condenser Inlet {C}
10.0,
!- Temp Lower Limit Condenser Inlet {C}
5.0,
!- Chilled Water Outlet Temperature Lower Limit {C}
0.0011,
!- Design Chilled Water Flow Rate {m3/s}
0.0011,
!- Design Condenser Water Flow Rate {m3/s}
VariableFlow,
!- Chiller Flow Mode
SteamUseFPLR,
!- Generator Heat Input function of part-load ratio curve name
PumpUseFPLR,
!- Pump Electric Input function of part-load ratio curve name
AbsorberSteamInletNode, !- Generator Inlet Node Name
AbsorberSteamOutletNode, !- Generator Outlet Node Name
CAPfCOND,
!- Capacity Correction function of condenser temperature curve name
CAPfEVAP,
!- Capacity Correction function of evaporator temperature curve name
,
!- Capacity Correction function of generator temperature curve name
SteamFCondTemp,
!- Generator Heat Input Correction function of condenser temperature curve name
SteamFEvapTemp,
!- Generator Heat Input Correction function of evaporator temperature curve name
Steam,
!- Generator Heat Source Type
autosize,
!- Design Generator Volumetric Fluid Flow Rate {m3/s}
30.0,
!- Temp Lower Limit Generator Inlet {C}
2.0,
!- Degree of Subcooling in Steam Generator {C}
12.0;
!- Degree of Subcooling in Steam Condensate Loop {C}

Indirect Absorption Chiller Outputs

HVAC,Average,Chiller Electric Power [W]
HVAC,Sum,Chiller Electric Energy [J]
Zone,Meter,Electricity:Plant [J]
Zone,Meter,Cooling:Electricity [J]

9/29/14

572

Input-Output Reference

Group Plant Equipment

HVAC,Average,Chiller Evaporator Cooling Rate [W]

HVAC,Sum,Chiller Evaporator Cooling Energy [J]
Zone,Meter,EnergyTransfer:Plant [J]
Zone,Meter,Chillers:EnergyTransfer [J]
HVAC,Average,Chiller Evaporator Inlet Temperature [C]
HVAC,Average,Chiller Evaporator Outlet Temperature [C]
HVAC,Average,Chiller Evaporator Mass Flow Rate [kg/s]
HVAC,Average,Chiller Condenser Heat Transfer Rate [W]
HVAC,Sum,Chiller Condenser Heat Transfer Energy [J]
Zone,Meter,HeatRejection:EnergyTransfer [J]
HVAC,Average,Chiller Condenser Inlet Temperature [C]
HVAC,Average,Chiller Condenser Outlet Temperature [C]
HVAC,Average,Chiller Condenser Mass Flow Rate [kg/s]
HVAC,Average,Chiller COP [W/W]
HVAC,Average,Chiller Part-Load Ratio
HVAC,Average,Chiller Cycling Ratio
For Chillers with Steam Generators:
HVAC,Average, Chiller Source Steam Rate [W]
HVAC,Sum, Chiller Source Steam Energy [J]
Zone,Meter,Steam:Plant [J]
Zone,Meter,Cooling:Steam [J]
HVAC,Average, Chiller Steam Mass Flow Rate [kg/s]
HVAC,Average, Chiller Steam Heat Loss Rate [W]
For Chillers with Hot Water Generators:
HVAC,Average, Chiller Source Hot Water Rate [W]
HVAC,Sum, Chiller Source Hot Water Energy [J]
Zone,Meter,EnergyTransfer:Plant [J]
Zone,Meter,Cooling:EnergyTransfer [J]
HVAC,Average, Chiller Hot Water Mass Flow Rate [kg/s]

These chiller output variables are defined above under "Generic Chiller Outputs."
Chiller:ConstantCOP
This chiller model is based on a simple, constant COP simulation of the chiller. In this case,
performance does not vary with chilled water temperature or condenser conditions.
Such a model is useful when the user does not have access to detailed performance data.
Field: Name
This alpha field contains the identifying name for the constant COP chiller.
Field: Nominal Capacity
This numeric field contains the nominal cooling capability of the chiller in Watts.
Field: Nominal COP
This numeric field contains the Chillers coefficient of performance.
Field: Design Chilled Water Flow Rate
For variable volume chiller this is the maximum flow and for constant flow chiller this is the
design flow rate. The units are in cubic meters per second.
Field: Design Condenser Water Flow Rate
This numeric field contains the electric chillers design condenser water flow rate in cubic
meters per second. This field is autosizable. This field is not used for Condenser Type =
AirCooled or EvaporativelyCooled.

9/29/14

573

Input-Output Reference

Group Plant Equipment

Field: Chilled Water Inlet Node Name

This required alpha field contains the identifying name for the constant COP chiller plant side
inlet node.
Field: Chilled Water Outlet Node Name
This required alpha field contains the identifying name for the constant COP chiller plant side
outlet node.
Field: Condenser Inlet Node Name
This alpha field contains the identifying name for the constant COP chiller condenser side
inlet node. This node name is required if the chiller is WaterCooled, and optional if the chiller
is AirCooled or EvaporativelyCooled. If the chiller is AirCooled or EvaporativelyCooled and a
condenser inlet node name is specified here, the node name specified must also be specified
in an OutdoorAir:Node object where the height of the node is taken into consideration when
calculating outdoor air temperature from the weather data. Alternately, the node name may
be specified in an OutdoorAir:NodeList object where the outdoor air temperature is taken
directly from the weather data. If the chiller is AirCooled or EvaporativelyCooled and this field
is left blank, the program automatically creates an outdoor air node and the air temperature
information on this node is taken directly from the weather file (no node height adjustment).
Field: Condenser Outlet Node Name
This alpha field contains the identifying name for the constant COP chiller condenser side
outlet node. This node name is required if the chiller is WaterCooled, and optional if the
chiller is AirCooled or EvaporativelyCooled. If the chiller is AirCooled or EvaporativelyCooled
and this field is left blank, the program automatically creates a condenser side outlet air node.
Field: Condenser Type
This alpha field determines what type of condenser will be modeled with this chiller. The 3
type of condensers are AirCooled, WaterCooled, and EvaporativelyCooled with the default
being AirCooled if not specified. AirCooled and EvaporativelyCooled do not require a
CondenserLoop to be specified, whereas the WaterCooled option requires the full
specification of the CondenserLoop and its associated equipment.
Field: Chiller Flow Mode
This choice field determines how the chiller operates with respect to the intended fluid flow
through the devices evaporator. There are three different choices for specifying operating
modes for the intended flow behavior:
NotModulated, ConstantFlow, and
LeavingSetpointModulated. NotModulated is useful for either variable or constant speed
pumping arrangements where the chiller is passive in the sense that although it makes a
nominal request for its design flow rate it can operate at varying flow rates. ConstantFlow is
useful for constant speed pumping arrangements where the chillers request for flow is
stricter and can increase the overall loop flow. LeavingSetpointModulated changes the chiller
model to internally vary the flow rate so that the temperature leaving the chiller matches a
setpoint. In all cases the operation of the external plant system can also impact the flow
through the chiller -- for example if the relative sizes and operation are such that flow is
restricted and the requests cannot be met. The default, if not specified, is NotModulated.
Field: Sizing Factor
This optional numeric field allows the user to specify a sizing factor for this component. The
sizing factor is used when the component design inputs are autosized: the autosizing
calculations are performed as usual and the results are multiplied by the sizing factor. For this
component the inputs that would be altered by the sizing factor are: Nominal Capacity,
Design Chilled Water Flow Rate and Design Condenser Water Flow Rate. Sizing Factor
allows the user to size a component to meet part of the design load while continuing to use
the autosizing feature.
9/29/14

574

Input-Output Reference

Group Plant Equipment

Field: Basin Heater Capacity

This numeric field contains the capacity of the chillers electric basin heater in watts per
degree Kelvin. This field only applies for Condenser Type = EvaporativelyCooled. This field is
used in conjunction with the Basin Heater Setpoint Temperature described in the following
field. The basin heater electric power is equal to this field multiplied by the difference between
the basin heater set point temperature and the outdoor dry-bulb temperature. The basin
heater only operates when the chiller is off, regardless of the basin heater schedule
described below. The basin heater capacity must be greater than or equal to zero, with a
default value of zero if this field is left blank.
Field: Basin Heater Setpoint Temperature
This numeric field contains the set point temperature (C) for the basin heater described in
the previous field. This field only applies for Condenser Type = EvaporativelyCooled. The
basin heater is active when the outdoor air dry-bulb temperature falls below this setpoint
temperature, as long as the chiller is off. This set point temperature must be greater than or
equal to 2C, and the default value is 2C if this field is left blank.
Field: Basin Heater Operating Schedule Name
This alpha field contains the name of the basin heater operating schedule. This field only
applies for Condenser Type = EvaporativelyCooled. The basin heater operating schedule is
assumed to be an on/off schedule and the heater is available to operate any time the
schedule value is greater than 0. The basin heater operates when scheduled on and the
outdoor air dry-bulb temperature is below the set point temperature described in the previous
field. If this field is left blank, the basin heater is available to operate throughout the
simulation. Regardless of this schedule, the basin heater may only operate when the chiller is
off.
An example of this statement in an IDF is:
Chiller:ConstantCOP, Little Chiller,
25000,
! Nominal Capacity [W]
2.5,
! COP
0.0011,
! Design Chilled Water Flow Rate [m3/s]
0.0011,
! Design Condenser Water Flow Rate [m3/s]
Little Chiller Inlet Node, Little Chiller Outlet Node,
Little Chiller Condenser Inlet Node, Little Chiller Condenser Outlet Node,
WaterCooled,
VariableFlow;
Chiller:ConstantCOP,
Little Chiller,
!- Name
25000,
!- Nominal Capacity {W}
2.5,
!- Nominal COP {W/W}
0.0011,
!- Design Chilled Water Flow Rate {m3/s}
0.0011,
!- Design Condenser Water Flow Rate {m3/s}
Little Chiller Inlet Node,
!- Chilled Water Inlet Node Name
Little Chiller Outlet Node, !- Chilled Water Outlet Node Name
Little Chiller Condenser Inlet Node,
!- Condenser Inlet Node Name
Little Chiller Condenser Outlet Node, !- Condenser Outlet Node Name
EvaporativelyCooled,
!- Condenser Type
VariableFlow,
!- Chiller Flow Mode
,
!- Sizing Factor
450;
!- Basin Heater Capacity {W/K}

Constant COP Chiller Outputs

HVAC,Average,Chiller Electric Power [W]
HVAC,Sum,Chiller Electric Energy [J]
Zone,Meter,Electricity:Plant [J]
Zone,Meter,Cooling:Electricity [J]

9/29/14

575

Input-Output Reference

Group Plant Equipment

HVAC,Average,Chiller Evaporator Cooling Rate [W]

HVAC,Sum,Chiller Evaporator Cooling Energy [J]
Zone,Meter,EnergyTransfer:Plant [J]
Zone,Meter,Chillers:EnergyTransfer [J]
HVAC,Average,Chiller Evaporator Inlet Temperature [C]
HVAC,Average,Chiller Evaporator Outlet Temperature [C]
HVAC,Average,Chiller Evaporator Mass Flow Rate [kg/s]
HVAC,Average,Chiller Condenser Heat Transfer Rate [W]
HVAC,Sum,Chiller Condenser Heat Transfer Energy [J]
Zone,Meter,HeatRejection:EnergyTransfer [J]
Air-cooled or Evap-cooled:
HVAC,Average,Chiller Condenser Inlet Temperature [C]
Evap-cooled:
HVAC,Average,Chiller Basin Heater Electric Power [W]
HVAC,Average,Chiller Basin Heater Electric Energy [J]
Water-cooled:
HVAC,Average,Chiller Condenser Inlet Temperature [C]
HVAC,Average,Chiller Condenser Outlet Temperature [C]
HVAC,Average,Chiller Condenser Mass Flow Rate [kg/s]

These chiller output variables are defined above under "Generic Chiller Outputs."
Chiller:Electric
This chiller model is the empirical model from the Building Loads and System
Thermodynamics (BLAST) program. Capacity, power, and full load are each defined by a set
of performance curves (quadratics). Chiller performance curves are generated by fitting
catalog data to third order polynomial equations. The nominal inputs and curves described
below are combined as follows to calculate the chiller power:

Power = FracFullLoadPower FullLoadPowerRat AvailToNominalCapacityRatio

NominalCapacity
COP

where:
NominalCapacity = Nominal Capacity field
COP = COP field
AvailToNominalCapacityRatio = the result of the Capacity Ratio Curve
FullLoadPowerRat = the result of the Power Ratio Curve
FracFullLoadPower = the result of the Full Load Ratio Curve
Field: Name
This alpha field contains the identifying name for the electric chiller.
Field: Condenser Type
This alpha field determines what type of condenser will be modeled with this chiller. The 3
type of condensers are AirCooled, WaterCooled, and EvaporativelyCooled with the default
being AirCooled if not specified. AirCooled and EvaporativelyCooled do not require a
Condenser Loop to be specified, where the WaterCooled option requires the full specification
of the Condenser Loop and its associated equipment.
Field: Nominal Capacity
This numeric field contains the nominal cooling capability of the chiller in Watts.

9/29/14

576

Input-Output Reference

Group Plant Equipment

Field: Nominal COP

This numeric field contains the chillers coefficient of performance. For a water-cooled chiller,
this number does not include energy use due to condenser pumps and/or fans. For an aircooled or evap-cooled chiller, this number includes condenser fan power.
Field: Chilled Water Inlet Node Name
This required alpha field contains the identifying name for the electric chiller plant side inlet
node.
Field: Chilled Water Outlet Node Name
This required alpha field contains the identifying name for the electric chiller plant side outlet
node.
Field: Condenser Inlet Node Name
This alpha field contains the identifying name for the electric chiller condenser side inlet node.
This node name is required if the chiller is WaterCooled, and optional if the chiller is
AirCooled or EvaporativelyCooled. If the chiller is AirCooled or EvaporativelyCooled and a
condenser inlet node name is specified here, the node name specified must also be specified
in an OutdoorAir:Node object where the height of the node is taken into consideration when
calculating outdoor air temperature from the weather data. Alternately, the node name may
be specified in an OutdoorAir:NodeList object where the outdoor air temperature is taken
directly from the weather data. If the chiller is AirCooled or EvaporativelyCooled and this field
is left blank, the program automatically creates an outdoor air node and the air temperature
information on this node is taken directly from the weather file (no node height adjustment).
Field: Condenser Outlet Node Name
This alpha field contains the identifying name for the electric chiller condenser side outlet
node. This node name is required if the chiller is WaterCooled, and optional if the chiller is
AirCooled or EvaporativelyCooled. If the chiller is AirCooled or EvaporativelyCooled and this
field is left blank, the program automatically creates a condenser side outlet air node.
Field: Minimum Part Load Ratio
This numeric field contains the electric chillers minimum part load ratio. The expected range
is between 0 and 1. The minimum part load is not the load where the machine shuts off, but
where the amount of power remains constant to produce smaller loads than this fraction.
Field: Maximum Part Load Ratio
This numeric field contains the electric chillers maximum part load ratio. This value may
exceed 1, but the normal range is between 0 and 1.1.
Field: Optimum Part Load Ratio
This numeric field contains the electric chillers optimum part load ratio. This is the part load
ratio at which the chiller performs at its maximum COP.
Field: Design Condenser Inlet Temperature
This numeric field contains the electric chillers condenser inlet design temperature in
Celsius.
Field: Temperature Rise Coefficient
This numeric field contains the electric chillers temperature rise coefficient which is defined
as the ratio of the required change in condenser water temperature to a given change in
chilled water temperature, which maintains the capacity at the nominal value. This is
calculated as the following ratio:

9/29/14

577

Input-Output Reference

Group Plant Equipment

TCEntrequired TCEntrated
TELvrequired TELvrated
where:
TCEntrequired = Required entering condenser air or water temperature to maintain rated
capacity.
TCEntrated = Rated entering condenser air or water temperature at rated capacity.
TELvrequired = Required leaving evaporator water outlet temperature to maintain rated
capacity.
TELvrated = Rated leaving evaporator water outlet temperature at rated capacity.
Field: Design Chilled Water Outlet Temperature
This numeric field contains the electric chillers evaporator outlet design temperature in
Celsius.
Field: Design Chilled Water Flow Rate
For variable volume chiller this is the maximum flow and for constant flow chiller this is the
design flow rate. The units are in cubic meters per second.
Field: Design Condenser Fluid Flow Rate
This numeric field contains the electric chillers design condenser water flow rate in cubic
meters per second. This field is autosizable. This field is also used to enter the air flow rate if
the Condenser Type = AirCooled or EvaporativelyCooled and Heat Recovery is specified.
Capacity Ratio Curve
The Capacity Ratio Curve is a quadratic equation that determines the Ratio of Available
Capacity to Nominal Capacity. The defining equation is:

AvailToNominalCapacityRatio C1 C2

temp

C3

2
temp

Where the Delta Temperature is defined as:

Temp

TempCondIn - TempCondInDesign
TempRiseCoefficient

(TempEvapOut - TempEvapOutDesign)

TempCondIn = Temperature entering the condenser (water or air temperature depending on

condenser type).
TempCondInDesign = Design Condenser Inlet Temperature from User input above.
TempEvapOut = Temperature leaving the evaporator.
TempEvapOutDesign = Design Chilled Water Outlet Temperature from User input above.
TempRiseCoefficient = User Input from above.
The following three fields contain the coefficients for the quadratic equation.
Field: Coefficient 1 of Capacity Ratio Curve
This numeric field contains the first coefficient for the capacity ratio curve.
Field: Coefficient 2 of Capacity Ratio Curve
This numeric field contains the second coefficient for the capacity ratio curve.
Field: Coefficient 3 of Capacity Ratio Curve
This numeric field contains the third coefficient for the capacity ratio curve.

9/29/14

578

Input-Output Reference

Group Plant Equipment

Power Ratio Curve

The Power Ratio Curve is a quadratic equation that determines the Ratio of Full Load Power
at Available Capacity to Full Load Power at Nominal Capacity. The defining equation is:

FullLoadPowerRatio C1 C2 AvailToNominalCapRatio C3 AvailToNominalCapRatio2

The following three fields contain the coefficients for the quadratic equation.
Field: Coefficient1 of the power ratio curve
This numeric field contains the first coefficient for the power ratio curve.
Field: Coefficient 2 of Power Ratio Curve
This numeric field contains the second coefficient for the power ratio curve.
Field: Coefficient 3 of Power Ratio Curve
This numeric field contains the third coefficient for the power ratio curve.
Full Load Ratio Curve
The Full Load Ratio Curve is a quadratic equation that determines the fraction of full load
power. The defining equation is:

FracFullLoadPower

C1 C2 PartLoadRatio C3 PartLoadRatio2

The following three fields contain the coefficients for the quadratic equation.
Field: Coefficient 1 of Full Load Ratio Curve
This numeric field contains the first coefficient for the full load ratio curve.
Field: Coefficient 2 of Full Load Ratio Curve
This numeric field contains the second coefficient for the full load ratio curve.
Field: Coefficient 3 of Full Load Ratio Curve
This numeric field contains the third coefficient for the full load ratio curve.
Field: Chilled Water Outlet Temperature Lower Limit
This numeric field contains the lower limit for the evaporator outlet temperature. This
temperature acts as a cut off for heat transfer in the evaporator, so that the fluid doesnt get
too cold.
Field: Chiller Flow Mode
This choice field determines how the chiller operates with respect to the intended fluid flow
through the devices evaporator. There are three different choices for specifying operating
modes for the intended flow behavior:
NotModulated, ConstantFlow, and
LeavingSetpointModulated. NotModulated is useful for either variable or constant speed
pumping arrangements where the chiller is passive in the sense that although it makes a
nominal request for its design flow rate it can operate at varying flow rates. ConstantFlow is
useful for constant speed pumping arrangements where the chillers request for flow is
stricter and can increase the overall loop flow. LeavingSetpointModulated changes the chiller
model to internally vary the flow rate so that the temperature leaving the chiller matches a
setpoint. In all cases the operation of the external plant system can also impact the flow
through the chiller -- for example if the relative sizes and operation are such that flow is
restricted and the requests cannot be met. The default, if not specified, is NotModulated.
Field: Design Heat Recovery Water Flow Rate
This is the design flow rate used if the heat recovery option is being simulated. If this value is
greater than 0.0 then a heat recovery loop must be specified and attached to the chiller using
9/29/14

579

Input-Output Reference

Group Plant Equipment

the next 2 node fields. To determine how the heat recovery algorithm works look at the
Enegineering Manual at the Chiller:Electric with Heat Recovery section. The units are in cubic
meters per second. This field is autosizable. When autosizing, the flow rate is simply the
product of the design condenser flow rate and the condenser heat recovery relative capacity
fraction set in the field below.
Field: Heat Recovery Inlet Node Name
This alpha field contains the identifying name for the electric chiller heat recovery side inlet
node. A heat recovery loop must be specified.
Field: Heat Recovery Outlet Node Name
This alpha field contains the identifying name for the electric chiller heat recovery side outlet
node. A heat recovery loop must be specified.
Field: Sizing Factor
This optional numeric field allows the user to specify a sizing factor for this component. The
sizing factor is used when the component design inputs are autosized: the autosizing
calculations are performed as usual and the results are multiplied by the sizing factor. For this
component the inputs that would be altered by the sizing factor are: Nominal Capacity,
Design Chilled Water Flow Rate and Design Condenser Water Flow Rate. Sizing Factor
allows the user to size a component to meet part of the design load while continuing to use
the autosizing feature.
Field: Basin Heater Capacity
This numeric field contains the capacity of the chillers electric basin heater in watts per
degree Kelvin. This field only applies for Condenser Type = EvaporativelyCooled. This field is
used in conjunction with the Basin Heater Setpoint Temperature described in the following
field. The basin heater electric power is equal to this field multiplied by the difference between
the basin heater set point temperature and the outdoor dry-bulb temperature. The basin
heater only operates when the chiller is off, regardless of the basin heater schedule
described below. The basin heater capacity must be greater than or equal to zero, with a
default value of zero if this field is left blank.
Field: Basin Heater Setpoint Temperature
This numeric field contains the set point temperature (C) for the basin heater described in
the previous field. This field only applies for Condenser Type = EvaporativelyCooled. The
basin heater is active when the outdoor air dry-bulb temperature falls below this setpoint
temperature, as long as the chiller is off. This set point temperature must be greater than or
equal to 2C, and the default value is 2C if this field is left blank.
Field: Basin Heater Operating Schedule Name
This alpha field contains the name of the basin heater operating schedule. This field only
applies for Condenser Type = EvaporativelyCooled. The basin heater operating schedule is
assumed to be an on/off schedule and the heater is available to operate any time the
schedule value is greater than 0. The basin heater operates when scheduled on and the
outdoor air dry-bulb temperature is below the set point temperature described in the previous
field. If this field is left blank, the basin heater is available to operate throughout the
simulation. Regardless of this schedule, the basin heater may only operate when the chiller is
off.
Field: Condenser Heat Recovery Relative Capacity Fraction
This field is optional. It can be used to describe the physical size of the heat recovery portion
of a split bundle condenser section. This fraction describes the relative capacity of the heat
recovery bundle of a split condenser compared to the nominal, full load heat rejection rate of
the chiller. This fraction will be applied to the full heat rejection when operating at nominal
9/29/14

580

Input-Output Reference

Group Plant Equipment

capacity and nominal COP to model a capacity limit for the heat rejection. If this field is not
entered then the capacity fraction is set to 1.0.
Field: Heat Recovery Inlet High Temperature Limit Schedule Name
This field is optional. It can be used to control heat recovery operation of the chiller. The
schedule named here should contain temperature values, in C, that describe an upper limit
for the return fluid temperatures entering the chiller at the heat recovery inlet node. If the fluid
temperature is too high, then the heat recovery will not operate. This is useful to restrict the
chiller lift from becoming too high and to avoid overheating the hot water loop. This limit can
be used with or without the alternate control using leaving setpoint that is set in the next field.
Field: Heat Recovery Leaving Temperature Setpoint Node Name
This field is optional. It can be used to refine the model and controls for heat recovery
operation of the chiller. The node named here should have a setpoint placed on it by a
setpoint manager. If the plant loops demand calculation scheme is set to SingleSetpoint,
then a single setpoint manager should be used. If the plant loops demand calculation is set
to DualSetpointDeadband then a dual setpoint manager should be used and the upper
setpoint is used for control. When this field is used, a different model is used for determining
the distribution of rejected heat between the two bundles that is more appropriate for series
bundle arrangements and for chillers that are able to produce relatively higher temperature
heated fluids.
An example of this statement in an IDF is:
Chiller:Electric,
Big Chiller,
!- Chiller Name
WaterCooled,
!- Condenser Type
100000,
!- Nominal Capacity {W}
2.75,
!- COP
Big Chiller Inlet Node, !- Chilled Water Inlet Node Name
Big Chiller Outlet Node, !- Chilled Water Outlet Node Name
Big Chiller Condenser Inlet Node, !- Condenser Inlet Node Name
Big Chiller Condenser Outlet Node, !- Condenser Outlet Node Name
.15,
!- Minimum Part Load Ratio
1.0,
!- Maximum Part Load Ratio
.65,
!- Optimum Part Load Ratio
29.44,
!- Design Condenser Inlet Temperature {C}
2.682759,
!- Temperature Rise Coefficient
6.667,
!- Design Chilled Water Outlet Temperature {C}
0.0011,
!- Design Chilled Water Flow Rate {m3/s}
0.0005,
!- Design Condenser Water Flow Rate {m3/s}

0.94483600,
-.05700880,
-.00185486,
1.907846,
-1.20498700,
0.26346230,
0.03303,
0.6852,
0.2818,
5,
VariableFlow;

!!!!!!!!!!!-

Coefficient 1 of Capacity Ratio Curve

Coefficient 2 of Capacity Ratio Curve
Coefficient 3 of Capacity Ratio Curve
Coefficient 1 of Power Ratio Curve
Coefficient 2 of Power Ratio Curve
Coefficient 3 of Power Ratio Curve
Coefficient 1 of Full Load Ratio Curve
Coefficient 2 of Full Load Ratio Curve
Coefficient 3 of Full Load Ratio Curve
Chilled Water Outlet Temperature Lower Limit {C}
Chiller Flow Mode

An example of an Air-Cooled Chiller:

9/29/14

581

Input-Output Reference

Group Plant Equipment

Chiller:Electric,
Big Chiller,
!- Chiller Name
AirCooled,
!- Condenser Type
100000,
!- Nominal Capacity {W}
2.58,
!- COP
Big Chiller Inlet Node, !- Chilled Water Inlet Node Name
Big Chiller Outlet Node, !- Chilled Water Outlet Node Name
Big Chiller Condenser Inlet Node, !- Condenser Inlet Node Name
Big Chiller Condenser Outlet Node, !- Condenser Outlet Node Name
.05,
!- Minimum Part Load Ratio
1.0,
!- Maximum Part Load Ratio
.65,
!- Optimum Part Load Ratio
35.0,
!- Design Condenser Inlet Temperature {C}
2.778,
!- Temperature Rise Coefficient
6.67,
!- Design Chilled Water Outlet Temperature {C}
0.0011,
!- Design Chilled Water Flow Rate {m3/s}
0.002,
!- Design Condenser Water Flow Rate {m3/s}
0.9949,
!- Coefficient 1 of Capacity Ratio Curve
-0.045954,
!- Coefficient 2 of Capacity Ratio Curve
-0.0013543,
!- Coefficient 3 of Capacity Ratio Curve
2.333,
!- Coefficient 1 of Power Ratio Curve
-1.975,
!- Coefficient 2 of Power Ratio Curve
0.6121,
!- Coefficient 3 of Power Ratio Curve
0.03303,
!- Coefficient 1 of Full Load Ratio Curve
0.6852,
!- Coefficient 2 of Full Load Ratio Curve
0.2818,
!- Coefficient 3 of Full Load Ratio Curve
5,
!- Chilled Water Outlet Temperature Lower Limit {C}
VariableFlow;
!- Chiller Flow Mode

OutdoorAir:Node,
Big Chiller Condenser Inlet Node, !- Node Name
-1.0;
!- Height Above Ground {m}

9/29/14

582

Input-Output Reference

Group Plant Equipment

An example of an Evaporatively-Cooled Chiller:

Chiller:Electric,
Big Chiller,
!- Name
EvaporativelyCooled,
!- Condenser Type
100000,
!- Nominal Capacity {W}
2.58,
!- Nominal COP
Big Chiller Inlet Node, !- Chilled Water Inlet Node Name
Big Chiller Outlet Node, !- Chilled Water Outlet Node Name
Big Chiller Condenser Inlet Node, !- Condenser Inlet Node Name
Big Chiller Condenser Outlet Node, !- Condenser Outlet Node Name
0.05,
!- Minimum Part Load Ratio
1.0,
!- Maximum Part Load Ratio
0.65,
!- Optimum Part Load Ratio
35.0,
!- Design Condenser Inlet Temperature {C}
2.778,
!- Temperature Rise Coefficient
6.67,
!- Design Chilled Water Outlet Temperature {C}
0.0011,
!- Design Chilled Water Flow Rate {m3/s}
0.002,
!- Design Condenser Water Flow Rate {m3/s}
0.9949,
!- Coefficient 1 of Capacity Ratio Curve
-0.045954,
!- Coefficient 2 of Capacity Ratio Curve
-0.0013543,
!- Coefficient 3 of Capacity Ratio Curve
2.333,
!- Coefficient 1 of Power Ratio Curve
-1.975,
!- Coefficient 2 of Power Ratio Curve
0.6121,
!- Coefficient 3 of Power Ratio Curve
0.03303,
!- Coefficient 1 of Full Load Ratio Curve
0.6852,
!- Coefficient 2 of Full Load Ratio Curve
0.2818,
!- Coefficient 3 of Full Load Ratio Curve
5,
!- Chilled Water Outlet Temperature Lower Limit {C}
VariableFlow,
!- Chiller Flow Mode
,
!- Design Heat Recovery Water Flow Rate {m3/s}
,
!- Heat Recovery Inlet Node Name
,
!- Heat Recovery Outlet Node Name
,
!- Sizing Factor
450,
!- Basin Heater Capacity {W/K}
3,
!- Basin Heater Setpoint Temperature {C}
Basin heater sch;
!- Basin Heater Operating Schedule Name
OutdoorAir:Node,
Big Chiller Condenser Inlet Node, !- Name
-1.0;
!- Height Above Ground {m}

An example of a Heat Recovery Chiller:

Chiller:Electric,
Big Chiller,
!- Chiller Name
WaterCooled,
!- Condenser Type
25000,
!- Nominal Capacity {W}
2.75,
!- COP
Big Chiller Inlet Node, !- Chilled Water Inlet Node Name
Big Chiller Outlet Node, !- Chilled Water Outlet Node Name
Big Chiller Condenser Inlet Node, !- Condenser Inlet Node Name
Big Chiller Condenser Outlet Node, !- Condenser Outlet Node Name
.15,
!- Minimum Part Load Ratio
1.0,
!- Maximum Part Load Ratio
.65,
!- Optimum Part Load Ratio
29.44,
!- Design Condenser Inlet Temperature {C}
2.682759,
!- Temperature Rise Coefficient
6.667,
!- Design Chilled Water Outlet Temperature {C}
0.0011,
!- Design Chilled Water Flow Rate {m3/s}
0.0005,
!- Design Condenser Water Flow Rate {m3/s}
0.94483600,
!- Coefficient 1 of Capacity Ratio Curve
-.05700880,
!- Coefficient 2 of Capacity Ratio Curve
-.00185486,
!- Coefficient 3 of Capacity Ratio Curve
1.907846,
!- Coefficient 1 of Power Ratio Curve
-1.20498700,
!- Coefficient 2 of Power Ratio Curve
0.26346230,
!- Coefficient 3 of Power Ratio Curve
0.03303,
!- Coefficient 1 of Full Load Ratio Curve
0.6852,
!- Coefficient 2 of Full Load Ratio Curve
0.2818,
!- Coefficient 3 of Full Load Ratio Curve

9/29/14

583

Input-Output Reference

Group Plant Equipment

5,
!- Chilled Water Outlet Temperature Lower Limit {C}
VariableFlow,
!- Chiller Flow Mode
0.00055,
!- Design heat recovery water flow rate {m3/s}
Big Chiller Heat Rec Inlet Node, !- Heat Recovery Inlet Node Name
Big Chiller Heat Rec Outlet Node; !- Heat Recovery Outlet Node Name

Electric Chiller Outputs

HVAC,Average,Chiller Electric Power [W]
HVAC,Sum,Chiller Electric Energy [J]
Zone,Meter,Electricity:Plant [J]
Zone,Meter,Cooling:Electricity [J]
HVAC,Average,Chiller Evaporator Cooling Rate [W]
HVAC,Sum,Chiller Evaporator Cooling Energy [J]
Zone,Meter,EnergyTransfer:Plant [J]
Zone,Meter,Chillers:EnergyTransfer [J]
HVAC,Average,Chiller Evaporator Inlet Temperature [C]
HVAC,Average,Chiller Evaporator Outlet Temperature [C]
HVAC,Average,Chiller Evaporator Mass Flow Rate [kg/s]
HVAC,Average,Chiller COP [W/W]
HVAC,Average,Chiller Condenser Heat Transfer Rate [W]
HVAC,Sum,Chiller Condenser Heat Transfer Energy [J]
Zone,Meter,HeatRejection:EnergyTransfer [J]
Air-cooled or Evap-cooled:
HVAC,Average,Chiller Condenser Inlet Temperature [C]
Evap-cooled:
HVAC,Average,Chiller Basin Heater Electric Power [W]
HVAC,Average,Chiller Basin Heater Electric Energy [J]
Water-cooled:
HVAC,Average,Chiller Condenser Inlet Temperature [C]
HVAC,Average,Chiller Condenser Outlet Temperature [C]
HVAC,Average,Chiller Condenser Mass Flow Rate [kg/s]
HeatRecovery:
HVAC,Average,Chiller Total Recovered Heat Rate [W]
HVAC,Sum, Chiller Total Recovered Heat Energy [J]
HVAC,Average,Chiller Heat Recovery Inlet Temperature [C]
HVAC,Average,Chiller Heat Recovery Outlet Temperature [C]
HVAC,Average,Chiller Heat Recovery Mass Flow Rate [kg/s]
HVAC,Average,Chiller Effective Heat Rejection Temperature [C]

These chiller output variables are defined above under "Generic Chiller Outputs."
Chiller:Electric:EIR
This chiller model is the empirical model used in the DOE-2.1 building energy simulation
program. The model uses performance information at reference conditions along with three
curve fits for cooling capacity and efficiency to determine chiller operation at off-reference
conditions. Chiller performance curves can be generated by fitting manufacturers catalog
data or measured data. Performance curves for more than 160 chillers, including the default
DOE-2.1E reciprocating and centrifugal chillers, are provided in the EnergyPlus Reference
DataSets (Chillers.idf and AllDataSets.idf).
Note: Chiller:Electric:EIR objects and their associated performance curve objects are developed using
performance information for a specific chiller and should normally be used together for an EnergyPlus

9/29/14

584

Input-Output Reference

Group Plant Equipment

simulation. Changing the object input values, or swapping performance curves between chillers, should be
done with caution.

Field: Name
This alpha field contains the identifying name for the electric EIR chiller.
Field: Reference Capacity
This numeric field contains the reference cooling capacity of the chiller in Watts. This should
be the capacity of the chiller at the reference temperatures and water flow rates defined
below. Alternately, this field can be autosized.
Field: Reference COP
This numeric field contains the chillers coefficient of performance. This value should not
include energy use due to pumps or cooling tower fans. This COP should be at the reference
temperatures and water flow rates defined below. This value should include evap-cooled or
air-cooled condenser fans except when the Condenser Fan Power Ratio input field defined
below is used and that input value is greater than 0. For the case when condenser fan power
is modeled separately, the calculated condenser fan energy is reported on the same electric
meter as compressor power. Be careful to not duplicate this energy use.
Field: Reference Leaving Chilled Water Temperature
This numeric field contains the chillers reference leaving chilled water temperature in
Celsius. The default value is 6.67C.
Field: Reference Entering Condenser Fluid Temperature
This numeric field contains the chillers reference entering condenser fluid temperature in
Celsius. The default value is 29.4C. For water-cooled chillers this is the water temperature
entering the condenser (e.g., leaving the cooling tower). For air- or evap-cooled condensers
this is the entering outdoor air dry-bulb or wet-bulb temperature, respectively.
Field: Reference Chilled Water Flow Rate
For a variable flow chiller this is the maximum water flow rate and for a constant flow chiller
this is the operating water flow rate through the chillers evaporator. The units are in cubic
meters per second. The minimum value for this numeric input field must be greater than zero,
or this field can be autosized.
Field: Reference Condenser Fluid Flow Rate
This numeric field contains the chillers operating condenser water flow rate in cubic meters
per second. This field can be autosized. This field is also used to enter the air flow rate if
Condenser Type = AirCooled or EvaporativelyCooled and Heat Recovery is specified..
Field: Cooling Capacity Function of Temperature Curve Name
The name of a biquadratic performance curve (ref: Performance Curves) that parameterizes
the variation of the cooling capacity as a function of the leaving chilled water temperature and
the entering condenser fluid temperature. The output of this curve is multiplied by the
reference capacity to give the cooling capacity at specific temperature operating conditions
(i.e., at temperatures different from the reference temperatures). The curve should have a
value of 1.0 at the reference temperatures and flow rates specified above. The biquadratic
curve should be valid for the range of water temperatures anticipated for the simulation.
Field: Electric Input to Cooling Output Ratio Function of Temperature Curve Name
The name of a biquadratic performance curve (ref: Performance Curves) that parameterizes
the variation of the energy input to cooling output ratio (EIR) as a function of the leaving
9/29/14

585

Input-Output Reference

Group Plant Equipment

chilled water temperature and the entering condenser fluid temperature. The EIR is the
inverse of the COP. The output of this curve is multiplied by the reference EIR (inverse of the
reference COP) to give the EIR at specific temperature operating conditions (i.e., at
temperatures different from the reference temperatures). The curve should have a value of
1.0 at the reference temperatures and flow rates specified above. The biquadratic curve
should be valid for the range of water temperatures anticipated for the simulation.
Field: Electric Input to Cooling Output Ratio Function of Part Load Ratio Curve Name
The name of a quadratic performance curve (ref: Performance Curves) that parameterizes
the variation of the energy input ratio (EIR) as a function of the part-load ratio (EIRfTPLR).
The EIR is the inverse of the COP, and the part-load ratio is the actual cooling load divided
by the chillers available cooling capacity. This curve is generated by dividing the operating
electric input power by the available full-load capacity (do not divide by load) at the specific
operating temperatures. The curve output should decrease from 1 towards 0 as part-load
ratio decreases from 1 to 0. The output of this curve is multiplied by the reference full-load
EIR (inverse of the reference COP) and the Energy Input to Cooling Output Ratio Function of
Temperature Curve to give the EIR at the specific temperatures and part-load ratio at which
the chiller is operating. This curve should have a value of 1.0 when the part-load ratio equals
1.0. An ideal chiller with the same efficiency at all part-load ratios would use a performance
curve that has a value of 0 when the part-load ratio equals 0 (i.;e., a line connecting 0,0 and
1,1 when plotted as EIRfTPLR versus PLR), however, actual systems can have part-load
EIRs slightly above or below this line (i.e., part-load efficiency often differs from rated
efficiency). The quadratic curve should be valid for the range of part-load ratios anticipated
for the simulation.
Field: Minimum Part Load Ratio
This numeric field contains the chillers minimum part-load ratio. The expected range is
between 0 and 1. Below this part-load ratio, the compressor cycles on and off to meet the
cooling load. The Minimum Part Load Ratio must be less than or equal to the Maximum Part
Load Ratio. The default value is 0.1.
Field: Maximum Part Load Ratio
This numeric field contains the chillers maximum part-load ratio. This value may exceed 1,
but the normal range is between 0 and 1.0. The Maximum Part Load Ratio must be greater
than or equal to the Minimum Part Load Ratio. The default value is 1.0.
Field: Optimum Part Load Ratio
This numeric field contains the chillers optimum part-load ratio. This is the part-load ratio at
which the chiller performs at its maximum COP. The optimum part-load ratio must be greater
than or equal to the Minimum Part Load Ratio, and less than or equal to the Maximum Part
Load Ratio. The default value is 1.0.
Field: Minimum Unloading Ratio
This numeric field contains the chillers minimum unloading ratio. The expected range is
between 0 and 1. The minimum unloading ratio is where the chiller capacity can no longer be
reduced by unloading and must be false loaded to meet smaller cooling loads. A typical false
loading strategy is hot-gas bypass. The minimum unloading ratio must be greater than or
equal to the Minimum Part Load Ratio, and less than or equal to the Maximum Part Load
Ratio. The default value is 0.2.
Field: Chilled Water Side Inlet Node
This required alpha field contains the identifying name for the chiller plant side (chilled water)
inlet node.

9/29/14

586

Input-Output Reference

Group Plant Equipment

Field: Chilled Water Side Outlet Node

This required alpha field contains the identifying name for the chiller plant side (chilled water)
outlet node.
Field: Condenser Inlet Node Name
This alpha field contains the identifying name for the chiller condenser side inlet node. This
node name is required if the chiller is WaterCooled, and optional if the chiller is AirCooled or
EvaporativelyCooled. If the chiller is AirCooled or EvaporativelyCooled and a condenser inlet
node name is specified here, the node name specified must also be specified in an
OutdoorAir:Node object where the height of the node is taken into consideration when
calculating outdoor air temperature from the weather data. Alternately, the node name may
be specified in an OutdoorAir:NodeList object where the outdoor air temperature is taken
directly from the weather data. If the chiller is AirCooled or EvaporativelyCooled and this field
is left blank, the program automatically creates an outdoor air node and the air temperature
information on this node is taken directly from the weather file (no node height adjustment).
Field: Condenser Outlet Node Name
This alpha field contains the identifying name for the chiller condenser side outlet node. This
node name is required if the chiller is WaterCooled, and optional if the chiller is AirCooled or
EvaporativelyCooled. If the chiller is AirCooled or EvaporativelyCooled and this field is left
blank, the program automatically creates a condenser side outlet air node.
Field: Condenser Type
This alpha field determines what type of condenser will be modeled with this chiller. Valid
condenser types are AirCooled, WaterCooled, and EvaporativelyCooled with the default
being WaterCooled if not specified. AirCooled and EvaporativelyCooled do not require a
Condenser Loop to be specified, whereas the WaterCooled option requires the full
specification of the Condenser Loop and its associated equipment.
Field: Condenser Fan Power Ratio
This field is used to model condenser fan power associated with air-cooled or evaporativelycooled condensers (for cooling towers, refer to Group - Condenser Equipment). Enter the
ratio of the condenser fan power to the reference chiller cooling capacity in W/W. If this input
is greater than 0, the condenser fan power is modeled seperatly from compressor power. In
addition, if condenser fan power is modeled using this input, the reference COP and Electric
Input to Cooling Output Ratio Function of performance curves should not include condenser
fan power.
Field: Fraction of Compressor Electric Power Rejected by Condenser
This numeric input represents the fraction of compressor electrical energy consumption that
must be rejected by the condenser. Enter a value of 1.0 when modeling hermetic chillers. For
open chillers, enter the compressor motor efficiency. This value must be greater than 0.0 and
less than or equal to 1.0, with a default value of 1.0.
Field: Leaving Chilled Water Lower Temperature Limit
This numeric field contains the lower limit for the leaving chilled water temperature in Celsius.
This temperature acts as a cut off for heat transfer in the evaporator, so that the fluid doesnt
get too cold. This input field is currently unused. The default value is 2 C.
Field: Chiller Flow Mode
This choice field determines how the chiller operates with respect to the intended fluid flow
through the devices evaporator. There are three different choices for specifying operating
modes for the intended flow behavior:
NotModulated, ConstantFlow, and
LeavingSetpointModulated. NotModulated is useful for either variable or constant speed
pumping arrangements where the chiller is passive in the sense that although it makes a
9/29/14

587

Input-Output Reference

Group Plant Equipment

nominal request for its design flow rate it can operate at varying flow rates. ConstantFlow is
useful for constant speed pumping arrangements where the chillers request for flow is
stricter and can increase the overall loop flow. LeavingSetpointModulated changes the chiller
model to internally vary the flow rate so that the temperature leaving the chiller matches a
setpoint. In all cases the operation of the external plant system can also impact the flow
through the chiller -- for example if the relative sizes and operation are such that flow is
restricted and the requests cannot be met. The default, if not specified, is NotModulated.
Field: Design Heat Recovery Water Flow Rate
This is the design heat recovery water flow rate if the heat recovery option is being simulated.
If this value is greater than 0.0 (or Autosize), a heat recovery loop must be specified and
attached to the chiller using the next two node fields. The units are in cubic meters per
second. This field is autosizable. When autosizing, the flow rate is simply the product of the
design condenser flow rate and the condenser heat recovery relative capacity fraction set in
the field below.
Field: Heat Recovery Side Inlet Node
This alpha field contains the identifying name for the chiller heat recovery side inlet node. If
the user wants to model chiller heat recovery, a heat recovery loop must be specified.
Field: Heat Recovery Side Outlet Node
This alpha field contains the identifying name for the chiller heat recovery side outlet node. If
the user wants to model chiller heat recovery, a heat recovery loop must be specified.
Field: Sizing Factor
This optional numeric field allows the user to specify a sizing factor for this component. The
sizing factor is used when the component design inputs are autosized: the autosizing
calculations are performed as usual and the results are multiplied by the sizing factor. For this
component the inputs that would be altered by the sizing factor are: Reference Capacity,
Reference Chilled Water Flow Rate and Reference Condenser Water Flow Rate. Sizing
Factor allows the user to size a component to meet part of the design load while continuing to
use the autosizing feature.
Field: Basin Heater Capacity
This numeric field contains the capacity of the chillers electric basin heater in watts per
degree Kelvin. This field only applies for Condenser Type = EvaporativelyCooled. This field is
used in conjunction with the Basin Heater Setpoint Temperature described in the following
field. The basin heater electric power is equal to this field multiplied by the difference between
the basin heater set point temperature and the outdoor dry-bulb temperature. The basin
heater only operates when the chiller is off, regardless of the basin heater schedule
described below. The basin heater capacity must be greater than or equal to zero, with a
default value of zero if this field is left blank.
Field: Basin Heater Setpoint Temperature
This numeric field contains the set point temperature (C) for the basin heater described in
the previous field. This field only applies for Condenser Type = EvaporativelyCooled. The
basin heater is active when the outdoor air dry-bulb temperature falls below this setpoint
temperature, as long as the chiller is off. This set point temperature must be greater than or
equal to 2C, and the default value is 2C if this field is left blank.
Field: Basin Heater Operating Schedule Name
This alpha field contains the name of the basin heater operating schedule. This field only
applies for Condenser Type = EvaporativelyCooled. The basin heater operating schedule is
assumed to be an on/off schedule and the heater is available to operate any time the
schedule value is greater than 0. The basin heater operates when scheduled on and the
9/29/14

588

Input-Output Reference

Group Plant Equipment

outdoor air dry-bulb temperature is below the set point temperature described in the previous
field. If this field is left blank, the basin heater is available to operate throughout the
simulation. Regardless of this schedule, the basin heater may only operate when the chiller is
off.
Field: Condenser Heat Recovery Relative Capacity Fraction
This field is optional. It can be used to describe the physical size of the heat recovery portion
of a split bundle condenser section. This fraction describes the relative capacity of the heat
recovery bundle of a split condenser compared to the nominal, full load heat rejection rate of
the chiller. This fraction will be applied to the full heat rejection when operating at nominal
capacity and nominal COP to model a capacity limit for the heat rejection. If this field is not
entered then the capacity fraction is set to 1.0.
Field: Heat Recovery Inlet High Temperature Limit Schedule Name
This field is optional. It can be used to control heat recovery operation of the chiller. The
schedule named here should contain temperature values, in C, that describe an upper limit
for the return fluid temperatures entering the chiller at the heat recovery inlet node. If the fluid
temperature is too high, then the heat recovery will not operate. This is useful to restrict the
chiller lift from becoming too high and to avoid overheating the hot water loop. This limit can
be used with or without the alternate control using leaving setpoint that is set in the next field.
Field: Heat Recovery Leaving Temperature Setpoint Node Name
This field is optional. It can be used to refine the model and controls for heat recovery
operation of the chiller. The node named here should have a setpoint placed on it by a
setpoint manager. If the plant loops demand calculation scheme is set to SingleSetpoint,
then a single setpoint manager should be used. If the plant loops demand calculation is set
to DualSetpointDeadband then a dual setpoint manager should be used and the upper
setpoint is used for control. When this field is used, a different model is used for determining
the distribution of rejected heat between the two bundles that is more appropriate for series
bundle arrangements and for chillers that are able to produce relatively higher temperature
heated fluilds.

9/29/14

589

Input-Output Reference

Group Plant Equipment

An example of this statement in an IDF is:

! ElectricEIRChiller DOE-2 Centrifugal/5.50COP
! A generic centrifugal chiller from DOE-2.1E
!
Chiller:Electric:EIR,
DOE-2 Centrifugal/5.50COP, !- Chiller Name
Autosize,
!- Reference Capacity {W}
5.5,
!- Reference COP {W/W}
6.67,
!- Reference Leaving Chilled Water Temperature {C}
29.4,
!- Reference Entering Condenser Fluid Temperature {C}
Autosize,
!- Reference Chilled Water Flow Rate {m3/s}
Autosize,
!- Reference Condenser Water Flow Rate {m3/s}
DOE-2 Centrifugal/5.50COP CAPFT, !- Cooling Capacity Function of Temperature Curve
DOE-2 Centrifugal/5.50COP EIRFT, !- Electric Input to Cooling Output Ratio Function of
Temperature Curve
DOE-2 Centrifugal/5.50COP EIRFPLR,!- Electric Input to Cooling Output Ratio Function of Part Load
Ratio Curve
0.1,
!- Minimum Part Load Ratio
1.0,
!- Maximum Part Load Ratio
1.0,
!- Optimum Part Load Ratio
0.2,
!- Minimum Unloading Ratio
Chilled Water Side Inlet Node,
!- Chilled Water Side Inlet Node
Chilled Water Side Outlet Node,
!- Chilled Water Side Outlet Node
Condenser Side Inlet Node, !- Condenser Side Inlet Node
Condenser Side Outlet Node, !- Condenser Side Outlet Node
WaterCooled,
!- Condenser Type
,
!- Condenser Fan Power Ratio {W/W}
1.0,
!- Fraction of Compressor Electric Power Rejected by Condenser
2.0,
!- Leaving Chilled Water Lower Temperature Limit {C}
ConstantFlow;
!- Chiller Evaporator Flow Mode

9/29/14

590

Input-Output Reference

Group Plant Equipment

!
! Curve set (3 Curves):
!
! Cooling Capacity Function of Temperature Curve for open or hermetic water-cooled centrifugal
chillers
! x = Leaving Chilled Water Temperature and y = Entering Condenser Water Temperature
! Same as DOE-2.1E HERM-CENT-CAP-FT (CCAPT3) and OPEN-CENT-CAP-FT (CCAPT1)
Curve:Biquadratic,
DOE-2 Centrifugal/5.50COP CAPFT, !- Name
0.257896E+00,
!- Coefficient1 Constant
0.389016E-01,
!- Coefficient2 x
-0.217080E-03,
!- Coefficient3 x**2
0.468684E-01,
!- Coefficient4 y
-0.942840E-03,
!- Coefficient5 y**2
-0.343440E-03,
!- Coefficient6 x*y
5.0,
!- Minimum Value of x
10.0,
!- Maximum Value of x
24.0,
!- Minimum Value of y
35.0;
!- Maximum Value of y
!
! Energy Input to Cooling Output Ratio Function of Temperature Curve for open or hermetic watercooled centrifugal chillers
! x = Leaving Chilled Water Temperature and y = Entering Condenser Water Temperature
! Same as DOE-2.1E HERM-CENT-EIR-FT (EIRT3) and OPEN-CENT-EIR-FT (EIRT1)
Curve:Biquadratic,
DOE-2 Centrifugal/5.50COP EIRFT, !- Name
0.933884E+00,
!- Coefficient1 Constant
-0.582120E-01,
!- Coefficient2 x
0.450036E-02,
!- Coefficient3 x**2
0.243000E-02,
!- Coefficient4 y
0.486000E-03,
!- Coefficient5 y**2
-0.121500E-02,
!- Coefficient6 x*y
5.0,
!- Minimum Value of x
10.0,
!- Maximum Value of x
24.0,
!- Minimum Value of y
35.0;
!- Maximum Value of y
!
! Energy Input to Cooling Output Ratio Function of Part Load Ratio Curve for open or hermetic
water-cooled centrifugal chillers
! x = Part Load Ratio (load/capacity)
! Same as DOE-2.1E HERM-CENT-EIR-FPLR (EIRPLR3) and OPEN-CENT-EIR-FPLR (EIRPLR1)
Curve:Quadratic,
DOE-2 Centrifugal/5.50COP EIRFPLR, !- Name
0.222903,
!- Coefficient1 Constant
0.313387,
!- Coefficient2 x
0.463710,
!- Coefficient3 x**2
0.0,
!- Minimum Value of x
1.0;
!- Maximum Value of x

Electric EIR Chiller Outputs

HVAC,Average,Chiller Electric Power [W]
HVAC,Sum,Chiller Electric Energy [J]
Zone,Meter,Electricity:Plant [J]
Zone,Meter,Cooling:Electricity [J]
HVAC,Average,Chiller Evaporator Cooling Rate [W]
HVAC,Sum,Chiller Evaporator Cooling Energy [J]
Zone,Meter,EnergyTransfer:Plant [J]
Zone,Meter,Chillers:EnergyTransfer [J]
HVAC,Average,Chiller Evaporator Inlet Temperature [C]
HVAC,Average,Chiller Evaporator Outlet Temperature [C]
HVAC,Average,Chiller Evaporator Mass Flow Rate [kg/s]
HVAC,Average,Chiller COP [W/W]
HVAC,Average,Chiller Condenser Heat Transfer Rate [W]
HVAC,Sum,Chiller Condenser Heat Transfer Energy [J]

9/29/14

591

Input-Output Reference

Group Plant Equipment

Zone,Meter,HeatRejection:EnergyTransfer [J]
HVAC,Average,Chiller Part Load Ratio []
HVAC,Average,Chiller Cycling Ratio []
HVAC,Average,Chiller False Load Heat Transfer Rate [W]
HVAC,Sum,Chiller False Load Heat Transfer Energy [J]
Curve object outputs:
HVAC,Average,Chiller Capacity Temperature Modifier Multiplier []
HVAC,Average,Chiller EIR Temperature Modifier Multiplier []
HVAC,Average,Chiller EIR Part Load Modifier Multiplier []
Air-cooled or Evap-cooled:
HVAC,Average,Chiller Condenser Inlet Temperature [C]
Air-cooled or Evap-cooled reported only when the condenser fan power ratio
input field is greater than 0:
HVAC,Average,Chiller Condenser Fan Electric Power [W]
HVAC,Average,Chiller Condenser Fan Electric Consumption [J]
Evap-cooled:
HVAC,Average,Chiller Basin Heater Electric Power [W]
HVAC,Average,Chiller Basin Heater Electric Energy [J]
Water-cooled:
HVAC,Average,Chiller Condenser Inlet Temperature [C]
HVAC,Average,Chiller Condenser Outlet Temperature [C]
HVAC,Average,Chiller Condenser Mass Flow Rate [kg/s]
HeatRecovery:
HVAC,Average,Chiller Total Recovered Heat Rate [W]
Zone,Meter,HeatRecovery:EnergyTransfer [J]
HVAC,Sum,Chiller Heat Recovery [J]
HVAC,Average,Chiller Heat Recovery Inlet Temperature [C]
HVAC,Average,Chiller Heat Recovery Outlet Temperature [C]
HVAC,Average,Chiller Heat Recovery Mass Flow Rate [kg/s]
HVAC,Average,Chiller Effective Heat Rejection Temperature [C]

Most of these chiller output variables are defined above under "Generic Chiller Outputs."
Output variables not described above are discussed here.
Chiller Condenser Fan Electric Power [W]
Chiller Condenser Fan Electric Energy [J]
These outputs are for the electric power consumption of the chiller condenser fan and are
applicable to air- or evaporatively-cooled chillers. These reports are available only for the
Chiller:Electric:EIR and only when the Condenser Fan Power Ratio input field is greater than
0. This output is also added to a meter object with Resource Type = Electricity, End Use Key
= Chillers, Group Key = Plant (Ref. Output:Meter objects).
Chiller Capacity Temperature Modifier Multiplier []
This is the output of the curve object Cooling Capacity Function of Temperature Curve.
Chiller EIR Temperature Modifier Multiplier []
This is the output of the curve object Electric Input to Cooling Output Ratio Function of
Temperature Curve.
Chiller EIR Part Load Modifier Multiplier []
This is the output of the curve object Electric Input to Cooling Output Ratio Function of Part
Load Curve.
9/29/14

592

Input-Output Reference

Group Plant Equipment

Chiller Part Load Ratio []

This output is the ratio of the evaporator heat transfer rate plus the false load heat transfer
rate (if applicable) to the available chiller capacity. This value is used to determine Chiller EIR
Part Load Modifier Multiplier.
Chiller Cycling Ratio []
The cycling ratio is the amount of time the chiller operates during each simulation timestep. If
the chiller part-load ratio falls below the minimum part-load ratio, the chiller cycles on and off
to meet the cooling load.
Chiller False Load Heat Transfer Rate [W]
Chiller False Load Heat Transfer Energy [J]
These outputs are the heat transfer rate and total heat transfer due to false loading of the
chiller. When the chiller part-load ratio is below the minimum unloading ratio, the chiller false
loads (e.g. hot-gas bypass) to further reduce capacity. The false load heat transfer output
variable is not metered.
Chiller:Electric:ReformulatedEIR
This chiller model, developed through the CoolTools project sponsored by Pacific Gas and
Electric Company (PG&E), is an empirical model similar to EnergyPlus Chiller:Electric:EIR
model. The model uses performance information at reference conditions along with three
curve fits for cooling capacity and efficiency to determine chiller operation at off-reference
conditions. The model has the same capabilities as the Chiller:Electric:EIR model, but can
potentially provide significant accuracy improvement over the Chiller:Electric:EIR model for
variable-speed compressor drive and variable condenser water flow applications. Chiller
performance curves can be generated by fitting manufacturers catalog data or measured
data. Performance curves developed from manufacturers performance data are provided in
the EnergyPlus Reference DataSets (Chillers.idf and AllDataSets.idf). This chiller model can
be used to predict the performance of various chiller types (e.g., reciprocating, screw, scroll,
and centrifugal) with water-cooled condensers.
The main difference between this model and the Chiller:Electric:EIR model is the condenser
fluid
temperature
used
in
the
associated
performance
curves:
the
Chiller:Electric:ReformulatedEIR model uses the LEAVING condenser water temperature
while the Chiller:Electric:EIR model uses the ENTERING condenser water temperature.
Note: Chiller:Electric:Reformulated EIR objects and their associated performance curve objects are
developed using performance information for a specific chiller and should almost always be used together
for an EnergyPlus simulation. Changing the object input values, or swapping performance curves between
chillers, should be done with extreme caution. For example, if the user wishes to model a chiller size that is
different from the reference capacity, it is highly recommended that the reference flow rates be scaled
proportionately to the change in reference capacity. Although this model can provide more accurate
prediction than the Chiller:Electric:EIR model, it requires more performance data to develop the associated
performance curves (at least 12 points from full-load performance and 7 points from part-load
performance).

Field: Chiller Name

This alpha field contains the identifying name for this chiller.
Field: Reference Capacity
This numeric field contains the reference cooling capacity of the chiller in Watts. This should
be the capacity of the chiller at the reference temperatures and water flow rates defined
below. Alternately, this field can be autosized.
9/29/14

593

Input-Output Reference

Group Plant Equipment

Field: Reference COP

This numeric field contains the chillers coefficient of performance. This value should not
include energy use due to pumps or cooling tower fans. This COP should be at the reference
temperatures and water flow rates defined below.
Field: Reference Leaving Chilled Water Temperature
This numeric field contains the chillers reference leaving chilled water temperature in
Celsius. The default value is 6.67C.
Field: Reference Leaving Condenser Water Temperature
This numeric field contains the chillers reference leaving condenser water temperature in
Celsius. The default value is 35C.
Field: Reference Chilled Water Flow Rate
For a variable flow chiller this is the maximum water flow rate and for a constant flow chiller
this is the operating water flow rate through the chillers evaporator. The units are in cubic
meters per second. The minimum value for this numeric input field must be greater than zero,
or this field can be autosized.
Field: Reference Condenser Water Flow Rate
This numeric field contains the chillers operating condenser water flow rate in cubic meters
per second. The units are in cubic meters per second. The minimum value for this numeric
input field must be greater than zero, or this field can be autosized.
Field: Cooling Capacity Function of Temperature Curve Name
The name of a biquadratic performance curve (ref: Performance Curves) that parameterizes
the variation of the cooling capacity as a function of the leaving chilled water temperature and
the leaving condenser water temperature. The output of this curve is multiplied by the
reference capacity to give the cooling capacity at specific temperature operating conditions
(i.e., at temperatures different from the reference temperatures). The curve should have a
value of 1.0 at the reference temperatures and flow rates specified above. The biquadratic
curve should be valid for the range of water temperatures anticipated for the simulation
(otherwise the program issues warning messages).
Field: Electric Input to Cooling Output Ratio Function of Temperature Curve Name
The name of a biquadratic performance curve (ref: Performance Curves) that parameterizes
the variation of the energy input to cooling output ratio (EIR) as a function of the leaving
chilled water temperature and the leaving condenser water temperature. The EIR is the
inverse of the COP. The output of this curve is multiplied by the reference EIR (inverse of the
reference COP) to give the EIR at specific temperature operating conditions (i.e., at
temperatures different from the reference temperatures). The curve should have a value of
1.0 at the reference temperatures and flow rates specified above. The biquadratic curve
should be valid for the range of water temperatures anticipated for the simulation (otherwise
the program issues warning messages).
Field: Electric Input to Cooling Output Ratio Function of Part Load Ratio Curve Name
The name of a bicubic performance curve (ref: Performance Curves) that parameterizes the
variation of the energy input ratio (EIR) as a function of the leaving condenser water
temperature and the part-load ratio (EIRfTPLR). The EIR is the inverse of the COP, and the
part-load ratio is the actual cooling load divided by the chillers available cooling capacity.
This curve is generated by dividing the operating electric input power by the available fullload capacity (do not divide by load) at the specific operating temperatures. The curve output
should decrease from 1 towards 0 as part-load ratio decreases from 1 to 0. The output of this
curve is multiplied by the reference full-load EIR (inverse of the reference COP) and the
Energy Input to Cooling Output Ratio Function of Temperature Curve to give the EIR at the
9/29/14

594

Input-Output Reference

Group Plant Equipment

specific temperatures and part-load ratio at which the chiller is operating. This curve should
have a value of 1.0 at the reference leaving condenser water temperature with the part-load
ratio equal to 1.0. An ideal chiller with the same efficiency at all part-load ratios would use a
performance curve that has a value of 0 when the part-load ratio equals 0 (i.;e., a line
connecting 0,0 and 1,1 when plotted as EIRfTPLR versus PLR), however, actual systems can
have part-load EIRs slightly above or below this line (i.e., part-load efficiency often differs
from rated efficiency). The bicubic curve should be valid for the range of condenser water
temperatures and part-load ratios anticipated for the simulation (otherwise the program
issues warning messages).
Note: Although a bicubic curve requires 10 coefficients (ref. Curve:Bicubic), coefficients 7, 9 and 10 are
typically not used in the performance curve described here and should be entered as 0 unless sufficient
performance data and regression accuracy exist to justify the use of these coefficients. Additionally,
coefficients 2, 3, and 6 should not be used unless sufficient temperature data is available to accurately
define the performance curve (i.e., negative values may result from insufficient data).

Field: Minimum Part Load Ratio

This numeric field contains the chillers minimum part-load ratio. The expected range is
between 0 and 1. Below this part-load ratio, the compressor cycles on and off to meet the
cooling load. The Minimum Part Load Ratio must be less than or equal to the Maximum Part
Load Ratio. The default value is 0.1.
Field: Maximum Part Load Ratio
This numeric field contains the chillers maximum part-load ratio. This value may exceed 1,
but the normal range is between 0 and 1.0. The Maximum Part Load Ratio must be greater
than or equal to the Minimum Part Load Ratio. The default value is 1.0.
Field: Optimum Part Load Ratio
This numeric field contains the chillers optimum part-load ratio. This is the part-load ratio at
which the chiller performs at its maximum COP. The optimum part-load ratio must be greater
than or equal to the Minimum Part Load Ratio, and less than or equal to the Maximum Part
Load Ratio. The default value is 1.0.
Field: Minimum Unloading Ratio
This numeric field contains the chillers minimum unloading ratio. The expected range is
between 0 and 1. The minimum unloading ratio is where the chiller capacity can no longer be
reduced by unloading and must be false loaded to meet smaller cooling loads. A typical false
loading strategy is hot-gas bypass. The minimum unloading ratio must be greater than or
equal to the Minimum Part Load Ratio, and less than or equal to the Maximum Part Load
Ratio. The default value is 0.2.
Field: Chilled Water Side Inlet Node
This required alpha field contains the identifying name for the chiller plant side (chilled water)
inlet node.
Field: Chilled Water Side Outlet Node
This required alpha field contains the identifying name for the chiller plant side (chilled water)
outlet node.
Field: Condenser Side Inlet Node
This required alpha field contains the identifying name for the chiller condenser side inlet
node.

9/29/14

595

Input-Output Reference

Group Plant Equipment

Field: Condenser Side Outlet Node

This required alpha field contains the identifying name for the chiller condenser side outlet
node.
Field: Fraction of Compressor Electric Power Rejected by Condenser
This numeric input represents the fraction of compressor electrical energy consumption that
must be rejected by the condenser. Enter a value of 1.0 when modeling hermetic chillers. For
open chillers, enter the compressor motor efficiency. This value must be greater than 0.0 and
less than or equal to 1.0, with a default value of 1.0.
Field: Leaving Chilled Water Lower Temperature Limit
This numeric field contains the lower limit for the leaving chilled water temperature in Celsius.
This temperature acts as a cut off for heat transfer in the evaporator, so that the water
doesnt get too cold. This input field is currently unused. The default value is 2 C.
Field: Chiller Flow Mode Type
This choice field determines how the chiller operates with respect to the intended fluid flow
through the devices evaporator. There are three different choices for specifying operating
modes for the intended flow behavior:
NotModulated, ConstantFlow, and
LeavingSetpointModulated. NotModulated is useful for either variable or constant speed
pumping arrangements where the chiller is passive in the sense that although it makes a
nominal request for its design flow rate it can operate at varying flow rates. ConstantFlow is
useful for constant speed pumping arrangements where the chillers request for flow is
stricter and can increase the overall loop flow. LeavingSetpointModulated changes the chiller
model to internally vary the flow rate so that the temperature leaving the chiller matches a
setpoint. In all cases the operation of the external plant system can also impact the flow
through the chiller -- for example if the relative sizes and operation are such that flow is
restricted and the requests cannot be met. The default, if not specified, is NotModulated.
Field: Design Heat Recovery Water Flow Rate
This is the design heat recovery water flow rate if the heat recovery option is being simulated.
If this value is greater than 0.0 (or autosize), a heat recovery loop must be specified and
attached to the chiller using the next two node fields. The units are in cubic meters per
second. This field is autosizable. When autosizing, the flow rate is simply the product of the
design condenser flow rate and the condenser heat recovery relative capacity fraction set in
the field below.
Field: Heat Recovery Side Inlet Node
This alpha field contains the identifying name for the chiller heat recovery side inlet node. If
the user wants to model chiller heat recovery, a heat recovery loop must be specified and it
can only be used with a water-cooled condenser.
Field: Heat Recovery Side Outlet Node
This alpha field contains the identifying name for the chiller heat recovery side outlet node. If
the user wants to model chiller heat recovery, a heat recovery loop must be specified and it
can only be used with a water-cooled condenser.
Field: Sizing Factor
This optional numeric field allows the user to specify a sizing factor for this component. The
sizing factor is used when the component design inputs are autosized: the autosizing
calculations are performed as usual and the results are multiplied by the sizing factor. For this
component the inputs that would be altered by the sizing factor are: Reference Capacity,
Reference Chilled Water Flow Rate and Reference Condenser Water Flow Rate. Sizing
Factor allows the user to size a component to meet part of the design load while continuing to
use the autosizing feature.
9/29/14

596

Input-Output Reference

Group Plant Equipment

Field: Condenser Heat Recovery Relative Capacity Fraction

This field is optional. It can be used to describe the physical size of the heat recovery portion
of a split bundle condenser section. This fraction describes the relative capacity of the heat
recovery bundle of a split condenser compared to the nominal, full load heat rejection rate of
the chiller. This fraction will be applied to the full heat rejection when operating at nominal
capacity and nominal COP to model a capacity limit for the heat rejection. If this field is not
entered then the capacity fraction is set to 1.0.
Field: Heat Recovery Inlet High Temperature Limit Schedule Name
This field is optional. It can be used to control heat recovery operation of the chiller. The
schedule named here should contain temperature values, in C, that describe an upper limit
for the return fluid temperatures entering the chiller at the heat recovery inlet node. If the fluid
temperature is too high, then the heat recovery will not operate. This is useful to restrict the
chiller lift from becoming too high and to avoid overheating the hot water loop. This limit can
be used with or without the alternate control using leaving setpoint that is set in the next field.
Field: Heat Recovery Leaving Temperature Setpoint Node Name
This field is optional. It can be used to refine the model and controls for heat recovery
operation of the chiller. The node named here should have a setpoint placed on it by a
setpoint manager. If the plant loops demand calculation scheme is set to SingleSetpoint,
then a single setpoint manager should be used. If the plant loops demand calculation is set
to DualSetpointDeadband then a dual setpoint manager should be used and the upper
setpoint is used for control. When this field is used, a different model is used for determining
the distribution of rejected heat between the two bundles that is more appropriate for series
bundle arrangements and for chillers that are able to produce relatively higher temperature
heated fluilds.
An example of this statement in an IDF is:
Chiller:Electric:ReformulatedEIR,
Main Chiller,
50000,
3.99,
6.67,
35.0,
0.00898,
0.01122,
Main Chiller RecipCapFT,
Main Chiller RecipEIRFT,

!!!!!!!!!-

Main Chiller RecipEIRFPLR,

!-

0.01,
1,
1,
0.07,
Main Chiller ChW
Main Chiller ChW
Main Chiller Cnd
Main Chiller Cnd
1,
2,
ConstantFlow;

!!!!!!!!!!!-

9/29/14

Inlet,
Outlet,
Inlet,
Outlet,

Chiller Name
Reference Capacity {W}
Reference COP
Reference Leaving Chilled Water Temperature {C}
Reference Leaving Condenser Water Temperature {C}
Reference Chilled Water Flow Rate {m3/s}
Reference Condenser Water Flow Rate {m3/s}
Cooling Capacity Function of Temperature Curve
Electric Input to Cooling Output Ratio Function of
Temperature Curve
Electric Input to Cooling Output Ratio Function of Part
Load Ratio Curve
Minimum Part Load Ratio
Maximum Part Load Ratio
Optimum Part Load Ratio
Minimum Unloading Ratio
Chilled Water Side Inlet Node
Chilled Water Side Outlet Node
Condenser Side Inlet Node
Condenser Side Outlet Node
Fraction of Compressor Electric Power Rejected by Condenser
Leaving Chilled Water Lower Temperature Limit {C}
Chiller Flow Mode

597

Input-Output Reference

Group Plant Equipment

! Cooling capacity to rated capacity function of Temperature Curve

! x = Leaving Chilled Water Temperature and y = Leaving Condenser Water Temperature
Curve:Biquadratic,
Main Chiller RecipCapFT, !- Name
0.958546443,
!- Coefficient1 Constant
0.035168695,
!- Coefficient2 x
0.000124662,
!- Coefficient3 x**2
-0.00274551,
!- Coefficient4 y
-0.00005000,
!- Coefficient5 y**2
-0.00017234,
!- Coefficient6 x*y
5.00,
!- Minimum Value of x
10.0,
!- Maximum Value of x
20.00,
!- Minimum Value of y
40.94;
!- Maximum Value of y

! Energy Input to Cooling Output Ratio Function of Temperature Curve

! x = Leaving Chilled Water Temperature and y = Leaving Condenser Water Temperature
Curve:Biquadratic,
Main Chiller RecipEIRFT, !- Name
0.732700123,
!- Coefficient1 Constant
-0.00834360,
!- Coefficient2 x
0.000638530,
!- Coefficient3 x**2
-0.00303753,
!- Coefficient4 y
0.000484952,
!- Coefficient5 y**2
-0.00083584,
!- Coefficient6 x*y
5.00,
!- Minimum Value of x
10.0,
!- Maximum Value of x
20.00,
!- Minimum Value of y
40.94;
!- Maximum Value of y

! Energy Input to Cooling Output Ratio Function of Part Load Ratio Curve
! x = Leaving Condenser water Temperature and y = Part Load Ratio
Curve:Bicubic,
Main Chiller RecipEIRFPLR, !- Name
0.070862846,
!- Coefficient1 Constant
0.002787560,
!- Coefficient2 x
-0.00000891,
!- Coefficient3 x**2
0.230973399,
!- Coefficient4 y
1.250442176,
!- Coefficient5 y**2
-0.00216102,
!- Coefficient6 x*y
0.000000,
!- Coefficient7 x**3
-0.56300936,
!- Coefficient8 y**3
0.000000,
!- Coefficient9 x**2*y
0.000000,
!- Coefficient10 x*y**2
20.00,
!- Minimum Value of x
40.94,
!- Maximum Value of x
0.01,
!- Minimum Value of y
1.0;
!- Maximum Value of y

Electric Reformulated EIR Chiller Outputs

The output variables for Chiller:Electric:ReformulatedEIR are the same as the output
variables for Chiller:Electric:EIR (ref. Electric EIR Chiller Outputs). except for the Chiller
Condenser Fan Electric Power and Energy reports
Chiller:EngineDriven
Field: Name
This alpha field contains the identifying name for the engine driven chiller.

9/29/14

598

Input-Output Reference

Group Plant Equipment

Field: Condenser Type

This alpha field determines what type of condenser will be modeled with this chiller. The 3
type of condensers are AirCooled, WaterCooled, and EvaporativelyCooled with the default
being AirCooled if not specified. AirCooled and EvaporativelyCooled do not require a
Condenser Loop to be specified, where the WaterCooled option requires the full specification
of the Condenser Loop and its associated equipment.
Field: Nominal Capacity
This numeric field contains the nominal cooling capability of the chiller in Watts.
Field: Nominal COP
This numeric field contains the chillers coefficient of performance (COP).
Field: Chilled Water Inlet Node Name
This required alpha field contains the identifying name for the chiller plant side inlet node.
Field: Chilled Water Outlet Node Name
This required alpha field contains the identifying name for the chiller plant side outlet node.
Field: Condenser Inlet Node Name
This alpha field contains the identifying name for the chiller condenser side inlet node. This
node name is required if the chiller is WaterCooled, and optional if the chiller is AirCooled or
EvaporativelyCooled. If the chiller is AirCooled or EvaporativelyCooled and a condenser inlet
node name is specified here, the node name specified must also be specified in an
OutdoorAir:Node object where the height of the node is taken into consideration when
calculating outdoor air temperature from the weather data. Alternately, the node name may
be specified in an OutdoorAir:NodeList object where the outdoor air temperature is taken
directly from the weather data. If the chiller is AirCooled or EvaporativelyCooled and this field
is left blank, the program automatically creates an outdoor air node and the air temperature
information on this node is taken directly from the weather file (no node height adjustment).
Field: Condenser Outlet Node Name
This alpha field contains the identifying name for the chiller condenser side outlet node. This
node name is required if the chiller is WaterCooled, and optional if the chiller is AirCooled or
EvaporativelyCooled. If the chiller is AirCooled or EvaporativelyCooled and this field is left
blank, the program automatically creates a condenser side outlet air node.
Field: Minimum Part Load Ratio
This numeric field contains the chillers minimum part load ratio. The expected range is
between 0 and 1. The minimum part load is not the load where the machine shuts off, but
where the amount of power remains constant to produce smaller loads than this fraction.
Field: Maximum Part Load Ratio
This numeric field contains the chillers maximum part load ratio. This value may exceed 1,
but the normal range is between 0 and 1.1.
Field: Optimum Part Load Ratio
This numeric field contains the chillers optimum part load ratio. This is the part load ratio at
which the chiller performs at its maximum COP.
Field: Design Condenser Inlet Temperature
This numeric field contains the chillers condenser inlet design temperature in Celsius.

9/29/14

599

Input-Output Reference

Group Plant Equipment

Field: Temperature Rise Coefficient

This numeric field contains the electric chillers temperature rise coefficient which is defined
as the ratio of the required change in condenser water temperature to a given change in
chilled water temperature, which maintains the capacity at the nominal value. This is
calculated as the following ratio:

TCEntrequired TCEntrated
TELvrequired TELvrated
where:
TCEntrequired = Required entering condenser air or water temperature to maintain rated
capacity.
TCEntrated = Rated entering condenser air or water temperature at rated capacity.
TELvrequired = Required leaving evaporator water outlet temperature to maintain rated
capacity.
TELvrated = Rated leaving evaporator water outlet temperature at rated capacity.
Field: Design Chilled Water Outlet Temperature
This numeric field contains the chillers evaporator outlet design temperature in Celsius.
Field: Design Chilled Water Flow Rate
For variable volume chiller this is the maximum flow and for constant flow chiller this is the
design flow rate. The units are in cubic meters per second.
Field: Design Condenser Water Flow Rate
This numeric field contains the chillers design condenser water flow rate in cubic meters per
second. This field can be autosized. This field is not user for Condenser Type = AirCooled or
EvaporativelyCooled.
Capacity Ratio Curve
The Capacity Ratio Curve is a quadratic equation that determines the Ratio of Available
Capacity to Nominal Capacity. The defining equation is:

AvailToNominalCapacityRatio C1 C2

temp

C3

2
temp

Where the Delta Temperature is defined as:

Temp

TempCondIn - TempCondInDesign
TempRiseCoefficient

(TempEvapOut - TempEvapOutDesign)

TempCondIn = Temperature entering the condenser (water or air temperature depending on

condenser type).
TempCondInDesign = Design Condenser Inlet Temperature from User input above.
TempEvapOut = Temperature leaving the evaporator.
TempEvapOutDesign = Design Chilled Water Outlet Temperature from User input above.
TempRiseCoefficient = User Input from above.
The following three fields contain the coefficients for the quadratic equation.
Field: Coefficient 1 of Capacity Ratio Curve
This numeric field contains the first coefficient for the capacity ratio curve.

9/29/14

600

Input-Output Reference

Group Plant Equipment

Field: Coefficient 2 of Capacity Ratio Curve

This numeric field contains the second coefficient for the capacity ratio curve.
Field: Coefficient 3 of Capacity Ratio Curve
This numeric field contains the third coefficient for the capacity ratio curve.
Power Ratio Curve
The Power Ratio Curve is a quadratic equation that determines the Ratio of Full Load to
Power. The defining equation is:

FullLoadtoPowerRatio C1 C2 AvailToNominalCapRatio C3 AvailToNominalCapRatio2

The following three fields contain the coefficients for the quadratic equation.
Field: Coefficient 1 of Power Ratio Curve
This numeric field contains the first coefficient for the power ratio curve.
Field: Coefficient 2 of Power Ratio Curve
This numeric field contains the second coefficient for the power ratio curve.
Field: Coefficient 3 of Power Ratio Curve
This numeric field contains the third coefficient for the power ratio curve.
Full Load Ratio Curve
The Full Load Ratio Curve is a quadratic equation that determines the fraction of full load
power. The defining equation is:

FracFullLoadPower

C1 C2 PartLoadRatio C3 PartLoadRatio2

The following three fields contain the coefficients for the quadratic equation.
Field: Coefficient 1 of Full Load Ratio Curve
This numeric field contains the first coefficient for the full load ratio curve.
Field: Coefficient 2 of Full Load Ratio Curve
This numeric field contains the second coefficient for the full load ratio curve.
Field: Coefficient 3 of Full Load Ratio Curve
This numeric field contains the third coefficient for the full load ratio curve.
Field Chilled Water Outlet Temperature Lower Limit
This numeric field contains the lower limit for the evaporator outlet temperature. This
temperature acts as a cut off for heat transfer in the evaporator, so that the fluid doesnt get
too cold.
Field: Fuel Use Curve Name
This alpha field contains the name of the Cooling Load to Fuel Use curve. The curve itself is
specified separately using the EnergyPlus Curve Manager. The Fuel Use Curve is a
quadratic equation that determines the ratio of Cooling Load to Fuel Energy. The defining
equation is:

CoolingLoadtoFuelCurve C1 C2 PLR C3 PLR2

where PLR is the Part Load Ratio from the Chiller. The Part Load Based Fuel Input Curve
determines the ratio of fuel energy per unit time (J/s) / cooling load (W). This is illustrated by
the logic block in the Engine Driven Chiller algorithm.
9/29/14

601

Input-Output Reference

Group Plant Equipment

IF (PartLoadRat == 0)THEN
EngineDrivenFuelEnergy = 0
ELSE
ClngLoadFuelRat =
CurveValue(EngineDrivenChiller(ChillerNum)%ClngLoadtoFuelCurve, PartLoadRat )
EngineDrivenFuelEnergy = QEvaporator / ClngLoadFuelRat
END IF

Field: Jacket Heat Recovery Curve Name

This alpha field contains the name of the Recovery Jacket Heat curve. The curve itself is
specified separately using the EnergyPlus Curve Manager. The Recovery Jacket Heat Curve
is a quadratic equation that determines the ratio of recovery jacket heat to fuel energy. The
defining equation is:

RecoveryJacketHeatToFuelRatio C1 C2 RL C3 RL2
where RL is the Ratio of Load to Diesel Engine Capacity
Field: Lube Heat Recovery Curve Name
This alpha field contains the name of the Recovery Lube Heat curve. The curve itself is
specified separately using the EnergyPlus Curve Manager. The Recovery Lubricant Heat
Curve is a quadratic equation that determines the ratio of recovery lube heat to fuel energy.
The defining equation is:

RecoveryLubeHeatToFuelRatio C1 C2 RL C3 RL2
where RL is the Ratio of Load to Diesel Engine Capacity
Field: Total Exhaust Energy Curve Name
This alpha field contains the name of the Total Exhaust Energy curve. The curve itself is
specified separately using the EnergyPlus Curve Manager. The Total Exhaust Energy Curve
is a quadratic equation that determines the ratio of total exhaust energy to fuel energy. The
defining equation is:

TotalExhaustToFuelRatio C1 C2 RL C3 RL2
where RL is the Ratio of Load to Diesel Engine Capacity
Field: Exhaust Temperature Curve Name
This alpha field contains the name of the Exhaust Temperature curve. The curve itself is
specified separately using the EnergyPlus Curve Manager. The Exhaust Temperature Curve
is a quadratic equation that determines the absolute exhaust temperature. The defining
equation is:

AbsoluteExhaustTemperature C1 C2 RL C3 RL2
where RL is the Ratio of Load to Diesel Engine Capacity

9/29/14

602

Input-Output Reference

Group Plant Equipment

U-Factor Times Area Curve

The U-Factor Times Area (UA) is an equation that determines the overall heat transfer
coefficient for the exhaust gasses with the stack. The heat transfer coefficient ultimately helps
determine the exhaust stack temperature. The defining equation is:

UAToCapacityRatio C1EngineCapacity C2
The following two fields contain the coefficients for the equation.
Field: Coefficient 1 of U-Factor Times Area Curve
This numeric field contains the first coefficient for the overall heat transfer coefficient curve.
Field: Coefficient 2 of U-Factor Times Area Curve
This numeric field contains the second (exponential) coefficient for the overall heat transfer
coefficient curve.
Field: Maximum Exhaust Flow per Unit of Power Output
This numeric field contains the maximum exhaust gas mass flow rate per watt of cooling
provided by the engine driven chiller
Field: Design Minimum Exhaust Temperature
This numeric field contains the steam saturation temperature in Celsius that would be used to
determine the energy recovered from a water jacket heat exchanger on the engine.
Field: Fuel Type
This alpha value specifies the type of fuel used in the engine. The fuel type can be
NaturalGas, PropaneGas, Diesel, Gasoline, FuelOil#1, FuelOil#2, OtherFuel1 or OtherFuel2.
This field is required.
Field: Fuel Higher Heating Value
This numeric field contains the higher heating value of the fuel used in kJ/kg.
Field: Design Heat Recovery Water Flow Rate
This numeric field specifies the heat recovery volumetric flow rate through the engine in
m3/sec. The heat recovery loop manager and hot water tan must also be specified if heat
energy is to be recovered from the engine driven chiller.
Field: Heat Recovery Inlet Node Name
This alpha field contains the identifying name for the heat recovery side inlet. If a loop is
connected, then the jacket and lubricant heat will be recovered. There is no need for an
effectiveness term, since the jacket and lubricant recovered heat energies are the actual
recovered energies.
Field: Heat Recovery Outlet Node Name
This alpha field contains the identifying name for the heat recovery side outlet.
Field: Chiller Flow Mode
This choice field determines how the chiller operates with respect to the intended fluid flow
through the devices evaporator. There are three different choices for specifying operating
modes for the intended flow behavior:
NotModulated, ConstantFlow, and
LeavingSetpointModulated. NotModulated is useful for either variable or constant speed
pumping arrangements where the chiller is passive in the sense that although it makes a
nominal request for its design flow rate it can operate at varying flow rates. ConstantFlow is
useful for constant speed pumping arrangements where the chillers request for flow is
9/29/14

603

Input-Output Reference

Group Plant Equipment

stricter and can increase the overall loop flow. LeavingSetpointModulated changes the chiller
model to internally vary the flow rate so that the temperature leaving the chiller matches a
setpoint. In all cases the operation of the external plant system can also impact the flow
through the chiller -- for example if the relative sizes and operation are such that flow is
restricted and the requests cannot be met. The default, if not specified, is NotModulated.
Field: Maximum Temperature for Heat Recovery at Heat Recovery Outlet Node
This field sets the maximum temperature that this piece of equipment can produce for heat
recovery. The idea behind this field is that the current models do not take temperatures into
account for availability and they just pass Q's around the loop without a temperature limit.
This temperature limit puts an upper bound on the recovered heat and limits the max
temperatures leaving the component.
As temperatures in the loop approach the maximum temperature, the temperature difference
between the entering water and the surfaces in the piece of equipment becomes smaller. For
the given heat recovery flow rate and that temperature difference the amount of heat
recovered will be reduced, and eventually there will be no heat recovered when the entering
water temperature is equal to the maximum temperature specified by the user in this field.
The reduced amount of heat recovered will diminish if the temperature of the loop approach
is the maximum temperature, and this will show up in the reporting. This allows the user to
set the availability or the quality of the heat recovered for usage in other parts of the system
or to heat domestic hot water supply. The temperature is specified in degrees C.
Field: Sizing Factor
This optional numeric field allows the user to specify a sizing factor for this component. The
sizing factor is used when the component design inputs are autosized: the autosizing
calculations are performed as usual and the results are multiplied by the sizing factor. For this
component the inputs that would be altered by the sizing factor are: Nominal Capacity,
Design Chilled Water Flow Rate and Design Condenser Water Flow Rate. Sizing Factor
allows the user to size a component to meet part of the design load while continuing to use
the autosizing feature.
Field: Basin Heater Capacity
This numeric field contains the capacity of the chillers electric basin heater in watts per
degree Kelvin. This field only applies for Condenser Type = EvaporativelyCooled. This field is
used in conjunction with the Basin Heater Setpoint Temperature described in the following
field. The basin heater electric power is equal to this field multiplied by the difference between
the basin heater set point temperature and the outdoor dry-bulb temperature. The basin
heater only operates when the chiller is off, regardless of the basin heater schedule
described below. The basin heater capacity must be greater than or equal to zero, with a
default value of zero if this field is left blank.
Field: Basin Heater Setpoint Temperature
This numeric field contains the set point temperature (C) for the basin heater described in
the previous field. This field only applies for Condenser Type = EvaporativelyCooled. The
basin heater is active when the outdoor air dry-bulb temperature falls below this setpoint
temperature, as long as the chiller is off. This set point temperature must be greater than or
equal to 2C, and the default value is 2C if this field is left blank.
Field: Basin Heater Operating Schedule Name
This alpha field contains the name of the basin heater operating schedule. This field only
applies for Condenser Type = EvaporativelyCooled. The basin heater operating schedule is
assumed to be an on/off schedule and the heater is available to operate any time the
schedule value is greater than 0. The basin heater operates when scheduled on and the
outdoor air dry-bulb temperature is below the set point temperature described in the previous
field. If this field is left blank, the basin heater is available to operate throughout the
9/29/14

604

Input-Output Reference

Group Plant Equipment

simulation. Regardless of this schedule, the basin heater may only operate when the chiller is
off.
An example of this statement in an IDF is:
Chiller:EngineDriven,,
Central Chiller,
!- Chiller Name
WaterCooled,
!- Condenser Type
autosize,
!- Nominal Capacity {W}
2.75,
!- COP
Central Chiller Inlet Node, !- Chilled Water Inlet Node Name
Central Chiller Outlet Node, !- Chilled Water Outlet Node Name
Central Chiller Condenser Inlet Node, !- Condenser Inlet Node Name
Central Chiller Condenser Outlet Node, !- Condenser Outlet Node Name
0.0,
!- Minimum Part Load Ratio
1.0,
!- Maximum Part Load Ratio
.65,
!- Optimum Part Load Ratio
35.0,
!- Design Condenser Inlet Temperature {C}
2.778,
!- Temperature Rise Coefficient
6.67,
!- Design Chilled Water Outlet Temperature {C}
autosize,
!- Design Chilled Water Flow Rate {m3/s}
autosize,
!- Design Condenser Water Flow Rate {m3/s}
0.9949,
!- Coefficient 1 of Capacity Ratio Curve
-0.045954,
!- Coefficient 2 of Capacity Ratio Curve
-0.0013543,
!- Coefficient 3 of Capacity Ratio Curve
2.333,
!- Coefficient 1 of Power Ratio Curve
-1.975,
!- Coefficient 2 of Power Ratio Curve
0.6121,
!- Coefficient 3 of Power Ratio Curve
0.03303,
!- Coefficient 1 of Full Load Ratio Curve
0.6852,
!- Coefficient 2 of Full Load Ratio Curve
0.2818,
!- Coefficient 3 of Full Load Ratio Curve
5,
!- Chilled Water Outlet Temperature Lower Limit {C}

Fuel Use Curve,

!Jacket Heat Recovery Curve,
Lube Heat Recovery Curve,!Total Exhaust Energy Curve,
Exhaust Temperature Curve,
0.01516,
!0.9,
!0.00063,
!150,
!DIESEL,
!45500,
!0.0,
!,
!,
!VariableFlow,
!60.0;
!-

the Fuel Use Curve

!- the Recovery Jacket Heat curve
the Recovery Lube Heat curve
!- the Total Exhaust Energy curve
!- the Exhaust Temperature curve
Coefficient1 of UA curve
Coefficient2 of UA curve
Maximum Exhaust Flow per W of Power Output {(kg/s)/W}
Design Minimum Exhaust temp. (Steam Saturation Temperature) {C}
Fuel Type
Fuel Heating Value {kJ/kg}
Design heat recovery water flow rate {m3/s}
Heat Recovery Inlet Node Name
Heat Recovery Outlet Node Name
Chiller Flow Mode
Maximum Temp for Heat Recovery. This sets max availability {C}

Engine Driven Chiller Outputs

HVAC,Average,Chiller Electric Power [W]
HVAC,Sum,Chiller Electric Energy [J]
Zone,Meter,Electricity:Plant [J]
Zone,Meter,Cooling:Electricity [J]
HVAC,Average,Chiller Evaporator Cooling Rate [W]
HVAC,Sum,Chiller Evaporator Cooling Energy [J]
Zone,Meter,EnergyTransfer:Plant [J]
Zone,Meter,Chillers:EnergyTransfer [J]
HVAC,Average,Chiller Evaporator Inlet Temperature [C]
HVAC,Average,Chiller Evaporator Outlet Temperature [C]
HVAC,Average,Chiller Evaporator Mass Flow Rate [kg/s]
HVAC,Average,Chiller COP [W/W]
HVAC,Average,Chiller Condenser Heat Transfer Energy Rate [W]
9/29/14

605

Input-Output Reference

Group Plant Equipment

HVAC,Sum,Chiller Condenser Heat Transfer Energy [J]

Zone,Meter,HeatRejection:EnergyTransfer [J]
Air-cooled or Evap-cooled:
HVAC,Average,Chiller Condenser Inlet Temperature [C]
Evap-cooled:
HVAC,Average,Chiller Basin Heater Electric Power [W]
HVAC,Average,Chiller Basin Heater Electric Energy [J]
Water-cooled:
HVAC,Average,Chiller Condenser Inlet Temperature [C]
HVAC,Average,Chiller Condenser Outlet Temperature [C]
HVAC,Average,Chiller Condenser Mass Flow Rate [kg/s]
HVAC,Average,Chiller Drive Shaft Power [W]
HVAC,Sum,Chiller Drive Shaft Energy [J]
HVAC,Average,Chiller Jacket Recovered Heat Rate [W]
HVAC,Sum,Chiller Jacket Recovered Heat Energy [J]
Zone,Meter,HeatRecovery:EnergyTransfer [J]
HVAC,Average,Chiller Lube Recovered Heat Rate [W]
HVAC,Sum,Chiller Lube Recovered Heat Energy [J]
HVAC,Average,Chiller Exhaust Heat Recovery Rate [W]
HVAC,Sum,Chiller Exhaust Heat Recovery Energy [J]
HVAC,Average,Chiller Total Recovered Heat Rate [W]
HVAC,Sum,Chiller Total Recovered Heat Energy [J]
HVAC,Average,Chiller Heat Recovery Mass Flow Rate [kg/s]
HVAC,Average,Chiller Heat Recovery Inlet Temperature [C]
HVAC,Average,Chiller Heat Recovery Outlet Temperature [C]
HVAC,Average,Chiller Exhaust Temperature [C]
One of the following blocks will be applicable based on fuel type:
HVAC,Average,Chiller Gas Rate [W]
HVAC,Sum,Chiller Gas Energy [J]
HVAC,Average,Chiller Gas Mass Flow Rate [kg/s]
HVAC,Average,Chiller Propane Rate [W]
HVAC,Sum,Chiller Propane Energy [J]
HVAC,Average,Chiller Propane Mass Flow Rate [kg/s]
HVAC,Average,Chiller Diesel Rate [W]
HVAC,Sum,Chiller Diesel Energy [J]
HVAC,Average,Chiller Diesel Mass Flow Rate [kg/s]
HVAC,Average,Chiller Gasoline Rate [W]
HVAC,Sum,Chiller Gasoline Energy [J]
HVAC,Average,Chiller Gasoline Mass Flow Rate [kg/s]
HVAC,Average,Chiller FuelOil#1 Rate [W]
HVAC,Sum,Chiller FuelOil#1 Energy [J]
HVAC,Average,Chiller FuelOil#1 Mass Flow Rate [kg/s]
HVAC,Average,Chiller FuelOil#2 Rate [W]
HVAC,Sum,Chiller FuelOil#2 Energy [J]
HVAC,Average,Chiller FuelOil#2 Mass Flow Rate [kg/s
HVAC,Average,Chiller OtherFuel1 Rate [W]
HVAC,Sum,Chiller OtherFuel1 Energy [J]
HVAC,Average,Chiller OtherFuel1 Mass Flow Rate [kg/s]
HVAC,Average,Chiller OtherFuel2 Rate [W]
HVAC,Sum,Chiller OtherFuel2 Energy [J]
HVAC,Average,Chiller OtherFuel2 Mass Flow Rate [kg/s]

9/29/14

606

Input-Output Reference

Group Plant Equipment

These chiller output variables are defined above under "Generic Chiller Outputs."
Chiller:CombustionTurbine
This chiller model is the empirical model from the Building Loads and System
Thermodynamics (BLAST) program. Chiller performance curves are generated by fitting
catalog data to third order polynomial equations. Three sets of coefficients are required.
Field: Name
This alpha field contains the identifying name for the combustion turbine chiller.
Field: Condenser Type
This alpha field determines what type of condenser will be modeled with this chiller. The 3
type of condensers are AirCooled, WaterCooled, and EvaporativelyCooled with the default
being AirCooled if not specified. AirCooled and EvaporativelyCooled do not require a
Condenser Loop to be specified, where the WaterCooled option requires the full specification
of the Condenser Loop and its associated equipment.
Field: Nominal Capacity
This numeric field contains the nominal cooling capability of the chiller in Watts.
Field: Nominal COP
This numeric field contains the chillers coefficient of performance (COP).
Field: Chilled Water Inlet Node Name
This alpha field contains the identifying name for the combustion turbine chiller plant side inlet
node.
Field: Chilled Water Outlet Node Name
This required alpha field contains the identifying name for the combustion turbine chiller plant
side inlet node.
Field: Chilled Water Outlet Node Name
This required alpha field contains the identifying name for the combustion turbine chiller plant
side outlet node.
Field: Condenser Inlet Node Name
This alpha field contains the identifying name for the combustion turbine chiller condenser
side inlet node. This node name is required if the chiller is WaterCooled, and optional if the
chiller is AirCooled or EvaporativelyCooled. If the chiller is AirCooled or EvaporativelyCooled
and a condenser inlet node name is specified here, the node name specified must also be
specified in an OutdoorAir:Node object where the height of the node is taken into
consideration when calculating outdoor air temperature from the weather data. Alternately,
the node name may be specified in an OutdoorAir:NodeList object where the outdoor air
temperature is taken directly from the weather data. If the chiller is AirCooled or
EvaporativelyCooled and this field is left blank, the program automatically creates an outdoor
air node and the air temperature information on this node is taken directly from the weather
file (no node height adjustment).
Field: Condenser Outlet Node Name
This alpha field contains the identifying name for the combustion turbine chiller condenser
side outlet node. This node name is required if the chiller is WaterCooled, and optional if the
chiller is AirCooled or EvaporativelyCooled. If the chiller is AirCooled or EvaporativelyCooled
and this field is left blank, the program automatically creates a condenser side outlet air node.

9/29/14

607

Input-Output Reference

Group Plant Equipment

Field: Minimum Part Load Ratio

This numeric field contains the combustion turbine chillers minimum part load ratio. The
expected range is between 0 and 1. The minimum part load is not the load where the
machine shuts off, but where the amount of power remains constant to produce smaller loads
than this fraction.
Field: Maximum Part Load Ratio
This numeric field contains the combustion turbine chillers maximum part load ratio. This
value may exceed 1, but the normal range is between 0 and 1.1.
Field: Optimum Part Load Ratio
This numeric field contains the combustion turbine chillers optimum part load ratio. This is
the part load ratio at which the chiller performs at its maximum COP.
Field: Design Condenser Inlet Temperature
This numeric field contains the combustion turbine chillers condenser inlet design
temperature in Celsius.
Field: Temperature Rise Coefficient
This numeric field contains the electric chillers temperature rise coefficient which is defined
as the ratio of the required change in condenser water temperature to a given change in
chilled water temperature, which maintains the capacity at the nominal value. This is
calculated as the following ratio:

TCEntrequired TCEntrated
TELvrequired TELvrated
where:
TCEntrequired = Required entering condenser air or water temperature to maintain rated
capacity.
TCEntrated = Rated entering condenser air or water temperature at rated capacity.
TELvrequired = Required leaving evaporator water outlet temperature to maintain rated
capacity.
TELvrated = Rated leaving evaporator water outlet temperature at rated capacity.
Field: Design Chilled Water Outlet Temperature
This numeric field contains the combustion turbine chillers evaporator outlet design
temperature in Celsius.
Field: Design Chilled Water Flow Rate
For variable volume chiller this is the maximum flow and for constant flow chiller this is the
design flow rate. The units are in cubic meters per second.
Field: Design Condenser Water Flow Rate
This numeric field contains the combustion turbine chillers design condenser water flow rate
in cubic meters per second. This field can be autosized. This field is not used for Condenser
Type = AirCooled or EvaporativelyCooled.
Capacity Ratio Curve
The Capacity Ratio Curve is a quadratic equation that determines the Ratio of Available
Capacity to Nominal Capacity. The defining equation is:

9/29/14

608

Input-Output Reference

Group Plant Equipment

AvailToNominalCapacityRatio C1 C2

temp

C3

2
temp

Where the Delta Temperature is defined as:

Temp

TempCondIn - TempCondInDesign
TempRiseCoefficient

(TempEvapOut - TempEvapOutDesign)

TempCondIn = Temperature entering the condenser (water or air temperature depending on

condenser type).
TempCondInDesign = Design Condenser Inlet Temperature from User input above.
TempEvapOut = Temperature leaving the evaporator.
TempEvapOutDesign = Design Chilled Water Outlet Temperature from User input above.
TempRiseCoefficient = User Input from above.
The following three fields contain the coefficients for the quadratic equation.
Field: Coefficient 1 of Capacity Ratio Curve
This numeric field contains the first coefficient for the capacity ratio curve.
Field: Coefficient 2 of Capacity Ratio Curve
This numeric field contains the second coefficient for the capacity ratio curve.
Field: Coefficient 3 of Capacity Ratio Curve
This numeric field contains the third coefficient for the capacity ratio curve.
Power Ratio Curve
The Power Ratio Curve is a quadratic equation that determines the Ratio of Full Load to
Power. The defining equation is:

FullLoadtoPowerRatio C1 C2 AvailToNominalCapRatio C3 AvailToNominalCapRatio2

The following three fields contain the coefficients for the quadratic equation.
Field: Coefficient 1 of Power Ratio Curve
This numeric field contains the first coefficient for the power ratio curve.
Field: Coefficient 2 of Power Ratio Curve
This numeric field contains the second coefficient for the power ratio curve.
Field: Coefficient 3 of Power Ratio Curve
This numeric field contains the third coefficient for the power ratio curve.
Full Load Ratio Curve
The Full Load Ratio Curve is a quadratic equation that determines the fraction of full load
power. The defining equation is:

FracFullLoadPower

C1 C2 PartLoadRatio C3 PartLoadRatio2

The following three fields contain the coefficients for the quadratic equation.
Field: Coefficient 1 of Full Load Ratio Curve
This numeric field contains the first coefficient for the full load ratio curve.
Field: Coefficient 2 of Full Load Ratio Curve
This numeric field contains the second coefficient for the full load ratio curve.

9/29/14

609

Input-Output Reference

Group Plant Equipment

Field: Coefficient 3 of Full Load Ratio Curve

This numeric field contains the third coefficient for the full load ratio curve.
Field: Chilled Water Outlet Temperature Lower Limit
This numeric field contains the lower limit for the evaporator outlet temperature. This
temperature acts as a cut off for heat transfer in the evaporator, so that the fluid doesnt get
too cold.
Fuel Input Curve
The Fuel Input Curve is a polynomial equation that determines the Ratio of Fuel Input to
Energy Output. The equation combines both the Fuel Input Curve Coefficients and the
Temperature Based Fuel Input Curve Coefficients. The defining equation is:

FuelEnergyInput

PLoad ( FIC1 FIC2 RLoad

FIC3 RLoad 2 ) (TBFIC1 TBFIC2 ATair TBFIC3 ATair2 )

where FIC represents the Fuel Input Curve Coefficients, TBFIC represents the Temperature
Based Fuel Input Curve Coefficients, Rload is the Ratio of Load to Combustion Turbine
Engine Capacity, and ATair is the difference between the current ambient and design ambient
temperatures.
The following three fields contain the coefficients for the fuel input curve.
Field: Coefficient 1 of Fuel Input Curve
This numeric field contains the first coefficient for the Fuel Input Curve.
Field: Coefficient 2 of Fuel Input Curve
This numeric field contains the second coefficient for the Fuel Input Curve.
Field: Coefficient 3 of Fuel Input Curve
This numeric field contains the third coefficient for the Fuel Input Curve.
The following three fields contain the coefficients for the temperature based fuel input curve.
Field: Coefficient 1 of Temperature Based Fuel Input Curve
This numeric field contains the first coefficient for the Temperature Based Fuel Input Curve.
Field: Coefficient 2 of Temperature Based Fuel Input Curve
This numeric field contains the second coefficient for the Temperature Based Fuel Input
Curve.
Field: Coefficient 3 of Temperature Based Fuel Input Curve
This numeric field contains the third coefficient for the Temperature Based Fuel Input Curve.
Exhaust Flow Curve
The Exhaust Flow Curve is a quadratic equation that determines the Ratio of Exhaust Gas
Flow Rate to Engine Capacity. The defining equation is:

ExhaustFlowRate GTCapacity (C1 C2 ATair

C3 ATair2 )

where GTCapacity is the Combustion Turbine Engine Capacity, and AT air is the difference
between the current ambient and design ambient temperatures.
Field: Coefficient 1 of Exhaust Flow Curve
This numeric field contains the first coefficient for the Exhaust Flow Curve.
9/29/14

610

Input-Output Reference

Group Plant Equipment

Field: Coefficient 2 of Exhaust Flow Curve

This numeric field contains the second coefficient for the Exhaust Flow Curve.
Field: Coefficient 3 of Exhaust Flow Curve
This numeric field contains the third coefficient for the Exhaust Flow Curve.
Exhaust Gas Temperature Curve
The Exhaust Gas Temperature Curve is a polynomial equation that determines the Exhaust
Gas Temperature. The equation combines both the Exhaust Gas Temperature Curve
Coefficients (Based on the Part Load Ratio) and the (Ambient) Temperature Based Exhaust
Gas Temperature Curve Coefficients. The defining equation is:

ExhaustTemperature (C1 C2 RLoad C3 RLoad 2 ) (TBC1 TBC2 ATair TBC3 ATair2 ) 273.15
where C represents the Exhaust Gas Temperature Curve Coefficients, TBC are the
Temperature Based Exhaust Gas Temperature Curve Coefficients, RLoad is the Ratio of
Load to Combustion Turbine Engine Capacity, and AT air is the difference between the actual
ambient and design ambient temperatures.
Field: Coefficient 1 of Exhaust Gas Temperature Curve
This numeric field contains the first coefficient for the Exhaust Gas Temperature Curve.
Field: Coefficient 2 of Exhaust Gas Temperature Curve
This numeric field contains the second coefficient for the Exhaust Gas Temperature Curve.
Field: Coefficient 3 of Exhaust Gas Temperature Curve
This numeric field contains the third coefficient for the Exhaust Gas Temperature Curve.
Field: Coefficient 1 of Temperature Based Exhaust Gas Temperature Curve
This numeric field contains the first coefficient for the Temperature Based Exhaust Gas
Temperature Curve.
Field: Coefficient 2 of Temperature Based Exhaust Gas Temperature Curve
This numeric field contains the second coefficient for the Temperature Based Exhaust Gas
Temperature Curve.
Field: Coefficient 3 of Temperature Based Exhaust Gas Temperature Curve
This numeric field contains the third coefficient for the Temperature Based Exhaust Gas
Temperature Curve.
Recovery Lubricant Heat Curve
The Recovery Lubricant Heat Curve is a quadratic equation that determines the recovery
lube energy. The defining equation is:

RecoveryLubeEnergy

PLoad (C1 C2 RL C3 RL2 )

where Pload is the engine load and RL is the Ratio of Load to Combustion Turbine Engine
Capacity
The following three fields contain the coefficients for the quadratic equation.
Field: Coefficient 1 of Recovery Lube Heat Curve
This numeric field contains the first coefficient for the Recovery Lube Heat curve.

9/29/14

611

Input-Output Reference

Group Plant Equipment

Field: Coefficient 2 of Recovery Lube Heat Curve

This numeric field contains the second coefficient for the Recovery Lube Heat curve.
Field: Coefficient 3 of Recovery Lube Heat Curve
This numeric field contains the third coefficient for the Recovery Lube Heat curve.
U-Factor Times Area Curve Curve
The U-Factor Times Area Curve (UA) is an equation that determines the overall heat transfer
coefficient for the exhaust gasses with the stack. The heat transfer coefficient ultimately helps
determine the exhaust stack temperature. The defining equation is:

UAToCapacityRatio C1GasTurbineEngineCapacityC2
The following two fields contain the coefficients for the equation.
Field: Coefficient 1 of U-Factor Times Area Curve
This numeric field contains the first coefficient for the overall heat transfer coefficient curve.
Field: Coefficient 2 of U-Factor Times Area Curve
This numeric field contains the second (exponential) coefficient for the overall heat transfer
coefficient curve.
Field: Gas Turbine Engine Capacity
This numeric field contains the capacity of the gas turbine engine in watts.
Field: Maximum Exhaust Flow per Unit of Power Output
This numeric field contains the maximum exhaust gas mass flow rate per kilowatt of power
out.
Field: Design Steam Saturation Temperature
This numeric field contains the design steam saturation temperature in Celsius.
Field: Fuel Higher Heating Value
This numeric field contains the higher heating value of the fuel used in kJ/kg.
Field: Design Heat Recovery Water Flow Rate
This is the design heat recovery water flow rate if the heat recovery option is being simulated.
If this value is greater than 0.0, a heat recovery loop must be specified and attached to the
chiller using the next two node fields. The units are in cubic meters per second.
Field: Heat Recovery Inlet Node Name
This alpha field contains the identifying name for the heat recovery side inlet. If a loop is
connected, then the jacket and lubricant heat will be recovered. There is no need for an
effectiveness term, since the jacket and lubricant recovered heat energies are the actual
recovered energies.
Field: Heat Recovery Outlet Node Name
This alpha field contains the identifying name for the heat recovery side outlet.
Field: Chiller Flow Mode
This choice field determines how the chiller operates with respect to the intended fluid flow
through the devices evaporator. There are three different choices for specifying operating
modes for the intended flow behavior:
NotModulated, ConstantFlow, and
LeavingSetpointModulated. NotModulated is useful for either variable or constant speed
9/29/14

612

Input-Output Reference

Group Plant Equipment

pumping arrangements where the chiller is passive in the sense that although it makes a
nominal request for its design flow rate it can operate at varying flow rates. ConstantFlow is
useful for constant speed pumping arrangements where the chillers request for flow is
stricter and can increase the overall loop flow. LeavingSetpointModulated changes the chiller
model to internally vary the flow rate so that the temperature leaving the chiller matches a
setpoint. In all cases the operation of the external plant system can also impact the flow
through the chiller -- for example if the relative sizes and operation are such that flow is
restricted and the requests cannot be met. The default, if not specified, is NotModulated.
Field: Fuel Type
This alpha field determines the type of fuel that the chiller uses. Valid choices are:
NaturalGas, PropaneGas, Diesel, Gasoline, FuelOil#1, FuelOil#2, OtherFuel1 or
OtherFuel2. The default is NaturalGas.
Field: Heat Recovery Maximum Temperature
This field sets the maximum temperature that this piece of equipment can produce for heat
recovery. The idea behind this field is that the current models do not take temperatures into
account for availability and they just pass Q's around the loop without a temperature limit.
This temperature limit puts an upper bound on the recovered heat and limits the max
temperatures leaving the component.
As temperatures in the loop approach the maximum temperature, the temperature difference
between the entering water and the surfaces in the piece of equipment becomes smaller. For
the given heat recovery flow rate and that temperature difference the amount of heat
recovered will be reduced, and eventually there will be no heat recovered when the entering
water temperature is equal to the maximum temperature specified by the user in this field.
The reduced amount of heat recovered will diminish if the temperature of the loop approach
is the maximum temperature, and this will show up in the reporting. This allows the user to
set the availability or the quality of the heat recovered for usage in other parts of the system
or to heat domestic hot water supply.
The temperature is specified in degrees C.
Field: Sizing Factor
This optional numeric field allows the user to specify a sizing factor for this component. The
sizing factor is used when the component design inputs are autosized: the autosizing
calculations are performed as usual and the results are multiplied by the sizing factor. For this
component the inputs that would be altered by the sizing factor are: Nominal Capacity,
Design Chilled Water Flow Rate and Design Condenser Water Flow Rate. Sizing Factor
allows the user to size a component to meet part of the design load while continuing to use
the autosizing feature.
Field: Basin Heater Capacity
This numeric field contains the capacity of the chillers electric basin heater in watts per
degree Kelvin. This field only applies for Condenser Type = EvaporativelyCooled. This field is
used in conjunction with the Basin Heater Setpoint Temperature described in the following
field. The basin heater electric power is equal to this field multiplied by the difference between
the basin heater set point temperature and the outdoor dry-bulb temperature. The basin
heater only operates when the chiller is off, regardless of the basin heater schedule
described below. The basin heater capacity must be greater than or equal to zero, with a
default value of zero if this field is left blank.
Field: Basin Heater Setpoint Temperature
This numeric field contains the set point temperature (C) for the basin heater described in
the previous field. This field only applies for Condenser Type = EvaporativelyCooled. The
basin heater is active when the outdoor air dry-bulb temperature falls below this setpoint

9/29/14

613

Input-Output Reference

Group Plant Equipment

temperature, as long as the chiller is off. This set point temperature must be greater than or
equal to 2C, and the default value is 2C if this field is left blank.
Field: Basin Heater Operating Schedule Name
This alpha field contains the name of the basin heater operating schedule. This field only
applies for Condenser Type = EvaporativelyCooled. The basin heater operating schedule is
assumed to be an on/off schedule and the heater is available to operate any time the
schedule value is greater than 0. The basin heater operates when scheduled on and the
outdoor air dry-bulb temperature is below the set point temperature described in the previous
field. If this field is left blank, the basin heater is available to operate throughout the
simulation. Regardless of this schedule, the basin heater may only operate when the chiller is
off.
An example of this statement in an IDF is:

9/29/14

614

Input-Output Reference

Group Plant Equipment

Chiller:CombustionTurbine,
Big Chiller,
!- Chiller Name
WaterCooled,
!- Condenser Type
30000,
!- Nominal Capacity {W}
2.75,
!- COP
Big Chiller Inlet Node, !- Chilled Water Inlet Node Name
Big Chiller Outlet Node, !- Chilled Water Outlet Node Name
Big Chiller Condenser Inlet Node, !- Condenser Inlet Node Name
Big Chiller Condenser Outlet Node, !- Condenser Outlet Node Name
.15,
!- Minimum Part Load Ratio
1.0,
!- Maximum Part Load Ratio
.65,
!- Optimum Part Load Ratio
35.0,
!- Design Condenser Inlet Temperature {C}
2.778,
!- Temperature Rise Coefficient
6.67,
!- Design Chilled Water Outlet Temperature {C}
0.0011,
!- Design Chilled Water Flow Rate {m3/s}
0.0011,
!- Design Condenser Water Flow Rate {m3/s}
0.9949,
!- Coefficient 1 of Capacity Ratio Curve
-0.045954,
!- Coefficient 2 of Capacity Ratio Curve
-0.0013543,
!- Coefficient 3 of Capacity Ratio Curve
2.333,
!- Coefficient 1 of Power Ratio Curve
-1.975,
!- Coefficient 2 of Power Ratio Curve
0.6121,
!- Coefficient 3 of Power Ratio Curve
0.03303,
!- Coefficient 1 of Full Load Ratio Curve
0.6852,
!- Coefficient 2 of Full Load Ratio Curve
0.2818,
!- Coefficient 3 of Full Load Ratio Curve
5,
!- Chilled Water Outlet Temperature Lower Limit {C}
9.41,
!- Coefficient 1 of Fuel Input curve
-9.48,
!- Coefficient 2 of Fuel Input curve
4.32,
!- Coefficient 3 of Fuel Input curve
1.0044,
!- Coefficient 1 of Temperature Based Fuel Input curve
-0.0008,
!- Coefficient 2 of Temperature Based Fuel Input curve
0,
!- Coefficient 3 of Temperature Based Fuel Input curve
15.63518363,
!- Coefficient 1 of Exhaust Flow curve
-0.03059999,
!- Coefficient 2 of Exhaust Flow curve
-0.0002,
!- Coefficient 3 of Exhaust Flow curve
916.992,
!- Coefficient 1 of Exhaust Gas Temperature curve
307.998,
!- Coefficient 2 of Exhaust Gas Temperature curve
79.992,
!- Coefficient 3 of Exhaust Gas Temperature curve
1.005,
!- Coefficient 1 of Temperature Based Exhaust Gas Temperature c
0.0018,
!- Coefficient 2 of Temperature Based Exhaust Gas Temperature c
0,
!- Coefficient 3 of Temperature Based Exhaust Gas Temperature c
0.223,
!- Coefficient 1 of Recovery Lube Heat curve
-0.4,
!- Coefficient 2 of Recovery Lube Heat curve
0.2286,
!- Coefficient 3 of Recovery Lube Heat curve
0.01907045,
!- Coefficient 1 of UA curve
0.9,
!- Coefficient 2 of UA curve
50000,
!- Gas Turbine Engine Capacity {W}
0.00000504,
!- Maximum Exhaust Flow per Unit of Power Output {(kg/s)/W}
150,
!- Design Steam Saturation Temperature {C}
43500,
!- Fuel Higher Heating Value {kJ/kg}
0.0,
!- Design Heat Recovery Water Flow Rate {m3/s}
,
!- Heat Recovery Inlet Node Name
,
!- Heat Recovery Outlet Node Name
VariableFlow,
!- Chiller Flow Mode
NaturalGas,
!- Fuel Type
80.0;
!- Heat Recovery Maximum Temperature {C}

Combustion Turbine Chiller Outputs

HVAC,Average,Chiller Electric Power [W]
HVAC,Sum,Chiller Electric Energy [J]
Zone,Meter,Electricity:Plant [J]
Zone,Meter,Cooling:Electricity [J]
HVAC,Average,Chiller Evaporator Cooling Rate [W]
HVAC,Sum,Chiller Evaporator Cooling Energy [J]
Zone,Meter,EnergyTransfer:Plant [J]
Zone,Meter,Chillers:EnergyTransfer [J]
9/29/14

615

Input-Output Reference

Group Plant Equipment

HVAC,Average,Chiller Evaporator Inlet Temperature [C]

HVAC,Average,Chiller Evaporator Outlet Temperature [C]
HVAC,Average,Chiller Evaporator Mass Flow Rate [kg/s]
HVAC,Average,Chiller Condenser Heat Transfer Energy Rate [W]
HVAC,Sum,Chiller Condenser Heat Transfer Energy [J]
Zone,Meter,HeatRejection:EnergyTransfer [J]
HVAC,Average,Chiller COP [W/W]
Air-cooled or Evap-cooled:
HVAC,Average,Chiller Condenser Inlet Temperature [C]
Evap-cooled:
HVAC,Average,Chiller Basin Heater Electric Power [W]
HVAC,Average,Chiller Basin Heater Electric Energy [J]
Water-cooled:
HVAC,Average,Chiller Condenser Inlet Temperature [C]
HVAC,Average,Chiller Condenser Outlet Temperature [C]
HVAC,Average,Chiller Condenser Mass Flow Rate [kg/s]
HVAC,Average,Chiller Drive Shaft Power [W]
HVAC,Sum,Chiller Drive Shaft Energy [J]
HVAC,Sum,Chiller Lube Recovered Heat Energy [J]
Zone,Meter,HeatRecovery:EnergyTransfer [J]
HVAC,Average,Chiller Exhaust Temperature [C]
HVAC,Average,Chiller Heat Recovery Inlet Temperature [C]
HVAC,Average,Chiller Heat Recovery Outlet Temperature [C]
HVAC,Average,Chiller Heat Recovery Mass Flow Rate [kg/s]
HVAC,Average,Chiller <Fuel Type> Rate [W]
HVAC,Sum,Chiller <Fuel Type> Energy [J]
HVAC,Average,Chiller <Fuel Type> Mass Flow Rate [kg/s]
HVAC,Sum,Chiller <Fuel Type> Mass [kg]
HVAC,Average,Chiller COP [W/W]

These chiller output variables are defined above under "Generic Chiller Outputs." The Fuel
Type input will determine which fuel type is displayed in the output. In this example with the
user choice of NaturalGas, you will have Gas Consumption.
ChillerHeater:Absorption:DirectFired
This chiller is a direct fired absorption chiller-heater which is modeled using performance
curves similar to the equivalent chiller in DOE-2.1E. This type of chiller is unusual for
EnergyPlus, because it may be used in the same plant on both a chilled water supply branch
and a hot water supply branch. The chiller has six node connections for chilled water,
condenser water, and hot water, and can provide simultaneous heating and cooling. During
simultaneous operation, the heating capacity is reduced as the cooling load increases (for
more details see below). Some equations are provided below to help explain the function of
the various performance curves. For a detailed description of the algorithm and how the
curves are used in the calculations, please see the Engineering Reference.
Field: Name
This alpha field contains the identifying name for the chiller.
Field: Nominal Cooling Capacity
This numeric field contains the nominal cooling capability of the chiller in Watts.

9/29/14

616

Input-Output Reference

Group Plant Equipment

Field: Heating to Cooling Capacity Ratio

A positive fraction that represents the ratio of the heating capacity divided by the cooling
capacity at rated conditions. The default is 0.8.
Field: Fuel Input to Cooling Output Ratio
A positive fraction that represents the ratio of the instantaneous cooling fuel used divided by
the cooling capacity at rated conditions. The default is 0.97.
Field: Fuel Input to Heating Output Ratio
A positive fraction that represents the ratio of the instantaneous heating fuel used divided by
the nominal heating capacity. The default is 1.25.
Field: Electric Input to Cooling Output Ratio
A positive fraction that represents the ratio of the instantaneous electricity used divided by the
cooling capacity at rated conditions. If the chiller is both heating and cooling only the greater
of the computed cooling and heating electricity is used. The default is 0.01.
Field: Electric Input to Heating Output Ratio
A positive fraction that represents the ratio of the instantaneous electricity used divided by the
nominal heating capacity. If the chiller is both heating and cooling, the greater of the cooling
electricity and heating eletricity is used. The default is 0.0.
Field: Chilled Water Inlet Node Name
This required alpha field contains the identifying name for the chiller chilled water side inlet
node. This node name must be the same as the inlet node name for the chilled water supply
branch on which this chiller is placed.
Field: Chilled Water Outlet Node Name
This required alpha field contains the identifying name for the chiller chilled water side outlet
node.
Field: Condenser Inlet Node Name
This required alpha field contains the identifying name for the chiller condenser side inlet
node. If the Chiller is AirCooled, the node name specified must also be specified in an
OutdoorAir:Node object where the height of the node is taken into consideration when
calculating outdoor air dry-bulb temperature from the weather data. Alternately, the node
name may be specified in an OutdoorAir:NodeList object where the outdoor air dry-bulb
temperature is taken directly from the weather data.
Field: Condenser Outlet Node Name
This required alpha field contains the identifying name for the chiller condenser side outlet
node.
Field: Hot Water Inlet Node Name
This required alpha field contains the identifying name for the chiller-heater hot water side
inlet node. This node name must be the same as the inlet node name for the hot water supply
branch on which this chiller-heater is placed.
Field: Hot Water Outlet Node Name
This required alpha field contains the identifying name for the chiller-heater hot water side
outlet node.

9/29/14

617

Input-Output Reference

Group Plant Equipment

Field: Minimum Part Load Ratio

A positive fraction that represents the minimum cooling or heating output possible when
operated continually at rated temperature conditions divided by the available cooling or
heating capacity at those same conditions. If the load on the chiller is below this fraction, the
chiller will cycle. If the chiller is simultaneously heating and cooling, the greater part load ratio
will be used. The default is 0.1.
Field: Maximum Part Load Ratio
A positive fraction that represents the maximum cooling or heating output possible when
operated continually at rated temperature conditions divided by the available cooling or
heating capacity at those same conditions. If greater than 1.0, the chiller is typically thought
of as capable of being overloaded. The default is 1.0.
Field: Optimum Part Load Ratio
A positive fraction that represents the optimum cooling or heating output possible when
operated continually at rated temperature conditions divided by the available cooling or
heating capacity at those same conditions. It represents the most desirable operating point
for the chiller. The default is 1.0.
Field: Design Entering Condenser Water Temperature
The temperature in degrees C of the water entering the condenser of the chiller when
operating at design conditions. This is usually based on the temperature delivered by the
cooling tower in a water cooled application. The default is 29C.
Field: Design Leaving Chilled Water Temperature
The temperature in degrees C of the water leaving the evaporator of the chiller when
operating at design conditions; also called the chilled water supply temperature or leaving
chilled water temperature. The default is 7C.
Field: Design Chilled Water Flow Rate
For variable volume this is the max flow and for constant flow this is the chilled water flow
rate in m3/s.
Field: Design Condenser Water Flow Rate
The water flow rate at design conditions through the condenser in m 3/s. This field can be
autosized. This field can be autosized. This field is not used for Condenser Type=AirCooled.
Field: Design Hot Water Flow Rate
The water flow rate at design conditions through the heater side in m 3/s.
Field: Cooling Capacity Function of Temperature Curve Name
The CoolCapfT curve represents the fraction of the cooling capacity of the chiller as it varies
by temperature. The curve is normalized so that at design conditions the value of the curve
should be 1.0. The curve is usually a biquadratic or bilinear curve with the input variables
being the leaving chilled water temperature and either the entering or leaving condenser
water temperature (see Temperature Curve Input Variable below). The available cooling
capacity is computed as follows:

AvailableCoolingCapacity

NominalCoolingCapacity * CoolCapfT Tcw,l , Tcond

Field: Fuel Input to Cooling Output Ratio Function of Temperature Curve Name
The CFIRfT curve represents the fraction of the fuel input to the chiller at full load as it varies
by temperature. The curve is normalized so that at design conditions the value of the curve
9/29/14

618

Input-Output Reference

Group Plant Equipment

should be 1.0. The curve is usually a biquadratic or bilinear curve with the input variables
being the leaving chilled water temperature and either the entering or leaving condenser
water temperature (see Temperature Curve Input Variable below).
Field: Fuel Input to Cooling Output Ratio Function of Part Load Ratio Curve Name
The CFIRfPLR curve represents the fraction of the fuel input to the chiller as the load the
chiller varies but the operating temperatures remain at the design values. The curve is
normalized so that at full load the value of the curve should be 1.0. The curve is usually linear
or quadratic. The cooling fuel input to the chiller is computed as follows:

CoolFuelInput
AvailCoolCap RunFrac CFIR CFIRfT (Tcw,l , Tcond ) CFIRfPLR(CPLR)
Field: Electric Input to Cooling Output Ratio Function of Temperature Curve Name
The ElecCoolFT curve represents the fraction of the electricity to the chiller at full load as it
varies by temperature. The curve is normalized so that at design conditions the of the curve
should be 1.0. The curve is usually a biquadratic or bilinear curve with the input variables
being the leaving chilled water temperature and either the entering or leaving condenser
water temperature (see Temperature Curve Input Variable below).
Field: Electric Input to Cooling Output Ratio Function of Part Load Ratio Curve Name
The ElecCoolFPLR curve represents the fraction of the electricity to the chiller as the load on
the chiller varies but This operating temperatures remain at the design values. The curve is
normalized so that at full load the value of the curve should be 1.0. The curve is usually
linear or quadratic. The cooling electric input to the chiller is computed as follows:

CoolElectricPower
NomCoolCap RunFrac CEIR CEIRfT (Tcw,l , Tcond ) CEIRfPLR(CPLR)
Field: Heating Capacity Function of Cooling Capacity Curve Name
The HeatCapFCool curve represents how the heating capacity of the chiller varies with
cooling capacity when the chiller is simultaeous heating and cooling. The curve is normalized
so an input of 1.0 represents the nominal cooling capacity and an output of 1.0 represents the
full heating capacity (see the Heating to Cooling Capacity Ratio input) The curve is usually
linear or quadratic. The available heating capacity is computed as follows:

AvailHeatCap

NomCoolCap HeatCoolCapRatio HeatCapfCPLR(CPLRh)

Field: Fuel Input to Heat Output Ratio During Heating Only Operation Curve Name
When the chiller is operating as only a heater, the curve is used to represent the fraction of
fuel used as the heating load varies. It is normalized so that a value of 1.0 is the full available
heating capacity. The curve is usually linear or quadratic and will probably be similar to a
boiler curve for most chillers.

HeatFuelInput

AvailHeatCap HFIR HFIRfHPLR( HPLR)

Field: Temperature Curve Input Variable

This field sets the second independent variable in the three temperature dependent
performance curves to either the leaving or entering condenser water temperature.
Manufacturers express the performance of their chillers using either the leaving condenser
water temperature (to the tower) or the entering condenser water temperature (from the
9/29/14

619

Input-Output Reference

Group Plant Equipment

tower). Valid choices for this field are: LeavingCondenser or EnteringCondenser. It is

important that the performance curves and this field are consistent with each other. The
default is EnteringCondenser.
Field: Condenser Type
The condenser can either be air cooled or connected to a cooling tower. This alpha field
contains the keyword for the type of condenser, either AirCooled, or WaterCooled. The
default is WaterCooled.
Field: Chilled Water Temperature Lower Limit
The chilled water supply temperature in degrees C below which the chiller will shut off. The
default is 2C.
Field: Fuel Higher Heating Value
The fuel higher heating value in kJ/kg. This field is not currently used.
Field: Chiller Flow Mode
This field is deprecated and is not used.
Field: Fuel Type
This alpha field determines the type of fuel that the chiller uses. The default is NaturalGas.
Valid values are NaturalGas, PropaneGas, Diesel, Gasoline, FuelOil#1, FuelOil#2,
OtherFuel1, OtherFuel2.
Field: Sizing Factor
This optional numeric field allows the user to specify a sizing factor for this component. The
sizing factor is used when the component design inputs are autosized: the autosizing
calculations are performed as usual and the results are multiplied by the sizing factor. For this
component the inputs that would be altered by the sizing factor are: Nominal Cooling
Capacity, Design Chilled Water Flow Rate, Design Condenser Water Flow Rate and Design
Hot Water Flow Rate. Sizing Factor allows the user to size a component to meet part of the
design load while continuing to use the autosizing feature.
An example of this statement in an IDF is:

9/29/14

620

Input-Output Reference

Group Plant Equipment

ChillerHeater:Absorption:DirectFired,,
Big Chiller,
!- Chiller Name
100000,
!- Nominal Cooling Capacity {W}
0.8,
!- Heating to Cooling capacity ratio
0.97,
!- Fuel Input to Cooling Output Ratio
1.25,
!- Fuel Input to Heating Output Ratio
0.01,
!- Electric Input to Cooling Output Ratio
0.005,
!- Electric Input to Heating Output Ratio
Big Chiller Inlet Node, !- Chilled Water Side Inlet Node Name
Big Chiller Outlet Node, !- Chilled Water Side Outlet Node Name
Big Chiller Condenser Inlet Node, !- Condenser Side Inlet Node Name
Big Chiller Condenser Outlet Node, !- Condenser Side Outlet Node Name
Purchased Heat Inlet Node, !- Hot Water Side Inlet Node Name
Purchased Heat Outlet Node, !- Hot Water Side Outlet Node Name
0.000001,
!- Minimum Part Load Ratio
1.0,
!- Maximum Part Load Ratio
0.6,
!- Optimum Part Load Ratio
29,
!- Design Entering Condenser Water Temperature {C}
7,
!- Design Leaving Chilled Water Temperature {C}
0.0011,
!- Design Chilled Water Flow Rate {m3/s}
0.0011,
!- Design Condenser Water Flow Rate {m3/s}
0.0043,
!- Design Hot Water Flow Rate {m3/s}
GasAbsFlatBiQuad,
!- Cooling Capacity Function of Temperature Curve Name
GasAbsFlatBiQuad,
!- Fuel Input to Cooling Output Ratio Function of Temperature Curve Name
GasAbsLinearQuad,
!- Fuel Input to Cooling Output Ratio Function of Part Load Ratio Curve Name
GasAbsFlatBiQuad,
!- Electric Input to Cooling Output Ratio Function of Temperature Curve Name
GasAbsFlatQuad,
!- Electric Input to Cooling Output Ratio Function of Part Load Ratio Curve Name
GasAbsInvLinearQuad,
!- Heating Capacity Function of Cooling Capacity Curve Name
GasAbsLinearQuad,
!- Fuel Input to Heat Output Ratio During Heating Only Operation Curve Name
EnteringCondenser,
!- Temperature Curve Input Variable
WaterCooled,
!- Condenser Type
2,
!- Chilled Water Temperature Lower Limit {C}
0,
!- Fuel Higher Heating Value {kJ/kg}
VariableFlow,
!- Chiller Flow Mode
NaturalGas,
!- Fuel Type
1.0;
!- Sizing Factor

Direct Fired Absorption Chiller Outputs

HVAC,Average,Chiller Heater Electric Power [W]
HVAC,Sum,Chiller Heater Electric Energy [J]
Zone,Meter,Electricity:Plant [J]
Zone,Meter,Cooling:Electricity [J]
HVAC,Average,Chiller <Fuel Type> Consumption Rate [W]
HVAC,Sum,Chiller <Fuel Type> Consumption [J]
Zone,Meter,<Fuel Type>:Plant [J]
Zone,Meter,Cooling:<Fuel Type> [J]
HVAC,Average,Chiller Evaporator Cooling Rate [W]
HVAC,Sum,Chiller Heater Evaporator Cooling Energy [J]
Zone,Meter,EnergyTransfer:Plant [J]
Zone,Meter,Chillers:EnergyTransfer [J]
HVAC,Average,Chiller Heater Evaporator Inlet Temperature [C]
HVAC,Average,Chiller Heater Evaporator Outlet Temperature [C]
HVAC,Average,Chiller Heater Evaporator Mass Flow Rate [kg/s]
HVAC,Average,Chiller Heater Condenser Heat Transfer Rate [W]
HVAC,Sum,Chiller Heater Condenser Heat Transfer Energy [J]
Zone,Meter,HeatRejection:EnergyTransfer [J]
The following output is applicable only for air-cooled chillers
HVAC,Average,Chiller Heater Condenser Inlet Temperature [C]
The following three outputs are only available for water-cooled chillers
HVAC,Average,Chiller Heater Condenser Inlet Temperature [C]
HVAC,Average,Chiller Heater Condenser Outlet Temperature [C]
9/29/14

621

Input-Output Reference

Group Plant Equipment

HVAC,Average,Chiller Heater Condenser Mass Flow Rate [kg/s]

Outputs specific to Direct Fired Absorption Chiller
HVAC,Average,Chiller Heater Runtime Fraction []
Outputs specific to Direct Fired Absorption Chiller during cooling
operation
HVAC,Average,Chiller Heater Cooling <Fuel Type> Rate [W]
HVAC,Sum,Chiller Heater Cooling <Fuel Type> Consumption [J]
HVAC,Average,Chiller Heater Cooling Electric Power [W]
HVAC,Sum,Chiller Heater Cooling Electric Energy [J]
HVAC,Average,Chiller Heater Cooling Part Load Ratio
HVAC,Average,Chiller Heater Cooling Rate [W]
HVAC,Average,Chiller Heater Cooling COP [W/W]
Outputs specific to Direct Fired Absorption Chiller during heating
operation
HVAC,Average,Chiller Heater Heating Rate [W]
HVAC,Sum,Chiller Heater Heating Energy [J]
HVAC,Average,Chiller Heater Heating <Fuel Type> Rate [W]
HVAC,Sum,Chiller Heater Heating <Fuel Type> Energy [J]
HVAC,Average,Chiller Heater Heating Electric Power [W]
HVAC,Sum,Chiller Heater Heating Electric Energy [J]
HVAC,Average,Chiller Heater Heating Part Load Ratio []
HVAC,Average,Chiller Heater Heating Rate [W]
HVAC,Average,Chiller Heater Heating Inlet Temperature [C]
HVAC,Average,Chiller Heater Heating Outlet Temperature [C]
HVAC,Average,Chiller Heater Heating Mass Flow Rate [kg/s]

The "Chiller" output variables are defined above under "Generic Chiller Outputs." The
specific "Direct Fired Absorption Chiller" output variables and exceptions to the generic
outputs are defined below.
Chiller Heater Electric Power [W]
Chiller Heater Electric Energy [J]
These outputs are the electric power input to the chiller when operating in cooling mode,
heating mode, or both. This value is not metered, but the separate cooling and heating
electric consumption are metered (see below).
Chiller Heater <Fuel Type> Rate [W]
Chiller Heater <Fuel Type> Energy [J]
These outputs are the fuel input to the chiller when operating in cooling mode, heating mode,
or both depending on the fuel type entered. This value is not metered, but the separate
cooling and heating fuel consumption are metered (see below).
Chiller Heater Runtime Fraction []
This is the average fraction of the time period during which the direct fired absorption chillerheater was operating in either cooling mode, heating mode, or both.

9/29/14

622

Input-Output Reference

Group Plant Equipment

Chiller Heater Cooling <Fuel Type> Rate [W]

Chiller Heater Cooling <Fuel Type> Energy [J]
These outputs are the fuel input to the direct fired absorption chiller to serve cooling
operation. Consumption is metered on Cooling:<Fuel Type>, <Fuel Type>:Plant, and <Fuel
Type>:Facility.
Chiller Heater Cooling Electric Power [W]
Chiller Heater Cooling Electric Energy [J]
These outputs are the electricity input to the direct fired absorption chiller to serve cooling
operation. Consumption is metered on Cooling:Electricity, Electricity:Plant, and
Electricity:Facility.
Chiller Heater Cooling Rate [W]
This is the average available cooling capacity for the reported time period.
Chiller Heater Cooling Part Load Ratio
This is the average cooling load (Chiller Evaporator Cooling Rate [W]) divided by the average
available cooling capacity (Chiller Heater Cooling Rate [W]) for the reported time period.
Chiller Heater Cooling COP
This is the average coefficient of performance for the chiller in cooling operation, calculated
as the average cooling load (Chiller Evaporator Cooling Rate [W]) divided by the average fuel
consumption during cooling (Direct Fired Absorption Chiller Cooling <Fuel Type>
Consumption Rate [W]) for the reported time period. If the chiller cooling fuel consumption
rate (denominator) is zero, then this output variable is set to zero.
Chiller Heater Heating Rate [W]
Chiller Heater Heating Energy [J]
These outputs are the heating delivered by the direct fired absorption chiller-heater to serve
heating operation. Energy is metered on Boilers:EnergyTransfer, EnergyTransfer:Plant, and
EnergyTransfer:Facility.
Chiller Heater Heating <Fuel Type> Rate [W]
Chiller Heater Heating <Fuel Type> Energy [J]
These outputs are the fuel input to the direct fired absorption chiller-heater to serve heating
operation. Consumption is metered on Heating:<Fuel Type>, <Fuel Type>:Plant, and <Fuel
Type>:Facility.
Chiller Heater Heating Electric Power [W]
Chiller Heating Heating Electric Energy [J]
These outputs are the electric power input to the direct fired absorption chiller to serve
heating operation. Consumption is metered on Heating:Electricity, Electricity:Plant, and
Electricity:Facility.
Chiller Heater Heating Rate [W]
This is the average available heating capacity for the reported time period.
Chiller Heater Heating Part Load Ratio
This is the average heating load (Chiller Heater Heating Rate [W]) divided by the average
available heating capacity (Chiller Heater Heating Rate [W]) for the reported time period.

9/29/14

623

Input-Output Reference

Group Plant Equipment

Chiller Heater Heating Inlet Temperature [C]

Chiller Heater Heating Outlet Temperature [C]
Chiller Heater Heating Mass Flow Rate [kg/s]
These outputs are the hot water inlet and outlet temperatures and flow rate for the direct fired
absorption chiller-heater during heating mode operation.
ChillerHeater:Absorption:DoubleEffect
This chiller is an exhaust fired absorption chiller-heater which is modeled using performance
curves similar to the direct fired absorption chiller in DOE-2.1E. The model uses the exhaust
gas output from MicroTurbine. This type of chiller is unusual for EnergyPlus, because it may
be used in the same plant on both a chilled water supply branch and a hot water supply
branch. The chiller has six node connections for chilled water, condenser water, and hot
water, and can provide simultaneous heating and cooling. During simultaneous operation, the
heating capacity is reduced as the cooling load increases (for more details see below). Some
equations are provided below to help explain the function of the various performance curves.
For a detailed description of the algorithm and how the curves are used in the calculations,
please see the Engineering Reference.
Field: Name
This alpha field contains the identifying name for the chiller.
Field: Nominal Cooling Capacity
This numeric field contains the nominal cooling capability of the chiller in Watts. Autosize can
be used for this field.
Field: Heating to Cooling Capacity Ratio
A positive fraction that represents the ratio of the heating capacity divided by the cooling
capacity at rated conditions. The default is 0.8.
Field: Thermal Energy Input to Cooling Output Ratio
A positive fraction that represents the ratio of the instantaneous cooling Thermal Energy used
divided by the cooling capacity at rated conditions. The default is 0.97.
Field: Thermal Energy Input to Heating Output Ratio
A positive fraction that represents the ratio of the instantaneous heating Thermal Energy
used divided by the nominal heating capacity. The default is 1.25.
Field: Electric Input to Cooling Output Ratio
A positive fraction that represents the ratio of the instantaneous electricity used divided by the
cooling capacity at rated conditions. If the chiller is both heating and cooling only the greater
of the computed cooling and heating electricity is used. The default is 0.01.
Field: Electric Input to Heating Output Ratio
A positive fraction that represents the ratio of the instantaneous electricity used divided by the
nominal heating capacity. If the chiller is both heating and cooling, the greater of the cooling
electricity and heating eletricity is used. The default is 0.0.
Field: Chilled Water Inlet Node Name
This required alpha field contains the identifying name for the chiller chilled water side inlet
node. This node name must be the same as the inlet node name for the chilled water supply
branch on which this chiller is placed.

9/29/14

624

Input-Output Reference

Group Plant Equipment

Field: Chilled Water Outlet Node Name

This required alpha field contains the identifying name for the chiller chilled water side outlet
node.
Field: Condenser Inlet Node Name
This required alpha field contains the identifying name for the chiller condenser side inlet
node. If the Chiller is AirCooled, the node name specified must also be specified in an
OutdoorAir:Node object where the height of the node is taken into consideration when
calculating outdoor air dry-bulb temperature from the weather data. Alternately, the node
name may be specified in an OutdoorAir:NodeList object where the outdoor air dry-bulb
temperature is taken directly from the weather data.
Field: Condenser Outlet Node Name
This required alpha field contains the identifying name for the chiller condenser side outlet
node.
Field: Hot Water Inlet Node Name
This required alpha field contains the identifying name for the chiller-heater hot water side
inlet node. This node name must be the same as the inlet node name for the hot water supply
branch on which this chiller-heater is placed.
Field: Hot Water Outlet Node Name
This required alpha field contains the identifying name for the chiller-heater hot water side
outlet node.
Field: Minimum Part Load Ratio
A positive fraction that represents the minimum cooling or heating output possible when
operated continually at rated temperature conditions divided by the available cooling or
heating capacity at those same conditions. If the load on the chiller is below this fraction, the
chiller will cycle. If the chiller is simultaneously heating and cooling, the greater part load ratio
will be used. The default is 0.1.
Field: Maximum Part Load Ratio
A positive fraction that represents the maximum cooling or heating output possible when
operated continually at rated temperature conditions divided by the available cooling or
heating capacity at those same conditions. If greater than 1.0, the chiller is typically thought
of as capable of being overloaded. The default is 1.0.
Field: Optimum Part Load Ratio
A positive fraction that represents the optimum cooling or heating output possible when
operated continually at rated temperature conditions divided by the available cooling or
heating capacity at those same conditions. It represents the most desirable operating point
for the chiller. The default is 1.0.
Field: Design Entering Condenser Water Temperature
The temperature in degrees C of the water entering the condenser of the chiller when
operating at design conditions. This is usually based on the temperature delivered by the
cooling tower in a water cooled application. The default is 29C.
Field: Design Leaving Chilled Water Temperature
The temperature in degrees C of the water leaving the evaporator of the chiller when
operating at design conditions; also called the chilled water supply temperature or leaving
chilled water temperature. The default is 7C.

9/29/14

625

Input-Output Reference

Group Plant Equipment

Field: Design Chilled Water Flow Rate

For variable volume this is the max flow and for constant flow this is the chilled water flow
rate in m3/s. This field can be autosized.
Field: Design Condenser Water Flow Rate
The water flow rate at design conditions through the condenser in m 3/s. This field can be
autosized. This field is not used for Condenser Type=AirCooled.
Field: Design Hot Water Flow Rate
The water flow rate at design conditions through the heater side in m 3/s. This field can be
autosized.
Field: Cooling Capacity Function of Temperature Curve Name
The CoolCapfT curve represents the fraction of the cooling capacity of the chiller as it varies
with temperature. The curve is normalized so that at design conditions the value of the curve
should be 1.0. The curve is usually a biquadratic or bilinear curve with the input variables
being the leaving chilled water temperature and the entering condenser water temperature
(see Temperature Curve Input Variable below). The available cooling capacity is computed
as follows:

AvailCoolCap

NomCoolCap CoolCapfT (Tcw,l , Tcond )

Field: Thermal Energy Input to Cooling Output Ratio Function of Temperature Curve Name
The TeFIRfT curve represents the fraction of the Thermal Energy Input to the chiller at full
load as it varies with temperature. The curve is normalized so that at design conditions the
value of the curve should be 1.0. The curve is usually a biquadratic or bilinear curve with the
input variables being the leaving chilled water temperature and the entering condenser water
temperature (see Temperature Curve Input Variable below).
Field: Thermal Energy Input to Cooling Output Ratio Function of Part Load Ratio Curve
Name
The TeFIRfPLR curve represents the fraction of the Thermal Energy Input to the chiller as the
load on the chiller varies but the operating temperatures remain at the design values. The
curve is normalized so that at full load the value of the curve should be 1.0. The curve is
usually linear or quadratic.
The cooling Thermal Energy Input to the chiller is computed as follows:

CoolThermalEnergyInput

AvailCoolCap RunFrac TeFIR

TeFIRfT Tcw ,l , Tcond TeFIRfPLR(CPLR)

Field: Electric Input to Cooling Output Ratio Function of Temperature Curve Name
The CEIRfT curve represents the fraction of the electricity to the chiller at full load as it varies
with temperature. The curve is normalized so that at design conditions the of the curve
should be 1.0. The curve is usually a biquadratic or bilinear curve with the input variables
being the leaving chilled water temperature and either the entering or leaving condenser
water temperature (see Temperature Curve Input Variable below).
Field: Electric Input to Cooling Output Ratio Function of Part Load Ratio Curve Name
The CEIRfPLR curve represents the fraction of the electricity to the chiller as the load on the
chiller varies but This operating temperatures remain at the design values. The curve is

9/29/14

626

Input-Output Reference

Group Plant Equipment

normalized so that at full load the value of the curve should be 1.0. The curve is usually
linear or quadratic.
The cooling electric input to the chiller is computed as follows:

CoolElectricPower

NomCoolCap RunFrac CEIR CEIRfT Tcw,l , Tcond

CEIRfPLR(CPLR)

Field: Heating Capacity Function of Cooling Capacity Curve Name

The HeatCapFCPLR curve represents how the heating capacity of the chiller varies with
cooling capacity when the chiller is simultaneously heating and cooling. The curve is
normalized so an input of 1.0 represents the nominal cooling capacity and an output of 1.0
represents the full heating capacity (see the Heating to Cooling Capacity Ratio input) The
curve is usually linear or quadratic.
The available heating capacity is computed as follows:

AvailHeatCap

NomCoolCap HeatCoolCapRatio HeatCapfCPLR(CPLRh)

Field: Thermal Energy Input to Heat Output Ratio During Heating Only Operation Curve
Name
When the chiller is operating as only a heater, the curve is used to represent the fraction of
Thermal Energy used as the heating load varies. It is normalized so that a value of 1.0 is the
full available heating capacity. The curve is usually linear or quadratic and will probably be
similar to a boiler curve for most chillers.
The heating Thermal Energy Input to the chiller is computed as follows:

HeatThermalEnergyInput

AvailHeatCap HFIR HFIRfHPLR( HPLR)

Field: Temperature Curve Input Variable

This field sets the second independent variable in the three temperature dependent
performance curves to the entering condenser water temperature. Manufacturers express
the performance of their chillers typically using the entering condenser water temperature
(from the tower). ). This alpha field contains the keyword for the type of temperature input
variable, , either EnteringCondenserTemperature, or LeavingCondenserTemperature.
The default is EnteringCondenserTemperature.
Field: Condenser Type
The condenser can either be air cooled or water cooled (connected to a cooling tower). This
alpha field contains the keyword for the type of condenser, either AirCooled, or WaterCooled.
The default is WaterCooled.
Field: Chilled Water Temperature Lower Limit
The chilled water supply temperature in degrees C below which the chiller will shut off. The
default is 2C.
Field: Exhaust Source
This alpha field determines the type of exhaust source the chiller uses. The default is
MicroTurbine. Key Generator:MicroTurbine
Field: Exhaust Source Object
This alpha field shows the name of the Exhaust source object a Generator:MicroTurbine in
this case

9/29/14

627

Input-Output Reference

Group Plant Equipment

Field: Sizing Factor

This optional numeric field allows the user to specify a sizing factor for this component. Min
value should not be less than 0 and here is no max. The default is 1. The sizing factor is
used when the component design inputs are autosized: the autosizing calculations are
performed as usual and the results are multiplied by the sizing factor. For this component the
inputs that would be altered by the sizing factor are: Nominal Cooling Capacity, Design
Chilled Water Flow Rate, Design Condenser Water Flow Rate and Design Hot Water Flow
Rate. Sizing Factor allows the user to size a component to meet part of the design load while
continuing to use the autosizing feature.
An example of this statement in an IDF is:
ChillerHeater:Absorption:DoubleEffect,,
Exh Chiller,
!- Chiller Name
100000,
!- Nominal Cooling Capacity {W}
0.8,
!- Heating to Cooling capacity ratio
0.97,
!- Thermal Energy Input to Cooling Output Ratio
1.25,
!- Thermal Energy Input to Heating Output Ratio
0.01,
!- Electric Input to Cooling Output Ratio
0.005,
!- Electric Input to Heating Output Ratio
Exh Chiller Inlet Node, !- Chilled Water Side Inlet Node Name
Exh Chiller Outlet Node, !- Chilled Water Side Outlet Node Name
Exh Chiller Condenser Inlet Node, !- Condenser Side Inlet Node Name
Exh Chiller Condenser Outlet Node, !- Condenser Side Outlet Node Name
Exh Chiller Heating Inlet Node, !- Hot Water Side Inlet Node Name
Exh Chiller Heating Outlet Node, !- Hot Water Side Outlet Node Name
0.000001,
!- Minimum Part Load Ratio
1.0,
!- Maximum Part Load Ratio
0.6,
!- Optimum Part Load Ratio
29,
!- Design Entering Condenser Water Temperature {C}
7,
!- Design Leaving Chilled Water Temperature {C}
0.0011,
!- Design Chilled Water Flow Rate {m3/s}
0.0011,
!- Design Condenser Water Flow Rate {m3/s}
0.0043,
!- Design Hot Water Flow Rate {m3/s}
ExhAbsorb_CapFt,
!- Cooling Capacity Function of Temperature Curve Name
ExhAbsorb_EIRFt,
!- Thermal Energy Input to Cooling Output Ratio Function of Temperature Curve
Name
ExhAbsorb_PLR,
!- Thermal Energy Input to Cooling Output Ratio Function of Part Load Ratio
Curve Name
ExhAbsFlatBiQuad,
!- Electric Input to Cooling Output Ratio Function of Temperature Curve Name
ExhAbsFlatQuad,
!- Electric Input to Cooling Output Ratio Function of Part Load Ratio Curve Name
ExhAbsInvLinearQuad,
!- Heating Capacity Function of Cooling Capacity Curve Name
ExhAbsLinearQuad,
!- Thermal Energy Input to Heat Output Ratio During Heating Only Operation
Curve Name
EnteringCondenser,
!- Temperature Curve Input Variable
WaterCooled,
!- Condenser Type
2,
!- Chilled Water Temperature Lower Limit {C}
Generator:MicroTurbine ; ! Field Exhaust Source Object Type
Capston500 ;
! Field Exhaust Source name
1.0;
!- Sizing Factor

Exhaust Fired Absorption Chiller Outputs

HVAC,Average,Chiller Heater Electric Power [W]
HVAC,Sum,Chiller Heater Electric Energy [J]
HVAC,Average,Chiller Heater Evaporator Cooling Rate [W]
HVAC,Sum,Chiller Heater Evaporator Cooling Energy [J]
HVAC,Average,Chiller Heater Evaporator Inlet Temperature [C]
HVAC,Average,Chiller Heater Evaporator Outlet Temperature [C]
HVAC,Average,Chiller Heater Evaporator Mass Flow Rate [kg/s]
HVAC,Average,Chiller Heater Condenser Heat Transfer Rate [W]
HVAC,Sum,Chiller Heater Condenser Heat Transfer Energy [J]
The following output is applicable only for air-cooled chillers
9/29/14

628

Input-Output Reference

Group Plant Equipment

HVAC,Average,Chiller Heater Condenser Inlet Temperature [C]

The following three outputs
HVAC,Average,Chiller Heater
HVAC,Average,Chiller Heater
HVAC,Average,Chiller Heater

are only available for water-cooled chillers

Condenser Inlet Temperature [C]
Condenser Outlet Temperature [C]
Condenser Mass Flow Rate [kg/s]

Outputs specific to Exhaust Fired Absorption Chiller

HVAC,Average,Chiller Heater Runtime Fraction []
Outputs specific to Exhaust Fired Absorption Chiller during cooling operation
HVAC,Average,Chiller Heater Cooling Electric Power [W]
HVAC,Sum,Chiller Heater Cooling Electric Energy [J]
HVAC,Average,Chiller Heater Cooling Part Load Ratio
HVAC,Average,Chiller Heater Maximum Cooling Rate [W]HVAC,Average,Chiller
Heater Cooling Source Heat Transfer Rate [W]
HVAC,Average, Chiller Heater Cooling Source Heat COP [W/W]
HVAC,Average, Chiller Heater Source Exhaust Inlet Mass Flow Rate [kg/s]
HVAC,Average, Chiller Heater Source Exhaust Inlet Temperature [C]
Outputs specific to Exhaust Fired Absorption Chiller during heating operation
HVAC,Average,Chiller Heater Heating Rate [W]
HVAC,Sum,Chiller Heater Heating Energy [J]
HVAC,Average,Chiller Heater Heating Electric Power [W]
HVAC,Sum,Chiller Heater Heating Electric Energy [J]
Zone,Meter,Heating:Electricity [J]
HVAC,Average,Chiller Heater Heating Part Load Ratio
HVAC,Average,Chiller Heater Maximum Heating Rate [W]
HVAC,Average,Chiller Heater Heating Source Heat Transfer Rate
HVAC,Average,Chiller Heater Heating Inlet Temperature [C]
HVAC,Average,Chiller Heater Heating Outlet Temperature [C]
HVAC,Average,Chiller Heater Heating Mass Flow Rate [kg/s]

The "Chiller" output variables are defined above under "Generic Chiller Outputs." The
specific "Exhaust Fired Absorption Chiller" output variables and exceptions to the generic
outputs are defined below.
Chiller Heater Electric Power [W]
Chiller Heater Electric Energy [J]
These outputs are the electric power input to the chiller when operating in cooling mode,
heating mode, or both. This value is not metered, but the separate cooling and heating
electric consumption are metered (see below).
Chiller Heater Runtime Fraction []
This is the average fraction of the time period during which the Exhaust Fired absorption
chiller-heater was operating in either cooling mode, heating mode, or both.
These outputs are the electricity input to the Exhaust Fired absorption chiller heater to serve
cooling operation. Consumption is metered on Cooling:Electricity, Electricity:Plant, and
Electricity:Facility.
Chiller Heater Maximum Cooling Rate [W]
This is the average available cooling capacity for the reported time period.

9/29/14

629

Input-Output Reference

Group Plant Equipment

Chiller Heater Cooling Part Load Ratio []

This is the average cooling load (Chiller Heater Evaporator Cooling Rate [W]) divided by the
average available cooling capacity (Chiller Heater Maximum Cooling Rate [W]) for the
reported time period.
Chiller Heater Cooling Source Heat COP [W/W]
This is the average coefficient of performance for the chiller in cooling operation, calculated
as the average cooling load (Chiller Heater Evaporator Cooling Rate [W]) divided by the
average thermal energy use during cooling (Chiller Heater Cooling Source Heat Transfer
Rate [W]) for the reported time period. If the chiller cooling thermal energy use rate
(denominator) is zero, then this output variable is set to zero.
Chiller Heater Heating Rate [W]
Chiller Heater Heating Energy [J]
Chiller Heater Heating Electric Power [W]
Chiller Heater Heating Electric Energy [J]
These outputs are the electric power input to the Exhaust Fired absorption chiller to serve
heating operation. Consumption is metered on Heating:Electricity, Electricity:Plant, and
Electricity:Facility.
Chiller Heater Maximum Heating Rate [W]
This is the average available heating capacity for the reported time period.
Chiller Heater Heating Part Load Ratio []
This is the average heating load (Chiller Heater Heating Rate [W]) divided by the average
available heating capacity (Chiller Heater Maximum Heating Rate [W]) for the reported time
period.
Chiller Heater Heating Inlet Temperature [C]
Chiller Heater Heating Outlet Temperature [C]
Chiller Heater Heating Mass Flow Rate [kg/s]
These outputs are the hot water inlet and outlet temperatures and flow rate for the Exhaust
Fired absorption chiller-heater during heating mode operation.
Chiller Heater Heating Heat Recovery Potential Rate (W)
The heat recovery potential calculated based on Microturbine exhaust temperature and flow
rate during heating mode
Chiller Heater Heating Source Heat Transfer Rate (W)
The thermal energy consumption rate required for heating.
Chiller Heater Cooling Heat Recovery Potential Rate (W)
The heat recovery potential calculated based on Microturbine exhaust temperature and flow
rate during cooling mode.
Chiller Heater Cooling Source Heat Transfer Rate (W)
The thermal energy consumption rate required for cooling.
Chiller Heater Condenser Inlet Temperature [C]
The condenser (heat rejection) inlet temperature for air-cooled or water chiller heater. For an
air-cooled chiller heater, this output would be the dry-bulb temperature of the air entering the
condenser coil. For a water cooled chiller heater, this output would be the wet-bulb
temperature of the air entering the condenser coil.

9/29/14

630

Input-Output Reference

Group Plant Equipment

Chiller Heater Condenser Heat Transfer Energy [J]

The condenser heat transfer energy is the heat rejected from the chiller heater to either a
condenser water loop or through an air-cooled condenser. The values are calculated for each
HVAC system time step being simulated, and the results are summed across the reporting
period. Chiller Heater Condenser Heat Transfer Energy is metered on
HeatRejection:EnergyTransfer, EnergyTransfer:Plant, and EnergyTransfer:Facility.
Chiller Heater Condenser Heat Transfer Rate [W]
The condenser heat transfer is the rate of heat rejected from the chiller heater to either a
condenser water loop or through an air-cooled condenser. This value is calculated for each
HVAC system time step being simulated, and the results are averaged for the time step being
reported.
Chiller Heater Condenser Mass Flow Rate [kg/s]
This is the condenser coil outlet water mass flow rate in kilograms per second. This value is
calculated for each HVAC system time step being simulated, and the results are averaged for
the time step being reported.
Chiller Heater Condenser Outlet Temperature [C]
This is the condenser coil outlet water temperature in degrees C. This value is calculated for
each HVAC system time step being simulated, and the results are averaged for the time step
being reported
Chiller Heater Evaporator Cooling Energy [J]
The evaporator heat transfer is the cooling delivered by the chiller heater. The values are
calculated for each HVAC system time step being simulated, and the results are summed
across the reporting period. Chiller Heater Evaporator Cooling Energy is metered on
Chillers:EnergyTransfer, EnergyTransfer:Plant, and EnergyTransfer:Facility.
Chiller Heater Evaporator Cooling Rate [W]
The evaporator heat transfer rate of cooling delivered by the chiller heater. This value is
calculated for each HVAC system time step being simulated, and the results are averaged for
the time step being reported.
Chiller Heater Evaporator Inlet Temperature [C]
The evaporator (chilled water) inlet temperature over the time step being reported.
Chiller Heater Evaporator Mass Flow Rate [kg/s]
The evaporator (chilled water) average mass flow rate over the time step being reported
Chiller Heater Evaporator Outlet Temperature [C]
The evaporator (chilled water) outlet temperature over the time step being reported
Chiller Heater Cooling Electric Energy [J]
The electric power input to the exhaust fired absorption chiller to serve cooling operation. The
values are calculated for each HVAC system time step being simulated, and the results are
summed across the reporting period. Consumption is metered on Heating:Electricity,
Electricity:Plant, and Electricity:Facility.
Chiller Heater Cooling Electric Power [W]
The electric power input to the Exhaust Fired absorption chiller to serve cooling operation.
This value is calculated for each HVAC system time step being simulated, and the results are
averaged for the time step being reported.

9/29/14

631

Input-Output Reference

Group Plant Equipment

Chiller Heater Source Exhaust Inlet Mass Flow Rate [kg/s]

The exhaust flow rate from the Micro Turbine
Chiller Heater Source Exhaust Inlet Temperature [C]
The exhaust temperature from the Micro Turbine
Boiler:HotWater
The boiler model calculates the performance of fuel oil, gas and electric boilers. Boiler
performance is based on nominal thermal efficiency. A normailized efficiency performance
curve may be used to more accurately represent the performance of non-electric boilers but
is not considered a required input. When using the normalized efficiency performance curve,
if all coefficients are not required simply set the unused coefficients to 0. For example, an
electric boiler could be modeled by setting the nominal thermal efficiency to a value in the
range of 0.96 to 1.0. Coefficient A0 in the normalized efficiency performance curve would
equal 1 and all other coefficients would be set to 0. Coefficients for other types of non-electric
boilers would set a combination of the available coefficents to non-zero values.
Field: Name
This required alpha field contains the identifying name for the boiler.
Field: Fuel Type
This required choice field specifies the type of fuel used by the boiler. The fuel type can be
Electricity, NaturalGas, PropaneGas, FuelOil#1, FuelOil#2, Coal, Diesel, Gasoline,
OtherFuel1 or OtherFuel2.
Field: Nominal capacity
This numeric field contains the nominal operating capacity (W) of the boiler. The boiler may
be autosized and would require a heating plant sizing object.
Fuel Use Equation
The model is based the following two equations:

TheoreticalFuelUse

FuelUsed

BoilerLoad
NominalThermalEfficiency

TheoreticalFuelUse
NormalizedBoilerEfficiencyCurveOutput

Field: Nominal Thermal Efficiency

This required numeric field contains the heating efficiency (as a fraction between 0 and 1) of
the boilers burner. This is the efficiency relative to the higher heating value (HHV) of fuel at
a part load ratio of 1.0 and the temperature entered for the Design Boiler Water Outlet Temp.
Manufacturers typically specify the efficiency of a boiler using the higher heating value of the
fuel. For the rare occurences when a manufacturers (or particular data set) thermal efficiency
is based on the lower heating value (LHV) of the fuel, multiply the thermal efficiency by the
lower-to-higher heating value ratio. For example, assume a fuels lower and higher heating
values are approximately 45,450 and 50,000 kJ/kg, respectively. For a manuracturers
thermal effiency rating of 0.90 (based on the LHV), the nominal thermal efficiency entered
here is 0.82 (i.e. 0.9 multiplied by 45,450/50,000).

9/29/14

632

Input-Output Reference

Group Plant Equipment

Field: Efficiency Curve Temperature Evaluation Variable

This field is used to control which value for hot water temperature is used when evaluating
the efficiency curve specified in the next field (if applicable). There are two options,
EnteringBoiler or LeavingBoiler. EnteringBoiler indicates that the efficiency curves will be
evaluated using the temperature at boiler inlet node. LeavingBoiler indicates that the
efficiency curves will be evaluated using the temperature at the boiler outlet. This field is only
used if type of curve is one that uses temperature as a independent variable.
Field: Normalized Boiler Efficiency Curve Name
This alpha field contains the curve name which describes the normalized heating efficiency
(as a fraction of nominal thermal efficiency) of the boilers burner. If this field is left blank, the
nominal thermal efficiency is assumed to be constant (i.e., Fuel Used is equal to the
Theoretical Fuel Use in the equation above). When a boiler efficiency curve is used, the
curve may be any valid curve object with 1 (PLR) or 2 (PLR and boiler outlet water
temperature) independent variables. A tri-quadratic curve object is not allowed since it uses 3
independent variables. The linear, quadratic, and cubic curve types may be used when the
boiler efficiency is soley a function of boiler part-load ratio (PLR). When this type of curve is
used, the boiler should operate at (or very near) the design boiler water outlet temperature.
Other curve types may be used when the boiler efficiency is a function of both PLR and boiler
water temperature. Examples of valid single and dual independent variable equations are
shown below. For all curve types PLR is always the x independent variable. When using 2
independent variables, the boiler outlet water temperature (Toutlet) is always the y
independent variable.

Linear

Eff

Quadratic

Cubic

A0

A1 PLR

Eff

Eff

BiQuadratic

A1 PLR A2 PLR 2

A0
Eff

QuadraticLinear

Bicubic

Eff

A1 PLR A2 PLR 2

A0

A0
Eff

A0

A1 PLR A2 PLR2
A0

A3 Tw

A1 PLR A2 PLR2

A1 PLR A2 PLR 2

A7 Tw3

A3 PLR3

A8 PLR 2 Tw

A3 Tw

A4 Tw2

A3 Tw

A4Tw2

A5 PLR Tw

A4 PLR Tw

A5 PLR Tw

A5 PLR2 Tw

A6 PLR3

A9 PLR Tw2

where
Eff = normalized boiler efficiency
PLR = boiler part-load ratio
Tw = boiler water temperature [C] ], this can be either entering or leaving temperature
depending on the setting in the previous field
Field: Design Water Outlet Temperature
This numeric field contains the desired boiler water outlet temperature in Celsius.

9/29/14

633

Input-Output Reference

Group Plant Equipment

Field: Design Water Flow Rate

This numeric field contains the maximum design water volumetric flow rate in m3/sec. This
should be the largest flow rate than can be heated to the design outlet temperature. This field
is autosizable.
Field: Minimum Part Load Ratio
This numeric field contains the minimum part load ratio. If the ratio of demand to boiler
nominal capacity is less than the minimum part load ratio, then the Min PLR will determine
the operating PLR. The expected range is between 0 and 1. If this field is left blank, the
default value is 0.0.
Field: Maximum Part Load Ratio
This numeric field contains the maximum part load ratio. If the ratio of demand to boiler
nominal capacity is greater than the maximum part load ratio, then the Max PLR will
determine the operating PLR. This value may exceed 1, but the normal range is between 0
and 1.1. If this field is left blank, the default value is 1.0.
Field: Optimum Part Load Ratio
This numeric field contains the optimum part load ratio. This is the part load ratio at which the
boiler performs at its maximum efficiency. If this field is left blank, the default value is 1.0.
Field: Boiler Water Inlet Node Name
This required alpha field contains the water inlet node name.
Field: Boiler Water Outlet Node Name
This required alpha field contains the water outlet node name.
Field: Water Outlet Upper Temperature Limit
This numeric field contains the outlet temperature upper limit. If this field is left blank, the
default value is 99.9C.
Field: Boiler Flow Mode
This choice field determines how the boiler operates with respect to the intended fluid flow
through the device. There are three different choices for specifying operating modes for the
intended flow behavior: NotModulated, ConstantFlow, and LeavingSetpointModulated.
NotModulated is useful for either variable or constant speed pumping arrangements where
the boiler is passive in the sense that although it makes a nominal request for its design flow
rate it can operate at varying flow rates. ConstantFlow is useful for constant speed pumping
arrangements where the boilers request for flow is more strict and can increase the overall
loop flow. LeavingSetpointModulated changes the boiler model to internally vary the flow rate
so that the temperature leaving the boiler matches a setpoint. In all cases the operation of
the external plant system can also impact the flow through the boiler -- for example if the
relative sizes and operation are such that flow is restricted and the requests cannot be met.
The default, if not specified, is NotModulated.
Field: Parasitic Electric Load
This optional numeric field contains the parasitic electric power (W) consumed by a forced
draft fan or other electrical device associated with the boiler. This parasitic electric load is
consumed whenever the boiler is operating, and the model assumes that this parasitic power
does not contribute to heating the water. The minimum value for this field is 0.0, and the
default value is also 0.0 if the field is left blank.
Field: Sizing Factor
This optional numeric field allows the user to specify a sizing factor for this component. The
sizing factor is used when the component design inputs are autosized: the autosizing
9/29/14

634

Input-Output Reference

Group Plant Equipment

calculations are performed as usual and the results are multiplied by the sizing factor. For this
component the inputs that would be altered by the sizing factor are: Nominal Capacity and
Design Water Flow Rate. Sizing factor allows the user to size a component to meet part of
the design load while continuing to use the autosizing feature.
An example of this statement in an IDF is:
Boiler:HotWater,
Condensing Boiler,
NaturalGas,
25000,
EnteringBoiler
0.89,
CondensingBoilerEff,
75,
0.0021,
0.10,
1.00,
1.00,
Boiler Inlet Node,
Boiler Outlet Node,
80,
ConstantFlow,
25.0;

!!!!!!!!!!!!!!!!-

Curve:Biquadratic,
CondensingBoilerEff,
1.124970374,
0.014963852,
-0.02599835,
0.0,
-1.40464E-6,
-0.00153624,
0.1,
1.0,
30.0,
85.0;

Boiler Name
Fuel Type
Nominal Capacity {W}
Efficiency Curve Temperature Evaluation Variable
Nominal Thermal Efficiency
Boiler Efficiency Curve Name
Design Boiler Water Outlet Temp {C}
Max Design Boiler Water Flow Rate {m3/s}
Minimum Part Load Ratio
Maximum Part Load Ratio
Optimum Part Load Ratio
Boiler Water Inlet Node
Boiler Water Outlet Node
Temp Upper Limit Water Outlet {C}
Boiler Flow Mode
Parasitic Electric Load {W}
!!!!!!!!!!!-

Name
Coefficient1 Constant
Coefficient2 x
Coefficient3 x**2
Coefficient4 y
Coefficient5 y**2
Coefficient6 x*y
Minimum Value of x
Maximum Value of x
Minimum Value of y
Maximum Value of y

Boiler:HotWater Outputs
Outputs available from the boiler:
HVAC,Average,Boiler Heating Rate [W]
HVAC,Sum,Boiler Heating Energy [J]
Zone,Meter,Boilers:EnergyTransfer [J]
HVAC,Average,Boiler Inlet Temperature [C]
HVAC,Average,Boiler Outlet Temperature [C]
HVAC,Average,Boiler Mass Flow Rate [kg/s]
HVAC,Average,Boiler Parasitic Electric Power [W]
HVAC,Sum,Boiler Ancillary Electric Energy [J]
HVAC,Average,Boiler Part Load Ratio
One of the following blocks will be applicable based on fuel type:
HVAC,Average,Boiler Electric Power [W]
HVAC,Sum,Boiler Electric Energy [J]
HVAC,Average,Boiler Gas Rate [W]
HVAC,Sum,Boiler Gas Energy [J]
HVAC,Average,Boiler Propane Rate [W]
HVAC,Sum,Boiler Propane Energy [J]
9/29/14

635

Input-Output Reference

Group Plant Equipment

HVAC,Average,Boiler FuelOil#1 Rate [W]

HVAC,Sum,Boiler FuelOil#1 Energy [J]
HVAC,Average,Boiler FuelOil#2 Rate [W]
HVAC,Sum,Boiler FuelOil#2 Energy [J]
HVAC,Average,Boiler Coal Rate [W]
HVAC,Sum,Boiler Coal Energy [J]
HVAC,Average,Boiler Diesel Rate [W]
HVAC,Sum,Boiler Diesel Energy [J]
HVAC,Average,Boiler Gasoline Rate [W]
HVAC,Sum,Boiler Gasoline Energy [J]
HVAC,Average,Boiler OtherFuel1 Rate [W]
HVAC,Sum,Boiler OtherFuel1 Energy [J]
HVAC,Average,Boiler OtherFuel2 Rate [W]
HVAC,Sum,Boiler OtherFuel2 Energy [J]

Boiler Heating Rate [W]

Boiler Heating Energy [J]
These outputs are the heating output (load) of the boiler. Energy is metered on
Boilers:EnergyTransfer, EnergyTransfer:Plant, and EnergyTransfer:Facility.
Boiler Inlet Temperature [C]
Boiler Outlet Temperature [C]
Boiler Mass Flow Rate [kg/s]
These outputs are the hot water inlet and outlet temperatures and flow rate for the boiler.
Boiler Part Load Ratio []
This output is the operating part-load ratio of the boiler. The part-load ratio is calculated as
the boiler load divided by the boiler nominal capacity. The part-load ratio is limited by the
minimum and maximum part-load ratio inputs specified by the user.
Boiler <Fuel Type> Rate [W]
Boiler <Fuel Type> Energy [J] \
Boiler Electric Power [W]
These outputs are the energy input to the boiler. Valid fuel types are: Electric, Gas (natural
gas), Propane, FuelOil#1, FuelOil#2, Coal, Diesel, Gasoline, OtherFuel1, OtherFuel2.
Consumption is metered on Heating:<Fuel Type>, <Fuel Type>:Plant, and <Fuel
Type>:Facility.
Boiler Ancillary Electric Power [W]
Boiler Ancillary Electric Energy [J]
These outputs are the parasitic electric power and parasitic electric consumption associated
with the boiler. Used when simulating a forced draft fan or other electric component.
Consumption is metered on Heating:Electricity and Electricity:Plant.

9/29/14

636

Input-Output Reference

Group Plant Equipment

Boiler:Steam
The steam boiler model provides a first order approximation of performance for fuel oil, gas
and electric boilers. Boiler performance is based on a theoretical boiler efficiency (overall
efficiency at design operating conditions) and a single quadratic fuel use/ part load ratio
curve. This single curve accounts for all combustion inefficiencies and stack losses.
Field: Name
This alpha field contains the identifying name for the Steam Boiler.
Field: Fuel Type
This alpha value specifies the type of fuel used by the boiler. The fuel type can be
Electricity, NaturalGas, PropaneGas, FuelOil#1, FuelOil#2, Coal, Diesel, Gasoline,
OtherFuel1 or OtherFuel2.
Field: Maximum Operating Pressure
This numeric field contains the maximum value of pressure up to which the boiler would
operate, or the maximum design pressure. (Pascal)
Field: Theoretical Efficiency
This numeric field contains the heating efficiency (as a fraction between 0 and 1) of the
boilers burner
Field: Design Outlet Steam Temperature
The maximum value of steam temperature the boiler can provide. (Celcius)
Field: Nominal Capacity
This numeric field contains the nominal operating capacity (W) of the boiler.
Field: Minimum Part Load Ratio
This numeric field contains the minimum part load ratio. If the ratio of demand to boiler
nominal capacity is less than the minimum part load ratio, then the Min PLR will determine
the operating PLR. The expected range is between 0 and 1.
Field: Maximum Part Load Ratio
This numeric field contains the maximum part load ratio. If the ratio of demand to boiler
nominal capacity is greater than the maximum part load ratio, then the Max PLR will
determine the operating PLR. This value may exceed 1, but the normal range is between 0
and 1.1.
Field: Optimum Part Load Ratio
This numeric field contains the optimum part load ratio. This is the part load ratio at which the
boiler performs at its maximum efficiency.
Field: Coefficient 1 of Fuel Use Function of Part Load Ratio Curve
This numeric field contains the fuel use / PLR coefficient1.
Field: Coefficient 2 of Fuel Use Function of Part Load Ratio Curve
This numeric field contains the fuel use / PLR coefficient2.
Field: Coefficient 3 of Fuel Use Function of Part Load Ratio Curve
This numeric field contains the fuel use / PLR coefficient3.
Field: Water Inlet Node Name
This alpha field contains the water inlet node name.
9/29/14

637

Input-Output Reference

Group Plant Equipment

Field: Steam Outlet Node Name

This alpha field contains the steam outlet node name.
Field: Sizing Factor
This optional numeric field allows the user to specify a sizing factor for this component. The
sizing factor is used when the component design inputs are autosized: the autosizing
calculations are performed as usual and the results are multiplied by the sizing factor. For this
component the inputs that would be altered by the sizing factor are: Nominal Capacity. Sizing
factor allows the user to size a component to meet part of the design load while continuing to
use the autosizing feature.
More information on the technical aspects of steam boiler can be found in the Engineering
Reference Document.
An example of a Steam Boiler input statement from an IDF is:
Boiler:Steam,
Steam Boiler Plant
NaturalGas,
160000,
0.8,
115,
300000,
0.00001,
1.0,
0.2,
0.8,!- Coefficient
0.1,!- Coefficient
0.1,!- Coefficient
Steam Boiler Plant
Steam Boiler Plant

Boiler, !- Boiler Name

!- Fuel Type
!-Maximum Boiler Pressure Pascal
!- Theoretical Boiler Efficiency
!- Max Design Outlet Steam Temp
!- Nominal Capacity W
!- Minimum Part Load Ratio
!- Maximum Part Load Ratio
!- Optimum Part Load Ratio
1 of the fuel use/part load ratio curve
2 of the fuel use/part load ratio curve
3 of the fuel use/part load ratio curve
Boiler Inlet Node, !- Boiler Steam Inlet Node
Boiler Outlet Node; !- Plant Loop Outlet Node

Boiler:Steam,
Steam Boiler Plant
NaturalGas,
160000,
0.8,
115,
autosize,
0.00001,
1.0,
0.2,
0.8,!- Coefficient
0.1,!- Coefficient
0.1,!- Coefficient
Steam Boiler Plant
Steam Boiler Plant

Boiler, !- Boiler Name

!- Fuel Type
!-Maximum Boiler Pressure Pascal
!- Theoretical Boiler Efficiency
!- Max Design Outlet Steam Temp
!- Nominal Capacity W
!- Minimum Part Load Ratio
!- Maximum Part Load Ratio
!- Optimum Part Load Ratio
1 of the fuel use/part load ratio curve
2 of the fuel use/part load ratio curve
3 of the fuel use/part load ratio curve
Boiler Inlet Node, !- Boiler Steam Inlet Node
Boiler Outlet Node; !- Plant Loop Outlet Node

Steam Boiler Outputs

Outputs available from the steam boiler:
HVAC,Average,Boiler Heating Rate [W]
HVAC,Sum,Boiler Heating Energy [J]
Zone,Meter,Boilers:EnergyTransfer [J]
HVAC,Average,Boiler Steam Inlet Temperature [C]
HVAC,Average,Boiler Steam Outlet Temperature [C]
HVAC,Average,Boiler Mass Flow Rate [kg/s]
One of the following blocks will be applicable based on fuel type:
HVAC,Average,Boiler Electric Power [W]
9/29/14

638

Input-Output Reference

Group Plant Equipment

HVAC,Sum,Boiler Electric Energy [J]

HVAC,Average,Boiler Gas Rate [W]
HVAC,Sum,Boiler Gas Energy [J]
HVAC,Average,Boiler Propane Rate [W]
HVAC,Sum,Boiler Propane Energy [J]
HVAC,Average,Boiler FuelOil#1 Rate [W]
HVAC,Sum,Boiler FuelOil#1 Energy [J]
HVAC,Average,Boiler FuelOil#2 Rate [W]
HVAC,Sum,Boiler FuelOil#2 Energy [J]
HVAC,Average,Boiler Coal Rate [W]
HVAC,Sum,Boiler Coal Energy [J]
HVAC,Average,Boiler Diesel Rate [W]
HVAC,Sum,Boiler Diesel Energy [J]
HVAC,Average,Boiler Gasoline Rate [W]
HVAC,Sum,Boiler Gasoline Energy [J]
HVAC,Average,Boiler OtherFuel1 Rate [W]
HVAC,Sum,Boiler OtherFuel1 Energy [J]
HVAC,Average,Boiler OtherFuel2 Rate [W]
HVAC,Sum,Boiler OtherFuel2 Energy [J]

Boiler Heating Rate [W]

Boiler Heating Energy [J]
These outputs are the heating output (load) of the boiler. Energy is metered on
Boilers:EnergyTransfer, EnergyTransfer:Plant, and EnergyTransfer:Facility.
Boiler Steam Inlet Temperature [C]
Boiler Steam Outlet Temperature [C]
Boiler Steam Mass Flow Rate [kg/s]
These outputs are the steam inlet and outlet temperatures and steam flow rate for the boiler.
Boiler <Fuel Type> Rate [W]
Boiler <Fuel Type> Energy [J]
Boiler Electric Power [W]
Boiler Electric Energy [J]
These outputs are the energy input to the boiler. Valid fuel types are: Electric, Gas (natural
gas), Propane, FuelOil#1, FuelOil#2, Coal, Diesel, Gasoline, OtherFuel1, and OtherFuel2.
Consumption is metered on Heating:<Fuel Type>, <Fuel Type>:Plant, and <Fuel
Type>:Facility.
Water to Water Heat Pumps
The EnergyPlus has two water-to-water heat pump models, parameter estimation and
equation fit, to choose from:
HeatPump:WaterToWater:EquationFit:Cooling
HeatPump:WaterToWater:EquationFit:Heating
9/29/14

639

Input-Output Reference

Group Plant Equipment

This model is an equation-fit model from the catalog data which resembles a black box with
no usage of heat transfer equations. The performance of the heat pump is modeled using
curves fitted from the catalog data.
HeatPump:WaterToWater:ParameterEstimation:Cooling
HeatPump:WaterToWater:ParameterEstimation:Heating
This model is a parameter estimation based model that uses physical parameters generated
from the catalog data. The physical parameters are then used to predict the performance of
the heat pump using thermodynamic laws and heat transfer equations. The heat pump has a
reciprocating compressor that serves both the hot water and the chilled water loop. Note that
this model is currently hardwired to fluid property R22.
Descriptions and strength of each respective model is available in the following references:
Jin, Hui. 2002. Parameter Estimation Based Models of Water Source Heat Pumps. Phd.
Thesis, Department of Mechanical and Aerospace Engineering, Oklahoma State University.
(downloadable from http://www.hvac.okstate.edu/)
Tang,C. C. 2005. Modeling Packaged Heat Pumps in Quasi-Steady State Energy Simulation
Program. M.S. Thesis. Department of Mechanical and Aerospace Engineering, Oklahoma
State University. (downloadable from http://www.hvac.okstate.edu/)
The Supply side of the heat pump is usually connected to a Ground Heat Exchanger. The
figure below shows the layout and piping diagram of the water-to-water heat pump.

Grnd HX
Cond Supply
Side

U-tube

Cond
demand side
Heat
Pump
Plant
supply
Side

Plant
demand side
Zon
e

Figure 75. Schematic of EnergyPlus Ground Loop Heat Exchanger

First, the equation fit model objects are described. This model has two sets of coefficients,
one for the heating mode and other for the cooling mode.
HeatPump:WaterToWater:EquationFit:Cooling
Field: Name
This alpha field contains the identifying name for the ground source heat pump.
9/29/14

640

Input-Output Reference

Group Plant Equipment

Field: Source Side Inlet Node Name

This alpha field contains the heat pumps source side inlet node name.
Field: Source Side Outlet Node Name
This alpha field contains the heat pumps source side outlet node name.
Field: Load Side Inlet Node Name
This alpha field contains the heat pumps load side inlet node name.
Field: Load Side Outlet Node Name
This alpha field contains the heat pumps load side outlet node name.
Field: Rated Load Side Flow Rate
This numeric field contains the rated volumetric flow rate on the load side of the heat pump in
m3/s. This corresponds to the highest load side heat transfer rate listed in the catalog data.
Field: Rated Source Side Flow Rate
This numeric field contains the rated volumetric flow rate on the source side of the heat pump
in m3/s. This corresponds to the highest load side heat transfer rate listed in the catalog data.
Field: Rated Cooling Capacity
This numeric field contains the rated cooling capacity of the heat pump in W. This
corresponds to the highest load side heat transfer rate listed in the catalog data.
Field: Rated Cooling COP
This numeric field contains the rated cooling COP of the heat pump in W/W. The default
value is 4.0.
Fields: Cooling Capacity Coefficients
Five fields are used to describe the coefficients for the Cooling Capacity curve. More details
on how these coefficients are used are described in the Engineering Reference.
Field: Cooling Capacity Coefficient 1-5
These numeric fields contain the five coefficients for the heat pump capacity.
An idf example:
HeatPump:WaterToWater:EquationFit:Cooling,
GshpCLG,
!- Water to Water Heat Pump Name
GshpCLG SourceSide Inlet Node, !- Source Side Inlet Node
GshpCLG SourceSide Outlet Node, !- Source Side Outlet Node
GshpCLG LoadSide Inlet Node,
!- Load Side Inlet Node
GshpCLG LoadSide Outlet Node,
!- Load Side Outlet Node
1.89E-03,
!- Rated Load Side Flow Rate {m3/s}
1.89E-03,
!- Rated Source Side Flow Rate {m3/s}
39890.91,
!- Rated Cooling Capacity {W}
4.0,
!- Rated Cooling COP {W/W}
-1.52030596, !- Cooling Capacity Coefficient 1
3.46625667, !- Cooling Capacity Coefficient 2
-1.32267797, !- Cooling Capacity Coefficient 3
0.09395678, !- Cooling Capacity Coefficient 4
0.038975504; !- Cooling Capacity Coefficient 5

9/29/14

641

Input-Output Reference

Group Plant Equipment

Water to Water Heat Pump Equation Fit Outputs

This section describes the outputs available for the water to water heat pump, equation fit
model; both cooling and heating.
HVAC,Sum,Water to Water Heat Pump Electric Energy [J]
HVAC,Sum,Water to Water Heat Pump Load Side Heat Transfer Energy [J]
HVAC,Sum,Water to Water Heat Pump Source Side Heat Transfer Energy [J]
HVAC,Average,Water to Water Heat Pump Electric Power [W]
HVAC,Average,Water to Water Heat Pump Load Side Heat Transfer Rate [W]
HVAC,Average,Water to Water Heat Pump Source Side Heat Transfer Rate [W]
HVAC,Average,Water to Water Heat Pump Load Side Outlet Temperature [C]
HVAC,Average,Water to Water Heat Pump Load Side Inlet Temperature [C]
HVAC,Average,Water to Water Heat Pump Source Side Outlet Temperature [C]
HVAC,Average,Water to Water Heat Pump Source Side Inlet Temperature [C]
HVAC,Average,Water to Water Heat Pump Load Side Mass Flow Rate [kg/s]
HVAC,Average,Water to Water Heat Pump Source Side Mass Flow Rate [kg/s]

Water to Water Heat Pump Electric Energy [J]

This output variable represents the cumulative energy used by the compressor. The values
are calculated for each HVAC system time step being simulated, and the results are summed
across the reporting period.
Water to Water Heat Pump Load Side Heat Transfer Energy [J]
This output variable represents the cumulative heat transfer across the load side coil. The
values are calculated for each HVAC system time step being simulated, and the results are
summed across the reporting period.
Water to Water Heat Pump Source Side Heat Transfer Energy [J]
This output variable represents the cumulative heat transfer across the source side coil. The
values are calculated for each HVAC system time step being simulated, and the results are
summed across the reporting period.
Water to Water Heat Pump Electric Power [W]
This output variable represents the compressor power required to run the heat pump. The
values are calculated for each HVAC system time step being simulated, and the results are
averaged for the time step being reported.
Water to Water Heat Pump Load Side Heat Transfer Rate [W]
This output variable represents the heat transfer across the load side coil. The values are
calculated for each HVAC system time step being simulated, and the results are averaged for
the time step being reported.
Water to Water Heat Pump Source Side Heat Transfer Rate [W]
This output variable represents the heat transfer across the source side coil. The values are
calculated for each HVAC system time step being simulated, and the results are averaged for
the time step being reported.
Water to Water Heat Pump Load Side Outlet Temperature [C]
This output variable represents the average fluid temperature leaving the load side coil. The
values are calculated for each HVAC system time step being simulated, and the results are
averaged for the time step being reported.

9/29/14

642

Input-Output Reference

Group Plant Equipment

Water to Water Heat Pump Load Side Inlet Temperature [C]

This output variable represents the average fluid temperature entering the load side coil. The
values are calculated for each HVAC system time step being simulated, and the results are
averaged for the time step being reported.
Water to Water Heat Pump Source Side Outlet Temperature [C]
This output variable represents the average fluid temperature leaving the source side coil.
The values are calculated for each HVAC system time step being simulated, and the results
are averaged for the time step being reported.
Water to Water Heat Pump Source Side Inlet Temperature [C]
This output variable represents the average fluid temperature entering the source side coil.
The values are calculated for each HVAC system time step being simulated, and the results
are averaged for the time step being reported.
Water to Water Heat Pump Load Side Mass Flow Rate [kg/s]
This output variable represents the average fluid flow rate through the load side coil. The
values are calculated for each HVAC system time step being simulated, and the results are
averaged for the time step being reported.
Water to Water Heat Pump Source Side Mass Flow Rate [kg/s]
This output variable represents the average fluid flow rate through the source side coil. The
values are calculated for each HVAC system time step being simulated, and the results are
averaged for the time step being reported.
HeatPump:WaterToWater:EquationFit:Heating
Field: Name
This alpha field contains the identifying name for the ground source heat pump.
Field: Source Side Inlet Node Name
This alpha field contains the heat pumps source side inlet node name.
Field: Source Side Outlet Node Name
This alpha field contains the heat pumps source side outlet node name.
Field: Load Side Inlet Node Name
This alpha field contains the heat pumps load side inlet node name.
Field: Load Side Outlet Node Name
This alpha field contains the heat pumps load side outlet node name.
Field: Rated Load Side Flow Rate
This numeric field contains the rated volumetric flow rate on the load side of the heat pump in
m3/s. This corresponds to the highest load side heat transfer rate listed in the catalog data.
Field: Rated Source Side Flow Rate
This numeric field contains the rated volumetric flow rate on the source side of the heat pump
in m3/s. This corresponds to the highest load side heat transfer rate listed in the catalog data.
Field: Rated Heating Capacity
This numeric field contains the rated heating capacity of the heat pump in W. This
corresponds to the highest load side heat transfer rate listed in the catalog data.

9/29/14

643

Input-Output Reference

Group Plant Equipment

Field: Rated Heating COP

This numeric field contains the rated heating COP of the heat pump in W/W. The default
value is 4.0.
Fields: Heating Capacity Coefficients
Five fields are used to describe the coefficients for the Heating Capacity curve. More details
on how these coefficients are used are described in the Engineering Reference.
Field: Heating Capacity Coefficient 1-5
These numeric fields contain the five coefficients for the heat pump capacity.
An idf example:
HeatPump:WaterToWater:EquationFit:Heating,
GshpHeating, !- Water to Water Heat Pump Name
GshpHeating SourceSide Inlet Node, !- Source Side Inlet Node
GshpHeating SourceSide Outlet Node, !- Source Side Outlet Node
GshpHeating LoadSide Inlet Node,
!- Load Side Inlet Node
GshpHeating LoadSide Outlet Node,
!- Load Side Outlet Node
1.89E-03,
!- Rated Load Side Flow Rate {m3/s}
1.89E-03,
!- Rated Source Side Flow Rate {m3/s}
39040.92,
!- Rated Heating Capacity {W}
4.0,
!- Rated Heating COP {W/W}
-3.33491153, !- Heating Capacity Coefficient 1
-0.51451946, !- Heating Capacity Coefficient 2
4.51592706, !- Heating Capacity Coefficient 3
0.01797107, !- Heating Capacity Coefficient 4
0.155797661; !- Heating Capacity Coefficient 5

Next, the parameter estimation model objects are described. This model has two sets of
parameters, one for the heating mode and other for the cooling mode.
HeatPump:WaterToWater:ParameterEstimation:Cooling
Field: Name
This alpha field contains the identifying name for the ground source heat pump.
Field: Source Side Inlet Node Name
This alpha field contains the heat pumps source side inlet node name.
Field: Source Side Outlet Node Name
This alpha field contains the heat pumps source side outlet node name.
Field: Load Side Inlet Node Name
This alpha field contains the heat pumps load side inlet node name.
Field: Load Side Outlet Node Name
This alpha field contains the heat pumps load side outlet node name.
Field: Nominal COP
This numeric field contains the nominal coefficient of performance of the heat pump.
Field: Nominal Capacity
This numeric field contains the nominal capacity of the heat pump in Watts.

9/29/14

644

Input-Output Reference

Group Plant Equipment

Field: Minimum Part Load Ratio

This numeric field contains the minimum part load ratio of the heat pump usually set to 0.
Field: Maximum Part Load Ratio
This numeric field contains the maximum part load ratio of the heat pump usually set to 1.
Field: Optimum Part Load Ratio
This numeric field contains the optimal part load ratio of the heat pump usually set to 1.
Field: Load Side Flow Rate
This numeric field contains the volumetric flow rate on the load side of the heat pump in m3/s
Field: Source Side Flow Rate
This numeric field contains the volumetric flow rate on the source side of the heat pump in
m3/s
Field: Load Side Heat Transfer Coefficient
This numeric field contains Estimated parameter load side heat transfer coefficient W/K.
Field: Source Side Heat Transfer Coefficient
This numeric field contains Estimated parameter source side heat transfer coefficient W/K.
Field: Piston Displacement
This numeric field contains the Estimated parameter displacement of the reciprocating
compressor in m3/s.
Field: Compressor Clearance Factor
This numeric field contains the Estimated parameter clearance factor of the reciprocating
compressor.
Field: Compressor Suction and Discharge Pressure Drop
This numeric field contains the estimated parameter the pressure drop at compressor suction
and discharge in Pascals (N/m2).
Field: Superheating
This numeric field contains the estimated parameter superheat at the evaporator outlet in C.
Field: Constant Part of Electromechanical Power Losses
This numeric field contains the estimated parameter power loss, which accounts for the loss
of work due mechanical and electrical losses in the compressor in Watts.
Field: Loss Factor
This numeric field contains the factor of electromechanical loss that is proportional to the
theoretical power percentage.
Field: High Pressure Cut Off
This numeric field contains the design pressure limit of the compressor in Pascals (N/m2).
Field: Low Pressure Cut Off
This numeric field contains the design low-pressure limit of the compressor in Pascals
(N/m2).
An idf example:

9/29/14

645

Input-Output Reference

Group Plant Equipment

HeatPump:WaterToWater:ParameterEstimation:Cooling,
GshpCLG,
!- Water to Water Heat Pump Name
GshpCLG SourceSide Inlet Node, !- Source Side Inlet Node
GshpCLG SourceSide Outlet Node, !- Source Side Outlet Node
GshpCLG LoadSide Inlet Node, !- Load Side Inlet Node
GshpCLG LoadSide Outlet Node, !- Load Side Outlet Node
3.5,
!- Nominal COP
45000,
!- Nominal Capacity {W}
0.0,
!- Min PLR
1,
!- Max PLR
1,
!- optimum PLR
.003,
!- Load side Flow Rate {m3/s}
.003,
!- Source Side Flow Rate {m3/s}
7761,
!- Load side Heat Transfer Coefficient {W/K}
3998,
!- Source Side Heat Transfer Coefficient {W/K}
.012544,
!- Piston Displacement {m3/s}
.05469,
!- Compressor Clearance Factor %
92156.2,
!- Compressor Suction And Discharge Pressure Drop {Pa}
4.8907,
!- Superheating {C}
2803.9,
!- Constant Part of Electro Mechanical Power Losses {W}
.699,
!- Loss Factor
0.0,
!- High Pressure Cut off {Pa}
0.0;
!- LowPressure Cut off {Pa}

HeatPump:WaterToWater:ParameterEstimation:Heating
Field: Name
This alpha field contains the identifying name for the ground source heat pump.
Field: Source Side Inlet Node Name
This alpha field contains the heat pumps source side inlet node name.
Field: Source Side Outlet Node Name
This alpha field contains the heat pumps source side outlet node name.
Field: Load Side Inlet Node Name
This alpha field contains the heat pumps load side inlet node name.
Field: Load Side Outlet Node Name
This alpha field contains the heat pumps load side outlet node name.
Field: Nominal COP
This numeric field contains the nominal coefficient of performance of the heat pump.
Field: Nominal Capacity
This numeric field contains the nominal capacity of the heat pump in Watts.
Field: Minimum Part Load Ratio
This numeric field contains the minimum part load ratio of the heat pump usually set to 0.
Field: Maximum Part Load Ratio
This numeric field contains the maximum part load ratio of the heat pump usually set to 1.
Field: Optimum Part Load Ratio
This numeric field contains the optimal part load ratio of the heat pump usually set to 1.
Field: Load Side Flow Rate
This numeric field contains the volumetric flow rate on the load side of the heat pump in m3/s

9/29/14

646

Input-Output Reference

Group Plant Equipment

Field: Source Side Flow Rate

This numeric field contains the volumetric flow rate on the source side of the heat pump in
m3/s
Field: Load Side Heat Transfer Coefficient
This numeric field contains Estimated parameter load side heat transfer coefficient W/K.
Field: Source Side Heat Transfer Coefficient
This numeric field contains Estimated parameter source side heat transfer coefficient W/K.
Field: Piston Displacement
This numeric field contains the Estimated parameter displacement of the reciprocating
compressor in m3/s.
Field: Compressor Clearance Factor
This numeric field contains the Estimated parameter clearance factor of the reciprocating
compressor.
Field: Compressor Suction and Discharge Pressure Drop
This numeric field contains the estimated parameter the pressure drop at compressor suction
and discharge in Pascals (N/m2).
Field: Superheating
This numeric field contains the estimated parameter superheat at the evaporator outlet in C.
Field: Constant Part of Electromechanical Power Losses
This numeric field contains the estimated parameter power loss, which accounts for the loss
of work due mechanical and electrical losses in the compressor in Watts.
Field: Loss Factor
This numeric field contains the factor of electromechanical loss that is proportional to the
theoretical power percentage.
Field: High Pressure Cut Off
This numeric field contains the design pressure limit of the compressor in Pascals (N/m2).
Field: Low Pressure Cut Off
This numeric field contains the design low-pressure limit of the compressor in Pascals
(N/m2).
An idf example:

9/29/14

647

Input-Output Reference

Group Plant Equipment

HeatPump:WaterToWater:ParameterEstimation:Heating,
GshpHeating,
!- Water to Water Heat Pump Name
GshpHeating SourceSide Inlet Node, !- Source Side Inlet Node
GshpHeating SourceSide Outlet Node, !- Source Side Outlet Node
GshpHeating LoadSide Inlet Node, !- Load Side Inlet Node
GshpHeating LoadSide Outlet Node, !- Load Side Outlet Node
3.5,
!- Nominal COP
50000,
!- Nominal Capacity {W}
0.0,
!- Min PLR
1,
!- Max PLR
1,
!- optimum PLR
.003,
!- Load side Flow Rate {m3/s}
.003,
!- Source Side Flow Rate {m3/s}
7761,
!- Load side Heat Transfer Coefficient {W/K}
3998,
!- Source Side Heat Transfer Coefficient {W/K}
.012544,
!- Piston Displacement {m3/s}
.05469,
!- Compressor Clearance Factor %
92156.2,
!- Compressor Suction And Dischrage Pressure Drop {Pa}
4.8907,
!- Superheating {C}
2803.9,
!- Constant Part Of Electro Mechanical Power Losses {W}
.699,
!- Loss Factor
0.0,
!- High Pressure Cut off {Pa}
0.0;
!- LowPressure Cut off {Pa}

Since the heat pump is defined with two separate objects (one for heating, one for cooling),
the connections to the condenser has to be done carefully. The example below shows the
configuration for parameter estimation objects. The same specifications and configuration
also applies to the equation fit model.
Steps to specify the Ground Source Heat Pump
For the heating mode:
1) Specify a branch for the Heat pump in hot water loop .
2) Include the branch name in the splitter and mixer branches.
3) Add a branch in condenser loop and include its name in the respective splitter and mixer.
! in hot water loop
BRANCH, Heating GshpHeating Branch,
,
,
HeatPump:WatertoWater:ParameterEstimatinon:Heating,
GshpHeating,
GshpHeating LoadSide Inlet Node,
GshpHeating LoadSide Outlet Node,
ACTIVE;
!in condenser loop
BRANCH, GshpHeating SourceSide Branch,
,
,
HeatPump:WatertoWater:ParameterEstimatinon:Heating,
GshpHeating,
GshpHeating SourceSide Inlet Node,
GshpHeating SourceSide Outlet Node,
ACTIVE;

Example of Heat Pump Links

For the cooling mode:
1) Specify a branch for the Heat pump in chilled water loop .
2) Include the branch name in the splitter and mixer branches.
3) Add a branch in condenser loop and include its name in the respective splitter and mixer.
9/29/14

648

Input-Output Reference

Group Plant Equipment

! in chilled water loop

BRANCH,GshpCLG1 Chiller Branch,
,
,
HeatPump:WatertoWater:ParameterEstimatinon:Cooling, GshpCLG1,
GshpCLG LoadSide Inlet Node1,
GshpCLG LoadSide Outlet Node1,
Active;
!in condenser loop
BRANCH, GshpCLG1 Condenser Branch,
,
,
HeatPump:WatertoWater:ParameterEstimatinon:Cooling, GshpCLG1,
GshpCLG SourceSide Inlet Node1,
GshpCLG SourceSide Outlet Node1,
ACTIVE;

Water to Water Heat Pump Parameter Estimation Outputs

This section describes the outputs available for the water to water heat pump, parameter
estimation model; both cooling and heating.
HVAC,Average,Water to Water Heat Pump Electric Power [W]
HVAC,Average,Water to Water Heat Pump Electric Power [W]
HVAC,Sum,Water to Water Heat Pump Electric Energy [J]
HVAC,Sum,Water to Water Heat Pump Electric Energy [J]
HVAC,Average,Water to Water Heat Pump Load Side Heat Transfer Rate [W]
HVAC,Average,Water to Water Heat Pump Load Side Heat Transfer Rate [W]
HVAC,Sum,Water to Water Heat Pump Load Side Heat Transfer Energy [J]
HVAC,Sum,Water to Water Heat Pump Load Side Heat Transfer Energy [J]
HVAC,Average,Water to Water Heat Pump Source Side Heat Transfer Rate [W]
HVAC,Average,Water to Water Heat Pump Source Side Heat Transfer Rate [W]
HVAC,Sum,Water to Water Heat Pump Source Side Heat Transfer Energy [J]
HVAC,Sum,Water to Water Heat Pump Source Side Heat Transfer Energy [J]
HVAC,Average,Water to Water Heat Pump Load Side Outlet Temperature [C]
HVAC,Average,Water to Water Heat Pump Load Side Outlet Temperature [C]
HVAC,Average,Water to Water Heat Pump Load Side Inlet Temperature [C]
HVAC,Average,Water to Water Heat Pump Load Side Inlet Temperature [C]
HVAC,Average,Water to Water Heat Pump Source Side Outlet Temperature [C]
HVAC,Average,Water to Water Heat Pump Source Side Outlet Temperature [C]
HVAC,Average,Water to Water Heat Pump Source Side Inlet Temperature [C]
HVAC,Average,Water to Water Heat Pump Source Side Inlet Temperature [C]
HVAC,Average,Water to Water Heat Pump Load Side Mass Flow Rate [kg/s]
HVAC,Average,Water to Water Heat Pump Load Side Mass Flow Rate [kg/s]
HVAC,Average,Water to Water Heat Pump Source Side Mass Flow Rate [kg/s]
HVAC,Average,Water to Water Heat Pump Source Side Mass Flow Rate [kg/s]

Water to Water Heat Pump Electric Power [W]

Water to Water Heat Pump Electric Power [W]
This output variable represents the compressor power required to run the heat pump. The
values are calculated for each HVAC system time step being simulated, and the results are
averaged for the time step being reported.
Water to Water Heat Pump Electric Energy [J]
Water to Water Heat Pump Electric Energy [J]
This output variable represents the cumulative energy used by the compressor. The values
are calculated for each HVAC system time step being simulated, and the results are summed
across the reporting period.

9/29/14

649

Input-Output Reference

Group Plant Equipment

Water to Water Heat Pump Load Side Heat Transfer Rate [W]
Water to Water Heat Pump Load Side Heat Transfer Rate [W]
This output variable represents the heat transfer across the load side coil. The values are
calculated for each HVAC system time step being simulated, and the results are averaged for
the time step being reported.
Water to Water Heat Pump Load Side Heat Transfer Energy [J]
Water to Water Heat Pump Load Side Heat Transfer Energy [J]
This output variable represents the cumulative heat transfer across the load side coil. The
values are calculated for each HVAC system time step being simulated, and the results are
summed across the reporting period.
Water to Water Heat Pump Source Side Heat Transfer Rate [W]
Water to Water Heat Pump Source Side Heat Transfer Rate [W]
This output variable represents the heat transfer across the source side coil. The values are
calculated for each HVAC system time step being simulated, and the results are averaged for
the time step being reported.
Water to Water Heat Pump Source Side Heat Transfer Energy [J]
Water to Water Heat Pump Source Side Heat Transfer Energy [J]
This output variable represents the cumulative heat transfer across the source side coil. The
values are calculated for each HVAC system time step being simulated, and the results are
summed across the reporting period.
Water to Water Heat Pump Load Side Outlet Temperature [C]
Water to Water Heat Pump Load Side Outlet Temperature [C]
This output variable represents the average fluid temperature leaving the load side coil. The
values are calculated for each HVAC system time step being simulated, and the results are
averaged for the time step being reported.
Water to Water Heat Pump Load Side Inlet Temperature [C]
Water to Water Heat Pump Load Side Inlet Temperature [C]
This output variable represents the average fluid temperature entering the load side coil. The
values are calculated for each HVAC system time step being simulated, and the results are
averaged for the time step being reported.
Water to Water Heat Pump Source Side Outlet Temperature [C]
Water to Water Heat Pump Source Side Outlet Temperature C]
This output variable represents the average fluid temperature leaving the source side coil.
The values are calculated for each HVAC system time step being simulated, and the results
are averaged for the time step being reported.
Water to Water Heat Pump Source Side Inlet Temperature [C]
Water to Water Heat Pump Source Side Inlet Temperature [C]
This output variable represents the average fluid temperature entering the source side coil.
The values are calculated for each HVAC system time step being simulated, and the results
are averaged for the time step being reported.

9/29/14

650

Input-Output Reference

Group Plant Equipment

Water to Water Heat Pump Load Side Mass Flow Rate [kg/s]
Water to Water Heat Pump Load Side Mass Flow Rate [kg/s]
This output variable represents the average fluid flow rate through the load side coil. The
values are calculated for each HVAC system time step being simulated, and the results are
averaged for the time step being reported.
Water to Water Heat Pump Source Side Mass Flow Rate [kg/s]
Water to Water Heat Pump Source Side Mass Flow Rate [kg/s]
This output variable represents the average fluid flow rate through the source side coil. The
values are calculated for each HVAC system time step being simulated, and the results are
averaged for the time step being reported.
DistrictCooling
When the user is not interested in a plant simulation or there is some centralized source of
chilled water, the following object can be used in the input.
Field: Name
This alpha field contains the identifying name for the district cooling (i.e., purchased chilled
water).
Field: Chilled Water Inlet Node Name
This alpha field contains the identifying name for the district cooling inlet node.
Field: Chilled Water Outlet Node Name
This alpha field contains the identifying name for the district cooling outlet node.
Field: Nominal Capacity
This numeric field contains the nominal demand (W) that the district cooling will meet. This
field is autosizable.
Field: Capacity Fraction Schedule Name
This alpha field contains the name of a schedule that describes how the nominal capacity
varies over time. Values must non-negative. The capacity at a given point in time is
determined by the product of the previous field and the value in this schedule. If the field is
omitted or left blank, then the program assumes a schedule value of 1.0 all the time.
An example of this statement in an IDF is:
DistrictCooling, Purchased Cooling,
NODE_35,NODE_49,
68000;

DistrictCooling Outputs
HVAC,Average, District Cooling Chilled Water Rate [W]
HVAC,Sum, District Cooling Chilled Water Energy [J]
Zone,Meter, DistrictCooling:Plant [J]
Zone,Meter,Cooling: DistrictCooling [J]
HVAC,Average,District Cooling Rate [W]
HVAC,Average,District Cooling Inlet Temperature [C]
HVAC,Average,District Cooling Outlet Temperature [C]
HVAC,Average,District Cooling Mass Flow Rate [kg/s]

9/29/14

651

Input-Output Reference

Group Plant Equipment

District Cooling Chilled Water Rate [W]

District Cooling Chilled Water Energy [J]
These outputs are the energy taken from purchased chilled water. Consumption is metered
on Cooling:DistrictCooling, DistrictCooling:Plant, and DistrictCooling:Facility.
District Cooling Rate [W]
This is the useful rate of cooling energy from purchased chilled water. For the current
algorithm, this is the same as District Cooling Chilled Water Rate.
District Cooling Inlet Temperature [C]
District Cooling Outlet Temperature [C]
District Cooling Mass Flow Rate [kg/s]
These outputs are the supply-side plant loop chilled water inlet and outlet temperatures and
mass flow rate.
DistrictHeating
When the user is not interested in a plant simulation or there is some centralized source of
hot water (district heating), the following object can be used in the input.
Field: Name
This alpha field contains the identifying name for the district heating (i.e., purchased hot
water).
Field: Hot Water Inlet Node Name
This alpha field contains the identifying name for the district heating inlet node.
Field: Hot Water Outlet Node Name
This alpha field contains the identifying name for the district heating outlet node.
Field: Nominal Capacity
This numeric field contains the nominal demand (W) that the district heating will meet. This
field is autosizable.
Field: Capacity Fraction Schedule Name
This alpha field contains the name of a schedule that describes how the nominal capacity
varies over time. Values must non-negative. The capacity at a given point in time is
determined by the product of the previous field and the value in this schedule. If the field is
omitted or left blank, then the program assumes a schedule value of 1.0 all the time.
An example of this statement in an IDF is:
DistrictHeating,Purchased Heating,
NODE_30,NODE_29,
1000000;

DistrictHeating Outputs
HVAC,Average,District Heating Hot Water Rate [W]
HVAC,Sum,District Heating Hot Water Energy [J]
Zone,Meter,DistrictHeating:Plant [J]
Zone,Meter,Heating:DistrictHeating [J]
HVAC,Average,District Heating Rate [W]
HVAC,Average,District Heating Inlet Temperature [C]
HVAC,Average,District Heating Outlet Temperature [C]
9/29/14

652

Input-Output Reference

Group Plant Equipment

HVAC,Average,District Heating Mass Flow Rate [kg/s]

District Heating Hot Water Rate [W]

District Heating Hot Water Energy [J]
These outputs are the energy taken from purchased hot water. Consumption is metered on
Heating:DistrictHeating, DistrictHeating:Plant, and DistrictHeating:Facility.
District Heating Rate [W]
This is the useful rate of heating energy from purchased hot water. For the current algorithm,
this is the same as District Heating Hot Water Rate.
District Heating Inlet Temperature [C]
District Heating Outlet Temperature [C]
District Heating Mass Flow Rate [kg/s]
These outputs are the supply-side plant loop hot water inlet and outlet temperatures and
mass flow rate.
PlantComponent:TemperatureSource
This object allows the simulation of a water (or other fluid) source at a user-specified
temperature. This could include a river, well, or seawater source, or any other configuration
where the fluid temperature being supplied by the component to the plant is known. The
temperature may be a constant or scheduled. Of course, the scheduled value may also be
overwritten via EMS in cases where the specified temperature should be calculated at runtime.
Field: Name
This field is the string identifier for this component.
Field: Inlet Node
This is the name of this components inlet node for the plant connection.
Field: Outlet Node
This is the name of this components outlet node for the plant connection. The source
temperature is applied to this node when the component is active.
Field: Design Volume Flow Rate
This numeric field contains the design value for component volume flow rate in m3/s. This
field may be autosized.
Field: Temperature Specification Type
This string field specifies the behavior of the source temperature. Two inputs are allowed:
Constant or Scheduled. For a constant condition, a single input value (the next field) is used
as the returning temperature (component outlet temperature) throughout the entire
simulation. For a scheduled condition, the name of a schedule (the following field) is used to
allow the temperature to vary throughout the simulation. This schedule value may be
actuated via EMS to allow further flexibility on temperature specification at run-time.
Field: Source Temperature
If the Temperature Specification Type field is Constant, then the value in this field is used as
the source temperature (in C) throughout the entire simulation.

9/29/14

653

Input-Output Reference

Group Plant Equipment

Field: Source Temperature Schedule Name

If the Temperature Specification Type field is Scheduled, then this is the name of a schedule
entered in the IDF which specifies the dynamic temperature of this source object. The units of
this schedule should be C.
And, as shown in an IDF:
PlantComponent:TemperatureSource,
FluidSource,
!- Name
FluidSource Inlet Node, !- Inlet Node
FluidSource Outlet Node, !- Outlet Node
Autosize,
!- Design Volume Flow Rate {m3/s}
Constant,
!- Temperature Specification Type
62,
!- Source Temperature {C}
;
!- Source Temperature Schedule Name

PlantComponent:TemperatureSource Outputs
The following output variables are available for the temperature source plant components:
HVAC,Average,Plant Temperature Source Component Mass Flow Rate [kg/s]
HVAC,Average,Plant Temperature Source Component Inlet Temperature [C]
HVAC,Average,Plant Temperature Source Component Outlet Temperature [C]
HVAC,Average,Plant Temperature Source Component Source Temperature [C]
HVAC,Average,Plant Temperature Source Component Heat Transfer Rate [W]
HVAC,Sum,Plant Temperature Source Component Heat Transfer Energy [J]

Plant Temperature Source Component Mass Flow Rate [kg/s]

The current mass flow rate of this component.
Plant Temperature Source Component Inlet Temperature [C]
The current entering fluid temperature of this component.
Plant Temperature Source Component Outlet Temperature [C]
The current outlet temperature of this component.
Plant Temperature Source Component Source Temperature [C]
The current source temperature of this component.
Plant Temperature Source Component Heat Transfer Rate [W]
The current heat transfer rate of this component, positive for outlet temperature > inlet
temperature, or adding heat to the loop, or absorbing heat from the source.
Plant Temperature Source Component Heat Transfer Energy [J]
The current heat transfer energy over the given reporting period of this component.
CentralHeatPumpSystem
This is a central geothermal application that contains one or more chiller-heaters centrally
located in the building; the available chilled and/or hot water is then piped to the individual
zones. Chiller-heaters used for this particular system can be of two types: 1) standard vaporcompression, non-reversible cycle chillers designed for heat recovery or 2) reversible-cycle,
water-to-water heat pump chillers. Unlike a distributed ground source heat pump
configuration where individual heat pumps are located in each zone, a centralized geothermal
configuration has one or more chiller-heaters. Its function is to encapsulate the extra controls
needed to turn individual chiller-heater modules on/off and whether they are to operate in
cooling-only, heating-only or simultaneous cooling-heating mode and whether to connect the
source water to the evaporator or condenser side. A variety of control schemes can be
designed by setting schedules for both zone control types and individual chiller-heaters
schedules.
9/29/14

654

Input-Output Reference

Group Plant Equipment

The fluid used in this central system is usually water, and there is no sharing of condenser or
evaporator water between multiple machines. However, the control logic is such that the
source water can be delivered to individual chiller-heaters depending on their operating
mode, e.g., modules in simultaneous cooling-heating mode receive no source water, modules
in heating-only mode can have source water directed to their evaporator, or modules in
cooling-only mode can have source water directed to their condenser; the decision on which
module(s) receives the source water dictated by the smart controls. The following figures
illustrate node interconnections between this central geothermal application and plant and
condenser loops in various situations.
The order of the multiple chiller-heaters operation is assumed to be sequential. In other
words, the very first chiller-heater will be called at first to see if it meets all loads that the
central heat pump system should meet. If the chiller-heater meets all loads, the rest chillerheaters are assumed to be turned off. If not, the following chiller-heater will be called to meet
the remaining loads until all loads are met in the order as defined in the set of individual
chiller-heater objects below. The order of individual chiller-heater modules needs to be
carefully arranged in case users are intended to see the performance of various combinations
of different sizes of chiller-heaters in a central heat pump system.

Figure 76. Diagram of a central heat pump system with three chiller-heaters in cooling-only mode
(Condensers reject heat to the ground source loop)

9/29/14

655

Input-Output Reference

Group Plant Equipment

Figure 77. Diagram of a central heat pump system with three chiller-heaters in heat recovery mode
(No heat is exchanged with the ground source loop)

Figure 78. Diagram of a central heat pump system with one chiller-heater in heat recovery mode and two
chiller-heaters in cooling-only mode
In the above example, the cooling load needs 3 chiller-heaters and the heating load needs 1
chiller heater. Chiller 1 is in heat recovery mode and isolated from the ground source loop
while chillers 2 and 3 are in cooling-only mode, their condensers rejecting heat to the ground
source loop.

9/29/14

656

Input-Output Reference

Group Plant Equipment

Figure 79. Diagram of a central heat pump system with two chiller-heaters in heat recovery mode and one
chiller-heater in heating-only mode
In the above example, the heating load needs 3 chiller-heaters and the cooling load needs
two chiller-heaters. Chillers 1 and 2 are in heat recovery mode and isolated from the ground
source loop while chiller 3 is in heating-only mode, its evaporator extracting heat from the
ground source loop.
Users are required to define three different nodes such as chilled water, hot water, and
source water nodes. Only this central heat pump system will be metered, and individual
chiller-heaters energy will be available for reporting only, but not metered.
Field: Name
This alpha field contains the identifying name of the central heat pump system.
Field: Control Method
This field must contain a keyword defines how the central heat pump system controls the
interaction between the chiller-heater modules and the water loops to meet the cooling and
heating demands. Currently, the only available option is SmartMixing.
Field: Cooling Loop Inlet Node Name
This alpha field contains the identifying name of the chilled water inlet node.
Field: Cooling Loop Outlet Node Name
This alpha field contains the identifying name of the chilled water outlet node.
Field: Source Loop Inlet Node Name
This alpha field contains the identifying name of the source water inlet node.
Field: Source Loop Outlet Node Name
This alpha field contains the identifying name of the source water outlet node.
Field: Heating Loop Inlet Node Name
This alpha field contains the identifying name of the hot water inlet node.

9/29/14

657

Input-Output Reference

Group Plant Equipment

Field: Heating Loop Outlet Node Name

This alpha field contains the identifying name of the hot water outlet node.
Field: Ancillary Power
This numeric field contains the ancillary power of the central heat pump system in watts.
Field: Ancillary Operation Schedule Name
This alpha field contains the identifying name of the ancillary power schedule.
Field Set: Individual Chiller-Heater Module Objects
The following four items are repeated up to a maximum of 20 individual chiller-heater
modulesets. At least one module set must appear in an input file. In other words, a central
heat pump system must include at least one chiller-heater module component. A set of the
following four fields helps to define the specific type of a chiller-heater module, its operation
control, and the number of identical chiller-heater module objects.
Field: Chiller Heater Module Performance Component Object Type <x>
This alpha field describes the type of the chiller-heater comprising this module set. Only the
chiller-heater type ChillerHeaterPerformance:EIectric:EIR is currently available. Note that up
to 20 sets of chiller-heater module name, schedule, and number of identical chiller-heater
may be entered for a single central heat pump system.
Field: Chiller Heater Module Performance Component Name <x>
This alpha field is paired with the preceding chiller-heater module type to define the name of
the module.
Field: Chiller Heater Module Control Schedule Name <x>
This alpha field is paired with the preceding chiller-heater module type and name to define its
on/off control. This schedule will be used for all identical module components as defined in
the next field. Currently, this schedule only controls the module sets availability, i.e.,
schedule values equal to 1 indicate that the chiller-heater set is available while schedule
values equal to 0 indicate that the chiller-heater set is off.
Field: Number of Chiller Heater Modules <x>
This numeric field is paired with the preceding three fields to define how many identical
chiller-heaters define this module set.
An example of this statement in an IDF is:
CentralHeatPumpSystem,
ChillerBank,
!- Name
SmartMixing,
!- Control Method
Chiller Inlet Node,
!- Cooling Loop Inlet Node Name
Chiller Outlet Node,
!- Cooling Loop Outlet Node Name
Condenser Inlet Node,
!- Source Loop Inlet Node Name
Condenser Outlet Node,
!- Source Loop Outlet Node Name
HWInlet,
!- Heating Loop Inlet Node Name
HWOutlet,
!- Heating Loop Outlet Node Name
460,
!- Ancillary Power {W}
,
!- Ancillary Operation Schedule Name
ChillerHeaterPerformance:Electric:EIR, !- Chiller Heater Modules Object
ChillerHeaterModule 1,
!- Chiller Heater Modules Performance Component
ON,
!- Chiller Heater Modules Control Schedule Name
2,
!- Number of Chiller Heater Modules 1
ChillerHeaterPerformance:Electric:EIR, !- Chiller Heater Modules Object
ChillerHeaterModule 2,
!- Chiller Heater Modules Performance Component
ON,
!- Chiller Heater Modules Control Schedule Name
2;
!- Number of Chiller Heater Modules 2

9/29/14

Type 1
Name 1
1
Type 2
Name 2
2

658

Input-Output Reference

Group Plant Equipment

Central Heat Pump System Outputs

HVAC,Average,Chiller Heater System Cooling Electric Power [W]
HVAC,Sum,Chiller Heater System Cooling Electric Energy[J]
HVAC,Average,Chiller Heater System Heating Electric Power [W]
HVAC,Sum,Chiller Heater System Heating Electric Energy[J]
HVAC,Average,Chiller Heater System Cooling Rate [W]
HVAC,Sum,Chiller Heater System Cooling Energy[J]
HVAC,Average,Chiller Heater System Heating Rate [W]
HVAC,Sum,Chiller Heater System Heating Energy[J]
HVAC,Average,Chiller Heater System Source Heat Transfer Rate [W]
HVAC,Sum,Chiller Heater System Source Heat Transfer Energy[J]
HVAC,Average,Chiller Heater System Cooling Inlet Temperature [C]
HVAC,Average,Chiller Heater System Cooling Outlet Temperature [C]
HVAC,Average,Chiller Heater System Cooling Mass Flow Rate [kg/s]
HVAC,Average,Chiller Heater System Heating Inlet Temperature [C]
HVAC,Average,Chiller Heater System Heating Outlet Temperature [C]
HVAC,Average,Chiller Heater System Heating Mass Flow Rate [kg/s]
HVAC,Average,Chiller Heater System Source Inlet Temperature [C]
HVAC,Average,Chiller Heater System Source Outlet Temperature [C]
HVAC,Average,Chiller Heater System Source Mass Flow Rate [kg/s]

Chiller Heater System Cooling Electric Power [W]

Chiller Heater System Cooling Electric Energy [J]
These outputs are the sums of the cooling electric power consumption of the central heat
pump system containing one or more child objects. Cooling Energy is metered on
Cooling:Electricity, Electricity:Plant, and Electricity:Facility.
Chiller Heater System Heating Electric Power [W]
Chiller Heater System Heating Electric Energy [J]
These outputs are the sums of the heating electric power consumption of the central heat
pump system. Heating Energy is metered on Heating:Electricity, Electricity:Plant, and
Electricity:Facility.
Chiller Heater System Cooling Rate [W]
Chiller Heater System Cooling Energy [J]
These outputs are the evaporator heat transfer which is the cooling delivered by the central
heat pump system. These are the sums of the evaporator heat transfer of individual chillerheater modules included in the central heat pump system. Cooling Energy is metered on
Chiller:EnergyTransfer, EnergyTransfer:Plant, and EnergyTransfer:Facility.
Chiller Heater System Heating Rate [W]
Chiller Heater System Heating Energy [J]
These outputs are the condenser heat transfer which is the heating delivered by the central
heat pump system. These are the sums of the condenser heat transfer of individual chillerheater modules included in the central heat pump system. Heating Energy is metered on
Boiler:EnergyTransfer, EnergyTransfer:Plant, and EnergyTransfer:Facility.
Chiller Heater System Source Heat Transfer Rate [W]
Chiller Heater System Source Heat Transfer Energy [J]
These outputs are heat transfer which is the heat rejected to a ground source loop or
extracted from the source loop, depending on the operating modes of the chiller-heater
modules. This is the sums of evaporator heat transfer of the chiller-heater modules in
heating-only mode or heating dominant simultaneous cooling-heating mode while the sums of
condenser heat transfer of the chiller-heater modules in cooling-only mode or cooling
9/29/14

659

Input-Output Reference

Group Plant Equipment

dominant simultaneous cooling-heating mode. Source Heat Transfer Energy is metered on

HeatRejection:EnergyTransfer, EnergyTransfer:Plant, and EnergyTransfer:Facility.
Chiller Heater System Cooling Inlet Temperature [C]
Chiller Heater System Cooling Outlet Temperature [C]
Chiller Heater System Cooling Mass Flow Rate [kg/s]
These outputs are the chilled water inlet and outlet temperatures and flow rate.
Chiller Heater System Heating Inlet Temperature [C]
Chiller Heater System Heating Outlet Temperature [C]
Chiller Heater System Heating Mass Flow Rate [kg/s]
These outputs are the hot water inlet and outlet temperatures and flow rate.
Chiller Heater System Source Inlet Temperature [C]
Chiller Heater System Source Outlet Temperature [C]
Chiller Heater System Source Mass Flow Rate [kg/s]
These outputs are the source water inlet and outlet temperatures and flow rate.
ChillerHeaterPerformance:EIectric:EIR
The performance of the chiller-heater will be defined by two sets of curves meant to describe
unloading for: 1) cooling-only mode, and 2) heating-only mode or simultaneous coolingheating mode. Reference conditions must be defined for both because each has its own set
of three unloading curves based on their associated reference conditions. The cooling-mode
curves are typically (but not always) based on condenser entering water temperature while
the heating-only mode curves are typically based on condenser leaving water temperature.
This chiller-heater object allows the user to specify whether to use condenser leaving or
condenser entering as a dependent variable to differentiate, if necessary, the condenser
temperature basis used to generate the cooling- and heating-only mode curves.
Field: Name
This alpha field contains the identifying name of the chiller-heater to be included in a central
heat pump system.
Field: Reference Cooling Mode Evaporator Capacity
This numeric field contains the reference cooling capacity of the evaporator in cooling mode
in Watts. This value should be based on the reference temperatures and design water flow
rates defined below. This field can be autosized.
Field: Reference Cooling Mode COP
This numeric field contains the reference coefficient of performance of the evaporator for
cooling. It must be based on the values of Reference Cooling Mode Leaving Chilled Water
Temperature and Reference Cooling Mode Entering Condenser Water Temperature defined
in the next two fields.
Field: Reference Cooling Mode Leaving Chilled Water Temperature
This numeric field contains the reference leaving chilled water temperature of the evaporator
for cooling in Celsius. The default value is 6.67C.
Field: Reference Cooling Mode Entering Condenser Water Temperature
This numeric field contains the reference entering condenser water temperature of the
condenser in the cooling mode in Celsius. The default value is 29.4C.
9/29/14

660

Input-Output Reference

Group Plant Equipment

Field: Reference Cooling Mode Leaving Condenser Water Temperature

This numeric field contains the reference leaving condenser water temperature of the
condenser in the cooling mode in Celsius. The default value is 35.0C.
Field: Reference Heating Mode Cooling Capacity Ratio
This numeric field contains the evaporators capacity during the reference heating-only or
simultaneous cooling-heating mode as a ratio of reference cooling capacity. For example, the
ratio may be expressed as follows:

Ratio

EvapCapHtg@ Tchw,l

6.67C ,Tcond, l 51.67C

EvapCapC lg @ Tchw,l

6.67C ,Tcond, l 35.0C

where Tchw,l is the leaving chilled water temperature and Tcond,l is the leaving condenser
water temperature representing the heating-mode and cooling-mode reference temperatures
defined elsewhere in this object.
The default is 0.75. This field is used to determine evaporator capacity in heating-only mode
or simultaneous cooling-heating mode, multiplying it by the value entered in the field of the
Reference Cooling Mode Evaporator Capacity. Note that even when there is no cooling load,
i.e., the machine is in heating-only mode, the evaporator must still run and extract heat from
the source water. In heating-only mode, the leaving chilled water temperature (Tchw,l) may
float depending on the evaporator water flow rate and the source water temperature. In
simultaneous cooling and heating mode, the leaving chilled water temperature (Tchw,l) does
not float but is determined by the chilled water setpoint controls. For both heating-only and
simultaneous cooling and heating mode, the leaving condenser temperature (Tcond,l) is
determined by the hot water supply setpoint controls. This value of Tchw,l, combined with
Tcond,l is plugged into the CAPFT and EIRFT curves to determine the off-rated heatingmode evaporator capacity and associated compressor power.
Field: Reference Heating Mode Cooling Power Ratio
This numeric field contains the compressor power during simultaneous cooling-heating mode
as a ratio of reference cooling compressor power. For example, the ratio may be expressed
as follows:

Ratio

Power@ Tchw,l

6.67C ,Tcond, l 51.67C

Power@ Tchw,l

6.67C ,Tcond, l 35.0 C

The default value is 1.5. This field is used to determine full load compressor power at the
simultaneous cooling-heating modes reference chilled water leaving and condenser water
leaving temperatures. Note: In heating-only mode, the chilled water leaving temperature
floats so the EIRFT curve is used to modify the simultaneouos cooling-heating full load
compressor power value.
Field: Reference Heating Mode Leaving Chilled Water Temperature
This numeric field contains the reference leaving chilled water temperature of the evaporator
in simultaneous cooling-heating mode in Celsius. This is typically the same as the reference
cooling mode value and is used to create the heating-only mode and simultaneous coolingheating mode unloading curves. The leaving chilled water temperature for the chiller-heater is
not allowed to fall below this value during the heating-only mode and simultaneous coolingheating mode. The default value is 6.67C.

9/29/14

661

Input-Output Reference

Group Plant Equipment

Field: Reference Heating Mode Leaving Condenser Water Temperature

This numeric field contains the reference leaving condenser water temperature of the
condenser in heating mode in Celsius. This field is typically controlled to the design hot water
supply temperature, and used to create the heating-only mode and simultaneous coolingheating mode unloading curves. The default value is 60.0C.
Field: Reference Heating Mode Entering Condenser Water Temperature
This numeric field contains the reference entering condenser water temperature of the
condenser in heating mode in Celsius. This field typically represents the upper limit of the
source water temperature. The default value is 29.44C.
Field: Heating Mode Entering Chilled Water Temperature Low Limit
This numeric field contains the low limit of the entering chilled water temperature in heatingonly mode or simultaneous cooling-heating mode in Celsius. This field typically represents
the lower limit of the source water temperature. If necessary, auxiliary heat will be activated
to prevent source water temperature falling below the chilled water entering minimum. The
default value is 12.2C.
Field: Chilled Water Flow Mode Type
This alpha field contains the chilled water flow control mode. Valid water flow mode includes
constant flow and variable flow, and the default water flow mode is constant flow.
Field: Design Chilled Water Flow Rate
This numeric field contains the design chilled water flow rate in m 3/s. The minimum value for
this field must be greater than zero, and this field is autosizable.
Field: Design Condenser Water Flow Rate
This numeric field contains the design condenser water flow rate in m 3/s. The minimum value
for this field must be greater than zero, and this field is autosizable.
Field: Design Hot Water Flow Rate
This numeric field contains the design hot water flow rate in m 3/s. The minimum value and
default value for this field are zero, and this field is autosizable.
Field: Compressor Motor Efficiency
This numeric field contains the fraction of efficiency of the compressor electrical energy
consumption that must be rejected by the condenser. This value must be between 0.0 and
1.0, and the default value is 1.0.
Field: Condenser Type
This alpha field contains the type of condenser. WaterCooled is the only valid type, and it
requires the full specification of the condenser loop and its associated equipment.
Field: Cooling Mode Temperature Curve Condenser Water Independent Variable
This alpha field determines whether the entering or leaving condenser water temperature is
used in the cooling mode unloading performance curves that follow. Valid variables include
EnteringCondenser and LeavingCondenser, and the default variable is EnteringCondenser.
The condenser temperature used for the cooling mode unloading performance curves will be
dependent on this field input. For example, leaving condenser water temperature will be used
when the LeavingCondenser is chosen, otherwise entering condenser water temperature.
Field: Cooling Mode Cooling Capacity Function of Temperature Curve Name
This alpha field contains the name of a biquadratic performance curve (ref: Performance
Curves) that parameterizes the variation of the evaporator capacity as a function of the
9/29/14

662

Input-Output Reference

Group Plant Equipment

leaving chilled water temperature and either the entering condenser water temperature or the
leaving condenser water temperature as defined in the previous field. It is then multiplied by
the reference evaporator capacity to give the cooling capacity at specific temperature
operating conditions (i.e., at temperatures different from the reference temperatures). The
curve should have a value of 1.0 at the reference temperatures and flow rates specified
above. The biquadratic curve should be valid for the range of water temperatures anticipated
for the simulation.
Field: Cooling Mode Electric Input to Cooling Output Ratio Function of Temperature Curve
Name
This alpha field contains the name of a biquadratic performance curve (ref: Performance
Curves) that parameterizes the variation of the energy input to cooling output ratio (EIR) as a
function of the leaving chilled water temperature and either the entering condenser water
temperature or the leaving condenser water temperature as defined by the user. The EIR is
the inverse of the COP. It is then multiplied by the reference EIR (inverse of the reference
COP) to give the EIR at specific temperature operating conditions (i.e., at temperatures
different from the reference temperatures). The curve should have a value of 1.0 at the
reference temperatures and flow rates specified above. The biquadratic curve should be valid
for the range of water temperatures anticipated for the simulation.
Field: Cooling Mode Electric Input to Cooling Output Ratio Function of Part Load Ratio
Curve Name
This alpha field contains the name of a performance curve (ref: Performance Curves) that
parameterizes the variation of the energy input to cooling output ratio (EIR) as a function of
the part-load ratio (EIRFPLR). The EIR is the inverse of the COP, and the part-load ratio is
the actual cooling load divided by the available cooling capacity of the chiller-heater. This
curve is generated by dividing the operating electric input power by the available full-load
capacity at the specific operating temperatures. The curve output should decrease from 1
towards 0 as part-load ratio decreases from 1 to 0. Note that the bi-cubic formulation is
generally only valid when LeavingCondenser variable is chosen for the field of Cooling Mode
Condenser Water Temperature Curve Input Variable whereas the quadratic curve can be
used both choices, i.e., LeavingCondenser and EnteringCondenser. The output of this curve
is then multiplied by the reference full-load EIR and the EIRFT to give the EIR at the specific
temperatures and part-load ratio at which the chiller-heater is operating. This curve should
have a value of 1.0 when the part-load ratio equals 1.0. The curve should be valid for the
range of part-load ratios anticipated for the simulation.
Field: Cooling Mode Cooling Capacity Optimum Part Load Ratio
This numeric field contains the chiller-heaters optimum part-load ratio. This is the part-load
ratio at which the chiller-heater performs at its maximum COP. The optimum part-load ratio
must be greater than or equal to the minimum part-load ratio, and less than or equal to the
maximum part-load ratio. (Note: Both the minimum part-load ratio and maximum part-load
ratio are taken from the Cooling Mode EIRFPLR curve definition.) The default value is 1.0.
Field: Heating Mode Temperature Curve Condenser Water Independent Variable
This alpha field determines whether the entering or leaving condenser water temperature is
used in the heating mode unloading performance curves that follow. Valid variables include
EnteringCondenser and LeavingCondenser, and the default variable is EnteringCondenser.
The condenser temperature used for the cooling mode unloading performance curves will be
dependent on this field input. For example, leaving condenser water temperature will be used
when the LeavingCondenser is chosen, otherwise entering condenser water temperature.
Field: Heating Mode Cooling Capacity Function of Temperature Curve Name
This alpha field contains the name of a biquadratic performance curve (ref: Performance
Curves) that parameterizes the variation of the evaporator capacity in heating mode as a
9/29/14

663

Input-Output Reference

Group Plant Equipment

function of the leaving chilled water temperature and either the entering condenser water
temperature or the leaving condenser water temperature as defined in the previous field. This
curve is used to evaluate the adjusted evaporator capacity during heating-only mode or
simultaneous cooling-heating mode. This adjusted capacity is used as part of the cooling
part-load calculation for the EIRFPLR curve. It is then multiplied by the reference evaporator
capacity to give the cooling capacity at specific temperature operating conditions (i.e., at
temperatures different from the reference temperatures). The curve should have a value of
1.0 at the reference temperatures and flow rates specified above. The biquadratic curve
should be valid for the range of water temperatures anticipated for the simulation.
Field: Heating Mode Electric Input to Cooling Output Ratio Function of Temperature Curve
Name
This alpha field contains the name of a biquadratic performance curve (ref: Performance
Curves) that parameterizes the variation of the energy input to cooling output ratio (EIR) as a
function of the leaving chilled water temperature and either the entering condenser water
temperature or the leaving condenser water temperature as defined by the user. The EIR is
the inverse of the COP. It is then multiplied by the reference EIR (inverse of the reference
COP) to give the EIR at specific temperature operating conditions (i.e., at temperatures
different from the reference temperatures). The curve should have a value of 1.0 at the
reference temperatures and flow rates specified above. The biquadratic curve should be valid
for the range of water temperatures anticipated for the simulation.
Field: Heating Mode Electric Input to Cooling Output Ratio Function of Part Load Ratio
Curve Name
This alpha field contains the name of a performance curve (ref: Performance Curves) that
parameterizes the variation of the energy input to cooling output ratio (EIR) as a function of
the part-load ratio (EIRFPLR). The EIR is the inverse of the COP, and the part-load ratio is
the actual evaporator load divided by the available evaporator capacity of the chiller-heater at
the reference heating and simultaneous cooling-heating mode temperatures. This curve is
generated by dividing the operating electric input power by the available full-load capacity (do
not divide by load) at the specific operating temperatures. The curve output should decrease
from 1 towards 0 as part-load ratio decreases from 1 to 0. Note that the bicubic formulation
below can only be used when the chiller-heater uses a variable speed compressor motor
drive. It is also generally valid only when LeavingCondenser variable is chosen for the field of
Cooling Mode Condenser Water Temperature Curve Input Variable whereas the quadratic
curve can be used both choices, i.e., LeavingCondenser and EnteringCondenser. The output
of this curve is then multiplied by the reference full-load EIR (inverse of the reference COP)
and the EIRFT to give the EIR at the specific temperatures and part-load ratio at which the
chiller-heater is operating. This curve should have a value of 1.0 when the part-load ratio
equals 1.0. The curve should be valid for the range of part-load ratios anticipated for the
simulation.
Field: Heating Mode Cooling Capacity Optimum Part Load Ratio
This numeric field contains the chiller-heaters optimum part-load ratio during heating-only
mode or simultaneous cooling-heating mode. This is the part-load ratio at which the chillerheater performs at its maximum COP. The optimum part-load ratio must be greater than or
equal to the minimum part-load ratio, and less than or equal to the maximum part-load ratio.
(Note: Both the minimum part-load ratio and maximum part-load ratio are taken from the
Heating Mode EIRFPLR curve definition.) The default value is 1.0.
Field: Sizing Factor
This optional numeric field allows the user to specify a sizing factor for this component. The
Sizing Factor is a multiplier on the design plant chilled water loop flow rate associated with
the chiller-heaters parent CentralHeatPumpSystem object. The chiller-heater's modified
chilled water flow can then be used to autocalculate the Design Condenser Water Flow Rate
9/29/14

664

Input-Output Reference

Group Plant Equipment

and Reference Cooling Mode Evaporator Capacity values. In general, it is best to autosize all
three fields or set fixed values for all three fields.
An example of this statement in an IDF is:
ChillerHeaterPerformance:Electric:EIR,
ChillerHeaterModule 1,
!- Name
12500,
!- Reference Cooling Mode Evaporator Capacity {W}
1.5,
!- Reference Cooling Mode COP {W/W}
6.67,
!- Reference Cooling Mode Leaving Chilled Water Temperature {C}
29.4,
!- Reference Cooling Mode Entering Condenser Fluid Temperature {C}
35.0,
!- Reference Cooling Mode Leaving Condenser Water Temperature {C}
0.74,
!- Reference Heating Mode Cooling Capacity Ratio
1.38,
!- Reference Heating Mode Cooling Power Input Ratio
6.67,
!- Reference Heating Mode Leaving Chilled Water Temperature {C}
60,
!- Reference Heating Mode Leaving Condenser Water Temperature {C}
29.44,
!- Reference Heating Mode Entering Condenser Fluid Temperature {C}
5,
!- Heating Mode Entering Chilled Water Temperature Low Limit {C}
VariableFlow,
!- Chilled Water Flow Mode Type
0.0003525,
!- Design Chilled Water Flow Rate {m3/s}
0.0005525,
!- Design Condenser Water Flow Rate {m3/s}
0.0003525,
!- Design Hot Water Flow Rate {m3/s}
1,
!- Compressor Motor Efficiency
WaterCooled,
!- Condenser Type
EnteringCondenser,
!- Cooling Mode Temperature Curve Condenser Water Independent Variable
ChillerHeaterClgCapFT,
!- Cooling Mode Cooling Capacity Function of Temperature Curve Name
ChillerHeaterClgEIRFT,
!- Cooling Mode Electric Input to Cooling Output Ratio Function of
!Temperature Curve Name
ChillerHeaterClgEIRFPLR, !- Cooling Mode Electric Input to Cooling Output Ratio Function of Part Load
!Ratio Curve Name
1,
!- Cooling Mode Cooling Capacity Optimum Part Load Ratio
LeavingCondenser,
!- Heating Mode Temperature Curve Condenser Water Independent Variable
ChillerHeaterHtgCapFT,
!- Heating Mode Cooling Capacity Function of Temperature Curve Name
ChillerHeaterHtgEIRFT,
!- Heating Mode Electric Input to Cooling Output Ratio Function of
!Temperature Curve Name
ChillerHeaterHtgEIRFPLR, !- Heating Mode Electric Input to Cooling Output Ratio Function of Part Load
!Ratio Curve Name
1,
!- Heating Mode Cooling Capacity Optimum Part Load Ratio
1;
!- Sizing Factor

ChillerHeaterPerformance:Electric:EIR Outputs
HVAC,Average,Chiller Heater Operation Mode Unit <x> []
HVAC,Average,Chiller Heater Part Load Ratio Unit <x> []
HVAC,Average,Chiller Heater Cycling Ratio Unit <x> []
HVAC,Average,Chiller Heater Cooling Electric Power Unit <x> [W]
HVAC,Sum,Chiller Heater Cooling Electric Energy Unit <x> [J]
HVAC,Average,Chiller Heater Heating Electric Power Unit <x> [W]
HVAC,Sum,Chiller Heater Heating Electric Energy Unit <x> [J]
HVAC,Average,Chiller Heater Cooling Rate Unit <x> [W]
HVAC,Sum,Chiller Heater Cooling Energy Unit <x> [J]
HVAC,Average,Chiller Heater False Load Heat Transfer Rate Unit <x> [W]
HVAC,Sum,Chiller Heater False Load Heat Transfer Energy Unit <x> [J]
HVAC,Average,Chiller Heater Condenser Heat Transfer Rate Unit <x> [W]
HVAC,Sum,Chiller Heater Condenser Heat Transfer Energy Unit <x> [J]
HVAC,Average,Chiller Heater Evaporator Inlet Temperature Unit <x> [C]
HVAC,Average,Chiller Heater Evaporator Outlet Temperature Unit <x> [C]
HVAC,Average,Chiller Heater Evaporator Mass Flow Rate Unit <x> [kg/s]
HVAC,Average,Chiller Heater Condenser Inlet Temperature Unit <x> [C]
HVAC,Average,Chiller Heater Condenser Outlet Temperature Unit <x> [C]
HVAC,Average,Chiller Heater Condenser Mass Flow Rate Unit <x> [kg/s]
HVAC,Average,Chiller Heater COP Unit <x> []
HVAC,Average,Chiller Heater Capacity Temperature Modifier Multiplier Unit <x>
[]
HVAC,Average,Chiller Heater EIR Temperature Modifier Multiplier Unit <x> []
9/29/14

665

Input-Output Reference

Group Plant Equipment

HVAC,Average,Chiller Heater EIR Part Load Modifier Multiplier Unit <x> []

Note that much of these output variables are adapted from the definitions above under
Generic Chiller Outputs and Electric EIR Chiller Outputs. The following outputs are
repeated up to the maximum of individual chiller-heater module objects. The maximum
number may be different from the number of object defined in this object when users define
two or more identical chiller-heater modules for a single chiller heater object in the central
heat pump system.
Chiller Heater Operation Mode Unit <x> [ ]
This output represents the operating mode of the chiller-heater module. Two single mode
outputs and three simultaneous cooling-heating mode outputs are possible:
0: off
1: cooling-only mode
2: heating-only mode
3: heat recovery mode
4: cooling dominant simultaneous cooling-heating mode
5: heating dominant simultaneous cooling-heating mode.
The first mode 0 is reported when the chiller-heater is turned off. The next two modes 2 and 3
are reported when the chiller-heater provides only either cooling or heating, respectively. The
last three modes 3 to 5 indicate when the chiller-heater is in a simultaneous cooling-heating
mode. Mode 3 indicates the chiller-heaters provides simultaneous cooling and heating
without heat exchange with the ground source. Mode 4 denotes that at least one of the
chiller-heater modules in the central heat pump system provides both cooling and heating,
and the chiller-heater is meeting remaining cooling demand (see Figure 78. Diagram of a
central heat pump system with one chiller-heater in heat recovery mode and two chillerheaters in cooling-only mode) Similarly, mode 5 indicates that at least one of the chillerheater modules in the central heat pump system is in the heat recovery mode, and the chillerheater is meeting remaining heating demand (see Figure 79).
Note that the decision to operate individual chiller-heater modules is solely dependent on the
chiller-heater schedule and loads. A fraction may appear in case the chiller-heater mode
varies within a zone time step. In this particular case, users may define a detailed reporting
frequency for this output variable.
Chiller Heater Part Load Ratio Unit <x> [ ]
This output is the ratio of the evaporator heat transfer rate plus the false load heat transfer
rate (if applicable) to the available chiller-heater capacity. This value is used to determine
ChillerEIRFPLR.
Chiller Heater Cycling Ratio Unit <x> [ ]
The cycling ratio is the amount of time the chiller-heater operates during each simulation time
step. If the chiller-heater part-load ratio falls below the minimum part-load ratio, the chillerheater cycles on and off to meet the loads.
Chiller Heater Cooling Electric Power Unit <x> [W]
Chiller Heater Cooling Electric Energy Unit <x> [J]
These outputs are the cooling electric power consumption of the chiller-heater.

9/29/14

666

Input-Output Reference

Group Plant Equipment

Chiller Heater Heating Electric Power Unit <x> [W]

Chiller Heater Heating Electric Energy Unit <x> [J]
These outputs are the heating electric power consumption of the chiller-heater.
Chiller Heater Cooling Rate Unit <x> [W]
Chiller Heater Cooling Energy Unit <x> [J]
These outputs are the evaporator heat transfer which is the cooling delivered by the chillerheater module.
Chiller Heater False Load Heat Transfer Rate Unit <x> [W]
Chiller Heater False Load Heat Transfer Energy Unit <x> [J]
These outputs are the heat transfer rate and total heat transfer due to false loading of the
chiller-heater. When the chiller-heater part-load ratio is below the minimum unloading ratio,
the chiller-heater false loads (e.g. hot-gas bypass) to further reduce capacity.
Chiller Heater Condenser Heat Transfer Rate Unit <x> [C]
Chiller Heater Condenser Heat Transfer Energy Unit <x> [C]
These outputs are the heat transfer which is the heating delivered by the chiller-heater
module in heating mode.
Chiller Heater Evaporator Inlet Temperature Unit <x> [C]
Chiller Heater Evaporator Outlet Temperature Unit <x> [C]
Chiller Heater Evaporator Mass Flow Rate Unit <x> [C]
These outputs are the evaporator water inlet and outlet temperatures and flow rate. Note that
these represent the chilled water temperatures and flow rate in cooling mode or the source
water temperature and flow rate in heating mode.
Chiller Heater Condenser Inlet Temperature Unit <x> [C]
Chiller Heater Condenser Outlet Temperature Unit <x> [C]
Chiller Heater Condenser Mass Flow Rate Unit <x> [C]
These outputs are the condenser water inlet and outlet temperatures and flow rate. Note that
these represent the hot water temperatures and flow rate in heating mode or the source
water temperature and flow rate in cooling mode.
Chiller Heater COP Unit <x> [C]
This output is the coefficient of performance for the chiller-heater. It is calculated as the
evaporator heat transfer rate divided by the chiller-heater electric power.
Chiller Heater Capacity Temperature Modifier Multiplier Unit <x> [C]
This is the output of the curve object Cooling Capacity Function of Temperature Curve.
Chiller Heater EIR Temperature Modifier Multiplier Unit <x> [C]
This is the output of the curve object Electric Input to Cooling Output Ratio Function of
Temperature Curve.
Chiller Heater EIR Part Load Modifier Multiplier Unit <x> [C]
This is the output of the curve object Electric Input to Cooling Output Ratio Function of Part
Load Ratio Curve.

9/29/14

667

Input-Output Reference

Group Plant Equipment

Thermal Storage Objects

There are four types of cold thermal storage objects:
ThermalStorage:Ice:Simple
ThermalStorage:Ice:Detailed
ThermalStorage:ChilledWater:Mixed
ThermalStorage:ChilledWater:Stratified
These objects are typically placed on the supply side of a primary chilled water loop in series
or in parallel with one or more chillers.
Using the the component set point
(PlantEquipmentOperation:ComponentSetpoint) plant operation scheme type, the chiller and
storage tank setpoints are used to control operation. Using a SetpointManager:Scheduled
object (or other appropriate type of set point manager), the setpoints on the chiller outlet node
and the ice storage outlet node can be used to control how the cooling load is shared and
when charging of storage occurs. Example setpoints to use for various modes of operation
are shown in the table below:
Mode

Chiller
Setpoint

Storage
Setpoint

Charging ice storage tank

-5C

7C

Cooling with chiller only

7C

99C

Cooling with chiller and storage

(fully load chiller before using
storage))

7C

7C

Cooling with chiller and storage

(chiller carries portion of load,
valid if chiller is upstream of
storage)

10C

7C

Example files have been developed for three common storage configurations:
1) Series Chiller Upstream:

In this configuration, a chiller is placed first on the same

branch as the storage unit and both use the SeriesActive branch control type.

2) Series Chiller Downstream:

In this configuration, a chiller is placed second on the

same branch as the storage unit and both use the SeriesActive branch control type.

3) Parallel: In this configuration, the chiller is on a branch parallel to the storage unit branch

when it is not charging. During charging mode, valves will be changed so that the chiller
is in series upstream of the storage. To accomplish this in EnergyPlus, the chiller must
be modeled using two different chiller objects to represent the same chiller. One chiller
object on a parallel branch operates only when storage is not being charged. The other
chiller object, in series upstream of the storage unit operates only during charging mode.
Other considerations for applying cold thermal storage objects include:
In the PlantLoop object, the "Minimum Loop Temperature" must be set equal to or less
than the lowest setpoint to be used anywhere in the loop.
To end the storage charging cycle, use a AvailabilityManager:LowTemperatureTurnOff to
shut off the primary chilled water loop when the temperature leaving the storage tank
nears the charging mode chiller setpoint indicating that the tank is fully charged. For
example, if the chiller is set to provide 5C chilled water during charging, then charging
can be shut down when the water temperature leaving the storage unit reaches 4C.
When using a primary-secondary loop arrangement, it may be necessary to schedule this
availability manager to be active only when the HVAC systems are off to avoid fighting
between the demand controls and the availability manager.

9/29/14

668

Input-Output Reference

Group Plant Equipment

ThermalStorage:Ice:Simple
This thermal storage model is based on a simple simulation of an ice storage tank with a
fixed capacity. The tank is charged, or frozen, in an ice-on-coil configuration where ice builds
up on the outside of the tubes carrying the brine or glycol solution from the chiller. There are
two discharge (melt) options, internal or external. Internal melt uses the same fluid tubes for
charging and discharging. External melt uses a separate fluid path for discharge such that
the outer layers of ice melt first. The ice storage model includes an implied 3-way valve to
control the amount if charge/discharge based on the incoming water temperature and the
outlet node setpoint temperature. The storage tank is assumed to be fully charged (full of
ice) at the beginning of each environment. The tank is then allowed to charge and discharge
during the warmup days of the environment. The tank is best controlled using the
PlantEquipmentOperation:ComponentSetpoint plant operation scheme, and requires that a
setpoint be placed by a set point manager on the ice storage Plant Outlet Node.
The input fields for the object are described in detail below:
Field: Name
This alpha field contains the identifying name for the ice storage tank.
Field: Ice Storage Type
This alpha field specifies the type of ice storage tank to be modeled. There are two options:
"IceOnCoilInternal" models ice-on-coil, internal melt. "IceOnCoilExternal" models ice-on-coil,
external melt.
Field: Capacity
This numeric field contains the nominal capacity of the ice storage in GJ (Giga is 10 9).
Field: Inlet Node Name
This alpha field specifies the name of the chilled water inlet node.
Field: Outlet Node Name
This alpha field specifies the name of the chilled water outlet node.
Following is an example input for the THERMAL STORAGE:ICE:SIMPLE object.
ThermalStorage:Ice:Simple,
ITS,
IceOnCoilInternal,
1.5,
ITS Inlet Node,
ITS Outlet Node;

!!!!!-

Ice Storage Name

Ice Storage Type
Ice Storage Capacity {GJ}
Plant Loop Inlet Node
Plant Loop Outlet Node

Simple Ice Storage Outputs

The following outputs are available for simple Ice Storage model:
HVAC,Average,Ice Thermal Storage Requested Load [W]
Zone,Average,Ice Thermal Storage End Fraction[]
HVAC,Average,Ice Thermal Storage Mass Flow Rate [kg/s]
HVAC,Average,Ice Thermal Storage Inlet Temperature [C]
HVAC,Average,Ice Thermal Storage Outlet Temperature [C]
HVAC,Average,Ice Thermal Storage Cooling Discharge Rate [W]
HVAC,Sum,Ice Thermal Storage Cooling Discharge Energy [J]
HVAC,Average,Ice Thermal Storage Cooling Charge Rate [W]
HVAC,Sum,Ice Thermal Storage Cooling Charge Energy [J]

9/29/14

669

Input-Output Reference

Group Plant Equipment

Ice Thermal Storage Requested Load [W]

The load requested by the plant control scheme. A positive value indicates a cooling load or a
request to discharge (melt) the tank. A negative value indicates a request to charge (freeze)
the tank.
Ice Thermal Storage End Fraction []
The fraction of full ice storage which is present at the end of the current HVAC timestep.
When reported at a frequency less than detailed, this value is averaged over the reporting
period.
Ice Thermal Storage Mass Flow Rate [kg/s]
The total water mass flow rate through the ice storage component. Because the component
includes an implied 3-way valve, this flow may be all through the tank, all bypassed through
the valve, or a mixture of both.
Ice Thermal Storage Inlet Temperature [C]
The water temperature entering the ice storage component.
Ice Thermal Storage Outlet Temperature [C]
The water temperature leaving the ice storage component.
Ice Thermal Storage Cooling Discharge Rate [W]
The rate of cooling delivered by the ice storage component. A positive value indicates the ice
tank is discharging (melting). A zero value indicates the tank is charging or dormant.
Ice Thermal Storage Cooling Discharge Energy [J]
The cooling energy delivered by the ice storage component. A positive value indicates the ice
tank is discharging (melting). A zero value indicates the tank is charging or dormant.
Ice Thermal Storage Cooling Charge Rate [W]
The rate of charging delivered to the ice storage component. A positive value indicates the
ice tank is charging (freezing). A zero value indicates the tank is discharging or dormant.
Ice Thermal Storage Cooling Charge Energy [J]
The charging energy delivered to the ice storage component. A positive value indicates the
ice tank is charging (freezing). A zero value indicates the tank is discharging or dormant.
ThermalStorage:Ice:Detailed
The detailed ice storage model allows the users of EnergyPlus to model more closely specific
manufacturers ice storage units. This is possible due to the use of curve fits to simulate the
performance of the ice storage unit during charging and discharging. In this implementation,
both charging and discharging are a function of the fraction charged/discharged as well as
the log mean temperature difference across the storage unit. More information on the model
is provided in the Engineering Reference for EnergyPlus. The remainder of this section
describes the input required for the detailed ice storage model and the output that it can
produce.
Field: Name
This field is the name of the detailed ice storage system given to it by the user.
Field: Availability Schedule Name
This field is the name of the schedule (ref: Schedule) that determines whether or not the ice
storage system is available during a particular time period. This allows the system to be
turned off during a particular season. A value of less than or equal to zero indicates that the
9/29/14

670

Input-Output Reference

Group Plant Equipment

ice storage system is not available. Any value greater than zero indicates that the system is
available. If this field is blank, the schedule has values of 1 for all time periods.
Field: Capacity
This number is the maximum amount of latent thermal storage available in the ice storage
system. This model does not allow the removal or addition of sensible energy from the tank.
Thus, it is always assumed to be at the freezing temperature of the storage material. The
capacity is expressed in units of GJ.
Field: Inlet Node Name
This is the name of the node that connects the ice storage system to the plant loop. It is the
inlet node to the ice storage component. The next field defines the outlet node. Due to
presence of an internal bypass in this model, there are other nodes that are handled
internally within the program. Users do not need to define any nodes other than the inlet and
outlet nodes.
Field: Outlet Node Name
This is the name of the other node that connects the ice storage system to the plant loop. It is
the outlet node to the ice storage component.
Field: Discharging Curve Object Type
The detailed ice storage model in EnergyPlus takes advantage of the Curve feature of the
program. Currently, the only two allowed curve fit types for the detailed ice storage model are
the QuadraticLinear and the CubicLinear curves. More information on this curve can be found
in the section on Curves.
Field: Discharging Curve Name
This field specifies the name of the actual curve fit to be used to model the discharging
process of the detailed ice storage system.
Field: Charging Curve Object Type
The detailed ice storage model in EnergyPlus takes advantage of the Curve feature of the
program. Currently, the only two allowed curve fit types for the detailed ice storage model are
the QuadraticLinear and the CubicLinear curves. More information on this curve can be found
in the section on Curves.
Field: Charging Curve Name
This field specifies the name of the actual curve fit to be used to model the charging process
of the detailed ice storage system.
Field: Timestep of the Curve Data
This field defines what timestep was used to produce the curve fits named in the previous
inputs. This parameter is important because the curve fit is non-dimensional. Thus, the data
used to develop the curve fits were based on a specific length of time. In many cases, this is
probably one hour or 1.0. The units for this parameter are hours.
Field: Parasitic Electric Load During Discharging
This field defines the amount of parasitic electric consumption (for controls or other
miscellaneous electric consumption associate with the ice storage unit itself) during the
discharge phase. This parameter is dimensionless and gets multiplied by the current load on
the tank.
Field: Parasitic Electric Load During Charging
This field defines the amount of parasitic electric consumption (for controls or other
miscellaneous electric consumption associate with the ice storage unit itself) during the
9/29/14

671

Input-Output Reference

Group Plant Equipment

charge phase. This parameter is dimensionless and gets multiplied by the current load on the
tank.
Field: Tank Loss Coefficient
This field defines the loss of ice stored during a particular hour. This field is dimensionless
(per hour). It is not multiplied by any temperature difference between the tank and the
environment in which it might be located.
Field: Freezing Temperature of Storage Medium
This parameter defines the freezing/melting temperature of the ice storage medium in
degrees Celsius. For most tanks, this is simply 0.0 C (the default value). However, some
tanks may use other materials or salts which would change the freezing temperature. This
can be changed using this parameter.
Field: Thaw Process Indicator
This input field assists in more accurate modeling of the charging process by defining how
the thawing of ice takes place. There are two options for this input: InsideMelt and
OutsideMelt. Some ice storage systems, by their nature, start the charging process with a
bare coil or no ice left on the charging surface even though there is still ice stored in the tank.
An example of such a system is sometimes referred to as an ice-on-coil inside melt system,
and these systems would define this parameter using the InsideMelt option for this field.
Other systems melt the ice from the outside, leaving ice still on the charging surface when
charging begins. These systems are modeled using the OutsideMelt option. For systems
that have a charging process that does not vary significantly with fraction charged can ignore
this input by accepting the default value. The default value for this field is OutsideMelt.
An IDF example:
ThermalStorage:Ice:Detailed,
Ice Tank,
ON,
0.5,
Ice Tank Inlet Node,
Ice Tank Outlet Node,
QuadraticLinear,
DischargeCurve,
QuadraticLinear,
ChargeCurve,
1.0,
0.0001,
0.0002,
0.0003,
0.0;

!!!!!!!!!!!!!!-

Ice Storage Name

Ice Storage availability schedule
Ice Storage Capacity {GJ}
Plant Loop Inlet Node
Plant Loop Outlet Node
Discharging Curve Fit Type
Discharging Curve Name
Charging Curve Fit Type
Charging Curve Name
Timestep of Curve Fit Data
Parasitic electric load during discharging
Parasitic electric load during charging
Tank loss coefficient
Freezing temperature [C]

Detailed Ice Storage Outputs

Current detailed ice storage output variables are:

9/29/14

672

Input-Output Reference
System,
System,
System,
System,
System,
System,
System,
System,
System,
System,
System,
System,
System,
System,
System,
System,

Average,
Average,
Average,
Average,
Average,
Average,
Average,
Average,
Average,
Average,
Sum, Ice
Average,
Sum, Ice
Average,
Sum, Ice
Average,

Group Plant Equipment

Ice Thermal Storage Cooling Rate [W]

Ice Thermal Storage Change Fraction []
Ice Thermal Storage End Fraction []
Ice Thermal Storage Mass Flow Rate [kg/s]
Ice Thermal Storage Bypass Mass Flow Rate [kg/s]
Ice Thermal Storage Tank Mass Flow Rate [kg/s]
Ice Thermal Storage Fluid Inlet Temperature [C]
Ice Thermal Storage Blended Outlet Temperature [C]
Ice Thermal Storage Tank Outlet Temperature [C]
Ice Thermal Storage Cooling Discharge Rate [W]
Thermal Storage Cooling Discharge Energy [J]
Ice Thermal Storage Cooling Charge Rate [W]
Thermal Storage Cooling Charge Energy [J]
Ice Thermal Storage Ancillary Electric Power [W]
Thermal Storage Ancillary Electric Energy [J]
Ice Thermal Storage On Coil Fraction []

Ice Thermal Storage Cooling Rate [W]

The actual load (absolute value) provided by the ice storage system during the current
timestep
Ice Thermal Storage Change Fraction []
The change in the ice tanks charge fraction charged during the current timestep (positive for
charging, negative for discharging).
Ice Thermal Storage End Fraction [ ]
The fraction charge of the ice storage system at the end of the timestep
Ice Thermal Storage On Coil Fraction [ ]
The fraction of ice that is actually on the freezing surface at the end of the timestep. This can
be different for an inside melt system than the end fraction (see previous output parameter).
Ice Thermal Storage Mass Flow Rate [kg/s]
The mass flow through the ice storage component
Ice Thermal Storage Bypass Mass Flow Rate [kg/s]
The mass flow through the ice storage component bypass (bypasses the actual unit)
Ice Thermal Storage Tank Mass Flow Rate [kg/s]
The mass flow through the ice storage unit itself
Ice Thermal Storage Fluid Inlet Temperature [C]
The inlet temperature to the ice storage component
Ice Thermal Storage Blended Outlet Temperature [C]
The outlet temperature of the component after mixing any bypass flow with flow through the
ice storage unit
Ice Thermal Storage Tank Outlet Temperature [C]
The outlet temperature of the ice storage unit itself below mixing with any bypass flow
Ice Thermal Storage Cooling Discharge Rate [W]
The cooling done (as a rate) by the ice storage unit or its discharge rate
Ice Thermal Storage Cooling Discharge Energy [J]
The total cooling done by the ice storage unit or its discharge rate

9/29/14

673

Input-Output Reference

Group Plant Equipment

Ice Thermal Storage Cooling Charge Rate [W]

The charging done (as a rate) to the ice storage unit
Ice Thermal Storage Cooling Charge Energy [J]
The total charging done to the ice storage unit
Ice Thermal Storage Ancillary Electric Power [W]
The electric power as a result of parasitic loads on the ice storage unit for things like controls
or other miscellaneous parts of the ice storage unit itself
Ice Thermal Storage Ancillary Electric Energy [J]
The electric consumption as a result of parasitic loads on the ice storage unit for things like
controls or other miscellaneous parts of the ice storage unit itself
ThermalStorage:ChilledWater:Mixed
The ThermalStorage:ChilledWater:Mixed object analytically solves the differential equation
governing the energy balance of the water tank. The chilled water is used by drawing from
the Use Side of the water tank. The tank is indirectly charged by circulating cold water
through the Source Side of the water tank.
Control is based on cycling flow through the source side. When the tank temperature rises
above a cut-in temperature, source side flow is requested. Source side flow will continue
until the tank is cooled to below the tank set point or cut-out temperature.
For heat gains from the ambient environment, the ambient air temperature can be taken from
a schedule, a zone, or the exterior. When used with a zone, the skin gains are removed from
the zone heat balance as negative internal heat gains.
Field: Name
The unique name of the ThermalStorage:ChilledWater:Mixed object.
Field: Tank Volume
The volume of the thermal storage tank [m 3].
Field: Setpoint Temperature Schedule Name
The reference to the schedule object specifying the chilled water temperature setpoint [C].
Also known as the "cut-out" temperature.
Field: Deadband Temperature Difference
The delta temperature difference [C] between the setpoint and the "cut-in" temperature at
which the storage tank will request cooling. In other words, the "cut-in" temperature is
Setpoint + Deadband.
Field: Minimum Temperature Limit
The temperature [C] at which the tank water becomes too cold. No source side flow is
allowed when the tank temperature is below this limit. The minimum temperature must be
lower than the setpoint temperature at all times.
Field: Nominal Cooling Capacity
This field describes the typical cooling capacity that the chilled water tank will provide. Since
this is a passive device, the actual cooling capacity depends on water temperatures and flow
rates. However, this field is used to describe the chilled water tanks nominal cooling
capacity for supervisory control where plant operation schemes require a cooling capacity to
model how equipment is dispatched.

9/29/14

674

Input-Output Reference

Group Plant Equipment

Field: Ambient Temperature Indicator

The Ambient Temperature Indicator specifies how the ambient air temperature will be
indicated. The field can be Schedule, Zone, or Exterior. If Schedule is used, the Ambient
Temperature Schedule Name field provides the values for ambient temperature. If Zone is
used, the zone air temperature of the zone specified in the Ambient Temperature Zone field
provides the ambient temperature. If Exterior is used, the outdoor dry-bulb air temperature
provides the ambient temperature.
Field: Ambient Temperature Schedule Name
The field contains the name of a schedule object specifying the ambient air temperature
around the tank for skin gains. This field is only used if Ambient Temperature Indicator is
Schedule.
Field: Ambient Temperature Zone Name
The reference to the zone object specifying the ambient air temperature around the tank for
skin gains. This field is only used if Ambient Temperature Indicator is Zone.
Field: Ambient Temperature Outdoor Air Node Name
This optional alpha field specifies the outdoor air node (OutdoorAir:Node) name used to
define the ambient conditions surrounding the chilled water tank. This field is applicable only
when the Ambient Temperature Indicator is specified as Exterior, otherwise this field should
be left blank. The node name specified must also be specified in an OutdoorAir:Node object
where the height of the node is taken into consideration when calculating outdoor air
conditions from the weather data. Alternately, the node name may be specified in an
OutdoorAir:NodeList object where the outdoor air conditions are taken directly from the
weather data.
Field: Heat Gain Coefficient from Ambient Temperature
The gain coefficient [W/K] from the ambient air temperature. This coefficient is often referred
to as the "UA" for the overall tank thermal performance with respect to heat gains from the
tanks skin..
Field: Use Side Inlet Node Name
The inlet node connection to the plant loop for the use side of the chilled water storage tank.
Typically the use side draws chilled water from the tank and returns warmer water.
Field: Use Side Outlet Node Name
The outlet node connection to the plant loop for the use side of the chilled water storage tank.
Typically the use side chilled water from the tank and returns warmer water.
Field: Use Side Heat Transfer Effectiveness
This field specifies the heat transfer effectiveness between the use side water and the tank
water. If the effectiveness is set to 1 then complete heat transfer occurs, simulating perfect
mixing of the use side water and the tank water. If the effectiveness is lower, then the use
side outlet water temperature will not be as cold as the tank water, simulating a heat
exchanger.
Field: Use Side Availability Schedule Name
This field contains the name of an availability schedule for the use side of the water tank. If
the schedules value is 0.0, then the use side is not available and flow will not be requested.
If the schedules value is note equal to 0.0 (usually 1 is used), the use side is available. If this
field is blank, the schedule has values of 1 for all time periods.

9/29/14

675

Input-Output Reference

Group Plant Equipment

Field: Use Side Design Flow Rate

This field is used to specify the design flow rate through the Use Side of the chilled water
tank. The volumetric design flow rate is specified in m3/s. The field can be autosized. If
autosized, then the input file should include a Plant Sizing object for the plant loop connected
to the Use side. Sizing results are reported in the EIO file.
Field: Source Side Inlet Node Name
The inlet node connection to the plant loop for the source side of the chilled water storage
tank. Typically the source side draws somewhat warm water from the tank and returns colder
water. The source side volume flow rate is obtained from the plant loop. The magnitude of
the flow rates through the source side can be controlled by setting the Maximum Branch Flow
Rate field in the BRANCH object that connects the source inlet node.
Field: Source Side Outlet Node Name
The outlet node connection to the plant loop for the source side of the chilled water storage
tank. Typically the source side draws somewhat warm water from the tank and returns colder
water.
Field: Source Side Heat Transfer Effectiveness
This field specifies the heat transfer effectiveness between the source side water and the
tank water. If the effectiveness is set to 1 then complete heat transfer occurs, simulating
perfect mixing of the source side water and the tank water. If the effectiveness is lower, then
the source side outlet water temperature will not be as cold as the tank water, simulating a
heat exchanger.
Field: Source Side Availability Schedule Name
This field contains the name of an availability schedule for the source side of the water tank.
If the schedules value is 0.0, then the source side is not available and flow will not be
requested. If the schedules value is not equal to 0.0 (usually 1 is used), the source side is
available. If this field is blank, the schedule has values of 1 for all time periods.
Field: Source Side Design Flow Rate
This field is used to specify the design flow rate through the Source Side of the chilled water
tank. The volumetric design flow rate is specified in m 3/s. The field can be autosized. If
autosized, then the input file should include a Plant Sizing object for the plant loop. Sizing
results are reported in the EIO file.
Field: Tank Recovery Time
This field is used to autosize the Source Side Design Flow Rate. The field is used if the
previous field is set to autosize and the water tanks source side is on the demand side of a
plant loop. This the the time, in hours, that the chilled water tank is to be indirectly cooled
from 14.4C to 9.0C using the exit temperature of in the associated Plant Sizing object.
An example input object follows.

9/29/14

676

Input-Output Reference
ThermalStorage:ChilledWater:Mixed,
Chilled Water Storage Tank 1 , !4.0 ,
!CW-Tank-Temp-Schedule,
!3.5,
!1.0 ,
!25000 ,
!Zone ,
!,
!ZN_1_FLR_1_SEC_5 ,
!,
!5.0 ,
!CW Tank Discharge Inlet node,
!CW Tank Discharge Outlet node , !1.0 ,
!TES Use Schedule,
!Autosize ,
!CW Tank Charge Inlet Node,
!CW Tank Charge Outlet Node,
!1.0,
!TES Charge Schedule,
!Autosize ,
!4.0;
!-

Group Plant Equipment

Name
Tank Volume
Setpoint Temperature Schedule Name
Deadband Temperature Difference
Minimum Temperature Limit
Nominal Cooling Capacity
Ambient Temperature Indicator
Ambient Temperature Schedule Name
Ambient Temperature Zone Name
Ambient Temperature Outdoor Air Node Name
Heat Gain Coefficient from Ambient Temperature
Use Side Inlet Node Name
Use Side Outlet Node Name
Use Side Effectiveness
Use Side Availability Schedule Name
Use Side Design Flow Rate
Source Side Inlet Node Name
Source Side Outlet Node Name
Source Side Effectiveness
Source Side Availability Schedule Name
Source Side Design Flow Rate
Tank Recovery Time

Chilled Water Mixed Thermal Storage Outputs

The following output variables are reported for chilled water thermal storage tanks.
Chilled Water Thermal
[C]
Chilled Water Thermal
[C]
Chilled Water Thermal
Average [W]
Chilled Water Thermal
[J]
Chilled Water Thermal
Average [kg/s]
Chilled Water Thermal
[C]
Chilled Water Thermal
[C]
Chilled Water Thermal
HVAC Average [W]
Chilled Water Thermal
HVAC Sum [J]
Chilled Water Thermal
Average [kg/s]
Chilled Water Thermal
[C]
Chilled Water Thermal
[C]
Chilled Water Thermal
HVAC Average [W]
Chilled Water Thermal
HVAC Sum [J]

Storage Tank Temperature

!- HVAC Average

Storage Final Tank Temperature

!- HVAC Average

Storage Tank Heat Gain Rate

!- HVAC

Storage Tank Heat Gain Energy

!- HVAC Sum

Storage Use Side Mass Flow Rate

!- HVAC

Storage Use Side Inlet Temperature

!- HVAC Average

Storage Use Side Outlet Temperature

!- HVAC Average

Storage Use Side Heat Transfer Rate

!-

Storage Use Side Heat Transfer Energy

!-

Storage Source Side Mass Flow Rate

Storage Source Side Inlet Temperature

!- HVAC
!- HVAC Average

Storage Source Side Outlet Temperature !- HVAC Average

Storage Source Side Heat Transfer Rate

!-

Storage Source Side Heat Transfer Energy

!-

Chilled Water Thermal Storage Tank Temperature [C]

The average water tank temperature.

9/29/14

677

Input-Output Reference

Group Plant Equipment

Chilled Water Thermal Storage Final Tank Temperature [C]

The final water tank temperature at the end of the system timestep. If reported at the
"Detailed" interval, this output variable can be used to verify an exact energy balance on the
water storage tank.
Chilled Water Thermal Storage Tank Heat Gain Rate [W]
The average heat exchange rate to the storage tank from the surrounding ambient. This is
usually positive with surrounding ambient heating the storage tank.
Chilled Water Thermal Storage Tank Heat Gain Energy [J]
The energy exchange to the storage tank from the surrounding ambient. This is usually
positive with surrounding ambient heating the storage tank.
Chilled Water Thermal Storage Use Side Mass Flow Rate [kg/s]
The use side mass flow rate.
Chilled Water Thermal Storage Use Side Inlet Temperature [C]
The inlet temperature on the use side.
Chilled Water Thermal Storage Use Side Outlet Temperature [C]
The outlet temperature on the use side.
Chilled Water Thermal Storage Use Side Heat Transfer Rate [W]
The average heat transfer rate between the use side water and the tank water.
Chilled Water Thermal Storage Use Side Heat Transfer Energy [J]
The heat transfer energy between the use side water and the tank water.
Chilled Water Thermal Storage Source Side Mass Flow Rate [kg/s]
The source side mass flow rate.
Chilled Water Thermal Storage Source Side Inlet Temperature [C]
The inlet temperature on the source side.
Chilled Water Thermal Storage Source Side Outlet Temperature [C]
The outlet temperature on the source side.
Chilled Water Thermal Storage Source Side Heat Transfer Rate [W]
The average heat transfer rate between the source side water and the tank water.
Chilled Water Thermal Storage Source Side Heat Transfer Energy [J]
The heat transfer energy between the source side water and the tank water.
ThermalStorage:ChilledWater:Stratified
The ThermalStorage:ChilledWater:Stratified object divides the water tank into multiple nodes
of equal volume. The nodes are coupled by vertical conduction effects, internode fluid flow,
and temperature inversion mixing. The object simultaneously solves the differential equations
governing the energy balances on the nodes using a numerical method. The system timestep
is divided into many small substeps that allow the simulation to capture events that occur on
a very short time scale. The chilled water is used by drawing from the Use Side of the
water tank. The tank is indirectly charged by circulating cold water through the Source Side
of the water tank.

9/29/14

678

Input-Output Reference

Group Plant Equipment

Control is based on cycling flow through the source side. When the tank temperature rises
above a cut-in temperature, source side flow is requested. Source side flow will continue
until the tank is cooled to below the tank set point or cut-out temperature.
For heat gains from the ambient environment, the ambient air temperature can be taken from
a schedule, a zone, or the exterior. When used with a zone, the skin gains are removed from
the zone heat balance as negative internal heat gains.
Field: Name
The unique name of the ThermalStorage:ChilledWater:Stratified object.
Field: Tank Volume
The volume of the thermal storage tank [m 3].
Field: Tank Height
The height [m] of the tank. For the HorizontalCylinder shape (see below) the height of the
tank is the measure in the axial direction, i.e., the height if you were to stand the cylinder up
on its end.
Field: Tank Shape
The tank shape determines the size and skin losses of the stratified nodes. There are three
options: VerticalCylinder, HorizontalCylinder, and Other.
VerticalCylinder describes most upright cylindrical water tanks.
HorizontalCylinder describes a few specialty water tanks and some large commercial storage
tanks. HorizontalCylinder implies that the tank is divided into nodes of equal mass, but not
equal height.
Other describes water storage tanks that have a uniform horizontal cross-section, but are not
cylinders, e.g., a cuboid or other shape. The length of the perimeter is then specified by the
Tank Perimeter field.
If blank, the default shape is VerticalCylinder.
Field: Tank Perimeter
The length of the tank perimeter [m]. This field is only used if Tank Shape is Other.
Field: Setpoint Temperature Schedule Name
The reference to the schedule object specifying the chilled water temperature setpoint [C].
Also known as the "cut-out" temperature.
Field: Deadband Temperature Difference
The delta temperature difference [C] between the setpoint and the "cut-in" temperature at
which the storage tank will request cooling. In other words, the "cut-in" temperature is
Setpoint + Deadband.
Field: Temperature Sensor Height
This field is used to describe the location in the tank where the temperature is sensed for
control descisions. The program will associate one of the nodes with this height and use that
nodes temperature for control decisions. The location is described in meters from the bottom
of the tank.
Field: Minimum Temperature Limit
The temperature [C] at which the tank water becomes too cold. No source side flow is
allowed when the tank temperature is below this limit. The minimum temperature must be
lower than the setpoint temperature at all times.

9/29/14

679

Input-Output Reference

Group Plant Equipment

Field: Nominal Cooling Capacity

This field describes the typical cooling capacity that the chilled water tank will provide. Since
this is a passive device, the actual cooling capacity depends on water temperatures and flow
rates. However, this field is used to describe the chilled water tanks nominal cooling
capacity for supervisory control where plant operation schemes require a cooling capacity to
model how equipment is dispatched.
Field: Ambient Temperature Indicator
The Ambient Temperature Indicator specifies how the ambient air temperature will be
indicated. The field can be Schedule, Zone, or Exterior. If Schedule is used, the Ambient
Temperature Schedule Name field provides the values for ambient temperature. If Zone is
used, the zone air temperature of the zone specified in the Ambient Temperature Zone field
provides the ambient temperature. If Exterior is used, the outdoor dry-bulb air temperature
provides the ambient temperature.
Field: Ambient Temperature Schedule Name
The field contains the name of a schedule object specifying the ambient air temperature
around the tank for skin gains. This field is only used if Ambient Temperature Indicator is
Schedule.
Field: Ambient Temperature Zone Name
The reference to the zone object specifying the ambient air temperature around the tank for
skin gains. This field is only used if Ambient Temperature Indicator is Zone.
Field: Ambient Temperature Outside Air Node Name
This optional alpha field specifies the outdoor air node name used to define the ambient
conditions surrounding the chilled water tank. This field is applicable only when the Ambient
Temperature Indicator is specified as Exterior, otherwise this field should be left blank. The
node name specified must also be specified in an OutdoorAir:Node object where the height of
the node is taken into consideration when calculating outdoor air conditions from the weather
data. Alternately, the node name may be specified in an OutdoorAir:NodeList object where
the outdoor air conditions are taken directly from the weather data.
Field: Uniform Skin Loss Coefficient per Unit Area to Ambient Temperature
The uniform skin loss coefficient [W/m 2-K] or U-Value of the tank to the ambient air
temperature. The uniform skin loss accounts for the tank insulation. The overall losses at any
particular tank node can be further modified using the Additional Loss Coefficient fields to
account for thermal shorting due to pipe penetrations, tank feet, and any other loss effects.
Field: Use Side Inlet Node Name
The inlet node connection to the plant loop for the use side of the chilled water storage tank.
Typically the use side draws chilled water from the tank and returns warmer water.
Field: Use Side Outlet Node Name
The outlet node connection to the plant loop for the use side of the chilled water storage tank.
Typically the use side chilled water from the tank and returns warmer water.
Field: Use Side Heat Transfer Effectiveness
This field specifies the heat transfer effectiveness between the use side water and the tank
water. If the effectiveness is set to 1 then complete heat transfer occurs, simulating perfect
mixing of the use side water and the tank water. If the effectiveness is lower, then the use
side outlet water temperature will not be as cold as the tank water, simulating a heat
exchanger.

9/29/14

680

Input-Output Reference

Group Plant Equipment

Field: Use Side Availability Schedule Name

This field contains the name of an availability schedule for the use side of the water tank. If
the schedules value is 0.0, then the use side is not available and flow will not be requested.
If the schedules value is not equal to 0.0 (usually 1 is used), then the use side is available. If
this field is blank, the schedule has values of 1 for all time periods.
Field: Use Side Inlet Height
The height of the use side inlet to the tank. If blank, the inlet defaults to the top of the tank.
The inlet height cannot be higher than the tank height.
Field: Use Side Outlet Height
The height of the use side outlet from the tank. If blank or autocalculate, the inlet defaults to
the bottom of the tank. The outlet height cannot be higher than the tank height.
Field: Use Side Design Flow Rate
This field is used to specify the design flow rate through the Use Side of the water tank. The
volumetric design flow rate is specified in m3/s. The field is needed when the Use Side is
connected to a plant loop. The field can be autosized. If autosized, then the input file should
include a Plant Sizing object for the plant loop. Sizing results are reported in the EIO file.
Field: Source Side Inlet Node Name
The inlet node connection to the plant loop for the source side of the chilled water storage
tank. Typically the source side draws somewhat warm water from the tank and returns colder
water. The source side volume flow rate is obtained from the plant loop. The magnitude of
the flow rates through the source side can be controlled by setting the Maximum Branch Flow
Rate field in the BRANCH object that connects the source inlet node.
Field: Source Side Outlet Node Name
The outlet node connection to the plant loop for the source side of the chilled water storage
tank. Typically the source side draws somewhat warm water from the tank and returns colder
water.
Field: Source Side Heat Transfer Effectiveness
This field specifies the heat transfer effectiveness between the source side water and the
tank water. If the effectiveness is set to 1 then complete heat transfer occurs, simulating
perfect mixing of the source side water and the tank water. If the effectiveness is less than
1.0, then the source side outlet water temperature will be less than the tank water at the
outlet node, simulating a heat exchanger.
Field: Source Side Availability Schedule Name
This field contains the name of an availability schedule for the source side of the water tank.
If the schedules value is 0.0, then the source side is not available and flow will not be
requested. If the schedules value is not equal to 0.0 (usually 1 is used), then the source side
is available. If this field is blank, the schedule has values of 1 for all time periods.
Field: Source Side Inlet Height
The height of the source side inlet to the tank. If blank or autocalculate, the inlet defaults to
the bottom of the tank. The inlet height cannot be higher than the tank height.
Field: Source Side Outlet Height
The height of the source side outlet from the tank. If blank, the inlet defaults to the top of the
tank. The outlet height cannot be higher than the tank height.

9/29/14

681

Input-Output Reference

Group Plant Equipment

Field: Source Side Design Flow Rate

This field is optional and is used to specify the design flow rate through the Source Side of
the water heater. The volumetric design flow rate is specified in m 3/s. The field is needed
when the Source Side is connected to a plant loop. The field can be autosized. If autosized,
then the input file should include a Plant Sizing object for the plant loop. Sizing results are
reported in the EIO file.
Field: Tank Recovery Time
This field is used to autosize the Source Side Design Flow Rate. The field is used if the
previous field is set to autosize and the water tanks source side is on the demand side of a
plant loop. This the the time, in hours, that the chilled water tank is to be indirectly cooled
from 14.4C to 9.0C using the exit temperature of in the associated Plant Sizing object.
Field: Inlet Mode
The inlet mode of entering fluid from the use and source sides. There are two options:
Fixed or Seeking. In Fixed mode, the fluid enters at the fixed heights specified above. In
Seeking mode, the fluid "seeks out" the stratified node that is closest to the inlet temperature
and adds all flow to that node. The Seeking mode provides maximum stratification.
Field: Number of Nodes
The number of stratified nodes in the tank. There must be at least one node. The maximum
number of nodes is 10, although this limit can be increased by editing the IDD.
Field: Additional Destratification Conductivity
An additional destratification conductivity [W/m-K] is added to the fluid conductivity of water
(0.6 W/m-K) to account for vertical conduction effects along the inside of the tank wall, and
perhaps other vertical components such as a dip tube pipe or anode rod.
Field: Node 1-10 Additional Loss Coefficient
An additional heat gain coefficient [W/m-K] added to the skin gains for a given node to
account for thermal shorting due to pipe penetrations, tank feet, and any other loss effects.
An example input object follows.

9/29/14

682

Input-Output Reference

Group Plant Equipment

ThermalStorage:ChilledWater:Stratified,
Chilled Water Storage Tank 1 , !- Name
4.0 ,
!- Tank Volume
2.0 ,
!- Tank Height
VerticalCylinder,
!- Tank Shape
,
!- Tank Perimeter
CW-Tank-Temp-Schedule ,
!- Setpoint Temperature Schedule Name
3.5 ,
!- Deadband Temperature Difference
1.4 ,
!- Temperature Sensor Height
1.0 ,
!- Minimum Temperature Limit
2500,
!- Nominal Cooling Capacity
Zone,
!- Ambient Temperature Indicator
,
!- Ambient Temperature Schedule Name
ZN_1_FLR_1_SEC_5 ,
!- Ambient Temperature Zone Name
,
!- Ambient Temperature OutdoorAir:Node Name
4.2,
!- Uniform Skin Loss Coefficient Per Unit Area To Ambient Temperature
CW Tank Discharge Inlet node,
!- Use Side Inlet Node Name
CW Tank Discharge Outlet node, !- Use Side Outlet Node Name
1.0,
!- Use Side Effectiveness
ALWAYS_ON,
!- Use Side Availability Schedule Name
1.85 ,
!- Use Side Inlet Height
0.15 ,
!- Use Side Outlet Height
autosize,
!- Use Side Design Flow Rate
CW Tank Charge Inlet Node,
!- Source Side Inlet Node Name
CW Tank Charge Outlet Node,
!- Source Side Outlet Node Name
1.0,
!- Source Side Effectiveness
TES Charge Schedule,
!- Source Side Availability Schedule Name
0.15,
!- Source Side Inlet Height
1.85,
!- Source Side Outlet Height
autosize,
!- Source Side Design Flow Rate
2.0,
!- Tank Recovery Time
Seeking,
!- Inlet Mode
6,
!- Number Of Nodes
0.0;
!- Additional Destratification Conductivity

Chilled Water Stratified Thermal Storage Outputs

The following output variables are reported for stratified chilled water thermal storage tanks.
Chilled
[C]
Chilled
[C]
Chilled
Average
Chilled
Sum [J]
Chilled
Average
Chilled
[C]
Chilled
[C]
Chilled
!- HVAC
Chilled
!- HVAC
Chilled
Average
Chilled
[C]
Chilled
[C]
Chilled
!- HVAC

9/29/14

Water Thermal Storage Tank Temperature

!- HVAC Average

Water Thermal Storage Final Tank Temperature

!- HVAC Average

Water Thermal Storage Tank Heat Gain Rate

[W]
Water Thermal Storage Tank Heat Gain Energy

!- HVAC
!- HVAC

Water Thermal Storage Use Side Mass Flow Rate

[kg/s]
Water Thermal Storage Use Side Inlet Temperature

!- HVAC Average

Water Thermal Storage Use Side Outlet Temperature

!- HVAC Average

Water Thermal
Average [W]
Water Thermal
Sum [J]
Water Thermal
[kg/s]
Water Thermal

!- HVAC

Storage Use Side Heat Transfer Rate

Storage Use Side Heat Transfer Energy
Storage Source Side Mass Flow Rate
Storage Source Side Inlet Temperature

Water Thermal Storage Source Side Outlet Temperature

!- HVAC
!- HVAC Average
!- HVAC Average

Water Thermal Storage Source Side Heat Transfer Rate

Average [W]

683

Input-Output Reference
Chilled
!- HVAC
Chilled
Average
Chilled
[C]

Group Plant Equipment

Water Thermal Storage Source Side Heat Transfer Energy

Sum [J]
Water Thermal Storage Temperature Node <1 - 10>
!- HVAC
[C]
Water Thermal Storage Final Temperature Node <1 10> !- HVAC Average

Chilled Water Thermal Storage Tank Temperature [C]

The average water tank temperature, i.e., the average of all of the node average
temperatures.
Chilled Water Thermal Storage Tank Final Temperature [C]
The final water tank temperature at the end of the system timestep, i.e., the average of all of
the final node temperatures at the end of the system timestep. If reported at the "Detailed"
interval, this output variable can be used to verify an exact energy balance on the water
storage tank.
Chilled Water Thermal Storage Tank Heat Gain Rate [W]
The average heat exchange rate to the storage tank from the surrounding ambient. This is
usually positive with surrounding ambient heating the storage tank.
Chilled Water Thermal Storage Tank Heat Gain Energy [J]
The energy exchange to the storage tank from the surrounding ambient. This is usually
positive with surrounding ambient heating the storage tank.
Chilled Water Thermal Storage Use Side Mass Flow Rate [kg/s]
The use side mass flow rate.
Chilled Water Thermal Storage Use Side Inlet Temperature [C]
The inlet temperature on the use side.
Chilled Water Thermal Storage Use Side Outlet Temperature [C]
The outlet temperature on the use side.
Chilled Water Thermal Storage Use Side Heat Transfer Rate [W]
The average heat transfer rate between the use side water and the tank water.
Chilled Water Thermal Storage Use Side Heat Transfer Energy [J]
The heat transfer energy between the use side water and the tank water.
Chilled Water Thermal Storage Source Side Mass Flow Rate [kg/s]
The source side mass flow rate.
Chilled Water Thermal Storage Source Side Inlet Temperature [C]
The inlet temperature on the source side.
Chilled Water Thermal Storage Source Side Outlet Temperature [C]
The outlet temperature on the source side.
Chilled Water Thermal Storage Source Side Heat Transfer Rate [W]
The average heat transfer rate between the source side water and the tank water.
Chilled Water Thermal Storage Source Side Heat Transfer Energy [J]
The heat transfer energy between the source side water and the tank water.

9/29/14

684

Input-Output Reference

Group Water Heaters

Chilled Water Thermal Storage Temperature Node 1-10 [C]

The average node temperature.
Chilled Water Thermal Storage Final Temperature Node 1-10 [C]
The final node temperature at the end of the system timestep.

Group Water Heaters

Water heater objects are components for storing and heating water. They can be coupled to
a plant loop simulation or used stand-alone. Typical water heater applications are for
domestic hot water heating, low-temperature radiant space heating, and energy storage for
solar hot water systems or waste heat recovery.
When coupled to the plant loop, the water heater has an inlet node and outlet node on the
"source side" and an inlet node and outlet node on the "use side". The source side typically
draws cold water from the tank and returns warmer water, for instance, from solar hot water
systems or waste heat recovery systems. The use side typically draws hot water from the
tank and returns cooler water from the cold water supply mains or from the outlet of a heating
system. The distinction between source and use sides is merely a convenience for reporting.
They can actually be used interchangeably. If so desired, either source side or use side can
be used by itself, without the other side being connected to the plant loop.
However, for a water heater that is indirectly heated (e.g. with a separate boiler), the source
side can be used to provide remotely heated water to the tank. The source side is configured
to operate as a component on the demand side of a plant loop. The design flow rate through
the source side can be set by the user or autosized. If autosized, then a Plant Sizing object
is needed elsewhere in the input file for the Plant Loop serving the source side. The water
heater input includes an additional design parameter that describes how rapidly the tank can
recover.

Figure 80. Water Heater Configuration

If the use side only consists of domestic hot water usage, a simple scheduled use flow rate
can be specified in lieu of the full plant loop connections. The scheduled use flow rate can be
used simultaneously with source side plant connections, but cannot be used with use side
plant connections.
For stand-alone operation, there are no node connections to the plant loop on either source
or use sides. The scheduled use flow rate determines all fluid exchange with the water tank.
There are currently two water heater objects in EnergyPlus:
9/29/14

685

Input-Output Reference

Group Water Heaters

WaterHeater:Mixed
WaterHeater:Stratified
There is also a compound object that uses the WaterHeater:Mixed as part of its strategy:
WaterHeater:HeatPump
The WaterHeater:Mixed object simulates a well-mixed, single-node water tank. The
WaterHeater:Stratified object simulates a stratified, multi-node water tank. Both water heater
objects can be appropriate for simulating many types of water heaters and storage tanks,
including gas and electric residential water heaters, and a variety of large commercial water
heaters. Both objects share similar features, such as stand-alone operation, on- and off-cycle
parasitic loads, and thermal losses to the zone. However, each object has its advantages
which may make one water heater object more appropriate than the other depending on the
application.
Advantages of WaterHeater:Mixed:
can simulate instantaneous/tankless water heaters
requires less input than the stratified tank
faster execution time than the stratified tank
adequate for modeling gas water heaters with no source connections.
Advantages of WaterHeater:Stratified:
better modeling of electric water heaters with two heating elements
better modeling of thermal storage applications which rely on stratification to improve
heat transfer peformance.
Standard Ratings
The EIO file reports the industry standard ratings of Recovery Efficiency and Energy Factor
for water heater objects. The rating method is based on the GAMA and 10CFR430 test
procedures. Under certain input parameters, the rating method will not succeed and a
warning message will be generated. Problems occur when inputs do not allow the tank to
recover to the setpoint temperature within the test period. This can occur if the maximum
heater capacity is undersized, or if the deadband temperature difference is large enough that
the first draw of the test does not trigger the heater to come on. In either case, the Recovery
Efficiency test will not compute properly because recovery to the setpoint was not achieved.
Standard ratings for storage-only water tanks (Heater Maximum Capacity = 0) cannot be
calculated and do not report anything in the EIO file.
WaterHeater:Mixed
The WaterHeater:Mixed object analytically solves the differential equation governing the
energy balance of the water tank. Within a timestep, conditions are solved separately for
when the heater element or burner is "on" (on-cycle) and when it is "off" (off-cycle). This
approach allows ambient losses and parasitic loads to be divided into on-cycle and off-cycle
effects and accounted for in detail.
For losses to the ambient environment, the ambient air temperature can be taken from a
schedule, a zone, or the exterior. When used with a zone, a fraction of the skin losses can be
added to the zone heat balance as internal heat gains.
Control options allow the heater to cycle or modulate to meet the load. When cycling, the
heater element or burner is either on or off. The heater remains fully on while heating the tank
up to the setpoint temperature. When the setpoint is reached, the heater turns off. The heater
remains off until the tank temperature falls below the "cut-in" temperature, i.e., the setpoint
temperature minus the deadband temperature difference. The heater continuously cycles on
and off to maintain the tank temperature within the deadband. Most storage-tank water
heaters cycle.

9/29/14

686

Input-Output Reference

Group Water Heaters

When modulating, the heater power varies between the maximum and minimum heater
capacities. The heater stays on as long as the required total demand is above the minimum
capacity. Below the minimum capacity, the heater will begin to cycle on and off based on the
deadband temperature difference. Equipment is usually designed and rated to avoid this
condition. Most tankless/instantaneous water heaters modulate.
Field: Name
The name of the WaterHeater:Mixed object.
Field: Tank Volume
The volume of the storage tank [m 3]. This field is autosizable if used with a Water
Heater:Sizing object. Although this field is allowed to go down to zero, even so-called
"tankless" water heaters have some volume of water that is maintained around the heating
elements or in the heat exchanger, typically around 0.00379 m 3 (1 gallon).
Field: Setpoint Temperature Schedule Name
The reference to the schedule object specifying the hot water temperature setpoint [C]. Also
known as the "cut-out" temperature.
Field: Deadband Temperature Difference
The delta temperature difference [C] between the setpoint and the "cut-in" temperature at
which the heater will turn on. In other words, the "cut-in" temperature is Setpoint Deadband.
Field: Maximum Temperature Limit
The temperature [C] at which the tank water becomes dangerously hot and is vented
through boiling or an automatic safety. The tank temperature will never exceed the maximum.
Any extra heat added to the tank is immediately vented. Note: The maximum temperature
must be greater than the setpoint temperature at all times.
Field: Heater Control Type
The control type can be Cycle or Modulate. Cycle is appropriate for most storage tank-type
water heaters. Modulate is appropriate for most instantaneous/tankless water heaters.
Field: Heater Maximum Capacity
The maximum heat rate [W] that can be supplied to the water, probably the same as the
"nominal" capacity. This field is autosizable if used with a Water Heater:Sizing object.
Field: Heater Minimum Capacity
The minimum heat rate [W] that can be supplied to the water. This field is only used when the
Heater Control Type is Modulate. If the total demand rate for heating is less than the
minimum, even a modulating water heater will begin to cycle.
Field: Heater Ignition Minimum Flow Rate
NOT YET IMPLEMENTED.
Field: Heater Ignition Delay
NOT YET IMPLEMENTED.
Field: Heater Fuel Type
The type of fuel used for heating. The fuel type can be Electricity, NaturalGas, PropaneGas,
FuelOil#1, FuelOil#2, Coal, Diesel, Gasoline, Steam, OtherFuel1, OtherFuel2 or
DistrictHeating.

9/29/14

687

Input-Output Reference

Group Water Heaters

Field: Heater Thermal Efficiency

The thermal conversion efficiency from fuel energy to heat energy for the heater element or
burner. This is not the same as the overall efficiency of the water heater.
Field: Part Load Factor Curve Name
The reference to the curve object that relates the overall efficiency of the water heater to the
Runtime Fraction (if Control Type Cycle) or Part Load Ratio (if Control Type Modulate). This
is an additional multiplier applied to the Heater Thermal Efficiency to compute fuel energy
use. The Part Load Factor Curve should not have a value less than 0.1 in the domain from 0
to 1. If the Part Load Factor Curve accounts for ambient losses and/or parasitic fuel
consumption, these effects should not also be input into the related fields in this object as that
would result in double-counting.
Field: Off-Cycle Parasitic Fuel Consumption Rate
Off-cycle parasitics include parts of the water heater that consume fuel when the heater is off,
for example, a pilot light, or stand-by electronic control circuits. The fuel consumption rate [W]
is strictly the total fuel that is consumed by all of the off-cycle parasitics.
Field: Off-Cycle Parasitic Fuel Type
The type of fuel used by the off-cycle parasitics. The fuel type can be Electricity, NaturalGas,
PropaneGas, FuelOil#1, FuelOil#2, Coal, Diesel, Gasoline, Steam, OtherFuel1, OtherFuel2
or DistrictHeating. The fuel type can be the same or different from the Heater Fuel Type.
Field: Off-Cycle Parasitic Heat Fraction to Tank
The fraction of off-cycle parasitic fuel energy that is converted to heat energy that ends up in
the tank water. For example, a pilot light would deliver most of its heat to the tank water, as
long as the thermal conversion efficiency must be taken into account, so perhaps 0.80 is
reasonable. Electronic control circuits, on the other hand, do not add any heat to the tank and
should be 0.
Field: On-Cycle Parasitic Fuel Consumption Rate
On-cycle parasitics include parts of the water heater that consume fuel when the heater is on,
for example, an induction fan, or stand-by electronic control circuits. The fuel consumption
rate [W] is strictly the total fuel that is consumed by all of the on-cycle parasitics.
Field: On-Cycle Parasitic Fuel Type
The type of fuel used by the on-cycle parasitics. The fuel type can be Electricity, NaturalGas,
PropaneGas, FuelOil#1, FuelOil#2, Coal, Diesel, Gasoline, Steam, OtherFuel1, OtherFuel2
or DistrictHeating. The fuel type can be the same or different from the Heater Fuel Type.
Field: On-Cycle Parasitic Heat Fraction to Tank
The fraction of on-cycle parasitic fuel energy that is converted to heat energy that ends up in
the tank water. For example, an induction fan might (maybe) deliver a small fraction of its
energy to the tank water for a value of 0.05. Electronic control circuits, on the other hand, do
not add any heat to the tank and should be 0.
Field: Ambient Temperature Indicator
The Ambient Temperature Indicator specifies how the ambient air temperature will be
indicated. The field can be Schedule, Zone, or Outdoors. If Schedule is used, the Ambient
Temperature Schedule field provides the ambient temperature. If Zone is used, the zone air
temperature of the zone specified in the Ambient Temperature Zone field provides the
ambient temperature. If Outdoors is used, the outdoor dry-bulb air temperature provides the
ambient temperature.

9/29/14

688

Input-Output Reference

Group Water Heaters

Field: Ambient Temperature Schedule Name

The reference to the schedule object specifying the ambient air temperature around the tank
for skin losses. This field is only used if Ambient Temperature Indicator is Schedule.
Field: Ambient Temperature Zone Name
The reference to the zone object specifying the ambient air temperature around the tank for
skin losses. This field is only used if Ambient Temperature Indicator is Zone.
Field: Ambient Temperature Outdoor Air Node Name
This optional alpha field specifies the outdoor air node name used to define the ambient
conditions surrounding the water heater tank. This field is applicable only when the Ambient
Temperature Indicator is specified as Outdoors, otherwise this field should be left blank. The
node name specified must also be specified in an OutdoorAir:Node object where the height of
the node is taken into consideration when calculating outdoor air conditions from the weather
data. Alternately, the node name may be specified in an OutdoorAir:NodeList object where
the outdoor air conditions are taken directly from the weather data.
Field: Off-Cycle Loss Coefficient to Ambient Temperature
The loss coefficient [W/K] to the ambient air temperature. Often this coefficient is identical to
the "UA" for skin losses. However, it can also be used to model the loss effects of the flue in a
combustion water heater, in addition to the skin losses.
Field: Off-Cycle Loss Fraction to Zone
If the Ambient Temperature Indicator is Zone, this field adds the specified fraction of the offcycle losses to the zone heat balance as an internal gain.
Field: On-Cycle Loss Coefficient to Ambient Temperature
The loss coefficient [W/K] to the ambient air temperature. Often this coefficient is identical to
the "UA" for skin losses. If the loss effects of the flue are being modeled in the Off-Cycle Loss
Coefficient, than this field would have a different value accounting only for the skin losses.
Field: On-Cycle Loss Fraction to Zone
If the Ambient Temperature Indicator is Zone, this field adds the specified fraction of the oncycle losses to the zone heat balance as an internal gain.
Field: Peak Use Flow Rate
The peak flow rate [m 3/s] of domestic hot water usage for stand-alone operation, i.e., without
plant loop node connections. The peak value is multiplied by the Use Flow Rate Fraction
Schedule. If there are node connections, this field is not used.
Field: Use Flow Rate Fraction Schedule Name
The reference to the schedule object specifiying the current fraction of Peak Volumetric Use
Flow Rate of domestic hot water usage for stand-alone operation.
Field: Cold Water Supply Temperature Schedule Name
The reference to the schedule object specifying the cold water temperature [C] from the
supply mains that makes up for the hot water lost down the drain. If blank, water
temperatures are calculated by the Site:WaterMainsTemperature object. This field is for
stand-alone operation only. If there are node connections, this field is not used.
Field: Use Side Inlet Node Name
The inlet node connection to the plant loop for the use side of the water heater. Typically the
use side draws hot water from the tank and returns cooler water.

9/29/14

689

Input-Output Reference

Group Water Heaters

Field: Use Side Outlet Node Name

The outlet node connection to the plant loop for the use side of the water heater. Typically the
use side draws hot water from the tank and returns cooler water.
Field: Use Side Effectiveness
This field specifies the heat transfer effectiveness between the use side water and the tank
water. If the effectiveness is set to 1 then complete heat transfer occurs, simulating perfect
mixing of the use side water and the tank water. If the effectiveness is lower, then the use
side outlet water temperature will not be as hot as the tank water, simulating a heat
exchanger.
Field: Source Side Inlet Node Name
The inlet node connection to the plant loop for the source side of the water heater. Typically
the source side draws cold water from the tank and returns warmer water. The source side
volume flow rate is obtained from the plant loop. The magnitude of the flow rates through the
source side can be controlled by setting the Maximum Branch Flow Rate field in the Branch
object that connects the source inlet node.
Field: Source Side Outlet Node Name
The outlet node connection to the plant loop for the source side of the water heater. Typically
the source side draws cold water from the tank and returns warmer water.
Field: Source Side Effectiveness
This field specifies the heat transfer effectiveness between the source side water and the
tank water. If the effectiveness is set to 1 then complete heat transfer occurs, simulating
perfect mixing of the source side water and the tank water. If the effectiveness is lower, then
the source side outlet water temperature will not be as hot as the tank water, simulating a
heat exchanger.
Field: Use Side Design Flow Rate
This field is optional and is used to specify the design flow rate through the Use Side of the
water heater. The volumetric design flow rate is specified in m 3/s. The field is needed when
the Use Side is connected to a plant loop. The field can be autosized. If autosized, then the
input file should include a Plant Sizing object for the plant loop. Sizing results are reported in
the EIO file.
Field: Source Side Design Flow Rate
This field is optional and is used to specify the design flow rate through the Source Side of
the water heater. The volumetric design flow rate is specified in m 3/s. The field is needed
when the Source Side is connected to a plant loop. The field can be autosized. If autosized,
then the input file should include a Plant Sizing object for the plant loop. Sizing results are
reported in the EIO file.
Field: Indirect Water Heating Recovery Time
This field is optional and is used to provide a design parameter for autosizing design flow
rates when the water heater is connected to the demand side of a plant loop. The recovery
time is expressed in hours. This is the time that the entire volume of the tank can be heated
from 14.4C to 57.2C (58F to 135F) with an inlet temperature defined as the exit
temperature in the associated Plant Sizing object. The default is 1.5 hours. The calculation
is based on log-mean temperature difference (LMTD) and includes the heat transfer
effectiveness factor entered above.
Field: Source Side Flow Control Mode
This field is optional and is used to provide control over the logic used by the source side of
the water heater to request flow. There are three choices for different modes:
9/29/14

690

Input-Output Reference

Group Water Heaters

IndirectHeatPrimarySetpoint, IndirectHeatAlternateSetpoint, or StorageTank.

The mode
called IndirectHeatPrimarySetpoint is the historical behavior prior to version 8.1. In this mode
the water heater will request flow at the source side when the main setpoint, in the input field
called Setpoint Temperature Schedule Name, and deadband call for the tank to be heated.
This mode is typical for a water heater indirectly heated by a boiler. The mode called
IndirectHeatAlternateSetpoint is similar but it bases its control decisions on an alternate
setpoint given in the following field. This mode is useful when the indirect source of heat may
not satisfy the load and an internal heater is used for backup. The mode called StorageTank
is for a passive tank and it always requests flow unless the tank temperature is equal to or
higher than the maximum limit given in the input field called Maximum Temperature Limit.
Field: Indirect Alternate Setpoint Temperature Schedule Name
This field is optional and is used to provide a schedule with alternate setpoints for use with
the IndirectHeatAlternateSetpoint mode in the previous field. The input field should contain a
reference to a schedule object specifying the hot water temperature setpoint [C] to use as
the "cut-out" temperature for control logic at the source side.
WaterHeater:Mixed,
! Stand-alone electric, outdoor example
Outdoor Electric Tank, !- Name
0.151, !- Tank Volume {m3}
Hot Water Setpoint Temp Schedule, !- Setpoint Temperature Schedule
2.0, !- Deadband Temperature Difference {deltaC}
82.2222, !- Maximum Temperature Limit {C}
Cycle, !- Heater Control Type {Cycle | Modulate}
11712, !- Heater Maximum Capacity {W}
, !- Heater Minimum Capacity {W}
, !- Heater Ignition Minimum Flow Rate {m3/s}
, !- Heater Ignition Delay {s}
ELECTRICITY, !- Heater Fuel Type
0.95, !- Heater Thermal Efficiency
, !- Part Load Factor Curve
15, !- Off-Cycle Parasitic Fuel Consumption Rate {W}
ELECTRICITY, !- Off-Cycle Parasitic Fuel Type
0, !- Off-Cycle Parasitic Heat Fraction To Tank
15, !- On-Cycle Parasitic Fuel Consumption Rate {W}
ELECTRICITY, !- On-Cycle Parasitic Fuel Type
0, !- On-Cycle Parasitic Heat Fraction To Tank
Outdoors, !- Ambient Temperature Indicator {Schedule | Zone | Outdoors}
, !- Ambient Temperature Schedule
, !- Ambient Temperature Zone
2.36, !- Off-Cycle Loss Coefficient To Ambient Temperature {W/K}
, !- Off-Cycle Loss Fraction To Zone
2.36, !- On-Cycle Loss Coefficient To Ambient Temperature {W/K}
, !- On-Cycle Loss Fraction To Zone
0.000379, !- Peak Volumetric Use Flow Rate {m3/s}
Hot Water Demand Schedule, !- Use Flow Rate Fraction Schedule
Constant Mains Temp Schedule; !- Cold Water Supply Temperature Schedule

9/29/14

691

Input-Output Reference

Group Water Heaters

WaterHeater:Mixed,
! Stand-alone electric, tankless example
Tankless, !- Name
0.003785, !- Tank Volume {m3}
Hot Water Setpoint Temp Schedule, !- Setpoint Temperature Schedule
, !- Deadband Temperature Difference {deltaC}
82.2222, !- Maximum Temperature Limit {C}
Modulate, !- Heater Control Type {Cycle | Modulate}
11712, !- Heater Maximum Capacity {W}
0, !- Heater Minimum Capacity {W}
, !- Heater Ignition Minimum Flow Rate {m3/s}
, !- Heater Ignition Delay {s}
ELECTRICITY, !- Heater Fuel Type
0.95, !- Heater Thermal Efficiency
, !- Part Load Factor Curve
10, !- Off-Cycle Parasitic Fuel Consumption Rate {W}
ELECTRICITY, !- Off-Cycle Parasitic Fuel Type
0, !- Off-Cycle Parasitic Heat Fraction To Tank
30, !- On-Cycle Parasitic Fuel Consumption Rate {W}
ELECTRICITY, !- On-Cycle Parasitic Fuel Type
0, !- On-Cycle Parasitic Heat Fraction To Tank
Schedule, !- Ambient Temperature Indicator {Schedule | Zone | Outdoors}
Hot Water Ambient Temp Schedule, !- Ambient Temperature Schedule
, !- Ambient Temperature Zone
, !- Off-Cycle Loss Coefficient To Ambient Temperature {W/K}
, !- Off-Cycle Loss Fraction To Zone
, !- On-Cycle Loss Coefficient To Ambient Temperature {W/K}
, !- On-Cycle Loss Fraction To Zone
0.000379, !- Peak Volumetric Use Flow Rate {m3/s}
Hot Water Demand Schedule, !- Use Flow Rate Fraction Schedule
; !- Cold Water Supply Temperature Schedule

WaterHeater:Mixed,
! Plant loop connected, gas example
Water Heater, !- Name
0.454, !- Tank Volume {m3}
Hot Water Setpoint Temp Schedule, !- Setpoint Temperature Schedule
5.0, !- Deadband Temperature Difference {deltaC}
82.2222, !- Maximum Temperature Limit {C}
Cycle, !- Heater Control Type {Cycle | Modulate}
2000, !- Heater Maximum Capacity {W}
, !- Heater Minimum Capacity {W}
, !- Heater Ignition Minimum Flow Rate {m3/s}
, !- Heater Ignition Delay {s}
NATURALGAS, !- Heater Fuel Type
0.80, !- Heater Thermal Efficiency
, !- Part Load Factor Curve
, !- Off-Cycle Parasitic Fuel Consumption Rate {W}
, !- Off-Cycle Parasitic Fuel Type
, !- Off-Cycle Parasitic Heat Fraction To Tank
, !- On-Cycle Parasitic Fuel Consumption Rate {W}
, !- On-Cycle Parasitic Fuel Type
, !- On-Cycle Parasitic Heat Fraction To Tank
Schedule, !- Ambient Temperature Indicator {Schedule | Zone | Outdoors}
Hot Water Ambient Temp Schedule, !- Ambient Temperature Schedule
, !- Ambient Temperature Zone
5.0, !- Off-Cycle Loss Coefficient To Ambient Temperature {W/K}
, !- Off-Cycle Loss Fraction To Zone
5.0, !- On-Cycle Loss Coefficient To Ambient Temperature {W/K}
, !- On-Cycle Loss Fraction To Zone
, !- Peak Volumetric Use Flow Rate {m3/s}
, !- Use Flow Rate Fraction Schedule
, !- Cold Water Supply Temperature Schedule
Water Heater Use Inlet Node, !- Use Side Inlet Node
Water Heater Use Outlet Node, !- Use Side Outlet Node
1.0, !- Use Side Effectiveness
Water Heater Source Inlet Node, !- Source Side Inlet Node
Water Heater Source Outlet Node, !- Source Side Outlet Node
1.0; !- Source Side Effectiveness

9/29/14

692

Input-Output Reference

Group Water Heaters

WaterHeater:Mixed,
Indirect Water Heater,
!- Name
1.00,
!- Tank Volume {m3}
Hot Water Setpoint Temperature Schedule, !- Setpoint Temperature Schedule
5.0,
!- Deadband Temperature Difference {deltaC}
82.2222,
!- Maximum Temperature Limit {C}
Cycle,
!- Heater Control Type
0.0,
!- Heater Maximum Capacity {W}
,
!- Heater Minimum Capacity {W}
,
!- Heater Ignition Minimum Flow Rate {m3/s}
,
!- Heater Ignition Delay {s}
ELECTRICITY,
!- Heater Fuel Type
0.8,
!- Heater Thermal Efficiency
,
!- Part Load Factor Curve
,
!- Off-Cycle Parasitic Fuel Consumption Rate {W}
,
!- Off-Cycle Parasitic Fuel Type
,
!- Off-Cycle Parasitic Heat Fraction To Tank
,
!- On-Cycle Parasitic Fuel Consumption Rate {W}
,
!- On-Cycle Parasitic Fuel Type
,
!- On-Cycle Parasitic Heat Fraction To Tank
Zone,
!- Ambient Temperature Indicator
,
!- Ambient Temperature Schedule
SPACE5-1,
!- Ambient Temperature Zone
,
!- Ambient Temperature Outside Air Node
5.0,
!- Off-Cycle Loss Coefficient To Ambient Temperature {W/K}
,
!- Off-Cycle Loss Fraction To Zone
5.0,
!- On-Cycle Loss Coefficient To Ambient Temperature {W/K}
,
!- On-Cycle Loss Fraction To Zone
,
!- Peak Volumetric Use Flow Rate {m3/s}
,
!- Use Flow Rate Fraction Schedule
,
!- Cold Water Supply Temperature Schedule
SHWSys1 Pump-SHWSys1 Water HeaterNode, !- Use Side Inlet Node
SHWSys1 Supply Equipment Outlet Node, !- Use Side Outlet Node
1.0,
!- Use Side Effectiveness
Indirect Water Heater SrcSideInletNode, !- Source Side Inlet Node
Indirect Water Heater SrcSideOutletNode, !- Source Side Outlet Node
0.9,
!- Source Side Effectiveness
autosize,
!- Use Side Design Flow Rate
autosize,
!- Source Side Design Flow Rate
1.0;
!- Indirect Water Heating Recovery Time

Mixed Water Heater Outputs

The following output variables are reported for the WaterHeater:Mixed object:
HVAC,Average,Water Heater Tank Temperature [C]
HVAC,Average,Water Heater Final Tank Temperature [C]
HVAC,Average,Water Heater Heat Loss Rate [W]
HVAC,Sum,Water Heater Heat Loss Energy [J]
HVAC,Average, Water Heater Use Side Mass Flow Rate [kg/s]
HVAC,Average,Water Heater Use Side Inlet Temperature [C]
HVAC,Average,Water Heater Use Side Outlet Temperature [C]
HVAC,Average,Water Heater Use Side Heat Transfer Rate [W]
HVAC,Sum,Water Heater Use Side Heat Transfer Energy [J]
HVAC,Average,Water Heater Source Side Mass Flow Rate [kg/s]
HVAC,Average,Water Heater Source Side Inlet Temperature [C]
HVAC,Average,Water Heater Source Side Outlet Temperature [C]
HVAC,Average,Water Heater Source Side Heat Transfer Rate [W]
HVAC,Sum,Water Heater Source Side Heat Transfer Energy [J]
HVAC,Average,Water Heater Off Cycle Parasitic Tank Heat Transfer Rate [W]
HVAC,Sum,Water Heater Off Cycle Parasitic Tank Heat Transfer Energy [J]
HVAC,Average,Water Heater On Cycle Parasitic Tank Heat Transfer Rate [W]
HVAC,Sum,Water Heater On Cycle Parasitic Tank Heat Transfer Energy [J]
HVAC,Average,Water Heater Total Demand Heat Transfer Rate [W]
HVAC,Sum,Water Heater Total Demand Energy [J]
HVAC,Average,Water Heater Heating Rate [W]
HVAC,Sum,Water Heater Heating Energy [J]
HVAC,Average,Water Heater Unmet Demand Heat Transfer Rate [W]
9/29/14

693

Input-Output Reference

Group Water Heaters

HVAC,Sum,Water Heater Unmet Demand Heat Transfer Energy [J]

HVAC,Average,Water Heater Venting Heat Transfer Rate [W]
HVAC,Sum,Water Heater Venting Heat Transfer Energy [J]
HVAC,Average,Water Heater Net Heat Transfer Rate [W]
HVAC,Sum,Water Heater Net Heat Transfer Energy [J]
HVAC,Sum,Water Heater Cycle On Count []
HVAC,Average,Water Heater Runtime Fraction []
HVAC,Average,Water Heater Part Load Ratio []
HVAC,Average,Water Heater Electric Power [W]
HVAC,Average,Water Heater <Fuel Type> Rate [W]
HVAC,Sum,Water Heater <Fuel Type> Energy [J]
HVAC,Average,Water Heater Off Cycle Parasitic <Fuel Type> Rate [W]
HVAC,Sum,Water Heater Off Cycle Parasitic <Fuel Type> Energy [J]
HVAC,Average,Water Heater On Cycle Parasitic <Fuel Type> Rate [W]
HVAC,Sum,Water Heater On Cycle Parasitic <Fuel Type> Energy [J]
HVAC,Average,Water Heater Water Volume Flow Rate [m3/s]
HVAC,Sum,Water Heater Water Volume [m3]

Water Heater Tank Temperature [C]

The average water tank temperature.
Water Heater Final Tank Temperature [C]
The final water tank temperature at the end of the system timestep. If reported at the
"Detailed" interval, this output variable can be used to verify an exact energy balance on the
water heater. Also see the output variable: Water Heater Net Heat Transfer Energy.
Water Heater Heat Loss Rate [W]
The average heat loss rate due to the off- and on-cycle loss coefficients to the ambient
temperature.
Water Heater Heat Loss Energy [J]
The heat loss energy due to the off- and on-cycle loss coefficients to the ambient
temperature.
Water Heater Use Side Mass Flow Rate [kg/s]
The use side mass flow rate. If stand-alone, this is the scheduled use flow rate.
Water Heater Use Side Inlet Temperature [C]
The inlet temperature on the use side.
Water Heater Use Side Outlet Temperature [C]
The outlet temperature on the use side.
Water Heater Use Side Heat Transfer Rate [W]
The average heat transfer rate between the use side water and the tank water.
Water Heater Use Side Heat Transfer Energy [J]
The heat transfer energy between the use side water and the tank water.
Water Heater Source Side Mass Flow Rate [kg/s]
The source side mass flow rate. If in stand-alone operation, this is 0.
Water Heater Source Side Inlet Temperature [C]
The inlet temperature on the source side.

9/29/14

694

Input-Output Reference

Group Water Heaters

Water Heater Source Side Outlet Temperature [C]

The outlet temperature on the source side.
Water Heater Source Side Heat Transfer Rate [W]
The average heat transfer rate between the source side water and the tank water.
Water Heater Source Side Heat Transfer Energy [J]
The heat transfer energy between the source side water and the tank water.
Water Heater Off Cycle Parasitic Tank Heat Transfer Rate [W]
The average heat gain rate to the tank water due to off-cycle parasitics.
Water Heater Off Cycle Parasitic Tank Heat Transfer Energy [J]
The heat gain energy to the tank water due to off-cycle parasitics.
Water Heater On Cycle Parasitic Tank Heat Transfer Rate [W]
The average heat gain rate to the tank water due to on-cycle parasitics.
Water Heater On Cycle Parasitic Tank Heat Transfer Energy [J]
The heat gain energy to the tank water due to on-cycle parasitics.
Water Heater Total Demand Heat Transfer Rate [W]
The average heating rate demanded to maintain the setpoint temperature.
Water Heater Total Demand Energy [J]
The heating energy demanded to maintain the setpoint temperature.
Water Heater Heating Rate [W]
The average heating rate supplied by the heater element or burner.
Water Heater Heating Energy [J]
The heating energy supplied by the heater element or burner.
Water Heater Unmet Demand Heat Transfer Rate [W]
The average heating rate unmet by the heater element or burner. The difference between the
Total Demand Rate and the Heating Rate.
Water Heater Unmet Demand Heat Transfer Energy [J]
The heating energy unmet by the heater element or burner. The difference between the Total
Demand Energy and the Heating Energy.
Water Heater Venting Heat Transfer Rate [W]
The average venting rate to keep the tank below the Maximum Temperature Limit.
Water Heater Venting Heat Transfer Energy [J]
The venting energy to keep the tank below the Maximum Temperature Limit.
Water Heater Net Heat Transfer Rate [W]
The average net heat transfer rate when considering all losses and gains.
Water Heater Net Heat Transfer Energy [J]
The net heat transfer energy when considering all losses and gains.

9/29/14

695

Input-Output Reference

Group Water Heaters

Water Heater Cycle On Count []

The number of times that the heater turned on in the time period.
Water Heater Runtime Fraction []
The fraction of the time period that the heater was running.
Water Heater Part Load Ratio []
The fraction of the Heater Maximum Capacity.
Water Heater <Fuel Type> Rate [W]
Water Heater Electric Power [W]
The average fuel consumption rate for the heater element or burner.
Water Heater <Fuel Type> Energy [J]
The fuel consumption energy for the heater element or burner.
Water Heater Off Cycle Parasitic <Fuel Type> Rate [W]
Water Heater Off Cycle Parasitic Electric Power [W]
The average fuel consumption rate for the off-cycle parasitics.
Water Heater Off Cycle Parasitic <Fuel Type> Energy [J]
The fuel consumption energy for the off-cycle parasitics.
Water Heater On Cycle Parasitic <Fuel Type> Rate [W]
Water Heater On Cycle Parasitic Electric Power [W]
The average fuel consumption rate for the on-cycle parasitics.
Water Heater On Cycle Parasitic <Fuel Type> Energy [J]
The fuel consumption energy for the on-cycle parasitics.
Water Heater Water Volume Flow Rate [m3/s]
The water consumption rate for the use side, if in stand-alone operation.
Water Heater Water Volume [m3]
The water consumption for the use side, if in stand-alone operation.
Water Heater Mains Water Volume [m3]
The volume of water consumption drawn from mains water service.
WaterHeater:Stratified
The WaterHeater:Stratified object divides the water tank into multiple nodes of equal volume.
The nodes are coupled by vertical conduction effects, internode fluid flow, and temperature
inversion mixing. The object simultaneously solves the differential equations governing the
energy balances on the nodes using a numerical method. The system timestep is divided into
many small substeps that allow the simulation to capture events that occur on a very short
time scale. This approach allows ambient losses and parasitic loads to be divided into oncycle and off-cycle effects and accounted for in detail.
For losses to the ambient environment, the ambient air temperature can be taken from a
schedule, a zone, or the exterior. When used with a zone, a fraction of the skin losses can be
added to the zone heat balance as internal heat gains.
The WaterHeater:Stratified object allows two heating elements to be simulated. The two
elements can cycle on and off to maintain the node temperature within the deadband. The
9/29/14

696

Input-Output Reference

Group Water Heaters

Heater Priority Control field determines how the heaters work together. There are two
options: MasterSlave or Simultaneous. In the MasterSlave option, Heater 1 is the master and
Heater 2 is the slave. That is, both heaters are not allowed to turn on at the same time. If the
thermostats ask for heat at both Heater 1 and 2, only Heater 1 will turn on. Once Heater 1
has met the set point, it turns off and Heater 2 can turn on, if necessary. In the
Simultaneousoption, Heater 1 and Heater 2 can turn on and off independently. Autosizing is
available for only Heater 1.
Field: Name
The name of the WaterHeater:Stratified object.
Field: End-Use Subcategory
Allows you to specify a user-defined end-use subcategory, e.g., "Laundry", "Dish Washing",
etc. A new meter for reporting is created for each unique subcategory (ref: Output:Meter
objects). Subcategories are also reported in the ABUPS table under the "Water Systems"
end-use category. If this field is omitted or blank, the water use will be assigned to the
"General" end-use subcategory.
Field: Tank Volume
The actual volume [m3] of fluid in the tank. This field is autosizable if used with a Water
Heater:Sizing object. The actual volume is typically not equal to the nominal volume
specified by the manufacturer. Actual volume is almost always 10% lower for electric water
heaters, and 5% lower for gas water heaters (Burch and Erickson 2004).
Burch, J., and P. Erickson. 2004. "Using Ratings Data to Derive Simulation-Model Inputs for
Storage-Tank Water Heaters". Proceedings of the Solar 2004 Conference, 11-14 July 2004,
Portland, Oregon, American Solar Energy Society (ASES), pp. 393-398.
Field: Tank Height
The height [m] of the tank. For the HorizontalCylinder shape (see below) the height of the
tank is the measure in the axial direction, i.e., the height if you were to stand the cylinder up
on its end. This field is autosizable if used with a Water Heater:Sizing object.
Field: Tank Shape
The tank shape determines the size and skin losses of the stratified nodes. There are three
options: VerticalCylinder, HorizontalCylinder, and Other.
VerticalCylinder describes most upright residential water heaters.
HorizontalCylinder describes a few specialty water heaters and large commercial storage
tanks. HorizontalCylinder can also be used to model an outdoor storage tank located above a
solar collector in a thermosiphon configuration. HorizontalCylinder implies that the tank is
divided into nodes of equal mass, but not equal height.
Other describes water heaters or storage tanks that have a uniform horizontal cross-section,
but are not cylinders, e.g., a cuboid or other shape. The length of the perimeter is then
specified by the Tank Perimeter field.
If blank, the default shape is VerticalCylinder.
Field: Tank Perimeter
The length of the tank perimeter [m]. This field is only used if Tank Shape is Other.
Field: Maximum Temperature Limit
The temperature [C] at which the tank water becomes dangerously hot and is vented
through boiling or an automatic safety. The tank temperature will never exceed the maximum.
Any extra heat added to the tank is immediately vented. Note: The maximum temperature
must be greater than the setpoint temperature at all times.

9/29/14

697

Input-Output Reference

Group Water Heaters

Field: Heater Priority Control

The heater priority control determines how Heater 1 and Heater 2 work together. There are
two options: MasterSlave or Simultaneous. In the MasterSlave option, Heater 1 is the
master and Heater 2 is the slave. In most residential electric water heaters, the heaters
operate in a MasterSlave relationship. That is, both heaters are not allowed to turn on at the
same time. If the thermostats ask for heat at both Heater 1 and 2, only Heater 1 will turn on.
Once Heater 1 has met the set point, it turns off and Heater 2 can turn on, if necessary. In
other words, only one heater can be on at any time, and Heater 1 is always has priority over
Heater 2.
In the Simultaneous option, Heater 1 and Heater 2 can turn on and off independently.
If blank, the default is MasterSlave.
Field: Heater 1 Set Point Temperature Schedule Name
The reference to the schedule object specifying the hot water temperature set point [C] for
Heater 1. Also known as the "cut-out" temperature.
Field: Heater 1 Deadband Temperature Difference
The delta temperature difference [C] between the set point and the "cut-in" temperature at
which Heater 1 will turn on. In other words, the "cut-in" temperature is Set Point Deadband.
Field: Heater 1 Capacity
The heat rate [W] supplied to the water for Heater 1, probably the same as the "nominal"
capacity. For residential electric water heaters, heating elements are usually 4500 W. This
field is autosizable if used with a Water Heater:Sizing object.
Field: Heater 1 Height
The height [m] of Heater 1 in the tank.
Field: Heater 2 Set Point Temperature Schedule Name
The reference to the schedule object specifying the hot water temperature set point [C] for
Heater 2. Also known as the "cut-out" temperature.
Field: Heater 2 Deadband Temperature Difference
The delta temperature difference [C] between the set point and the "cut-in" temperature at
which Heater 2 will turn on. In other words, the "cut-in" temperature is Set Point Deadband.
Field: Heater 2 Capacity
The heat rate [W] supplied to the water for Heater 1, probably the same as the "nominal"
capacity. For residential electric water heaters, heating elements are usually 4500 W.
Field: Heater 2 Height
The height [m] of Heater 2 in the tank.
Field: Heater Fuel Type
The type of fuel used for both Heaters 1 and 2. The fuel type can be Electricity, NaturalGas,
PropaneGas, FuelOil#1, FuelOil#2, Coal, Diesel, Gasoline, Steam, OtherFuel1, OtherFuel2
or DistrictHeating.
Field: Heater Thermal Efficiency
The thermal conversion efficiency from fuel energy to heat energy for the heater element or
burner (for both Heaters 1 and 2). This is not the same as the overall efficiency of the water
heater.

9/29/14

698

Input-Output Reference

Group Water Heaters

Field: Off-Cycle Parasitic Fuel Consumption Rate

Off-cycle parasitics include parts of the water heater that consume fuel when the heater is off,
for example, a pilot light, or stand-by electronic control circuits. The fuel consumption rate [W]
is strictly the total fuel that is consumed by all of the off-cycle parasitics.
Field: Off-Cycle Parasitic Fuel Type
The type of fuel used by the off-cycle parasitics. The fuel type can be Electricity, NaturalGas,
PropaneGas, FuelOil#1, FuelOil#2, Coal, Diesel, Gasoline, Steam, OtherFuel1, OtherFuel2
or DistrictHeating. The fuel type can be the same or different from the Heater Fuel Type.
Field: Off-Cycle Parasitic Heat Fraction to Tank
The fraction of off-cycle parasitic fuel energy that is converted to heat energy that ends up in
the tank water. For example, a pilot light would deliver most of its heat to the tank water, as
long as the thermal conversion efficiency must be taken into account, so perhaps 0.80 is
reasonable. Electronic control circuits, on the other hand, do not add any heat to the tank and
should be 0.
Field: Off-Cycle Parasitic Height
The height [m] where any off-cycle parasitic heat gains are added to the tank.
Field: On-Cycle Parasitic Fuel Consumption Rate
On-cycle parasitics include parts of the water heater that consume fuel when the heater is on,
for example, an induction fan, or stand-by electronic control circuits. The fuel consumption
rate [W] is strictly the total fuel that is consumed by all of the on-cycle parasitics.
Field: On-Cycle Parasitic Fuel Type
The type of fuel used by the on-cycle parasitics. The fuel type can be Electricity, NaturalGas,
PropaneGas, FuelOil#1, FuelOil#2, Coal, Diesel, Gasoline, Steam, OtherFuel1, OtherFuel2
or DistrictHeating. The fuel type can be the same or different from the Heater Fuel Type.
Field: On-Cycle Parasitic Heat Fraction to Tank
The fraction of on-cycle parasitic fuel energy that is converted to heat energy that ends up in
the tank water. For example, an induction fan might (maybe) deliver a small fraction of its
energy to the tank water for a value of 0.05. Electronic control circuits, on the other hand, do
not add any heat to the tank and should be 0.
Field: On-Cycle Parasitic Height
The height [m] where any on-cycle parasitic heat gains are added to the tank.
Field: Ambient Temperature Indicator
The Ambient Temperature Indicator specifies how the ambient air temperature will be
indicated. The field can be Schedule, Zone, or Outdoors. If Schedule is used, the Ambient
Temperature Schedule value provides the ambient temperature. If Zone is used, the zone air
temperature of the zone specified in the Ambient Temperature Zone field provides the
ambient temperature. If Outdoors is used, the outdoor dry-bulb air temperature of the
outdoor air node specified in the Ambient Temperature OutdoorAir:Node field provides the
ambient temperature.
Field: Ambient Temperature Schedule Name
The reference to the schedule object specifying the ambient air temperature around the tank
for skin losses. This field is only used if Ambient Temperature Indicator is Schedule.

9/29/14

699

Input-Output Reference

Group Water Heaters

Field: Ambient Temperature Zone

The reference to the zone object specifying the ambient air temperature around the tank for
skin losses. This field is only used if Ambient Temperature Indicator is Zone.
Field: Ambient Temperature Outdoor Air Node
The reference to the outdoor air node specifying the ambient air temperature around the tank
for skin losses. An outdoor air node can be defined by an OutdoorAir:Node object or
OutdoorAir:NodeList object. This field is only used if Ambient Temperature Indicator is
Outdoors.
Field: Uniform Skin Loss Coefficient Per Unit Area to Ambient Temperature
The uniform skin loss coefficient [W/m2-K] or U-Value of the tank to the ambient air
temperature. The uniform skin loss accounts for the tank insulation and applies during both
off- and on-cycle operation. The overall losses at any particular node can be further modified
using the Additional Loss Coefficient fields to account for thermal shorting due to pipe
penetrations, water heater feet, and any other loss effects.
Field: Skin Loss Fraction to Zone
If the Ambient Temperature Indicator is Zone, this field adds the specified fraction of the skin
losses to the zone heat balance as an internal gain.
Field: Off-Cycle Flue Loss Coefficient to Ambient Temperature
The off-cycle flue loss coefficient [W/K] to the ambient air temperature. This field mainly
applies to gas water heaters that have a flue.
Field: Off-Cycle Flue Loss Fraction to Zone
If the Ambient Temperature Indicator is Zone, this field adds the specified fraction of the offcycle flue losses to the zone heat balance as an internal gain.
Field: Peak Use Flow Rate
The peak flow rate [m 3/s] of domestic hot water usage for stand-alone operation, i.e., without
plant loop node connections. The peak value is multiplied by the Use Flow Rate Fraction
Schedule. If there are node connections, this field is not used.
Field: Use Flow Rate Fraction Schedule Name
The reference to the schedule object specifiying the current fraction of Peak Volumetric Use
Flow Rate of domestic hot water usage for stand-alone operation. If blank, the fraction
defaults to 1.0 at all times.
Field: Cold Water Supply Temperature Schedule Name
The reference to the schedule object specifying the cold water temperature [C] from the
supply mains that makes up for the hot water lost down the drain. If blank, water
temperatures are calculated by the Site:WaterMainsTemperature object. This field is for
stand-alone operation only. If there are node connections, this field is not used.
Field: Use Side Inlet Node Name
The inlet node connection to the plant loop for the use side of the water heater. Typically the
use side draws hot water from the tank and returns cooler water.
Field: Use Side Outlet Node Name
The outlet node connection to the plant loop for the use side of the water heater. Typically the
use side draws hot water from the tank and returns cooler water.

9/29/14

700

Input-Output Reference

Group Water Heaters

Field: Use Side Effectiveness

This field specifies the heat transfer effectiveness between the use side water and the tank
water. If the effectiveness is set to 1 then complete heat transfer occurs, simulating perfect
mixing of the use side water and the tank water. If the effectiveness is less than 1.0, then the
use side outlet water temperature will not be as hot as the tank water at the outlet node,
simulating an external heat exchanger that is indirectly coupled to the water heater tank.
Field: Use Side Inlet Height
The height of the use side inlet to the tank. If blank, the inlet defaults to the bottom of the
tank. The inlet height cannot be higher than the tank height.
Field: Use Side Outlet Height
The height of the use side outlet from the tank. If blank or autocalculate, the inlet defaults to
the top of the tank. The outlet height cannot be higher than the tank height.
Field: Source Side Inlet Node
The inlet node connection to the plant loop for the source side of the water heater. Typically
the source side draws cold water from the tank and returns warmer water.
Field: Source Side Outlet Node
The outlet node connection to the plant loop for the source side of the water heater. Typically
the source side draws cold water from the tank and returns warmer water.
Field: Source Side Effectiveness
This field specifies the heat transfer effectiveness between the source side water and the
tank water. If the effectiveness is set to 1 then complete heat transfer occurs, simulating
perfect mixing of the source side water and the tank water. If the effectiveness is less than
1.0, then the source side outlet water temperature will be higher than the tank water at the
outlet node, simulating an external heat exchanger that is indirectly coupled to the water
heater tank.
Field: Source Side Inlet Height
The height of the source side inlet to the tank. If blank or autocalculate, the inlet defaults to
the top of the tank. The inlet height cannot be higher than the tank height.
Field: Source Side Outlet Height
The height of the source side outlet from the tank. If blank, the inlet defaults to the bottom of
the tank. The outlet height cannot be higher than the tank height.
Field: Inlet Mode
The inlet mode of entering fluid from the use and source sides. There are two options: Fixed
or Seeking. In Fixed mode, the fluid enters at the fixed heights specified above. In Seeking
mode, the fluid "seeks out" the stratified node that is closest to the inlet temperature and adds
all flow to that node. The Seekingbmode provides maximum stratification. The default is
Fixed.
Field: Use Side Design Flow Rate
This field is optional and is used to specify the design flow rate through the Use Side of the
water heater. The volumetric design flow rate is specified in m 3/s. The field is needed when
the Use Side is connected to a plant loop. The field can be autosized. If autosized, then the
input file should include a Plant Sizing object for the plant loop. Sizing results are reported in
the EIO file.

9/29/14

701

Input-Output Reference

Group Water Heaters

Field: Source Side Design Flow Rate

This field is optional and is used to specify the design flow rate through the Source Side of
the water heater. The volumetric design flow rate is specified in m 3/s. The field is needed
when the Source Side is connected to a plant loop. The field can be autosized. If autosized,
then the input file should include a Plant Sizing object for the plant loop. Sizing results are
reported in the EIO file.
Field: Indirect Water Heating Recovery Time
This field is optional and is used to provide a design parameter for autosizing design flow
rates when the water heater is connected to the demand side of a plant loop. The recovery
time is expressed in hours. This is the time that the entire volume of the tank can be heated
from 14.4C to 57.2C (58F to 135F) with an inlet temperature defined as the exit
temperature in the associated Plant Sizing object. The default is 1.5 hours. The calculation
is based on log-mean temperature difference (LMTD) and includes the heat transfer
effectiveness factor entered above.
Field: Number Of Nodes
The number of stratified nodes in the tank. There must be at least one node. The maximum
number of nodes is 10, although this limit can be increased by editing the IDD.
Field: Additional Destratification Conductivity
An additional destratification conductivity [W/m-K] is added to the fluid conductivity of water
(0.6 W/m-K) to account for vertical conduction effects along the inside of the tank wall, and
perhaps other vertical components such as the flue, the cold water inlet pipe (dip tube), and
the anode rod.
Field: Node 1-10 Additional Loss Coefficient
An additional loss coefficient [W/m-K] added to the skin losses for a given node to account for
thermal shorting due to pipe penetrations, water heater feet, and any other loss effects.
Field: Source Side Flow Control Mode
This field is optional and is used to provide control over the logic used by the source side of
the water heater to request flow. There are three choices for different modes:
IndirectHeatPrimarySetpoint, IndirectHeatAlternateSetpoint, or StorageTank.
The mode
called IndirectHeatPrimarySetpoint is the historical behavior prior to version 8.1. In this mode
the water heater will request flow at the source side when the main setpoint, in the input field
called Setpoint Temperature Schedule Name, and deadband call for the tank to be heated.
This mode is typical for a water heater indirectly heated by a boiler. The mode called
IndirectHeatAlternateSetpoint is similar but it bases its control decisions on an alternate
setpoint given in the following field. This mode is useful when the indirect source of heat may
not satisfy the load and an internal heater is used for backup. The mode called StorageTank
is for a passive tank and it always requests flow unless the tank temperature is equal to or
higher than the maximum limit given in the input field called Maximum Temperature Limit.
Field: Indirect Alternate Setpoint Temperature Schedule Name
This field is optional and is used to provide a schedule with alternate setpoints for use with
the IndirectHeatAlternateSetpoint mode in the previous field. The input field should contain a
reference to a schedule object specifying the hot water temperature setpoint [C] to use as
the "cut-out" temperature for control logic at the source side.

9/29/14

702

Input-Output Reference

Group Water Heaters

WaterHeater:Stratified,
Electric Water Heater, !- Name
Water Heater, !- End-Use Subcategory
0.1893, !- Tank Volume {m3}
1.4, !- Tank Height {m}
VerticalCylinder, !- Tank Shape
, !- Tank Perimeter {m}
82.2222, !- Maximum Temperature Limit {C}
MasterSlave, !- Heater Priority
Hot Water Set Point Temp Schedule, !- Heater 1 Set Point Temperature Schedule
2.0, !- Heater 1 Deadband Temperature Difference {deltaC}
4500, !- Heater 1 Capacity {W}
(Master)
1.0, !- Heater 1 Height {m}
Hot Water Set Point Temp Schedule, !- Heater 2 Set Point Temperature Schedule
5.0, !- Heater 2 Deadband Temperature Difference {deltaC}
4500, !- Heater 2 Capacity {W}
(Slave)
0.0, !- Heater 2 Height {m}
ELECTRICITY, !- Heater Fuel Type
0.98, !- Heater Thermal Efficiency
10, !- Off-Cycle Parasitic Fuel Consumption Rate {W}
ELECTRICITY, !- Off-Cycle Parasitic Fuel Type
0, !- Off-Cycle Parasitic Heat Fraction To Tank
, !- Off-Cycle Parasitic Height {m}
10, !- On-Cycle Parasitic Fuel Consumption Rate {W}
ELECTRICITY, !- On-Cycle Parasitic Fuel Type
0, !- On-Cycle Parasitic Heat Fraction To Tank
, !- On-Cycle Parasitic Height {m}
SCHEDULE, !- Ambient Temperature Indicator
Ambient Temp Schedule, !- Ambient Temperature Schedule
, !- Ambient Temperature Zone
, !- Ambient Temperature Outdoor Air Node
0.846, !- Uniform Skin Loss Coefficient Per Unit Area To Ambient Temperature {W/m2-K}
, !- Skin Loss Fraction To Zone {}
, !- Off-Cycle Flue Loss Coefficient To Ambient Temperature {W/K}
, !- Off-Cycle Flue Loss Fraction To Zone {}
, !- Peak Volumetric Use Flow Rate {m3/s}
, !- Use Flow Rate Fraction Schedule
, !- Cold Water Supply Temperature Schedule
Water Heater Use Inlet Node, !- Use Side Inlet Node
Water Heater Use Outlet Node, !- Use Side Outlet Node
1.0, !- Use Side Effectiveness {}
, !- Use Side Inlet Height {m}
, !- Use Side Outlet Height {m}
, !- Source Side Inlet Node
, !- Source Side Outlet Node
, !- Source Side Effectiveness {}
, !- Source Side Inlet Height {m}
, !- Source Side Outlet Height {m}
FIXED, !- Inlet Mode {FIXED | SEEKING}
6, !- Number Of Nodes
0.1, !- Destratification Conductivity {W/m-K}
0.15, !- Node 1 Additional Loss Coefficient {W/K}
, !- Node 2 Additional Loss Coefficient {W/K}
, !- Node 3 Additional Loss Coefficient {W/K}
, !- Node 4 Additional Loss Coefficient {W/K}
, !- Node 5 Additional Loss Coefficient {W/K}
0.1; !- Node 6 Additional Loss Coefficient {W/K}

Stratified Water Heater Outputs

All of the output variables reported for the WaterHeater:Mixed object also apply to the
WaterHeater:Stratified object, with several qualifications noted below:
Water Heater Tank Temperature [C]
The average water tank temperature, i.e., the average of all of the node average
temperatures.

9/29/14

703

Input-Output Reference

Group Water Heaters

Water Heater Final Tank Temperature [C]

The final water tank temperature at the end of the system timestep, i.e., the average of all of
the final node temperatures at the end of the system timestep. If reported at the "Detailed"
interval, this output variable can be used to verify an exact energy balance on the water
heater.
Water Heater Heating Rate [W]
The total average heating rate supplied by Heater 1 plus Heater 2.
Water Heater Heating Energy [J]
The total heating energy supplied by Heater 1 plus Heater 2.
Water Heater Cycle On Count []
The number of times that either Heater 1 or Heater 2 turned on in the time period.
Water Heater Runtime Fraction []
The fraction of the time period that either Heater 1 or Heater 2 was running.
In addition, the WaterHeater:Stratified object also reports the following output variables:
HVAC,Average,Water Heater Heater 1 Heating Rate [W]
HVAC,Average,Water Heater Heater 2 Heating Rate [W]
HVAC,Sum,Water Heater Heater 1 Heating Energy [J]
HVAC,Sum,Water Heater Heater 2 Heating Energy [J]
HVAC,Sum,Water Heater Heater 1 Cycle On Count []
HVAC,Sum,Water Heater Heater 2 Cycle On Count []
HVAC,Average,Water Heater Heater 1 Runtime Fraction []
HVAC,Average,Water Heater Heater 2 Runtime Fraction []
HVAC,Average,Water Heater Temperature Node <x> [C]
HVAC,Average,Water Heater Final Temperature Node <x> [C]

Water Heater Heater 1 Heating Rate [W]

The average heating rate supplied by Heater 1.
Water Heater Heater 2 Heating Rate [W]
The average heating rate supplied by Heater 2.
Water Heater Heater 1 Heating Energy [J]
The heating energy supplied by Heater 1.
Water Heater Heater 2 Heating Energy [J]
The heating energy supplied by Heater 2.
Water Heater Heater 1 Cycle On Count []
The number of times that Heater 1 turned on in the time period.
Water Heater Heater 2 Cycle On Count []
The number of times that Heater 2 turned on in the time period.
Water Heater Heater 1 Runtime Fraction []
The fraction of the time period that Heater 1 was running.
Water Heater Heater 2 Runtime Fraction []
The fraction of the time period that Heater 2 was running.
Water Heater Temperature Node 1-10 [C]
The average node temperature.
9/29/14

704

Input-Output Reference

Group Water Heaters

Water Heater Final Temperature Node 1-10 [C]

The final node temperature at the end of the system timestep.
WaterHeater:Sizing
The WaterHeater:Sizing object is used to provide additional input data needed for designing
tank volume and/or heater capacity for either the Mixed or Stratified water heaters. This
object is only needed if volume or capacity is being automatically sized. There are no output
variable associated with this object -- sizing results are reported to the EIO output file and
some predefined summary reports.
A source of design input data for use with this object can be found in the current ASHRAE
Handbook HVAC Applications chapter on Service Water Heating.
The idd entry for this object follows.
Field: WaterHeater Name
This field contains the unique name of the water heater being sized. This name should
match the name of a Water Heater:Mixed or a Water Heater:Stratified input object defined
elsewhere in the input file.
Field: Design Mode
This field describes which of several methods are to be used for sizing the water heater.
There are six possible choices and one of the following should be selected:
PeakDraw. This design method uses the design flow rates of all the different
demands placed on the water heater. The tank size is based on how long it can
meet the demand and how quickly it can recover. The user enters the time in hours
that the water heater can meet the demands. Only the hot water uses connected to
an individual water heater, or scheduled in the water heater object for stand-alone
units, are included in that water heaters peak draw.
ResidentialHUD-FHAMinimum This design method is based on minimum
permissible water heater sizes (established by HUD-FHA in its Minimum Property
Standards for One- and Two-Family Living Units, No. 4900.1-1982). The user enters
the number of bathrooms and bedrooms in this input object. The smallest allowable
water heater sizes are used.
PerPerson This design method scales sizes based on the total number of people in
all zones in the building. Each water heater in the model will be sized using the total
(peak, design) number of people for the entire model. The number of people is
determined from People objects defined elsewhere in the input file
PerFloorArea This design method scales sizes based on the total floor area in all the
zones in the building. Each water heater in the model will be sized using all the floor
area in the model. The floor areas are determined from the geometry input
elsewhere in the input file.
PerUnit This design method scales sizes based on an arbitrary number of units.
This can be used, for example, to size based on the number of rooms in a lodging
building. The user provides the number of units in an input field in this object.
PerSolarCollectorArea This design method scales tank volume based on the
collector area for a solar hot water collector. The collector area is summed for all the
collectors in the model and each tank is sized for the total. The collector area is
determined from input for Solar Collectors defined elsewhere in the input file.
Field: Time Storage Can Meet Peak Draw
This field provides the time, in hours, that the tanks volume can sustain a peak draw. It is
used to size the tanks volume which is the simple product of peak draw volume flow rate and
the draw time. There is no assurance that the water will be at the desired temperature for the
9/29/14

705

Input-Output Reference

Group Water Heaters

entire draw. This field is only used if the Design Mode is PeakDraw. For a water heater
connected to a full plant loop, it should be on the supply side and the plant loop needs a Plant
Sizing object and the draw rate is the Use side design flow rate. For a stand-alone water
heater, the draw rate is the maximum scheduled peak use flow rate.
Field: Time for Tank Recovery
This field provides the the time, in hours, that tanks heater needs to recover the volume of
the tank. The temperatures used to define recovery are a starting temperature of 14.4C
(58F) and a final temperature of 57.2C (135F). This field is only used if the Design Mode is
PeakDraw.
Field: Nominal Tank Volume for Autosizing Plant Connections
This field is used in case the water heater is indirectly heated by its source side connections
and they are also autosized. Because of the complexity of such a water heater and the
timing for when sizing calculation happen inside EnergyPlus, the Source side connection flow
rates need to be reported before the tanks volume can be sized to meet Peak Draw. This
input field is used to provide a nominal tank volume to use temporarily while the flow
connections are sized. This field is only used if the Design Mode is PeakDraw and the
water heater has autosized plant connections on the demand side.
Field: Number of Bedrooms
This field is used to enter the numer of bedrooms in the model. This field is only used if the
Design Mode is ResidentialHUD-FHAMinimum.
Field: Number of Bathrooms
This field is used to enter the number of bathrooms in the model. This field is only used if the
Design Mode is ResidentialHUD-FHAMinimum.
Field: Storage Capacity per Person
This field is used to enter the tanks storage volume on per-person basis. The units are
m3/person. This field is only used if the Design Mode is PerPerson.
Field: Recovery Capacity per Person
This field is used to enter the recovery capacity per person in units of m 3/person/hr. This is
the volume of water the heater can recover in one hour per person. Recovery is heating
water from a starting temperature of 14.4C (58F) to a final temperature of 57.2C (135F).
This field is only used if the Design Mode is PerPerson.
Field: Storage Capacity per Floor Area
This field is used to enter the tanks storage volume on a per-floor-area basis. The units are
m3 /m2 (water/floor area). This field is only used if the Design Mode is PerFloorArea.
Field: Recovery Capacity per Floor Area
This field is used to enter the recovery capacity per floor area in units of m 3/m2/hr. This is the
volume water the heater can recover in an hour per floor area. Recovery is heating water
from a starting temperature of 14.4C (58F) to a final temperature of 57.2C (135F). This
field is only used if the Design Mode is PerFloorArea.
Field: Number of Units
This field is used to enter the number of Units for use in sizing on per-Unit basis with the next
two fields. This field is only used if the Design Mode is PerUnit. This can be used to
account for any arbitrary item such as lodging rooms, desks, water fixtures, restrooms, etc.

9/29/14

706

Input-Output Reference

Group Water Heaters

Field: Storage Capacity per Unit

This field is used to enter the tanks storage volume on per-Unit basis. The units are m 3/Unit.
The number of Units is entered in the previous field. This field is only used if the Design
Mode is PerUnit.
Field: Recovery Capacity per Unit
This field is used to enter the recover capacity per Unit in units of m 3/Unit/hr. This is the
volume of water the heater can recover in an hour per Unit. Recovery is heating water from a
starting temperature of 14.4C (58F) to a final temperature of 57.2C (135F). This field is
only used if the Design Mode is PerUnit.
Field: Storage Capacity per Collector Area
This field is used to enter the tanks storage volume on per-solar-collector-area basis. The
units are m3/m2. This field is only used if the Design Mode is PerSolarCollectorArea.
Field: Height Aspect Ratio
This field is used to scale the height of a stratified tank to preserve relative geometry for
different size tanks. The Height Aspect Ratio is defined at the length scale in the vertical
direction (height) divided by the length scale in the horizontal direction (diameter). This field
is only used if the water heater being sized is a Water Heater:Stratified, the tank height has
been set to Autosize, and the tank shape is set to VerticalCylinder. This field can be used
with any Design Mode.
WaterHeater:HeatPump
The heat pump water heater (HPWH) is a compound object consisting of a water heater tank
(e.g., WaterHeater:Mixed or WaterHeater:Stratified), a direct expansion (DX) coil (i.e., an
air-to-water DX compression system which includes a water heating coil, air coil, compressor,
and water pump), and a fan to provide air flow across the air coil associated with the DX
compression system. These objects work together to model a system which heats water
using zone air, outdoor air, or a combination of zone and outdoor air as the primary heat
source. Numerous configurations of tank location, inlet air source, and DX coil compressor
location can be modeled, with one common configuration shown below.

9/29/14

707

Input-Output Reference

Group Water Heaters

Figure 81. Schematic diagram for a heat pump water heater located in a zone
In this model, the heat pump water heaters DX coil is considered the primary heat source
and the water tanks heater (element or burner) provides supplemental heat as necessary.
The model also assumes that the heat pumps fan and water pump cycle on and off with the
compressor.
To model a heat pump water heater, the input data file must include some combination of the
following objects depending on the configuration to be modeled:
WaterHeater:HeatPump (required)
WaterHeater:Mixed or WaterHeater:Stratified (required)
Coil:WaterHeating:AirToWaterHeatPump (required)
Fan:OnOff (required)
ZoneHVAC:EquipmentList (when the HPWH draws some or all of its air from the zone,
the heat pump water heater type and name must be in this list)
ZoneHVAC:EquipmentConnections (when the HPWH draws some or all of its air from the
zone, the HPWH air inlet and outlet node names must be provided in this object)
OutdoorAir:NodeList (for HPWHs that use outdoor air as all or part of the heat source, the
HPWH outdoor air node name must be provided in this list)
The input fields for the compound object are described in detail below:
Field: Name
This alpha field contains a unique user-assigned name for an instance of a heat pump water
heater. Any reference to this heat pump water heater by another object will use this name.
Field: Availability Schedule Name
This alpha field contains the name of the schedule (ref: Schedule) that denotes whether the
heat pump compressor is available to operate during a given time period. A schedule value
equal to 0 denotes that the heat pump compressor is off for that time period. A value other
than 0 denotes that the heat pump compressor is available to operate during that time period.
During times when the heat pump compressor is scheduled off, the heater (element or
burner) in the water tank object operates based on its tank set point temperature schedule
9/29/14

708

Input-Output Reference

Group Water Heaters

and the heat pumps parasitic electric power is also off for that time period. If this field is
blank, the schedule has values of 1 for all time periods.
Field: Compressor Setpoint Temperature Schedule Name
This alpha field contains the name of the schedule (ref: Schedule) that specifies the set point
(or cut-out) temperature for the heat pump compressor. Temperature values used in this
schedule should be in degrees Celsius. The heat pump compressor cycles off when the tank
water reaches this set point temperature. Once the heat pump compressor cycles off, the
tank water temperature floats downward until it falls below the set point temperature minus
the dead band temperature difference defined below (i.e., the cut-in temperature). At this
point, the heat pump compressor cycles on and remains on until the heat pump compressor
set point temperature is reached.
Field: Dead Band Temperature Difference
This numeric field contains the dead band temperature difference in degrees Celsius. The
heat pump compressor cut-in temperature is defined as the compressor set point
temperature defined above minus this dead band temperature difference. The heat pump
compressor cycles on when the water temperature in the tank falls below the cut-in
temperature. The heat pump compressor remains on until the water temperature in the tank
rises above the compressor set point (cut-out) temperature defined above. The dead band
temperature difference must be greater than 0C and less than or equal to 20C. If this field is
left blank, the default value is 5C.
In this model, the heat pump water heaters DX compression system is considered the primary heat source
and the water tanks heater (element or burner) provides supplemental heat as necessary. Therefore, the
cut-in temperature for the heat pump compressor (set point minus dead band temperature difference) is
usually higher than the set point temperature for the heater (element or burner) in the associated water
heater tank object. At times when the water heater tank set point temperature is greater than the cut-in
temperature of the heat pump compressor, the heat pump compressor is disabled and the tanks heater is
used to heat the water.

Field: Condenser Water Inlet Node Name

This alpha field contains the name of the inlet water node for the heat pumps water heating
coil (condenser). This node name must also be specified in the water heater tank object as
the source outlet node name, and in the DX coil object as the condenser water inlet node
name.
Field: Condenser Water Outlet Node Name
This alpha field contains the name of the outlet water node for the heat pumps water heating
coil (condenser). This node name must also be specified in the water heater tank object as
the source inlet node name, and in the DX coil object as the condenser water outlet node
name.
Field: Condenser Water Flow Rate
This numeric field contains the heat pumps condenser water flow rate in cubic meters per
second. It is the actual condenser water flow rate to be simulated, which may differ from the
rated condenser water volumetric flow rate specified for the heat pumps DX coil (Ref.
Coil:WaterHeating:AirToWaterHeatPump). This water flow rate must be greater than 0 or this
field is autocalculatable. If autocalculated (field value = autocalculate), the condenser water
flow rate is set equal to the rated heating capacity of the heat pumps DX coil multiplied by
4.487E-8 m3/s/W. When this flow rate is different from the Rated Condenser Water
Volumetric Flow Rate specified in the heat pumps DX coil object (Ref.
Coil:WaterHeating:AirToWaterHeatPump), the user should also specify a Total Heating
9/29/14

709

Input-Output Reference

Group Water Heaters

Capacity Modifier Curve Name (function of water flow fraction) and a Heating COP Modifier
Curve Name (function of water flow fraction) in the associated DX coil object to account for
differences in capacity and power consumption at the off-rated water flow rate.
Field: Evaporator Air Flow Rate
This numeric field contains the air flow rate across the heat pumps air coil (evaporator) in
cubic meters per second. It is the actual air flow rate to be simulated, which may differ from
the rated evaporator air volumetric flow rate specified for the heat pumps DX coil (Ref.
Coil:WaterHeating:AirToWaterHeatPump). Values must be greater than 0 or this field is
autocalculatable. If autocalculated (field value = autocalculate), the evaporator air flow rate
is set equal to the rated heating capacity of the heat pumps DX coil multiplied by 5.035E-5
m3/s/W. When this flow rate is different from the Rated Evaporator Air Volumetric Flow Rate
specified in the heat pumps DX coil object (Ref. Coil:WaterHeating:AirToWaterHeatPump),
the user should also specify a Total Heating Capacity Modifier Curve Name (function of air
flow fraction) and a Heating COP Modifier Curve Name (function of air flow fraction) in the
associated DX coil object to account for differences in capacity and power consumption at the
off-rated air flow rate.
Field: Inlet Air Configuration
This choice field defines the configuration of the air flow path through the heat pump air coil
(evaporator) and fan section. Valid entries are Schedule, ZoneAirOnly, OutdoorAirOnly, or
ZoneAndOutdoorAir. If Schedule is selected, names for an inlet air temperature schedule
and an inlet air humidity schedule must be defined in the fields below. If ZoneAirOnly is
selected, the corresponding zone name must be entered in the Inlet Air Zone Name field
below. If ZoneAndOutdoorAir is selected, the corresponding Inlet Air Zone Name, Inlet Air
Mixer Node Name, Outlet Air Splitter Node Name, and an Inlet Air Mixer Schedule Name
must be entered in the corresponding fields below.
Field: Air Inlet Node Name
This alpha field contains the name of the node from which the heat pump water heater draws
its inlet air. If the Inlet Air Configuration field defined above is set to ZoneAirOnly or
ZoneAndOutdoorAir, then this node name should be the name of a zone air exhaust node
(Ref. ZoneHVAC:EquipmentConnections). If the Inlet Air Configuration field is set to
OutdoorAirOnly, this node name should be left blank. If the Inlet Air Configuration field is set
to Schedule, this node name should simply be a unique name that allows the user to receive
output on conditions at this node for verification purposes.
Field: Air Outlet Node Name
This alpha field contains the name of the node to which the heat pump water heater sends its
outlet air. If the Inlet Air Configuration field defined above is set to ZoneAirOnly or
ZoneAndOutdoorAir, then this node name should be the name of a zone air inlet node (Ref.
ZoneHVAC:EquipmentConnections). If the Inlet Air Configuration field is set to
OutdoorAirOnly, this node name should be left blank. If the Inlet Air Configuration field is set
to Schedule, this node name should simply be a unique name that allows the user to receive
output on conditions at this node for verification purposes.
Field: Outdoor Air Node Name
This alpha field contains the name of the node from which the heat pump water heater draws
its outdoor air. If the Inlet Air Configuration field defined above is set to ZoneAirOnly or
Schedule, this node name should be left blank. If the Inlet Air Configuration field is set to
ZoneAndOutdoorAir or OutdoorAirOnly, this node name should be the name of an outdoor
air node (Ref. OutdoorAir:NodeList).

9/29/14

710

Input-Output Reference

Group Water Heaters

Field: Exhaust Air Node Name

This alpha field contains the name of the node to which the heat pump water heater sends its
exhaust air. If the Inlet Air Configuration field defined above is set to ZoneAirOnly or
Schedule, this node name should be left blank. If the Inlet Air Configuration field is set to
ZoneAndOutdoorAir or OutdoorAirOnly, then this node name should be a unique name that
allows the user to receive output on conditions at this node for verification purposes.
Field: Inlet Air Temperature Schedule Name
This alpha field contains the name of a schedule used to define the dry-bulb temperature of
the inlet air to the heat pump air coil (evaporator) and fan section. Schedule values should be
in degrees Celsius. This field is only used when the Inlet Air Configuration defined above is
specified as Schedule, otherwise leave this field blank.
Field: Inlet Air Humidity Schedule Name
This alpha field contains the name of a schedule used to define the humidity of the inlet air to
the heat pump evaporator and fan section. Schedule values must be entered as relative
humidity fraction from 0 to 1 (e.g., a schedule value of 0.5 means 50%RH). This field is only
used when the Inlet Air Configuration defined above is specified as Schedule, otherwise
leave this field blank.
Field: Inlet Air Zone Name
This alpha field contains the name of the zone from which the heat pump evaporator and fan
section draws some or all of its inlet air. This field is only used when the Inlet Air
Configuration defined above is specified as ZoneAirOnly or ZoneAndOutdoorAir.
Field: Tank Object Type
This alpha (choice) field contains the type of water heater tank used by this heat pump water
heater. Currently, the only valid choices are WaterHeater:Mixed or WaterHeater:Stratified.
Field: Tank Name
This alpha field contains the name of the specific water heater tank (WaterHeater:Mixed
object) used by this heat pump water heater.
Field: Tank Use Side Inlet Node Name
This alpha field contains the name of the use side inlet node of the water heater tank used by
this heat pump water heater. This name must match the Use Side Inlet Node Name in the
water heater tank object (Ref. WaterHeater:Mixed). This field is required if the water heater
tank use side nodes are connected to a plant loop, otherwise leave this field blank. When
used, the branch object should reflect that this node is part of a WaterHeater:HeatPump
object (see branch object example below).
Field: Tank Use Side Outlet Node Name
This alpha field contains the name of the use side outlet node of the water heater tank used
by this heat pump water heater. This name must match the Use Side Outlet Node Name in
the water heater tank object (Ref. WaterHeater:Mixed). This field is required if the water
heater tank use side nodes are connected to a plant loop, otherwise leave this field blank.
When used, the branch object should reflect that this node is part of a
WaterHeater:HeatPump object (see branch object example below).
Field: DX Coil Object Type
This alpha (choice) field contains the type of DX coil used by this heat pump water heater.
Currently, the only valid choice is Coil:WaterHeating:AirToWaterHeatPump.

9/29/14

711

Input-Output Reference

Group Water Heaters

Field: DX Coil Name

This
alpha
field
contains
the
name
of
the
specific
DX
(Coil:WaterHeating:AirToWaterHeatPump object) used by this heat pump water heater.

coil

Field: Minimum Inlet Air Temperature for Compressor Operation

This numeric field contains the minimum inlet air dry-bulb temperature entering the air coil
(evaporator) and fan section, in degrees Celsius, below which the heat pump compressor
does not operate. The minimum inlet air dry-bulb temperature should be greater than or equal
to 5C. If this field is left blank, the default value is 10C.
Field: Compressor Location
This alpha (choice) field contains the location of the heat pump compressor and the air
temperature for this location is used to control operation of the compressors crankcase
heater in the Coil:WaterHeating:AirToWaterHeatPump object. Valid entries are Schedule,
Zone, or Outdoors. If Schedule is selected, a compressor ambient temperature schedule
name must be defined in the field below; otherwise, the field below should be left blank. If
Zone is selected, the crankcase heater operation is controlled based on the air temperature
in the zone defined in the field Inlet Air Zone Name, and the Inlet Air Configuration must be
ZoneAirOnly or ZoneAndOutdoorAir. If Outdoors is selected, crankcase heater operation
is controlled based on the outdoor air temperature.
Field: Compressor Ambient Temperature Schedule Name
This alpha field contains the name of a schedule that defines the ambient air temperature
surrounding the heat pump compressor, which is used to control the compressors crankcase
heater operation. This field is only used when the compressor location field defined above is
specified as Schedule, otherwise it should be left blank.
Field: Fan Object Type
This alpha (choice) field contains the type of fan used by this heat pump water heater.
Currently, the only valid choice is Fan: OnOff.
Field: Fan Name
This alpha field contains the name of the specific fan (Fan:OnOff object) used by this heat
pump water heater.
Field: Fan Placement
This alpha (choice) field defines the placement of the fan in the heat pump water heater.
Valid choices are BlowThrough (fan upstream of the air coil) and DrawThrough (fan
downstream of the air coil). If this field is left blank, the default value is DrawThrough.
Field: On Cycle Parasitic Electric Load
This numeric field contains the on-cycle parasitic electric power in Watts. This is the parasitic
electric power consumed by controls or other electrical devices associated with the heat
pump water heater. This parasitic electric load is consumed whenever the heat pump
compressor is operating and the model assumes that this parasitic power does not contribute
to heating the water. This parasitic load does, however, affect the zone air heat balance when
the heat pump water heater sends some or all of its outlet air to a zone (i.e., Inlet Air
Configuration field specified as ZoneAirOnly or ZoneAndOutdoorAir) and the Parasitic Heat
Rejection Location field is specified as Zone. The minimum value for this field is 0.0, and the
default value is also 0.0 if this field is left blank.
Field: Off Cycle Parasitic Electric Load
This numeric field contains the off-cycle parasitic electric power in Watts. This is the parasitic
electric power consumed by controls or other electrical devices associated with the heat
pump compressor. This parasitic electric load is consumed whenever the heat pump water
9/29/14

712

Input-Output Reference

Group Water Heaters

heater is available but the compressor is not operating, and the model assumes that this
parasitic power does not contribute to heating the water. This parasitic load does, however,
affect the zone air heat balance when the heat pump water heater sends some or all of its
outlet air to a zone (i.e., Inlet Air Configuration field specified as ZoneAirOnly or
ZoneAndOutdoorAir) and the Parasitic Heat Rejection Location field is specified as Zone.
The minimum value for this field is 0.0, and the default value is also 0.0 if this field is left
blank.
Field: Parasitic Heat Rejection Location
This alpha (choice) field determines where the on-cycle and off-cycle parasitic heat is
rejected. Valid choices are Zone and Exterior. If Zone is selected, both the on-cycle and offcycle parasitic heat is rejected to the zone defined in the field Inlet Air Zone Name, and the
Inlet Air Configuration must be ZoneAirOnly or ZoneAndOutdoorAir. If Outdoors is
selected, this parasitic heat is rejected outdoors (does not impact the zone air heat balance)
regardless of the specified Inlet Air Configuration. If this field is left blank, the default value is
Outdoors.
Field: Inlet Air Mixer Node Name
This optional alpha field defines the name of the HVAC node which represents the mixture of
outdoor air and zone air that enters the heat pump air coil (evaporator) and fan section. The
model mixes outdoor air with zone air and places the result on this inlet air mixer node based
on the Inlet Air Mixer Schedule defined below. When the schedule value is equal to 0, 100%
zone air enters the evaporator coil and fan section of the heat pump water heater. When the
schedule value is equal to 1, 100% outdoor air enters the evaporator coil and fan section.
This node name must be provided if the Inlet Air Configuration field above is specified as
ZoneAndOutdoor Air, otherwise this field should be left blank.
Field: Outlet Air Splitter Node Name
This alpha field defines the name of the air node to which the heat pump air coil (evaporator)
and fan sends all of its outlet air. The supply air flow downstream of this node is split between
the zone and outdoors based on the Inlet Air Mixer schedule defined below. When the
schedule value is equal to 0, the entire outlet air stream is diverted to the zone. When the
schedule value is equal to 1, the entire outlet air stream is exhausted to outdoors. This node
name must be provided if the Inlet Air Configuration field above is specified as Zone and
Outdoor Air, otherwise this field should be left blank.
Field: Inlet Air Mixer Schedule Name
This alpha field defines the name of the schedule (ref: Schedule) that denotes whether the
heat pump draws its inlet air from the zone, outdoors, or a combination of zone and outdoor
air. A schedule value equal to 0 indicates that the heat pump draws its inlet air from the zone.
A schedule value equal to 1 denotes that the heat pump draws its inlet air from outdoors.
Values between 0 and 1 denote a mixture of zone and outdoor air proportional to the
schedule value. The Inlet Air Mixer schedule controls both the inlet air mixer and outlet air
splitter nodes in unison to ensure that the operation of the heat pump does not contribute to
zone pressurization or depressurization. For example if the Inlet Air Mixer schedule value is
0.4, then the inlet air mixer node is composed of 40% outdoor air and 60% zone air. For this
same case, the outlet air splitter directs 60% of the HPWH outlet air back to the zone and
40% of the outlet air flow is exhausted outdoors. This schedule name must be provided if the
Inlet Air Configuration field is specified as Zone and Outdoor Air, otherwise this field should
be left blank.
Field: Control Sensor Location In Stratified Tank
This alpha field defines where the tank temperature is sensed for heat pump control when the
tank type is WaterHeater:Stratified. The stratified tank model produces tank temperature at
different nodes in the vertical direction and various options are available for how this
9/29/14

713

Input-Output Reference

Group Water Heaters

temperature should be sensed to control the heat pump. There are six choices that, when
combined with the input for the stratified tank, indicate which of the nodes should be used.
The default is Heater1. The choices include:
Heater1. This indicates the tank node associated with (backup) heater #1 should be
used for tank temperature control. This is determined by the field called Heater 1 Height
in the WaterHeater:Stratified object.
Heater2. This indicates the tank node associated with (backup) heater #2 should be
used for tank temperature control. This is determined by the field called Heater 2 Height
in the WaterHeater:Stratified object.
SourceInlet. This indicates the tank node associated with the source side inlet should be
used for tank temperature control. This is determined by the field called Source Side
Inlet Height in the WaterHeater:Stratified object.
SourceOutlet. This indicates the tank node associated with the source side outlet should
be used for tank temperature control. This is determined by the field called Source Side
Outlet Height in the WaterHeater:Stratified object.
UseInlet. This indicates the tank node associated with the use side inlet should be used
for tank temperature control. This is determined by the field called Use Side Inlet Height
in the WaterHeater:Stratified object.
UseOutlet. This indicates the tank node associated with the use side outlet should be
used for tank temperature control. This is determined by the field called Use Side Outlet
Height in the WaterHeater:Stratified object.
Following is an example input for the Heat Pump:Water Heater compound object and the
other required component objects that it references.

9/29/14

714

Input-Output Reference

Group Water Heaters

WaterHeater:HeatPump,
PlantHeatPumpWaterHeater,!- Name
PlantHPWHSch,
!- Availability Schedule Name
PlantHPWHTempSch,
!- Compressor Setpoint Temperature Schedule Name
2.0,
!- Dead Band Temperature Difference {deltaC}
HPPlantWaterInletNode,
!- Condenser Water Inlet Node Name
HPPlantWaterOutletNode, !- Condenser Water Outlet Node Name
0.00115525,
!- Condenser Water Flow Rate {m3/s}
1.00695,
!- Evaporator Air Flow Rate {m3/s}
OutdoorAirOnly,
!- Inlet Air Configuration
,
!- Air Inlet Node Name
,
!- Air Outlet Node Name
HPPlantAirInletNode,
!- Outdoor Air Node Name
HPPlantAirOutletNode,
!- Exhaust Air Node Name
,
!- Inlet Air Temperature Schedule Name
,
!- Inlet Air Humidity Schedule Name
,
!- Inlet Air Zone Name
WaterHeater:Mixed,
!- Tank Object Type
HPWHPlantTank,
!- Tank Name
HPWH Use Inlet Node,
!- Tank Use Side Inlet Node Name
HPWH Use Outlet Node,
!- Tank Use Side Outlet Node Name
Coil:WaterHeating:AirToWaterHeatPump, !- DX Coil Object Type
HPWHPlantDXCoil,
!- DX Coil Name
11.0,
!- Minimum Inlet Air Temperature for Compressor Operation {C}
Outdoors,
!- Compressor Location
,
!- Compressor Ambient Temperature Schedule Name
Fan:OnOff,
!- Fan Object Type
HPWHPlantFan,
!- Fan Name
BlowThrough,
!- Fan Placement
,
!- On Cycle Parasitic Electric Load {W}
,
!- Off Cycle Parasitic Electric Load {W}
;
!- Parasitic Heat Rejection Location
NOTE: branch object required only when tank use inlet nodes are used.
Branch,
Central HPWH Branch,
!0,
!,
!WaterHeater:HeatPump,
!PlantHeatPumpWaterHeater,!HPWH Use Inlet Node,
!HPWH Use Outlet Node,
!PASSIVE;
!-

9/29/14

Name
Maximum Flow Rate {m3/s}
Pressure Drop Curve Name
Component 1 Object Type
Component 1 Name
Component 1 Inlet Node Name
Component 1 Outlet Node Name
Component 1 Branch Control Type

715

Input-Output Reference

Group Water Heaters

WaterHeater:Mixed,
HPWHPlantTank,
0.757,
Plant Hot Water Setpoint
2.0,
82.2222,
CYCLE,
25000,
0,
,
,
ELECTRICITY,
0.98,
,
10,
ELECTRICITY,
0,
30,
ELECTRICITY,
0,
Outdoors,
,
,
HPWHPlantTank OA Node,
0.0,
0.0,
0.0,
0.0,
,
,
,
HPWH Use Inlet Node,
HPWH Use Outlet Node,
0.98,
HPPlantWaterOutletNode,
HPPlantWaterInletNode,
0.98,
autosize;

!- Name
!- Tank Volume {m3}
Temp Schedule, !- Setpoint Temperature Schedule Name
!- Deadband Temperature Difference {deltaC}
!- Maximum Temperature Limit {C}
!- Heater Control Type
!- Heater Maximum Capacity {W}
!- Heater Minimum Capacity {W}
!- Heater Ignition Minimum Flow Rate {m3/s}
!- Heater Ignition Delay {s}
!- Heater Fuel Type
!- Heater Thermal Efficiency
!- Part Load Factor Curve Name
!- Off Cycle Parasitic Fuel Consumption Rate {W}
!- Off Cycle Parasitic Fuel Type
!- Off Cycle Parasitic Heat Fraction to Tank
!- On Cycle Parasitic Fuel Consumption Rate {W}
!- On Cycle Parasitic Fuel Type
!- On Cycle Parasitic Heat Fraction to Tank
!- Ambient Temperature Indicator
!- Ambient Temperature Schedule Name
!- Ambient Temperature Zone Name
!- Ambient Temperature Outdoor Air Node Name
!- Off Cycle Loss Coefficient to Ambient Temperature {W/K}
!- Off Cycle Loss Fraction to Zone
!- On Cycle Loss Coefficient to Ambient Temperature {W/K}
!- On Cycle Loss Fraction to Zone
!- Peak Use Flow Rate {m3/s}
!- Use Flow Rate Fraction Schedule Name
!- Cold Water Supply Temperature Schedule Name
!- Use Side Inlet Node Name
!- Use Side Outlet Node Name
!- Use Side Effectiveness
!- Source Side Inlet Node Name
!- Source Side Outlet Node Name
!- Source Side Effectiveness
!- Use Side Design Flow Rate {m3/s}

OutdoorAir:Node,
HPWHPlantTank OA Node;

!- Name

Coil:WaterHeating:AirToWaterHeatPump,
HPWHPlantDXCoil,
!- Name
25000.0,
!- Rated Heating Capacity {W}
3.2,
!- Rated COP {W/W}
0.736,
!- Rated Sensible Heat Ratio
29.44,
!- Rated Evaporator Inlet Air Dry-Bulb Temperature {C}
22.22,
!- Rated Evaporator Inlet Air Wet-Bulb Temperature {C}
55.72,
!- Rated Condenser Inlet Water Temperature {C}
1.00695,
!- Rated Evaporator Air Flow Rate {m3/s}
0.00115525,
!- Rated Condenser Water Flow Rate {m3/s}
No,
!- Evaporator Fan Power Included in Rated COP
No,
!- Condenser Pump Power Included in Rated COP
No,
!- Condenser Pump Heat Included in Rated Heating Capacity and Rated COP
150.0,
!- Condenser Water Pump Power {W}
0.1,
!- Fraction of Condenser Pump Heat to Water
HPPlantFanAirOutletNode, !- Evaporator Air Inlet Node Name
HPPlantAirOutletNode,
!- Evaporator Air Outlet Node Name
HPPlantWaterInletNode,
!- Condenser Water Inlet Node Name
HPPlantWaterOutletNode, !- Condenser Water Outlet Node Name
100.0,
!- Crankcase Heater Capacity {W}
5.0,
!- Maximum Ambient Temperature for Crankcase Heater Operation {C}
WetBulbTemperature,
!- Evaporator Air Temperature Type for Curve Objects
HPWHHeatingCapFTemp,
!- Heating Capacity Function of Temperature Curve Name
,
!- Heating Capacity Function of Air Flow Fraction Curve Name
,
!- Heating Capacity Function of Water Flow Fraction Curve Name
HPWHHeatingCOPFTemp,
!- Heating COP Function of Temperature Curve Name
,
!- Heating COP Function of Air Flow Fraction Curve Name
,
!- Heating COP Function of Water Flow Fraction Curve Name
HPWHPLFFPLR;
!- Part Load Fraction Correlation Curve Name

9/29/14

716

Input-Output Reference

Fan:OnOff,
HPWHPlantFan,
PlantHPWHSch,
0.7,
100.0,
2.6852,
0.9,
1.0,
HPPlantAirInletNode,
HPPlantFanAirOutletNode;

Group Condenser Equipment

!!!!!!!!!-

Name
Availability Schedule Name
Fan Total Efficiency
Pressure Rise {Pa}
Maximum Flow Rate {m3/s}
Motor Efficiency
Motor In Airstream Fraction
Air Inlet Node Name
Air Outlet Node Name

Heat Pump Water Heater Outputs

HVAC,Average,Water Heater Compressor Part Load Ratio
HVAC,Average,Water Heater On Cycle Ancillary Electric Power [W]
HVAC,Sum,Water Heater On Cycle Ancillary Electric Energy [J]
HVAC,Average,Water Heater Off Cycle Ancillary Electric Power [W]
HVAC,Sum,Water Heater Off Cycle Ancillary Electric Energy [J]
Water Heater Compressor Part Load Ratio
This output is the average part-load ratio of the heat pump water heaters compressor (as
well as its water pump and fan) for the timestep being reported. This output is independent of
the Water Heater Part Load Ratio (Ref. Water Heater Outputs) which represents the partload ratio of the supplemental heater (element or burner) in the water tank. When the water
tanks (supplemental) heater set point temperature is higher than the cut-in temperature of
the heat pump water heaters compressor, the heat pump compressor is disabled and the
water tanks heater (element or burner) is used to heat the water. During these times the
Water Heater Compressor Part Load Ratio is equal to 0.
Water Heater On Cycle Ancillary Electric Power [W]
Water Heater On Cycle Ancillary Electric Energy [J]
Water Heater Off Cycle Ancillary Electric Power [W]
Water Heater Off Cycle Ancillary Electric Energy [J]
These outputs are the parasitic electric power and consumption associated with the heat
pump water heater. Specific outputs represent parasitic electrical usage during the
compressor/fan on and off cycles. These outputs represent electronic controls or other
electric component. The model assumes that the parasitic power does not contribute to
heating the water, but it can impact the zone air heat balance depending on user inputs. The
parasitic electric consumption outputs are also added to a meter with Resource Type =
Electricity, End Use Key = DHW, Group Key = Plant (ref. Output:Meter objects).

Group Condenser Equipment

Equipment Types
In each CondenserEquipmentList, various equipment types and names must be given. Each
type-name pair must then have a corresponding equipment definition. This subsection lists
the various equipment types that are available and examples from an IDF. Where
appropriate, notes and comments on the input structure are provided.
CoolingTower:SingleSpeed
Cooling towers are components that may be assigned to condenser loops. The cooling tower
is modeled as a counterflow heat exchanger with a single-speed fan (induced draft
configuration) based on Merkels theory. The user must define tower performance via one of
9/29/14

717

Input-Output Reference

Group Condenser Equipment

two methods: design heat transfer coefficient-area product (UA) and design water flow rate,
or nominal tower capacity at a specific rating point. Regardless of which method is chosen,
the design airflow rate and corresponding fan power must be specified. The model will also
account for tower performance in the free convection regime, when the tower fan is off but
the water pump remains on and heat transfer still occurs (albeit at a low level). If the user
wants the model to account for free convection, they must specify the corresponding airflow
rate and heat transfer coefficient-area product (UA), or the nominal tower capacity during this
mode of operation.
The cooling tower seeks to maintain the temperature of the water exiting the cooling tower at
(or below) a set point. The set point schedule value is defined by the field Condenser Loop
Temperature Setpoint Node Name or Reference for the CondenserLoop object. The model
first checks to determine the impact of free convection, if specified by the user, on the tower
exiting water temperature. If the exiting water temperature based on free convection is at or
below the set point, then the tower fan is not turned on. If the exiting water temperature
based on free convection is below the set point, the tower will operate in FluidBypass mode
portion of the water goes through the tower media and gets cooled while the remaining
water flow gets bypassed, two water flows then mix together trying to meet the water setpoint
temperature. If the exiting water temperature remains above the set point after free
convection is modeled, then the tower fan is turned on to reduce the exiting water
temperature to the set point. If the capacity control is FanCycling, the model assumes that
part-load operation is represented by a simple linear interpolation between two steady-state
regimes (i.e., tower fan on for the entire simulation timestep and tower fan off for the entire
simulation timestep). Cyclic losses are not taken into account. If the capacity control is
FluidBypass, the model determines the fraction of water flow to be bypassed while the
remaining water goes through the tower cooling media and gets cooled, then the two water
flows mix to meet the setpoint temperature. In this case, the fan runs at full speed for the
entire timestep.
Cooling towers here are wet and consume water through evaporation, drift, and blowdown.
The model can be used to predict water consumed by the towers. The last six input fields are
optional and provide methods of controlling details of the water consumption calculations.
The user can specifiy connections to the rest of the buildings water system by providing the
name of a water storage tanks (i.e. WaterUse:Storage objects).
For the operation of multi-cell towers, the first step is to determine the number of cells to
operate based on the cell control method between the minimum number of cells subject to
the maximum water flow rate fraction per cell, and maximum number of cells subject to the
minimum water flow rate fraction per cell. If the calculated cells do not meet the loads,
additional cells will be operating to help meet the loads. Inside each cell, the existing capacity
controls still apply.
For multi-cell towers, the following inputs are assumed to be for the entire tower including all
cells:
Design Water Flow Rate; Design Air Flow Rate; Fan Power at Design Air Flow Rate;
Air Flow Rate in Free Convection Regime; Nominal Capacity; Free Convection Capacity
BASIN HEATER (we assume that there is a common basin)
Field: Name
This alpha field contains the identifying name for the cooling tower.
Field: Water Inlet Node Name
This alpha field contains the identifying name for the cooling towers water inlet node.
Field: Water Outlet Node Name
This alpha field contains the identifying name for the cooling towers water outlet node.

9/29/14

718

Input-Output Reference

Group Condenser Equipment

Field: Design Water Flow Rate

This numeric field contains the design water flow rate through the tower in m 3/s. This value is
the flow rate of the condenser loop water being cooled by the tower (not the flow rate of water
being sprayed on the outside of the heat exchange coil). If the input field Performance Input
Method is specified as UFactorTimesAreaAndDesignWaterFlowRate, then a water flow
rate greater than zero must be defined or the field can be autosized. If autosized, a Plant
Sizing object must be defined and the design water flow rate is derived from the design load
to be rejected by the condenser loop and the design loop delta T (Ref. Sizing and Input for
Design Calculations and Component Autosizing sections). If Performance Input Method is
specified as NominalCapacity, then this field must be left blank since the model
automatically assumes a water flow rate of 5.382E-8 m3/s per watt (3 gpm/ton) of tower
capacity specified in the field Nominal Capacity.
Field: Design Air Flow Rate
This numeric field contains the design air flow rate induced by the tower fan in m 3/s. A value
greater than zero must be defined regardless of the tower performance input method.
Alternately, this field can be autosized. If autosized, the design air flow rate is calculated as
follows:

Design Air Flow Rate

0.5

air

( Fan power at Design Air Flow Rate)

190.

where a fan pressure rise of 190 Pascals and total fan efficiency of 0.5 are assumed.
Field: Design Fan Power
This numeric field contains the fan power (in watts) at the design air flow rate specified in the
previous field. A value greater than zero must be specified regardless of the tower
performance input method, or this field can be autosized. If autosized, the fan power is
calculated as follows:
If Performance Input Method is specified as UFactorTimesAreaAndDesignWaterFlowRate,
then

Fan power

0.0105

water

C p,water Design Water Flow Rate Design Loop T

is used.
If Performance Input Method is specified as NominalCapacity, then

Fan power

0.0105 Tower Nominal Capacity

is used.
Field: Design U-Factor Times Area Value
This numeric field contains the heat transfer coefficient-area product (UA) in watts per Kelvin
corresponding to the design air and water flow rates specified above. If the input field
Performance Input Method is specified as UFactorTimesAreaAndDesignWaterFlowRate,
then a UA value greater than zero but less than or equal to 300,000 must be defined, or the
field can be autosized. If autosized, a Plant Sizing object must be defined and the design
tower UA value is derived from the design load to be rejected by the condenser loop and the
design loop delta T (Ref. Sizing and Input for Design Calculations and Component Autosizing
sections), assuming a tower water inlet temperature of 35C and tower inlet air at 35C
drybulb/25.6C wetbulb. If Performance Input Method is specified as NominalCapacity,
then this field must be left blank since the model automatically calculates the tower UA based
on the tower capacity specified in the field Nominal Capacity.
9/29/14

719

Input-Output Reference

Group Condenser Equipment

Field: Free Convection Regime Air Flow Rate

This numeric field contains the air flow rate (m 3/s) when the tower is in the free convection
regime (water flow exists but tower fan is turned off). This value must be less than the value
specified for the field Design Air Flow Rate. This field may be autocalculated, in which case
it is set to a fraction of the Design Air Flow Rate determined in the following input field. If the
user does not wish to model free convection and is using the Performance Input Method
UFactorTimesAreaAndDesignWaterFlowRate, then this field should be set to 0.0. If the user
specifies the U-Factor Times Area Value at Free Convection Air Flow Rate or Free
Convection Capacity as a value greater than zero, then the free convection air flow rate must
be specified greater than 0.0.
Field: Free Convection Regime Air Flow Rate Sizing Factor
This numeric field contains the sizing factor to use when calculating the free convection
regime air flow rate. The default is 0.1.
Field: Free Convection Regine U-Factor Times Area Value
This numeric field contains the heat transfer coefficient-area product (W/K) when the tower is
in the free convection regime (water flow exists but tower fan is turned off). This value must
be less than the value specified for the field U-Factor Times Area Value at Design Air Flow
Rate. This field may be autosized, in which case it is set to a fraction of the U-Factor Times
Area Value at Design Air Flow Rate determined in the following input field. If the user does
not wish to model free convection and is using the
Performance Input Method
UFactorTimesAreaAndDesignWaterFlowRate, then this field should be set to 0.0. If
Performance Input Method is specified as NominalCapacity, then this field must be left
blank since the model automatically calculates the tower UA based on the tower capacity
specified in the field Free Convection Capacity.\
Field: Free Convection U-Factor Times Area Value Sizing Factor
This numeric field contains the sizing factor to use when calculating the free convection
regime U-Factor times area value. The default is 0.1.
Field: Performance Input Method
This alpha field contains the method by which the user will specify tower performance:
UFactorTimesAreaAndDesignWaterFlowRate or NominalCapacity. If this field is left
blank in the input data file, the default input method is assumed to be
UFactorTimesAreaAndDesignWaterFlowRate.
If
the
method
UFactorTimesAreaAndDesignWaterFlowRate is selected, then the user must enter
design UA values, design water flow rates and air flow rates as described for the previous
input fields. If the method NominalCapacity is selected then the fields Design Water Flow
Rate, U-Factor Times Area Value at Design Air Flow Rate and U-Factor Times Area Value
at Free Convection Air Flow Rate must be left blank, but the fields Nominal Capacity and
Free Convection Capacity must be entered as described below.
Field: Heat Rejection Capacity and Nominal Capacity Sizing Ratio
This numeric field contains the value for the ratio of actual tower heat rejection to nominal
capacity. This ratio is defined at entering water at 35C (95F), leaving water at 29.4C (85F),
entering air at 25.6C (78F) wetbulb and 35C (95F) drybulb temperatures. Historically this ratio
has been set at 1.25 based on the assumption that the tower must dissipate 0.25 W of
compressor power for every what of heat removed at the chiller evaporator. The default is
1.25.
Field: Nominal Capacity
This numeric input field contains the nominal heat rejection capacity of the cooling tower in
watts, with entering water at 35C (95F), leaving water at 29.4C (85F), entering air at 25.6C
(78F) wetbulb and 35C (95F) drybulb temperatures. The design water flow rate is assumed to
9/29/14

720

Input-Output Reference

Group Condenser Equipment

be 5.382E-8 m3/s per watt of nominal capacity (3 gpm/ton). The value in the previous field
times this nominal tower capacity gives the actual tower heat rejection at these operating
conditions (based on historical assumption that the tower must dissipate additional heat from
the compressor heat for heat removed at the evaporator).
Field: Free Convection Capacity
This numeric input field contains the nominal heat rejection capacity of the cooling tower in
watts when the tower is in the free convection regime (water flow exists but tower fan is
turned off), with entering water at 35C (95F), leaving water at 29.4C (85F), entering air at
25.6C (78F) wetbulb and 35C (95F) drybulb temperatures. The design water flow rate is
assumed to be 5.382E-8 m3/s per watt of nominal tower capacity (input field above). The heat
rejection capacity and nominal capacity sizing ratio is applied tof this free convection tower
capacity to give the actual tower heat rejection at these operating conditions (typical value is
1.25 based on historical assumption that the tower must dissipate 0.25W of compressor heat
for every watt of heat removed by the evaporator). The value specified for this field must be
less than the value specified for the field Tower Nominal Capacity. If the user does not wish
to model free convection, then this field should be set to 0.0. If the user specifies a value
greater than zero, then the Air Flow Rate in Free Convection Regime field must contain a
value greater than zero. This field can be automatically calculated using the sizing factor in
the following field.
Field: Free Convection Nominal Capacity Sizing Factor
This numeric field contains the sizing factor to use when calculating the Free Convection
Capacity. The default is 0.1.
Field: Basin Heater Capacity
This numeric field contains the capacity of the towers electric basin heater in watts per
degree Kelvin. This field is used in conjunction with the Basin Heater Setpoint Temperature
described in the following field. The basin heater electric power is equal to this field multiplied
by the difference between the basin heater set point temperature and the outdoor dry-bulb
temperature. The basin heater only operates when the tower fan is off and water is not
flowing through the tower, regardless of the basin heater schedule described below. The
basin heater capacity must be greater than or equal to zero, with a default value of zero if this
field is left blank.
Field: Basin Heater Setpoint Temperature
This numeric field contains the set point temperature (C) for the basin heater described in
the previous field. The basin heater is active when the outdoor air dry-bulb temperature falls
below this setpoint temperature, as long as the tower fan is off and water is not flowing
through the tower. This set point temperature must be greater than or equal to 2C, and the
default value is 2C if this field is left blank.
Field: Basin Heater Operating Schedule Name
This alpha field contains the name of the basin heater operating schedule. The basin heater
operating schedule is assumed to be an on/off schedule and the heater is available to
operate any time the schedule value is greater than 0. The basin heater operates when
scheduled on and the outdoor air dry-bulb temperature is below the set point temperature
described in the previous field. If this field is left blank, the basin heater is available to operate
throughout the simulation. Regardless of this schedule, the basin heater may only operate
when the cooling tower fan is off and water is not flowing through the tower.
Field: Evaporation Loss Mode
This field is used to choose which method is used to model the amount of water evaporated
by the cooling tower. There are two options: LossFactor or SaturatedExit. The default is
SaturatedExit. The user-defined loss factor is entered in the following field. By assuming that
9/29/14

721

Input-Output Reference

Group Condenser Equipment

the air leaving the tower is saturated, the evaporation can be directly calculated using moist
air engineering calculations with data available within the cooling tower model (and does not
require additional user input).
Field: Evaporation Loss Factor
This field is used to specify the rate of water evaporated from the cooling tower and lost to
the outside air [percent/K]. This field is only used if the Evaporation Calculation Mode is set to
LossFactor. The evaporation loss is then calculated as a fraction of the circulating
condenser water flow and varies with the temperature change in the condenser water. The
value entered here is in units of percent-per-degree Kelvin. The evaporation rate will equal
this value times each degree Kelvin of temperature drop in the condenser water. Typical
values are from 0.15 to 0.27 [percent/K]. The default is 0.2.
Field: Drift Loss Percent
This field is used to specify the rate of water lost to the exiting air as entrained droplets [%].
The drift loss is a percent of the condenser water flow. Typical values for towers with efficient
drift eliminators are between 0.002 and 0.2% of the condenser water flow rate. The default
value is 0.008%.
Field: Blowdown Calculation Mode
This field specifies which method is used to determine blowdown rates. There two options
ConcentrationRatio or ScheduledRate. The choice will determine which of the two models
below is used. The default is ConcentrationRatio.
Field: Blowdown Concentration Ratio
This field is used to dynamically adjust the rate of blowdown in the cooling tower as a function
of the rate of evaporation. Blowdown is water intentionally drained from the tower in order to
offset the build up of solids in the water that would otherwise occur because of evaporation.
The value entered here is dimensionless. It can be characterized as the ratio of solids in the
blowdown water to solids in the make up water. Typical values for tower operation are 3 to 5.
The default value is 3.
Field: Blowdown Makeup Water Usage Schedule Name
This alpha field contains the name of the schedule used to define the amount of water (m 3/s)
flushed from the basin on a periodic basis to purge the tower of mineral scale build-up and
other contaminants. This schedule is only used if the Blowdown Calculation Mode is set to
ScheduledRate. The amount of water use due to blowdown depends on the makeup water
quality and is specific to each geographical location. Typical values range from 0.0002 to
0.0013 m3/s (17.3 to 112.3 m 3/day). This water usage is in addition to the amount of water
lost to the atmosphere due to evaporation and/or drift. Since blowdown occurs when the
basin water contaminant concentration is high, blowdown only occurs when the cooling tower
is active and water is flowing through the tower (regardless of the water usage defined by this
schedule).
Field: Supply Water Storage Tank Name
This field is optional. It is used to describe where the tower obtains water used for
evaporative cooling. If blank or omitted, then the tower will obtain water directly from the
mains. If the name of a WaterUse:Storage object is used here, then the tower will obtain its
water from that tank. If a tank is specified, the tower will attempt to obtain all the water it uses
from the tank. However if the tank cannot provide all the water the tower needs, then the
tower will still operate and obtain the rest of the water it needs from the mains (referred to as
Starved water).

9/29/14

722

Input-Output Reference

Group Condenser Equipment

Field: Outdoor Air Inlet Node Name

This optional alpha field specifies the outdoor air node name used to define the conditions of
the air entering the cooling tower. If this field is left blank, the outdoor air conditions entering
the cooling tower are taken directly from the weather data. If this field is not blank, the node
name specified must also be specified in an OutdoorAir:Node object where the height of the
node is taken into consideration when calculating outdoor air conditions from the weather
data. Alternately, the node name may be specified in an OutdoorAir:NodeList object where
the outdoor air conditions are taken directly from the weather data.
Field: Capacity Control
This alpha field contains the cooling capacity control for the cooling tower. Two choices are
available: FanCycling and FluidBypass. During part-load conditions, there are two ways to
maintain the exiting water temperature at the setpoint: either cycling the tower fan, or
bypassing portion of the tower water with a three-way valve. For FluidBypass, the tower fan
still runs at full speed for the entire timestep, but only portion of the water flow goes through
the cooling tower media to get cooled while the remaining portion of the water flow gets
bypassed. Two water flows then mix at the common water sump to meet the setpoint
temperature.
Field: Number of Cells
This integer field contains the number of cells in the multi-cell cooling tower. If not entered,
the program will assume it is a single-cell cooling tower
Field: Cell Control
This alpha field specifies the method used to control the number of cells used to meet the
load, the two choices are:
MinimalCell : the program will use minimal number of cells needed, all other cells will be shut
down with no water flow. It will attempt to use as few cells as possible to cool the fluid. In no
case, however, will the flow per cell be allowed to exceed its maximum value defined by the
Maximum Water Flow Rate Fraction.
MaximalCell: As many cells as possible will be turned on. In no case, however, will the flow
per cell be allowed to drop below its minimum value specified by the Minimum Water Flow
Rate Fraction.
Field: Cell Minimum Water Flow Rate Fraction
This numeric field specifies the allowable smallest fraction of the design water flow rate.
Flows less than this value will commonly result in fluid distribution problems; the pressure at
each nozzle will be too weak for the fluid to be sprayed out in the correct pattern, not all the
fill would be wet. If this field is left blank, the default value is 0.33.
Field: Cell Maximum Water Flow Rate Fraction
This numeric field specifies the allowable largest fraction of the design water flow rate. If this
field is left blank, the default value is 2.5.
Field: Sizing Factor
This optional numeric field allows the user to specify a sizing factor for this component. The
sizing factor is used when the component design inputs are autosized: the autosizing
calculations are performed as usual and the results are multiplied by the sizing factor. Sizing
factor allows the user to size a component to meet part of the design load while continuing to
use the autosizing feature. For this component the inputs that would be altered by the sizing
factor are:
1. Design Water Flow Rate;
2. Design Air Flow Rate;
3. Fan Power at Design Air Flow Rate;
9/29/14

723

Input-Output Reference

Group Condenser Equipment

4. U-Factor Times Area Value at Design Air Flow Rate;

5. Air Flow Rate in Free Convection Regime;
6. U-Factor Times Area Value at Free Convection Air Flow Rate.
Note that the U-Factor Times Area Value at Design Air Flow Rate is not multiplied by the
Sizing Factor. Instead the design tower load is multiplied by the sizing factor and the design
UA then calculated as usual. The U-Factor Times Area Value at Free Convection Air Flow
Rate is set to 10% of the new design Tower UA.
Three examples of an IDF specification for this object are shown below:
CoolingTower:SingleSpeed,
My Tower,
!- Name
Condenser Tower Inlet Node,
!- Water Inlet Node Name
Condenser Tower Outlet Node, !- Water Outlet Node Name
.0011,
!- Design Water Flow Rate (m3/s)
16.0,
!- Design Air Flow Rate (m3/s)
10000.,
!- Fan Power at Design Air Flow Rate (W)
3500., !- U-Factor Times Area Value at Design Air Flow Fate (W/C)
0.0,
!- Air Flow Rate in Free Convection Regime (m3/s)
0.0,
!- U-Factor Times Area Value at Free Convection Air Flow Rate (W/C)
UFactorTimesAreaAndDesignWaterFlowRate,!- Performance Input Method
,
!- Nominal Capacity (W)
,
!- Free Convection Capacity (W)
,
!- Basin Heater Capacity {W/K}
,
!- Basin Heater Setpoint Temperature {C}
,
!- Basin Heater Operating Schedule Name
,
!- Evaporation Loss Mode
,
!- Evaporation Loss Factor (percent/K)
,
!- Drift Loss Percent (percent)
,
!- Blowdown Calculation Mode
,
!- Blowdown Concentration Ratio
,
!- Blowdown Makeup Water Usage Schedule Name
,
!- Supply Water Storage Tank Name
,
!- Outdoor Air Inlet Node Name
FluidBypass,
!- Capacity Control
4,
!- Number of Cells
MinimalCell,
!- Cell Control
0.25,
!- Cell Minimum Water Flow Rate Fraction
1.50;
!- Cell Maximum Water Flow Rate Fraction
CoolingTower:SingleSpeed,
My Tower,
!- Name
Condenser Tower Inlet Node, !- Water Inlet Node Name
Condenser Tower Outlet Node,!- Water Outlet Node Name
,
!- Design Water Flow Rate (m3/s)
autosize,
!- Design Air Flow Rate (m3/s)
1000.,
!- Fan Power at Design Air Flow Rate (W)
,
!- U-Factor Times Area Value at Design Air Flow Fate (W/C)
autosize,
!- Air Flow Rate in Free Convection Regime (m3/s)
,
!- U-Factor Times Area Value at Free Convection Air Flow Rate (W/C)
NominalCapacity,
!- Performance Input Method
95250.,
!- Nominal Capacity (W)
9525.;
!- Free Convection Capacity (W)
CoolingTower:SingleSpeed,
TowerWaterSys CoolTower, !- Name
TowerWaterSys Pump-TowerWaterSys CoolTowerNode, !- Water Inlet Node Name
TowerWaterSys Supply Equipment Outlet Node, !- Water Outlet Node Name
AUTOSIZE,
!- Design Water Flow Rate {m3/s}
AUTOSIZE,
!- Design Air Flow Rate {m3/s}

9/29/14

724

Input-Output Reference

Group Condenser Equipment

AUTOSIZE,
!- Fan Power at Design Air Flow Rate {W}
AUTOSIZE,
!- U-Factor Times Area Value at Design Air Flow Rate {W/K}
AUTOSIZE,
!- Air Flow Rate in Free Convection Regime {m3/s}
AUTOSIZE,
!- U-Factor Times Area at Free Convection Air Flow Rate {W/K}
UFactorTimesAreaAndDesignWaterFlowRate, !- Performance Input Method
,
!- Nominal Capacity {W}
,
!- Free Convection Capacity {W}
,
!- Basin Heater Capacity {W/K}
,
!- Basin Heater Setpoint Temperature {C}
,
!- Basin Heater Operating Schedule Name
SaturatedExit,
!- Evaporation Loss Mode
,
!- Evaporation Loss Factor {percent/K}
0.0080,
!- Drift Loss Percent {percent}
ConcentrationRatio,
!- Blowdown Calculation Mode
3.0000,
!- Blowdown Concentration Ratio
,
!- Blowdown Makeup Water Usage Schedule Name
,
!- Supply Water Storage Tank Name
TowerWaterSys CoolTowerOA ref Node, !- Outdoor Air Inlet Node Name
FanCycling,
!- Capacity Control
4,
!- Number of Cells
MinimalCell,
!- Cell Control
0.25,
!- Cell Minimum Water Flow Rate Fraction
1.50,
!- Cell Maximum Water Flow Rate Fraction
1.0000;
!- Sizing Factor

Single Speed Cooling Tower Outputs

HVAC,Average,Cooling Tower Fan Electric Power [W]
HVAC,Sum,Cooling Tower Fan Electric Energy [J]
HVAC,Average,Cooling
HVAC,Average,Cooling
HVAC,Average,Cooling
HVAC,Average,Cooling
HVAC,Average,Cooling
HVAC,Average,Cooling
HVAC,Average,Cooling

Tower
Tower
Tower
Tower
Tower
Tower
Tower

Heat Transfer Rate [W]

Inlet Temperature [C]
Outlet Temperature [C]
Mass Flow Rate [kg/s]
Bypass Fraction []
Fan Cycling Ratio []
Operating Cells Count []

A tower uses either mains water or storage tank for make-up water.
When mains water is used:
HVAC,Average,Cooling Tower Make Up Water Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Tower Make Up Water Volume [m3]
HVAC,Sum,Cooling Tower Make Up Mains Water Volume [m3]
When storage tank water is used:
HVAC,Average,Cooling Tower Make Up Water Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Tower Make Up Water Volume [m3]
HVAC,Sum,Cooling Tower Storage Tank Water Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Tower Storage Tank Water Volume [m3]
HVAC,Sum,Cooling Tower Starved Storage Tank Water Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Tower Starved Storage Tank Water Volume [m3]
HVAC,Sum,Cooling Tower Make Up Mains Water Volume [m3]
HVAC,Average,Cooling Tower Water Evaporation Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Tower Water Evaporation Volume [m3]
HVAC,Average,Cooling Tower Water Drift Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Tower Water Drift Volume [m3]
HVAC,Average,Cooling Tower Water Blowdown Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Tower Water Blowdown Volume [m3]
IF specified:
HVAC,Average,Cooling Tower Basin Heater Electric Power [W]
9/29/14

725

Input-Output Reference

Group Condenser Equipment

HVAC,Sum,Cooling Tower Basin Heater Electric Energy [J]

Cooling Tower Fan Electric Power [W]

Cooling Tower Fan Electric Energy [J]
These outputs are the electric power input to the tower fans. Consumption is metered on
HeatRejection:Electricity, Electricity:Plant, and Electricity:Facility.
Cooling Tower Heat Transfer Rate [W]
This is the rate at which heat is removed from the condenser water loop by the tower.
Cooling Tower Inlet Temperature [C]
Cooling Tower Outlet Temperature [C]
Cooling Tower Mass Flow Rate [kg/s]
These outputs are the tower water inlet and outlet temperatures, and mass flow rate of the
circulating condenser water loop.
Cooling Tower Basin Heater Electric Power [W]
Cooling Tower Basin Heater Electric Energy [J]
These outputs are the electric power input to the tower basin heater. Consumption is metered
on HeatRejection:Electricity, Electricity:Plant, and Electricity:Facility
Cooling Tower Make Up Water Volume Flow Rate [m3/s]
Cooling Tower Make Up Water Volume [m3]
These outputs are the water consumed by the wet cooling tower for external water sprays
used to augment heat transfer. This is the total of evaporation, drift, and blowdown.
Cooling Tower Water Evaporation Volume Flow Rate [m3/s]
Cooling Tower Water Evaporation Volume [m3]
Cooling Tower Water Drift Volume Flow Rate [m3/s]
Cooling Tower Water Drift Volume [m3]
Cooling Tower Water Blowdown Volume Flow Rate [m3/s]
Cooling Tower Water Blowdown Volume [m3]
These outputs provide the breakdown of the different components of water use during cooling
tower operation.
Cooling Tower Make Up Mains Water Volume [m3]
This is the volume of water drawn from mains service to feed the cooling tower.
If a water storage tank is used to provide water to the tower, then the following output
variables will also be available.
Cooling Tower Storage Tank Water Volume Flow Rate [m3/s]
Cooling Tower Storage Tank Water Volume [m3]
These are the rate and volume of water provided by the Water Storage Tank.

9/29/14

726

Input-Output Reference

Group Condenser Equipment

Cooling Tower Starved Storage Tank Water Volume Flow Rate [m3/s]
Cooling Tower Starved Storage Tank Water Volume [m3]
These are the rate and volume of water the Storage Tank connections was not able to
provide. The starved water is assumed to come from the mains. The towers operation is not
affected by a lack of storage tank water.
Cooling Tower Fan Cycling Ratio []
This represents the fraction of a time-step when tower fan is on.
Cooling Tower Bypass Fraction []
This represents the fraction of a fluid bypassing the tower when a mixture of the tower fluid
and tower return water is able to meet the set point temperature.
Cooling Tower Operating Cells Count []
This represents the number of cells operating at each time step.
CoolingTower:TwoSpeed
The two-speed cooling tower is modeled in a similar fashion to the single-speed tower. The
cooling tower is modeled as a counterflow heat exchanger with a two-speed fan (induced
draft configuration) based on Merkels theory. The user must define tower performance via
one of two methods: heat transfer coefficient-area product (UA) and design water flow rate, or
nominal tower capacity at a specific rating point. Regardless of which method is chosen, the
airflow rate and corresponding fan power at both high and low fan speed must be specified.
The model will also account for tower performance in the free convection regime, when the
tower fan is off but the water pump remains on and heat transfer still occurs (albeit at a low
level). If the user wants the model to account for free convection, they must specify the
corresponding air flow rate and heat transfer coefficient-area product (UA), or the nominal
tower capacity during this mode of operation.
The cooling tower seeks to maintain the temperature of the water exiting the cooling tower at
(or below) a set point. The set point schedule value is defined by the field Condenser Loop
Temperature Setpoint Node Name or Reference for the CondenserLoop object. The model
first checks to determine the impact of free convection, if specified by the user, on the tower
exiting water temperature. If the exiting water temperature based on free convection is at or
below the set point, then the tower fan is not turned on. If the exiting water temperature
remains above the set point after free convection is modeled, then the tower fan is turned
on at low speed to reduce the exiting water temperature. If operating the tower fan at low
speed does not reduce the exiting water temperature to the set point, then the tower fan is
increased to its high speed.
The model assumes that part-load operation is represented by a simple linear interpolation
between two steady-state regimes (i.e., tower fan at high speed for the entire simulation
timestep and tower fan at low speed for the entire simulation timestep, or tower fan at low
speed for the entire simulation timestep and tower fan off for the entire simulation timestep).
Cyclic losses are not taken into account.
Cooling towers here are wet and consume water through evaporation, drift, and blowdown.
The model can be used to predict water consumed by the towers. The last six input fields are
optional and provide methods of controlling details of the water consumption calculations.
The user can specifiy connections to the rest of the buildings water system by providing the
name of a WaterUse:Storage object.
For the operation of multi-cell towers, the first step is to determine the number of cells to
operate based on the cell control method between the minimum number of cells subject to
the maximum water flow rate fraction per cell, and maximum number of cells subject to the
minimum water flow rate fraction per cell. If the calculated cells do not meet the loads,

9/29/14

727

Input-Output Reference

Group Condenser Equipment

additional cells will be operating to help meet the loads. Inside each cell, the existing capacity
controls still apply.
For multi-cell towers, the following inputs are assumed to be for the entire tower including all
cells:
Design Water Flow Rate; Design Air Flow Rate; Fan Power at Design Air Flow Rate;
Air Flow Rate in Free Convection Regime; Nominal Capacity; Free Convection Capacity
BASIN HEATER (we assume that there is a common basin)
Field: Name
This alpha field contains the identifying name for the cooling tower.
Field: Water Inlet Node Name
This alpha field contains the identifying name for the cooling towers water inlet node.
Field: Water Outlet Node Name
This alpha field contains the identifying name for the cooling towers water outlet node.
Field: Design Water Flow Rate
This numeric field contains the design water flow rate through the tower in m 3/s. This value is
the flow rate of the condenser loop water being cooled by the tower (not the flow rate of water
being sprayed on the outside of the heat exchange coil). If the input field Performance Input
Method is specified as UFactorTimesAreaAndDesignWaterFlowRate, then a water flow
rate greater than zero must be defined or the field can be autosized. If autosized, a Plant
Sizing object must be defined and the design water flow rate is derived from the design load
to be rejected by the condenser loop and the design loop delta T (Ref. Sizing and Input for
Design Calculations and Component Autosizing sections). If Performance Input Method is
specified as NominalCapacity, then this field must be left blank since the model
automatically assumes a design water flow rate of 5.382E-8 m3/s per watt (3 gpm/ton) of
tower capacity specified in the field Tower High-Speed Nominal Capacity.
Field: High Fan Speed Air Flow Rate
This numeric field contains the tower air flow rate at high fan speed in m 3/s. A value greater
than zero must be defined regardless of the tower performance input method. Alternately, this
field can be autosized. If autosized, the design air flow rate is calculated as follows:
Air Flow Rate at High Fan Speed

0.5

air

( Fan Power at High Fan Speed )

190.

where a fan pressure rise of 190 Pascals and total fan efficiency of 0.5 are assumed.
Field: High Fan Speed Fan Power
This numeric field contains the fan power (in Watts) at the high-speed air flow rate specified
in the previous field. A value greater than zero must be specified regardless of the tower
performance input method, or this field can be autosized. If autosized, the fan power is
calculated as follows:
If Performance Input Method is specified as UFactorTimesAreaAndDesignWaterFlowRate,
then

Fan powerHigh Fan Speed

0.0105

water

C p, water Design Water Flow Rate Design Loop T

is used.
If Performance Input Method is specified as NominalCapacity, then

Fan powerHigh Fan Speed

9/29/14

0.0105 Tower High Speed Nominal Capacity

728

Input-Output Reference

Group Condenser Equipment

is used.
Field: High Fan Speed U-Factor Times Area Value
This numeric field contains the heat transfer coefficient-area product (UA) in watts per degree
Celsius corresponding to the high-speed air flow rate and design water flow rate specified
above. If the input field Performance Input Method is specified as
UFactorTimesAreaAndDesignWaterFlowRate, then a UA value greater than zero but less
than or equal to 300,000 must be defined, or the field can be autosized. If autosized, a Plant
Sizing object must be defined and the tower UA value at high fan speed is derived from the
design load to be rejected by the condenser loop and the design loop delta T (Ref. Sizing and
Input for Design Calculations and Component Autosizing sections), assuming a tower water
inlet temperature of 35C and tower inlet air at 35C drybulb/25.6C wetbulb. If Performance
Input Method is specified as NominalCapacity, then this field must be left blank since the
model automatically calculates the tower UA based on the capacity specified in the field
High-Speed Nominal Capacity.
Field: Low Fan Speed Air Flow Rate
This numeric field contains the tower air flow rate at low fan speed in m 3/s. This value must
be greater than zero, less than the value specified for the field Air Flow Rate at High Fan
Speed, and greater than the value specified for the field Air Flow Rate in Free Convection
Regime. This field may be autocalculated, in which case it is set to a fraction of the Air Flow
Rate at High Fan Speed determined in the next field.
Field: Low Fan Speed Air Flow Rate Sizing Factor
This numeric field contains the sizing factor to use when calculating the low fan speed air flow
rate. The default is 0.5.
Field: Low Fan Speed Fan Power
This numeric field contains the fan power (in Watts) at the low-speed air flow rate specified in
the previous field. This value must be specified greater than zero or the field may be
autocalculated, in which case it is set to a fraction of the Fan Power at High Fan Speed
determined in the next field.
Field: Low Fan Speed Fan Power Sizing Factor
This numeric field contains the sizing factor to use when calculating the low speed fan power.
The default is 0.16.
Field: Low Fan Speed U-Factor Times Area Value
This numeric field contains the heat transfer coefficient-area product (UA) in watts per degree
Celsius corresponding to the design water flow rate and low-speed air flow rate specified
above. If the input field Performance Input Method is specified as
UFactorTimesAreaAndDesignWaterFlowRate, this value must be greater than zero but less
than or equal to 300,000, less than the value specified for the field U-Factor Times Area
Value at High Fan Speed, and greater than the value specified for the field U-Factor Times
Area Value at Free Convection Air Flow Rate. This field may be autocalculated, in which
case it is set to a fraction of the U-Factor Times Area Value at High Fan Speed determined
in the following field. If Performance Input Method is specified as NominalCapacity, then
this field must be left blank since the model automatically calculates the tower UA based on
the tower capacity specified in the field Low Speed Nominal Capacity.
Field: Low Fan Speed U-Factor Times Area Sizing Factor
This numeric field contains the sizing factor to use when calculating the low speed heat
transfer coefficient-area product (UA). The default is 0.6.

9/29/14

729

Input-Output Reference

Group Condenser Equipment

Field: Free Convection Regime Air Flow Rate

This numeric field contains the air flow rate (m 3/s) when the tower is in the free convection
regime (water flow exists but tower fan is turned off). This value must be less than the value
specified for the field Air Flow Rate at Low Fan Speed. This field may be autocalculated, in
which case it is set to a fraction of the Air Flow Rate at High Fan Speed determined in the
following field. If the user does not wish to model free convection and is using the
Performance Input Method UFactorTimesAreaAndDesignWaterFlowRate, then this field
should be set to 0.0. If the user specifies the U-Factor Times Area Value at Free Convection
Air Flow Rate or Free Convection Capacity as a value greater than zero, then the free
convection air flow rate must be specified greater than 0.0.
Field: Free Convection Air Flow Rate Sizing Factor
This numeric field contains the sizing factor to use when calculating the free convection
regime air flow rate. The default is 0.1.
Field: Free Convection U-Factor Times Area Value
This numeric field contains the heat transfer coefficient-area product (W/C) when the tower
is in the free convection regime (water flow exists but tower fan is turned off). This value
must be less than the value specified for the field U-Factor Times Area Value at Low Fan
Speed. This field may be autocalculated, in which case it is set to a fraction of the U-Factor
Times Area Value at High Fan Speed determined in the following field. If the user does not
wish to model free convection and is using the Performance Input Method
UFactorTimesAreaAndDesignWaterFlowRate, then this field should be set to 0.0. If
Performance Input Method is specified as NominalCapacity, then this field must be left
blank since the model automatically calculates the tower UA based on the tower capacity
specified in the field Free Convection Capacity.
Field: Free Convection U-Factor Times Area Value Sizing Factor
This numeric field contains the sizing factor to use when calculating the free convection
regime U-Factor times area value. The default is 0.1.
Field: Performance Input Method
This alpha field contains the method by which the user will specify tower performance:
UFactorTimesAreaAndDesignWaterFlowRate or NominalCapacity. If this field is left blank
in the input data file, the default input method is assumed to be
UFactorTimesAreaAndDesignWaterFlowRate.
If
the
method
UFactorTimesAreaAndDesignWaterFlowRate is selected, then the user must enter UA
values, design water flow rate and air flow rates as described for the previous input fields. If
the method NominalCapacity is selected then the fields Design Water Flow Rate, UFactor Times Area Value at High Fan Speed, U-Factor Times Area Value at Low Fan
Speed and U-Factor Times Area Value at Free Convection Air Flow Rate must be left
blank, but the fields High Speed Nominal Capacity, Low Speed Nominal Capacity and
Free Convection Capacity must be entered as described below.
Field: Heat Rejection Capacity and Nominal Capacity Sizing Ratio
This numeric field contains the value for the ratio of actual tower heat rejection to nominal
capacity. This ratio is defined at entering water at 35C (95F), leaving water at 29.4C (85F),
entering air at 25.6C (78F) wetbulb and 35C (95F) drybulb temperatures. Historically this ratio
has been set at 1.25 based on the assumption that the tower must dissipate 0.25 W of
compressor power for every what of heat removed at the chiller evaporator. The default is
1.25.
Field: High Speed Nominal Capacity
This numeric input field contains the nominal heat rejection capacity of the cooling tower in
watts under high-speed fan operation, with entering water at 35C (95F), leaving water at
9/29/14

730

Input-Output Reference

Group Condenser Equipment

29.4C (85F), entering air at 25.6C (78F) wetbulb and 35C (95F) drybulb temperatures. The
design water flow rate is assumed to be 5.382E-8 m3/s per watt of high-speed nominal
capacity (3 gpm/ton). The Heat Rejection Capacity and Nominal Capacity Sizing Ratio set in
the previous field is applied to this nominal tower capacity to give the actual tower heat
rejection at these operating.
Field: Low Speed Nominal Capacity
This numeric input field contains the nominal heat rejection capacity of the cooling tower in
watts under low-speed fan operation, with entering water at 35C (95F), leaving water at
29.4C (85F), entering air at 25.6C (78F) wetbulb and 35C (95F) drybulb temperatures. The
design water flow rate is assumed to be 5.382E-8 m3/s per watt of high-speed nominal tower
capacity (input field above). The Heat Rejection Capacity and Nominal Capacity Sizing Ratio
is applied to this nominal tower capacity to give the actual tower heat rejection at these
operating conditions. The value specified for this field must be greater than zero but less than
the value specified for the field High-Speed Nominal Capacity. This field may be
autocalculated, in which case it is set to a fraction of the High Speed Nominal Capacity
determined in the following field.
Field: Low Speed Nominal Capacity Sizing Factor
This numeric field contains the sizing factor to use when calculating the Low Speed Nominal
Capacity. The default is 0.5.
Field: Free Convection Capacity
This numeric input field contains the nominal heat rejection capacity of the cooling tower in
watts when the tower is in the free convection regime (water flow exists but tower fan is
turned off), with entering water at 35C (95F), leaving water at 29.4C (85F), entering air at
25.6C (78F) wetbulb and 35C (95F) drybulb temperatures. The design water flow rate is
assumed to be 5.382E-8 m3/s per watt of high-speed nominal tower capacity (input field
above). The Heat Rejection Capacity and Nominal Capacity Sizing Ratio is applied to this
free convection tower capacity to give the actual tower heat rejection at these operating
conditions.The value specified for this field must be less than the value specified for the field
Tower Low-Speed Nominal Capacity. If the user does not wish to model free convection,
then this field should be set to 0.0. If the user specifies a value greater than zero, then the
Air Flow Rate in Free Convection Regime field must contain a value greater than zero. This
field may be autocalculated, in which case it is set to a fraction of the High Speed Nominal
Capacity determined in the following field.
Field: Free Convection Nominal Capacity Sizing Factor
This numeric field contains the sizing factor to use when calculating the Free Convection
Capacity. The default is 0.1.
Field: Basin Heater Capacity
This numeric field contains the capacity of the towers electric basin heater in watts per
degree Kelvin. This field is used in conjunction with the Basin Heater Setpoint Temperature
described in the following field. The basin heater electric power is equal to this field multiplied
by the difference between the basin heater set point temperature and the outdoor dry-bulb
temperature. The basin heater only operates when the tower fan is off and water is not
flowing through the tower, regardless of the basin heater schedule described below. The
basin heater capacity must be greater than or equal to zero, with a default value of zero if this
field is left blank.
Field: Basin Heater Setpoint Temperature
This numeric field contains the set point temperature (C) for the basin heater described in
the previous field. The basin heater is active when the outdoor air dry-bulb temperature falls
below this setpoint temperature, as long as the tower fan is off and water is not flowing
9/29/14

731

Input-Output Reference

Group Condenser Equipment

through the tower. This set point temperature must be greater than or equal to 2C, and the
default value is 2C if this field is left blank.
Field: Basin Heater Operating Schedule Name
This alpha field contains the name of the basin heater operating schedule. The basin heater
operating schedule is assumed to be an on/off schedule and the heater is available to
operate any time the schedule value is greater than 0. The basin heater operates when
scheduled on and the outdoor air dry-bulb temperature is below the set point temperature
described in the previous field. If this field is left blank, the basin heater is available to operate
throughout the simulation. Regardless of this schedule, the basin heater may only operate
when the cooling tower fan is off and water is not flowing through the tower.
Field: Evaporation Loss Mode
This field is used to choose which method is used to model the amount of water evaporated
by the cooling tower. There are two options: LossFactor or SaturatedExit. The default is
SaturatedExit. The user-defined loss factor is entered in the following field. By assuming that
the air leaving the tower is saturated, the evaporation can be directly calculated using moist
air engineering calculations with data available within the cooling tower model (and does not
require additional user input).
Field: Evaporation Loss Factor
This field is used to specify the rate of water evaporated from the cooling tower and lost to
the outside air [percent/K]. This field is only used if the Evaporation Calculation Mode is set to
LossFactor. The evaporation loss is then calculated as a fraction of the circulating condenser
water flow and varies with the temperature change in the condenser water. The value entered
here is in units of percent-per-degree Kelvin. The evaporation rate will equal this value times
each degree Kelvin of temperature drop in the condenser water. Typical values are from 0.15
to 0.27 [percent/K]. The default is 0.2.
Field: Drift Loss Percent
This field is used to specify the rate of water lost to the exiting air as entrained droplets [%].
The drift loss is a percent of the condenser water flow. Typical values for towers with efficient
drift eliminators are between 0.002 and 0.2% of the condenser water flow rate. The default
value is 0.008%.
Field: Blowdown Calculation Mode
This field specifies which method is used to determine blowdown rates. There two options
ConcentrationRatio or ScheduledRate. The choice will determine which of the two models
below is used. The default is ConcentrationRatio
Field: Blowdown Concentration Ratio
This field is used to dynamically adjust the rate of blowdown in the cooling tower as a function
of the rate of evaporation. Blowdown is water intentionally drained from the tower in order to
offset the build up of solids in the water that would otherwise occur because of evaporation.
The value entered here is dimensionless. It can be characterized as the ratio of solids in the
blowdown water to solids in the make up water. Typical values for tower operation are 3 to 5.
The default value is 3.
Field: Blowdown Makeup Water Usage Schedule Name
This alpha field contains the name of the schedule used to define the amount of water (m3/s)
flushed from the basin on a periodic basis to purge the tower of mineral scale build-up and
other contaminants. This schedule is only used if the Blowdown Calculation mode is set to
ScheduledRate. The amount of water use due to blowdown depends on the makeup water
quality and is specific to each geographical location. Typical values range from 0.0002 to
0.0013 m3/s (17.3 to 112.3 m 3/day). This water usage is in addition to the amount of water
9/29/14

732

Input-Output Reference

Group Condenser Equipment

lost to the atmosphere due to evaporation and/or drift. Since blowdown occurs when the
basin water contaminant concentration is high, blowdown only occurs when the cooling tower
is active and water is flowing through the tower (regardless of the water usage defined by this
schedule).
Field: Supply Water Storage Tank Name
This field is optional. It is used to describe where the tower obtains water used for
evaporative cooling. If blank or omitted, then the tower will obtain water directly from the
mains. If the name of a WaterUse:Storage object is used here, then the tower will obtain its
water from that tank. If a tank is specified, the tower will attempt to obtain all the water it uses
from the tank. However if the tank cannot provide all the water the tower needs, then the
tower will still operate and obtain the rest of the water it needs from the mains (referred to as
Starved water).
Field: Outdoor Air Inlet Node Name
This optional alpha field specifies the outdoor air node name used to define the conditions of
the air entering the cooling tower. If this field is left blank, the outdoor air conditions entering
the cooling tower are taken directly from the weather data. If this field is not blank, the node
name specified must also be specified in an OutdoorAir:Node object where the height of the
node is taken into consideration when calculating outdoor air conditions from the weather
data. Alternately, the node name may be specified in an OutdoorAir:NodeList object where
the outdoor air conditions are taken directly from the weather data.
Field: Number of Cells
This integer field contains the number of cells in the multi-cell cooling tower. If not entered,
the program will assume it is a single-cell cooling tower
Field: Cell Control
This alpha field specifies the method used to control the number of cells used to meet the
load, the two choices are:
MinimalCell: the program will use minimal number of cells needed, all other cells will be shut
down with no water flow. It will attempt to use as few cells as possible to cool the fluid. In no
case, however, will the flow per cell be allowed to exceed its maximum value defined by the
Maximum Water Flow Rate Fraction.
MaximalCell: As many cells as possible will be turned on. In no case, however, will the flow
per cell be allowed to drop below its minimum value specified by the Minimum Water Flow
Rate Fraction.
Field: Cell Minimum Water Flow Rate Fraction
This numeric field specifies the allowable smallest fraction of the design water flow rate.
Flows less than this value will commonly result in fluid distribution problems; the pressure at
each nozzle will be too weak for the fluid to be sprayed out in the correct pattern, not all the
fill would be wet. If this field is left blank, the default value is 0.33.
Field: Cell Maximum Water Flow Rate Fraction
This numeric field specifies the allowable largest fraction of the design water flow rate. If this
field is left blank, the default value is 2.5.
Field: Sizing Factor
This optional numeric field allows the user to specify a sizing factor for this component. The
sizing factor is used when the component design inputs are autosized: the autosizing
calculations are performed as usual and the results are multiplied by the sizing factor. Sizing
factor allows the user to size a component to meet part of the design load while continuing to
use the autosizing feature.For this component the inputs that would be altered by the sizing
factor are:
9/29/14

733

Input-Output Reference

Group Condenser Equipment

1. Design Water Flow Rate;

2. Air Flow Rate at High Fan Speed;
3. Fan Power at High Fan Speed;
4. U-Factor Times Area Value at High Fan Speed;
5. Air Flow Rate at Low Fan Speed;
6. Fan Power at Low Fan Speed;
7. U-Factor Times Area Value at Low Fan Speed;
8. Air Flow Rate in Free Convection Regime;
9. U-Factor Times Area Value at Free Convection Air Flow Rate.
Note that the U-Factor Times Area Value at High Fan Speed is not multiplied by the Sizing
Factor. Instead the design tower load is multiplied by the sizing factor and the design UA then
calculated as usual. The U-Factor Times Area Value at Low Fan Speed is set to a fraction of
the full load design UA determined by the field Low Fan Speed U-Factor Times Area Sizing
Factor. The U-Factor Times Area Value at Free Convection Air Flow Rate is set to a fraction
of the design Tower UA determined by the field Free Convection Air U-Factor Times Area
Value Sizing Factor.
Four examples of an IDF specification for this object are shown below:
CoolingTower:TwoSpeed,
My Tower,
!- Name
Condenser Tower Inlet Node,
!- Water inlet node name
Condenser Tower Outlet Node,
!- Water outlet node name
.0011,
!- Design water flow rate, m3/s
16.0,
!- Air flow rate at high fan speed, m3/s
10000,
!- Fan power at high fan speed, W
3500.,
!- Tower UA at high fan speed, W/C
8.0,
!- Air flow rate at low fan speed, m3/s
1600,
!- Fan power at low fan speed, W
2100.,
!- Tower UA at low fan speed, W/C
1.6,
!- Air flow rate for free convection, m3/s
350,
!- Tower UA at free convection air flow, W/C
UFactorTimesAreaAndDesignWaterFlowRate; !- Tower performance input method
CoolingTower:TwoSpeed,
My Tower,
!- Name
Condenser Tower Inlet Node,
!- Water Inlet Node Name
Condenser Tower Outlet Node, !- Water Outlet Node Name
,
!- Design Water Flow Rate {m3/s}
8.0,
!- Air Flow Rate at High Fan Speed {m3/s}
500,
!- Fan Power at High Fan Speed {W}
,
!- U-Factor Times Area Value at High Fan Speed {W/K}
4.0,
!- Air Flow Rate at Low Fan Speed {m3/s}
125,
!- Fan Power at Low Fan Speed {W}
,
!- U-Factor Times Area Value at Low Fan Speed {W/K}
0.8,
!- Air Flow Rate in Free Convection Regime {m3/s}
,
!- U-Factor Times Area Value at Free Convection Air Flow Rate {W/K}
NominalCapacity,
!- Performance Input Method
20000.0,
!- High Speed Nominal Capacity {W}
10000.0,
!- Low Speed Nominal Capacity {W}
2000.0;
!- Free Convection Capacity {W}
CoolingTower:TwoSpeed,
Big Tower1, !- Tower Name
Condenser Tower 1 Inlet Node, !- Water Inlet Node Name
Condenser Tower 1 Outlet Node, !- Water Outlet Node Name
9/29/14

734

Input-Output Reference

Group Condenser Equipment

, !- Design Water Flow Rate {m3/s}

8.0, !- Design High Speed Air Flow Rate {m3/s}
500, !- Fan Power at Design High Speed Air Flow Rate {W}
, !- Tower UA Value at Design High Speed Air Flow Rate {W/K}
4.0, !- Design Low Speed Air Flow Rate {m3/s}
125, !- Fan Power at Design Low Speed Air Flow Rate {W}
, !- Tower UA Value at Design Low Speed Air Flow Rate {W/K}
0.8, !- Air Flow Rate in Free Convection Regime {m3/s}
, !- Tower UA Value at Free Convection Air Flow Rate {W/K}
NominalCapacity, !- Tower Performance Input Method
20000.0, !- Tower High Speed Nominal Capacity
10000.0, !- Tower Low Speed Nominal Capacity
2000.0, !- Tower Free Convection Nominal Capacity
,
!- Basin Heater Capacity {W/K}
,
!- Basin Heater Setpoint Temperature {C}
,
!- Basin Heater Operating Schedule Name
SaturatedExit, !- Evaporation Loss Mode
, !- Evaporation Loss Factor [%/C]
0.008 , !- Drift Loss Percent
ConcentrationRatio, !- Blowdown Calculation Mode
3.0, !- Blowdown Concentration Ratio
, !- Schedule Name for Makeup Water Usage due to Blowdown
Recovery Tank; !- Name of Water Storage Tank for Supply
CoolingTower:TwoSpeed,
TowerWaterSys CoolTower,
!- Name
TowerWaterSys Pump-TowerWaterSys CoolTowerNode, !- Water Inlet Node Name
TowerWaterSys Supply Equipment Outlet Node, !- Water Outlet Node Name
AUTOSIZE,
!- Design Water Flow Rate {m3/s}
AUTOSIZE,
!- Air Flow Rate at High Fan Speed {m3/s}
AUTOSIZE,
!- Fan Power at High Fan Speed {W}
AUTOSIZE,
!- U-Factor Times Area Value at High Fan Speed {W/K}
AUTOSIZE,
!- Air Flow Rate at Low Fan Speed {m3/s}
AUTOSIZE,
!- Fan Power at Low Fan Speed {W}
AUTOSIZE,
!- U-Factor Times Area Value at Low Fan Speed {W/K}
AUTOSIZE,
!- Air Flow Rate in Free Convection Regime {m3/s}
AUTOSIZE,
!- U-Factor Times Area at Free Convection Air Flow Rate {W/K}
UFactorTimesAreaAndDesignWaterFlowRate,
!- Performance Input Method
,
!- High Speed Nominal Capacity {W}
,
!- Low Speed Nominal Capacity {W}
,
!- Free Convection Capacity {W}
, !- Basin Heater Capacity {W/K}
, !- Basin Heater Setpoint Temperature {C}
, !- Basin Heater Operating Schedule Name
SaturatedExit, !- Evaporation Loss Mode { LossFactor | SaturatedExit }
, !- Evaporation Loss Factor
0.0080, !- Drift Loss Percent
ConcentrationRatio, !- Blowdown Calculation Mode { ConcentrationRatio |
!- ScheduledRate }
3.0000, !- Blowdown Concentration Ratio
, !- Blowdown Makeup Water Usage Schedule Name
, !- Supply Water Storage Tank Name
TowerWaterSys CoolTower OA ref Node, !- Outdoor Air Inlet Node Name
,
!- Number of cells available
MinimalCell, !- Cell Control
,
!- Cell Minimum Water Flow Rate Fraction
,
!- Cell Maximum Water Flow Rate Fraction
1.0000; !- Sizing Factor

Two Speed Cooling Tower Outputs

HVAC,Average,Cooling Tower Fan Electric Power [W]
9/29/14

735

Input-Output Reference

Group Condenser Equipment

HVAC,Sum,Cooling Tower Fan Electric Energy [J]

HVAC,Average,Cooling
HVAC,Average,Cooling
HVAC,Average,Cooling
HVAC,Average,Cooling
HVAC,Average,Cooling
HVAC,Average,Cooling
HVAC,Average,Cooling
HVAC,Average,Cooling

Tower
Tower
Tower
Tower
Tower
Tower
Tower
Tower

Heat Transfer Rate [W]

Inlet Temperature [C]
Outlet Temperature [C]
Mass Flow Rate [kg/s]
Fan Cycling Ratio []
Operating Cells Count []
Fan Speed Level []
Bypass Fraction []

A tower uses either mains water or storage tank for make-up water.
When mains water is used:
HVAC,Average,Cooling Tower Make Up Water Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Tower Make Up Water Volume [m3]
HVAC,Sum,Cooling Tower Make Up Mains Water Volume [m3]
When storage tank water is used:
HVAC,Average,Cooling Tower Make Up Water Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Tower Make Up Water Volume [m3]
HVAC,Sum,Cooling Tower Storage Tank Water Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Tower Storage Tank Water Volume [m3]
HVAC,Sum,Cooling Tower Starved Storage Tank Water Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Tower Starved Storage Tank Water Volume [m3]
HVAC,Sum,Cooling Tower Make Up Mains Water Volume [m3]
HVAC,Average,Cooling Tower Water Evaporation Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Tower Water Evaporation Volume [m3]
HVAC,Average,Cooling Tower Water Drift Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Tower Water Drift Volume [m3]
HVAC,Average,Cooling Tower Water Blowdown Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Tower Water Blowdown Volume [m3]
IF specified:
HVAC,Average,Cooling Tower Basin Heater Electric Power [W]
HVAC,Sum,Cooling Tower Basin Heater Electric Energy [J]

Cooling Tower Fan Electric Power [W]

Cooling Tower Fan Electric Energy [J]
These outputs are the electric power input to the tower fans. Consumption is metered on
HeatRejection:Electricity, Electricity:Plant, and Electricity:Facility.
Cooling Tower Heat Transfer Rate [W]
This is the rate at which heat is removed from the condenser water loop by the tower.
Cooling Tower Inlet Temperature [C]
Cooling Tower Outlet Temperature [C]
Cooling Tower Mass Flow Rate [kg/s]
These outputs are the tower water inlet and outlet temperatures, and mass flow rate.
Cooling Tower Basin Heater Electric Power [W]
Cooling Tower Basin Heater Electric Energy [J]
These outputs are the electric power input to the tower basin heater. Consumption is metered
on HeatRejection:Electricity, Electricity:Plant, and Electricity:Facility

9/29/14

736

Input-Output Reference

Group Condenser Equipment

Cooling Tower Make Up Water Volume Flow Rate [m3/s]

Cooling Tower Make Up Water Volume [m3]
These outputs are the water consumed by the wet cooling tower for external water sprays
used to augment heat transfer. This is the total of evaporation, drift, and blowdown.
Cooling Tower Water Evaporation Volume Flow Rate [m3/s]
Cooling Tower Water Evaporation Volume [m3]
Cooling Tower Water Drift Volume Flow Rate [m3/s]
Cooling Tower Water Drift Volume [m3]
Cooling Tower Water Blowdown Volume Flow Rate [m3/s]
Cooling Tower Water Blowdown Volume [m3]
These outputs provide the breakdown of the different components of water use during cooling
tower operation.
Cooling Tower Make Up Mains Water Volume [m3]
This is the volume of water drawn from mains service to feed the cooling tower. If a water
storage tank is used to provide water to the tower, then the following output variables will also
be available.
Cooling Tower Storage Tank Water Volume Flow Rate [m3/s]
Cooling Tower Storage Tank Water Volume [m3]
These are the rate and volume of water provided by the Water Storage Tank.
Cooling Tower Starved Storage Tank Water Volume Flow Rate [m3/s]
Cooling Tower Starved Storage Tank Water Volume [m3]
These are the rate and volume of water the Storage Tank connections was not able to
provide. The starved water is assumed to come from the mains. The towers operation is not
affected by a lack of storage tank water.
Cooling Tower Fan Cycling Ratio []
This represents the fraction of a time-step when tower fan is on. The fan can cycle at both
speeds.
Cooling Tower Operating Cells Count []
This represents the number of cells operating at each time step.
Cooling Tower Fan Speed Level []
This represents the fan speed operating at each time step: 2 for High Speed, 1 for Low
Speed, and 0 when the fan is OFF.
CoolingTower:VariableSpeed:Merkel
This variable speed tower model is based on Merkel's theory and is similar to the singlespeed and two-speed tower models. The closed-circuit cooling tower is modeled as a
counter flow heat exchanger with a variable-speed fan drawing air through the tower
(induced-draft configuration). The model also includes a free convection regime where
cooling tower performance modeled with the fan off.
For this model, Merkels theory is modified to include adjustments developed by Scheier to
alter the heat transfer effectiveness based on current wetbulb, air flow rates, and water flow
rates. The input requires performance curves or lookup tables to describe these three
adjustment factors.
9/29/14

737

Input-Output Reference

Group Condenser Equipment

For a multi-cell tower, the capacity and air/water flow rate inputs are for the entire tower.
Field: Name
This alpha field contains the identifying name for the cooling tower.
Field: Water Inlet Node Name
This alpha field contains the identifying name for the cooling towers water inlet node.
Field: Water Outlet Node Name
This alpha field contains the identifying name for the cooling towers water outlet node.
Field: Performance Input Method
This alpha field contains the method by which the user will specify tower performance:
UFactorTimesAreaAndDesignWaterFlowRate or NominalCapacity. If this field is left
blank in the input data file, the default input method is assumed to be NominalCapacity. If
the method is selected, then the user must enter design UA values, design water flow rates
and air flow rates as described for the previous input fields. If the method NominalCapacity
is selected then the fields Design Water Flow Rate, U-Factor Times Area Value at Design
Air Flow Rate and U-Factor Times Area Value at Free Convection Air Flow Rate must be
left blank, but the fields Nominal Capacity and Free Convection Capacity must be entered
as described below.
Field: Heat Rejection Capacity and Nominal Capacity Sizing Ratio
This numeric field contains the value for the ratio of actual tower heat rejection to nominal
capacity. This ratio is defined at entering water at 35C (95F), leaving water at 29.4C (85F),
entering air at 25.6C (78F) wetbulb and 35C (95F) drybulb temperatures. Historically this ratio
has been set at 1.25 based on the assumption that the tower must dissipate 0.25 W of
compressor power for every what of heat removed at the chiller evaporator. The default is
1.25.
Field: Nominal Capacity
This numeric input field contains the nominal heat rejection capacity of the cooling tower in
watts under full-speed fan operation, with entering water at 35C (95F), leaving water at 29.4C
(85F), entering air at 25.6C (78F) wetbulb and 35C (95F) drybulb temperatures. The Heat
Rejection Capacity and Nominal Capacity Sizing Ratio set in the previous field is applied to
this nominal tower capacity to give the actual tower heat rejection at these operating
conditions. This field can be autosized, in which case a Sizing:Plant object is needed for the
condenser loop.
Field: Free Convection Nominal Capacity
This numeric input field contains the nominal heat rejection capacity of the cooling tower in
watts when the tower is in the free convection regime (water flow exists but tower fan is
turned off), with entering water at 35C (95F), leaving water at 29.4C (85F), entering air at
25.6C (78F) wetbulb and 35C (95F) drybulb temperatures. The Heat Rejection Capacity and
Nominal Capacity Sizing Ratio is applied to this free convection tower capacity to give the
actual tower heat rejection at these operating conditions.The value specified for this field
must be less than the value specified for the field Tower Low-Speed Nominal Capacity. If
the user does not wish to model free convection, then this field should be set to 0.0. If the
user specifies a value greater than zero, then the Air Flow Rate in Free Convection Regime
field must contain a value greater than zero. This field may be autocalculated, in which case it
is set to a fraction of the High Speed Nominal Capacity determined in the following field.
Field: Free Convection Nominal Capacity Sizing Factor
This numeric field contains the sizing factor to use when calculating the Free Convection
Capacity. The default is 0.1.
9/29/14

738

Input-Output Reference

Group Condenser Equipment

Field: Design Water Flow Rate

This numeric field contains the design water flow rate through the tower in m 3/s. This value is
the flow rate of the condenser loop water being cooled by the tower. If the input field
Performance Input Method is specified as UFactorTimesAreaAndDesignWaterFlowRate,
then a water flow rate greater than zero must be defined or the field can be autosized. If
autosized, a Sizing:Plant object must be defined and the design water flow rate is derived
from the design load to be rejected by the condenser loop and the design loop delta T (Ref.
Sizing and Input for Design Calculations and Component Autosizing sections). If
Performance Input Method is specified as NominalCapacity, then this field can be
autocalculated using the sizing factor in the following field.
Field: Design Water Flow Rate per Unit of Nominal Capacity
This numeric field contains a scalable sizing factor for design water flow rate that scales with
nominal capacity, in units of m 3/s/W. The default value is 5.382*10-8. This field is only used if
the previous field is set to autocalculate and performance input method is NominalCapacity.
(If the performance input method is set to UFactorTimesAreaAndDesignWaterFlowRate then
the design water flow rate is obtained from the plant sizing result.)
Field: Design Air Flow Rate
This numeric field contains the tower air flow rate at full fan speed, in m 3/s. The value can be
autocalculated, in which case the air flow rate is based off of the scalable sizing factor in the
following input field.
Field: Design Air Flow Rate Per Unit of Nominal Capacity
This numeric field contains the sizing factor to use when calculating the design air flow rate
from the nominal capacity, in units of m 3/s/W. The default is 2.76316*10-5. When this field is
left blank, then the default value is used but the flow rate is also scaled to account for
elevation (with larger volume flow rates at higher altitudes). When a hard value is entered,
even if it is the same as the default, then the design air flow rate is not also adjusted for
elevation and the scaling factor is used directly.
Field: Minimum Air Flow Rate Ratio
This numeric field contains the minimum air flow rate ratio. The tower fan is allowed to
operate between the ratio defined here and a maximum air flow rate ratio of 1.0 (which
corresponds to the design [maximum] tower air flow rate). Below this value the tower is
assumed to operate in the free convection regime with the tower fan off. The minimum air
flow rate ratio must be greater than or equal to 0.1 and less than or equal to 0.5, with a
default value of 0.2 if the field is left blank.
Field: Design Fan Power
This numeric field contains the fan power in watts at the design (maximum) air flow rate
through the tower. A value greater than zero must be specified or this field can be
autocalculated. When the field is autocalculated the following input field is used to size the
fan power based on nominal capacity.
Field: Design Fan Power Per Unit of Nominal Capacity
This numeric field contains the sizing factor to use when calculating the design fan power
from the nominal capacity, in units of Watts per Watt. This field is only used if the previous is
set to autocalculate. The default values is 0.0105.
Field: Fan Power Modifier Function of Air Flow Rate Ratio Curve Name
This alpha field contains the name of a curve or table object that describes fan power ratio
(fan power/design fan power) as a function of air flow rate ratio (air flow rate/design air flow
rate). The curve or table object must be for one independent variable, typically a cubic, and
should be normalized to 1.0 at an air flow rate ratio of 1.0. This field is required.
9/29/14

739

Input-Output Reference

Group Condenser Equipment

Field: Free Convection Regime Air Flow Rate

This numeric field contains the air flow rate (m 3/s) when the tower is in the free convection
regime (water flow exists but tower fan is turned off). This value must be less than the value
specified for the field Design Air Flow Rate. This field may be autocalculated, in which case
it is set to a fraction of the Design Air Flow Rate determined in the following input field. If the
user does not wish to model free convection and is using the Performance Input Method
UFactorTimesAreaAndDesignWaterFlowRate, then this field should be set to 0.0. If the user
specifies the U-Factor Times Area Value at Free Convection Air Flow Rate or Free
Convection Capacity as a value greater than zero, then the free convection air flow rate must
be specified greater than 0.0.
Field: Free Convection Regime Air Flow Rate Sizing Factor
This numeric field contains the sizing factor to use when calculating the free convection
regime air flow rate. The default is 0.1.
Field: Design Air Flow Rate U-Factor Times Area Value
This numeric field contains the heat transfer coefficient-area product (UA) in watts per Kelvin
corresponding to the design air and water flow rates specified above. If the input field
Performance Input Method is specified as UFactorTimesAreaAndDesignWaterFlowRate,
then a UA value greater than zero but less than or equal to 300,000 must be defined, or the
field can be autosized. If autosized, a Plant Sizing object must be defined and the design
tower UA value is derived from the design load to be rejected by the condenser loop and the
design loop delta T (Ref. Sizing and Input for Design Calculations and Component Autosizing
sections), assuming a tower water inlet temperature of 35C and tower inlet air at 35C
drybulb/25.6C wetbulb. If Performance Input Method is specified as NominalCapacity,
then this field must be left blank since the model automatically calculates the tower UA based
on the tower capacity specified in the field Nominal Capacity.
Field: Free Convection Regime U-Factor Times Area Value
This numeric field contains the heat transfer coefficient-area product (W/K) when the tower is
in the free convection regime (water flow exists but tower fan is turned off). This value must
be less than the value specified for the field U-Factor Times Area Value at Design Air Flow
Rate. This field may be autosized, in which case it is set to a fraction of the U-Factor Times
Area Value at Design Air Flow Rate determined in the following input field. If the user does
not wish to model free convection and is using the
Performance Input Method
UFactorTimesAreaAndDesignWaterFlowRate, then this field should be set to 0.0. If
Performance Input Method is specified as NominalCapacity, then this field must be left
blank since the model automatically calculates the tower UA based on the tower capacity
specified in the field Free Convection Capacity.
Field: Free Convection U-Factor Times Area Value Sizing Factor
This numeric field contains the sizing factor to use when calculating the free convection
regime U-Factor times area value. The default is 0.1. This field is only used if the previous
field
is
set
to
autocalculate
and
the
performance
input
method
is
UFactorTimesAreaAndDesignWaterFlowRate.
Field: U-Factor Times Area Modifier Function of Air Flow Ratio Curve Name
This alpha field contains the name of a curve or table object that describes how the UA value
varies as a function of air flow rate ratio (air flow rate/design air flow rate). The result of this
curve is multiplied by the design UA value to adjust for air flow rate, along with the two other
modifiers discussed below. The curve or table object must be for one independent variable
and should be normalized to 1.0 at an air flow rate ratio of 1.0. This field is required.

9/29/14

740

Input-Output Reference

Group Condenser Equipment

Field: U-Factor Times Area Modifier Function of Wetbulb Temperature Difference Curve
Name
This alpha field contains the name of a curve or table object that describes how the UA value
varies as a function of the current wetbulb temperature. The result of this curve is multiplied
by the design UA value to adjust for wetbulb temperatures that differ from design conditions
at 25.56C (78F), along with the two other modifiers discussed in the previous and following
fields. The independe variable is the design wetbulb minus the current outdoor air wetbulb, in
units of degrees Celsius. The curve or table object must be for one independent variable and
should be normalized to 1.0 at a wetbulb temperature difference of 0.0. This field is required.
Field: U-Factor Times Area Modifier Function of Water Flow Ratio Curve Name
This alpha field contains the name of a curve or table object that describes how the UA value
varies as a function of the current water flow rate ratio (water flow rate/design water flow
rate). The result of this curve is multiplied by the design UA value to adjust for water flow
rates that differ from design level, along with the other two modifiers discussed above. The
curve or table object must be for one independent variable and should be normalized to 1.0
at a water flow ratio of 1.0. This field is required
Field: Basin Heater Capacity
This numeric field contains the capacity of the towers electric basin heater in watts per
degree Kelvin. This field is used in conjunction with the Basin Heater Setpoint Temperature
described in the following field. The basin heater electric power is equal to this field multiplied
by the difference between the basin heater set point temperature and the outdoor dry-bulb
temperature. The basin heater only operates when the tower fan is off and water is not
flowing through the tower, regardless of the basin heater schedule described below. The
basin heater capacity must be greater than or equal to zero, with a default value of zero if this
field is left blank.
Field: Basin Heater Setpoint Temperature
This numeric field contains the set point temperature (C) for the basin heater described in
the previous field. The basin heater is active when the outdoor air dry-bulb temperature falls
below this setpoint temperature, as long as the tower fan is off and water is not flowing
through the tower. This set point temperature must be greater than or equal to 2C, and the
default value is 2C if this field is left blank.
Field: Basin Heater Operating Schedule Name
This alpha field contains the name of the basin heater operating schedule. The basin heater
operating schedule is assumed to be an on/off schedule and the heater is available to
operate any time the schedule value is greater than 0. The basin heater operates when
scheduled on and the outdoor air dry-bulb temperature is below the set point temperature
described in the previous field. If this field is left blank, the basin heater is available to operate
throughout the simulation. Regardless of this schedule, the basin heater may only operate
when the cooling tower fan is off and water is not flowing through the tower.
Field: Evaporation Loss Mode
This field is used to choose which method is used to model the amount of water evaporated
by the cooling tower. There are two options: LossFactor or SaturatedExit. The default is
SaturatedExit. The user-defined loss factor is entered in the following field. By assuming that
the air leaving the tower is saturated, the evaporation can be directly calculated using moist
air engineering calculations with data available within the cooling tower model (and does not
require additional user input).
Field: Evaporation Loss Factor
This field is used to specify the rate of water evaporated from the cooling tower and lost to
the outside air [percent/K]. This field is only used if the Evaporation Calculation Mode is set to
9/29/14

741

Input-Output Reference

Group Condenser Equipment

LossFactor. The evaporation loss is then calculated as a fraction of the circulating

condenser water flow and varies with the temperature change in the condenser water. The
value entered here is in units of percent-per-degree Kelvin. The evaporation rate will equal
this value times each degree Kelvin of temperature drop in the condenser water. Typical
values are from 0.15 to 0.27 [percent/K]. The default is 0.2.
Field: Drift Loss Percent
This field is used to specify the rate of water lost to the exiting air as entrained droplets [%].
The drift loss is a percent of the condenser water flow. Typical values for towers with efficient
drift eliminators are between 0.002 and 0.2% of the condenser water flow rate. The default
value is 0.008%.
Field: Blowdown Calculation Mode
This field specifies which method is used to determine blowdown rates. There two options
ConcentrationRatio or ScheduledRate. The choice will determine which of the two models
below is used. The default is ConcentrationRatio.
Field: Blowdown Concentration Ratio
This field is used to dynamically adjust the rate of blowdown in the cooling tower as a function
of the rate of evaporation. Blowdown is water intentionally drained from the tower in order to
offset the build up of solids in the water that would otherwise occur because of evaporation.
The value entered here is dimensionless. It can be characterized as the ratio of solids in the
blowdown water to solids in the make up water. Typical values for tower operation are 3 to 5.
The default value is 3.
Field: Blowdown Makeup Water Usage Schedule Name
This alpha field contains the name of the schedule used to define the amount of water (m 3/s)
flushed from the basin on a periodic basis to purge the tower of mineral scale build-up and
other contaminants. This schedule is only used if the Blowdown Calculation Mode is set to
ScheduledRate. The amount of water use due to blowdown depends on the makeup water
quality and is specific to each geographical location. Typical values range from 0.0002 to
0.0013 m3/s (17.3 to 112.3 m 3/day). This water usage is in addition to the amount of water
lost to the atmosphere due to evaporation and/or drift. Since blowdown occurs when the
basin water contaminant concentration is high, blowdown only occurs when the cooling tower
is active and water is flowing through the tower (regardless of the water usage defined by this
schedule).
Field: Supply Water Storage Tank Name
This field is optional. It is used to describe where the tower obtains water used for
evaporative cooling. If blank or omitted, then the tower will obtain water directly from the
mains. If the name of a WaterUse:Storage object is used here, then the tower will obtain its
water from that tank. If a tank is specified, the tower will attempt to obtain all the water it uses
from the tank. However if the tank cannot provide all the water the tower needs, then the
tower will still operate and obtain the rest of the water it needs from the mains (referred to as
Starved water).
Field: Outdoor Air Inlet Node Name
This optional alpha field specifies the outdoor air node name used to define the conditions of
the air entering the cooling tower. If this field is left blank, the outdoor air conditions entering
the cooling tower are taken directly from the weather data. If this field is not blank, the node
name specified must also be specified in an OutdoorAir:Node object where the height of the
node is taken into consideration when calculating outdoor air conditions from the weather
data. Alternately, the node name may be specified in an OutdoorAir:NodeList object where
the outdoor air conditions are taken directly from the weather data.

9/29/14

742

Input-Output Reference

Group Condenser Equipment

Field: Number of Cells

This integer field contains the number of cells in the multi-cell cooling tower. If not entered,
the program will assume it is a single-cell cooling tower
Field: Cell Control
This alpha field specifies the method used to control the number of cells used to meet the
load, the two choices are:
MinimalCell : the program will use minimal number of cells needed, all other cells will be shut
down with no water flow. It will attempt to use as few cells as possible to cool the fluid. In no
case, however, will the flow per cell be allowed to exceed its maximum value defined by the
Maximum Water Flow Rate Fraction.
MaximalCell: As many cells as possible will be turned on. In no case, however, will the flow
per cell be allowed to drop below its minimum value specified by the Minimum Water Flow
Rate Fraction.
Field: Cell Minimum Water Flow Rate Fraction
This numeric field specifies the allowable smallest fraction of the design water flow rate.
Flows less than this value will commonly result in fluid distribution problems; the pressure at
each nozzle will be too weak for the fluid to be sprayed out in the correct pattern, not all the
fill would be wet. If this field is left blank, the default value is 0.33.
Field: Cell Maximum Water Flow Rate Fraction
This numeric field specifies the allowable largest fraction of the design water flow rate. If this
field is left blank, the default value is 2.5.
Field: Sizing Factor
This optional numeric field allows the user to specify a sizing factor for this component. The
sizing factor is used when the component design inputs are autosized: the autosizing
calculations are performed as usual and the results are multiplied by the sizing factor. Sizing
factor allows the user to size a component to meet part of the design load while continuing to
use the autosizing feature.
An example IDF specification follows.
CoolingTower:VariableSpeed:Merkel,
Big Tower1, !- Name
Condenser Tower 1 Inlet Node, !- Water Inlet Node Name
Condenser Tower 1 Outlet Node, !- Water Outlet Node Name
NominalCapacity, !- Performance Input Method
1.25, !- Heat Rejection Capacity and Nominal Capacity Sizing Ratio
20000.0, !- Nominal Capacity
autocalculate, !- Free Convection Nominal Capacity
0.1, !- Free Convection Nominal Capacity Sizing Factor
autocalculate, !- Design Water Flow Rate
5.382E-8, !- Design Water Flow Rate per Unit of Nominal Capacity
autocalculate, !- Design Air Flow Rate
2.76316E-5, !- Design Air Flow Rate Per Unit of Nominal Capacity
0.2, !- Minimum Air Flow Rate Ratio
autocalculate, !- Design Fan Power
0.0105, !- Design Fan Power Per Unit of Nominal Capacity
VS tower fan power mod func air flow ratio, !- Fan Power Modifier
Function of Air Flow Rate Ratio Curve Name
autocalculate, !- Free Convection Regime Air Flow Rate
0.1, !- Free Convection Regime Air Flow Rate Sizing Factor
, !- Design Air Flow Rate U-Factor Times Area Value
, !- Free Convection Regime U-Factor Times Area Value
, !- Free Convection U-Factor Times Area Value Sizing Factor
VS tower UA mod func air flow ratio, !- U-Factor Times Area Modifier
Function of Air Flow Ratio Curve Name
9/29/14

743

Input-Output Reference

Group Condenser Equipment

VS tower UA mod func wetbulb difference, !- U-Factor Times Area Modifier

Function of Wetbulb Temperature Difference Curve Name
VS tower UA mod func water flow ratio; !- U-Factor Times Area Modifier
Function of Water Flow Ratio Curve Name
Curve:Cubic,
VS tower fan power mod func air flow ratio, !- Name
0.02 , !- Coefficient1 Constant
0.0 , !- Coefficient2 x
0.0 , !- Coefficient3 x**2
0.98 , !- Coefficient4 x**3
0.2,
!- Minimum Value of x
1.0 , !- Maximum Value of x
0.0 , !- Minimum Curve Output
1.0 , !- Maximum Curve Output
Dimensionless, !- Input Unit Type for X
Dimensionless; !- Output Unit Type
Curve:Quadratic,
VS tower UA mod func air flow ratio, !- Name
0.0 , !- Coefficient1 Constant
1.3 , !- Coefficient2 x
-0.3 , !- Coefficient3 x**2
0.2 , !- Minimum Value of x
1.0 , !- Maximum Value of x
0.0 , !- Minimum Curve Output
1.0 , !- Maximum Curve Output
Dimensionless, !- Input Unit Type for X
Dimensionless; !- Output Unit Type
Curve:Linear,
VS tower UA mod func wetbulb difference , !- Name
1.0 , !- Coefficient1 Constant
0.0081 , !- Coefficient2 x
-10 , !- Minimum Value of x
25.0 , !- Maximum Value of x
0.85 , !- Minimum Curve Output
1.3 , !- Maximum Curve Output
Dimensionless, !- Input Unit Type for X
Dimensionless; !- Output Unit Type
Curve:Quadratic,
VS tower UA mod func water flow ratio, !- Name
0.1082 , !- Coefficient1 Constant
1.667 , !- Coefficient2 x
-0.7713 , !- Coefficient3 x**2
0.3 , !- Minimum Value of x
1.0 , !- Maximum Value of x
0.5 , !- Minimum Curve Output
1.1 , !- Maximum Curve Output
Dimensionless, !- Input Unit Type for X
Dimensionless; !- Output Unit Type

CoolingTower:VariableSpeed:Merkel Outputs
HVAC,Average,Cooling Tower
HVAC,Average,Cooling Tower
HVAC,Average,Cooling Tower
HVAC,Average,Cooling Tower
HVAC,Average,Cooling Tower
HVAC,Sum,Cooling Tower Fan
HVAC,Average,Cooling Tower
9/29/14

Inlet Temperature [C]

Outlet Temperature [C]
Mass Flow Rate [kg/s]
Heat Transfer Rate [W]
Fan Electric Power [W]
Electric Energy [J]
Operating Cells Count []
744

Input-Output Reference

Group Condenser Equipment

HVAC,Average,Cooling Tower Fan Speed Ratio []

A tower uses either mains water or storage tank for make-up water.
When mains water is used:
HVAC,Average,Cooling Tower Make Up Water Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Tower Make Up Water Volume [m3]
HVAC,Sum,Cooling Tower Make Up Mains Water Volume [m3]
When storage tank water is used:
HVAC,Average,Cooling Tower Make Up Water Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Tower Make Up Water Volume [m3]
HVAC,Sum,Cooling Tower Storage Tank Water Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Tower Storage Tank Water Volume [m3]
HVAC,Sum,Cooling Tower Starved Storage Tank Water Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Tower Starved Storage Tank Water Volume [m3]
HVAC,Sum,Cooling Tower Make Up Mains Water Volume [m3]
HVAC,Average,Cooling Tower Water Evaporation Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Tower Water Evaporation Volume [m3]
HVAC,Average,Cooling Tower Water Drift Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Tower Water Drift Volume [m3]
HVAC,Average,Cooling Tower Water Blowdown Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Tower Water Blowdown Volume [m3]
IF specified:
HVAC,Average,Cooling Tower Basin Heater Electric Power [W]
HVAC,Sum,Cooling Tower Basin Heater Electric Energy [J]

Cooling Tower Fan Electric Power [W]

Cooling Tower Fan Electric Energy [J]
These outputs are the electric power input to the tower fans. Consumption is metered on
HeatRejection:Electricity, Electricity:Plant, and Electricity:Facility.
Cooling Tower Heat Transfer Rate [W]
This is the rate at which heat is removed from the condenser water loop by the tower.
Cooling Tower Inlet Temperature [C]
Cooling Tower Outlet Temperature [C]
Cooling Tower Mass Flow Rate [kg/s]
These outputs are the tower water inlet and outlet temperatures, and mass flow rate.
Cooling Tower Fan Speed Ratio
This output is the air flow ratio. The current air flow rate divided by the design air flow rate
with values from 0.0 to 1.0.
Cooling Tower Operating Cells Count []
This represents the number of cells operating at each time step.
Cooling Tower Basin Heater Electric Power [W]
Cooling Tower Basin Heater Electric Energy [J]
These outputs are the electric power input to the tower basin heater. Consumption is metered
on HeatRejection:Electricity, Electricity:Plant, and Electricity:Facility

9/29/14

745

Input-Output Reference

Group Condenser Equipment

Cooling Tower Make Up Water Volume Flow Rate [m3/s]

Cooling Tower Make Up Water Volume [m3]
These outputs are the water consumed by the wet cooling tower for external water sprays
used to augment heat transfer. This is the total of evaporation, drift, and blowdown.
Cooling Tower Water Evaporation Volume Flow Rate [m3/s]
Cooling Tower Water Evaporation Volume [m3]
Cooling Tower Water Drift Volume Flow Rate [m3/s]
Cooling Tower Water Drift Volume [m3]
Cooling Tower Water Blowdown Volume Flow Rate [m3/s]
Cooling Tower Water Blowdown Volume [m3]
These outputs provide the breakdown of the different components of water use during cooling
tower operation.
Cooling Tower Make Up Mains Water Volume [m3]
This is the volume of water drawn from mains service to feed the cooling tower. If a water
storage tank is used to provide water to the tower, then the following output variables will also
be available.
Cooling Tower Storage Tank Water Volume Flow Rate [m3/s]
Cooling Tower Storage Tank Water Volume [m3]
These are the rate and volume of water provided by the Water Storage Tank.
Cooling Tower Starved Storage Tank Water Volume Flow Rate [m3/s]
Cooling Tower Starved Storage Tank Water Volume [m3]
These are the rate and volume of water the Storage Tank connections was not able to
provide. The starved water is assumed to come from the mains. The towers operation is not
affected by a lack of storage tank water.
CoolingTower:VariableSpeed
The variable speed tower model is based on empirical curve fits of manufacturers
performance data or field measurements. The user specifies tower performance at design
conditions, and empirical curves are used to determine the approach temperature and fan
power at off-design conditions. The user defines tower performance by entering the inlet air
wet-bulb temperature, tower range, and tower approach temperature at the design
conditions. The corresponding water flow rate (within 25% of the towers rated water mass
flow rate), air flow rate, and fan power must also be specified. The model will account for
tower performance in the free convection regime, when the tower fan is off but the water
pump remains on and heat transfer still occurs (albeit at a low level). Basin heater operation
and makeup water usage (due to evaporation, drift, and blowdown) are also modeled.
The cooling tower seeks to maintain the temperature of the water exiting the cooling tower at
(or below) a set point. The set point schedule is defined by the field Condenser Loop
Temperature Setpoint Node Name or Reference for the CondenserLoop object. The model
first checks to determine the impact of free convection on the tower exiting water
temperature. If the exiting water temperature based on free convection is at or below the set
point, then the variable-speed tower fan is not turned on. If the exiting water temperature is
above the set point after free convection is modeled, then the variable-speed tower fan is
turned on to reduce the exiting water temperature. Tower fan power is calculated based on
the tower air flow rate required to achieve the exiting water set point temperature.
9/29/14

746

Input-Output Reference

Group Condenser Equipment

Cooling towers here are wet and consume water through evaporation, drift, and blowdown.
The model can be used to predict water consumed by the towers. The last six input fields are
optional and provide methods of controlling details of the water consumption calculations.
The user can specifiy connections to the rest of the buildings water system by providing the
name of a WaterUse:Storage object.
For the operation of multi-cell towers, the first step is to determine the number of cells to
operate based on the cell control method between the minimum number of cells subject to
the maximum water flow rate fraction per cell, and maximum number of cells subject to the
minimum water flow rate fraction per cell. If the calculated cells do not meet the loads,
additional cells will be operating to help meet the loads. Inside each cell, the existing capacity
controls still apply.
For multi-cell towers, the following inputs are assumed to be for the entire tower including all
cells:
Design Water Flow Rate; Design Air Flow Rate; Fan Power at Design Air Flow Rate;
Air Flow Rate in Free Convection Regime; Nominal Capacity; Free Convection Capacity
BASIN HEATER (we assume that there is a common basin)
Field: Name
This alpha field contains the identifying name for the variable speed cooling tower.
Field: Water Inlet Node Name
This alpha field contains the identifying name for the cooling towers water inlet node.
Field: Water Outlet Node Name
This alpha field contains the identifying name for the cooling towers water outlet node.
Field: Model Type
This alpha field contains the type of empirical model used to simulate the towers thermal
performance (approach temperature). Valid choices for this field are CoolToolsCrossFlow,
CoolToolsUserDefined, YorkCalc, or YorkCalcUserDefined. CoolToolsCrossFlow and
YorkCalc are empirical models with the equation form and model coefficients already
defined within EnergyPlus. If CoolToolsUserDefined or YorkCalcUserDefined is selected,
the user must specify a valid Model Coefficient Name in the next input field to reference an
appropriate CoolingTowerPerformance:CoolTools or CoolingTowerPerformance:YorkCalc
object. If a user-defined model type is selected and the specified Model Coefficient Name is
not found in the input data file (idf), then a severe message is issued and the simulation will
terminate.
Field: Model Coefficient Name
This
alpha
field
contains
the
identifying
name
for
the
object(s)
CoolingTowerPerformance:CoolTools or CoolingTowerPerformance:YorkCalc. A single
model coefficient object may be used to define coefficients for multiple variable speed cooling
tower objects (i.e., the same name may be used in this input field for more than one variable
speed tower). This field is only used when the field Tower Model Type described above is set
to CoolToolsUserDefined or YorkCalcUserDefined, and should be left blank otherwise.
Field: Design Inlet Air Wet-Bulb Temperature
This numeric field specifies the inlet air wet-bulb temperature (C) at design conditions. This
design temperature should correspond with the design values for range temperature,
approach temperature, water flow rate, and air flow rate specified in the following fields. The
minimum value for this field is 20C and the default value is 25.6C if this field is left blank.

9/29/14

747

Input-Output Reference

Group Condenser Equipment

Field: Design Approach Temperature

This numeric field specifies the tower approach temperature (C) at design conditions. The
approach temperature is the outlet water temperature minus the inlet air wet-bulb
temperature. The design approach temperature should correspond with the design values for
inlet air wet-bulb temperature, range temperature, water flow rate, and air flow rate specified
for this tower. The value for this field must be greater than 0C and the default value is 3.9C
if this field is left blank.
Field: Design Range Temperature
This numeric field specifies the range temperature (C) at design conditions. The range
temperature is defined as the inlet water temperature minus the outlet water temperature.
The design range temperature should correspond with the design values for inlet air wet-bulb
temperature, approach temperature, water flow rate, and air flow rate specified for this tower.
The value for this field must be greater than 0C and the default value is 5.6C if this field is
left blank.
Field: Design Water Flow Rate
This numeric field contains the design water flow rate through the tower in m 3/s. The value
entered should be within 25% of the towers rated water mass flow rate as specified by the
manufacturer if Model Type is CoolToolsCrossFlow or YorkCalc. This constraint may be
different for Model Type CoolToolsUserDefined or YorkCalcUserDefined (ref.
CoolingTowerPerformance:CoolTools or CoolingTowerPerformance:YorkCalc).
This value is the flow rate of the condenser loop water being cooled by the tower. A value
greater than zero must be specified or this field can be autosized. A Plant Sizing object must
be defined if the field is autosized and the design water flow rate is then derived from the
design load to be rejected by the condenser loop and the design loop delta T (Ref. Sizing and
Input for Design Calculations and Component Autosizing sections). The design water flow
rate should correspond with the design values specified for the inlet air wet-bulb temperature,
approach temperature, range temperature, and air flow rate. When this field is not autosized,
the condenser loop flow rate specified in other objects should be within 25% of the towers
rated water flow rate (different range is permissible if Model Type is User Defined).
Field: Design Air Flow Rate
This numeric field contains the design (maximum) air flow rate through the tower in m 3/s. A
value greater than zero must be specified or this field can be autosized. Autosizing of this
field does not require a Plant Sizing object since the design air flow rate is assumed to be the
design fan power multiplied by a total fan efficiency of 0.5 and divided by a fan pressure rise
of 190 Pascals. A correction for altitude is also included as follows:

Design Air Flow Rate

0.5( Fan power at Design Air Flow Rate) 101325.

190.
Patm

Field: Design Fan Power

This numeric field contains the fan power in watts at the design (maximum) air flow rate
through the tower. A value greater than zero must be specified or this field can be autosized.
If autosized, a Plant Sizing object must be defined and the fan power is calculated as follows:

Design fan power

0.0105

water

C p,water Design Water Flow Rate Design Loop T

Field: Fan Power Ratio Function of Air Flow Rate Ratio Curve Name
This alpha field contains the curve object name for fan power ratio (fan power/design fan
power) as a function of air flow rate ratio (air flow rate/design air flow rate) [ref. Performance
9/29/14

748

Input-Output Reference

Group Condenser Equipment

Curves]. The curve object must be a cubic curve and should be normalized to 1.0 at an air
flow rate ratio of 1.0. If this field is left blank, a theoretical fan curve is assumed where fan
power ratio is directly proportional to the air flow rate ratio cubed.
Field: Minimum Air Flow Rate Ratio
This numeric field contains the minimum air flow rate ratio. The tower fan is allowed to
operate between the ratio defined here and a maximum air flow rate ratio of 1.0 (which
corresponds to the design [maximum] tower air flow rate). Below this value, the tower is
assumed to operate either in the free convection regime with the tower fan off, or the tower
fan is cycled on/off to maintain the exiting water set point temperature. The minimum air flow
rate ratio must be greater than or equal to 0.2 and less than or equal to 0.5, with a default
value of 0.2 if the field is left blank.
Field: Fraction of Tower Capacity in Free Convection Regime
This numeric field contains the fraction of tower capacity available in the free convection
regime (i.e., when the tower fan is off but water continues to flow through the tower). The
tower fan does not operate when the free convection tower capacity is able to meet or
exceed the exiting water set point temperature. The air flow rate through the tower in the free
convection regime is assumed to be this same fraction of the tower design air flow rate. The
fraction of tower capacity in free convection regime must be greater than or equal to 0 and
less than or equal to 0.2, with a default value of 0.125 if this field is left blank.
Field: Basin Heater Capacity
This numeric field contains the capacity of the towers electric basin heater in watts per
degree Kelvin. This field is used in conjunction with the Basin Heater Setpoint Temperature
described in the following field. The basin heater electric power is equal to this field multiplied
by the difference between the basin heater set point temperature and the outdoor dry-bulb
temperature. The basin heater only operates when the tower fan is off and water is not
flowing through the tower, regardless of the basin heater schedule described below. The
basin heater capacity must be greater than or equal to zero, with a default value of zero if this
field is left blank.
Field: Basin Heater Setpoint Temperature
This numeric field contains the set point temperature (C) for the basin heater described in
the previous field. The basin heater is active when the outdoor air dry-bulb temperature falls
below this setpoint temperature, as long as the tower fan is off and water is not flowing
through the tower. This set point temperature must be greater than or equal to 2C, and the
default value is 2C if this field is left blank.
Field: Basin Heater Operating Schedule Name
This alpha field contains the name of the basin heater operating schedule. The basin heater
operating schedule is assumed to be an on/off schedule and the heater is available to
operate any time the schedule value is greater than 0. The basin heater operates when
scheduled on and the outdoor air dry-bulb temperature is below the set point temperature
described in the previous field. If this field is left blank, the basin heater is available to operate
throughout the simulation. Regardless of this schedule, the basin heater may only operate
when the cooling tower fan is off and water is not flowing through the tower.
Field: Evaporation Loss Mode
This field is used to choose which method is used to model the amount of water evaporated
by the cooling tower. There are two options: LossFactor or SaturatedExit. The default is
SaturatedExit. The user-defined loss factor is entered in the following field. By assuming that
the air leaving the tower is saturated, the evaporation can be directly calculated using moist
air engineering calculations with data available within the cooling tower model (and does not
require additional user input).
9/29/14

749

Input-Output Reference

Group Condenser Equipment

Field: Evaporation Loss Factor

This field is used to specify the rate of water evaporated from the cooling tower and lost to
the outside air [percent/K]. This field is only used if the Evaporation Calculation Mode is set to
LossFactor. The evaporation loss is then calculated as a fraction of the circulating condenser
water flow and varies with the temperature change in the condenser water. The value entered
here is in units of percent-per-degree Kelvin. The evaporation rate will equal this value times
each degree Kelvin of temperature drop in the condenser water. Typical values are from 0.15
to 0.27 [percent/K]. The default is 0.2.
Field: Drift Loss Percent
This numeric field contains the percent (%) of design water flow rate lost to the atmosphere at
the design air flow rate due to drift, which is water droplets that are entrained in the airstream
as it passes through the tower. Drift is assumed to vary directly with tower air flow rate ratio,
and is in addition to the amount of water lost to the atmosphere due to evaporation and/or
blowdown. Typical values for water usage due to drift are from 0.05 to 0.2% of the total water
circulation rate with currently-available drift eliminators from tower manufacturers. The value
entered in this field must be greater than or equal to zero, and the default is zero if the field is
left blank.
Field: Blowdown Calculation Mode
This field specifies which method is used to determine blowdown rates. There two options
ConcentrationRatio or ScheduledRate. The choice will determine which of the two models
below is used. The default is ConcentrationRatio.
Field: Blowdown Concentration Ratio
This field is used to dynamically adjust the rate of blowdown in the cooling tower as a function
of the rate of evaporation. Blowdown is water intentionally drained from the tower in order to
offset the build up of solids in the water that would otherwise occur because of evaporation.
The value entered here is dimensionless. It can be characterized as the ratio of solids in the
blowdown water to solids in the make up water. Typical values for tower operation are 3 to 5.
The default value is 3.
Field: Blowdown Makeup Water Usage Schedule Name
This alpha field contains the name of the schedule used to define the amount of water (m 3/s)
flushed from the basin on a periodic basis to purge the condenser loop of mineral scale buildup and other contaminants. The amount of water use due to blowdown depends on the
makeup water quality and is specific to each geographical location. Typical values range from
0.0002 to 0.0013 m 3/s (17.3 to 112.3 m 3/day). This water usage is in addition to the amount
of water lost to the atmosphere due to evaporation and/or drift. Since blowdown occurs when
the basin water contaminant concentration is high, blowdown only occurs when the cooling
tower is active and water is flowing through the tower (regardless of the water usage defined
by this schedule).
Field: Supply Water Storage Tank Name
This field is optional. It is used to describe where the tower obtains water used for
evaporative cooling. If blank or omitted, then the tower will obtain water directly from the
mains. If the name of a WaterUser:Storage object is used here, then the tower will obtain its
water from that tank. If a tank is specified, the tower will attempt to obtain all the water it uses
from the tank. However if the tank cannot provide all the water the tower needs, then the
tower will still operate and obtain the rest of the water it needs from the mains (referred to as
Starved water).
Field: Outdoor Air Inlet Node Name
This optional alpha field specifies the outdoor air node name used to define the conditions of
the air entering the cooling tower. If this field is left blank, the outdoor air conditions entering
9/29/14

750

Input-Output Reference

Group Condenser Equipment

the cooling tower are taken directly from the weather data. If this field is not blank, the node
name specified must also be specified in an OutdoorAir:Node object where the height of the
node is taken into consideration when calculating outdoor air conditions from the weather
data. Alternately, the node name may be specified in an OutdoorAir:NodeList object where
the outdoor air conditions are taken directly from the weather data.
Field: Number of Cells
This integer field contains the number of cells in the multi-cell cooling tower. If not entered,
the program will assume it is a single-cell cooling tower
Field: Cell Control
This alpha field specifies the method used to control the number of cells used to meet the
load, the two choices are:
MinimalCell: the program will use minimal number of cells needed, all other cells will be shut
down with no water flow. It will attempt to use as few cells as possible to cool the fluid. In no
case, however, will the flow per cell be allowed to exceed its maximum value defined by the
Maximum Water Flow Rate Fraction.
MaximalCel : As many cells as possible will be turned on. In no case, however, will the flow
per cell be allowed to drop below its minimum value specified by the Minimum Water Flow
Rate Fraction.
Field: Cell Minimum Water Flow Rate Fraction
This numeric field specifies the allowable smallest fraction of the design water flow rate.
Flows less than this value will commonly result in fluid distribution problems; the pressure at
each nozzle will be too weak for the fluid to be sprayed out in the correct pattern, not all the
fill would be wet. If this field is left blank, the default value is 0.33.
Field: Cell Maximum Water Flow Rate Fraction
This numeric field specifies the allowable largest fraction of the design water flow rate. If this
field is left blank, the default value is 2.5.
Field: Sizing Factor
This optional numeric field allows the user to specify a sizing factor for this component. The
sizing factor is used when the component design inputs are autosized: the autosizing
calculations are performed as usual and the results are multiplied by the sizing factor. Sizing
factor allows the user to size a component to meet part of the design load while continuing to
use the autosizing feature.For this component the inputs that would be altered by the sizing
factor are:
1. Design Water Flow Rate;
2. Design Air Flow Rate;
3. Design Fan Power.
An example IDF specification for this object is shown below:
CoolingTower:VariableSpeed,
Big Tower1, !- Tower Name
Condenser 1 Inlet Node, !- Water Inlet Node Name
Condenser 1 Outlet Node, !- Water Outlet Node Name
YorkCalc, !- Tower Model Type
, !- Tower Model Coefficient Name
25.5556, !- Design Inlet Air Wet-Bulb Temperature {C}
3.8889, !- Design Approach Temperature {C}
5.5556, !- Design Range Temperature {C}
0.0015, !- Design Water Flow Rate {m3/s}
1.6435, !- Design Air Flow Rate {m3/s}
275, !- Design Fan Power {W}
FanRatioCurve, !- Fan Power Ratio - function of Air Flow Rate Curve Name
9/29/14

751

Input-Output Reference

Group Condenser Equipment

0.2, !- Minimum Air Flow Rate Ratio

0.125, !- Fraction of Tower Capacity in Free Convection Regime
450.0, !- Basin Heater Capacity {W/K}
4.5, !- Basin Heater Set Point Temperature {C}
BasinSchedule, !- Basin Heater Operating Schedule Name
SaturatedExit, !- Evaporation Loss Mode
, !- Evaporation Loss Factor
0.05, !- Makeup Water Usage due to Drift {percent}
ScheduledRate, !- Blowdown Calculation Mode
BlowDownSchedule, !- Schedule Name for Makeup Water Usage due to Blowdown
, !- Name of Water Storage Tank for Supply
, !- Outdoor Air Inlet Node Name
4, !- Number of Cells
MinimalCell, !- Cell Control
, !- Cell Minimum Water Flow Rate Fraction
, !- Cell Maximum Water Flow Rate Fraction
1.000 ; !- Sizing Factor

Variable Speed Cooling Tower Outputs

HVAC,Average,Cooling Tower Fan Electric Power [W]
HVAC,Sum,Cooling Tower Fan Electric Energy [J]
HVAC,Average,Cooling
HVAC,Average,Cooling
HVAC,Average,Cooling
HVAC,Average,Cooling
HVAC,Average,Cooling
HVAC,Average,Cooling
HVAC,Average,Cooling

Tower
Tower
Tower
Tower
Tower
Tower
Tower

Heat Transfer Rate [W]

Inlet Temperature [C]
Outlet Temperature [C]
Mass Flow Rate [kg/s]
Fan Part Load Ratio
Air Flow Rate Ratio
Operating Cells Count

A tower uses either mains water or storage tank for make-up water.
When mains water is used:
HVAC,Average,Cooling Tower Make Up Water Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Tower Make Up Water Volume [m3]
HVAC,Sum,Cooling Tower Make Up Mains Water Volume [m3]
When storage tank water is used:
HVAC,Average,Cooling Tower Make Up Water Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Tower Make Up Water Volume [m3]
HVAC,Sum,Cooling Tower Storage Tank Water Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Tower Storage Tank Water Volume [m3]
HVAC,Sum,Cooling Tower Starved Storage Tank Water Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Tower Starved Storage Tank Water Volume [m3]
HVAC,Sum,Cooling Tower Make Up Mains Water Volume [m3]
HVAC,Average,Cooling Tower Water Evaporation Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Tower Water Evaporation Volume [m3]
HVAC,Average,Cooling Tower Water Drift Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Tower Water Drift Volume [m3]
HVAC,Average,Cooling Tower Water Blowdown Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Tower Water Blowdown Volume [m3]
IF specified:
HVAC,Average,Cooling Tower Basin Heater Electric Power [W]
HVAC,Sum,Cooling Tower Basin Heater Electric Energy [J]

9/29/14

752

Input-Output Reference

Group Condenser Equipment

Cooling Tower Fan Electric Power [W]

Cooling Tower Fan Electric Energy [J]
These outputs are the electric power input to the tower fan. Consumption is metered on
HeatRejection:Electricity, Electricity:Plant, and Electricity:Facility.
Cooling Tower Fan Part Load Ratio []
This is the on/off cycling rate of the tower fan when free convection cannot meet the set point
temperature and the tower capacity at the minimum air flow rate ratio drives the tower exiting
water temperature below the set point temperature. The fan part-load ratio is calculated as
the ratio of the exiting water temperature in the free convection regime minus the exiting
water temperature set point divided by the exiting water temperature in the free convection
regime minus the exiting water temperature at the minimum air flow rate ratio. If tower air flow
is at or above the minimum air flow rate ratio, then the tower fan part-load ratio is 1.0.
Cooling Tower Heat Transfer Rate [W]
This is the rate at which heat is removed from the condenser water loop by the tower.
Cooling Tower Inlet Temperature [C]
Cooling Tower Outlet Temperature [C]
Cooling Tower Mass Flow Rate [kg/s]
These outputs are the tower water inlet and outlet temperatures, and mass flow rate of the
circulating condenser water loop.
Cooling Tower Air Flow Rate Ratio []
This is the ratio of air flow through the tower to the design air flow rate. During times when the
tower can maintain the condenser loop set point temperature using free convection (when the
fan in not operating), the air flow rate ratio is assumed to be equal to the field Fraction of
Tower Capacity in Free Convection Regime. During times when the fan cycles on/off to
maintain the outlet water set point temperature, the air flow rate ratio is calculated as the
summation of Fan Part-Load Ratio multiplied by the Minimum Air Flow Rate Ratio and (1.0 Fan Part-Load Ratio) multiplied by the fraction of Tower Capacity in Free Convection
Regime.
Cooling Tower Basin Heater Electric Power [W]
Cooling Tower Basin Heater Electric Energy [J]
These outputs are the electric power input to the tower basin heater. Consumption is metered
on HeatRejection:Electricity, Electricity:Plant, and Electricity:Facility.
Cooling Tower Make Up Water Volume Flow Rate [m3/s]
Cooling Tower Make Up Water Volume [m3]
These outputs are the water consumed by the wet cooling tower for external water sprays
used to augment heat transfer. This is the total of evaporation, drift, and blowdown.

9/29/14

753

Input-Output Reference

Group Condenser Equipment

Cooling Tower Water Evaporation Volume Flow Rate [m3/s]

Cooling Tower Water Evaporation Volume [m3]
Cooling Tower Water Drift Volume Flow Rate [m3/s]
Cooling Tower Water Drift Volume [m3]
Cooling Tower Water Blowdown Volume Flow Rate [m3/s]
Cooling Tower Water Blowdown Volume [m3]
These outputs provide the breakdown of the different components of water use during cooling
tower operation.
Cooling Tower Make Up Mains Water Volume [m3]
This is the volume of water drawn from mains service to feed the cooling tower. If a water
storage tank is used to provide water to the tower, then the following output variables will also
be available.
Cooling Tower Storage Tank Water Volume Flow Rate [m3/s]
Cooling Tower Storage Tank Water Volume [m3]
These are the rate and volume of water provided by the Water Storage Tank.
Cooling Tower Starved Storage Tank Water Volume Flow Rate [m3/s]
Cooling Tower Starved Storage Tank Water Volume [m3]
These are the rate and volume of water the Storage Tank connections was not able to
provide. The starved water is assumed to come from the mains. The towers operation is not
affected by a lack of storage tank water.
Cooling Tower Operating Cells Count []
This represents the number of cells operating at each time step.
CoolingTowerPerformance:CoolTools
Variable speed cooling towers can be modeled by EnergyPlus with user-selectable
performance based on the CoolTools correlation, YorkCalc correlation, or user-defined
coefficients for either the CoolTools or YorkCalc correlations. The empirical CoolTools tower
correlation uses a set of 35 coefficients to model the thermal performance (approach
temperature) of a cooling tower based on four independent variables. If the user specifies
Model Type = CoolToolsCrossFlow in the CoolingTower:VariableSpeed object, then the 35
coefficients derived for the CoolTools simulation model are used and these coefficients are
already defined within EnergyPlus. If the user specifies Model Type = CoolToolsUserDefined,
then the user must enter a CoolingTowerPerformance:CoolTools object to define the 35
coefficients that will be used by the CoolTools correlation.
The user must specify a name for the model coefficient object, and this name must be used
in the CoolingTower:VariableSpeed object (field Model Coefficient Name) to tell the program
to use these coefficients. Next, the user enters the minimum and maximum values for inlet air
wet-bulb temperature, range temperature, approach temperature, and water mass flow rate
ratio to specify the valid range for which the model coefficients were derived. For all of these
variables, the program issues warnings if the actual values are beyond the
minimum/maximum values specified. For inlet air wet-bulb temperature and water mass flow
rate ratio, the values of these variables used in the calculation of approach temperature are
limited to be within the valid minimum/maximum range specified. For approach and range,
the warnings are issued if the values are beyond the specified minimum/maximum range but
the actual values are still used.

9/29/14

754

Input-Output Reference

Group Condenser Equipment

The CoolTools correlation has four independent variables: inlet air wet-bulb temperature
(Twb), tower range temperature (Tr), water flow rate ratio (FRwater), and air flow rate ratio
(FRair). Temperatures are in units of C and flow rate ratios are dimensionless (actual flow
rate divided by design flow rate). Using these independent variables, tower approach
temperature (C) is calculated as follows:
Approach = Coeff(1) + Coeff(2)FRair + Coeff(3)(FRair)2 +
Coeff(4)(FRair)3 + Coeff(5)FRwater +
Coeff(6)FRairFRwater + Coeff(7)(FRair)2FRwater +
Coeff(8)(FRwater)2 + Coeff(9)FRair(FRwater)2 +
Coeff(10)(FRwater)3 + Coeff(11)Twb + Coeff(12)FRairTwb +
Coeff(13)(FRair)2Twb + Coeff(14)FRwaterTwb +
Coeff(15)FRairFRwaterTwb + Coeff(16)(FRwater)2Twb +
Coeff(17)(Twb)2 + Coeff(18)FRair(Twb)2 +
Coeff(19)FRwater(Twb)2 + Coeff(20)(Twb)3 + Coeff(21)Tr +
Coeff(22)FRairTr + Coeff(23)FRairFRairTr +
Coeff(24)FRwaterTr + Coeff(25)FRairFRwaterTr +
Coeff(26)(FRwater)2Tr + Coeff(27)TwbTr +
Coeff(28)FRairTwbTr + Coeff(29)FRwaterTwbTr +
Coeff(30)(Twb)2Tr + Coeff(31)(Tr)2 + Coeff(32)FRair(Tr)2 +
Coeff(33)FRwater(Tr)2 + Coeff(34)Twb(Tr)2 + Coeff(35)(Tr)3
This object allows the user to specify model coefficients for use with the CoolTools correlation
shown above. It is recommended that a broad set of cooling tower performance data be used
to generate these model coefficients. The data set used to create the model coefficients
should cover the entire range of water and air flow rate ratios and inlet air wet-bulb, range,
and approach temperatures expected during the simulation.
Field: Name
This alpha field contains the identifying name for the variable speed cooling tower model
coefficients.
Field: Minimum Inlet Air Wet-Bulb Temperature
This numeric field contains the minimum inlet air wet-bulb temperature to be used by the
model (approach temperature correlation). Inlet air wet-bulb temperatures less than this value
will not be used; instead, the minimum inlet air wet-bulb temperature specified here will be
used by the correlation and a warning will be issued.
Field: Maximum Inlet Air Wet-Bulb Temperature
This numeric field contains the maximum inlet air wet-bulb temperature to be used by the
model (approach temperature correlation). Inlet air wet-bulb temperatures greater than this
value will not be used; instead, the maximum inlet air wet-bulb temperature specified here will
be used by the correlation and a warning will be issued.
Field: Minimum Range Temperature
This numeric field contains the minimum range temperature (inlet water temperature minus
outlet water temperature) to be used by the empirical model. If the range temperature is less
than this value the actual range temperature is still passed to the empirical model but a
warning will be issued.
Field: Maximum Range Temperature
This numeric field contains the maximum range temperature (inlet water temperature minus
outlet water temperature) to be used by the empirical model. If the range temperature is
9/29/14

755

Input-Output Reference

Group Condenser Equipment

greater than this value the actual range temperature is still passed to the empirical model but
a warning will be issued.
Field: Minimum Approach Temperature
This numeric field contains the minimum approach temperature (outlet water temperature
minus inlet air wet-bulb temperature) to be used by the empirical model. If the calculated
approach temperature is less than this value then the calculated value is still used but a
warning will be issued.
Field: Maximum Approach Temperature
This numeric field contains the maximum approach temperature (outlet water temperature
minus inlet air wet-bulb temperature) to be used by the empirical model. If the calculated
approach temperature is greater than this value then the calculated value is still used but a
warning will be issued.
Field: Minimum Water Flow Rate Ratio
This numeric field contains the minimum water flow rate ratio (ratio of actual water flow rate to
rated water flow rate) to be used by the empirical model. Water flow rate ratios less than this
value will not be used; instead, the minimum water flow rate ratio specified here will be used
by the model and a warning will be issued.
Field: Maximum Water Flow Rate Ratio
This numeric field contains the maximum water flow rate ratio (ratio of actual water flow rate
to rated water flow rate) to be used by the empirical model. Water flow rate ratios greater
than this value will not be used; instead, the maximum water flow rate ratio specified here will
be used by the model and a warning will be issued.
Field: Coefficient 1 to 35
These numeric fields contain the coefficients to be used by the CoolTools approach
temperature correlation shown above.
An example IDF specification for this object is shown below:
CoolingTowerPerformance:CoolTools,
CoolTools CrossFlow Default Model,
-1.0,
!- Minimum
26.6667,
!- Maximum
1.1111,
!- Minimum
11.1111,
!- Maximum
1.1111,
!- Minimum
11.1111,
!- Maximum
0.75,
!- Minimum
1.25,
!- Maximum
0.52049709836241,
-10.617046395344,
10.7292974722538,
-2.74988377158227,
4.73629943913743,
-8.25759700874711,
1.57640938114136,
6.51119643791324,
1.50433525206692,
-3.2888529287801,
0.0257786145353773,
0.182464289315254,
-0.0818947291400898,
-0.215010003996285,
0.0186741309635284,

9/29/14

!- Tower Model Coefficient Name

Inlet Air Wet-Bulb Temperature {C}
Inlet Air Wet-Bulb Temperature {C}
Range Temperature {C}
Range Temperature {C}
Approach Temperature {C}
Approach Temperature {C}
Water Flow Rate Ratio
Water Flow Rate Ratio
!- Coefficient 1
!- Coefficient 2
!- Coefficient 3
!- Coefficient 4
!- Coefficient 5
!- Coefficient 6
!- Coefficient 7
!- Coefficient 8
!- Coefficient 9
!- Coefficient 10
!- Coefficient 11
!- Coefficient 12
!- Coefficient 13
!- Coefficient 14
!- Coefficient 15

756

Input-Output Reference

Group Condenser Equipment

0.0536824177590012,
-0.00270968955115031,
0.00112277498589279,
-0.00127758497497718,
0.0000760420796601607,
1.43600088336017,
-0.5198695909109,
0.117339576910507,
1.50492810819924,
-0.135898905926974,
-0.152577581866506,
-0.0533843828114562,
0.00493294869565511,
-0.00796260394174197,
0.000222619828621544,
-0.0543952001568055,
0.00474266879161693,
-0.0185854671815598,
0.00115667701293848,
0.000807370664460284;

!!!!!!!!!!!!!!!!!!!!-

Coefficient
Coefficient
Coefficient
Coefficient
Coefficient
Coefficient
Coefficient
Coefficient
Coefficient
Coefficient
Coefficient
Coefficient
Coefficient
Coefficient
Coefficient
Coefficient
Coefficient
Coefficient
Coefficient
Coefficient

16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

CoolingTowerPerformance:CoolTools Outputs
No additional cooling tower output variables are output when this object is used.
CoolingTowerPerformance:YorkCalc
Variable speed cooling towers can be modeled by EnergyPlus with user-selectable
performance based on the CoolTools correlation, YorkCalc correlation, or user-defined
coefficients for either the CoolTools or YorkCalc correlations. The empirical YorkCalc tower
correlation uses a set of 27 coefficients to model the thermal performance (approach
temperature) of a variable speed cooling tower based on three independent variables. If the
user specifies Tower Model Type = YorkCalc in the CoolingTower:VariableSpeed object, then
the 27 coefficients derived for the YorkCalc simulation model are used and these coefficients
are already defined within EnergyPlus. If the user specifies Tower Model Type =
YorkCalcUserDefined, then the user must enter a CoolingTowerPerformance:YorkCalc object
to define the 27 coefficients that will be used by the YorkCalc correlation.
The user must specify a name for the model coefficient object, and this name must be used
in the CoolingTower:VariableSpeed object (field Model Coefficient Name) to tell the program
to use these coefficients. Next, the user enters the minimum and maximum values for inlet air
wet-bulb temperature, range temperature, approach temperature, and water mass flow rate
ratio to specify the valid range for which the model coefficients were derived. The user also
specifies the maximum valid liquid-to-gas ratio. For all of these variables, the program issues
warnings if the actual values are beyond the minimum/maximum values specified. For inlet
air wet-bulb temperature and water mass flow rate ratio, the values of these variables used in
the calculation of approach temperature are limited to be within the valid minimum/maximum
range specified. For approach, range, and liquid-to-gas ratio the warnings are issued if the
values are beyond the specified minimum/maximum range but the actual values are still
used.
The YorkCalc correlation has three independent variables: inlet air wet-bulb temperature
(Twb), tower range temperature (Tr), and the liquid-to-gas ratio (ratio of water flow rate ratio
to air flow rate ratio = LGRatio). Temperatures are in units of C and liquid-to-gas ratio is
dimensionless. Using these independent variables, an approach temperature (C) is
calculated as follows:
Approach =

9/29/14

Coeff(1) + Coeff(2)Twb + Coeff(3)Twb2 + Coeff(4)Tr +

Coeff(5)TwbTr + Coeff(6)Twb2Tr + Coeff(7)Tr2 +
Coeff(8)TwbTr2 + Coeff(9)Twb2Tr2 + Coeff(10)LGRatio +

757

Input-Output Reference

Group Condenser Equipment

Coeff(11)TwbLGRatio + Coeff(12)Twb2LGRatio +
Coeff(13)TrLGRatio + Coeff(14)TwbTrLGRatio +
Coeff(15)Twb2TrLGRatio + Coeff(16)Tr2LGRatio +
Coeff(17)TwbTr2LGRatio + Coeff(18)Twb2Tr2LGRatio +
Coeff(19)LGRatio2 + Coeff(20)TwbLGRatio2 +
Coeff(21) Twb2LGRatio2 + Coeff(22)TrLGRatio2 +
Coeff(23)TwbTrLGRatio2 + Coeff(24)Twb2TrLGRatio2 +
Coeff(25)Tr2LGRatio2 + Coeff(26)TwbTr2LGRatio2 +
Coeff(27)Twb2Tr2LGRatio2
This object allows the user to specify model coefficients for use with the YorkCalc correlation
shown above. It is recommended that a broad set of cooling tower performance data be used
to generate these model coefficients. The data set used to create the model coefficients
should cover the entire range of water and air flow rate ratios and inlet air wet-bulb, range,
and approach temperatures expected during the simulation.
Field: Name
This alpha field contains the identifying name for the variable speed cooling tower model
coefficients.
Field: Minimum Inlet Air Wet-Bulb Temperature
This numeric field contains the minimum inlet air wet-bulb temperature to be used by the
model (approach temperature correlation). Inlet air wet-bulb temperatures less than this value
will not be used; instead, the minimum inlet air wet-bulb temperature specified here will be
used by the correlation and a warning will be issued.
Field: Maximum Inlet Air Wet-Bulb Temperature
This numeric field contains the maximum inlet air wet-bulb temperature to be used by the
model (approach temperature correlation). Inlet air wet-bulb temperatures greater than this
value will not be used; instead, the maximum inlet air wet-bulb temperature specified here will
be used by the model and a warning will be issued.
Field: Minimum Range Temperature
This numeric field contains the minimum range temperature (inlet water temperature minus
outlet water temperature) to be used by the empirical model. If the range temperature is less
than this value the actual range temperature is still passed to the empirical model but a
warning will be issued.
Field: Maximum Range Temperature
This numeric field contains the maximum range temperature (inlet water temperature minus
outlet water temperature) to be used by the empirical model. If the range temperature is
greater than this value the actual range temperature is still passed to the empirical model but
a warning will be issued.
Field: Minimum Approach Temperature
This numeric field contains the minimum approach temperature (outlet water temperature
minus inlet air wet-bulb temperature) to be used by the empirical model. If the calculated
approach temperature is less than this value then the calculated value is still used but a
warning will be issued.
Field: Maximum Approach Temperature
This numeric field contains the maximum approach temperature (outlet water temperature
minus inlet air wet-bulb temperature) to be used by the empirical model. If the calculated

9/29/14

758

Input-Output Reference

Group Condenser Equipment

approach temperature is greater than this value then the calculated value is still used but a
warning will be issued.
Field: Minimum Water Flow Rate Ratio
This numeric field contains the minimum water flow rate ratio (ratio of actual water flow rate to
rated water flow rate) to be used by the empirical model. Water flow rate ratios less than this
value will not be used; instead, the minimum water flow rate ratio specified here will be used
by the model and a warning will be issued.
Field: Maximum Water Flow Rate Ratio
This numeric field contains the maximum water flow rate ratio (ratio of actual water flow rate
to rated water flow rate) to be used by the empirical model. Water flow rate ratios greater
than this value will not be used; instead, the maximum water flow rate ratio specified here will
be used by the model and a warning will be issued.
Field: Maximum Liquid to Gas Ratio
This numeric field contains the maximum liquid-to-gas ratio (ratio of actual water flow rate
ratio [capped to be within the minimum/maximum water flow rate ratio defined above as
necessary] to actual air flow rate ratio) to be used by the empirical model. If the liquid-to-gas
ratio is greater than this value the actual liquid to gas ratio is still passed to the empirical
model but a warning will be issued.
Field: Coefficient 1 to 27
These numeric fields contain the coefficients to be used by the YorkCalc approach
temperature correlation shown above.
An example IDF specification for this object is shown below:
CoolingTowerPerformance:YorkCalc
YorkCalc Default Tower Model, !- Tower Model Coefficient Name
-34.4,
!- Minimum Inlet Air Wet-Bulb Temperature {C}
26.6667,
!- Maximum Inlet Air Wet-Bulb Temperature {C}
1.1111,
!- Minimum Range Temperature {C}
22.2222,
!- Maximum Range Temperature {C}
1.1111,
!- Minimum Approach Temperature {C}
40.0,
!- Maximum Approach Temperature {C}
0.75,
!- Minimum Water Flow Rate Ratio
1.25,
!- Maximum Water Flow Rate Ratio
8.0,
!- Maximum Liquid to Gas Ratio
-0.359741205,
!- Coefficient 1
-0.055053608,
!- Coefficient 2
0.0023850432,
!- Coefficient 3
0.173926877,
!- Coefficient 4
-0.0248473764,
!- Coefficient 5
0.00048430224,
!- Coefficient 6
-0.005589849456,
!- Coefficient 7
0.0005770079712,
!- Coefficient 8
-0.00001342427256,
!- Coefficient 9
2.84765801111111,
!- Coefficient 10
-0.121765149,
!- Coefficient 11
0.0014599242,
!- Coefficient 12
1.680428651,
!- Coefficient 13
-0.0166920786,
!- Coefficient 14
-0.0007190532,
!- Coefficient 15
-0.025485194448,
!- Coefficient 16
0.0000487491696,
!- Coefficient 17
0.00002719234152,
!- Coefficient 18
-0.0653766255555556,
!- Coefficient 19
-0.002278167,
!- Coefficient 20
9/29/14

759

Input-Output Reference
0.0002500254,
-0.0910565458,
0.00318176316,
0.000038621772,
-0.0034285382352,
0.00000856589904,
-0.000001516821552;

Group Condenser Equipment

!!!!!!!-

Coefficient
Coefficient
Coefficient
Coefficient
Coefficient
Coefficient
Coefficient

21
22
23
24
25
26
27

CoolingTowerPerformance:YorkCalc Outputs
No additional cooling tower output variables are output when this object is used.
EvaporativeFluidCooler:SingleSpeed
Evaporative fluid coolers are components that may be assigned to condenser loops. The
Evaporative fluid cooler is modeled as a counter flow heat exchanger with single-speed fans
(induced draft configuration). The user must define fluid cooler performance via one of three
methods: design heat transfer coefficient-area product (UA) and design water flow rate, or
standard fluid cooler design capacity at a specific rating point or design capacity at non
standard conditions. Regardless of which method is chosen, the design airflow rate and
corresponding fan power must be specified.
The evaporative fluid cooler seeks to maintain the temperature of the water exiting the
evaporative fluid cooler at (or below) a set point. The set point schedule value is defined by
the field Condenser Loop Temperature Setpoint Node Name or Reference for the
CondenserLoop object. The model first checks to see whether inlet water temperature is at or
below the set point. If so, then the fluid cooler fan is not turned on and all the flow goes
through bypass. If the inlet water temperature is above the set point then the fluid cooler fan
is turned on to reduce the exiting water temperature to the set point. If the capacity control is
FanCycling, the model assumes that part-load operation is represented by a simple linear
interpolation between two steady-state regimes (i.e., fluid cooler fan on for the entire
simulation timestep and fluid cooler fan off for the entire simulation timestep). Cyclic losses
are not taken into account. If the capacity control is FluidBypass, the model determines the
fraction of water flow to be bypassed while the remaining water goes through the fluid cooler
cooling media and gets cooled, then the two water flows mix to meet the setpoint
temperature. In this case, the fan runs at full speed for the entire timestep.
Evaporative fluid coolers consume water through evaporation, drift, and blowdown. The
model can be used to predict water consumed by the fluid coolers. For this purpose, the last
seven input fields can either be provided in the input or if nothing is specified then the default
values for these fields will be used. These fields provide the methods of controlling details of
the water consumption calculations. The user can specify connections to the rest of the
buildings water system by providing the name of a water storage tanks (i.e.
WaterUse:Storage objects). The schematic of the system is shown below:

9/29/14

760

Input-Output Reference

Group Condenser Equipment

(ma, ha,out)

Heated Air

Fan

Drift eliminators
External water

Spray
distribution

(mw, tw,in)

Process fluid

Air In

Air In
Water
(mw, tw,out)

Air
(ma, twb,in)

Pump

Figure 82. Schematic diagram for evaporative fluid cooler

Where,
h = Enthalpy (j/kg-K)
m = mass flow rate (kg/s)
Subscripts
a = air
w = water
wb = wet-bulb
in = inlet
out= outlet
Field: Name
This alpha field contains the identifying name for the fluid cooler.

9/29/14

761

Input-Output Reference

Group Condenser Equipment

Field: Water Inlet Node Name

This alpha field contains the identifying name for the fluid coolers water inlet node.
Field: Water Outlet Node Name
This alpha field contains the identifying name for the fluid coolers water outlet node.
Field: Design Air Flow Rate
This numeric field contains the design air flow rate induced by the fluid cooler fan in m 3/s. The
field must contain a value greater than zero regardless of the fluid cooler performance input
method. Alternately, this field can be autosized. See Engineering Reference document for
autosizing calculations.
Field: Design Air Flow Rate Fan Power
This numeric field contains the fan power (in watts) at the design air flow rate specified in the
previous field. The field must contain a value greater than zero regardless of the fluid cooler
performance input method. Alternately, this field can be autosized. See Engineering
Reference document for autosizing calculations.
Field: Design Spray Water Flow Rate
This numeric field contains the design spray water flow rate through the fluid cooler in m 3/s. A
value greater than zero must be specified regardless of the performance input method,
Field: Performance Input Method
This alpha field contains the method by which the user will specify fluid cooler performance:
UFactorTimesAreaAndDesignWaterFlowRate
or
StandardDesignCapacity
or
UserSpecifiedDesignCapacity.
Field: Outdoor Air Inlet Node Name
This optional alpha field specifies the outdoor air node name used to define the conditions of
the air entering the fluid cooler. If this field is left blank, the outdoor air conditions entering the
fluid cooler are taken directly from the weather data. If this field is not blank, the node name
specified must also be specified in an OutdoorAir:Node object where the height of the node is
taken into consideration when calculating outdoor air conditions from the weather data.
Alternately, the node name may be specified in an OutdoorAir:NodeList object where the
outdoor air conditions are taken directly from the weather data.
Field: Heat Rejection Capacity and Nominal Capacity Sizing Ratio
This numeric field contains the value for the ratio of actual tower heat rejection to nominal
capacity. This ratio is defined at entering water at 35C (95F), leaving water at 29.4C (85F),
entering air at 25.6C (78F) wetbulb and 35C (95F) drybulb temperatures. Historically this ratio
has been set at 1.25 based on the assumption that the tower must dissipate 0.25 W of
compressor power for every what of heat removed at the chiller evaporator. The default is
1.25.
Field: Standard Design Capacity
This numeric input field contains the heat rejection capacity of the fluid cooler in watts, with
entering water at 35C (95F), leaving water at 29.4C (85F), entering air at 25.6C (78F)
wetbulb and 35C (95F) drybulb temperatures. The design water flow rate is assumed to be
5.382E-8 m3/s per watt of nominal capacity (3 gpm/ton). 125% of this capacity gives the
actual fluid cooler heat rejection at these operating conditions (based on historical
assumption that the evaporative fluid cooler must dissipate 0.25W of compressor heat for
every watt of heat removed by the evaporator). This field is only used for performance input
method =StandardDesignCapacity. For other input methods this field is ignored. The
standard conditions mentioned above for standard design capacity are already specified in
the EnergyPlus. So the input fields such as design entering water temp., design entering air
9/29/14

762

Input-Output Reference

Group Condenser Equipment

wet-bulb and dry-bulb temp. and design water flow rate, if provided in the input, will be
ignored for the StandardDesignCapacity performance input method. Also, the standard
conditions are for water as a fluid type so this performance input method can only be used
with water as a fluid type (ref. CondenserLoop object).
Field: Design Air Flow Rate U-factor Times Area Value
This numeric field contains the heat transfer coefficient-area product (UA) in watts per Kelvin
corresponding to the design air and water flow rates specified above. If the input field
Performance Input Method is specified as UFactorTimesAreaAndDesignWaterFlowRate,
then a UA value greater than zero but less than or equal to 300,000 must be defined, or the
field can be autosized. If autosized, a Plant Sizing object must be defined and the design fluid
cooler UA value is derived from the design load to be rejected by the condenser loop and the
design loop delta T (Ref. Sizing and Input for Design Calculations and Component Autosizing
sections), the fluid cooler inlet air dry-bulb and wetbulb temperature are taken from the input.
This
field
is
only
used
for
performance
input
method
=
UFactorTimesAreaAndDesignWaterFlowRate. For other performance input methods, this
field is ignored.
Field: Design Water Flow Rate
This numeric field contains the design water flow rate through the fluid cooler in m 3/s. This
value is the flow rate of the condenser loop water being cooled by the fluid cooler. This field is
ignored for the StandardDesignCapacity performance input method. If autosized, a Plant
Sizing object must be defined and the design water flow rate is derived from the design load
to be rejected by the condenser loop and the design loop delta T (Ref. Sizing and Input for
Design Calculations and Component Autosizing sections).
Field: User Specified Design Capacity
This numeric input field contains the heat rejection capacity of the fluid cooler in watts.
Design conditions for this capacity i.e. entering air dry-bulb temperature, entering air wet-bulb
temperature and entering water temperature must be provided in the input. Only used for
Performance Input Method = UserSpecifiedDesignCapacity; for other performance input
methods this field is ignored.
Field: Design Entering Water Temperature
This numeric field contains entering water temperature at nominal conditions in degrees
Celsius. The design entering water temperature must be greater than the design entering air
temperature. Only used for Performance Input Method = UserSpecifiedDesignCapacity; for
other performance input methods this field is ignored.
Field: Design Entering Air Temperature
This numeric field contains entering air dry-bulb temperature at nominal conditions in degrees
Celsius. The design entering air temperature must be greater than the design entering air
wet-bulb
temperature.
Only
used
for
Performance
Input
Method
=
UserSpecifiedDesignCapacity; for other performance input methods this field is ignored.
Field: Design Entering Air Wet-bulb Temperature
This numeric field contains entering air wetbulb temperature at nominal conditions in degrees
Celsius. The design entering air wet-bulb temperature must be less than the design entering
air (dry-bulb) temperature. Only used for Performance Input Method =
UserSpecifiedDesignCapacity; for other performance input methods this field is ignored.
Field: Capacity Control
This alpha field contains the cooling capacity control for the evaporative fluid cooler. Two
choices are available: FanCycling and FluidBypass. During part-load conditions, there are
two ways to maintain the exiting water temperature at the setpoint: either cycling the
9/29/14

763

Input-Output Reference

Group Condenser Equipment

evaporative fluid cooler fan, or bypassing portion of the evaporative fluid cooler water with a
three-way valve. For FluidBypass, the evaporative fluid cooler fan still runs at full speed for
the entire timestep, but only portion of the water flow goes through the evaporative fluid
cooler media to get cooled while the remaining portion of the water flow gets bypassed. Two
water flows then mix at the common water sump to meet the setpoint temperature.
Field: Sizing Factor
This optional numeric field allows the user to specify a sizing factor for this component. The
sizing factor is used when the component design inputs are autosized: the autosizing
calculations are performed as usual and the results are multiplied by the sizing factor. Sizing
factor allows the user to size a component to meet part of the design load while continuing to
use the autosizing feature. For this component the inputs that would be altered by the sizing
factor are:
1. Design Water Flow Rate;
2. Design Air Flow Rate;
3. Fan Power at Design Air Flow Rate;
4. U-Factor Times Area Value at Design Air Flow Rate;
Note that the U-Factor Times Area Value at Design Air Flow Rate is not multiplied by the
Sizing Factor. Instead the design evaporative fluid cooler load is multiplied by the sizing
factor and the design UA then calculated as usual.
Field: Evaporation Loss Mode
This field is used to choose which method is used to model the amount of water evaporated
by the evaporative fluid cooler. There are two options: LossFactor or SaturatedExit. The
default is SaturatedExit. The user-defined loss factor is entered in the following field. By
assuming that the air leaving the evaporative fluid cooler is saturated, the evaporation can be
directly calculated using moist air engineering calculations with data available within the
evaporative fluid cooler model (and does not require additional user input).
Field: Evaporation Loss Factor
This field is used to specify the rate of water evaporated from the evaporative fluid cooler and
lost to the outside air [percent/K]. This field is only used if the Evaporation Calculation Mode
is set to LossFactor. The evaporation loss is then calculated as a fraction of the circulating
condenser water flow and varies with the temperature change in the condenser water. The
value entered here is in units of percent-per-kelvin. The evaporation rate will equal this value
times each degree Kelvin of temperature drop in the condenser water. Empirical correlation is
used to calculate default loss factor if it not explicitly specified in the input file.
Field: Drift Loss Percent
This field is used to specify the rate of water lost to the exiting air as entrained droplets [%].
The drift loss is a percent of the condenser water flow. Default value is under investigation for
now cooling towers evaporation loss factor is taken as default value.
Field: Blowdown Calculation Mode
This field specifies which method is used to determine blowdown rates. There two options
ConcentrationRatio or ScheduledRate. The choice will determine which of the two models
below is used. The default is ConcentrationRatio.
Field: Blowdown Concentration Ratio
This field is used to dynamically adjust the rate of blowdown in the evaporative fluid cooler as
a function of the rate of evaporation. Blowdown is water intentionally drained from the
evaporative fluid cooler in order to offset the build up of solids in the water that would
otherwise occur because of evaporation. The value entered here is dimensionless. It can be
characterized as the ratio of solids in the blowdown water to solids in the make up water.
9/29/14

764

Input-Output Reference

Group Condenser Equipment

Default value is under investigation for now cooling towers evaporation loss factor is taken as
default value.
Field: Blowdown Makeup Water Usage Schedule Name
This alpha field contains the name of the schedule used to define the amount of water (m3/s)
flushed from the basin on a periodic basis to purge the evaporative fluid cooler of mineral
scale build-up and other contaminants. This schedule is only used if the Blowdown
Calculation Mode is set to ScheduledRate. The amount of water use due to blowdown
depends on the makeup water quality and is specific to each geographical location. Default
value is under investigation for now cooling towers evaporation loss factor is taken as default
value.This water usage is in addition to the amount of water lost to the atmosphere due to
evaporation and/or drift. Since blowdown occurs when the basin water contaminant
concentration is high, blowdown only occurs when the evaporative fluid cooler is active and
water is flowing through the evaporative fluid cooler (regardless of the water usage defined
by this schedule).
Field: Supply Water Storage Tank Name
This field is optional. It is used to describe where the evaporative fluid cooler obtains water
used for evaporative cooling. If blank or omitted, then the evaporative fluid cooler will obtain
water directly from the mains. If the name of a WaterUse:Storage object is used here, then
the evaporative fluid cooler will obtain its water from that tank. If a tank is specified, the
evaporative fluid cooler will attempt to obtain all the water it uses from the tank. However if
the tank cannot provide all the water the evaporative fluid cooler needs, then the evaporative
fluid cooler will still operate and obtain the rest of the water it needs from the mains (referred
to as Starved water).
An IDF specification for this object is shown below:
EvaporativeFluidCooler:SingleSpeed,
Big EvaporativeFluidCooler,
!- Name
Condenser EvaporativeFluidcooler Inlet Node, !- Water Inlet Node Name
Condenser EvaporativeFluidcooler Outlet Node, !- Water Outlet Node Name
3.02,
!- Design Air Flow Rate {m3/s}
2250,
!- Design Air Flow Rate Fan Power {W}
0.002208,
!- Design Spray Water Flow Rate {m3/s}
UserSpecifiedDesignCapacity,
!- Performance Input Method
,
!- Outdoor Air Inlet Node Name
1.25,
!- Heat Rejection Capacity and Nominal Capacity Sizing Ratio
,
!- Standard Design Capacity {W}
,
!- Design Air Flow Rate U-factor Times Area Value {W/K}
0.001703,
!- Design Water Flow Rate {m3/s}
87921,
!- User Specified Design Capacity {W}
46.11,
!- Design Entering Water Temperature {C}
35,
!- Design Entering Air Temperature {C}
25.6;
!- Design Entering Air Wet-bulb Temperature {C}

Single Speed Evaporative Fluid Cooler Outputs

HVAC,Average,Cooling Tower Fan Electric Power [W]
HVAC,Sum,Cooling Tower Fan Electric Energy [J]
HVAC,Average,Cooling Tower Heat Transfer Rate [W]
HVAC,Average,Cooling Tower Inlet Temperature [C]
HVAC,Average,Cooling Tower Outlet Temperature [C]
HVAC,Average,Cooling Tower Mass Flow Rate [kg/s]
HVAC,Average,Cooling Tower Bypass Fraction []
HVAC,Average,Cooling Tower Make Up Water Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Tower Make Up Water Volume [m3]
HVAC,Average,Cooling Tower Water Evaporation Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Tower Water Evaporation Volume [m3]
HVAC,Average,Cooling Tower Water Drift Volume Flow Rate [m3/s]
HVAC,Sum,Evaporative Fluid Cooler Water Drift [m3]
HVAC,Average,Cooling Tower Water Blowdown Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Tower Water Blowdown Volume [m3]
9/29/14

765

Input-Output Reference

Group Condenser Equipment

HVAC,Sum,Cooling Tower Make Up Mains Water Volume [m3]

If Supply Water Storage Tank Name is specified:
HVAC,Average,Cooling Tower Storage Tank Water Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Tower Storage Tank Water Volume [m3]
HVAC,Average,Cooling Tower Starved Storage Tank Water Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Tower Starved Storage Tank Water Volume [m3]

Cooling Tower Fan Electric Power [W]

The average electric power consumption of the fluid cooler fan in Watts for the timestep being
reported.
Cooling Tower Fan Electric Energy [J]
Fan energy use in Joules.
Consumption is metered on HeatRejection:Electricity,
Electricity:Plant, and Electricity:Facility.
Cooling Tower Heat Transfer Rate [W]
This is the average rate, in Watts, at which heat is removed from the condenser water loop by
the fluid cooler for the time step being reported.
Cooling Tower Inlet Temperature [C]
The fluid temperature at the fluid cooler inlet in degrees Celsius.
Cooling Tower Outlet Temperature [C]
The fluid temperature at the fluid cooler outlet in degrees Celsius.
Cooling Tower Mass Flow Rate [kg/s]
The average fluid mass flow rate through the fluid cooler in kg/s for the time step being
reported.
Cooling Tower Bypass Fraction []
This output is the average fluid bypass fraction for the time step being reported. See Capacity
Control input field.
Cooling Tower Make Up Water Volume Flow Rate [m3/s]
Cooling Tower Make Up Water Volume [m3]
These outputs are the external spray water consumed by the evaporative fluid cooler. This is
the total of evaporation, drift, and blowdown.
Cooling Tower Water Evaporation Volume Flow Rate [m3/s]
Cooling Tower Water Evaporation Volume [m3]
Cooling Tower Water Drift Volume Flow Rate [m3/s]
Cooling Tower Water Drift Volume [m3]
Cooling Tower Water Blowdown Volume Flow Rate [m3/s]
Cooling Tower Water Blowdown Volume [m3]
These outputs provide the breakdown of the different components of water use during fluid
cooler operation.
Cooling Tower Make Up Mains Water Volume [m3]
The volume of make up water provided by the mains in cubic meters. If no Supply Water
Storage Tank is specified, then all fluid cooler make up water is provided by the mains (same
as Cooling Tower Make Up Water Volume). If a Supply Water Storage Tank is specified, then
9/29/14

766

Input-Output Reference

Group Condenser Equipment

the make up from the mains only occurs when sufficient water supply is not available from the
tank (same as Evaporative Fluid Cooler Water Starved by Storage Tank). This output
variable
is
metered
on
HeatRejection:MainsWater,
MainsWater:Plant
and
MainsWater:Facility.
Cooling Tower Storage Tank Water Volume Flow Rate [m3/s]
Cooling Tower Storage Tank Water Volume [m3]
These are the rate and volume of water provided by the Supply Water Storage Tank.
Cooling Tower Starved Storage Tank Water Volume Flow Rate [m3/s]
Cooling Tower Starved Storage Tank Water Volume [m3]
These are the rate and volume of water the Supply Water Storage Tank was not able to
provide. The starved water is assumed to come from the mains. The fluid coolers operation
is not affected by a lack of storage tank water.
EvaporativeFluidCooler:TwoSpeed
The two-speed evaporative fluid cooler is modeled in a similar fashion to the single-speed
evaporative fluid cooler. The evaporative fluid cooler is modeled as a counter flow heat
exchanger with two-speed fan (induced draft configuration. See schematic diagram in
EvaporativeFluidCooler:SingleSpeed section). The user must define fluid cooler performance
via one of the three methods: design heat transfer coefficient-area product (UA) and design
water flow rate, or standard fluid cooler design capacity at a specific rating point or design
capacity at non standard conditions. Regardless of which method is chosen, the design
airflow rate and corresponding fan power must be specified.
The evaporative fluid cooler seeks to maintain the temperature of the water exiting the
evaporative fluid cooler at (or below) a set point. The set point schedule value is defined by
the field Condenser Loop Temperature Setpoint Node Name or Reference for the
CondenserLoop object. The model first checks to see whether inlet water temperature is at or
below the set point. If so, then the fluid cooler fan is not turned on and all the flow goes
through bypass. If the inlet water temperature is above the set point then the fluid cooler fan
is turned on at low speed to reduce the exiting water temperature to the set point. If operating
the fluid cooler fan at low speed does not reduce the exiting water temperature to the set
point, then the fluid cooler fan is increased to its high speed.
The model assumes that part-load operation is represented by a simple linear interpolation
between two steady-state regimes (i.e., fluid cooler fan at high speed for the entire simulation
timestep and fluid cooler fan at low speed for the entire simulation timestep, or fluid cooler fan
at low speed for the entire simulation timestep and fluid cooler fan off for the entire simulation
timestep). Cyclic losses are not taken into account.
Evaporative fluid coolers consume water through evaporation, drift, and blowdown. The
model can be used to predict water consumed by the evaporative fluid coolers. For this
purpose, the last seven input fields can either be provided in the input or if nothing is
specified then the default values for these fields will be used. These fields provide methods of
controlling details of the water consumption calculations. The user can specify connections to
the rest of the buildings water system by providing the name of a water storage tanks (i.e.
WaterUse:Storage objects).
Field: Name
This alpha field contains the identifying name for the fluid cooler.
Field: Water Inlet Node Name
This alpha field contains the identifying name for the fluid coolers water inlet node.

9/29/14

767

Input-Output Reference

Group Condenser Equipment

Field: Water Outlet Node Name

This alpha field contains the identifying name for the fluid coolers water outlet node.
Field: High Fan Speed Air Flow Rate
This numeric field contains the fluid cooler air flow rate at high fan speed in m 3/s. A value
greater than zero must be defined regardless of fluid cooler performance input method.
Alternately, this field can be autosized. See Engineering Reference document for fluid cooler
autosizing.
Field: High Fan Speed Fan Power
This numeric field contains the fan power (in Watts) at the high-speed air flow rate specified
in the previous field. A value greater than zero must be specified regardless of fluid cooler
performance input method, or this field can be autosized. See Engineering Reference
document for fluid cooler autosizing.
Field: Low Fan Speed Air Flow Rate
This numeric field contains the fluid cooler air flow rate at low fan speed in m 3/s. This value
must be greater than zero, less than the value specified for the field Air Flow Rate at High
Fan Speed. This field may be autocalculated, in which case it is set to a fraction of the Air
Flow Rate at High Fan Speed determined in the following field.
Field: Low Fan Speed Air Flow Rate Sizing Factor
This numeric field contains the sizing factor for calculating the low fan speed air flow rate as a
fraction of the high fan speed air flow rate. The default is 0.5.
Field: Low Fan Speed Fan Power
This numeric field contains the fan power (in Watts) at the low-speed air flow rate specified in
the previous field. This value must be specified greater than zero or the field may be
autocalculated, in which case it is set to a fraction of the Fan Power at High Fan Speed
determined in the following field.
Field: Low Fan Speed Fan Power Sizing Factor
This numeric field contains the sizing factor for calculating the low fan speed fan power as a
fraction of the high fan speed fan power. The default is 0.16.
Field: Design Spray Water Flow Rate
This numeric field contains the design spray water flow rate through the fluid cooler in m 3/s.
This input field must be specified for all the performance input methods.
Field: Performance Input Method
This alpha field contains the method by which the user will specify fluid cooler performance:
UFactorTimesAreaAndDesignWaterFlowRate
or
StandardDesignCapacity
or
UserSpecifiedDesignCapacity.
Field: Outdoor Air Inlet Node Name
This optional alpha field specifies the outdoor air node name used to define the conditions of
the air entering the fluid cooler. If this field is left blank, the outdoor air conditions entering the
fluid cooler are taken directly from the weather data. If this field is not blank, the node name
specified must also be specified in an OutdoorAir:Node object where the height of the node is
taken into consideration when calculating outdoor air conditions from the weather data.
Alternately, the node name may be specified in an OutdoorAir:NodeList object where the
outdoor air conditions are taken directly from the weather data.

9/29/14

768

Input-Output Reference

Group Condenser Equipment

Field: Heat Rejection Capacity and Nominal Capacity Sizing Ratio

This numeric field contains the value for the ratio of actual tower heat rejection to nominal
capacity. This ratio is defined at entering water at 35C (95F), leaving water at 29.4C (85F),
entering air at 25.6C (78F) wetbulb and 35C (95F) drybulb temperatures. Historically this ratio
has been set at 1.25 based on the assumption that the tower must dissipate 0.25 W of
compressor power for every what of heat removed at the chiller evaporator. The default is
1.25.
Field: High Speed Standard Design Capacity
This numeric input field contains the heat rejection capacity of the fluid cooler in watts, with
entering water at 35C (95F), leaving water at 29.4C (85F), entering air at 25.6C (78F)
wetbulb and 35C (95F) drybulb temperatures. The design water flow rate is assumed to be
5.382E-8 m3/s per watt of nominal capacity (3 gpm/ton). The Heat Rejection Capacity and
Nominal Capacity Sizing Ratio set in the previous field is applied to this capacity to give the
actual fluid cooler heat rejection at these operating conditions. This field is only used for
performance input method =StandardDesignCapacity. For other input methods this field is
ignored. The standard conditions mentioned above for standard design capacity are already
specified in the EnergyPlus. So the input fields such as design entering water temp., design
entering air wet-bulb and dry-bulb temp. and design water flow rate, if provided in the input,
will be ignored for the StandardDesignCapacity performance input method. Also, the
standard conditions are for water as a fluid type so this performance input method can only
be used with water as a fluid type (ref. CondenserLoop object).
Field: Low Speed Standard Design Capacity
This numeric input field contains the heat rejection capacity of the fluid cooler in watts, with
entering water at 35C (95F), leaving water at 29.4C (85F), entering air at 25.6C (78F)
wetbulb and 35C (95F) drybulb temperatures. The design water flow rate is assumed to be
5.382E-8 m3/s per watt of nominal capacity (3 gpm/ton). The Heat Rejection Capacity and
Nominal Capacity Sizing Ratio is applied to this capacity to give the actual fluid cooler heat
rejection at these operating conditions. This field is only used for performance input method
=StandardDesignCapacity. For other input methods this field is ignored. The standard
conditions mentioned above for standard design capacity are already specified in the
EnergyPlus. So the input fields such as design entering water temp., design entering air wetbulb and dry-bulb temp. and design water flow rate, if provided in the input, will be ignored for
the StandardDesignCapacity performance input method. Also, the standard conditions are for
water as a fluid type so this performance input method can only be used with water as a fluid
type (ref. CondenserLoop object). The value specified for this field must be greater than zero
but less than the value specified for the field High-Speed Standard Design Capacity. This
field may be autocalculated, in which case it is set to a fraction of the High-Speed Standard
Design Capacity determined in the following field.
Field: Low Speed Standard Capacity Sizing Factor
This numeric field contains the sizing factor to use when calculating the Low Speed Standard
Design Capacity. The default is 0.5.
Field: High Fan Speed U-factor Times Area Value
This numeric field contains the heat transfer coefficient-area product (UA) in watts per Kelvin
corresponding to the high speed design air and water flow rates specified above. If the input
field
Performance
Input
Method
is
specified
as
UFactorTimesAreaAndDesignWaterFlowRate, then a UA value greater than zero but less
than or equal to 2,100,000 must be defined, or the field can be autosized. If autosized, a
Plant Sizing object must be defined and the design fluid cooler UA value is derived from the
design load to be rejected by the condenser loop and the design loop delta T (Ref. Sizing and
Input for Design Calculations and Component Autosizing sections), the fluid cooler inlet air
dry-bulb and wetbulb temperature are taken from the input. This field is only used for
9/29/14

769

Input-Output Reference

Group Condenser Equipment

performance input method = UFactorTimesAreaAndDesignWaterFlowRate. For other input

methods this field is ignored.
Field: Low Fan Speed U-factor Times Area Value
This numeric field contains the heat transfer coefficient-area product (UA) in watts per degree
Kelvin corresponding to the low speed design air and water flow rates specified above. If the
input
field
Performance
Input
Method
is
specified
as
UFactorTimesAreaAndDesignWaterFlowRate, then a UA value greater than zero but less
than or equal to 300,000 and less than the value specified for the field U-Factor Times Area
Value at High Fan Speed must be defined. This field may be autocalculated, in which case it
is set to a factor of the U-Factor Times Area Value at High Fan Speed determined in the
following field. This field is only used for performance input method =
UFactorTimesAreaAndDesignWaterFlowRate. For other input methods this field is ignored.
Field: Low Fan Speed U-Factor Times Area Sizing Factor
This field contains the sizing factor to use when calculating the Low Fan Speed U-Factor
Times Area Value. The default is 0.6.
Field: Design Water Flow Rate
This numeric field contains the design water flow rate through the fluid cooler in m 3/s. This
value is the flow rate of the condenser loop water being cooled by the fluid cooler. This field is
ignored for the StandardDesignCapacity performance input method. If autosized, a Plant
Sizing object must be defined and the design water flow rate is derived from the design load
to be rejected by the condenser loop and the design loop delta T (Ref. Sizing and Input for
Design Calculations and Component Autosizing sections).
Field: High Speed User Specified Design Capacity
This numeric input field contains the heat rejection capacity of the fluid cooler in watts.
Design conditions for this capacity i.e. entering air dry-bulb temperature, entering air wet-bulb
temperature and entering water temperature must be provided in the input. Only used for
Performance Input Method = UserSpecifiedDesignCapacity; for other performance input
methods this field is ignored.
Field: Low Speed User Specified Design Capacity
This numeric input field contains the heat rejection capacity of the fluid cooler in watts.
Design conditions for this capacity i.e. entering air dry-bulb temperature, entering air wet-bulb
temperature and entering water temperature must be provided in the input. Only used for
Performance Input Method = UserSpecifiedDesignCapacity; for other performance input
methods this field is ignored. This field may be autocalculated, in which case it is set to a
fraction of the High Speed User Specified Design Capacity determined in the following field.
Field: Low Speed User Specified Design Capacity Sizing Factor
This field contains the sizing factor to use when calculating the Low-Speed User Specified
Design Capacity. The default is 0.5.
Field: Design Entering Water Temperature
This numeric field contains entering water temperature at nominal conditions in degrees
Celsius. The design entering water temperature must be greater than the design entering air
temperature. Only used for Performance Input Method = UserSpecifiedDesignCapacity; for
other performance input methods this field is ignored.
Field: Design Entering Air Temperature
This numeric field contains entering air dry-bulb temperature at nominal conditions in degrees
Celsius. The design entering air temperature must be greater than the design entering air

9/29/14

770

Input-Output Reference

Group Condenser Equipment

wet-bulb
temperature.
Only
used
for
Performance
Input
Method
UserSpecifiedDesignCapacity; for other performance input methods this field is ignored.

Field: Design Entering Air Wet-bulb Temperature

This numeric field contains entering air wetbulb temperature at nominal conditions in degrees
Celsius. The design entering air wet-bulb temperature must be less than the design entering
air (dry-bulb) temperature. Only used for Performance Input Method =
UserSpecifiedDesignCapacity; for other performance input methods this field is ignored.
Field: High Speed Sizing Factor
This optional numeric field allows the user to specify a sizing factor for this component. The
sizing factor is used when the component design inputs are autosized: the autosizing
calculations are performed as usual and the results are multiplied by the sizing factor. Sizing
factor allows the user to size a component to meet part of the design load while continuing to
use the autosizing feature. For this component the inputs that would be altered by the sizing
factor are:
1. Design Water Flow Rate;
2. Air Flow Rate at High Fan Speed;
3. Fan Power at High Fan Speed;
4. U-Factor Times Area Value at High Fan Speed;
5. Air Flow Rate at Low Fan Speed;
6. Fan Power at Low Fan Speed;
7. U-Factor Times Area Value at Low Fan Speed;
Note that the U-Factor Times Area Value at High Fan Speed is not multiplied by the Sizing
Factor. Instead the design evaporative fluid cooler load is multiplied by the sizing factor and
the design UA then calculated as usual. The U-Factor Times Area Value at Low Fan Speed is
set to Low Fan Speed U-Factor Times Area Sizing Factor times the full load design UA.
Field: Evaporation Loss Mode
This field is used to choose which method is used to model the amount of water evaporated
by the evaporative fluid cooler. There are two options: LossFactor or SaturatedExit. The
default is SaturatedExit. The user-defined loss factor is entered in the following field. By
assuming that the air leaving the evaporative fluid cooler is saturated, the evaporation can be
directly calculated using moist air engineering calculations with data available within the
evaporative fluid cooler model (and does not require additional user input).
Field: Evaporation Loss Factor
This field is used to specify the rate of water evaporated from the evaporative fluid cooler and
lost to the outside air [percent/K]. This field is only used if the Evaporation Calculation Mode
is set to LossFactor. The evaporation loss is then calculated as a fraction of the circulating
condenser water flow and varies with the temperature change in the condenser water. The
value entered here is in units of percent-per-kelvin. The evaporation rate will equal this value
times each degree Kelvin of temperature drop in the condenser water. Empirical correlation is
used to calculate default loss factor if it not explicitly specified in the input file.
Field: Drift Loss Percent
This field is used to specify the rate of water lost to the exiting air as entrained droplets [%].
The drift loss is a percent of the condenser water flow. Default value is under investigation for
now cooling towers evaporation loss factor is taken as default value.

9/29/14

771

Input-Output Reference

Group Condenser Equipment

Field: Blowdown Calculation Mode

This field specifies which method is used to determine blowdown rates. There two options
ConcentrationRatio or ScheduledRate. The choice will determine which of the two models
below is used. The default is ConcentrationRatio.
Field: Blowdown Concentration Ratio
This field is used to dynamically adjust the rate of blowdown in the evaporative fluid cooler as
a function of the rate of evaporation. Blowdown is water intentionally drained from the
evaporative fluid cooler in order to offset the build up of solids in the water that would
otherwise occur because of evaporation. The value entered here is dimensionless. It can be
characterized as the ratio of solids in the blowdown water to solids in the make up water.
Default value is under investigation for now cooling towers evaporation loss factor is taken as
default value.
Field: Blowdown Makeup Water Usage Schedule Name
This alpha field contains the name of the schedule used to define the amount of water (m3/s)
flushed from the basin on a periodic basis to purge the evaporative fluid cooler of mineral
scale build-up and other contaminants. This schedule is only used if the Blowdown
Calculation Mode is set to ScheduledRate. The amount of water use due to blowdown
depends on the makeup water quality and is specific to each geographical location. Default
value is under investigation for now cooling towers evaporation loss factor is taken as default
value.This water usage is in addition to the amount of water lost to the atmosphere due to
evaporation and/or drift. Since blowdown occurs when the basin water contaminant
concentration is high, blowdown only occurs when the evaporative fluid cooler is active and
water is flowing through the evaporative fluid cooler (regardless of the water usage defined
by this schedule).
Field: Supply Water Storage Tank Name
This field is optional. It is used to describe where the evaporative fluid cooler obtains water
used for evaporative cooling. If blank or omitted, then the evaporative fluid cooler will obtain
water directly from the mains. If the name of a WaterUse:Storage object is used here, then
the evaporative fluid cooler will obtain its water from that tank. If a tank is specified, the
evaporative fluid cooler will attempt to obtain all the water it uses from the tank. However if
the tank cannot provide all the water the evaporative fluid cooler needs, then the evaporative
fluid cooler will still operate and obtain the rest of the water it needs from the mains (referred
to as Starved water).
Examples of an IDF specification for this object are shown below:

9/29/14

772

Input-Output Reference

Group Condenser Equipment

EvaporativeFluidCooler:TwoSpeed,
Big EvaporativeFluidCooler,
!- Name
Condenser EvaporativeFluidcooler Inlet Node, !- Water Inlet Node Name
Condenser EvaporativeFluidcooler Outlet Node, !- Water Outlet Node Name
9.911,
!- High Fan Speed Air Flow Rate {m3/s}
autosize,
!- High Fan Speed Fan Power {W}
4.911,
!- Low Fan Speed Air Flow Rate {m3/s}
0.5,
!- Low Fan Speed Air Flow Rate Sizing Factor
autosize,
!- Low Fan Speed Fan Power {W}
0.16,
!- Low Fan Speed Fan Power Sizing Factor
0.002208,
!- Design Spray Water Flow Rate {m3/s}
UserSpecifiedDesignCapacity,
!- Performance Input Method
,
!- Outdoor Air Inlet Node Name
1.25,
!- Heat Rejection Capacity and Nominal Capacity Sizing Ratio
,
!- High Speed Standard Design Capacity {W}
,
!- Low Speed Standard Design Capacity {W}
0.5,
!- Low Speed Standard Capacity Sizing Factor
,
!- High Fan Speed U-factor Times Area Value {W/K}
,
!- Low Fan Speed U-factor Times Area Value {W/K}
0.6,
!- Low Fan Speed U-Factor Times Area Sizing Factor
0.001703,
!- Design Water Flow Rate {m3/s}
87921,
!- High Speed User Specified Design Capacity {W}
47921,
!- Low Speed User Specified Design Capacity {W}
0.5,
!- Low Speed User Specified Design Capacity Sizing Factor
46.11,
!- Design Entering Water Temperature {C}
35,
!- Design Entering Air Temperature {C}
25.6;
!- Design Entering Air Wet-bulb Temperature {C}

Two Speed Evaporative Fluid Cooler Outputs

HVAC,Average,Cooling Tower Fan Electric Power [W]
HVAC,Sum,Cooling Tower Fan Electric Energy [J]
HVAC,Average,Cooling Tower Heat Transfer Rate [W]
HVAC,Average,Cooling Tower Inlet Temperature [C]
HVAC,Average,Cooling Tower Outlet Temperature [C]
HVAC,Average,Cooling Tower Mass Flow Rate [kg/s]
HVAC,Average,Cooling Tower Make Up Water Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Tower Make Up Water Volume [m3]
HVAC,Average,Cooling Tower Water Evaporation Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Tower Water Evaporation Volume [m3]
HVAC,Average,Cooling Tower Water Drift Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Tower Water Drift Volume [m3]
HVAC,Average,Cooling Tower Water Blowdown Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Tower Water Blowdown Volume [m3]
HVAC,Sum,Cooling Tower Make Up Mains Water Volume [m3]
If Supply Water Storage Tank Name is specified:
HVAC,Average,Cooling Tower Storage Tank Water Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Tower Storage Tank Water Volume [m3]
HVAC,Average,Cooling Tower Starved Storage Tank Water Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Tower Starved Storage Tank Water Volume [m3]

Cooling Tower Fan Electric Power [W]

The average electric power consumption of the fluid cooler fan in Watts for the timestep being
reported.
Cooling Tower Fan Electric Energy [J]
Fan energy use in Joules.
Consumption is metered on HeatRejection:Electricity,
Electricity:Plant, and Electricity:Facility.
Cooling Tower Heat Transfer Rate [W]
This is the average rate, in Watts, at which heat is removed from the condenser water loop by
the fluid cooler for the time step being reported.

9/29/14

773

Input-Output Reference

Group Condenser Equipment

Cooling Tower Inlet Temperature [C]

The fluid temperature at the fluid cooler inlet in degrees Celsius.
Cooling Tower Outlet Temperature [C]
The fluid temperature at the fluid cooler outlet in degrees Celsius.
Cooling Tower Mass Flow Rate [kg/s]
The average fluid mass flow rate through the fluid cooler in kg/s for the time step being
reported.
Cooling Tower Make Up Water Volume Flow Rate [m3/s]
Cooling Tower Make Up Water Volume [m3]
These outputs are the external spray water consumed by the evaporative fluid cooler. This is
the total of evaporation, drift, and blowdown.
Cooling Tower Water Evaporation Volume Flow Rate [m3/s]
Cooling Tower Water Evaporation Volume [m3]
Cooling Tower Water Drift Volume Flow Rate [m3/s]
Cooling Tower Water Drift Volume [m3]
Cooling Tower Water Blowdown Volume Flow Rate [m3/s]
Cooling Tower Water Blowdown Volume [m3]
These outputs provide the breakdown of the different components of water use during fluid
cooler operation.
Cooling Tower Make Up Mains Water Volume [m3]
The volume of make up water provided by the mains in cubic meters. If no Supply Water
Storage Tank is specified, then all fluid cooler make up water is provided by the mains (same
as Cooling Tower Make Up Water Volume). If a Supply Water Storage Tank is specified, then
the make up from the mains only occurs when sufficient water supply is not available from the
tank (same as Cooling Tower Starved Storage Tank Water Volume). This output variable is
metered on HeatRejection:MainsWater, MainsWater:Plant and MainsWater:Facility.
Cooling Tower Storage Tank Water Volume Flow Rate [m3/s]
Cooling Tower Storage Tank Water Volume [m3]
These are the rate and volume of water provided by the Supply Water Storage Tank.
Cooling Tower Starved Storage Tank Water Volume Flow Rate [m3/s]
Cooling Tower Starved Storage Tank Water Volume [m3]
These are the rate and volume of water the Supply Water Storage Tank was not able to
provide. The starved water is assumed to come from the mains. The fluid coolers operation
is not affected by a lack of storage tank water.
FluidCooler:SingleSpeed
Fluid coolers are components that may be assigned to condenser loops. The Fluid cooler is
modeled as a cross flow heat exchanger (both streams unmixed) with single-speed fans
(induced draft configuration). The user must define fluid cooler performance via one of the
two methods: design heat transfer coefficient-area product (UA) and design water flow rate,
or nominal fluid cooler capacity at a specific rating point. Regardless of which method is
chosen, the design airflow rate and corresponding fan power must be specified.

9/29/14

774

Input-Output Reference

Group Condenser Equipment

The fluid cooler seeks to maintain the temperature of the water exiting the fluid cooler at (or
below) a set point. The set point schedule value is defined by the field Condenser Loop
Temperature Setpoint Node Name or Reference for the CondenserLoop object. The model
assumes that part-load operation is represented by a simple linear interpolation between two
steady-state regimes (i.e., fluid cooler fan on for the entire simulation timestep and fluid
cooler fan off for the entire simulation timestep). Cyclic losses are not taken into account.
Field: Name
This alpha field contains the identifying name for the Fluid Cooler.
Field: Water Inlet Node Name
This alpha field contains the identifying name for the Fluid Coolers water inlet node.
Field: Water Outlet Node Name
This alpha field contains the identifying name for the Fluid Coolers water outlet node.
Field: Performance Input Method
This alpha field contains the method by which the user will specify fluid cooler performance:
UFactorTimesAreaAndDesignWaterFlowRate or NominalCapacity.
Field: Design Air Flow Rate U-factor Times Area Value
This numeric field contains the heat transfer coefficient-area product (UA) in watts per Kelvin
corresponding to the design air and water flow rates specified above. If the input field
Performance Input Method is specified as UFactorTimesAreaAndDesignWaterFlowRate,
then a UA value greater than zero but less than or equal to 300,000 must be defined, or the
field can be autosized. If autosized, a Plant Sizing object must be defined and the design fluid
cooler UA value is derived from the design load to be rejected by the condenser loop and the
design loop delta T (Ref. Sizing and Input for Design Calculations and Component Autosizing
sections), the fluid cooler inlet air dry-bulb and wetbulb temperature are taken from the input.
If Performance Input Method is specified as NominalCapacity, then this field must be left
blank since the model automatically calculates the fluid cooler UA based on the fluid cooler
capacity and nominal conditions specified in input file.
Field: Nominal Capacity
This numeric input field contains the nominal heat rejection capacity of the fluid cooler in
watts, Nominal conditions i.e. entering air dry-bulb temperature, entering air wet-bulb
temperature and Entering water temperature should be provided in the input.
Field: Design Entering Water Temperature
This numeric field contains entering water temperature at nominal conditions in degrees
Celsius. This field must be specified for both the performance input methods. The design
entering water temperature must be greater than the design entering air temperature.
Field: Design Entering Air Temperature
This numeric field contains entering air dry-bulb temperature at nominal conditions in degrees
Celsius. This field must be specified for both the performance input methods. The design
entering air temperature must be greater than the design entering air wet-bulb temperature.
Field: Design Entering Air Wet-bulb Temperature
This numeric field contains entering air wetbulb temperature at nominal conditions in degrees
Celsius. This field must be specified for both the performance input methods. The design
entering air wet-bulb temperature must be less than the design entering air (dry-bulb)
temperature.

9/29/14

775

Input-Output Reference

Group Condenser Equipment

Field: Design Water Flow Rate

This numeric field contains the design water flow rate through the fluid cooler in m 3/s. This
value is the flow rate of the condenser loop water being cooled by the fluid cooler. A water
flow rate greater than zero must be defined or the field can be autosized. If autosized, a Plant
Sizing object must be defined and the design water flow rate is derived from the design load
to be rejected by the condenser loop and the design loop delta T (Ref. Sizing and Input for
Design Calculations and Component Autosizing sections).
Field: Design Air Flow Rate
This numeric field contains the design air flow rate induced by the fluid cooler fan in m 3/s. A
value greater than zero must be defined regardless of the fluid cooler performance input
method. Alternately, this field can be autosized. See Engineering Reference document for
fluid cooler autosizing.
Field: Design Air Flow Rate Fan Power
This numeric field contains the fan power (in watts) at the design air flow rate specified in the
previous field. A value greater than zero must be specified regardless of the performance
input method, or this field can be autosized. See Engineering ref. for fluid cooler autosizing.
Field: Outdoor Air Inlet Node Name
This optional alpha field specifies the outdoor air node name used to define the conditions of
the air entering the fluid cooler. If this field is left blank, the outdoor air conditions entering the
fluid cooler are taken directly from the weather data. If this field is not blank, the node name
specified must also be specified in an OutdoorAir:Node object where the height of the node is
taken into consideration when calculating outdoor air conditions from the weather data.
Alternately, the node name may be specified in an OutdoorAir:NodeList object where the
outdoor air conditions are taken directly from the weather data.
An IDF specification for this object is shown below:
FluidCooler:SingleSpeed,
Big FLUIDCOOLER1,
!- Name
Condenser FLUIDCOOLER 1 Inlet Node, !- Water Inlet Node Name
Condenser FLUIDCOOLER 1 Outlet Node, !- Water Outlet Node Name
NominalCapacity,
!- Performance Input Method
,
!- Design Air Flow Rate U-factor Times Area Value {W/K}
58601.,
!- Nominal Capacity {W}
51.67,
!- Design Entering Water Temperature {C}
35,
!- Design Entering Air Temperature {C}
25.6,
!- Design Entering Air Wetbulb Temperature {C}
0.001388,
!- Design Water Flow Rate{m3/s}
9.911,
!- Design Air Flow Rate {m3/s}
Autosize;
!- Design Air Flow Rate Fan Power {W}

Single Speed Fluid Cooler Outputs

HVAC,Average,Cooling Tower Fan Electric Power [W]
HVAC,Sum,Cooling Tower Fan Electric Energy [J]
Zone,Meter,HeatRejection:Electricity [J]
HVAC,Average,Cooling Tower Heat Transfer Rate [W]
HVAC,Average, Cooling Tower Inlet Temperature [C]
HVAC,Average, Cooling Tower Outlet Temperature [C]
HVAC,Average,Cooling Tower Mass Flow Rate [kg/s]

Cooling Tower Fan Electric Power [W]

The electric power consumption of the fluid cooler fans.
Cooling Tower Fan Electric Energy [J]
Fan energy use. Consumption is metered on HeatRejection:Electricity, Electricity:Plant, and
Electricity:Facility.
9/29/14

776

Input-Output Reference

Group Condenser Equipment

Cooling Tower Heat Transfer Rate [W]

This is the rate at which heat is removed from the condenser water loop by the fluid cooler.
Cooling Tower Inlet Temperature [C]
The loop temperature at the fluid cooler inlet.
Cooling Tower Outlet Temperature [C]
The loop temperature at the fluid cooler outlet.
Cooling Tower Mass Flow Rate [kg/s]
The loop mass flow rate of the circulating condenser water loop.
FluidCooler:TwoSpeed
The two-speed fluid cooler is modeled in a similar fashion to the single-speed fluid cooler.
The fluid cooler is modeled as a cross flow heat exchanger (both stream unmixed) with twospeed fans (induced draft configuration). The user must define fluid cooler performance via
one of two methods: heat transfer coefficient-area product (UA) and design water flow rate, or
nominal fluid cooler capacity at a specific rating point. Regardless of which method is chosen,
the airflow rate and corresponding fan power at both high and low fan speed must be
specified. The Fluid Cooler seeks to maintain the temperature of the water exiting the Fluid
Cooler at (or below) a set point. The set point schedule is defined by the field Condenser
Loop Temperature Setpoint Node Name or Reference for the CondenserLoop object. The
model first runs at low speed and calculates the fluid cooler exiting water temperature. If the
exiting water temperature based on low speed is at or below the set point, then the fluid
cooler fan runs at this speed or below this speed. If the exiting water temperature remains
above the set point after low speed is modeled, then the fluid cooler fan runs at high speed
to reduce the exiting water temperature.
The model assumes that part-load operation is represented by a simple linear interpolation
between two steady-state regimes (i.e., fluid cooler fan at high speed for the entire simulation
timestep and fluid cooler fan at low speed for the entire simulation timestep,). Cyclic losses
are not taken into account.
Field: Name
This alpha field contains the identifying name for the fluid cooler.
Field: Water Inlet Node Name
This alpha field contains the identifying name for the fluid coolers water inlet node.
Field: Water Outlet Node Name
This alpha field contains the identifying name for the fluid coolers water outlet node.
Field: Performance Input Method
This alpha field contains the method by which the user will specify fluid cooler performance:
UFactorTimesAreaAndDesignWaterFlowRate or NominalCapacity.
Field: High Fan Speed U-factor Times Area Value
This numeric field contains the heat transfer coefficient-area product (UA) in watts per degree
Celsius corresponding to the high-speed air flow rate and design water flow rate specified
above. If the input field Performance Input Method is specified as
UFactorTimesAreaAndDesignWaterFlowRate, then a UA value greater than zero but less
than or equal to 300,000 must be defined, or the field can be autosized. If autosized, a Plant
Sizing object must be defined and the fluid cooler UA value at high fan speed is derived from
the design load to be rejected by the condenser loop and the design loop delta T (Ref. Sizing
and Input for Design Calculations and Component Autosizing sections), fluid cooler water
9/29/14

777

Input-Output Reference

Group Condenser Equipment

inlet temperature, fluid cooler inlet air drybulb and wetbulb are provided in the input. If
Performance Input Method is specified as NominalCapacity, then this field must be left
blank since the model automatically calculates the fluid cooler UA based on the capacity
specified in the field High Speed Nominal Capacity and nominal conditions.
Field: Low Fan Speed U-factor Times Area Value
This numeric field contains the heat transfer coefficient-area product (UA) in watts per Kelvin
corresponding to the design water flow rate and low-speed air flow rate specified above. If the
input
field
Performance
Input
Method
is
specified
as
UFactorTimesAreaAndDesignWaterFlowRate, this value must be greater than zero but less
than or equal to 300,000, less than the value specified for the field U-factor Times Area
Value at High Fan Speed. This field may be autocalculated, in which case it is set to a factor
of the U-factor Times Area Value at High Fan Speed determined in the following field. If
Performance Input Method is specified as NominalCapacity, then this field must be left
blank since the model automatically calculates the fluid cooler UA based on the fluid cooler
capacity specified in the field Low Speed Nominal Capacity.
Field: Low Fan Speed U-Factor Times Area Sizing Factor
This numeric field contains the sizing factor to use when calculating the Low Fan Speed Ufactor Times Area Value. The default is 0.6.
Field: High Speed Nominal Capacity
This numeric input field contains the nominal heat rejection capacity of the fluid cooler in
watts under high-speed fan operation, with nominal (design) inputs entering water
temperature, entering air temperature and entering air wet-bulb temperature. The design
water flow rate is also provided in the input.
Field: Low Speed Nominal Capacity
This numeric input field contains the nominal heat rejection capacity of the Fluid Cooler in
watts under low-speed fan operation, with nominal (design) inputs entering water
temperature, entering air temperature and entering air wet-bulb temperature. The design
water flow rate is also provided in the input. The value specified for this field must be greater
than zero but less than the value specified for the field High Speed Nominal Capacity. This
field may be autocalculated, in which case it is set to a fraction of the High Speed Nominal
Capacity determined in the following field.
Field: Low Speed Nominal Capacity Sizing Factor
This numeric field contains the sizing factor to use when calculating the Low Speed Nominal
Capacity. The default is 0.5.
Field: Design Entering Water Temperature
This numeric field contains entering water temperature at nominal conditions in degrees
Celsius. This field must be specified for both the performance input methods. The design
entering water temperature must be greater than the design entering air temperature.
Field: Design Entering Air Temperature
This numeric field contains entering air dry-bulb temperature at nominal conditions in degrees
Celsius. This field must be specified for both the performance input methods. The design
entering air temperature must be greater than the design entering air wet-bulb temperature.
Field: Design Entering Air Wet-bulb Temperature
This numeric field contains entering air wet-bulb temperature at nominal conditions in
degrees Celsius. This field must be specified for both the performance input methods. The
design entering air wet-bulb temperature must be less than the design entering air (dry-bulb)
temperature.
9/29/14

778

Input-Output Reference

Group Condenser Equipment

Field: Design Water Flow Rate

This numeric field contains the design water flow rate through the fluid cooler in m 3/s. This
value is the flow rate of the condenser loop water being cooled by the fluid cooler. A water
flow rate greater than zero must be defined or the field can be autosized. If autosized, a Plant
Sizing object must be defined and the design water flow rate is derived from the design load
to be rejected by the condenser loop and the design loop delta T (Ref. Sizing and Input for
Design Calculations and Component Autosizing sections).
Field: High Fan Speed Air Flow Rate
This numeric field contains the fluid cooler air flow rate at high fan speed in m 3/s. A value
greater than zero must be defined regardless of the fluid cooler performance input method.
Alternately, this field can be autosized. See Engineering ref. for fluid cooler autosizing.
Field: High Fan Speed Fan Power
This numeric field contains the fan power (in Watts) at the high-speed air flow rate specified
in the previous field. A value greater than zero must be specified regardless of the fluid cooler
performance input method, or this field can be autosized. See Engineering ref. for fluid cooler
autosizing.
Field: Low Fan Speed Air Flow Rate
This numeric field contains the fluid cooler air flow rate at low fan speed in m 3/s. This value
must be greater than zero, less than the value specified for the field Air Flow Rate at High
Fan Speed. This field may be autocalculated, in which case it is set to a fraction of the Air
Flow Rate at High Fan Speed determined in the following field.
Field: Low Fan Speed Air Flow Rate Sizing Factor
This numeric field contains the sizing factor to use when calculating the Low Fan Speed Air
Flow Rate. The default is 0.5.
Field: Low Fan Speed Fan Power
This numeric field contains the fan power (in Watts) at the low-speed air flow rate specified in
the previous field. This value must be specified greater than zero or the field may be
autocalculated, in which case it is set to set to a fraction of the Fan Power at High Fan
Speed determined in the following field.
Field: Low Fan Speed Fan Power Sizing Factor
This numeric field contains the sizing factor to use whe calculating the Low Fan Speed Fan
Power. The default is 0.16.
Field: Outdoor Air Inlet Node Name
This optional alpha field specifies the outdoor air node name used to define the conditions of
the air entering the Fluid Cooler. If this field is left blank, the outdoor air conditions entering
the Fluid Cooler are taken directly from the weather data. If this field is not blank, the node
name specified must also be specified in an OutdoorAir:Node object where the height of the
node is taken into consideration when calculating outdoor air conditions from the weather
data. Alternately, the node name may be specified in an OutdoorAir:NodeList object where
the outdoor air conditions are taken directly from the weather data.
Examples of an IDF specification for this object are shown below:

9/29/14

779

Input-Output Reference

Group Condenser Equipment

FluidCooler:TwoSpeed,
Big FLUIDCOOLER1,
!- Name
Condenser FLUIDCOOLER 1 inlet Node, !- Water Inlet Node Name
Condenser FLUIDCOOLER 1 Outlet Node, !- Water Outlet Node Name
NominalCapacity,
!- Performance Input Method
,
!- High Fan Speed U-factor Times Area Value {W/K}
,
!- Low Fan Speed U-factor Times Area Value {W/K}
,
!- Low Fan Speed U-Factor Times Area Sizing Factor
58601.,
!- High Speed Nominal Capacity {W}
28601.,
!- Low Speed Nominal Capacity {W}
.
0.6,
!- Low Speed Nominal Capacity Sizing Factor
51.67,
!- Design Entering Water tempereture {C}
35,
!- Design Entering Air tempereture {C}
25.6,
!- Design Entering Air Wet-bulb tempereture {C}
0.001388,
!- Design Water Flow Rate {m3/s}
9.911,
!- High Fan Speed Air Flow Rate {m3/s}
autosize,
!- High Fan Speed Fan Power {W}
autosize,
!- Low Fan Speed Air Flow Rate {m3/s}
0.5,
!- Low Fan Speed Air Flow Rate Sizing Factor
autosize,
!- Low Fan Speed Fan Power {W}
0.16;
!- Low Fan Speed Fan Power Sizing Factor

Two Speed Fluid Cooler Outputs

HVAC,Average,Cooling Tower Fan Electric Power [W]
HVAC,Sum,Cooling Tower Fan Electric Energy [J]
HVAC,Average,Cooling Tower Heat Transfer Rate [W]
HVAC,Average, Cooling Tower Inlet Temperature [C]
HVAC,Average, Cooling Tower Outlet Temperature [C]
HVAC,Average,Cooling Tower Mass Flow Rate [kg/s]

Cooling Tower Fan Electric Power [W]

Average fan electric power consumed.
Cooling Tower Fan Electric Energy [J]
Total energy used by the fan. Consumption is metered on HeatRejection:Electricity,
Electricity:Plant, and Electricity:Facility.
Cooling Tower Heat Transfer Rate [W]
This is the rate at which heat is removed from the condenser water loop by the fluid cooler.
Cooling Tower Inlet Temperature [C]
Loop temperature at the fluid cooler inlet.
Cooling Tower Outlet Temperature [C]
Loop temperature at the fluid cooler outlet.
Cooling Tower Mass Flow Rate [kg/s]
Loop mass flow rate through the fluid cooler.
GroundHeatExchanger:Vertical
The EnergyPlus Ground loop heat exchanger is a condenser component. This serves the
condenser supply side in addition to the cooling towers and other condensing components.
The following figure shows the Ground Heat Exchanger in the simulation environment.
The heat exchanger response is defined by a G-function. This is a non-dimensional function
that is used to calculate the response to square heat pulses of different duration. (This
function is not the same as G-factors referred to in the ASHRAE Applications Handbook).
This continuous function is specified by a series of data pairs (LNTTSi, GFNCi) where,
LNTTSi is the non-dimensional time: ln(T/Ts)

9/29/14

780

Input-Output Reference

Group Condenser Equipment

GFNCi is the G-function value

The G-function is different for each borehole field configuration (i.e. a 4x4 field has a different
response than a 80x80 field) and the borehole thermal resistance. It is also dependant on the
ratio of borehole spacing to depth. G-function values, for accurate simulation, have to be
calculated for each specific heat exchanger design. This can be done using some
commercial ground loop heat exchanger design tool and the like. A reference data set,
containing examples input data for 1x2, 4x4 and 8x8 configurations and for both standard and
thermally enhanced grout, have also been provided. These data are provided as examples
only. Custom G-function values may be generated using an external program such as
GLHEPro. For more information about the datasets and GLHEPro, see the Auxiliary
Programs document section G-Function Spreadsheet.
Further details of the implementation of this model can be found in:
Murugappan, A. Implementing Ground Source Heat Pump and Ground Loop Heat Exchanger
Models in the EnergyPlus Simulation Environment. M.S. Thesis, Oklahoma State University,
December 2002.

Grnd HX
Cond Supply
Side

U-tube

Cond demand
side
Heat
Pump

Plant supply
side

Plant demand
side
Zone

Figure 83. Schematic of EnergyPlus Ground Loop Heat Exchanger

The data definition for the ground loop heat exchanger from the Energy+.idd is shown below.
The syntax to the specification of Borehole, U-tube and ground are illustrated in the example
following.
Field: Name
This alpha field contains the identifying name for the ground heat exchanger (GHE).
Field: Inlet Node Name
This alpha field contains the ground heat exchanger inlet node name.
Field: Outlet Node Name
This alpha field contains the ground heat exchanger outlet node name.
9/29/14

781

Input-Output Reference

Group Condenser Equipment

Field: Maximum Flow Rate

This numeric field contains the GHE maximum design flow rate in cubic meters per second
{m3/s}.
Field: Number of Bore Holes
This numeric field contains the number of bore holes in the GHE installation.
Field: Bore Hole Length
This numeric field contains the length of the borehole in meters {m}.
Field: Bore Hole Radius
This numeric field contains the radius of the borehole in meters.
Field: Ground Thermal Conductivity
This numeric field contains the thermal conductivity of the ground in W/m-K.
FieldSet: Ground Thermal Heat Capacity
This numeric field contains the thermal heat capacity of the ground in J/m3-K.
Field: Ground Temperature
This numeric field contains the far field temperature of the ground in C.
Field: Design Flow Rate
This numeric field contains the design volume flow rate of the GHE in m3/s.
Field: Grout Thermal Conductivity
This numeric field contains the thermal conductivity of the filler material in W/m-K.
Field: Pipe Thermal Conductivity
This numeric field contains the thermal conductivity of the pipe in W/m-K.
Field: Pipe Out Diameter
This numeric field contains the outer diameter of the U-tube (pipe) in meters {m}.
Field: U-Tube Distance
This numeric field contains the distance between the two legs of the U-tube in meters {m}.
Field: Pipe Thickness
This numeric field contains the outer diameter of the U-tube (pipe) in meters.
Field: Maximum Length of Simulation
This numeric field contains the maximum number of years of simulation to be carried out.
Field: G-Function Reference Ratio
The G-Functions may be formulated slightly differently based on the program which
generated them. The raw G-Functions are based on an borehole radius to active length
ratio of 0.0005. If the physical ratio is different from this, a correction must be applied.
EnergyPlus will apply the correction, based on the reference ratio entered in this field.
Therefore, therefore two possible input configurations.
If the G-Functions have not had a correction applied, then the G-Functions are still
based on a reference of 0.0005, so use a value of 0.0005 in this field. EnergyPlus will
adjust the G-Functions internally to create the properly referenced G-Function.
If the correction has already been applied, then the input G-Functions are based on a
reference to the actual (physical) radius/length ratio, so enter the physical
9/29/14

782

Input-Output Reference

Group Condenser Equipment

radius/length in this field. Entering the actual value will nullify any internal corrections,
which will avoid re-basing the G-Function set.
The software GLHEPro has been making this pre-correction to the data sets since version
3.1 of that software, so this input field should match the actual (physical) radius/length ratio.
Field: Number of Data Pairs of the G Function
The borehole response is defined by a non-dimensional G-function. This is specified as a
series of data points giving values of non-dimensional time vs G-function value (LNTTS1,
GFUNC1), (LNTTS2, GFUNC2), (LNTTS3, GFUNC3) .. (LNTTSn, GFUNCn), This
numeric field contains the number of data pairs to be read in (n).
Field: G-Function Ln(T/Ts) Value <x>
This numeric field contains the natural log of time/steady state time:

ln(T/Ts)

Field: G-Function 'G' Value <x>

This numeric field contains the G-function value of the corresponding LNTTS.
The following is an example input:
GroundHeatExchanger:Vertical,
Vertical Ground Heat Exchanger, !- Name
GHE Inlet Node,
!- Inlet Node Name
GHE Outlet Node,
!- Outlet Node Name
0.00330000,
!- Maximum Flow Rate {m3/s}
120,
!- Number of Bore Holes
76.2,
!- Bore Hole Length {m}
.635080E-01,
!- Bore Hole Radius {m}
.692626E+00,
!- Ground Thermal Conductivity {W/m-K}
.234700E+07,
!- Ground Thermal Heat Capacity {J/m3-K}
13.375,
!- Ground Temperature {C}
0.0033,
!- Design Flow Rate {m3/s}
.692626E+00,
!- Grout Thermal Conductivity {W/m-K}
.391312E+00,
!- Pipe Thermal Conductivity {W/m-K}
2.66667E-02,
!- Pipe Out Diameter {m}
2.53977E-02,
!- U-Tube Distance {m}
2.41285E-03,
!- Pipe Thickness {m}
2,
!- Maximum Length of Simulation
0.0005,
!- G-Function Reference Ratio
35,
!- Number of Data Pairs of the G Function
! The G-function is defined by the following data pairs
-15.2996, -0.348322, ! G-Function Ln(T/Ts) Value 1, G-Function G Value
-14.201,
0.022208, ! G-Function Ln(T/Ts) Value 2, G-Function G Value
-13.2202, 0.412345, ! G-Function Ln(T/Ts) Value 3, G-Function G Value
-12.2086, 0.867498, ! G-Function Ln(T/Ts) Value 4, G-Function G Value
-11.1888, 1.357839, ! G-Function Ln(T/Ts) Value 5, G-Function G Value
-10.1816, 1.852024, ! G-Function Ln(T/Ts) Value 6, G-Function G Value
-9.1815,
2.345656, ! G-Function Ln(T/Ts) Value 7, G-Function G Value
-8.6809,
2.593958, ! G-Function Ln(T/Ts) Value 8, G-Function G Value
-8.5,
2.679,
! etc, etc.
-7.8,
3.023,
-7.2,
3.32,
-6.5,
3.681,
-5.9,
4.071,
-5.2,
4.828,
-4.5,
6.253,
-3.963,
7.894,
-3.27,
11.82,
-2.864,
15.117,
-2.577,
18.006,
-2.171,
22.887,
-1.884,
26.924,
9/29/14

1
2
3
4
5
6
7
8

783

Input-Output Reference
-1.191,
-0.497,
-0.274,
-0.051,
0.196,
0.419,
0.642,
0.873,
1.112,
1.335,
1.679,
2.028,
2.275,
3.003,

Group Condenser Equipment

38.004,
49.919,
53.407,
56.632,
59.825,
62.349,
64.524,
66.412,
67.993,
69.162,
70.476,
71.361,
71.79,
72.511;

!- 35 PAIRS

Vertical Ground Heat Exchanger Outputs

HVAC,Average,Ground
HVAC,Average,Ground
HVAC,Average,Ground
HVAC,Average,Ground
HVAC,Average,Ground
HVAC,Average,Ground

Heat
Heat
Heat
Heat
Heat
Heat

Exchanger
Exchanger
Exchanger
Exchanger
Exchanger
Exchanger

Average Borehole Temperature [C]

Heat Transfer Rate [W]
Inlet Temperature [C]
Outlet Temperature [C]
Mass Flow Rate [kg/s]
Average Fluid Temperature [C]

Ground Heat Exchanger Average Borehole Temperature [C]

This is the model result for the average temperature of the borehole heat exchanger.
Ground Heat Exchanger Heat Transfer Rate [W]
This is the rate of heat transfer between the working fluid and the ground heat exchanger, in
Watts.
Ground Heat Exchanger Inlet Temperature [C]
This is the temperature of the working fluid entering the ground heat exchanger.
Ground Heat Exchanger Outlet Temperature [C]
This is the temperature of the working fluid leaving the ground heat exchanger.
Ground Heat Exchanger Mass Flow Rate [kg/s]
This is the mass flow rate of the working fluid through the heat exchanger.
Ground Heat Exchanger Average Fluid Temperature [C]
This is the average temperature of the working fluid inside the heat exchanger.
GroundHeatExchanger:Pond
The pond heat exchanger model represents a shallow pond with submerged hydronic tubes
through which the heat transfer fluid is circulated. The model represents a 'shallow' pond in
that no attempt is made to model any stratification effects that may be present in deeper
ponds.
This type of heat exchanger is intended to be connected to the supply side of a condenser
loop, and can be used with any type of plant loop. The pond may be specified as the only
heat exchanger on the condenser loop (as shown in Figure 84) or it may be connected in
parallel with other condenser loop heat exchangers (such as cooling towers, ground surface
heat exchangers) as shown in the second figure below.

9/29/14

784

Input-Output Reference

Group Condenser Equipment

Pump

Mixer

Splitter

Pond
Heat
Exchanger

CONDENSER LOOP

Chiller

Mixer

Splitter

Figure 84. Example of Pond Ground Heat Exchanger as only heat exchanger on condenser loop

CONDENSER LOOP

Mixer

Chiller

Pump

Splitter

Surface
Heat
Exchanger

Pond

Splitter

Mixer

Figure 85. Pond Ground Heat Exchanger with other heat exchangers on condenser loop
Field: Name
This alpha field contains the identifying name for the outside pond heat exchanger.
Field: Fluid Inlet Node Name
This alpha field contains the fluid inlet node name.
Field: Fluid Outlet Node Name
This alpha field contains the fluid outlet node name.
Field: Pond Depth
This numeric field contains the pond depth {m}.
Field: Pond Area
This numeric field contains the pond area {m 2}.
9/29/14

785

Input-Output Reference

Group Condenser Equipment

Field: Hydronic Tubing Inside Diameter

This numeric field contains the hydronic tubing inside diameter {m}.
Field: Hydronic Tubing Outside Diameter
This numeric field contains the hydronic tubing outside diameter {m}.
Field: Hydronic Tubing Thermal Conductivity
This numeric field contains the hydronic tubing thermal conductivity in W/mK.
Field: Ground Thermal Conductivity
This numeric field contains the ground thermal conductivity in W/m 2K.
Field: Number of Tubing Circuits
This numeric field contains the number of hydronic tubing circuits, total in parallel in this
pond..
Field: Length of Each Tubing Circuit
This numeric field contains length {m} of each hydronic tubing circuit.
An example of the IDF is shown below.
GroundHeatExchanger:Pond,
Pond 1,
!- Name
Condenser Tower 1 Inlet Node, !- Fluid Inlet Node Name
Condenser Tower 1 Outlet Node, !- Fluid Outlet Node Name
2.0,
!- Pond Depth {m}
1000.0,
!- Pond Area {m2}
0.02,
!- Hydronic Tubing Inside Diameter {m}
0.025,
!- Hydronic Tubing Outside Diameter {m}
0.4,
!- Hydronic Tubing Thermal Conductivity {W/m-K}
1.0,
!- Ground Thermal Conductivity {W/m2-K}
10,
!- Number of Tubing Circuits
50.0;
!- Length of Each Tubing Circuit {m}

Pond Heat Exchanger Outputs

HVAC,Average,Pond Heat Exchanger Heat Transfer Rate [W]
HVAC,Sum,Pond Heat Exchanger Heat Transfer Energy [J]
HVAC,Average,Pond Heat Exchanger Mass Flow Rate [kg/s]
HVAC,Average,Pond Heat Exchanger Inlet Temperature [C]
HVAC,Average,Pond Heat Exchanger Outlet Temperature [C]
HVAC,Average,Pond Heat Exchanger Bulk Temperature [C]

Pond Heat Exchanger Heat Transfer Rate [W]

Pond Heat Exchanger Heat Transfer Energy [J]
These outputs are the pond ground heat exchanger heat transfer rate and total energy
exchange for the timestep.
Pond Heat Exchanger Mass Flow Rate [kg/s]
Pond Heat Exchanger Inlet Temperature [C]
Pond Heat Exchanger Outlet Temperature [C]
These outputs are the pond fluid inlet and outlet temperatures and mass flow rate.
Pond Heat Exchanger Bulk Temperature [C]
This output is the pond bulk temperature.

9/29/14

786

Input-Output Reference

Group Condenser Equipment

GroundHeatExchanger:Surface
The surface heat exchanger model is to simulate hydronic surface ground heat exchangers.
This includes pavement surfaces with embedded pipes for snow-melting or heat rejection
from hybrid ground source heat pump systems.
The heat exchanger may be ground coupled or not. In the latter case the bottom surface is
exposed to the wind but not solar gains. This type of heat exchanger is intended to be
connected to the supply side of a condenser loop, and can be used with any type of plant
loop. The surface heat exchanger may be specified as the only heat exchanger on the
condenser loop (as shown in the first figure below) or it may be connected in parallel with
other condenser loop heat exchangers (such as cooling towers, ground surface heat
exchangers) as shown in the second figure below.

Mixer

Pump

Splitter

Surface
Heat
Exchanger

CONDENSER LOOP

Chiller

Mixer

Splitter

Figure 86. Example of Surface Ground Heat Exchanger as only heat exchanger on condenser loop

CONDENSER LOOP

Mixer

Chiller

Splitter

Pump

Splitter

Surface
Heat
Exchanger

Tower

Mixer

Figure 87. Surface Ground Heat Exchanger with other heat exchangers on condenser loop
Field: Name
This alpha field contains the identifying name for the outside panel heat exchanger.
9/29/14

787

Input-Output Reference

Group Condenser Equipment

Field: Construction Name

This alpha field contains the construction name. It must contain a valid Construction name
that is usual for Surfaces. (Ref: Group Surface Construction Elements).
Field: Fluid Inlet Node Name
This alpha field contains the fluid inlet node name.
Field: Fluid Outlet Node Name
This alpha field contains the fluid outlet node name.
Field: Hydronic Tubing Inside Diameter
This numeric field contains the hydronic tubing inside diameter in m.
Field: Number of Tubing Circuits
This numeric field contains the number of hydronic tubing circuits.
Field: Hydronic Tube Spacing
This numeric field contains the hydronic tube spacing in m.
Field: Surface Length
This numeric field contains the surface length in m.
Field: Surface Width
This numeric field contains the surface width in m.
Field: Lower Surface Environment
This alpha field expresses the lower surface exposure: Exposed or Ground.
An example of this statement in an IDF is shown below:
GroundHeatExchanger:Surface,
SURFACE 1,
!- Name
Outside Surface Construction, !- Construction Name
Condenser Tower 1 Inlet Node, !- Fluid Inlet Node Name
Condenser Tower 1 Outlet Node, !- Fluid Outlet Node Name
0.02,
!- Hydronic Tubing Inside Diameter {m}
10.0,
!- Number of Tubing Circuits
0.3,
!- Hydronic Tube Spacing {m}
100.0,
!- Surface Length {m}
100.0,
!- Surface Width {m}
GROUND;
!- Lower Surface Environment

Surface Ground Heat Exchanger Outputs

HVAC,Average,Ground Heat Exchanger Heat Transfer Rate [W]
HVAC,Average,Ground Heat Exchanger Surface Heat Transfer Rate [W]
HVAC,Sum,Ground Heat Exchanger Heat Transfer Energy [J]
HVAC,Average,Ground Heat Exchanger Mass Flow Rate [kg/s]
HVAC,Average,Ground Heat Exchanger Inlet Temperature [C]
HVAC,Average,Ground Heat Exchanger Outlet Temperature [C]
HVAC,Average,Ground Heat Exchanger Top Surface Temperature [C]
HVAC,Average Ground Heat Exchanger Bottom Surface Temperature [C]
HVAC,Average,Ground Heat Exchanger Top Surface Heat Transfer Energy per Area [J/m2]
HVAC,Average,Ground Heat Exchanger Bottom Surface Heat Transfer Energy per Area[J/m2]
HVAC,Sum,Ground Heat Exchanger Surface Heat Transfer Energy [J]
HVAC,Average,Ground Heat Exchanger Source Temperature [C]

9/29/14

788

Input-Output Reference

Group Condenser Equipment

Ground Heat Exchanger Heat Transfer Rate [W]

Ground Heat Exchanger Surface Heat Transfer Rate [W]
Ground Heat Exchanger Heat Transfer Energy [J]
These outputs are the source heat transfer rate, surface heat transfer rate and the total
source energy input for the timestep.
Ground Heat Exchanger Mass Flow Rate [kg/s]
Ground Heat Exchanger Inlet Temperature [C]
Ground Heat Exchanger Outlet Temperature [C]
These outputs are the surface heat exchanger fluid inlet and outlet temperatures and mass
flow rate.
Ground Heat Exchanger Top Surface Temperature [C]
Ground Heat Exchanger Bottom Surface Temperature [C]
These outputs are the surface heat exchanger top and bottom surface temperatures.
Ground Heat Exchanger Top Surface Heat Transfer Energy per Area [J/m2]
Ground Heat Exchanger Bottom Surface Heat Transfer Energy per Area [J/m2]
These outputs are the surface heat exchanger top and bottom surface flux.
Ground Heat Exchanger Surface Heat Transfer Energy [J]
This is the total surface energy exchange for the timestep.
Ground Heat Exchanger Source Temperature [C]
This is the surface heat exchanger source temperature.
GroundHeatExchanger:HorizontalTrench
The horizontal trench ground heat exchanger object provides an alternate interface to the
detailed PipingSystem:Underground:* objects. The same underlying simulation algorithm is
utilized, providing a transient numerical simulation of soil with buried pipes and a detailed
surface heat balance. The input syntax is much smaller and useful for simple applications.
For full flexibility, use the PipingSystem:Underground:* objects to build a detailed simulation
domain and piping circuit. For information regarding the simulation algorithms, see the
engineering reference document section covering the buried piping system objects.
Field: Name
This alpha field is used as an identifying field for the ground heat exchanger.
Field: Inlet Node Name
This alpha field is the name of the inlet node of this component on a plant loop, and must
match other topology definitions such as branch objects.
Field: Outlet Node Name
This alpha field is the name of the outlet node of this component on a plant loop, and must
match other topology definitions such as branch objects.
Field: Design Flow Rate [m3/s]
This numeric field is the designed flow rate for this heat exchanger; the plant loop solver will
attempt to meet this request based on flow and loop conditions.
Field: Trench Length in Pipe Axial Direction [m]

9/29/14

789

Input-Output Reference

Group Condenser Equipment

This numeric field represents the axial length of each pipe trench. Each pipe defined for this
ground heat exchanger will have the same length. If different pipes have different lengths,
they must use separate GroundHeatExchanger:HorizontalTrench objects with different
lengths.
Field: Number of Trenches
This integer field is the number of trenches for this heat exchanger. Since each trench has a
single pipe, this defines the number of pipe segments for this overall heat exchanger. The
total piping length is then calculated as the trench length times the number of trenches.
Field: Horizontal Spacing Between Pipes [m]
This numeric field represents the horizontal spacing (pipe centroid to pipe centroid) between
pipes/trenches.
Field: Pipe Inner Diameter [m]
This numeric field is the inner diameter of the pipe. The same pipe properties are used for all
pipes in this heat exchanger.
Field: Pipe Outer Diameter [m]
This numeric field is the outer diameter of the pipe. The same pipe properties are used for all
pipes in this heat exchanger.
Field: Burial Depth [m]
This numeric field is the burial depth of each pipe, from ground surface to pipe cross section
centroid. The same pipe depth is used for all pipes in this heat exchanger.
Field: Soil Thermal Conductivity [W/mK]
This numeric field is the soil thermal conductivity.
Field: Soil Density [kg/m3]
This numeric field is the soil density.
Field: Soil Specific Heat [J/kgK]
This numeric field is the nominal soil specific heat, but is corrected for moisture content and
in freezing conditions.
Field: Pipe Thermal Conductivity [W/mK]
This numeric field is the pipe thermal conductivity.
Field: Pipe Density [kg/m3]
This numeric field is the pipe density.
Field: Pipe Specific Heat [J/kgK]
This numeric field is the pipe specific heat.
Field: Soil Moisture Content Percent [%]
This numeric field represents the volume fraction, in percent, of water content in the soil.
Field: Soil Moisture Content Percent at Saturation [%]
This numeric field represents the volume fraction, in percent, of water content in the soil
which results in saturation.
Field: Kusuda-Achenbach Average Surface Temperature [C]

9/29/14

790

Input-Output Reference

Group Condenser Equipment

This numeric field is the average annual ground surface temperature, used in the KusudaAchenbach undisturbed ground temperature (far-field boundary) model. This field can be
inferred (left blank) if a Site:GroundTemperatures:Shallow object is provided in the input file.
Field: Kusuda-Achenbach Average Amplitude of Surface Temperature [C]
This numeric field is the average annual amplitude of ground surface temperature, used in
the Kusuda-Achenbach undisturbed ground temperature (far-field boundary) model. This
field can be inferred (left blank) if a Site:GroundTemperatures:Shallow object is provided in
the input file.
Field: Kusuda-Achenbach Phase Shift of Minimum Surface Temperature [days]
This numeric field is the phase shift to minimum ground surface temperature, in days, since
the beginning of the year, used in the Kusuda-Achenbach undisturbed ground temperature
(far-field boundary) model.
This field can be inferred (left blank) if a
Site:GroundTemperatures:Shallow object is provided in the input file.
Field: Evapotranspiration Ground Cover Parameter [-]
This numeric field specifies the ground cover effects used in the evapotranspiration model at
the ground surface heat balance. The values range from 0 (solid, non-permeable ground
surface) to 1.5 (wild growth).
An example of this statement in an IDF is shown below:
GroundHeatExchanger:HorizontalTrench,
My Pipe Circuit, !- Name
Plant Supply Intermediate Node, !- Inlet Node Name
Plant Supply Outlet Node, !- Outlet Node Name
0.004,
!- Design Flow Rate
75,
!- Trench Length in Pipe Axial Direction
2,
!- Number of Trenches
2.0,
!- Horizontal Spacing Between Pipes
0.016,
!- Pipe Inner Diameter
0.02667,
!- Pipe Outer Diameter
1.25,
!- Burial Depth
1.08,
!- Soil Thermal Conductivity
962,
!- Soil Density
2576,
!- Soil Specific Heat
0.3895,
!- Pipe Thermal Conductivity {W/m-K}
641,
!- Pipe Density {kg/m3}
2405,
!- Pipe Specific Heat {J/kg-K}
30,
!- Soil Moisture Content Volume Fraction {percent}
50,
!- Soil Moisture Content Volume Fraction at Saturation {percent}
15.5,
!- Kusuda-Achenbach Average Surface Temperature {C}
12.8,
!- Kusuda-Achenbach Average Amplitude of Surface Temperature {C}
17.3,!- Kusuda-Achenbach Phase Shift of Minimum Surface Temperature {days}
0.408;
!- Evapotranspiration Ground Cover Parameter

Horizontal Trench Ground Heat Exchanger Outputs

HVAC,Average,Ground
HVAC,Average,Ground
HVAC,Average,Ground
HVAC,Average,Ground

Heat
Heat
Heat
Heat

Exchanger
Exchanger
Exchanger
Exchanger

Mass Flow Rate [kg/s]

Inlet Temperature [C]
Outlet Temperature [C]
Fluid Heat Transfer Rate [W]

Ground Heat Exchanger Mass Flow Rate [kg/s]

The output provides the mass flow rate currently being sent through the heat exchanger.
Ground Heat Exchanger Inlet Temperature [C]
Ground Heat Exchanger Outlet Temperature [C]
Temperature of fluid at the inlet and outlet of the heat exchanger.
9/29/14

791

Input-Output Reference

Group Condenser Equipment

Ground Heat Exchanger Fluid Heat Transfer Rate [W]

Heat transfer rate for the heat exchanger, defined as positive for fluid heat loss.
HeatExchanger:FluidToFluid
A fluid-to-fluid heat exchanger designed to couple the supply side of one plant or condenser
loop to the demand side of another plant or condenser loop. This heat exchanger is fairly
general and can be configured for use in any application where any two loops need to be
connected together. The only constraints are that that one side must be connected to the
supply side of one loop and the other side connected to the demand side of a different loop.
Because the heat exchanger is intended to be generic, its two sides are distinguished by the
nature of loop side being connected. One side is called Loop Supply Side to indicate the
heat exchanger is situated on the supply side of a loop. The other side is called Loop
Demand Side to indicate it is on the demand side of a loop. The heat exchanger is intended
to act as a supply component for the loop connected to it as the Loop Supply Side and as a
demand component for the loop connected to it as the Loop Demand Side. From the point
of view of the heat exchanger model itself, the Loop Demand Side fluid serves as the
source/sink to supply heating/cooling to the fluid in the Loop Supply Side. Only hydronic
plant fluids are allowed, no air-side connections are possible with this heat exchanger.

Figure 88. Plant Fluid-to-Fluid Heat Exchanger

Various options are available for the heat exchanger model. The heat transfer between the
two sides can be modeled using one of seven different models for different types of heat
exchangers. Heat transfer is calculated and reported using a sign convention from chilled
water applications where positive heat transfer indicates energy was extracted from the Loop
Supply Side and added to the Loop Demand Side.
9/29/14

792

Input-Output Reference

Group Condenser Equipment

There are eleven options for different ways to control the heat exchanger. One general type
of control is OnOff where the flow through the heat exchanger is either fully on or fully off.
Another type of control is Modulated where the flow through the Loop Demand Side is
controlled to try and meet a target setpoint or load on the Loop Supply Side.
This heat exchanger can be used for a wide variety of applications including chilled water, hot
water, condenser, ground source, primary-secondary systems, etc. As of Version 8.0, this
object replaces three separate objects that were available prior to version 8.0 of EnergyPlus.
The former HeatExchanger:Hydronic object corresponds to a situation where the Loop
Demand Side is the demand side of condenser loop, the Loop Supply Side is a the supply
side
of
a
chilled
water
loop,
the
control
type
is
CoolingSetpointOnOffWithComponentOverride, and the remote override component is a
chiller. The former HeatExchanger:WatersideEconomizer object corresponds to a situation
where the Loop Demand Side is the demand side of condenser loop, the Loop Supply Side is
a the supply side of a chilled water loop, and the control type is CoolingDifferentialOnOff.
The former HeatExchanger:Plate object corresponds to a situation where the Loop Demand
Side is the demand side of a condenser loop, the Loop Supply Side is the supply side of a
second condenser loop, and the control type is UncontrolledOn.
Field: Name
This alpha field provides the unique identifying name for this heat exchanger.
Field: Availability Schedule Name
This field specifies the name of an availability schedule that can be used for supervisory
control of the device. If blank, the default is that heat exchanger is always available. If a
scheduled is named here, then the heat exchanger is available for use whenever the
schedule value is greater than zero. The heat exchanger is not available whenever the
schedule value is zero or less.
Field: Loop Demand Side Inlet Node Name
This field specifies the name of a plant system node that connects an inlet of the heat
exchanger to the demand side of a loop. This node must be on a branch located on the
demand side of a plant or condenser loop.
Field: Loop Demand Side Outlet Node Name
This field specifies the name of a plant system node that connects an outlet of the heat
exchanger to the demand side of a loop. This node must be on a branch located on the
demand side of a plant or condenser loop.
Field: Loop Demand Side Design Flow Rate
This field specifies the design flow rate, in m3/s, of the hydronic fluid passing through the heat
exchanger on the Loop Demand Side. This field is autosizable. When autosized, this design
flow rate is set to equal the design flow rate for the Loop Supply Side.
Field: Loop Supply Side Inlet Node Name
This field specifies the name of a plant system node that connects an inlet of the heat
exchanger to the supply side of a loop. This node must be on a branch located on the supply
side of a plant or condenser loop.
Field: Loop Supply Side Outlet Node Name
This field specifies the name of a plant system node that connects an outlet of the heat
exchanger to the supply side of a loop. This node must be on a branch located on the supply
side of a plant or condenser loop.

9/29/14

793

Input-Output Reference

Group Condenser Equipment

Field: Loop Supply Side Design Flow Rate

This field specifies the design flow rate, in m 3/s, of the fluid passing through the heat
exchanger on the Loop Supply Side. This field is autosizable. When autosized, this design
flow rate is set equal to the overall design flow rate of the loop that is connected. If a sizing
factor is entered in the field below, then it is multiplied to modify the design flow rate.
Field: Heat Exchange Model Type
This alpha field identifies the nature of heat exchanger. Heat exchanger model type is
specified by one of the following four key word choices:
CrossFlowBothUnMixed. Specifies a single-pass, cross-flow heat exchanger. The
effectiveness will be calculated using a cross-flow heat exchanger correlation for both
streams unmixed.
CrossFlowBothMixed. Specifies a single-pass, cross-flow heat exchanger. The
effectiveness will be calculated using a cross-flow heat exchanger correlation for both
streams mixed.
CrossFlowSupplyMixedDemandUnMixed. Specifes a single-pass, cross-flow heat
exchanger. The effectiveness will be calculated using a cross-flow heat exchanger
correlation for flow mixed on the Loop Supply side and flow unmixed on the Loop
Demand Side.
CrossFlowSupplyUnMixedDemandMixed. Specifes a single-pass, cross-flow heat
exchanger. The effectiveness will be calculated using a cross-flow heat exchanger
correlation for flow unmixed on the Loop Supply side and flow mixed on the Loop
Demand Side.
CounterFlow. Specifies a counter-flow shell and tube heat exchanger. The
effectiveness will be calculated using a counter-flow shell and tube heat exchanger
correlation.
ParallelFlow. Specifies a parallel-flow shell and tube heat exchanger.
The
effectiveness will be calculated using a parallel-flow shell and tube heat exchanger
correlation.
Ideal. Specifies an ideal heat exchanger. The effectiveness will be set to '1.0' and
the specified UA will be ignored. The heat transfer rate will be calculated as the
maximum possible heat transfer rate.
Field: Heat Exchanger U-Factor Times Area Value
This numerical field is used to specify the overall U-Factor Times Area (UA) {W/K} for use in
the calculation of the heat exchanger effectiveness using the appropriate -NTU correlation.
If Ideal is specified as the heat exchanger type, the effectiveness will be set to 1.0. When set
to autosize Heat Exchanger U-Factor Times Area Value is calculated based on an
effectiveness of 1.0 where capacity is such that the temperatures in the Sizing:Plant objects
for the two loops can be maintained.
Field: Control Type
This field is used to specify how the heat exchanger is to be controlled during operation.
Different applications for connecting two loops will require different control behavior and
different control options are needed depending on the desired behavior. There are the
following eleven key choice options to choose from:
UncontrolledOn. This control mode is applicable to situations where the heat
exchanger is passively running all the time and always transfers as much heat as
possible between the fluid streams. However there is one aspect of control in that it
will only request flow on the Loop Demand Side when there is non-zero flow into the
heat exchanger on the Loop Supply Side. This control mode corresponds to that
available in the HeatExchanger:Plate object prior to version 8.0.

9/29/14

794

Input-Output Reference

Group Condenser Equipment

OperationSchemeModulated. This control mode is applicable to situations where

the heat exchanger is controlled by an operation scheme (see objects called
PlantEquipmentOperationScheme or CondenserEquipmentOperationSchemes).
When using this control mode the heat exchanger must be listed in
PlantEquipmentList or a CondenserEquipmentList and it serves as a supply
component. The operation scheme will dispatch a load request to the heat
exchanger which it will try meet by conditioning the fluid stream connected as the
Loop Supply Side. If the heat exchanger could exceed the load request, then the
flow through the fluid stream connected as the Loop Demand Side will be modulated
to just meet the load request.
OperationSchemeOnOff. This control mode is applicable to situations where the
heat exchanger is controlled by an operation scheme (see objects called
PlantEquipmentOperationScheme or CondenserEquipmentOperationSchemes).
When using this control mode the heat exchanger must be listed in
PlantEquipmentList or a CondenserEquipmentList and it serves as a supply
component. The operation scheme will dispatch a load request to the heat
exchanger which it will use as an on/off signal to decide if the heat exchange should
run or not. If it runs, it will run at full capacity and may exceed the load request.
HeatingSetpointModulated. This control mode is applicable to situations where the
Loop Demand Side can provide useful heating to the Loop Supply Side. A heating
setpoint is obtained from a node named in the following field. If the setpoint and inlet
temperatures are such that heat exchanger could transfer heat from the Loop
Demand Side to the Loop Supply Side to meet the heating setpoint, then the heat
exchanger will run. The inlet temperatures must differ by more than the value set in
the field called Minimum Temperature Difference to Activate Heat Exchanger for the
heat exchanger to operate. If the heat exchanger could overshoot the setpoint, then
the flow through the fluid stream connected as the Loop Demand Side will be
modulated to just meet the setpoint.
HeatingSetpointOnOff. This control mode is applicable to situations where the Loop
Demand Side can provide useful heating to the Loop Supply Side. A heating setpoint
is obtained from a node named in the following field. If the setpoints and inlet
temperatures are such that heat exchanger could transfer heat from the Loop
Demand Side to the Loop Supply Side to meet the heating setpoint, then the heat
exchanger will run. The inlet temperatures must differ by more than the value set in
the field called Minimum Temperature Difference to Activate Heat Exchanger for the
heat exchanger to operate. If it runs, it will run at full capacity and may overshoot the
setpoint.
CoolingSetpointModulated. This control mode is applicable to situations where the
Loop Demand Side can provide useful cooling to the Loop Supply Side. A cooling
setpoint is obtained from a node named in the following field. If the setpoints and
inlet temperatures are such that heat exchanger could transfer heat from the Loop
Supply Side to the Loop Demand Side to meet the cooling setpoint, then the heat
exchanger will run. The inlet temperatures must differ by more than the value set in
the field called Minimum Temperature Difference to Activate Heat Exchanger for the
heat exchanger to operate. If the heat exchanger could undershoot the setpoint, then
the flow through the fluid stream connected as the Loop Demand Side will be
modulated to just meet the setpoint.
CoolingSetpointOnOff. This control mode is applicable to situations where the Loop
Demand Side can provide useful cooling to the Loop Supply Side. A cooling setpoint
is obtained from a node named in the following field. If the setpoints and inlet
temperatures are such that heat exchanger could transfer heat from the Loop Supply
Side to the Loop Demand Side to meet the cooling setpoint, then the heat exchanger
will run. The inlet temperatures must differ by more than the value set in the field
called Minimum Temperature Difference to Activate Heat Exchanger for the heat
exchanger to operate. If it runs, it will run at full capacity and may undershoot the
9/29/14

795

Input-Output Reference

Group Condenser Equipment

setpoint.
This control mode corresponds to that available in the
HeatExchanger:WatersideEconomizer object prior to version 8.0.
DualDeadbandSetpointModulated. This control mode is applicable to situations
where the Loop Demand Side can provide either useful cooling or heating to the
Loop Supply Side. A dual deadband setpoint is obtained from a node named in the
following field. If the setpoints and inlet temperatures are such that heat exchanger
could transfer heat from the Loop Demand Side to the Loop Supply Side to meet the
lower setpoint, then the heat exchanger will run. If the setpoints and inlet
temperatures are such that heat exchanger could transfer heat from the Loop Supply
Side to the Loop Demand Side to meet the high setpoint, then the heat exchanger
will run. The inlet temperatures must differ by more than the value set in the field
called Minimum Temperature Difference to Activate Heat Exchanger for the heat
exchanger to operate. If the heat exchanger could overshoot the lower setpoint, or
undershoot the higher setpoint, then the flow through the fluid stream connected as
the Loop Demand Side will be modulated to just meet the deadband setpoint.
DualDeadbandSetpointOnOff. This control mode is applicable to situations where
the Loop Demand Side can provide either useful cooling or heating to the Loop
Supply Side. A dual deadband setpoint is obtained from a node named in the
following field. If the setpoints and inlet temperatures are such that heat exchanger
could transfer heat from the Loop Demand Side to the Loop Supply Side to meet the
lower setpoint, then the heat exchanger will run. If the setpoints and inlet
temperatures are such that heat exchanger could transfer heat from the Loop Supply
Side to the Loop Demand Side to meet the high setpoint, then the heat exchanger
will run. The inlet temperatures must differ by more than the value set in the field
called Minimum Temperature Difference to Activate Heat Exchanger for the heat
exchanger to operate. If the heat exchanger runs, it will run at full capacity and may
overshoot the lower setpoint or undershoot the higher setpoint.
CoolingDifferentialOnOff. This control mode is applicable to situations where the
Loop Demand Side can provide useful cooling to the Loop Supply Side. This mode
is similar to CoolingSetpointOnOff except that it ignores any cooling setpoint and its
control is based only on the temperature difference between Loop Demand Side and
the Loop Supply Side. The inlet temperatures must differ by more than the value set
in the field called Minimum Temperature Difference to Activate Heat Exchanger for
the heat exchanger to operate. This control mode corresponds to that available in
the HeatExchanger:WatersideEconomizer object prior to version 8.0.
CoolingSetpointOnOffWithComponentOverride. This control mode is applicable
to situations where the heat exchanger operation is integrated with the operation of a
specific chiller. When conditions are favorable for the heat exchanger to provide
cooling to the Loop Supply Side, the heat exchanger is run and the integrated chiller
is turned off. A cooling setpoint is obtained from a node named in the following field.
If it runs it will run at full capacity and may undershoot the setpoint. The chiller that is
integrated with the heat exchanger is identified by entering the names of the chillers
inlet nodes in the input fields below. The control decision can be based on one of
three different temperature signals selected in the field below called Component
Override Cooling Control Temperature Mode. The setpoint and control signal
temperatures must differ by more than the value set in the field called Minimum
Temperature Difference to Activate Heat Exchanger for the heat exchanger to
operate. This control mode corresponds to that available in the
HeatExchanger:Hydronic object prior to version 8.0.
Field: Heat Exchanger Setpoint Node Name
This field specifies the name of a plant system node located on loop attached to the Loop
Supply Side. This field is used and required when the previous field is set to one of the
Setpoint control types. The node must have a temperature setpoint placed on it by a
setpoint manager (or EMS actuator).
9/29/14

796

Input-Output Reference

Group Condenser Equipment

If the previous field is set to DualDeadbandSetpointModulated or DeadbandSetpointOnOff

then there must be a setpoint manager that places both a high and low setpoint on the node
named in this field. (see SetpointManager:Scheduled:DualSetpoint).
Field: Minimum Temperature Difference to Activate Heat Exchanger
This field specifies the value of a temperature tolerance used in control decisions, in deg.
Celsius. Whenever the control logic needs to compare two temperatures, the value entered
in this field is used as a threshold for comparisons.
Field: Heat Transfer Metering End Use Type
This field specifies how the metering for heat transfer will be accounted with respect to end
uses. Although the heat exchanger consumes no energy that needs to be metered, there are
also meters for heat transfers that apply to the model. The nature of the end use may vary
depending on the application that the heat exchanger is being used for. The available
choices are FreeCooling, HeatRecovery, HeatRejection, HeatRecoveryForCooling,
HeatRecoveryForHeating, and LoopToLoop.
Field: Component Override Loop Supply Side Inlet Node Name
This field specifies the name of an inlet node for the remote component that will be integrated
with this heat exchanger. This inlet should be on the supply side of a loop -- typically chilled
water inlet or return for a chiller. This field and the next two are only used for the control type
called CoolingSetpointOnOffWithComponentOverride.
Field: Component Override Loop Demand Side Inlet Node Name
This field specifies the name of an inlet node for the remote component that will be integrated
with this heat exchanger. This inlet should be on the demand side of a loop -- typically
condenser water inlet or return for a water-cooled chiller. This field is only used for the
control type called CoolingSetpointOnOffWithComponentOverride.
Field: Component Override Cooling Control Temperature Mode
This field specifies which type of temperature is used to control a heat exchanger that uses
the control type called CoolingSetpointOnOffWithComponentOverride. There are three
options: Loop, WetBulbTemperature, and DryBulbTemperature. The option called Loop
directs the program to use the inlet fluid temperature at the Loop Demand Side connection of
heat exchanger for the temperature used as a signal to be compared with the setpoint. The
option call WetBulbTemperature uses the outdoor air wetbulb temperature as the signal.
The option called DryBulbTemperature uses the outdoor air drybulb temperature as the
signal.
Field: Sizing Factor
This optional field can be used to modify the results of autosize calculations. This sizing
factor is used for this heat exchanger and modifies sizing results by multiplying them by the
factor entered here. This factor is applied to the Loop Supply Side Design Flow rate and in
turn affects the heat exchanger UA and the loop demand side flow rate which are derived
from that flow rate. This allows fine control over the size of the heat exchanger when using
autosize in those fields.
Field: Operation Minimum Temperature Limit
This optional field can be used to provide supervisory control of the heat exchanger. If either
of the inlet temperatures are below this limit (C), the heat exchanger will not operate.
Field: Operation Maximum Temperature Limit
This optional field can be used to provide supervisory control of the heat exchanger. If either
of the inlet temperatures are above this limit (C), the heat exchanger will not operate.

9/29/14

797

Input-Output Reference

Group Condenser Equipment

Some example IDF input objects follow.

HeatExchanger:FluidToFluid,
CondenserLoop HX,!- Name
ALWAYS_ON,
!- Availability Schedule Name
CondenserLoop HX HX Inlet Node, !- Loop Demand Side Inlet Node Name
CondenserLoop HX HX Outlet Node, !- Loop Demand Side Outlet Node Name
autosize,
!- Loop Demand Side Design Flow Rate
CondenserLoop Pump- HXNode,
!- Loop Supply Side Inlet Node Name
CondenserLoop HX- ChillerNode,!- Loop Supply Side Outlet Node Name
autosize,
!- Loop Supply Side Design Flow Rate
CounterFlow,
!- Heat Exchange Model Type
autosize,
!- Heat Exchanger U-Factor Times Area Value
CoolingDifferentialOnOff,
!- Control Type
,
!- Heat Exchanger Setpoint Node Name
2.0,
!- Minimum Temperature Difference to Activate Heat Exchanger
FreeCooling;
!- Heat Transfer Metering End Use Type
HeatExchanger:FluidToFluid,
SOURCE to TRANSFER HX , !- Name
AlwaysOnSchedule, !- Availability Schedule Name
SOURCE Demand HX Inlet Node , !- Loop Demand Side Inlet Node Name
SOURCE Demand HX Outlet Node , !- Loop Demand Side Outlet Node Name
0.003 , !- Loop Demand Side Design Flow Rate
TRANSFER HX Supply Inlet Node, !- Loop Supply Side Inlet Node Name
TRANSFER HX Supply Outlet Node, !- Loop Supply Side Outlet Node Name
0.003 , !- Loop Supply Side Design Flow Rate
CrossFlow, !- Heat Exchange Model Type
15000 , !- Heat Exchanger U-Factor Times Area Value
DualDeadbandSetpointModulated , !- Control Type
TRANSFER Supply Outlet Node, !- Heat Exchanger Setpoint Node Name
0.2 , !- Minimum Temperature Difference to Activate Heat Exchanger
LoopToLoop; !- Heat Transfer Metering End Use Type

Fluid to Fluid Heat Exchanger Outputs

Fluid Heat Exchanger Heat Transfer Rate [W]
Fluid Heat Exchanger Heat Transfer Energy [J]
These outputs are the rate and energy transferred from the Loop Supply Side to the Loop
Demand Side. The sign convention is taken from cooling or heat rejection applications such
that positive values indicate cooling of the Loop Supply Side.
Fluid Heat Exchanger Loop Supply Side Mass Flow Rate [kg/s]
This is the system mass flow of fluid through the heat exchanger side connected as the Loop
Supply Side, in kg/s.
Fluid Heat Exchanger Loop Supply Side Inlet Temperature [C]
This is the temperature, in degrees Celsius, of the fluid entering the heat exchanger on the
side connected as the Loop Supply Side.
Fluid Heat Exchanger Loop Supply Side Outlet Temperature [C]
This is the temperature, in degrees Celsius, of the fluid leaving the heat exchanger on the
side connected as the Loop Supply Side.
Fluid Heat Exchanger Loop Demand Side Mass Flow Rate [kg/s]
This is the system mass flow of fluid through the heat exchanger side connected as the Loop
Demand Side, in kg/s.
9/29/14

798

Input-Output Reference

Group Plant-Condenser Flow Control

Fluid Heat Exchanger Loop Demand Side Inlet Temperature [C]

This is the temperature, in degrees Celsius, of the fluid entering the heat exchanger on the
side connected as the Loop Demand Side.
Fluid Heat Exchanger Loop Demand Side Outlet Temperature [C]
This is the temperature, in degrees Celsius, of the fluid leaving the heat exchanger on the
side connected as the Loop Demand Side.
Fluid Heat Exchanger Operation Status [0=off, 1= on]
This output is a numeric flag that indicates whether or not the heat exchanger was operating
or not. If the value is 0, then the heat exchanger was not operating. If the value is 1, then the
heat was operating.
Fluid Heat Exchanger Effectiveness [ ]
This output is the calculated heat exchanger effectiveness (non-dimensional). It is an
intermediate value in the NTU model calculations for heat flow rate. Values range between 0
and 1.0. A value of 1.0 indicates ideal heat transfer.

Group Plant-Condenser Flow Control

The connector list described earlier determines how the branches of a particular loop will be
hooked together. These connections can be classified either as a separation of a single
stream into several outlet streams (splitter) or the merging of several streams into a single
outlet stream (mixer). Due to the limitation per branch of a single splitter and a single mixer,
the connector list can only have two pieces of equipment as a maximum. The names defined
for either/both the splitter or/and the mixer refer then to component definitions as described
below.
Connector:Splitter, Connector:Mixer
The format of both the Connector:Splitter and Connector:Mixer statements is similar. Both
begin with an identifying name followed by the branch name of the single side of the
component. In the case of the splitter, this is the inlet since the inlet stream is broken into
several outlet streams. In the case of the mixer, this is the outlet since several streams are
mixed together to form a single outlet. The remaining list of up to 50 names is simply the
branch names of the outlet legs in the case of the splitter and inlet legs in the case of the
mixer. No control logic is assume in these componentsa determination of how much air to
split in which direction using the splitter must be defined by other components.
Connector:Splitter
Field: Name
This alpha field contains the identifying name for the Splitter.
Field: Inlet Branch Name
This alpha field contains the identifying name for the Splitter Inlet Branch.
Field: Outlet Branch <x> Name
This alpha field contains the identifying names for the Splitter Outlet Branches and you enter
as many outlet branches as needed.
Connector:Mixer
Field: Name
This alpha field contains the identifying name for the Mixer.

9/29/14

799

Input-Output Reference

Group Plant-Condenser Flow Control

Field: Outlet Branch Name

This alpha field contains the identifying name for the Mixer Outlet Branch.
Field: Inlet Branch <x> Name
This alpha field contains the identifying names for the Mixer Inlet Branches and you enter as
many inlet branch names as needed..
An example of these statements in an IDF is:
Connector:Splitter,
CW Loop Splitter,
CW Pump Branch,
Little Chiller Branch,
Big Chiller Branch,
Purchased Cooling Branch,
Supply Bypass Branch;
Connector:Mixer,
CW Loop Mixer,
Cooling Supply Outlet,
Little Chiller Branch,
Big Chiller Branch,
Purchased Cooling Branch,
Supply Bypass Branch;

TemperingValve
This object is used for special cases where plant flow control is needed to make efficient use
of thermal storage. In certain solar hot water and heat recovery situations, a thermal storage
tank may become warmer than is necessary or allowable for safe use of the hot water.
Although real installations of a tempering, or anti-scald valve, would more commonly mix a
new stream of mains water with the hot water to achieve a desired outlet temperature, this is
difficult to model directly within EnergyPlus because plant loops need to be closed circuits.
For many installations where the water entering the splitter is directly from the mains, such as
make up water entering a water heater tank, the modeling provided with this object should be
thermodynamically equivalent.
The TemperingValve object models a temperature-controlled diversion valve. It models a
valve on a bypass pipe that can open to divert flow around one or more plant components. It
can only be used on one of two branches between a Splitter and a Mixer. The figure below
shows the use of the tempering valve with a Water Heater:Mixed component on Stream 2.
The tempering valve acts to divert flow through the branch it is on in order to adjust the
temperature at the outlet of the mixer. If the temperature at Stream 2 Source Node is warmer
than the setpoint and the inlet flow is cooler than the setpoint, then a controller determines
how much flow should bypass the storagew tank to achieve the desired setpoint.

9/29/14

800

Input-Output Reference

Group Plant-Condenser Flow Control

Figure 89. Tempering Valve Schematic

The TemperingValve is an Active component and the other path should have only Passive
components. Only two paths in the splitter/mixer can be used; bypasses are not allowed. No
other Connector:Splitter and Connector:Mixer pair can be used on the supply side of the plant
loop.
Field: Name
This field should contain an unique name for each TemperingValve object
Field: Inlet Node Name
This field should contain the name of node which is the inlet for the valve.
Field: Outlet Node Name
This field should contain the name of node which is the outlet for the valve
Field: Stream 2 Source Node Name
This field should contain the name of node that is the inlet to the Mixer object for the second
stream containing the component whose flow is being diverted.
Field: Temperature Setpoint Node Name
This field should contain the name of a node that has a temperature setpoint assigned to it. A
separate set point manager object is needed to provide a set point on the node listed here.
Field: Pump Outlet Node Name
This field should contain the name of the node that is the outlet for the pump that is one the
same plant loop. This is node is used to sense the total flow rate.
This object is demonstrated in the example file called SolarCollectorFlatPlateWater.idf. An
example of this object is:
TemperingValve,
DHW Anti-Scald Diverter,
DHW Anti-Scald Inlet Node, ! Inlet Node Name
9/29/14

801

Input-Output Reference
DHW
SHW
DHW
DHW

Group Air Distribution

Anti-Scald Outlet Node, ! Outlet Node Name
Storage Tank Use Outlet Node, ! Stream 2 Source Node Name
Instantaneous Boost Outlet Node, ! Temperature Setpoint Node Name
Use Side Pump Outlet; ! pump outlet node

Tempering Valve Outputs

Use output variables for System Nodes for flow and temperature results.

Group Air Distribution

AirLoopHVAC
Air loops along with zone equipment form the entire forced air heating and cooling system (air
side). The main statement for defining an air loop is the AirLoopHVAC object described here.
As with the main plant and condenser statements, several of the items in the AirLoopHVAC
object definition are actually names that refer to other objects in the input file. After the
AirLoopHVAC object name, four such list pointers are encountered: for controllers, system
availability, branches, and connectors. The Controller List defines how the air loop will
respond due to various inputs (control signals). The Availability Manager List refers to
methods for controlling when a system is operational. This may be as simple as a schedule to
define when the system is shutdown. The Branch List lists the branches that comprise the
primary air system. Finally, the Connector List lists the connections between the branches.
The branches and connections together define the primary air system topology.
The only numeric input is the design primary air flow rate. This item is input just before the
BranchList name.
The next series of names refer to nodes for the various inlet and outlet points of the air loop.
The air loop starts where the zone equipment ends. This is a single point consisting of the
return air duct once all of the zone return air streams have been collected. While in reality,
there is really only one point, for clarity within the simulation components and consistency
with the other HVAC loop sections, this point in the systems is defined as two points: one that
resides with the zone equipment simulation and one that is acted upon by the air loop
simulation. Both node names must be entered into the input file, and both nodes must have
unique names. Similarly, the end points of the air loop that also correspond to the beginning
points of the zone equipment loop must also be defined. These consist of names referencing
lists of up to three pairs of node names as shown below. Up to three air loop outlets are
allowed to accommodate the simulation of three deck systems.
Field: Name
This field is a unique, user assigned name for a single instance of an AirLoopHVAC object.
Any other object referencing this AirLoopHVAC will use this name.
Field: Controller List Name
This field is the name of a ControllerList object. A Controller List is simply a list of controllers
giving both controller name and type. This Controller List specifies all the controllers that will
act on this primary air loop. The order of the controllers in the list is significant: controllers are
simulated sequentially in the order given in the Controller List.
Field: Availability Manager List Name
This field is the name of a AvailabilityManagerList object. A Availability Manager List is a list
of Availability Managers giving both Availability Manager type and name. The availability
managers in the list apply to this primary air loop. That is, they determine when and if this air
loop is on or off, overriding the control provided by the central fan on/off schedule.
Field: Design Supply Air Flow Rate
This is the system primary air design volumetric flow rate in cubic meters per second.
9/29/14

802

Input-Output Reference

Group Air Distribution

Field: Branch List Name

This field is the object name of a BranchList object (see BranchList and Branch). The
BranchList named here specifies all the branches composing the primary air system. These
branches, together with the Connectors listed in the ConnectorList, define the primary air
system topology.
Field: Connector List Name
This field is the name of ConnectorList object. This ConnectorList object lists all the
Connectors (by type and name) that are included in this primary air system. These
Connectors, together with the Branches in the BranchList, define the topology of the primary
air system.
Field: Supply Side Inlet Node Name
The name of the air entrance node of this primary air system. This is the inlet node for return
air for this air system.
Field: Demand Side Outlet Node Name
The name of the air outlet node for the zone equipment group
(ZoneHVAC:EquipmentConnections objects) attached to the primary air system. This should
be the outlet node of a AirLoopHVAC:ZoneMixer in the AirLoopHVAC:ReturnPath for the
zone equipment group attached to this primary air system.
Field: Demand Side Inlet Node Names
This field can be the name of a node which is the air inlet node for the zone equipment group
(see ZoneHVAC:EquipmentConnections objects) attached to this primary air system. Or, this
field can be the name of a node list containing one or more nodes (up to 3). These nodes
should be the inlet nodes to the AirLoopHVAC:ZoneSplitter or AirLoopHVAC:SupplyPlenum
in each of the AirLoopHVAC:SupplyPaths for the zone equipment groups attached to this
primary air system. For single duct systems, there is only one node name in this list. For two
and three duct systems, the order of the nodes in this list must correspond with the order of
the nodes in the Supply Side Outlet Node Names list.
Field: Supply Side Outlet Node Names
This field can be the name of a node which is the air outlet node for each supply duct of this
primary air system. Or, this field can be the name of a node list containing one or more nodes
(up to 3). The list can contain the names of up to three nodes. For single duct systems, there
is only one node name in this list. For two and three duct systems, the order of the nodes in
this list must correspond with the order of the nodes in the Demand Side Inlet Node Names
list.
An example of this statement in an IDF is:
AirLoopHVAC,
Main Dual Duct Air Loop,
! Primary Air Loop Name
Dual Duct System 1 Controllers,
! Controller List
Dual Duct System 1 Schedule List , ! System Availability Manager List
1.3 ,
! Primary air design volumetric flow rate
Dual Duct Air Loop Branches ,
! Air Loop Branch List Name
Dual Duct Connectors ,
! Air Loop Connector List Name
Supply Fan Inlet Node ,
! ReturnAir AirLoop Inlet Node
Return Air Mixer Outlet ,
! ZoneEquipGroup Outlet Node
Zone Equipment Inlet Node List ,
! SupplyAirPath ZoneEquipGroup Inlet Nodes
Air Loop Outlet Node List ;
! AirLoop Outlet Nodes

AirLoopHVAC Outputs
HVAC,Average,Air System Simulation Cycle On Off Status
9/29/14

803

Input-Output Reference

Group Air Distribution

HVAC,Sum,HVAC System Solver Iteration Count []

HVAC,Sum,Air System Solver Iteration Count []
HVAC,Sum,Air System Simulation Maximum Iteration Count []
HVAC,Sum,Air System Simulation Iteration Count []
HVAC,Sum,Air System Component Model Simulation Calls []

Air System Simulation Cycle On Off Status

This field is the availability status of an AirLoopHVAC. This status flag is a result of the
calculations made by the System Availability Manager(s) listed in a System Availability
Manager List. When a single availability manager is used in a System Availability Manager
List, this is also the availability status reported by the specific availability manager (Ref.
System Availability Manager Outputs). When multiple availability managers are used in a
System Availability Manager List, the loop availability status is determine by the rules
associated with AirLoopHVACs (see rules described for Group System Availability
Managers). The control status outputs are represented using integers 0 through 3.. These
integers represent NoAction (0), ForceOff (1), CycleOn (2), and CycleOnZoneFansOnly (3).
Since the status output is averaged, the output result may not correspond to the values
described here when output variable frequencies other than detailed are used. Use the
detailed reporting frequency (Ref. Output:Variable object) to view the availability status at
each simulation timestep.
HVAC System Solver Iteration Count []
Air System Solver Iteration Count []
Air System Simulation Maximum Iteration Count []
Air System Simulation Iteration Count []
Air System Component Model Simulation Calls []
These variables are simply counters of how many iterations were executed. The count for
any given HVAC time step will be the iterations executed before convergence was achieved,
or the max allowed in which case the simulation throws a warning and proceeds to the next
time step.
Outdoor Air Ventilation Outputs
This section provides more detailed information on the reporting available for outdoor air
ventilation. Sixteen cooling and heating load variables and eight energy summary variables
are available that report the impact of system outdoor air on zone loads, system demand and
total energy use. The representative air system shown in the diagram below shows outdoor
air (OA), return air (RA), supply air (SA) and mixed air (MA).

9/29/14

804

Input-Output Reference

Group Air Distribution

Figure 90. Example System for Ventilation Loads Report

The overall effect of outdoor air on the system shown above can be summarized by
considering the mixing box. In this system, part or all of the return air is replaced by outdoor
air. The presence of any heat recovery will already be taken into account and thus will
automatically be accounted for by using the outdoor air inlet conditions to the mixing box
(point OA in the diagram) rather than actual outdoor air conditions. Thus, the overall energy
impact of outdoor air (ventilation) on a particular system can be evaluated by multiplying the
outdoor air mass flow rate by the enthalpy difference between the outdoor air entering the
mixing box (OA) and the return air entering the mixing box (RA) as shown in the following
equation.

qOA

mOA hOA hRA

msys hMA hRA

Ventilation Flow Outputs

The fresh air flow into each zones are reported using the ventilation flow output variables.
The total outdoor air flow in a primary air system is divided to each zone based on the
fraction of flow each zone is supplied. There are six variables which deals with the
mechanical ventilation flow reporting. Those six variables are:
Zone Mechanical Ventilation Mass Flow Rate [kg/s]
Reports the average outdoor air mass flow rate to any zone over the reporting interval.
Zone Mechanical Ventilation Mass [kg]
Reports the total outdoor air mass that has been supplied to any zone over the reporting
interval.

9/29/14

805

Input-Output Reference

Group Air Distribution

Zone Mechanical Ventilation Standard Density Volume Flow Rate [m3/s]

Reports the average outdoor air volume flow rate to any zone over the reporting interval,
calculated using a standard density for air. Standard density in EnergyPlus corresponds to
20C drybulb, dry air, and nominally adjusted for elevation.
Zone Mechanical Ventilation Standard Density Volume [m3]
Reports the total outdoor air volume that has been supplied to a zone over the reporting
interval, calculated using a standard density for air. Standard density in EnergyPlus
corresponds to 20C drybulb, dry air, and nominally adjusted for elevation.
Zone Mechanical Ventilation Current Density Volume Flow Rate [m3/s]
Reports the average outdoor air volume flow rate to any zone over the reporting interval,
calculated using the current density for zone air.
Zone Mechanical Ventilation Current Density Volume [m3]
Reports the total outdoor air volume that has been supplied to a zone over the reporting
interval, calculated using the current density for zone air.
Zone Mechanical Ventilation Air Changes per Hour [ach]
Reports the air changes per hour in the zone due to the outside fresh air supplied by
mechanical ventilation system.
The example syntax below shows the basic ventilation flow variables reported on an hourly
basis.
Output:Variable,*,Zone Mechanical Ventilation Mass Flow Rate,Hourly;
Output:Variable,*,Zone Mechanical Ventilation Mass,Hourly;
Output:Variable,*,Zone Mechanical Ventilation Standard Density Volume Flow Rate,Hourly;
Output:Variable,*,Zone Mechanical Ventilation Standard Density Volume,Hourly;
Output:Variable,*,Zone Mechanical Ventilation Current Density Volume Flow Rate,Hourly;
Output:Variable,*,Zone Mechanical Ventilation Current Density Volume,Hourly;
Output:Variable,*, Zone Mechanical Ventilation Air Changes per Hour,Hourly;

Ventilation Load Reports

The impact of system outdoor air on a particular zone may be calculated by summing the
mass flow weighted qOA over the supply air paths (both cooling and heating) serving the
zone as follows:
AirPathNum

qOA, Zone 1

qOA
n 1

mn
msys

Four output variables each for cooling and heating report the impact of the ventilation air on
the zone load in the absence of ventilation air system interactions. The ventilation load output
variables are:
Zone Mechanical Ventilation Cooling Load Increase Due to Overheating Energy [J]
Zone Mechanical Ventilation Heating Load Increase Due to Overcooling Energy [J]
The cooling/heating load that would occur once ventilation air met the zone cooling/heating
load and continued to overcool/overheat the zone. No system effects are accounted for.
Zone Mechanical Ventilation Cooling Load Decrease Energy [J]
Zone Mechanical Ventilation Heating Load Decrease[J]
The decrease in zone cooling/heating load that would occur as a result of ventilation air
introduced directly into the zone. No system effects are accounted for.
9/29/14

806

Input-Output Reference

Group Air Distribution

Zone Mechanical Ventilation No Load Heat Removal Energy [J]

Zone Mechanical Ventilation No Load Heat Addition Energy [J]
The addition or removal of heat to a zone with no load. The heat addition or removal is due to
mechanical ventilation while the zone thermostat is in the deadband.
To summarize:
Cooling:
1. Zone Mechanical Ventilation No Load Heat Removal Energy [J]
Cooling that would be provided directly to zone by ventilation air. Ventilation occurred
with no zone load.
2. Zone Mechanical Ventilation Cooling Load Increase Energy [J]
The increase in zone cooling load that would occur as a result of ventilation air
introduced directly into the zone. No system effects are accounted for.
3. Zone Mechanical Ventilation Cooling Load Increase Due to Overheating Energy
[J]
The cooling load that would occur once ventilation air met the zone heating load and
continued to overheat the zone. No system effects are accounted for.
4. Zone Mechanical Ventilation Cooling Load Decrease Energy [J]
The decrease in zone cooling load that would occur as a result of ventilation air
introduced directly into the zone. No system effects are accounted for.
Heating:
1. Zone Mechanical Ventilation No Load Heat Addition Energy [J]
Heating that would be provided directly to zone by ventilation air. Ventilation occurred
with no zone load.
2. Zone Mechanical Ventilation Heating Load Increase Energy [J]
The increase in zone heating load that would occur as a result of ventilation air
introduced directly into the zone. No system effects are accounted for.
3. Zone Mechanical Ventilation Heating Load Increase Due to Overcooling Energy
[J]
The heating load that would occur once ventilation air met the zone cooling load and
continued to overcool the zone. No system effects are accounted for.
4. Zone Mechanical Ventilation Heating Load Decrease Energy [J]
The decrease in zone heating load that would occur as a result of ventilation air
introduced directly into the zone. No system effects are accounted for.
The output variables are calculated by comparing the zone ventilation load with the zone
cooling or heating load. Ventilation cooling decreases the zone cooling load until the cooling
load has been eliminated. The remaining ventilation cooling is reported as overcooling.
Overheating is calculated in the same manner. The actual system operation, which
determines whether or not an overcooling or overheating load actually results in increased
energy consumption, is not considered in the calculation of these output variables.
The ventilation zone load output variables are shown in Table 24. The variables report the
maximum potential cost or benefit of ventilation air introduced directly into the zone.

9/29/14

807

Input-Output Reference

Group Air Distribution

Table 24. Ventilation Load Output Variables

No Zone Load

Zone Cooling Load

Ventilation
Cooling

Zone Mechanical
Ventilation No Load
Heat Removal
Energy

Ventilation
Heating

Zone Mechanical
Ventilation No Load
Heat Addition Energy

Zone Mechanical
Ventilation Cooling
Load Decrease
Energy
Zone Mechanical
Ventilation Heating
Load Increase Due
to Overcooling
Energy
Zone Mechanical
Ventilation Cooling
Load Increase
Energy

Zone Heating
Load

Zone Mechanical
Ventilation Heating
Load Increase
Energy

Zone Mechanical
Ventilation Heating
Load Decrease
Energy
Zone Mechanical
Ventilation Cooling
Load Increase Due
to Overheating
Energy

The example syntax below shows the basic ventilation load variables reported on a monthly
basis.
Output:Variable,*,Zone
Output:Variable,*,Zone
Output:Variable,*,Zone
Output:Variable,*,Zone
Output:Variable,*,Zone
Output:Variable,*,Zone

Mechanical
Mechanical
Mechanical
Mechanical
Mechanical
Mechanical

Ventilation
Ventilation
Ventilation
Ventilation
Ventilation
Ventilation

Heating
Heating
No Load
Cooling
Cooling
No Load

Load
Load
Heat
Load
Load
Heat

Increase Energy,monthly;
Decrease Energy,monthly;
Addition Energy,monthly;
Increase Energy,monthly;
Decrease Energy,monthly;
Removal Energy,monthly;

Reporting on a timestep or hourly level would produce a detailed report with variables
intermingled with the other output variables that might be requested in the input file.
Another method will more easily encapsulate the report:
OutputControl:Table:Style, HTML;

!- ColumnSeparator

Output:Table:Monthly,
Ventilation Loads,
!- Name
,
!- DigitsAfterDecimal
Zone Mechanical Ventilation No Load Heat Removal Energy,
SumOrAverage,
Zone Mechanical Ventilation Cooling Load Increase Due to Overheating Energy,
SumOrAverage,
Zone Mechanical Ventilation Cooling Load Decrease Energy,
SumOrAverage,
Zone Mechanical Ventilation Cooling Load Increase Energy,
SumOrAverage,
Zone Mechanical Ventilation No Load Heat Addition Energy,
SumOrAverage,
Zone Mechanical Ventilation Heating Load Increase Due to Overcooling Energy,
SumOrAverage,
Zone Mechanical Ventilation Heating Load Decrease Energy,
SumOrAverage,
Zone Mechanical Ventilation Heating Load Increase Energy,
SumOrAverage;
9/29/14

808

Input-Output Reference

Group Air Distribution

This combination will report the ventilation loads on a monthly basis in a HTML style report
that can be easily read in a web browser. Review the Output:Table:Monthly object for other
methods of display or further options on this report item.
Systems Level Reporting
Most output variables are a single entity reporting. Meters are a combination of like variables
specifically for Energy Consumption. This section introduces a slightly different concept
where output variables described herein are a combination of several similar items
specifically targeted at HVAC/System level reporting. This reporting is coupled with an Air
Loop (ref: AirLoopHVAC)
All items shown in this section are typical output variables and can be reported with the
Output:Variable object.
Or, as is shown by example here, perhaps a more readable form is to generate them in
Tabular Form with the Output:Table:Monthly object.

OA

Outside
Air Comp.

system
components

MA

RA
system
components

Reheat
Coil

Zone 1
Zone 2
Zone 3
Figure 91. View of System Level Reporting

System Loads Outputs

In this category, the total system load is reported. Two aspects are reported here: Heating
and Cooling. The following two variables report the heat energy that system components
(including packaged equipment, fans, main coils, reheat coils, humidifiers, desiccant
dehumidifiers, evaporative coolers and heat exchangers) add or remove from the air loop.
Each variable within these grouping wil
Air System Total Heating Energy
Heat Addition to the Air Loop (Sum of all components) in Joules
Air System Total Cooling Energy
Heat Removal from the Air Loop (Sum of all components) in Joules
In Output:Table:Monthly format shown below.
9/29/14

809

Input-Output Reference

Group Air Distribution

OutputControl:Table:Style,HTML;
Output:Table:Monthly,
System Loads,
!- Name
,
!- DigitsAfterDecimal
Air System Total Heating Energy, SumOrAverage,
Air System Total Cooling Energy, SumOrAverage;

System Energy Use Outputs

System Energy Use consists of six output variables that report the total energy (in Joules)
and water consumption (in m 3) for all system components and including packaged
equipment, fans, main coils, reheat coils, humidifiers, desiccant dehumidifiers, and
evaporative coolers. The output variables shown below show hot and cold water, steam,
electric and gas energy. Hot and cold water energy includes all district cooling and district
heating energy.
Air System Hot Water Energy
Hot Water Consumption for the system (Joules).
Air System Steam Energy
Steam Consumption for the system (Joules).
Air System Chilled Water Energy
Chilled Water Consumption for the system (Joules).
Air System Electric Energy
Electric Consumption for the system (Joules).
Air System Gas Energy
Gas (Natural Gas and Propane) Consumption for the system (Joules).
Air System Water Volume
Water Consumption for the system (humidifiers and evaporative coolers) (m3).
The Standard reports file includes these variables reporting in the Tabular report form as Air
Loop System Energy and Water Use.
OutputControl:Table:Style,HTML;
Output:Table:Monthly,
Air Loop System Energy and Water Use,
!- Name
,
!- DigitsAfterDecimal
Air System Hot Water Energy , SumOrAverage,
Air System Steam Energy , SumOrAverage,
Air System Chilled Water Energy, SumOrAverage,
Air System Electric Energy, SumOrAverage,
Air System Gas Energy, SumOrAverage,
Air System Water Volume, SumOrAverage;

System Component Loads Outputs

Reporting System Component Loads shows the energy transferred to or extracted from the
air loop by system component type. Fans, Cooling Coils, Heating Coils, Heat exchangers,
humidifiers, evaporative coolers, and desiccant dehumidifiers show heat transfer rates in
Joules. The components may be located in outdoor air systems bundled with packaged
equipment or specified as stand-alone components. The reporting accounts for both main
branch and reheat coils.
9/29/14

810

Input-Output Reference

Group Air Distribution

The Standard reports file includes these variables reporting in the Tabular report form as Air
Loop System Component Loads.
OutputControl:Table:Style,HTML;
Output:Table:Monthly,
Air Loop System Component Loads,
!- Name
,
!- DigitsAfterDecimal
Air System Fan Air Heating Energy, SumOrAverage,
Air System Cooling Coil Total Cooling Energy, SumOrAverage,
Air System Heating Coil Total Heating Energy, SumOrAverage,
Air System Heat Exchanger Total Heating Energy, SumOrAverage,
Air System Heat Exchanger Total Cooling Energy, SumOrAverage,
Air System Humidifier Total Heating Energy, SumOrAverage,
Air System Evaporative Cooler Total Cooling Energy, SumOrAverage,
Air System Desiccant Dehumidifier Total Cooling Energy, SumOrAverage;

Air System Fan Air Heating Energy

Energy added to the air loop by Fans (Joules)
Air System Cooling Coil Total Cooling Energy
Energy removed from air loop by Cooling Coils (Joules)
Air System Heating Coil Total Heating Energy
Energy added to air loop by Heating Coils (Joules)
Air System Heat Exchanger Total Heating Energy
Energy added to air loop by air-to-air heat recovery heat exchangers (Joules)
Air System Heat Exchanger Total Cooling Energy
Energy removed from air loop by air-to-air heat recovery heat exchangers (Joules)
Air System Humidifier Total Heating Energy
Energy added to air loop by humidifiers (Joules)
Air System Evaporative Cooler Total Cooling Energy
Energy removed from air loop by evaporative coolers (Joules)
Air System Desiccant Dehumidifier Total Cooling Energy
Energy removed from air loop by desiccant dehumidifiers (Joules)
Air System Solar Collector Total Heating Energy
Energy added to air loop by solar collectors (Joules)
Air System Solar Collector Total Cooling Energy
Energy removed from air loop by solar collectors (Joules)
Air System User Defined Air Terminal Total Heating Energy
Energy added to air loop by user defined air terminal units (Joules)
Air System User Defined Air Terminal Total Cooling Energy
Energy removed from air loop by user defined air terminal units (Joules)

9/29/14

811

Input-Output Reference

Group Air Distribution

System Component Energy Use Outputs

Reporting System Component Energy Use consists of eleven output variables that report the
total energy consumption (in Joules) of system components by energy type and coil type.
Electric energy consumption is reported for fans, heating and cooling coils in packaged (DX)
systems, electric resistance heating coils, humidifiers, evaporative coolers and desiccant
dehumidifiers.
Air System Fan Electric Energy
Electric consumption for fans. (Joules)
Air System Heating Coil Hot Water Energy
Consumption for heating coil hot water (both purchased and plant supplied) (Joules)
Air System Cooling Coil Chilled Water Energy
Consumption for cooling coil chilled water (both purchased and plant supplied) (Joules)
Air System DX Heating Coil Electric Energy
Compressor plus condenser fan electricity use. (Joules)
Air System DX Cooling Coil Electric Energy
Compressor plus condenser fan electricity use. (Joules)
Air System Heating Coil Electric Energy
Electricity consumption for the heating coil. (Joules)
Air System Heating Coil Gas Energy
Gas (Propane and Natural Gas) consumption for the heating coil. (Joules)
Air System Heating Coil Steam Energy
Steam consumption for the heating coil (steam coils). (Joules)
Air System Humidifier Electric Energy
Electricity consumption for the humidifiers. (Joules)
Air System Evaporative Cooler Electric Energy
Electricity consumption for the evaporative coolers. (Joules)
Air System Desiccant Dehumidifier Electric Energy
Electricity consumption for the desiccant dehumidifiers. (Joules)
The Standard reports file includes these variables reporting in the Tabular report form as Air
Loop System Component Energy Use.
OutputControl:Table:Style,HTML;
Output:Table:Monthly,
Air Loop System Component Energy Use,
!- Name
,
!- DigitsAfterDecimal
Air System Fan Electric Energy, SumOrAverage,
Air System Heating Coil Hot Water Energy, SumOrAverage,
Air System Cooling Coil Chilled Water Energy, SumOrAverage,
Air System DX Heating Coil Electric Energy, SumOrAverage,
Air System DX Cooling Coil Electric Energy, SumOrAverage,
Air System Heating Coil Electric Energy, SumOrAverage,
Air System Heating Coil Gas Energy, SumOrAverage,
Air System Heating Coil Steam Energy, SumOrAverage,
9/29/14

812

Input-Output Reference

Group Air Distribution

Air System Humidifier Electric Energy, SumOrAverage,

Air System Evaporative Cooler Electric Energy, SumOrAverage,
Air System Desiccant Dehumidifier Electric Energy, SumOrAverage;

Overall Air Loop Syntax

A map for Air Loop input syntax is shown in the following diagram.

Air Loop Input Structure/Map

AirLoopHVAC
data
Controller List
Availability Manager List
Branch List
Connector List

AirLoopHVAC:ControllerList
component controllers in
order of priority; defined
by CONTROL:... syntax

AvailabilityManagerList
managers such as:
AvailabilityManager:Scheduled
etc.

BranchList
branch name 1, branch name 2, ..

ConnectorList
Connector type, connector name

Figure 92. Air Loop Input Syntax Map

AirLoopHVAC:ControllerList
The syntax for the AirLoopHVAC:ControllerList definition is shown below. As with other lists
in EnergyPlus input, the object title and identifying name are followed by type-name pairs. In
this case, the types are controller types. The order in which controllers appear on this list also
define the priority as described below. The identifying name refers back to the name recorded
in the AirLoopHVAC statement.
Field: Name
The user designated unique name of an instance of a Controller List. Any object referencing
this Controller List will do so using this name.
Field Set (Object Type, Controller Name) up to 8
After the identifying name, input for the controller list consists of up to 8 pairs of data items: a
controller type and a controller name. The first controller listed has the highest priority, the
second the second highest priority, and so forth.
Field: Controller <x> Object Type
The type of controller. This should be a key word defining a class of controllers such as
Controller:WaterCoil.

9/29/14

813

Input-Output Reference

Group Air Distribution

Field: Controller <x> Name

The name of a controller object (such as a Controller:WaterCoil) defined elsewhere in the
input file.
An example of this statement in an IDF is:
AirLoopHVAC:ControllerList,
Dual Duct System 1 Controllers,
Controller:WaterCoil, Main Cooling Coil Controller,
Controller:WaterCoil, Main Heating Coil Controller;

AvailabilityManagerAssignmentList
The AvailabilityManagerAssignmentList defines the applicable managers used for an
AirLoopHVAC or PlantLoop. The priority of availability managers is based on a set of rules
and are specific to the type of loop. The output from each Availability Manager is an
availability status flag. This flag can have the values NoAction, ForceOff, CycleOn, or
CycleOnZoneFansOnly (used only for air loops). The availability status flags for the
Availability Managers referenced by an air or plant loop are used to set the availability status
flag for each loop. For the air loops, ForceOff takes precedence: if any of the loops
availability managers are showing status ForceOff, the loop status will be ForceOff. Next in
precedence is CycleOnZoneFansOnly, followed by CycleOn, and NoAction. For the plant
loops, there is no precedence among the Availability Manager status flag values. Instead, the
first availability manager giving a status flag value other than NoAction sets the status for the
loop. The Availability Managers are executed in Availability Manager List order.
Special rules also apply for which managers may be listed in a Availability Manager list. The
Hybrid Ventilation Control Manager (object: AvailabilityManager:HybridVentilation) is a
special type of manager and is never specified in a Availability Manager List (it is used standalone for a specific air loop). All other types of availability managers may be listed in the
Availability Manager List used for AirLoopHVACs. For Plant Loops, the Night Cycle and Night
Ventilation
managers
(objects:
AvailabilityManager:NightCycle
and
AvailabilityManager:NightVentilation) are not allowed in the Availability Manager List.
Field: Name
The name of the AvailabilityManagerAssignmentList
AirLoopHVAC and PlantLoop objects.

object. This is referenced by

Field Set (Availability Manager Object Type, Name)

Managers are listed by pairs of data items: Availability Manager Object Type and Availability
Manager Name. The managers are simulated down the list and calculate a control status for
use by the AirLoopHVAC or PlantLoop. The priority of each manager used for a specific loop
is based on the rules described above. Availability managers are not currently used for
condenser loops. The availability managers, along with the AirLoopHVAC and PlantLoop
object, report the control status calculated each simulation timestep. These output variables
can be used to prioritize the managers according to the required control strategy. Six
managers are accomodated in the list by default, however, this IDD specification is
extensible. Additional pairs may be added by directly editing the IDD.
Field: Availability Manager <x> Object Type
The key word defining the type of manager, e.g. AvailabilityManager:NightCycle.
Field: Availability Manager<x> Name
The name of a AvailabilityManager object defined elsewhere in the input file.
An example of this statement in an IDF is:

9/29/14

814

Input-Output Reference

Group Air Distribution

AvailabilityManagerAssignmentList,
Collector Loop Availability Manager List, !- Name
AvailabilityManager:HighTemperatureTurnOff,
!- System Availability Manager Type 1
High Temperature Turn Off Availability Manager, !- System Availability Manager Name 1
AvailabilityManager:LowTemperatureTurnOn ,
!- System Availability Manager Type 2
Low Temperature Turn On Availability Manager, !- System Availability Manager Name 2
AvailabilityManager:DifferentialThermostat,
!- System Availability Manager Type 3
Differential Thermostat Availability Manager; !- System Availability Manager Name 3

AirLoopHVAC:OutdoorAirSystem
The Outside Air System (object AirLoopHVAC:OutdoorAirSystem) is a subsystem of an
AirLoopHVAC. It handles the mixed air portion of the primary air system: the system relief air,
the outside air inlet, and any components and controllers associated with the system relief air
and outside air streams. From the perspective of the primary air loop the Outside Air System
is treated as a single component. As a subsystem, it can contain one or more components
and controllers.
The input for the Outside Air System consists of a system name, a controller list name, an
equipment list name, and an availability manager list name. The controller list simply lists, by
type and unique name, all the controllers in the subsystem. The controllers will be simulated
in list order. The equipment list lists all the components in the subsystem, by type and name.
The equipment is simulated in list order. Finally, the availability manager list gives the type
and name of the availability managers used by the subsystem.
The equipment inlet/outlet must be sequential with no loops - the simulation can only handle
a straight-through air path, both on the primary air side and on the secondary air side, if any.
Heat exchanger secondary air inlets need to be independent of the primary air stream
usually relief air is used.
Field: Name
The unique, user assigned name for a single instance of an Outside Air System. Any other
object referencing this Outside Air System will use this name.
Field: Name: Controller List Name
This field is the name of a AirLoopHVAC:ControllerList object. A AirLoopHVAC:ControllerList
is simply a list of controllers giving both controller name and type. This Controller List
specifies all the controllers that will act on this outside air system. The order of the controllers
in the list is significant: controllers are simulated sequentially in the order given in the
Controller List. Typically the Controller List would contain a Controller:OutdoorAir. If there are
chilled water or hot water coils in the outdoor air system, each such coil will need a
Controller:WaterCoil.
Field: Outdoor Air Equipment List Name
This field is the name of an AirLoopHVAC:OutdoorAirSystem:EquipmentList object. An
AirLoopHVAC:OutdoorAirSystem:EquipmentList is simply a list of components giving both
component name and type. This Outdoor Air Equipment List specifies all the components that
will be simulated in this outside air system. The order of the components in the list is
significant: components are simulated sequentially in the order given in the Outdoor Air
Equipment List. Typically the equipment list would contain at least an OutdoorAir:Mixer. If
there is more than one component, the components must be listed in order from the outside
air to the OutdoorAir:Mixer (the OutdoorAir:Mixer is last).
Field: Availability Manager List Name
This field is the name of a AvailabilityManagerAssignmentList object. An Availability Manager
List is a list of Availability Managers giving both Availability Manager Object Type and Name.
Use of this input is optional. This field may be omitted; it is not currently used by the
program.
An IDF example, including the AirLoopHVAC, and the controller and equipment lists.
9/29/14

815

Input-Output Reference

Group Air Distribution

AirLoopHVAC,Typical Terminal Reheat 1,

Reheat System 1 Controllers,
Reheat System 1 Avail List,
1.3,
Air Loop Branches,,
Air Loop Inlet Node, Return Air Mixer Outlet,
Zone Equipment Inlet Node, Air Loop Outlet Node;
AirLoopHVAC:ControllerList,
Reheat System 1 Controllers,
Controller:WaterCoil, Main Cooling Coil Controller;
BranchList, Air Loop Branches,
Air Loop Main Branch;
Branch, Air Loop Main Branch,
1.3,
,
AirLoopHVAC:OutdoorAirSystem, OA Sys 1,
Air Loop Inlet Node, Mixed Air Node,PASSIVE
Fan:ConstantVolume, Supply Fan 1,
Mixed Air Node, Cooling Coil Air Inlet Node, ACTIVE,
Coil:Cooling:Water:DetailedGeometry, Detailed Cooling Coil,
Cooling Coil Air Inlet Node, Air Loop Outlet Node, PASSIVE;
AvailabilityManagerAssignmentList, Reheat System 1 Avail List,
AvailabilityManager:Scheduled, Reheat System 1 Avail;
AvailabilityManager:Scheduled, Reheat System 1 Avail,
FanAndCoilAvailSched;

AirLoopHVAC:OutdoorAirSystem,
OA Sys 1,
OA Sys 1 Controllers,
OA Sys 1 Equipment;
AirLoopHVAC:ControllerList,
OA Sys 1 Controllers,
Controller:OutdoorAir, OA Controller 1;
AirLoopHVAC:OutdoorAirSystem:EquipmentList,
OA Sys 1 Equipment,
HeatExchanger:AirToAir:FlatPlate,OA Heat Recovery 1,
OutdoorAir:Mixer, OA Mixing Box 1;

Outdoor Air System Outputs

The impact of using outside air/mechanical ventilation is described in the section: Outdoor Air
Ventilation Outputs.
AirLoopHVAC:OutdoorAirSystem:EquipmentList
Used to specify the components in the outdoor air system. The components will be simulated
in the order in which they occur in the list.
Field: Name
The user designated unique name of an instance of an Air Loop Equipment List. Any object
referencing this Air Loop Equipment List will do so using this name.
Field Set (Component Object Type,, Component Name) up to 8
After the identifying name, the list consists of up to 8 pairs of data items:
Field: Component <x> Object Type
This field specifies the keyword for the type of component used.
9/29/14

816

Input-Output Reference

Group Air Distribution

Field: Component <x> Name

This field is the unique name of the component specified in the previous field. This named
object must appear in the IDF.
An example from an IDF:
AirLoopHVAC:OutdoorAirSystem:EquipmentList,
OA Sys 1 Equipment,
HeatExchanger:AirToAir:FlatPlate,OA Heat Recovery 1,
OutdoorAir:Mixer, OA Mixing Box 1;

OutdoorAir:Node
The OutdoorAir:Node object declares an HVAC system node for outdoor air conditions. The
program automatically sets the air conditions at these nodes to correspond to the ambient
environmental conditions at the beginning of every timestep. The outdoor air node is typically
used as the inlet air node to an HVAC component such as the OutdoorAir:Mixer object.
Multiple OutdoorAir:Node objects can be used in an input file, however, duplicate node
names are not allowed.
The Height Above Ground field is used to adjust the weather file air conditions, e.g., outdoor
dry-bulb and wet-bulb air temperatures, for atmospheric variation with height. This variation
can become a significant factor when modeling tall buildings. See the Engineering Reference
section on Atmospheric Variation for a description of the algorithm for variation of
atmospheric properties with height. A blank entry or a value less than zero for this field
indicates that the height will be ignored and the weather file conditions will be used.
OutdoorAir:Node and OutdoorAir:NodeList both set a node to outdoor air conditions. OutdoorAir:Node
modifies the weather file conditions if a height has been specified. OutdoorAir:NodeList does not have a
height input and always uses the weather file conditions without modification. The same node name may
not be used with both of these objects.

Field: Name
The unique name for this outdoor air node.
Field: Height Above Ground
The height [m] of the node above ground level. A value greater than zero allows the weather
file conditions, e.g., outdoor dry-bulb and wet-bulb air temperatures, to be adjusted according
to atmospheric variation with height.
A blank entry or value less than zero indicates that the height will be ignored and the weather
file conditions will be used.
An example IDF:
OutdoorAir:Node,
OA Node 1; !- Name
OutdoorAir:Node,
Floor 10 Outdoor air Inlet Node, !- Name
30.0; !- Height Above Ground {m}

Outdoor Air Node outputs:

The ambient dry-bulb air temperature and flow rate at the outdoor air node can be monitored
using the system node output variables:
HVAC,Average,System Node Temperature [C]
HVAC,Average,System Node Mass Flow Rate [kg/s]

e.g.
9/29/14

817

Input-Output Reference

Group Air Distribution

Output:Variable,
Floor 10 Outdoor air Inlet Node,
System Node Temperature,
Hourly;

OutdoorAir:NodeList
The program needs to know which HVAC system nodes are inlets for outdoor air. Knowing
this, the program can set the conditions at these nodes to the outdoor conditions at the start
of each major timestep. The OutdoorAir:NodeList provides the means for specifying which
nodes are outdoor air nodes.
The input is flexible: there may be one or more OutdoorAir:NodeList in each input file. Each
list contains up to 25 names. The names can be the name of a unique HVAC system node, or
the name of a Node List which will contain the actual node names. Duplicate node names are
ignored.
OutdoorAir:Node and OutdoorAir:NodeList both set a node to outdoor air conditions. OutdoorAir:Node
modifies the weather file conditions if a height has been specified. OutdoorAir:NodeList does not have a
height input and always uses the weather file conditions without modification. The same node name may
not be used with both of these objects.

Field: Node or NodeList name

The name of an HVAC system node or of a NodeList object. There can be up to 25 names.
An example IDF:
OutdoorAir:NodeList,
OutsideAirInletNodes;
NodeList,OutsideAirInletNodes,
Outdoor air Inlet Node;

OutdoorAir:Mixer
The OutdoorAir:Mixer is the most common component used in an outdoor air system. The
outdoor air mixer has 2 inlet air streams: the system return air and the outdoor air. It has 2
outlet air streams: the system relief air and the mixed air. This is a passive component. It
takes the inlet mass flows and conditions plus the relief air mass flow and calculates the
mixed air flow rate and conditions (as well as the relief air conditions). The inlet and relief
mass flow must be set outside the component most commonly by an outdoor air controller.
The OutdoorAir:Mixer can also be used in compound components such as a fan coil unit.
Input for this object is very simple: a unique name plus the node names of the 2 inlet nodes
and the 2 outlet nodes.
Field: Name
A unique user assigned name for a particular outdoor air mixer component. Any reference to
this component by another object will use this name.
Field: Mixed Air Node Name
The name of the HVAC system node which is the outlet for the mixed air stream.
Field: Outdoor Air Stream Node Name
The name of the HVAC system node which is the inlet for the outdoor air stream.
Field: Relief Air Stream Node Name
The name of the HVAC system node which is the outlet for the system relief air.
9/29/14

818

Input-Output Reference

Group Airflow Network

Field: Return Air Stream Node Name

The name of the HVAC system node which is the inlet for the return air stream.
An IDF example:
OutdoorAir:Mixer,
Zone1WindACOAMixer,
Zone1WindACOAMixerOutletNode,
Zone1WindACOAInNode,
Zone1WindACExhNode,
Zone1WindACAirInletNode;

!
!
!
!
!

name
mixer
mixer
mixer
mixer

outlet node
OA node
relief node
inlet node

Group Airflow Network

Overview
The Airflow Network model provides the ability to simulate multizone airflows driven by wind
and also by a forced air distribution system. The model can also simulate the heat and
moisture gains or losses from the air distribution system itself (e.g., ductwork). When
modeling an air distribution system, the current version of the Airflow Network model is
restricted to a single forced air system (i.e., AirLoopHVAC object) with a constant volume
supply air fan (Fan:ConstantVolume or Fan:OnOff). The capabilities of the model are to:
Simulate zone pressures due to envelope leakage and forced air distribution during
HVAC system fan operation
Simulate node pressures in a forced air distribution system during HVAC system fan
operation
Calculate multizone airflows due to forced air, wind, and surface leakage, including
adjacent zones and outdoors, during HVAC system fan operation
Simulate distribution system airflows, including supply and return air leaks, during
HVAC system fan operation
Simulate air distribution system node temperatures and humidity ratios during HVAC
system fan operation
Calculate duct conduction losses during HVAC system fan operation
Calculate vapor diffusion losses of ducts during HVAC system fan operation
Calculate sensible and latent loads on the surrounding zones due to supply and
return air leaks in the air distribution system during HVAC system fan operation
Simulate zone pressures due to envelope leakage driven by wind when the HVAC
system fan is off or if no air distribution system is specified
Calculate multizone airflows due to wind and surface leakage, including adjacent
zones and outdoors when the HVAC system fan is off or if no air distribution system
is specified
Allow zone exhaust fans to be included as part of the airflow network
For airflow networks with a forced air distribution system, calculate zone sensible and
latent loads for two different supply air fan operation modes as required: cycling fan,
cycling compressor (CyclingFanAndCompressor) and continuous fan, cycling
compressor (ContinuousFanWithCyclingCompressor)
Summary of Objects
Before describing the Airflow Network input objects in detail, we list all of the objects and then
give a short description of what the objects do.
The Airflow Network input objects are:
AirflowNetwork:SimulationControl
AirflowNetwork:Multizone:Zone
AirflowNetwork:Multizone:Surface
9/29/14

819

Input-Output Reference

Group Airflow Network

AirflowNetwork:MultiZone:Component:SimpleOpening
AirflowNetwork:MultiZone:Component:DetailedOpening
AirflowNetwork:MultiZone:Component:HorizontalOpening
AirflowNetwork:MultiZone:Surface:Crack
AirflowNetwork:MultiZone:ReferenceCrackConditions
AirflowNetwork:MultiZone:Surface:EffectiveLeakageArea
AirflowNetwork:MultiZone:Component:ZoneExhaustFan
AirflowNetwork:MultiZone:ExternalNode
AirflowNetwork:MultiZone:WindPressureCoefficientArray
AirflowNetwork:MultiZone:WindPressureCoefficientValues
AirflowNetwork:Distribution:Node
AirflowNetwork:Distribution:Component:Leak
AirflowNetwork:Distribution:Component:LeakageRatio
AirflowNetwork:Distribution:Component:Duct
AirflowNetwork:Distribution:Component:ConstantPressureDrop
AirflowNetwork:Distribution:Component:ConstantVolumeFan
AirflowNetwork:Distribution:Component:Coil
AirflowNetwork:Distribution:Component:HeatExchanger
AirflowNetwork:Distribution:Component:TerminalUnit
AirflowNetwork:Distribution:Linkage
AirflowNetwork:SimulationControl defines basic run parameters for the air flow
calculations and specifies whether wind pressure coefficients are input by the user or, for
rectangular buildings, calculated by the program.
The AirflowNetwork:Multizone:Zone object specifies the ventilation control that applies
to all of the openable exterior and interior windows and doors in the corresponding
thermal zone. Surface-level ventilation control can be used to override the zone-level
ventilation control if required (see AirflowNetwork: Multizone:Surface object below).
AirflowNetwork:Multizone:Surface object indicates whether a heat transfer surface
(wall,
window,
etc.)
has
a
crack
or
opening
and
references
an
AirflowNetwork:MultiZone:Surface:Crack,
AirflowNetwork:MultiZone:Surface:EffectiveLeakageArea,
AirflowNetwork:MultiZone:Component:SimpleOpening,
AirflowNetwork:MultiZone:Component:DetailedOpening,
AirflowNetwork:MultiZone:Component:HorizontalOpening
or AirflowNetwork:MultiZone:Component:ZoneExhaustFan object that gives the air
flow characteristics of that crack, opening, or zone exhaust fan. The
AirflowNetwork:Multizone:Surface object can also be used to specify individual ventilation
control for openable exterior and interior windows and doors.
AirflowNetwork:MultiZone:ReferenceCrackConditions is used to normalize crack
information that is based on measurements of crack air flow.
AirflowNetwork:Distribution:Node represents air distribution system nodes for the
AirflowNetwork model. A set of an AirLoopHVAC and ZoneHVAC:EquipmentList nodes is
a subset of the AirflowNetwork:Distribution:Nodes.
AirflowNetwork:Distribution:Component objects consist of Leak, LeakageRatio,
Duct, ConstantPressureDrop, ConstantVolumeFan, Coil, and TerminalUnit. The
components provide a relationship between pressure and airflow. The Leak and
Leakage components can be used to simulate supply and/or return leaks in an air
distribution system. The Duct and ConstantPressureDrop components can be used to
deliver forced air into conditioned spaces. The components ConstantVolumeFan, Coil,
and TerminalUnit reference normal EnergyPlus objects. The Airflow Network model gets
information from these objects to perform an airflow network simulation.
AirflowNetwork:Distribution:Linkage object represents a connection between two
node objects and an AirflowNetwork component. The node objects can be an
9/29/14

820

Input-Output Reference

Group Airflow Network

AirflowNetwork:Distribution:Node,
AirflowNetwork:MultiZone:ExternalNode
or
AirflowNetwork:Multizone:Zone.
If you input wind pressure coefficients, AirflowNetwork:Multizone:Surface also has an
associated
AirflowNetwork:MultiZone:ExternalNode,
that,
via
the
AirflowNetwork:Multizone:WindPressureCoefficientArray
and
AirflowNetwork:MultiZone:WindPressureCoefficientValues objects, gives the wind
pressure distribution vs. wind direction for that node and, implicitly, for the cracks and
openings in the exterior surfaces associated with that node.
Figure 93 shows the relationships among AirflowNetwork:Multizone objects and between
AirflowNetwork:Multizone objects and regular EnergyPlus objects. In this figure an arrow from
object A to object B means A references B, i.e., one of the inputs in A is the name of object B.
For example, one input for AirflowNetwork: Multizone:Surface is the name of a heat transfer
surface, and another is the name of a crack or opening object. The arrow between
AirflowNetwork:Multizone:Surface and AirflowNetwork:MultiZone:ExternalNode is shown
dashed to indicate that this reference is not used when wind pressure coefficients are
calculated by the program rather than being input by the user.
Figure 93 also shows the relationships among AirflowNetwork:Distribution objects and
between AirflowNetwork:Distribution objects and regular EnergyPlus objects. The
AirflowNetwork:Distribution:Linkage
objects
link
two
nodes
from
AirflowNetwork:Distribution:Node and/or AirflowNetwork:Multizone:Zone objects with a
component defined in the object AirflowNetwork:Distribution:Component. The solid arrows
show a reference from object A to object B. The dashed arrows indicate the components
which can be used in a linkage object. The red arrows pointing to the Zone object indicate the
components that interact with the zone air. For example, the temperature in a zone where a
supply leak terminates is used to calculate duct leakage energy loss. The temperature in a
zone where a duct component is located is also used to calculate duct conduction loss.

9/29/14

821

Input-Output Reference

Group Airflow Network

Figure 93. Relationships among AirflowNetwork objects (right-hand side) and between AirflowNetwork
objects and regular EnergyPlus objects. An arrow from object A to object B means that A references B.
Much of the information needed for the air flow calculation is automatically extracted from the
building description for thermal modeling. This includes things like the volume and neutral
height of the zones, and the orientation and location of the building surfaces that contain
cracks or openings through which air flows. From all of this information the program creates a
pressure-flow network that is solved each timestep using iterative solution methods to
obtain the unknown pressures and air flows.

9/29/14

822

Input-Output Reference

Group Airflow Network

Figure 94 shows a plan view of a very simple air flow network that you can construct using
the above AirflowNetwork objects. There are three thermal zones, Zone-1, Zone-2 and Zone3. There are openable exterior windowsWindow-1, Window-2 and Window-3and
openable interior doorsDoor-12 and Door-23. Two External Nodes are indicated.
ExternalNode-1 is associated with the faade that contains Window-1 and Window-2.
ExternalNode-2 is associated with the faade containing Window-3.
One possible air flow pattern is shown in this figure. The actual air flow pattern in a particular
timestep, and the size of the flows, depends on many factors, such as (1) What is the wind
pressure distribution seen by the exterior windows? (2) Are the exterior windows open or
closed, and if open, how far are they open? (3) Are the interior doors open or closed? (4)
What are the air temperature differences between zones and between zones and the outdoor
air (which affect buoyancy flows)?

ExternalNode-1
Window-2

Window-1

Zone-1

Door-12

Zone-2
ExternalNode-2
Door-23
Window-3

Zone-3
Figure 94. Plan view of a simple air flow network showing a possible air flow pattern in which all of the
windows and doors are open.
Figure 94 shows a possible air flow pattern in which all of the windows and doors are open.
Associated with the external nodes are wind pressure coefficient distributions as a function of
wind direction that are input using two AirflowNetwork:Multizone:Wind Pressure Coefficient
objects. The nature of the air flows through the windows and doors is specified using
AirflowNetwork:MultiZone:Component:DetailedOpening
and
AirflowNetwork:MultiZone:Component:SimpleOpening objects. The Airflow Network model
calculates the flows each system timestep depending on various factors, including wind
direction and speed, size and vertical position of openings, outdoor air temperature, and zone
air temperatures.
Airflow Network Example Files (included in the installation)
AirflowNetwork3zVent.idf
AirflowNetwork3zVentAutoWPC.idf
AirflowNetwork_Simple_House.idf
AirflowNetwork_Simple_SmallOffice.idf
AirflowNetwork_Multizone_House.idf
AirflowNetwork_MultiZone_House_OvercoolDehumid.idf
AirflowNetwork_Multizone_House_TwoSpeed.idf
9/29/14

823

Input-Output Reference

Group Airflow Network

AirflowNetwork_Multizone_SmallOffice.idf
AirflowNetwork_Multizone_SmallOffice_CoilHXAssistedDX.idf
AirflowNetwork_MultiZone_SmallOffice_GenericContam.idf
AirflowNetwork_Multizone_SmallOffice_HeatRecoveryHXSL.idf
AirflowNetwork_Multizone_SmallOffice_VAV.idf
AirflowNetwor_Multizone_HorizontalOpening.idf
CrossVent_1Zone_AirflowNetwork.idf
DisplacementVent_Nat_AirflowNetwork.idf
HybridVentilationControl.idf
What the Airflow Network Model Can and Cannot Do
Here is a list of some of the things that the Airflow Network calculation can and cannot model.
Can Do
1) Air flow through cracks in exterior or interzone surfaces.
2) Air flow through cracks around windows and doors when closed.
3) Natural ventilation (i.e., air flow through open or partially open exterior windows and

doors).

4) Zone level control of natural ventilation (all windows/doors in a zone that are defined with

a component opening object have identical controls).

5) Individual surface control of natural ventilation for a subsurface (window, door, or

glassdoor).

6) Modulation of natural ventilation to prevent large zone air temperature swings.

7) Interzone air flow (i.e., air flow through open interzone windows and doors, and through

cracks in interzone surfaces).

8) Dependence of air flow on buoyancy effects and wind pressure.

9) Dependence of wind pressure on wind speed, wind direction and surface orientation.
10) Supply and return air leaks in an air distribution system.
11) Account for the effect of supply-air and/or return-air leakage on zone pressure when a

forced air distribution system is present and is operating.

12) When duct leakage is modeled and the HVAC system is on, interzone airflow or

infiltration/exfiltration can occur due to changes in zone pressure.

13) Bi-directional

flow through large openings. See

AirflowNetwork:MultiZone:Component:DetailedOpening,
AirflowNetwork:Multizone:Component:HorizontalOpening,
AirflowNetwork:Multizone:Component:SimpleOpening.

discussion

below

under
and

14) Calculate air flows and pressures in ducts or other components of a forced air distribution

system.

15) Calculate zone loads when the supply air fan cycles on and off during a system timestep

using the CyclingFanAndCompressor fan operation mode (Fan:OnOff).

16) Determine

the impact of zone exhaust fans on

temperatures/humidity levels and energy consumption.

air

flows,

pressures,

air

Cannot Do or Restricted
1) The model is restricted to using a constant volume fan (Fan:ConstantVolume and

Fan:OnOff) and cannot model variable volume fan equipment.

2) Air circulation and/or air temperature stratification within a thermal zone. For example,

you should not try to divide a high space, such as an atrium, into subzones separated by

9/29/14

824

Input-Output Reference

Group Airflow Network

artificial horizontal surfaces that have cracks or openings with the expectation that
AirflowNetwork will give you a realistic temperature in each subzone and/or a realistic air
flow between subzones.
3) The model is restricted to eleven types of coils that can be in the air distribution system

(Coil:Cooling:DX:SingleSpeed,
Coil:Heating:Gas,
Coil:Heating:Electric,
Coil:Heating:DX:SingleSpeed,
Coil:Cooling:Water,
Coil:Heating:Water,
Coil:Cooling:Water:DetailedGeometry,
Coil:Cooling:DX:TwoStageWithHumidityControlMode,
Coil:Cooling:DX:MultiSpeed,
Coil:Heating:DX:MultiSpeed, and Coil:Heating:Desuperheater).

4) The model is restricted to a single type of air distribution equipment terminal units

(AirTerminal:SingleDuct:ConstantVolume:Reheat).

5) Pollutant transport cannot currently be modeled.

6) Supply and return leaks are not allowed in an AirLoopHVAC. They can only be modeled

in the Zone Equipment portion of the air loop (i.e., return leaks may be modeled between
the zone return node and the zone mixer inlet or the zone mixer outlet and the zone
equipment loop outlet; and supply leaks may be modeled between the zone equipment
loop inlet and the AirLoopHVAC:ZoneSplitter inlet node or the AirLoopHVAC:ZoneSplitter
outlet node and the zone supply node).

7) An air distribution system must be located inside the building (i.e., the ducts must pass

through zones within the building).

8) Zone exhaust fans must be defined in ZoneHVAC:EquipmentConnections objects.

The input specifications consist of five main sections: AirflowNetwork:SimulationControl

object, AirflowNetwork multizone data objects, AirflowNetwork distribution node
objects, AirflowNetwork distribution component objects, and AirflowNetwork
distribution linkage objects. Each of these object types is described in detail below.
AirflowNetwork:SimulationControl
The basic run parameters for this model are defined in this unique object which has the
following input specifications:
Field: Name
This is a unique character string associated with this instance of
AirflowNetwork:SimulationControl
object.
At
this
time,
only
AirflowNetwork:SimulationControl object can be specified in an input data file (idf).

the
one

Field: AirflowNetwork Control

The following selections are available to control the Airflow Network simulation:
MultizoneWithDistribution: Multizone air flow calculations are performed during all
simulation timesteps, including the impacts of the air distribution system when a HVAC
system fan is operating. Any ZoneInfiltration:*, ZoneVentilation:*, ZoneMixing and
ZoneCrossMixing objects specified in the input data file are not simulated.
MultizoneWithoutDistribution: Multizone air flow calculations are performed during all
simulation timesteps, but the air distribution system portion of the network is not modeled
even if it is specified in the input data file. Any ZoneInfiltration:*, ZoneVentilation:*,
ZoneMixing and ZoneCrossMixing objects specified in the input data file are not simulated.
MultizoneWithDistributionOnlyDuringFanOperation: Multizone air flow calculations,
including the impacts of the air distribution system, are only performed when the HVAC
system fan is operating. Any ZoneInfiltration:*, ZoneVentilation:*, ZoneMixing and
ZoneCrossMixing objects specified in the input data file are used when the HVAC system
fan is OFF (if none are specified, then no air flow calculations are performed when the fan is
OFF).
9/29/14

825

Input-Output Reference

Group Airflow Network

NoMultizoneOrDistribution: No multizone air flow calculations (with or without the air

distribution system portion of the network) are performed during the simulation. Any
ZoneInfiltration:*, ZoneVentilation:*, ZoneMixing and ZoneCrossMixing objects specified
in the input data file are simulated (if none are specified, then no air flow calculations are
performed). Note: Having an input data file with no AirflowNetwork:SimulationControl objects
gives the same impact no multizone air flow calculations. However, this choice is provided
as a convenience to the user to easily disable the multizone air flow calculations for an input
data file that already contains AirflowNetwork objects.
Note: A ZoneInfiltration:* object indicates any one of ZoneInfiltration:DesignFlowRate,
ZoneInfiltration:EffectiveLeakageArea,and ZoneInfiltration:FlowCoefficient objects. A object of
ZoneVentilation:*
indicates
any
one
of
ZoneVentilation:DesignFlowRate
and
ZoneVentilation:WindandStackOpenArea objects.

Field: Wind Pressure Coefficient Type

Determines whether the wind pressure coefficients are input by the user or calculated. The
choices are Input or SurfaceAverageCalculation, with the default being
SurfaceAverageCalculation.
If INPUT, you must enter an AirflowNetwork:MultiZone:WindPressureCoefficientArray object,
one or more AirflowNetwork:MultiZone:ExternalNode objects, and one or more
AirflowNetwork:MultiZone:WindPressureCoefficientValues objects.
The second choice, SurfaceAverageCalculation, should only be used for rectangular
buildings. In this case surface-average wind pressure coefficients vs. wind direction are
calculated by the program for the four vertical facades and the roof based on user entries for
Building Type, Azimuth Angle of Long Axis of Building, and Ratio of Building Width Along
Short Axis to Width Along Long Axis (see description of these fields below). With this choice
you do not have to enter any of the following objects: AirflowNetwork:MultiZone: Wind
Pressure
Coefficient
Array,
AirflowNetwork:MultiZone:ExternalNode
and
AirflowNetwork:MultiZone:WindPressureCoefficientValues.
Field: AirflowNetwork Wind Pressure Coefficient Array Name
This is the name of the AirflowNetwork:MultiZone:WindPressureCoefficientArray object that
contains wind directions corresponding to the wind pressure coefficients given in the
AirflowNetwork:MultiZone:WindPressureCoefficientValues objects.
A value need be entered only if Wind Pressure Coefficient Type = INPUT (see description of
previous field).
Field: Height Selection for Local Wind Pressure Calculation
Determines whether the local wind pressure is calculated based on either given external
node heights or surface opening heights. The choices are ExternalNode or OpeningHeight,
with the default being OpeningHeight. The local outdoor wind speed calculation procedure is
given in the section of Local Wind Speed Calculation in the Engineering Reference. The
calculation procedure requires the height input.
If ExternalNode, the heights given in the AirflowNetwork:MultiZone:ExternalNode objects are
used to calculate local wind pressures based on the given height local wind speed. Used
only if Wind Pressure Coefficient Type = INPUT (see description of previous field).
If OpeningHeight, the number of the AirflowNetwork:MultiZone:ExternalNode objects has to
be equal to the number of external surfaces defined in the AirflowNetwork:MultiZone:Surface
objects. The centroids in the z direction of the AirflowNetwork:MultiZone:Surface objects are
the heights used in the local wind pressure calculation with the given height wind speed. The
input is required if Wind Pressure Coefficient Type = INPUT (see description of previous
field).
9/29/14

826

Input-Output Reference

Group Airflow Network

If Wind Pressure Coefficient Type = SurfaceAverageCalculation, a value in this field is not

required and a blank may be entered. The default choice is used internally to generate the
AirflowNetwork:MultiZone:ExternalNode objects
Field: Building Type
Used only if Wind Pressure Coefficient Type = SurfaceAverageCalculation. The choices for
Building Type are LowRise and HighRise, with the default being LowRise.
LowRise corresponds to a rectangular building whose height is less than three times the
width of the footprint (wshort in Figure 95) and is less than three times the length of the
footprint (wlong in the same figure).
HighRise corresponds to a rectangular building whose height is more than three times the
width of the footprint (wshort in Figure 95) or is more than three times the length of the footprint
(wlong in the same figure).
Field: Maximum Number of Iterations
The maximum number of iterations allowed in finding an AirflowNetwork solution. If the
number of iterations at each simulation timestep is above the maximum number of iterations
defined by this field, the program could not find the solution and a Severe error is issued and
the program is aborted. The default value is 500.
Field: Initialization Type
Designates which method is used for AirflowNetwork initialization. The choices for
Initialization Type are LinearInitializationMethod and ZeroNodePressures, with the default
being ZeroNodePressures.
Field: Relative Airflow Convergence Tolerance
The solution is assumed to have converged when

mi

m i is less than the value

specified for this input field. This convergence criteria is equivalent to the ratio of the absolute
value of the sum of all network airflows (

m i ) to the sum of network airflow magnitudes (

m i ). The default value is 1.0x10-4.

Field: Absolute Airflow Convergence Tolerance
The solution is assumed to have converged when the summation of the absolute value of all
network airflows (

m i ) is less than the value specified for this input field. The default

value is 1.0x10-6.
Field: Convergence Acceleration Limit
If the ratio of successive pressure corrections is less than this limit, use Steffensen
acceleration algorithm (Ref. AirflowNetwork Model in the EnergyPlus Engineering
Reference). The range for this field is -1 to 1, with the default value being -0.5.
Field: Azimuth Angle of Long Axis of Building
Gives the orientation of a rectangular building for calculating wind pressure coefficients. This
is the smaller of the angles, measured clockwise, between North and the long axis of the
building (see Figure 95). Used only if Wind Pressure Coefficient Type =
SurfaceAverageCalculation. The range for this input is 0 to 180, with the default value being
0.
9/29/14

827

Input-Output Reference

Group Airflow Network

Field: Ratio of Building Width Along Short Axis to Width Along Long Axis
This is the aspect ratio of a rectangular footprint. It is given by the width of the footprint along
its short axis divided by the width along the long axis (see Figure 95). If the footprint is
square, the value of this field is 1.0. Used only if Wind Pressure Coefficient Type =
SurfaceAverageCalculation. The range for this input is > 0 to 1, with the default value being 1.

North

Long axis
Building
footprint

wshort
wlong
Short axis

Figure 95. Footprint of a rectangular building showing variables used by the program to calculate surfaceaverage wind pressure coefficients. The angle is the Azimuth Angle of Long Axis of Building.
wshort/wlong is the Ratio of Building Width Along Short Axis to Width Along Long Axis.
Field: Height Dependence of External Node Temperature
This is an optional field. Input is Yes or No. The default is No. Yes is that external node
temperature is dependent on node height. No means that external node temperature is
calculated with zero height.
An IDF example is shown below:
AirflowNetwork:SimulationControl,
AirflowNetwork_All,
!- Name
MultiZoneWithDistribution, !- AirflowNetwork Control
Input,
!- Wind Pressure Coefficient Type
Every 30 Degrees,
!- AirflowNetwork Wind Pressure Coefficient Array Name
OpeningHeight,
!- Height Selection for Local Wind Speed Calculation
LowRise,
!- Building Type
500,
!- Maximum Number of Iterations {dimensionless}
ZeroNodePressures,
!- Initialization Type
1.0E-05,
!- Relative Airflow Convergence Tolerance {dimensionless}
1.0E-06,
!- Absolute Airflow Convergence Tolerance {kg/s}
-0.5,
!- Convergence Acceleration Limit {dimensionless}
0.0,
!- Azimuth Angle of Long Axis of Building {deg}
1.0;
!- Ratio of Building Width Along Short Axis to Width Along Long Axis

AirflowNetwork:Multizone data objects are used to calculate multizone airflows. This section
describes the input requirements for the following objects:
AirflowNetwork:MultiZone:Zone
AirflowNetwork:Multizone data objects are used to calculate multizone airflows. This section
describes the input requirements for the following objects:
AirflowNetwork:MultiZone:Zone

9/29/14

828

Input-Output Reference

Group Airflow Network

AirflowNetwork:MultiZone:Surface
AirflowNetwork:MultiZone:Surface:Crack
AirflowNetwork:MultiZone:ReferenceCrackConditions
AirflowNetwork:MultiZone:Surface:EffectiveLeakageArea
AirflowNetwork:MultiZone:Component:DetailedOpening
AirflowNetwork:MultiZone:Component:SimpleOpening
AirflowNetwork:MultiZone:Component:HorizontalOpening
AirflowNetwork:MultiZone:Component:ZoneExhaustFan
AirflowNetwork:MultiZone:ExternalNode
AirflowNetwork:MultiZone:WindPressureCoefficientArray
AirflowNetwork:MultiZone:WindPressureCoefficientValues
A detailed description for each of these objects is provided below.
AirflowNetwork:Multizone:Zone
This object allows control of natural ventilation through exterior and interior openings in a
zone, where opening is defined as an openable window or door. (Note that only window,
door or glass door subsurfaces in a zone that are specified using
AirflowNetwork:MultiZone:Component:DetailedOpening,
AirflowNetwork:MultiZone:Component:HorizontalOpening
or
AirflowNetwork:Multizone:Component:SimpleOpening
and
have
an
associated
AirflowNetwork:Multizone:Surface object are considered to be openings). The control will be
applied in the same way to all of the openings in the zone.
This object is required to perform Airflow Network calculations. Note that ventilation control
for all openings is provided at the zone level as default and individual ventilation control of a
surface opening can be used to override the zone-level control (see the
AirflowNetwork:Multizone:Surface object description below).
Field: Zone Name
The name of the EnergyPlus thermal zone corresponding to the AirflowNetwork zone.
Field: Ventilation Control Mode
Specifies the type of zone-level natural ventilation control.
Let Tout equal the outdoor air temperature, Tzone equal the previous timesteps zone air
temperature, Tset equal the Vent Temperature Schedule value, Hzone equal the specific
enthalpy of zone air from the previous timestep, and Hout equal the specific enthalpy of
outdoor air. Then the four allowed choices for Ventilation Control Mode are:
NoVent: All of the zones openable windows and doors are closed at all times independent of
indoor or outdoor conditions. The Venting Availability Schedule is ignored in this case. This is
the default value for this field.
Temperature: All of the zones openable windows and doors are opened if T zone > Tout and
Tzone > Tset and Venting Availability Schedule (see below) allows venting.
Enthalpy: All of the zones openable windows and doors are opened if H zone > Hout and
Tzone > Tset and Venting Availability Schedule allows venting.
Constant: Whenever this objects Venting Availability Schedule allows venting, all of the
zones openable windows and doors are open, independent of indoor or outdoor conditions.

9/29/14

829

Input-Output Reference

Group Airflow Network

Note that Constant here means that the size of each opening is fixed while venting; the air
flow through each opening can, of course, vary from timestep to timestep.
ASHRAE55Adaptive: All of the zones operable windows and doors are opened if the
operative temperature is greater than the comfort temperature (central line) calculated from
the ASHRAE Standard 55-2010 adaptive comfort model and Venting Availability Schedule
allows venting.
CEN15251Adaptive: All of the zones operable windows and doors are opened if the
operative temperature is greater than the comfort temperature (central line) calculated from
the CEN15251 adaptive comfort model and Venting Availability Schedule allows venting.
Field: Ventilation Control Zone Temperature Setpoint Schedule Name
The name of a schedule of zone air temperature set points that controls the opening of
windows and doors in the thermal zone to provide natural ventilation. This setpoint is the
temperature above which all the openable windows and doors in the zone will be opened if
the conditions described in the previous field Ventilation Control Mode are met.
The Ventilation Control Zone Temperature Setpoint Schedule Name applies only to windows
and
doors
in
the
zone
that
are
specified
using
AirflowNetwork:MultiZone:Component:DetailedOpening,
AirflowNetwork:MultiZone:Component:HorizontalOpening
or
AirflowNetwork:MultiZone:Component:SimpleOpening
and
have
an
associated
AirflowNetwork:MultiZone:Surface object.
(The
discussion
under
the
field
Window/Door
Opening
Factor
in
the
AirflowNetwork:MultiZone:Surface object describes how the actual opening area of a window
or door in a particular timestep is determined.)
Modulation of Openings
The following five fields can be used to modulate the window/door openings when Ventilation
Control Mode = Temperature or Enthalpy. These fields determine a factor between 0 and 1
that multiplies the opening factor of each window and door in the zone according to the
control action shown in Figure 96 for Ventilation Control Mode = Temperature and in Figure
97 for Ventilation Control Mode = Enthalpy. Modulation of the openings can reduce the large
temperature swings that can occur if the windows/doors are open too far when they are
venting, especially when there is a large inside-outside temperature difference.
The modulation takes the following form when Ventilation Control Mode = Temperature:
Tzone - Tout
[Lower Value on Inside/Outside Temperature Difference for Modulating the Venting
Open Factor]
Multiplication factor = 1.0
[Lower Value on Inside/Outside Temperature Difference for Modulating the Venting Open Factor] <
Tzone - Tout < [Upper Value on Inside/Outside Temperature Difference for Modulating the Venting
Open Factor]
Multiplication factor varies linearly from 1.0 to [Limit Value on Multiplier for
Modulating Venting Open Factor]
Tzone - Tout
[Upper Value on Inside/Outside Temperature Difference for Modulating the Venting
Open Factor]
Multiplication factor = [Limit Value on Multiplier for Modulating Venting Open
Factor]

One way of tuning the following modulation control parameters is to perform a sensitivity
analysis for winter and/or summer design days to determine what combination of values
causes the biggest reduction in zone air temperature fluctuations due to venting.
Note that the default values for the following fields are such that, if none of the fields are
specified, the default values are assigned.

9/29/14

830

Input-Output Reference

Group Airflow Network

Field: Minimum Venting Open Factor

See Figure 96 or Figure 97. This field applies only if Ventilation Control Mode = Temperature
or Enthalpy. This value may be from zero to 1.0, with the default being 0.0.
Field: Indoor and Outdoor Temperature Difference Lower Limit For Maximum Venting
Open Factor
See Figure 96. This field applies only if Ventilation Control Mode = Temperature. This value
may be from zero to less than 100C, with the default being 0C. The value for this field must
be less than the value specified for the following field.
Field: Indoor and Outdoor Temperature Difference Upper Limit for Minimun Venting Open
Factor
See Figure 96. This field applies only if Ventilation Control Mode = Temperature. This value
must be greater than 0C, with the default being 100C. The value for this field must be
greater than the value specified for the previous field..
Field: Indoor and Outdoor Enthalpy Difference Lower Limit For Maximum Venting Open
Factor
See Figure 97. This field applies only if Ventilation Control Mode = Enthalpy. This value may
be from zero to less than 300,000 J/kg, with the default being 0 J/kg. The value for this field
must be less than the value specified for the following field.
Field: Indoor and Outdoor Enthalpy Difference Upper Limit for Minimun Venting Open
Factor
See Figure 97. This field applies only if Ventilation Control Mode = Enthalpy. This value must
be greater than zero, with the default being 300,000 J/kg. The value for this field must be
greater than the value specified for the previous field.
Field: Venting Availability Schedule Name
The name of a schedule that specifies when venting is available. A zero or negative schedule
value means venting is not allowed. A value greater than zero means venting can occur if
other venting control conditions (specified by Ventilation Control Mode and Vent Temperature
Schedule Name) are satisfied. This schedule name should not be confused with Vent
Temperature Schedule Name.
If a Venting Availability Schedule Name is not specified, it is assumed that venting is always
available.
Using Venting Availability Schedule allows you to turn off venting at certain times of the day
(at night, for example), of the week (on weekends, for example), or of the year (during the
winter, for example).
If used with Ventilation Control Mode = Constant, the ventilation rate is constant only when
this schedule allows venting; otherwise the ventilation rate is set to zero.
If Ventilation Control Mode = NoVent, this schedule has no effect.

9/29/14

831

Input-Output Reference

Group Airflow Network

Multiplier on
Venting Open
Factor
1.0

Limit Value on
Multiplier for
Modulating Venting
Open Factor
0.0
Lower Value on
Inside/Outside
Temperature Difference for
Modulating the Venting
Open Factor

Tzone - Tout
Upper Value on
Inside/Outside
Temperature Difference for
Modulating the Venting
Open Factor

Figure 96. Modulation of venting area according to inside-outside temperature difference.

Multiplier on
Venting Open
Factor
1.0

Limit Value on
Multiplier for
Modulating Venting
Open Factor
0.0
Lower Value on
Inside/Outside Enthalpy
Difference for Modulating
the Venting Open Factor

Hzone - Hout
Upper Value on
Inside/Outside Enthalpy
Difference for Modulating
the Venting Open Factor

Figure 97. Modulation of venting area according to inside-outside enthalpy difference.

Note: In order to establish an airflow network, each AirflowNetwork:Multizone:Zone object must have at
least two surfaces defined with AirflowNetwork:Multizone:Surface objects, so that air can flow from one
zone into other zones (or to outdoors) through the network (air mass flow conserved). In addition, for all
AirflowNetwork:Multizone:Surface objects facing the same Zone (ref. BuildingSurface:Detailed), at least

9/29/14

832

Input-Output Reference

Group Airflow Network

two different environments must be defined for the other side of these surfaces (e.g., an external node and
an adjacent zone, two adjacent zones, or two external nodes).

An IDF example is shown below:

AirflowNetwork:MultiZone:Zone,
RESISTIVE ZONE,
!Temperature,
!WindowVentSched,
!0.3,
!!5.0,
!!10.0,
!!0.0,
!!300000.0,
!!VentingSched;
!-

Name of Associated Thermal Zone

Ventilation Control Mode
Vent Temperature Schedule Name
Limit Value on Multiplier for Modulating Venting Open Factor
{dimensionless}
Lower Value on Inside/Outside Temperature Difference for
Modulating the Venting Open Factor {deltaC}
Upper Value on Inside/Outside Temperature Difference for
Modulating the Venting Open Factor {deltaC}
Lower Value on Inside/Outside Enthalpy Difference for Modulating
the Venting Open Factor {J/kg}
Upper Value on Inside/Outside Enthalpy Difference for Modulating
the Venting Open Factor {J/kg}
Venting Availability Schedule Name

AirflowNetwork:Multizone:Surface
The AirflowNetwork:Multizone:Surface object specifies the properties of a surface linkage
through which air flows. This linkage is always associated with a heat transfer surface (wall,
roof, floor, or a ceiling) or subsurface (door, glass door, or window) with both faces exposed
to air. The linkage specifies two connected nodes: two zone nodes defined in
AirflowNetwork:Multizone:Zone objects based on inside and outside face environment for an
interior surface, or a zone node defined in an AirflowNetwork:Multizone:Zone object based on
inside
face
environment
and
an
external
node
defined
in
an
AirflowNetwork:MultiZone:ExternalNode object for an exterior surface. The associated
leakage component for this surface can be a crack (or surface effective leakage area) in an
exterior or interior heat transfer surface or subsurface, or an exterior or interior window, door
or glass door (heat transfer subsurface) that can be opened to allow air flow. The allowed
surface air leakage components are:
AirflowNetwork:MultiZone:Surface:Crack
AirflowNetwork:MultiZone:Surface:EffectiveLeakageArea
AirflowNetwork:MultiZone:Component:DetailedOpening
AirflowNetwork:MultiZone:Component:HorizontalOpening
AirflowNetwork:MultiZone:Component:SimpleOpening
AirflowNetwork:MultiZone:Component:ZoneExhaustFan
The two opening components are used to modulate openness based on required
conditions.
The AirflowNetwork:Multizone:Surface object allows a heat transfer surface or subsurface to
have one crack (or one surface effective leakage area object), or a subsurface (i.e., window,
door or glass door) to have one opening (detailed or simple).
An interior heat transfer surface (BuildingSurface:Detailed) whose surface name is used as
the input for the Outside Boundary Condition Object field represents a floor without ground
contact and is not allowed as an AirflowNetwork:Multizone:Surface. A heat transfer surface
defined in the BuildingSurface:Detailed:ExteriorNaturalVentedCavity is also not allowed.
Field: Surface Name
This is the name of the corresponding surface (wall, roof, ceiling, floor, window, door or glass
door).

9/29/14

833

Input-Output Reference

Group Airflow Network

Information on this surface is used by the program as follows:

(1) For a linkage associated with an exterior heat transfer surface: air flow through this
linkage is between the outside environment and the thermal zone to which the surface
belongs.
(2) For a linkage associated with an interior (i.e., interzone) heat transfer surface: air flow
through this linkage is between the thermal zones separated by the surface (i.e., the
thermal zone associated with the inside face environment and the thermal zone
associated with the outside face environment).
(3) This heat transfer surface determines the height of the linkage, which is used in
calculating buoyancy-related flow through the linkage.
Note: It is possible to define an interzone surface twice in EnergyPlus, once in each of the zones that the
surface separates. Previously this was a requirement of EnergyPlus (prior to version 2.0), but now it is
optional and the user also has the option of only defining the surface once (EnergyPlus defines the second
surface automatically within the program). For each interzone surface, use only one (of possible two)
interzone surface names in the AirflowNetwork:Multizone:Surface object for Surface Name. Do not enter
two AirflowNetwork:Multizone:Surface objects corresponding to the two possible interzone names. This
would cause the air flow through the surface to be counted twice.

Field: Leakage Component Name

The name of the AirflowNetwork:MultiZone:Surface:Crack,
AirflowNetwork:MultiZone:Surface:EffectiveLeakageArea,
AirflowNetwork:MultiZone:Component:SimpleOpening,
AirflowNetwork:MultiZone:Component:HorizontalOpening,
AirflowNetwork:MultiZone:Component:DetailedOpening
or AirflowNetwork:MultiZone:Component:ZoneExhaustFan object associated with this air flow
linkage.
If
the
name
of
an
opening
component
(i.e.
AirflowNetwork:MultiZone:Component:DetailedOpening.
AirflowNetwork:MultiZone:Component:HorizontalOpening,
or
AirflowNetwork:MultiZone:Component:SimpleOpening is given here, then the Surface Name
in the previous field must be that of a window, door or glass door heat transfer subsurface.
Otherwise an error message will be reported.
If
the
name
of
an
AirflowNetwork:MultiZone:Surface:Crack
object
or
AirflowNetwork:MultiZone:Surface:EffectiveLeakageArea object is given here, the program
will position the crack at the average height of the associated heat transfer surface or
subsurface. The user can define multiple heat transfer surfaces (e.g., split a wall into several
surfaces) to be more precise in establishing the crack location. Similarly, the user can define
multiple heat transfer surfaces if a wall, for example, has multiple cracks or openings that
need to be defined individually.
If the name of an AirflowNetwork:MultiZone:Component:ZoneExhaustFan is given here, then
the Surface Name in the previous field must be that of an exterior heat transfer surface. The
zone name defined in the Zone Name field for this heat transfer surface must be the same
zone name defined in the ZoneHVAC:EquipmentConnections object (which references a
ZoneHVAC:EquipmentList containing the name of the corresponding zone exhaust fan).
Otherwise an error message will be reported. When this zone exhaust fan is operating for a
simulation timestep, all surface-level controls described below are ignored for that timestep.

9/29/14

834

Input-Output Reference

Group Airflow Network

Field: External Node Name

The name of the associated AirflowNetwork:MultiZone:ExternalNode object, which
determines the wind pressure coefficients for the heat transfer surface. Used only if Surface
Name is for an exterior surface.
If
Wind
Pressure
Coefficient
Type
=
SurfaceAverageCalculation
in
the
AirflowNetwork:SimulationControl object, this field is not used and a blank may be entered. If
the surface is an interior (i.e., interzone) surface, leave this field blank.
Field: Window/Door Opening Factor, or Crack Factor
If this linkage is associated with an AirflowNetwork:MultiZone:Component:DetailedOpening or
AirflowNetwork:MultiZone:Component:SimpleOpening object (which means it is an openable
window or door), then this field is called Window/Door Opening Factor and represents the
value of the Opening Factor that is in effect when the Vent Temperature Schedule (defined in
the AirflowNetwork:Multizone:Zone object) indicates that this window or door is open.
The AirflowNetwork model uses a combination of factors to determine the actual opening
area for a window or door when it is venting. For example, consider a window that is 1.5m
high
and
2.0m
wide
(excluding
frame).
Assume
that
the
AirflowNetwork:MultiZone:Component:DetailedOpening for this window has Type of Large
Vertical Opening = 1 (non-pivoting window), Height Factor = 0.5 and Width Factor = 0.8.
Then when the window is fully open, the opening area = height of opening (0.5x1.5) times
width of opening (0.8x2.0) = 0.75x1.6 = 1.2 m 2. If the Window/Door Opening Factor is 0.75,
then the opening area = 0.75x1.2 = 0.9 m2.
If, in addition, the window is in a thermal zone for which opening modulation has been
specified (ref: AirflowNetwork:Multizone:Zone) and the multiplication factor due to modulation
is 0.3 in a particular timestep, then the actual opening factor that timestep = 0.3x0.75 = 0.225
and the actual opening area that timestep = 0.3x0.9 = 0.27 m2.
If this linkage is associated with an AirflowNetwork:MultiZone:Surface:Crack object, the
following crack air flow equation is used.

Q (Crack Factor)*CT *CQ

Where
Q = air mass flow (kg/s)

CQ = air mass flow coefficient (kg/s @ 1 Pa)

CT
= reference condition temperature

correction

factor

(dimensionless).

See

AirflowNetwork:MultiZone:Surface:Crack object.

P = pressure difference across crack (Pa)

n

= air flow exponent (dimensionless)

The following fields control venting. They are used only when Name of Associated Heat Transfer
Surface is that of an openable exterior or interior window, door or glass door. They only apply to
openings, and do not apply to surface cracks, effective leakage area or zone exhaust fans. If none of
these fields is specified, or if Ventilation Control Mode = ZoneLevel, venting is controlled by the
AirflowNetwork:Multizone:Zone object for the thermal zone containing the window or door (ref:
AirflowNetwork:Multizone:Zone Data).

Field: Ventilation Control Mode

Specifies the type of surface-level natural ventilation control.
Let Tout equal the outdoor air temperature, Tzone equal the previous timesteps zone air
temperature, Tset equal the Vent Temperature Schedule value, Hzone equal the specific

9/29/14

835

Input-Output Reference

Group Airflow Network

enthalpy of zone air from the previous timestep, and Hout equal the specific enthalpy of
outdoor air. Then the four allowed choices for Ventilation Control Mode are:
NoVent: The openable window or door associated with this surface is closed at all times
independent of indoor or outdoor conditions. The Venting Availability Schedule is ignored in
this case.
Temperature: The openable window or door associated with this surface is opened if Tzone >
Tout and Tzone > Tset and Venting Availability Schedule (see below) allows venting.
Enthalpy: The openable window or door associated with this surface is opened if H zone >
Hout and Tzone > Tset and Venting Availability Schedule allows venting.
Constant: Whenever this objects Venting Availability Schedule allows venting, the openable
window or door associated with this surface is open, independent of indoor or outdoor
conditions. Note that Constant here means that the size of this opening is fixed while
venting; the air flow through this opening can, of course, vary from timestep to timestep.
ASHRAE55Adaptive: The openable window or door associated with this surface is opened if
the operative temperature is greater than the comfort temperature (central line) calculated
from the ASHRAE Standard 55-2010 adaptive comfort model and Venting Availability
Schedule allows venting.
CEN15251Adaptive: The openable window or door associated with this surface is opened if
the operative temperature is greater than the comfort temperature (central line) calculated
from the CEN15251 adaptive comfort model and Venting Availability Schedule allows
venting.
ZoneLevel: Venting of the window or door is not controlled individually, but is controlled
instead at the zone level. This means that the venting is determined by the
AirflowNetwork:Multizone:Zone object for the thermal zone containing the window or door
(ref: AirflowNetwork:Multizone:Zone object). This is the default value for this field.
AdjacentTemperature: This choice is used for an interior surface only. The openable interior
window or door associated with this surface is opened if Tzone > Tadjacent zone and Tzone >
Tset and Venting Availability Schedule (see below) allows venting, where T adjacent zone is
the adjacent zone temperature.
AdjacentEnthalpy: This choice is also used for an interior surface only. The interior
openable window or door associated with this surface is opened if Hzone > Hadjacent zone
and Tzone > Tset and Venting Availability Schedule allows venting, where Hadjacent zone is
the adjacent zone specific enthalpy.
Field: Ventilation Control Zone Temperature Setpoint Schedule Name
The name of a schedule of zone air temperature set points that controls the opening of a
window or door associated with this surface to provide natural ventilation. This setpoint is the
temperature above which this openable window or door will be opened if the conditions
described in the previous field Ventilation Control Mode are met.
The Ventilation Control Zone Temperature Setpoint Schedule applies only to a window or
door
attached
to
this
surface
that
is
specified
using
AirflowNetwork:MultiZone:Component:DetailedOpening
or
AirflowNetwork:MultiZone:Component:SimpleOpening.
(The discussion under the field Window/Door Opening Factor in this object describes how the
actual opening area of a window or door in a particular timestep is determined.)
Modulation of Openings

9/29/14

836

Input-Output Reference

Group Airflow Network

The following five fields can be used to modulate this window/door opening when Ventilation
Control Mode = Temperature or Enthalpy. These fields determine a factor between 0 and 1
that multiplies the opening factor of this window or door according to the control action shown
in Figure 96 for Ventilation Control Mode = Temperature and in Figure 97 for Ventilation
Control Mode = Enthalpy. Modulation of this opening can reduce the large temperature
swings that can occur if the window/door is open too far when it is venting, especially when
there is a large inside-outside temperature difference.
The modulation takes the following form when Ventilation Control Mode = Temperature:
Tzone - Tout
[Lower Value on Inside/Outside Temperature Difference for Modulating the Venting
Open Factor]
Multiplication factor = 1.0
[Lower Value on Inside/Outside Temperature Difference for Modulating the Venting Open Factor] <
Tzone - Tout < [Upper Value on Inside/Outside Temperature Difference for Modulating the Venting
Open Factor]
Multiplication factor varies linearly from 1.0 to [Limit Value on Multiplier for
Modulating Venting Open Factor]
Tzone - Tout
[Upper Value on Inside/Outside Temperature Difference for Modulating the Venting
Open Factor]
Multiplication factor = [Limit Value on Multiplier for Modulating Venting Open
Factor]

One way of tuning the following modulation control parameters is to perform a sensitivity
analysis for winter and/or summer design days to determine what combination of values
causes the biggest reduction in zone air temperature fluctuations due to venting.
Note that the default values for the following fields are such that, if none of the fields are
specified, modulation will not occur.
Field: Minimum Venting Open Factor
See Figure 96 or Figure 97. This field applies only if Ventilation Control Mode = Temperature
or Enthalpy. This value may be from zero to 1.0, with the default being 0.0.
Field: Indoor and Outdoor Temperature Difference Lower Limit For Maximum Venting
Open Factor
See Figure 96. This field applies only if Ventilation Control Mode = Temperature. This value
may be from zero to less than 100C, with the default being 0C. The value for this field must
be less than the value specified for the following field.
Field: Indoor and Outdoor Temperature Difference Upper Limit for Minimun Venting Open
Factor
See Figure 96. This field applies only if Ventilation Control Mode = Temperature. This value
must be greater than 0C, with the default being 100C. The value for this field must be
greater than the value specified for the previous field.
Field: Indoor and Outdoor Enthalpy Difference Lower Limit For Maximum Venting Open
Factor
See Figure 97. This field applies only if Ventilation Control Mode = Enthalpy. This value may
be from zero to less than 300,000 J/kg, with the default being 0 J/kg. The value for this field
must be less than the value specified for the following field.

9/29/14

837

Input-Output Reference

Group Airflow Network

Field: Indoor and Outdoor Enthalpy Difference Upper Limit for Minimun Venting Open
Factor
See Figure 97. This field applies only if Ventilation Control Mode = Enthalpy. This value must
be greater than zero, with the default being 300,000 J/kg. The value for this field must be
greater than the value specified for the previous field.
Field: Venting Availability Schedule Name
The name of a schedule that specifies when venting is available. A zero or negative schedule
value means venting is not allowed. A value greater than zero means venting can occur if
other venting control conditions (specified by Ventilation Control Mode and Vent Temperature
Schedule Name) are satisfied. This schedule name should not be confused with Vent
Temperature Schedule Name.
If a Venting Availability Schedule Name is not specified, it is assumed that venting is always
available.
Using Venting Availability Schedule allows you to turn off venting at certain times of the day
(at night, for example), week (on weekends, for example), or year (during the winter, for
example).
If used with Ventilation Control Mode = Constant, the ventilation rate is constant only when
this schedule allows venting; otherwise the ventilation rate is set to zero.
If Ventilation Control Mode = NoVent, this schedule has no effect.
Note: In order to establish an airflow network, each AirflowNetwork:Multizone:Zone object must have at
least two surfaces defined with AirflowNetwork:Multizone:Surface objects, so that air can flow from one
zone into other zones (or to outdoors) through the network (air mass flow conserved). In addition, for all
AirflowNetwork:Multizone:Surface objects facing the same Zone Name (ref. BuildingSurface:Detailed), at
least two different environments must be defined for the other side of these surfaces (e.g., an external
node and an adjacent zone, two adjacent zones, or two external nodes).

IDF examples are provided below:

AirflowNetwork:MultiZone:Surface,
Zn001:Wall001,
!- Name of Associated Heat Transfer Surface
CR-1,
!- Leakage Component Name
SFacade,
!- External Node Name
1.0;
!- Window/Door Opening Factor, or Crack Factor {dimensionless}
AirflowNetwork:MultiZone:Surface,
Zn001:Wall001:Win001,
!- Name of Associated Heat Transfer Surface
WiOpen1,
!- Leakage Component Name
SFacade,
!- External Node Name
0.5;
!- Window/Door Opening Factor, or Crack Factor {dimensionless}

9/29/14

838

Input-Output Reference

Group Airflow Network

AirflowNetwork:MultiZone:Surface,
Zn003:Wall003,
!- Name of Associated Heat Transfer Surface
Zone3 Exhaust Fan,
!- Leakage Component Name
EFacade,
!- External Node Name
1.0;
!- Window/Door Opening Factor, or Crack Factor {dimensionless}
AirflowNetwork:MultiZone:Surface,
Zn001:Wall001:Win002,
!- Name of Associated Heat Transfer Surface
WiOpen2,
!- Leakage Component Name
WFacade,
!- External Node Name
0.5;
!- Window/Door Opening Factor, or Crack Factor {dimensionless}
Temperature,
!- Ventilation Control Mode
WindowVentSched,
!- Vent Temperature Schedule Name
0.3,
!- Limit Value on Multiplier for Modulating Venting Open Factor
!- {dimensionless}
5.0,
!- Lower Value on Inside/Outside Temperature Difference for
!- Modulating the Venting Open Factor {deltaC}
10.0,
!- Upper Value on Inside/Outside Temperature Difference for
!- Modulating the Venting Open Factor {deltaC}
0.0,
!- Lower Value on Inside/Outside Enthalpy Difference for Modulating
!- the Venting Open Factor {J/kg}
300000.0,
!- Upper Value on Inside/Outside Enthalpy Difference for Modulating
!- the Venting Open Factor {J/kg}
VentingSched;
!- Venting Availability Schedule Name

AirflowNetwork:MultiZone:ReferenceCrackConditions
This object specifies the reference conditions for temperature, humidity, and pressure which
correspond to the AirflowNetwork:MultiZone:Surface:Crack object.
Field: Name
The name of this Reference Crack Conditons object. This name is referenced by an
AirflowNetwork:MultiZone:Surface:Crack object.
Field: Reference Temperature
The reference temperature in C under which the Surface Crack Data were obtained. The
default value is 20C.
Field: Reference Barometric Pressure
The reference barometric pressure in Pa under which the Surface Crack Data were obtained.
The default value is 101325 Pa.
Field: Reference Humidity Ratio
The reference humidity ratio in kgWater/kgDryAir under which the Surface Crack Data were
obtained. The default value is 0 kgWater/kgDryAir.
An IDF example is provided below:
AirflowNetwork:MultiZone:ReferenceCrackConditions,
ReferenceCrackConditions,
!- Name of Reference Crack Conditions
20.0,
!- Reference Temperature for Crack Data {C}
101325,
!- Reference Barometric Pressure for Crack Data {Pa}
0.0;
!- Reference Humidity Ratio for Crack Data {kgWater/kgDryAir}

AirflowNetwork:MultiZone:Surface:Crack
This object specifies the properties of air flow through a crack and the associated
measurement conditions. The following power law form is used that gives air flow through the
crack as a function of the pressure difference across the crack:

Q (Crack Factor)*CT *CQ

Where

Q = air mass flow (kg/s)

9/29/14

839

Input-Output Reference

Group Airflow Network

CQ = air mass flow coefficient (kg/s-Pan @ 1 Pa)

CT = reference condition temperature correction factor (dimensionless)

P = pressure difference across crack (Pa)

n

= air flow exponent (dimensionless)

n 1

CT

2n 1
o

where
= Air density at the specific air temperature and humidity ratio conditions [kg/m 3]
= Air kinetic viscosity at the specific air temperature condition [m2/s]
o = Air density at the reference air conditions provided by the
AirflowNetwork:MultiZone:ReferenceCrackConditions specified in the field Reference
Conditions [kg/m3]
o = Air kinetic viscosity at the reference air temperature provided by the
AirflowNetwork:MultiZone:ReferenceCrackConditions specified in the field Reference
Conditions [m2/s]

object
Crack
object
Crack

Note: The correction factor shown above is use for this particular component as specified.

Field: Name
This is a name for this AirflowNetwork:MultiZone:Surface:Crack object. It is referenced by an
AirflowNetwork:Multizone:Surface object.
Field: Air Mass Flow Coefficient at Reference Conditions
The value of the air mass flow coefficient, CQ , in the crack air flow equation. It has units of
kg/s at 1Pa. This value must be greater than zero.
Field: Air Mass Flow Exponent
The value of the exponent, n, in the crack air flow equation. The valid range is 0.5 to 1.0, with
the default value being 0.65.
Field: Reference Crack Conditions
The name of the AirflowNetwork:MultiZone:ReferenceCrackConditions object which specifies
the conditions under which the air mass flow coefficient was measured. If the user omits this
field and only one AirflowNetwork:MultiZone:ReferenceCrackConditions object is defined in
the input data file, then those reference crack conditions will be used. If the user omits this
field and either zero or more than one AirflowNetwork:MultiZone:ReferenceCrackConditions
objects are defined in the input data file, then the default conditions for the
AirflowNetwork:Multizone: Reference Crack Conditions object will be used.
An IDF example is shown below:
AirflowNetwork:MultiZone:Surface:Crack,
CR-1,
!- Name of Surface Crack Component
0.01,
!- Air Mass Flow Coefficient at Reference Conditions {kg/s}
0.667,
!- Air Mass Flow Exponent {dimensionless}
ReferenceCrackConditions; !- Reference Crack Conditions

AirflowNetwork:MultiZone:Surface:EffectiveLeakageArea
The effective leakage area (ELA) object is used to define surface air leakage. It has
9/29/14

840

Input-Output Reference

Group Airflow Network

five fields. The relationship between pressure and airflow may be expressed as:

ELA * Cd 2 *

Pr

0.5 n

where

= Air mass flow rate [kg/s]

ELA = Effective leakage area [m2]

= Air density [kg/m3]

Pr = Reference pressure difference [Pa]

P = Pressure difference across this component [Pa]
Cd
n

= Discharge coefficient [dimensionless]

= Air mass flow exponent [dimensionless]

Field: Name
This is a name for this AirflowNetwork:MultiZone:Surface:EffectiveLeakageArea object. It is
referenced by an AirflowNetwork:Multizone:Surface object.
Field: Effective Leakage Area
This numeric field is used to input the effective leakage area in square meters. The effective
leakage area is used to characterize openings for infiltration calculations (ASHRAE
Handbook of Fundamentals, 1997, pp 25.18). This value must be greater than zero.
Field: Discharge Coefficient
This numeric field is used to input the discharge coefficient. This value must be greater than
zero, with a default value of 1.0.
Field: Reference Pressure Difference
This numeric field is used to input the reference pressure difference [Pa]. This value must be
greater than zero, with a default value of 4.0 Pa.
Field: Air Mass Flow Exponent
This numeric field is used to input the pressure difference exponent. The valid range of the
exponent is from 0.5 to 1.0, with a default value of 0.65.
Note: There are two common sets of reference conditions: Cd = 1.0 and P = 4 Pa, or Cd = 0.6 and P =
10 Pa

An IDF example is shown below:

AirflowNetwork:MultiZone:Surface:EffectiveLeakageArea,
SurfaceELR,
!- Name of surface effective leakage area component
0.07,
!- Effective leakage area {dimensionless}
1.00,
!- Discharge coefficient {dimensionless}
4.0,
!- Reference pressure difference {Pa}
0.65;
!- Air mass flow exponent {dimensionless}

AirflowNetwork:MultiZone:Component:DetailedOpening
This object specifies the properties of air flow through windows and doors (window, door and
glass door heat transfer subsurfaces) when they are closed or open. The fields are similar to
those for AirflowNetwork:Multizone:SurfaceCrack object when the window or door is closed,
but additional fields are required to describe the air flow characteristics when the window or
9/29/14

841

Input-Output Reference

Group Airflow Network

door is open. These additional fields include opening type, opening dimensions, degree of
opening, and opening schedule.
The AirflowNetwork model assumes that open windows or doors are vertical or close to
vertical; for this reason they are called Large Vertical Openings. Such openings can have
air flow moving simultaneously in two different directions depending on stack effects and wind
conditions (for example, flow from inside to outside at the top of a window and from outside to
inside at the bottom). AirflowNetwork models such two-directional flow, but only for vertical
openings.
It is assumed that the air flow through a window opening is unaffected by the presence of a
shading device such as a shade or blind on the window. Also, the calculation of conductive
heat transfer and solar gain through a window or door assumes that the window or door is
closed.
The AirflowNetwork model does not have a model for bi-directional flow through large
horizontal
openings.
For
this
reason,
AirflowNetwork:MultiZone:Component:DetailedOpening should not be used for
horizontal openings. The best modeling technique in this case is to put an
AirflowNetwork:MultiZone:Surface:Crack object in a horizontal surface and use a large air
mass flow coefficient. Crack flow is assumed to be uni-directional in any given timestep (but
can reverse flow direction from timestep to timestep).
A subsurface multiplier may be used to represent multiple subsurfaces and calculates total air
flow when the subsurface (window, glassdoor, or door) is either closed or open. The total
airflow across the surface is equal to the airflow based on the surface geometry multiplied by
the subsurface multiplier.
Field: Name
The name of this AirflowNetwork:MultiZone:Component:DetailedOpening object. It is
referenced by an AirflowNetwork:Multizone:Surface object.
Field: Air Mass Flow Coefficient When Opening is Closed
Crack flow is assumed when the window or door is closed. The units for this air mass flow
coefficient ( CQ , unit length ) are different from the units for CQ (kg/s at 1 Pa pressure difference)
defined in an AirflowNetwork:MultiZone:Surface:Crack object. There is no default but the
entered value must be greater than zero. The program will automatically generate four cracks
around the perimeter of the window or door--one along the bottom, one along the top, and
one
on
each
side.
The
temperature
correction
factor
used
in
the
AirflowNetwork:MultiZone:Surface:Crack object is not used for this component to calculate air
mass flow rate.
Field: Air Mass Flow Exponent When Opening Is Closed
Crack flow is assumed when the window or door is closed. In this case, the value of this field
is the exponent, n, in the crack air flow equation. The valid range for this exponent is 0.5 to
1.0, with the default value being 0.65.
Field: Type of Rectanguler Large Vertical Opening (LVO)
This alpha field specifies the type of rectangular window or door. (Open windows or doors are
also called Large Vertical Openings (LVOs). The choices for the opening type are
NonPivoted (LVO Type 1) and HorizontallyPivoted (LVO Type 2) with the default being
NonPivoted. The NonPivoted type represents a regular window or door. The
HorizontallyPivoted type represents a window with a horizontal axis ((i.e., a horizontallypivoting window) and cannot be used for a door.
Field: Extra Crack Length or Height of Pivoting Axis
Specifies window or door characteristics that depend on the LVO type.

9/29/14

842

Input-Output Reference

Group Airflow Network

For LVO Type 1 (rectangular non-pivoted windows and doors) this field is the extra crack
length in meters due to multiple openable parts, if present. Extra here means in addition to
the length, calculated by the program, of the cracks on the top, bottom and sides of the
window/door.
For LVO Type 2 (rectangular horizontally-pivoted windows) this field gives the height of the
pivoting axis measured from the bottom of the glazed part of the window (m).
Field: Number of Sets of Opening Factor Data
This is the number of the following sets of data for opening factor, discharge coefficient, width
factor, height factor, and start height factor. From two to four of these sets must be defined.
The first set should be for Opening Factor = 0.0 and the last set should be for Opening Factor
= 1.0. For example, if only two sets are defined, the first set should be for Opening Factor =
0.0 and the second set should be for Opening Factor = 1.0, as shown below in the IDF
example below.
An opening factor refers to the amount that a window or door is opened. The program
linearly interpolates each timestep between the values of discharge coefficient, width factor,
etc., in these sets using the opening factor for the window or door for the timestep. (See
discussion
under
the
field
Window/Door
Opening
Factor
in
the
AirflowNetwork:Multizone:Zone object for a description of how the AirflowNetwork model
determines the time-step value of the opening factor.)
Field Group: Opening Factor, Discharge Coefficient, Width Factor, Height Factor, Start
Height Factor
Each field is described for as many groups as required in the previous field (number of sets of
opening factor data). As the final field has specific requirements, this field (n) will be
described.
Field: Opening Factor 11
The first opening factor of a window or door. This value must be 0.0. The default value is also
0.0.
For LVO Type 1 (rectangular non-pivoted window or door), the Opening Factor corresponds
to the fraction of window or door that is opened.
For LVO Type 2 (rectangular horizontally-pivoted windows), the Opening Factor is
determined by the window opening angle. For example, an opening angle of 45 corresponds
to an Opening Factor of 0.50 since the maximum opening angle is 90.
Field: Discharge Coefficient for Opening Factor 1
The discharge coefficient of the window or door for Opening Factor 1. The range is greater
than 0.0 to less than or equal to 1.0. The default value is 0.001. The Discharge Coefficient
indicates the fractional effectiveness for air flow through a window or door at that Opening
Factor.
Note: In the following, window width and window height are glazing dimensions; they do not include the
frame, if present.

Field: Width Factor for Opening Factor 1

The Width Factor of the rectangular window or door for Opening Factor 1. The Width Factor
is the opening width divided by the window or door width (see Figure 98). The range is 0.0 to
1.0. The default value is 0.0. Note that the width factor applies to rectangular windows or
doors where the width is assumed constant along the entire height of the opening.

9/29/14

843

Input-Output Reference

Group Airflow Network

Field: Height Factor for Opening Factor 1

The Height Factor of the rectangular window or door for Opening Factor 1. The Height Factor
is the opening height divided by the window or door height (see Figure 98). The range is 0.0
to 1.0. The default value is 0.0. Note that the height factor applies to rectangular windows or
doors where the height is assumed constant along the entire width of the opening.
Field: Start Height Factor for Opening Factor 1
The Start Height Factor of the window or door for Opening Factor 1. The Start Height Factor
is the Start Height divided by the window or door height (see Figure 98). The range is 0.0 to
1.0. The default is 0. Start Height is the distance between the bottom of the window or door
and the bottom of the window or door opening. The sum of the Height Factor and the Start
Height Factor must be less than 1.0 in order to have the opening within the window or door
dimensions.

Window (or door)

Window
height

Opening

Opening width

Opening
height

Opening Width
Window Width
Opening Height
Height Factor
Window Height
Start Height
Start Height Factor
Window Height

Width Factor

Start
height

Window width

Figure 98. Window (or door) showing geometrical factors associated with an opening through which air
flows.
Field: Opening Factor <n>
When Number of Sets of Opening Factor Data = n, the value of Opening Factor n must be set
to 1.0.
Field: Discharge Coefficient for Opening Factor <n>
The discharge coefficient of the window or door for Opening Factor n. The range is greater
than 0.0 to less than or equal to 1.0. The default value is 1.0.
Field: Width Factor for Opening Factor <n>
The Width Factor of the rectangular window or door for Opening Factor n. The Width Factor
is the opening width divided by the window or door width (see Figure 98). The range is 0.0 to
1.0. The default value is 1.0.
Field: Height Factor for Opening Factor <n>
The Height Factor of the rectangular window or door for Opening Factor n. The Height Factor
is the opening height divided by the window or door height (see Figure 98). The range is 0.0
to 1.0. The default value is 1.0.
9/29/14

844

Input-Output Reference

Group Airflow Network

Field: Start Height Factor for Opening Factor <n>

The Start Height Factor of the window or door for Opening Factor n. The Start Height Factor
is the Start Height divided by the window or door height (see Figure 98). The range is 0.0 to
1.0. The default is 0.
When the opening factor value (as described under the field Window/Door Opening Factor in
the AirflowNetwork:Multizone:Surface object) is between two Opening Factor field values, the
values of Discharge Coefficient, Width Factor, Height Factor, and Start Height Factor are
linearly interpolated.
An IDF example is shown below:
AirflowNetwork:MultiZone:Component:DetailedOpening,
WiOpen1,
!- Detailed Opening Name
0.001,
!- Air Mass Flow Coefficient When Opening is Closed {kg/s-m}
0.667,
!- Air Mass Flow Exponent When Opening is Closed {dimensionless}
NonPivoted,
!- Type of Large Vertical Opening (LVO)
0.0,
!- Extra crack length for LVO type 1 with multiple openable parts,
!- or Height of pivoting axis for LVO type 2 {m}
2,
!- Number of Sets of Opening Factor Data
0.0,
!- Opening factor 1 {dimensionless}
0.5,
!- Discharge coefficient for opening factor 1 {dimensionless}
0.0,
!- Width factor for opening factor 1 {dimensionless}
1.0,
!- Height factor for opening factor 1 {dimensionless}
0.0,
!- Start height factor for opening factor 1 {dimensionless}
1.0, 0.6, 1.0, 1.0, 0.0; !- Set of values for opening factor 2

AirflowNetwork:MultiZone:Component:HorizontalOpening
This object specifies the properties of air flow through windows, doors and glass doors (heat
transfer subsurfaces defined as a subset of FenestrationSurface:Detailed objects) when they
are closed or open. This AirflowNetwork model assumes that these openings are horizontal
or close to horizontal and are interzone surfaces. The second and third input fields are similar
to those for AirflowNetwork:MultiZone:Surface:Crack, when the window or door is closed, but
additional information is required to describe the air flow characteristics when the window or
door is open. This additional information is specified in the last two input fields. The airflow
across the opening consists of two types of flows: forced and buoyancy. The forced flow is
caused by the pressure difference between two zones, while the buoyancy flow only occurs
when the air density in the upper zone is greater than the air density in the lower zone. This
opening also allows for the possibility of two-way flow when forced and buoyancy flows coexist. This objects openness can also be modulated based on the same opening factor
control as an AirflowNetwork:MultiZone:Component:DetailedOpening object. However, the
opening factor is only applied to the subsurface width. The opening width is equal to opening
factor multiplied by the subsurface width.
A subsurface multiplier may be used to represent multiple subsurfaces and calculates total air
flow when the subsurface (window, glassdoor, or door) is either closed or open. The total
airflow across the surface is equal to the airflow based on the surface geometry multiplied by
the subsurface multiplier.
Field: Name
This is a name for this AirflowNetwork:MultiZone:Component:HorizontalOpening object. It is
referenced by an AirflowNetwork:Multizone:Surface object.
Field: Air Mass Flow Coefficient When Opening is Closed
The value of the air mass flow coefficient, CQ , unit length , in the horizontal opening air flow
equation. It has units of kg/s-m at 1Pa. The temperature correction factor is not applied to the
mass flow calculation. This is a required input field and the entered value must be greater
than zero.

9/29/14

845

Input-Output Reference

Group Airflow Network

Field: Air Mass Flow Exponent When Opening is Closed

The value of the exponent, n, in the crack air flow equation. The valid range is 0.5 to 1.0, with
the default value being 0.65.
Field: Sloping Plane Angle
This numeric field is used to represent the angle between the horizontal plane and a sloped
plane under the horizontal opening. Sloping plane angle = 90 is equivalent to fully open. The
valid range is >0 to 90, with the default value being 90.
Field: Discharge Coefficient
This numeric field is used to input the discharge coefficient. This is a required field and the
entered value must be greater than zero.
An IDF example is shown below:
AirflowNetwork:MultiZone:Component:HorizontalOpening,
HrOpen,
!- Name
0.001,
!- Air Mass Flow Coefficient When Opening is Closed {kg/s-m}
0.667,
!- Air Mass Flow Exponent When Opening is Closed {dimensionless}
90.0,
!- Sloping Plane Angle
0.2;
!- Discharge Coefficient

AirflowNetwork:MultiZone:Component:SimpleOpening
This object specifies the properties of air flow through windows, doors and glass doors (heat
transfer subsurfaces) when they are closed or open. The AirflowNetwork model assumes that
open windows or doors are vertical or close to vertical. The second and third fields are similar
to those for AirflowNetwork:MultiZone:Surface:Crack, when the window or door is closed, but
additional information is required to describe the air flow characteristics when the window or
door is open. This additional information is specified in the last two fields. Compared to the
object AirflowNetwork:MultiZone:Component:DetailedOpening, which requires more inputs at
different opening factors, this object needs comparatively less inputs. For this reason it is
called a simple opening. This opening also allows for the possibility of two-way flow due to
temperature and resulting density differences. Therefore, it is possible to have a positive
pressure difference at the top of the opening, and a negative pressure difference at the
bottom (or vice versa) when the neutral height is between the bottom and top heights of the
associated surface. This objects openness can also be modulated based on the same
opening factor control as an AirflowNetwork:MultiZone:Component:DetailedOpening object.
However, the opening factor is only applied to the subsurface width. The opening width is
equal to opening factor multiplied by the subsurface width.
A subsurface multiplier may be used to represent multiple subsurfaces and calculates total air
flow when the subsurface (window, glassdoor, or door) is either closed or open. The total
airflow across the surface is equal to the airflow based on the surface geometry multiplied by
the subsurface multiplier.
Field: Name
This is a name for this AirflowNetwork:MultiZone:Component:SimpleOpening object. It is
referenced by an AirflowNetwork:Multizone:Surface object.
Field: Air Mass Flow Coefficient When Opening is Closed
The value of the air mass flow coefficient, CQ , unit length , in the simple opening air flow
equation. It has units of kg/s-m at 1Pa. The temperature correction factor is not applied for
mass flow calculation.

9/29/14

846

Input-Output Reference

Group Airflow Network

Field: Air Mass Flow Exponent When Opening is Closed

The value of the exponent, n, in the crack air flow equation. The valid range is 0.5 to 1.0, with
the default value being 0.65.
Field: Minimum Density Difference for Two-Way Flow
This numeric field is used to input the minimum density difference above which two-way or
one way flow may occur due to stack effect with the window being open. Two-way flow
occurs only when the neutral plane is within the opening. Density differences less than this
value result in one-way flow only with the window being closed. The minimum value for this
field is greater than zero.
Field: Discharge Coefficient
This numeric field is used to input the discharge coefficient. This value must be greater than
zero.
An IDF example is shown below:
AirflowNetwork:MultiZone:Component:SimpleOpening,
WiOpen2,
!- Simple Opening Name
0.001,
!- Air Mass Flow Coefficient When Opening Is Closed {kg/s-m}
0.650,
!- Air Mass Flow Exponent When Opening Is Closed {dimensionless}
0.0001,
!- Minimum density difference for two-way flow (kg/m3)
1.0;
!- Discharge coefficient (dimensionless)

AirflowNetwork:MultiZone:Component:ZoneExhaustFan
This object specifies the properties of air flow through an exterior heat transfer surface with a
zone exhaust fan. The zone exhaust fan turns on or off based on the availability schedule
defined in the corresponding Fan:ZoneExhaust object. When the exhaust fan mass flow rate
is greater than zero, the airflow network model treats this object as a constant volume fan.
When the fan is off based on the availability schedule, the model treats this object as a crack.
When the fan is on, the air mass flow rate modeled for the airflow network is based on the
value defined in the Maximum Flow Rate field of the Fan:ZoneExhaust object. The airflow
direction is from the corresponding zone to outdoors.
When the fan is off, the following power law form is used that gives air flow through the crack
as a function of the pressure difference across the crack:

Q (Crack Factor)*CT *CQ

Where

Q = air mass flow (kg/s)

CQ = air mass flow coefficient (kg/s-Pan @ 1 Pa)
CT = reference condition temperature correction factor (dimensionless)

P = pressure difference across crack (Pa)

n

= air flow exponent (dimensionless)

n 1

CT

2n 1
o

where
= Air density at the specific air temperature and humidity ratio conditions [kg/m 3]
= Air kinetic viscosity at the specific air temperature condition [m2/s]
9/29/14

847

Input-Output Reference

Group Airflow Network

o = Air density at the reference air conditions provided by the

AirflowNetwork:MultiZone:ReferenceCrackConditions specified in the field Reference
Conditions [kg/m3]
o = Air kinetic viscosity at the reference air temperature provided by the
AirflowNetwork:MultiZone:ReferenceCrackConditions specified in the field Reference
Conditions [m2/s]

object
Crack
object
Crack

Note: The correction factor shown above is used when the exhaust fan is off. The airflow direction is based
on the pressure difference between the zone and outdoors.

Field: Name
This
is
the
name
for
this
instance
of
the
AirflowNetwork:MultiZone:Component:ZoneExhaustFan object. This name must be the same
name defined in the Fan:ZoneExhaust object. It is referenced by an
AirflowNetwork:Multizone:Surface object.
Field: Air Mass Flow Coefficient When the Zone Exhaust Fan is Off at Reference
Conditions
The value of the air mass flow coefficient, CQ , in the crack air flow equation. It has units of
kg/s at 1Pa. This value must be greater than zero. The value is used when the fan is off.
Field: Air Mass Flow Exponent When the Zone Exhaust Fan is Off
The value of the exponent, n, in the crack air flow equation. The valid range is 0.5 to 1.0, with
the default value being 0.65. The value is used when the fan is off.
Field: Reference Crack Conditions
The name of the AirflowNetwork:MultiZone:ReferenceCrackConditions object which specifies
the conditions under which the air mass flow coefficient was measured. If the user omits this
field and only one AirflowNetwork:MultiZone:ReferenceCrackConditions object is defined in
the input data file, then those reference crack conditions will be used. If the user omits this
field and either zero or more than one AirflowNetwork:MultiZone:ReferenceCrackConditions
objects are defined in the input data file, then the default conditions for the
AirflowNetwork:Multizone: Reference Crack Conditions object will be used.
An IDF example is shown below:
AirflowNetwork:MultiZone:Component:ZoneExhaustFan,
Zone3 Exhaust Fan,
!- Name
0.01,
!- Air Mass Flow Coefficient When the Zone Exhaust Fan is Off at Reference Conditions {kg/s}
0.667;
!- Air Mass Flow Exponent When the Zone Exhaust Fan is Off{dimensionless}
ReferenceCrackConditions; !- Reference Crack Conditions

AirflowNetwork:MultiZone:ExternalNode
External nodes in the AirflowNetwork model define environmental conditions outside of the
building. These conditions include wind pressure coefficients that vary from faade to faade
and can be highly dependent on the building geometry.
AirflowNetwork:MultiZone:ExternalNode objects do not have to be entered if Wind Pressure
Coefficient Type = SurfaceAverageCalculation in the AirflowNetwork:SimulationControl
object.
Field: Name
The external node name is associated with a particular building faade. This name is
referenced
by
the
External
Node
Name
field
of
an
AirflowNetwork:MultiZone:WindPressureCoefficientValues object (which gives wind pressure
9/29/14

848

Input-Output Reference

Group Airflow Network

coefficients for the faade as a function of angle of wind incident on the faade) and by the
External Node Name field of an AirflowNetwork:MultiZone:Surface object.
Field: External Node Height
Designates the reference height, in meters, used to calculate relative pressure. The default
value is 0 meters.
Field: Wind Pressure Coefficient Values Object Name
The name of a specific AirflowNetwork:MultiZone:WindPressureCoefficientValues object
(which gives wind pressure coefficients for the faade as a function of angle of wind incident
on the faade).
IDF examples are provided below:
AirflowNetwork:MultiZone:ExternalNode,
NFacade,
!- Name
1.524,
!- External Node Height {m}
NFacade_WPCValue;
!- Wind Pressure Coefficient Values Object Name
AirflowNetwork:MultiZone:ExternalNode,
EFacade,
!- Name
1.524,
!- External Node Height {m}
EFacade_WPCValue;
!- Wind Pressure Coefficient Values Object Name
AirflowNetwork:MultiZone:ExternalNode,
SFacade,
!- Name
1.524,
!- External Node Height {m}
SFacade_WPCValue;
!- Wind Pressure Coefficient Values Object Name
AirflowNetwork:MultiZone:ExternalNode,
WFacade,
!- Name
1.524,
!- External Node Height {m}
WFacade_WPCValue;
!- Wind Pressure Coefficient Values Object Name
AirflowNetwork:MultiZone:ExternalNode,
Horizontal,
!- Name
3.028,
!- External Node Height {m}
Horizontal_WPCValue;
!- Wind Pressure Coefficient Values Object Name

AirflowNetwork:MultiZone:WindPressureCoefficientArray
The reference height and wind directions are first specified under the
AirflowNetwork:MultiZone:WindPressureCoefficientArray object. The user may specify up to
36 different wind directions in ascending order. These are then referenced by
AirflowNetwork:MultiZone:WindPressureCoefficientValues
objects defined
for each
AirflowNetwork:MultiZone:ExternalNode.
The AirflowNetwork:MultiZone:WindPressureCoefficientArray object is unique and needs to
be entered only if Wind Pressure Coefficient Type = INPUT in the
AirflowNetwork:SimulationControl object. If Wind Pressure Coefficient Type =
SurfaceAverageCalculation, this object is not required.
Field: Name
The name of this AirflowNetwork:MultiZone:WindPressureCoefficientArray object. This name
is referenced by each AirflowNetwork:MultiZone:WindPressureCoefficientValues object
which, for each AirflowNetwork:MultiZone:ExternalNode, gives the wind pressure coefficients
at
each
of
the
wind
directions
listed
in
the
AirflowNetwork:MultiZone:WindPressureCoefficientArray. This name is also referenced by
the
AirflowNetwork:SimulationControl
object,
indicating
that
this
AirflowNetwork:MultiZone:WindPressureCoefficientArray and the pressure coefficients in the

9/29/14

849

Input-Output Reference

Group Airflow Network

associated AirflowNetwork:MultiZone:WindPressureCoefficientValues objects will be used in

the air flow simulation.
Field: Wind Direction 1-Wind Direction N
Each field references the wind direction corresponding to the first through the Nth WPC value
in each of the AirflowNetwork:MultiZone:WindPressureCoefficientValues objects. N can be as
high as 36.
An IDF example is provided below:
AirflowNetwork:MultiZone:WindPressureCoefficientArray,
Every 30 Degrees,
!- WPC Array Name
0,
!- Wind Direction #1 {deg}
30,
!- Wind Direction #2 {deg}
60,
!- Wind Direction #3 {deg}
90,
!- Wind Direction #4 {deg}
120,
!- Wind Direction #5 {deg}
150,
!- Wind Direction #6 {deg}
180,
!- Wind Direction #7 {deg}
210,
!- Wind Direction #8 {deg}
240,
!- Wind Direction #9 {deg}
270,
!- Wind Direction #10 {deg}
300,
!- Wind Direction #11 {deg}
330;
!- Wind Direction #12 {deg}

AirflowNetwork:MultiZone:WindPressureCoefficientValues
This object specifies up to 36 wind pressure coefficients (WPCs) for an
AirflowNetwork:MultiZone:ExternalNode. These coefficients are defined for each of the wind
directions defined in the unique AirflowNetwork:MultiZone:WindPressureCoefficientArray
object. In the air flow calculation, interpolation of the specified WPC values is done for timestep values of wind direction.
AirflowNetwork:MultiZone:WindPressureCoefficientValues objects need to be entered only if
the Wind Pressure Coefficient Type = INPUT in the AirflowNetwork:SimulationControl object.
If Wind Pressure Coefficient Type = SurfaceAverageCalculation, this object is not required
and is not used.
Field: Name
The name of this WindPressureCoefficientValues object. This name can be referenced by
multiple AirflowNetwork:MultiZone:ExternalNode objects.
Field: WindPressureCoefficientArray Name
Name of the associated AirflowNetwork:MultiZone:WindPressureCoefficientArray, which lists
the wind direction corresponding to each wind pressure coefficient value in this
AirflowNetwork:MultiZone:WindPressureCoefficientValues object.
Field: Wind Pressure Coefficient Value 1 to Wind Pressure Coefficient Value N
The WPC (wind pressure coefficient) value for the building faade indicated by the External
Node Name field above. This WPC value corresponds to the first wind direction in the
AirflowNetwork:MultiZone:WindPressureCoefficientArray. Note that WPC values can be
positive, negative or zero.
Obtaining WPC values
WPC values can be obtained from wind tunnel measurements, CFD calculations, or from
published values for different building shapes.
For rectangular buildings EnergyPlus will automatically calculate surface-averaged Cp
values for the walls and roof of the building if you specify Wind Pressure Coefficient Type =

9/29/14

850

Input-Output Reference

Group Airflow Network

SurfaceAverageCalculation in the AirflowNetwork:SimulationControl object. In this case you

do not have to enter any AirflowNetwork:MultiZone:WindPressureCoefficientValues objects.
Wind pressure coefficients are reported in the eplusout.eio either from inputs using INPUT
as the choice for the Wind Pressure Coefficient Type field defined in the
AirflowNetwork:SimulationControl object, or from internal calculation using
SurfaceAverageCalculation as the choice for the Wind Pressure Coefficient Type field
defined in the same object. Below is an output example from the eplusout.eio file:
AirflowNetwork Model:Wind Direction, 0.0,30.0,60.0,90.0,120.0,150.0,180.0,210.0,240.0,270.0,300.0,330.0
! <AirflowNetwork Model:Wind Pressure Coefficients, WPC Name, Wind Pressure Coefficients #1 to n
(dimensionless)>
AirflowNetwork Model:Wind Pressure Coefficients, NFACADE, 0.60,0.48,4.00E-002,-0.56,-0.56,-0.42,-0.37,0.42,-0.56,-0.56,4.00E-002,0.48
AirflowNetwork Model:Wind Pressure Coefficients, EFACADE, -0.56,4.00E-002,0.48,0.60,0.48,4.00E-002,-0.56,0.56,-0.42,-0.37,-0.42,-0.56
AirflowNetwork Model:Wind Pressure Coefficients, SFACADE, -0.37,-0.42,-0.56,-0.56,4.00E002,0.48,0.60,0.48,4.00E-002,-0.56,-0.56,-0.42
AirflowNetwork Model:Wind Pressure Coefficients, WFACADE, -0.56,-0.56,-0.42,-0.37,-0.42,-0.56,-0.56,4.00E002,0.48,0.60,0.48,4.00E-002

An IDF example is provided below:

AirflowNetwork:MultiZone:WindPressureCoefficientValues,
NFacade_WPCValue,
!- Name
Every 30 Degrees,
!- AirflowNetwork:MultiZone:WindPressureCoefficientArray Name
0.60,
!- Wind Pressure Coefficient Value 1 {dimensionless}
0.48,
!- Wind Pressure Coefficient Value 2 {dimensionless}
0.04,
!- Wind Pressure Coefficient Value 3 {dimensionless}
-0.56,
!- Wind Pressure Coefficient Value 4 {dimensionless}
-0.56,
!- Wind Pressure Coefficient Value 5 {dimensionless}
-0.42,
!- Wind Pressure Coefficient Value 6 {dimensionless}
-0.37,
!- Wind Pressure Coefficient Value 7 {dimensionless}
-0.42,
!- Wind Pressure Coefficient Value 8 {dimensionless}
-0.56,
!- Wind Pressure Coefficient Value 9 {dimensionless}
-0.56,
!- Wind Pressure Coefficient Value 10 {dimensionless}
0.04,
!- Wind Pressure Coefficient Value 11 {dimensionless}
0.48;
!- Wind Pressure Coefficient Value 12 {dimensionless}

The previous sections of this AirflowNetwork model discussion describe input objects used
for multizone airflow calculations. The following sections describe input objects used for air
distribution system simulations. These objects work when control option MultiZone with
Distribution or MultiZone with Distribution Only During Fan Operation is defined in the
AirflowNetwork Control field in the AirflowNetwork:SimulationControl object.
The first section presents the input object for distribution system nodes. Although thermal
zones are required to perform air distribution system simulations, the thermal zones are
already defined in the multizone input section (described previously), so that there is no need
to repeat the inputs for thermal zones when modeling an air distribution system. The same is
also true for surface air leakage. This section has only one object:
AirflowNetwork:Distribution:Node.
AirflowNetwork:Distribution:Node
The AirflowNetwork:Distribution:Node object is used to represent air distribution system
nodes for the AirflowNetwork model. The EnergyPlus nodes defined in an AirLoopHVAC are
a subset of the nodes used to simulate the distribution system using the AirflowNetwork
model. For example, the inlet node of a fan and the outlet node of a coil defined in an
AirLoopHVAC must be defined as nodes using the AirflowNetwork:Distribution:Node object. A
set of EnergyPlus Zone Equipment nodes is also a subset of the
AirflowNetwork:Distribution:Nodes. For example, zone inlet and outlet nodes must be defined
as nodes using the AirflowNetwork:Distribution: Node object. In addition, although mixers and
9/29/14

851

Input-Output Reference

Group Airflow Network

splitters are defined as objects with inlet and outlet nodes within EnergyPlus, the
AirflowNetwork:Distribution:Node object treats mixers and splitters as single nodes. The node
objects are referenced by AirflowNetwork:Distribution:Linkage objects.
In summary, all nodes used to define an AirLoopHVAC (except splitters, mixers, and outdoor
air systems which are treated as single nodes) and its connections to a thermal zone must be
specified as AirflowNetwork:Distribution:Nodes. If distribution system air leaks are to be
modeled, additional AirflowNetwork:Distribution:Nodes may be defined along with
AirflowNetwork:Distribution:Components (e.g., leak or leak ratio) to define the air leakage
characteristics.
Note: Supply and return leaks are not allowed in an AirLoopHVAC. They can only be modeled in the Zone
Equipment Loop (i.e., return leaks may be modeled between the zone return node and the zone mixer inlet
or the zone mixer outlet and the zone equipment loop outlet; and supply leaks may be modeled between
the zone equipment loop inlet and the AirLoopHVAC:ZoneSplitter inlet node or the
AirLoopHVAC:ZoneSplitter outlet node and the zone supply node).

Field: Name
The name of an air distribution system node. This node name is referenced by an
AirflowNetwork:Distribution:Linkage and in the output listing. Each node should have a
unique name within the AirflowNetwork:Distribution:Node objects (however, the node name
may be used elsewhere as regular EnergyPlus node names such as the fan inlet node or coil
outlet node).
Field:Component Name or Node Name
Designates node names defined in another EnergyPlus object, so that the
AirflowNetwork:Distribution:Node object is able to get input parameters and node conditions
from the associated EnergyPlus node or object. The actual node name is entered here and
represents a node already defined in an AirLoopHVAC or zone equipment loop. This field is
left blank if the EnergyPlus Node Type field below is entered as Mixer, Splitter, Outdoor air
System, or Other.
Field: Component Object Type or Node Type
This choice field distinguishes the node type for the EnergyPlus node or object name defined
above. Five node types are available:
AirLoopHVAC:ZoneMixer: Represents an AirLoopHVAC:ZoneMixer object defined in
EnergyPlus
AirLoopHVAC:ZoneSplitter: Represents an AirLoopHVAC:ZoneSplitter object defined
in EnergyPlus
AirLoopHVAC:OutdoorAirSystem: Represents an AirLoopHVAC:OutdoorAirSystem
object used in EnergyPlus
OAMixerOutdoorAirStreamNode: Represents an external node name specified as an
Outdoor Air Stream Node Name in the OutdoorAir:Mixer object when the
AirLoopHVAC:OutdoorAirSystem object is used.
OutdoorAir:NodeList: Represents an external node name defined in the
OutdoorAir:NodeList object when the AirLoopHVAC:OutdoorAirSystem object and an
exhaust energy recovery system (air-to-air heat exchanger) are used.
OutdoorAir: Represents an external node name defined in the OutdoorAir:Node object
when the AirLoopHVAC:OutdoorAirSystem and an exhaust energy recovery system (airto-air heat exchanger) are used.
Other: Represents a type not already defined above.

9/29/14

852

Input-Output Reference

Group Airflow Network

Note: Both the OutdoorAir:NodeList and OutdoorAir:Node node types represent a node to outdoor air
conditions. Either one of these node types can be used to represent an external node when an air-to-air
heat exchanger is used to recover energy from the exhaust air stream as part of an
AirLoopHVAC:OutdoorAirSystem object. Node type OAMixerOutdoorAirStreamNode does not represent
an external node when an OutdoorAir:NodeList or OutdoorAir:Node object is specified. If no exhaust heat
recovery system (i.e., air-to-air heat exchanger) is specified in the AirLoopHVAC:OutdoorAirSystem, the
node type OAMixerOutdoorAirStreamNode represents an external node.

Field: Node Height

Designates the reference height in meters used to calculate relative pressure. The default
value is 0 meters.
IDF examples are provided below:
AirflowNetwork:Distribution:Node,
EquipmentInletNode,
!- Name
Zone Equipment Inlet Node, !- Component Name or Node Name
Other,
!- Component Object Type or Node Type
3.0;
!- Node Height {m}
AirflowNetwork:Distribution:Node,
SupplyMainNode,
!- Name
,
!- Component Name or Node Name
Other,
!- Component Object Type or Node Type
3.0;
!- Node Height {m}
AirflowNetwork:Distribution:Node,
MainSplitterNode,
!- Name
,
!- Component Name or Node Name
AirLoopHVAC:ZoneSplitter, !- Component Object Type or Node Type
3.0;
!- Node Height {m}

AirflowNetwork:Distribution:Node,
MainSplitterNode,
!- Name of Node
,
!- Name of Associated EnergyPlus Node or Object
AirLoopHVAC:ZoneSplitter, !- EnergyPlus Object or Node Type
3.0;
!- Node Height {m}

The next section describes AirflowNetwork Distribution Components, with 7 available types
listed below. All required fields for each component represent a relationship between
pressure
difference
and
airflow.
The
components
are
referenced
in
AirflowNetwork:Distribution:Linkage objects.
AirflowNetwork:Distribution:Component:Leak
AirflowNetwork:Distribution:Component:LeakageRatio
AirflowNetwork:Distribution:Component:Duct
AirflowNetwork:Distribution:Component:ConstantVolumeFan
AirflowNetwork:Distribution:Component:Coil
AirflowNetwork:Distribution:Component:HeatExchanger
AirflowNetwork:Distribution:Component:TerminalUnit
AirflowNetwork:Distribution:Component:ConstantPressureDrop
AirflowNetwork:Distribution:Component:Leak
This component may be also called a power law component and is used to represent a
supply or return air leak in an air distribution system. Its relationship between pressure
difference and airflow may be expressed as:
9/29/14

853

Input-Output Reference

Group Airflow Network

m CT C

where

m = Air mass flow rate through the component [kg/s]

C = Air mass flow coefficient (kg/s at 1 Pa pressure difference)

P = Total pressure loss across the element [Pa]

n = Air mass flow exponent
CT = Temperature correction factor
n 1

CT

2n 1
o

where
= Air density at the specific air temperature and humidity ratio conditions [kg/m 3]
= Air kinetic viscosity at the specific air temperature condition [m2/s]
o = Air density at air conditions of 20C, 0 kg/kg and 101325 Pa [kg/m 3]
o = Air kinetic viscosity at an air temperature of 20C [m2/s]
Note: The correction factor shown above is use for this particular component as specified.

Field: Name
A unique name identifying a supply or return air leak in an air distribution system. This unique
name will be referenced by an AirflowNetwork:Distribution:Linkage object to represent a
component leak.
Field: Air Mass Flow Coefficient
This numeric field is defined as the air mass flow coefficient at 1 Pa pressure difference
across this component. Valid entries must be greater than zero.
Field: Air Mass Flow Exponent
This numeric field is defined as the pressure difference exponent across the component.
Valid entries are from 0.5 to 1.0, with the default value being 0.65.
An IDF example is provided below:
AirflowNetwork:Distribution:Component:Leak,
MainSupplyLeak,
!- Name of Supply or Return Leak
0.0001,
!- Air Mass Flow Coefficient {kg/s}
0.65;
!- Air Mass Flow Exponent {dimensionless}
AirflowNetwork:Distribution:Component:Leak,
ZoneSupplyLeak,
!- Name of Supply or Return Leak
0.01,
!- Air Mass Flow Coefficient {kg/s}
0.65;
!- Air Mass Flow Exponent {dimensionless}

AirflowNetwork:Distribution:Component:LeakageRatio
The leakage ratio component is generally used to define supply and return leaks with respect
to a constant fan flow. This object requires 5 inputs. The relationship between pressure and
airflow may be expressed as a power law element:

9/29/14

854

Input-Output Reference

m Cequ

Group Airflow Network

where
= Air density [kg/m3]

P = Total pressure loss across the element [Pa]

n = Air mass flow exponent
Cequ = Equivalent air mass flow coefficient

Cequ

r * Qr * *

Pr

where
r = Effective leakage ratio [dimensionless]
Qr = Maximum airflow rate [m 3/s]

Pr = Reference pressure difference [Pa]

n = Air mass flow exponent [dimensionless]
The above calculation is valid only for a HVAC system using a constant volume supply fan:
Fan:ConstantVolume or Fan:OnOff.
Field: Name
A unique name identifying a supply or return air leak (ratio with respect to the constant
volume fan flow rate) in an air distribution system. This unique name will be referenced in an
AirflowNetwork:Distribution:Linkage object to represent a component.
Field: Effective Leakage Ratio
This numeric field is used to input the effective leakage ratio. This value must be greater than
zero and less than or equal to 1. The effective leakage ratio is used to characterize supply
and return leaks with respect to the constant fan flow (supply or return air leak flow rate
divided by the maximum air flow rate for the fan). When a VAV system is used with Supply
Fan Object Type = Fan:VariableVolume in the AirflowNetwork:Distribution:Component:Fan
object, the ratio for a supply leak is defined as the value of supply air leak flow rate divided by
the supply fan air flow rate at the current time step. The inputs of the rest of 3 fields are not
used.
Field: Maximum Flow Rate
This numeric field is used to input the maximum flow rate for a constant volume fan [m 3/s].
This value must be greater than 0 m 3/s. When a VAV system is used with Supply Fan Object
Type = Fan:VariableVolume in the AirflowNetwork:Distribution:Component:Fan object, this
input is not used, because the real supply fan flow rate at the current time step is used to
calculate the amount of a supply leak.
Field: Reference Pressure Difference
This numeric field is used to input the reference pressure difference [Pa]. This value must be
greater than 0 Pa. When a VAV system is used with Supply Fan Object Type =
Fan:VariableVolume in the AirflowNetwork:Distribution:Component:Fan object, this input is
not used, because the real supply fan flow rate at the current time step is used to calculate
the amount of a supply leak.
Field: Air Mass Flow Exponent
This numeric field is used to input the pressure difference exponent. The value of the
exponent can be from 0.5 to 1.0, with the default value being 0.65. When a VAV system is
9/29/14

855

Input-Output Reference

Group Airflow Network

used
with
Supply
Fan
Object
Type
=
Fan:VariableVolume
in
the
AirflowNetwork:Distribution:Component:Fan object, this input is not used, because the real
supply fan flow rate at the current time step is used to calculate the amount of a supply leak.
Note: The reference pressure difference is defined as the difference between pressures of originate and
terminate nodes for supply and return leaks. In general, it may require that a simulation be performed with
an initial guess for reference pressure difference using design day conditions. After obtaining pressures at
the leakage nodes, more realistic reference pressure differences can be entered. It should be pointed out
that since pressures at the nodes vary with temperature and other conditions, the effective leakage ratio is
only an estimate. In other words, the exact leakage ratio may not be available.
When a VAV system is used with Supply Fan Object Type = Fan:VariableVolume in the
AirflowNetwork:Distribution:Component:Fan
object,
the
AirflowNetwork:Distribution:Component:LeakageRatio object has to be used to define a supply leak. The
other components cannot be used. In addition, the first node in a AirflowNetwork:Distribution:Linkage to
define a supply leak has to be the node in the duct to originate a supply leak, and the second node has to
be the node of a zone to terminate a supply leak. In other words, the supply leak has to flow from node 1 to
node 2.
When this object is used to define a return leak, the first node in a
AirflowNetwork:Distribution:Linkage has to be a thermal zone to originate a leak, and the second node has
to be the node of a duct to terminate a leak.

An IDF example is provided below:

AirflowNetwork:Distribution:Component:LeakageRatio,
Zone1SupplyLeakELA,
!- Name of Effective Leakage Ratio
0.043527,
!- Effective Leakage Ratio {dimensionless}
1.0,
!- Maximum Flow Rate {m3/s}
20.0,
!- Reference Pressure Difference {Pa}
0.65;
!- Air Mass Flow Exponent {dimensionless}

AirflowNetwork:Distribution:Component:Duct
This object represents a duct component and requires 9 input fields, one alpha field and 8
numeric fields. The relationship between pressure and airflow across the component may be
expressed as (2001 ASHRAE Handbook of Fundamentals, Chapter 34):

2 A2 P
fL / D
Cd

where

m = Mass flow rate of air through the component [kg/s]

= Air density [kg/m 3]
A = Cross sectional area [m 2]

P = Total pressure loss across the component [Pa]

L = Duct length [m]
D = Hydraulic diameter [m]
Cd = Dynamic loss coefficient due to fitting [dimensionless]
f = Friction factor
The friction factor can be calculated using the nonlinear Colebrook equation (ASHRAE
Handbook of Fundamentals, 1997. p. 2.9, Eq. 29b)

9/29/14

856

Input-Output Reference

1
f

Group Airflow Network

1.44 2*log

2*log 1

9.3
Re* / D * f

where
= Surface roughness [m]
Re = Reynolds number =

VD

Field: Name
A unique name for an AirflowNetwork duct component in an air distribution system. This
unique name will be referenced by an AirflowNetwork:Distribution:Linkage object to represent
a component.
Field: Duct Length
This numeric field is used to input duct length [m]. This value must be greater than zero.
Field: Hydraulic Diameter
This numeric field is used to input hydraulic diameter, which is defined as:

Dh

4A
P

where
Dh = Hydraulic diameter [m]
A = Duct cross sectional area [m 2]
P = Perimeter of cross section [m]
Field: Cross Section Area
This numeric field is used to input cross section area [m 2]. The model assumes that this
element has no area change along its length. Otherwise, effective cross sectional area is
required.
Field: Surface Roughness
This numeric field is used to input surface roughness [m]. This value must be greater than
zero, and the default value is 0.0009 m.
Field: Coefficient for Local Dynamic Loss Due to fitting
This numeric field is defined as a coefficient for dynamic loss [dimensionless]. It represents
dynamic loss due to fittings (such as an elbow).
Field: Overall Heat Transmittance Coefficient (U-Factor) from Air to Air
This numeric field is defined as the overall heat transmittance coefficient (U value, W/m 2-K)
from air to air, including film coefficients at both surfaces.
Field: Overall Moisture Transmittance Coefficient from Air to Air
This numeric field is defined as the overall moisture transmittance coefficient (kg/m2) from air
to air, including film coefficients at both surfaces.
An IDF example is provided below:

9/29/14

857

Input-Output Reference

Group Airflow Network

AirflowNetwork:Distribution:Component:Duct,
MainTruck1,
!- Name of Duct Component
3.0,
!- Duct Length {m}
0.6,
!- Hydraulic Diameter {m}
0.2827,
!- Cross Section Area {m2}
0.0009,
!- Surface Roughness {m}
0.01,
!- Coefficient for local dynamic loss due to fitting {dimensionless}
0.772,
!- Overall heat transmittance coefficient (U value) from air to air
!- {W/m2-K}
0.0001;
!- Overall moisture transmittance coefficient from air to air {kg/m2}

AirflowNetwork:Distribution:Component:Fan
This component represents a constant volume fan in the air distribution system
(AirLoopHVAC). The air flow rate and air conditions (temperature and humidity) are obtained
from the associated Fan:ConstantVolume, Fan:OnOff, or Fan:VariableVolume object.
Field: Fan Name
The name identifying an AirflowNetwork constant volume fan in an air distribution system.
This name must be the same as the name of the associated Fan:ConstantVolume,
Fan:OnOff or Fan:VariableVolume object. This name will be referenced by an
AirflowNetwork:Distribution:Linkage object to represent a component.
Field: Supply Fan Object Type
This choice field defines the type of fan. The only valid choices are Fan:OnOff,
Fan:ConstantVolume, and Fan:VariableVolume, with the default being Fan:ConstantVolume.
Both cycling and continuous fan operating modes are allowed for Fan:OnOff. Only the
continuous fan operating mode is allowed for Fan:ConstantVolume. The variable airflow rate
is allowed for Fan:VariableVolume.
Note: Make sure that the volumetric air flow rates for the fan, coils, and parent components (e.g., unitary
system or furnace) are the same so that fan energy and air distribution system losses/gains are properly
calculated.

An IDF example is provided below:

AirflowNetwork:Distribution:Component:Fan,
Supply Fan 1,
!- Name of Constant Volume Fan
Fan:ConstantVolume; !- Supply fan type

AirflowNetwork:Distribution:Component:Coil
This component represents a cooling or heating coil. The main purpose for this object is to
get calculated values (air flow and temperature/humidity conditions) from the associated coil
models.
Field: Coil Name
The name identifying an AirflowNetwork cooling coil or heating coil defined in an air loop. This
name must be the same name as the associated coil object. This unique name will be
referenced by an AirflowNetwork:Distribution:Linkage object to represent a component.
Field: Coil Object Type
This field requires input of the coil type used in the AirflowNetwork model. The available
choices are:
Coil:Cooling:DX:SingleSpeed
Coil:Heating:Gas

9/29/14

858

Input-Output Reference

Group Airflow Network

Coil:Heating:Electric
Coil:Heating:DX:SingleSpeed
Coil:Cooling:Water
Coil:Heating:Water
Coil:Cooling:Water:DetailedGeometry
Coil:Cooling:DX:TwoStageWithHumidityControlMode
Coil:Cooling:DX:MultiSpeed
Coil:Heating:DX:MultiSpeed
Coil:Heating:Desuperheater
Field: Air Path Length
This numeric field is used to input air path length for the coil [m]. This value must be greater
than 0 meters.
Field: Air Path Hydraulic Diameter
This numeric field is used to input hydraulic diameter of a coils air path, which is defined as:

Dh

4A
P

where
Dh = Hydraulic diameter [m]
A = Duct cross section area [m 2]
P = Perimeter of cross section [m]
For this component, the relationship between airflow and pressure is similar to the
component AirflowNetwork:Distribution:Component:Duct. However, the model assumes very
small surface roughness (10-4) and no local dynamic loss due to fittings for this component.
Therefore, this component only requires two numerical fields. Heat and moisture exchange
from surroundings is ignored.
Note: Make sure that the volumetric air flow rates for the fan, coils, and parent components (e.g., unitary
system or furnace) are the same so that fan energy and air distribution system losses/gains are properly
calculated.

An IDF example is provided below:

AirflowNetwork:Distribution:Component:Coil,
ACDXCoil 1,
!Coil:Cooling:DX:SingleSpeed,
!0.1,
!1.00;
!- Air

Name of Associated EnergyPlus Coil

EnergyPlus Coil Type
Air Path Length {m}
Path Hydraulic Diameter {m}

AirflowNetwork:Distribution:Component:Coil,
HP Heating Coil 1,
!Coil:Heating:DX:SingleSpeed,
!0.1,
!1.00;
!-

Name of Associated EnergyPlus Coil

EnergyPlus Coil Type
Air Path Length {m}
Air Path Hydraulic Diameter {m}

AirflowNetwork:Distribution:Component:HeatExchanger
This component represents an air-to-air heat exchanger typically used in combination with a
cooling coil to enhance dehumidification or in an outside air system to recover energy from
exhaust air to pretreat incoming outdoor ventilation air. The cooling coils with enhanced
dehumidification
are
defined
in
the
two
objects
9/29/14

859

Input-Output Reference

Group Airflow Network

CoilSystem:Cooling:DX:HeatExchangerAssisted
and
CoilSystem:Cooling:Water:HeatExchangerAssisted using one of three heat exchanger
objects specified below. The exhaust air energy recovery system also has the same
restriction using the one of three heat exchanger objects. The main purpose for this object is
to obtain calculated values (air flow and temperature/humidity conditions) from the associated
heat exchanger models for the airflow network calculations.
Field: Heat Exchanger Name
The name identifying an AirflowNetwork heat exchanger defined in an air loop. This name
must be the same name that is used in the associated heat exchanger object. This unique
name will be referenced by an AirflowNetwork:Distribution:Linkage object to represent a
component.
Field: Heat Exchanger Object Type
This field requires input of the heat exchanger type. The available choices are:
HeatExchanger:AirToAir:FlatPlate
HeatExchanger:AirToAir:SensibleAndLatent
HeatExchanger:Desiccant:BalancedFlow
Field: Air Path Length
This numeric field is used to input air path length for the heat exchanger coil [m]. This value
must be greater than 0 meters.
Field: Air Path Hydraulic Diameter
This numeric field is used to input hydraulic diameter of a heat exchanger coils air path,
which is defined as:

Dh

4A
P

where
Dh = Hydraulic diameter [m]
A = Duct cross section area [m 2]
P = Perimeter of cross section [m]
For this component, the relationship between airflow and pressure is similar to the
component AirflowNetwork:Distribution:Component:Duct. However, the model assumes very
small surface roughness (10-4) and no local dynamic loss due to fittings for this component.
Therefore, this component only requires two numerical fields. Heat and moisture exchange
from surroundings are ignored.
Note:
When
a
heat
exchanger
is
used
as
a
component
of
either
CoilSystem:Cooling:DX:HeatExchangerAssisted or CoilSystem:Cooling:Water:HeatExchangerAssisted,
the heat exchanger acts as two components in an air primary loop. For example, an air-to-air heat
exchanger has a component connected to the supply air side (equivalent to a supply coil) and a
component connected to exhaust air side (equivalent to an exhaust coil). The desiccant heat exchanger
has a component connected to regeneration air side (equivalent to a regeneration air coil) and a
component connected to process air side (equivalent to a process air coil). Therefore, each air-to-air heat
exchanger used in this configuration requires two linkage objects (instead of only one linkage object as
required for other AirflowNetwork components).

9/29/14

860

Input-Output Reference

Group Airflow Network

When a heat exchanger is used in an exhaust air energy recovery system (i.e., in an
AirLoopHVAC:OutdoorAirSystem object to recover waste heat from exhaust air to pretreat incoming
outdoor ventilation air), the heat exchanger is treated as a single component. The AirflowNetwork model
only connects the two nodes associated with the incoming outdoor ventilation air, while the two exhaust
nodes are not defined as part of the AirflowNetwork model. Therefore, each heat exchanger component
used in an exhaust air energy recovery system has only one linkage object, similar to AirflowNetwork coil
components.

An IDF example is provided below:

AirflowNetwork:Distribution:Component:HeatExchanger,
OA Heat Recovery 1,
!- HeatExchanger Name
HeatExchanger:AirToAir:SensibleAndLatent, !- HeatExchanger Object Type
0.1,
!- Air Path Length {m}
1.00;
!- Air Path Hydraulic Diameter {m}
AirflowNetwork:Distribution:Component:HeatExchanger,
Desiccant Heat Exchanger 1, !- HeatExchanger Name
HeatExchanger:Desiccant:BalancedFlow, !- HeatExchanger Object Type
0.1,
!- Air Path Length {m}
1.00;
!- Air Path Hydraulic Diameter {m}

AirflowNetwork:Distribution:Component:TerminalUnit
This component represents a terminal unit for reheating the incoming supply air. The main
purpose is to get calculated values from the terminal unit models.
Field: Terminal Unit Name
A name identifying an AirflowNetwork terminal unit defined in a zone equipment list. This
name must be the same as the associated terminal unit object. This unique name will be
referenced by an AirflowNetwork:Distribution:Linkage object to represent a component.
Field: Terminal Unit Object Type
This field requires input of the terminal unit type used in the AirflowNetwork model. The
available
types
are
AirTerminal:SingleDuct:ConstantVolume:Reheat
and
AirTerminal:SingleDuct:VAV:Reheat. The AirTerminal:SingleDuct:ConstantVolume:Reheat
type
is
used
when
the
Supply
Fan
Object
Type
in
the
AirflowNetwork:Distribution:Component:Fan is either Fan:ConstantVolume or Fan:OnOff. The
AirTerminal:SingleDuct:VAV:Reheat type is used when the Supply Fan Object Type in the
AirflowNetwork:Distribution:Component:Fan is Fan:VariableVolume only.
Field: Air Path Length
This numeric field is used to input the air path length for the terminal unit [m]. This value must
be greater than 0 meters.
Field: Air Path Hydraulic Diameter
This numeric field is used to input hydraulic diameter for the terminal units air path, which is
defined as:

Dh

4A
P

where
Dh = Hydraulic diameter [m]
9/29/14

861

Input-Output Reference

Group Airflow Network

A = Duct cross section area [m 2]

P = Perimeter of cross section [m]
It should be noted that the relationship for this component between airflow and pressure is
similar to the component AirflowNetwork:Distribution:Component:Duct. However, the model
assumes very small surface roughness (10-4) and no local dynamic loss due to fittings for this
component. Therefore, this component only requires two numerical fields. Heat and moisture
exchange from surroundings is ignored.
Note: The AirflowNetwork:Distribution:Component:TerminalUnit object is used to represent an
AirTerminal:SingleDuct:ConstantVolume:Reheat or an AirTerminal:SingleDuct:VAV:Reheat object in an
AirflowNetwork simulation. The AirflowNetwork:Distribution:Component:TerminalUnit should not be used to
represent any other air terminal unit types. When the ZoneHVAC:EquipmentList object specifies an
Air:Terminal:SingleDuct:Uncontrolled object, the AirflowNetwork:Distribution:Component:Duct object
should be used instead.
The AirTerminal:SingleDuct:VAV:Reheat object has two components: a damper and a reheat coil. When
the AirTerminal:SingleDuct:VAV:Reheat type is used, two objects of AirflowNetwork:Distribution:Linkage
have to be used to make two links, one of which is a link to connect two nodes for a damper, and the other
is a link to connect two nodes for a reheat coil.
When a VAV system is used with Supply Fan Object Type = Fan:VariableVolume in the
AirflowNetwork:Distribution:Component:Fan object, the type of all terminals has to be
AirTerminal:SingleDuct:VAV:Reheat. The object of Air:Terminal:SingleDuct:Uncontrolled is not allowed.

An IDF example is provided below:

AirflowNetwork:Distribution:Component:TerminalUnit,
Reheat Zone 1,
!- Name of Associated Energyplus Terminal Unit
AirTerminal:SingleDuct:ConstantVolume:Reheat, !- EnergyPlus Terminal Unit Type
0.1,
!- Air Path Length {m}
0.44;
!- Air Path Hydraulic Diameter {m}

AirflowNetwork:Distribution:Component:ConstantPressureDrop
This component represents a constant pressure drop component. It is generally used to
simulate a constant pressure drop filter. The mathematical equation may be written as:

P const
Field: Name
A unique name identifying an AirflowNetwork constant pressure drop component in an air
distribution system. This unique name will be referenced by an AirflowNetwork:
Distribution:Linkage object to represent a component.
Field: Pressure Difference across the Component
This numeric field is used to input the pressure difference across the element [Pa].
Note: This object should be used with caution. Each node connected to this object cannot be a node for a
mixer or splitter, a node in an AirLoopHVAC, or a node in a zone configuration loop. It is recommended
that duct components be specified at both ends of this object.

An IDF example is provided below:

9/29/14

862

Input-Output Reference

Group Airflow Network

AirflowNetwork:Distribution:Component:ConstantPressureDrop,
SupplyCPDComp, ! Name of Constant Pressure Drop Component
1.0;
! Pressure Difference Across the Component [Pa]

AirflowNetwork:Distribution:Linkage
The AirflowNetwork:Distribution:Linkage represents a connection between two
AirflowNetwork:Distribution:Node objects and an AirflowNetwork component defined above.
In addition, the relative height from node height to linkage height for each node is required.
Field: Name
The name identifies the linkage for later reference and in the output listing. Each linkage
should have a unique name.
Field: Node 1 Name
Designates a node name where airflow starts. The node name should be defined in an
AirflowNetwork:Distribution:Node object.
Field: Node 2 Name
Designates a node name where airflow ends. The node name should be defined in an
AirflowNetwork:Distribution:Node object.
Field: Component Name
Designates an AirflowNetwork component name associated with the two nodes. The
component name should be one of the AirflowNetwork:Distribution:Component object
names.
Field: Thermal Zone Name
Designates a thermal zone where the linkage is located. The information provides the
ambient conditions for duct elements to calculate duct conduction losses (only used if
component is AirflowNetwork:Distribution:Component:Duct).
An IDF example is provided below:
AirflowNetwork:Distribution:Linkage,
Main Link 1,
!- Name of Linkage
EquipmentInletNode,
!- Node 1 Name
SupplyMainNode,
!- Node 2 Name
MainTruck1,
!- Component Name
Attic Zone;
!- Thermal Zone Name

Airflow Network Outputs

The AirflowNetwork nodes in the following output variables includes zones defined in
AirflowNetwork:Multizone:Zone
objects,
external
nodes
defined
in
AirflowNetwork:MultiZone:ExternalNode
objects,
and
nodes
defined
in
AirflowNetwork:Distribution:Node objects.
The AirflowNetwork linkage used in following output variables includes surfaces defined in
AirflowNetwork:Multizone:Surface
objects,
and
linkages
defined
in
AirflowNetwork:Distribution:Linkage objects. The surface linkages represent airflows through
surface cracks or openings between two zones or between a zone and outdoors. The
distribution linkages represent airflows in an air distribution system.
HVAC,Average,AFN
HVAC,Average,AFN
HVAC,Average,AFN
HVAC,Average,AFN
HVAC,Average,AFN
HVAC,Average,AFN
HVAC,Average,AFN
9/29/14

Node Temperature [C]

Node Humidity Ratio [kgWater/kgDryAir]
Node Total Pressure [Pa]
Node Wind Pressure [Pa]
Node CO2 Concentration [ppm]
Node Generic Air Contaminant Concentration [ppm]
Linkage Node 1 to Node 2 Mass Flow Rate [kg/s]
863

Input-Output Reference

Group Airflow Network

HVAC,Average,AFN Linkage Node 2 to Node 1 Mass Flow Rate [kg/s]

HVAC,Average,AFN Linkage Node 1 to Node 2 Volume Flow Rate [m3/s]
HVAC,Average,AFN Linkage Node 2 to Node 1 Volume Flow Rate [m3/s]
HVAC,Average,AFN Linkage Node 1 to Node 2 Pressure Difference [Pa]
HVAC,Average,AFN Surface Venting Window or Door Opening Factor []
HVAC,Average,AFN Surface Venting Window or Door Opening Modulation Multiplier
[]
HVAC,Average,AFN Surface Venting Inside Setpoint Temperature [C]
HVAC,Average,AFN Surface Venting Availability Status []
HVAC,Average,AFN Zone Infiltration Sensible Heat Gain Rate [W]
HVAC,Sum,AFN Zone Infiltration Sensible Heat Gain Energy [J]
HVAC,Average,AFN Zone Mixing Sensible Heat Gain Rate [W]
HVAC,Sum,AFN Zone Mixing Sensible Heat Gain Energy [J]
HVAC,Average,AFN Zone Infiltration Sensible Heat Loss Rate [W]
HVAC,Sum,AFN Zone Infiltration Sensible Heat Loss Energy [J]
HVAC,Average,AFN Zone Mixing Sensible Heat Loss Rate [W]
HVAC,Sum,AFN Zone Mixing Sensible Heat Loss Energy [J]
HVAC,Average,AFN Zone Infiltration Latent Heat Gain Rate [W]
HVAC,Sum,AFN Zone Infiltration Latent Heat Gain Energy [J]
HVAC,Average,AFN Zone Infiltration Latent Heat Loss Rate [W]
HVAC,Sum,AFN Zone Infiltration Latent Heat Loss Energy [J]
HVAC,Average,AFN Zone Mixing Latent Heat Gain Rate [W]
HVAC,Sum,AFN Zone Mixing Latent Heat Gain Energy [J]
HVAC,Average,AFN Zone Mixing Latent Heat Loss Rate [W]
HVAC,Sum,AFN Zone Mixing Latent Heat Loss Energy [J]
HVAC,Average,AFN Zone Duct Leaked Air Sensible Heat Gain Rate [W]
HVAC,Sum,AFN Zone Duct Leaked Air Sensible Heat Gain Energy [J]
HVAC,Average,AFN Zone Duct Leaked Air Sensible Heat Loss Rate [W]
HVAC,Sum,AFN Zone Duct Leaked Air Sensible Heat Loss Energy [J]
HVAC,Average,AFN Zone Duct Leaked Air Latent Heat Gain Rate [W]
HVAC,Sum,AFN Zone Duct Leaked Air Latent Heat Gain Energy [J]
HVAC,Average,AFN Zone Duct Leaked Air Latent Heat Loss Rate [W]
HVAC,Sum,AFN Zone Duct Leaked Air Latent Heat Loss Energy [J]
HVAC,Average,AFN Zone Duct Conduction Sensible Heat Gain Rate [W]
HVAC,Sum,AFN Zone Duct Conduction Sensible Heat Gain Energy [J]
HVAC,Average,AFN Zone Duct Conduction Sensible Heat Loss Rate [W]
HVAC,Sum,AFN Zone Duct Conduction Sensible Heat Loss Energy [J]
HVAC,Average,AFN Zone Duct Diffusion Latent Heat Gain Rate [W]
HVAC,Sum,AFN Zone Duct Diffusion Latent Heat Gain Energy [J]
HVAC,Average,AFN Zone Duct Diffusion Latent Heat Loss Rate [W]
HVAC,Sum,AFN Zone Duct Diffusion Latent Heat Loss Energy [J]
HVAC,Average,AFN Distribution Sensible Heat Gain Rate [W]
HVAC,Sum,AFN Distribution Sensible Heat Gain Energy [J]
HVAC,Average,AFN Distribution Sensible Heat Loss Rate [W]
HVAC,Sum,AFN Distribution Sensible Heat Loss Energy [J]
HVAC,Average,AFN Distribution Latent Heat Gain Rate [W]
HVAC,Sum,AFN Distribution Latent Heat Gain Energy [J]
HVAC,Average,AFN Distribution Latent Heat Loss Rate [W]
HVAC,Sum,AFN Distribution Latent Heat Loss Energy [J]
HVAC,Sum,AFN Zone Infiltration Volume [m3]
HVAC,Sum,AFN Zone Infiltration Mass [kg]
HVAC,Average,AFN Zone Infiltration Air Change Rate [ach]
HVAC,Sum,AFN Zone Mixing Volume [m3]
HVAC,Sum,AFN Zone Mixing Mass [kg]
The following are reported only when a Fan:OnOff object is used:
HVAC,Average,AFN Zone Average Pressure [Pa]
HVAC,Average,AFN Zone On Cycle Pressure [Pa]
HVAC,Average,AFN Zone Off Cycle Pressure [Pa]
HVAC,Average,AFN Linkage Node 1 to 2 Average Mass Flow Rate [kg/s]
HVAC,Average,AFN Linkage Node 2 to 1 Average Mass Flow Rate [kg/s]
HVAC,Average,AFN Linkage Node 1 to 2 Average Volume Flow Rate [m3/s]
HVAC,Average,AFN Linkage Node 2 to 1 Average Volume Flow Rate [m3/s]
9/29/14

864

Input-Output Reference

Group Airflow Network

HVAC,Average,AFN Surface Average Pressure Difference [Pa]

HVAC,Average,AFN Surface On Cycle Pressure Difference [Pa]
HVAC,Average,AFN Surface Off Cycle Pressure Difference [Pa]

AFN Node Temperature [C]

This is the AirflowNetwork node temperature output in degrees C. When a Fan:OnOff object
is used and is scheduled to operate in the cycling fan operation mode, this value for
AirflowNetwork:Distribution:Node objects reflects the temperature when the fan is operating
(ON).
AFN Node Humidity Ratio [kgWater/kgDryAir]
This is the AirflowNetwork node humidity ratio output in kgWater/kgDryAir. When a
Fan:OnOff object is used and is scheduled to operate in the cycling fan operation mode, this
value for AirflowNetwork:Distribution:Node objects reflects the humidity ratio when the fan is
operating (ON).
AFN Node Total Pressure [Pa]
This is the AirflowNetwork node total pressure in Pa with respect to outdoor barometric
pressure. The total pressure is the sum of static pressure, dynamic pressure, and elevation
impact at the nodes relative height. When a Fan:OnOff object is used and is scheduled to
operate in the cycling fan operation mode, the value for AirflowNetwork:Distribution:Node
objects reflects the total pressure when the fan is operating (ON). The total pressures for
nodes associate with AirflowNetwork:Multizone:Zone objects are reported in different output
variables (below).
AFN Node CO2 Concentration [ ppm]
This is the AirflowNetwork node carbon dioxide concentration level in parts per million (ppm).
When a Fan:OnOff object is used and is scheduled to operate in the cycling fan operation
mode, this value for AirflowNetwork:Distribution:Node objects reflects the carbon dioxide
when the fan is operating (ON).
AFN Node Generic Air Contaminant Concentration [ppm]
This is the AirflowNetwork node generic contaminant concentration level in parts per million
(ppm). When a Fan:OnOff object is used and is scheduled to operate in the cycling fan
operation mode, this value for AirflowNetwork:Distribution:Node objects reflects the carbon
dioxide when the fan is operating (ON).
AFN Zone Average Pressure [Pa]
This is the AirflowNetwork average zone total pressure in Pa with respect to outdoor
barometric pressure. This output is only available when a Fan:OnOff object is used in the air
distribution system. The average zone pressure is weighted by the system fan part-load ratio
using the calculated zone pressures during the fan on and off periods for the system
timestep. The system fan part-load ratio is defined as the ratio of the air distribution system
mass flow rate (average for the simulation timestep) to the system design mass flow rate.
Average zone pressure = (Zone pressure during on cycle * Part-load ratio) + Zone pressure
during off cycle * (1.0 Part-load ratio)
AFN Zone On Cycle Pressure [Pa]
This is the AirflowNetwork zone total pressure in Pa with respect to outdoor barometric
pressure when the air distribution system fan is operating (ON). This output is only available
when a Fan:OnOff object is used in the air distribution system. When the fan part-load ratio is
equal to 0.0, this pressure value will be zero because the air distribution system is not
simulated when the fan is off for the entire timestep.

9/29/14

865

Input-Output Reference

Group Airflow Network

AFN Zone Off Cycle Pressure [Pa]

This is the AirflowNetwork zone total pressure in Pa with respect to outdoor barometric
pressure when the air distribution system fan is not operating (OFF). This output is only
available when a Fan:OnOff object is used in the air distribution system. Even if the fan partload ratio is equal to 1.0, the pressure calculated as if the fan were not operating (OFF) is
reported.
AFN Node Wind Pressure [Pa]
This is the AirflowNetwork wind pressure output in Pa. The wind pressure depends on
several factors, including wind speed, wind direction, the wind-pressure coefficient (Cp)
values for the AirflowNetwork:MultiZone:ExternalNode associated with the heat transfer
surface and the site wind conditions.
When Wind Pressure Coefficient Type = Input in the AirflowNetwork:SimulationControl
object, the output represents external node pressures driven by wind defined in an
AirflowNetwork:MultiZone:ExternalNode object. When Wind Pressure Coefficient Type =
SurfaceAverageCalculation in AirflowNetwork:SimulationControl, the program assumes five
external nodes:
FACADE1
Representing north orientation
FACADE2
Representing east orientation
FACADE3
Representing south orientation
FACADE4
Representing west orientation
ROOF
Representing horizontal orientation
In this case, the output represents the wind pressures for the five external nodes defined
above.
AFN Linkage Node 1 to Node 2 Mass Flow Rate [kg/s]
This is the AirflowNetwork linkage mass flow rate output in kg/s in the direction from Node 1
to Node 2. It reports surface airflows through a crack or opening, and through linkages
defined in an AirflowNetwork:Distribution:Linkage object. The surface linkage is divided into
two types of surfaces, exterior surface and interior surface. Node 1 for an exterior surface
linkage is a thermal zone and Node 2 is an external node. The value of AFN Linkage Node 1
to Node 2 Mass Flow Rate represents the flow rate from a thermal zone to outdoors. The flow
direction through an interior surface crack or opening is defined from a thermal zone defined
by a surfaces Zone Name (Node 1) to an adjacent thermal zone defined by a surfaces
OutsideFaceEnvironment (Node 2). For an AirflowNetwork:Distribution:Linkage object, the
value represents the air mass flow rate flowing from Node 1 to Node 2.
It should be pointed out that in general, each linkage has one directional flow at any given
time, either from Node 1 to 2 or from Node 2 to 1. However, there are three components
which
may
have
flows
in
both
directions
simultaneously:
AirflowNetwork:MultiZone:Component:DetailedOpening,
AirflowNetwork:MultiZone:Component:SimpleOpening,
and
AirflowNetwork:MultiZone:Component:HorizontalOpening.
When a Fan:OnOff object is used, the air mass flow rates reported for the
AirflowNetwork:Distribution:Linkage objects are the values when the fan is operating (ON). It
is assumed that the air mass flow rates when the fan is off are zero for the distribution system
air linkage objects. The air mass flow rates for the AirflowNetwork:Multizone:Surface object
are reported in different output variables (below).
AFN Linkage Node 2 to Node 1 Mass Flow Rate [kg/s]
This is the AirflowNetwork linkage mass flow rate output in kg/s in the direction from Node 2
to Node 1. It reports airflows from surfaces through a crack or opening, and from linkages
defined in an AirflowNetwork:Distribution:Linkage object. Node 1 and Node 2 for a surface or

9/29/14

866

Input-Output Reference

Group Airflow Network

subsurface are defined in the same manner as AFN Linkage Node 1 to Node 2 Mass Flow
Rate.
When a Fan:OnOff object is used, the air mass flow rates reported for the
AirflowNetwork:Distribution:Linkage objects are the values when the fan is operating (ON). It
is assumed that the air mass flow rates when the fan is off are zero for the distribution system
air linkage objects. The air mass flow rates for the AirflowNetwork:Multizone:Surface object
are reported in different output variables (below).
AFN Linkage Node 1 to 2 Average Mass Flow Rate [kg/s]
This is the AirflowNetwork linkage average mass flow rate in kg/s in the direction from Node 1
to Node 2 defined in the AirflowNetwork:Multizone:Surface objects. This output is only
available when a Fan:OnOff object is used in the air distribution system. The average mass
flow rate is weighted by the system fan part-load ratio using the calculated air mass flow rates
during the fan on and off periods for the system timestep. The system fan part-load ratio is
defined as the ratio of the air distribution system mass flow rate (average for the simulation
timestep) to the system design mass flow rate.
Average surface mass flow rate = (Surface mass flow rate during on cycle * Part-load ratio) +
Surface mass flow rate during off cycle * (1.0 Part-load ratio)
AFN Linkage Node 2 to 1 Average Mass Flow Rate [kg/s]
This is the AirflowNetwork linkage average mass flow rate in kg/s in the direction from Node 2
to Node 1 defined in the AirflowNetwork:Multizone:Surface objects. This output is only
available when a Fan:OnOff object is used in the air distribution system. The average mass
flow rate is weighted by the system fan part-load ratio using the calculated air mass flow rates
during the fan on and off periods for the system timestep. The system fan part-load ratio is
defined as the ratio of the air distribution system mass flow rate (average for the simulation
timestep) to the system design mass flow rate.
AFN Linkage Node 1 to Node 2 Volume Flow Rate [m3/s]
This is the AirflowNetwork linkage volume flow rate output in m 3/s in the direction from the
Node 1 to Node 2. It is defined in the same manner as AFN Linkage Node 1 to Node 2 Mass
Flow Rate.
When a Fan:OnOff object is used, the air volume flow rates reported for the
AirflowNetwork:Distribution:Linkage objects are the values when the fan is operating (ON). It
is assumed that the air volume flow rates when the fan is off are zero for the distribution
system
air
linkage
objects.
The
air
volume
flow
rates
for
the
AirflowNetwork:Multizone:Surface object are reported in different output variables (below).
AFN Linkage Node 2 to Node 1 Volume Flow Rate [m3/s]
This is the AirflowNetwork linkage volume flow rate output in m 3/s in the direction from Node
2 to Node 1. It is defined in the same manner as AFN Linkage Node 2 to Node 1 Mass Flow
Rate.
When a Fan:OnOff object is used, the air volume flow rates reported for the
AirflowNetwork:Distribution:Linkage objects are the values when the fan is operating (ON). It
is assumed that the air volume flow rates when the fan is off are zero for the distribution
system
air
linkage
objects.
The
air
volume
flow
rates
for
the
AirflowNetwork:Multizone:Surface object are reported in different output variables (below).
AFN Linkage Node 1 to 2 Average Volume Flow Rate [m3/s]
This is the AirflowNetwork linkage average volume flow rate in m 3/s in the direction from
Node 1 to Node 2 defined in the AirflowNetwork:Multizone:Surface objects. This output is
only available when a Fan:OnOff object is used. The average volume flow rate is weighted by
the system fan part-load ratio using the calculated air volume flow rates during the fan on and
off periods for the system timestep.
9/29/14

867

Input-Output Reference

Group Airflow Network

Average surface volume flow rate = (Surface volume flow rate during on cycle * Part-load
ratio) + Surface volume flow rate during off cycle * (1.0 Part-load ratio)
AFN Linkage Node 2 to 1 Average Volume Flow Rate [m3/s]
This is the AirflowNetwork linkage average volume flow rate in m 3/s in the direction from
Node 2 to Node 1 defined in the AirflowNetwork:Multizone:Surface objects. This output is
only available when a Fan:OnOff object is used. The average volume flow rate is weighted by
the system fan part-load ratio using the calculated air volume flow rates during the fan on and
off periods for the system timestep.
AFN Linkage Node 1 to Node 2 Pressure Difference [Pa]
This is the pressure difference across a linkage in Pa. The linkage includes both objects:
AirflowNetwork:Multizone:Surface and AirflowNetwork: Distribution:Linkage.
When a Fan:OnOff object is used, the pressure differences reported for the
AirflowNetwork:Distribution:Linkage objects are the values calculated when the fan is
operating (ON). It is assumed that the pressure differences when the fan is off are zero for
the distribution system air linkage objects. The pressure differences defined in the
AirflowNetwork:Multizone:Surface are reported in different output variables (below).
AFN Surface Average Pressure Difference [Pa]
This is the average pressure difference across a linkage in Pa for the
AirflowNetwork:Multizone:Surface objects only when a Fan:OnOff object is used. The
average pressure difference is weighted by the system fan part-load ratio using the
calculated pressure differences during the fan on and off periods for the system timestep.
The system fan part-load ratio is defined as the ratio of the air distribution system mass flow
rate (average for the simulation timestep) to the system design mass flow rate.
Surface Average Pressure Difference = (Surface Average Pressure Difference during on
cycle * Part-load ratio) + Surface Average Pressure Difference during off cycle * (1.0 - Partload ratio)
AFN Surface On Cycle Pressure Difference [Pa]
This
is
the
pressure
difference
across
a
linkage
in
Pa
for
the
AirflowNetwork:Multizone:Surface objects only when the air distribution system fan is
operating (ON). This output is only available when a Fan:OnOff object is used. When the fan
part-load ratio is equal to 0.0, this pressure difference value will be zero because the air
distribution system is not simulated when the fan is off for the entire timestep.
AFN Surface Off Cycle Pressure Difference [Pa]
This
is
the
pressure
difference
across
a
linkage
in
Pa
for
AirflowNetwork:Multizone:Surface objects only when the air distribution system fan is
operating (OFF). This output is only available when a Fan:OnOff object is used. Even if
fan part-load ratio is equal to 1.0, the pressure difference calculated as if the fan were
operating (OFF) is reported.

the
not
the
not

AFN Surface Venting Window or Door Opening Factor []

The current time-step value of the venting opening factor for a particular window or door.
When the window or door is venting, this is the input value of the opening factor (see
AirflowNetwork:Multizone:Surface, Window/Door Opening Factor) times the multiplier for
venting modulation (see description of next output variable, Opening Factor Multiplier for
AirflowNetwork Venting Modulation). For example, if the input Window/Door opening factor
is 0.5 and the modulation multiplier is 0.7, then the value of this output variable will be 0.5x0.7
= 0.35.

9/29/14

868

Input-Output Reference

Group Airflow Network

AFN Surface Venting Window or Door Opening Modulation Multiplier []

This is the multiplier on a window or door opening factor when venting modulation is in effect.
See Modulation of Openings under AirflowNetwork:Multizone:Zone for a description of how
the multiplier is determined.
When modulation is in effect the value of the multiplier is between 0.0 and 1.0. When
modulation does not apply the value of the multiplier may be 1.0. When modulation applies
but the surface is not venting, the value is 1.0. This is summarized in the following table. In
this table, Zone means a thermal zone for which AirflowNetwork:Multizone:Zone has been
specified. See object AirflowNetwork: Multizone:Zone for definition of Ventilation Control
Mode.
Table 25. Value of opening factor multiplier for different venting conditions.
Is surface in a
Zone?

Ventilation Control
Mode

Is surface
venting?

Value of opening
factor multiplier

Yes

Temperature

Yes

0.0 to 1.0

No

-1.0

Yes

0.0 to 1.0

No

-1.0

Constant

Yes

1.0

NoVent

No

-1.0

Enthalpy

AFN Surface Venting Inside Setpoint Temperature [C]

The time-step value of the venting setpoint temperature for the zone to which the surface
belongs. This setpoint is determined from the Vent Temperature Schedule input (ref:
AirflowNetwork:Multizone:Zone).
AFN Surface Venting Availability Status [ ]
A value of 1.0 means venting through the surface can occur if venting control conditions are
satisfied. A value of 0.0 means venting through the surface cannot occur under any
circumstances. This value is determined by the Venting Availability Schedule input (ref:
AirflowNetwork:Multizone:Zone or AirflowNetwork:Multizone: Surface).
AFN Zone Infiltration Sensible Heat Gain Rate [W]
The average convective sensible heat gain rate, in Watts, to the zone air corresponding to
the Zone Infiltration Volume averaged over the reporting period. This value is calculated for
each timestep when the outdoor dry-bulb temperature is higher than the zone temperature;
otherwise, the sensible gain rate is set to 0.
When a Fan:OnOff object is used, this reported value is weighted by the system run time
fraction using the calculated infiltration sensible gain rate during the system on and off cycles
for the reporting period:
Infiltration Sensible Gain Rate = (Infiltration Sensible Gain Rate during on cycle * Run time
fraction) + Infiltration Sensible Gain Rate during off cycle * (1.0 Run time fraction)
AFN Zone Infiltration Sensible Heat Gain Energy [J]
The average convective sensible heat gain, in Joules, to the zone air corresponding to the
Zone Infiltration Volume averaged over the reporting period. This value is calculated for each
timestep when the outdoor dry-bulb temperature is higher than the zone temperature;
otherwise, the sensible gain rate is set to 0.
9/29/14

869

Input-Output Reference

Group Airflow Network

When a Fan:OnOff object is used, the reported value is weighted by the system run time
fraction using the calculated infiltration sensible gain during the system on and off cycles for
the reporting period:
Infiltration Sensible Gain = (Infiltration Sensible Gain during on cycle * Run time fraction) +
Infiltration Sensible Gain during off cycle * (1.0 Run time fraction)
AFN Zone Infiltration Sensible Heat Loss Rate [W]
The average convective sensible heat loss rate, in Watts, to the zone air corresponding to the
Zone Infiltration Volume averaged over the reporting period.
When a Fan:OnOff object is used, the reported value is weighted by the system run time
fraction using the calculated infiltration sensible loss rate during the system on and off cycles
for the reporting period:
Infiltration Sensible Loss Rate = (Infiltration Sensible Loss Rate during on cycle * Run time
fraction) + Infiltration Sensible Loss Rate during off cycle * (1.0 Run time fraction)
AFN Zone Infiltration Sensible Heat Loss Energy [J]
The average convective sensible heat loss, in Joules, to the zone air corresponding to the
Zone Infiltration Volume averaged over the reporting period.
When a Fan:OnOff object is used, the reported value is weighted by the system run time
fraction using the calculated infiltration sensible loss rate during the system on and off cycles
for the reporting period:
Infiltration Sensible Loss = (Infiltration Sensible Loss during on cycle * Run time fraction) +
Infiltration Sensible Loss during off cycle * (1.0 Run time fraction)
AFN Zone Infiltration Latent Heat Gain Rate [W]
The average convective latent heat gain rate, in Watts, to the zone air corresponding to the
Zone Infiltration Volume averaged over the reporting period, when the outdoor humidity ratio
is higher than the zone air humidity ratio.
When a Fan:OnOff object is used, the reported value is weighted by the system run time
fraction using the calculated infiltration latent gain rate during the system on and off cycles for
the reporting period:
Infiltration Latent Gain Rate = (Infiltration Latent Gain Rate during on cycle * Run time
fraction) + Infiltration Latent Gain Rate during off cycle * (1.0 Run time fraction)
AFN Zone Infiltration Latent Heat Gain Energy [J]
The total convective latent heat gain, in Joules, to the zone air corresponding to the Zone
Infiltration Volume summed over the reporting period.
When a Fan:OnOff object is used, the reported value is weighted by the system run time
fraction using the calculated infiltration latent gain during the system on and off cycles for the
reporting period:
Infiltration Latent Gain = (Infiltration Latent Gain during on cycle * Run time fraction) +
Infiltration Latent Gain during off cycle * (1.0 Run time fraction)
AFN Zone Infiltration Latent Heat Loss Rate [W]
The average convective latent heat loss rate, in Watts, to the zone air corresponding to the
Zone Infiltration Volume averaged over the reporting period.
When a Fan:OnOff object is used, the reported value is weighted by the system run time
fraction using the calculated infiltration latent loss rate during the system on and off cycles for
the reporting period:
Infiltration Latent Loss Rate = (Infiltration Latent Gain Loss Rate during on cycle * Run time
fraction) + Infiltration Latent Loss Rate during off cycle * (1.0 Run time fraction)

9/29/14

870

Input-Output Reference

Group Airflow Network

AFN Zone Infiltration Latent Heat Loss Energy [J]

The total convective latent heat loss, in Joules, to the zone air corresponding to the Zone
Infiltration Volume summed over the reporting period.
When a Fan:OnOff object is used, the reported value is weighted by the system run time
fraction using the calculated infiltration latent loss during the system on and off cycles for the
reporting period:
Infiltration Latent Loss = (Infiltration Latent Gain Loss during on cycle * Run time fraction) +
Infiltration Latent Loss during off cycle * (1.0 Run time fraction)
AFN Zone Mixing Sensible Heat Gain Rate [W]
The average convective sensible heat gain rate, in Watts, to the zone air corresponding to
the Zone Mixing Volume averaged over the reporting period. The mixing-volume is defined as
incoming volume flow from other adjacent zones where the air temperature is higher than the
temperature in this zone. For example, there are two zones (Zone 2 and Zone 3) adjacent to
this zone (Zone 1). Zone 1 receives airflows from both Zone 2 and Zone 3. The air
temperature is 21C in Zone 1. The air temperatures are 20C in Zone 2 and 22C in Zone 3.
The sensible gain rate only includes heat gain from Zone 3 with respect to Zone 1. The
energy received from Zone 2 is considered as a sensible loss, instead of a gain, because the
air temperature in Zone 2 is lower than in Zone 1.
When a Fan:OnOff object is used, the reported value is weighted by the system run time
fraction using the calculated mixing sensible gain rate during the system on and off cycles for
the reporting period:
Mixing Sensible Gain Rate = (Mixing Sensible Gain Rate during on cycle * Run time fraction)
+ Mixing Sensible Gain Rate during off cycle * (1.0 Run time fraction)
AFN Zone Mixing Sensible Heat Loss Rate [W]
The average convective sensible heat loss rate, in Watts, to the zone air corresponding to the
Zone Mixing Volume averaged over the reporting period.
When a Fan:OnOff object is used, the reported value is weighted by the system run time
fraction using the calculated mixing sensible loss rate during the on and off cycles for the
reporting period:
Mixing Sensible Loss Rate = (Mixing Sensible Loss Rate during on cycle * Run time fraction)
+ Mixing Sensible Loss Rate during off cycle * (1.0 Run time fraction)
AFN Zone Mixing Sensible Heat Gain Energy [J]
The total convective sensible heat gain, in Joules, to the zone air corresponding to the Zone
Mixing Volume summed over the reporting period.
When a Fan:OnOff object is used, the reported value is weighted by the system run time
fraction using the calculated mixing sensible gain during the on and off cycles for the
reporting period:
Mixing Sensible Gain = (Mixing Sensible Gain during on cycle * Run time fraction) + Mixing
Sensible Gain during off cycle * (1.0 Run time fraction)
AFN Zone Mixing Sensible Heat Loss Energy [J]
The total convective sensible heat loss, in Joules, to the zone air corresponding to the Zone
Mixing Volume summed over the reporting period.
When a Fan:OnOff object is used, the reported value is weighted by the system run time
fraction using the calculated mixing sensible loss during the on and off cycles for the
reporting period:
Mixing Sensible Loss = (Mixing Sensible Loss during on cycle * Run time fraction) + Mixing
Sensible Loss during off cycle * (1.0 Run time fraction)

9/29/14

871

Input-Output Reference

Group Airflow Network

AFN Zone Mixing Latent Heat Gain Rate [W]

The average convective latent heat gain rate, in Watts, to the zone air corresponding to the
Zone Mixing Volume averaged over the reporting period.
When a Fan:OnOff object is used, the reported value is weighted by the system run time
fraction using the calculated mixing latent gain rate during the on and off cycles for the
reporting period:
Mixing Latent Gain Rate = (Mixing Latent Gain Rate during on cycle * Run time fraction) +
Mixing Latent Gain Rate during off cycle * (1.0 Run time fraction)
AFN Zone Mixing Latent Heat Gain Energy [J]
The total convective latent heat gain, in Joules, to the zone air corresponding to the Zone
Mixing Volume summed over the reporting period.
When a Fan:OnOff object is used, the reported value is weighted by the system run time
fraction using the calculated mixing latent gain during the on and off cycles for the reporting
period:
Mixing Latent Gain = (Mixing Latent Gain during on cycle * Run time fraction) + Mixing Latent
Gain during off cycle * (1.0 Run time fraction)
AFN Zone Mixing Latent Heat Loss Rate [W]
The average convective latent heat loss rate, in Watts, to the zone air corresponding to the
Zone Mixing Volume averaged over the reporting period.
When a Fan:OnOff object is used, the reported value is weighted by the system run time
fraction using the calculated mixing latent loss rate during the on and off cycles for the
reporting period:
Mixing Latent Loss Rate = (Mixing Latent Loss Rate during on cycle * Run time fraction) +
Mixing Latent Loss Rate during off cycle * (1.0 Run time fraction)
AFN Zone Mixing Latent Heat Loss Energy [J]
The total convective latent heat loss, in Joules, to the zone air corresponding to the Zone
Mixing Volume summed over the reporting period.
When a Fan:OnOff object is used, the reported value is weighted by the system run time
fraction using the calculated mixing latent loss during the on and off cycles for the reporting
period:
Mixing Latent Loss = (Mixing Latent Loss during on cycle * Run time fraction) + Mixing Latent
Loss during off cycle * (1.0 Run time fraction)
AFN Zone Mixing CO2 Mass Flow Rate [kg/s]
This is a sum of mass flow rates from adjacent zones multiplied by the corresponding zone
carbon dioxide concentration level to the receiving zone. When a Fan:OnOff object is used,
the reported value is weighted by the system fan part-load ratio using the mixing mass flow
rate calculated during the fan on and off periods for the simulation timestep.
AFN Zone Mixing Generic Air Contaminant Mass Flow Rate [kg/s]
This is a sum of mass flow rates from adjacent zones multiplied by the corresponding zone
generic contaminant concentration level to the receiving zone. When a Fan:OnOff object is
used, the reported value is weighted by the system fan part-load ratio using the mixing mass
flow rate calculated during the fan on and off periods for the simulation timestep.
AFN Zone Duct Leaked Air Sensible Heat Gain Rate [W]
This is the average sensible heat gain rate, in Watts, to a specific zone due to supply air
leaks from the forced air distribution system. This value is averaged over the reporting period.
A sensible heat gain occurs when duct air is warmer than zone air. It should be pointed out
that when multiple supply air leaks are present in a single zone, the output value is the
9/29/14

872

Input-Output Reference

Group Airflow Network

summation of all the supply air leak gains in this zone. When a Fan:OnOff object is used, the
reported value is for the system on cycle.
AFN Zone Duct Leaked Air Sensible Heat Gain Energy [J]
This is the total sensible heat gain, in Joules, to a specific zone due to supply air leaks
summed over the reporting period. When a Fan:OnOff object is used, the reported value is
for the system on cycle.
AFN Zone Duct Leaked Air Sensible Heat Loss Rate [W]
This is the average sensible heat loss rate, in Watts, to a specific zone due to supply air leaks
from the forced air distribution system. This value is averaged over the reporting period. A
sensible heat loss occurs when duct air is cooler than zone air. It should be pointed out that
when multiple supply air leaks are present in this zone, the output value is the summation of
all the supply air leak losses in this zone. When a Fan:OnOff object is used, the reported
value is for the system on cycle.
AFN Zone Duct Leaked Air Sensible Heat Loss Energy [J]
This is the total sensible heat loss, in Joules, to a specific zone due to supply air leaks
summed over the reporting period. When a Fan:OnOff object is used, the reported value is
for the system on cycle.
AFN Zone Duct Leaked Air Latent Heat Gain Rate [W]
This is the average latent heat gain rate, in Watts, to a specific zone due to supply air leaks
from the forced air distribution system for the reported time period. When a Fan:OnOff object
is used, the reported value is for the system on cycle.
AFN Zone Duct Leaked Air Latent Heat Gain Energy [J]
This is the total latent heat gain, in Joules, to a specific zone due to supply air leaks summed
over the reporting period. When a Fan:OnOff object is used, the reported value is for the
system on cycle.
AFN Zone Duct Leaked Air Latent Heat Loss Rate [W]
This is the average latent heat loss rate, in Watts, to a specific zone due to supply air leaks
from the forced air distribution system for the reported time period. When a Fan:OnOff object
is used, the reported value is for the system on cycle.
AFN Zone Duct Leaked Air Latent Heat Loss Energy [J]
This is the total latent heat loss, in Joules, to a specific zone due to supply air leaks summed
over the reporting period. When a Fan:OnOff object is used, the reported value is for the
system on cycle.
AFN Zone Duct Conduction Sensible Heat Gain Rate [W]
This is the average sensible heat gain rate, in Watts, of duct conduction to a specific zone
where the ducts are located. This value is averaged over the reporting period. A sensible
heat gain occurs when duct air is warmer than the zone air. It should be pointed out that
when ducts are located in different zones, the total duct conduction loss should be the
summation of the duct conduction losses in these zones. When a Fan:OnOff object is used,
the reported value is for the system on cycle.
AFN Zone Duct Conduction Sensible Heat Gain Energy [J]
This is the total sensible heat gain, in Joules, to a specific zone due to duct conduction
summed over the reporting period. When a Fan:OnOff object is used, the reported value is
for the system on cycle.

9/29/14

873

Input-Output Reference

Group Airflow Network

AFN Zone Duct Conduction Sensible Heat Loss Rate [W]

This is the average sensible heat loss rate, in Watts, of duct conduction to a specific zone
where the ducts are located. This value is averaged over the reporting period. A sensible
heat loss occurs when duct air is cooler than the zone air. When a Fan:OnOff object is used,
the reported value is for the system on cycle.
AFN Zone Duct Conduction Sensible Heat Loss Energy [J]
This is the total sensible heat loss, in Joules, to a specific zone due to duct conduction
summed over the reporting period. When a Fan:OnOff object is used, the reported value is
for the system on cycle.
AFN Zone Duct Diffusion Latent Heat Gain Rate [W]
This is the average latent heat gain rate, in Watts, of vapor diffusion through the walls of the
air distribution system to a specific zone where the ducts are located. This value is averaged
over the reporting period. When a Fan:OnOff object is used, the reported value is for the
system on cycle.
AFN Zone Duct Diffusion Latent Heat Gain Energy [J]
This is the total latent heat gain, in Joules, to a specific zone due to duct vapor diffusion
summed over the reporting period. When a Fan:OnOff object is used, the reported value is
for the system on cycle.
AFN Zone Duct Diffusion Latent Heat Loss Rate [W]
This is the average latent heat loss rate, in Watts, of duct vapor diffusion to a specific zone
where the ducts are located. This value is averaged over the reporting period. When a
Fan:OnOff object is used, the reported value is for the system on cycle.
AFN Zone Duct Diffusion Latent Heat Loss Energy [J]
This is the total latent heat loss, in Joules, to a specific zone due to duct vapor diffusion
summed over the reporting period. When a Fan:OnOff object is used, the reported value is
for the system on cycle.
AFN Distribution Sensible Heat Gain Rate [W]
This is the average total sensible heat gain rate, in Watts, in a specific zone caused by the
forced air distribution system. The total sensible gain rate is the sum of duct leakage sensible
gain rate and duct conduction sensible gain rate. This value is averaged over the reporting
period. The multizone airflow sensible gain rate is excluded in this output variable. The output
of multizone airflow sensible gain is reported in the previously-described output variables
AFN Zone Infiltration Sensible Heat Gain Rate and AFN Zone Mixing Sensible Heat Gain
Rate. When a Fan:OnOff object is used, the reported value is for the system on cycle.
AFN Distribution Sensible Heat Gain Energy [J]
This is the total sensible heat gain, in Joules, in a specific zone caused by the forced air
distribution system. The total sensible gain is the sum of duct leakage sensible gain and duct
conduction sensible gain. This value is summed over the reporting period. The multizone
airflow sensible gain is excluded in this output variable. The output of multizone airflow
sensible gain is reported in the previously-described output variables AFN Zone Infiltration
Sensible Heat Gain Energy and AFN Zone Mixing Sensible Heat Gain Energy. When a
Fan:OnOff object is used, the reported value is for the system on cycle.
AFN Distribution Sensible Heat Loss Rate [W]
This is the average total sensible heat loss rate, in Watts, in a specific zone caused by the
forced air distribution system. The total sensible loss rate is the sum of duct leakage sensible
loss rate and duct conduction sensible loss rate. This value is averaged over the reporting
period. The multizone airflow sensible loss rate is excluded in this output variable. The output
9/29/14

874

Input-Output Reference

Group Airflow Network

of multizone airflow sensible loss rate is reported in the previously-described output variables
AFN Zone Infiltration Sensible Heat Loss Rate and AFN Zone Mixing Sensible Heat Loss
Rate. When a Fan:OnOff object is used, the reported value is for the system on cycle.
AFN Distribution Sensible Heat Loss Energy [J]
This is the total sensible heat loss, in Joules, in a specific zone caused by the forced air
distribution system. The total sensible loss is the sum of duct leakage sensible loss and duct
conduction sensible loss. This value is summed over the reporting period. The multizone
airflow sensible loss is excluded in this output variable. The output of multizone airflow
sensible loss is reported in the previously-described output variables AFN Zone Infiltration
Sensible Heat Loss Energy and AFN Zone Mixing Sensible Heat Loss Energy. When a
Fan:OnOff object is used, the reported value is for the system on cycle.
AFN Distribution Latent Heat Gain Rate [W]
This is the average total latent heat gain rate, in Watts, in a specific zone caused by the
forced air distribution system. The total latent gain rate is the sum of duct leakage latent gain
rate and duct conduction latent gain rate. This value is averaged over the reporting period.
When a Fan:OnOff object is used, the reported value is for the system on cycle.
AFN Distribution Latent Heat Gain Energy [J]
This is the total latent heat gain, in Joules, in a specific zone caused by the forced air
distribution system. The total latent gain is the sum of duct leakage latent gain and duct
diffusion latent gain. This value is summed over the reporting period. When a Fan:OnOff
object is used, the reported value is for the system on cycle.
AFN Distribution Latent Heat Loss Rate [W]
This is the average total latent heat loss rate, in Watts, in a specific zone caused by the
forced air distribution system. The total latent loss rate is a sum of duct leakage latent loss
rate and duct diffusion latent loss rate. This value is averaged over the reporting period.
When a Fan:OnOff object is used, the reported value is for the system on cycle.
AFN Distribution Latent Heat Loss Energy [J]
This is the total latent heat loss, in Joules, in a specific zone caused by the forced air
distribution system. The total latent loss is the sum of duct leakage latent loss and duct
diffusion latent loss. This value is summed over the reporting period. When a Fan:OnOff
object is used, the reported value is for the system on cycle.
NOTE: The following output variables should not be confused with similar output variables for the
infiltration, mixing, and cross mixing objects (Ref. Infiltration Output, Mixing Output, or Cross Mixing
Output). The output variables described below refer to infiltration, mixing, and cross-mixing when an
Airflow Network Simulation is performed. The following output variables are always used to describe
infiltration, mixing, and cross mixing when the AirflowNetwork Control field in the
AirflowNetwork:SimulationControl
object
is
set
to
MultizoneWithoutDistribution
or
MultizoneWithDistribution. In this case the output variables for the infiltration, mixing, and cross mixing
objects will always be 0.
In contrast, the following output variables are only used to describe infiltration, mixing, and cross mixing
when the AirflowNetwork Control field in the AirflowNetwork:SimulationControl object is set to
MultizoneAirflowWithDistributionOnlyDuringFanOperation and the fan is operating. When the fan is not
operating, the output variables for the infiltration, mixing, and cross mixing objects are used.
In the case where the AirflowNetwork Control field in the AirflowNetwork:SimulationControl object is set to
NoMultizoneOrDistribution, the following output variables are not used and the output variables for the
infiltration, mixing, and cross mixing objects are used instead.

9/29/14

875

Input-Output Reference

Group Airflow Network

AFN Zone Infiltration Sensible Heat Gain Energy [J]

The total convective sensible heat gain, in Joules, to the zone air corresponding to the Zone
Infiltration Volume summed over the reporting period. This value is calculated for each
timestep when the outdoor dry-bulb temperature is higher than the zone temperature,
otherwise the sensible gain is set to 0. When a Fan:OnOff object is used, the reported value
is for the system on cycle.
AFN Zone Infiltration Sensible Heat Loss Energy [J]
The total convective sensible heat loss, in Joules to the zone air corresponding to the Zone
Infiltration Volume summed over the reporting period. When a Fan:OnOff object is used, the
reported value is for the system on cycle.
AFN Zone Infiltration Volume [m3]
The volume of outdoor air flow into the zone from window/door openings and cracks in the
exterior surfaces of the zone (i.e., the sum of ventilation and crack flows from the exterior into
the zone). The zone air density is used to calculate the zone infiltration volume based on the
mass flow rate. Note that AirflowNetwork Zone Infiltration Volume will be zero if all of the
flows through the zones exterior surfaces are out of the zone. When a Fan:OnOff object is
used, the reported value is weighted by the system fan part-load ratio using the infiltration
volume calculated during the fan on and off periods for the simulation timestep.
AFN Zone Infiltration Mass [kg]
The mass of air corresponding to the AirflowNetwork Zone Infiltration Volume. When a
Fan:OnOff object is used, the reported value is weighted by the system fan part-load ratio
using the infiltration mass calculated during the fan on and off periods for the simulation
timestep.
AFN Zone Infiltration Air Change Rate [ach]
The number of air changes per hour produced by outdoor air flow into the zone from
window/door openings and cracks in the exterior surfaces of the zone (i.e. the sum of
ventilation and crack flows from the exterior into the zone). The target zone air density is
used to calculate the zone infiltration air change rate based on the mass flow rate Note that,
like Zone Infiltration Volume, Zone Infiltration Air Change Rate will be zero if all flows through
the zones exterior surfaces are out of the zone. When a Fan:OnOff object is used, the
reported value is weighted by the system fan part-load ratio using the infiltration air change
rate calculated during the fan on and off periods for the simulation timestep.
AFN Zone Mixing Volume [m3]
This is a measure of interzone air flow for each thermal zone. It is the volume of air flow into
the zone from adjacent zones through window/door openings and cracks in the interior heat
transfer surfaces of the zone. The target zone air density is used to calculate the zone mixing
volume based on the mass flow rate. This variable does not include flows that are from the
zone to adjacent zones. Note that Zone Mixing Volume will be zero if all flows through the
zones interior surfaces are out of the zone. When a Fan:OnOff object is used, the reported
value is weighted by the system fan part-load ratio using the mixing volume calculated during
the fan on and off periods for the simulation timestep.
AFN Zone Mixing Mass [kg]
The mass of air corresponding to the AFN Zone Mixing Volume. When a Fan:OnOff object is
used, the reported value is weighted by the system fan part-load ratio using the mixing mass
calculated during the fan on and off periods for the simulation timestep.
AFN Zone Mixing Mass Flow Rate [kg/s]
This is a sum of mass flow rates from adjacent zones to the receiving zone. When a
Fan:OnOff object is used, the reported value is weighted by the system fan part-load ratio
9/29/14

876

Input-Output Reference

Group Zone Equipment

using the mixing mass flow rate calculated during the fan on and off periods for the simulation
timestep.
AFN Zone Outdoor Air CO2 Mass Flow Rate [kg/s]
This is a sum of mass flow rates from outdoors multiplied by the outdoor carbon dioxide
concentration level to the receiving zone. When a Fan:OnOff object is used, the reported
value is weighted by the system fan part-load ratio using the outdoor mass flow rate
calculated during the fan on and off periods for the simulation timestep.
AFN Zone Outdoor Air Generic Air Contaminant Mass Flow Rate [kg/s]
This is a sum of mass flow rates from outdoors multiplied by the outdoor generic air
contaminant concentration level to the receiving zone. When a Fan:OnOff object is used, the
reported value is weighted by the system fan part-load ratio using the outdoor mass flow rate
calculated during the fan on and off periods for the simulation timestep
AFN Zone Outdoor Air Mass Flow Rate [kg/s]
This is a sum of mass flow rates from outdoors to the receiving zone. When a Fan:OnOff
object is used, the reported value is weighted by the system fan part-load ratio using the
outdoor mass flow rate calculated during the fan on and off periods for the simulation
timestep.
AFN Zone Total CO2 Mass Flow Rate [kg/s]
This is a sum of mass flow rates from adjacent zones or outdoors multiplied by the carbon
dioxide concentration differences between the corresponding zone and the receiving zone.
AFN Zone Total Generic Air Contaminant Mass Flow Rate [kg/s]
This is a sum of mass flow rates from adjacent zones or outdoors multiplied by the generic
contaminant concentration differences between the corresponding zone and the receiving
zone.

Group Zone Equipment

There are five main zone equipment statements that must be used to describe a block of
zone equipment as shown in the below figure Zone Equipment Input Syntax Map.
Types of Zone equipment are listed below and shown below in figure Zone Equipment.
Table 26. Available Zone Equipment Types

Air Distribution Equipment

Zone Forced Air Units

9/29/14

AirTerminal:SingleDuct:Uncontrolled
AirTerminal:SingleDuct:ConstantVolume:Reheat
AirTerminal:SingleDuct:VAV:Reheat
AirTerminal:SingleDuct:VAV:NoReheat
AirTerminal:SingleDuct:VAV:Reheat:VariableSpeedFan
AirTerminal:DualDuct:ConstantVolume
AirTerminal:DualDuct:VAV
Powered Induction Units (Series and Parallel)
ZoneHVAC:IdealLoadsAirSystem
ZoneHVAC:FourPipeFanCoil
ZoneHVAC:WindowAirConditioner
ZoneHVAC:RefrigerationChillerSet
Unit Ventilator/Heater

877

Input-Output Reference

Group Zone Equipment

Air-to-Air Heat Pumps

Unitary Systems (heat only and heat/cool)
Furnaces (heat only and heat/cool)
Energy Recovery Ventilator:Stand Alone
CoilSystem:Cooling:DX
Radiative/Convective Units

9/29/14

Baseboard Heaters
Low Temp Radiant Systems
High Temp Radiant System

878

Input-Output Reference

Group Zone Equipment

Figure 99. Zone Equipment Input Syntax Map

9/29/14

879

Input-Output Reference

Group Zone Equipment

Zone
Supply Air
Splitter

Return Air
Path

Dual
Duct
Constant
Volume
(CV)

Zone Exhaust Branch (Opt.)

Dual
Duct
VAV

Air
Distribution
Unit

Zone 1

Select One

Low
Temp
Radiant

Select One

High
Temp
Radiant/
Convective

None

Single
Duct CV
Reheat

Air
Distribution
Unit
Options

Single
Duct
VAV:
Reheat

Local
Convective
Units

Select One
Select
One

Low
Temp
Radiant
Panels
Low Temp Rad
Alternatives

High
Temp
Radiators

Baseboards

Radiators

Window
AC

Fan Coil

Hi Temp Rad/Conv
Alternatives

Unit
Heater/
Ventilator

Air-Air
HP

Water-Air
HP &
Ground
Source
HP

Local Conv. Unit Alternatives

Figure 100. Representative Zone Equipment

The following figure (Air Loop/Zone Equipment Node Diagram) illustrates the connection
between the zone equipment and the air loop systems.
from
supply
fan
Air
Loop

Air Loop Splitter

5
CC

3
HC

4
Zone
7
Equipment

6
11

to mixing
dampers

Figure 101. Air Loop/Zone Equipment Node Diagram

Each zone served by an HVAC system must have three additional statements to complete
the zone equipment specification. An ZoneHVAC:AirDistributionUnit allows equipment
9/29/14

880

Input-Output Reference

Group Zone Equipment

typically found within the zone inlet ductwork (such as dampers, reheat coils, etc.) to be
attached to the supply air stream for a particular zone. A ZoneControl statement will allow the
conditions in the zone to be managed. Finally, a ZoneHVAC:EquipmentConnections
statement describes all of the pertinent information about the zone from an HVAC
perspective. Each of these statements is described in more detail below.
ZoneHVAC:AirDistributionUnit
The ZoneHVAC:AirDistributionUnit object gives further information on what air loop
equipment (air terminal units) will be serving a particular
zone. The
ZoneHVAC:AirDistributionUnit is the part of the system that is supplied from a common main
air handler simulated in the Air Loop Simulation and includes the equipment that controls or
tempers the air going to each individual zone according to the desired thermostatic control.
The current options for ZoneHVAC:AirDistributionUnit terminal unit types are:
AirTerminal:DualDuct:ConstantVolume
AirTerminal:DualDuct:VAV
AirTerminal:DualDuct:VAV:OutdoorAir
AirTerminal:SingleDuct:ConstantVolume:Reheat
AirTerminal:SingleDuct:VAV:Reheat
AirTerminal:SingleDuct:VAV:NoReheat
AirTerminal:SingleDuct:SeriesPIU:Reheat
AirTerminal:SingleDuct:ParallelPIU:Reheat
AirTerminal:SingleDuct:ConstantVolume:FourPipeInduction
AirTerminal:SingleDuct:VAV:Reheat:VariableSpeedFan
AirTerminal:SingleDuct:VAV:HeatAndCool:Reheat
AirTerminal:SingleDuct:VAV:HeatAndCool:NoReheat

Connections between the air distribution unit, the supply air duct, and the zone are specified
in the input syntax for the air distribution unit and the AirLoopHVAC:ZoneSplitter. The input
syntax also explicitly defines an outlet identifier. This implies a connection to a zone through
a NodeList for zone inlets (see the ZoneHVAC:EquipmentConnections statement). The air
distribution unit is limited to one combined component-controller unit; because controls are
normally based on the zone thermostat and can work in parallel or series in complex fashion.
Since the control and the flow resolution can be complex, each air distribution unit is unique
in addressing these combinations and therefore only one is allowed per zone.
The Air Distribution unit also allows the user to specify leaks in the supply air duct system.
These inputs are used in the EnergyPlus Simplified Duct Leakage Model (SDLM). This model
simulates a specific configuration: supply leaks to a return plenum in a commercial VAV or
CV system. The system must have a constant static pressure setpoint. Within these
limitations SDLM allows the user to easily evaluate the energy penalty due to duct leakage.
Field: Name
Unique identifying name of the air distribution unit.
Field: Air Distribution Unit Outlet Node Name
Outlet node name for the air distribution unit to the attached zone.
Field: Air Terminal Object Type
Single combined component/controller unit for that attached zone. Selection of components
as listed above.
Field: Air Terminal Name
The unique identifying component name.
Field: Nominal Upstream Leakage Fraction
This is the leakage upstream of the terminal unit as a fraction of the design flow rate through
the unit. It is the leakage fraction at the design flow rate. It is used to calculate a leakage flow
9/29/14

881

Input-Output Reference

Group Zone Equipment

rate which is then held constant while the system air flow varies. This input is optional; the
default is zero.
Field: Constant Downstream Leakage Fraction
This is the leakage downstream of the terminal unit as a fraction of the current flow rate
through the terminal unit. This fraction is held constant, so the leakage flow rate will vary
proportinally with the supply air flow rate. This input is optional; the default is zero.
Two example IDF excerpts (one with duct leakage, one without):
ZoneHVAC:AirDistributionUnit,
SPACE1-1 ATU,
!- Air Distribution Unit Name
SPACE1-1 In Node,
!- Air Dist Unit Outlet Node Name
AIRTERMINAL:SINGLEDUCT:VAV:REHEAT, !- KEY--System Component Type 1
SPACE1-1 VAV Reheat;
!- Component Name 1
ZoneHVAC:AirDistributionUnit,
SPACE4-1 ATU,
!- Air Distribution Unit Name
SPACE4-1 In Node,
!- Air Dist Unit Outlet Node Name
AIRTERMINAL:SINGLEDUCT:VAV:REHEAT, !- KEY--System Component Type 1
SPACE4-1 VAV Reheat,
!- Component Name 1
0.05,
!- upstream nominal leakage fraction
0.07;
!- downstream constant leakage fraction

ZoneHVAC:EquipmentConnections
Finally, the ZoneHVAC:EquipmentConnections statement defines the remaining details about
each thermal zone from an HVAC perspective (besides the controls which were defined
above). As with other statements, the first two items in this object are the keyword and an
identifying name which links the zone back to its geometrical input, internal gains, etc. and
other statements in the HVAC section of the input. The next three items are names of lists
(equipment, air inlet nodes, and air exhaust nodes) that are described in more detail below.
Note that if there are no air exhaust nodes from the zone that field is left blank. And if there
are no air inlet nodes, that field is left blank. Finally, two node names are necessary to
complete the zone-HVAC description. The first node is the main air node for the zone upon
which the air heat balance is performed. The other node begins the return air path from the
zone.
Note that all nodes mentioned in the ZoneHVAC:EquipmentConnections input must be unique. That is, all
nodes in all the ZoneHVAC:EquipmentConnections statements referenced by the Zone Air Inlet Nodes,
Zone Air Exhaust Nodes, Zone Air Node Name and Zone Return Air Node Name cannot have any
node name appearing more than once.

Field: Zone Name

Name links this equipment list back to the heat balance for the zone.
Field: Zone Conditioning Equipment List Name
List of zone equipment for this zone in a ZoneHVAC:EquipmentList object. This list will
consist of air distribution units or other direct convection or radiant equipment, i.e. window air
conditioner, baseboard, fan coils, etc.
Field: Zone Air Inlet Node or NodeList Name
There can be more than one air inlet node depending on how many pieces of equipment are
in the ZoneHVAC:EquipmentList. Generally there will be one air inlet node for each piece of
zone equipment that delivers conditioned air to the zone. Components such as electric or hot
water baseboards and radiant systems do not require zone air inlet nodes. If there is only one
node its name can be put in this field. If there is more than one node, this must be the name

9/29/14

882

Input-Output Reference

Group Zone Equipment

of a node list object (a node list object can also contain only one node name). If this field is
not required (as in the baseboard system), it should be blank.
Field: Zone Air Exhaust Node or NodeList Name
List of exhaust nodes leaving the zone for exhaust fans, zone energy recovery, etc. However
these nodes are also used as sources of zone air for zone components such as fan coil units,
unit heaters and ventilators, and window air conditioners. For each such component attached
to a zone there should be a unique zone exhaust node acting as the inlet node to the
component. If there is only one node its name can be put in this field. If there is more than
one node, this must be the name of a node list object (a node list object can also contain only
one node name). If there are no air exhaust nodes, this field should be blank.
Field: Zone Air Node Name
The conditions at this node represent the average state of the air in the zone. For zones
modeled as fully mixed the conditions at this node are assumed to represent the air in the
entire zone. This field is required for all ZoneHVAC:EquipmentConnections statements.
Field: Zone Return Air Node Name
The name of the return air node which attaches the zone to the return air path described
above. Even if there is no return air or no return air path a unique name must be entered in
this field. The conditions at this node represent the state of the air leaving the zone including
any heat gain from light-heat-to-return.
An example of this statement in an IDF is:
ZoneHVAC:EquipmentConnections,
SPACE3-1,
!- Zone
SPACE3-1 Eq,
!- List
SPACE3-1 In Nodes,
!- List
,
!- List
SPACE3-1 Node,
!- Zone
SPACE3-1 Out Node;
!- Zone

Name
Name: Zone Equipment
Name: Zone Air Inlet Nodes
Name: Zone Air Exhaust Nodes
Air Node Name
Return Air Node Name

ZoneHVAC:EquipmentList
The first list encountered in the ZoneHVAC:EquipmentConnections statement is the
ZoneHVAC:EquipmentList. This object lists all HVAC equipment serving the zone. Each item
in the list has four fields associated with it: Object Type, Name, Cooling Sequence and
Heating or No-Load Sequence The Object Type and Name identify the specific equipment
object. Cooling Sequence and Heating or No-Load Sequence specify the order of simulation
for zones with more than one type of HVAC equipment.
Note that a ZoneHVAC:AirDistributionUnit or AirTerminal:SingleDuct:Uncontrolled must be
listed in this statement if there is a forced air system serving the zone from an air loop.
Field: Name
Unique identifying name.
Field Set (Zone Equipment: Object Type, Name, Cooling Sequence, Heating or No-Load
Sequence)
This set is used together in order to sequence the equipment for heating and cooling. The #1
sequence equipment will try to meet the entire demand with its capacity and then pass the
results on to the #2 and so on for both heating and cooling. This field set is extensible by
duplicating the last four fields.
Equipment is simulated in the order specified by Zone Equipment Cooling Sequence and
Zone Equipment Heating or No-Load Sequence, depending on the current thermostat
request. For equipment of similar type, assign sequence 1 to the first system intended to
serve that type of load, assign sequence 2 to the next system, and so on. For situations
where one or more equipment types has limited capacity or limited control capability, order
9/29/14

883

Input-Output Reference

Group Zone Equipment

the sequence so that the most controllable piece of equipment runs last. For example, with a
dedicated outdoor air system (DOAS), the air terminal for the DOAS should be assigned
Heating Sequence = 1 and Cooling Sequence = 1. Any other equipment should be assigned
sequence 2 or higher so that it will see the net load after the DOAS air is added to the zone.
Field: Zone Equipment <x> Object Type
Type of zone equipment such as air distribution unit, baseboard, window air conditioner, etc.
The current legal types are listed in the following table:
Table 27. Legal Zone Equipment Types (ZoneHVAC:EquipmentList)
Legal Zone Equipment Types
AirTerminal:SingleDuct:Uncontrolled
Fan:ZoneExhaust
WaterHeater:HeatPump
ZoneHVAC:AirDistributionUnit
ZoneHVAC:Baseboard:Convective:Electric
ZoneHVAC:Baseboard:Convective:Water
ZoneHVAC:Baseboard:RadiantConvective:Electric
ZoneHVAC:Baseboard:RadiantConvective:Water
ZoneHVAC:Baseboard:RadiantConvective:Steam
ZoneHVAC:Dehumidifier:DX
ZoneHVAC:EnergyRecoveryVentilator
ZoneHVAC:FourPipeFanCoil
ZoneHVAC:HighTemperatureRadiant
ZoneHVAC:IdealLoadsAirSystem
ZoneHVAC:LowTemperatureRadiant:ConstantFlow
ZoneHVAC:LowTemperatureRadiant:Electric
ZoneHVAC:LowTemperatureRadiant:VariableFlow
ZoneHVAC:OutdoorAirUnit
ZoneHVAC:PackagedTerminalAirConditioner
ZoneHVAC:PackagedTerminalHeatPump
ZoneHVAC:RefrigerationChillerSet
ZoneHVAC:UnitHeater
ZoneHVAC:UnitVentilator
ZoneHVAC:WindowAirConditioner
ZoneHVAC:WaterToAirHeatPump
ZoneHVAC:VentilatedSlab
Field: Zone Equipment <x> Name
Name of the zone equipment used in the object definition of its type.
Field: Zone Equipment <x> Cooling Sequence
Specifies the zone equipment simulation order when the zone thermostat requests cooling.
Field: Zone Equipment <x> Heating or No-Load Sequence

9/29/14

884

Input-Output Reference

Group Air Distribution Equipment

Specifies the zone equipment simulation order when the zone thermostat requests heating or
no load.
Examples of this statement in an IDF are:
ZoneHVAC:EquipmentList,
Zone1Equipment,
!- Name
ZoneHVAC:AirDistributionUnit, !- Zone Equipment 1 Object Type
Zone1TermReheat,
!- Zone Equipment 1 Name
1,
!- Zone Equipment 1 Cooling Sequence
1;
!- Zone Equipment 1 Heating or No-Load Sequence
ZoneHVAC:EquipmentList,
Zone1Equipment,
!- Name
AirTerminal:SingleDuct:Uncontrolled, !- Zone Equipment 1 Object Type
Zone1DirectAir,
!- Zone Equipment 1 Name
1,
!- Zone Equipment 1 Cooling Sequence
1,
!- Zone Equipment 1 Heating or No-Load Sequence
ZoneHVAC:WaterToAirHeatPump, !- Zone Equipment 2 Object Type
Zone1WTAHP,
!- Zone Equipment 2 Name
2,
!- Zone Equipment 2 Cooling Sequence
2;
!- Zone Equipment 2 Heating or No-Load Sequence

Group Air Distribution Equipment

The systems described in the Air Distribution Units (ADUs) are shown below. A variety of air
terminal units are available for connecting air systems to thermal zones. These single
description ADUs contain the reference to the components and the actual controls in one
block of input. The idea is that the control volume is drawn tightly around the controls and
loosely around the components. This allows complex interactions to take place between all of
the components that respond to the Zone Thermostatic Control output. The coils that are
referenced in the ADUs are explained fully in the Coils section of this manual.
AirTerminal:SingleDuct:Uncontrolled
Central system air is usually supplied to a zone through a terminal unit such as a single duct
VAV reheat box. Sometimes, however, it is desirable to supply central system air directly to a
zone without any zone level control or tempering. An example would be a single zone reheat
system.
The control zone receives supply air directly from the central system since the supply air
temperature has been adjusted to control the temperature in the control zone. The slave
zones then have baseboards or reheat coils to allow some temperature adjustment. The
AirTerminal:SingleDuct:Uncontrolled object creates the capability of supplying central system
air directly to a zone. Its input consists of the object name, an availability (on/off) schedule,
and a node name. This node is both a zone inlet node and an outlet node of the
AirLoopHVAC:ZoneSplitter.
For the objects to work correctly, it is important in any systems including Direct Air objects for
the sum of the maximum zone air flow rates to be equal to the maximum central system flow
rate. The zone maximum flow rates are specified in the zone terminal unit or direct air inputs.
The central air system flow rate is specified in the AirLoopHVAC input and also in the air loop
branch and central fan inputs.
Field: Name
A unique user assigned name for each AirTerminal:SingleDuct:Uncontrolled component. Any
other component that needs to use this direct air component will refer to it by this name.
Field: Availability Schedule Name
The name of the schedule (ref: Schedule) that denotes whether the component can run
during a given time period. A schedule value greater than 0 (usually 1 is used) indicates that
9/29/14

885

Input-Output Reference

Group Air Distribution Equipment

the component can be on during the time period. A value less than or equal to 0 (usually 0 is
used) denotes that the component must be off for the time period. If this field is blank, the
schedule has values of 1 for all time periods.
Field: Zone Supply Air Node Name
The name of the node to which the component is supplying air. This should be one of the
supply air nodes for the zone the component is serving. This node should also be an outlet
node of a AirLoopHVAC:ZoneSplitter component.
Field: Maximum Air Flow Rate
The
design
maximum
volume
flow
rate
(m 3/sec)
AirTerminal:SingleDuct:Uncontrolled object. This field is autosizable.
An example input follows.

specified

for

the

AirTerminal:SingleDuct:Uncontrolled,
Zone1DirectAir,
FanAndCoilAvailSched,
Zone 1 Inlet Node,
0.47;
AirTerminal:SingleDuct:Uncontrolled,
Zone2DirectAir,
FanAndCoilAvailSched,
Zone 2 Inlet Node,
0.36;
AirTerminal:SingleDuct:Uncontrolled,
Zone3DirectAir,
FanAndCoilAvailSched,
Zone 3 Inlet Node,
0.47;

Single Duct Uncontrolled AirTerminal Outputs

HVAC,Sum,Zone Air
HVAC,Sum,Zone Air
HVAC,Average,Zone
HVAC,Average,Zone

Terminal Sensible Heating Energy [J]

Terminal Sensible Cooling Energy [J]
Air Terminal Sensible Heating Rate [W]
Air Terminal Sensible Cooling Rate [W]

Zone Air Terminal Sensible Heating Energy [J]

Zone Air Terminal Sensible Heating Rate [W]
These outputs are the sensible heating power and energy provided to the zone by the
uncontrolled air terminal unit.
Zone Air Terminal Sensible Cooling Energy [J]
Zone Air Terminal Sensible Cooling Rate [W]
These outputs are the sensible cooling power and energy provided to the zone by the
uncontrolled air terminal unit.
AirTerminal:SingleDuct:ConstantVolume:Reheat
The AirTerminal:SingleDuct:ConstantVolume:Reheat or terminal reheat system is a constant
volume reheat system. The systems cooling capabilities are provided by way of cooling coil
that supplies cooling to the entire supply air volume. The cooling coil is controlled by a
controller setpoint specified for the cooling coil. Zone control is accomplished by heating
(reheating) the airflow into each zone as determined by the zone thermostat. Currently the
reheat can be supplied by a electric, gas, or hot water coil that tries to meet the zone
demand.
Field: Name
Unique name for the terminal reheat Air Distribution Unit (ADU).
9/29/14

886

Input-Output Reference

Group Air Distribution Equipment

Field: Availability Schedule Name

Schedule that this component will operate or is available to operate. A schedule value greater
than 0 (usually 1 is used) indicates that the component can be on during the time period. A
value less than or equal to 0 (usually 0 is used) denotes that the component must be off for
the time period. If this field is blank, the schedule has values of 1 for all time periods.
Field: Air Outlet Node Name
The outlet node from the ADU to the zone. This is the same node as the reheat component
air outlet node.
Field: Air Inlet Node Name
The air-inlet node name that connects the air splitter to the individual zone ADU. This is the
same node as the reheat component air inlet node.
Field: Maximum Air Flow Rate
The design constant volume flow rate (m 3/sec) specified for the terminal reheat ADU.
Control Fields:
The last several fields for this object describe the type of reheat coil that is being used and
how it is controlled. Most of the fields pertain to the hot water coil since the gas and electric
coil are much more simplified.
Field: Hot Water or Steam Inlet Node Name
For the hot water reheat coil there is a node on the water side that would control the flow to
the coil capacity to allow the coil to meet the zone demand. This control location is the name
of the control node for the terminal reheat ADU. For the gas and electric coil this is left blank.
Field: Reheat Coil Object Type
The valid reheat component objects currently available are:
Coil:Heating:Water
Coil:Heating:Electric
Coil:Heating:Gas
Coil:Heating:Steam

Field: Reheat Coil Name

Reheat Coil Object name being simulated with this ADU. Applicable for all coils.
Field: Maximum Hot Water or Steam Flow Rate
This field is zero for gas and electric coils. Set to the maximum design hot water or steam
volumetric flow rate in m3/s for the hot water or steam heating coil. The steam volumetric flow
rate is calculated at 100C and 101325 Pa.
Field: Minimum Hot Water or Steam Flow Rate
This field is zero for gas and electric coils. Set to the minimum design hot water or steam
volumetric flow rate in m 3/s for the hot water or steam coil, normally set to be a shut off valve
that is set to zero. The steam volumetric flow rate is calculated at 100C and 101325 Pa.
Field: Convergence Tolerance
The coil is controlled by knowing the zone demand determined by the zone thermostat and
setting the outlet conditions to meet this demand. For the electric and gas coils, this is set
exactly since the coil model solution can be inverted. With the hot water coil that uses an
effectiveness-NTU method, the solution cannot be inverted directly. Therefore, to determine
the correct mass flow rate for the hot water the solution is solved for by iteration. The iterative
solution uses an interval halving routine and needs a termination criteria that is set with the
9/29/14

887

Input-Output Reference

Group Air Distribution Equipment

Convergence Tolerance parameter. This control offset is set to a decimal fraction of the zone
demand as the criteria, i.e. 0.001. The default for the field is 0.001.
Field: Maximum Reheat Air Temperature
This is the upper limit on the temperature in degrees C of the air leaving the terminal unit
reheat coil (and being delivered to the zone). If the user leaves this field blank, no maximum
reheat air temperature is enforced.
An IDF example:
AirTerminal:SingleDuct:ConstantVolume:Reheat,
Reheat Zone 1, !- Name of System
FanAndCoilAvailSched, !- Availability schedule for VAV System
Zone 1 Reheat Air Outlet Node, !- Unit Air Outlet Node
Zone 1 Reheat Air Inlet Node, !- Unit Air Inlet Node
0.59, !- Maximum air flow rate {m3/s}
, !- Control node
COIL:Gas:Heating, !- Reheat Component Object
Reheat Coil Zone 1, !- Name of Reheat Component
0.0, !- Max Reheat Water Flow {m3/s}
0.0, !- Min Reheat Water Flow {m3/s}
0.001; !- Convergence Tolerance

Single Duct Constant Volume Reheat AirTerminal Outputs

There are no outputs for the constant volume reheat air terminal.
AirTerminal:SingleDuct:VAV:Reheat
AirTerminal:SingleDuct:VAV:Reheat - Variable air volume (VAV) systems control the dry-bulb
temperature inside a zone by varying the supply air volume instead of the air temperature. At
full cooling the VAV damper is fully open supplying the specified maximum air flow rate. As
the cooling load decreases, the damper closes until it reaches the minimum stop specified by
the zone minimum air flow fraction.
VAV systems can be used for interior or perimeter zones with a common fan system, air
temperature control, and reheating devices. The VAV concept may vary according to the VAV
box locations, air temperature controls and types of heating elements. Heating can usually be
provided by use of reheat coils or thermostatic baseboard.
Field: Name
Unique name for the AirTerminal:SingleDuct:VAV:Reheat Air Distribution Unit (ADU).
Field: Availability Schedule Name
Schedule that this component will operate or is available to operate. A schedule value greater
than 0 (usually 1 is used) indicates that the component can be on during the time period. A
value less than or equal to 0 (usually 0 is used) denotes that the component must be off for
the time period. If this field is blank, the schedule has values of 1 for all time periods.
Field: Damper Air Outlet Node Name
The VAV damper outlet node. This is the outlet node of the damper and the inlet node of the
reheat coil.
Field: Air Inlet Node Name
The air inlet node name that connects the air splitter to the individual zone ADU. This is not
the same as the air inlet node of the reheat component: it is upstream of that node. This is
the inlet node to the terminal unit and the damper
Field: Maximum Air Flow Rate
The design maximum volume flow rate (m 3/sec) specified for VAV ADU.

9/29/14

888

Input-Output Reference

Group Air Distribution Equipment

Field: Zone Minimum Air Flow Method

This field is used to select how the program will determine the minimum flow rate to the zone
while the system is operating. There are three choices for selecting how the minimum flow
rate is specified: Constant, FixedFlowRate, and Scheduled. If Constant is entered, then the
program will use the value for the constant minimum air flow fraction entered in the following
field. If FixedFlowRate is entered, then the program will use the value entered in the field
below called Fixed Minimum Air Flow Rate. If Scheduled is entered, then the program will
obtain the value for minimum flow fraction from the schedule named in the field below called
Minimum Air Flow Fraction Schedule Name.
Field: Constant Minimum Air Flow Fraction
The minimum flow rate to the zone while the system is operating, specified as a fraction of
the maximum air flow rate. The minimum zone fraction is normally specified to meet the
minimum ventilation requirement for the occupants. The reheat coil operates only when the
damper is at this minimum flow rate when Damper Heating Action is set to Normal (the
default). This field is used if the previous field is set to Constant. If the previous field is set to
Scheduled (and the field Maximum Hot Water or Steam Flow Rate is set to autosize), then
this field is optional and can be used to separately control the air flow rate used for sizing
normal-action reheat coils. If this field and the following field have values, the greater of the
two is used for sizing.
Field: Fixed Minimum Air Flow Rate
The minimum flow rate to the zone while the system is operating, specified as a fixed
minimum air flow rate in meters cubed per second. The minimum air flow rate is
normally specified to meet the minimum ventilation requirement for the occupants. The
reheat coil operates only when the damper is at this minimum flow rate when Damper
Heating Action is set to Normal (the default). This field is used if the Zone Minimum Air
Flow Method field is set to FixedFlowRate. If the Zone Minimum Air Flow Method field is
set to Scheduled (and the field Maximum Hot Water or Steam Flow Rate is set to
autosize), then this field is optional and can be used to separately control the air flow
rate used for sizing normal-action reheat coils. Only one of these two minimum air flow
fields (i.e., this field and the previous field) should be used at any time. If this field and
the previous field have values, the greater of the two is used for sizing.
Field: Minimum Air Flow Fraction Schedule Name
The name of a schedule that determines the value of the minimum air flow fraction. The
schedule should contain fractions from 0.0 to 1.0. These values will define the minimum flow
rate to the zone while the system is operating, specified as a fraction of the maximum air flow
rate. The reheat coil operates only when the damper is at this minimum flow rate when
Damper Heating Action is set to Normal (the default). This field is used if the previous field is
set to Scheduled. If the previous field is left blank (and the field Maximum Hot Water or
Steam Flow Rate is set to autosize), then the air flow rate used for sizing normal-action
reheat coils is the average of the minimum and maximum values in this schedule. The air
flow rate used for reheat coil sizing is reported with other component sizing information as
Reheat Coil Sizing Air Volume Flow Rate.
Field: Reheat Coil Object Type
The valid reheat component objects currently available are:
Coil:Heating:Water
Coil:Heating:Electric
Coil:Heating:Gas
Coil:Heating:Steam

If there is no reheat coil,use AirTerminal:SingleDuct:VAV:NoReheat instead of this object.

9/29/14

889

Input-Output Reference

Group Air Distribution Equipment

Field: Reheat Coil Name

Reheat Coil Object name being simulated with this ADU. Applicable for all coils. If there is no
reheat coil,use object AirTerminal:SingleDuct:VAV:NoReheat instead of this object.
Field: Maximum Hot Water or Steam Flow Rate
This field is zero for gas and electric coils. Set to the maximum design hot water or steam
volumetric flow rate in m3/s for the hot water or steam heating coil. The steam volumetric flow
rate is calculated at 100C and 101325 Pa. This field is autosizable. If there is no reheat coil,
this is left blank.
Field: Minimum Hot Water or Steam Flow Rate
This field is zero for gas and electric coils. Set to the minimum design hot water or steam
volumetric flow rate in m3/s for the hot water or steam heating coil, normally set to be a shut
off valve that is set to zero. The steam volumetric flow rate is calculated at 100C and 101325
Pa. If there is no reheat coil, this is left blank.
Field: Air Outlet Node Name
The terminal unit outlet node. This is the outlet node of the reheat coil and the zone inlet
node.
Field: Convergence Tolerance
The coil is controlled by knowing the zone demand determined by the zone thermostat and
setting the outlet conditions to meet this demand. For the electric and gas coils, this is set
exactly since the coil model solution can be inverted. With the hot water coil that uses an
effectiveness-NTU method, the solution cannot be inverted directly. Therefore, to determine
the correct mass flow rate for the hot water the solution is solved for by iteration. The iterative
solution uses an interval halving routine and needs a termination criteria that is set with the
Convergence Tolerance parameter. This control offset is set to a decimal fraction of the zone
demand as the criteria, i.e. 0.001. The default for the field is 0.001.
Field: Damper Heating Action
During heating operation, there are two control options for the damper controlling the air flow
in the VAV terminal unit as the zone moves above or below the zone setpoint. With both
control options, the damper is at the minimum air flow rate whenever the zone temperature is
between the cooling and heating setpoints (deadband condition).
With Normal (the default) action, the damper will remain at the minimum air flow rate during
heating operation. As the heating load increases, the water flow rate in the reheat coil will be
increased to maintain temperature in the zone until the maximum water flow rate is reached
or the user-specified maximum reheat air temperature is reached.. This is sometimes called
the single maximum control logic as illustrated below.

9/29/14

890

Input-Output Reference

Group Air Distribution Equipment

Figure 102. The Single Maximum Control Logic

With Reverse action, as the heating load increases, the unit starts at minimum air flow and
minimum hot water flow. The hot water flow is increased until it reaches maximum flow or the
user-specified maximum reheat air temperature is reached, then the air damper starts to
open to meet the load. This option is used if the minimum air flow rate is not adequate to
serve the peak heating load. This is sometimes called the dual maximum control logic as
illustrated in following figure. For heating coil types other than the hot-water coil, e.g. electric,
steam, and gas, the reverse action works the same as the normal action always keeping
the air flow at the minimum during heating.
The dual-max control currently applies to the AirTerminal:SingleDuct:VAV:Reheat objects
with reverse acting dampers and hot-water coils.

9/29/14

891

Input-Output Reference

Group Air Distribution Equipment

Figure 103. The Dual Maximum Control Logic

Control Fields for Maximum Flow During Reheat:
The following two fields are used only when Reheat Coil Object Type = Coil:Heating:Water
and Damper Heating Action = Reverse. Maximum Flow per Zone Floor Area During Reheat
and Maximum Flow Fraction During Reheat are two optional methods to calculate the
maximum allowable air flow rate during reheat operation. If both are entered, the greater
resulting flow rate is used. If Design Specification Outdoor Air Object Name is also specified,
it may increase this limit to meet the outdoor air flow rate requirement. At no time will the
maximum flow rate calculated here exceed the value for Maximum Air Flow Rate.
This limit is active only when the zone thermostat requests heating and the VAV box damper
is reverse acting.
Field: Maximum Flow per Zone Floor Area During Reheat
This factor (m 3/s-m2) is multiplied by the zone area, to determine the maximum volume flow
rate (m3/s) allowed during reheat operation (see detailed explanation above). This field is
autocalculatable. If autocalculate is selected, the value is set to 0.002032 m3/s-m2 (0.4
cfm/ft2). If this field and the following field are entered, the greater of the two inputs is used. If
this field and the following field are left blank, the maximum flow will not be limited.
Field: Maximum Flow Fraction During Reheat
This fraction is multiplied by the Maximum Air Flow Rate to determine the maximum volume
flow rate (m 3/s) allowed during reheat operation (see detailed explanation above). This field is
autocalculatable. If autocalculate is selected, the value is set to 0.002032 m3/s-m2 (0.4
cfm/ft2) multiplied by the zone floor area divided by the Maximum Air Flow Rate. If this field
and the previous field are entered, the greater of the two inputs is used. If this field and the
previous field are left blank, the maximum flow will not be limited.
Field: Maximum Reheat Air Temperature
This field specifies a maximum supply air temperature (C) leaving the reheat coil in a VAV
terminal unit during heating operation. If leaving blank, the temperature of the supply air to
the space in heating operation may get unrealistic high.

9/29/14

892

Input-Output Reference

Group Air Distribution Equipment

Field: Design Specification Outdoor Air Object Name

This alpha field specifies the name of a DesignSpecification:OutdoorAir object. When this
field is used, the terminal unit will increase flow as needed to meet this outdoor air
requirement. If Outdoor Air Flow per Person is non-zero, then the outdoor air requirement will
be computed based on the current number of occupants in the zone. At no time will the
supply air flow rate exceed the value for Maximum Air Flow Rate. If this field is blank, then
the terminal unit will not be controlled for outdoor air flow. See documentation for the zone
HVAC outdoor air object for further information (Ref DesignSpecification:OutdoorAir).
An IDF example:
AirTerminal:SingleDuct:VAV:Reheat,
SPACE2-1 VAV Reheat, !- Name of System
ReheatCoilAvailSched, !- Availability schedule for VAV System
SPACE2-1 Zone Coil Air In Node, !- Damper Air Outlet Node
SPACE2-1 ATU In Node, !- Unit Air Inlet Node
autosize, !- Maximum air flow rate {m3/s}
Constant, !- Zone Minimum Air Flow Input Method
0.3, !- Constant Minimum Air Flow Fraction
, !- Fixed Minimum Air Flow Rate
, !- Minimum Air Flow Fraction Schedule Name
COIL:Gas:Heating, !- Reheat Component Object
SPACE2-1 Zone Coil, !- Name of Reheat Component
0.0, !- Max Reheat Water Flow {m3/s}
0.0, !- Min Reheat Water Flow {m3/s}
SPACE2-1 In Node, !- Unit Air Outlet Node
0.001, !- Convergence Tolerance
Reverse, !- Damper Heating Action
,
!- Maximum Flow per Zone Floor Area During Reheat
,
!- Maximum Flow Fraction During Reheat
35.0,
!- Maximum Reheat Air Temperature {C}
;
!- Design Specification Outdoor Air Object Name
DesignSpecification:OutdoorAir,
ZoneMinOARequirements,
!- Name
Sum,
!- Outdoor
0.00472,
!- Outdoor
0.000508,
!- Outdoor
,
!- Outdoor
,
!- Outdoor
Min OARequirements Sched; !- Outdoor

Air
Air
Air
Air
Air
Air

Method
Flow per Person {m3/s}
Flow per Zone Floor Area {m3/s-m2}
Flow per Zone
Flow Air Changes per Hour
Flow Rate Fraction Schedule Name

Schedule:Compact,
Min OARequirements Sched, !- Name
Any Number,
!- Schedule Type Limits Name
Through: 12/31,
!- Field 1
For: Weekdays SummerDesignDay WinterDesignDay, !- Field 2
Until: 24:00,1.0,
!- Field 7
For: AllOtherDays,
!- Field 9
Until: 24:00,0.25;
!- Field 10
COIL:Heating:Gas,
SPACE1-1 Zone Coil, !- Coil Name
ReheatCoilAvailSched, !- Availability Schedule Name
0.8, !- Gas Burner Efficiency of the Coil
autosize, !- Nominal Capacity of the Coil {W}
SPACE1-1 Zone Coil Air In Node, !- Coil_Air_Inlet_Node
SPACE1-1 In Node; !- Coil_Air_Outlet_Node

Single Duct VAV Reheat AirTerminal Outputs

HVAC,Average,Zone Air Terminal VAV Damper Position []
HVAC,Average,Zone Air Terminal Minimum Air Flow Fraction []
HVAC,Average,Zone Air Terminal Outdoor Air Volume Flow Rate [m3/s]

9/29/14

893

Input-Output Reference

Group Air Distribution Equipment

Zone Air Terminal VAV Damper Position []

This output is the variable air volume damper position required to meet the zone load. This is
the average value over the frequency being reported. The damper position is defined as the
terminal unit air mass flow rate divided by the terminal units maximum air mass flow rate.
Zone Air Terminal Minimum Air Flow Fraction []
This output is the value for the minimum air flow fraction setting on a VAV terminal. This is
the average value over the frequency being reported. The minimum air flow fraction is
defined as the lower limit on the terminal unit air mass flow rate divided by the terminal units
maximum air mass flow rate.
Zone Air Terminal Outdoor Air Volume Flow Rate [m3/s]
This output is the amount of outdoor air entering the zone. This is the average value
over the frequency being reported. The amount of outdoor air is defined as the terminal
unit air volume flow rate multiplied by the fraction of outdoor air entering the air loops
outside air system.
AirTerminal:SingleDuct:VAV:Reheat:VariableSpeedFan
The VAV terminal unit with variable-speed fan and reheat coil is an air system terminal unit
consisting of a variable speed fan in series with a heating coil. These units are usually
employed in underfloor air distribution (UFAD) systems where the air is supplied at low static
pressure through an underfloor plenum. The fan is used to control the flow of conditioned air
that enters the space. When the fan is off the plenum pressure drives the minimum air flow
through the terminal unit. At maximum cooling the fan runs at its maximum speed. At full
heating the fan runs at its heating maximum usually less than the cooling maximum flow
rate. Thus this unit has two separate maximum flow rates one for heating and one for
cooling.
For cooling, control is maintained simply by varying the fan speed. For heating, the unit first
tries to meet the heating load by varying the heating coil output while keeping the air flow at
minimum (fan off). If this is not adequate the fan turns on and operates in variable flow mode
up to the heating maximum flow rate.
This unit is modeled in EnergyPlus as a compound component a variable speed fan and a
heating coil in series in the air stream. The unit is blow through the fan is upstream of the
heating coil.
Field: Name
A unique user assigned name for a particular VS fan VAV reheat terminal unit. Any reference
to this unit by another object will use this name.
Field: Availability Schedule Name
The name of the schedule (ref: Schedule) that denotes whether the unit can run during a
given time period. A schedule value greater than 0 (usually 1 is used) indicates that the unit
can be on during the time period. A value less than or equal to 0 (usually 0 is used) denotes
that the unit must be off for the time period. If this field is blank, the schedule has values of 1
for all time periods.
Field: Maximum Cooling Air Flow Rate
The maximum volumetric air flow rate through the unit in cubic meters per second when the
thermostat is calling for cooling. Normally this is the same as the units fan maximum
volumetric flow rate.
Field: Maximum Heating Air Flow Rate
The maximum volumetric air flow rate through the unit in cubic meters per second when the
thermostat is calling for heating.
9/29/14

894

Input-Output Reference

Group Air Distribution Equipment

Field: Zone Minimum Air Flow Fraction

The minimum flow rate to the zone while the system is operating, specified as a fraction of
the maximum air flow rate. For this unit this is the flow rate when the fan is off.
Field: Air Inlet Node Name
The name of the HVAC system node that is the air inlet node for the terminal unit. This is also
the air inlet node for the units fan.
Field: Air Outlet Node Name
The name of the HVAC system node that is the air outlet node of the unit. This same node
will be the unit heating coils air outlet node. This node is also a zone inlet node.
Field: Heating Coil Air Inlet Node Name
The name of the HVAC system node that is the air inlet node of the units heating coil. The
same node is the outlet node of the units fan. This is an internal node of this compound
component.
Field: Hot Water or Steam Inlet Node Name
The name of the HVAC system node which regulates the flow of hot water through the units
hot water heating coil. This should be the same node as the water inlet node of the hot water
coil. For gas or electric coils this field should be left blank.
Field: Fan Object Type
The type of fan in the terminal unit. At this time the only type of fan allowed is
Fan:VariableVolume.
Field: Fan Name
The name of the particular fan object in this terminal unit.
Field: Heating Coil Object Type
The type of heating coil in the terminal unit. The valid choices are:
Coil:Heating:Water
Coil:Heating:Electric
Coil:Heating:Gas
Coil:Heating:Steam

Field: Heating Coil Name

The name of the heating coil object contained in this terminal unit.
Field: Maximum Hot Water or Steam Flow Rate
The maximum hot water or steam volumetric flow rate in m 3/s through the units heating coil.
The steam volumetric flow rate is calculated at 100C and 101325 Pa. If the heating coil is not
a hot water or steam coil this field should be left blank.
Field: Minimum Hot Water or Steam Flow Rate
The minimum hot water or steam volumetric flow rate in m 3/s through the units heating coil.
The steam volumetric flow rate is calculated at 100C and 101325 Pa. If the heating coil is not
a hot water or steam coil this field should be left blank.
The control tolerance for the unit heating output. The unit is controlled by matching the unit
output to the zone demand. The model must be numerically inverted to obtain a specified
output. The convergence tolerance is the error tolerance used to terminate the numerical
inversion procedure. Basically this is the fraction:

9/29/14

895

Input-Output Reference

Group Air Distribution Equipment

Qunit ,out Qzone load

Qzone load

ConvergenceTolerance

The default is 0.001.

An IDF example:
AirTerminal:SingleDuct:VAV:Reheat:VariableSpeedFan,
SPACE2-1 VAV Reheat,
!- Name of System
ReheatCoilAvailSched,
!- System Availability schedule
autosize,
!- Maximum cooling air volume flow rate
autosize,
!- Maximum heating air volume flow rate
0.05,
!- Zone Minimum Air Flow Fraction
SPACE2-1 ATU In Node,
!- Unit supply air inlet node
SPACE2-1 In Node,
!- Unit supply air outlet node
SPACE2-1 Zone Coil Air In Node, !- heating coil air inlet node
SPACE2-1 Zone Coil Water In Node,!- Hot water control node
FAN:SIMPLE:VariableVolume,
!- Fan object
SPACE2-1 Zone Fan,
!- Fan name
COIL:Water:SimpleHeating,!- Heating coil object
SPACE2-1 Zone Coil,
!- Heating coil name
autosize,
!- Max hot water flow
0.0,
!- Min hot water flow
0.001;
!- Heating Convergence Tolerance

Coil:Heating:Water,
SPACE2-1 Zone Coil,
!- Coil Name
ReheatCoilAvailSched,
!- Availability Schedule Name
autosize,
!- UA of the Coil {W/K}
autosize,
!- Max Water Flow Rate of Coil {m3/s}
SPACE2-1 Zone Coil Water In Node, !- Coil_Water_Inlet_Node
SPACE2-1 Zone Coil Water Out Node, !- Coil_Water_Outlet_Node
SPACE2-1 Zone Coil Air In Node, !- Coil_Air_Inlet_Node
SPACE2-1 In Node;
!- Coil_Air_Outlet_Node

Fan:VariableVolume,
SPACE2-1 Zone Fan,
!- Fan Name
FanAvailSched,
!- Availability Schedule Name
0.7,
!- Fan Total Efficiency
125.0,
!- Delta Pressure {Pa}
autosize,
!- Max Flow Rate {m3/s}
0.0,
!- Min Flow Rate {m3/s}
0.9,
!- Motor Efficiency
1.0,
!- Motor In Airstream Fraction
0.00153028,
!- FanCoefficient 1
0.00520806,
!- FanCoefficient 2
1.1086242,
!- FanCoefficient 3
-.11635563,
!- FanCoefficient 4
0.000,
!- FanCoefficient 5
SPACE2-1 ATU In Node,
!- Fan_Inlet_Node
SPACE2-1 Zone Coil Air In Node;
!- Fan_Outlet_Node

Single Duct VAV Reheat Variable Speed Fan AirTerminal Outputs

HVAC,Average,Zone Air Terminal VAV Damper Position []

Zone Air Terminal VAV Damper Position

This output is the variable air volume flow fraction required to meet the zone load. This is the
average value over the frequency being reported. The flow fraction is defined as the terminal
unit air mass flow rate divided by the terminal units maximum air mass flow rate.

9/29/14

896

Input-Output Reference

Group Air Distribution Equipment

AirTerminal:SingleDuct:VAV:HeatAndCool:Reheat
Variable air volume (VAV) systems typically control the dry-bulb temperature inside a zone by
varying the supply air volume instead of the supply air temperature (ref:
AirTerminal:SingleDuct:VAV:NoReheat). Reheat coils may be required to avoid overcooling
(ref: AirTerminal:SingleDuct:VAV:Reheat).
This terminal unit is slightly different from the AirTerminal:SingleDuct:VAV:Reheat terminal
unit. Both operate the same in cooling mode: the damper opens as needed to provide
additional sensible cooling to the zone. The difference between the two is in heating mode.
For the Single Duct VAV Reheat terminal unit, the air flow rate is reduced to the minimum
value (max air flow rate x zone minimum air flow fraction) when zone heating is required and
the reheat coil output is modulated to meet the zone heating load.
For the
AirTerminal:SingleDuct:VAV:HeatAndCool:Reheat terminal unit, the air flow rate in heating
mode is increased to meet higher zone heating loads (similar to what is done in cooling
mode). If additional heat is required (beyond what the terminal unit can provide with its
damper fully open), then the reheat coil is modulated as needed to meet the additional
heating load.
This terminal unit model was originally developed and tested for use with the changeoverbypass VAV unitary system.

Figure 104. Single Duct VAV Heat and Cool Reheat Schematic
Field: Name
Unique user-defined name for this Air Distribution Unit (ADU).
Field: Availability Schedule Name
This alpha field defines the name of the schedule (ref: Schedule) that denotes whether or not
this component is available to operate during a given time period. A schedule value greater
than 0 (usually 1 is used) indicates that the component can be on during the time period. A
value less than or equal to 0 (usually 0 is used) denotes that the component must be off for
the time period. If this field is blank, the schedule has values of 1 for all time periods.
Field: Damper Air Outlet Node Name
This alpha field defines the name of the VAV damper air outlet node. This is the outlet node
of the damper and the inlet node of the reheat coil.
Field: Air Inlet Node Name
This alpha field defines the name of the air inlet node that connects the air splitter to the
individual zone ADU. This is not the same as the air inlet node of the reheat component: it is
upstream of that node. This is the inlet node to the terminal unit and the damper.
Field: Maximum Air Flow Rate
This numeric field defines the design maximum volumetric flow rate (m 3/sec) specified for this
VAV ADU. This flow rate must be greater than 0 or can be autosized.
Field: Zone Minimum Air Flow Fraction
This numeric field defines the minimum air volumetric flow rate to the zone while the system
is operating, specified as a fraction of the maximum air flow rate. The minimum zone fraction
9/29/14

897

Input-Output Reference

Group Air Distribution Equipment

is normally specified to meet the minimum ventilation requirement for the occupants. The
reheat coil operates as needed to maintain the heating set point specified in the Zone
Control:Thermostatic object. This value must be between 0 and 1.
Control Fields:
The last several fields for this terminal reheat component describe the type of reheat coil that
is being used and how it is controlled. Most of the fields pertain to the hot water coil since the
gas and electric coil are much more simplified.
Field: Hot Water or Steam Inlet Node Name
For the hot water reheat coil there is a node on the water side that would control the water
flow rate to allow the coil to meet the zone demand. This control location is the name of the
control node for this terminal reheat ADU. For the gas and electric coils this field is left blank.
Field: Reheat Coil Object Type
The valid reheat component objects currently available are:
Coil:Heating:Water
Coil:Heating:Electric
Coil:Heating:Gas
Coil:Heating:Steam

If no reheat coil is required, use AirTerminal:SingleDuct:VAV:HeatAndCool:NoReheat instead

of this object.
Field: Reheat Coil Name
Unique coil name being simulated with this ADU. Applicable for all coils. If there is no reheat
coil, use AirTerminal:SingleDuct:VAV:HeatAndCool:NoReheat instead of this object.
Field: Maximum Hot Water or Steam Flow Rate
This field is ignored for gas or electric reheat coils. If using a hot water or steam reheat coil,
set to the maximum design water or steam volumetric flow rate in m 3/s for the hot water or
steam heating coil. The steam volume flow rate is calculated at 100C and 101325 Pa. This
volumetric flow rate can be autosized.
Field: Minimum Hot Water or Steam Flow Rate
This field is ignored for gas and electric coils. Set to the minimum design water or steam
volumetric flow rate in m 3/s for the hot water or steam heating coil, normally set to be a shutoff valve that is set to zero. The steam volume flow rate is calculated at 100C and 101325 Pa.
Field: Air Outlet Node Name
This is the air outlet node for the ADU and is then connected to the zone. This is the same
node as the air outlet node of the reheat component.
Field: Convergence Tolerance
The coil is controlled by knowing the zone demand determined by the zone thermostat and
setting the outlet conditions to meet this demand. For the electric and gas coils, this is set
exactly since the coil model solution can be inverted and this field is not used. With the hot
water coil that uses an effectiveness-NTU method, the solution cannot be inverted directly.
Therefore, to determine the correct mass flow rate for the hot water the solution is solved by
iteration. The iterative solution uses an interval-halving routine and needs a termination
criteria that is set with this Convergence Tolerance parameter. This control offset is set to a
decimal fraction of the zone demand. The default value for this field is 0.001.

9/29/14

898

Input-Output Reference

Group Air Distribution Equipment

Field: Maximum Reheat Air Temperature

This is the upper limit on the temperature in degrees C of the air leaving the terminal unit
reheat coil (and being delivered to the zone). If the user leaves this field blank, no maximum
reheat air temperature is enforced.
An IDF example is provided below:
AirTerminal:SingleDuct:VAV:HeatAndCool:Reheat,
Zone 1 VAV System,
!- Name of System
FanAndCoilAvailSched,
!- System Availability schedule
Zone 1 Reheat Air Inlet Node, !- DAMPER Air Outlet Node
Zone 1 VAV Inlet Node,
!- UNIT Air Inlet Node
0.583,
!- Maximum air flow rate {m3/s}
0.25,
!- Zone Minimum Air Flow Fraction
,
!- Control node
Coil:Heating:Electric,
!- Reheat Component Object
Reheat Coil Zone 1,
!- Name of Reheat Component
0.0,
!- Max Reheat Water Flow {m3/s}
0.0,
!- Min Reheat Water Flow {m3/s}
Zone 1 Reheat Air Outlet Node, !- UNIT Air Outlet Node
0.001;
!- Convergence Tolerance
Coil:Heating:Electric,
Reheat Coil Zone 1,
FanAndCoilAvailSched,
1.0,
3000.0,
Zone 1 Reheat Air Inlet Node,
Zone 1 Reheat Air Outlet Node;

!!!!!!-

Coil Name
Availability Schedule Name
Efficiency of the Coil
Nominal Capacity of the Coil {W}
Coil_Air_Inlet_Node
Coil_Air_Outlet_Node

Single Duct VAV Heat and Cool Reheat AirTerminal Outputs

HVAC,Average,Zone Air Terminal VAV Damper Position []

Zone Air Terminal VAV Damper Position []

This output is the damper position required to meet the zone load. This is the average value
over the simulation timestep being reported. The damper position is defined as the terminal
unit air mass flow rate divided by the terminal units maximum air mass flow rate.
AirTerminal:SingleDuct:VAV:NoReheat
Variable air volume (VAV) systems control the dry-bulb temperature inside a zone by varying
the supply air volume instead of the air temperature. At full cooling the VAV damper is fully
open supplying the specified maximum air flow rate. As the cooling load decreases, the
damper closes until it reaches the minimum stop specified by the zone minimum air flow
fraction.
VAV systems can be used for interior or perimeter zones with a common fan system and air
temperature control. The VAV concept may vary according to the VAV box locations and air
temperature controls. Heating can be provided if necessary by use of baseboard.
Field: Name
Unique name for the VAV Air Distribution Unit (ADU).
Field: Availability Schedule Name
Schedule that this component will operate or is available to operate. A schedule value greater
than 0 (usually 1 is used) indicates that the component can be on during the time period. A
value less than or equal to 0 (usually 0 is used) denotes that the component must be off for
the time period. If this field is blank, the schedule has values of 1 for all time periods.
Field: Air Outlet Node Name
The VAV damper and Unit outlet node.

9/29/14

899

Input-Output Reference

Group Air Distribution Equipment

Field: Air Inlet Node Name

The air inlet node name that connects the air splitter to the individual zone ADU.
Field: Maximum Air Flow Rate
The design maximum volume flow rate (m 3/sec) specified for VAV ADU. This is autosizable.
Field: Zone Minimum Air Flow Method
This field is used to select how the program will determine the minimum flow rate to the zone
while the system is operating. The minimum flow rate is modeled as a fraction of the
maximum flow rate. There are five choices: Constant, FixedFlowRate, Scheduled, Sum and
Maximum. If Constant is entered, then the program will use the value for minimum flow
fraction entered in the following field. If FixedFlowRate is entered, then the program will use
the value for minimum flow rate entered in the field below called Fixed Minimum Air Flow
Rate. If Scheduled is entered, then the program will obtain the value for minimum flow
fraction from the schedule named in the field below called Minimum Air Flow Fraction
Schedule Name. Sum and Maximum are used to either provide the summation of all
entered inputs or the maximum of all entered inputs.
Field: Constant Minimum Air Flow Fraction
The minimum flow rate to the zone while the system is operating, specified as a fraction of
the maximum air flow rate. The minimum zone fraction is normally specified to meet the
minimum ventilation requirement for the occupants. This field is only used if the Zone
Minimum Air Flow Method field is set to Constant.
Field: Fixed Minimum Air Flow Rate
The minimum flow rate to the zone while the system is operating, specified as a fixed
minimum air flow rate in meters cubed per second. The minimum air flow rate is
normally specified to meet the minimum ventilation requirement for the occupants. This
field is only used if the Zone Minimum Air Flow Method field is set to FixedFlowRate.
Field: Minimum Air Flow Fraction Schedule Name
The name of a schedule that determines the value of the minimum air flow fraction. The
schedule should contain fractions from 0.0 to 1.0. These values will define the minimum flow
rate to the zone while the system is operating, specified as a fraction of the maximum air flow
rate. This field is only used if the Zone Minimum Air Flow Method field is set to Scheduled.
Field: Design Specification Outdoor Air Object Name
This alpha field specifies the name of a DesignSpecification:OutdoorAir object. When this
field is used, the terminal unit will increase flow as needed to meet this outdoor air
requirement. If Outdoor Air Flow per Person is non-zero, then the outdoor air requirement will
be computed based on the current number of occupants in the zone. At no time will the
supply air flow rate exceed the value for Maximum Air Flow Rate. If this field is blank, then
the terminal unit will not be controlled for outdoor air flow. See documentation for the zone
HVAC outdoor air object for further information (Ref DesignSpecification:OutdoorAir).
An IDF example:

9/29/14

900

Input-Output Reference

Group Air Distribution Equipment

AirTerminal:SingleDuct:VAV:NoReheat,
Zone 1 VAV System,
!- Name
FanAndCoilAvailSched,
!- Availability Schedule Name
Zone 1 Reheat Air Outlet Node, !- Air Outlet Node Name
Zone 1 Damper Inlet Node,!- Air Inlet Node Name
0.47,
!- Maximum Air Flow Rate {m3/s}
Constant,
!- Zone Minimum Air Flow Input Method
0.3,
!- Constant Minimum Air Flow Fraction
,
!- Fixed Minimum Air Flow Rate
,
!- Minimum Air Flow Fraction Schedule Name
ZoneOAData;
!- Design Specification Outdoor Air Object Name
DesignSpecification:OutdoorAir,
ZoneOAData,
!- Name
Sum,
!- Outdoor
0.00236,
!- Outdoor
0.00305,
!- Outdoor
,
!- Outdoor
,
!- Outdoor
OARequirements Sched; !- Outdoor

Air
Air
Air
Air
Air
Air

Method
Flow per Person {m3/s}
Flow per Zone Floor Area {m3/s-m2}
Flow per Zone {m3/s}
Flow Air Changes per Hour
Flow Rate Fraction Schedule Name

Schedule:Compact,
OARequirements Sched,
!- Name
Any Number,
!- Schedule Type Limits Name
Through: 12/31,
!- Field 1
For: Weekdays SummerDesignDay WinterDesignDay, !- Field 2
Until: 24:00, 1.0,
!- Field 4
For: AllOtherDays,
!- Field 5
Until: 24:00, 0.5;
!- Field 7

Single Duct VAV NoReheat AirTerminal Outputs

HVAC,Average,Zone Air Terminal VAV Damper Position []
HVAC,Average,Zone Air Terminal Outdoor Air Volume Flow Rate [m3/s]

Zone Air Terminal VAV Damper Position []

This output is the damper position required to meet the zone load. This is the average value
over the simulation timestep being reported. The damper position is defined as the terminal
unit air mass flow rate divided by the terminal units maximum air mass flow rate.
Zone Air Terminal Outdoor Air Volume Flow Rate [m3/s]
This output is the amount of outdoor air entering the zone. This is the average value
over the frequency being reported. The amount of outdoor air is defined as the terminal
unit air volume flow rate multiplied by the fraction of outdoor air entering the air loops
outside air system.
AirTerminal:SingleDuct:VAV:HeatAndCool:NoReheat
Variable air volume (VAV) systems typically control the dry-bulb temperature inside a zone by
varying the supply air volume instead of the supply air temperature (ref:
AirTerminal:SingleDuct:VAV:NoReheat). Reheat coils may be required to avoid overcooling
(ref: AirTerminal:SingleDuct:VAV:Reheat).
This terminal unit is slightly different from the AirTerminal:SingleDuct:VAV:NoReheat terminal
unit. Both operate the same in cooling mode: the damper opens as needed to provide
additional sensible cooling to the zone. The difference between the two is in heating mode.
For the Single Duct VAV NoReheat terminal unit, the air flow rate is reduced to the minimum
value (max air flow rate x zone minimum air flow fraction) when zone heating is required. For
the AirTerminal:SingleDuct:VAV:HeatAndCool:NoReheat terminal unit, the air flow rate in
heating mode is increased to meet higher zone heating loads (similar to what is done in
cooling mode).

9/29/14

901

Input-Output Reference

Group Air Distribution Equipment

This terminal unit model was originally developed and tested for use with the changeoverbypass VAV unitary system..This object may be used when the central heating coil is
sufficient to maintain the heating set point temperature. Additional heating may be provided, if
necessary,
by
use
of
AirTerminal:SingleDuct:VAV:HeatAndCool:Reheat
or
ZoneHVAC:Baseboard:* objects.

Figure 105. Single Duct VAV Heat and Cool NoReheat Schematic
Field: Name
Unique user-defined name for this Air Distribution Unit (ADU).
Field: Availability Schedule Name
This alpha field defines the name of the schedule (ref: Schedule) that denotes whether or not
this component is available to operate during a given time period. If a schedule value is
greater than zero then the system is available to operate; otherwise, the system is
unavailable for that time period. If this field is blank, the schedule has values of 1 for all time
periods.
Field: Air Outlet Node Name
This alpha field defines the name of the VAV damper air outlet node.
Field: Air Inlet Node Name
This alpha field defines the name of the air inlet node that connects the air splitter to the
individual zone ADU.
Field: Maximum Air Flow Rate
This numeric field defines the design maximum volume flow rate (m 3/sec) specified for this
VAV ADU. This flow rate must be greater than 0 or can be autosized.
Field: Zone Minimum Air Flow Fraction
This numeric field defines the minimum air volume flow rate to the zone while the system is
operating, specified as a fraction of the maximum air flow rate. The minimum zone fraction is
normally specified to meet the minimum ventilation requirement for the occupants. This value
must be between 0 and 1.
An IDF example is provided below:

9/29/14

902

Input-Output Reference

Group Air Distribution Equipment

AirTerminal:SingleDuct:VAV:HeatAndCool:NoReheat,
Zone 3 VAV System,
!- Name of System
FanAndCoilAvailSched,
!- System Availability schedule
Zone 3 Reheat Air Outlet Node, !- UNIT Air Outlet Node
Zone 3 VAV Inlet Node,
!- UNIT Air Inlet Node
0.584,
!- Maximum air flow rate {m3/s}
0.25;
!- Zone Minimum Air Flow Fraction

Single Duct VAV Heat and Cool NoReheat AirTerminal Outputs

HVAC,Average,Zone Air Terminal VAV Damper Position []

Zone Air Terminal VAV Damper Position []

This output is the damper position required to meet the zone load. This is the average value
over the simulation timestep being reported. The damper position is defined as the terminal
unit air mass flow rate divided by the terminal units maximum air mass flow rate.
AirTerminal:SingleDuct:SeriesPIU:Reheat
The series powered induction unit is an air system terminal unit that mixes varying amounts
of secondary (recirculated) air and primary (conditioned supply) air to produce a fixed flow of
air to a zone. The unit contains a small fan that acts to induce the secondary air and a
heating coil for heating the mixed secondary and primary air. The fan runs at a constant
volume flow rate whenever the unit is on (and the fans availability schedule is on or it is
activated by an availability manager). The fan is downstream of the primary and secondary
air inlets. The variable mixing is accomplished by a damper in the units primary air supply
inlet duct. This damper can move from fully open (100% primary air. 0% secondary air) to a
minimum stop that is specified in the input description. At full cooling the damper will be fully
open. At minimum cooling and for heating the damper will be at the minimum stop and the
secondary air flow will be at its maximum.
The EnergyPlus model of the series PIU terminal unit is composed of three components: a
zone mixer, a constant volume fan, and a heating coil (hot water, electric, or gas).

Figure 106. Series PIU Terminal Unit

Field: Name
A unique user assigned name for a particular series powered induction terminal unit. Any
reference to this unit by another object will use this name.
Field: Availability Schedule Name
The name of the schedule (ref: Schedule) that denotes whether the unit can run during a
given time period. A schedule value greater than 0 (usually 1 is used) indicates that the unit
can be on during the time period. A value less than or equal to 0 (usually 0 is used) denotes

9/29/14

903

Input-Output Reference

Group Air Distribution Equipment

that the unit must be off for the time period. If this field is blank, the schedule has values of 1
for all time periods.
Field: Maximum Air Flow Rate
The maximum volumetric air flow rate through the unit in cubic meters per second. Since this
is a constant air volume unit, this is also the design, rated air flow rate of the unit.
Field: Maximum Primary Air Flow Rate
The maximum volumetric air flow rate of primary air through the unit in cubic meters per
second. This is the primary air flow rate at full cooling load when the primary air damper is
fully open. Usually this quantity is the same as the total unit flow rate, but it can be less.
Field: Minimum Primary Air Flow Fraction
The minimum volumetric air flow rate of primary air through the unit expressed as a fraction
of the maximum volumetric air flow rate of primary air. This input can be 0.0.
Field: Supply Air Inlet Node Name
The name of the HVAC system node from which the unit draws its primary or supply air
Field: Secondary Air Inlet Node Name
The name of the HVAC system node from which the unit draws its secondary or recirculated
air. The unit can draw secondary air from its conditioned zone directly or from a return air
plenum. Thus this node should be one of the zones exhaust air nodes (see Zone Air Exhaust
Node in ZoneHVAC:EquipmentConnections) or an induced air node outlet of a return
plenum (see Induced Air Outlet Node in AirLoopHVAC:ReturnPlenum).
Field: Outlet Node Name
The name of the HVAC system node to which the unit sends its outlet air. This should be one
of the inlet air nodes of the zone which is being served.
Field: Reheat Coil Air Inlet Node Name
The name of the HVAC system node which is the inlet node of the units heating coil. This is
also the outlet node of the units fan.
Field: Zone Mixer Name
The name of an zone mixer component (object: AirLoopHVAC:ZoneMixer) which composes
part of the unit. Note that some of the input for the mixer will duplicate input fields of the
powered induction unit. One of the zone mixer inlet nodes should be the same as the supply
air inlet node of the PIU; the other inlet node of the zone mixer should be the same as the
secondary air inlet node of the PIU. The outlet node of the zone mixer should be the same as
the inlet node of the PIU fan.
Field: Fan Name
The name of a fan component which composes part of the unit. Note that the fans maximum
flow rate should be the same as the maximum air flow rate of the PIU and the type of fan
object must be Fan:ConstantVolume. The fans inlet node should be the same as the zone
mixers outlet node. The fans outlet node should be the same as the heating coils air inlet
node. The secondary fan will run according to the Availability Schedule specified in the
Fan:ConstantVolume object, unless it is overridden by an availability manager (ref.
AvailabilityManager:NightCycle and others).
Field: Reheat Coil Object Type
The type of coil in the PIU. The valid choices are:
Coil:Heating:Water
Coil:Heating:Electric
9/29/14

904

Input-Output Reference

Group Air Distribution Equipment

Coil:Heating:Gas
Coil:Heating:Steam

In other words the PIU may have a hot water, gas, electric or steam reheat coil.
Field: Reheat Coil Name
The name of the heating coil component which composes part of the unit. Note that the
heating coils air inlet node is the same as the fan outlet node and the heating coils air outlet
node is the same as the PIU outlet node.
Field: Maximum Hot Water or Steam Flow Rate
The maximum hot water volumetric flow rate in m 3/sec through the units heating coil. If the
heating coil is gas or electric this field should be blank.
Field: Minimum Hot Water or Steam Flow Rate
The minimum hot water volumetric flow rate in m 3/sec through the units heating coil. If the
heating coil is gas or electric this field should be blank.
Field: Hot Water or Steam Inlet Node Name
The name of the HVAC system node which regulates the flow of hot water through the unit.
This should be the same node as the water inlet node of the units hot water coil. For gas or
electric heating coils, this input should be blank.
Field: Convergence Tolerance
The control tolerance for the unit heating output. The unit is controlled by matching the unit
output to the zone demand. For units with water coils, the model must be numerically inverted
to obtain a specified output. The convergence tolerance is the error tolerance used to
terminate the numerical inversion procedure. Basically this is the fraction:

QPIU ,out Qzone load

Qzone load

ConvergenceTolerance

For gas or electric heating coils, this input should be left blank. The default is 0.001.
An IDF example:
AirTerminal:SingleDuct:SeriesPIU:Reheat,
Zone 1 SPIU ATU,
! Name of air terminal unit
FanAndCoilAvailSched,
! Availability schedule for series PIU ATU
0.47,
! Total volume flow rate through ATU
0.47,
! Maximum primary air flow rate through terminal unit
0.3,
! Minimum primary air flow rate (fraction of max)
Zone 1 PIU Pri Air Inlet Node,
! Air Terminal unit supply air inlet node
Zone 1 PIU Sec Air Inlet Node,
! Air Terminal unit secondary air inlet node
Zone 1 PIU Air Outlet Node,
! Air Terminal unit outlet node
Zone 1 Reheat Air Inlet Node,
! Reheat coil air inlet node (fan outlet node)
Zone 1 PIU Mixer,
! Air terminal unit mixer name
Zone 1 PIU Fan,
! Air terminal unit fan name
COIL:Heating:Water,
! type of air terminal unit reheat coil
Reheat Coil Zone 1,
! name of air terminal unit reheat coil
0.0013,
! Max Reheat Water Flow {Flow: m3/sec}
0.0,
! Min Reheat Water Flow {Flow: m3/sec}
Zone 1 Reheat Water Inlet Node, ! Control node
0.001;
! Convergence tolerance

Single Duct Series PIU Reheat AirTerminal Outputs

HVAC,Average,Zone Air Terminal Heating Rate [W]
HVAC,Sum,Zone Air Terminal Heating Energy [J]
9/29/14

905

Input-Output Reference

Group Air Distribution Equipment

HVAC,Average,Zone Air Terminal Sensible Cooling Rate [W]

HVAC,Sum,Zone Air Terminal Sensible Cooling Energy [J]

Zone Air Terminal Heating Rate [W]

This field reports the dry air heating addition rate of the series PIU terminal unit to the zone it
is serving in Watts. This is determined by outlet and zone air conditions and the mass flow
rate through the terminal unit.
Zone Air Terminal Heating Energy [J]
This field reports the dry air heat addition of the series PIU terminal unit to the zone it is
serving in Joules over the timestep being reported. This is determined by outlet and zone air
conditions, the mass flow rate through the terminal unit, and the timestep.
Zone Air Terminal Sensible Cooling Rate [W]
This field reports the dry air sensible heat extraction rate of the series PIU terminal unit from
the zone it is serving in Watts. This is determined by the outlet and zone conditions and the
mass flow rate through the terminal unit.
Zone Air Terminal Sensible Cooling Energy [J]
This field reports the dry air sensible heat extraction of the series PIU terminal unit from the
zone it is serving in Joules over the timestep being reported. This is determined by outlet and
zone air conditions, the mass flow rate through the terminal unit, and the timestep.
AirTerminal:SingleDuct:ParallelPIU:Reheat
The parallel powered induction unit is an air system terminal unit that mixes varying amounts
of secondary (recirculated) air and primary (conditioned supply) air to produce a variable total
flow of air to a zone. The unit contains a small fan that acts to induce the secondary air and a
heating coil for heating the mixed secondary and primary air. The secondary and primary air
streams enter the unit in parallel. The fan sits in the secondary air stream and runs only when
the primary air flow is below the Fan On Flow Fraction and the fans availability schedule is
on or it is activated by an availability manager. The primary air inlet contains a damper that
can move from fully open (maximum primary air) to a minimum stop (minimum primary air).
At full cooling load the primary air damper is fully open and the fan is off. The primary air flow
is at maximum and there is little or no secondary air flow. As the cooling load decreases, the
primary air damper gradually closes and the secondary air flow remains close to zero. At
some point, usually when the primary air flow has reached the minimum, the fan switches on
and secondary air is induced. The heating coil will switch on as needed to meet any heating
demand.
The EnergyPlus model of the parallel PIU terminal unit is composed of three components: a
constant volume fan, a zone mixer, and a heating coil (hot water, electric, or gas).

9/29/14

906

Input-Output Reference

Group Air Distribution Equipment

Figure 107. Parallel PIU Terminal Unit

Field: Name
A unique user assigned name for a particular parallel powered induction terminal unit. Any
reference to this unit by another object will use this name.
Field: Availability Schedule Name
The name of the schedule (ref: Schedule) that denotes whether the unit can run during a
given time period. A schedule value greater than 0 (usually 1 is used) indicates that the unit
can be on during the time period. A value less than or equal to 0 (usually 0 is used) denotes
that the unit must be off for the time period. If this field is blank, the schedule has values of 1
for all time periods.
Field: Maximum Primary Air Flow Rate
The maximum volumetric air flow rate of primary air through the unit in cubic meters per
second. This is the primary air flow rate at full cooling load when the primary air damper is
fully open.
Field: Maximum Secondary Air Flow Rate
The maximum volumetric air flow rate of secondary air through the unit in cubic meters per
second. This flow rate can be any amount but is commonly less than the maximum primary
air flow rate.
Field: Minimum Primary Air Flow Fraction
The minimum volumetric air flow rate of primary air through the unit expressed as a fraction
of the maximum volumetric air flow rate of primary air. This input can be 0.0.
Field: Fan On Flow Fraction
The fraction of the primary air flow at which fan turns on. In the parallel PIU the fan operation
is intermittent. If the primary air flow is above this fraction of the maximum, the fan is off.
Otherwise the secondary fan will run according to the Availability Schedule specified in the
Fan:ConstantVolume object (see Fan Name below), unless it is overridden by an availability
manager (ref. AvailabilityManager:NightCycle and others).
Field: Supply Air Inlet Node Name
The name of the HVAC system node from which the unit draws its primary or supply air
Field: Secondary Air Inlet Node Name
The name of the HVAC system node from which the unit draws its secondary or recirculated
air. The unit can draw secondary air from its conditioned zone directly or from a return air
plenum. Thus this node should be one of the zones exhaust air nodes (see Zone Air Exhaust
9/29/14

907

Input-Output Reference

Group Air Distribution Equipment

Node in ZoneHVAC:EquipmentConnections) or an induced air node outlet of a return

plenum (see Induced Air Outlet Node in AirLoopHVAC:ReturnPlenum).
Field: Outlet Node Name
The name of the HVAC system node to which the unit sends its outlet air. This should be one
of the inlet air nodes of the zone which is being served.
Field: Reheat Coil Air Inlet Node Name
The name of the HVAC system node which is the inlet node of the units heating coil. This is
also the outlet node of the units zone mixer.
Field: Zone Mixer Name
The name of an zone mixer component (object: AirLoopHVAC:ZoneMixer) which composes
part of the unit. Note that some of the input for the mixer will duplicate input fields of the
powered induction unit. One of the zone mixer inlet nodes should be the same as the supply
air inlet node of the PIU; the other inlet node of the zone mixer should be the same as the air
outlet node of the fan. The outlet node of the zone mixer should be the same as the inlet
node of the heating coil.
Field: Fan Name
The name of a fan component which composes part of the unit. Note that the fans maximum
flow rate should be the same as the maximum secondary air flow rate of the PIU and the type
of fan object must be Fan:ConstantVolume. The fans inlet node should be the same as the
PIU secondary air inlet node. The fans outlet node should be the same as one of the zone
mixers inlet nodes. When the primary air flow is below the Fan On Flow Fraction (above), the
secondary fan will run according to the Availability Schedule specified in the
Fan:ConstantVolume object, unless it is overridden by an availability manager (ref.
AvailabilityManager:NightCycle and others).
Field: Reheat Coil Object Type
The type of coil in the PIU. The valid choices are:
Coil:Heating:Water
Coil:Heating:Electric
Coil:Heating:Gas
Coil:Heating:Steam

In other words the PIU may have a hot water, gas, electric or steam reheat coil.
Field: Reheat Coil Name
The name of the heating coil component which composes part of the unit. Note that the
heating coils air inlet node is the same as the zone mixers outlet node and the heating coils
air outlet node is the same as the PIU outlet node.
Field: Maximum Hot Water or Steam Flow Rate
The maximum hot water or steam volumetric flow rate in m 3/s through the units heating coil.
The steam volumetric flow rate is calculated at 100C and 101325 Pa. If the heating coil is gas
or electric this field should be blank.
Field: Minimum Hot Water or Steam Flow Rate
The minimum hot water or steam volumetric flow rate in m 3/s through the units heating coil.
The steam volumetric flow rate is calculated at 100C and 101325 Pa. If the heating coil is gas
or electric this field should be blank.

9/29/14

908

Input-Output Reference

Group Air Distribution Equipment

Field: Hot Water or Steam Inlet Node Name

The name of the HVAC system node which regulates the flow of hot water through the unit.
This should be the same node as the water inlet node of the units hot water coil. For gas or
electric heating coils, this input should be blank.
Field: Convergence Tolerance
The control tolerance for the unit heating output. The unit is controlled by matching the unit
output to the zone demand. For units with water coils, the model must be numerically inverted
to obtain a specified output. The convergence tolerance is the error tolerance used to
terminate the numerical inversion procedure. Basically this is the fraction:

QPIU ,out Qzone load

Qzone load

ConvergenceTolerance

For gas or electric heating coils, this input should be left blank. The default is 0.001.
An IDF example:
AirTerminal:SingleDuct:ParallelPIU:Reheat,
Zone 3 PPIU ATU,
! Name of air terminal unit
FanAndCoilAvailSched,
! Availability schedule for series PIU ATU
0.47,
! Maximum primary air flow rate through terminal unit
0.375,
! Maximum secondary air flow rate through the terminal unit
0.1,
! Minimum primary air flow rate (fraction of max)
0.1,
! fan on flow fraction
Zone 3 PIU Pri Air Inlet Node,
! Air Terminal unit supply air inlet node
Zone 3 PIU Sec Air Inlet Node,
! Air Terminal unit secondary air inlet node
Zone 3 PIU Air Outlet Node,
! Air Terminal unit outlet node
Zone 3 Reheat Air Inlet Node,
! Reheat coil air inlet node (fan outlet node)
Zone 3 PIU Mixer,
! Air terminal unit mixer name
Zone 3 PIU Fan,
! Air terminal unit fan name
Coil:Heating:Water,
! type of air terminal unit reheat coil
Reheat Coil Zone 3,
! name of air terminal unit reheat coil
0.0013,
! Max Reheat Water Flow {Flow: m3/sec}
0.0,
! Min Reheat Water Flow {Flow: m3/sec}
Zone 3 Reheat Water Inlet Node, ! Control node
0.001;
! Convergence tolerance

Single Duct Parallel PIU Reheat AirTerminal Outputs

HVAC,Average,Zone Air Terminal Heating Rate [W]
HVAC,Sum,Zone Air Terminal Heating Energy [J]
HVAC,Average,Zone Air Terminal Sensible Cooling Rate [W]
HVAC,Sum, Zone Air Terminal Sensible Cooling Energy [J]

Zone Air Terminal Heating Rate [W]

This field reports the dry air heating addition rate of the parallel PIU terminal unit to the zone
it is serving in Watts. This is determined by outlet and zone air conditions and the mass flow
rate through the terminal unit.
Zone Air Terminal Heating Energy [J]
This field reports the dry air heat addition of the parallel PIU terminal unit to the zone it is
serving in Joules over the timestep being reported. This is determined by outlet and zone air
conditions, the mass flow rate through the terminal unit, and the timestep.

9/29/14

909

Input-Output Reference

Group Air Distribution Equipment

Zone Air Terminal Sensible Cooling Rate [W]

This field reports the sensible heat extraction rate of the parallel PIU terminal unit from the
zone it is serving in Watts. This is determined by the outlet and zone conditions and the mass
flow rate through the terminal unit.
Zone Air Terminal Sensible Cooling Energy [J]
This field reports the dry air sensible heat extraction of the parallel PIU terminal unit from the
zone it is serving in Joules over the timestep being reported. This is determined by outlet and
zone air conditions, the mass flow rate through the terminal unit, and the timestep.
AirTerminal:SingleDuct:ConstantVolume:FourPipeInduction
The four pipe induction terminal unit provides local hot water heating or chilled water cooling
of induced zone air which then mixes with centrally conditioned supply air. An air conditioning
system consisting of these terminal units is effectively a mixed cental air / local hydronic
system. The centrally conditioned air supplied to the induction terminal units is constant
volume at quite high pressure. The central air is discharged through a nozzle in the terminal
unit, inducing a flow of room air over a hydronic heating/cooling coil. The coil is connected
either to a single inlet and outlet pipe (2 pipe unit) or to 2 inlets and 2 outlets (4 pipe unit).
The heated or cooled induced air mixes with the centrally conditioned air before being
discharged into the zone. The terminal units are usually expected to do only sensible cooling
any dehumidification is done by the central air conditioning system.
The EnergyPlus model of the four pipe induction terminal unit is a compound component
consisting of a hot water heating coil, a chilled water cooling coil, and an air mixer. The unit
has two inlet air streams: the centrally conditioned supply air and the induced air from the
zone. The induced air passes first through the heating coil, then through the cooling coil and
finally through the mixer. The central supply air goes directly into the mixer. The water flow
through the hot or cold water coil is varied to meet the zone air conditioning requirement.
Note that EnergyPlus models the four pipe induction terminal unit as having separate heating
and cooling coils whereas real units have only a single coil used for both heating and cooling.
Note also that the four pipe induction unit model can be used to model a two pipe unit by
simply adjusting the heating and cooling coil schedules so that the heating coil is off when the
cooling coil is on and vice versa.
Field: Name
A unique user assigned name for a particular four pipe induction terminal unit. Any reference
to this unit by another object will use this name.
Field: Availability Schedule Name
The name of the schedule (ref: Schedule) that denotes whether the unit can run during a
given time period. A schedule value greater than 0 (usually 1 is used) indicates that the unit
can be on during the time period. A value less than or equal to 0 (usually 0 is used) denotes
that the unit must be off for the time period. If this field is blank, the schedule has values of 1
for all time periods.
Field: Maximum Total Air Flow Rate
The maximum volumetric air flow rate discharged from the unit in cubic meters per second.
Since this is a constant air volume unit, this is also the design, rated air flow rate of the unit.
Note that this is the total discharge flow rate including both central supply and induced air.
Field: Induction Ratio
The ratio of induced air flow rate to primary supply air flow rate. The default is 2.5 the supply
air induces zone air flow at 2.5 times the primary supply air flow rate.

9/29/14

910

Input-Output Reference

Group Air Distribution Equipment

Field: Supply Air Inlet Node Name

The name of the HVAC system node from which the unit draws its primary or supply air
Field: Induced Air Inlet Node Name
The name of the HVAC system node from which the unit draws its secondary or recirculated
air. This should be the same node as one of the zone exhaust nodes.
Field: Air Outlet Node Name
The name of the HVAC system node to which the unit sends its outlet air. This should be one
of the inlet air nodes of the zone which is being served.
Field: Hot Water Inlet Node Name
The name of the HVAC system node which regulates the flow of hot water through the unit.
This should be the same node as the water inlet node of the units hot water coil.
Field: Cold Water Inlet Node Name
The name of the HVAC system node which regulates the flow of cold water through the unit.
This should be the same node as the water inlet node of the units chilled water coil.
Field: Heating Coil Object Type
The type of heating coil in the terminal unit. The choices are:
Coil:Heating:Water

In other words the unit may have a hot water coil only.
Field: Heating Coil Name
The name of the heating coil component which composes part of the unit. Note that the
heating coils air inlet node is the same as the terminal units induced air inlet node. The
heating coils air outlet node is the same as the cooling coils air inlet node.
Field: Maximum Hot Water Flow Rate
The maximum hot water volumetric flow rate in m 3/sec through the units heating coil.
Field: Minimum Hot Water Flow Rate
The minimum hot water volumetric flow rate in m 3/sec through the units heating coil.
Field: Heating Convergence Tolerance
The control tolerance for the unit heating output. The unit is controlled by matching the unit
output to the zone demand. The model must be numerically inverted to obtain a specified
output. The convergence tolerance is the error tolerance used to terminate the numerical
inversion procedure. Basically this is the fraction:

Qunit ,out Qzone load

Qzone load

ConvergenceTolerance

The default is 0.001.

Field: Cooling Coil Object Type
The type of cooling coil in the terminal unit. The choices are:
Coil:Cooling:Water
Coil:Cooling:Water:DetailedGeometry
In other words the unit must use only the water cooling coils.
9/29/14

911

Input-Output Reference

Group Air Distribution Equipment

Field: Cooling Coil Name

The name of the cooling coil component which composes part of the unit. Note that the
cooling coils air inlet node is the same as the heating coils air outlet node. The cooling coils
air outlet node is the same as one of the zone mixers inlets.
Field: Maximum Cold Water Flow Rate
The maximum cold water volumetric flow rate in m 3/sec through the units cooling coil.
Field: Minimum Cold Water Flow Rate
The minimum cold water volumetric flow rate in m 3/sec through the units cooling coil.
Field: Cooling Convergence Tolerance
The control tolerance for the unit cooling output. The unit is controlled by matching the unit
output to the zone demand. The model must be numerically inverted to obtain a specified
output. The convergence tolerance is the error tolerance used to terminate the numerical
inversion procedure. Basically this is the fraction:

Qunit ,out Qzone load

Qzone load

ConvergenceTolerance

The default is 0.001.

Field: Zone Mixer Name
The name of an zone mixer component (object: AirLoopHVAC:ZoneMixer) which composes
part of the terminal unit. Note that some of the zone mixers inputs will duplicate some of the
terminal unitss inputs. One of the zone mixer inlet nodes should be the same as the supply
air inlet node of the terminal unit; the other inlet node of the zone mixer should be the same
as the cooling coil air outlet node. The outlet node of the zone mixer should be the same as
the outlet node of the terminal unit.
An IDF example:
AirTerminal:SingleDuct:ConstantVolume:FourPipeInduction,
SPACE2-1 FPIU,
!- Name of System
ReheatCoilAvailSched,
!- System Availability schedule
autosize,
!- Maximum total air volume flow rate
1.0,
!- Induction ratio
SPACE2-1 ATU Supply Node, !- Terminal unit supply air inlet node
SPACE2-1 ATU Induc Node, !- Terminal unit induced air inlet node
SPACE2-1 In Node,
!- Terminal unit air outlet node
SPACE2-1 HW Coil Water In Node, !- Hot water control node
SPACE2-1 CW Coil Water In Node, !- Cold water control node
COIL:Heating:Water,
!- Heating coil object
SPACE2-1 HW Coil,
!- Heating coil name
autosize,
!- Max hot water flow
0.0,
!- Min hot water flow
0.001,
!- Heating Convergence Tolerance
COIL:Cooling:Water,
!- Cooling coil object
SPACE2-1 CW Coil,
!- Cooling coil name
autosize,
!- Max cold water flow
0.0,
!- Min cold water flow
0.001,
!- Cooling Convergence Tolerance
SPACE2-1 ATU Mixer;
!- Zone mixer component name

9/29/14

912

Input-Output Reference

Group Air Distribution Equipment

COIL:Heating:Water,
SPACE2-1 HW Coil,
!- Coil Name
ReheatCoilAvailSched,
!- Availability Schedule Name
autosize,
!- UA of the Coil {W/K}
autosize,
!- Max Water Flow Rate of Coil {m3/s}
SPACE2-1 HW Coil Water In Node, !- Coil_Water_Inlet_Node
SPACE2-1 HW Coil Water Out Node, !- Coil_Water_Outlet_Node
SPACE2-1 ATU Induc Node, !- Coil_Air_Inlet_Node
SPACE2-1 HW Coil Air Out Node;
!- Coil_Air_Outlet_Node

COIL:Cooling:Water,
SPACE2-1 CW Coil,
!- Coil Name
CWCoilAvailSched,
!- Availability Schedule
autosize,
!- UA of the Coil
autosize,
!- Max Water Flow Rate of Coil
,
!- Leaving Relative Humidity of Coil
SPACE2-1 CW Coil Water In Node, !- Coil_Water_Inlet_Node
SPACE2-1 CW Coil Water Out Node, !- Coil_Water_Outlet_Node
SPACE2-1 HW Coil Air Out Node,
!- Coil_Air_Inlet_Node
SPACE2-1 CW Coil Air Out Node;
!- Coil_Air_Outlet_Node
AirLoopHVAC:ZoneMixer,
SPACE2-1 ATU Mixer,
SPACE2-1 In Node,
SPACE2-1 ATU Supply Node,
SPACE2-1 CW Coil Air Out Node;

!!!!-

Mixer Name
Outlet_Node
Inlet_Node_1
Inlet_Node_2

Single Duct Constant Volume Four Pipe Induction AirTerminal Outputs

There are no specific outputs for the four pipe induction terminal units.
AirTerminal:SingleDuct:ConstantVolume:CooledBeam
The Cooled Beam system is a mixed air-hydronic system. A central, single-duct forced-air
system supplies conditioned ventilation air to the zones. Sensible cooling is done by chilled
water circulating through ceiling mounted cooled beam units. Chilled water flow rate through
the cooled beam units is varied to meet the zone sensible cooling load. Any dehumidification
is done by the central ventilation air system. Heating is usually accomplished with hot water
radiators. Thermodynamically, the cooled beam system resembles the four-pipe induction
unit.
To model a typical cooled beam system the user will need to define a conventional central
constant volume forced air system. This system will normally be 100% outside air delivered at
a fixed supply temperature (which could be reset by schedule or by outside air temperature).
On the supply side of this air loop there will be the usual central AC equipment: outside air
mixer, fan, heating and cooling coil. On the zone equipment (demand) side of the loop, the
chilled beams will be represented as terminal units. Additional zone equipment (such as
baseboard heaters) will be needed to handle heating loads.
Although the cooled beam equipment in a zone is treated by the program as a single terminal
unit, the actual installation will have multiple beams in each zone. The program (in its sizing
calculation for the system) figures out how many beams of what length are needed to meet
the zone design load.
Field: Name
A unique user assigned name for a particular chilled beam unit. Any reference to this unit by
another object will use this name.
Field: Availability Schedule Name
The name of the schedule (ref: Schedule) that denotes whether the unit can run during a
given time period. A schedule value greater than 0 (usually 1 is used) indicates that the unit
can be on during the time period. A value less than or equal to 0 (usually 0 is used) denotes
9/29/14

913

Input-Output Reference

Group Air Distribution Equipment

that the unit must be off for the time period. If this field is blank, the schedule has values of 1
for all time periods.
Field: Cooled Beam Type
Two types of units are modeled: Active or Passive. In the active unit, primary air is supplied
through the beam, inducing some secondary zone air into contact with the coil. This unit acts
as an active convector. The passive unit is simply a passive, finned convector. Primary air is
supplied through a normal diffuser.
Field: Supply Air Inlet Node Name
The name of the HVAC system node from which the unit draws its primary or supply air. Note
that this field should be specified for both types of unit, even though supply air does not pass
through the passive unit.
Field: Supply Air Outlet Node Name
The name of the air node that connects this terminal unit to the zone. The will be the same as
one of the zone inlet nodes. The name of this node must be entered even if the actual beams
are passive and is not actually supplying air to the zone.
Field: Chilled Water Inlet Node Name
The name of the chilled water inlet node.
Field: Chilled Water Outlet Node Name
The name of the chilled water outlet node.
Field: Supply Air Volumetric Flow Rate
This is the air flow rate in cubic meters per second of the supply air entering the zone. This
input would normally be autosized based on the ventilation requirement (see Zone Sizing).
Field: Maximum Total Chilled Water Volumetric Flow Rate
The maximum chilled water flow rate (in cubic meters per second) for the unit. This input
would normally be autosized based on the zone design load.
Field: Number of Beams
The number of individual cooled beam units in the zone. Normally this unit would be
autocalculated by the program based upon the previous field and the nominal flow rate for a
single beam unit (set by the program to 0.07 kg/s).
Field: Beam Length
The length of an individual beam in meters. Normally this will be autocalculated by the
program based upon the number of beam units and the zone design sensible cooling load. 1
to 4 meters is a typical length range.
Field: Design Inlet Water Temperature
The nominal or design inlet water temperature in degrees Celsius. The default is 15 C.
Field: Design Outlet Water Temperature
The nominal or design outlet water temperature in degrees Celsius. The default is 17 C.
The following inputs are parameters used to characterize the performance of the chilled
beam units. Values for a given unit can be obtained from the manufacturer. The parameters
are used in the following equations.
Pbeam = A K
K
v
9/29/14

Tn1
qin

beam cooling output per unit length W/m

T
n2
air

n3

coil heat transfer coefficient W/(m2K)

room air mass flow rate across coil kg/(m 2s)
914

Input-Output Reference

qin K1

Group Air Distribution Equipment

room air volumetric flow rate across coil per

unit length m3/(s-m)

Tn Kin qpr

T is the room air water temperature difference (average water temperature is used) in
degrees C.
is the water velocity in m/s.
qpr is the supply air flow rate per unit length m 3/(s-m)
Field: Coil Surface Area per Coil Length
Surface area on the air side of the beam per unit beam length. The units are square meters
per meter. The default is 5.422. This is A in the above equations.
Field: Model Parameter
This is

(a)

in the above equations. The default is 15.3

Field: Model Parameter n1

This is n1 in the above equations. The default is 0.
Field: Model Parameter n2
This is n2 in the above equations. The default is 0.84.
Field: Model Parameter n3
This is n3 in the above equations. The default is 0.12.
Field: Model Parameter

(a)

This is 0 in the above equations. It is the free area of the coil in plan view (for the air flow)
per unit beam length. The units are square meters per meter. The default is 0.171.
Field: Model Parameter K1 (K1)
This is K1 in the above equations. The default is 0.005.
Field: Model Parameter n
This is n in the above equations. The default is 0.4.
Field: Coefficient of Induction Kin (Kin)
The coefficient of induction Kin in the above equations. The default is 2.0 for active beams and
0.0 for passive beams.
Field: Pipe Inside Diameter
The water pipe inside diameter in meters. The default is 0.0145.
An example input is:
AirTerminal:SingleDuct:ConstantVolume:CooledBeam,
SPACE2-1 CB,
!- Name
CWCoilAvailSched,
!- Availability Schedule Name
Active,
!- Cooled Beam Type
SPACE2-1 ATU Supply Node,!- Supply Air Inlet Node Name
SPACE2-1 In Node,
!- Supply Air Outlet Node Name
SPACE2-1 CW Coil Water In Node, !- Chilled Water Inlet Node Name
SPACE2-1 CW Coil Water Out Node, !- Chilled Water Outlet Node Name
,
!- Supply Air Volumetric Flow Rate
,
!- Maximum Total Chilled Water Volumetric Flow Rate
,
!- Number of Beams
,
!- Beam Length
,
!- Design Inlet Water Temperature
,
!- Design Outlet Water temperature
,
!- Coil Surface Area per Coil Length
9/29/14

915

Input-Output Reference
,
,
,
,
,
,
,
,
;

Group Air Distribution Equipment

!!!!!!!!!-

Model Parameter a
Model Parameter n1
Model Parameter n2
Model Parameter n3
Model Parameter a0
Model Parameter K1
Model Parameter n
Coefficient of Induction Kin
Leaving Pipe Inside Diameter

Singled Duct Constant Volume Cooled Beam AirTerminal Outputs

HVAC,Sum,Zone Air Terminal Beam Sensible Cooling Energy [J]
HVAC,Average,Zone Air Terminal Beam Sensible Cooling Rate [W]
HVAC,Sum, Zone Air Terminal Supply Air Sensible Cooling Energy [J]
HVAC,Average,Zone Air Terminal Supply Air Sensible Cooling Rate [W]
HVAC,Sum,Zone Air Terminal Supply Air Sensible Heating Energy [J]
HVAC,Average,Zone Air Terminal Supply Air Sensible Heating Rate [W]
HVAC,Sum,Zone Air Terminal Beam Chilled Water Energy [J]

Zone Air Terminal Beam Sensible Cooling Rate [W]

Sensible cooling by the beams in the zone, exclusive of any cooling or heating done by the
supply air.
Zone Air Terminal Beam Sensible Cooling Energy [J]
Sensible cooling by the beams in the zone, exclusive of any cooling or heating done by the
supply air.
Zone Air Terminal Supply Air Sensible Cooling Rate [W]
Sensible cooling by the supply air to the zone, exclusive of any cooling done by the beams.
Zone Air Terminal Supply Air Sensible Cooling Energy [J]
Sensible cooling by the supply air to the zone, exclusive of any cooling done by the beams.
Zone Air Terminal Supply Air Sensible Heating Rate [W]
Heating by the supply air to the zone, exclusive of any cooling done by the beams.
Zone Air Terminal Supply Air Sensible Heating Energy [J]
Heating by the supply air to the zone, exclusive of any cooling done by the beams.
Zone Air Terminal Beam Chilled Water Energy [J]
The heat transfer energy for the chilled water serving the beams, in Joules.
AirTerminal:SingleDuct:InletSideMixer
The inlet side mixer air terminal unit provides a means of supplying central system air to the
air inlet of a zone AC unit such as a four pipe fan coil. Normally the central air would be
ventilation air from a dedicated outside air system (DOAS).
The AirTerminal:SingleDuct:InletSideMixer simply mixes two inlet air streams into a single
outlet stream. One inlet - designated the primary air stream - is from the DOAS. The other
inlet - designated the secondary air stream - is recirculated air from the zone. The outlet air
stream of the inlet side mixer is then the inlet to the zone AC unit.

9/29/14

916

Input-Output Reference

Group Air Distribution Equipment

Primary air from

DOA
Supply air to
zone

Fan Coil

Fan coil
inlet

TU Mixer

Secondary air
recirc from zone

Figure 108. Inlet Side Mixer Air Terminal Unit with Fan Coil
Field: Name
A unique user assigned name for a particular inlet side mixer terminal unit. Any reference to
this unit by another object will use this name.
Field: ZoneHVAC Terminal Unit Object Type
The type of zone AC unit to which this terminal unit will be connected. Currently only
ZoneHVAC:FourPipeFanCoil can be used.
Field: ZoneHVAC Terminal Unit Name
The name of the zone AC unit to which this terminal will be connected.
Field: Terminal Unit Outlet Node Name
The name of the air outlet node of the inlet side mixer. This will be the inlet air node of the
zone AC unit.
Field: Terminal Unit Primary Air Inlet Node Name
The name of the primary air inlet node of the inlet side mixer. This will be an outlet node of an
AirLoopHVAC:ZoneSplitter, providing the connection to the DOAS system.
Field: Terminal Unit Secondary Air Inlet Node Name
The name of the secondary air inlet node of the inlet side mixer. This will be an exhaust node
of the zone that is being conditioned.
An IDF example:
AirTerminal:SingleDuct:InletSideMixer,
SPACE2-1 DOAS Air Terminal, !- Name
ZoneHVAC:FourPipeFanCoil,!- ZoneHVAC Terminal Unit Object Type
SPACE2-1 Fan Coil,
!- ZoneHVAC Terminal Unit Name
SPACE2-1 Fan Coil Inlet, !- Terminal Unit Outlet Node Name
SPACE2-1 Air Terminal Mixer Primary Inlet, !- Terminal Unit Primary Air Inlet Node Name
SPACE2-1 Air Terminal Mixer Secondary Inlet; !- Terminal Unit Secondary Air Inlet Node Name

AirTerminal:SingleDuct:SupplySideMixer
The supply side mixer air terminal unit provides a means of supplying central system air to
the air outlet of a zone AC unit such as a four pipe fan coil. Normally the central air would be
ventilation air from a dedicated outside air system (DOAS).
The AirTerminal:SingleDuct:SupplySideMixer simply mixes two inlet air streams into a single
outlet stream. One inlet - designated the primary air stream - is from the DOAS. The other

9/29/14

917

Input-Output Reference

Group Air Distribution Equipment

inlet - designated the secondary air stream - is outlet air from the zone AC unit. The outlet air
stream from the supply side mixer is then the inlet to the conditioned zone.

Primary air from DOA

Supply air to
zone

TU Mixer

Fan Coil

Secondary air
recirc from zone

Secondary
air
Figure 109. Supply Side Mixer Air Terminal Unit with Fan Coil
Field: Name
A unique user assigned name for a particular supply side mixer terminal unit. Any reference
to this unit by another object will use this name.
Field: ZoneHVAC Terminal Unit Object Type
The type of zone AC unit to which this terminal unit will be connected. Currently only
ZoneHVAC:FourPipeFanCoil can be used.
Field: ZoneHVAC Terminal Unit Name
The name of the zone AC unit to which this terminal will be connected.
Field: Terminal Unit Outlet Node Name
The name of the air outlet node of the supply side mixer. This will be an inlet air node of the
conditioned zone.
Field: Terminal Unit Primary Air Inlet Node Name
The name of the primary air inlet node of the supply side mixer. This will be an outlet node of
an AirLoopHVAC:ZoneSplitter, providing the connection to the DOAS system.
Field: Terminal Unit Secondary Air Inlet Node Name
The name of the secondary air inlet node of the supply side mixer. This will be the outlet air
node of the zone AC unit.
An IDF example:

9/29/14

918

Input-Output Reference

Group Air Distribution Equipment

AirTerminal:SingleDuct:SupplySideMixer,
SPACE1-1 DOAS Air Terminal, !- Name
ZoneHVAC:FourPipeFanCoil,!- ZoneHVAC Terminal Unit Object Type
SPACE1-1 Fan Coil,
!- ZoneHVAC Terminal Unit Name
SPACE1-1 Supply Inlet,
!- Terminal Unit Outlet Node Name
SPACE1-1 Air Terminal Mixer Primary Inlet, !- Terminal Unit Primary Air Inlet Node Name
SPACE1-1 Fan Coil Outlet;!- Terminal Unit Secondary Air Inlet Node Name

AirTerminal:DualDuct:ConstantVolume
The AirTerminal:DualDuct:ConstantVolume simulation or the typical Multizone is described
by this Air Distribution Unit (ADU). Multizone systems condition all the air in a central
apparatus and distribute it to the conditioned zones through two parallel ducts. One duct
carries cold air and the other warm air, providing air sources for both heating and cooling at
all times. In each conditioned zone, a mixing valve responsive to a room thermostat mixes
the warm and cold air in proper proportions to satisfy the prevailing heating or cooling load of
the space. The Multizone ADU is the specific component that leads to the zone containing
the mixer and the mixing damper and then connecting to the zone. The total airflow to each
room is kept constant while the proportion of hot air to cold air is adjusted to maintain the
temperature in each zone at the desired level.
Field: Name
Unique name for the Multizone ADU.
Field: Availability Schedule Name
Schedule that this component will operate or is available to operate for a given time period. A
schedule value greater than 0 (usually 1 is used) indicates that the component can be on
during the time period. A value less than or equal to 0 (usually 0 is used) denotes that the
component must be off for the time period. If this field is blank, the schedule has values of 1
for all time periods.
Field: Air Outlet Node Name
The outlet node from the ADU to the zone.
Field: Hot Air Inlet Node Name
The air-inlet node name that connects the hot air splitter to the individual zone ADU.
Field: Cold Air Inlet Node Name
The air-inlet node name that connects the cold air splitter to the individual zone ADU.
Field: Maximum Air Flow Rate
The design constant volume flow rate (m 3/sec) specified for that Multizone ADU.
An IDF example:
AirTerminal:DualDuct:ConstantVolume,
Zone2MixDamp, !- Name
FanAndCoilAvailSched, !- Availability Schedule
Zone 2 Dual Duct Outlet, !- Unit Air Outlet Node
Zone 2 Dual Duct Hot Inlet, !- Unit Hot Air Inlet Node
Zone 2 Dual Duct Cold Inlet, !- Unit Cold Air Inlet Node
0.36; !- Max Air Flow Rate {m3/s}

Dual Duct Constant Volume AirTerminal Outputs

HVAC,Average,Zone Air Terminal Cold Supply Duct Damper Position []
HVAC,Average,Zone Air Terminal Hot Supply Duct Damper Position []

9/29/14

919

Input-Output Reference

Group Air Distribution Equipment

Zone Air Terminal Cold Supply Duct Damper Position

This output is the damper position of the cold air stream in a dual duct air terminal. This is the
average value over the frequency being reported. The damper position is defined as the
terminal unit cold air mass flow rate divided by the terminal units maximum cold air mass
flow rate. This output is dimensionless and ranges from 0.0 to 1.0.
Zone Air Terminal Hot Supply Duct Damper Position
This output is the damper position of the hot air stream in a dual duct air terminal. This is the
average value over the frequency being reported. The damper position is defined as the
terminal unit hot air mass flow rate divided by the terminal units maximum hot air mass flow
rate. This output is dimensionless and ranges from 0.0 to 1.0.
AirTerminal:DualDuct:VAV
AirTerminal:DualDuct:VAV (i.e., Dual duct variable air volume (DDVAV)) systems are used to
obtain zone temperature control by mixing the cold and warm air in various volume
combinations. The fan is sized for the anticipated maximum coincident hot or cold volume,
not the sum of the instantaneous peaks. This system has an advantage of a true single path
VAV system, except for warm port leakage. When cold air is modulated for control before
mixing, it operates similar to the VAV induction when mixing occurs without hot deck reheat.
It is similar to a reheat system when mixing occurs while the hot deck is using the reheat coil.
It uses more energy than a true VAV system, but less than a constant volume dual duct
system.
Field: Name
Unique name for the AirTerminal:DualDuct:VAV Air Distribution Unit (ADU).
Field: Availability Schedule Name
Schedule that this component will operate or is available to operate for a given time period. A
schedule value greater than 0 (usually 1 is used) indicates that the component can be on
during the time period. A value less than or equal to 0 (usually 0 is used) denotes that the
component must be off for the time period. If this field is blank, the schedule has values of 1
for all time periods.
Field: Air Outlet Node Name
The outlet node from the ADU to the zone.
Field: Hot Air Inlet Node Name
The air-inlet node name that connects the hot air splitter to the individual zone ADU.
Field: Cold Air Inlet Node Name
The air-inlet node name that connects the cold air splitter to the individual zone ADU.
Field: Maximum Damper Air Flow Rate
The design maximum volume flow rate (m 3/sec) specified for DDVAV ADU.
Field: Zone Minimum Air Flow Fraction
The minimum flow rate to the zone while the system is operating, specified as a fraction of
the Max Damper Air Flow Rate. The minimum zone fraction is normally specified to meet the
minimum ventilation requirement for the occupants.
Field: Design Specification Outdoor Air Object Name
This alpha field specifies the name of a DesignSpecification:OutdoorAir object. When this
field is used, the terminal unit will increase flow as needed to meet this outdoor air
requirement. If Outdoor Air Flow per Person is non-zero, then the outdoor air requirement will
9/29/14

920

Input-Output Reference

Group Air Distribution Equipment

be computed based on the current number of occupants in the zone. At no time will the
supply air flow rate exceed the value for Maximum Air Flow Rate. If this field is blank, then
the terminal unit will not be controlled for outdoor air flow. See documentation for the zone
HVAC outdoor air object for further information (Ref DesignSpecification:OutdoorAir).
An IDF example:
AirTerminal:DualDuct:VAV,
Zone1MixDamp,
!- Name
FanAndCoilAvailSched,
!- Availability Schedule Name
Zone 1 Dual Duct Outlet, !- Air Outlet Node Name
Zone 1 Dual Duct Hot Inlet, !- Hot Air Inlet Node Name
Zone 1 Dual Duct Cold Inlet, !- Cold Air Inlet Node Name
autosize,
!- Maximum Air Flow Rate {m3/s}
0.1,
!- Zone Minimum Air Flow Fraction
ZoneMinOARequirements;
!- Design Specification Outdoor Air Object Name
! Outdoor air specification should be consistent with Sizing:Zone object
inputs.
DesignSpecification:OutdoorAir,
ZoneMinOARequirements,
!- Name
Sum,
!- Outdoor Air Method
0.00944,
!- Outdoor Air Flow per Person {m3/s}
0.000508,
!- Outdoor Air Flow per Zone Floor Area {m3/sm2}
,
!- Outdoor Air Flow per Zone
,
!- Outdoor Air Flow Air Changes per Hour
Min OARequirements Sched; !- Outdoor Air Flow Rate Fraction Schedule Name
Schedule:Compact,
Min OARequirements Sched, !Any Number,
!Through: 12/31,
!For: Weekdays SummerDesignDay
Until: 24:00,1.0,
!For: AllOtherDays,
!Until: 24:00,0.25;
!-

Name
Schedule Type Limits Name
Field 1
WinterDesignDay, !- Field 2
Field 7
Field 9
Field 10

Dual Duct VAV AirTerminal Outputs

HVAC,Average,Zone Air Terminal Cold Supply Duct Damper Position []
HVAC,Average,Zone Air Terminal Hot Supply Duct Damper Position []
HVAC,Average,Zone Air Terminal Outdoor Air Volume Flow Rate [m3/s]

Zone Air Terminal Cold Supply Duct Damper Position []

This output is the damper position of the cold air stream in a dual duct air terminal. This is the
average value over the frequency being reported. The damper position is defined as the
terminal unit cold air mass flow rate divided by the terminal units maximum cold air mass
flow rate.
Zone Air Terminal Hot Supply Duct Damper Position []
This output is the damper position of the hot air stream in a dual duct air terminal. This is the
average value over the frequency being reported. The damper position is defined as the
terminal unit hot air mass flow rate divided by the terminal units maximum hot air mass flow
rate.
Zone Air Terminal Outdoor Air Volume Flow Rate [m3/s]
This output is the amount of outdoor air entering the zone. This is the average value
over the frequency being reported. The amount of outdoor air is defined as the terminal

9/29/14

921

Input-Output Reference

Group Air Distribution Equipment

unit air volume flow rate multiplied by the fraction of outdoor air entering the air loops
outdoor air system.
AirTerminal:DualDuct:VAV:OutdoorAir
AirTerminal:DualDuct:VAV:OutdoorAir provides a model for a type of dual duct air system in
which one duct provides outdoor air ventilation and the other provides VAV cooling. The
Outdoor Air stream and the Recirculated Air stream are conditioned and supplied through
separate air streams as part of a centralized dedicated outdoor air (DOAS) distribution
system. The dual duct arrangement allows the ventilation air to be controlled separately using
schedules or occupancy demand while the recirculated air is controlled to meet the dry-bulb
zone temperature setpoint. The two airstreams remain decoupled until the terminal box
where they are mixed. The terminal unit is meant for systems regulating outdoor air based
only on demand control or code minimum settings and not on economizer operation.
This air terminal does not have heating coils and is not configured for conditions zones that
need heat. Additional ZoneHVAC equipment, such as baseboards or fan coil units, are
needed to provide heating to the zone when using this air terminal.
Although this air terminal is primarily for dual duct system, it is allowed to use just the outdoor
air side in a single duct system. This can be useful for modeling single duct DOAS when the
required volume of outdoor air varies over time.
Field: Name
Unique name for the AirTerminal:DualDuct:VAV:OutdoorAir Air Distribution Unit (ADU).
Field: Availability Schedule Name
Schedule that this component will operate or is available to operate for a given time
period. A schedule value greater than 0 (usually 1 is used) indicates that the component
can be on during the time period. A value less than or equal to 0 (usually 0 is used)
denotes that the component must be off for the time period. If this field is blank, the
schedule has values of 1 for all time periods.
Field: Air Outlet Node Name
The outlet node of the terminal unit. This is the node leaving the unit and serving as the inlet
to the zone. It is for the mixed flow leaving from both of the inlet node.
Field: Outdoor Air Inlet Node Name
The inlet node of the Outdoor Air (OA) stream deck of the Dual Duct system.
Field: Recirculated Air Inlet Node Name
The inlet node of the Recirculated Air (RA) stream deck of the Dual Duct system. This input
is optional. If no node name is entered here, then the recirulation duct is disabled and the
model functions as a single duct terminal and no second cooling deck is needed.
Field: Maximum Zone Total Airflow Rate
Max total airflow rate (in m3/s) at the terminal unit outlet including both the Outdoor Air
stream and the Recirculated stream. Can be autosized based on the Design Outdoor Airflow
Rate and the zone thermal cooling load. The autosized flow rate will be the sum of the
maximum outdoor air requirement and the flow for cooling. When autosizing, this maximum
and the individual inlet flow rate sizes are reported to the eio file.
Field: Design Specification Outdoor Air Object Name
This field specifies the name of a DesignSpecification:OutdoorAir object. This field is
required for this object. The terminal unit will modulate the Outdoor Air stream to meet this
outdoor air requirement. If Outdoor Air Flow per Person is applied, then the outdoor air
required will be based on either the current number of occupants in the zone, as for demand
9/29/14

922

Input-Output Reference

Group Air Distribution Equipment

controlled ventilation, or the design level of occupants depending on the setting in the next
field.
Field: Per Person Ventilation Rate Mode
This field specifies how the outdoor air ventilation rates are calculated when based on a rate
per person. It can be either based on the current number of people as affected by timevarying occupancy schedules, or on the constant value for the maximum number of people.
Enter the key CurrentOccupancy for the former and DesignOccupancy for the later.
An example input object follows.
AirTerminal:DualDuct:VAV:OutdoorAir,
Media_Center Dual Duct Box Component,
ALWAYS_ON,
Media_Center Dual Duct Box Outlet Node Name,
Media_Center Dual Duct Box Inlet Node Name,
RC Media_Center Dual Duct Box Inlet Node Name,
AUTOSIZE,
Media_Center Dual Duct Box OA Design Spec,
CurrentOccupancy;

!!!!!!!!-

Name
Availability Schedule Name
Air Outlet Node Name
Outdoor Air Inlet Node Name
Recirculated Air Inlet Node Name
Maximum Terminal Air Flow Rate {m3/s}
Design Specification Outdoor Air Object Name
Per Person Ventilation Rate Mode

DesignSpecification:OutdoorAir,
Media_Center Dual Duct Box OA Design Spec, !- Name
Sum,
!- Outdoor Air Method
0.004719,
!- Outdoor Air Flow per Person {m3/s-person}
0.00061,
!- Outdoor Air Flow per Zone Floor Area {m3/s-m2}
0.0,
!- Outdoor Air Flow per Zone {m3/s}
0.0,
!- Outdoor Air Flow Air Changes per Hour
MinOA_Sched;
!- Outdoor Air Flow Rate Fraction Schedule Name

Dual Duct VAV Outdoor Air AirTerminal Outputs

Output:Variable,*,Zone Air Terminal Outdoor Air Duct Damper Position,hourly; !- HVAC Average []
Output:Variable,*,Zone Air Terminal Recirculated Air Duct Damper Position,hourly; !- HVAC Average []
Output:Variable,*,Zone Air Terminal Outdoor Air Fraction,hourly; !- HVAC Average []

Zone Air Terminal Outdoor Air Duct Damper Position []

This output is the damper position of the outdoor air stream in a dual duct air terminal. This is
the average value over the frequency being reported. The damper position is defined as the
terminal unit outdoor air mass flow rate divided by the terminal units maximum outdoor air
mass flow rate. This output is dimensionless and ranges from 0.0 to 1.0.
Zone Air Terminal Recirculated Air Duct Damper Position []
This output is the damper position of the recirculated cool air stream in a dual duct air
terminal. This is the average value over the frequency being reported. The damper position is
defined as the terminal unit cool air mass flow rate divided by the terminal units maximum
cool air mass flow rate. This output is dimensionless and ranges from 0.0 to 1.0.
Zone Air Terminal Outdoor Air Fraction []
This output is the current fraction of outdoor air contained in the combined flow of aire
entering the zone from the terminal unit. This is the average value over the frequency being
reported. The outdoor air fraction is defined as the terminal unit outdoor air mass flow rate
divided by the total air mass flow rate. This output is dimensionless and ranges from 0.0 to
1.0.

9/29/14

923

Input-Output Reference

Group Zone Forced Air Units

Group Zone Forced Air Units

ZoneHVAC:IdealLoadsAirSystem
The simplest piece of zone equipment is the ZoneHVAC:IdealLoadsAirSystem component.
ZoneHVAC:IdealLoadsAirSystem is used in situations where the user wishes to study the
performance of a building without modeling a full HVAC system. In such a case, the Ideal
Loads Air System is usually the sole conditioning component: the user does not need to
specify air loops, water loops, etc. All that is needed for the ideal system are zone controls,
zone equipment configurations, and the ideal loads system component.
This component can be operated with infinite or finite heating and cooling capacity. For either
mode infinite or limited capacity the user can also specify on/off schedules for heating
and cooling and outdoor air controls. There are also optional controls for dehumidification,
humidification, economizer, and heat recovery. This component may be used in combination
with other HVAC equipment serving the same zone.
This component can be thought of as an ideal unit that mixes air at the zone exhaust
condition with the specified amount of outdoor air and then adds or removes heat and
moisture at 100% efficiency in order to produce a supply air stream at the specified
conditions. The energy required to condition the supply air is metered and reported as
DistrictHeating and DistrictCooling.
Notes: The ideal loads system uses the zone return node or an optional zone exhaust node
to extract air from the zone. Every zone served by an HVAC component must have a return
air node, even though this node may not be connected to anything.
The ideal loads system was significantly expanded in version 7.0 (October 2011). As part of
this upgrade, any change in the moisture content of the supply air stream results in a latent
cooling (dehumidification) or latent heating (humidification) load which is metered as
DistrictCooling and DistrictHeating energy consumption. Prior to version 7.0, when the ideal
loads system was in heating mode, only the energy for sensible heating was metered. This
results in significant changes in reported energy use compared to earlier versions, especially
when using the ConstantSupplyHumidityRatio option for Humidification Control Type.
Older idf files which are transitioned to version 7.0 will automatically be set to use the
ConstantSupplyHumidityRatio option for both dehumidification and humidification controls,
because this is equivalent to the controls used in the older version of this system. However,
the user should review all of the humidity control options and select the one which best
reflects the goal of the simulation.
Field: Name
A unique user assigned name for each ideal loads air system component. This name is
referenced in a ZoneHVAC:EquipmentList object.
Field: Availability Schedule Name
This alpha field defines the name of the schedule (ref: Schedule) that denotes whether or not
this component is available to operate during a given time period. If the schedule value is
greater than zero then the system is available to operate; otherwise, the system is
unavailable for that time period. If this field is blank, the schedule has values of 1 for all time
periods.
Field: Zone Supply Air Node Name
The name of the outlet air node of the ideal loads object. This should be the same as one of
the zone air inlet nodes for the zone the ideal loads component is serving.
Field: Zone Exhaust Air Node Name
The name of the zone exhaust air node of the ideal loads object. This should be the same as
one of the zone air exhaust nodes for the zone this component is serving. This node name is
9/29/14

924

Input-Output Reference

Group Zone Forced Air Units

required if ZoneHVAC:IdealLoadsAirSystem is used in a zone which also has other forced air
HVAC equipment. Otherwise this node name is optional but recommended.
Field: Maximum Heating Supply Air Temperature
The maximum air temperature (degrees C) of the air used for heating the zone. The default is
50C (122F).
Field: Minimum Cooling Supply Air Temperature
The minimum air temperature (degrees C) of the air used for cooling the zone. The default is
13C (55.4F).
Field: Maximum Heating Supply Air Humidity Ratio
The maximum humidity ratio (kg of water per kg of dry air) of the hot supply air. The default is
0.0156 kgWater/kgDryAir which corresponds to a 20%RH at 50C (122F) dry bulb.
Field: Minimum Cooling Supply Air Humidity Ratio
The minimum humidity ratio (kg of water per kg of dry air) of the cool supply air. The default is
0.0077 kgWater/kgDryAir which corresponds to a 10C (50F) dew point.
Field: Heating Limit
The input must be either LimitFlowRate, LimitCapacity, LimitFlowRateAndCapacity or
NoLimit. LimitFlowRate means that the heating supply air flow rate will be limited to the
value specified in the next input field. LimitCapacity means that the sensible heating
capacity will be limited to the value specified in the Maximum Sensible Heating Capacity field.
LimitFlowRateAndCapacity means that both flow rate and capacity will be limited. NoLimit
(the default) means that there will not be any limit on the heating supply air flow rate or
capacity and the subsequent two fields will be ignored.
Field: Maximum Heating Air Flow Rate
The maximum heating supply air flow rate in cubic meters per second if heating limit is set to
LimitFlowRate or LimitFlowRateAndCapacity . This field may be autosized. This field is
ignored if heating limit is set to NoLimit or LimitCapacity. If blank, there is no limit.
Field: Maximum Sensible Heating Capacity
The maximum allowed sensible heating capacity in Watts if Heating Limit is set to
LimitCapacity or LimitFlowRateAndCapacity. This field may be autosized. If blank, there is
no limit. If Heating Limit is set to NoLimit or LimitFlowRate, this field is ignored.
Field: Cooling Limit
The input must be either LimitFlowRate, LimitCapacity, LimitFlowRateAndCapacity or
NoLimit. LimitFlowrate means that the cooling supply air flow rate will be limited to the
value specified in the next input field. LimitCapacity means that the total cooling capacity will
be limited to the value specified in the Maximum Total Cooling Capacity field.
LimitFlowRateAndCapacity means that both flow rate and capacity will be limited. NoLimit
(the default) means that there will not be any limit on the cooling supply air flow rate or
capacity and the subsequent two fields will be ignored.
Field: Maximum Cooling Air Flow Rate
The maximum cooling supply air flow rate in cubic meters per second if Cooling Limit is set to
LimitFlowRate or LimitFlowRateAndCapacity. This field may be autosized. This field is
ignored if cooling limit is set to NoLimit or LimitCapacity. If blank, there is no limit. If Cooling
Limit is set to NoLimit, this field is ignored. This field is required if Outdoor Air Control Type is
TemperatureEconomizer in order to establish an upper limit on outdoor air flow when the
economizer is active.

9/29/14

925

Input-Output Reference

Group Zone Forced Air Units

Field: Maximum Total Cooling Capacity

The maximum allowed total (sensible plus latent) cooling capacity in Watts if Cooling Limit is
set to LimitCapacity or LimitFlowRateAndCapacity. This field may be autosized. If blank,
there is no limit. If Cooling Limit is set to NoLimit or LimitFlowRate, this field is ignored.
Field: Heating Availability Schedule Name
The name of a schedule (ref: Schedule) that denotes whether heating is available. A
schedule value greater than 0 (usually 1 is used) indicates that heating and humidification are
available. A value less than or equal to 0 (usually 0 is used) denotes that heating and
humidification are not available. If blank, heating and humidification are always available.
Field: Cooling Availability Schedule Name
The name of a schedule (ref: Schedule) that denotes whether cooling is available. A schedule
value greater than 0 (usually 1 is used) indicates that cooling and dehumidification are
available. A value less than or equal to 0 (usually 0 is used) denotes that cooling and
dehumidification is not available. If blank, cooling and dehumidification are always available.
Field: Dehumidification Control Type
Select
from
ConstantSensibleHeatRatio,
Humidistat,
None,
or
ConstantSupplyHumidityRatio. ConstantSensibleHeatRatio (the default) means that the
ideal loads system will be controlled to meet the sensible cooling load, and the latent cooling
rate will be computed using a constant sensible heat ratio (SHR) (see next field). Humidistat
means that there is a ZoneControl:Humidistat for this zone and the ideal loads system will
attempt to meet the humidistat request (i.e. will dehumidify according to the Dehumidifying
Relative Humidity Schedule in the ZoneControl:Humidistat object). None means that there is
no dehumidification. ConstantSupplyHumidityRatio means that during cooling the supply
air will always be at the Minimum Cooling Supply Humidity Ratio. For
ConstantSensibleHeatRatio and Humidistat, if the mixed air humidity ratio is less than the
target humidity ratio, then the mixed air humidity ratio will be used. For all options, the supply
air humidity ratio will never be allowed to exceed saturation at the supply dry bulb
temperature.
The selected dehumidification control type is always applied when the unit is in cooling mode.
If the unit is in deadband mode (not actively heating the supply air) control type Humidistat
will be active. If the unit is in heating mode, control type Humidistat will be active if the
Humidification Control Type field below is set to Humidistat or None.
This allows the ideal loads system to heat and dehumidify at the same time.
Field: Cooling Sensible Heat Ratio
When the Dehumidification Control Type is set to ConstantSensibleHeatRatio the ideal
loads system will be controlled to meet the sensible cooling load, and the latent cooling rate
will be computed using the value of Cooling Sensible Heat Ratio (SHR), where SHR =
Sensible Cooling divided by Total Cooling (sensible plus latent). The default is 0.7. If
Dehumidification Control Type is set to something other than ConstantSensibleHeatRatio
then this field will be ignored.
Field: Humidification Control Type
Select from None, Humidistat, or ConstantSupplyHumidityRatio. None means that there
is no humidification. Humidistat means that there is a ZoneControl:Humidistat for this zone
and the ideal loads system will attempt to meet the humidistat request (i.e., humidify
according to the Humidifying Relative Humidity Setpoint Schedule in the
ZoneControl:Humidistat object). ConstantSupplyHumidityRatio means that during heating
the supply air will always be at the Maximum Heating Supply Humidity Ratio. The default is
None. For Humidistat, if the mixed air humidity ratio is greater than the target humidity ratio,

9/29/14

926

Input-Output Reference

Group Zone Forced Air Units

then the mixed air humidity ratio will be used. For all options, the supply air humidity ratio will
never be allowed to exceed saturation at the supply dry bulb temperature.
The selected humidification control type is always applied when the unit is in heating mode. If
the unit is in deadband mode (not actively heating the supply air) control type Humidistat will
be active. If the unit is in cooling mode, control type Humidistat will be active if the
Dehumidification Control Type field above is set to Humidistat or None.
This allows the ideal loads system to cool and humidify at the same time.
Field: Design Specification Outdoor Air Object Name
This alpha field specifies the name of a DesignSpecification:OutdoorAir object which
specifies the outdoor air requirements and schedule for this system. The outdoor air flow rate
may also be affected by the next two fields, Demand Controlled Ventilation Type and Outdoor
Air Economizer Type. If this field is blank, this system will have no outdoor air, and all outdoor
air control and heat recovery options will be ignored..
Field: Outdoor Air Inlet Node Name
This alpha field specifies the node name of the outdoor air inlet node. This node name is also
specified in an OutdoorAir:Node or OutdoorAir:NodeList object. If this field is blank, a node
name will be created internally.
Field: Demand Controlled Ventilation Type
This field, along with the Design Specification Outdoor Air Object (if used) specifies how the
minimum outdoor air flow rate is calculated. The choices are: None, OccupancySchedule or
CO2Setpoint. The default is None.
None means that the design occupancy level will be used when computing the
minimum outdoor air flow rate based on the inputs in the Design Specification
Outdoor Air Object (see previous field).
OccupancySchedule means that the current occupancy level will be used when
computing the minimum outdoor air flow rate based on the inputs in the Design
Specification Outdoor Air Object (see previous field).
CO2Setpoint means that the design occupancy level will be used when computing
the minimum outdoor air flow rate based on the inputs in the Design Specification
Outdoor Air Object (see previous field). In addition, the minimum outdoor air flow rate
may be increased if necessary to maintain the level of indoor air carbon dioxide at or
below the setpoint defined in a ZoneControl:ContaminantController object.
Field: Outdoor Air Economizer Type
This field specifies if there is an outdoor air economizer. The choices are: NoEconomizer,
DifferentialDryBulb, or DifferentialEnthalpy. The default is NoEconomizer.
DifferentialDryBulb and DifferentialEnthalpy mean that the economizer will increase the
outdoor air flow rate above the minimum outdoor air flow (see fields Design Specification
Outdoor Air Object Name and Demand Controlled Ventilation Type) when there is a cooling
load and the outdoor air temperature or enthalpy is below the zone exhaust air temperature
or enthalpy. The DifferentialDryBulb and DifferentialEnthalpy options require that the
Maximum Cooling Air Flow Rate be specified which will be used as the limit for maximum
outdoor air flow rate.
Field: Heat Recovery Type
Select from None, Sensible, or Enthalpy. None means that there is no heat recovery.
Sensible means that there is sensible heat recovery whenever the zone exhaust air
temperature is more favorable than the outdoor air temperature. Enthalpy means that there
is latent and sensible heat recovery whenever the zone exhaust air enthalpy is more
favorable than the outdoor air enthalpy. The default is None.

9/29/14

927

Input-Output Reference

Group Zone Forced Air Units

Field: Sensible Heat Recovery Effectiveness

The sensible heat recovery effectiveness, where effectiveness is defined as the change in
supply temperature divided by the difference in entering supply and relief air temperatures.
The default is 0.70.
Field: Latent Heat Recovery Effectiveness
The latent heat recovery effectiveness, where effectiveness is defined as the change in
supply humidity ratio divided by the difference in entering supply and relief air humidity ratios.
The default is 0.65.
Field: Design Specification ZoneHVAC Sizing Object Name
This optional input field is the name of a DesignSpecificationZoneHVACSizing object. The
name must correspond to unique name of a DesignSpecification:ZoneHVAC:Sizing object. A
Design Sepcification Zone HVAC Sizing object defines scalable sizing methods for sizing
input fields such as Maximum Heating Air Flow Rate and Maximum Cooling Air Flow Rate in
a Ideal Load Air System zone HVAC object. The scaled maximum heating and cooling air
flow rates are used to size the heating and cooling capacities.
An example of this object in an IDF is:
ZoneHVAC:IdealLoadsAirSystem,
Zone1 Ideal Loads System, !- Name
AlwaysOn,
!- Availability Schedule Name
Zone1 Ideal Loads Supply Node, !- Zone Supply Air Node Name
Zone1 Ideal Loads Return Node, ! Zone Exhaust Air Node Name
50,
!- Maximum Heating Supply Air Temperature {C}
13,
!- Minimum Cooling Supply Air Temperature {C}
0.0156,
!- Maximum Heating Supply Air Humidity Ratio {kgWater/kgDryAir}
0.0077,
!- Minimum Cooling Supply Air Humidity Ratio {kgWater/kgDryAir}
NoLimit,
!- Heating Limit
,
!- Maximum Heating Air Flow Rate {m3/s}
,
!- Maximum Sensible Heating Capacity {W}
NoLimit,
!- Cooling Limit
,
!- Maximum Cooling Air Flow Rate {m3/s}
,
!- Maximum Total Cooling Capacity {W}
,
!- Heating Availability Schedule Name
,
!- Cooling Availability Schedule Name
ConstantSensibleHeatRatio, !- Dehumidification Control Type
0.7,
!- Cooling Sensible Heat Ratio
None,
!- Humidification Control Type
Office OA Specification, !- Design Specification Outdoor Air Object Name
Zone1 Ideal Loads OA Inlet Node, !- Outdoor Air Inlet Node Name
None,
!- Demand Controlled Ventilation Type
NoEconomizer,
!- Outdoor Air Economizer Type
Enthalpy,
!- Heat Recovery Type
0.70,
!- Sensible Heat Recovery Effectiveness
0.65;
!- Latent Heat Recovery Effectiveness

ZoneHVAC:IdealLoadsAirSystem Outputs
HVAC,Sum,Zone
HVAC,Sum,Zone
HVAC,Sum,Zone
HVAC,Sum,Zone
HVAC,Sum,Zone
HVAC,Sum,Zone
HVAC,Sum,Zone
HVAC,Sum,Zone
HVAC,Sum,Zone
HVAC,Sum,Zone
HVAC,Sum,Zone
HVAC,Sum,Zone
9/29/14

Ideal
Ideal
Ideal
Ideal
Ideal
Ideal
Ideal
Ideal
Ideal
Ideal
Ideal
Ideal

Loads
Loads
Loads
Loads
Loads
Loads
Loads
Loads
Loads
Loads
Loads
Loads

Supply Air Sensible Heating Energy [J]

Supply Air Total Heating Energy [J]
Supply Air Sensible Cooling Energy [J]
Supply Air Latent Cooling Energy [J]
Supply Air Total Cooling Energy [J]
Supply Air Latent Heating Energy [J]
Zone Sensible Heating Energy [J]
Zone Latent Heating Energy [J]
Zone Total Heating Energy [J]
Zone Sensible Cooling Energy [J]
Zone Latent Cooling Energy [J]
Zone Total Cooling Energy [J]
928

Input-Output Reference

Group Zone Forced Air Units

HVAC,Sum,Zone Ideal Loads Outdoor Air Sensible Heating Energy [J]

HVAC,Sum,Zone Ideal Loads Outdoor Air Latent Heating Energy [J]
HVAC,Sum,Zone Ideal Loads Outdoor Air Total Heating Energy [J]
HVAC,Sum,Zone Ideal Loads Outdoor Air Sensible Cooling Energy [J]
HVAC,Sum,Zone Ideal Loads Outdoor Air Latent Cooling Energy [J]
HVAC,Sum,Zone Ideal Loads Outdoor Air Total Cooling Energy [J]
HVAC,Sum,Zone Ideal Loads Heat Recovery Sensible Heating Energy [J]
HVAC,Sum,Zone Ideal Loads Heat Recovery Latent Heating Energy [J]
HVAC,Sum,Zone Ideal Loads Heat Recovery Total Heating Energy [J]
HVAC,Sum,Zone Ideal Loads Heat Recovery Sensible Cooling Energy [J]
HVAC,Sum,Zone Ideal Loads Heat Recovery Latent Cooling Energy [J]
HVAC,Sum,Zone Ideal Loads Heat Recovery Total Cooling Energy [J]
HVAC,Average,Zone Ideal Loads Supply Air Sensible Heating Rate [W]
HVAC,Average,Zone Ideal Loads Supply Air Latent Heating Rate [W]
HVAC,Average,Zone Ideal Loads Supply Air Total Heating Rate [W]
HVAC,Average,Zone Ideal Loads Supply Air Sensible Cooling Rate [W]
HVAC,Average,Zone Ideal Loads Supply Air Latent Cooling Rate [W]
HVAC,Average,Zone Ideal Loads Supply Air Total Cooling Rate [W]
HVAC,Average,Zone Ideal Loads Zone Sensible Heating Rate [W]
HVAC,Average,Zone Ideal Loads Zone Latent Heating Rate [W]
HVAC,Average,Zone Ideal Loads Zone Total Heating Rate [W]
HVAC,Average,Zone Ideal Loads Zone Sensible Cooling Rate [W]
HVAC,Average,Zone Ideal Loads Zone Latent Cooling Rate [W]
HVAC,Average,Zone Ideal Loads Zone Total Cooling Rate [W]
HVAC,Average,Zone Ideal Loads Outdoor Air Sensible Heating Rate [W]
HVAC,Average,Zone Ideal Loads Outdoor Air Latent Heating Rate [W]
HVAC,Average,Zone Ideal Loads Outdoor Air Total Heating Rate [W]
HVAC,Average,Zone Ideal Loads Outdoor Air Sensible Cooling Rate [W]
HVAC,Average,Zone Ideal Loads Outdoor Air Latent Cooling Rate [W]
HVAC,Average,Zone Ideal Loads Outdoor Air Total Cooling Rate [W]
HVAC,Average,Zone Ideal Loads Heat Recovery Sensible Heating Rate [W]
HVAC,Average,Zone Ideal Loads Heat Recovery Latent Heating Rate [W]
HVAC,Average,Zone Ideal Loads Heat Recovery Total Heating Rate [W]
HVAC,Average,Zone Ideal Loads Heat Recovery Sensible Cooling Rate [W]
HVAC,Average,Zone Ideal Loads Heat Recovery Latent Cooling Rate [W]
HVAC,Average,Zone Ideal Loads Heat Recovery Total Cooling Rate [W]
HVAC,Sum,Zone Ideal Loads Economizer Active Time [hr]
HVAC,Sum,Zone Ideal Loads Heat Recovery Active Time [hr]
HVAC,Average,Zone Ideal Loads Hybrid Ventilation Available Status []

Ideal Loads Output Variable Overview

All of the ZoneHVAC:IdealLoadsAirSystem loads and energy use are reported for Sensible
Heating, Latent Heating, Total Heating, Sensible Cooling, Latent Cooling, and Total Cooling.
To explain the relationship between the various outputs, Total Cooling Energy will be used.
Zone Ideal Loads Supply Air Total Cooling Energy is the district cooling energy
consumed by the ideal loads system cooling coil to cool and dehumidify the supply air.
Zone Ideal Loads Zone Total Cooling Energy is the total (sensible plus latent) cooling
energy delivered to the zone. If there is no outdoor air, then Zone Ideal Loads Supply Air
Total Cooling Energy = Zone Ideal Loads Zone Total Cooling Energy.
Zone Ideal Loads Outdoor Air Total Cooling Energy is the total (sensible plus latent) cooling
energy required to cool the outdoor air to the zone exhaust air temperature and humidity
ratio.
Zone Ideal Loads Heat Recovery Total Cooling Energy is the total (sensible plus latent)
cooling energy supplied by heat recovery. This offsets a portion of the Zone Ideal Loads
Outdoor Air Total Cooling Energy.
When the economizer is not active, these values are related by the following equation:

9/29/14

929

Input-Output Reference

Group Zone Forced Air Units

Zone Ideal Loads Supply Air Total Cooling Energy + Zone Ideal Loads Heat Recovery
Total Cooling Energy =
Zone Ideal Loads Zone Total Cooling Energy+ Zone Ideal Loads Outdoor Air Total
Cooling Energy
Zone Ideal Loads Supply Air Sensible Heating Energy [J]
Zone Ideal Loads Supply Air Sensible Heating Rate [W]
The sensible heating energy (or rate) added to raise the temperature of the mixed air stream
to the temperature of the supply air stream. This is the ideal heating coil load.
Zone Ideal Loads Supply Air Latent Heating Energy [J]
Zone Ideal Loads Supply Air Latent Heating Rate [W]
The latent heating energy (or rate) added to raise the humidity ratio of the mixed air stream to
the temperature of the supply air stream. This is the ideal humidifier load.
Zone Ideal Loads Supply Air Total Heating Energy [J]
Zone Ideal Loads Supply Air Total Heating Rate [W]
The total (sensible and latent) heating energy (or rate) added to raise the mixed air stream to
the temperature and humidity ratio of the supply air stream. Zone Ideal Loads Supply Air
Total Heating Energy is metered as DistrictHeating energy.
Zone Ideal Loads Supply Air Sensible Cooling Energy [J]
Zone Ideal Loads Supply Air Sensible Cooling Rate [W]
The sensible cooling energy (or rate) removed to lower the temperature of the mixed air
stream to the temperature of the supply air stream. This is the ideal cooling coil sensible
load.
Zone Ideal Loads Supply Air Latent Cooling Energy [J]
Zone Ideal Loads Supply Air Latent Cooling Rate [W]
The latent cooling energy (or rate) removed to lower the humidity ratio of the mixed air stream
to the temperature of the supply air stream. This is the ideal cooling coil latent load.
Zone Ideal Loads Supply Air Total Cooling Energy [J]
Zone Ideal Loads Supply Air Total Cooling Rate [W]
The total (sensible and latent) cooling energy (or rate) removed to lower the mixed air stream
to the temperature and humidity ratio of the supply air stream. Zone Ideal Loads Supply Air
Total Cooling Energy is metered as DistrictCooling energy. This is the ideal cooling coil total
load.
Zone Ideal Loads Zone Sensible Heating Energy [J]
Zone Ideal Loads Zone Sensible Heating Rate [W]
The sensible heating energy (or rate) added to the zone.
Zone Ideal Loads Zone Latent Heating Energy [J]
Zone Ideal Loads Zone Latent Heating Rate [W]
The latent heating energy (or rate) added to the zone.
Zone Ideal Loads Zone Total Heating Energy [J]
Zone Ideal Loads Zone Total Heating Rate [W]
The total (sensible and latent) heating energy (or rate) added to the zone.
9/29/14

930

Input-Output Reference

Group Zone Forced Air Units

Zone Ideal Loads Zone Sensible Cooling Energy [J]

Zone Ideal Loads Zone Sensible Cooling Rate [W]
The sensible cooling energy (or rate) removed from the zone.
Zone Ideal Loads Zone Latent Cooling Energy [J]
Zone Ideal Loads Zone Latent Cooling Rate [W]
The latent cooling energy (or rate) removed from the zone.
Zone Ideal Loads Zone Total Cooling Energy [J]
Zone Ideal Loads Zone Total Cooling Rate [W]
The total (sensible and latent) cooling energy (or rate) removed from the zone.
Zone Ideal Loads Outdoor Air Sensible Heating Energy [J]
Zone Ideal Loads Outdoor Air Sensible Heating Rate [W]
The sensible heating energy (or rate) required to raise the temperature of the outdoor air to
the zone exhaust air temperature. This value will be calculated only when heating is active.
Zone Ideal Loads Outdoor Air Latent Heating Energy [J]
Zone Ideal Loads Outdoor Air Latent Heating Rate [W]
The latent heating energy (or rate) required to raise the humidity ratio of the outdoor air to the
zone exhaust air humidity ratio. This value will be calculated only when humidification is
active.
Zone Ideal Loads Outdoor Air Total Heating Energy [J]
Zone Ideal Loads Outdoor Air Total Heating Rate [W]
The total (sensible and latent) heating energy (or rate) required to raise the temperature and
humidity ratio of the outdoor air to the zone exhaust air humidity ratio. This value will be
calculated only when heating or humidification is active.
Zone Ideal Loads Outdoor Air Sensible Cooling Energy [J]
Zone Ideal Loads Outdoor Air Sensible Cooling Rate [W]
The sensible cooling energy (or rate) required to lower (or raise) the temperature of the
outdoor air to the zone exhaust air temperature. This value will be calculated only when
cooling is active.
Zone Ideal Loads Outdoor Air Latent Cooling Energy [J]
Zone Ideal Loads Outdoor Air Latent Cooling Rate [W]
The latent cooling energy (or rate) required to lower (or raise) the humidity ratio of the
outdoor air to the zone exhaust air humidity ratio. This will be calculated only when
dehumidification is active.
Zone Ideal Loads Outdoor Air Total Cooling Energy [J]
Zone Ideal Loads Outdoor Air Total Cooling Rate [W]
The total (sensible and latent) cooling energy (or rate) required to lower the temperature and
humidity ratio of the outdoor air to the zone exhaust air temperature and humidity ratio. This
value will be calculated only when cooling or dehumidification is active.

9/29/14

931

Input-Output Reference

Group Zone Forced Air Units

Zone Ideal Loads Heat Recovery Sensible Heating Energy [J]

Zone Ideal Loads Heat Recovery Sensible Heating Rate [W]
The sensible heating energy (or rate) added to the outdoor air stream from heat recovery.
Zone Ideal Loads Heat Recovery Latent Heating Energy [J]
Zone Ideal Loads Heat Recovery Latent Heating Rate [W]
The latent heating energy (or rate) added to the outdoor air stream from heat recovery.
Zone Ideal Loads Heat Recovery Total Heating Energy [J]
Zone Ideal Loads Heat Recovery Total Heating Rate [W]
The total (sensible and latent) heating energy (or rate) added to the outdoor air stream from
heat recovery.
Zone Ideal Loads Heat Recovery Sensible Cooling Energy [J]
Zone Ideal Loads Heat Recovery Sensible Cooling Rate [W]
The sensible cooling energy (or rate) removed from the outdoor air stream from heat
recovery.
Zone Ideal Loads Heat Recovery Latent Cooling Energy [J]
Zone Ideal Loads Heat Recovery Latent Cooling Rate [W]
The latent cooling energy (or rate) removed from the outdoor air stream from heat recovery.
Zone Ideal Loads Heat Recovery Total Cooling Energy [J]
Zone Ideal Loads Heat Recovery Total Cooling Rate [W]
The total (sensible and latent) cooling energy (or rate) removed from the outdoor air stream
from heat recovery.
Zone Ideal Loads Economizer Active Time [hr]
Hours when the Ideal Loads economizer increased the outdoor air flow rate above the
minimum.
Zone Ideal Loads Heat Recovery Active Time [hr]
Hours when the Ideal Loads heat recovery was actively heating or cooling the outdoor air
stream.
Zone Ideal Loads Hybrid Ventilation Available Status []
This is the availability status of the ideal loads object as set by the hybrid ventilation
manager. Rules to determine the availability status are described in the section Group
System Availability Managers. The control status outputs are represented using integers 0
and 1. These integers represent NoAction (0) and ForceOff (1). When the availability status is
ForceOff, the unit is turned off regardless of its availability schedule. The other status flag i.e.
NoAction does not control the unit and the controls of the unit turn it back on. Since the status
output is averaged, the output result may not correspond to the values described here when
output variable frequencies other than detailed are used. Use the detailed reporting
frequency (Ref. Output:Variable object) to view the availability status at each simulation
timestep.
ZoneHVAC:FourPipeFanCoil
What is a fan coil unit? Like many HVAC terms, fan coil unit is used rather loosely.
Sometimes it is used for terminal units that would be better described as powered induction
units. Carrier and others use the term for the room side of refrigerant-based split systems.
9/29/14

932

Input-Output Reference

Group Zone Forced Air Units

Here we are modeling in-room forced-convection hydronic units. Typically these units are
small (200 1200 cfm) and self-contained. They are mostly used in exterior zones, usually in
hotels, apartments, or offices. They may be connected to ducted outside air, or have a direct
outside air vent, but they do not have outside air economizers. Units with outside air
economizers are marketed (in the United States) as unit ventilators. Unit ventilators are
typically bigger than fan coils and are widely used in classrooms or other applications where
ventilation is a priority. If a zonal unit with an outside economizer is desired,
ZoneHVAC:UnitVentilator should be used.
The heating or cooling output of the unit ventilator is controlled by varying the air flow rate,
the water flow rate, or both. Air flow rate can be controlled by cycling the fan on/off or with a
variable speed fan drive. The most common setup is a two or three speed fan with the speed
selected by hand. The fan then cycles on/off to control heating / cooling output. The controls
are often a wall mounted thermostat with hand selection of heating/cooling and fan speed
(off/low/medium/high). These controls may also be mounted on the unit
Carrier offers a retrofit VSD motor for fan coil units. It claims up to 45% energy savings from
such a retrofit, as well as increased comfort and less noise compared to a cycling fan (fan coil
fans ar typically noisy and inefficient). Some other manufacturers are also offering units with
VSD fans. Variable speed fans appear to offer an easy way to significantly increase the
efficiency of what have typically been very inefficient units.
EnergyPlus provides 4 capacity control methods for this unit: 1) multi-speed cycling fan with
constant water flow rate; 2) constant speed continuous fan with variable water flow rate; 3)
variable-speed fan with constant water flow rate; 4) variable-speed fan with variable water
flow rate.
In EnergyPlus the fan coil units are modeled as compound components. That is, they are
assembled from other components. Fan coils contain an outdoor air mixer, a fan, a heating
coil and a cooling coil. These components are described elsewhere in this document. The fan
coil input simply requires the names of these four components, which have to be described
elsewhere in the input. The input also requires the name of an availability schedule,
maximum airflow rate, outdoor airflow rate, and maximum and minimum hot and cold water
volumetric flow rates. The unit is connected to the zone inlet and exhaust nodes and the
outdoor air by specifying unit inlet, and outlet air node names and the outdoor air mixer object
name. The outdoor air mixer child object provides the outdoor air and relief air nodes names.
Note that the unit air inlet node should be the same as a zone exhaust node and the unit
outlet node should be the same as a zone inlet node. The fan coil unit is connected to a hot
water loop (demand side) through its hot water coil and to a chilled water loop (demand side)
through its cooling coil.
Note that the type of fan component associated with the fan coil unit depends on the type of
capacity control method chosen. For ConstantFanVariableFlow
a Fan:OnOff or
Fan:ConstantVolume should be used. For CyclingFan, a Fan:OnOff should be used. And for
VariableFanVariableFlow or VariableFanConstantFlow a Fan:VariableVolume should be
chosen.
Fan coil units can be 4-pipe or 2-pipe. For 4-pipe units there are 2 supply pipes and 2 return
pipes. For 2-pipe units there is a single supply pipe and a single return pipe and the supply is
switched between hot and chilled water depending on the season. We model 4-pipe units, but
the 4-pipe model can be used to model 2-pipe units by using the coil availability schedules to
make sure that either hot or chilled water is exclusively available.
Field: Name
A unique user assigned name for an instance of a Fan Coil unit. Any reference to this Fan
Coil unit by another object will use this name.
Field: Availability Schedule Name
The name of the schedule (ref: Schedule) that denotes whether the fan coil unit can run
during a given time period. A schedule value greater than 0 (usually 1 is used) indicates that
9/29/14

933

Input-Output Reference

Group Zone Forced Air Units

the component can be on during the time period. A value less than or equal to 0 (usually 0 is
used) denotes that the component must be off for the time period. If this field is blank, the
schedule has values of 1 for all time periods.
Field: Capacity Control Method
This input denotes how the units output is controlled in order to meet zone heating or cooling
requirement.
The
choices
are
ConstantFanVariableFlow,
CyclingFan,
VariableFanVariableFlow or VariableFanConstantFlow. For ConstantFanVariableFlow, the
fan speed is held constant to produce a fixed air flow rate whenever the unit is scheduled on.
The hot water or chilled flow rate is varied so that the unit output matches the zone heating or
cooling requirement. For CyclingFan, the fan speed is chosen so that the unit capacity is
greater than or equal to the heating / cooling load and the fan is cycled to match unit output
with the load. For VariableFanVariableFlow both air and water flow rates are varied to match
the load. For VariableFanConstantFlow, the water flow rate is at full flow and the fan speed
varies to meet the load.
Field: Maximum Supply Air Flow Rate
The maximum volumetric airflow rate (m 3/sec) through the fan coil unit. This is also the
design, rated airflow rate of the unit.
Field: Low Speed Supply Air Flow Ratio
This numerical field specifies the ratio of the low speed flow rate to the maximum supply air
flow rate. Its value should be less than Medium Speed Supply Air Flow Ratio. If left blank, the
default value is 0.33. Leave it blank if the capacity control method selected is not CyclingFan.
Field: Medium Speed Supply Air Flow Ratio
This numerical field specifies the ratio of the medium speed flow rate to the maximum supply
air flow rate. Its value should be greater than the Low Speed Supply Air Flow Ratio but less
than 1.If left blank, the default value is 0.66.Leave it blank if the capacity control method
selected is not CyclingFan.
Field: Maximum Outdoor Air Flow Rate
If the fan coil unit uses outdoor air, this field specifies the outdoor air volumetric flow rate
(m3/sec). This flow rate should be less than or equal to the maximum airflow rate. A value of
zero specifies no outdoor air.
Field: Outdoor Air Schedule Name
The name of a schedule whose values (0.0 to 1.0) are used as multipliers to alter the outdoor air
flow rate. If this field is left blank, the values will default to 1.0.
Field: Air Inlet Node Name
The name of the HVAC system node from which the fan coil unit draws its indoor air. This
should be one of zone exhaust nodes for the zone which the fan coil unit is serving.
Field: Air Outlet Node Name
The name of the HVAC system node to which the fan coil unit sends its outlet air. This should
be one of the inlet air nodes of the zone which is being served.
Field: Outdoor Air Mixer Object Type
This field specifies the type of outdoor air mixer used by this fan coil unit. The outdoor air
mixer component is part of the fan coil compound object. The only available outdoor air mixer
type is:
OutdoorAir:Mixer

9/29/14

934

Input-Output Reference

Group Zone Forced Air Units

Field: Outdoor Air Mixer Name

The name of an outdoor air mixer component (object: OutdoorAir:Mixer) which composes
part of the fan coil unit. Note that the return air node of the outdoor air mixer should be the
same node as the air inlet node of the fan coil unit. In addition, the outdoor air mixers mixed
air node should be the same as the inlet air node of the fan coil units fan.
Field: Supply Air Fan Object Type
This field specifies the type of supply air fan object used by this fan coil. The supply air fan is
part of the fan coil compound object. The only valid supply air fan types are:
Fan:OnOff
Fan:ConstantVolume
Fan:VariableVolume

Field: Supply Air Fan Name

The name of a fan component that composes part of the fan coil unit. Note that the fans
maximum flow rate should be the same as the maximum airflow rate of the fan coil unit and
the type of fan object should correspond to the capacity control method. Namely, for
ConstantFanVariableFlow a Fan:OnOff or Fan:ConstantVolume should be used. For
CyclingFan, a Fan:OnOff should be used. And for VariableFanVariableFlow or
VariableFanConstantFlow a Fan:VariableVolume should be chosen. The fans inlet node
should be the same as the outdoor air mixers mixed air node.
The fans outlet node should be the same as the cooling coils air inlet node.
Field: Cooling Coil Object Type
This field specifies the type of chilled water cooling coil to be modeled for this fan coil unit.
Only the following coil types can be used:
Coil:Cooling:Water
Coil:Cooling:Water:DetailedGeometry
CoilSystem:Cooling:Water:HeatExchangerAssisted

The input requirements for these chilled water coil objects are described elsewhere in this
document.
Field: Cooling Coil Name
The name of the cooling coil component that composes part of the fan coil unit. The cooling
coil air inlet node should be the same as the fan outlet node. The cooling coil air outlet node
should be the same as the heating coil air inlet node.
Only the following coil types can be used:
Coil:Cooling:Water
Coil:Cooling:Water:DetailedGeometry
CoilSystem:Cooling:Water:HeatExchangerAssisted

Field: Maximum Cold Water Flow Rate

The maximum cold water volumetric flow rate (m 3/sec) through the fan coil units cooling coil.
Field: Minimum Cold Water Flow Rate
The minimum cold water volumetric flow rate (m3/sec) through the fan coil units cooling coil.
Field: Cooling Convergence Tolerance
The convergence tolerance for the control of the unit cooling output. The unit is controlled by
matching the unit output to the zone demand. For units with water coils, the model must be
numerically inverted to obtain a specified output. The cooling convergence tolerance is the
error tolerance used to terminate the numerical inversion procedure. Basically this is the
fraction:
9/29/14

935

Input-Output Reference

Group Zone Forced Air Units

Q fancoil ,out

Qzoneload

Qzoneload

CoolingConvergenceTolerance

Field: Heating Coil Object Type

This field is the type of coil that is used for heating in the fan coil system. It is used in
conjunction with the heating coil name (see next field) to specify the heating coil present
within the system. The only allowable heating coil type is:
Coil:Heating:Water

Field: Heating Coil Name

The name of the heating coil component that composes part of the fan coil unit. The heating
coil air inlet node should be the same as the cooling coil outlet node. The heating coil air
outlet node should be the same as the fan coil air outlet node.
Only the following coil type can be used:
Coil:Heating:Water

Field: Maximum Hot Water Flow Rate

The maximum hot water volumetric flow rate (m 3/sec) through the fan coil units heating coil.
Field: Minimum Hot Water Flow Rate
The minimum hot water volumetric flow rate (m 3/sec) through the fan coil units heating coil.
Field: Heating Convergence Tolerance
The convergence tolerance for the control of the unit heating output. The unit is controlled by
matching the unit output to the zone demand. For units with water coils, the model must be
numerically inverted to obtain a specified output. The heating convergence tolerance is the
error tolerance used to terminate the numerical inversion procedure. Basically this is the
fraction:

Q fancoil ,out

Qzoneload

Qzoneload

HeatingConvergenceTolerance

Field: Availability Manager List Name

This optional input field is the name of an AvailabilityManagerAssignmentList object. An Availability
Manager Assignment List is a list of Availability Managers giving both Availability Manager type and
name. The availability managers in the list apply to this objects fan. If the fan coil is available (per the
Availability Schedule Name input field above) and this input field has a valid availability manager
assignment list name, then the availability managers in the list determine when and if the fan of this object
should be on or off.
Field: Design Specification ZoneHVAC Sizing Object Name
This optional input field is the name of a DesignSpecificationZoneHVACSizing object. The
name must correspond to unique name of a DesignSpecification:ZoneHVAC:Sizing object. A
Design Sepcification Zone HVAC Sizing object defines scalable sizing methods for sizing
input fields such as Maximum Air Flow Rate in this Four Pipe FanCoil zone HVAC object. The
scaled Maximum Air Flow Rate in turn is used to size cooling and heating capacity of the unit.

An example input for a fan coil unit, including its constituent components, is shown below.

9/29/14

936

Input-Output Reference
ZoneHVAC:FourPipeFanCoil,
Zone1FanCoil,
!FanAndCoilAvailSched,
!ConstantFanVariableFlow, !autosize,
!,
!,
!autosize,
!OUTAIRFANCOILSCHEDULE,
!Zone1FanCoilAirInletNode,!Zone1FanCoilAirOutletNode,
OutdoorAir:Mixer,
!Zone1FanCoilOAMixer,
!Fan:ConstantVolume,
!Zone1FanCoilFan,
!Coil:Cooling:Water,
!Zone1FanCoilCoolingCoil, !autosize,
!0.0,
!0.001,
!Coil:Heating:Water,
!Zone1FanCoilHeatingCoil, !autosize,
!0.0,
!0.001;
!-

Group Zone Forced Air Units

Name
Availability Schedule Name
Capacity Control Method
Maximum Supply Air Flow Rate {m3/s}
Low Speed Supply Air Flow Ratio
Medium Speed Supply Air Flow Ratio
Maximum Outdoor Air Flow Rate {m3/s}
Outdoor Air Schedule Name
Air Inlet Node Name
!- Air Outlet Node Name
Outdoor Air Mixer Object Type
Outdoor Air Mixer Name
Supply Air Fan Object Type
Supply Air Fan Name
Cooling Coil Object Type
Cooling Coil Name
Maximum Cold Water Flow Rate {m3/s}
Minimum Cold Water Flow Rate {m3/s}
Cooling Convergence Tolerance
Heating Coil Object Type
Heating Coil Name
Maximum Hot Water Flow Rate {m3/s}
Minimum Hot Water Flow Rate {m3/s}
Heating Convergence Tolerance

OutdoorAir:Mixer,
Zone1FanCoilOAMixer, ! name
Zone1FanCoilOAMixerOutletNode, ! Mixed Air Node Name
Zone1FanCoilOAInNode, ! Outdoor Air Stream Node Name
Zone1FanCoilExhNode, ! Relief Air Stream Node Name
Zone1FanCoilAirInletNode; ! Return Air Stream Node Name

Fan:OnOff,
Zone1FanCoilFan,
!- Name
FanAndCoilAvailSched,
!- Availability Schedule Name
0.5,
!- Fan Total Efficiency
75.0,
!- Pressure Rise {Pa}
autosize,
!- Maximum Flow Rate {m3/s}
0.9,
!- Motor Efficiency
1.0,
!- Motor In Airstream Fraction
Zone1FanCoilOAMixerOutletNode, !- Air Inlet Node Name
Zone1FanCoilFanOutletNode, !- Air Outlet Node Name
FanPowerRatioCurve,
!- Fan Power Ratio Function of Speed Ratio Curve Name
FanEffRatioCurve;
!- Fan Efficiency Ratio Function of Speed Ratio Curve Name

9/29/14

937

Input-Output Reference

Group Zone Forced Air Units

Coil:Cooling:Water,
Zone1FanCoilCoolingCoil, !FanAndCoilAvailSched,
!autosize,
!autosize,
!autosize,
!autosize,
!autosize,
!autosize,
!autosize,
!Zone1FanCoilChWInletNode,!Zone1FanCoilChWOutletNode,
Zone1FanCoilFanOutletNode,
Zone1FanCoilCCOutletNode,!SimpleAnalysis,
!CrossFlow;
!-

Name
Availability Schedule Name
Design Water Flow Rate {m3/s}
Design Air Flow Rate {m3/s}
Design Inlet Water Temperature {C}
Design Inlet Air Temperature {C}
Design Outlet Air Temperature {C}
Design Inlet Air Humidity Ratio {kgWater/kgDryAir}
Design Outlet Air Humidity Ratio {kgWater/kgDryAir}
Water Inlet Node Name
!- Water Outlet Node Name
!- Air Inlet Node Name
Air Outlet Node Name
Type of Analysis
Heat Exchanger Configuration

Coil:Heating:Water,
Zone1FanCoilHeatingCoil, !- Name
FanAndCoilAvailSched,
!- Availability Schedule Name
autosize,
!- U-Factor Times Area Value {W/K}
autosize,
!- Maximum Water Flow Rate {m3/s}
Zone1FanCoilHWInletNode, !- Water Inlet Node Name
Zone1FanCoilHWOutletNode,!- Water Outlet Node Name
Zone1FanCoilCCOutletNode,!- Air Inlet Node Name
Zone1FanCoilAirOutletNode, !- Air Outlet Node Name
UFactorTimesAreaAndDesignWaterFlowRate, !- Performance Input Method
autosize,
!- Nominal Capacity {W}
82.2,
!- Design Inlet Water Temperature {C}
16.6,
!- Design Inlet Air Temperature {C}
71.1,
!- Design Outlet Water Temperature {C}
32.2;
!- Design Outlet Air Temperature {C}
Curve:Exponent,
FanPowerRatioCurve,
0.0,
1.0,
3.0,
0.0,
1.5,
0.01,
1.5;

Curve:Cubic,
FanEffRatioCurve,
0.33856828,
1.72644131,
-1.49280132,
0.42776208,
0.5,
1.5,
0.3,
1.0;

!!!!!!!!-

!!!!!!!!!-

Name
Coefficient1 Constant
Coefficient2 Constant
Coefficient3 Constant
Minimum Value of x
Maximum Value of x
Minimum Curve Output
Maximum Curve Output

Name
Coefficient1 Constant
Coefficient2 x
Coefficient3 x**2
Coefficient4 x**3
Minimum Value of x
Maximum Value of x
Minimum Curve Output
Maximum Curve Output

Fan Coil Outputs

HVAC,Average,Fan Coil Heating Rate [W]
HVAC,Sum,Fan Coil Heating Energy [J]
HVAC,Average,Fan Coil Total Cooling Rate [W]
HVAC,Sum,Fan Coil Total Cooling Energy [J]
HVAC,Average,Fan Coil Sensible Cooling Rate [W]
HVAC,Sum,Fan Coil Sensible Cooling Energy [J]
HVAC,Average,Fan Coil Fan Electric Power[W]
HVAC,Sum,Fan Coil Fan Electric Energy [J]
HVAC,Average,Fan Coil Runtime Fraction []
HVAC,Average, Fan Coil Fan Speed Level []
9/29/14

938

Input-Output Reference

Group Zone Forced Air Units

HVAC,Average,Fan Coil Part Load Ratio []

HVAC,Average,Fan Coil Availability Status []

Fan Coil Heating Rate [W]

This field reports the dry air heating addition rate of the fan coil unit to the zone it is serving in
Watts. This is determined by outlet and zone air conditions and the mass flow rate through
the unit.
Fan Coil Heating Energy [J]
This field is the dry air heat addition of the fan coil unit to the zone it is serving in Joules over
the timestep being reported. This is determined by outlet and zone air conditions, the mass
flow rate through the unit, and the timestep.
Fan Coil Total Cooling Rate [W]
This field is the total (sensible and latent) heat extraction rate of the fan coil unit from the
zone it is serving in Watts. This is determined by the outlet and zone conditions and the mass
flow rate through the unit.
Fan Coil Total Cooling Energy [J]
This field is the total (sensible and latent) heat extraction of the fan coil unit from the zone it
is serving in Joules over the timestep being reported. This is determined by outlet and zone
air conditions, the mass flow rate through the unit, and the timestep.
Fan Coil Sensible Cooling Rate [W]
This field reports the dry air sensible heat extraction rate of the fan coil unit from the zone it is
serving in Watts. This is determined by the outlet and zone conditions and the mass flow rate
through the unit.
Fan Coil Sensible Cooling Energy [J]
This field is the dry air sensible heat extraction of the fan coil unit from the zone it is serving in
Joules over the timestep being reported. This is determined by the outlet and zone
conditions, the mass flow rate through the unit, and the timestep.
Fan Coil Fan Electric Power [W]
This field reports the electricity consumption rate of the fan coil unit in Watts.
Fan Coil Fan Electric Energy [J]
This field is the electricity consumption of the fan coil unit in Joules over the timestep being
reported.
Fan Coil Runtime Fraction[]
This field is the fraction of the system timestep the fan coil unit is running for the CyclingFan
capacity control method. This variable is defined only for the CyclingFan capacity control
method.
Fan Coil Fan Speed Level []
This field is indicates the speed chosen for the fan in the CyclingFan capacity control method.
A value of '0' means that the unit is off, '1' the fan is running at its low speed, '2' medium
speed, and '3' high speed (maximum). This variable is defined only for the CyclingFan
capacity control method.
Fan Coil Part Load Ratio []
When the capacity control method is VariableFanVariableFlow or VariableFanConstantFlow,
this output variable reports the unit part load ratio (ratio of unit heating / cooling output to the

9/29/14

939

Input-Output Reference

Group Zone Forced Air Units

maximum heating / cooling output). This variable is defined only for VariableFanVariableFlow
or VariableFanConstantFlow capacity control methods.
Fan Coil Availability Status []
This is the availability status of the fan coil unit fan. This status flag is a result of the
calculations
made
by
the
Availability
Manager(s)
listed
in
an
AvailabilityManagerAssignmentList object and/or calculations made by Hybrid Ventilation
Manager object. The AvailabilityManagerAssignmentList is an optional input in the fan coil
unit object. When a single availability manager is used in an Availability Manager
Assignment List, this is also the availability status reported by the specific availability
manager (Ref. AvailabilityManager:* Outputs). For multiple availability managers in an
Availability Manager Assignment List (with or without Hybrid Ventilation Manager), rules to
determine fan availability status are described in the section Group System Availability
Managers. The control status outputs are represented using integers 0 through 3. These
integers represent NoAction (0), ForceOff (1), CycleOn (2), and CycleOnZoneFansOnly (3).
Since the status output is averaged, the output result may not correspond to the values
described here when output variable frequencies other than detailed are used. Use the
detailed reporting frequency (Ref. Output:Variable object) to view the availability status at
each simulation timestep.
ZoneHVAC:UnitVentilator
Unit ventilators are zone equipment units which are assembled from other components. They
contain a built-in outdoor air mixer, a fan, a heating coil, and a cooling coil. These
components are described elsewhere in this document, except the built-in outdoor air mixer
which is contained within the unit ventilator statement. The unit ventilator input simply
requires the names of these other three components, which have to be described elsewhere
in the input. The input also requires the name of an availability schedule, maximum airflow
rate, outdoor air control information (control type and schedules), an outdoor airflow rate, and
maximum and minimum hot and cold water mass flow rates. The unit is connected to the
zone inlet and exhaust nodes and the outdoor air by specifying unit inlet, outlet, outdoor air
and exhaust (relief) air node names. Note that the unit air inlet node should be the same as a
zone exhaust node and the unit outlet node should be the same as a zone inlet node. In
general, the unit ventilator input is very similar to the fan coil unit input, and the unit is
connected to a hot water loop (demand side) through its hot water coil and to a chilled water
loop (demand side) through its cooling coil.
The main difference between the fan coil and unit ventilator input is that the unit ventilator has
a built-in outdoor air mixer with its own specialized controls. The outdoor air control type can
be selected from one of the following options: variable percent, fixed temperature or fixed
amount. In fixed temperature control, the amount of outdoor air is varied between the
minimum outdoor air fraction (specified by a schedule) and 100% outdoor air to obtain a
mixed air temperature as close as possible to the temperature schedule defined in the input.
Variable percent control will also vary the amount of outdoor air between the minimum and
maximum fractions (both specified in input by the user) to meet the load without the use of a
coil if possible. In fixed amount control, the outdoor air flow rate is fixed to the specified value
by the user. In this control strategy, the maximum outdoor air flow rate and schedule are
automatically set to be equal to the minimum outdoor air flow rate and schedule. These
control types are based on the 2004 ASHRAE Systems and Equipment Handbook (pp. 31.131.3) description of unit ventilator systems.
The unit is controlled to meet the zone (remaining) heating or cooling demand. If there is a
heating demand, the cooling coil is off and the hot water flow through the heating coil is
throttled to meet the demand. The hot water control node must be specified (same as the hot
water coil inlet node). If there is a cooling demand from the zone, the hot water coil is off and
the chilled water flow through the cooling coil is throttled to meet the load. The cooling coil
control node must be specified (same as the cooling coil inlet node). Finally both heating and
cooling require a convergence tolerance, which is the tolerance denoting how closely the fan
9/29/14

940

Input-Output Reference

Group Zone Forced Air Units

coil unit will meet the heating or cooling load. The tolerance is always relative to the zone
load.
Overall, control of the unit must consider the outdoor air. Here is a more detailed description
of the overall unit control:
Off: Unit is schedule off or there is no load on it. All flow rates are set to zero and the
temperatures are set to zone conditions (except for the outdoor air inlet). Outdoor air
requirements will not override this condition.
Heating/No Coil/VariablePercent: The unit is on, there is a heating load, no heating coil is
present or it has been scheduled off, and variable percent outdoor air control type has been
specified. In this case, the variable percent outdoor air controls what happens with the
outdoor air. If the outside temperature is greater than the return temperature, then the
outdoor air is set to the maximum as defined by the user input. If the outdoor air temperature
is less than the return temperature from the zone, then the outdoor air is set to the minimum
outdoor air flow rate as defined by the user. Since a coil is not present to further condition the
supply air, the zone simply receives whatever temperature air results from the outdoor air
controls.
Heating/No Coil/FixedTemperature: The unit is on, there is a heating load, no heating coil
is present or it has been scheduled off, and fixed temperature has been specified. The unit
ventilator tries to use outdoor air as best as possible to meet the temperature goal. If it cannot
meet this goal because the temperature goal is not between the zone return temperature and
the outdoor air temperature, then the unit ventilator will either use the maximum or minimum
outdoor air flow rate.
Heating/No Coil/FixedAmount: The unit is on, there is a heating load, no heating coil is
present or it has been scheduled off, and fixed amount control has been specified. The unit
ventilator fixes the outdoor air flow rate as defined by the user and sets the maximum and
minimum outdoor air flow rate to be equal in order to avoid the variation of outdoor air flow
rate between the maximum and minimum values. Since a coil is not present to further
condition the supply air, the zone simply receives whatever temperature air results from the
outdoor air controls.
Heating /With Coil/VariablePercent: The unit is on, there is a heating load, and variable
percent control is specified. The outdoor air fraction is set to the minimum outdoor air fraction
(schedule based), and the heating coil is activated. The heating coil attempts to meet the
remaining load on the zone being served by the unit ventilator.
Heating /With Coil/FixedAmount: The unit is on, there is a heating load, a heating coil is
present and is scheduled on, and fixed amount control has been specified. The unit ventilator
fixes the outdoor air flow rate as defined by the user and sets the maximum and minimum
outdoor air flow rate to be equal in order to avoid the variation of outdoor air flow rate
between the maximum and minimum values. The heating coil then attempts to meet any
remaining zone heating load.
Cooling/No Coil/VariablePercent: The unit is on, there is a cooling load, no coil is present
or it has been scheduled off, and variable percent outdoor air control type has been specified.
In this case, the variable percent outdoor air controls what happens with the outdoor air. If the
outside temperature is greater than the return temperature, then the outdoor air is set to the
minimum as defined by the user input. If the outdoor air temperature is less than the return
temperature from the zone, then the outdoor air is set to the maximum outdoor air flow rate
as defined by the user. This may be somewhat simplistic in that it could result in overcooling
of the space. However, since a temperature goal was not established, this is the best that can
be done by the simulation. Since a coil is not present to further condition the supply air, the
zone simply receives whatever temperature air results from the outdoor air controls.
Cooling/No Coil/FixedTemperature: The unit is on, there is a cooling load, no cooling coil is
present or it has been scheduled off, and fixed temperature has been specified. The unit
ventilator tries to use outdoor air as best as possible to meet the temperature goal. If it cannot
meet this goal because the temperature goal is not between the zone return temperature and

9/29/14

941

Input-Output Reference

Group Zone Forced Air Units

the outdoor air temperature, then the unit ventilator will either use the maximum or minimum
outdoor air flow rate in the same fashion as the variable percent outdoor air control.
Cooling/No Coil/FixedAmount: The unit is on, there is a cooling load, no cooling coil is
present or it has been scheduled off, and fixed amount control has been specified. The unit
ventilator fixes the outdoor air flow rate as defined by the user and sets the maximum and
minimum outdoor air flow rate to be equal in order to avoid the variation of outdoor air flow
rate between the maximum and minimum values. Since a coil is not present to further
condition the supply air, the zone simply receives whatever temperature air results from the
outside air controls.
Cooling/With Coil/VariablePercent: The unit is on, there is a cooling load, a coil is present
and is scheduled on, and variable percent outdoor air control type has been specified. In this
case, the percentage of outdoor air is set to the minimum flow outdoor air flow rate. The coil
then attempts to meet any remaining zone load.
Cooling/With Coil/FixedTemperature: The unit is on, there is a cooling load, a cooling coil
is present and is scheduled on, and fixed temperature has been specified. The unit ventilator
tries to use outdoor air as best as possible to meet the temperature goal. If it cannot meet this
goal because the temperature goal is not between the zone return temperature and the
outdoor air temperature, then the unit ventilator will either use the maximum or minimum
outdoor air flow rate in the same fashion as the fixed temperature outdoor air control for the
no coil conditions. The cooling coil then attempts to meet any remaining zone load.
Cooling/With Coil/FixedAmount: The unit is on, there is a cooling load, a cooling coil is
present and is scheduled on, and fixed amount control has been specified. The unit ventilator
fixes the outdoor air flow rate as defined by the user and sets the maximum and minimum
outdoor air flow rate to be equal in order to avoid the variation of outdoor air flow rate
between the maximum and minimum values. The cooling coil then attempts to meet any
remaining zone cooling load.
Note: the unit ventilator controls are strictly temperature based and do not factor humidity into
the equation (not an enthalpy economy cycle but rather a simple return air economy cycle). In
addition, temperature predictions are not strict energy balances here in the control routine
though in the mixing routine an energy balance is preserved.
Field: Name
This field is simply the identifying name that distinguishes one particular unit ventilator from
another in the input data file. Like all other names in EnergyPlus, it is assumed that this is a
unique character string and that no other unit ventilators use this same name.
Field: Availability Schedule Name
This field is a schedule name (ref: Schedule) that determines whether the unit ventilator is
available to operate. A schedule value greater than 0 (usually 1 is used) indicates that the
component can be on during the time period. A value less than or equal to 0 (usually 0 is
used) denotes that the component must be off for the time period. If this field is blank, the
schedule has values of 1 for all time periods.
Field: Maximum Supply Air Flow Rate
This field allows the user to enter the maximum volumetric flow rate of air through the unit
ventilator system in m3/sec. This parameter should be some real number greater than zero.
Field: Outdoor Air Control Type
This field allows the user to control how outdoor air is used in the unit ventilator system. The
unit ventilator system described by this syntax has its own outdoor air handler. The three
options for outdoor air control are VariablePercent, FixedTemperature and
FixedAmount. Those keys are the only allowed choices for this parameter. In general, the
variable percent control will attempt to vary the amount of outdoor air between some
minimum and maximum schedules of fractions (see next two fields) to best meet the current
9/29/14

942

Input-Output Reference

Group Zone Forced Air Units

heating or cooling load. The fixed temperature control will vary the amount of outdoor air
between the minimum schedule (fraction of maximum, see next field) and 100% available
outdoor air to come as close as possible to a desired mixed air temperature (see 2 fields
down) that can be scheduled. The fixed amount control will fix the outdoor air flow rate as
minimum outdoor air flow rate and schedule specified by the user and automatically set the
maximum and minimum outside flow rate to be equal by ignoring the maximum outdoor air
flow rate. More information on the controls and operation of the unit ventilator are given in the
introductory section above. For cycling fan operating mode, the outdoor air mass rate is
capped by the actual supply air flow rate if the former is greater than the latter; otherwise,
uses the amount calculated by the outdoor air control.
Field: Minimum Outdoor Air Flow Rate
This field allows the user to enter the minimum volumetric flow rate of outdoor air (in m3/sec)
that will be brought in to the unit ventilator. The actual minimum outdoor air flow rate will be
this number multiplied by the schedule value from the minimum outdoor air schedule. If
FixedAmount type is selected as the outdoor air control strategy, the outdoor air flow rate
will be fixed as this field and the unit ventilator will automatically set the maximum and
minimum outside flow rate to be equal by ignoring the maximum outdoor air flow rate.
Field: Minimum Outdoor Air Schedule Name
This field contains a schedule name (ref: Schedule) that should contain values for the
minimum outdoor air used by the unit ventilator system for IAQ or other reasons. Note that if
the unit ventilator is scheduled off or if there is no load sensed in the zone that the system will
not operate even to achieve the minimum air fraction. However, if the system is operating, it
will always bring in this fraction of the minimum air flow rate (see minimum air flow rate field
above). If FixedAmount type is selected as the outdoor air control strategy, the actual
outdoor air flow rate will be this number multiplied by the minimum outdoor air flow rate in the
field above. The unit ventilator will automatically set the maximum and minimum outdoor air
schedule to be equal by ignoring the maximum outdoor air schedule.
Field: Maximum Outdoor Air Flow Rate
This field allows the user to enter the maximum volumetric flow rate of outdoor air that can be
brought into the unit ventilator system in m 3/sec. This parameter should be some real number
greater than zero. Note that the value for this parameter may be less than the maximum air
flow rate of the unit ventilator and this may affect the maximum fraction of outdoor air within
the control strategy defined above. This parameter is an absolute maximum and will
supercede any scheduled fraction of the unit ventilator maximum airflow rate. If
FixedAmount type is selected as the outdoor air control strategy, this field will be ignored
and be automatically set to be equal to the minimum outdoor air flow rate specified in the field
above.
Field: Maximum Outdoor Air Fraction or Temperature Schedule Name
This field can have one of two meanings depending the type of control selected in the
outdoor air control type parameter above. If VariablePercent or FixedAmount was
selected, then this field is a schedule name (ref: Schedule) corresponding to a maximum air
fraction schedule. Furthermore, if FixedAmount type is selected as the outdoor air control
strategy, this field will be ignored and be automatically set to be equal to the minimum
outdoor air fraction specified in the field below. Note that this is a fraction of the maximum
airflow rate field (see parameter above) for the unit ventilator. If FixedTemperature control
was selected, then this field is still a schedule name (ref: Schedule), but it corresponds to a
schedule of mixed air temperatures that the outdoor air control will try to attain.
Field: Air Inlet Node Name
This field is a node name used to identify the node that serves as the inlet (air side) to the
unit ventilator. In EnergyPlus, nodes represent points between components or at various
9/29/14

943

Input-Output Reference

Group Zone Forced Air Units

points in the loops. In a unit ventilator, the air inlet node to the system will typically be the
same node as a zone outlet node. While a node name may be referenced more than once in
an input data file, each node must have a unique name.
Field: Air Outlet Node Name
This field is a node name used to identify the node that serves as the outlet (air side) to the
unit ventilator. In EnergyPlus, nodes represent points between components or at various
points in the loops. In a unit ventilator, the air outlet node from the system will typically be the
same node as a zone inlet node. While a node name may be referenced more than once in
an input data file, each node must have a unique name.
Field: Outdoor Air Node Name
This field is a node name used to identify the node associated with fresh air brought into the
unit ventilator from the outdoor environment. You should also have defined an
OutdoorAir:Node object with the same name and assign it an optional height (above ground).
Field: Exhaust Air Node Name
This field is a node name used to identify the node associated with air exhausted out of the
unit ventilator to the outdoor environment. While from a simulation standpoint this name is
arbitrary and not a necessity, assigning a name to this node allows the user to receive
output on conditions at this node to verify the correct operation of the unit ventilator.
Field: Mixed Air Node Name
This field is a node name used to identify the node associated with the mixed air of the unit
ventilator. These conditions are post-mixing box since they are the conditions of the fraction
of return air combined with the outdoor air. Since this is a simple system, this can also be
viewed as the conditions of the air being sent to the coils. While from a simulation standpoint
this name is arbitrary and not a necessity, assigning a name to this node allows the user to
receive output on conditions at this node to verify the correct operation of the unit ventilator.
Field: Supply Air Fan Object Type
This field specifies the type of supply air fan used by this unit ventilator. The supply air fan is
part of the unit ventilator compound object. The only valid supply air fan types are:
Fan:OnOff
Fan:ConstantVolume
Fan:VariableVolume

Field: Supply Air Fan Name

This field is the name of a fan (ref: Fan:OnOff, Fan:ConstantVolume, Fan: VariableVolume)
that is part of the unit ventilator system. This name links the unit ventilator to particular fan
data entered elsewhere in the input data file. A fan name is required since it is the prime
mover of air in the unit ventilator system.
Field: Coil Option
This field allows the user to specify the coil operating options as one of the following options:
None, Heating, Cooling or HeatingAndCooling. If None is selected, the unit ventilator does
not have any coils, and any other input will be ignored. If either Heating or Cooling is
selected, only a heating or cooling coil, respectively, is present. Thus, only four more inputs
will be expected. If HeatingAndCooling is selected, both heating and cooling coil input must
be entered, and the unit ventilator will have both a heating and a cooling coil.
Field: Heating Coil Object Type
This field is the type of coil that is used for heating in the unit ventilator system. It is used in
conjunction with the heating coil name (see next field) to specify the heating coil present
within the system. Allowable heating coil types are:
9/29/14

944

Input-Output Reference

Group Zone Forced Air Units

Coil:Heating:Water
Coil:Heating:Electric
Coil:Heating:Gas
Coil:Heating:Steam

Field: Heating Coil Name

This field is the name of the heating coil that is part of the unit ventilator system. It is
assumed that there is always some sort of heating coil associated with a unit ventilator
system. This name links the unit ventilator to particular heating coil data entered elsewhere in
the input data file.
Field: Heating Convergence Tolerance
The control tolerance for the unit heating output. This field allows the user some control over
how closely the heating coil will control the air side conditions. The relative size of this
parameter relates directly to the closeness of the control. A very small value in this field will
result in tight control and will probably result in larger numbers of iterations. A large value in
this field will result in looser controls and could result in unsatisfactory fluctuations in supply
conditions (that could in turn result in excessive iterations). Initial experience with this
parameter lends to the recommendation of using 0.001 as a starting point. This field is
ignored for gas and electric heating coils.
The unit is controlled by matching the unit output to the zone demand. For units with water
coils, the model must be numerically inverted to obtain a specified output. The heating
convergence tolerance is the error tolerance used to terminate the numerical inversion
procedure. Basically this is the fraction:

QUnitVentilator ,Out QZoneLoad

QZoneLoad

HeatingConvergenceTolerance

Field: Cooling Coil Object Type

This field is the type of coil that is used for cooling in the unit ventilator system. It is used in
conjunction with the cooling coil name (see next field) to specify the cooling coil present
within the system.
Only the following coil types can be used:
Coil:Cooling:Water
Coil:Cooling:Water:DetailedGeometry
CoilSystem:Cooling:Water:HeatExchangerAssisted

Field: Cooling Coil Name

This field is the name of the cooling coil that is part of the unit ventilator system. This name
links the unit ventilator to particular cooling coil data entered elsewhere in the input data file.
Note that a cooling coil is not a required part of a unit ventilator system. If no cooling coil is
present, the previous field may be followed by a semi-colon and the remaining parameters in
this statement may be ignored.
Field: Cooling Convergence Tolerance
The convergence tolerance for the unit cooling output. This field allows the user some control
over how closely the cooling coil will control the air side conditions. The relative size of this
parameter relates directly to the closeness of the control. A very small value in this field will
result in tight control and will probably result in larger numbers of iterations. A large value in
this field will result in looser controls and could result in unsatisfactory fluctuations in supply
conditions (that could in turn result in excessive iterations). Initial experience with this
parameter lends to the recommendation of using 0.001 as a starting point.

9/29/14

945

Input-Output Reference

Group Zone Forced Air Units

The unit is controlled by matching the unit output to the zone demand. For units with water
coils, the model must be numerically inverted to obtain a specified output. The cooling
convergence tolerance is the error tolerance used to terminate the numerical inversion
procedure. Basically this is the fraction:

QUnitVentilator ,Out QZoneLoad

QZoneLoad

CoolingConvergenceTolerance

Field: Availability Manager List Name

This optional input field is the name of an AvailabilityManagerAssignmentList object. An
Availability Manager Assignment List is a list of Availability Managers giving both Availability
Manager type and name. The availability managers in the list apply to this unit ventilator
objects fan. If the unit ventilator is available (per the Availability Schedule Name input field
above) and this input field has a valid availability manager assignment list name, then the
availability managers in the list determine when and if the fan of this unit ventilator object
should be on or off.
Field: Design Specification ZoneHVAC Sizing Object Name
This optional input field is the name of a DesignSpecificationZoneHVACSizing object. The
name must correspond to unique name of a DesignSpecification:ZoneHVAC:Sizing object. A
Design Sepcification Zone HVAC Sizing object defines scalable sizing methods for sizing
input fields such as Maximum Air Flow Rate in this Unit Ventilator zone HVAC object. The
scaled Maximum Air Flow Rate in turn is used to size cooling and heating capacity of the unit.
An example input for a unit ventilator, including its constituent components, is shown below.
ZoneHVAC:UnitVentilator,
Zone1UnitVent,
!- Name
UnitVentAvailability,
!- Availability Schedule Name
0.84,
!- Maximum Supply Air Flow Rate {m3/s}
VariablePercent,
!- Outdoor Air Control Type
0.168,
!- Minimum Outdoor Air Flow Rate {m3/s}
UnitVentMinOA,
!- Minimum Outdoor Air Schedule Name
0.84,
!- Maximum Outdoor Air Flow Rate {m3/s}
UnitVentMaxOA,
!- Maximum Outdoor Air Fraction or Temperature Schedule Name
Zone1UnitVentAirInletNode, !- Air Inlet Node Name
Zone1UnitVentAirOutletNode, !- Air Outlet Node Name
Zone1UnitVentOAInNode,
!- Outdoor Air Node Name
Zone1UnitVentExhNode,
!- Exhaust Air Node Name
Zone1UnitVentOAMixerOutletNode, !- Mixed Air Node Name
Fan: ConstantVolume,
!- Supply Air Fan Object Type
Zone1UnitVentFan,
!- Fan Name
HeatingAndCooling,
!- Coil Option
Coil:Heating:Water,
!- Heating Coil Object Type
Zone1UnitVentHeatingCoil,!- Heating Coil Name
0.001,
!- Heating Convergence Tolerance
Coil:Cooling:Water,
!- Cooling Coil Object Type
Zone1UnitVentCoolingCoil,!- Cooling Coil Name
0.001;
!- Cooling Convergence Tolerance

OutdoorAir:Node,
Zone1UnitVentOAInNode,
-1.0;

9/29/14

!- Name
!- Height Above Ground {m}

946

Input-Output Reference

Group Zone Forced Air Units

Fan:ConstantVolume,
Zone1UnitVentFan,
!- Name
UnitVentAvailability,
!- Availability Schedule Name
0.5,
!- Fan Total Efficiency
75.0,
!- Pressure Rise {Pa}
0.84,
!- Maximum Flow Rate {m3/s}
0.9,
!- Motor Efficiency
1.0,
!- Motor In Airstream Fraction
Zone1UnitVentOAMixerOutletNode, !- Fan Inlet Node Name
Zone1UnitVentFanOutletNode; !- Fan Outlet Node Name

Coil:Cooling:Water,
Zone1UnitVentCoolingCoil,!FanAndCoilAvailSched,
!0.0010,
!0.84,
!6.67,
!30,
!12,
!0.013,
!0.008,
!Zone1UnitVentChWInletNode,
Zone1UnitVentChWOutletNode,
Zone1UnitVentFanOutletNode,
Zone1UnitVentCCOutletNode,
SimpleAnalysis,
!CrossFlow;
!-

Name
Availability Schedule Name
Design Water Flow Rate {m3/s}
Design Air Flow Rate {m3/s}
Design Inlet Water Temperature {C}
Design Inlet Air Temperature {C}
Design Outlet Air Temperature {C}
Design Inlet Air Humidity Ratio {kgWater/kgDryAir}
Design Outlet Air Humidity Ratio {kgWater/kgDryAir}
!- Water Inlet Node Name
!- Water Outlet Node Name
!- Air Inlet Node Name
!- Air Outlet Node Name
Type of Analysis
Heat Exchanger Configuration

Coil:Heating:Water,
Zone1UnitVentHeatingCoil,!- Name
FanAndCoilAvailSched,
!- Availability Schedule Name
400.,
!- U-Factor Times Area Value {W/K}
0.0005,
!- Maximum Water Flow Rate {m3/s}
Zone1UnitVentHWInletNode,!- Water Inlet Node Name
Zone1UnitVentHWOutletNode, !- Water Outlet Node Name
Zone1UnitVentCCOutletNode, !- Air Inlet Node Name
Zone1UnitVentAirOutletNode, !- Air Outlet Node Name
UFactorTimesAreaAndDesignWaterFlowRate, !- Performance Input Method
autosize,
!- Nominal Capacity {W}
82.2,
!- Design Inlet Water Temperature {C}
16.6,
!- Design Inlet Air Temperature {C}
71.1,
!- Design Outlet Water Temperature {C}
32.2;
!- Design Outlet Air Temperature {C}

Unit Ventilator Outputs

HVAC,Average,Zone Unit Ventilator Heating Rate [W]
HVAC,Sum,Zone Unit Ventilator Heating Energy [J]
HVAC,Average,Zone Unit Ventilator Total Cooling Rate [W]
HVAC,Sum,Zone Unit Ventilator Total Cooling Energy [J]
HVAC,Average,Zone Unit Ventilator Sensible Cooling Rate [W]
HVAC,Sum,Zone Unit Ventilator Sensible Cooling Energy [J]
HVAC,Average,Zone Unit Ventilator Fan Electric Power[W]
HVAC,Sum,Zone Unit Ventilator Fan Electric Energy [J]
HVAC,Average,Zone Unit Ventilator Fan Availability Status []
HVAC,Average, Zone Unit Ventilator Fan Part Load Ratio []

Zone Unit Ventilator Heating Rate [W]

This field reports the heating output rate of the unit ventilator system to the zone it is serving
in Watts. This is determined by outlet and zone air conditions and the mass flow rate through
the unit ventilator.

9/29/14

947

Input-Output Reference

Group Zone Forced Air Units

Zone Unit Ventilator Heating Energy [J]

This field is the heating output of the unit ventilator system to the zone it is serving in Joules
over the timestep being reported. This is determined by outlet and zone air conditions, the
mass flow rate through the unit ventilator, and the timestep.
Zone Unit Ventilator Total Cooling Rate [W]
This field reports the total cooling (sensible plus latent) output rate of the unit ventilator
system to the zone it is serving in Watts. This is determined by outlet and zone air conditions
and the mass flow rate through the unit ventilator.
Zone Unit Ventilator Total Cooling Energy [J]
This field is the total cooling (sensible plus latent) output of the unit ventilator system to the
zone it is serving in Joules over the timestep being reported. This is determined by outlet and
zone air conditions, the mass flow rate through the unit ventilator, and the timestep.
Zone Unit Ventilator Sensible Cooling Rate [W]
This field reports the sensible cooling output rate of the unit ventilator system to the zone it is
serving in Watts. This is determined by outlet and zone air conditions and the mass flow rate
through the unit ventilator.
Zone Unit Ventilator Sensible Cooling Energy [J]
This field is the sensible cooling output of the unit ventilator system to the zone it is serving in
Joules over the timestep being reported. This is determined by outlet and zone air conditions,
the mass flow rate through the unit ventilator, and the timestep.
Zone Unit Ventilator Fan Electric Power [W]
This field reports the electric power consumption rate of the fan of the unit ventilator in Watts.
Zone Unit Ventilator Fan Electric Energy [J]
This field reports the electric power consumed by the fan of the unit ventilator over the
timestep in Joules.
Zone Unit Ventilator Fan Availability Status []
This is the availability status of the unit ventilator fan. This status flag is a result of the
calculations
made
by
the
Availability
Manager(s)
listed
in
an
AvailabilityManagerAssignmentList object and/or calculations made by Hybrid Ventilation
Manager object. The AvailabilityManagerAssignmentList is an optional input in the unit
ventilator object. When a single availability manager is used in an Availability Manager
Assignment List, this is also the availability status reported by the specific availability
manager (Ref. AvailabilityManager:* Outputs). For multiple availability managers in an
Availability Manager Assignment List (with or without Hybrid Ventilation Manager), rules to
determine fan availability status are described in the section Group System Availability
Managers. The control status outputs are represented using integers 0 through 3. These
integers represent NoAction (0), ForceOff (1), CycleOn (2), and CycleOnZoneFansOnly (3).
Since the status output is averaged, the output result may not correspond to the values
described here when output variable frequencies other than detailed are used. Use the
detailed reporting frequency (Ref. Output:Variable object) to view the availability status at
each simulation timestep.
Zone Unit Ventilator Fan Part Load Ratio []
This is the fans part load ratio for the report timestep during which the fan had operated. This
variable is available for OnOff supply air fan type only.

9/29/14

948

Input-Output Reference

Group Zone Forced Air Units

ZoneHVAC:UnitHeater
Unit heaters are zone equipment units which are assembled from other components and are
a simplification of unit ventilators. They contain only a fan and a heating coil. These
components are described elsewhere in this document. The unit heater input simply requires
the names of these components, which have to be described elsewhere in the input. The
input also requires the name of an availability schedule, maximum airflow rate, and maximum
and minimum hot water volumetric flow rates. The unit is connected to the zone inlet and
exhaust nodes by specifying unit inlet and outlet node names. Note that the unit air inlet node
should be the same as a zone exhaust node and the unit outlet node should be the same as
a zone inlet node.
While the control of the heating coil is similar to the fan coil units and the unit ventilator, the
overall control of the unit heater is much different. There are four different modes in which a
unit heat can operate based on the user input:
Off: Unit is schedule off. All flow rates are set to zero and the temperatures are set to zone
conditions.
NoLoad OR Cooling/No is specified in input field Supply Air Fan Operation During No
Heating: Unit is available, but there is no heating load. With No specified for Supply Air
Fan Operation During No Heating and the supply fan operating mode set to 0, the fan will be
off since there is no heating load. All flow rates are set to zero and the temperatures are set
to zone conditions.
NoLoad OR Cooling/Yes is specified in input field Supply Air Fan Operation During No
Heating: Unit is available, the supply fan operating mode schedule value is greater than 0
(for OnOff Fan) and the fan is running (if it is scheduled to be available also). No heating is
provided, only air circulation via the fan running. However, any heat added by the fan is
introduced into the space with the circulation of the air.
Heating: The unit is on/available and there is a heating load. The heating coil is modulated
(constant fan speed) to meet the heating load. When the fan type is not an OnOff fan then the
control of the heating coil and its flow rate is identical to the fan coil unit. In the case of OnOff
fan, the fan cycles with heating coil if the current timestep supply fan operating mode is
schedule value is 0, or else if the current timestep supply fan operating mode schedule value
is greater than 0, then the supply fan runs continuously for the entire timestep.
Field: Name
This field is simply the identifying name that distinguishes one particular unit heater from
another in the input data file. Like all other names in EnergyPlus, it is assumed that this is a
unique character string and that no other unit heaters use this same name.
Field: Availability Schedule Name
This field is a schedule name (ref: Schedule) that determines whether the unit heater is
available to operate. A schedule value greater than 0 (usually 1 is used) indicates that the
component can be on during the time period. A value less than or equal to 0 (usually 0 is
used) denotes that the component must be off for the time period. If this field is blank, the
schedule has values of 1 for all time periods.
Field: Air Inlet Node Name
This field is a node name used to identify the node that serves as the inlet (air side) to the
unit heater. In EnergyPlus, nodes represent points between components or at various points
in the loops. In a unit heater, the air inlet node to the system will typically be the same node
as a zone outlet node. While a node name may be referenced more than once in an input
data file, each node must have a unique name.

9/29/14

949

Input-Output Reference

Group Zone Forced Air Units

Field: Air Outlet Node Name

This field is a node name used to identify the node that serves as the outlet (air side) to the
unit heater. In EnergyPlus, nodes represent points between components or at various points
in the loops. In a unit heater, the air outlet node from the system will typically be the same
node as a zone inlet node. While a node name may be referenced more than once in an input
data file, each node must have a unique name.
Field: Supply Air Fan Object Type
This field specifies the type of supply air fan used by this unit heater. The supply air fan is
part of the unit heater compound object. The only valid supply air fan types are:
Fan:OnOff
Fan:ConstantVolume
Fan:VariableVolume

Field: Supply Air Fan Name

This field is the name of a fan (ref: Fan:ConstantVolume, Fan:VariableVolume) that is part of
the unit heater system. This name links the unit heater to particular fan data entered
elsewhere in the input data file. A fan name is required since it is the prime mover of air in the
unit heater system.
Field: Maximum Supply Air Flow Rate
This field allows the user to enter the maximum volumetric flow rate of air through the unit
heater system in m3/s. This parameter should be some real number greater than zero.
Field: Heating Coil Object Type
This field is the type of coil that is used for heating in the unit heater system. It is used in
conjunction with the heating coil name (see next field) to specify the heating coil present
within the system. Allowable heating coil types are:
Coil:Heating:Water
Coil:Heating:Electric
Coil:Heating:Gas
Coil:Heating:Steam

Field: Heating Coil Name

This field is the name of the heating coil that is part of the unit heater system. It is assumed
that there is always some sort of heating coil associated with a unit heater system. This name
links the unit ventilator to particular heating coil data entered elsewhere in the input data file.
Field: Supply Air Fan Operating Mode Schedule Name
This field is a schedule name (ref: Schedule) that determines whether the operating modes of
unit heaters On:Off fan. A schedule values of 0 indicates cycling fan operation (fan cycles
with cooling/heating coil). A schedule values greater than 0 (usually 1 is used) indicate
constant fan operation (fan runs continually regardless of coils operation). If this input field is
left blank, then the operating mode of the OnOff fan type defaults to cycling operation.
Field: Supply Air Fan Operation During No Heating
This choice field allows the user to define how the unit heater will operate under no heating
load or cooling conditions. The user may select from two options (Yes, No). If the No
control is selected, then the fan will not run unless there is a heating load. If the fan does not
run, this effectively shuts the unit heater system off. If the Yes control is selected, the unit
heater is available, and the fan is continuous, then the fan will always run. This will produce
air movement in the zone but also add some amount of heat to the energy balance since the
fan generates some heat. But if the Yes control is selected and the Supply Air Fan

9/29/14

950

Input-Output Reference

Group Zone Forced Air Units

Operating Mode Schedule values is 0 (for OnOff fan), then the fan will NOT run. This allows
the user to schedule the operation of the fan when there is no load.
Field: Maximum Hot Water or Steam Flow Rate
This field allows the user to enter a maximum hot water or steam volumetric flow rate through
the heating coil in m 3/s. The steam volume flow rate is calculated at 100C and 101325 Pa.
This number should be some number greater than zero and greater than the minimum hot
water or steam volumetric flow rate (see next field). Note that this parameter has no meaning
for either an electric or a gas heating coil.
Field: Minimum Hot Water or Steam Flow Rate
This field allows the user to enter a minimum hot water or steam volumetric flow rate through
the heating coil in m 3/s. The steam volume flow rate is calculated at 100C and 101325 Pa.
This number should be some number greater than zero and less than the maximum hot water
or steam volumetric flow rate (see previous field). Note that this parameter has no meaning
for either an electric or a gas heating coil.
Field: Heating Convergence Tolerance
The convergence tolerance for the unit heating output. This field allows the user some control
over how closely the heating coil will control the air side conditions. The relative size of this
parameter relates directly to the closeness of the control. A very small value in this field will
result in tight control and will probably result in larger numbers of iterations. A large value in
this field will result in looser controls and could result in unsatisfactory fluctuations in supply
conditions (that could in turn result in excessive iterations). Initial experience with this
parameter lends to the recommendation of using 0.001 as a starting point. This field is
ignored for gas and electric heating coils.
The unit is controlled by matching the unit output to the zone demand. For units with water
coils, the model must be numerically inverted to obtain a specified output. The heating
convergence tolerance is the error tolerance used to terminate the numerical inversion
procedure. Basically this is the fraction:

Qunit heater ,out Qzoneload

Qzoneload

HeatingConvergenceTolerance

Field: Availability Manager List Name

This optional input field is the name of an AvailabilityManagerAssignmentList object. An
Availability Manager Assignment List is a list of Availability Managers giving both Availability
Manager type and name. The availability managers in the list apply to this unit heater objects
fan. If the unit heater is available (per the Availability Schedule Name input field above) and
this input field has a valid availability manager assignment list name, then the availability
managers in the list determine when and if the fan of this unit heater object should be on or
off.
Field: Design Specification ZoneHVAC Sizing Object Name
This optional input field is the name of a DesignSpecificationZoneHVACSizing object. The
name must correspond to unique name of a DesignSpecification:ZoneHVAC:Sizing object. A
Design Sepcification Zone HVAC Sizing object defines scalable sizing methods for sizing
input fields Maximum Supply Air Flow Rate in this Unit Heater zone HVAC object. The scaled
maximum supply air flow rates is used to size Maximum Hot Water or Steam Flow Rate if
specified as autosize. The scaled Maximum Air Flow Rate in turn is used to size heating
capacity of the unit.
An example input for a unit heater, including its constituent components, is shown below.
9/29/14

951

Input-Output Reference

Group Zone Forced Air Units

ZoneHVAC:UnitHeater,
Zone1UnitHeat,
!UnitHeatAvailability,
!Zone1UnitHeatAirInletNode,
Zone1UnitHeatAirOutletNode,
Fan: ConstantVolume,
!Zone1UnitHeatFan,
!0.84,
!Continuous,
!Coil:Heating:Water,
!Zone1UnitHeatHeatingCoil,!0.0005,
!0.0,
!0.001;
!-

Name
Availability Schedule Name
!- Air Inlet Node Name
!- Air Outlet Node Name
Supply Air Fan Object Type
Fan Name
Maximum Supply Air Flow Rate {m3/s}
Fan Control Type
Heating Coil Object Type
Heating Coil Name
Maximum Hot Water or Steam Flow Rate {m3/s}
Minimum Hot Water or Steam Flow Rate {m3/s}
Heating Convergence Tolerance

Fan:ConstantVolume,
Zone1UnitHeatFan,
!UnitHeatAvailability,
!0.5,
!75.0,
!0.84,
!0.9,
!1.0,
!Zone1UnitHeatAirInletNode,
Zone1UnitHeatFanOutletNode;

Name
Availability Schedule Name
Fan Total Efficiency
Pressure Rise {Pa}
Maximum Flow Rate {m3/s}
Motor Efficiency
Motor In Airstream Fraction
!- Fan Inlet Node Name
!- Fan Outlet Node Name

Coil:Heating:Water,
Zone1UnitHeatHeatingCoil,!- Name
FanAndCoilAvailSched,
!- Availability Schedule Name
400.,
!- U-Factor Times Area Value {W/K}
0.0005,
!- Maximum Water Flow Rate {m3/s}
Zone1UnitHeatHWInletNode,!- Water Inlet Node Name
Zone1UnitHeatHWOutletNode, !- Water Outlet Node Name
Zone1UnitHeatFanOutletNode, !- Air Inlet Node Name
Zone1UnitHeatAirOutletNode, !- Air Outlet Node Name
UFactorTimesAreaAndDesignWaterFlowRate, !- Performance Input Method
autosize,
!- Nominal Capacity {W}
82.2,
!- Design Inlet Water Temperature {C}
16.6,
!- Design Inlet Air Temperature {C}
71.1,
!- Design Outlet Water Temperature {C}
32.2;
!- Design Outlet Air Temperature {C}

Unit Heater Outputs

HVAC,Average,Zone Unit Heater Heating Rate [W]
HVAC,Sum,Zone Unit Heater Heating Energy [J]
HVAC,Average,Zone Unit Heater Fan Electric Power[W]
HVAC,Sum,Zone Unit Heater Fan Electric Energy [J]
HVAC,Average, Zone Unit Heater Fan Availability Status []
HVAC,Average, Zone Unit Heater Fan Part Load Ratio []

Zone Unit Heater Heating Rate [W]

This field reports the heating output rate of the unit heater system to the zone it is serving in
Watts. This is determined by outlet and zone air conditions and the mass flow rate through
the unit heater.
Zone Unit Heater Heating Energy [J]
This field is the heating output of the unit heater system to the zone it is serving in Joules
over the timestep being reported. This is determined by outlet and zone air conditions, the
mass flow rate through the unit heater, and the timestep.

9/29/14

952

Input-Output Reference

Group Zone Forced Air Units

Zone Unit Heater Fan Electric Power [W]

This field reports the electric power consumption rate of the fan of the unit heater in Watts.
Zone Unit Heater Fan Electric Energy [J]
This field reports the electric power consumed by the fan of the unit heater over the timestep
in Joules.
Zone Unit Heater Fan Availability Status []
This is the availability status of the unit heater fan. This status flag is a result of the
calculations
made
by
the
Availability
Manager(s)
listed
in
an
AvailabilityManagerAssignmentList object and/or calculations made by Hybrid Ventilation
Manager object. The AvailabilityManagerAssignmentList is an optional input in the unit heater
object. When a single availability manager is used in an Availability Manager Assignment
List, this is also the availability status reported by the specific availability manager (Ref.
AvailabilityManager:* Outputs). For multiple availability managers in an Availability Manager
Assignment List (with or without Hybrid Ventilation Manager), rules to determine fan
availability status are described in the section Group System Availability Managers. The
control status outputs are represented using integers 0 through 3. These integers represent
NoAction (0), ForceOff (1), CycleOn (2), and CycleOnZoneFansOnly (3). Since the status
output is averaged, the output result may not correspond to the values described here when
output variable frequencies other than detailed are used. Use the detailed reporting
frequency (Ref. Output:Variable object) to view the availability status at each simulation
timestep.
Zone Unit Heater Fan Part Load Ratio []
This is the fans part load ratio for the report timestep during which the fan had operated. This
variable is available for OnOff supply air fan type only.
ZoneHVAC:EvaporativeCoolerUnit
The zone evaporative cooler unit is a compound object made up of a fan and one or two
evaporative cooler components. This unit serves a single thermal zone as a forcedconvection, cooling-only unit with supply fan. It always draws 100% of its supply air from the
outside, passes the air through a supply fan and evaporative cooler(s) and then into the zone.
The fan can be positioned upstream of the cooler(s) for a blow through placement. Or it can
be positioned downstream of the cooler(s) for a draw through placement. If there is more
than one evaporative cooler, then should be in series with the first cooler immediately
upstream of the second cooler. There is an option to include a relief zone exhaust node to
balance the air in the zone.
The unit can have either constant or variable speed fans. This zone unit differs from other
constant speed forced-air zone units in that its controls are not based on a part-load
formulation with averaged air flow rates. Instead the unit is completely on or off during the
entire timestep. This means that it is beneficial to use relatively short timesteps. However for
variable speed fans, the unit can modulate fan speed to just meet cooling loads and therefore
operates similar to other zone HVAC units.
Field: Name
This alpha field defines a unique user-assigned name for an instance of a zone evaporative
cooler unit. References to this unit by other objects will use this name.
Field: Availability Schedule Name
This alpha field defines the name of a schedule that denotes whether the unit operates during
a given time period. A schedule value equal to 0.0 denotes that the cooler unit must be off for
that time period. A schedule value greater than 0.0 denotes that the cooler is available to
operate during that time period. If this field is left blank, then the program assumes that the
unit is always available as if the schedule was always set to 1.0.
9/29/14

953

Input-Output Reference

Group Zone Forced Air Units

Field: Availability Manager List Name

This optional alpha input field is the name of an AvailabilityManagerAssignmentList object. An
Availability Manager Assignment List is a list of Availability Managers giving both Availability
Manager type and name. The availability managers in the list apply to this evaporative cooler
units operation. If this field is used and the cooler unit is scheduled to be available, based on
the previous input field, then the unit will operate based on the result of the availability
managers in the list.
Field: Outdoor Air Inlet Node Name
This alpha input field defines the name of the HVAC system node from which the evaporative
cooler unit draws its supply air. This node is usually declared to be an outdoor air node using
OutdoorAir:Node or OutdoorAir:NodeList.
Field: Cooler Outlet Node Name
This alpha input field defines the name of the HVAC system node to which the evaporative
cooler sends its outlet air. This node name must be the name of a zone air inlet node (Ref.
ZoneHVAC:EquipmentConnections).
Field: Zone Relief Air Node Name
This optional alpha input field defines the name of an HVAC system node which can extract
air from the zone to balance the air supplied to the zone by the cooler outlet node. This node
name would match the name of a zone exhaust air node.
Field: Supply Air Fan Object Type
This alpha input field defines the type of fan used by the zone evaporative cooler unit. There
are four valid choices: Fan:ConstantVolume, Fan:OnOff, Fan:VariableVolume, or
Fan:ComponentModel. However the type of fan must be consistent with the control method
defined below and a variable speed fan is needed with ZoneCoolingLoadVariableSpeedFan.
Field: Supply Air Fan Name
This alpha input field defines the user-defined name of the fan used by this cooler unit. The
fan itself is defined elsewhere. Note that the fans maximum flow rate should be greater than
or equal to the Design Supply Air Flow Rate defined in the following field. For a blow-through
fan placement, the fans inlet node should be the same as the Outlet Air Inlet Node Name.
For a draw-through fan placement, the fans outlet node should be the same as the Cooler
Outlet Node Name.
Field: Design Supply Air Flow Rate [m3/s]
This numeric input field defines the evaporative cooler units design supply air flow rate, in
cubic meters per second. This value is typically consistent with the maximum air flow rate of
the fan, but it can be less if desired.
Field: Fan Placement
This alpha input field defines how the supply fan is arranged. There are two choices,
BlowThrough or DrawThrough. The BlowThrough choice indicates that the fan is located
upstream of the evaporative cooler(s). The DrawThrough choice indicates that the fan is
located downstream of the evaporative cooler(s). These are the only configurations that are
available and the HVAC system nodes used as inlets and outlet in the components must be
arranged consistent with the flow path.
Field: Cooler Unit Control Method
This alpha field is used to determine how the unit is to be controlled.
possible choices:

9/29/14

There are three

954

Input-Output Reference

Group Zone Forced Air Units

ZoneTemperatureDeadbandOnOffCycling. This control method determines

whether or not to operate the cooler based on the thermostat setpoint and the zone
air temperature. This thermostatic control method uses a throttling temperature
range, determined in the following input field, to model hysteresis-type control to
avoid excessive short-cycling. If the zone air temperature is warmer than the cooling
setpoint temperature plus one-half of the throttling range, then the unit is operated for
the entire timestep at the design air mass flow rate. If the zone air temperature is
cooler than the cooling setpoint temperature minus one-half of the throttling range,
then the unit is off for the entire timestep. When the zone air temperatures are within
the throttling range, then the unit will stay off if it was not running during the previous
timestep and will stay on if it was already running. This control method does not
usually behave in a smooth manner and zone conditions will tend to oscillate
considerably during periods of low load.
ZoneCoolingLoadOnOffCycling. This control method determines whether or not to
operate the cooler based on the predicted zone load to cooling setpoint. If there is a
cooling load (and the unit is available), then the unit is operated for the entire
timestep at the design air mass flow rate. If there is no cooling load, then the unit is
not operated at all. The magnitude of the cooling load that will trigger the unit to
operate can be controlled using the field below called Cooling Load Control
Threshold Heat Transfer Rate. This control method does not usually behave in a
smooth manner and zone conditions will tend to oscillate considerably during periods
of low load.
ZoneCoolingLoadVariableSpeedFan. This control method determines whether or
not to operate the cooler based on the predicted zone load to cooling setpoint. If
there is a cooling load (and the unit is available), then the unit is operated for the
entire timestep at a fan speed that is controlled to meet the sensible cooling load (if
possible). The magnitude of the cooling load that will trigger the unit to operate can
be controlled using the field below called Cooling Load Control Threshold Heat
Transfer Rate. This control method requires a variable speed fan and cannot be
used with Fan:ConstantVolume or Fan:OnOff.
Field: Throttling Range Temperature Difference [DeltaC]
This numeric input field defines the throttling range to use for zone-temperature based
control, in degrees Celsius. This value is used when the units control method is
ZoneTemperatureDeadbandOnOffCycling. This temperature range is used for hysteresis
thermostatic control. It is modeled as symmetric about the cooling setpoint. The default is
1.0C.
Field: Cooling Load Control Threshold Heat Transfer Rate [W]
This numeric input field defines the magnitude, in Watts, of a significant zone cooling load to
use with zone-load-to-setpoint based control. This value is used when the units control
method is ZoneCoolingLoadOnOffCycling or ZoneCoolingLoadVariableSpeedFan. This is a
sensible cooling load that is used as a threshold to determine when the cooling load is
significant. When the predicted zone load to cooling setpoint is less than this threshold, the
cooler units control will consider the load to be too small to trigger operation. The default is
100W.
Field: First Evaporative Cooler Object Type
This alpha input field defines the type of evaporative cooler used in the unit. The zone
evaporative cooler unit can have one or two separate cooler components and this field is for
the first cooler. There are five types of evaporative cooler component models to choose from:
EvaporativeCooler:Direct:CelDekPad,
EvaporativeCooler:Direct:ResearchSpecial,
EvaporativeCooler:Indirect:CelDekPad,
EvaporativeCooler:Indirect:WetCoil,
or
EvaporativeCooler:Indirect:ResearchSpecial.

9/29/14

955

Input-Output Reference

Group Zone Forced Air Units

Field: First Evaporative Cooler Object Name

This alpha input field defines the user-defined name of the first evaporative cooler component
used by this zone unit. The cooler component itself is defined elsewhere. For a blow through
fan placement, the inlet node for the evaporative cooler should be the same as the fans
outlet node. For a draw through fan placement, the inlet node for the evaporative cooler
should be the same as the units Outdoor Air Inlet Node Name.
Field: Second Evaporative Cooler Object Type
This optional alpha input field defines the type of evaporative cooler used in the unit. This
field is used when the zone evaporative cooler unit has two separate evaporative cooler
sections arranged in series. For example, some coolers are arranged with both direct and
indirect evaporative coolers. If the unit has only one type of cooler, this field should be left
blank. There are five types of evaporative cooler component models to choose from:
EvaporativeCooler:Direct:CelDekPad,
EvaporativeCooler:Direct:ResearchSpecial,
EvaporativeCooler:Indirect:CelDekPad,
EvaporativeCooler:Indirect:WetCoil,
or
EvaporativeCooler:Indirect:ResearchSpecial
Field: Second Evaporative Cooler Name
This optional alpha input field defines the user-defined name of the second evaporative
cooler component used by this zone unit. The cooler component itself is defined elsewhere.
The inlet node for the second evaporative cooler should be the same as the outlet node for
the first evaporative cooler. For a draw through fan placement, the outlet node for the second
evaporative cooler should be the same as the units fan inlet node.
Field: Design Specification ZoneHVAC Sizing Object Name
This optional input field is the name of a DesignSpecificationZoneHVACSizing object. The
name must correspond to unique name of a DesignSpecification:ZoneHVAC:Sizing object
defined elsewhere. A Design Sepcification Zone HVAC Sizing object defines scalable sizing
methods for sizing input field Design Supply Air Flow Rate in Evaportaive Cooler zone HVAC
object. The scaled design supply air flow rates in turn is used to size capacity of the unit.
An example input object follows.
ZoneHVAC:EvaporativeCoolerUnit,
Zone Evap Unit, !- Name
System Availability Schedule , !- Availability Schedule Name
, !- Availability Manager List Name
Cooler Unit OA inlet , !- Outdoor Air Inlet Node Name
Main Zone Inlet Node, !- Cooler Outlet Node Name
Main Zone Relief Node , !- Zone Relief Air Node Name
Fan:ConstantVolume , !- Supply Air Fan Object Type
Supply Fan , !- Supply Air Fan Name
2.0, !- Design Supply Air Flow Rate
DrawThrough , !- Fan Placement
ZoneCoolingLoadOnOffCycling, !- Cooler Unit Control Method
1.1, !- Throttling Range Temperature Difference
100.0, !- Cooling Load Control Threshold Heat Transfer Rate
EvaporativeCooler:Direct:CelDekPad, !- First Evaporative Cooler Object
Type
Evaporative Cooler, !- First Evaporative Cooler Object Name
, !- Second Evaporative Cooler Object Type
; !- Second Evaporative Cooler Name

ZoneHVAC:EvaporativeCoolerUnit Outputs
HVAC,Average,Zone Evaporative Cooler Unit Total Cooling Rate [W]
HVAC,Sum,Zone Evaporative Cooler Unit Total Cooling Energy [J]
9/29/14

956

Input-Output Reference

Group Zone Forced Air Units

HVAC,Average,Zone Evaporative Cooler Unit Sensible Cooling Rate [W]

HVAC,Sum,Zone Evaporative Cooler Unit Sensible Cooling Energy [J]
HVAC,Average,Zone Evaporative Cooler Unit Latent Heating Rate [W]
HVAC,Sum,Zone Evaporative Cooler Unit Latent Heating Energy [J]
HVAC,Average,Zone Evaporative Cooler Unit Latent Cooling Rate [W]
HVAC,Sum,Zone Evaporative Cooler Unit Latent Cooling Energy [J]
HVAC,Average,Zone Evaporative Cooler Unit Fan Speed Ratio []
HVAC,Average,Zone Evaporative Cooler Unit Fan Availability Status []

Zone Evaporative Cooler Unit Total Cooling Rate [W]

This output is the total (enthalpy) heat extraction rate of the zone evaporative cooler unit from
the zone it is serving, in Watts. This value is calculated using the enthalpy difference of the
unit outlet air node and the zone air node and the air mass flow rate entering the zone.
Zone Evaporative Cooler Unit Total Cooling Energy [J]
This output is the total (enthalpy) heat extraction of the zone evaporative cooler unit from the
zone it is serving, in Joules. This value is calculated using the enthalpy difference of the unit
outlet air node and the zone air node and the air mass flow rate entering the zone.
Zone Evaporative Cooler Unit Sensible Cooling Rate [W]
This output is the moist air sensible-only heat extraction rate of the zone evaporative cooler
unit from the zone it is serving, in Watts. This value is calculated using the enthalpy
difference of the unit outlet air node and the zone air node based on a single, minimum
humidity ratio along with the air mass flow rate entering the zone.
Zone Evaporative Cooler Unit Sensible Cooling Energy [J]
This output is the moist air sensible-only heat extraction of the zone evaporative cooler unit
from the zone it is serving, in Joules. This value is calculated using the enthalpy difference of
the unit outlet air node and the zone air node based on a single, minimum humidity ratio
along with the air mass flow rate entering the zone.
Zone Evaporative Cooler Unit Latent Heating Rate [W]
This output is the latent heat addition (humidification) rate of the zone evaporative cooler unit
to the zone it is serving in Watts. This value is calculated as the difference between the total
cooling rate and the sensible cooling rate. Because an evaporative cooler can provide
sensible cooling while adding moisture the zone air, a unit can operate with both a positive
sensible cooling load and a positive latent heating rate.
Zone Evaporative Cooler Unit Latent Heating Energy [J]
This output is the latent heat addition (humidification) of the zone evaporative cooler unit to
the zone it is serving in Joules. This value is calculated as the difference between the total
cooling energy and the sensible cooling energy.
Zone Evaporative Cooler Unit Latent Cooling Rate [W]
This output is the latent heat extraction (dehumidification) rate of the zone evaporative cooler
unit to the zone it is serving in Watts. This value is calculated as the difference between the
total cooling rate and the sensible cooling rate.
Zone Evaporative Cooler Unit Latent Cooling Energy [J]
This output is the latent heat extraction (dehumidification) of the zone evaporative cooler unit
to the zone it is serving in Joules. This value is calculated as the difference between the total
cooling energy and the sensible cooling energy.
Zone Evaporative Cooler Unit Fan Speed Ratio [ ]
This output is the speed ratio of the fan for the zone evaporative cooler unit. The speed ratio
is defined as the current supply air mass flow rate divided by the design air mass flow rate.
9/29/14

957

Input-Output Reference

Group Zone Forced Air Units

Zone Evaporative Cooler Unit Fan Availability Status [ ]

This output is the availability status of the zone evaporative cooler units fan. This status flag
is a result of the calculations made by the Availability Manager(s) listed in an
AvailabilityManagerAssignmentList object and/or calculations made by Hybrid Ventilation
Manager object. The AvailabilityManagerAssignmentList is an optional input in the zone
evaporative cooler object. When a single availability manager is used in an Availability
Manager Assignment List, this is also the availability status reported by the specific manager.
For multiple availability managers in an Availability Manager Assignment List (with or without
Hybrid Ventilation Manager)), rules to determine fan availability status are described in the
section on system availability managers. The control status outputs are represented using
integers 0 through 3. These integers represent NoAction (0), ForceOff (1), CycleOn(2), and
CycleOneZoneFansOnly (3). It is recommend to report this output at the Detailed frequency
because the integer status flags do not average out to meaningful values.
ZoneHVAC:OutdoorAirUnit
The zone outdoor air unit (ZoneHVAC:OutdoorAirUnit) in EnergyPlus is intended to model
dedicated outdoor air systems (DOAS) and other similar systems which aim to provide either
additional outside air or some limited amount of sensible and/or latent conditioning. The zone
outdoor air unit is a piece of zone equipment that can consist of a supply fan, an exhaust fan
(optional), heating and cooling coils, and heat recovery. The outdoor air unit input simply
requires information about flow rates, schedules, node names, and a list of component that
are part of the unit. These components require additional input as per the requirements for
these components. In addition, the input includes information about controls for the unit. It
should be noted that the components that make up the zone outdoor air unit do not require
additional controls or setpoints. The unit input defines how the unit outlet temperature is
controlled as described below.
Zone Outdoor Air
Unit
Suppl
y Fan

Exha
ust
Fan(
Optio
nal)

Heat
Reco
very

Zone Outdoor Air

Unit Equipments

Node List
(1) Air Outlet Node
(2) Air Inlet Node
(3) Air Relief Node
(Optional)
(4) OA Inlet Node

Figure 110. Zone Outdoor Air Unit Schematic

Zones may contain one or more zone outdoor air units. The user can choose to have each
unit have its own exhaust fan or may choose to have only one unit have a exhaust fan that
will handle the flow of all of the zone outdoor air units. Note that the user will need to account
for any flow balance among the zone outdoor air units on the supply and exhaust sides.
9/29/14

958

Input-Output Reference

Group Zone Forced Air Units

The full input for zone outdoor air units is described below using a variety of fields.
Field: Name
This field is simply the identifying name that distinguishes one particular outdoor air unit from
another in the input data file. Like all other names in EnergyPlus, it is assumed that this is a
unique character string and that no other zone outdoor air units use this same name.
Field: Availability Schedule Name
This field is a schedule name (ref: Schedule) that determines whether the zone outdoor air
unit is available to operate. A schedule value greater than 0 (usually 1 is used) indicates that
the outdoor air unit can be on during the time period. A value less than or equal to 0 (usually
0 is used) denotes that the outdoor air unit must be off for the time period. If this field is blank,
the schedule has values of 1 for all time periods. For any schedule value greater than zero,
the outdoor air unit is considered available and will operate at the supply and exhaust flow
rates defined by input field described below.
Field: Zone Name
This field is the name of the zone (Ref: Zone) in which the outdoor air unit is located and
intended to affect. Zone outdoor air units impact only a single zone.
Field: Outdoor Air Flow Rate
This field allows the user to enter the volumetric flow rate of outdoor air (in m 3/sec) that will be
brought in through the outdoor air unit. The actual outdoor air flow rate will be this number
multiplied by the schedule value from the outdoor air schedule. This field is autosizable.
When autosized, the units outdoor air flow rate will match the minimum outdoor air
requirements specified through the Sizing:Zone object.
Field: Outdoor Air Schedule Name
This field contains a schedule name (ref: Schedule) that contains values for modifying the
outdoor air flow rate. The supply air flow rate is the product of the outdoor air flow rate and
the outdoor air schedule value for the time of interest. Note that if the outdoor air unit is
scheduled off that the system will not operate regardless of the outdoor air schedule value.
However, if the system is operating, it will always bring in this fraction of the outdoor air flow
rate.
Field: Supply Fan Name
This field is the name of a fan (ref: Fan:ConstantVolume, Fan: VariableVolume) that is part of
the zone outdoor air unit. This name links the outdoor air unit to particular fan data entered
elsewhere in the input data file. A fan name is required since it is the prime mover of air in the
outdoor air control unit.
Field: Fan Placement
This field has two choices: BlowThrough or DrawThrough. The first choice stands for blow
through fan. It means that the unit consists of outdoor air node followed by a supply fan
followed by the equipment that are part of the system. The second choice stands for draw
through fan. It means that the supply fan placed at the end of supply air stream and supply
fan outlet node is identified with the air outlet node. The fan draws air through the
equipment system.
BlowThrough
DrawThrough

If the user does not select a fan placement type, DrawThrough is assumed as default by
EnergyPlus.

9/29/14

959

Input-Output Reference

Group Zone Forced Air Units

Field: Exhaust Fan Name

This field is the name of a fan (ref: Fan:ConstantVolume, Fan: VariableVolume) that is part of
the outdoor air unit. This name links the outdoor air unit to particular fan data entered
elsewhere in the input data file. This field is optional.
Field: Exhaust Air Flow Rate
This field allows the user to enter the volumetric flow rate of air (in m 3/sec) that will be
exhausted to the outdoors. The actual exhaust air flow rate will be this number multiplied by
the schedule value from the exhaust air schedule. If the exhaust fan name is left blank, this
field will be ignored and automatically set to be equal to zero.
Field: Exhaust Air Schedule Name
This field contains a schedule name (ref: Schedule) that should contain values for modifying
the exhaust air flow rate. The actual exhaust air flow rate equals the exhaust air flow rate
input (previous field) multiplied by the exhaust air schedule value. If the exhaust fan name is
left blank, this field will be ignored and automatically set to be equal to zero.
Field: Unit Control Type
The unit control type field determines with conditions in the zone being served what the
response of the zone outdoor air system will be. It is important to note that this only controls
the temperature of the air being delivered to the space not whether or not the system will
operate. There are two options for this field: Neutral or Temperature. Neutral control tries to
have no energy impact on the zone by delivering air at the temperature of the zone. This
allows air to be delivered to the zone without affecting the zone air heat balance and thus
provides outside air without impacting any other system providing conditioning to this zone.
The temperature control option will supply air to the zone based on the high and low air
control temperature schedules (see next two fields). For temperature control, when the
outside air temperature is less than the low air control temperature, the zone outdoor air unit
will provide whatever heating is available from its components to achieve the low air
temperature value. When the outside air temperature is above the high air control
temperature, the zone outdoor air unit will provide whatever cooling is available from its
components to achieve the high air temperature value. When the outdoor air temperature is
between the high and low air control temperatures, the unit will simply provide air at whatever
the outdoor air conditions are, modified by any fan heat added by the supply fan. In summary,
the user must select from the following two options:
NeutralControl
TemperatureControl

If the user does not select a unit control type, NeutralControl is assumed as the default by
EnergyPlus.
Field: High Air Control Temperature Schedule Name
This field specifies the dry-bulb air temperature in degrees Celsius for the supply air
temperature to the zone. When the outdoor air temperature or post-supply fan outlet
temperature in the case of blow through is above the high air control temperature, a cooling
coil, if available and specified by the user, is tuned on to conditioning the outdoor air to the
high control temperature. This field only applies to zone outdoor air units that use
Temperature Control (see previous field).
Field: Low Air Control Temperature Schedule Name
This field specifies the dry-bulb air temperature in degrees Celsius for the supply air
temperature to the zone. When the outdoor air temperature or post-supply fan outlet
temperature is below the low air control temperature, a heating coil, if available and specified
by the user, is tuned on to conditioning the outdoor air to the low control temperature. This

9/29/14

960

Input-Output Reference

Group Zone Forced Air Units

field only applies to zone outdoor air units that use Temperature Control (see two previous
fields).
Field: Outdoor Air Node Name
This field is a node name used to identify the node associated with fresh air brought into the
outdoor air unit from the outdoor environment. It should also be defined in an
OutdoorAir:Node object with the same name and assigned an optional height (above
ground).
Field: Air Outlet Node Name
This field is a node name used to identify the node that serves as the outlet (air side) from the
zone outdoor air unit. In EnergyPlus, nodes represent points between components or at
various points in the loops. In an outdoor air unit, the air outlet node from the system will
typically be the same node as a zone inlet node. While a node name may be referenced
more than once in an input data file, each node must have a unique name.
Field: Air Inlet Node Name
This field is a node name used to identify the node that serves as the inlet (air side) to the
exhaust side of the outdoor air unit. In EnergyPlus, nodes represent points between
components or at various points in the loops. In an outdoor air unit, the air inlet node of the
system will typically be the same node as a zone outlet node. While a node name may be
referenced more than once in an input data file, each node must have a unique name.
Field: Supply Fan Outlet Node Name
This field is a node name used to identify the node that serves as the outlet (air side) of the
supply fan for the zone outdoor air unit. In EnergyPlus, nodes represent points between
components or at various points in the loops. While a node name may be referenced more
than once in an input data file, each node must have a unique name.
Field: Outdoor Air Unit List Name
This field is the name of an ZoneHVAC:OutdoorAirUnit:EquipmentList object. An
ZoneHVAC:OutdoorAirUnit:EquipmentList is simply a list of components giving both
component name and type. This equipment list specifies all the components that will be
simulated in this unit. The order of the components in the list is significant: components are
simulated sequentially in the order given in the Equipment List.
Field: Availability Manager List Name
This optional input field is the name of an AvailabilityManagerAssignmentList object. An
Availability Manager Assignment List is a list of Availability Managers giving both Availability
Manager type and name. The availability managers in the list apply to this outdoor air unit
objects fan. If the outdoor air unit is available (per the Availability Schedule Name input field
above) and this input field has a valid availability manager assignment list name, then the
availability managers in the list determine when and if the fan of this outdoor air unit object
should be on or off.
An example of this object defined in an input data file is shown below:

9/29/14

961

Input-Output Reference
ZoneHVAC:OutdoorAirUnit,
Zone5DXOutAir,
OAUnitOASched,
SPACE5-1,
0.42,
OAUnitOASched,
Zone5OAUFan1,
BlowThrough,
,
,
,
TemperatureControl,
OAUHitemp2,
OAULotemp2,
Zone5OAUOANode,
Zone5OAUZoneInletNode,
Zone5OAUZoneOutletNode,
Zone5OAUFanOutletNode,
Zone5OAUEquip1;

Group Zone Forced Air Units

!!!!!!!!!!!!!!!!!!-

Name
Availability Schedule Name
Zone Name
Outdoor Air Flow Rate {m3/s}
Outdoor Air Schedule Name
Supply Fan Name
Supply Fan Placement
Exhaust Fan Name
Exhaust Air Flow Rate {m3/s}
Exhaust Air Schedule Name
Unit Control Type
High Air Control Temperature Schedule Name
Low Air Control Temperature Schedule Name
Outdoor Air Node Name
AirOutlet Node Name
AirInlet Node Name
Supply FanOutlet Node Name
Outdoor Air Unit List Name

Outdoor Air Unit Outputs

HVAC,Average, Zone Outdoor Air Unit Total Heating Rate [W]
HVAC,Sum, Zone Outdoor Air Unit Total Heating Energy [J]
HVAC,Average, Zone Outdoor Air Unit Total Cooling Rate [W]
HVAC,Sum, Zone Outdoor Air Unit Total Cooling Energy [J]
HVAC,Average, Zone Outdoor Air Unit Sensible Cooling Rate [W]
HVAC,Sum, Zone Outdoor Air Unit Sensible Heating Energy [J]
HVAC,Average, Zone Outdoor Air Unit Fan Electric Power [W]
HVAC,Sum, Zone Outdoor Air Unit Fan Electric Energy [J]
HVAC,Average, Zone Outdoor Air Unit Air Mass Flow Rate [kg/s]
HVAC,Average, Zone Outdoor Air Unit Fan Availability Status []
Zone Outdoor Air Unit Latent Cooling Energy
Zone Outdoor Air Unit Total Heating Rate [W]
This field reports the heating output rate of the outdoor air unit system to the zone it is serving
in Watts. This is determined by outlet and zone air conditions and the mass flow rate through
the zone outdoor air unit.
Zone Outdoor Air Unit Total Heating Energy [J]
This field is the heating output of the outdoor air unit system to the zone it is serving in Joules
over the timestep being reported. This is determined by outlet and zone air conditions, the
mass flow rate through the zone outdoor air unit, and the time step.
Zone Outdoor Air Unit Total Cooling Rate [W]
This field reports the total cooling (sensible plus latent) output rate of the outdoor air unit
system to the zone it is serving in Watts. This is determined by outlet and zone air conditions
and the mass flow rate through the zone outdoor air unit.
Zone Outdoor Air Unit Total Cooling Energy [J]
This field is the total cooling (sensible plus latent) output of the outdoor air unit system to the
zone it is serving in Joules over the timestep being reported. This is determined by outlet and
zone air conditions, the mass flow rate through the zone outdoor air unit, and the time step.

9/29/14

962

Input-Output Reference

Group Zone Forced Air Units

Zone Outdoor Air Unit Sensible Cooling Energy [J]

Zone Outdoor Air Unit Sensible Cooling Rate [W]
These reports are the sensible cooling output rate of the outdoor air unit system to the zone it
is serving in Joules or Watts. This is determined by outlet and zone air conditions and the
mass flow rate through the zone outdoor air unit.
Zone Outdoor Air Unit Sensible Heating Energy [J]
Zone Outdoor Air Unit Sensible Heating Rate [W]
These are the sensible heating output of the outdoor air unit system to the zone it is serving
in Joules or Watts over the timestep being reported. This is determined by outlet and zone air
conditions, the mass flow rate through the zone outdoor air unit, and the time step.
Zone Outdoor Air Unit Latent Cooling Energy [J]
Zone Outdoor Air Unit Latent Cooling Rate [W]
These are the latent cooling output of the outdoor air unit system to the zone it is serving, in
Joules and Watts. This is determined by outlet and zone air conditions, the mass flow rate
through the zone outdoor air unit, and the time step.
Zone Outdoor Air Unit Latent Heating Energy [J]
Zone Outdoor Air Unit Latent Heating Rate [W]
These are the latent heating output of the outdoor air unit system to the zone it is serving, in
Joules and Watts. This is determined by outlet and zone air conditions, the mass flow rate
through the zone outdoor air unit, and the time step.
Zone Outdoor Air Unit Fan Electric Power [W]
This field reports the electric power consumption rate of the fan of the outdoor air unit in
Watts.
Zone Outdoor Air Unit Fan Electric Energy [J]
This field reports the electric power consumed by the fan of the outdoor air unit over the time
step in Joules.
Zone Outdoor Air Unit Air Mass Flow Rate [kg/s]
This field reports the air mass flow rate of the zone outdoor air unit Outdoor Air Unit in
kilograms per second.
Zone Outdoor Air Unit Fan Availability Status []
This is the availability status of the outdoor air unit fan. This status flag is a result of the
calculations
made
by
the
Availability
Manager(s)
listed
in
an
AvailabilityManagerAssignmentList object and/or calculations made by Hybrid Ventilation
Manager object. The AvailabilityManagerAssignmentList is an optional input in the outdoor air
unit object. When a single availability manager is used in an Availability Manager
Assignment List, this is also the availability status reported by the specific availability
manager (Ref. AvailabilityManager:* Outputs). For multiple availability managers in an
Availability Manager Assignment List (with or without Hybrid Ventilation Manager), rules to
determine fan availability status are described in the section Group System Availability
Managers. The control status outputs are represented using integers 0 through 3. These
integers represent NoAction (0), ForceOff (1), CycleOn (2), and CycleOnZoneFansOnly (3).
Since the status output is averaged, the output result may not correspond to the values
described here when output variable frequencies other than detailed are used. Use the
detailed reporting frequency (Ref. Output:Variable object) to view the availability status at
each simulation timestep.
9/29/14

963

Input-Output Reference

Group Zone Forced Air Units

ZoneHVAC:OutdoorAirUnit:EquipmentList
This input syntax is used to specify the components in a zone outdoor air unit. The
components will be simulated in the order in which they occur in this list.
Field: Name
The user designated unique name of an instance of a zone outdoor air unit equipment list.
Field Set (Component Object Type, Component Name, Control Node Name) up to 8
After the identifying name, the list consists of up to 8 pairs of data items.
Field: Component <x> Object Type
This field specifies the keyword for the type of component used.
Field: Component <x> Name
This field is the unique name of the component specified in the previous field. This named
object must appear in the IDF.
Note: If any of the components use the autosized option at the component level, input data for zone sizing
purposes are required for the proper sizing of the components. Please refer to the Sizing:Zone object for
more information.

An example from an IDF:

ZoneHVAC:OutdoorAirUnit:EquipmentList,
Zone5OAUEquip1,
!- Name
Dehumidifier:Desiccant:NoFans, !- Component 1 Object Type
Z5Dessicant,
!- Component 1 Name
HeatExchanger:AirToAir:FlatPlate, !- Component 2 Object Type
Zone5A2AHeat Recovery,
!- Component 2 Name
CoilSystem:Cooling:DX, !- Component 3 Object Type
DX Cooling Coil System 5,!- Component 3 Name
Coil:Heating:Electric,
!- Component 4 Object Type
Zone5DESHCoil;
!- Component 4 Name

ZoneHVAC:WindowAirConditioner
The Window Air Conditioner is a unit of zone equipment made up of other components. Each
window air conditioner consists of an outdoor air mixer, a fan, and a direct expansion (DX)
cooling coil. These components are described elsewhere in this document. The input for a
window air conditioner requires the names of these three pieces of equipment, which are
then specified individually elsewhere in the input. The input for a window air conditioner also
requires the name of an availability schedule, the maximum unit airflow rate, and the
maximum outdoor airflow rate for the unit. The unit is connected to a zone by specifying an
air inlet node, which must be the same as a zone exhaust node; and an air outlet node, which
must be the same as a zone inlet node (ref. ZoneHVAC:EquipmentConnections).
A supply air fan operating mode schedule must also be specified. The supply air fan
operating mode schedule value determines if the supply air fan can run continuously with the
DX coil cycling on/off to match the zone cooling demand or the fan and DX coil can cycle
on/off together to meet the cooling demand. The placement of the supply air fan, in relation to
the DX coil, must also be specified (blow through or draw through). The cooling convergence
tolerance is required, which is the tolerance denoting how closely the window air conditioner
will meet the cooling load. The tolerance is always relative to the zone load (i.e., the unit will
operate to meet the zone load to within the tolerance value times the zone load for each
simulation timestep). Finally, the DX cooling coil type must be specified.

9/29/14

964

Input-Output Reference

Group Zone Forced Air Units

Field: Name
A unique user assigned name for an instance of a window air conditioner unit. Any reference
to this window air conditioner by another object will use this name.
Field: Availability Schedule Name
The name of the schedule (ref: Schedule) that denotes whether the window air conditioner
unit can run during a given time period. A schedule value greater than 0 (usually 1 is used)
indicates that the unit can be on during the time period. A value less than or equal to 0
(usually 0 is used) denotes that the unit must be off for the time period. If this field is blank,
the schedule has values of 1 for all time periods.
Field: Maximum Supply Air Flow Rate
The maximum volumetric airflow rate through the window air conditioner in cubic meters per
second. Since the unit operates by cycling on/off, this is also the design, rated airflow rate of
the unit.
Field: Maximum Outdoor Air Flow Rate
If the window air conditioner uses outdoor air, this field specifies the outdoor air volumetric
flow rate in cubic meters per second. This flow rate should be less than or equal to the
maximum airflow rate. A value of zero specifies no outdoor air. Note that the outdoor airflow
rate is fixed: it cannot change during the simulation
Field: Air Inlet Node Name
The name of the HVAC system node (see Node) from which the window air conditioner
draws its indoor air. This should be one of the zone exhaust nodes for the zone which the
window air conditioner is cooling.
Field: Air Outlet Node Name
The name of the HVAC system node (see Node) to which the window air conditioner sends
its outlet air. This should be one of the inlet air nodes for the zone which is being cooled.
Field: Outdoor Air Mixer Object Type
This field specifies the type of outdoor air mixer used by this window air conditioner unit. The
outdoor air mixer component is part of the window air conditioner compound object. The only
available outdoor air mixer type is:
OutdoorAir:Mixer

Field: Outdoor Air Mixer Name

The name of an outdoor air mixer component which composes part of the window air
conditioner unit. Note that the return air node of the outdoor air mixer should be the same
node as the air inlet node of the window air conditioner. In addition, the outdoor air mixers
mixed air node should be the same as the window air conditioners fan inlet air node (for blow
through) or the air conditioners DX coil inlet node (for draw through)
Field: Supply Air Fan Object Type
This field specifies the type of supply air fan used by window air conditioner. The supply air
fan is part of the window air conditioner compound object. The only valid supply air fan types
are:
Fan:OnOff
Fan:ConstantVolume

Field:Supply Air Fan Name

The name of a constant volume fan component that composes part of the window air
conditioner. Note that the fans maximum flow rate should be the same as the maximum
9/29/14

965

Input-Output Reference

Group Zone Forced Air Units

airflow rate of the window air conditioner. A fan of type Fan:OnOff may be used with either
cycling or continuous fan, and a fan of type Fan:ConstantVolume is used only with
continuous fan (see Supply Air Fan Operating Mode Schedule field below). The fans inlet
node should be the same as the outdoor air mixers mixed air node (for blow through) or the
DX coils outlet node (for draw through). The fans outlet node should be the same as the DX
coils air inlet node (for blow through) or the window air conditioners air outlet node (for draw
through).
Field: Cooling Coil Object Type
This field specifies the type of cooling coil to be modeled for this window air conditioner. The
input requirements for these cooling coil objects are described elsewhere in this document. If
the user wants to control the enhanced dehumidification performance of the Heat Exchanger
Assisted coil type based on zone air humidity level, then the input file must include a
humidistat object (ref. ZoneControl:Humidistat) for the zone being served by this air
conditioner
and
a
high
humidity
set
point
manager
(ref.
SetpointManager:SingleZone:Humidity:Maximum) with the high humidity set point placed on
the outlet node of the heat exchanger assisted cooling coil. Only allowable coil types are:
Coil:Cooling:DX:SingleSpeed
CoilSystem:Cooling:DX:HeatExchangerAssisted

Field: DX Cooling Coil Name

The name of a DX cooling coil component that composes part of the window air conditioner
unit. The DX coil air inlet node should be the same as the fan outlet node (for blow through)
or the outdoor air mixers mixed air node (for draw through). The DX coil air outlet node
should be the same as the window air conditioners air outlet node (for blow through) or the
fans inlet node (for draw through).
Field: Supply Air Fan Operating Mode Schedule Name
This alpha field specifies the name of the supply air fan operating mode schedule. The supply
air fan operating mode may vary during the simulation based on time-of-day or with a change
of season. Schedule values of 0 denote that the supply air fan and the heating or cooling coil
cycle on and off together to meet the heating or cooling load (a.k.a. AUTO fan). Schedule
values other than 0 denote that the supply air fan runs continuously while the heating or
cooling coil cycles to meet the load. If this field is left blank, the model assumes the supply air
fan cycles with the heating or cooling coil throughout the simulation.
Field: Fan Placement
This input field has two choices: BlowThrough or DrawThrough. The first choice stands for
blow through fan. This means that the unit consists of an outdoor air mixer followed by a fan
followed by a DX coil. The fan blows through the DX coil. The second choice stands for
draw through fan. This means that the unit consists of an outdoor air mixer followed by a DX
coil followed by a fan. The fan draws air through the coil.
Field: Cooling Convergence Tolerance
This input field defines the convergence tolerance for the units cooling output. This field
allows the user some control over how closely the air conditioner will control the air-side
conditions. The relative size of this parameter relates directly to the closeness of the control.
A very small value in this field will result in tight control and will probably result in larger
numbers of iterations. A large value in this field will result in looser controls and could result in
unsatisfactory fluctuations in zone air temperature. Initial experience with this parameter
lends to the recommendation of using 0.001 as the starting point.
The window air conditioner is controlled by matching its sensible (temperature) cooling output
to the zone sensible load (demand). Because the performance of the DX coil is frequently
non-linear, the air conditioner model must call the DX coil model several times (iterate) to
determine the proper run time fraction to meet the zone load. The cooling convergence
9/29/14

966

Input-Output Reference

Group Zone Forced Air Units

tolerance is the error tolerance used to terminate the iteration procedure when the following
equation is satisfied:

QZoneLoad QWindowAirConditioner ,out )

QZoneLoad

CoolingConvergenceTolerance

The maximum number of iterations is limited, with a warning message generated if the above
equation is not satisfied within the maximum number of iterations.
Field: Availability Manager List Name
This optional input field is the name of an AvailabilityManagerAssignmentList object. An
Availability Manager Assignment List is a list of Availability Managers giving both Availability
Manager type and name. The availability managers in the list apply to this window air
conditioner or objects fan. If the window air conditioner is available (per the Availability
Schedule Name input field above) and this input field has a valid availability manager
assignment list name, then the availability managers in the list determine when and if the fan
of this window air conditioner object should be on or off.
Field: Design Specification ZoneHVAC Sizing Object Name
This optional input field is the name of a DesignSpecificationZoneHVACSizing object. The
name must correspond to unique name of a DesignSpecification:ZoneHVAC:Sizing object. A
Design Sepcification Zone HVAC Sizing object defines scalable sizing methods for sizing
input fields such as Maximum Air Flow Rate in this Window Air Conditioner zone HVAC
object. The scaled Maximum Air Flow Rate in turn is used to size cooling capacity of the unit.
Following is an example input for the cycling window air conditioner, along with its constituent
components.
ZoneHVAC:WindowAirConditioner,
Zone3WindAC,
FanAndCoilAvailSched,
0.6,
0.05,
Zone3WindACAirInletNode,
Zone3WindACAirOutletNode,
OutdoorAir:Mixer,
Zone3WindACOAMixer,
Fan:ConstantVolume,
Zone3WindACFan,
Zone3WindACDXCoil,
CyclingFanSch,
DrawThrough,
0.001,
Coil:Cooling:DX:SingleSpeed;

!
!
!
!
!
!
!
!
!
!
!
!
!
!
!

Schedule:Compact,
CyclingFanSch,
Fraction,
Through: 12/31,
For: AllDays,
Until: 24:00,
0.0;

!!!!!!-

9/29/14

name of window AC unit

Availability Schedule Name
Maximum Supply Air Flow Rate {m3/s}
Maximum Outdoor Air Flow Rate {m3/s}
Air Inlet Node Name
Air Outlet Node Name
Outdoor Air Mixer Object Type
Outdoor Air Mixer Name
Supply Air Fan Object Type
Fan Name
DX Cooling Coil Name
Supply Air Fan Operation Mode Schedule Name
Fan Placement
Cooling Convergence Tolerance
Cooling Coil Object Type

Name
ScheduleType
Complex Field
Complex Field
Complex Field
Complex Field

#1
#2
#7
#8

967

Input-Output Reference

Group Zone Forced Air Units

OutdoorAir:Mixer,
Zone3WindACOAMixer,
Zone3WindACOAMixerOutletNode,
Zone3WindACOAInNode,
Zone3WindACExhNode,
Zone3WindACAirInletNode;

!
!
!
!
!

Name
Mixed Air Node Name
Outdoor Air Stream Node Name
Relief Air Stream Node Name
Return Air Stream Node Name

Fan:ConstantVolume,
Zone3WindACFan,
FanAndCoilAvailSched,
0.5,
75.0,
0.6,
0.9,
1.0,
Zone3WindACDXOutletNode,
Zone3WindACAirOutletNode;

!
!
!
!
!
!
!
!
!

Name
Availability Schedule Name
Fan Total Efficiency
Pressure Rise {Pa}
Maximum Flow Rate {m3/s}
Motor Efficiency
Motor In Airstream Fraction
Air Inlet Node Name
Air Outlet Node Name

Coil:Cooling:DX:SingleSpeed,
Zone3WindACDXCoil,
!- Name
CoolingCoilAvailSched,
!- Availability Schedule Name
autosize,
!- Rated Total Cooling Capacity {W}
autosize,
!- Rated Sensible Heat Ratio
3.0,
!- Rated COP
autosize,
!- Rated Air Flow Rate {m3/s}
Zone3WindACOAMixerOutletNode, !- Air Inlet Node Name
Zone3WindACDXOutletNode, !- Air Outlet Node Name
WindACCoolCapFT,
!- Total Cooling Capacity Function of Temperature Curve Name
WindACCoolCapFFF,
!- Total Cooling Capacity Function of Flow Fraction Curve Name
WindACEIRFT,
!- Energy Input Ratio Function of Temperature Curve Name
WindACEIRFFF,
!- Energy Input Ratio Function of Flow Fraction Curve Name
WindACPLFFPLR;
!- Part Load Fraction Correlation Curve Name

Window Air Conditioner Outputs

HVAC,Average,Zone Window Air Conditioner Total Cooling Rate [W]
HVAC,Sum,Zone Window Air Conditioner Total Cooling Energy [J]
HVAC,Average,Zone Window Air Conditioner Sensible Cooling Rate [W]
HVAC,Sum,Zone Window Air Conditioner Sensible Cooling Energy [J]
HVAC,Average,Zone Window Air Conditioner Latent Cooling Rate [W]
HVAC,Sum,Zone Window Air Conditioner Latent Cooling Energy [J]
HVAC,Average,Zone Window Air Conditioner Electric Power[W]
HVAC,Sum,Zone Window Air Conditioner Electric Energy [J]
HVAC,Average, Zone Window Air Conditioner Fan Part Load Ratio []
HVAC,Average, Zone Window Air Conditioner Compressor Part Load Ratio []
HVAC,Average,Zone Window Air Conditioner Fan Availability Status []

Zone Window Air Conditioner Total Cooling Rate [W]

This field is the total (sensible and latent) heat extraction rate of the window air conditioner
unit from the zone it is serving in Watts. This is determined by the outlet and zone conditions
and the mass flow rate through the unit.
Zone Window Air Conditioner Total Cooling Energy [J]
This is the total (sensible and latent) heat extraction of the window air conditioner unit from
the zone it is serving in Joules over the timestep being reported. This is determined by outlet
and zone air conditions, the mass flow rate through the unit, and the timestep.
Zone Window Air Conditioner Sensible Cooling Rate [W]
This field reports the moist air sensible heat extraction rate of the window air conditioner unit
from the zone it is serving in Watts. This is determined by the outlet and zone conditions and
the mass flow rate through the unit.

9/29/14

968

Input-Output Reference

Group Zone Forced Air Units

Zone Window Air Conditioner Sensible Cooling Energy [J]

This field reports the moist air sensible heat extraction of the window air conditioner unit from
the zone it is serving in Joules over the timestep being reported. This is determined by the
outlet and zone conditions and the mass flow rate through the unit.
Zone Window Air Conditioner Latent Cooling Rate [W]
This output is the latent heat extraction rate of the window air conditioner unit from the zone it
is serving in Watts. This is determined by the outlet and zone conditions and the mass flow
rate through the unit.
Zone Window Air Conditioner Latent Cooling Energy [J]
This is the latent heat extraction of the window air conditioner unit from the zone it is serving
in Joules over the timestep being reported. This is determined by the outlet and zone
conditions and the mass flow rate through the unit.
Zone Window Air Conditioner Electric Power[W]
This output is the electricity consumption rate of the window air conditioner unit in Watts. The
consumption includes electricity used by the compressor and the fans (indoor supply air fan
and the condenser fan).
Zone Window Air Conditioner Electric Energy [J]
This output is the electricity consumption of the window air conditioner unit in Joules for the
time period being reported. The consumption includes electricity used by the compressor and
the fans (indoor supply air fan and the condenser fan).
Zone Window Air Conditioner Fan Part Load Ratio []
This is the fans part load ratio for the report timestep during which the fan had operated.
Zone Window Air Conditioner Compressor Part Load Ratio []
This is the part load ratio of the report timestep during which the DX unit compressor had
operated.
Zone Window Air Conditioner Fan Availability Status []
This is the availability status of the window air conditioner fan. This status flag is a result of
the
calculations
made
by
the
Availability
Manager(s)
listed
in
an
AvailabilityManagerAssignmentList object and/or calculations made by Hybrid Ventilation
Manager object. The AvailabilityManagerAssignmentList is an optional input in the window air
conditioner object. When a single availability manager is used in an Availability Manager
Assignment List, this is also the availability status reported by the specific availability
manager (Ref. AvailabilityManager:* Outputs). For multiple availability managers in an
Availability Manager Assignment List (with or without Hybrid Ventilation Manager), rules to
determine fan availability status are described in the section Group System Availability
Managers. The control status outputs are represented using integers 0 through 3. These
integers represent NoAction (0), ForceOff (1), CycleOn (2), and CycleOnZoneFansOnly (3).
Since the status output is averaged, the output result may not correspond to the values
described here when output variable frequencies other than detailed are used. Use the
detailed reporting frequency (Ref. Output:Variable object) to view the availability status at
each simulation timestep.
ZoneHVAC:PackagedTerminalAirConditioner
The packaged terminal air conditioner (PTAC) is a compound object made up of other
components. Each PTAC consists of an outdoor air mixer, direct expansion (DX) cooling coil,
heating coil (gas, electric, hot water, or steam) and a supply air fan. While the figure below
shows the PTAC with draw through fan placement, blow through fan placement can also be
modeled by positioning the supply air fan between the outdoor air mixer and the DX cooling
9/29/14

969

Input-Output Reference

Group Zone Forced Air Units

coil. The packaged terminal air conditioner coordinates the operation of these components
and is modeled as a type of zone equipment (Ref. ZoneHVAC:EquipmentList and
ZoneHVAC:EquipmentConnections).

Figure 111. Schematic of a packaged terminal air conditioner with draw through fan placement
Links to the PTACs supply air fan, DX cooling coil, heating coil, and outdoor air mixer
specifications are provided in the air conditioners input syntax. Additional inputs include
supply and outdoor air flow rates during cooling operation, heating operation, and when
neither cooling or heating is required. A description of each input field for the packaged
terminal air conditioner compound object is provided below.
Field: Name
This alpha field defines a unique user-assigned name for an instance of a packaged terminal
air conditioner. Any reference to this air conditioner by another object will use this name.
Field: Availability Schedule Name
This alpha field defines the name of the schedule (ref: Schedule) that denotes whether the air
conditioner operates during a given time period. A schedule value equal to 0 denotes that the
air conditioner must be off for that time period. A value greater than 0 denotes that the air
conditioner is available to operate during that time period. This schedule may be used to
completely disable the air conditioner (all of its coils and the supply air fan) as required. If this
field is blank, the schedule has values of 1 for all time periods.
Field: Air Inlet Node Name
This alpha field defines the name of the HVAC system node from which the air conditioner
draws its inlet air. This node name must be the name of a zone air exhaust node (Ref.
ZoneHVAC:EquipmentConnections).
Field: Air Outlet Node Name
This alpha field defines the name of the HVAC system node to which the air conditioner
sends its outlet air. This node name must be the name of a zone air inlet node (Ref.
ZoneHVAC:EquipmentConnections).

9/29/14

970

Input-Output Reference

Group Zone Forced Air Units

Field: Outdoor Air Mixer Object Type

This field specifies the type of outdoor air mixer used by this PTAC. The outdoor air mixer
component is part of the PTAC unit. The only available outdoor air mixer type is:
OutdoorAir:Mixer

Field: Outdoor Air Mixer Name

This alpha field defines the name of an outdoor air mixer component which composes part of
the PTAC. The return air node of the outdoor air mixer should also be the same node as the
air inlet node of the PTAC. Furthermore, the outdoor air mixers mixed air node should be the
same as the PTACs fan inlet air node (for blow through fan placement) or the PTACs DX
cooling coil inlet node (for draw through fan placement).
Field: Supply Air Flow Rate During Cooling Operation
This numeric field defines the supply air flow rate leaving the air conditioner in cubic meters
per second when the DX cooling coil is operating. Values must be greater than 0 or this field
is autosizable.
Field: Supply Air Flow Rate During Heating Operation
This numeric field defines the supply air flow rate leaving the air conditioner in cubic meters
per second when the heating coil is operating. Values must be greater than 0 or this field is
autosizable.
Field: Supply Air Flow Rate When No Cooling or Heating is Needed
This numeric field defines the supply air flow rate leaving the air conditioner in cubic meters
per second when neither cooling nor heating is required (i.e., DX coil and heater are off but
the supply air fan operates). This field is only used when the air conditioners supply air fan
operating mode schedule specifies continuous fan operation. Values must be greater than or
equal to zero, or this field is autosizable. If the air conditioners supply air fan operating mode
schedule specifies continuous fan operation and this value is set to zero or this field is left
blank, then the model assumes that the supply air flow rate when no cooling/heating is
needed is equal to the supply air flow rate when the cooling or heating coil was last operating
(for cooling operation or heating operation).
Field: Outdoor Air Flow Rate During Cooling Operation
This numeric field defines the outdoor air flow rate through the air conditioner in cubic meters
per second when the DX cooling coil is operating. Values must be greater than or equal to 0,
or this field is autosizable. Note that the outdoor air flow rate during cooling operation is fixed;
it cannot change during the simulation. In addition, the outdoor air flow rate during cooling
operation cannot be greater than the air conditioners supply air volumetric flow rate during
cooling operation.
Field: Outdoor Air Flow Rate During Heating Operation
This numeric field defines the outdoor air flow rate through the air conditioner in cubic meters
per second when the heating coil is operating. Values must be greater than or equal to 0, or
this field is autosizable. Note that the outdoor air flow rate during heating operation is fixed; it
cannot change during the simulation. In addition, the outdoor air flow rate during heating
operation cannot be greater than the air conditioners supply air volumetric flow rate during
heating operation.
Field: Outdoor Air Flow Rate When No Cooling or Heating is Needed
This numeric field defines the outdoor air flow rate through the air conditioner in cubic meters
per second when neither cooling nor heating is required (i.e., cooling and heating coils are off
but the supply air fan operates). Values must be greater than or equal to 0, or this field is
autosizable. Note that the outdoor air flow rate when no cooling/heating is needed is fixed; it
9/29/14

971

Input-Output Reference

Group Zone Forced Air Units

cannot change during the simulation. In addition, the outdoor air flow rate when no
cooling/heating is needed cannot be greater than the air conditioners supply air volumetric
flow rate when no cooling/heating is needed. This field is only used when the air conditioners
supply air fan operating mode schedule specifies continuous fan operation. If the air
conditioners supply air fan operating mode schedule specifies continuous fan operation and
the field Supply air volumetric flow rate when no cooling or heating is needed is set to zero
or is left blank, then the model assumes that the outdoor air flow rate when no
cooling/heating is needed is equal to the outdoor air flow rate when the cooling or heating coil
was last operating (for cooling operation [i.e., Outdoor air Flow rate during cooling operation]
or heating operation [i.e., Outdoor air flow rate during heating operation]) and this field is not
used.
Field: Supply Air Fan Object Type
This alpha field defines the type of fan used by this PTAC. The only valid choices are
Fan:OnOff and Fan:ConstantVolume. A fan of type Fan:OnOff is used with cycling fan
operating mode, and a fan of type Fan:ConstantVolume is used with continuous fan operating
mode (see Supply Air Fan Operating Mode Schedule field below). The input requirements for
these fan objects are described elsewhere in this document.
Field: Supply Air Fan Name
The name of a constant volume fan component that composes part of the PTAC. Note that
the fans maximum flow rate should be greater than or equal to the maximum supply air flow
rate for the PTAC. The fans inlet node should be the same as the outdoor air mixers mixed
air node (for blow through fan placement) or the heating coils outlet node (for draw through
fan placement). The fans outlet node should be the same as the DX cooling coils air inlet
node (for blow through fan placement) or the PTACs air outlet node (for draw through fan
placement).
Field: Heating Coil Object Type
This alpha field defines the type of heating coil to be used by this PTAC. The input
requirements for this heating coil object are described elsewhere in this document. The hot
water flow modulation through the heating coil does not require additional controller or
Controller:WaterCoil object. The parent object (PTAC) itself provides the "controller" function
of modulating water flow. Allowable heating coil types are:
Coil:Heating:Water
Coil:Heating:Electric
Coil:Heating:Gas
Coil:Heating:Steam

Field: Heating Coil Name

This alpha field defines the name of the heating coil used by this PTAC, and this name
should match the name specified in the corresponding heating coil object.
Field: Cooling Coil Object Type
This alpha field defines the type of DX cooling coil used by this PTAC. The input
requirements for these DX cooling coil objects are described elsewhere in this document.
Only allowable coil types are:
Coil:Cooling:DX:SingleSpeed
CoilSystem:Cooling:DX:HeatExchangerAssisted
Coil:Cooling:DX:VariableSpeed

Field: Cooling Coil Name

This alpha field defines the name of the cooling coil used by this PTAC, and this name should
match the name specified in the corresponding DX cooling coil object.

9/29/14

972

Input-Output Reference

Group Zone Forced Air Units

Field: Fan Placement

This alpha field has two choices: BlowThrough or DrawThrough. The first choice stands for
blow through fan. This means that the unit consists of an outdoor air mixer followed by a fan
followed by the DX cooling coil and heating coil. The fan blows through the DX cooling coil
and the heating coil. The second choice stands for draw through fan. This means that the
unit consists of an outdoor air mixer followed by the DX cooling coil and heating coil with the
fan located at the outlet of the PTAC. The fan draws air through the DX cooling coil and the
heating coil. If this field is left blank, the default is draw through.
Note: the packaged terminal air conditioners supply air fan, cooling coil and heating coil
must be connected according to the configuration shown above (Figure 111) for the draw
through fan configuration. The only other valid configuration is with a blow through fan
placement, where the fan is located between the outdoor air mixer and the DX cooling coil.

Field: Supply Air Fan Operating Mode Schedule Name

This alpha field specifies the name of the supply air fan operating mode schedule. The supply
air fan operating mode may vary during the simulation based on time-of-day or with a change
of season. Schedule values of 0 denote that the supply air fan and the heating or cooling coil
cycle on and off together to meet the heating or cooling load (a.k.a. AUTO fan). Schedule
values other than 0 denote that the supply fan runs continuously while the heating or cooling
coil cycles to meet the load.
Field: Availability Manager List Name
This optional input field is the name of an AvailabilityManagerAssignmentList object. An
Availability Manager Assignment List is a list of Availability Managers giving both Availability
Manager type and name. The availability managers in the list apply to this packaged terminal
air conditioner or objects fan. If the packaged terminal air conditioner is available (per the
Availability Schedule Name input field above) and this input field has a valid availability
manager assignment list name, then the availability managers in the list determine when and
if the fan of this packaged terminal air conditioner object should be on or off.
Field: Design Specification ZoneHVAC Sizing Object Name
This optional input field is the name of a DesignSpecificationZoneHVACSizing object. The
name must correspond to unique name of a DesignSpecification:ZoneHVAC:Sizing object. A
Design Sepcification Zone HVAC Sizing object defines scalable sizing methods for sizing
input fields such as Supply Air Flow Rate During Cooling Operation in this Packaged
Terminal Air Conditioner zone HVAC object. The scaled Supply Air Flow Rate in turn is used
to size cooling and heating capacity of the unit.
As shown in the example below, correct specification of the packaged terminal air conditioner
requires the following objects in addition to the compound object itself:
1) Fan (Fan:OnOff or Fan:ConstantVolume)
2) DX

cooling
coil
(Coil:Cooling:DX:SingleSpeed
CoilSystem:Cooling:DX:HeatExchangerAssisted)

3) Heating

coil
(Coil:Heating:Gas,
Coil:Heating:Steam)

Coil:Heating:Electric,

Coil:Heating:Water,

or
or

4) OutdoorAir:Mixer

9/29/14

973

Input-Output Reference

Group Zone Forced Air Units

ZoneHVAC:PackagedTerminalAirConditioner,
Zone2PTAC,
!- Name
FanAndCoilAvailSched,
!- Availability Schedule Name
Zone2PTACAirInletNode,
!- Air Inlet Node Name
Zone2PTACAirOutletNode, !- Air Outlet Node Name
OutdoorAir:Mixer,
!- Outdoor Air Mixer Object Type
Zone2PTACOAMixer,
!- Outdoor Air Mixer Name
autosize,
!- Supply Air Flow Rate During Cooling Operation {m3/s}
autosize,
!- Supply Air Flow Rate During Heating Operation operation {m3/s}
autosize,
!- Supply Air Flow Rate When No Cooling or Heating is Needed {m3/s}
autosize,
!- Outdoor Air Flow Rate During Cooling Operation {m3/s}
autosize,
!- Outdoor Air Flow Rate During Heating Operation {m3/s}
autosize,
!- Outdoor Air Flow Rate When No Cooling or Heating is Needed {m3/s}
Fan:OnOff,
!- Supply Air Fan Object Type
Zone2PTACFan,
!- Supply Air Fan Name
Coil:Heating:Electric,
!- Heating Coil Object Type
Zone2PTACHeatCoil,
!- Heating Coil Name
Coil:Cooling:DX:SingleSpeed, !- Cooling Coil Object Type
Zone2PTACDXCoolCoil,
!- Cooling Coil Name
BlowThrough,
!- Fan Placement
SupplyFanSch;
!- Supply Air Fan Operating Mode Schedule Name

Schedule:Compact,
SupplyFanSch,
Fraction,
Through: 12/31,
For: AllDays,
Until: 7:00,
0.0,
Until: 18:00,
1.0,
Until: 24:00,
0.0;

!!!!!!!!!!-

Name
ScheduleType
Complex Field
Complex Field
Complex Field
Complex Field
Complex Field
Complex Field
Complex Field
Complex Field

#1
#2
#3
#4
#5
#6
#7
#8

OutdoorAir:Mixer,
Zone2PTACOAMixer,
Zone2PTACOAMixerOutletNode,
Zone2PTACOAInNode,
Zone2PTACExhNode,
Zone2PTACAirInletNode;

!!!!!-

Name
Mixed Air Node Name
Outdoor Air Stream Node Name
Relief Air Stream Node Name
Return Air Stream Node Name

Fan:OnOff,
Zone2PTACFan,
FanAndCoilAvailSched,
0.5,
75.0,
autosize,
0.9,
1.0,
Zone2PTACOAMixerOutletNode,
Zone2PTACFanOutletNode;

!!!!!!!!!-

Name
Availability Schedule Name
Fan Total Efficiency
Pressure Rise {Pa}
Maximum Flow Rate{m3/s}
Motor Efficiency
Motor In Airstream Fraction
Air Inlet Node Name
Air Outlet Node Name

9/29/14

974

Input-Output Reference

Group Zone Forced Air Units

Coil:Cooling:DX:SingleSpeed,
Zone2PTACDXCoolCoil,
CoolingCoilAvailSched,
autosize,
autosize,
3.0,
autosize,
Zone2PTACFanOutletNode,
Zone2PTACCoolCoilOutletNode,
HPACCoolCapFT,
HPACCoolCapFFF,
HPACEIRFT,
HPACEIRFFF,
HPACPLFFPLR;

!!!!!!!!!!!!!-

Coil Name
Availability Schedule Name
Rated Total Cooling Capacity (gross) {W}
Rated SHR
Rated COP
Rated Air Volume Flow Rate {m3/s}
Coil Air Inlet Node
Coil Air Outlet Node
Total Cooling Capacity Modifier Curve (function of temperature)
Total Cooling Capacity Modifier Curve (function of flow fraction)
Energy Input Ratio Modifier Curve (function of temperature)
Energy Input Ratio Modifier Curve (function of flow fraction)
Part Load Fraction Correlation (function of part load ratio)

Coil:Heating:Electric,
Zone2PTACHeatCoil,
HeatingCoilAvailSched,
1.0,
autosize,
Zone2PTACCoolCoilOutletNode,
Zone2PTACAirOutletNode;

!!!!!!-

Coil Name
Availability Schedule Name
Efficiency
Nominal Capacity {W}
Air Inlet Node Name
Air Outlet Node Name

Packaged Terminal Air Conditioner (PTAC) Outputs

HVAC,Average,Zone Packaged Terminal
HVAC,Sum,Zone Packaged Terminal Air
HVAC,Average,Zone Packaged Terminal
HVAC,Sum,Zone Packaged Terminal Air
HVAC,Average,Zone Packaged Terminal
HVAC,Sum,Zone Packaged Terminal Air
HVAC,Average,Zone Packaged Terminal
HVAC,Sum,Zone Packaged Terminal Air
HVAC,Average,Zone Packaged Terminal
HVAC,Sum,Zone Packaged Terminal Air
HVAC,Average,Zone Packaged Terminal
HVAC,Sum,Zone Packaged Terminal Air
HVAC,Average,Zone Packaged Terminal
HVAC,Sum,Zone Packaged Terminal Air
HVAC,Average,Zone Packaged Terminal
HVAC,Average,Zone Packaged Terminal
Ratio []
HVAC,Average,Zone Packaged Terminal
[]

Air Conditioner Total Heating Rate [W]

Conditioner Total Heating Energy [J]
Air Conditioner Total Cooling Rate [W]
Conditioner Total Cooling Energy [J]
Air Conditioner Sensible Heating Rate [W]
Conditioner Sensible Heating Energy [J]
Air Conditioner Sensible Cooling Rate [W]
Conditioner Sensible Cooling Energy [J]
Air Conditioner Latent Heating Rate [W]
Conditioner Latent Heating Energy [J]
Air Conditioner Latent Cooling Rate [W]
Conditioner Latent Cooling Energy [J]
Air Conditioner Electric Power [W]
Conditioner Electric Energy [J]
Air Conditioner Fan Part Load Ratio []
Air Conditioner Compressor Part Load
Air Conditioner Fan Availability Status

Zone Packaged Terminal Air Conditioner Total Heating Rate [W]

This output field is the total (enthalpy) heat addition rate of the packaged terminal air
conditioner to the zone it is serving in Watts. This value is calculated using the enthalpy
difference of the air conditioner outlet air and inlet air streams, and the air mass flow rate
through the air conditioner. This value is calculated for each HVAC system timestep being
simulated, and the results (enthalpy addition only) are averaged for the timestep being
reported.
Zone Packaged Terminal Air Conditioner Total Heating Energy [J]
This output field is the total (enthalpy) heat addition of the packaged terminal air conditioner
to the zone it is serving in Joules over the timestep being reported. This value is calculated
using the enthalpy difference of the air conditioner outlet air and inlet air streams, the air
mass flow rate through the air conditioner, and the HVAC simulation timestep. This value is
calculated for each HVAC system timestep being simulated, and the results (enthalpy
addition only) are summed for the timestep being reported.

9/29/14

975

Input-Output Reference

Group Zone Forced Air Units

Zone Packaged Terminal Air Conditioner Total Cooling Rate [W]

This output field is the total (enthalpy) heat extraction rate of the packaged terminal air
conditioner from the zone it is serving in Watts. This value is calculated using the enthalpy
difference of the air conditioner outlet air and inlet air streams, and the air mass flow rate
through the air conditioner. This value is calculated for each HVAC system timestep being
simulated, and the results (enthalpy extraction only) are averaged for the timestep being
reported.
Zone Packaged Terminal Air Conditioner Total Cooling Energy [J]
This output field is the total (enthalpy) heat extraction of the packaged terminal air conditioner
from the zone it is serving in Joules over the timestep being reported. This value is calculated
using the enthalpy difference of the air conditioner outlet air and inlet air streams, the air
mass flow rate through the air conditioner, and the HVAC simulation timestep. This value is
calculated for each HVAC system timestep being simulated, and the results (enthalpy
extraction only) are summed for the timestep being reported.
Zone Packaged Terminal Air Conditioner Sensible Heating Rate [W]
This output field is the sensible heat addition rate of the packaged terminal air conditioner to
the zone it is serving in Watts. This value is calculated using the enthalpy difference of the air
conditioner outlet air and inlet air streams at a constant humidity ratio, and the air mass flow
rate through the air conditioner. This value is calculated for each HVAC system timestep
being simulated, and the results (heating only) are averaged for the timestep being reported.
Zone Packaged Terminal Air Conditioner Sensible Heating Energy [J]
This output field is the sensible heat addition of the packaged terminal air conditioner to the
zone it is serving in Joules over the timestep being reported. This value is calculated using
the enthalpy difference of the air conditioner outlet air and inlet air streams at a constant
humidity ratio, the air mass flow rate through the air conditioner, and the HVAC simulation
timestep. This value is calculated for each HVAC system timestep being simulated, and the
results (heating only) are summed for the timestep being reported.
Zone Packaged Terminal Air Conditioner Sensible Cooling Rate [W]
This output field reports the moist air sensible heat extraction rate of the packaged terminal
air conditioner from the zone it is serving in Watts. This value is calculated using the enthalpy
difference of the air conditioner outlet air and inlet air streams at a constant humidity ratio,
and the air mass flow rate through the air conditioner. This value is calculated for each HVAC
system timestep being simulated, and the results (cooling only) are averaged for the timestep
being reported.
Zone Packaged Terminal Air Conditioner Sensible Cooling Energy [J]
This output field reports the moist air sensible heat extraction of the packaged terminal air
conditioner from the zone it is serving in Joules over the timestep being reported. This value
is calculated using the enthalpy difference of the air conditioner outlet air and inlet air streams
at a constant humidity ratio, the air mass flow rate through the air conditioner, and the HVAC
simulation timestep. This value is calculated for each HVAC system timestep being
simulated, and the results (cooling only) are summed for the timestep being reported.
Zone Packaged Terminal Air Conditioner Latent Heating Rate [W]
This output field is the latent heat addition (humidification) rate of the packaged terminal air
conditioner to the zone it is serving in Watts. This value is calculated as the difference
between the total energy rate and the sensible energy rate provided by the packaged
terminal air conditioner. This value is calculated for each HVAC system timestep being
simulated, and the results (latent heat addition only) are averaged for the timestep being
reported.

9/29/14

976

Input-Output Reference

Group Zone Forced Air Units

Zone Packaged Terminal Air Conditioner Latent Heating Energy [J]

This output field is the latent heat addition (humidification) of the packaged terminal air
conditioner to the zone it is serving in Joules over the timestep being reported. This value is
calculated as the difference between the total energy delivered to the zone and the sensible
energy delivered to the zone by the packaged terminal air conditioner. This value is
calculated for each HVAC system timestep being simulated, and the results (latent heat
addition only) are summed for the timestep being reported.
Zone Packaged Terminal Air Conditioner Latent Cooling Rate [W]
This output field is the latent heat extraction (dehumidification) rate of the packaged terminal
air conditioner from the zone it is serving in Watts. This value is calculated as the difference
between the total energy rate and the sensible energy rate provided by the packaged
terminal air conditioner. This value is calculated for each HVAC system timestep being
simulated, and the results (latent heat extraction only) are averaged for the timestep being
reported.
Zone Packaged Terminal Air Conditioner Latent Cooling Energy [J]
This output field is the latent heat extraction (dehumidification) of the packaged terminal air
conditioner from the zone it is serving in Joules over the timestep being reported. This value
is calculated as the difference between the total energy delivered to the zone and the
sensible energy delivered to the zone by the packaged terminal air conditioner. This value is
calculated for each HVAC system timestep being simulated, and the results (latent heat
extraction only) are summed for the timestep being reported.
Zone Packaged Terminal Air Conditioner Electric Power [W]
This output field is the electricity consumption rate of the packaged terminal air conditioner in
Watts. The consumption includes electricity used by the compressor (including crankcase
heater), fans (indoor supply air fan and the condenser fan), and the heating coil (includes
electricity consumption rate for electric heating coil or parasitic electricity consumption rate for
non-electric coils). This value is calculated for each HVAC system timestep being simulated,
and the results are averaged for the timestep being reported.
Zone Packaged Terminal Air Conditioner Electric Energy [J]
This output field is the electricity consumption of the packaged terminal air conditioner in
Joules for the time period being reported. The consumption includes electricity used by the
compressor (including crankcase heater), fans (indoor supply air fan and the condenser fan),
and the heating coil (includes electricity consumption for electric heating coil or parasitic
electricity consumption for non-electric coils). This value is calculated for each HVAC system
timestep being simulated, and the results are summed for the timestep being reported.
Zone Packaged Terminal Air Conditioner Fan Part Load Ratio []
This output field is the part-load ratio of the fan. The fan part-load ratio is defined as the
average supply air mass flow rate divided by the maximum supply air mass flow rate. The
maximum supply air mass flow rate depends on whether heating, cooling, or no heating or
cooling is required during the timestep. This value is calculated for each HVAC system
timestep being simulated, and the results are averaged for the timestep being reported.
Zone Packaged Terminal Air Conditioner Compressor Part Load Ratio []
This output field is the part-load ratio used by the coils (cooling and heating). Part-load ratio is
defined as the total coil load divided by the coil steady-state capacity. This value is calculated
for each HVAC system timestep being simulated, and the results are averaged for the
timestep being reported.

9/29/14

977

Input-Output Reference

Group Zone Forced Air Units

Zone Packaged Terminal Air Conditioner Fan Availability Status []

This is the availability status of the packaged terminal air conditioner fan. This status flag is a
result of the calculations made by the Availability Manager(s) listed in an
AvailabilityManagerAssignmentList object and/or calculations made by Hybrid Ventilation
Manager object. The AvailabilityManagerAssignmentList is an optional input in the packaged
terminal air conditioner object. When a single availability manager is used in an Availability
Manager Assignment List, this is also the availability status reported by the specific
availability manager (Ref. AvailabilityManager:* Outputs). For multiple availability managers
in an Availability Manager Assignment List (with or without Hybrid Ventilation Manager), rules
to determine fan availability status are described in the section Group System Availability
Managers. The control status outputs are represented using integers 0 through 3. These
integers represent NoAction (0), ForceOff (1), CycleOn (2), and CycleOnZoneFansOnly (3).
Since the status output is averaged, the output result may not correspond to the values
described here when output variable frequencies other than detailed are used. Use the
detailed reporting frequency (Ref. Output:Variable object) to view the availability status at
each simulation timestep.
ZoneHVAC:PackagedTerminalHeatPump
The packaged terminal heat pump (PTHP) is a compound object made up of other
components. Each PTHP consists of an outdoor air mixer, direct expansion (DX) cooling coil,
DX heating coil, supply air fan, and a supplemental heating coil as shown in the figure below.
These individual components are described elsewhere in this document. The packaged
terminal heat pump coordinates the operation of these components and is modeled as a type
of zone equipment (Ref. ZoneHVAC:EquipmentList and ZoneHVAC:EquipmentConnections).

Figure 112. Schematic of a packaged terminal heat pump (draw through fan placement)
Links to the PTHPs supply air fan, DX coils, supplemental heating coil, and outdoor air mixer
specifications are provided in the heat pumps input syntax. Additional inputs include supply
and outdoor air flow rates during cooling operation, heating operation, and when neither
9/29/14

978

Input-Output Reference

Group Zone Forced Air Units

cooling or heating is required. A description of each input field for the packaged terminal heat
pump compound object is provided below.
Field: Name
This alpha field defines a unique user-assigned name for an instance of a packaged terminal
heat pump. Any reference to this heat pump by another object will use this name.
Field: Availability Schedule Name
This alpha field defines the name of the schedule (ref: Schedule) that denotes whether the
heat pump operates during a given time period. A schedule value equal to 0 denotes that the
heat pump must be off for that time period. A value greater than 0 denotes that the heat
pump is available to operate during that time period. This schedule may be used to
completely disable the heat pump (all of its coils and the supply air fan) as required. If this
field is blank, the schedule has values of 1 for all time periods.
Field: Air Inlet Node Name
This alpha field defines the name of the HVAC system node from which the heat pump draws
its inlet air. This node name must be the name of a zone air exhaust node (Ref.
ZoneHVAC:EquipmentConnections).
Field: Air Outlet Node Name
This alpha field defines the name of the HVAC system node to which the heat pump sends its
outlet air. This node name must be the name of a zone air inlet node (Ref.
ZoneHVAC:EquipmentConnections).
Field: Outdoor Air Mixer Object Type
This field specifies the type of outdoor air mixer used by this PTHP. The outdoor air mixer
component is part of the PTHP compound object. The only available outdoor air mixer type
is:
OutdoorAir:Mixer

Field: Outdoor Air Mixer Name

This alpha field defines the name of an outdoor air mixer component which composes part of
the PTHP. Note that the return air node of the outdoor air mixer should also be the same
node as the air inlet node of the PTHP. Furthermore, the outdoor air mixers mixed air node
should be the same as the PTHPs fan inlet air node (for blow through fan placement) or the
PTHPs DX cooling coil inlet node (for draw through fan placement).
Field: Supply Air Flow Rate During Cooling Operation
This numeric field defines the supply air flow rate leaving the heat pump in cubic meters per
second when the DX cooling coil is operating. Values must be greater than 0 or this field is
autosizable.
Field: Supply Air Flow Rate During Heating Operation
This numeric field defines the supply air flow rate leaving the heat pump in cubic meters per
second when the DX heating coil and/or supplemental heater are operating. Values must be
greater than 0 or this field is autosizable.
Field: Supply Air Flow Rate When No Cooling or Heating is Needed
This numeric field defines the supply air flow rate leaving the heat pump in cubic meters per
second when neither cooling or heating is required (i.e., DX coils and supplemental heater
are off but the supply air fan operates). This field is only used when the heat pumps supply
air fan operating mode schedule specifies continuous fan operation. Values must be greater
than or equal to zero, or this field is autosizable. If the heat pumps supply air fan operating
mode schedule specifies continuous fan operation and this value is set to zero or this field is
9/29/14

979

Input-Output Reference

Group Zone Forced Air Units

left blank, then the model assumes that the supply air flow rate when no cooling/heating is
needed is equal to the supply air flow rate when the cooling or heating coil was last operating
(for cooling operation or heating operation).
Field: Outdoor Air Flow Rate During Cooling Operation
This numeric field defines the outdoor air flow rate through the heat pump in cubic meters per
second when the DX cooling coil is operating. Values must be greater than or equal to 0, or
this field is autosizable. Note that the outdoor air flow rate during cooling operation is fixed; it
cannot change during the simulation. In addition, the outdoor air flow rate during cooling
operation cannot be greater than the heat pumps supply air volumetric flow rate during
cooling operation.
Field: Outdoor Air Flow Rate During Heating Operation
This numeric field defines the outdoor air flow rate through the heat pump in cubic meters per
second when the DX heating coil and/or supplemental heater are operating. Values must be
greater than or equal to 0, or this field is autosizable. Note that the outdoor air flow rate
during heating operation is fixed; it cannot change during the simulation. In addition, the
outdoor air flow rate during heating operation cannot be greater than the heat pumps supply
air volumetric flow rate during heating operation.
Field: Outdoor Air Flow Rate When No Cooling or Heating is Needed
This numeric field defines the outdoor air flow rate through the heat pump in cubic meters per
second when neither cooling or heating is required (i.e., DX coils and supplemental heater
are off but the supply air fan operates). Values must be greater than or equal to 0, or this field
is autosizable. Note that the outdoor air flow rate when no cooling/heating is needed is fixed;
it cannot change during the simulation. In addition, the outdoor air flow rate when no
cooling/heating is needed cannot be greater than the heat pumps supply air volumetric flow
rate when no cooling/heating is needed. This field is only used when the heat pumps supply
air fan operating mode schedule specifies continuous fan operation. If the heat pumps supply
air fan operating mode schedule specifies continuous fan operation and the field Supply air
volumetric flow rate when no cooling or heating is needed is set to zero or is left blank, then
the model assumes that the outdoor air flow rate when no cooling/heating is needed is equal
to the outdoor air flow rate when the cooling or heating coil was last operating (for cooling
operation [i.e., Outdoor air flow rate during cooling operation] or heating operation [i.e.,
Outdoor air flow rate during heating operation]) and this field is not used.
Field: Supply Air Fan Object Type
This alpha field defines the type of fan used by this PTHP. The only valid choices are
Fan:OnOff and Fan:ConstantVolume. A fan of type Fan:OnOff may be used with either
cycling or continuous fan operating mode, and a fan of type Fan:ConstantVolume is used
only with continuous fan operating mode (see Supply Air Fan Operating Mode Schedule field
below). The input requirements for these fan objects are described elsewhere in this
document.
Field: Supply Air Fan Name
The name of a constant volume fan component that composes part of the PTHP. Note that
the fans maximum flow rate should be greater than or equal to the maximum supply air flow
rate for the PTHP. The fans inlet node should be the same as the outdoor air mixers mixed
air node (for blow through fan placement) or the DX heating coils outlet node (for draw
through fan placement). The fans outlet node should be the same as the DX cooling coils air
inlet node (for blow through fan placement) or the supplemental heaters air inlet node (for
draw through fan placement).

9/29/14

980

Input-Output Reference

Group Zone Forced Air Units

Field: Heating Coil Object Type

This alpha field defines the type of DX heating coil to be used by this PTHP. The only valid
choice are Coil:Heating:DX:SingleSpeed and Coil:Heating:DX:VariableSpeed. The input
requirements for this DX heating coil object are described elsewhere in this document.
Field: Heating Coil Name
This alpha field defines the name of the DX heating coil used by this PTHP, and this name
should match the name specified in the corresponding DX heating coil object.
Field: Heating Convergence Tolerance
This numeric field defines the convergence tolerance for the units heating output. This field
allows the user some control over how closely the heat pump will control the air-side
conditions. The relative size of this parameter relates directly to the closeness of the control.
A very small value in this field will result in tight control and will probably result in larger
numbers of iterations. A large value in this field will result in looser controls and could result in
unsatisfactory fluctuations in zone air temperature. Initial experience with this parameter
lends to the recommendation of using 0.001 as the starting point.
The heat pump is controlled by matching its sensible (temperature) heating output to the
zone sensible load (demand). Because the performance of the DX heating coil is frequently
non-linear, the heat pump model must call the DX heating coil model several times (iterate) to
determine the proper run time fraction to meet the zone load. The heating convergence
tolerance is the error tolerance used to terminate the iteration procedure when the following
equation is satisfied:

(QZoneLoad

QHeatPump,out )

QZoneLoad

HeatingConvergenceTolerance

The maximum number of iterations is limited, with a warning message generated if the above
equation is not satisfied within the maximum number of iterations.
Field: Minimum Outdoor Dry-Bulb Temperature for Compressor Operation
This numeric field defines the minimum outdoor dry-bulb temperature in degrees Celsius for
PTHP compressor operation. The compressor will not operate (for DX heating or DX cooling)
when outdoor dry-bulb temperatures fall below this value. The minimum value must be
greater than or equal to -20 C. If this field is left blank, the default value is -8C. This
temperature should match the minimum compressor operating temperature specified for the
heat pumps DX heating coil (if they dont match, the highest of the two temperatures will be
the cut-off temperature for compressor operation).
Field: Cooling Coil Object Type
This alpha field defines the type of DX cooling coil used by this PTHP. The input
requirements for these DX cooling coil objects are described elsewhere in this document.
Only allowable coil types are:
Coil:Cooling:DX:SingleSpeed
CoilSystem:Cooling:DX:HeatExchangerAssisted
Coil:Cooling:DX:VariableSpeed

Field: Cooling Coil Name

This alpha field defines the name of the cooling coil used by this PTHP, and this name should
match the name specified in the corresponding DX cooling coil object.

9/29/14

981

Input-Output Reference

Group Zone Forced Air Units

Field: Cooling Convergence Tolerance

This numeric field defines the convergence tolerance for the units cooling output. This field
allows the user some control over how closely the heat pump will control the air-side
conditions. The relative size of this parameter relates directly to the closeness of the control.
A very small value in this field will result in tight control and will probably result in larger
numbers of iterations. A large value in this field will result in looser controls and could result in
unsatisfactory fluctuations in zone air temperature. Initial experience with this parameter
lends to the recommendation of using 0.001 as the starting point.
The heat pump is controlled by matching its sensible (temperature) cooling output to the zone
sensible load (demand). Because the performance of the DX cooling coil is frequently nonlinear, the heat pump model must call the DX cooling coil model several times (iterate) to
determine the proper run time fraction to meet the zone load. The cooling convergence
tolerance is the error tolerance used to terminate the iteration procedure when the following
equation is satisfied:

(QZoneLoad

QHeatPump,out )

QZoneLoad

CoolingConvergenceTolerance

The maximum number of iterations is limited, with a warning message generated if the above
equation is not satisfied within the maximum number of iterations.
Field: Supplemental Heating Coil Object Type
This alpha field defines the type of supplemental heating coil to be used by this PTHP. The
input requirements for these heating coil objects are described elsewhere in this document.
The hot water and steam heating coils require specifying plant loop, branches, and connector
objects to support the heating coils, and are placed on the demand side of the plantloop. The
hot water flow modulation through the supplemental heating coil does not require additional
controller or Controller:WaterCoil object. The parent object (PTHP) itself provides the
"controller" function of modulating water flow. Allowable coil types are:
Coil:Heating:Electric
Coil:Heating:Gas
Coil:Heating:Water
Coil:Heating:Steam

Field: Supplemental Heating Coil Name

This alpha field defines the name of the supplemental heating coil used by this PTHP, and
this name should match the name specified in the corresponding heating coil object.
Field: Maximum Supply Air Temperature from Supplemental Heater
This numeric field defines the maximum supply air temperature in degrees Celsius exiting the
heat pump supplemental heater coil. The supplemental heater will be controlled so that its
supply air temperature does not exceed this value. This field is autosizable.
Field: Maximum Outdoor Dry-Bulb Temperature for Supplemental Heater Operation
This numeric field defines the maximum outdoor dry-bulb temperature in degrees Celsius for
PTHP supplemental heater operation. The supplemental heater will not operate when the
outdoor dry-bulb temperature is above this value. The maximum value must be less than or
equal to 21C. If this field is left blank, the default value is 21C.
Field: Fan Placement
This alpha field has two choices: BlowThough or DrawThrough. The first choice stands for
blow through fan. This means that the unit consists of an outdoor air mixer followed by a fan
followed by the DX coils and supplemental heating coil. The fan blows through the cooling
9/29/14

982

Input-Output Reference

Group Zone Forced Air Units

and heating coils. The second choice stands for draw through fan. This means that the unit
consists of an outdoor air mixer followed by the DX coil(s) followed by a fan, with the
supplemental heater located at the outlet of the fan. The fan draws air through the DX
coil(s). If this field is left blank, the default is draw through.
Note: the packaged terminal heat pumps supply air fan, cooling coil, heating coil and supplementary
heating coil must be connected according to the configuration shown above (Figure 112) for the draw
through fan configuration. The only other valid configuration is with a blow through fan placement, where
the fan is located between the outdoor air mixer and the DX cooling coil.

Field: Supply Air Fan Operating Mode Schedule Name

This alpha field specifies the name of the supply air fan operating mode schedule. The supply
air fan operating mode may vary during the simulation based on time-of-day or with a change
of season. Schedule values of 0 denote that the supply air fan and the heating or cooling coil
cycle on and off together to meet the heating or cooling load (a.k.a. AUTO fan). Schedule
values other than 0 denote that the supply air fan runs continuously while the heating or
cooling coil cycles to meet the load. If this field is left blank, the model assumes the supply air
fan cycles with the heating or cooling coil throughout the simulation.
Field: Availability Manager List Name
This optional input field is the name of an AvailabilityManagerAssignmentList object. An
Availability Manager Assignment List is a list of Availability Managers giving both Availability
Manager type and name. The availability managers in the list apply to this packaged terminal
heat pump or objects fan. If the packaged terminal heat pump is available (per the
Availability Schedule Name input field above) and this input field has a valid availability
manager assignment list name, then the availability managers in the list determine when and
if the fan of this packaged terminal heat pump object should be on or off.
Field: Design Specification ZoneHVAC Sizing Object Name
This optional input field is the name of a DesignSpecificationZoneHVACSizing object. The
name must correspond to unique name of a DesignSpecification:ZoneHVAC:Sizing object. A
Design Sepcification Zone HVAC Sizing object defines scalable sizing methods for sizing
input fields such as Supply Air Flow Rate During Cooling Operation in this PTHP zone HVAC
object. The scaled Supply Air Flow Rate in turn is used to size cooling and heating capacity
of the unit.
As shown in the example below, correct specification of the packaged terminal heat pump
requires the following objects in addition to the compound object itself:
1) Fan (Fan:OnOff or Fan:ConstantVolume)
2) DX

cooling
coil
(Coil:Cooling:DX:SingleSpeed
CoilSystem:Cooling:DX:HeatExchangerAssisted)

or

3) DX heating coil (Coil:Heating:DX:SingleSpeed)

4) Supplemental heating coil (Coil:Heating:Gas or Coil:Heating:Electric)
5) OutdoorAir:Mixer

9/29/14

983

Input-Output Reference

Group Zone Forced Air Units

ZoneHVAC:PackagedTerminalHeatPump,
Zone2PTHP,
!- Name
FanAndCoilAvailSched,
!- Availability Schedule Name
Zone2PTHPAirInletNode,
!- Air Inlet Node Name
Zone2PTHPAirOutletNode, !- Air Outlet Node Name
OutdoorAir:Mixer,
!- Outdoor Air Mixer Object Type
Zone2PTHPOAMixer,
!- Outdoor Air Mixer Name
autosize,
!- Supply Air Flow Rate During Cooling Operation {m3/s}
autosize,
!- Supply Air Flow Rate During Heating Operation {m3/s}
autosize,
!- Supply Air Flow Rate When No Cooling or Heating is Needed {m3/s}
autosize,
!- Outdoor Air Flow Rate During Cooling Operation {m3/s}
autosize,
!- Outdoor Air Flow Rate During Heating Operation {m3/s}
autosize,
!- Outdoor Air Flow Rate When No Cooling or Heating is Needed {m3/s}
Fan:OnOff,
!- Supply Air Fan Object Type
Zone2PTHPFan,
!- Supply Air Fan Name
Coil:Heating:DX:SingleSpeed, !- Heating Coil Object Type
Zone2PTHPDXHeatCoil,
!- Heating Coil Name
0.001,
!- Heating Convergence Tolerance {dimensionless}
2.0,
!- Minimum Outdoor Dry-Bulb Temperature for Compressor Operation {C}
Coil:Cooling:DX:SingleSpeed, !- Cooling Coil Object Type
Zone2PTHPDXCoolCoil,
!- Cooling Coil Name
0.001,
!- Cooling Convergence Tolerance {dimensionless}
Coil:Heating:Electric,
!- Supplemental Heating Coil Object Type
Zone2PTHPSupHeater,
!- Supplemental Heating Coil Name
autosize,
!- Maximum Supply Air Temperature from Supplemental Heater {C}
10.0,
!- Maximum Outdoor Dry-Bulb Temperature for Supplemental Heater Operation {C}
BlowThrough,
!- Fan Placement
CyclingFanSch;
!- Supply Air Fan Operating Mode Schedule Name

Schedule:Compact,
CyclingFanSch,
Fraction,
Through: 12/31,
For: AllDays,
Until: 24:00,
0.0;

!!!!!!-

Name
ScheduleType
Complex Field
Complex Field
Complex Field
Complex Field

OutdoorAir:Mixer,
Zone2PTHPOAMixer,
Zone2PTHPOAMixerOutletNode,
Zone2PTHPOAInNode,
Zone2PTHPExhNode,
Zone2PTHPAirInletNode;

!!!!!-

Name
Mixed Air Node Name
Outdoor Air Stream Node Name
Relief Air Stream Node Name
Return Air Stream Node Name

Fan:OnOff,
Zone2PTHPFan,
FanAndCoilAvailSched,
0.5,
75.0,
autosize,
0.9,
1.0,
Zone2PTHPOAMixerOutletNode,
Zone2PTHPFanOutletNode;

!!!!!!!!!-

Name
Availability Schedule Name
Fan Total Efficiency
Pressure Rise {Pa}
Maximum Flow Rate {m3/s}
Motor Efficiency
Motor In Airstream Fraction
Air Inlet Node Name
Air Outlet Node Name

9/29/14

#1
#2
#7
#8

984

Input-Output Reference
Coil:Cooling:DX:SingleSpeed,
Zone2PTHPDXCoolCoil,
CoolingCoilAvailSched,
autosize,
autosize,
3.0,
autosize,
Zone2PTHPFanOutletNode,
Zone2PTHPCoolCoilOutletNode,
HPACCoolCapFT,
HPACCoolCapFFF,
HPACEIRFT,
HPACEIRFFF,
HPACPLFFPLR;

Group Zone Forced Air Units

!!!!!!!!!!!!!-

Coil Name
Availability Schedule
Rated Total Cooling Capacity (gross) {W}
Rated SHR
Rated COP
Rated Air Volume Flow Rate {m3/s}
Coil Air Inlet Node
Coil Air Outlet Node
Total Cooling Capacity Modifier Curve (function of temperature)
Total Cooling Capacity Modifier Curve (function of flow fraction)
Energy Input Ratio Modifier Curve (function of temperature)
Energy Input Ratio Modifier Curve (function of flow fraction)
Part Load Fraction Correlation (function of part load ratio)

COIL:Heating:DX:SingleSpeed,
Zone2PTHPDXHeatCoil,
!- Coil Name
HeatingCoilAvailSched,
!- Availability Schedule
autosize,
!- Rated Total Heating Capacity {W}
2.75,
!- Rated COP
autosize,
!- Rated Air Volume Flow Rate {m3/s}
Zone2PTHPCoolCoilOutletNode, !- Coil Air Inlet Node
Zone2PTHPDXHeatCoilOutletNode, !- Coil Air Outlet Node
HPACHeatCapFT,
!- Total heating capacity modifier curve (function of temperature)
HPACHeatCapFFF,
!- Total heating capacity modifier curve (function of flow fraction)
HPACHeatEIRFT,
!- Energy input ratio modifier curve (function of temperature)
HPACHeatEIRFFF,
!- Energy input ratio modifier curve (function of flow fraction)
HPACCOOLPLFFPLR,
!- Part load fraction correlation (function of part load ratio)
,
!- Defrost energy input ratio modifier curve (function of temperature)
2.0,
!- Minimum Outdoor Dry-bulb Temperature for Compressor Operation {C}
5.0,
!- Maximum Outdoor Dry-bulb Temperature for Defrost Operation {C}
200.0,
!- Crankcase Heater Capacity {W}
10.0,
!- Maximum Outdoor Dry-bulb Temperature for Crankcase Heater Operation {C}
Resistive,
!- Defrost Strategy
TIMED,
!- Defrost Control
0.166667,
!- Defrost Time Period Fraction
20000;
!- Resistive Defrost Heater Capacity {W}

Coil:Heating:Electric,
Zone2PTHPSupHeater,
!- Name
HeatingCoilAvailSched,
!- Availability Schedule Name
1.0,
!- Efficiency
autosize,
!- Nominal Capacity {W}
Zone2PTHPDXHeatCoilOutletNode, !- Air Inlet Node Name
Zone2PTHPAirOutletNode;
!- Air Outlet Node Name

Packaged Terminal Heat Pump (PTHP) Outputs

HVAC,Average,Zone Packaged Terminal Heat Pump Total Heating Rate [W]
HVAC,Sum,Zone Packaged Terminal Heat Pump Total Heating Energy [J]
HVAC,Average,Zone Packaged Terminal Heat Pump Total Cooling Rate [W]
HVAC,Sum,Zone Packaged Terminal Heat Pump Total Cooling Energy [J]
HVAC,Average,Zone Packaged Terminal Heat Pump Sensible Heating Rate [W]
HVAC,Sum,Zone Packaged Terminal Heat Pump Sensible Heating Energy [J]
HVAC,Average,Zone Packaged Terminal Heat Pump Sensible Cooling Rate [W]
HVAC,Sum,Zone Packaged Terminal Heat Pump Sensible Cooling Energy [J]
HVAC,Average,Zone Packaged Terminal Heat Pump Latent Heating Rate [W]
HVAC,Sum,Zone Packaged Terminal Heat Pump Latent Heating Energy [J]
HVAC,Average,Zone Packaged Terminal Heat Pump Latent Cooling Rate [W]
HVAC,Sum,Zone Packaged Terminal Heat Pump Latent Cooling Energy [J]
HVAC,Average,Zone Packaged Terminal Heat Pump Electric Power [W]
HVAC,Sum,Zone Packaged Terminal Heat Pump Electric Energy [J]
HVAC,Average,Zone Packaged Terminal Heat Pump Fan Part Load Ratio []
HVAC,Average,Zone Packaged Terminal Heat Pump Compressor Part Load Ratio []
HVAC,Average,Zone Packaged Terminal Heat Pump Fan Availability Status []

9/29/14

985

Input-Output Reference

Group Zone Forced Air Units

Zone Packaged Terminal Heat Pump Total Heating Rate [W]

This output field is the total (enthalpy) heat addition rate of the packaged terminal heat pump
to the zone it is serving in Watts. This value is calculated using the enthalpy difference of the
heat pump outlet air and inlet air streams, and the air mass flow rate through the heat pump.
This value is calculated for each HVAC system timestep being simulated, and the results
(enthalpy addition only) are averaged for the timestep being reported.
Zone Packaged Terminal Heat Pump Total Heating Energy [J]
This output field is the total (enthalpy) heat addition of the packaged terminal heat pump to
the zone it is serving in Joules over the timestep being reported. This value is calculated
using the enthalpy difference of the heat pump outlet air and inlet air streams, the air mass
flow rate through the heat pump, and the HVAC simulation timestep. This value is calculated
for each HVAC system timestep being simulated, and the results (enthalpy addition only) are
summed for the timestep being reported.
Zone Packaged Terminal Heat Pump Total Cooling Rate [W]
This output field is the total (enthalpy) heat extraction rate of the packaged terminal heat
pump from the zone it is serving in Watts. This value is calculated using the enthalpy
difference of the heat pump outlet air and inlet air streams, and the air mass flow rate through
the heat pump. This value is calculated for each HVAC system timestep being simulated, and
the results (enthalpy extraction only) are averaged for the timestep being reported.
Zone Packaged Terminal Heat Pump Total Cooling Energy [J]
This output field is the total (enthalpy) heat extraction of the packaged terminal heat pump
from the zone it is serving in Joules over the timestep being reported. This value is calculated
using the enthalpy difference of the heat pump outlet air and inlet air streams, the air mass
flow rate through the heat pump, and the HVAC simulation timestep. This value is calculated
for each HVAC system timestep being simulated, and the results (enthalpy extraction only)
are summed for the timestep being reported.
Zone Packaged Terminal Heat Pump Sensible Heating Rate [W]
This output field is the sensible heat addition rate of the packaged terminal heat pump to the
zone it is serving in Watts. This value is calculated using the enthalpy difference of the heat
pump outlet air and inlet air streams at a constant humidity ratio, and the air mass flow rate
through the heat pump. This value is calculated for each HVAC system timestep being
simulated, and the results (heating only) are averaged for the timestep being reported.
Zone Packaged Terminal Heat Pump Sensible Heating Energy [J]
This output field is the sensible heat addition of the packaged terminal heat pump to the zone
it is serving in Joules over the timestep being reported. This value is calculated using the
enthalpy difference of the heat pump outlet air and inlet air streams at a constant humidity
ratio, the air mass flow rate through the heat pump, and the HVAC simulation timestep. This
value is calculated for each HVAC system timestep being simulated, and the results (heating
only) are summed for the timestep being reported.
Zone Packaged Terminal Heat Pump Sensible Cooling Rate [W]
This output field reports the moist air sensible heat extraction rate of the packaged terminal
heat pump from the zone it is serving in Watts. This value is calculated using the enthalpy
difference of the heat pump outlet air and inlet air streams at a constant humidity ratio, and
the air mass flow rate through the heat pump. This value is calculated for each HVAC system
timestep being simulated, and the results (cooling only) are averaged for the timestep being
reported.

9/29/14

986

Input-Output Reference

Group Zone Forced Air Units

Zone Packaged Terminal Heat Pump Sensible Cooling Energy [J]

This output field reports the moist air sensible heat extraction of the packaged terminal heat
pump from the zone it is serving in Joules over the timestep being reported. This value is
calculated using the enthalpy difference of the heat pump outlet air and inlet air streams at a
constant humidity ratio, the air mass flow rate through the heat pump, and the HVAC
simulation timestep. This value is calculated for each HVAC system timestep being
simulated, and the results (cooling only) are summed for the timestep being reported.
Zone Packaged Terminal Heat Pump Latent Heating Rate [W]
This output field is the latent heat addition (humidification) rate of the packaged terminal heat
pump to the zone it is serving in Watts. This value is calculated as the difference between the
total energy rate and the sensible energy rate provided by the packaged terminal heat pump.
This value is calculated for each HVAC system timestep being simulated, and the results
(latent heat addition only) are averaged for the timestep being reported.
Zone Packaged Terminal Heat Pump Latent Heating Energy [J]
This output field is the latent heat addition (humidification) of the packaged terminal heat
pump to the zone it is serving in Joules over the timestep being reported. This value is
calculated as the difference between the total energy delivered to the zone and the sensible
energy delivered to the zone by the packaged terminal heat pump. This value is calculated
for each HVAC system timestep being simulated, and the results (latent heat addition only)
are summed for the timestep being reported.
Zone Packaged Terminal Heat Pump Latent Cooling Rate [W]
This output field is the latent heat extraction (dehumidification) rate of the packaged terminal
heat pump from the zone it is serving in Watts. This value is calculated as the difference
between the total energy rate and the sensible energy rate provided by the packaged
terminal heat pump. This value is calculated for each HVAC system timestep being
simulated, and the results (latent heat extraction only) are averaged for the timestep being
reported.
Zone Packaged Terminal Heat Pump Latent Cooling Energy [J]
This output field is the latent heat extraction (dehumidification) of the packaged terminal heat
pump from the zone it is serving in Joules over the timestep being reported. This value is
calculated as the difference between the total energy delivered to the zone and the sensible
energy delivered to the zone by the packaged terminal heat pump. This value is calculated
for each HVAC system timestep being simulated, and the results (latent heat extraction only)
are summed for the timestep being reported.
Zone Packaged Terminal Heat Pump Electric Power [W]
This output field is the electricity consumption rate of the packaged terminal heat pump in
Watts. The consumption includes electricity used by the compressor (including crankcase
heater), fans (indoor supply air fan and the condenser fan), and the supplemental heating coil
(if electric). This value is calculated for each HVAC system timestep being simulated, and the
results are averaged for the timestep being reported.
Zone Packaged Terminal Heat Pump Electric Energy [J]
This output field is the electricity consumption of the packaged terminal heat pump in Joules
for the time period being reported. The consumption includes electricity used by the
compressor (including crankcase heater), fans (indoor supply air fan and the condenser fan),
and the supplemental heating coil (if electric). This value is calculated for each HVAC system
timestep being simulated, and the results are summed for the timestep being reported.

9/29/14

987

Input-Output Reference

Group Zone Forced Air Units

Zone Packaged Terminal Heat Pump Fan Part Load Ratio []

This output field is the part-load ratio of the fan. The fan part-load ratio is defined as the
average supply air mass flow rate divided by the maximum supply air mass flow rate. The
maximum supply air mass flow rate depends on whether heating, cooling, or no heating or
cooling is required during the timestep. This value is calculated for each HVAC system
timestep being simulated, and the results are averaged for the timestep being reported.
Zone Packaged Terminal Heat Pump Compressor Part Load Ratio []
This output field is the part-load ratio of the compressor used by the DX coils (cooling and
heating). Compressor part-load ratio is defined as the total coil load divided by the coil
steady-state capacity. This value is calculated for each HVAC system timestep being
simulated, and the results are averaged for the timestep being reported.
Zone Packaged Terminal Heat Pump Fan Availability Status []
This is the availability status of the packaged terminal heat pump fan. This status flag is a
result of the calculations made by the Availability Manager(s) listed in an
AvailabilityManagerAssignmentList object and/or calculations made by Hybrid Ventilation
Manager object. The AvailabilityManagerAssignmentList is an optional input in the packaged
terminal heat pump object. When a single availability manager is used in an Availability
Manager Assignment List, this is also the availability status reported by the specific
availability manager (Ref. AvailabilityManager:* Outputs). For multiple availability managers
in an Availability Manager Assignment List (with or without Hybrid Ventilation Manager), rules
to determine fan availability status are described in the section Group System Availability
Managers. The control status outputs are represented using integers 0 through 3. These
integers represent NoAction (0), ForceOff (1), CycleOn (2), and CycleOnZoneFansOnly (3).
Since the status output is averaged, the output result may not correspond to the values
described here when output variable frequencies other than detailed are used. Use the
detailed reporting frequency (Ref. Output:Variable object) to view the availability status at
each simulation timestep.
ZoneHVAC:RefrigerationChillerSet
The ZoneHVAC:RefrigerationChillerSet object works in conjunction with one or multiple air
chillers, compressor racks, refrigeration systems, or refrigeration secondary system objects
(Ref. Refrigeration:AirChiller Refrigeration:CompressorRack, Refrigeration:System, or
Refrigeration:SecondarySystem) to simulate the performance of a group of air chillers cooling
a single zone. The chiller set model passes information about the zone conditions to
determine the performance of individual chiller coils within the set, thus providing the sensible
and latent heat exchange with the zone environment.
The refrigeration chiller set object inputs include a name, an availability schedule name, the
name of the zone cooled by the chiller set, the air inlet node name, the air outlet node name,
and an extensible list of air chiller names (Ref. Refrigeration:AirChiller).
Field: Name
A unique user-assigned name for an instance of a refrigeration chiller. Any reference to this
refrigeration chiller by another object (may be listed in a Refrigeration:CaseAndWalkInList,
Refrigeration:System, Refrigeration:SecondarySystem, or Refrigeration:CompressorRack)
will use this name.
Field: Availability Schedule Name
The name of the schedule (ref: Schedule) that denotes whether the refrigeration chiller can
operate during a given time period. A schedule value greater than 0 (maximum schedule
value of 1.0 is typically used) indicates that the refrigeration chiller will operate during a given
time period. A value equal to 0 denotes that the case does not operate (everything is OFF:
refrigeration, fans, lights, anti-sweat, etc.). Typically the refrigeration chiller will operate
9/29/14

988

Input-Output Reference

Group Zone Forced Air Units

throughout the day (i.e., the schedule will contain 1 for all time periods); however,
refrigeration chillers require maintenance and/or cleaning and this can be modeled
accordingly using this schedule if desired. If this field is left blank, the default schedule has a
value of 1 for all time periods.
Field: Zone Name
A unique user-assigned name for the zone cooled by this refrigeration chiller. This zone must
represent a conditioned space, that is, it must appear in a ZoneHVAC:EquipmentConnections
object.
Field: Air Inlet Node Name
Not used, reserved for future use. Current version exchanges energy directly with the zone,
external of any air system. (Future: The name of the zone exhaust node (see Node) from
which the refrigeration chiller draws its indoor air. This should be one of the zone exhaust
nodes for the zone cooled by the chiller set.)
Field: Air Outlet Node Name
Not used, reserved for future use. Current version exchanges energy directly with the zone,
external of any air system. (Future: The name of the node where the chiller coil sends its
outlet air, which must be one of the inlet air nodes for the zone which is being cooled.)
Field: Air Chiller #1 Name
The name of the first air chiller that will be used to meet the zone cooling load.
Field: Air Chiller #2 Name
The name of the second air chiller that will be used to meet the zone cooling load.
Field: Air Chiller #3 Name
The name of the third air chiller that will be used to meet the zone cooling load.
Field: Air Chiller #n Name (Extensible list, 20 provided in the IDD)
The name of the nth air chiller that will be used to meet the zone cooling load.
The following is an example input for a refrigeration chiller set.
ZoneHVAC:RefrigerationChillerSet,
SubFreezerChillerSet ,
!- Name
,
!- Availability Schedule Name
SubFreezer,
!- Zone Name
NODE_142,
!- Air Inlet Node Name
NODE_141,
!- Air Outlet Node Name
SubFreezerAirChiller_1,
!- Air Chiller #1 Name
SubFreezerAirChiller_2,
!- Air Chiller #2 Name
SubFreezerAirChiller_3;
!- Air Chiller #3 Name

There are no outputs variables for a ZoneHVAC:RefrigerationChillerSet. Outputs for the

refrigeration impact on any zone are listed in the Group:Refrigeration.
ZoneHVAC:WaterToAirHeatPump
The zone water-to-air heat pump is a compound component consisting of a fan, water-to-air
cooling and heating coils, and a supplemental heating coil. Links to the fan,
WaterToAirHeatPump cooling coil, WaterToAirHeatPump heating coil, and supplementary
heating coil specifications are provided in the heat pumps input data syntax. The heat pump
switches between cooling and heating depending on the zones demand. The load side (air)
of the zone water-to-air heat pump consists of an On/Off fan component, a
WaterToAirHeatPump cooling coil component, a WaterToAirHeatPump heating coil
component, and a Gas or Electric supplemental heating coil component. The source side
9/29/14

989

Input-Output Reference

Group Zone Forced Air Units

(water) of the heat pump is connected to a condenser loop with a heat exchanger (ground
heat exchanger or other type) or a plant loop with a heating source such as a boiler and a
cooling source such as a chiller or cooling tower. The diagram below shows the setup and
connection of the heat pump for the source side and load side for a ground heat exchanger
configuration. Note that on the load side, the WaterToAirHeatPump cooling coil must always
be placed before the WaterToAirHeatPump heating coil.
For this zone heat pump,there are two types of WaterToAirHeatPump coil model allowed:
Coil:Cooling:WaterToAirHeatPump:EquationFit
Coil:Heating:WaterToAirHeatPump:EquationFit
Coil:Cooling:WaterToAirHeatPump:VariableSpeedEquationFit
Coil:Heating:WaterToAirHeatPump:VariableSpeedEquationFit

Figure 113. Zone Water to Air Heat Pump Schematic for a DrawThrough Configuration with Ground Heat
Exchanger

9/29/14

990

Input-Output Reference

Group Zone Forced Air Units

Field: Name
This alpha field contains the identifying name for the zone system heat pump.
Field: Availability Schedule Name
This alpha field defines the name of the schedule (ref: Schedule) that denotes whether the
heat pump operates during a given time period. A schedule value equal to 0 denotes that the
heat pump must be off for that time period. A value greater than 0 denotes that the heat
pump is available to operate during that time period. This schedule may be used to
completely disable the heat pump (all of its coils and the supply air fan) as required. If this
field is blank, the schedule has values of 1 for all time periods.
Field: Air Inlet Node Name
This alpha field contains the name of the HVAC system node from which the heat pump
draws its inlet air. This node must be a zone exhaust node as specified in a
ZoneHVAC:EquipmentConnections object.
Field: Air Outlet Node Name
This alpha field contains the name of the HVAC system node to which the heat pump sends
its outlet air. This node must be a zone inlet node as specified in a
ZoneHVAC:EquipmentConnections object.
Field: Outdoor Air Mixer Object Type
This field specifies the type of outdoor air mixer used by this WaterToAirHeatPump unit. The
outdoor air mixer component is part of the WaterToAirHeatPump compound object. The only
available outdoor air mixer type is:
OutdoorAir:Mixer

Field: Outdoor Air Mixer Name

This alpha field defines the name of an outdoor air mixer component which composes part of
the zone WaterToAirHeatPump. The return air stream node of the outdoor air mixer should
also be the same node as the air inlet node of the WaterToAirHeatPump. Furthermore, the
outdoor air mixers mixed air node should be the same as the WaterToAirHeatPumps fan
inlet air node (for blow through fan placement) or the WaterToAirHeatPumps cooling coil inlet
node (for draw through fan placement).
Field: Supply Air Flow Rate During Cooling Operation
This numeric field defines the supply air flow rate leaving the heat pump in cubic meters per
second when the DX cooling coil is operating. Values must be greater than 0 or this field is
autosizable.
Field: Supply Air Flow Rate During Heating Operation
This numeric field defines the supply air flow rate leaving the heat pump in cubic meters per
second when the DX heating coil and/or supplemental heater are operating. Values must be
greater than 0 or this field is autosizable.
Field: Supply Air Flow Rate When No Cooling or Heating is Needed
This numeric field defines the supply air flow rate leaving the heat pump in cubic meters per
second when neither cooling or heating is required (i.e., DX coils and supplemental heater
are off but the supply air fan operates). This field is only used when the heat pumps supply
air fan operating mode schedule specifies continuous fan operation. Values must be greater
than or equal to zero, or this field is autosizable. If the heat pumps supply air fan operating
mode schedule specifies continuous fan operation and this value is set to zero or this field is
left blank, then the model assumes that the supply air flow rate when no cooling/heating is

9/29/14

991

Input-Output Reference

Group Zone Forced Air Units

needed is equal to the supply air flow rate when the cooling or heating coil was last operating
(for cooling operation or heating operation).
Field: Outdoor Air Flow Rate During Cooling Operation
This numeric field defines the outdoor air flow rate through the heat pump in cubic meters per
second when the DX cooling coil is operating. Values must be greater than or equal to 0, or
this field is autosizable. Note that the outside air flow rate during cooling operation is fixed; it
cannot change during the simulation. In addition, the outside air flow rate during cooling
operation cannot be greater than the heat pumps supply air volumetric flow rate during
cooling operation.
Field: Outdoor Air Flow Rate During Heating Operation
This numeric field defines the outdoor air flow rate through the heat pump in cubic meters per
second when the DX heating coil and/or supplemental heater are operating. Values must be
greater than or equal to 0, or this field is autosizable. Note that the outside air flow rate during
heating operation is fixed; it cannot change during the simulation. In addition, the outside air
flow rate during heating operation cannot be greater than the heat pumps supply air
volumetric flow rate during heating operation.
Field: Outdoor Air Flow Rate When No Cooling or Heating is Needed
This numeric field defines the outdoor air flow rate through the heat pump in cubic meters per
second when neither cooling or heating is required (i.e., DX coils and supplemental heater
are off but the supply air fan operates). Values must be greater than or equal to 0, or this field
is autosizable. Note that the outside air flow rate when no cooling/heating is needed is fixed;
it cannot change during the simulation. In addition, the outside air flow rate when no
cooling/heating is needed cannot be greater than the heat pumps supply air volumetric flow
rate when no cooling/heating is needed. This field is only used when the heat pumps supply
air fan operating mode schedule specifies continuous fan operation. If the heat pumps supply
air fan operating mode schedule specifies continuous fan operation and the field Supply air
volumetric flow rate when no cooling or heating is needed is set to zero or is left blank, then
the model assumes that the outside air flow rate when no cooling/heating is needed is equal
to the outside air flow rate when the cooling or heating coil was last operating (for cooling
operation [i.e., Outside air volumetric flow rate during cooling operation] or heating operation
[i.e., Outside air volumetric flow rate during heating operation]) and this field is not used.
Field: Supply Air Fan Object Type
This alpha field contains the identifying type of supply air fan specified in the heat pump. Fan
type must be Fan:OnOff.
Field: Supply Air Fan Name
This alpha field contains the identifying name given to the heat pump supply air fan, and
should match the name specified in the corresponding fan object.
Field: Heating Coil Object Type
This alpha field contains the identifying type of heating coil specified in the heat pump. The
only
valid
types
are
Coil:Heating:WaterToAirHeatPump:EquationFit
Coil:Heating:WaterToAirHeatPump:VariableSpeedEquationFit..
Field: Heating Coil Name
This alpha field contains the identifying name given to the WaterToAirHeatPump heating coil,
and should match the name specified in the corresponding WaterToAirHeatPump heating coil
object.

9/29/14

992

Input-Output Reference

Group Zone Forced Air Units

Field: Cooling Coil Object Type

This alpha field contains the identifying type of cooling coil specified in the heat pump. The
only
valid
types
are
Coil:Cooling:WaterToAirHeatPump:EquationFit
and
Coil:Cooling:WaterToAirHeatPump:VariableSpeedEquationFit.
Field: Cooling Coil Name
This alpha field contains the identifying name given to the WaterToAirHeatPump cooling coil,
and should match the name specified in the corresponding WaterToAirHeatPump cooling coil
object.
Field: Maximum Cycling Rate
This numeric field contains the maximum on-off cycling rate for the compressor, which occurs
at 50% run time fraction. Suggested values are shown below (Henderson et al. 1999):
Heat Pump Condition Recommended Values
Typical
2.5
Good
2.5
Poor
3.0

Field: Heat Pump Time Constant

This numeric field contains the time constant for the cooling coil's capacity to reach steady
state after startup. Suggested values are shown below (Henderson et al. 1999):
Heat Pump Condition Recommended Values
Typical
60
Good
60
Poor
60

Field: Fraction of On-Cycle Power Use

This numeric field contains the fraction of on-cycle power use to adjust the part load fraction
based on the off-cycle power consumption due to crankcase heaters, controls, fans, and etc.
Suggested value values are below (Henderson et al. 1999):
Heat Pump Condition Recommended Values
Typical
0.01
Good
0.01
Poor
0.03

Field: Heat Pump Fan Delay Time

This numeric field contains the time delay in seconds for the heat pump supply air fan to shut
off after compressor cycle off. This value can be obtained from the manufacturer or the heat
pump catalog. Suggested value is 60 seconds. This value is disregared at times when the
WaterToAirHeatPumps fan operating mode schedule value is greater than 0 (i.e., continuous
fan mode).
Field: Supplemental Heating Coil Object Type
This is the object type of the supplemental heating coil. The hot water and steam heating
coils require specifying plant loop, branches, and connector objects to support the heating
coils, and are placed on the demand side of the plantloop. The hot water flow modulation
through the supplemental heating coil does not require additional controller or
Controller:WaterCoil object. The parent object (Zone Water to Air Heat Pump) itself provides
the "controller" function of modulating water flow. The valid choices are:
Coil:Heating:Electric
Coil:Heating:Gas
Coil:Heating:Water
Coil:Heating:Steam
9/29/14

993

Input-Output Reference

Group Zone Forced Air Units

Field: Supplemental Heating Coil Name

This alpha field contains the identifying name given to the supplemental heating coil, and
should match the name specified in the corresponding supplemental heating coil object.
Field: Maximum Supply Air Temperature from Supplemental Heater
This numeric field defines the maximum allowed supply air temperature exiting the heat pump
supplemental heating coil in degrees Celsius.
Field: Maximum Outdoor Dry-Bulb Temperature for Supplemental Heater Operation
This numeric field defines the outdoor air dry-bulb temperature in degrees Celsius above
which the heat pump supplemental heating coil is disabled. The temperature for this input
field must be less than or equal to 21 C. If this input field is left blank, the default value is
21 C.
Field: Outdoor Dry-Bulb Temperature Sensor Node Name
This alpha field specifies the name of the outdoor node which controls the operation of the
supplemental heating coil. If this field is left blank, the outdoor temperature is based solely on
the weather data. If this field is not blank, the node name specified must also be listed in an
OutdoorAir:Node object where the height of the node is taken into consideration when
calculating outdoor temperature from the weather data. Alternately, the node name must be
specified in an OutdoorAir:NodeList object where the outdoor temperature is taken directly
from the weather data.
Field: Fan Placement
This alpha field has two choices: BlowThrough or DrawThrough. The first choice represents
a blow through system where the supply air fan is before the WaterToAirHeatPump
cooling/heating coil and the supplementary heating coil. The second choice represents a
draw through system where the supply fan is between the WaterToAirHeatPump
cooling/heating coil and the supplementary heating coil. If this input field is left blank, the
default is blow through.
Field: Supply Air Fan Operating Mode Schedule Name
This alpha field specifies the name of the supply air fan operating mode schedule. The supply
air fan operating mode may vary during the simulation based on time-of-day or with a change
of season. Schedule values of 0 denote that the supply air fan and the heating or cooling coil
cycle on and off together to meet the heating or cooling load (a.k.a. AUTO fan). Schedule
values other than 0 denote that the supply air fan runs continuously while the heating or
cooling coil cycles to meet the load. If this field is left blank, the model assumes the supply air
fan cycles with the heating or cooling coil throughout the simulation.
As shown in the example below, correct specifications of the WatertoAirHeatPump requires
specification of the following objects in addition to the ZoneHVAC:WaterToAirHeatPump
object:
On/Off fan
WatertoAirHeatPump cooling coil (EquationFit only)
WatertoAirHeatPump heating coil (EquationFit only)
Supplementary heating coil
Outdoor air mixer
Condenser loop or plant loop demand branches
Field: Availability Manager List Name
This optional input field is the name of an AvailabilityManagerAssignmentList object. An
Availability Manager Assignment List is a list of Availability Managers giving both Availability
Manager type and name. The availability managers in the list apply to this
9/29/14

994

Input-Output Reference

Group Zone Forced Air Units

WatertoAirHeatPump or objects fan. If the WatertoAirHeatPump is available (per the

Availability Schedule Name input field above) and this input field has a valid availability
manager assignment list name, then the availability managers in the list determine when and
if the fan of this WatertoAirHeatPump object should be on or off.
Field: Heat Pump Coil Water Flow Mode
This field specifies the way in which water flow through the heat pump coils will be modeled.
This field is only used when WatertoAirHeatPump:EquationFit coils are used. There are three
options:
Cycling
Constant
CyclingOnDemand
Cycling varies water flow through the coil based on the heat pump Part Load Ratio. This
control method is appropriate for modeling heat pumps that are outfitted with a soleniod valve
which allows water to flow through the coil only when the compressor is active. This is the
default for EnergyPlus V8 and later.
Constant provides a constant water flow regardless of heat pump operation. Remember that
EnergyPlus has two coils (a heating coil and a cooling coil) to approximate the operation of
one coil that can operate in either heating mode or cooling mode. Therefore, when the water
flow mode is constant, there will be full flow through either the heating coil or the cooling coil,
but not both at the same time.
ConstantOnDemand provides full flow through the coil whenever there is a load. When
there is no load, there is zero flow through the coil. This control strategy represents the way
EnergyPlus modeled heat pump water flow prior to Version 8.
Field: Design Specification ZoneHVAC Sizing Object Name
This optional input field is the name of a DesignSpecificationZoneHVACSizing object. The
name must correspond to unique name of a DesignSpecification:ZoneHVAC:Sizing object. A
Design Sepcification Zone HVAC Sizing object defines scalable sizing methods for sizing
input fields such as Supply Air Flow Rate During Cooling Operation in this Water To Air Heat
Pump zone HVAC object. The scaled Supply Air Flow Rate in turn is used to size cooling
and heating capacity of the unit.
Examples of IDF use:

9/29/14

995

Input-Output Reference

Group Zone Forced Air Units

ZoneHVAC:WaterToAirHeatPump,
Zone1WTAHP,
!- Name
FanAndCoilAvailSched,
!- Availability Schedule Name
Zone 1 Outlet Node,
!- Air Inlet Node Name
Zone 1 Inlet Node,
!- Air Outlet Node Name
OutdoorAir:Mixer,
!- Outdoor air mixer object type
Zone 1 Mixer,
!- Outdoor Air Mixer Name
Autosize,
!- Supply Air Flow Rate During Cooling Operation {m3/s}
Autosize,
!- Supply Air Flow Rate During Heating Operation {m3/s}
,
!- Supply Air Flow Rate When No Cooling or Heating is Needed {m3/s}
0.0,
!- Outdoor Air Flow Rate During Cooling Operation {m3/s}
0.0,
!- Outdoor Air Flow Rate During Heating Operation {m3/s}
,
!- Outdoor Air Flow Rate When No Cooling or Heating is Needed {m3/s}
Fan:OnOff,
!- Supply Air Fan Object Type
Zone 1 Fan,
!- Supply Air Fan Name
Coil:Heating:WaterToAirHeatPump:EquationFit, !- Heating Coil Object Type
Sys 1 Heat Pump Heating Mode, !- Heating Coil Name
Coil:Cooling:WaterToAirHeatPump:EquationFit, !- Cooling Coil Object Type
Sys 1 Heat Pump Cooling Mode, !- Cooling Coil Name
2.5,
!- Maximum Cycling Rate
60.0,
!- Heat Pump Time Constant
0.01,
!- Fraction of On-Cycle Power Use
60,
!- Heat Pump Fan Delay Time
Coil:Heating:Gas,
!- Supplemental Heating Coil Object Type
Heat Pump DX Supp Heating Coil 1, !- Supplemental Heating Coil Name
60.0,
!- Maximum Supply Air Temperature from Supplemental Heater {C}
20.0,
!- Maximum Outdoor Dry-Bulb Temperature for Supplemental Heater Operation {C}
Sys 1 Outside Air Inlet Node, !- Outdoor Dry-Bulb Temperature Sensor Node Name
BlowThrough,
!- Fan Placement
CyclingFanSch;
!- Supply Air Fan Operating Mode Schedule Name

Schedule:Compact,
CyclingFanSch,
Fraction,
Through: 12/31,
For: AllDays,
Until: 24:00,
0.0;

!!!!!!-

Name
Schedule Type Limits Name
Field 1
Field 2
Field 3
Field 4

Coil:Heating:WaterToAirHeatPump:EquationFit,
Sys 1 Heat Pump Heating Mode, !- Name
Sys 1 Water to Air Heat Pump Source Side2 Inlet Node,
!- Water Inlet Node Name
Sys 1 Water to Air Heat Pump Source Side2 Outlet Node, !- Water Outlet Node Name
Sys 1 Heating Coil Air Inlet Node,
!- Air Inlet Node Name
Sys 1 SuppHeating Coil Air Inlet Node, !- Air Outlet Node Name
Autosize,
!- Rated Air Flow Rate {m3/s}
Autosize,
!- Rated Water Flow Rate {m3/s}
Autosize,
!- Rated Heating Capacity {W}
4.75,
!- Rated Heating Coefficient of Performance
-1.361311959,
!- Heating Capacity Coefficient 1
-2.471798046,
!- Heating Capacity Coefficient 2
4.173164514,
!- Heating Capacity Coefficient 3
0.640757401,
!- Heating Capacity Coefficient 4
0.0,
!- Heating Capacity Coefficient 5
-2.176941116,
!- Heating Power Consumption Coefficient 1
0.832114286,
!- Heating Power Consumption Coefficient 2
1.570743399,
!- Heating Power Consumption Coefficient 3
0.690793651,
!- Heating Power Consumption Coefficient 4
0.0;
!- Heating Power Consumption Coefficient 5

9/29/14

996

Input-Output Reference

Group Zone Forced Air Units

OutdoorAir:Mixer,
Zone 1 Mixer,
!- Name
Sys 1 Mixed Air Node, !- Mixed Air Node Name
Sys 1 Outside Air Inlet Node, !- Outdoor Air Stream Node Name
Sys 1 Relief Air Outlet Node, !- Relief Air Stream Node Name
Zone 1 Outlet Node; !- Return Air Stream Node Name
Fan:OnOff,
Zone 1 Fan,
!- Name
FanAndCoilAvailSched,
!- Availability Schedule Name
0.7,
!- Fan Total Efficiency
300.0,
!- Pressure Rise {Pa}
Autosize,
!- Maximum Flow Rate {m3/s}
0.9,
!- Motor Efficiency
1.0,
!- Motor In Airstream Fraction
Sys 1 Mixed Air Node,
!- Air Inlet Node Name
Sys 1 Cooling Coil Air Inlet Node; !- Air Outlet Node Name
Coil:Heating:Gas,
Heat Pump DX Supp Heating Coil 1, !- Name
FanAndCoilAvailSched,
!- Availability Schedule Name
0.8,
!- Gas Burner Efficiency
32000,
!- Nominal Capacity {W}
Sys 1 SuppHeating Coil Air Inlet Node, !- Air Inlet Node Name
Zone 1 Inlet Node; !- Air Outlet Node Name

BRANCH,
Gshp Cooling Condenser Branch, !- Name
0, !- Maximum Flow Rate {m3/s}
, !- Pressure Drop Curve Name
Coil:Cooling:WaterToAirHeatPump:ParameterEstimation, !- Component 1 Object Type
Heat Pump Cooling Mode, !- Component 1 Name
Water to Air Heat Pump Source Side1 Inlet Node, !- Component 1 Inlet Node Name
Water to Air Heat Pump Source Side1 Outlet Node, !- Component 1 Outlet Node Name
ACTIVE; !- Component 1 Branch Control Type
BRANCH,
Gshp Heating Condenser Branch, !- Name
0, !- Maximum Flow Rate {m3/s}
, !- Pressure Drop Curve Name
Coil:Heating:WaterToAirHeatPump:ParameterEstimation, !- Component 1 Object Type
Heat Pump Heating Mode, !- Component 1 Name
Water to Air Heat Pump Source Side2 Inlet Node,
!- Component 1 Inlet Node Name
Water to Air Heat Pump Source Side2 Outlet Node, !- Component 1 Outlet Node Name
ACTIVE; !- Component 1 Branch Control Type

Water to Air Heat Pump (ZoneHVAC) Outputs

HVAC,Average,Zone Water to
HVAC,Sum,Zone Water to Air
HVAC,Average,Zone Water to
HVAC,Sum,Zone Water to Air
HVAC,Average,Zone Water to
HVAC,Sum,Zone Water to Air
HVAC,Average,Zone Water to
HVAC,Sum,Zone Water to Air
HVAC,Average,Zone Water to
HVAC,Sum,Zone Water to Air
HVAC,Average,Zone Water to
HVAC,Sum,Zone Water to Air
HVAC,Average,Zone Water to
HVAC,Sum,Zone Water to Air
HVAC,Average,Zone Water to
HVAC,Average,Zone Water to
HVAC,Average,Zone Water to

9/29/14

Air Heat Pump Total Heating Rate [W]

Heat Pump Total Heating Energy [J]
Air Heat Pump Total Cooling Rate [W]
Heat Pump Total Cooling Energy [J]
Air Heat Pump Sensible Heating Rate [W]
Heat Pump Sensible Heating Energy [J]
Air Heat Pump Sensible Cooling Rate [W]
Heat Pump Sensible Cooling Energy [J]
Air Heat Pump Latent Heating Rate [W]
Heat Pump Latent Heating Energy [J]
Air Heat Pump Latent Cooling Rate [W]
Heat Pump Latent Cooling Energy [J]
Air Heat Pump Electric Power [W]
Heat Pump Electric Energy [J]
Air Heat Pump Fan Part Load Ratio []
Air Heat Pump Compressor Part Load Ratio []
Air Heat Pump Fan Availability Status []

997

Input-Output Reference

Group Zone Forced Air Units

Zone Water to Air Heat Pump Total Heating Rate [W]

This output field is the total (enthalpy) heat addition rate of the Water to Air Heat Pump to the
zone it is serving in Watts. This value is calculated using the enthalpy difference of the heat
pump outlet air and inlet air streams, and the air mass flow rate through the heat pump. This
value is calculated for each HVAC system time step being simulated, and the results
(enthalpy addition only) are averaged for the time step being reported.
Zone Water to Air Heat Pump Total Heating Energy [J]
This output field is the total (enthalpy) heat addition of the Water to Air Heat Pump to the
zone it is serving in Joules over the time step being reported. This value is calculated using
the enthalpy difference of the heat pump outlet air and inlet air streams, the air mass flow rate
through the heat pump, and the HVAC simulation time step. This value is calculated for each
HVAC system time step being simulated, and the results (enthalpy addition only) are
summed for the time step being reported.
Zone Water to Air Heat Pump Total Cooling Rate [W]
This output field is the total (enthalpy) heat extraction rate of the Water to Air Heat Pump from
the zone it is serving in Watts. This value is calculated using the enthalpy difference of the
heat pump outlet air and inlet air streams, and the air mass flow rate through the heat pump.
This value is calculated for each HVAC system time step being simulated, and the results
(enthalpy extraction only) are averaged for the time step being reported.
Zone Water to Air Heat Pump Total Cooling Energy [J]
This output field is the total (enthalpy) heat extraction of the Water to Air Heat Pump from the
zone it is serving in Joules over the time step being reported. This value is calculated using
the enthalpy difference of the heat pump outlet air and inlet air streams, the air mass flow rate
through the heat pump, and the HVAC simulation time step. This value is calculated for each
HVAC system time step being simulated, and the results (enthalpy extraction only) are
summed for the time step being reported.
Zone Water to Air Heat Pump Sensible Heating Rate [W]
This output field is the sensible heat addition rate of the Water to Air Heat Pump to the zone it
is serving in Watts. This value is calculated using the enthalpy difference of the heat pump
outlet air and inlet air streams at a constant humidity ratio, and the air mass flow rate through
the heat pump. This value is calculated for each HVAC system time step being simulated,
and the results (heating only) are averaged for the time step being reported.
Zone Water to Air Heat Pump Sensible Heating Energy [J]
This output field is the sensible heat addition of the Water to Air Heat Pump to the zone it is
serving in Joules over the time step being reported. This value is calculated using the
enthalpy difference of the heat pump outlet air and inlet air streams at a constant humidity
ratio, the air mass flow rate through the heat pump, and the HVAC simulation time step. This
value is calculated for each HVAC system time step being simulated, and the results (heating
only) are summed for the time step being reported.
Zone Water to Air Heat Pump Sensible Cooling Rate [W]
This output field reports the moist air sensible heat extraction rate of the Water to Air Heat
Pump from the zone it is serving in Watts. This value is calculated using the enthalpy
difference of the heat pump outlet air and inlet air streams at a constant humidity ratio, and
the air mass flow rate through the heat pump. This value is calculated for each HVAC system
time step being simulated, and the results (cooling only) are averaged for the time step being
reported.

9/29/14

998

Input-Output Reference

Group Zone Forced Air Units

Zone Water to Air Heat Pump Sensible Cooling Energy [J]

This output field reports the moist air sensible heat extraction of the Water to Air Heat Pump
from the zone it is serving in Joules over the time step being reported. This value is
calculated using the enthalpy difference of the heat pump outlet air and inlet air streams at a
constant humidity ratio, the air mass flow rate through the heat pump, and the HVAC
simulation time step. This value is calculated for each HVAC system time step being
simulated, and the results (cooling only) are summed for the time step being reported.
Zone Water to Air Heat Pump Latent Heating Rate [W]
This output field is the latent heat addition (humidification) rate of the Water to Air Heat Pump
to the zone it is serving in Watts. This value is calculated as the difference between the total
energy rate and the sensible energy rate provided by the WaterToAirHP heat pump. This
value is calculated for each HVAC system time step being simulated, and the results (latent
heat addition only) are averaged for the time step being reported.
Zone Water to Air Heat Pump Latent Heating Energy [J]
This output field is the latent heat addition (humidification) of the Water to Air Heat Pump to
the zone it is serving in Joules over the time step being reported. This value is calculated as
the difference between the total energy delivered to the zone and the sensible energy
delivered to the zone by the WaterToAirHP heat pump. This value is calculated for each
HVAC system time step being simulated, and the results (latent heat addition only) are
summed for the time step being reported.
Zone Water to Air Heat Pump Latent Cooling Rate [W]
This output field is the latent heat extraction (dehumidification) rate of the Water to Air Heat
Pump from the zone it is serving in Watts. This value is calculated as the difference between
the total energy rate and the sensible energy rate provided by the WaterToAirHP heat pump.
This value is calculated for each HVAC system time step being simulated, and the results
(latent heat extraction only) are averaged for the time step being reported.
Zone Water to Air Heat Pump Latent Cooling Energy [J]
This output field is the latent heat extraction (dehumidification) of the Water to Air Heat Pump
from the zone it is serving in Joules over the time step being reported. This value is
calculated as the difference between the total energy delivered to the zone and the sensible
energy delivered to the zone by the WaterToAirHP heat pump. This value is calculated for
each HVAC system time step being simulated, and the results (latent heat extraction only)
are summed for the time step being reported.
Zone Water to Air Heat Pump Electric Power [W]
This output field is the electricity consumption rate of the Water to Air Heat Pump in Watts.
The consumption includes electricity used by the compressor (including crankcase heater),
fans (indoor supply air fan and the condenser fan), and the supplemental heating coil (if
electric). This value is calculated for each HVAC system time step being simulated, and the
results are averaged for the time step being reported.
Zone Water to Air Heat Pump Electric Energy [J]
This output field is the electricity consumption of the Water to Air Heat Pump in Joules for the
time period being reported. The consumption includes electricity used by the compressor
(including crankcase heater), fans (indoor supply air fan and the condenser fan), and the
supplemental heating coil (if electric). This value is calculated for each HVAC system time
step being simulated, and the results are summed for the time step being reported.
Zone Water to Air Heat Pump Fan Part Load Ratio []
This output field is the part-load ratio of the fan. The fan part-load ratio is defined as the
average supply air mass flow rate divided by the maximum supply air mass flow rate. The
9/29/14

999

Input-Output Reference

Group Zone Forced Air Units

maximum supply air mass flow rate depends on whether heating, cooling, or no heating or
cooling is required during the time step. This value is calculated for each HVAC system time
step being simulated, and the results are averaged for the time step being reported.
Zone Water to Air Heat Pump Compressor Part Load Ratio []
This output field is the part-load ratio of the compressor used by the DX coils (cooling and
heating). Compressor part-load ratio is defined as the total coil load divided by the coil
steady-state capacity. This value is calculated for each HVAC system time step being
simulated, and the results are averaged for the time step being reported.
Zone Water to Air Heat Pump Fan Availability Status []
This is the availability status of the zone water source heat pump fan. This status flag is a
result of the calculations made by the Availability Manager(s) listed in an
AvailabilityManagerAssignmentList object and/or calculations made by Hybrid Ventilation
Manager object. The AvailabilityManagerAssignmentList is an optional input in the zone
water source heat pump object. When a single availability manager is used in an Availability
Manager Assignment List, this is also the availability status reported by the specific
availability manager (Ref. AvailabilityManager:* Outputs). For multiple availability managers
in an Availability Manager Assignment List (with or without Hybrid Ventilation Manager), rules
to determine fan availability status are described in the section Group System Availability
Managers. The control status outputs are represented using integers 0 through 3. These
integers represent NoAction (0), ForceOff (1), CycleOn (2), and CycleOnZoneFansOnly (3).
Since the status output is averaged, the output result may not correspond to the values
described here when output variable frequencies other than detailed are used. Use the
detailed reporting frequency (Ref. Output:Variable object) to view the availability status at
each simulation timestep.
ZoneHVAC:Dehumidifier:DX
This object can be used for modeling conventional mechanical dehumidifiers. These systems
use a direct expansion (DX) cooling coil to cool and dehumidify an airstream. Heat from the
DX systems condenser section is rejected into the cool/dehumidified airstream, resulting in
warm dry air being supplied from the unit. In EnergyPlus, this object is modeled as a type of
zone equipment (ref. ZoneHVAC:EquipmentList and ZoneHVAC:EquipmentConnections).

Figure 114. Schematic of a mechanical dehumidifier

The model has inputs for water removal, energy factor and air flow rate at rated conditions
(26.7C, 60% RH). Curve objects must be specified to describe performance at off-rated
conditions. A part-load cycling curve input must also be specified to account for inefficiencies
due to cycling. Other inputs including minimum and maximum operating temperatures for
9/29/14

1000

Input-Output Reference

Group Zone Forced Air Units

dehumidifier operation, off-cycle parasitic load, and an input to direct the removed water to a
storage tank.
The model assumes that this equipment dehumidifies and heats the air. If used in tandem
with another system that cools and dehumidifies the zone air, then the zone dehumidifier
should be specified as the lowest cooling priority in the ZoneHVAC:EquipmentList object for
best control of zone temperature and humidity levels (e.g., if there are 3 pieces of equipment
in ZoneHVAC:EquipmentList, then the zone dehumidifier should have Cooling Priority = 3).
With this zone equipment prioritization, the other cooling and dehumidification system would
operate first to meet the temperature setpoint (and possibly meet the high humidity setpoint
as well). If additional dehumidification is needed, then the zone dehumidifier would operate.
The sensible heat generated by the dehumidifier is carried over to the zone air heat balance
for the next HVAC time step.
Field: Name
A unique user-assigned name for an instance of a zone DX dehumidifier unit. Any reference
to this dehumidifier by another object will use this name.
Field: Availability Schedule Name
This alpha field defines the name of the schedule (ref: Schedule) that denotes whether the
dehumidifier operates during a given time period. A schedule value equal to 0 denotes that
the dehumidifier will not operate for that time period. A value greater than 0 denotes that the
dehumidifier is available to operate during that time period. If this field is left blank, the
schedule has a value of 1 for all time periods.
Field: Air Inlet Node Name
This alpha field defines the name of the HVAC system node from which the dehumidifier
draws its inlet air. This node name must be the name of a zone air exhaust node (ref.
ZoneHVAC:EquipmentConnections).
Field: Air Outlet Node Name
This alpha field defines the name of the HVAC system node to which the dehumidifier sends
its outlet air. This node name must be the name of a zone air inlet node (ref.
ZoneHVAC:EquipmentConnections).
Field: Rated Water Removal
This numeric input is the full load water removal rate, in liters per day, at rated conditions (air
entering the dehumidifier at 26.7C [80F] dry-bulb and 60% relative humidity, and air flow
rate as defined by field Rated Air Flow Rate below). This is a required input field and the
entered value must be greater than zero.
Field: Rated Energy Factor
This numeric input is the energy factor (liters of water removed per kWh of electricity
consumed) at rated conditions (air entering the dehumidifier at 26.7C [80F] dry-bulb and
60% relative humidity, and air flow rate as defined by field Rated Air Flow Rate below). This
is a required input field and the entered value must be greater than zero.
Field: Rated Air Flow Rate
This numeric input is the volumetric air flow rate through the dehumidifier, in m 3 per second,
at rated conditions (air entering the dehumidifier at 26.7C [80F] dry-bulb and 60% relative
humidity). This is a required input field and the entered value must be greater than zero.
Field: Water Removal Curve Name
This alpha field defines the name of a biquadratic performance curve (ref: Performance
Curves) that parameterizes the variation of water removal as a function of the dry-bulb
temperature (C) and relative humidity (%) of the air entering the dehumidifier. The output of
9/29/14

1001

Input-Output Reference

Group Zone Forced Air Units

this curve is multiplied by the Rated Water Removal to give the water removal of the
dehumidifier at specific operating conditions (i.e., at temperatures and relative humidity levels
different from the rating point conditions). The curve should be normalized to have the value
of 1.0 at the rating point (air entering the dehumidifier at 26.7C [80F] dry-bulb and 60%
relative humidity, and air flow rate as defined by field Rated Air Flow Rate above).
Field: Energy Factor Curve Name
This alpha field defines the name of a biquadratic performance curve (ref: Performance
Curves) that parameterizes the variation of the energy factor as a function of the dry-bulb
temperature (C) and relative humidity (%) of the air entering the dehumidifier. The output of
this curve is multiplied by the Rated Energy Factor to give the energy factor of the
dehumidifier at specific operating conditions (i.e., at temperatures and relative humidity levels
different from the rating point conditions). The curve should be normalized to have the value
of 1.0 at the rating point (air entering the dehumidifier at 26.7C [80F] dry-bulb and 60%
relative humidity, and air flow rate as defined by field Rated Air Flow Rate above).
Field: Part Load Fraction Correlation Curve Name
This alpha field defines the name of a quadratic or cubic performance curve (ref:
Performance Curves) that parameterizes the variation of electrical power input to the
dehumidifier as a function of the part load ratio (PLR, defined as the water removal load to be
met (kg/s) divided by the dehumidifiers water removal rate (kg/s) at the current operating
conditions). The part load fraction (PLF) correlation accounts for efficiency losses due to
compressor cycling.
The part load fraction correlation should be normalized to a value of 1.0 when the part load
ratio equals 1.0 (i.e., no efficiency losses when the dehumidifier runs continuously for the
simulation timestep). For PLR values between 0 and 1 (0 <= PLR < 1), the following rules
apply:
0.7 <= PLF <= 1.0 and PLF >= PLR
If PLF < 0.7 a warning message is issued, the program resets the PLF value to 0.7, and the
simulation proceeds. The runtime fraction of the dehumidifier is defined as PLR/PLF. If PLF <
PLR, then a warning message is issued and the runtime fraction of the dehumidifier is set to
1.0.
Mechanical dehumidifier typically have long runtimes with minimal compressor cycling. So, a
typical part load fraction correlation might be:
PLF = 0.95 + 0.05(PLR)
If the user wishes to model no efficiency degradation due to compressor cycling, the part load
fraction correlation should be defined as follows:
PLF = 1.0 + 0.0(PLR)
Field: Minimum Dry-Bulb Temperature for Dehumidifier Operation
This numeric field defines the minimum inlet air dry-bulb temperature for dehumidifier
operation. The dehumidifier will not operate if the inlet air temperature is below this value.
This input value must be less than the Maximum Dry-Bulb Temperature for Dehumidifier
Operation, and the default value is 10C.
Field: Maximum Dry-Bulb Temperature for Dehumidifier Operation
This numeric field defines the maximum inlet air dry-bulb temperature for dehumidifier
operation. The dehumidifier will not operate if the inlet air temperature is above this value.
This input value must be greater than the Minimum Dry-Bulb Temperature for Dehumidifier
Operation, and the default value is 35C.
Field: Off-Cycle Parasitic Electric Load
This numeric field contains the off-cycle parasitic electric power in Watts. This is the parasitic
electric power consumed by controls or other electrical devices associated with the
9/29/14

1002

Input-Output Reference

Group Zone Forced Air Units

dehumidifier. This parasitic electric load is consumed whenever the dehumidifier is available
to operate, but is not operating. The model assumed that this parasitic power contributes to
heating the zone air (i.e., affects the zone air heat balance). The minimum value for this field
is 0.0, and the default value is also 0.0 if this field is left blank.
Field: Condensate Collection Water Storage Tank Name
This field is optional. It is used to specify where condensate from the dehumidifier is
collected. If blank or omitted, then any water (condensate) removed is discarded. Enter the
name of a Water Storage Tank (ref. WaterUse:Storage) object defined elsewhere and the
condensate will then be collected in that tank.
Following is an example input for a zone DX dehumidifier object. A ZoneControl:Humidistat
object must also be specified for the zone to which the dehumidifier is connected (connect via
a zone air exhaust node and a zone air inlet node, ref. ZoneHVAC:EquipmentConnections).
ZoneHVAC:Dehumidifier:DX,
North Zone Dehumidifier, !- Name
ON,
!- Availability Schedule Name
Zone3DehumidifierInlet,
!- Air Inlet Node Name
Dehumidifier Outlet Node, !- Air Outlet Node Name
50.16,
!- Rated Water Removal {L/day} (106 pints/day)
3.412,
!- Rated Energy Factor {L/kWh} (7.21 pints/kWh)
0.12036,
!- Rated Air Flow Rate {m3/s} (255 cfm)
ZoneDehumidWaterRemoval, !- Water Removal Curve Name
ZoneDehumidEnergyFactor, !- Energy Factor Curve Name
ZoneDehumidPLFFPLR,
!- Part Load Fraction Correlation Curve Name
10.0, !- Minimum Dry-Bulb Temperature for Compressor Operation {C}
32.0, !- Maximum Dry-Bulb Temperature for Compressor Operation {C}
0.0;
!- Off Cycle Parasitic Electric Load {W}
ZoneControl:Humidistat,
Zone 3 Humidistat,
!- Name
NORTH ZONE,
!- Zone Name
Seasonal Relative Humidity Sch; !- Relative Humidity Setpoint Schedule Name

DX Dehumidifier (ZoneHVAC) Outputs

HVAC,Average,Zone Dehumidifier Sensible Heating Rate [W]
HVAC,Sum,Zone Dehumidifier Sensible Heating Energy [J]
HVAC,Average,Zone Dehumidifier Removed Water Mass Flow Rate [kg/s]
HVAC,Sum,Zone Dehumidifier Removed Water Mass [kg]
HVAC,Average,Zone Dehumidifier Electric Power [W]
HVAC,Sum,Zone Dehumidifier Electric Energy [J]
HVAC,Average,Zone Dehumidifier Off Cycle Parasitic Electric Power [W]
HVAC,Sum,Zone Dehumidifier Off Cycle Parasitic Electric Energy [J]
HVAC,Average,Zone Dehumidifier Part Load Ratio []
HVAC,Average,Zone Dehumidifier Runtime Fraction []
HVAC,Average,Zone Dehumidifier Outlet Air Temperature [C]
If Condensate Collection Water Storage Tank Name is specified:
HVAC,Average,Zone Dehumidifier Condensate Volume Flow Rate [m3/s]
HVAC,Sum,Zone Dehumidifier Condensate Volume [m3]

Zone Dehumidifier Sensible Heating Rate [W]

This output field is the sensible heating rate output of the dehumidifier in Watts. This is
determined by the water removal rate, enthalpy of water evaporation, and the zone
dehumidifier electric power. To reduce simulation time, this heating is carried over to the zone
air heat balance for the next HVAC time step (i.e., it is reported here for the current time step
but actually impacts the zone air heat balance on the following HVAC time step). This value is
9/29/14

1003

Input-Output Reference

Group Zone Forced Air Units

calculated for each HVAC system timestep, and the results are averaged for the timestep
being reported.
Zone Dehumidifier Sensible Heating Energy [J]
This output field is the sensible heating output of the dehumidifier in Joules over the timestep
being reported. This is determined by the water removal rate, enthalpy of water evaporation,
and the zone dehumidifier electric power. To reduce simulation time, this heating is carried
over to the zone air heat balance for the next HVAC time step (i.e., it is reported here for the
current time step but actually impacts the zone air heat balance on the following HVAC time
step). This value is calculated for each HVAC system timestep, and the results are summed
for the timestep being reported.
Zone Dehumidifier Removed Water Mass Flow Rate [kg/s]
This output field is the water removal rate by the dehumidifier in kg/s. This value is calculated
for each HVAC system timestep, and the results are averaged for the timestep being
reported.
Zone Dehumidifier Removed Water Mass [kg]
This output field is the water removed by the dehumidifier in kg. This value is calculated for
each HVAC system timestep, and the results are summed for the timestep being reported.
Zone Dehumidifier Electric Power [W]
Zone Dehumidifier Electric Energy [J]
These outputs are the electric power and electric consumption of the dehumidifier for the time
period being reported. They include all electricity used by the dehumidifier (including off-cycle
electric parasitics). These values are calculated for each HVAC system timestep, and the
results are averaged (power) or summed (consumption) for the timestep being reported. The
electric consumption output is also added to a meter with Resource Type = Electricity, End
Use Key = Cooling, Group Key = System (ref. Output:Meter objects).
Zone Dehumidifier Off Cycle Parasitic Electric Power [W]
Zone Dehumidifier Off Cycle Parasitic Electric Energy [J]
These outputs are the parasitic electric power and electric consumption for controls or other
electrical devices associated with the dehumidifier. This parasitic electric load is consumed
whenever the dehumidifier is available to operate, but is not operating. The model assumes
that this parasitic power contributes to heating the zone air (i.e., affects the zone air heat
balance). These outputs values are included in the Zone Dehumidifier Electric Power and
Zone Dehumidifier Electric Energy output variables.
Zone Dehumidifier Part Load Ratio []
This output field is the part-load ratio for the dehumidifier. Part-load ratio is defined as the
water removal load to be met (kg/s) divided by the dehumidifiers water removal rate (kg/s) at
the current operating conditions. This value is calculated for each HVAC system timestep,
and the results are averaged for the timestep being reported.
Zone Dehumidifier Runtime Fraction []
This output field is the runtime fraction for the dehumidifier. This value is calculated for each
HVAC system timestep, and the results are averaged for the timestep being reported.
Zone Dehumidifier Outlet Air Temperature [C]
This output field is dry-bulb temperature of the air leaving the dehumidifier in Celsius. This
value represents the dry-bulb temperature of the air leaving the dehumidifier when it is
operating. For periods when the dehumidifier is not operating, the outlet air temperature is set

9/29/14

1004

Input-Output Reference

Group Zone Forced Air Units

equal to the inlet air temperature. This value is calculated for each HVAC system timestep,
and the results are averaged for the timestep being reported.
Zone Dehumidifier Condensate Volume Flow Rate [m3/s]
Zone Dehumidifier Condensate Volume [m3]
These outputs are the rate and volume of water removed as condensate by the dehumidifier.
These reports only appear if a water storage tank is named in the input object. The
condensate volume output is also added to a meter with Resource Type = OnSiteWater, End
Use Key = Condensate, Group Key = System (ref. Output:Meter objects).
ZoneHVAC:EnergyRecoveryVentilator
The ZoneHVAC:EnergyRecoveryVentilator - stand alone energy recovery ventilator (ERV) is
a single-zone HVAC component used for exhaust air heat recovery (Figure 115). This
compound object consists of 3 required components: a generic air-to-air heat exchanger (see
object Heat Exchanger:Air to Air:Generic), a supply air fan, and an exhaust air fan (see object
Fan:OnOff).
An optional controller (see object ZoneHVAC:EnergyRecoveryVentilator:Controller) may be
used to simulate economizer (free cooling) operation, modify air flow rates based on high
indoor humidity, or simulate a push-button type economizer controller.

Figure 115. ZoneHVAC:EnergyRecoveryVentilator compound object Schematic

This compound object models the basic operation of supply and exhaust air fans and an airto-air heat exchanger. The stand alone ERV operates whenever the unit is scheduled to be
available (Availability schedule). The stand alone ERV object can be used in conjunction with
an economizer feature whereby heat exchange is suspended whenever free cooling is
available (i.e., air flow is fully bypassed around a fixed-plate heat exchanger or the rotation of
a rotary heat exchanger is stopped). The economizer feature may also be activated based on
a time-of-day schedule. Heat exchange is also suspended when air flow rates through the
heat exchanger are modified in response to a zone humidistat. When an economizer is used
in conjunction with high humidity control, high humidity control has the priority.

9/29/14

1005

Input-Output Reference

Group Zone Forced Air Units

To model a stand alone ERV connected to a single zone, the input data file should include
the following objects:
ZoneHVAC:EnergyRecoveryVentilator
HeatExchanger:AirToAir:SensibleAndLatent
Fan:OnOff (supply air)
Fan:OnOff (exhaust air)
ZoneHVAC:EnergyRecoveryVentilator:Controller (if economizer [free cooling] mode or
high humidity control operation is desired)
ZoneControl:Humidistat (required for high humidity control option)
SetpointManager:Scheduled (if supply air outlet temperature control is used, Ref. Heat
Exchanger:Air to Air:Generic for additional guidance)
ZoneHVAC:EquipmentConnections
ZoneHVAC:EquipmentList
OutdoorAir:NodeList
A description of each input field for this compound object is provided below.
Field: Name
A unique user-assigned name for the stand alone ERV unit. Any reference to this unit by
another object will use this name.
Field: Availability Schedule Name
The name of the schedule (ref: Schedule) that denotes whether the unit can operate during a
given time period. A schedule value greater than 0 (usually 1 is used) indicates that the unit
can operate during the time period. A value less than or equal to 0 (usually 0 is used)
denotes that the unit will not operate. If this field is left blank, the schedule has a value of 1
for all time periods.
Field: Heat Exchanger Name
The user-assigned name corresponding to the air-to-air heat exchanger used in this
compound object. The only allowable type is:.
HeatExchanger:AirToAir:SensibleAndLatent

Field: Supply Air Flow Rate

The supply air flow rate through the ERV unit in cubic meters per second at standard
temperature and pressure (dry air at 20o C drybulb). The program uses local barometric
pressure to account for altitude using the equation for "standard atmospheric" pressure on p
6.1 of the ASHRAE 1997 HOF (SI edition) to initialize the air systems being simulated.
p=101325*(1-2.25577E-05*Z)**5.2559
where p=pressure in Pa and Z=altitude in m
Note that this flow rate must be within the valid air flow range for the heat exchanger (ref:
HeatExchanger:AirToAir:SensibleAndLatent in the Engineering Document). In addition, this
flow rate must be less than or equal to the supply fan air flow rate (Fan:OnOff). If the supply
air flow rate is less than the exhaust air flow rate, the zone infiltration (ref: ZoneInfiltration)
should be specified accordingly (the infiltration induced by imbalanced air flows is not
accounted for automatically). The ERV supply air flow rate may also be autosized using the
ventilation rate per floor area and/or ventilation rate per occupant fields below. When
autosizing, the heat exchanger and fan air flow rates should also be autosized.

9/29/14

1006

Input-Output Reference

Group Zone Forced Air Units

Note: The supply air inlet node specified in the generic heat exchanger object must be an outdoor air node
(ref: OutdoorAir:Node and OutdoorAir:NodeList). The supply air outlet node specified in the generic heat
exchanger object must be a zone air inlet node (ref: ZoneHVAC:EquipmentConnections).

Field: Exhaust Air Flow Rate

The exhaust air flow rate through the ERV unit in cubic meters per second at standard
temperature and pressure (dry air at 20o C drybulb). The program uses local barometric
pressure to account for altitude using the equation for "standard atmospheric" pressure on p
6.1 of the ASHRAE 1997 HOF (SI edition) to initialize the air systems being simulated.
p=101325*(1-2.25577E-05*Z)**5.2559
where p=pressure in Pa and Z=altitude in m
Note that this flow rate must be within the valid air flow range for the heat exchanger (ref:
HeatExchanger:AirToAir:SensibleAndLatent in the Engineering Document). In addition, this
flow rate must be less than or equal to the exhaust fan air flow rate (Fan:OnOff). If the
exhaust air flow rate is greater than the supply air flow rate, the zone infiltration (ref:
ZoneInfiltration) should be specified accordingly (the infiltration induced by imbalanced air
flows is not accounted for automatically). The ERV exhaust air flow rate may also be
autosized using the ventilation rate per floor area and/or ventilation rate per occupant fields
below. When autosizing, the heat exchanger and fan air flow rates should also be autosized.
Note: The exhaust air inlet node specified in the generic heat exchanger object must be a zone air exhaust
node (ref: ZoneHVAC:EquipmentConnections).

Field: Supply Air Fan Name

The name of the supply air fan used in this object. Fan type must be Fan:OnOff.
Field: Exhaust Air Fan Name
The name of the exhaust air fan used in this object. Fan type must be Fan:OnOff.
Field: Controller Name
This optional field specifies the name of the controller used by this compound component if
economizer (free cooling) mode or high humidity control operation is desired. Controller type
must be ZoneHVAC:EnergyRecoveryVentilator:Controller.
Field: Ventilation Rate per Unit Floor Area
This optional numeric field defines the ventilation rate per unit floor area in cubic meters per
second per square meter. This field is only used when the supply and exhaust air flow rates
are autosized.
Field: Ventilation Rate per Occupant
This optional numeric field defines the ventilation rate per occupant in cubic meters per
second per occupant. This field is only used when the supply and exhaust air flow rates are
autosized.
Field: Availability Manager List Name
This optional input field is the name of an AvailabilityManagerAssignmentList object. An
Availability Manager Assignment List is a list of Availability Managers giving both Availability
Manager type and name. The availability managers in the list apply to this Stand Alone ERV
objects fan. If the Stand Alone ERV is available (per the Availability Schedule Name input
field above) and this input field has a valid availability manager assignment list name, then
9/29/14

1007

Input-Output Reference

Group Zone Forced Air Units

the availability managers in the list determine when and if the fan of this Stand Alone ERV
object should be on or off.
Following is an example input for this compound object and associated objects that may be
defined:
ZoneHVAC:EnergyRecoveryVentilator,
Stand Alone ERV 1,
FanAndCoilAvailSched,
OA Heat Recovery 1,
0.05,
0.05,
Stand Alone ERV Supply Fan,
Stand Alone ERV Exhaust Fan,
ERV OA Controller 1;
OutdoorAir:NodeLine,
OutsideAirInletNodes;

!!!!!!!!-

Stand alone ERV name

Availability schedule name
Heat exchanger name
Supply air flow rate {m3/s}
Exhaust air flow rate {m3/s}
Supply air fan name
Exhaust air fan name
ERV controller name

!- 1st Node name or node list name

NodeList,
OutsideAirInletNodes,
!- Node List Name
ERV Outdoor air Inlet Node; !- Node_ID_1

ZoneHVAC:EquipmentConnections,
RESISTIVE ZONE,
!- Zone
Zone1Equipment,
!- List
Zone1Inlets,
!- List
Zone1Exhausts,
!- List
Zone 1 Node,
!- Zone
Zone 1 Outlet Node; !- Zone

Name
Name: Zone Equipment
Name: Zone Inlet Nodes
Name: Zone Exhaust Nodes
Air Node Name
Return Air Node Name

ZoneHVAC:EquipmentList,
Zone1Equipment,
ZoneHVAC:EnergyRecoveryVentilator,
Stand Alone ERV 1,
1,
1;

!- Name
!- KEY--Zone Equipment Type 1
!- Type Name 1
!- Cooling Priority
!- Heating Priority

NodeList,
Zone1Inlets,
Stand Alone ERV Supply Fan Outlet Node;
NodeList,
Zone1Exhausts,
Zone 1 Exhaust Node;

!- Node List Name

!- Node_ID_1

!- Node List Name

!- Node_ID_1

ZoneHVAC:EnergyRecoveryVentilator:Controller,
ERV OA Controller 1,
!- ERV controller name
0.05,
!- Outdoor air flow rate {m3/s}
19.,
!- Temperature high limit {C}
14.,
!- Temperature low limit {C}
0.0,
!- Enthalpy high limit {J/kg}
NoExhaustAirTemperatureLimit,
!- Exhaust air temperature limit
NoExhaustAirEnthalpyLimit; !- Exhaust air enthalpy limit

9/29/14

1008

Input-Output Reference

Group Zone Forced Air Units

HeatExchanger:AirToAir:SensibleAndLatent,
OA Heat Recovery 1,
!- Heat exchanger name
FanAndCoilAvailSched,
!- Availability schedule name
0.05,
!- Nominal supply air flow rate {m3/s}
.76,
!- Sensible effectiveness at 100% airflow heating condition
.68,
!- Latent effectiveness at 100% airflow heating condition
.81,
!- Sensible effectiveness at 75% airflow heating condition
.73,
!- Latent effectiveness at 75% airflow heating condition
.76,
!- Sensible effectiveness at 100% airflow cooling condition
.68,
!- Latent effectiveness at 100% airflow cooling condition
.81,
!- Sensible effectiveness at 75% airflow cooling condition
.73,
!- Latent effectiveness at 75% airflow cooling condition
ERV Outdoor air Inlet Node,
!- Supply air inlet node name
Heat Recovery Outlet Node,
!- Supply air outlet node name
Zone 1 Exhaust Node,
!- Exhaust air inlet node name
Heat Recovery Secondary Outlet Node, !- Exhaust air outlet node name
50.0,
!- Nominal electric power {W}
Yes,
!- Supply air outlet temperature control
Rotary,
!- Heat exchanger type
MinimumExhaustTemperature,
!- Frost control type
1.7;
!- Threshold temperature

Fan:OnOff,
Stand Alone ERV Supply Fan,
FanAndCoilAvailSched,
0.5,
75.0,
0.05,
0.9,
1.0,
Heat Recovery Outlet Node,
Stand Alone ERV Supply Fan Outlet Node;

!!!!!!!!!-

Fan Name
Availability Schedule Name
Fan Total Efficiency
Delta Pressure {Pa}
Max Flow Rate {m3/s}
Motor Efficiency
Motor In Airstream Fraction
Fan_Inlet_Node
Fan_Outlet_Node

Fan:OnOff,
Stand Alone ERV Exhaust Fan,
FanAndCoilAvailSched,
0.5,
75.0,
0.05,
0.9,
1.0,
Heat Recovery Secondary Outlet Node,
Stand Alone ERV Exhaust Fan Outlet Node;

!!!!!!!!!-

Fan Name
Availability Schedule Name
Fan Total Efficiency
Delta Pressure {Pa}
Max Flow Rate {m3/s}
Motor Efficiency
Motor In Airstream Fraction
Fan_Inlet_Node
Fan_Outlet_Node

SetpointManager:Scheduled,
Heat Exhchanger Supply Air Temp Manager, !- Name
Temperature, !- Control variable
Heat Exchanger Supply Air Temp Sch, !- Schedule Name
Heat Exchanger Supply Air Nodes;
!- Name of the set point Node List
NodeList,
Heat Exchanger Supply Air Nodes,
Heat Recovery Outlet Node;

!- Node List Name

!- Node_ID_1

Energy Recovery Ventilator (ERV) (ZoneHVAC) Outputs

HVAC,Average,Zone Ventilator Electric Power[W]
HVAC,Sum,Zone Ventilator Electric Energy [J]
HVAC,Average,Zone Ventilator Total Cooling Rate [W]
HVAC,Sum,Zone Ventilator Total Cooling Energy [J]
HVAC,Average,Zone Ventilator Total Heating Rate [W]
HVAC,Sum,Zone Ventilator Total Heating Energy [J]
HVAC,Average,Zone Ventilator Sensible Cooling Rate [W]
HVAC,Sum,Zone Ventilator Sensible Cooling Energy [J]
HVAC,Average,Zone Ventilator Sensible Heating Rate [W]
9/29/14

1009

Input-Output Reference

Group Zone Forced Air Units

HVAC,Sum,Zone Ventilator Sensible Heating Energy [J]

HVAC,Average,Zone Ventilator Latent Cooling Rate [W]
HVAC,Sum,Zone Ventilator Latent Cooling Energy [J]
HVAC,Average,Zone Ventilator Latent Heating Rate [W]
HVAC,Sum,Zone Ventilator Latent Heating Energy [J]
HVAC,Average,Zone Ventilator Supply Fan Availability Status []

Zone Ventilator Electric Power [W]

This output field is the electric consumption rate of the stand alone energy recovery ventilator
in Watts. This rate includes the electric consumption by the supply air fan, exhaust air fan and
the generic air-to-air heat exchanger.
Zone Ventilator Electric Energy [J]
This output field is the electric consumption of the stand alone energy recovery ventilator in
Joules for the timestep being reported. This value includes the electric consumption by the
supply air fan, exhaust air fan and the generic air-to-air heat exchanger.
Zone Ventilator Total Cooling Rate [W]
This output field is the total (enthalpy) heat extraction rate of the stand alone energy recovery
ventilator from the zone in Watts. This value is calculated using the supply air outlet mass
flow rate, and the enthalpy difference of the supply outlet and exhaust inlet air streams. This
value is calculated for each HVAC system timestep being simulated, and the results
(enthalpy extraction only) are averaged for the timestep being reported.
Zone Ventilator Total Cooling Energy [J]
This output field is the total (enthalpy) heat extraction of the stand alone energy recovery
ventilator from the zone in Joules over the timestep being reported. This value is calculated
using the supply air outlet mass flow rate, the enthalpy difference of the supply outlet and
exhaust inlet air streams, and the HVAC system timestep. This value is calculated for each
HVAC system timestep being simulated, and the results (enthalpy extraction only) are
summed for the timestep being reported.
Zone Ventilator Total Heating Rate [W]
This output field is the total (enthalpy) heat addition rate of the stand alone energy recovery
ventilator to the zone in Watts. This value is calculated using the supply air outlet mass flow
rate, and the enthalpy difference of the supply outlet and exhaust inlet air streams. This value
is calculated for each HVAC system timestep being simulated, and the results (enthalpy
addition only) are averaged for the timestep being reported.
Zone Ventilator Total Heating Energy [J]
This output field is the total (enthalpy) heat addition of the stand alone energy recovery
ventilator to the zone in Joules over the timestep being reported. This value is calculated
using the supply air outlet mass flow rate, the enthalpy difference of the supply outlet and
exhaust inlet air streams, and the HVAC system timestep. This value is calculated for each
HVAC system timestep being simulated, and the results (enthalpy addition only) are summed
for the timestep being reported.
Zone Ventilator Sensible Cooling Rate [W]
This output is the moist air sensible heat extraction rate of the stand alone energy recovery
ventilator from the zone in Watts. This value is calculated using the supply air outlet mass
flow rate, and the enthalpy difference of the supply outlet and exhaust inlet air streams at a
constant humidity ratio. This value is calculated for each HVAC system timestep being
simulated, and the results (cooling only) are averaged for the timestep being reported.

9/29/14

1010

Input-Output Reference

Group Zone Forced Air Units

Zone Ventilator Sensible Cooling Energy [J]

This output is the moist air sensible heat extraction of the stand alone energy recovery
ventilator from the zone in Joules over the timestep being reported. This value is calculated
using the supply air outlet mass flow rate, the enthalpy difference of the supply outlet and
exhaust inlet air streams at a constant humidity ratio, and the HVAC system timestep. This
value is calculated for each HVAC system timestep being simulated, and the results (cooling
only) are summed for the timestep being reported.
Zone Ventilator Sensible Heating Rate [W]
This output is the sensible heat addition rate of the stand alone energy recovery ventilator to
the zone in Watts. This value is calculated using the supply air outlet mass flow rate, and the
enthalpy difference of the supply outlet and exhaust inlet air streams at a constant humidity
ratio. This value is calculated for each HVAC system timestep being simulated, and the
results (heating only) are averaged for the timestep being reported.
Zone Ventilator Sensible Heating Energy [J]
This output is the sensible heat addition of the stand alone energy recovery ventilator to the
zone in Joules over the timestep being reported. This value is calculated using the supply air
outlet mass flow rate, the enthalpy difference of the supply outlet and exhaust inlet air
streams at a constant humidity ratio, and the HVAC system timestep. This value is calculated
for each HVAC system timestep being simulated, and the results (heating only) are summed
for the timestep being reported.
Zone Ventilator Latent Cooling Rate [W]
This output is the latent heat extraction (dehumidification) rate of the stand alone energy
recovery ventilator from the zone in Watts. This value is calculated as the difference between
the total energy rate and the sensible energy rate provided by the stand alone ERV. This
value is calculated for each HVAC system timestep being simulated, and the results (latent
heat extraction only) are averaged for the timestep being reported.
Zone Ventilator Latent Cooling Energy [J]
This output is the latent heat extraction (dehumidification) of the stand alone energy recovery
ventilator from the zone in Joules over the timestep being reported. This value is calculated
as the difference between the total energy delivered to the zone and the sensible energy
delivered to the zone by the stand alone ERV. This value is calculated for each HVAC system
timestep being simulated, and the results (latent heat extraction only) are summed for the
timestep being reported.
Zone Ventilator Latent Heating Rate [W]
This output is the latent heat addition (humidification) rate of the stand alone energy recovery
ventilator to the zone in Watts. This value is calculated as the difference between the total
energy rate and the sensible energy rate provided by the stand alone ERV. This value is
calculated for each HVAC system timestep being simulated, and the results (latent heat
addition only) are averaged for the timestep being reported.
Zone Ventilator Latent Heating Energy [J]
This output is the latent heat addition (humidification) of the stand alone energy recovery
ventilator to the zone in Joules over the timestep being reported. This value is calculated as
the difference between the total energy delivered to the zone and the sensible energy
delivered to the zone by the stand alone ERV. This value is calculated for each HVAC system
timestep being simulated, and the results (latent heat addition only) are summed for the
timestep being reported.

9/29/14

1011

Input-Output Reference

Group Zone Forced Air Units

Zone Ventilator Supply Fan Availability Status []

This is the availability status of the Stand Alone ERV fan. This status flag is a result of the
calculations
made
by
the
Availability
Manager(s)
listed
in
an
AvailabilityManagerAssignmentList object and/or calculations made by Hybrid Ventilation
Manager object. The AvailabilityManagerAssignmentList is an optional input in the Stand
Alone ERV object. When a single availability manager is used in an Availability Manager
Assignment List, this is also the availability status reported by the specific availability
manager (Ref. AvailabilityManager:* Outputs). For multiple availability managers in an
Availability Manager Assignment List (with or without Hybrid Ventilation Manager), rules to
determine fan availability status are described in the section Group System Availability
Managers. The control status outputs are represented using integers 0 through 3. These
integers represent NoAction (0), ForceOff (1), CycleOn (2), and CycleOnZoneFansOnly (3).
Since the status output is averaged, the output result may not correspond to the values
described here when output variable frequencies other than detailed are used. Use the
detailed reporting frequency (Ref. Output:Variable object) to view the availability status at
each simulation timestep.
ZoneHVAC:TerminalUnit:VariableRefrigerantFlow
Zone terminal units with variable refrigerant flow DX coils are used exclusively with variable
refrigerant flow (VRF) air conditioning systems (Ref. AirConditioner:VariableRefrigerantFlow
object). The zone terminal units are connected to a zone using the inlet and exhaust node
names specified in a ZoneHVAC:EquipmentConnections object. The zone exhaust node has
the same name as the terminal unit air inlet node. The zone inlet node has the same name as
the terminal unit air outlet node. The zone terminal unit is also listed in a zones equipment
list and will typically be the first equipment operating for both cooling and heating (i.e.,
Sequence = 1 in the ZoneHVAC:EquipmentList). Other ZoneHVAC equipment may be used
in the same zone and should be sequenced to operate after the zone terminal units (i.e.,
sequence = 2 or higher)
The terminal units operate to satisfy a heating or cooling load in a zone based on a zone
thermostat temperature set point. A direct-expansion (DX) cooling and/or DX heating coil is
specified depending on the operating mode required. Both a DX cooling and DX heating coil
will typically be installed in the terminal unit, however only one may be used if desired.
Outdoor ventilation air is modeled with the use of an optional outside air mixer object. Outside
air may be provided to the zone only when the coil is operating or can be supplied
continuously even when the coil is not operating. A supply air fan is also required and can be
modeled as either draw through or blow through.
Field: Zone Terminal Unit Name
This alpha field defines a unique user-assigned name for an instance of a variable refrigerant
flow zone terminal unit. Any reference to this terminal unit by another object will use this
name. The zone terminal unit name must be specified in a ZoneTerminalUnitList object to
connect this terminal unit to an AirConditioner:VariableRefrigerantFlow object.
Field: Availability Schedule Name
This alpha field defines the name of the schedule (ref: Schedule) that denotes whether the
terminal unit operates during a given time period. A schedule value equal to 0 denotes that
the terminal unit must be off for that time period. A value greater than 0 denotes that the
terminal unit is available to operate during that time period. This schedule may be used to
completely disable the terminal unit as required. If this field is left blank, the schedule has a
value of 1 for all time periods.
Field: Terminal Unit Air Inlet Node Name
This alpha field defines the name of the terminal unit air inlet node. This node name should
be the same as a zone exhaust node (ref: ZoneHVAC:EquipmentConnections).

9/29/14

1012

Input-Output Reference

Group Zone Forced Air Units

Field: Terminal Unit Air Outlet Node Name

This alpha field defines the name of the terminal unit air outlet node. This node name should
be the same as a zone inlet node (ref: ZoneHVAC:EquipmentConnections).
Field: Supply Air Flow Rate During Cooling Operation
This numeric field defines the terminal units operating volumetric air flow rate in cubic meters
per second. This volumetric air flow rate is used when the terminal unit is operating in cooling
mode.
Field: Supply Air Flow Rate When No Cooling is Needed
This numeric field defines the terminal units operating volumetric air flow rate in cubic meters
per second. This volumetric air flow rate is used when the terminal units cooling coil is not
operating and the previous mode was cooling.
Field: Supply Air Flow Rate During Heating Operation
This numeric field defines the terminal units operating volumetric air flow rate in cubic meters
per second. This volumetric air flow rate is used when the terminal unit is operating in heating
mode.
Field: Supply Air Flow Rate When No Heating is Needed
This numeric field defines the terminal units operating volumetric air flow rate in cubic meters
per second. This volumetric air flow rate is used when the terminal units heating coil is not
operating and the previous mode was heating.
Field: Outdoor Air Flow Rate During Cooling Operation
This numeric field defines the outdoor air volumetric air flow rate in cubic meters per second.
This volumetric air flow rate is used when the terminal unit is operating in cooling mode.
Field: Outdoor Air Flow Rate During Heating Operation
This numeric field defines the outdoor air volumetric air flow rate in cubic meters per second.
This volumetric air flow rate is used when the terminal unit is operating in heating mode.
Field: Outdoor Air Flow Rate When No Cooling or Heating is Needed
This numeric field defines the outdoor air volumetric air flow rate in cubic meters per second.
This volumetric air flow rate is used when the terminal unit is not operating in cooling or
heating mode.
Field: Supply Air Fan Operating Mode Schedule Name
This alpha field defines the name of the supply air fan operating mode schedule. Schedule
values equal to 0 denote cycling fan/cycling coil operation. All other schedule values denote
constant fan/cycling coil operation.
Field: Supply Air Fan Placement
This alpha field has two choices: BlowThrough or DrawThrough. If this field is left blank, the
default is blow through.
The first choice stands for blow through fan. This means that the unit consists of a fan
followed by the DX coils. The fan blows through the cooling and heating coils. If an outside
air mixer is used, the fan inlet connects to the outside air mixers mixed air node. If an outside
air mixer is not used, the fan inlet connects to the zone exhaust node. For this configuration,
the fan outlet always connects to the DX cooling coil inlet node (or if a DX cooling coil is not
used, the DX heating coil inlet node).
The second choice stands for draw through fan. This means that the unit consists of the DX
coil(s) followed by a fan. The fan draws air through the DX coil(s). In this case the fan inlet

9/29/14

1013

Input-Output Reference

Group Zone Forced Air Units

always connects to the DX heating coil outlet node (or if a DX heating coil is not use, the DX
cooling coil outlet node) and the fan outlet node always connects to the zone inlet node.
Field: Supply Air Fan Object Type
This choice field contains the identifying type of supply air fan specified for the furnace. Fan
type must be Fan:OnOff or Fan:ConstantVolume. Fan:ConstantVolume is used when the
Supply Air Fan Operating Mode Schedule values are never 0 and the fan operates
continuously. Fan:OnOff is used when the fan cycles on and off with the cooling or heating
coil (i.e. Supply Air Fan Operating Mode Schedule values are at times 0).
Field: Supply Air Fan Object Name
This alpha field defines the name of the terminal units supply air fan.
Field: Outside Air Mixer Object Type
This alpha field contains the identifying type of outside air mixer specified for the terminal
unit. Outside air mixer type must be OutsideAir:Mixer. This field should be left blank when
an outside air mixer is not simulated.
Field: Outside Air Mixer Object Name
This alpha field defines the name of the terminal units outside air mixer. If this field is left
blank, an outside air mixer is not simulated.
Field: DX Cooling Coil Object Type
This choice field contains the identifying type of the terminal units DX cooling coil. The only
valid DX cooling coil type is Coil:Cooling:DX:VariableRefrigerantFlow. This field should be
left blank when a DX cooling coil is not simulated.
Field: DX Cooling Coil Name
This alpha field defines the name of the terminal units DX cooling coil. If this field is left
blank, a DX cooling coil is not simulated.
Field: DX Heating Coil Object Type
This choice field contains the identifying type of the terminal units DX heating coil. The only
valid DX heating coil type is Coil:Heating:DX:VariableRefrigerantFlow. This field should be
left blank when a DX heating coil is not simulated.
Field: DX Heating Coil Object Name
This alpha field defines the name of the terminal units DX heating coil. This field should be
left blank when a DX heating coil is not simulated.
Field: Zone Terminal Unit On Parasitic Electric Energy Use
This numeric field defines the parasitic electrical energy use of the zone terminal unit when
either terminal unit coil is operating. When in cooling mode, this electric energy use is
reported in a zone terminal unit cooling electric consumption output variable. When in heating
mode, this electric energy use is reported in a zone terminal unit heating electric consumption
output variable.
Field: Zone Terminal Unit Off Parasitic Electric Energy Use
This numeric field defines the parasitic electrical energy use of the zone terminal unit when
the terminal unit coil(s) is not operating. When the previous mode was cooling, this electric
energy use is reported in a zone terminal unit cooling electric consumption output variable.
When the previous mode was heating, this electric energy use is reported in a zone terminal
unit heating electric consumption output variable.

9/29/14

1014

Input-Output Reference

Group Zone Forced Air Units

Field: Rated Total Heating Capacity Sizing Ratio

This numeric field defines the ratio of the heating coil to cooling coil size when autosizing is
used. The model assumes that when used, this value will be greater than 1. This field
supersedes the Rated Total Heating Capacity Sizing Ratio entered in the
AirConditioner:VariableRefrigerantFlow object. If this field is left blank, the value entered in
the parent object is used for sizing. If neither field is used, the sizing ratio is assumed to be 1.
Field: Availability Manager List Name
This optional input field is the name of an AvailabilityManagerAssignmentList object. An
Availability Manager Assignment List is a list of Availability Managers giving both Availability
Manager type and name. The availability managers in the list apply to this Zone Terminal Unit
objects fan. If the Zone Terminal Unit is available (per the Availability Schedule Name input
field above) and this input field has a valid availability manager assignment list name, then
the availability managers in the list determine when and if the fan of this Zone Terminal Unit
object should be on or off.
Field: Design Specification ZoneHVAC Sizing Object Name
This optional input field is the name of a DesignSpecificationZoneHVACSizing object. The
name must correspond to unique name of a DesignSpecification:ZoneHVAC:Sizing object. A
Design Sepcification Zone HVAC Sizing object defines scalable sizing methods for sizing
input fields such as Supply Air Flow Rate During Cooling Operation in this VRF terminal unit
zone HVAC object. The scaled Supply Air Flow Rate in turn is used to size cooling and
heating capacity of the unit.
Following is an example input for a ZoneHVAC:TerminalUnit:VariableRefrigerantFlow object.
ZoneHVAC:TerminalUnit:VariableRefrigerantFlow,
Zone 1 TU,
!- Zone Terminal Unit Name
TU Availability Schedule,!- Terminal Unit Availability schedule
TU1 Inlet Node,
!- Terminal Unit Air Inlet Node Name
TU1 Outlet Node,
!- Terminal Unit Air Outlet Node Name
0.005,
!- Supply Air Flow Rate During Cooling Operation {m3/s}
0,
!- Supply Air Flow Rate When No Cooling is Needed {m3/s}
0.005,
!- Supply Air Flow Rate During Heating Operation {m3/s}
0,
!- Supply Air Flow Rate When No Heating is Needed {m3/s}
0.001,
!- Outdoor Air Flow Rate During Cooling Operation
0.001,
!- Outdoor Air Flow Rate During Heating Operation
0,
!- Outdoor Air Flow Rate When No Cooling or Heating is Needed
TU1 Fan Op Schedule,
!- Supply Air Fan Operating Mode Schedule Name
drawthrough,
!- Supply Air Fan placement
Fan:ConstantVolume,
!- Supply Air Fan Object Type
TU1 SA Fan,
!- Supply Air Fan Object Name
OutdoorAir:Mixer,
!- Outside Air Mixer Object Type
TU1 OA Mixer,
!- Outside Air Mixer Object Name
COIL:Cooling:DX:VariableRefrigerantFlow, !- Cooling Coil Object Type
TU1 VRF DX Cooling Coil, !- Cooling Coil Object Name
COIL:Heating:DX:VariableRefrigerantFlow, !- Heating Coil Object Type
TU1 VRF DX Heating Coil, !- Heating Coil Object Name
30,
!- Zone Terminal Unit On Parasitic Electric Energy Use {W}
20,
!- Zone Terminal Unit Off Parasitic Electric Energy Use {W}
,
!- Rated Total Heating Capacity Sizing Ratio {W/W}
;
!- Availability Manager List Name

Variable Refrigerant Flow (VRF) Terminal Unit (ZoneHVAC) Outputs

HVAC,Average,Zone VRF Air Terminal Total Cooling Rate [W]
HVAC,Sum, Zone VRF Air Terminal Total Cooling Energy [J]
HVAC,Average, Zone VRF Air Terminal Sensible Cooling Rate [W]
HVAC,Sum, Zone VRF Air Terminal Sensible Cooling Energy [J]
HVAC,Average, Zone VRF Air Terminal Latent Cooling Rate [W]
HVAC,Sum, Zone VRF Air Terminal Latent Cooling Energy [J]
9/29/14

1015

Input-Output Reference

Group Zone Forced Air Units

HVAC,Average,Zone VRF Air Terminal Total Heating Rate [W]

HVAC,Sum, Zone VRF Air Terminal Total Heating Energy [J]
HVAC,Average, Zone VRF Air Terminal Sensible Heating Rate [W]
HVAC,Sum, Zone VRF Air Terminal Sensible Heating Energy [J]
HVAC,Average, Zone VRF Air Terminal Latent Heating Rate [W]
HVAC,Sum, Zone VRF Air Terminal Latent Heating Energy [J]
HVAC,Average, Zone VRF Air Terminal Cooling Electric Power [W]
HVAC,Sum, Zone VRF Air Terminal Cooling Electric Energy [J]
HVAC,Average,Zone VRF Air Terminal Heating Electric Power [W]
HVAC,Sum,Zone VRF Air Terminal Heating Electric Energy [J]
HVAC,Average, Zone VRF Air Terminal Fan Availability Status []

Zone VRF Air Terminal Total Cooling Rate [W]

This field is the total (sensible and latent) cooling rate output of the terminal unit in Watts.
This is determined by terminal unit inlet and outlet air conditions and the air mass flow rate
through the unit. This value describes the total energy rate delivered to the zone.
Zone VRF Air Terminal Total Cooling Energy [J]
This is the total (sensible plus latent) cooling output of the terminal unit in Joules over the
time step being reported. This is determined by the terminal unit inlet and outlet air conditions
and the air mass flow rate through the unit. This value describes the total cooling energy
delivered to the zone.
Zone VRF Air Terminal Sensible Cooling Rate [W]
This output is the moist air sensible cooling rate output of the terminal unit in Watts. This is
determined by enthalpy difference between the inlet and outlet air temperature at a constant
humidity ratio, using the minimum of the inlet and outlet air node humidity ratios, and the air
mass flow rate through the unit. This value describes the sensible cooling energy rate
delivered to the zone.
Zone VRF Air Terminal Sensible Cooling Energy [J]
This is the moist air sensible cooling output of the terminal unit in Joules for the time step
being reported. This is determined by enthalpy difference between the inlet and outlet air
temperature at a constant humidity ratio, using the minimum of the inlet and outlet air node
humidity ratios, and the air mass flow rate through the unit. This value describes the sensible
cooling energy delivered to the zone.
Zone VRF Air Terminal Latent Cooling Rate [W]
This is the latent cooling rate output of the terminal unit in Watts. This is determined by the
inlet and outlet air humidity ratios and the air mass flow rate through the unit. This value
describes the latent cooling energy rate delivered to the zone.
Zone VRF Air Terminal Latent Cooling Energy [J]
This is the latent cooling output of the terminal unit in Joules for the time step being reported.
This is determined by the inlet and outlet air humidity ratios and the air mass flow rate
through the unit. This value describes the latent cooling energy delivered to the zone.
Zone VRF Air Terminal Total Heating Rate [W]
This field is the total enthalpic heating rate output of the terminal unit in Watts. This is
determined by the terminal unit inlet and outlet air conditions and the air mass flow rate
through the unit. This value describes the total heating energy rate delivered to the zone.

9/29/14

1016

Input-Output Reference

Group Zone Forced Air Units

Zone VRF Air Terminal Total Heating Energy [J]

This is the total enthalpic heating output of the terminal unit in Joules over the time step being
reported. This is determined by the terminal unit inlet and outlet air conditions and the air
mass flow rate through the unit. This value describes the total heating energy delivered to the
zone.
Zone VRF Air Terminal Sensible Heating Rate [W]
This output is the moist air sensible heating rate output of the terminal unit in Watts. This is
determined by enthalpy difference between the inlet and outlet air temperature at a constant
humidity ratio, using the minimum of the inlet and outlet air node humidity ratios, and the air
mass flow rate through the unit. This value describes the sensible heating energy rate
delivered to the zone.
Zone VRF Air Terminal Sensible Heating Energy [J]
This is the moist air sensible heating output of the terminal unit in Joules for the time step
being reported. This is determined by enthalpy difference between the inlet and outlet air
temperature at a constant humidity ratio, using the minimum of the inlet and outlet air node
humidity ratios, and the air mass flow rate through the unit. This value describes the sensible
heating energy delivered to the zone.
Zone VRF Air Terminal Latent Heating Rate [W]
This is the latent heating rate output of the terminal unit in Watts. This is determined by the
inlet and outlet air specific humidity ratios and the air mass flow rate through the unit. This
value describes the latent heating energy rate delivered to the zone.
Zone VRF Air Terminal Latent Heating Energy [J]
This is the latent heating output of the terminal unit in Joules for the time step being reported.
This is determined by the inlet and outlet air specific humidity ratios and the air mass flow
rate through the unit. This value describes the latent heating energy delivered to the zone.
Zone VRF Air Terminal Cooling Electric Power[W]
This output field is the parasitic electricity consumption rate of the zone terminal unit in Watts.
The consumption rate includes parasitic electricity used by the zone terminal units
transformers, controls, or other electricity consuming devices. This value is calculated for
each HVAC system time step being simulated, and the results are averaged for the time step
being reported. The terminal unit parasitic on and off electricity is reported in this cooling
output variable when the unit operates in cooling mode or the most recent operation was for
cooling.
Zone VRF Air Terminal Cooling Electric Energy [J]
This output field is the electricity consumption of the zone terminal unit in Joules for the time
period being reported. The consumption includes parasitic electricity used by the zone
terminal units transformers, controls, or other electricity consuming devices. This value is
calculated for each HVAC system time step being simulated, and the results are summed for
the time step being reported. The terminal unit parasitic on and off electricity consumption is
reported in this cooling output variable when the unit operates in cooling mode or the most
recent operation was for cooling. This output is also added to a meter with Resource Type =
Electricity, End Use Key = Cooling, Group Key = System (ref. Output:Meter objects).
Zone VRF Air Terminal Heating Electric Power[W]
This output field is the parasitic electricity consumption rate of the zone terminal unit in Watts.
The consumption rate includes parasitic electricity used by the zone terminal units
transformers, controls, or other electricity consuming devices. This value is calculated for
each HVAC system time step being simulated, and the results are averaged for the time step
being reported. The terminal unit parasitic on and off electricity is reported in this heating
9/29/14

1017

Input-Output Reference

Group Zone Forced Air Units

output variable when the unit operates in heating mode or the most recent operation was for
heating.
Zone VRF Air Terminal Heating Electric Energy [J]
This output field is the electricity consumption of the zone terminal unit in Joules for the time
period being reported. The consumption includes parasitic electricity used by the zone
terminal units transformers, controls, or other electricity consuming devices. This value is
calculated for each HVAC system time step being simulated, and the results are summed for
the time step being reported. The terminal unit parasitic on and off electricity consumption is
reported in this heating output variable when the unit operates in heating mode or the most
recent operation was for heating. This output is also added to a meter with Resource Type =
Electricity, End Use Key = Heating, Group Key = System (ref. Output:Meter objects).
Zone VRF Air Terminal Fan Availability Status []
This is the availability status of the Zone Terminal Unit fan. This status flag is a result of the
calculations
made
by
the
Availability
Manager(s)
listed
in
an
AvailabilityManagerAssignmentList object and/or calculations made by Hybrid Ventilation
Manager object. The AvailabilityManagerAssignmentList is an optional input in the Zone
Terminal Unit object. When a single availability manager is used in an Availability Manager
Assignment List, this is also the availability status reported by the specific availability
manager (Ref. AvailabilityManager:* Outputs). For multiple availability managers in an
Availability Manager Assignment List along with Hybrid Ventilation Manager, rules to
determine fan availability status are described in the section Group System Availability
Managers. The control status outputs are represented using integers 0 through 3. These
integers represent NoAction (0), ForceOff (1), CycleOn (2), and CycleOnZoneFansOnly (3).
Since the status output is averaged, the output result may not correspond to the values
described here when output variable frequencies other than detailed are used. Use the
detailed reporting frequency (Ref. Output:Variable object) to view the availability status at
each simulation timestep.
DesignSpecification:ZoneHVAC:Sizing
This object is used to describe general sizing and scalable sizing methods which are
referenced by zone HVAC equipment objects. It is optional input field in zone HVAC objects.
If a name of this optional input is not specified or is blank then the sizing method or input
specified in the parent object is used. If the name of this object is entered, then the values or
method specified overrides the sizing method in the parent zone HVAC objects. This object is
meant to provide scalable sizing method to users. The name of this object is an optional input
field in the zoneHVAC objects. When this name in not specified in the zone HVAC object the
sizing method or the value specified in the zone HVAC object will be used.
List of zoneHVAC objects than can reference this object include:
ZoneHVAC:TerminalUnit:VariableRefrigerantFlow
ZoneHVAC:PackagedTerminalAirConditioner
ZoneHVAC:PackagedTerminalHeatPump
ZoneHVAC:WaterToAirHeatPump
ZoneHVAC:WindowAirConditioner
ZoneHVAC:UnitHeater
ZoneHVAC:UnitVentilator
ZoneHVAC:FourPipeFanCoil
ZoneHVAC:VentilatedSlab
ZoneHVAC:EvaporativeCoolerUnit
ZoneHVAC:IdealLoadsAirSystem
The sizing methods input fields available in this objects are for supply air flow and capacity
for heating and cooling operating modes. Some zone HVAC equipment has single supply air
9/29/14

1018

Input-Output Reference

Group Zone Forced Air Units

flow rate input field that serves both cooling and heating operating modes. So entering either
of the cooling or heating scalable sizing input field is sufficient. When there are separate
input fields for cooling, heating, no-cooling, and no-heating operating modes, the
corresponding input fields are specified. The child components supply air flow rate are also
sized using scalable sizing methods specified in the parent objects. The methods allow users
to enter a fixed or hard sized values, autosizable, or scalable sizing methods. Methods
allowed for sizing supply air flow rates include: SupplyAirFlowRate,
FractionOfAutosizedCoolingAirflow, FractionOfAutosizedHeatingAirflow, FlowPerFloorArea,
FlowPerCoolingCapacity, and FlowPerHeatingCapacity. The different sizing options are
defined as follows:
SupplyAirFlowRate: entered when it is intended that the user specified either hard value or
the simulation engine autosize the supply air flow rates for cooling, heating, and no-cooling or
no-heating operating modes.
FlowPerFloorArea: entered when it is intended that the simulation engine determine the
supply air flow rates from the user specified supply air flow rates per unit floor area and the
zone floor area of the zone served by the zone HVAC equipment.
FractionOfAutosizedCoolingAirflow: entered when it is intended that the simulation engine
determines the supply air flow rates from the user specified flow fraction and autosized
cooling design supply air flow rate.
FractionOfAutosizedHeatingAirflow: entered when it is intended that the simulation engine
determines the supply air flow rates from the user specified flow fraction and autosized
heating design supply air flow rate.
FlowPerCoolingCapacity: entered when it is intended t that he simulation engine
determines the supply air flow rates from the user specified supply air flow per cooling
capacity value and autosized cooling design capacity.
FlowPerHeatingCapacity: entered when it is intended that the simulation engine determines
the supply air flow rates from the user specified supply air flow per heating capacity value and
autosized heating design capacity.
The Design Specification ZoneHVAC Sizing object also has input fields for sizing or scalable
sizing of cooling and heating capacity. However, most of the parent zone HVAC objects do
not have input fields for sizing capacities. So, the capacity scalable sizing fields in the parent
objects are used for sizing child components capacity sizings. The scalable capacity sizing
may be indirectly impacted by the scalable supply air flow rates sizing values. Moreover, the
autosized cold water, hot water and steam flow rates in the parent zone HVAC objects (e.g.
FanCoils, UnitHeaters, UnitVentilators, and VentilatedSlabs) and capacity in child
components are determined using the scalable sizing methods. Sizing methods allowed for
cooling and heating capacity include: CoolingDesignCapacity, HeatingDesignCapacity,
CapacityPerFloorArea, FractionOfAutosizedCoolingCapacity,
FractionOfAutosizedHeatingCapacity.
CoolingDesignCapacity: entered when it is intended that user specifies either a hard sized
cooling capacity value or the simulation engine autosizes cooling capacity value for the
cooling design capacity.
HeatingDesignCapacity: entered when it is intended that user specifies either a hard sized
heating capacity value or the simulation engine autosized heating capacity value for the
heating design capacity.

9/29/14

1019

Input-Output Reference

Group Zone Forced Air Units

CapacityPerFloorArea: is entered when it is intended that the simulation engine determines

the cooling or heating capacity from user specified capacity per floor area value and the floor
area of the zone served by the zone HVAC equipment.
FractionOfAutosizedCoolingCapacity: entered when it is intended that the simulation
engine sizes the cooling capacity from the user specified capacity fraction and autosized
cooling design capacity value.
FractionOfAutosizedHeatingCapacity: entered when it is intended that the simulation
engine sizes the heating capacity from the user specified capacity fraction and autosized
heating design capacity value.
Description of the input fields of the design specification zone HVAC sizing object
DesignSpecification:ZoneHVAC:Sizing:
Field: Name
Unique identifier name of the DesignSpecification:ZoneHVAC:Sizing object. This sizing
specification object referenced by a zone HVAC equipment whose design calculation will be
made using the input data of this object.
Field: Cooling Design Air Flow Method
The input of this field must be the method used to determine the cooling supply air volume
flow rate. Input allowed is either None, SupplyAirFlowRate, FlowPerFloorArea,
FractionOfAutosizedCoolingAirflow, or FlowPerCoolingCapacity. None means cooling coil is
not included in the zone HVAC equipment or this field may be left blank. SupplyAirFlowRate
means the user specifies the magnitude of supply air flow rate or the program calculates the
design cooling supply air volume flow rate if autosize is specified. FlowPerFloorArea means
the program calculates the cooling supply air volume flow rate from zone floor area served by
the zone HVAC unit and user specified Flow Per Floor Area value.
FractionOfAutosizedCoolingAirflow means the program calculates the cooling supply air
volume flow rate from user specified fraction and the autosized design cooling supply air
volume flow rate value determined by the simulation. FlowPerCoolingCapacity means the
supply air volume is calculated from user specified flow per cooling capacity and design
cooling capacity determined by the simulation. The default method is SupplyAirFlowRate.
Field: Cooling Design Supply Air Flow Rate {m3/s}
Enter the magnitude of the cooling supply air volume flow rate in m3/s. This input is an
alternative to using the program auto-calculated value. This input is a required field when the
Cooling Design air Flow Method is SupplyAirFlowRate. This field may be left blank if a
cooling coil is not included in the zone HVAC equipment. This input field is also autosizable.
Field: Cooling Design Supply Air Flow Rate Per Floor Area {m3/s-m2}
Enter the cooling supply air volume flow rate per zone conditioned floor area in m3/s-m2. This
field is required field when the Cooling Design air Flow Method is FlowPerFloorArea. This
field may be left blank if a cooling coil is not included in the zone HVAC equipment or the
Cooling Design Air Flow Method is not FlowPerFloorArea. The program calculates the
cooling supply air volume flow rate from the zone conditioned floor area served by the zone
HVAC equipment and the flow per unit area value specified by the user. Zone sizing object
(Sizing:Zone) is not required.
Field: Fraction of Autosized Cooling Design Supply Air Flow Rate {-}
Enter the cooling supply air volume flow rate as a fraction of the autosized cooling supply air
flow rate. This input field is required when the Cooling Design air Flow Method is
FractionOfAutosizedCoolingAirflow. This input field may be left blank if a cooling coil is not
9/29/14

1020

Input-Output Reference

Group Zone Forced Air Units

included in the zone HVAC equipment or the Cooling Design air Flow Method is not
FractionOfAutosizedCoolingAirflow. The program calculates the cooling supply air volume
flow rate from the design autosized cooling supply air flow rate and user specified fraction.
Zone sizing object (Sizing:Zone) is required.
Field: Cooling Design Supply Air Flow Rate Per Unit Cooling Capacity {m3/s-W}
Enter the cooling supply air volume flow rate per unit cooling capacity in m3/s-W. This input
field is required when the Cooling Design air Flow Method is FlowPerCoolingCapacity. This
field may be left blank if a cooling coil is not included in the zone HVAC equipment or the
Cooling Design air Flow Method is not FlowPerCoolingCapacity. The program calculates the
cooling supply air volume flow rate from the design autosized cooling capacity and user
specified flow per cooling capacity value. Zone sizing object (Sizing:Zone) is required.
Field: Supply Air Flow Rate Method When No Cooling or Heating is Required
Enter the method used to determine the supply air volume flow rate when No Cooling or
Heating is required. Inputs allowed are None, SupplyAirFlowRate, FlowPerFloorArea,
FractionOfAutosizedCoolingAirflow, and FractionOfAutosizedHeatingAirflow. None is used
when a cooling or heating coil is not included in the zone HVAC equipment or this field may
be left blank. SupplyAirFlowRate means user specifies the magnitude of supply air flow rate
or the program calculates the design supply air volume flow rate if autosize is specified.
FlowPerFloorArea means the program calculates the supply air volume flow rate from the
zone floor area served by the zone HVAC unit and Flow Per Floor Area value specified by
user. FractionOfAutosizedCoolingAirflow means the program calculates the supply air volume
flow rate from user specified fraction and autosized design cooling supply air volume flow rate
value determined by the program. FractionOfAutosizedHeatingAirflow means the program
calculates the supply air volume flow rate from user specified fraction and autosized heating
supply air flow rate value determined by the program. The default method is
SupplyAirFlowRate.
Field: Supply Air Flow Rate When No Cooling or Heating is Required {m3/s}
Enter the magnitude of the supply air volume flow rate when no cooling or heating is required
in m3/s. This input is an alternative to using the program auto-calculated value. This input is a
required field when the Supply Air Flow Rate Method When No Cooling or Heating is
Required is SupplyAirFlowRate. This field may be left blank if a cooling coil is not included in
the zone HVAC equipment. This input field is also autosizable.
Field: Supply Air Flow Rate Per Floor Area When No Clg or Htg is Required {m3/s-m2}
Enter the magnitude of supply air volume flow rate per zone floor area in m3/s-m2. This input
is a required field when Supply Air Flow Rate Method When No Cooling or Heating is
Required is FlowPerFloorArea. The program calculates the supply air flow rate when no
cooling or heating is required from user specified flow per floor area and the zone area
served by current zoneHVAC equipment.
Field: Fraction of Design Cooling Supply Air Flow Rate When No Clg or Htg Required {-}
Enter the fraction of supply air volume flow rate as a fraction of the autosized cooling supply
air flow rate. This input field is required field when Supply Air Flow Rate Method When No
Cooling or Heating is Required is FractionOfAutosizedCoolingAirflow. The program
calculates the supply air flow rate when no cooling or heating is required from user specified
fraction and the design cooling autosized supply air flow rate.
Field: Fraction of Design Heating Supply Air Flow Rate When No Clg or Htg Required {-}
Enter the fraction of supply air volume flow rate as a fraction of the autosized cooling supply
air flow rate. This input field is required field when Supply Air Flow Rate Method When No
Cooling or Heating is Required is FractionOfAutosizedHeatingAirflow. The program

9/29/14

1021

Input-Output Reference

Group Zone Forced Air Units

calculates the supply air flow rate when no cooling or heating is required from user specified
fraction and the design heating autosized supply air flow rate.
Field: Heating Design Air Flow Method
The input of this field must be the method used to determine the heating supply air volume
flow rate. Input allowed is either None, SupplyAirFlowRate, FlowPerFloorArea,
FractionOfAutosizedCoolingAirflow, or FlowPerCoolingCapacity. None means heating coil is
not included in the zone HVAC equipment or this field may be left blank. SupplyAirFlowRate
means the user specifies the magnitude of supply air flow rate or the program calculates the
design heating supply air volume flow rate if autosize is specified. FlowPerFloorArea means
the program calculates the heating supply air volume flow rate from zone floor area served by
the zone HVAC unit and user specified Flow Per Floor Area value.
FractionOfAutosizedHeatingAirflow means the program calculates the heating supply air
volume flow rate from user specified fraction and the autosized design heating supply air
volume flow rate value determined by the simulation. FlowPerHeatingCapacity means the
supply air volume is calculated from user specified flow per heating capacity and design
heating capacity determined by the simulation. The default method is SupplyAirFlowRate.
Field: Heating Design Supply Air Flow Rate {m3/s}
Enter the magnitude of the heating supply air volume flow rate in m3/s. This input is an
alternative to using the program auto-calculated value. This input is a required field when the
Heating Design air Flow Method is SupplyAirFlowRate. This field may be left blank if a
heating coil is not included in the zone HVAC equipment. This input field is also autosizable.
Field: Heating Design Supply Air Flow Rate Per Floor Area {m3/s-m2}
Enter the heating supply air volume flow rate per zone conditioned floor area in m3/s-m2.
This field is required field when the Heating Design air Flow Method is FlowPerFloorArea.
This field may be left blank if a heating coil is not included in the zone HVAC equipment or
the Heating Design Air Flow Method is not FlowPerFloorArea. The program calculates the
heating supply air volume flow rate from the zone conditioned floor area served by the zone
HVAC equipment and the flow per unit area value specified by the user.
Field: Fraction of Autosized Heating Design Supply Air Flow Rate {-}
Enter the heating supply air volume flow rate as a fraction of the autosized heating supply air
flow rate. This input field is required when the Heating Design air Flow Method is
FractionOfAutosizedHeatingAirflow. This input field may be left blank if a heating coil is not
included in the zone HVAC equipment or the Heating Design air Flow Method is not
FractionOfAutosizedHeatingAirflow. The program calculates the heating supply air volume
flow rate from the design autosized heating supply air flow rate and user specified fraction.
Field: Heating Design Supply Air Flow Rate Per Unit Heating Capacity {m3/s-W}
Enter the heating supply air volume flow rate per unit heating capacity in m3/s-W. This input
field is required when the Heating Design air Flow Method is FlowPerHeatingCapacity. This
field may be left blank if a cooling coil is not included in the zone HVAC equipment or the
Heating Design air Flow Method is not FlowPerHeatingCapacity. The program calculates the
heating supply air volume flow rate from the design autosized heating capacity and user
specified flow per unit heating capacity value.
Field Cooling Design Capacity Method
Enter the method used to determine the cooling design capacity for scalable sizing. Input
allowed is either None, CoolingDesignCapacity, CapacityPerFloorArea, and
FractionOfAutosizedCoolingCapacity. None is used when a cooling coil is not included in the
Zone HVAC equipment or this field may be left blank. If this input field is left blank, then the
design cooling capacity is set to zero. CoolingDesignCapacity means user specifies the
magnitude of cooling capacity or the program calculates the design cooling capacity if
9/29/14

1022

Input-Output Reference

Group Zone Forced Air Units

autosize is specified. CapacityPerFloorArea means the program calculates the design cooling
capacity from user specified cooling capacity per floor area and floor area of the zone served
by the HVAC unit. FractionOfAutosizedCoolingCapacity means the program calculates the
design cooling capacity from user specified fraction and the auto-sized design cooling
capacity. The default method is CoolingDesignCapacity.
Field: Cooling Design Capacity {W}
Enter the magnitude of the cooling capacity in Watts. This input is an alternative to using the
program auto-calculated cooling capacity value. This input is a required field when the
Cooling Design Capacity Method is CoolingDesignCapacity. This field may be left blank if a
cooling coil is not included in the zone HVAC equipment or alternative method is specified.
This input field is autosizable. Design day sizing run must be specified.
Field: Cooling Design Capacity Per Floor Area {W/m2}
Enter the cooling capacity per unit floor area in m3/s-m2. This field is required field when the
Cooling Design Capacity Method is CapacityPerFloorArea. This field may be left blank if a
cooling coil is not included in the zone HVAC equipment or the Cooling Design Capacity
Method is not CapacityPerFloorArea. The program calculates the cooling capacity from floor
area of the zone served by the zone HVAC equipment and the cooling capacity per unit floor
area value specified by the user.
Field: Fraction of Autosized Cooling Design Capacity {-}
Enter the cooling capacity as a fraction of the autosized cooling capacity. This input field is
required when the Cooling Design Capacity Method is FractionOfAutosizedCoolingCapacity.
This input field may be left blank if a cooling coil is not included in the zone HVAC equipment
or the Cooling Design Capacity Method is not FractionOfAutosizedCoolingCapacity. The
program calculates the cooling capacity from the design autosized cooling capacity and user
specified fraction. Design day sizing run must be specified.
Field: Heating Design Capacity Method
Enter the method used to determine the heating design capacity for scalable sizing. Input
allowed is either None, HeatingDesignCapacity, CapacityPerFloorArea, and
FractionOfAutosizedHeatingCapacity. None is used when a heating coil is not included in the
Zone HVAC equipment or this field may be left blank. If this input field is left blank, then the
design heating capacity is set to zero. HeatingDesignCapacity means user specifies the
magnitude of heating capacity or the program calculates the design heating capacity if
autosize is specified. CapacityPerFloorArea means the program calculates the design
heating capacity from user specified heating capacity per floor area and floor area of the zone
served by the HVAC unit. FractionOfAutosizedHeatingCapacity means the program
calculates the design heating capacity from user specified fraction and the auto-sized design
heating capacity. The default method is HeatingDesignCapacity.
Field: Heating Design Capacity {W}
Enter the magnitude of the heating capacity in Watts. This input is an alternative to using the
program auto-calculated heating capacity value. This input is a required field when the
Heating Design Capacity Method is HeatingDesignCapacity. This field may be left blank if a
heating coil is not included in the zone HVAC equipment or alternative method is specified.
This input field is autosizable. Design day sizing run must be specified.
Field: Heating Design Capacity Per Floor Area {W/m2}
Enter the heating capacity per unit floor area in m3/s-m2. This field is required field when the
Heating Design Capacity Method is CapacityPerFloorArea. This field may be left blank if a
heating coil is not included in the zone HVAC equipment or the Heating Design Capacity
Method is not CapacityPerFloorArea. The program calculates the heating capacity from floor

9/29/14

1023

Input-Output Reference

Group Zone Forced Air Units

area of the zone served by the zone HVAC equipment and the heating capacity per unit floor
area value specified by the user.
Field: Fraction of Autosized Heating Design Capacity {-}
Enter the heating capacity as a fraction of the autosized heating capacity. This input field is
required when the Heating Design Capacity Method is FractionOfAutosizedHeatingCapacity.
This input field may be left blank if a heating coil is not included in the zone HVAC equipment
or the Heating Design Capacity Method is not FractionOfAutosizedHeatingCapacity. The
program calculates the heating capacity from the design autosized cooling capacity and user
specified fraction. Design day sizing run must be specified.
DesignSpecification:ZoneHVAC:Sizing,
VRFDesignSpec1,
!- Name
SupplyAirFlowRate,
!- Cooling Design Air Flow Method
autosize,
!- Cooling Design Supply Air Flow Rate
,
!- Cooling Design Supply Air Flow Rate Per Floor Area
,
!- Fraction of Autosized Cooling Design Supply Air Flow Rate
,
!- Cooling Design Supply Air Flow Rate Per Unit of Capacity {m3/s-W}
SupplyAirFlowRate,
!- Supply Air Flow Rate Method When No Cooling or Heating is Required
autosize,
!- Supply Air Flow Rate When No Cooling or Heating is Required
,
!- Supply Air Flow Rate Per Floor Area When No Clg or Htg is Required
,
!- Fraction of Autosized Design Cooling Supply Air Flow Rate When No Clg or Htg
,
!- Fraction of Autosized Design Heating Supply Air Flow Rate When No Clg or Htg
SupplyAirFlowRate,
!- Heating Design Air Flow Method
autosize,
!- Heating Design Supply Air Flow Rate
,
!- Heating Design Supply Air Flow Rate Per Floor Area
,
!- Fraction of Autosized Heating Design Supply Air Flow Rate
,
!- Heating Design Supply Air Flow Rate Per Unit of Heating Capacity
CoolingDesignCapacity,
!- Cooling Design Capacity Method
autosize,
!- Cooling Design Capacity {W}
,
!- Cooling Design Capacity Per Floor Area {W/m2}
,
!- Fraction of Autosized Cooling Design Capacity {-}
HeatingDesignCapacity,
!- Heating Design Capacity Method
autosize,
!- Heating Design Capacity {W}
,
!- Heating Design Capacity Per Floor Area {W/m2}
;
!- Fraction of Autosized Cooling Design Capacity {-}
DesignSpecification:ZoneHVAC:Sizing,
VRFDesignSpec2,
!- Name
FlowPerFloorArea,
!- Cooling Design Air Flow Method
,
!- Cooling Design Supply Air Flow Rate
3.6311418E-03,
!- Cooling Design Supply Air Flow Rate Per Floor Area
,
!- Fraction of Autosized Cooling Design Supply Air Flow Rate
,
!- Cooling Design Supply Air Flow Rate Per Unit of Capacity {m3/s-W}
FlowPerFloorArea,
!- Supply Air Flow Rate Method When No Cooling or Heating is Required
,
!- Supply Air Flow Rate When No Cooling or Heating is Required
3.6311418E-03,
!- Supply Air Flow Rate Per Floor Area When No Clg or Htg is Required
,
!- Fraction of Autosized Design Cooling Supply Air Flow Rate When No Clg or Htg
,
!- Fraction of Autosized Design Heating Supply Air Flow Rate When No Clg or Htg
FlowPerFloorArea,
!- Heating Design Air Flow Method
,
!- Heating Design Supply Air Flow Rate
3.6311418E-03,
!- Heating Design Supply Air Flow Rate Per Floor Area
,
!- Fraction of Autosized Heating Design Supply Air Flow Rate
,
!- Heating Design Supply Air Flow Rate Per Unit of Heating Capacity
CoolingDesignCapacity,
!- Cooling Design Capacity Method
autosize,
!- Cooling Design Capacity {W}
,
!- Cooling Design Capacity Per Floor Area {W/m2}
,
!- Fraction of Autosized Cooling Design Capacity {-}
HeatingDesignCapacity,
!- Heating Design Capacity Method
autosize,
!- Heating Design Capacity {W}
,
!- Heating Design Capacity Per Floor Area {W/m2}
;
!- Fraction of Autosized Cooling Design Capacity {-}

9/29/14

1024

Input-Output Reference

Group Unitary Equipment

DesignSpecification:ZoneHVAC:Sizing,
VRFDesignSpec3,
!- Name
FractionOfAutosizedCoolingAirflow, !- Cooling Design Air Flow Method
,
!- Cooling Design Supply Air Flow Rate
,
!- Cooling Design Supply Air Flow Rate Per Floor Area
0.5,
!- Fraction of Autosized Cooling Design Supply Air Flow Rate
,
!- Cooling Design Supply Air Flow Rate Per Unit of Capacity {m3/s-W}
FractionOfAutosizedCoolingAirflow, !- Supply Air Flow Rate Method When No Cooling or Heating is Required
,
!- Supply Air Flow Rate When No Cooling or Heating is Required
,
!- Supply Air Flow Rate Per Floor Area When No Clg or Htg is Required
0.5,
!- Fraction of Autosized Design Cooling Supply Air Flow Rate When No Clg or Htg
,
!- Fraction of Autosized Design Heating Supply Air Flow Rate When No Clg or Htg
FractionOfAutosizedHeatingAirflow, !- Heating Design Air Flow Method
,
!- Heating Design Supply Air Flow Rate
,
!- Heating Design Supply Air Flow Rate Per Floor Area
0.5,
!- Fraction of Autosized Heating Design Supply Air Flow Rate
,
!- Heating Design Supply Air Flow Rate Per Unit of Heating Capacity
CoolingDesignCapacity,
!- Cooling Design Capacity Method
autosize,
!- Cooling Design Capacity {W}
,
!- Cooling Design Capacity Per Floor Area {W/m2}
,
!- Fraction of Autosized Cooling Design Capacity {-}
HeatingDesignCapacity,
!- Heating Design Capacity Method
autosize,
!- Heating Design Capacity {W}
,
!- Heating Design Capacity Per Floor Area {W/m2}
;
!- Fraction of Autosized Cooling Design Capacity {-}
DesignSpecification:ZoneHVAC:Sizing,
VRFDesignSpec4,
!- Name
FlowPerCoolingCapacity, !- Cooling Design Air Flow Method
,
!- Cooling Design Supply Air Flow Rate
,
!- Cooling Design Supply Air Flow Rate Per Floor Area
,
!- Fraction of Autosized Cooling Design Supply Air Flow Rate
2.9541628E-05,
!- Cooling Design Supply Air Flow Rate Per Unit of Capacity {m3/s-W}
FractionOfAutosizedHeatingAirflow, !- Supply Air Flow Rate Method When No Cooling or Heating is Required
,
!- Supply Air Flow Rate When No Cooling or Heating is Required
,
!- Supply Air Flow Rate Per Floor Area When No Clg or Htg is Required
,
!- Fraction of Autosized Design Cooling Supply Air Flow Rate When No Clg or Htg
0.413231177,
!- Fraction of Autosized Design Heating Supply Air Flow Rate When No Clg or Htg
FlowPerHeatingCapacity, !- Heating Design Air Flow Method
,
!- Heating Design Supply Air Flow Rate
,
!- Heating Design Supply Air Flow Rate Per Floor Area
,
!- Fraction of Autosized Heating Design Supply Air Flow Rate
2.9541628E-05,
!- Heating Design Supply Air Flow Rate Per Unit of Heating Capacity
CoolingDesignCapacity,
!- Cooling Design Capacity Method
autosize,
!- Cooling Design Capacity {W}
,
!- Cooling Design Capacity Per Floor Area {W/m2}
,
!- Fraction of Autosized Cooling Design Capacity {-}
HeatingDesignCapacity,
!- Heating Design Capacity Method
autosize,
!- Heating Design Capacity {W}
,
!- Heating Design Capacity Per Floor Area {W/m2}
;
!- Fraction of Autosized Cooling Design Capacity {-}

Group Unitary Equipment

Furnace and Unitary Systems
The components
AirLoopHVAC:UnitarySystem
AirLoopHVAC:Unitary:Furnace:HeatOnly
AirLoopHVAC:Unitary:Furnace:HeatCool
AirLoopHVAC:UnitaryHeatOnly
AirLoopHVAC:UnitaryHeatCool
AirLoopHVAC:UnitaryHeatPump:AirToAir
AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed

9/29/14

1025

Input-Output Reference

Group Unitary Equipment

are compound components usually placed in the primary air loop as the sole component. On
the zone equipment side they are usually connected to one or more zones through
uncontrolled terminal units (i.e., AirTerminal:SingleDuct:Uncontrolled objects). The maximum
or design air flow rate through the furnace or unitary system should usually be set equal to
the sum of the maximum air flow rates through the terminal unit objects. However, the
simulation program can usually account for unequal air flows if the user wishes to model this
scenario.
AirLoopHVAC:UnitarySystem
The AirLoopHVAC:UnitarySystem object is a virtual component that consists of a fan
component (OnOff, ConstantVolume, or VariableVolume), a cooling coil component, a
heating coil component, and a reheat coil as shown in Figure 117. When a draw through
configuration is desired, the fan is placed directly after the heating coil. If dehumidification
control is selected, a reheat coil component is also required. If the reheat coil is present and
the dehumidification control type input is not specified as CoolReheat, the reheat coil will not
be active,

Figure 1. Schematic of the EnergyPlus Unitary System

Links to the fan, cooling coil, heating coil and reheat coil specifications are provided in the
unitary system input data syntax. In addition, the control zone name and the system design
operating conditions are specified by the unitary system inputs.
Field: Name
This alpha field contains the identifying name for the unitary system.
Field: Control Type
This alpha field contains control type i.e. load based or setpoint based for the unitary system.
Valid choices are Load and SetPoint. Load control requires a Controlling Zone name and
SetPoint control requires set points at each coil outlet node. A single set point at the outlet of
the system is allowed but not recommended.

9/29/14

1026

Input-Output Reference

Group Unitary Equipment

Field: Controlling Zone or Thermostat Location

This alpha field contains the identifying zone name where the thermostat controlling the
unitary system is located.
Field: Dehumidification Control Type
This alpha field contains the type of dehumidification control. The following options are valid
for this field:
None - meet sensible load only, no active dehumidification control
Multimode - activate enhanced dehumidification mode as needed and meet sensible
load. This option is used to model DX equipment with a controllable heat exchanger
assisting the DX cooling coil for improved dehumidification. It is valid only with
cooling coil type = CoilSystem:Cooling:DX:HeatExchangerAssisted.
CoolReheat - cool beyond the dry-bulb temperature set point as required to meet the
high
humidity
setpoint.
If
cooling
coil
type
=
CoilSystem:Cooling:DX:HeatExchangerAssisted, then the heat exchanger is
assumed to always transfer energy between the cooling coils inlet and outlet
airstreams when the cooling coil is operating.
The default is None. For the other dehumidification control modes, the maximum humidity
setpoint is used. This must be set using a ZoneControl:Humidistat object. When extra
dehumidification is required, the system may not be able to meet the humidity setpoint if its
full capacity is not adequate. If the dehumidification control type is specified as CoolReheat,
then two additional inputs (reheat coil type and name) are also required as shown below.
Although the reheat coil is required only when CoolReheat is selected, the optional reheat
coil may be present for any of the allowed Dehumidification Control Types. If the reheat coil is
present and the dehumidification control type is not specified as CoolReheat, the reheat coil
will not be active,
Field: Availability Schedule Name
This alpha field contains the schedule name which contains information on the availability of
the unitary system to operate. A schedule value equal to 0 denotes that the unitary system
must be off for that time period. A value greater than 0 denotes that the unitary system is
available to operate during that time period. This schedule may be used to completely disable
the unitary system as required. If this field is left blank, the schedule has a value of 1 for all
time periods.
Field: Unitary System Air Inlet Node Name
This alpha field contains the unitary system inlet node name.
Field: Unitary System Air Outlet Node Name
This alpha field contains the unitary system outlet node name.
Field: Supply Fan Object Type
This alpha field contains the identifying type of supply air fan specified for the unitary system.
Fan type must be Fan:OnOff, Fan:ConstantVolume, or Fan:VariableVolume.
Fan:ConstantVolume is used when the Supply Air Fan Operating Mode Schedule values are
never 0 and the fan operates continuously. Fan:OnOff is used when the fan cycles on and off
with the cooling or heating coil (i.e. Supply Air Fan Operating Mode Schedule values are at
times 0). Fan:VariableVolume is used for variable air volume systems or multi- or variablespeed coils.
Field: Supply Fan Name
This alpha field contains the identifying name given to the unitary system fan.

9/29/14

1027

Input-Output Reference

Group Unitary Equipment

Field: Fan Placement

This alpha field has two choices: BlowThrough or DrawThrough. The first choice stands for
blow through fan. This means that the unit consists of a fan followed by the main cooling
and heating coils and supplemental heating coil. The fan blows through the cooling and
heating coils. The second choice stands for draw through fan. This means that the unit
consists of the main cooling/heating coil(s) followed by a fan, with the supplemental heater
located at the outlet of the fan. The fan draws air through the cooling/heating coil(s). If this
field is left blank, the default is blow through.
Field: Supply Air Fan Operating Mode Schedule Name
This alpha field specifies the name of the supply air fan operating mode schedule. The supply
air fan operating mode may vary during the simulation based on time-of-day or with a change
of season. Schedule values of 0 denote that the unitary system supply air fan and the heating
or cooling coil cycle on and off together to meet the heating or cooling load (a.k.a. AUTO fan).
Schedule values other than 0 denote that the supply fan runs continuously while the heating
or cooling coil cycles to meet the load.
Field: Heating Coil Object Type
This alpha field contains the identifying type of heating coil specified in the unitary system.
The hot water and steam heating coils require specifying plant loop, branches, and connector
objects to support the heating coils, and are placed on the demand side of the plantloop.
Allowable coil types are:
Coil:Heating:DX:SingleSpeed
Coil:Heating:DX:TwoSpeed
Coil:Heating:DX:MultiSpeed
Coil:Heating:DX:VariableSpeed
Coil:Heating:WaterToAirHeatPump:ParameterEstimation
Coil:Heating:WaterToAirHeatPump:EquationFit
Coil:Heating:WaterToAirHeatPump:VariableSpeedEquationFit
Coil:Heating:Gas
Coil:Heating:Gas:MultiStage
Coil:Heating:Electric
Coil:Heating:Electric:MultiStage
Coil:Heating:Water
Coil:Heating:Steam
Coil:Heating:Desuperheater

Field: Heating Coil Name

This alpha field contains the identifying name given to the unitary system heating coil.
Field: DX Heating Coil Sizing Ratio
This numeric field is used to adjust heat pump heating capacity with respect to DX cooling
capacity. It is used only for DX heat pump configurations (i.e., a DX cooling and heating coil
is used).
Field: Cooling Coil Object Type
This alpha field contains the identifying type of cooling coil specified in the unitary system.
Allowable coil types are:
Coil:Cooling:DX:SingleSpeed
Coil:Cooling:DX:TwoSpeed
Coil:Cooling:DX:MultiSpeed
Coil:Cooling:DX:VariableSpeed
Coil:Cooling:DX:TwoStageWithHumidityControlMode
CoilSystem:Cooling:DX:HeatExchangerAssisted
Coil:Cooling:WaterToAirHeatPump:ParameterEstimation
Coil:Cooling:WaterToAirHeatPump:EquationFit
Coil:Cooling:WaterToAirHeatPump:VariableSpeedEquationFit
9/29/14

1028

Input-Output Reference

Group Unitary Equipment

Coil:Cooling:Water
Coil:Cooling:Water:DetailedGeometry
CoilSystem:Cooling:Water:HeatExchangerAssisted

Field: Cooling Coil Name

This alpha field contains the identifying name given to the unitary system cooling coil.
Field: Use DOAS DX Cooling Coil
This input field eanbles DX Cooling coils to be used for 100% outdoor air dedicated outdor air
system applications. There are two choices Yes or No. If Yes, the DX coil is used as 100%
outdoor DX coil. If No, the DX coil is used as regular DX coil. This input file d is optional and
the default is No.
Field: DOAS DX Cooling Coil Leaving Minimum Air Temperature
This input field is DX Cooling coils leaving minimum air temperature for frost control. The DX
cooling coil leaving air temperature is not allowed to exceed this minimum air temperature.
The DX cooling coil frost controller adjusts or limits the desired coil outlet air setpoint
temperature when the coil outlet temperature exceeds this minimum temperature limit
specified. This input field is optional and only used along with in the input field above. The
m
is 2.0C.
Field: Latent Load Control
This alpha field defines the latent load control method. Available choices are
SensibleOnlyLoadControl, LatentOnlyLoadControl, LatentWithSensibleLoadControl, or
LatentOrSensibleLoadControl. The default choice is SensibleOnlyLoadControl. The
SensibleOnlyLoadControl choice will operate to meet only a sensible load, and the
LatentOnlyLoadConrol
will
operate
to
meet
only
a
latent
load.
The
LatentWithSensibleLoadControl will operate to meet the latent load only if there is a sensible
load. The LatentOrSensibleLoadControl will operate to meet either a latent or sensible load.
Field: Supplemental Heating Coil Object Type
This alpha field contains the identifying type of supplemental heating coil specified in the
unitary system. The hot water and steam heating coils require specifying plant loop,
branches, and connector objects to support the heating coils, and are placed on the demand
side of the plantloop. supplemental heating type must be one of:
Coil:Heating:Electric
Coil:Heating:Gas
Coil:Heating:Desuperheater
Coil:Heating:Water
Coil:Heating:Steam

Field: Supplemental Heating Coil Name

This alpha field contains the identifying name given to the unitary system reheat coil.
Field: Supply Air Flow Rate Method During Cooling Operation
This alpha field defines the supply air flow method during cooling operation. Available choices
are
SupplyAirFlowRate,
FlowPerFloorArea,
FractionOfAutosizedCoolingValue,
FlowPerCoolingCapacity. For each of the choices, corresponding air flow rate for cooling
must be specified.
Field: Supply Air Flow Rate During Cooling Operation
This numeric field defines the supply air flow rate leaving the unitary system in cubic meters
per second when the cooling coil is operating. Values must be greater than 0 or this field is

9/29/14

1029

Input-Output Reference

Group Unitary Equipment

autosizable. Required field when Supply Air Flow Rate Method During Cooling Operation is
SupplyAirFlowRate.
Field: Supply Air Flow Rate Per Floor Area During Cooling Operation
This numeric field defines the supply air flow rate per floor area leaving the unitary system in
meters per second when the cooling coil is operating. Values must be greater than 0 or this
field is autosizable. Required field when Supply Air Flow Rate Method During Cooling
Operation is FlowPerFloorArea.
Field: Fraction of Autosized Design Cooling Supply Air Flow Rate
This numeric field defines the fraction of autosized supply air flow rate leaving the unitary
system when the cooling coil is operating. Values must be greater than 0 or this field is
autosizable. Required field when Supply Air Flow Rate Method During Cooling Operation is
FractionOfAutosizedCoolingValue.
Field: Design Supply Air Flow Rate Per Unit of Capacity During Cooling Operation
This numeric field defines the supply air flow rate per unit of capacity leaving the unitary
system when the cooling coil is operating. Values must be greater than 0 or this field is
autosizable. Required field when Supply Air Flow Rate Method During Cooling Operation is
FlowPerCoolingCapacity.
Field: Supply Air Flow Rate Method During Heating Operation
This alpha field defines the supply air flow method during heating operation. Available
choices are SupplyAirFlowRate, FlowPerFloorArea, FractionOfAutosizedHeatingValue,
FlowPerHeatingCapacity. For each of the choices, corresponding air flow rate for heating
must be specified.
Field: Supply Air Flow Rate During Heating Operation
This numeric field defines the supply air flow rate leaving the unitary system in cubic meters
per second when the heating coil is operating. Values must be greater than 0 or this field is
autosizable. Required field when Supply Air Flow Rate Method During Heating Operation is
SupplyAirFlowRate.
Field: Supply Air Flow Rate Per Floor Area During Heating Operation
This numeric field defines the supply air flow rate per floor area leaving the unitary system in
meters per second when the heating coil is operating. Values must be greater than 0 or this
field is autosizable. Required field when Supply Air Flow Rate Method During Heating
Operation is FlowPerFloorArea.
Field: Fraction of Autosized Design Heating Supply Air Flow Rate
This numeric field defines the fraction of autosized supply air flow rate leaving the unitary
system when the heating coil is operating. Values must be greater than 0 or this field is
autosizable. Required field when Supply Air Flow Rate Method During Heating Operation is
FractionOfAutosizedHeatingValue.
Field: Design Supply Air Flow Rate Per Unit of Capacity During Heating Operation
This numeric field defines the supply air flow rate per unit of capacity leaving the unitary
system when the heating coil is operating. Values must be greater than 0 or this field is
autosizable. Required field when Supply Air Flow Rate Method During Heating Operation is
FlowPerHeatingCapacity.
Field: Supply Air Flow Rate Method When No Cooling or Heating is Needed
This alpha field defines the supply air flow method when neither cooling or heating is
required.
Available
choices
are
SupplyAirFlowRate,
FlowPerFloorArea,
FractionOfAutosizedCoolingValue,
FractionOfAutosizedHeatingValue,
9/29/14

1030

Input-Output Reference

Group Unitary Equipment

FlowPerCoolingCapacity, FlowPerHeatingCapacity. For each of the choices, corresponding

air flow rate must be specified.
Field: Supply Air Flow Rate When No Cooling or Heating is Needed
This numeric field defines the supply air flow rate leaving the unitary system in cubic meters
per second when neither cooling or heating is required (i.e., main cooling/heating coils and
supplemental heater are off but the supply air fan operates). This field is only used when the
unitary system operating mode is specified as continuous fan operation. Values must be
greater than or equal to zero, or this field is autosizable. If the unitary system operating mode
is specified as continuous fan operation and this value is set to zero or this field is left blank,
then the model assumes that the supply air flow rate when no cooling/heating is needed is
equal to the supply air flow rate when the compressor was last operating (for cooling
operation or heating operation).
Field: Supply Air Flow Rate Per Floor Area When No Cooling or Heating is Needed
This numeric field defines the supply air flow rate per floor area leaving the unitary system in
meters per second when neither cooling or heating coil is operating. Values must be greater
than 0 or this field is autosizable. Required field when Supply Air Flow Rate Method During
Heating Operation is FlowPerFloorArea.
Field: Fraction of Autosized Design Cooling Supply Air Flow Rate When No Cooling or
Heating is Needed
This numeric field defines the fraction of autosized supply air flow rate leaving the unitary
system when neither cooling or heating coil is operating. Values must be greater than 0 or
this field is autosizable. Required field when Supply Air Flow Rate Method During Cooling
Operation is FractionOfAutosizedCoolingValue.
Field: Fraction of Autosized Design Heating Supply Air Flow Rate When No Cooling or
Heating is Needed
This numeric field defines the fraction of autosized supply air flow rate leaving the unitary
system when the neither cooling or heating coil is operating. Values must be greater than 0 or
this field is autosizable. Required field when Supply Air Flow Rate Method During Heating
Operation is FractionOfAutosizedHeatingValue.
Field: Design Supply Air Flow Rate Per Unit of Capacity During Cooling Operation When
No Cooling or Heating is Needed
This numeric field defines the supply air flow rate per unit of capacity leaving the unitary
system when neither cooling or heating is operating. Values must be greater than 0 or this
field is autosizable. Required field when Supply Air Flow Rate Method During Cooling
Operation is FlowPerCoolingCapacity.
Field: Design Supply Air Flow Rate Per Unit of Capacity During Heating Operation When
No Cooling or Heating is Needed
This numeric field defines the supply air flow rate per unit of capacity leaving the unitary
system when neither cooling or heating is operating. Values must be greater than 0 or this
field is autosizable. Required field when Supply Air Flow Rate Method During Heating
Operation is FlowPerHeatingCapacity.
Field: Maximum Supply Air Temperature
This numeric field contains the design operating air outlet temperature in degrees C when the
unitary system is heating. If this input field is left blank, the default value is 80 C.

9/29/14

1031

Input-Output Reference

Group Unitary Equipment

Field: Maximum Outdoor Dry-Bulb Temperature for Supplemental Heater Operation

This numeric field defines the outdoor air dry-bulb temperature above which the heat pump
supplemental heating coil is disabled. The temperature for this input field must be less than
or equal to 21 C. If this input field is left blank, the default value is 21 C.
Field: Outdoor Dry-Bulb Temperature Sensor Node Name
This alpha field specifies the name of the outdoor node which controls the operation of the
supplemental heating coil. If this field is left blank, the outdoor temperature is based solely on
the weather data. If this field is not blank, the node name specified must also be listed in an
OutdoorAir:Node object where the height of the node is taken into consideration when
calculating outdoor temperature from the weather data. Alternately, the node name must be
specified in an OutdoorAir:NodeList object where the outdoor temperature is taken directly
from the weather data.
Field: Maximum Cycling Rate
This numeric field contains the maximum on-off cycling rate for the compressor, which occurs
at 50% run time fraction. Suggested values are shown below (Henderson et al. 1999):
Heat Pump Condition Recommended Values
Typical
2.5
Good
2.5
Poor
3.0

Field: Heat Pump Time Constant

This numeric field contains the time constant for the cooling coil's capacity to reach steady
state after startup. Suggested values are shown below (Henderson et al. 1999):
Heat Pump Condition Recommended Values
Typical
60
Good
60
Poor
60

Field: Fraction of On-Cycle Power Use

This numeric field contains the fraction of on-cycle power use to adjust the part load fraction
based on the off-cycle power consumption due to crankcase heaters, controls, fans, and etc.
Suggested value values are below (Henderson et al. 1999):
Heat Pump Condition Recommended Values
Typical
0.01
Good
0.01
Poor
0.03

Field: Heat Pump Fan Delay Time

This numeric field contains the time delay for the heat pump supply air fan to shut off after the
compressor cycles off in seconds. This value can be obtained from the manufacturer or the
heat pump catalog. Enter a value of zero when the heat pumps fan operating mode is
continuous. Suggested value is 60 seconds.
Field: Ancilliary On-Cycle Electric Power
This field defines ancilliary electrical power (W) consumed during the on-cycle period (i.e.,
when the cooling or heating coil is operating). The model assumes that this ancilliary power
does not contribute to heating the supply air. The minimum value for this field is 0.0, and the
default value is also 0.0 if the field is left blank.

9/29/14

1032

Input-Output Reference

Group Unitary Equipment

Field: Ancilliary Off-Cycle Electric Power

This field defines ancilliary electrical power (W) consumed during the off-cycle period (i.e.,
when the cooling and heating coil are not operating). The model assumes that this ancilliary
power does not contribute to heating the supply air. The minimum value for this field is 0.0,
and the default value is also 0.0 if the field is left blank.
Field: Design Heat Recovery Water Flow Rate
This optional input field defines the design water flow rate used if the heat recovery option is
being simulated. If this value is greater than 0.0 then a heat recovery loop must be specified
and attached to the multispeed heat pump using the next 2 node fields. To determine how the
heat recovery algorithm works, refer to the EnergyPlus Engineering Reference in the
AirLoopHVAC:UnitarySystem with Heat Recovery section. The units for this input value are
cubic meters per second.
Field: Maximum Temperature for Heat Recovery
This field sets the maximum temperature (in degrees C) that this heat pump can produce for
heat recovery. The idea behind this field is that the current models do not take temperatures
into account for availability and they just pass Q's around the loop without a temperature limit.
This temperature limit puts an upper bound on the recovered heat and limits the max
temperature leaving the component.
As temperatures in the loop approach the maximum temperature, the temperature difference
between the entering water and the surfaces in the piece of equipment becomes smaller. For
the given heat recovery flow rate and that temperature difference the amount of heat
recovered will be reduced, and eventually there will be no heat recovered when the entering
water temperature is equal to the maximum temperature specified by the user in this field.
The reduced amount of heat recovered will diminish if the temperature of the loop approach
is the maximum temperature, and this will show up in the reporting. This allows the user to
set the availability or the quality of the heat recovered for usage in other parts of the system
or to heat domestic hot water supply.
Field: Heat Recovery Water Inlet Node Name
This alpha field contains the identifying name for the heat recovery side inlet node.
Field: Heat Recovery Water Outlet Node Name
This alpha field contains the identifying name for the heat recovery side outlet node.
Field: Design Specification Multispeed Heat Pump Object Type
This alpha field contains the identifying type for the design specification multispeed object.
This field is only needed when multispeed cooling or heating coil is specified.
Field: Design Specification Multispeed Heat Pump Object Name
This alpha field contains the identifying name for the design specification multispeed object.
This field is only needed when multispeed cooling or heating coil is specified.
As shown in the example below, correct specification of the heat/cool unitary system requires
specification of the following objects in addition to the unitary system object:
1) Fan (Fan:OnOff or Fan:ConstantVolume)
2) Cooling coil
3) Heating coil
4) Reheat coil
5) Direct air unit (AirTerminal:SingleDuct:Uncontrolled) for each zone served by the unitary

system

9/29/14

1033

Input-Output Reference

Group Unitary Equipment

AirLoopHVAC:UnitarySystem,
DXAC Heat Pump 1,
!- Name
Load,
!- Control Type
East Zone,
!- Controlling Zone or Thermostat Location
,
!- Dehumidification Control Type
FanAndCoilAvailSched,
!- Availability Schedule Name
Mixed Air Node,
!- Air Inlet Node Name
Air Loop Outlet Node,
!- Air Outlet Node Name
Fan:OnOff,
!- Supply Air Fan Object Type
Supply Fan 1,
!- Supply Air Fan Name
BlowThrough,
!- Fan Placement
FanModeSchedule,
!- Supply Air Fan Operating Mode Schedule Name
Coil:Heating:DX:MultiSpeed, !- Heating Coil Object Type
Heat Pump DX Heating Coil 1, !- Heating Coil Name
,
!- DX Heating Coil Sizing Ratio
Coil:Cooling:DX:MultiSpeed, !- Cooling Coil Object Type
Heat Pump ACDXCoil 1,
!- Cooling Coil Name
,
!- Use DOAS DX Cooling Coil
,
!- DOAS DX Cooling Coil Leaving Minimum Air Temperature
,
!- Latent Load Control
Coil:Heating:Gas,
!- Supplemental Heating Coil Object Type
Supp Gas Heating Coil 1, !- Supplemental Heating Coil Name
SupplyAirFlowRate,
!- Supply Air Flow Rate Method During Cooling Operation
1.7,
!- Supply Air Flow Rate During Cooling Operation {m3/s}
,
!- Supply Air Flow Rate Per Floor Area During Cooling Opertation
,
!- Fraction of Autosized Design Cooling Supply Air Flow Rate
,
!- Design Supply Air Flow Rate Per Unit of Capacity During Cooling Operation
SupplyAirFlowRate,
!- Supply Air Flow Rate Method During Heating Operation
1.7,
!- Supply Air Flow Rate During Heating Operation {m3/s}
,
!- Supply Air Flow Rate Per Floor Area During Heating Opertation
,
!- Fraction of Autosized Design Heating Supply Air Flow Rate
,
!- Design Supply Air Flow Rate Per Unit of Capacity During Heating Operation
SupplyAirFlowRate,
!- Supply Air Flow Rate Method When No Cooling or Heating is Required
0.2,
!- Supply Air Flow Rate When No Cooling or Heating is Required {m3/s}
,
!- Supply Air Flow Rate Per Floor Area When No Cooling or Heating is Required
,
!- Fraction of Autosized Design Cooling Supply Air Flow Rate
,
!- Fraction of Autosized Design Heating Supply Air Flow Rate
,
!- Design Supply Air Flow Rate Per Unit of Capacity During Cooling Operation
,
!- Design Supply Air Flow Rate Per Unit of Capacity During Heating Operation
50,
!- Maximum Supply Air Temperature {C}
21, !- Maximum Outdoor Dry-Bulb Temperature for Supplemental Heater Operation
, !- Outdoor Dry-Bulb Temperature Sensor Node Name
, !- Maximum Cycling Rate
, !- Heat Pump Time Constant
, !- Fraction of On-Cycle Power Use
, !- Heat Pump Fan Delay Time
, !- Ancilliary On-Cycle Electric Power
, !- Ancilliary Off-Cycle Electric Power
, !- Design Heat Recovery Water Flow Rate
, !- Maximum Temperature for Heat Recovery (Maximum Heat Recovery Outlet Temperature?)
, !- Heat Recovery Water Inlet Node Name
, !- Heat Recovery Water Outlet Node Name
UnitarySystemPerformance:HeatPump:Multispeed, !- Design Specification Multispeed Heat Pump Object Type
MyMultispeedHPSpec; !- Design Specification Multispeed Heat Pump Object Name
UnitarySystemPerformance:HeatPump:Multispeed,
MyMultispeedHPSpec,
!- Name
4,
!- Number of Speeds for Heating
4,
!- Number of Speeds for Cooling
0.235294118,
!- Speed 1 Supply Air Flow Rate
0.235294118,
!- Speed 1 Supply Air Flow Rate
0.470588235,
!- Speed 2 Supply Air Flow Rate
0.470588235,
!- Speed 2 Supply Air Flow Rate
0.705882353,
!- Speed 3 Supply Air Flow Rate
0.705882353,
!- Speed 3 Supply Air Flow Rate
1.0,
!- Speed 4 Supply Air Flow Rate
1.0;
!- Speed 4 Supply Air Flow Rate

9/29/14

During
During
During
During
During
During
During
During

Heating
Cooling
Heating
Cooling
Heating
Cooling
Heating
Cooling

Operation
Operation
Operation
Operation
Operation
Operation
Operation
Operation

{m3/s}
{m3/s}
{m3/s}
{m3/s}
{m3/s}
{m3/s}
{m3/s}
{m3/s}

1034

Input-Output Reference

Group Unitary Equipment

Unitary System (AirLoopHVAC) Outputs

HVAC,Average, Unitary System Fan Part Load Ratio []
HVAC,Average, Unitary System Compressor Part Load Ratio
HVAC,Average,Unitary System Total Cooling Rate [W]
HVAC,Average,Unitary System Total Heating Rate [W]
HVAC,Average,Unitary System Sensible Cooling Rate [W]
HVAC,Average,Unitary System Sensible Heating Rate [W]
HVAC,Average,Unitary System Latent Cooling Rate [W]
HVAC,Average,Unitary System Latent Heating Rate [W]
HVAC,Average,Unitary System Ancillary Electric Power[W]
Two speed coil outputs
HVAC,Average,Unitary System Cycling Ratio []
Multi speed coil outputs
HVAC,Average,Unitary System DX Coil Cycling Ratio []
HVAC,Average,Unitary System DX Coil Speed Ratio []
HVAC,Average,Unitary System DX Coil Speed Level []
HVAC,Average,Unitary System Electric Power[W]
HVAC,Sum,Unitary System Electric Energy [J]
HVAC,Sum,Unitary System Cooling Ancillary Electric Energy [J]
HVAC,Sum,Unitary System Heating Ancillary Electric Energy [J]
Multi speed coil outputs(If heat recovery is specified)
HVAC,Average, Unitary System Heat Recovery Rate [W]
HVAC,Average, Unitary System Heat Recovery Inlet Temperature [C]
HVAC,Average, Unitary System Heat Recovery Outlet Temperature [C]
HVAC,Average, Unitary System Heat Recovery Fluid Mass Flow Rate [kg/s]
HVAC,Sum, Unitary System Heat Recovery Energy [J]
Water to air heat pump outputs
HVAC,Average, Unitary System Requested Sensible Cooling Rate [W]
HVAC,Average, Unitary System Requested Latent Cooling Rate [W]
HVAC,Average, Unitary System Requested Heating Rate [W]

Unitary System Fan Part Load Ratio []

This output variable is the ratio of actual air mass flow rate through the unitary system to the
unitary systems design air mass flow rate (i.e., design volumetric flow rate converted to dry
air mass flow rate). For continuous fan operation mode, this variable is always 1.0 when the
unitary system is available (based on the availability schedule). For cycling fan/cycling coil
operation mode, the actual air mass flow rate is calculated based on the ratio of the sensible
heating (or cooling) load to the steady-state unitary system heating (or cooling) capacity. For
the cycling fan mode, the runtime fraction for the unitary system fan may be different from the
fan part-load ratio reported here due the part-load performance of the unitary systems
heating (or cooling) coil (delay at start-up to reach steady-state output). In general, runtime
fractions are reported by individual components where appropriate (e.g., Fan:OnOff). When
the speed number is greater than 1, the value is 1.0.
Unitary System Compressor Part Load Ratio []
This output variable is the ratio of the sensible load (heating or cooling) to the steady-state
capacity of the unitary systems DX heating or cooling coil at Speed 1. The runtime fraction
for the unitary system compressor may be different from the compressor part-load ratio
reported here due the part-load performance of the heating/cooling coil (delay at start-up to
reach steady-state output). In general, runtime fractions are reported by individual
components where appropriate. When the speed number is greater than 1, the value is 1.0.
Unitary System DX Coil Cycling Ratio []
This output variable is the ratio of the sensible load (heating or cooling) to the steady-state
capacity of the unitary systems DX heating or cooling coil (Speed 1) for the entire system
timestep. The value is between 0.0 and 1.0 when the unitary system is cycling on and off its
lowest speed (Speed 1) and 1.0 when the unitary system operates at speeds above 1.

9/29/14

1035

Input-Output Reference

Group Unitary Equipment

Unitary System DX Coil Speed Ratio []

This output variable is the ratio of time in a system timestep that the compressor is at rated
speed between two consecutive speed numbers ( [Compressor Speed - Compressor speed
at Speed i-1] / [Compressor speed at Speed i - Compressor speed at Speed i-1]). The
compressor speed ratio reports (1.0 is max, 0.0 is min) and any value in between as it is
averaged over the timestep. The value is 0.0 during Speed 1 operation.
The physical meaning of the speed ratio is dependent on the compressor configuration
defined in the field of child coil object: Apply Part Load Fraction to Speeds greater than 1.
The allowed choice is either Yes or No. When No is entered, one compressor is assumed for
all speeds. The speed ratio represents how long the higher speed runs as a fraction of the
system timestep, and the lower speed runs in the rest of the system timestep. When Yes is
entered, multiple compressors are assumed, and each compressor has associated speed.
The speed ratio represents how long the higher speed runs as a fraction of the system
timestep, and the low speed runs in a whole system timestep.
Unitary System DX Coil Speed Level []
This output variable reports the maximum speed needed when the unitary system operates to
meet the sensible load (heating or cooling) in a system timestep. When the value is 1, the
unitary system operates at Speed 1 (lowest speed). For this case the cycling ratio is between
0.0 and 1.0, while the speed ratio is 0.0. When the speed number output variable is above
one, such as i, the unitary system operation is determined by the speed ratio through linear
interpolation. For example, when the speed ratio is 0.4 and the speed number is 3, the
unitary system operates at Speed 3 for 40% of a system timestep and at Speed 2 for 60% of
a system timestep for a single compressor. For multiple compressors, the unitary system
operates at Speed 3 in the 40% of a system timestep and at Speed 2 in the whole system
timestep.
Unitary System Total Heating Rate [W]
This output field is the total (enthalpy) heat addition rate of the unitary system to the zones it
is serving in Watts. This value is calculated using the enthalpy difference of the unitary
system outlet air and inlet air streams, and the air mass flow rate through the unitary system.
This value is calculated for each HVAC system timestep being simulated, and the results
(enthalpy addition only) are averaged for the timestep being reported.
Unitary System Total Cooling Rate [W]
This output field is the total (enthalpy) heat extraction rate of the unitary system from the
zones it is serving in Watts. This value is calculated using the enthalpy difference of the
unitary system outlet air and inlet air streams, and the air mass flow rate through the unitary
system. This value is calculated for each HVAC system timestep being simulated, and the
results (enthalpy extraction only) are averaged for the timestep being reported.
Unitary System Sensible Heating Rate [W]
This output field reports the sensible heat addition rate of the unitary system to the zones it is
serving in Watts. This value is calculated using the enthalpy difference of the unitary system
outlet air and inlet air streams at a constant humidity ratio, and the air mass flow rate through
the unitary system. This value is calculated for each HVAC system timestep being simulated,
and the results (heating only) are averaged for the timestep being reported.
Unitary System Sensible Cooling Rate [W]
This output field reports the moist air sensible heat extraction rate of the unitary system from
the zones it is serving in Watts. This value is calculated using the enthalpy difference of the
unitary system outlet air and inlet air streams at a constant humidity ratio, and the air mass
flow rate through the unitary system. This value is calculated for each HVAC system timestep
being simulated, and the results (cooling only) are averaged for the timestep being reported.

9/29/14

1036

Input-Output Reference

Group Unitary Equipment

Unitary System Latent Heating Rate [W]

This output field is the latent heat addition (humidification) rate of the unitary system in Watts.
This value is calculated as the difference between the total energy rate and the sensible
energy rate provided by the unitary system. This value is calculated for each HVAC system
timestep being simulated, and the results (latent heat addition only) are averaged for the
timestep being reported.
Unitary System Latent Cooling Rate [W]
This output field is the latent heat extraction (dehumidification) rate of the unitary system in
Watts. This value is calculated as the difference between the total energy rate and the
sensible energy rate provided by the unitary system. This value is calculated for each HVAC
system timestep being simulated, and the results (latent heat extraction only) are averaged
for the timestep being reported.
Unitary System Electric Power [W]
This output field is the electricity consumption rate of the unitary system in Watts. The
consumption includes electricity used by the DX coils (including crankcase heater if the fuel
type is electricity), fans (indoor supply air fan and the condenser fans associated with the DX
coil[s]), auxiliary power during on and off period, and the supplemental heating coil (if
electric). This value is calculated for each HVAC system timestep being simulated, and the
results are averaged for the timestep being reported. Any non-electric energy use is not
reported by the unitary system object but is reported in the associated coil objects as
appropriate.
Unitary System Electric Energy [J]
This output field is the electricity consumption of the unitary system in Joules for the timestep
being reported. The consumption includes electricity used by the DX compressor (including
crankcase heater if the fuel type is electricity), fans (indoor supply air fan and the condenser
fans associated with the DX coil[s]), auxiliary power during on and off period, and the
supplemental heating coil (if electric). This value is calculated for each HVAC system
timestep being simulated, and the results are summed for the timestep being reported. Any
non-electric energy use is not reported by the unitary system object but is reported in the
associated coil objects as appropriate.
Unitary System Ancillary Electric Power [W]
This output field is the average auxiliary electricity consumption rate (including both on-cycle
and off-cycle) in Watts for the timestep being reported.
Unitary System Cooling Ancillary Electric Energy [J]
This is the auxiliary electricity consumption in Joules for the timestep being reported. This is
the auxiliary electricity consumption during periods when the unitary system is providing
cooling (DX cooling coil is operating). This output is also added to a meter with Resource
Type = Electricity, End Use Key =Cooling, Group Key = System (ref. Output:Meter objects).
Unitary System Heating Ancillary Electric Energy [J]
This is the auxiliary electricity consumption in Joules for the timestep being reported. This is
the auxiliary electricity consumption during periods when the unitary system is providing
heating (DX heating coil is operating). This output is also added to a meter with Resource
Type = Electricity, End Use Key =Heating, Group Key = System (ref. Output:Meter objects).

9/29/14

1037

Input-Output Reference

Group Unitary Equipment

Unitary System Heat Recovery Inlet Temperature [C]

Unitary System Heat Recovery Outlet Temperature [C]
Unitary System Heat Recovery Fluid Mass Flow Rate [kg/s]
These outputs are the heat recovery inlet and outlet temperatures and water mass flow rate
for unitary systems with heat recovery.
Unitary System Heat Recovery Rate [W]
Unitary System Heat Recovery Energy [J]
For multispeed unitary systems with heat recovery, these outputs are the recoverable energy
rate (in Watts) and energy (in Joules).
Unitary System Requested Sensible Cooling Rate [W]
This output variable is the sensible cooling requested from the zone thermostat in watts. This
value is calculated using the unitary system outlet air and zone conditions, the specific heat
of the zone air, and the supply air mass flow rate entering/leaving the system. This value is
calculated for each HVAC system timestep being simulated, and the results are averaged for
the timestep being reported.
Unitary System Requested Latent Cooling Rate [W]
This output variable is the latent cooling requested from the zone humidistat in watts. This
value is calculated using the unitary system outlet air and zone conditions, the heat of
vaporization of water at the current zone conditions, and the supply air mass flow rate
entering/leaving the system. This value is calculated for each HVAC system timestep being
simulated, and the results are averaged for the timestep being reported.
Unitary System Requested Heating Rate [W]
This output variable is the sensible heating requested from the zone thermostat in watts. This
value is calculated using the unitary system outlet air and zone conditions, the specific heat
of the zone air, and the supply air mass flow rate entering/leaving the system. This value is
calculated for each HVAC system timestep being simulated, and the results are averaged for
the timestep being reported.
UnitarySystemPerformance:HeatPump:Multispeed
Field: Name
This alpha field contains the identifying name for the multispeed performance specification.
Field: Number of Speeds for Heating
This field defines the number of heating speeds for the heat pump, and must match the
number of heating speeds defined in the associated heating coil. The value for this input field
defines the number of airflow rate ratios that must be defined for heating in the fields below.
The minimum value for this field is one and the maximum value is the number specified in the
coil object. If the heating coil type used in the unitary system object is not a multispeed coil
type, then this field should be 1.
Field: Number of Speeds for Cooling
This field defines the number of cooling speeds for the heat pump, and must match the
number of cooling speeds defined in the associated DX cooling coil. The value for this input
field defines the number of airflow rate ratios that must be defined for cooling in the fields
below. The minimum value for this field is one and the maximum value is the number
specified in the coil object. If the cooling coil type used in the unitary system object is not a
multispeed coil type, then this field should be 1.

9/29/14

1038

Input-Output Reference

Group Unitary Equipment

Field: Speed 1 Supply Air Flow Ratio During Heating Operation

This numeric field defines the ratio of supply air flow rate leaving the unitary system to the
maximum air flow rate specified in the coil object at maximum speed when the heating coil
and/or supplemental heater are operating at Speed 1 (lowest speed). Values must be greater
than 0.
Field: Speed 1 Supply Air Flow Ratio During Cooling Operation
This numeric field defines the ratio of supply air flow rate leaving the unitary system to the
maximum air flow rate specified in the coil object at maximum speed when the DX cooling
coil is operating at Speed 1 (lowest speed). Values must be greater than 0.
Field: Speed 2 Supply Air Flow Ratio During Heating Operation
This numeric field defines the ratio of supply air flow rate leaving the unitary system to the
maximum air flow rate specified in the coil object at maximum speed when the heating coil
and/or supplemental heater are operating at Speed 2. Values must be greater than 0. The
entered value must be greater or equal to the flow rate ratio specified for heating speed 1.
Field: Speed 2 Supply Air Flow Ratio During Cooling Operation
This numeric field defines the ratio of supply air flow rate leaving the unitary system to the
maximum air flow rate specified in the coil object at maximum speed when the DX cooling
coil is operating at Speed 2. Values must be greater than 0. The entered value must be
greater or equal to the flow rate ratio specified for cooling speed 1.
Field: Speed 3 Supply Air Flow Ratio During Heating Operation
This numeric field defines the ratio of supply air flow rate leaving the unitary system to the
maximum air flow rate specified in the coil object at maximum speed when the heating coil
and/or supplemental heater are operating at Speed 3. Values must be greater than 0. The
entered value must be greater or equal to the flow rate ratio specified for heating speed 2. If
the Number of Speeds for Heating is less than 3, then this field can be left blank.
Field: Speed 3 Supply Air Flow Ratio During Cooling Operation
This numeric field defines the ratio of supply air flow rate leaving the unitary system to the
maximum air flow rate specified in the coil object at maximum speed when the DX cooling
coil is operating at Speed 3. Values must be greater than 0. The entered value must be
greater or equal to the flow rate ratio specified for cooling speed 2. If the Number of Speeds
for Cooling is less than 3, then this field can be left blank.
Field: Speed 4 Supply Air Flow Ratio During Heating Operation
This numeric field defines the ratio of supply air flow rate leaving the unitary system to the
maximum air flow rate specified in the coil object at maximum speed when the DX heating
coil and/or supplemental heater are operating at Speed 3. Values must be greater than 0.
The entered value must be greater or equal to the flow rate ratio specified for heating Speed
3. If the Number of Speeds for Heating is less than 4, then this field can be left blank.
Field: Speed 4 Supply Air Flow Ratio During Cooling Operation
This numeric field defines the ratio of supply air flow rate leaving the unitary system to the
maximum air flow rate specified in the coil object at maximum speed when the DX cooling
coil is operating at Speed 4. Values must be greater than 0. The entered value must be
greater or equal to the flow rate ratio specified for cooling Speed 3. If the Number of Speeds
for Cooling is less than 4, then this field can be left blank.
AirLoopHVAC:Unitary:Furnace:HeatCool
The heat/cool furnace is a virtual component that consists of a fan component (OnOff or
ConstantVolume), a DX cooling coil component, and a Gas or Electric heating coil
9/29/14

1039

Input-Output Reference

Group Unitary Equipment

component. The blow through furnace configuration is shown in Figure 116 below. When a
draw through furnace configuration is desired, the fan is placed directly after the heating coil.
If the dehumidification control type is specified as CoolReheat, a reheat coil component is
also required. If the reheat coil is present and the dehumidification control type input is not
specified as CoolReheat, the reheat coil will not be active,

Figure 116. Schematic of EnergyPlus Heat/Cool Furnace

Note: the coil order shown here has been revised from previous versions (prior to V4.0) of Energyplus to
configure the cooling coil upstream of the heating coil. This configuration provides uniformity with all
unitary equipment. However, for unitary HeatCool systems that do not use a reheat coil, the heating coil
can also be placed upstream of the cooling coil. This optional coil placement is retained to allow
compatibility with previous versions of Energyplus. For input files developed using previous versions of
Energyplus, it is recommended that the coil order be revised according to the figure above.

Links to the fan, heating coil, DX cooling coil and optional reheat coil specifications are
provided in the furnace input data syntax. In addition, the control zone name and the furnace
design operating conditions are specified by the furnace inputs.
Field: Name
This alpha field contains the identifying name for the unit.
Field: Availability Schedule Name
This alpha field contains the schedule name which contains information on the availability of
the furnace to operate. A schedule value equal to 0 denotes that the furnace must be off for
that time period. A value greater than 0 denotes that the furnace is available to operate
during that time period. This schedule may be used to completely disable the furnace as
required. If this field is left blank, the schedule has a value of 1 for all time periods.
Field: Furnace Air Inlet Node Name
This alpha field contains the furnace inlet node name.

9/29/14

1040

Input-Output Reference

Group Unitary Equipment

Field: Furnace Air Outlet Node Name

This alpha field contains the furnace outlet node name.
Field: Supply Air Fan Operating Mode Schedule Name
This alpha field specifies the name of the supply air fan operating mode schedule. The supply
air fan operating mode may vary during the simulation based on time-of-day or with a change
of season. Schedule values of 0 denote that the furnace supply air fan and the heating or
cooling coil cycle on and off together to meet the heating or cooling load (a.k.a. AUTO fan).
Schedule values other than 0 denote that the supply fan runs continuously while the heating
or cooling coil cycles to meet the load.
Field: Maximum Supply Air Temperature
This numeric field contains the design operating furnace air outlet temperature in degrees C
when the furnace is heating. If this input field is left blank, the default value is 80 C.
Field: Supply Air Flow Rate During Cooling Operation
This numeric field defines the supply air flow rate leaving the furnace in cubic meters per
second when the DX cooling coil is operating. Values must be greater than 0 or this field is
autosizable.
Field: Supply Air Flow Rate During Heating Operation
This numeric field defines the supply air flow rate leaving the furnace in cubic meters per
second when the DX heating coil and/or supplemental heater are operating. Values must be
greater than 0 or this field is autosizable.
Field: Supply Air Flow Rate When No Cooling or Heating is Needed
This numeric field defines the supply air flow rate leaving the furnace in cubic meters per
second when neither cooling or heating is required (i.e., DX coils and supplemental heater
are off but the supply air fan operates). This field is only used when the furnace operating
mode is specified as continuous fan operation. Values must be greater than or equal to zero,
or this field is autosizable. If the furnace operating mode is specified as continuous fan
operation and this value is set to zero or this field is left blank, then the model assumes that
the supply air flow rate when no cooling/heating is needed is equal to the supply air flow rate
when the compressor was last operating (for cooling operation or heating operation).
Field: Controlling Zone or Thermostat Location
This alpha field contains the identifying zone name where the thermostat controlling the
furnace is located.
Field: Supply Fan Object Type
This alpha field contains the identifying type of supply air fan specified for the furnace. Fan
type must be Fan:OnOff or Fan:ConstantVolume. Fan:ConstantVolume is used when the
Supply Air Fan Operating Mode Schedule values are never 0 and the fan operates
continuously. Fan:OnOff is used when the fan cycles on and off with the cooling or heating
coil (i.e. Supply Air Fan Operating Mode Schedule values are at times 0).
Field: Supply Fan Name
This alpha field contains the identifying name given to the furnace fan.
Field: Fan Placement
This alpha field has two choices: BlowThrough or DrawThrough. The first choice stands for
blow through fan. This means that the unit consists of a fan followed by the DX coils and
supplemental heating coil. The fan blows through the cooling and heating coils. The second
choice stands for draw through fan. This means that the unit consists of the DX coil(s)

9/29/14

1041

Input-Output Reference

Group Unitary Equipment

followed by a fan, with the supplemental heater located at the outlet of the fan. The fan
draws air through the DX coil(s). If this field is left blank, the default is blow through.
Field: Heating Coil Object Type
This alpha field contains the identifying type of heating coil specified in the furnace. The hot
water and steam heating coils require specifying plant loop, branches, and connector objects
to support the heating coils, and are placed on the demand side of the plantloop. The hot
water flow modulation through the heating coil does not require additional controller or
Controller:WaterCoil object. The parent object (Unitary Heat and Cool Furnace) itself
provides the "controller" function of modulating water flow. Allowable coil types are:
Coil:Heating:Electric
Coil:Heating:Gas
Coil:Heating:Water
Coil:Heating:Steam

Field: Heating Coil Name

This alpha field contains the identifying name given to the furnace heating coil.
Field: Cooling Coil Object Type
This alpha field contains the identifying type of cooling coil specified in the furnace. Only
allowable coil types are:
Coil:Cooling:DX:SingleSpeed
CoilSystem:Cooling:DX:HeatExchangerAssisted
Coil:Cooling:DX:VariableSpeed

Field: Cooling Coil Name

This alpha field contains the identifying name given to the furnace cooling coil.
Field: Dehumidification Control Type
This alpha field contains the type of dehumidification control. The following options are valid
for this field:
None - meet sensible load only, no active dehumidification control
Multimode - activate enhanced dehumidification mode as needed and meet sensible
load. This option is used to model DX equipment with a controllable heat exchanger
assisting the DX cooling coil for improved dehumidification. It is valid only with
cooling coil type = CoilSystem:Cooling:DX:HeatExchangerAssisted.
CoolReheat - cool beyond the dry-bulb temperature set point as required to meet the
high
humidity
setpoint.
If
cooling
coil
type
=
CoilSystem:Cooling:DX:HeatExchangerAssisted, then the heat exchanger is
assumed to always transfer energy between the cooling coils inlet and outlet
airstreams when the cooling coil is operating.
The default is None. For the other dehumidification control modes, the maximum humidity
setpoint is used. This must be set using a ZoneControl:Humidistat object. When extra
dehumidification is required, the system may not be able to meet the humidity setpoint if its
full capacity is not adequate. If the dehumidification control type is specified as CoolReheat,
then two additional inputs (reheat coil type and name) are also required as shown below.
Although the reheat coil is required only when CoolRheat is selected, the optional reheat coil
may be present for any of the allowed Dehumidification Control Types. If the reheat coil is
present and the dehumidification control type is not specified as CoolReheat, the reheat coil
will not be active,
Field: Reheat Coil Object Type
This alpha field contains the identifying type of reheat coil specified in the furnace. The hot
water and steam heating coils require specifying plant loop, branches, and connector objects
9/29/14

1042

Input-Output Reference

Group Unitary Equipment

to support the heating coils, and are placed on the demand side of the plantloop. The hot
water flow modulation through the reheat coil does not require additional controller or
Controller:WaterCoil object. The parent object (Unitary Heat and Cool Furnace) itself
provides the "controller" function of modulating water flow. Reheat coil type must be one of:
Coil:Heating:Electric
Coil:Heating:Gas
Coil:Heating:Desuperheater
Coil:Heating:Water
Coil:Heating:Steam

Field: Reheat Coil Name

This alpha field contains the identifying name given to the furnace reheat coil.
As shown in the example below, correct specification of the heat/cool furnace requires
specification of the following objects in addition to the furnace object:
1) fan (Fan:OnOff or Fan:ConstantVolume)
2) cooling

coil
(Coil:Cooling:DX:SingleSpeed
CoilSystem:Cooling:DX:HeatExchangerAssisted)

or

3) heating coil (Coil:Heating:Gas or Coil:Heating:Electric)

4) reheat

coil
(optional,
Coil:Heating:Desuperheater)

Coil:Heating:Gas,

Coil:Heating:Electric,

or

5) terminal unit (AirTerminal:SingleDuct:Uncontrolled) for each zone served by the furnace

Note: the furnaces fan, cooling coil, heating coil and optional reheat coil must be connected in the air loop
according to the configuration shown above (Figure 116) when CoolReheat is selected as the
dehujmidificaiton control type. In addition, the volumetric air flow rate specified in the terminal air unit for
the controlling zone should properly reflect the fractional volumetric air flow rate specified in the furnace
object.

AirLoopHVAC:Unitary:Furnace:HeatCool,
GasHeat DXAC Furnace 1, !- Name of furnace
FanAndCoilAvailSched,
!- Availability schedule
Air Loop Inlet Node,
!- Furnace inlet node name
Air Loop Outlet Node,
!- Furnace outlet node name
CycFanSchedule,
!- Supply Air Fan Operating Mode Schedule Name
80,
!- Maximum supply air temperature from furnace heater {C}
1.3,
!- Supply air volumetric flow rate during cooling operation {m3/s}
1.3,
!- Supply air volumetric flow rate during heating operation {m3/s}
0.0,
!- Design air volumetric flow rate when no heating or cooling is needed {m3/s}
East Zone, !- Controlling zone or thermostat location
Fan:OnOff,
!- Supply fan type
Supply Fan 1,
!- Supply fan name
BlowThrough,
!- Fan Placement
Coil:Heating:Gas,
!- Heating coil type
Furnace Heating Coil 1, !- Heating coil name
Coil:Cooling:DX:SingleSpeed, !- Cooling coil type
Furnace ACDXCoil 1,
!- Cooling coil name
None;
!- Dehumidificatioin Control Type

Coil:Heating:Gas,
Furnace Heating Coil 1,
!- Coil Name
FanAndCoilAvailSched,
!- Availability Schedule Name
0.8,
!- Gas Burner Efficiency of the Coil
25000, !- Nominal Capacity of the Coil {W}
Heating Coil Air Inlet Node,
!- Coil_Air_Inlet_Node
Air Loop Outlet Node;
!- Coil_Air_Outlet_Node

9/29/14

1043

Input-Output Reference

Group Unitary Equipment

Coil:Cooling:DX:SingleSpeed,
Furnace ACDXCoil 1,
!- Coil Name
FanAndCoilAvailSched, !- Availability Schedule
25000, !- Rated Total Cooling Capacity (gross) {W}
0.75,
!- Rated SHR
3.0,
!- Rated COP
1.3,
!- Rated Air Volume Flow Rate {m3/s}
DX Cooling Coil Air Inlet Node, !- Coil Air Inlet Node
Heating Coil Air Inlet Node,
!- Coil Air Outlet Node
WindACCoolCapFT, !- Total Cooling Capacity Modifier Curve (function of temperature)
WindACCoolCapFFF, !- Total Cooling Capacity Modifier Curve (function of flow fraction)
WindACEIRFT,
!- Energy Input Ratio Modifier Curve (function of temperature)
WindACEIRFFF,
!- Energy Input Ratio Modifier Curve (function of flow fraction)
WindACPLFFPLR,
!- Part Load Fraction Correlation (function of part load ratio)
CyclingFanAndCompressor;
!- Supply Air Fan Operation Mode

Fan:OnOff,
Supply Fan 1,
!- Fan Name
FanAndCoilAvailSched,
!- Availability Schedule Name
0.7,
!- Fan Total Efficiency
600.0, !- Delta Pressure {Pa}
1.3,
!- Max Flow Rate {m3/s}
0.9,
!- Motor Efficiency
1.0,
!- Motor In Airstream Fraction
Air Loop Inlet Node,
!- Fan_Inlet_Node
DX Cooling Coil Air Inlet Node; !- Fan_Outlet_Node
AirTerminal:SingleDuct:Uncontrolled,
Zone1DirectAir,
!- Direct Air Name
FanAndCoilAvailSched, !- Schedule name for on/off schedule
Zone 1 Inlet Node,
!- Zone Supply Air Node Name
0.47; !- Maximum air flow rate {m3/s}
AirTerminal:SingleDuct:Uncontrolled,
Zone2DirectAir,
!- Direct Air Name
FanAndCoilAvailSched, !- Schedule name for on/off schedule
Zone 2 Inlet Node,
!- Zone Supply Air Node Name
0.36; !- Maximum air flow rate {m3/s}
AirTerminal:SingleDuct:Uncontrolled,
Zone3DirectAir,
!- Direct Air Name
FanAndCoilAvailSched, !- Schedule name for on/off schedule
Zone 3 Inlet Node,
!- Zone Supply Air Node Name
0.47; !- Maximum air flow rate {m3/s}

Example of Heat/Cool Furnace Specification

Unitary System/Furnace Heat and Cool (AirLoopHVAC) Outputs
HVAC,Average,Unitary System Fan Part Load Ratio []
HVAC,Average,Unitary System Compressor Part Load Ratio []

Unitary System Fan Part Load Ratio

This output variable is the ratio of actual air mass flow rate through the furnace to the
furnaces design air mass flow rate (i.e., design volumetric flow rate converted to dry air mass
flow rate). For continuous fan operation mode, this variable is always 1.0 when the furnace is
available (based on the availability schedule). For cycling fan/cycling coil operation mode, the
actual air mass flow rate is calculated based on the ratio of the sensible heating (or cooling)
load to the steady-state furnace heating (or cooling) capacity. For the cycling fan mode, the
runtime fraction for the furnace fan may be different from the fan part-load ratio reported here
due the part-load performance of the furnaces heating (or cooling) coil (delay at start-up to
reach steady-state output). In general, runtime fractions are reported by individual
components where appropriate (e.g., Fan:OnOff).
Unitary System Compressor Part Load Ratio []

9/29/14

1044

Input-Output Reference

Group Unitary Equipment

AirLoopHVAC:UnitaryHeatCool
The
AirLoopHVAC:UnitaryHeatCool
object
is
the
identical
model
to
the
AirLoopHAVC:Unitary:Furnace:HeatCool object. The heat/cool unitary system is a virtual
component that consists of a fan component (OnOff or ConstantVolume), a DX cooling coil
component and a Gas or Electric heating coil component as shown in Figure 117. When a
draw through configuration is desired, the fan is placed directly after the heating coil. If
dehumidification control is selected, a reheat coil component is also required. If the reheat
coil is present and the dehumidification control type input is not specified as CoolReheat, the
reheat coil will not be active,

Figure 117. Schematic of Blow Through Heat/Cool Unitary System

Note: the coil order shown here has been revised from previous versions (prior to V4.0) of Energyplus to
configure the cooling coil upstream of the heating coil. This configuration provides uniformity with all
unitary equipment. However, for unitary HeatCool systems that do not use a reheat coil, the heating coil
can also be placed upstream of the cooling coil. This optional coil placement is retained to allow
compatibility with previous versions of Energyplus. For input files developed using previous versions of
Energyplus, it is recommended that the coil order be revised according to the figure above.

Links to the fan, DX cooling coil, heating coil and optional reheat coil specifications are
provided in the unitary system input data syntax. In addition, the control zone name and the
system design operating conditions are specified by the unitary system inputs.
Field: Name
This alpha field contains the identifying name for the unitary system.
Field: Availability Schedule Name
This alpha field contains the schedule name which contains information on the availability of
the unitary system to operate. A schedule value equal to 0 denotes that the unitary system
must be off for that time period. A value greater than 0 denotes that the unitary system is
available to operate during that time period. This schedule may be used to completely disable
9/29/14

1045

Input-Output Reference

Group Unitary Equipment

the unitary system as required. If this field is left blank, the schedule has a value of 1 for all
time periods.
Field: Unitary System Air Inlet Node Name
This alpha field contains the unitary system inlet node name.
Field: Unitary System Air Outlet Node Name
This alpha field contains the unitary system outlet node name.
Field: Supply Air Fan Operating Mode Schedule Name
This alpha field specifies the name of the supply air fan operating mode schedule. The supply
air fan operating mode may vary during the simulation based on time-of-day or with a change
of season. Schedule values of 0 denote that the unitary system supply air fan and the heating
or cooling coil cycle on and off together to meet the heating or cooling load (a.k.a. AUTO fan).
Schedule values other than 0 denote that the supply fan runs continuously while the heating
or cooling coil cycles to meet the load.
Field: Maximum Supply Air Temperature
This numeric field contains the design operating air outlet temperature in degrees C when the
unitary system is heating. If this input field is left blank, the default value is 80 C.
Field: Supply Air Flow Rate During Cooling Operation
This numeric field defines the supply air flow rate leaving the unitary system in cubic meters
per second when the DX cooling coil is operating. Values must be greater than 0 or this field
is autosizable.
Field: Supply Air Flow Rate During Heating Operation
This numeric field defines the supply air flow rate leaving the unitary system in cubic meters
per second when the DX heating coil and/or supplemental heater are operating. Values must
be greater than 0 or this field is autosizable.
Field: Supply Air Flow Rate When No Cooling or Heating is Needed
This numeric field defines the supply air flow rate leaving the unitary system in cubic meters
per second when neither cooling or heating is required (i.e., DX coils and supplemental
heater are off but the supply air fan operates). This field is only used when the unitary system
operating mode is specified as continuous fan operation. Values must be greater than or
equal to zero, or this field is autosizable. If the unitary system operating mode is specified as
continuous fan operation and this value is set to zero or this field is left blank, then the model
assumes that the supply air flow rate when no cooling/heating is needed is equal to the
supply air flow rate when the compressor was last operating (for cooling operation or heating
operation).
Field: Controlling Zone or Thermostat Location
This alpha field contains the identifying zone name where the thermostat controlling the
unitary system is located.
Field: Supply Fan Object Type
This alpha field contains the identifying type of supply air fan specified for the unitary system.
Fan type must be Fan:OnOff or Fan:ConstantVolume. Fan:ConstantVolume is used when
the Supply Air Fan Operating Mode Schedule values are never 0 and the fan operates
continuously. Fan:OnOff is used when the fan cycles on and off with the cooling or heating
coil (i.e. Supply Air Fan Operating Mode Schedule values are at times 0).
Field: Supply Fan Name
This alpha field contains the identifying name given to the unitary system fan.

9/29/14

1046

Input-Output Reference

Group Unitary Equipment

Field: Fan Placement

This alpha field has two choices: BlowThrough or DrawThrough. The first choice stands for
blow through fan. This means that the unit consists of a fan followed by the DX coils and
supplemental heating coil. The fan blows through the cooling and heating coils. The second
choice stands for draw through fan. This means that the unit consists of the DX coil(s)
followed by a fan, with the supplemental heater located at the outlet of the fan. The fan
draws air through the DX coil(s). If this field is left blank, the default is blow through.
Field: Heating Coil Object Type
This alpha field contains the identifying type of heating coil specified in the unitary system.
The hot water and steam heating coils require specifying plant loop, branches, and connector
objects to support the heating coils, and are placed on the demand side of the plantloop. The
hot water flow modulation through the heating coil does not require additional controller or
Controller:WaterCoil object. The parent object (Unitary Heat and Cool System) itself provides
the "controller" function of modulating water flow. Allowable coil types are:
Coil:Heating:Electric
Coil:Heating:Gas
Coil:Heating:Water
Coil:Heating:Steam

Field: Heating Coil Name

This alpha field contains the identifying name given to the unitary system heating coil.
Field: Cooling Coil Object Type
This alpha field contains the identifying type of cooling coil specified in the unitary system.
Only allowable coil types are:
Coil:Cooling:DX:SingleSpeed
CoilSystem:Cooling:DX:HeatExchangerAssisted
Coil:Cooling:DX:VariableSpeed

Field: Cooling Coil Name

This alpha field contains the identifying name given to the unitary system cooling coil.
Field: Dehumidification Control Type
This alpha field contains the type of dehumidification control. The following options are valid
for this field:
None - meet sensible load only, no active dehumidification control
Multimode - activate enhanced dehumidification mode as needed and meet sensible
load. This option is used to model DX equipment with a controllable heat exchanger
assisting the DX cooling coil for improved dehumidification. It is valid only with
cooling coil type = CoilSystem:Cooling:DX:HeatExchangerAssisted.
CoolReheat - cool beyond the dry-bulb temperature set point as required to meet the
high
humidity
setpoint.
If
cooling
coil
type
=
CoilSystem:Cooling:DX:HeatExchangerAssisted, then the heat exchanger is
assumed to always transfer energy between the cooling coils inlet and outlet
airstreams when the cooling coil is operating.
The default is None. For the other dehumidification control modes, the maximum humidity
setpoint is used. This must be set using a ZoneControl:Humidistat object. When extra
dehumidification is required, the system may not be able to meet the humidity setpoint if its
full capacity is not adequate. If the dehumidification control type is specified as CoolReheat,
then two additional inputs (reheat coil type and name) are also required as shown below.
Although the reheat coil is required only when CoolReheat is selected, the optional reheat
coil may be present for any of the allowed Dehumidification Control Types. If the reheat coil is

9/29/14

1047

Input-Output Reference

Group Unitary Equipment

present and the dehumidification control type is not specified as CoolReheat, the reheat coil
will not be active,
Field: Reheat Coil Object Type
This alpha field contains the identifying type of reheat coil specified in the unitary system. The
hot water and steam heating coils require specifying plant loop, branches, and connector
objects to support the heating coils, and are placed on the demand side of the plantloop. The
hot water flow modulation through the reheat coil does not require additional controller or
Controller:WaterCoil object. The parent object (Unitary Heat and Cool System) itself provides
the "controller" function of modulating water flow. Reheat coil type must be one of:
Coil:Heating:Electric
Coil:Heating:Gas
Coil:Heating:Desuperheater
Coil:Heating:Water
Coil:Heating:Steam

Field: Reheat Coil Name

This alpha field contains the identifying name given to the unitary system reheat coil.
As shown in the example below, correct specification of the heat/cool unitary system requires
specification of the following objects in addition to the unitary system object:
1) Fan (Fan:OnOff or Fan:ConstantVolume)
2) Cooling

coil
(Coil:Cooling:DX:SingleSpeed
CoilSystem:Cooling:DX:HeatExchangerAssisted)

or

3) Heating coil (Coil:Heating:Gas or Coil:Heating:Electric)

4) Reheat

coil
(optional,
Coil:Heating:Desuperheater)

Coil:Heating:Gas,

Coil:Heating:Electric,

or

5) Direct air unit (AirTerminal:SingleDuct:Uncontrolled) for each zone served by the unitary

system

Note: the unitary systems fan, cooling coil, heating coil and optional reheat coil must be connected in the
air loop according to the configuration shown above (Figure 117). In addition, the volumetric air flow rate
specified in the direct air unit for the controlling zone should properly reflect the fractional volumetric air
flow rate specified in the unitary system object.

AirLoopHVAC:Unitary:Furnace:HeatCool,
GasHeat DXAC Unitary System 1, !- Name of unitary system
FanAndCoilAvailSched,
!- Availability schedule
Air Loop Inlet Node,
!- Unitary system inlet node name
Air Loop Outlet Node,
!- Unitary system outlet node name
CycFanSchedule,
!- Supply Air Fan Operating Mode Schedule Name
80,
!- Maximum supply air temperature from unitary system heater {C}
1.3,
!- Supply air volumetric flow rate during cooling operation {m3/s}
1.3,
!- Supply air volumetric flow rate during heating operation {m3/s}
0.0,
!- Design air volumetric flow rate when no heating or cooling is needed {m3/s}
East Zone, !- Controlling zone or thermostat location
Fan:OnOff,
!- Supply fan type
Supply Fan 1,
!- Supply fan name
BlowThrough,
!- Fan Placement
Coil:Heating:Gas,
!- Heating coil type
Unitary System Heating Coil 1,
!- Heating coil name
Coil:Cooling:DX:SingleSpeed, !- Cooling coil type
Unitary System ACDXCoil 1,
!- Cooling coil name
None;
!- High humidity control

9/29/14

1048

Input-Output Reference

Group Unitary Equipment

Coil:Heating:Gas,
Unitary System Heating Coil 1, !- Coil Name
FanAndCoilAvailSched,
!- Availability Schedule Name
0.8,
!- Gas Burner Efficiency of the Coil
25000, !- Nominal Capacity of the Coil {W}
Heating Coil Air Inlet Node,
!- Coil_Air_Inlet_Node
Air Loop Outlet Node;
!- Coil_Air_Outlet_Node

Coil:Cooling:DX:SingleSpeed,
Unitary System ACDXCoil 1,
!- Coil Name
FanAndCoilAvailSched, !- Availability Schedule
25000, !- Rated Total Cooling Capacity (gross) {W}
0.75,
!- Rated SHR
3.0,
!- Rated COP
1.3,
!- Rated Air Volume Flow Rate {m3/s}
DX Cooling Coil Air Inlet Node, !- Coil Air Inlet Node
Heating Coil Air Inlet Node,
!- Coil Air Outlet Node
WindACCoolCapFT, !- Total Cooling Capacity Modifier Curve (function of temperature)
WindACCoolCapFFF, !- Total Cooling Capacity Modifier Curve (function of flow fraction)
WindACEIRFT,
!- Energy Input Ratio Modifier Curve (function of temperature)
WindACEIRFFF,
!- Energy Input Ratio Modifier Curve (function of flow fraction)
WindACPLFFPLR,
!- Part Load Fraction Correlation (function of part load ratio)
CyclingFanAndCompressor;
!- Supply Air Fan Operation Mode

Fan:OnOff,
Supply Fan 1,
!- Fan Name
FanAndCoilAvailSched,
!- Availability Schedule Name
0.7,
!- Fan Total Efficiency
600.0, !- Delta Pressure {Pa}
1.3,
!- Max Flow Rate {m3/s}
0.9,
!- Motor Efficiency
1.0,
!- Motor In Airstream Fraction
Air Loop Inlet Node,
!- Fan_Inlet_Node
DX Cooling Coil Air Inlet Node; !- Fan_Outlet_Node
AirTerminal:SingleDuct:Uncontrolled,
Zone1DirectAir,
!- Direct Air Name
FanAndCoilAvailSched, !- Schedule name for on/off schedule
Zone 1 Inlet Node,
!- Zone Supply Air Node Name
0.47; !- Maximum air flow rate {m3/s}
AirTerminal:SingleDuct:Uncontrolled,
Zone2DirectAir,
!- Direct Air Name
FanAndCoilAvailSched, !- Schedule name for on/off schedule
Zone 2 Inlet Node,
!- Zone Supply Air Node Name
0.36; !- Maximum air flow rate {m3/s}
AirTerminal:SingleDuct:Uncontrolled,
Zone3DirectAir,
!- Direct Air Name
FanAndCoilAvailSched, !- Schedule name for on/off schedule
Zone 3 Inlet Node,
!- Zone Supply Air Node Name
0.47; !- Maximum air flow rate {m3/s}

Example of Heat/Cool Unitary System Specification

Unitary System Heat and Cool (AirLoopHVAC) Outputs
HVAC,Average, Unitary System Fan Part Load Ratio []
HVAC,Average, Unitary System Compressor Part Load Ratio

Unitary System Fan Part Load Ratio []

This output variable is the ratio of actual air mass flow rate through the unitary system to the
systems design air mass flow rate (i.e., design volumetric flow rate converted to dry air mass
flow rate). For continuous fan operation mode, this variable is always 1.0 when the unitary
9/29/14

1049

Input-Output Reference

Group Unitary Equipment

system is available (based on the availability schedule). For cycling fan/cycling coil operation
mode, the actual air mass flow rate is calculated based on the ratio of the sensible heating (or
cooling) load to the steady-state unitary system heating (or cooling) capacity. For the cycling
fan mode, the runtime fraction for the unitary system fan may be different from the fan partload ratio reported here due the part-load performance of the systems heating (or cooling)
coil (delay at start-up to reach steady-state output). In general, runtime fractions are reported
by individual components where appropriate (e.g., Fan:OnOff).
Unitary System Compressor Part Load Ratio []
This output variable is the ratio of the sensible cooling load to the steady-state cooling
capacity of the unitary systems DX cooling coil. The runtime fraction for the DX cooling coil
compressor may be different from the compressor part-load ratio reported here due the partload performance of the cooling coil (delay at start-up to reach steady-state output). In
general, runtime fractions are reported by individual components where appropriate.
AirLoopHVAC:UnitaryHeatPump:AirToAir
The unitary air-to-air heat pump is a virtual component that consists of a fan component
(OnOff or ConstantVolume), a DX cooling coil component, a DX heating coil component, and
a Gas or Electric supplementary heating coil component as shown in the Figure below.

Figure 118. Schematic of EnergyPlus Unitary Air-to-Air Heat Pump (Blow Through Configuration)
Links to the fan, DX cooling coil, DX heating coil, and supplementary heating coil
specifications are provided in the heat pumps input data syntax. In addition the control zone
name and the system design operating conditions are specified by the heat pump inputs.
Field: Name
This alpha field contains the identifying name for the unitary system heat pump.

9/29/14

1050

Input-Output Reference

Group Unitary Equipment

Field: Availability Schedule Name

This alpha field contains the schedule name (ref. Schedule objects) that contains information
on the availability of the heat pump to operate. A schedule value greater than 0 (usually 1 is
used) indicates that the unit can be on during the hour. A value less than or equal to 0
(usually 0 is used) denotes that the unit must be off for the hour. If this field is left blank, the
schedule has a value of 1 for all time periods.
Field: Air Inlet Node Name
This alpha field contains the name of the HVAC system node from which the heat pump
draws its inlet air.
Field: Air Outlet Node Name
This alpha field contains the name of the HVAC system node to which the heat pump sends
its outlet air.
Field: Supply Air Flow Rate During Cooling Operation
This numeric field defines the supply air flow rate leaving the heat pump in cubic meters per
second when the DX cooling coil is operating. Values must be greater than 0 or this field is
autosizable.
Field: Supply Air Flow Rate During Heating Operation
This numeric field defines the supply air flow rate leaving the heat pump in cubic meters per
second when the DX heating coil and/or supplemental heater are operating. Values must be
greater than 0 or this field is autosizable.
Field: Supply Air Flow Rate When No Cooling or Heating is Needed
This numeric field defines the supply air flow rate leaving the heat pump in cubic meters per
second when neither cooling or heating is required (i.e., DX coils and supplemental heater
are off but the supply air fan operates). This field is only used when the heat pump operating
mode is specified as continuous fan operation. Values must be greater than or equal to zero,
or this field is autosizable. If the heat pump operating mode is specified as continuous fan
operation and this value is set to zero or this field is left blank, then the model assumes that
the supply air flow rate when no cooling/heating is needed is equal to the supply air flow rate
when the compressor was last operating (for cooling operation or heating operation).
Field: Controlling Zone or Thermostat Location
This alpha field contains the identifying zone name where the thermostat controlling the heat
pump is located.
Field: Supply Air Fan Object Type
This alpha field contains the identifying type of supply air fan specified for the heat pump. Fan
type must be Fan:OnOff or Fan:ConstantVolume. Fan:ConstantVolume is used when the
Supply Air Fan Operating Mode Schedule values are never 0 and the fan operates
continuously. Fan:OnOff is used when the fan cycles on and off with the cooling or heating
coil (i.e. Supply Air Fan Operating Mode Schedule values are at times 0).
Field: Supply Air Fan Name
This alpha field contains the identifying name given to the heat pump supply air fan, and
should match the name specified in the corresponding fan object.
Field: Heating Coil Object Type
This alpha field contains the identifying type of heating coil specified in the heat pump.
Heating
coil
type
must
be
either
Coil:Heating:DX:SingleSpeed
or
Coil:Heating:DX:VariableSpeed.

9/29/14

1051

Input-Output Reference

Group Unitary Equipment

Field: Heating Coil Name

This alpha field contains the identifying name given to the heat pump DX heating coil, and
should match the name specified in the corresponding DX heating coil object.
Field: Cooling Coil Object Type
This alpha field contains the identifying type of cooling coil specified in the heat pump. There
are three valid choices for this field:
Coil:Cooling:DX:SingleSpeed
CoilSystem:Cooling:DX:HeatExchangerAssisted
Coil:Cooling:DX:VariableSpeed

Field: Cooling Coil Name

This alpha field contains the identifying name given to the heat pump cooling coil, and should
match the name specified in the corresponding DX cooling coil object.
Field: Supplemental Heating Coil Object Type
This alpha field contains the identifying type of supplemental heating coil specified in the heat
pump. The hot water and steam heating coils require specifying plant loop, branches, and
connector objects to support the heating coils, and are placed on the demand side of the
plantloop. The hot water flow modulation through the supplemental heating coil does not
require additional controller or Controller:WaterCoil object. The parent object (Airloop Air to
Air Heat Pump) itself provides the "controller" function of modulating water flow. Heating coil
type must be:
Coil:Heating:Electric
Coil:Heating:Gas
Coil:Heating:Water
Coil:Heating:Steam

Field: Supplemental Heating Coil Name

This alpha field contains the identifying name given to the heat pump supplemental heating
coil, and should match the name specified in the corresponding heating coil object.
Field: Maximum Supply Air Temperature from Supplemental Heater
This numeric field defines the maximum allowed supply air temperature exiting the heat pump
supplemental heating coil.
Field: Maximum Outdoor Dry-Bulb Temperature for Supplemental Heater Operation
This numeric field defines the outdoor air dry-bulb temperature above which the heat pump
supplemental heating coil is disabled. The temperature for this input field must be less than or
equal to 21 C. If this input field is left blank, the default value is 21 C.
Field: Fan Placement
This alpha field has two choices: BlowThrough or DrawThrough. The first choice represents
a blow through system where the supply air fan is before the DX cooling/heating coil and the
supplementary heating coil. The second choice represents a draw through system where the
supply air fan is between the DX cooling/heating coil and the supplementary heating coil. If
this input field is left blank, the default is blow through.
Field: Supply Air Fan Operating Mode Schedule Name
This alpha field specifies the name of the supply air fan operating mode schedule. The supply
air fan operating mode may vary during the simulation based on time-of-day or with a change
of season. Schedule values of 0 denote that the unitary system supply air fan and the heating
or cooling coil cycle on and off together to meet the heating or cooling load (a.k.a. AUTO fan).
Schedule values other than 0 denote that the supply fan runs continuously while the heating
or cooling coil cycles to meet the load.
9/29/14

1052

Input-Output Reference

Group Unitary Equipment

As shown in the example below, correct specification of the air-to-air heat pump requires
specification of the following objects in addition to the heat pump object:
1) Fan (Fan:OnOff or Fan:ConstantVolume)
2) Heating coil (Coil:Heating:DX:SingleSpeed)
3) Cooling

coil
(Coil:Cooling:DX:SingleSpeed
CoilSystem:Cooling:DX:HeatExchangerAssisted)

or

4) Supplemental heating coil (Coil:Heating:Gas or Coil:Heating:Electric)

5) Direct air unit (AirTerminal:SingleDuct:Uncontrolled) for each zone served by the unitary

system

Field: Dehumidification Control Type

This alpha input field contains the type of dehumidification control. The following options are
valid for this field:
None - meet sensible load only, no active dehumidification control
Multimode - activate enhanced dehumidification mode as needed and meet sensible
cooling load. This option is used to model DX equipment with a controllable heat
exchanger assisting the DX cooling coil for improved dehumidification. It is valid only
with cooling coil type = CoilSystem:Cooling:DX:HeatExchangerAssisted.
CoolReheat - cool beyond the dry-bulb temperature set point as required to meet the
high humidity setpoint. The excess cooling beyond the cooling set point temperature
is offset by the supplemental heating coil. If cooling coil type =
CoilSystem:Cooling:DX:HeatExchangerAssisted, then the heat exchanger is
assumed to always transfer energy between the cooling coils inlet and outlet
airstreams when the cooling coil is operating.
The default is None. For the other dehumidification control modes, the maximum humidity
setpoint is required. This must be set using a ZoneControl:Humidistat object. When extra
dehumidification is required, the system may not be able to meet the humidity setpoint if its
full capacity is not adequate. Supplemental heating coil (supplemental heating coil type and
name) is a required input in AirToAir HeatPumps. The supplemental heating coil capacity
must be adequate enough to meet the heating coil load and offset the excess cooling load
due to extra dehumidification required to meet the high relative humidity setpoint.
Note: the air-to-air heat pumps fan, cooling coil, heating coil and supplementary heating coil must be
connected in the air loop according to the configuration shown above (Figure 118) for the blow-through fan
configuration. The only other valid configuration is with a draw-through fan placement, where the fan is
located between the DX heating coil and the supplementary heating coil. In addition, the volumetric air flow
rate specified in the direct air unit for the controlling zone should properly reflect the fractional volumetric
air flow rate specified in the heat pump object.

9/29/14

1053

Input-Output Reference

Group Unitary Equipment

AirLoopHVAC:UnitaryHeatPump:AirToAir Example Specification

AirLoopHVAC:UnitaryHeatPump:AirToAir,
DXAC Heat Pump 1,
! Heat Pump name
FanAndCoilAvailSched,
! Heat Pump availability schedule
Mixed Air Node,
! Heat Pump air inlet node
Air Loop Outlet Node,
! Heat Pump air outlet node
1.3,
!- Supply air volumetric flow rate during cooling operation {m3/s}
1.3,
!- Supply air volumetric flow rate during heating operation {m3/s}
0.0,
!- Design air volumetric flow rate when no heating or cooling is needed {m3/s}
East Zone,
! Controlling zone or thermostat location
Fan:OnOff,
! Supply air fan type
Supply Fan 1,
! Supply air fan name - same name used in fan object
Coil:Heating:DX:SingleSpeed,
! Heating coil type
Heat Pump DX Heating Coil 1, ! Heating coil name - same name used in DX heating coil object
Coil:Cooling:DX:SingleSpeed, ! Cooling coil type
Heat Pump ACDXCoil 1,
! Cooling coil name - same name used in DX cooling coil object
Coil:Heating:Gas,
! Supplemental heating coil type
Heat Pump DX Supp Heating Coil 1, ! Supplemental heating coil name- same as in heating coil object
50,
! Maximum supply air temperature from supplemental heater [C]
21,
! Maximum outdoor dry-bulb temp for supplemental heating coil operation [C]
BlowThrough,
! Fan placement
CycFanSchedule,
! Supply air fan operating mode schedule name
CoolReheat;
!- Dehumidification Control Type

Coil:Heating:DX:SingleSpeed,
Heat Pump DX Heating Coil 1,
! Name of heating coil
FanAndCoilAvailSched,
! Heating coil schedule
35000,
! Rated total heating capacity [W] (at 21.11C/8.33C)
2.75,
! Rated heating COP
1.7,
! Rated air flow rate [m3/s]
Heating Coil Air Inlet Node,
! Coil air inlet node
SuppHeating Coil Air Inlet Node, ! Coil air outlet node
HPACHeatCapFT,
! Heating capacity modifier curve (temperature,C)
HPACHeatCapFFF,
! Heating capacity modifier curve (flow fraction)
HPACHeatEIRFT,
! Energy input ratio modifier curve (temperature,C)
HPACHeatEIRFFF,
! Energy input ratio modifier curve (flow fraction)
HPACCoolPLFFPLR,
! Part load fraction modifier curve (function of part-load ratio)
,
! defrost EIR modifier curve (temp, C) not required for resistive defrost
CyclingFanAndCompressor,
! Operation mode (cycling fan, cycling compressor)
-5.0,
! Minimum OAT for heat pump compressor operation [C]
5.0,
! Maximum outdoor dry-bulb temp for defrost operation [C]
200.0,
! Crankcase heater capacity[W]
10.0,
! Maximum OAT for crankcase heater operation [C]
resistive,
! Defrost strategy (resistive or reverse-cycle)
timed,
! Defrost control (timed or on-demand)
0.166667,
!Defrost time period fraction (used for timed defrost control only)
20000;
! Resistive defrost heater capacity [W]

9/29/14

1054

Input-Output Reference
Coil:Cooling:DX:SingleSpeed,
Heat Pump ACDXCoil 1,
FanAndCoilAvailSched,
32000,
0.75,
3.0,
1.7,
DX Cooling Coil Air Inlet Node,
Heating Coil Air Inlet Node,
HPACCoolCapFT,
HPACCoolCapFFF,
HPACCoolEIRFT,
HPACCoolEIRFFF,
HPACCoolPLFFPLR,
CyclingFanAndCompressor;

Group Unitary Equipment

!
!
!
!
!
!
!
!
!
!
!
!
!

Coil:Heating:Gas,
Heat Pump DX Supp Heating Coil 1,
FanAndCoilAvailSched,
0.8 ,
32000,
SuppHeating Coil Air Inlet Node,
Air Loop Outlet Node;

Fan:OnOff,
Supply Fan 1,
FanAndCoilAvailSched,
0.7,
300.0,
1.7,
0.9,
1.0,
Mixed Air Node,
DX Cooling Coil Air Inlet Node;

Name of cooling coil

Availability schedule
Rated total cooling capacity [W]
Rated sensible heat ratio
Rated COP
Rated air flow rate [m3/s]
Coil air inlet node
Coil air outlet node
Cooling capacity modifier curve (temperature,C)
Cooling capacity modifier curve (flow fraction)
Energy input ratio modifier curve (temperature,C)
Energy input ratio modifier curve (flow fraction)
Part load factor modifier curve (function of part-load ratio)
! Operation mode (cycling fan, cycling compressor)

!
!
!
!
!
!

!
!
!
!
!
!
!
!
!

Name of heating coil

Availability schedule
Gas Burner Efficiency of the Coil
Nominal Capacity of the Coil [W]
Supplementary heating coil air side inlet node
Supplementary heating coil air side outlet node

Fan Name
Fan Schedule
Fan Total Efficiency
Delta Pressure [N/M^2]
Max Vol Flow Rate [m^3/Sec]
motor efficiency
motor in air stream fraction
fan inlet node
fan outlet node

AirTerminal:SingleDuct:Uncontrolled,
Zone1DirectAir,
!
FanAndCoilAvailSched,
!
Zone 1 Inlet Node,
!
0.612;
!

direct air unit name

schedule name for on/off schedule
zone supply air node name
maximum air flow rate, m3/s

AirTerminal:SingleDuct:Uncontrolled,
Zone2DirectAir,
!
FanAndCoilAvailSched,
!
Zone 2 Inlet Node,
!
0.476;
!

direct air unit name

schedule name for on/off schedule
zone supply air node name
maximum air flow rate, m3/s

AirTerminal:SingleDuct:Uncontrolled,
Zone3DirectAir,
!
FanAndCoilAvailSched,
!
Zone 3 Inlet Node,
!
0.612;
!

direct air unit name

schedule name for on/off schedule
zone supply air node name
maximum air flow rate, m3/s

Unitary Air to Air Heat Pump (AirLoopHVAC) Outputs

HVAC, Average, Unitary System Fan Part Load Ratio []
HVAC, Average, Unitary System Compressor Part Load Ratio []
HVAC, Average, Unitary System Dehumidification Induced Heating Demand Rate
[W]

Unitary System Fan Part Load Ratio []

This output variable is the ratio of actual air mass flow rate through the heat pump to the heat
pumps design air mass flow rate (i.e., design volumetric flow rate converted to dry air mass
flow rate). For continuous fan operation mode, this variable is always 1.0 when the furnace is
available (based on the availability schedule). For cycling fan/cycling coil operation mode, the
9/29/14

1055

Input-Output Reference

Group Unitary Equipment

actual air mass flow rate is calculated based on the ratio of the sensible heating (or cooling)
load to the steady-state heat pump heating (or cooling) capacity. For the cycling fan mode,
the runtime fraction for the heat pump fan may be different from the fan part-load ratio
reported here due the part-load performance of the heat pumps heating (or cooling) coil
(delay at start-up to reach steady-state output). In general, runtime fractions are reported by
individual components where appropriate (e.g., Fan:OnOff).
Unitary System Compressor Part Load Ratio []
This output variable is the ratio of the sensible load (heating or cooling) to the steady-state
capacity of the heat pumps DX heating or cooling coil. The runtime fraction for the heat pump
compressor may be different from the compressor part-load ratio reported here due the partload performance of the heating/cooling coil (delay at start-up to reach steady-state output).
In general, runtime fractions are reported by individual components where appropriate.
Unitary System Dehumidification Induced Heating Demand Rate [W]
This output variable is the additional heating demand rate of the supplemental heating coil of
an Air-to-Air heat pumps in Watts. This additional heating demand is induced when zone air
overshoots the heating setpoint due to extra dehumidification requirement to meet the high
humidity setpoint. This value is always positive. This value is calculated for each HVAC
system timestep, and the results are averaged for the timestep being reported.
AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed
The multispeed air-to-air heat pump is a virtual component that consists of a fan component
(On/Off or ConstVolume), a DX multispeed cooling coil component, a DX multispeed heating
coil component, and a Gas or Electric supplemental heating coil component. This system
also includes the option to use available waste energy to heat water. A schematic diagram of
the air-to-air multispeed heat pump is shown below. The component connection sequence for
the blow through option (shown below) from inlet to outlet is fan, cooling coil, heating coil, and
supplemental heater. The connection sequence for the draw through option is cooling coil,
heating coil, fan, and supplemental heater.
The main difference between this heat pump object and other EnergyPlus heat pump objects
is that this object allows from two to four discrete compressor speeds for heating and cooling
operation (instead of a single speed for each mode). The lowest speed is called Speed 1, and
the highest speed is called Speed n (2, 3 or 4 as specified in the input syntax). This object
allows a different number of speeds for cooling and heating, and each speed has an
associated airflow rate. The airflow rates for the various heating speeds can be different from
the airflow rates for the cooling speeds. In addition, the airflow rate when no cooling or
heating is needed can also be defined. The number of cooling and heating speeds defined by
the user in this heat pump object must equal the number of speeds defined in the associated
coils (child objects). For example, the number of speeds for cooling defined in this heat pump
object must be equal to the number of speeds defined in the associated cooling coil object.
Links to the fan, DX multispeed cooling coil, DX multispeed heating coil, and supplementary
heating coil specifications are provided in the heat pumps input data syntax. In addition, the
control zone name and airflow rates at the corresponding compressor speeds are specified
by the heat pump syntax.
If the ZoneControl:Thermostat:StagedDualSetpoint object and other zone control thermostat
and humidistat are assigned to the same controlled zone in the Controlling Zone or
Thermostat Location field, the ZoneControl:Thermostat:StagedDualSetpoint object takes
precedence
and
the
stage
number
provided
by
the
the
ZoneControl:Thermostat:StagedDualSetpoint object is used to set the speed number.

9/29/14

1056

Input-Output Reference

Group Unitary Equipment

Figure 119. Schematic of EnergyPlus Unitary Air-to-Air Multi Speed Heat Pump
Field: Name
This alpha field contains the identifying name for the multispeed heat pump.
Field: Availability Schedule Name
This alpha field contains the schedule name (ref. Schedule objects) that contains information
on the availability of the heat pump to operate. A schedule value greater than 0 (usually 1 is
used) indicates that the unit can be on during the time period. A value less than or equal to 0
(usually 0 is used) denotes that the unit must be off for the time period. If this field is left
blank, the schedule has a value of 1 for all time periods.
Field: Air Inlet Node Name
This alpha field contains the name of the HVAC system node from which the heat pump
draws its inlet air.
Field: Air Outlet Node Name
This alpha field contains the name of the HVAC system node to which the heat pump sends
its outlet air.
Field: Controlling Zone or Thermostat Location
This alpha field contains the identifying zone name where the thermostat controlling the
multispeed heat pump is located.
Field: Supply Air Fan Object Type
This alpha field contains the identifying type of supply air fan specified for the heat pump. Fan
type must be Fan:OnOff or Fan:ConstantVolume. Fan:ConstantVolume can only be used

9/29/14

1057

Input-Output Reference

Group Unitary Equipment

when the supply air fan operating mode is continuous (see field Supply air fan operating
mode schedule name).
Field: Supply Air Fan Name
This alpha field contains the identifying name given to the heat pump supply air fan, and
should match the name specified in the corresponding fan object.
Field: Supply Air Fan Placement
This alpha field has two choices: BlowThrough or DrawThrough. The first choice stands for
blow through fan. This means that the unit consists of a fan followed by a DX multispeed
cooling coil, DX multispeed heating coil, and a supplemental heating coil. The fan blows
through the cooling and heating coils. The second choice stands for draw through fan. This
means that the unit consists of the DX cooling and heating coils followed by a fan, with the
supplemental heater located at the outlet of the fan. The fan draws air through the DX coils.
Note: the multispeed heat pumps supply air fan, cooling coil, heating coil and supplemental heating coil
must be connected according to the configuration shown above (Figure 119) for the blow through fan
configuration. For the draw through fan configuration the fan must be located between the DX heating coil
and the supplemental heater, whose outlet node is the system outlet node. In addition, the DX cooling coil
and DX heating coil operation mode must be specified consistently with the heat pumps supply air fan
operating mode (e.g., with the heat pumps supply air fan set to cycle on and off with the cooling/heating
load, the DX cooling and heating coil operation mode must be CyclingFanAndCompressor). If the
operation modes in the parent (heat pump) and child (coil) objects are specified differently, the operation
mode in the parent object prevails.

Field: Supply Air Fan Operating Mode Schedule Name

This alpha field contains the schedule name (ref. Schedule objects) that contains information
to control the supply air fan. Schedule values of zero mean that the supply air fan will cycle
off if there is no cooling or heating load in the control zone. Non-zero schedule values mean
that the supply air fan will operate continuously even if there is no cooling or heating load in
the control zone. If this field is left blank, the supply air fan will operate continuously for the
entire simulation period.
Field: Heating Coil Object Type
This alpha field contains the identifying type of heating coil specified in the heat pump.
Allowable choices for Heating coil type
are Coil:Heating:DX:MultiSpeed,
Coil:Heating:Electric:MultiStage, Coil:Heating:Gas:MultiStage, Coil:Heating:Water, and
Coil:Heating:Steam.
Field: Heating Coil Name
This alpha field contains the identifying name given to the DX heating coil, and should match
the name specified in the corresponding DX heating coil object.
Field: Minimum Outdoor Dry-Bulb Temperature for Compressor Operation
This numeric field defines the outdoor air dry-bulb temperature below which the DX heating
coil turns off. The temperature for this input field must be greater than or equal to 20 C. If
this input field is left blank, the default value is -8 C. This temperature should match the
minimum compressor operating temperature specified for the multispeed heat pumps DX
heating coil. This field is only needed when Heating Coil Object Type above is
Coil:Heating:DX:MultiSpeed.

9/29/14

1058

Input-Output Reference

Group Unitary Equipment

Field: Cooling Coil Object Type

This alpha field contains the identifying type of cooling coil specified in the heat pump.
Cooling coil type must be Coil:Cooling:DX:MultiSpeed.
Field: Cooling Coil Name
This alpha field contains the identifying name given to the heat pump cooling coil, and should
match the name specified in the corresponding DX cooling coil object.
Field: Supplemental Heating Coil Object Type
This alpha field contains the identifying type of supplemental heating coil specified in the heat
pump. The hot water and steam heating coils require specifying plant loop, branches, and
connectors objects to support the heating coils, and are placed on the demand side of the
plantloop. The hot water flow modulation through the supplemental heating coil does not
require additional controller or Controller:WaterCoil object. The parent object (Unitary
MultiSpeed Air to Air Heat Pump) itself provides the "controller" function of modulating water
flow. Heating coil type must be:
Coil:Heating:Electric
Coil:Heating:Gas
Coil:Heating:Water
Coil:Heating:Steam

Field: Supplemental Heating Coil Name

This alpha field contains the identifying name given to the heat pump supplemental heating
coil, and should match the name specified in the corresponding heating coil object.
Field: Maximum Supply Air Temperature from Supplemental Heater
This numeric field defines the maximum allowed supply air temperature (in degrees C) exiting
the heat pump supplemental heating coil. If the calculated supply air temperature exiting the
supplemental heater exceeds this value, then it is reset to this maximum temperature. This
field is autosizable.
Field: Maximum Outdoor Dry-Bulb Temperature for Supplemental Heater Operation
This numeric field defines the outdoor air dry-bulb temperature above which the heat pump
supplemental heating coil is disabled. The temperature for this input field must be less than
or equal to 21 C. If this input field is left blank, the default value is 21 C.
Field: Auxiliary On-Cycle Electric Power
This field defines auxiliary electrical power (W) consumed during the on-cycle period (i.e.,
when the cooling or heating coil is operating). The model assumes that this auxiliary power
does not contribute to heating the supply air. The minimum value for this field is 0.0, and the
default value is also 0.0 if the field is left blank.
Field: Auxiliary Off-Cycle Electric Power
This field defines auxiliary electrical power (W) consumed during the off-cycle period (i.e.,
when the cooling and heating coil are not operating). The model assumes that this auxiliary
power does not contribute to heating the supply air. The minimum value for this field is 0.0,
and the default value is also 0.0 if the field is left blank.
Field: Design Heat Recovery Water Flow Rate
This optional input field defines the design water flow rate used if the heat recovery option is
being simulated. If this value is greater than 0.0 then a heat recovery loop must be specified
and attached to the multispeed heat pump using the next 2 node fields. To determine how the
heat recovery algorithm works, refer to the EnergyPlus Engineering Reference in the
AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed with Heat Recovery section. The units
for this input value are cubic meters per second.
9/29/14

1059

Input-Output Reference

Group Unitary Equipment

Field: Maximum Temperature for Heat Recovery

This field sets the maximum temperature (in degrees C) that this heat pump can produce for
heat recovery. The idea behind this field is that the current models do not take temperatures
into account for availability and they just pass Q's around the loop without a temperature limit.
This temperature limit puts an upper bound on the recovered heat and limits the max
temperature leaving the component.
As temperatures in the loop approach the maximum temperature, the temperature difference
between the entering water and the surfaces in the piece of equipment becomes smaller. For
the given heat recovery flow rate and that temperature difference the amount of heat
recovered will be reduced, and eventually there will be no heat recovered when the entering
water temperature is equal to the maximum temperature specified by the user in this field.
The reduced amount of heat recovered will diminish if the temperature of the loop approach
is the maximum temperature, and this will show up in the reporting. This allows the user to
set the availability or the quality of the heat recovered for usage in other parts of the system
or to heat domestic hot water supply.
Field: Heat Recovery Water Inlet Node Name
This alpha field contains the identifying name for the heat recovery side inlet node.
Field: Heat Recovery Water Outlet Node Name
This alpha field contains the identifying name for the heat recovery side outlet node.
Field: Supply Air Flow Rate When No Cooling or Heating is Needed
This numeric field defines the supply air flow rate leaving the heat pump in cubic meters per
second when neither cooling nor heating is required (i.e., DX coils and supplemental heater
are off but the supply air fan operates). This field is only used when the heat pump supply air
fan is scheduled to operate continuously regardless of DX coil operation (ref. field Supply Air
Fan Operating Mode Schedule). Values must be greater than or equal to zero, or this field is
autosizable. If the heat pump supply air fan is scheduled to operate continuously and the
input value for this field is set to zero or this field is left blank, then the model assumes that
the supply air flow rate when no cooling/heating is needed is equal to the supply air flow rate
when the compressor was last operating (for cooling operation or heating operation).
Field: Number of Speeds for Heating
This field defines the number of heating speeds for the heat pump, and must match the
number of heating speeds defined in the associated heating coil. The value for this input field
defines the number of airflow rates that must be defined for heating in the field below. The
minimum value for this field is one and the maximum value is four. If the Heating Coil Object
Type above are Coil:Heating:Water or Coil:Heating:Steam, then this field should be 1.
Field: Number of Speeds for Cooling
This field defines the number of cooling speeds for the heat pump, and must match the
number of cooling speeds defined in the associated DX cooling coil. The value for this input
field defines the number of airflow rates that must be defined for cooling in the field below.
The minimum value for this field is two and the maximum value is four.
Field: Speed 1 Supply Air Flow Rate During Heating Operation
This required numeric field defines the supply air flow rate leaving the heat pump in cubic
meters per second when the DX heating coil and/or supplemental heater are operating at
Speed 1 (lowest speed). Values must be greater than 0 or this field is autosizable.
Field: Speed 2 Supply Air Flow Rate During Heating Operation
This required numeric field defines the supply air flow rate leaving the heat pump in cubic
meters per second when the DX heating coil and/or supplemental heater are operating at
9/29/14

1060

Input-Output Reference

Group Unitary Equipment

Speed 2. Values must be greater than 0 or this field is autosizable. If not autosized, the
entered value must be greater or equal to the flow rate specified for heating Speed 1.
Field: Speed 3 Supply Air Flow Rate During Heating Operation
This numeric field defines the supply air flow rate leaving the heat pump in cubic meters per
second when the DX heating coil and/or supplemental heater are operating at Speed 3.
Values must be greater than 0 or this field is autosizable. If not autosized, the entered value
must be greater or equal to the flow rate specified for heating Speed 2. If the Number of
Speeds for Heating is less than 3, then this field can be left blank.
Field: Speed 4 Supply Air Flow Rate During Heating Operation
This numeric field defines the supply air flow rate leaving the heat pump in cubic meters per
second when the DX heating coil and/or supplemental heater are operating at Speed 4 (high
speed). Values must be greater than 0 or this field is autosizable. If not autosized, the
entered value must be greater or equal to the flow rate specified for heating Speed 3. If the
Number of Speeds for Heating is less than 4, then this field can be left blank.
Note: When autosizable is selected for any of the supply air volumetric flow rate fields, all supply air flow
fields at the different speeds must be specified as autosizable. Otherwise, a fatal error will be issued and
the simulation will terminate.

Field: Speed 1 Supply Air Flow Rate During Cooling Operation

This required numeric field defines the supply air flow rate leaving the heat pump in cubic
meters per second when the DX cooling coil is operating at Speed 1 (lowest speed). Values
must be greater than 0 or this field is autosizable.
Field: Speed 2 Supply Air Flow Rate During Cooling Operation
This required numeric field defines the supply air flow rate leaving the heat pump in cubic
meters per second when the DX cooling coil is operating at Speed 2. Values must be greater
than 0 or this field is autosizable. If not autosized, the entered value must be greater or equal
to the flow rate specified for cooling Speed 1.
Field: Speed 3 Supply Air Flow Rate During Cooling Operation
This numeric field defines the supply air flow rate leaving the heat pump in cubic meters per
second when the DX cooling coil is operating at Speed 3. Values must be greater than 0 or
this field is autosizable. If not autosized, the entered value must be greater or equal to the
flow rate specified for cooling Speed 2. If the Number of Speeds for Cooling is less than 3,
then this field can be left blank.
Field: Speed 4 Supply Air Flow Rate During Cooling Operation
This numeric field defines the supply air flow rate leaving the heat pump in cubic meters per
second when the DX cooling coil is operating at Speed 4 (highest speed). Values must be
greater than 0 or this field is autosizable. If not autosized, the entered value must be greater
or equal to the flow rate specified for cooling Speed 3. If the Number of Speeds for Cooling
is less than 4, then this field can be left blank.
Following is an example input for the object and its associated components.

9/29/14

1061

Input-Output Reference

Group Unitary Equipment

AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed,
DXAC Heat Pump 1,
!- Name of multispeed heat pump
FanAndCoilAvailSched,
!- Availability schedule
Mixed Air Node,
!- Heat pump air inlet node name
Air Loop Outlet Node,
!- Heat pump air outlet node name
East Zone,
!- Controlling zone or thermostat location
Fan:OnOff,
!- Supply air fan type
Supply Fan 1,
!- Supply air fan name
BlowThrough,
!- Supply air fan placement
FanModeSchedule,
!- Supply air fan operating mode schedule name
Coil:Heating:DX:MultiSpeed, Heat Pump DX Heating Coil 1, !- Heating coil type & name
-8.0,
!- Minimum outdoor dry-bulb temperature for compressor operation
Coil:Cooling:DX:MultiSpeed, Heat Pump ACDXCoil 1,
!- Cooling coil type & name
Coil:Heating:Gas,
!- Supplemental heating coil type
Supp Gas Heating Coil 1, !- Supplemental heating coil name
50.0,
!- Maximum supply air temperature from supplemental heater
21,
!- Maximum outdoor dry-bulb temperature for supplemental heater operation
0,
!- Auxiliary On-Cycle Electric Power {W}
0,
!- Auxiliary Off-Cycle Electric Power {W}
0.00,
!- Design Heat Recovery Water Flow Rate {m3/s}
80.0,,,
!- Maximum Temp for Heat Recovery {C} & Node names (none)
0.2,
!- Supply air volumetric flow rate when no cooling or heating is needed
4,
!- Number of speeds for heating
4,
!- Number of speeds for cooling
0.4,
!- Supply air flow rate during heating operation, Speed 1
0.8,
!- Supply air flow rate during heating operation, Speed 2
1.2,
!- Supply air flow rate during heating operation, Speed 3
1.7,
!- Supply air flow rate during heating operation, Speed 4
0.4,
!- Supply air flow rate during cooling operation, Speed 1
0.8,
!- Supply air flow rate during cooling operation, Speed 2
1.2,
!- Supply air flow rate during cooling operation, Speed 3
1.7;
!- Supply air flow rate during cooling operation, Speed 4

9/29/14

1062

Input-Output Reference

Group Unitary Equipment

Coil:Heating:DX:MultiSpeed,
Heat Pump DX Heating Coil 1, !- Name of heat pump heating coil
FanAndCoilAvailSched,
!- Availability Schedule
Heating Coil Air Inlet Node, !- Coil Air Inlet Node
SuppHeating Coil Air Inlet Node, !- Coil Air Outlet Node
CyclingFanAndCompressor,
!- Supply Air Fan Operation Mode
-8.0,
!- Minimum Outdoor Dry-bulb Temperature for Compressor Operation {C}
200.0,
!- Crankcase Heater Capacity {W}
10.0,
!- Maximum Outdoor Dry-bulb Temperature for Crankcase Heater
!- Operation {C}
HPACDefrostCAPFT,
!- Defrost energy input ratio modifier curve (temperature)
7.22,
!- Maximum Outdoor Dry-bulb Temperature for Defrost Operation
reverse-cycle,
!- Defrost Strategy
timed,
!- Defrost Control
0.058333,
!- Defrost Time Period Fraction
2000.0,
!- Resistive Defrost Heater Capacity {W}
No,
!- Apply Part Load Fraction to Speeds greater than 1
NaturalGas,
!- Fuel type
4,
!- Number of speeds
7500,
!- Rated Total Heating Capacity, Speed 1 {W}
2.75,
!- Rated COP, Speed 1
0.45,
!- Rated Air Volume Flow Rate, Speed 1 {m3/s}
HPACHeatCapFT Speed 1,
!- Total Heating Capacity Modifier Curve, Speed 1 (temperature)
HPACHeatCapFF Speed 1,
!- Total Heating capacity modifier curve, Speed 1 (flow fraction)
HPACHeatEIRFT Speed 1,
!- Energy input ratio modifier curve, Speed 1 (temperature)
HPACHeatEIRFF Speed 1,
!- Energy input ratio modifier curve, Speed 1 (flow fraction)
HPACHeatPLFFPLR Speed 1, !- Part load fraction correlation, Speed 1 (part load ratio)
0.2,
!- Rated waste heat fraction of power input, Speed 1
HAPCHeatWHFT Speed 1,
!- Waste heat modifier curve, Speed 1 (temperature)
17500,
!- Rated Total Heating Capacity, Speed 2 {W}
2.75,
!- Rated COP, Speed 2
0.85,
!- Rated Air Volume Flow Rate, Speed 2 {m3/s}
HPACHeatCapFT Speed 2,
!- Total Heating Capacity Modifier Curve, Speed 2 (temperature)
HPACHeatCapFF Speed 2,
!- Total Heating capacity modifier curve, Speed 2 (flow fraction)
HPACHeatEIRFT Speed 2,
!- Energy input ratio modifier curve, Speed 2 (temperature)
HPACHeatEIRFF Speed 2,
!- Energy input ratio modifier curve, Speed 2 (flow fraction)
HPACHeatPLFFPLR Speed 2, !- Part load fraction correlation, Speed 2 (part load ratio)
0.2,
!- Rated waste heat fraction of power input, Speed 2
HAPCHeatWHFT Speed 2,
!- Waste heat modifier curve, Speed 2 (temperature)
25500,
!- Rated Total Heating Capacity, Speed 3 {W}
2.75,
!- Rated COP, Speed 3
1.25,
!- Rated Air Volume Flow Rate, Speed 3 {m3/s}
HPACHeatCapFT Speed 3,
!- Total Heating Capacity Modifier Curve, Speed 3 (temperature)
HPACHeatCapFF Speed 3,
!- Total Heating capacity modifier curve, Speed 3 (flow fraction)
HPACHeatEIRFT Speed 3,
!- Energy input ratio modifier curve, Speed 3 (temperature)
HPACHeatEIRFF Speed 3,
!- Energy input ratio modifier curve, Speed 3 (flow fraction)
HPACHeatPLFFPLR Speed 3, !- Part load fraction correlation, Speed 3 (part load ratio)
0.2,
!- Rated waste heat fraction of power input, Speed 3
HAPCHeatWHFT Speed 3,
!- Waste heat modifier curve, Speed 3 (temperature)
35500,
!- Rated Total Heating Capacity, Speed 4 {W}
2.75,
!- Rated COP, Speed 4
1.75,
!- Rated Air Volume Flow Rate, Speed 4 {m3/s}
HPACHeatCapFT Speed 4,
!- Total Heating Capacity Modifier Curve, Speed 4 (temperature)
HPACHeatCapFF Speed 4,
!- Total Heating capacity modifier curve, Speed 4 (flow fraction)
HPACHeatEIRFT Speed 4,
!- Energy input ratio modifier curve, Speed 4 (temperature)
HPACHeatEIRFF Speed 4,
!- Energy input ratio modifier curve, Speed 4 (flow fraction)
HPACHeatPLFFPLR Speed 4, !- Part load fraction correlation, Speed 4 (part load ratio)
0.2,
!- Rated waste heat fraction of power input, Speed 4
HAPCHeatWHFT Speed 4;
!- Waste heat modifier curve, Speed 4 (temperature)

9/29/14

1063

Input-Output Reference

Group Unitary Equipment

COIL:Cooling:DX:MultiSpeed,
Heat Pump ACDXCoil 1,
!- Coil Name
FanAndCoilAvailSched,
!- Availability Schedule
DX Cooling Coil Air Inlet Node, !- Coil Air Inlet Node
Heating Coil Air Inlet Node, !- Coil Air Outlet Node
CyclingFanAndCompressor,
!- Supply Air Fan Operation Mode
Outdoor Condenser Air Node, !- Condenser Air Inlet Node Name
AirCooled,
!- Condenser Type
,
!- Name of Water Storage Tank for Supply
,
!- Name of Water Storage Tank for Condensate Collection
No,
!- Apply Part Load Fraction to Speeds greater than 1
No,
!- Apply Latent Degradation to Speeds greater than 1
200.0,
!- Crankcase Heater Capacity {W}
10.0,
!- Maximum Outdoor Dry-bulb Temperature for Crankcase Heater
!- Operation {C}
NaturalGas,
!- Fuel type
4,
!- Number of speeds
7500,
!- Rated Total Cooling Capacity, Speed 1 (gross) {W}
0.75,
!- Rated SHR, Speed 1
3.0,
!- Rated COP, Speed 1
0.40,
!- Rated Air Volume Flow Rate, Speed 1 {m3/s}
HPACCoolCapFT Speed 1,
!- Total Cooling Capacity Modifier Curve, Speed 1 (temperature)
HPACCoolCapFF Speed 1,
!- Total Cooling Capacity Modifier Curve, Speed 1 (flow fraction)
HPACCOOLEIRFT Speed 1,
!- Energy Input Ratio Modifier Curve, Speed 1 (temperature)
HPACCOOLEIRFF Speed 1,
!- Energy Input Ratio Modifier Curve, Speed 1 (flow fraction)
HPACCOOLPLFFPLR Speed 1, !- Part Load Fraction Correlation, Speed 1 (part load ratio)
1000.0,
!- Nominal Time for Condensate Removal to Begin, Speed 1 {s}
1.5,
!- Ratio of Initial Moisture Evaporation Rate and Steady-state Latent
!- Capacity, Speed 1 {dimensionless}
3.0,
!- Maximum ON/OFF Cycling Rate, Speed 1 {cycles/hr}
45.0,
!- Latent Capacity Time Constant, Speed 1 {s}
0.2,
!- Rated waste heat fraction of power input, Speed 1 {dimensionless}
HAPCCoolWHFT Speed 1,
!- Waste heat modifier curve, Speed 1 (temperature)
0.9,
!- Evaporative Condenser Effectiveness, Speed 1 {dimensionless}
0.05,
!- Evaporative Condenser Air Volume Flow Rate, Speed 1 {m3/s}
50,
!- Evaporative Condenser Pump Rated Power Consumption, Speed 1 {W}
17500,
!- Rated Total Cooling Capacity, Speed 2 (gross) {W}
0.75,
!- Rated SHR, Speed 2
3.0,
!- Rated COP, Speed 2
0.85,
!- Rated Air Volume Flow Rate, Speed 2 {m3/s}
HPACCoolCapFT Speed 2,
!- Total Cooling Capacity Modifier Curve, Speed 2 (temperature)
HPACCoolCapFF Speed 2,
!- Total Cooling Capacity Modifier Curve, Speed 2 (flow fraction)
HPACCOOLEIRFT Speed 2,
!- Energy Input Ratio Modifier Curve, Speed 2 (temperature)
HPACCOOLEIRFF Speed 2,
!- Energy Input Ratio Modifier Curve, Speed 2 (flow fraction)
HPACCOOLPLFFPLR Speed 1, !- Part Load Fraction Correlation, Speed 2 (part load ratio)
1000.0,
!- Nominal Time for Condensate Removal to Begin, Speed 2 {s}
1.5,
!- Ratio of Initial Moisture Evaporation Rate and Steady-state Latent
!- Capacity, Speed 2 {dimensionless}
3.0,
!- Maximum ON/OFF Cycling Rate, Speed 2 {cycles/hr}
45.0,
!- Latent Capacity Time Constant, Speed 2 {s}
0.2,
!- Rated waste heat fraction of power input, Speed 2 {dimensionless}
HAPCCoolWHFT Speed 2,
!- Waste heat modifier curve, Speed 2 (temperature)
0.9,
!- Evaporative Condenser Effectiveness, Speed 2 {dimensionless}
0.1,
!- Evaporative Condenser Air Volume Flow Rate, Speed 2 {m3/s}
60,
!- Evaporative Condenser Pump Rated Power Consumption, Speed 2 {W}
25500,
!- Rated Total Cooling Capacity, Speed 3 (gross) {W}
0.75,
!- Rated SHR, Speed 3
3.0,
!- Rated COP, Speed 3
1.25,
!- Rated Air Volume Flow Rate, Speed 3 {m3/s}
HPACCoolCapFT Speed 3,
!- Total Cooling Capacity Modifier Curve, Speed 3 (temperature)
HPACCoolCapFF Speed 3,
!- Total Cooling Capacity Modifier Curve, Speed 3 (flow fraction)
HPACCOOLEIRFT Speed 3,
!- Energy Input Ratio Modifier Curve, Speed 3 (temperature)
HPACCOOLEIRFF Speed 3,
!- Energy Input Ratio Modifier Curve, Speed 3 (flow fraction)
HPACCOOLPLFFPLR Speed 1, !- Part Load Fraction Correlation, Speed 3 (part load ratio)
1000.0,
!- Nominal Time for Condensate Removal to Begin, Speed 3 {s}
1.5,
!- Ratio of Initial Moisture Evaporation Rate and Steady-state Latent
!- Capacity, Speed 3 {dimensionless}
3.0,
!- Maximum ON/OFF Cycling Rate, Speed 3 {cycles/hr}
45.0,
!- Latent Capacity Time Constant, Speed 3 {s}
0.2,
!- Rated waste heat fraction of power input, Speed 3 {dimensionless}
HAPCCoolWHFT Speed 3,
!- Waste heat modifier curve, Speed 3 (temperature)

9/29/14

1064

Input-Output Reference
0.9,
0.2,
80,
35500,
0.75,
3.0,
1.75,
HPACCoolCapFT Speed 4,
HPACCoolCapFF Speed 4,
HPACCOOLEIRFT Speed 4,
HPACCOOLEIRFF Speed 4,
HPACCOOLPLFFPLR Speed 1,
1000.0,
1.5,
3.0,
45.0,
0.2,
HAPCCoolWHFT Speed 4,
0.9,
0.3,
100;

Group Unitary Equipment

!!!!!!!!!!!!!!!!!!!!!!-

Evaporative Condenser Effectiveness, Speed 3 {dimensionless}

Evaporative Condenser Air Volume Flow Rate, Speed 3 {m3/s}
Evaporative Condenser Pump Rated Power Consumption, Speed 3 {W}
Rated Total Cooling Capacity, Speed 4 (gross) {W}
Rated SHR, Speed 4
Rated COP, Speed 4
Rated Air Volume Flow Rate, Speed 4 {m3/s}
Total Cooling Capacity Modifier Curve, Speed 4 (temperature)
Total Cooling Capacity Modifier Curve, Speed 4 (flow fraction)
Energy Input Ratio Modifier Curve, Speed 4 (temperature)
Energy Input Ratio Modifier Curve, Speed 4 (flow fraction)
Part Load Fraction Correlation, Speed 4 (part load ratio)
Nominal Time for Condensate Removal to Begin, Speed 4 {s}
Ratio of Initial Moisture Evaporation Rate and Steady-state Latent
Capacity, Speed 4 {dimensionless}
Maximum ON/OFF Cycling Rate, Speed 4 {cycles/hr}
Latent Capacity Time Constant, Speed 4 {s}
Rated waste heat fraction of power input, Speed 4 {dimensionless}
Waste heat modifier curve, Speed 4 (temperature)
Evaporative Condenser Effectiveness, Speed 4 {dimensionless}
Evaporative Condenser Air Volume Flow Rate, Speed 4 {m3/s}
Evaporative Condenser Pump Rated Power Consumption, Speed 4 {W}

Coil:Heating:Gas,
Supp Gas Heating Coil 1, !- Coil Name
FanAndCoilAvailSched,
!- Availability Schedule Name
0.8,
!- Gas Burner Efficiency of the Coil
45000,
!- Nominal Capacity of the Coil {W}
SuppHeating Coil Air Inlet Node, !- Coil_Air_Inlet_Node
Air Loop Outlet Node;
!- Coil_Air_Outlet_Node
Fan:OnOff,
Supply Fan 1,
!- Fan Name
FanAndCoilAvailSched,
!- Availability Schedule Name
0.7,
!- Fan Total Efficiency
300.0,
!- Delta Pressure {Pa}
1.7,
!- Max Flow Rate {m3/s}
0.9,
!- Motor Efficiency
1.0,
!- Motor In Airstream Fraction
Mixed Air Node,
!- Fan_Inlet_Node
DX Cooling Coil Air Inlet Node; !- Fan_Outlet_Node
AirTerminal:SingleDuct:Uncontrolled,
Zone1DirectAir,
FanAndCoilAvailSched,
Zone 1 Inlet Node,
0.612;

!
!
!
!

direct air unit name

schedule name for on/off schedule
zone supply air node name
maximum air flow rate, m3/s

AirTerminal:SingleDuct:Uncontrolled,
Zone2DirectAir,
FanAndCoilAvailSched,
Zone 2 Inlet Node,
0.476;

!
!
!
!

direct air unit name

schedule name for on/off schedule
zone supply air node name
maximum air flow rate, m3/s

AirTerminal:SingleDuct:Uncontrolled,
Zone3DirectAir,
FanAndCoilAvailSched,
Zone 3 Inlet Node,
0.612;

!
!
!
!

direct air unit name

schedule name for on/off schedule
zone supply air node name
maximum air flow rate, m3/s

Unitary Air to Air MultiSpeed Heat Pump (AirLoopHVAC) Outputs

HVAC,Average,Unitary
HVAC,Average,Unitary
HVAC,Average,Unitary
HVAC,Average,Unitary
HVAC,Average,Unitary
HVAC,Average,Unitary

9/29/14

System
System
System
System
System
System

Fan Part Load Ratio []

Compressor Part Load Ratio []
DX Coil Cycling Ratio []
DX Coil Speed Ratio []
DX Coil Speed Level []
Electric Power[W]

1065

Input-Output Reference

Group Unitary Equipment

HVAC,Sum,Unitary System Electric Energy [J]

HVAC,Average,Unitary System Total Cooling Rate [W]
HVAC,Average,Unitary System Total Heating Rate [W]
HVAC,Average,Unitary System Sensible Cooling Rate [W]
HVAC,Average,Unitary System Sensible Heating Rate [W]
HVAC,Average,Unitary System Latent Cooling Rate [W]
HVAC,Average,Unitary System Latent Heating Rate [W]
HVAC,Average,Unitary System Ancillary Electric Power[W]
HVAC,Sum,Unitary System Cooling Ancillary Electric Energy [J]
HVAC,Sum,Unitary System Heating Ancillary Electric Energy [J]
If heat recovery is specified:
HVAC,Average, Unitary System Heat Recovery Rate [W]
HVAC,Average, Unitary System Heat Recovery Inlet Temperature [C]
HVAC,Average, Unitary System Heat Recovery Outlet Temperature [C]
HVAC,Average, Unitary System Heat Recovery Fluid Mass Flow Rate [kg/s]
HVAC,Sum, Unitary System Heat Recovery Energy [J]

Unitary System Fan Part Load Ratio []

This output variable is the ratio of actual air mass flow rate through the multispeed heat pump
to the heat pumps design air mass flow rate (i.e., design volumetric flow rate converted to dry
air mass flow rate) at Speed 1. For continuous fan operation mode, this variable is always 1.0
when the heat pump is available (based on the availability schedule). For cycling fan/cycling
coil operation mode, the actual air mass flow rate is calculated based on the ratio of the
sensible heating (or cooling) load to the steady-state heat pump heating (or cooling) capacity.
For the cycling fan mode, the runtime fraction for the heat pump fan may be different from the
fan part-load ratio reported here due the part-load performance of the heat pumps heating
(or cooling) coil (delay at start-up to reach steady-state output). In general, runtime fractions
are reported by individual components where appropriate (e.g., Fan:OnOff). When the speed
number is greater than 1, the value is 1.0.
Unitary System Compressor Part Load Ratio []
This output variable is the ratio of the sensible load (heating or cooling) to the steady-state
capacity of the multispeed heat pumps DX heating or cooling coil at Speed 1. The runtime
fraction for the heat pump compressor may be different from the compressor part-load ratio
reported here due the part-load performance of the heating/cooling coil (delay at start-up to
reach steady-state output). In general, runtime fractions are reported by individual
components where appropriate. When the speed number is greater than 1, the value is 1.0.
Unitary System DX Coil Cycling Ratio []
This output variable is the ratio of the sensible load (heating or cooling) to the steady-state
capacity of the multispeed heat pumps DX heating or cooling coil (Speed 1) for the entire
system timestep. The value is between 0.0 and 1.0 when the heat pump is cycling on and off
its lowest speed (Speed 1) and 1.0 when the multispeed heat pump operates at speeds
above 1.
Unitary System DX Coil Speed Ratio []
This output variable is the ratio of time in a system timestep that the compressor is at rated
speed between two consecutive speed numbers ( [Compressor Speed - Compressor speed
at Speed i-1] / [Compressor speed at Speed i - Compressor speed at Speed i-1]). The
compressor speed ratio reports (1.0 is max, 0.0 is min) and any value in between as it is
averaged over the timestep. The value is 0.0 during Speed 1 operation.
The physical meaning of the speed ratio is dependent on the compressor configuration
defined in the field of child coil object: Apply Part Load Fraction to Speeds greater than 1.
The allowed choice is either Yes or No. When No is entered, one compressor is assumed for
all speeds. The speed ratio represents how long the higher speed runs as a fraction of the
system timestep, and the lower speed runs in the rest of the system timestep. When Yes is
entered, multiple compressors are assumed, and each compressor has associated speed.
9/29/14

1066

Input-Output Reference

Group Unitary Equipment

The speed ratio represents how long the higher speed runs as a fraction of the system
timestep, and the low speed runs in a whole system timestep.
Unitary System DX Coil Speed Level []
This output variable reports the maximum speed needed when the heat pump operates to
meet the sensible load (heating or cooling) in a system timestep. When the value is 1, the
heat pump operates at Speed 1 (lowest speed). For this case the cycling ratio is between 0.0
and 1.0, while the speed ratio is 0.0. When the speed number output variable is above one,
such as i, the heat pump operation is determined by the speed ratio through linear
interpolation. For example, when the speed ratio is 0.4 and the speed number is 3, the heat
pump operates at Speed 3 for 40% of a system timestep and at Speed 2 for 60% of a system
timestep for a single compressor. For multiple compressors, the heat pump operates at
Speed 3 in the 40% of a system timestep and at Speed 2 in the whole system timestep.
Unitary System Total Heating Rate [W]
This output field is the total (enthalpy) heat addition rate of the multispeed heat pump to the
zones it is serving in Watts. This value is calculated using the enthalpy difference of the heat
pump outlet air and inlet air streams, and the air mass flow rate through the heat pump. This
value is calculated for each HVAC system timestep being simulated, and the results
(enthalpy addition only) are averaged for the timestep being reported.
Unitary System Total Cooling Rate [W]
This output field is the total (enthalpy) heat extraction rate of the multispeed heat pump from
the zones it is serving in Watts. This value is calculated using the enthalpy difference of the
heat pump outlet air and inlet air streams, and the air mass flow rate through the heat pump.
This value is calculated for each HVAC system timestep being simulated, and the results
(enthalpy extraction only) are averaged for the timestep being reported.
Unitary System Sensible Heating Rate [W]
This output field reports the sensible heat addition rate of the multispeed heat pump to the
zones it is serving in Watts. This value is calculated using the enthalpy difference of the heat
pump outlet air and inlet air streams at a constant humidity ratio, and the air mass flow rate
through the heat pump. This value is calculated for each HVAC system timestep being
simulated, and the results (heating only) are averaged for the timestep being reported.
Unitary System Sensible Cooling Rate [W]
This output field reports the moist air sensible heat extraction rate of the multispeed heat
pump from the zones it is serving in Watts. This value is calculated using the enthalpy
difference of the heat pump outlet air and inlet air streams at a constant humidity ratio, and
the air mass flow rate through the heat pump. This value is calculated for each HVAC system
timestep being simulated, and the results (cooling only) are averaged for the timestep being
reported.
Unitary System Latent Heating Rate [W]
This output field is the latent heat addition (humidification) rate of the multispeed heat pump
in Watts. This value is calculated as the difference between the total energy rate and the
sensible energy rate provided by the multispeed heat pump. This value is calculated for each
HVAC system timestep being simulated, and the results (latent heat addition only) are
averaged for the timestep being reported.
Unitary System Latent Cooling Rate [W]
This output field is the latent heat extraction (dehumidification) rate of the multispeed heat
pump in Watts. This value is calculated as the difference between the total energy rate and
the sensible energy rate provided by the multispeed heat pump. This value is calculated for

9/29/14

1067

Input-Output Reference

Group Unitary Equipment

each HVAC system timestep being simulated, and the results (latent heat extraction only) are
averaged for the timestep being reported.
Unitary System Electric Power [W]
This output field is the electricity consumption rate of the multispeed heat pump in Watts. The
consumption includes electricity used by the DX coils (including crankcase heater if the fuel
type is electricity), fans (indoor supply air fan and the condenser fans associated with the DX
coil[s]), auxiliary power during on and off period, and the supplemental heating coil (if
electric). This value is calculated for each HVAC system timestep being simulated, and the
results are averaged for the timestep being reported. Any non-electric energy use is not
reported by the heat pump object but is reported in the associated coil objects as appropriate.
Unitary System Electric Energy [J]
This output field is the electricity consumption of the multispeed heat pump in Joules for the
timestep being reported. The consumption includes electricity used by the DX compressor
(including crankcase heater if the fuel type is electricity), fans (indoor supply air fan and the
condenser fans associated with the DX coil[s]), auxiliary power during on and off period, and
the supplemental heating coil (if electric). This value is calculated for each HVAC system
timestep being simulated, and the results are summed for the timestep being reported. Any
non-electric energy use is not reported by the heat pump object but is reported in the
associated coil objects as appropriate.
Unitary System Ancillary Electric Power [W]
This output field is the average auxiliary electricity consumption rate (including both on-cycle
and off-cycle) in Watts for the timestep being reported.
Unitary System Cooling Ancillary Electric Energy [J]
This is the auxiliary electricity consumption in Joules for the timestep being reported. This is
the auxiliary electricity consumption during periods when the heat pump is providing cooling
(DX cooling coil is operating). This output is also added to a meter with Resource Type =
Electricity, End Use Key =Cooling, Group Key = System (ref. Output:Meter objects).
Unitary System Heating Ancillary Electric Energy [J]
This is the auxiliary electricity consumption in Joules for the timestep being reported. This is
the auxiliary electricity consumption during periods when the heat pump is providing heating
(DX heating coil is operating). This output is also added to a meter with Resource Type =
Electricity, End Use Key =Heating, Group Key = System (ref. Output:Meter objects).
Unitary System Heat Recovery Inlet Temperature [C]
Unitary System Heat Recovery Outlet Temperature [C]
Unitary System Heat Recovery Fluid Mass Flow Rate [kg/s]
These outputs are the heat recovery inlet and outlet temperatures and water mass flow rate
for multispeed heat pumps with heat recovery.
Unitary System Heat Recovery Rate [W]
Unitary System Heat Recovery Energy [J]
For multispeed heat pumps with heat recovery, these outputs are the recoverable energy rate
(in Watts) and energy (in Joules).
AirLoopHVAC:Unitary:Furnace:HeatOnly
The EnergyPlus furnace is a virtual component that consists of a fan component (OnOff or
ConstantVolume) and a Gas or Electric heating coil component. The blow through furnace
configuration is shown in the Figure below.
9/29/14

1068

Input-Output Reference

Group Unitary Equipment

Furnace

Fan

Air Loop

Heating
Coil

Zone Equipment

Control
Zone

Direct Air
Unit

Zone

Direct Air
Unit

Figure 120. Schematic of Blow Through Furnace Model

Links to the fan and heating coil specifications are provided in the furnace input data syntax.
In addition the control zone name and the furnace design operating conditions are specified
by the furnace inputs.
Field: Name
This alpha field contains the identifying name for the furnace.
Field: Availability Schedule Name
This alpha field contains the schedule name which contains information on the availability of
the furnace to operate. A schedule value equal to 0 denotes that the furnace must be off for
that time period. A value greater than 0 denotes that the furnace is available to operate
during that time period. This schedule may be used to completely disable the unitary system
as required. If this field is left blank, the schedule has a value of 1 for all time periods.
Field: Furnace Inlet Node Name
This alpha field contains the furnace inlet node name.
Field: Furnace Outlet Node Name
This alpha field contains the furnace outlet node name.
Field: Supply Air Fan Operating Mode Schedule Name
This alpha field specifies the name of the supply air fan operating mode schedule. The supply
air fan operating mode may vary during the simulation based on time-of-day or with a change
of season. Schedule values of 0 denote that the furnace supply air fan and the heating coil
cycle on and off together to meet the heating load (a.k.a. AUTO fan). Schedule values other
than 0 denote that the supply fan runs continuously while the heating coil cycles to meet the
load.

9/29/14

1069

Input-Output Reference

Group Unitary Equipment

Field: Maximum Supply Air Temperature

This numeric field contains the design operating furnace air outlet temperature in degrees C
when the furnace is heating. If this input field is left blank, the default value is 80 C.
Field: Supply Air Flow Rate
This numeric field contains the design volumetric flow rate of the furnace in cubic meters per
second. This volumetric flow rate should match the flow rate specified for the furnace fan.
Field: Controlling Zone or Thermostat Location
This alpha field contains the identifying zone name where the thermostat controlling the
furnace is located.
Field: Supply Fan Object Type
This alpha field contains the identifying type of supply air fan specified for the furnace. Fan
type must be Fan:OnOff or Fan:ConstantVolume. Fan:ConstantVolume is used when the
Supply Air Fan Operating Mode Schedule values are never 0 and the fan operates
continuously. Fan:OnOff is used when the fan cycles on and off with the cooling or heating
coil (i.e. Supply Air Fan Operating Mode Schedule values are at times 0).
Field: Supply Fan Name
This alpha field contains the identifying name given to the furnace fan.
Field: Fan Placement
This alpha field has two choices: BlowThrough or DrawThrough. The first choice stands for
blow through fan. This means that the unit consists of a fan followed by the heating coil. The
fan blows through the heating coil. The second choice stands for draw through fan. This
means that the unit consists of the heating coil followed by a fan. The fan draws air through
the heating coil. If this field is left blank, the default is blow through.
Field: Heating Coil Object Type
This alpha field contains the identifying type of heating coil specified in the furnace. The hot
water and steam heating coils require specifying plant loop, branches, and connectors
objects to support the heating coils, and are placed on the demand side of the plantloop. The
hot water flow modulation through the heating coil does not require additional controller or
Controller:WaterCoil object. The parent object (Unitary Heat Only Furnace) itself provides the
"controller" function of modulating water flow. Heating coil type must be:
Coil:Heating:Electric
Coil:Heating:Gas
Coil:Heating:Water
Coil:Heating:Steam

Field: Heating Coil Name

This alpha field contains the identifying name given to the furnace heating coil.
As shown in the example below, correct specification of the furnace requires specification of
the following objects in addition to the furnace object:
1) fan (Fan:OnOff or Fan:ConstantVolume)
2) heating coil (Coil:Heating:Gas or Coil:Heating:Electric)
3) direct air unit (AirTerminal:SingleDuct:Uncontrolled) for each zone served by the furnace

Note: the furnaces fan and heating coil must be connected in the air loop according to the configuration
shown above (Figure 120) when a blow through fan configuration is specified. If a draw through fan is

9/29/14

1070

Input-Output Reference

Group Unitary Equipment

used, the fan is located down stream of the heating coil. In addition, the volumetric air flow rate specified in
the direct air unit for the controlling zone should properly reflect the fractional volumetric air flow rate
specified in the furnace object.

AirLoopHVAC:Unitary:Furnace:HeatOnly,
Gas Furnace 1,
!- Name
FanAndCoilAvailSched, !- Availability Schedule Name
Air Loop Inlet Node, !- Furnace Air Inlet Node Name
Air Loop Outlet Node, !- Furnace Air Outlet Node Name
CycFanSchedule,
!- Supply Air Fan Operating Mode Schedule Name
80,
!- Maximum Supply Air Temperature {C}
1.3,
!- Supply Air Flow Rate {m3/s}
East Zone,
!- Controlling Zone or Thermostat Location
Fan:OnOff,
!- Supply Fan Object Type
Supply Fan 1,
!- Supply Fan Fame
BlowThrough,
!- Fan Placement
Coil:Heating:Gas,
!- Heating Coil Object Type
Furnace Coil;
!- Heating Coil Name

Coil:Heating:Gas,
Furnace Coil,
FanAndCoilAvailSched,
0.8,
20000,
Heating Coil Air Inlet
Air Loop Outlet Node,
,
100,
PLFCurveforGasFurnace,
10;

!- Coil Name
!- Availability Schedule Name
!- Gas Burner Efficiency of the Coil
!- Nominal Capacity of the Coil {W}
Node, !- Coil_Air_Inlet_Node
!- Coil_Air_Outlet_Node
!- Coil_Temp_Setpoint_Node
!- Parasitic Electric Load {W}
!- Part load fraction correlation (function of part load ratio)
!- Parasitic Gas Load {W}

Curve:Cubic,
PLFCurveforGasFurnace, !- Name
0.8, !- Coefficient1 Constant
0.2, !- Coefficient2 x
0.0, !- Coefficient3 x**2
0.0, !- Coefficient4 x**3
0, !- Minimum Value of x
1; !- Maximum Value of x

Fan:OnOff,
Supply Fan 1,
!- Fan Name
FanAndCoilAvailSched, !- Availability Schedule Name
0.7,
!- Fan Total Efficiency
600.0, !- Delta Pressure {Pa}
1.3,
!- Max Flow Rate {m3/s}
0.9,
!- Motor Efficiency
1.0,
!- Motor In Airstream Fraction
Air Loop Inlet Node,
!- Fan_Inlet_Node
Heating Coil Air Inlet Node; !- Fan_Outlet_Node

9/29/14

1071

Input-Output Reference

Group Unitary Equipment

AirTerminal:SingleDuct:Uncontrolled,
Zone1DirectAir,
!- Direct Air Name
FanAndCoilAvailSched, !- Schedule name for on/off schedule
Zone 1 Inlet Node,
!- Zone Supply Air Node Name
0.47;
!- Maximum air flow rate {m3/s}
AirTerminal:SingleDuct:Uncontrolled,
Zone2DirectAir,
!- Direct Air Name
FanAndCoilAvailSched, !- Schedule name for on/off schedule
Zone 2 Inlet Node,
!- Zone Supply Air Node Name
0.36;
!- Maximum air flow rate {m3/s}
AirTerminal:SingleDuct:Uncontrolled,
Zone3DirectAir,
!- Direct Air Name
FanAndCoilAvailSched, !- Schedule name for on/off schedule
Zone 3 Inlet Node,
!- Zone Supply Air Node Name
0.47;
!- Maximum air flow rate {m3/s}

Example of Heat-Only Furnace Specification

Unitary/Furnace Heat Only (AirLoopHVAC) Outputs
HVAC,Average,Unitary System Fan Part Load Ratio []

Unitary System Fan Part Load Ratio []

This output variable is the ratio of actual air mass flow rate through the furnace to the
furnaces design air mass flow rate (i.e., design volumetric flow rate converted to dry air mass
flow rate). For continuous fan operation mode, this variable is always 1.0 when the furnace is
available (based on the availability schedule). For cycling fan/cycling coil operation mode, the
actual air mass flow rate is calculated based on the ratio of the sensible heating load to the
furnace heating capacity. For the cycling fan mode, the runtime fraction for the furnace fan
may be different from the fan part-load ratio reported here due the part-load performance of
the furnaces heating coil (delay at start-up to reach steady-state heating output). In general,
runtime fractions are reported by individual components where appropriate (e.g., Fan:OnOff).
AirLoopHVAC:UnitaryHeatOnly
The
AirLoopHVAC:UnitaryHeatOnly
is
identical
to
the
AirLoopHVAC:Unitary:Furnace:HeatOnly model. The heat-only unitary system is a virtual
component that consists of a fan component (OnOff or ConstantVolume) and a Gas or
Electric heating coil component. The blow through unitary system configuraion is shown in
the Figure below.

9/29/14

1072

Input-Output Reference

Group Unitary Equipment

Unitary System

Fan

Air Loop

Heating
Coil

Zone Equipment

Control
Zone

Direct Air
Unit

Zone

Direct Air
Unit

Figure 121. Schematic of Blow Through Heat-Only Unitary System

Links to the fan and heating coil specifications are provided in the unitary system input data
syntax. In addition, the control zone name and the unitary system design operating conditions
are specified by the unitary system syntax.
Field: Name
This alpha field contains the identifying name for the unitary system.
Field: Availability Schedule Name
This alpha field contains the schedule name which contains information on the availability of
the unitary system to operate. A schedule value equal to 0 denotes that the unitary system
must be off for that time period. A value greater than 0 denotes that the unitary system is
available to operate during that time period. This schedule may be used to completely disable
the unitary system as required. If this field is left blank, the schedule has a value of 1 for all
time periods.
Field: Unitary System Air Inlet Node Name
This alpha field contains the unitary system inlet node name.
Field: Unitary System Air Outlet Node Name
This alpha field contains the unitary system outlet node name.
Field: Supply Air Fan Operating Mode Schedule Name
This alpha field specifies the name of the supply air fan operating mode schedule. The supply
air fan operating mode may vary during the simulation based on time-of-day or with a change
of season. Schedule values of 0 denote that the furnace supply air fan and the heating coil
cycle on and off together to meet the heating load (a.k.a. AUTO fan). Schedule values other
than 0 denote that the supply fan runs continuously while the heating coil cycles to meet the
load.
9/29/14

1073

Input-Output Reference

Group Unitary Equipment

Field: Maximum Supply Air Temperature

This numeric field contains the design air outlet temperature in degrees C when the unitary
system is heating. If this input field is left blank, the default value is 80 C.
Field: Supply Air Flow Rate
This numeric field contains the design volumetric flow rate of the unitary system in cubic
meters per second. This volumetric flow rate should match the flow rate specified for the
unitary system fan.
Field: Controlling Zone or Thermostat Location
This alpha field contains the identifying zone name where the thermostat controlling the
unitary system is located.
Field: Supply Fan Object Type
This alpha field contains the identifying type of supply air fan specified for the unitary system.
Fan type must be Fan:OnOff or Fan:ConstantVolume. Fan:ConstantVolume is used when
the Supply Air Fan Operating Mode Schedule values are never 0 and the fan operates
continuously. Fan:OnOff is used when the fan cycles on and off with the cooling or heating
coil (i.e. Supply Air Fan Operating Mode Schedule values are at times 0).
Field: Supply Fan Name
This alpha field contains the identifying name given to the unitary system fan.
Field: Fan Placement
This alpha field has two choices: BlowThrough or DrawThrough. The first choice stands for
blow through fan. This means that the unit consists of a fan followed by the heating coil. The
fan blows through the heating coil. The second choice stands for draw through fan. This
means that the unit consists of the heating coil followed by a fan. The fan draws air through
the heating coil. If this field is left blank, the default is blow through.
Field: Heating Coil Object Type
This alpha field contains the identifying type of heating coil specified in the unitary system.
The hot water and steam heating coils require specifying plant loop, branches, and
connectors objects to support the heating coils, and are placed on the demand side of the
plantloop. The hot water flow modulation through the heating coil does not require additional
controller or Controller:WaterCoil object. The parent object (Unitary Heat Only) itself provides
the "controller" function of modulating water flow. Heating coil type must be:
Coil:Heating:Electric
Coil:Heating:Gas
Coil:Heating:Water
Coil:Heating:Steam

Field: Heating Coil Name

This alpha field contains the identifying name given to the unitary system heating coil.
As shown in the example below, correct specification of the heat-only unitary system requires
specification of the following objects in addition to the unitary system object:
1) fan (Fan:OnOff or Fan:ConstantVolume)
2) heating coil (Coil:Heating:Gas or Coil:Heating:Electric)
3) direct air unit (AirTerminal:SingleDuct:Uncontrolled) for each zone served by the furnace

9/29/14

1074

Input-Output Reference

Group Unitary Equipment

Note: the unitary systems fan and heating coil must be connected in the air loop according to the
configuration shown above (Figure 121) when a blow through fan configuration is specified. If a draw
through fan is used, the fan is located down stream of the heating coil. In addition, the volumetric air flow
rate specified in the direct air unit for the controlling zone should properly reflect the fractional volumetric
air flow rate specified in the unitary system object.

AirLoopHVAC:UnitaryHeatOnly,
Gas Unitary System 1, !- Name
FanAndCoilAvailSched, !- Availability Schedule Name
Air Loop Inlet Node, !- Unitary System Air Inlet Node Name
Air Loop Outlet Node, !- Unitary System Air Outlet Node Name
CycFanSchedule,
!- Supply Air Fan Operating Mode Schedule Name
80,
!- Maximum Supply Air Temperature {C}
1.3,
!- Supply Air Flow Rate {m3/s}
East Zone,
!- Controlling Zone or Thermostat Location
Fan:OnOff,
!- Supply Fan Object Type
Supply Fan 1,
!- Supply Fan Name
BlowThrough,
!- Fan Placement
Coil:Heating:Gas,
!- Heating Coil Object Type
Unitary System Heating Coil; !- Heating Coil Name

Coil:Heating:Gas,
Unitary System Heating Coil,
FanAndCoilAvailSched,
0.8,
20000,
Heating Coil Air Inlet Node,
Air Loop Outlet Node,
,
100,
PLFCurveforUnitarySystem,
10;

!!!!!!!!!!-

Coil Name
Availability Schedule Name
Gas Burner Efficiency of the Coil
Nominal Capacity of the Coil {W}
Coil_Air_Inlet_Node
Coil_Air_Outlet_Node
Coil_Temp_Setpoint_Node
Parasitic Electric Load {W}
Part load fraction correlation (function of part load ratio)
Parasitic Gas Load {W}

Curve:Cubic,
PLFCurveforUnitarySystem, !- Name
0.8, !- Coefficient1 Constant
0.2, !- Coefficient2 x
0.0, !- Coefficient3 x**2
0.0, !- Coefficient4 x**3
0, !- Minimum Value of x
1; !- Maximum Value of x

Fan:OnOff,
Supply Fan 1,
!- Fan Name
FanAndCoilAvailSched, !- Availability Schedule Name
0.7,
!- Fan Total Efficiency
600.0, !- Delta Pressure {Pa}
1.3,
!- Max Flow Rate {m3/s}
0.9,
!- Motor Efficiency
1.0,
!- Motor In Airstream Fraction
Air Loop Inlet Node,
!- Fan_Inlet_Node
Heating Coil Air Inlet Node; !- Fan_Outlet_Node

9/29/14

1075

Input-Output Reference

Group Unitary Equipment

AirTerminal:SingleDuct:Uncontrolled,
Zone1DirectAir,
!- Direct Air Name
FanAndCoilAvailSched, !- Schedule name for on/off schedule
Zone 1 Inlet Node,
!- Zone Supply Air Node Name
0.47;
!- Maximum air flow rate {m3/s}
AirTerminal:SingleDuct:Uncontrolled,
Zone2DirectAir,
!- Direct Air Name
FanAndCoilAvailSched, !- Schedule name for on/off schedule
Zone 2 Inlet Node,
!- Zone Supply Air Node Name
0.36;
!- Maximum air flow rate {m3/s}
AirTerminal:SingleDuct:Uncontrolled,
Zone3DirectAir,
!- Direct Air Name
FanAndCoilAvailSched, !- Schedule name for on/off schedule
Zone 3 Inlet Node,
!- Zone Supply Air Node Name
0.47;
!- Maximum air flow rate {m3/s}

Example of Heat-Only Unitary System Specification

Unitary Heat Only (AirLoopHVAC) Outputs
HVAC,Average,Unitary System Fan Part Load Ratio []

Unitary System Fan Part Load Ratio []

This output variable is the ratio of actual air mass flow rate through the unitary system to the
unitary systems design air mass flow rate (i.e., design volumetric flow rate converted to dry
air mass flow rate). For continuous fan operation mode, this variable is always 1.0 when the
unitary system is available (based on the availability schedule). For cycling fan/cycling coil
operation mode, the actual air mass flow rate is calculated based on the ratio of the sensible
heating load to the unitary system heating capacity. For the cycling fan mode, the runtime
fraction for the unitary system fan may be different from the fan part-load ratio reported here
due the part-load performance of the unitary systems heating coil (delay at start-up to reach
steady-state heating output). In general, runtime fractions are reported by individual
components where appropriate (e.g., Fan:OnOff).
AirLoopHVAC:UnitaryHeatPump:WaterToAir
The unitary water-to-air heat pump is similar to the unitary air-to-air heat pump except water
is used on the source side. Links to the fan, WaterToAirHeatPump cooling coil,
WaterToAirHeatPump heating coil, and supplementary heating coil specifications are
provided in the heat pumps input data syntax. The heat pump switches between cooling and
heating depending on the zones demand. The load side (air) of the unitary water-to-air heat
pump consists of an On/Off fan component, a WaterToAirHeatPump cooling coil component,
a WaterToAirHeatPump heating coil component, and a Gas, Electric, Steam, or Hot Water
supplemental heating coil component. The source side (water) of the heat pump is connected
to a condenser loop with a heat exchanger (ground heat exchanger or other type) or a plant
loop with a heating source such as a boiler and a cooling source such as a chiller or cooling
tower. The diagram below shows the setup and connection of the heat pump for the source
side and load side for a ground heat exchanger configuration. Note that on the load side, the
WaterToAirHeatPump cooling coil must always be placed before the WaterToAirHeatPump
heating coil.
There are three type of WaterToAirHeatPump coil models available:
Coil:Cooling:WaterToAirHeatPump:ParameterEstimation
Coil:Heating:WaterToAirHeatPump:ParameterEstimation
Coil:Cooling:WaterToAirHeatPump:EquationFit
Coil:Heating:WaterToAirHeatPump:EquationFit
Coil:Cooling:WatertoAirHeatPump:VariableSpeedEquationFit
Coil:Heating:WatertoAirHeatPump:VariableSpeedEquationFit

9/29/14

1076

Input-Output Reference

Group Unitary Equipment

Figure 122. Water to Air Heat Pump Schematic for a BlowThrough Configuration with Ground Heat
Exchanger
In addition, the control zone name and the system design operating conditions are specified
by the heat pump inputs.
Field: Name
This alpha field contains the identifying name for the unitary system heat pump.
Field: Availability Schedule Name
This alpha field contains the schedule name (ref. Schedule objects) that contains information
on the availability of the heat pump to operate. A schedule value greater than 0 (usually 1 is
used) indicates that the unit can be on during the time period. A value less than or equal to 0
(usually 0 is used) denotes that the unit must be off for the time period. If this field is left
blank, the schedule has a value of 1 for all time periods.
Field: Air Inlet Node Name
This alpha field contains the name of the HVAC system node from which the heat pump
draws its inlet air.
Field: Air Outlet Node Name
This alpha field contains the name of the HVAC system node to which the heat pump sends
its outlet air.

9/29/14

1077

Input-Output Reference

Group Unitary Equipment

Field: Supply Air Flow Rate

This numeric field contains the design volumetric flow rate through the heat pump in cubic
meters per second. This volume flow rate is only used when the cooling and heating coil
object type is Coil:*:WaterToAirHeatPump:ParameterEstimation. Although a value greater
than 0 is required (input cannot be blank or 0), this input is not used for the EquationFit
model. Instead, the supply air flow rate is determined by the input in the corresponding
Coil:*:WaterToAirHeatPump:EquationFit objects.
Field: Controlling Zone or Thermostat Location
This alpha field contains the identifying zone name where the thermostat controlling the heat
pump is located.
Field: Supply Air Fan Object Type
This alpha field contains the identifying type of supply air fan specified in the heat pump. Fan
type must be Fan:OnOff.
Field: Supply Air Fan Name
This alpha field contains the identifying name given to the heat pump supply air fan, and
should match the name specified in the corresponding fan object.
Field: Heating Coil Object Type
This alpha field contains the identifying type of heating coil specified in the heat pump.
Heating coil types are:
Coil:Heating:WaterToAirHeatPump:ParameterEstimation
Coil:Heating:WaterToAirHeatPump:EquationFit
Coil:Heating:WaterToAirHeatPump:VariableSpeedEquationFit

Field: Heating Coil Name

This alpha field contains the identifying name given to the WaterToAirHeatPump heating coil,
and should match the name specified in the corresponding WaterToAirHeatPump heating coil
object.
Field: Heating Convergence
This numeric value allows the user to determine how close the air side has to be controlled.
Lower the value of convergence better the control of air side conditions and less the zone
temperature fluctuations. However in a poorly designed system, a lower convergence might
result in warning errors which are caused due to the iteration limit for run time fraction
calculation is limited to 20.
Field: Cooling Coil Object Type
This alpha field contains the identifying type of cooling coil specified in the heat pump.
Cooling coil types are:
Coil:Cooling:WaterToAirHeatPump:ParameterEstimation
Coil:Cooling:WaterToAirHeatPump:EquationFit
Coil:Cooling:WaterToAirHeatPump:VariableSpeedEquationFit

Field: Cooling Coil Name

This alpha field contains the identifying name given to the WaterToAirHeatPump cooling coil,
and should match the name specified in the corresponding WaterToAirHeatPump cooling coil
object.
Field: Cooling Convergence
This numeric value allows the user to determine how close the air side has to be controlled.
Lower the value of convergence better the control of air side conditions and less the zone
9/29/14

1078

Input-Output Reference

Group Unitary Equipment

temperature fluctuations. However in a poorly designed system, a lower convergence might

result in warning errors which are caused due to the iteration limit for run time fraction
calculation is limited to 20.
Field: Maximum Cycling Rate
This numeric field contains the maximum on-off cycling rate for the compressor, which occurs
at 50% run time fraction. Suggested values are shown below (Henderson et al. 1999):
Heat Pump Condition Recommended Values
Typical
2.5
Good
2.5
Poor
3.0

Field: Heat Pump Time Constant

This numeric field contains the time constant for the cooling coil's capacity to reach steady
state after startup. Suggested values are shown below (Henderson et al. 1999):
Heat Pump Condition Recommended Values
Typical
60
Good
60
Poor
60

Field: Fraction of On-Cycle Power Use

This numeric field contains the fraction of on-cycle power use to adjust the part load fraction
based on the off-cycle power consumption due to crankcase heaters, controls, fans, and etc.
Suggested value values are below (Henderson et al. 1999):
Heat Pump Condition Recommended Values
Typical
0.01
Good
0.01
Poor
0.03

Field: Heat Pump Fan Delay Time

This numeric field contains the time delay for the heat pump supply air fan to shut off after the
compressor cycles off in seconds. This value can be obtained from the manufacturer or the
heat pump catalog. Enter a value of zero when the heat pumps fan operating mode is
continuous. Suggested value is 60 seconds.
Field: Supplemental Heating Coil Object Type
This is the object type of the supplemental heating coil. The hot water and steam heating
coils require specifying plant loop, branches, and connectors objects to support the heating
coils, and are placed on the demand side of the plantloop. The hot water flow modulation
through the supplemental heating coil does not require additional controller or
Controller:WaterCoil object. The parent object (AirLoop Unitary Water to Air Heat Pump) itself
provides the "controller" function of modulating water flow. The valid choices are:
Coil:Heating:Electric
Coil:Heating:Gas
Coil:Heating:Water
Coil:Heating:Steam

Field: Supplemental Heating Coil Name

This alpha field contains the identifying name given to the supplemental heating coil, and
should match the name specified in the corresponding supplemental heating coil object.

9/29/14

1079

Input-Output Reference

Group Unitary Equipment

Field: Maximum Supply Air Temperature from Supplemental Heater

This numeric field defines the maximum allowed supply air temperature exiting the heat pump
supplemental heating coil in degrees Celsius.
Field: Maximum Outdoor Dry-Bulb Temperature for Supplemental Heater Operation
This numeric field defines the outdoor air dry-bulb temperature in degrees Celsius above
which the heat pump supplemental heating coil is disabled. The temperature for this input
field must be less than or equal to 21 C. If this input field is left blank, the default value is
21 C.
Field: Outdoor Dry-Bulb Temperature Sensor Node Name
This alpha field specifies the name of the outdoor node which controls the operation of the
supplemental heating coil. If this field is left blank, the outdoor temperature is based solely on
the weather data. If this field is not blank, the node name specified must also be listed in an
OutdoorAir:Node object where the height of the node is taken into consideration when
calculating outdoor temperature from the weather data. Alternately, the node name must be
specified in an OutdoorAir:NodeList object where the outdoor temperature is taken directly
from the weather data.
Field: Fan Placement
This alpha field has two choices: BlowThrough or DrawThrough. The first choice represents
a blow through system where the supply air fan is before the WaterToAirHeatPump
cooling/heating coil and the supplementary heating coil. The second choice represents a
draw through system where the supply fan is between the WaterToAirHeatPump
cooling/heating coil and the supplementary heating coil. If this input field is left blank, the
default is blow through.
Field: Supply Air Fan Operating Mode Schedule Name
This alpha field specifies the name of the supply air fan operating mode schedule. The supply
air fan operating mode may vary during the simulation based on time-of-day or with a change
of season. Schedule values of 0 denote that the supply air fan and the heating/cooling coil
cycle on and off together to meet the heating or cooling load (a.k.a. AUTO fan). Schedule
values other than 0 denote that the supply air fan runs continuously while the heating or
cooling coil cycles to meet the load. If this field is left blank, the model assumes the supply air
fan cycles with the heating or cooling coil throughout the simulation period.
As shown in the example below, correct specification of the water-to-air heat pump requires
specification
of
the
following
objects
in
addition
to
the
AirLoopHVAC:UnitaryHeatPump:WaterToAir object:
On/Off fan
WaterToAirHeatPump cooling coil
WaterToAirHeatPump heating coil
Supplementary heating coil
Direct air unit for each zone served by the heat pump
Condenser demand branches
It should be noted that the volumetric air flow rate specified in the direct air unit for the
controlling zone should properly reflect the fractional volumetric air flow rate specified in the
heat pump object.
Field: Dehumidification Control Type
This alpha input field contains the type of dehumidification control. The following options are
valid for this field:
None - meet sensible load only, no active dehumidification control
9/29/14

1080

Input-Output Reference

Group Unitary Equipment

CoolReheat - cool beyond the dry-bulb temperature set point as required to meet the
high humidity setpoint. The excess cooling beyond the cooling set point temperature
is offset by the supplemental heating coil.
The default is None. For CoolReheat dehumidification control modes, the maximum humidity
setpoint is required. This must be set using a ZoneControl:Humidistat object. When extra
dehumidification is required, the system may not be able to meet the humidity setpoint if its
full capacity is not adequate. Supplemental heating coil (supplemental heating coil type and
name) is a required input in WaterToAir HeatPumps. When dehumidification control is active
the heating and the reheat load due to extra dehumidification are met with supplemetal
heating coil. The supplemental heating coil capacity must be adequate enough to meet the
heating coil load and offset the excess cooling load due to extra dehumidification. The
dehumidification
control
type
CoolReheat
works
only
with
Coil:Cooling:WaterToAirHeatPump:EquationFit cooling coil type.
Field: Heat Pump Coil Water Flow Mode
This field specifies the way in which water flow through the heat pump coils will be modeled.
This field is only used when WatertoAirHeatPump:EquationFit coils are used. There are three
options:
Cycling
Constant
CyclingOnDemand
Cycling varies water flow through the coil based on the heat pump Part Load Ratio. This
control method is appropriate for modeling heat pumps that are outfitted with a soleniod valve
which allows water to flow through the coil only when the compressor is active. This is the
default for EnergyPlus V8 and later.
Constant provides a constant water flow regardless of heat pump operation. Remember that
EnergyPlus has two coils (a heating coil and a cooling coil) to approximate the operation of
one coil that can operate in either heating mode or cooling mode. Therefore, when the water
flow mode is constant, there will be full flow through either the heating coil or the cooling coil,
but not both at the same time.
ConstantOnDemand provides full flow through the coil whenever there is a load. When
there is no load, there is zero flow through the coil. This control strategy represents the way
EnergyPlus modeled heat pump water flow prior to Version 8.

9/29/14

1081

Input-Output Reference

Group Unitary Equipment

Following is an example of IDF usage:

AirLoopHVAC:UnitaryHeatPump:WaterToAir,
DXAC Heat Pump 1,
!- Name
FanAndCoilAvailSched,
!- Availability Schedule Name
Mixed Air Node,
!- Air Inlet Node Name
Air Loop Outlet Node,
!- Air Outlet Node Name
2,
!- Supply Air Flow Fate {m3/s}
East Zone,
!- Controlling Zone or Thermostat Location
Fan:OnOff,
!- Supply Air Fan Object Type
Supply Fan 1,
!- Supply Air Fan Name
Coil:Heating:WaterToAirHeatPump:ParameterEstimation, !- Heating Coil Object Type
Heat Pump Heating Mode, !- Heating Coil Name
0.001,
!- Heating Convergence
Coil:Cooling:WaterToAirHeatPump:ParameterEstimation, !- Cooling Coil Object Type
Heat Pump Cooling Mode, !- Cooling Coil Name
0.001,
!- Cooling Convergence
2.5, !- Maximum Cycling Rate {cycles/hr}
60, !- Heat Pump Time Constant {s}
0.01, !- Fraction of On-Cycle Power Use
60,
!- Heat Pump Fan Delay Time {s}
Coil:Heating:Gas,
!- Supplemental Heating Coil Object Type
Heat Pump DX Supp Heating Coil 1, !- Supplemental Heating Coil Name
50,
!- Maximum Supply Air Temperature from Supplemental Heater {C}
21,
!- Maximum Outdoor Dry-Bulb Temperature for Supplemental Heater Operation {C}
Outside Air Inlet Node, !- Outdoor Dry-Bulb Temperature Sensor Node Name
BlowThrough,
!- Fan Placement
CyclingFanSch,
!- Supply Air Fan Operating Mode Schedule Name
CoolReheat;
!- Dehumidification Control Type

Schedule:Compact,
CyclingFanSch,
Fraction,
Through: 12/31,
For: AllDays,
Until: 24:00,
0.0;

!!!!!!-

Name
Schedule Type Limits Name
Field 1
Field 2
Field 3
Field 4

Coil:Cooling:WaterToAirHeatPump:ParameterEstimation,
Heat Pump Cooling Mode, !- Name
Scroll,
!- Compressor Type
R22,
!- Refrigerant Type
0.0015,
!- Design Source Side Flow Rate {m3/s}
38000, !- Nominal Cooling Coil Capacity {W)
0,
!- Nominal Time for Condensate Removal to Begin {s}
0,
!- Ratio of Initial Moisture Evaporation Rate and Steady State Latent Capacity
3000000,
!- High Pressure CutOff {Pa}
0,
!- Low Pressure CutOff {Pa}
Water to Air Heat Pump Source Side1 Inlet Node, !- Water Inlet Node Name
Water to Air Heat Pump Source Side1 Outlet Node, !- Water Outlet Node Name
Cooling Coil Air Inlet Node, !- Air Inlet Node Name
Heating Coil Air Inlet Node, !- Air Outlet Node Name
3.78019E+03,!- Parameter 1 {W/K}
2.80303E+03,!- Parameter 2 {W/K}
7.93591E-01,!- Parameter 3 {C}
1.91029E+03,!- Parameter 4 {W}
2.66127E+00,!- Parameter 5
1.06009E-02,!- Parameter 6
1.65103E+00,!- Parameter 7
9.73887E-03,!- Parameter 8
1.04563E+03;!- Parameter 9

9/29/14

1082

Input-Output Reference

Group Unitary Equipment

Coil:Heating:WaterToAirHeatPump:ParameterEstimation,
Heat Pump HEATING Mode, !- Name
Scroll,
!- Compressor Type
R22,
!- Refrigerant Type
0.0015,
!- Design Source Side Flow Rate {m3/s}
38000,
!- Nominal Heating Coil Capacity {W}
3000000,
!- High Pressure CutOff
0,
!- Low Pressure CutOff {Pa}
Water to Air Heat Pump Source Side2 Inlet Node, !- Water Inlet Node Name
Water to Air Heat Pump Source Side2 Outlet Node, !- Water Outlet Node Name
Heating Coil Air Inlet Node, !- Air Inlet Node Name
SuppHeating Coil Air Inlet Node, !- Air Outlet Node Name
3.91379E+03, !- Parameter 1 {W/K}
5.94753E-01, !- Parameter 2 {C}
2.49945E+03, !- Parameter 3 {W}
8.68734E-01, !- Parameter 4
7.23595E-03, !- Parameter 5
3.69126E+00, !- Parameter 6
1.75701E-05, !- Parameter 7
3.65348E+03; !- Parameter 8

Coil:Heating:Gas,
Heat Pump DX Supp Heating Coil 1, !- Name
FanAndCoilAvailSched,
!- Availability Schedule Name
0.8,
!- Gas Burner Efficiency
32000,
!- Nominal Capacity {W}
SuppHeating Coil Air Inlet Node, !- Air Inlet Node Name
Air Loop Outlet Node;
!- Air Outlet Node Name

BRANCH,
Gshp Cooling Condenser Branch, !- Name
0, !- Maximum Flow Rate {m3/s}
, !- Pressure Drop Curve Name
Coil:Cooling:WaterToAirHeatPump:ParameterEstimation, !- Component 1 Object Type
Heat Pump Cooling Mode, !- Component 1 Name
Water to Air Heat Pump Source Side1 Inlet Node, !- Component 1 Inlet Node Name
Water to Air Heat Pump Source Side1 Outlet Node, !- Component 1 Outlet Node Name
ACTIVE; !- Component 1 Branch Control Type
BRANCH,
Gshp Heating Condenser Branch, !- Name
0, !- Maximum Flow Rate {m3/s}
, !- Pressure Drop Curve Name
Coil:Heating:WaterToAirHeatPump:ParameterEstimation, !- Component 1 Object Type
Heat Pump Heating Mode, !- Component 1 Name
Water to Air Heat Pump Source Side2 Inlet Node, !- Component 1 Inlet Node Name
Water to Air Heat Pump Source Side2 Outlet Node, !- Component 1 Outlet Node Name
ACTIVE; !- Component 1 Branch Control Type

9/29/14

1083

Input-Output Reference
Fan:OnOff,
Supply Fan 1,
FanAndCoilAvailSched,
0.7,
300.0,
2.0,
0.9,
1.0,
Mixed Air Node,
Cooling Coil Air Inlet

Group Unitary Equipment

!- Name
!- Availability Schedule Name
!- Fan Total Efficiency
! Pressure Rise {Pa}
!- Maximum Flow Rate {m3/s}
!- Motor Efficiency
!- Motor In Airstream Fraction
!- Air Inlet_Node Name
Node; !- Air Outlet Node Name

AirTerminal:SingleDuct:Uncontrolled,
Zone1DirectAir,
!- Name
FanAndCoilAvailSched, !- Availability Schedule Name
Zone 1 Inlet Node,
!- Zone Supply Air Node Name
0.7;
!- Maximum Air Flow Rate {m3/s}
AirTerminal:SingleDuct:Uncontrolled,
Zone2DirectAir,
!- Name
FanAndCoilAvailSched, !- Availability Schedule Name
Zone 2 Inlet Node,
!- Zone Supply Air Node Name
0.6;
!- Maximum Air Flow Rate {m3/s}
AirTerminal:SingleDuct:Uncontrolled,
Zone3DirectAir,
!- Name
FanAndCoilAvailSched, !- Availability Schedule Name
Zone 3 Inlet Node,
!- Zone Supply Air Node Name
0.7;
!- Maximum Air Flow Rate {m3/s}

Unitary Water to Air Heat Pump (AirLoopHVAC) Outputs

Energy use reporting for the water-to-air heat pump is documented under the heat pump coil
object types:
Coil:Cooling:WaterToAirHeatPump:ParameterEstimation
Coil:Heating:WaterToAirHeatPump:ParameterEstimation
Coil:Cooling:WaterToAirHeatPump:EquationFit
Coil:Heating:WaterToAirHeatPump:EquationFit

The heat pump demand as well as the compressor and fan part-load ratios may be obtained
with the output variables shown below.
HVAC,Average,
HVAC,Average,
HVAC,Average,
HVAC,Average,
HVAC,Average,
HVAC,Average,

Unitary
Unitary
Unitary
Unitary
Unitary
Unitary

System
System
System
System
System
System

Requested Sensible Cooling Rate [W]

Requested Latent Cooling Rate [W]
Requested Heating Rate [W]
Compressor Part Load Ratio []
Fan Part Load Ratio
Dehumidification Induced Heating Demand Rate [W]

Unitary System Requested Sensible Cooling Rate [W]

This output variable is the sensible cooling requested from the zone thermostat in watts. This
value is calculated using the unitary heat pump outlet air and zone conditions, the specific
heat of the zone air, and the supply air mass flow rate entering/leaving the system. This value
is calculated for each HVAC system timestep being simulated, and the results are averaged
for the timestep being reported.
Unitary System Requested Latent Cooling Rate [W]
This output variable is the latent cooling requested from the zone humidistat in watts. This
value is calculated using the unitary heat pump outlet air and zone conditions, the heat of
vaporization of water at the current zone conditions, and the supply air mass flow rate
entering/leaving the system. This value is calculated for each HVAC system timestep being
simulated, and the results are averaged for the timestep being reported.
9/29/14

1084

Input-Output Reference

Group Unitary Equipment

Unitary System Requested Heating Rate [W]

This output variable is the sensible heating requested from the zone thermostat in watts. This
value is calculated using the unitary heat pump outlet air and zone conditions, the specific
heat of the zone air, and the supply air mass flow rate entering/leaving the system. This value
is calculated for each HVAC system timestep being simulated, and the results are averaged
for the timestep being reported.
Unitary System Compressor Part Load Ratio []
This output variable is the ratio of actual load on the unitary system to the unitary systems
steady state output. This ratio is based on the nominal capacity of the unit.
Unitary System Fan Part Load Ratio []
This output variable is the ratio of actual air mass flow rate through the unitary system to the
unitary systems design air mass flow rate (i.e., design volumetric flow rate converted to dry
air mass flow rate). For continuous fan operation mode, this variable is always 1.0 when the
unitary system is available (based on the availability schedule).
Unitary System Dehumidification Induced Heating Demand Rate [W]
This output variable is the additional heating demand rate of the supplemental heating coil of
a Water-to-Air heat pumps in Watts. This additional heating demand is induced when zone
air overshoots the heating setpoint due to extra dehumidification requirement to meet the
high humidity setpoint. This value is always positive. This value is calculated for each HVAC
system timestep, and the results are averaged for the timestep being reported.
AirLoopHVAC:UnitaryHeatCool:VAVChangeoverBypass
The changeover-bypass variable air volume (CBVAV) unitary system is a compound object
made up of other components. Each CBVAV system consists of an outdoor air mixer, direct
expansion (DX) cooling coil, heating coil, and a supply air fan as shown in the figures below.
Zone thermostats and terminal units are required in each zone served by this system. The
terminal
units
are
specific
to
this
system
type
and
are
either
AirTerminal:SingleDuct:VAV:HeatAndCool:Reheat
or
AirTerminal:SingleDuct:VAV:HeatAndCool:NoReheat. A zone humidistat and single zone
max humidity set point manager may also be specified to help control high humidity levels.
These individual components are described elsewhere in this document. The CBVAV unitary
system object coordinates the operation of these components and is modeled as a type of air
loop equipment (Ref. AirLoopHVAC).

9/29/14

1085

Input-Output Reference

Group Unitary Equipment

Figure 123. Schematic of a CBVAV unitary system (draw through fan placement)

Figure 124. Schematic of a CBVAV unitary system (blow through fan placement)

Links to the CBVAV systems supply air fan, coils, and outdoor air mixer specifications are
provided in the objects input syntax. Additional inputs include system and outdoor air flow
rates during heating and cooling operation, the priority control mode, and dehumidification

9/29/14

1086

Input-Output Reference

Group Unitary Equipment

control type. A description of each input field for the CBVAV unitary system compound object
is provided below.
Field: Name
This alpha field defines a unique user-assigned name for an instance of a changeoverbypass VAV system. Any reference to this system by another object will use this name.
Field: Availability Schedule Name
This alpha field defines the name of the schedule (ref: Schedule) that denotes whether the
system operates during a given time period. A schedule value equal to 0 denotes that the
system must be off for that time period, and a schedule value greater than 0 denotes that the
system is available to operate during that time period. This schedule may be used to
completely disable the system (all of its coils and the supply air fan) as required. If this field is
left blank, the schedule has a value of 1 for all time periods.
Field: System Air Flow Rate During Cooling Operation
This numeric field defines the air flow rate through the system (i.e., through the fan and
heating/cooling coils) in cubic meters per second when the DX cooling coil is operating.
Values must be greater than 0, or this field is autosizable.
Field: System Air Flow Rate During Heating Operation
This numeric field defines the air flow rate through the system (i.e., through the fan and
heating/cooling coils) in cubic meters per second when the heating coil is operating. Values
must be greater than 0, or this field is autosizable.
Field: System Air Flow Rate When No Cooling or Heating is Needed
This numeric field defines the air flow rate through the system (i.e., through the fan and
heating/cooling coils) in cubic meters per second when neither cooling nor heating is required
(i.e., the DX cooling coil and heating coil are off but the supply air fan operates). Values must
be greater than or equal to zero, or this field is autosizable. This field is only used when the
unitary systems supply air fan operating mode is specified as continuous fan operation (Ref.
Field: Supply air fan operating mode schedule name). If the systems supply air fan operating
mode is specified as continuous fan operation and this value is set to zero or the field is left
blank, then the model assumes that the system air flow rate when no heating/cooling is
needed is equal to the system air flow rate when the coils were last operating (for cooling
operation or heating operation).
Field: Outdoor Air Flow Rate During Cooling Operation
This numeric field defines the outdoor air flow rate through the system (i.e., through the
Outdoor air Mixers Outside_Air_Stream_Node) in cubic meters per second when the DX
cooling coil is operating. Values must be greater than or equal to 0, or this field is autosizable.
Note that the outdoor air flow rate during cooling operating can be changed during the
simulation using a multiplier schedule (Ref. Field: Outdoor air volumetric flow rate multiplier
schedule name). For any simulation timestep, the outdoor air flow rate during cooling
operation cannot exceed the system air volumetric flow rate during cooling operation.
Field: Outdoor Air Flow Rate During Heating Operation
This numeric field defines the outdoor air flow rate through the system (i.e., through the
Outdoor air Mixers Outside_Air_Stream_Node) in cubic meters per second when the heating
coil is operating. Values must be greater than or equal to 0, or this field is autosizable. Note
that the outdoor air flow rate during heating operating can be changed during the simulation
using a multiplier schedule (Ref. Field: Outdoor air volumetric flow rate multiplier schedule
name). For any simulation timestep, the outdoor air flow rate during heating operation cannot
exceed the system air volumetric flow rate during heating operation.

9/29/14

1087

Input-Output Reference

Group Unitary Equipment

Field: Outdoor Air Flow Rate When No Cooling or Heating is Needed

This numeric field defines the outdoor air flow rate through the system (i.e., through the
Outdoor air Mixers Outside_Air_Stream_Node) in cubic meters per second when neither
cooling nor heating is required (i.e., the DX cooling coil and heating coil are off but the supply
air fan operates). Values must be greater than or equal to 0, or this field is autosizable. Note
that the outdoor air flow rate when no cooling/heating is needed can be changed during the
simulation using a multiplier schedule (Ref. Field: Outdoor air volumetric flow rate multiplier
schedule name). For any simulation timestep, the outdoor air flow rate when no
cooling/heating is needed cannot exceed the system air volumetric flow rate when no
cooling/heating is needed. This field is only used when the unitary systems supply air fan
operating mode is specified as continuous fan operation (Ref. Field: Supply air fan operating
mode schedule name). If the systems supply air fan operating mode is specified as
continuous fan operation and this value is set to zero or the field is left blank, then the model
assumes that the outdoor air flow rate when no cooling/heating is needed is equal to the
outdoor air flow rate when the coils were last operating (for cooling operation [i.e. Outdoor air
volumetric flow rate during cooling operation] or heating operation [i.e. Outdoor air volumetric
flow rate during heating operation]) and this field is not used.
Field: Outdoor Air Flow Rate Multiplier Schedule Name
This alpha field defines the name of a schedule (ref: Schedule) that contains multipliers for
the outdoor air volume flow rates (heating, cooling, no heating/cooling). Schedule values
must be from zero to 1. If this field is left blank, then the model assumes that the outdoor air
multiplier is 1 for the entire simulation period.
Field: Air Inlet Node Name
This alpha field defines the name of the HVAC system node from which the system draws its
inlet air.
Field: Bypass Duct Mixer Node Name
This alpha field defines the name of the HVAC system node where the bypass air mixes with
the unitary systems inlet air. This name should match the name of the Return Air Stream
Node Name for the OutdoorAir:Mixer associated with this system. This node name must be
different from the systems air inlet node name.
Field: Bypass Duct Splitter Node Name
This alpha field defines the name of the HVAC system node where the conditioned air is split
into bypass air and supply air leaving the system (e.g., delivered to the terminal units). This
splitter air node name should match the outlet node name for the last component (furthest
downstream) in this unitary system. For blow through fan placement, the splitter air node is
the outlet node of the heating coil. For draw through fan placement, the splitter node is the
outlet node of the supply air fan.
Field: Air Outlet Node Name
This alpha field defines the name of the HVAC system node to which the system sends its
outlet air.
Field: Outdoor Air Mixer Object Type
This field specifies the type of outdoor air mixer used by this CBVAV unitary system. The
outdoor air mixer component is part of the CBVAV unitary compound object. The only
available outdoor air mixer type is:
OutdoorAir:Mixer

9/29/14

1088

Input-Output Reference

Group Unitary Equipment

Field: Outdoor Air Mixer Name

This alpha field defines the name of an outdoor air mixer component that composes part of
the CBVAV system. The name of the outdoor air mixers Return_Air_Stream_Node should
match the bypass duct mixer node name, and be different from the CBVAV systems air inlet
node name. The Mixed Air Node Name of the outdoor air mixer should be the same as the
CBVAV systems supply fan inlet air node (for blow through fan placement) or the systems
DX cooling coil inlet node (for draw through fan placement).
Field: Supply Air Fan Object Type
This alpha field defines the type of fan used by this unitary system. The only valid choices are
Fan:OnOff and Fan:ConstantVolume. The input requirements for these fan objects are
described elsewhere in this document.
Field: Supply Air Fan Name
This alpha field defines the name of the fan component that composes part of this unitary
system. Note that the fan components maximum flow rate should be greater than or equal to
the largest system air volumetric flow rate specified for this unitary system (heating, cooling,
and no heating/cooling). In addition, the fans inlet air node should be the same as the
outdoor air mixers Mixed Air Node (for blow through fan placement) or the heating coils
outlet node (for draw through fan placement). The fan outlet air node should be the same as
the DX cooling coils air inlet node (for blow through fan placement) or the systems bypass
duct splitter node (for draw through fan placement).
Field: Supply Air Fan Placement
This alpha field defines the placement of the supply air fan within this unitary system. The
only valid choices are BlowThrough and DrawThrough. With blow through placement, the
supply air fan is located immediately upstream of the systems cooling coil. With draw through
placement, the supply air fan is located immediately downstream of the heating coil.
Field: Supply Air Fan Operating Mode Schedule Name
This alpha field defines the name of a schedule that specifies the supply air fan operating
mode during the simulation. A schedule value of 0 denotes the fan cycles off when no cooling
or heating is required, and any other value denotes that the fan runs continuously regardless
of the need for heating or cooling. If this field is left blank, the model assumes continuous
supply air fan operation for the entire simulation period.
Field: Cooling Coil Object Type
This alpha field defines the type of cooling coil used by this unitary system. There are three
valid choices for this field:
Coil:Cooling:DX:SingleSpeed
CoilSystem:Cooling:DX:HeatExchangerAssisted
Coil:Cooling:DX:TwoStageWithHumidityControlMode

The input requirements for these cooling coil objects are described elsewhere in this
document.
Field: Cooling Coil Name
This alpha field defines the name of the cooling coil used by this unitary system, and this
name should match the name specified in the corresponding cooling coil object.
Field: Heating Coil Object Type
This alpha field defines the type of heating coil used by this unitary system. The hot water
and steam heating coils require specifying plant loop, branches, and connector objects to
support the heating coils, and are placed on the demand side of the plantloop. The hot water
flow modulation through the heating coil does not require additional controller or
9/29/14

1089

Input-Output Reference

Group Unitary Equipment

Controller:WaterCoil object. The parent object (CBVAV Unitary System) itself provides the
"controller" function of modulating water flow. The valid choices are:
Coil:Heating:Electric
Coil:Heating:Gas
Coil:Heating:DX:SingleSpeed
Coil:Heating:Water
Coil:Heating:Steam

The input requirements for these heating coil objects are described elsewhere in this
document.
Field: Heating Coil Name
This alpha field defines the name of the heating coil used by this unitary system, and this
name should match the name specified in the corresponding heating coil object.
Field: Priority Control Mode
This choice field defines the cooling or heating priority control mode for the unitary system.
Valid choices are:
CoolingPriority
HeatingPriority
ZonePriority

If CoolingPriority is selected, the system operates to meet the cooling load if any zone served
by this system (air loop) requires cooling. If no zones require cooling, then the system
operates in heating mode if needed. If HeatingPriority is selected, the system operates to
meet the heating load if any zone requires heating. If no zones require heating, then the
system operates in cooling mode if needed. If ZonePriority is selected, the system operates
based on the maximum number of zones requiring either heating or cooling. If the number of
zones requiring cooling is greater than the number of zones requiring heating, then the
system operates in cooling mode. If the number of zones requiring heating is greater than the
number of zones requiring cooling, then the system operates in heating mode. If the number
of zones requiring cooling equals the number of zones requiring heating, then the largest
combined load (i.e., the sum of the cooling loads for zones requiring cooling compared to the
sum of the heating loads for zones that require heating) sets the cooling or heating operating
mode for the system during that simulation timestep.
Field: Minimum Outlet Air Temperature During Cooling Operation
This numeric field defines the minimum outlet air temperature leaving the system when the
unit is operating to provide cooling. Values are specified in degrees Celsius and must be
greater than 0. The default value is 8 C. This value must be less than or equal to the
maximum outlet air temperature during heating operation.
Field: Maximum Outlet Air Temperature During Heating Operation
This numeric field defines the maximum outlet air temperature leaving the system when the
unit is operating to provide heating. Values are specified in degrees Celsius and must be
greater than 0. The default value is 50 C. This value must be greater than or equal to the
minimum outlet air temperature during cooing operation.
Field: Dehumidification Control Type
This alpha field contains the type of dehumidification control. The following options are valid
for this field:
None - meet sensible load only, no active dehumidification control
Multimode - activate enhanced dehumidification mode as needed and meet sensible
load. This option is used to model DX equipment with a controllable heat exchanger
assisting the DX cooling coil for improved dehumidification. It is valid only with
cooling coil type = Coil:Cooling:DX:TwoStageWithHumidityControlMode.
9/29/14

1090

Input-Output Reference

Group Unitary Equipment

CoolReheat - cool beyond the dry-bulb temperature set point as required to meet the
high humidity setpoint. It is valid only with cooling coil type =
Coil:Cooling:DX:TwoStageWithHumidityControlMode.
The default is None. For the other dehumidification control modes, the maximum humidity
setpoint on the CBVAV systems air outlet node is used. This must be set using a
ZoneControl:Humidistat and one of:
SetpointManager:SingleZone:Humidity:Maximum
SetpointManager:MultiZone:Humidity:Maximum
SetpointManager:MultiZone:MaximumHumidity:Average
objects. When extra dehumidification is required, the system may not be able to meet the
humidity setpoint if its full capacity is not adequate.
As shown in the example below, correct specification of the CBVAV unitary system requires
specification
of
the
following
objects
in
addition
to
the
AirLoopHVAC:UnitaryHeatCool:VAVChangeoverBypass object:
1) outdoor air mixer (OutdoorAir:Mixer)
2) fan (Fan:OnOff or Fan:ConstantVolume)
3) cooling

coil
CoilSystem:Cooling:DX:HeatExchangerAssisted,
Coil:Cooling:DX:TwoStageWithHumidityControlMode)

(Coil:Cooling:DX:SingleSpeed,
or

4) heating coil (Coil:Heating:Gas, Coil:Heating:Electric, or Coil:Heating:DX:SingleSpeed)

5) terminal

unit
for
each
zone
being
(AirTerminal:SingleDuct:VAV:HeatAndCool:Reheat
AirTerminal:SingleDuct:VAV:HeatAndCool:NoReheat)

served

by

this

system
or

Note: The fan, heating coil, cooling coil, and outdoor air mixer must be connected in the air loop according
to the configurations shown above (Figure 123 and Figure 124).

AirLoopHVAC:UnitaryHeatCool:VAVChangeoverBypass,
GasHeat CBVAV System, !- Name of unitary system
FanAndCoilAvailSched, !- Availability schedule name
1.8,
!- System air volumetric flow rate during cooling operation {m3/s}
1.7,
!- System air volumetric flow rate during heating operation {m3/s}
1.6,
!- System air volumetric flow rate when no cooling or heating is needed {m3/s}
0.32,
!- Outdoor air volumetric flow rate during cooling operation {m3/s}
0.3,
!- Outdoor air volumetric flow rate during heating operation {m3/s}
0.27,
!- Outdoor air volumetric flow rate when no cooling or heating is needed {m3/s}
Outdoor Air Multiplier Schedule, !- Outdoor air volumetric flow rate multiplier schedule name
Air Loop Inlet Node,
!- Air inlet node name
Mixer Inlet Node,
!- Bypass duct mixer node name
Heating Coil Air Outlet Node,
!- Bypass duct splitter node name
Air Loop Outlet Node,
!- Air outlet node name
OutdoorAir:Mixer,
!- Outdoor Air Mixer Object Type
Outdoor air Mixer,
!- Outdoor air mixer name
Fan:OnOff,
!- Supply air fan type
Supply Fan 1,
!- Supply air fan name
BlowThrough,
!- Supply air fan placement
Fan OpMode Schedule,
!- Supply air fan operating mode schedule name
Coil:Cooling:DX:TwoStageWithHumidityControlMode, !- Cooling coil type
ACDXCoil 2,
!- Cooling coil name
Coil:Heating:Gas,
!- Heating coil type
Furnace Heating Coil 1, !- Heating coil name
CoolingPriority,
!- Priority control mode
10.0,
!- Minimum outlet air temperature during cooling operation {C}
50.0,
!- Maximum outlet air temperature during heating operation {C}
None;
!- Dehumidification control type

9/29/14

1091

Input-Output Reference
OutdoorAir:Mixer,
Outdoor air Mixer,
Mixed Air Node,
Outdoor air Inlet Node,
Relief Air Outlet Node,
Mixer Inlet Node;

Group Unitary Equipment

!!!!!-

Name
Mixed Air Node Name
Outdoor Air Stream Node
Relief Air Stream Node Name
Return Air Stream Node Name

Fan:OnOff,
Supply Fan 1,
!- Fan Name
FanAndCoilAvailSched,
!- Availability Schedule Name
0.7,
!- Fan Total Efficiency
600.0,
!- Delta Pressure {Pa}
1.8,
!- Max Flow Rate {m3/s}
0.9,
!- Motor Efficiency
1.0,
!- Motor In Airstream Fraction
Mixed Air Node,
!- Fan_Inlet_Node
DX Cooling Coil Air Inlet Node; !- Fan_Outlet_Node

Coil:Cooling:DX:TwoStageWithHumidityControlMode,
ACDXCoil 2,
!- Coil Name
FanAndCoilAvailSched,
!- Availability Schedule
DX Cooling Coil Air Inlet Node, !- Coil Air Inlet Node
Heating Coil Air Inlet Node,
!- Coil Air Outlet Node
,
!- Crankcase Heater Capacity {W}
,
!- Maximum Outdoor Dry-bulb Temperature for Crankcase Heater Operation {C}
2,
!- Number of Capacity Stages
0,
!- Number of Enhanced Dehumidification Modes
CoilPerformance:DX:Cooling, !- Normal Mode Stage 1 Coil Performance Object Type
ACDXCoil 2 Standard Mode-Stage 1, !- Normal Mode Stage 1 Coil Performance Object Name
CoilPerformance:DX:Cooling, !- Normal Mode Stage 1+2 Coil Performance Object Type
ACDXCoil 2 Standard Mode-Stage 1&2; !- Normal Mode Stage 1+2 Coil Performance Object Name

Coil:Heating:Gas,
Furnace Heating Coil 1, !- Coil Name
FanAndCoilAvailSched,
!- Availability Schedule Name
0.8,
!- Gas Burner Efficiency of the Coil
35000,
!- Nominal Capacity of the Coil {W}
Heating Coil Air Inlet Node, !- Coil_Air_Inlet_Node
Heating Coil Air Outlet Node; !- Coil_Air_Outlet_Node

AirTerminal:SingleDuct:VAV:HeatAndCool:Reheat,
Zone 1 VAV System,
!- Name of System
FanAndCoilAvailSched,
!- System Availability schedule
Zone 1 Reheat Air Inlet Node, !- DAMPER Air Outlet Node
Zone 1 VAV Inlet Node,
!- UNIT Air Inlet Node
0.583,
!- Maximum air flow rate {m3/s}
0.25,
!- Zone Minimum Air Flow Fraction
,
!- Control node
Coil:Heating:Electric,
!- Reheat Component Object
Reheat Coil Zone 1,
!- Name of Reheat Component
0.0,
!- Max Reheat Water Flow {m3/s}
0.0,
!- Min Reheat Water Flow {m3/s}
Zone 1 Reheat Air Outlet Node, !- UNIT Air Outlet Node
0.001;
!- Convergence Tolerance

9/29/14

1092

Input-Output Reference

Group Unitary Equipment

AirTerminal:SingleDuct:VAV:HeatAndCool:Reheat,
Zone 2 VAV System,
!- Name of System
FanAndCoilAvailSched,
!- System Availability schedule
Zone 2 Reheat Air Inlet Node, !- DAMPER Air Outlet Node
Zone 2 VAV Inlet Node,
!- UNIT Air Inlet Node
0.583,
!- Maximum air flow rate {m3/s}
0.25,
!- Zone Minimum Air Flow Fraction
,
!- Control node
Coil:Heating:Electric,
!- Reheat Component Object
Reheat Coil Zone 2,
!- Name of Reheat Component
0.0,
!- Max Reheat Water Flow {m3/s}
0.0,
!- Min Reheat Water Flow {m3/s}
Zone 2 Reheat Air Outlet Node, !- UNIT Air Outlet Node
0.001;
!- Convergence Tolerance

AirTerminal:SingleDuct:VAV:HeatAndCool:NoReheat,
Zone 3 VAV System,
!- Name of System
FanAndCoilAvailSched,
!- System Availability schedule
Zone 3 Reheat Air Outlet Node, !- UNIT Air Outlet Node
Zone 3 VAV Inlet Node,
!- UNIT Air Inlet Node
0.584,
!- Maximum air flow rate {m3/s}
0.25;
!- Zone Minimum Air Flow Fraction

Unitary VAV Changeover Bypass Heat and Cool (AirLoopHVAC) Outputs

HVAC,Average,Unitary System Total Heating Rate [W]
HVAC,Sum,Unitary System Total Heating Energy [J]
HVAC,Average,Unitary System Total Cooling Rate [W]
HVAC,Sum,Unitary System Total Cooling Energy [J]
HVAC,Average,Unitary System Sensible Heating Rate [W]
HVAC,Sum,Unitary System Sensible Heating Energy [J]
HVAC,Average,Unitary System Sensible Cooling Rate [W]
HVAC,Sum,Unitary System Sensible Cooling Energy [J]
HVAC,Average,Unitary System Latent Heating Rate [W]
HVAC,Sum,Unitary System Latent Heating Energy [J]
HVAC,Average,Unitary System Latent Cooling Rate [W]
HVAC,Sum,Unitary System Latent Cooling Energy [J]
HVAC,Average,Unitary System Electric Power [W]
HVAC,Sum,Unitary System Electric Energy [J]
HVAC,Average,Unitary System Fan Part Load Ratio []
HVAC,Average,Unitary System Compressor Part Load Ratio []
HVAC,Average,Unitary System Bypass Air Mass Flow Rate [kg/s]
HVAC,Average,Unitary System Air Outlet Setpoint Temperature [C]

Unitary System Total Heating Rate [W]

This output field is the total (enthalpy) heat addition rate of the CBVAV system in Watts. This
value is calculated using the enthalpy difference of the outlet air and inlet air streams, and the
supply air mass flow rate entering/leaving the system. This value is calculated for each HVAC
system timestep being simulated, and the results (enthalpy addition only) are averaged for
the timestep being reported.
Unitary System Total Heating Energy [J]
This output field is the total (enthalpy) heat addition of the CBVAV system in Joules over the
timestep being reported. This value is calculated using the enthalpy difference of the outlet air
and inlet air streams, the supply air mass flow rate entering/leaving the system, and the
HVAC simulation timestep. This value is calculated for each HVAC system timestep being
simulated, and the results (enthalpy addition only) are summed for the timestep being
reported.
Unitary System Total Cooling Rate [W]
This output field is the total (enthalpy) heat extraction rate of the CBVAV system in Watts.
This value is calculated using the enthalpy difference of the outlet air and inlet air streams,
9/29/14

1093

Input-Output Reference

Group Unitary Equipment

and the supply air mass flow rate entering/leaving the system. This value is calculated for
each HVAC system timestep being simulated, and the results (enthalpy extraction only) are
averaged for the timestep being reported.
Unitary System Total Cooling Energy [J]
This output field is the total (enthalpy) heat extraction of the CBVAV system in Joules over
the timestep being reported. This value is calculated using the enthalpy difference of the
outlet air and inlet air streams, the supply air mass flow rate entering/leaving the system, and
the HVAC simulation timestep. This value is calculated for each HVAC system timestep being
simulated, and the results (enthalpy extraction only) are summed for the timestep being
reported.
Unitary System Sensible Heating Rate [W]
This output field is the sensible heat addition rate of the CBVAV system in Watts. This value
is calculated using the enthalpy difference of the outlet air and inlet air streams at a constant
humidity ratio, and the supply air mass flow rate entering/leaving the system. This value is
calculated for each HVAC system timestep being simulated, and the results (heating only)
are averaged for the timestep being reported.
Unitary System Sensible Heating Energy [J]
This output field is the sensible heat addition of the CBVAV system in Joules over the
timestep being reported. This value is calculated using the enthalpy difference of the outlet air
and inlet air streams at a constant humidity ratio, the supply air mass flow rate
entering/leaving the system, and the HVAC simulation timestep. This value is calculated for
each HVAC system timestep being simulated, and the results (heating only) are summed for
the timestep being reported.
Unitary System Sensible Cooling Rate [W]
This output field reports the moist air sensible heat extraction rate of the CBVAV system in
Watts. This value is calculated using the enthalpy difference of the outlet air and inlet air
streams at a constant humidity ratio, and the supply air mass flow rate entering/leaving the
system. This value is calculated for each HVAC system timestep being simulated, and the
results (cooling only) are averaged for the timestep being reported.
Unitary System Sensible Cooling Energy [J]
This output field reports the moist air sensible heat extraction of the CBVAV system in Joules
over the timestep being reported. This value is calculated using the enthalpy difference of the
outlet air and inlet air streams at a constant humidity ratio, the supply air mass flow rate
entering/leaving the system, and the HVAC simulation timestep. This value is calculated for
each HVAC system timestep being simulated, and the results (cooling only) are summed for
the timestep being reported.
Unitary System Latent Heating Rate [W]
This output field is the latent heat addition (humidification) rate of the CBVAV system in
Watts. This value is calculated as the difference between the total energy rate and the
sensible energy rate provided by the system. This value is calculated for each HVAC system
timestep being simulated, and the results (latent heat addition only) are averaged for the
timestep being reported.
Unitary System Latent Heating Energy [J]
This output field is the latent heat addition (humidification) of the CBVAV system in Joules
over the timestep being reported. This value is calculated as the difference between the total
energy and the sensible energy delivered by the system. This value is calculated for each
HVAC system timestep being simulated, and the results (latent heat addition only) are
summed for the timestep being reported.
9/29/14

1094

Input-Output Reference

Group Unitary Equipment

Unitary System Latent Cooling Rate [W]

This output field is the latent heat extraction (dehumidification) rate of the CBVAV system in
Watts. This value is calculated as the difference between the total energy rate and the
sensible energy rate provided by the system. This value is calculated for each HVAC system
timestep being simulated, and the results (latent heat extraction only) are averaged for the
timestep being reported.
Unitary System Latent Cooling Energy [J]
This output field is the latent heat extraction (dehumidification) of the CBVAV system in
Joules over the timestep being reported. This value is calculated as the difference between
the total energy and the sensible energy delivered by the system. This value is calculated for
each HVAC system timestep being simulated, and the results (latent heat extraction only) are
summed for the timestep being reported.
Unitary System Electric Power [W]
This output field is the electricity consumption rate of the CBVAV system in Watts. The
consumption includes electricity used by the DX compressor (including crankcase heater),
fans (indoor supply air fan and the condenser fans associated with the DX coil[s]), and the
heating coil (if electric). This value is calculated for each HVAC system timestep being
simulated, and the results are averaged for the timestep being reported.
Unitary System Electric Energy [J]
This output field is the electricity consumption of the CBVAV system in Joules for the time
period being reported. The consumption includes electricity used by the DX compressor
(including crankcase heater), fans (indoor supply air fan and the condenser fans associated
with the DX coil[s]), and the heating coil (if electric). This value is calculated for each HVAC
system timestep being simulated, and the results are summed for the timestep being
reported.
Unitary System Fan Part Load Ratio []
This output field is the part-load ratio of the supply air fan, which will be either zero or 1 for
each simulation timestep. For this system, the fan will operate continuously for the simulation
timestep if the system is available (ref. Field: Availability schedule name) and there is a
cooling or heating load to be met (i.e., fan part-load ratio will equal 1). When the system is
available but there is no cooling or heating load to be met, the fan will either be off for the
entire timestep or on for the entire timestep depending on the supply air fan operating mode
schedule (ref. Field: Supply Air Fan Operating Mode Schedule Name). This value is set for
each HVAC system timestep being simulated, and the results are averaged for the timestep
being reported.
Unitary System Compressor Part Load Ratio []
This output field is the part-load ratio of the compressor used by the DX coils (cooling and
heating). The compressor part-load ratio is defined as the total coil load divided by the coil
steady-state capacity (steady-state capacity of first stage for multi-mode coils). This value is
calculated for each HVAC system timestep being simulated, and the results are averaged for
the timestep being reported.
Unitary System Bypass Air Mass Flow Rate [kg/s]
This output field is the mass flow rate of air, in kg/s, being bypassed from the supply air path
and blended with the air entering the CBVAV system. This value is calculated for each HVAC
system timestep being simulated, and the results are averaged for the timestep being
reported.

9/29/14

1095

Input-Output Reference

Group Variable Refrigerant Flow Equipment

Unitary System Air Outlet Setpoint Temperature [C]

This output field is the dry-bulb set point temperature in degrees Celsius. This set point
temperature is calculated by the model based on the zone cooling/heating loads calculated
by EnergyPlus, and the priority control mode and the dehumidification control type specified
for this unitary system. The CBVAV system attempts to achieve the outlet air set point
temperature to the extent possible.

Group Variable Refrigerant Flow Equipment

AirConditioner:VariableRefrigerantFlow
This model simulates a variable-refrigerant-flow (or variable-refrigerant-volume) airconditioning system. This system type models direct-expansion cooling and/or heating coils
configured in a zone terminal unit. For this system type, the zone terminal units are
connected to a zone via the zone inlet and exhaust nodes. The zone terminal units are
identified in a ZoneTerminalUnitList object. And finally, the name of the ZoneTerminalUnitList
object is entered as an input to the AirConditioner:VariableRefrigerantFlow object. The
Energyplus connection methodology is shown as dashed and greyed arrows in the figure
below according to the following rules:
1. The zone inlet and zone exhaust node names are defined in a
ZoneHVAC:EquipmentConnections object (bottom of figure).
2. A ZoneHVAC:TerminalUnit:VariableRefrigerantFlow object will identify these zone
exhaust and zone inlet node names as the terminal units air inlet and air outlet
nodes, respectively.
3. All zone terminal units that are connected to the same AirConditioner:
VariableRefrigerantFlow object are listed in a ZoneTerminalUnitList object.
4. The name of the ZoneTerminalUnitList object is an input to the AirConditioner:
VariableRefrigerantFlow object.
5. The AirCondtiioner:VariableRefrigerantFlow object is not listed in an AirloopHVAC
object and, therefore, can only be simulated if the terminal units are connected to the
AirCondtiioner:VariableRefrigerantFlow object using the ZoneTerminalUnitList.
6. Secondary ZoneHVAC equipment objects may be used in the same zones as the
terminal units for other purposes (e.g., code compliance)
The following schematic demonstrates these connection rules.

9/29/14

1096

Input-Output Reference

Group Variable Refrigerant Flow Equipment

Figure 125. Variable Refrigerant Flow Schematic

Energyplus object type and object name, and node name relationships are also shown in the
following figure to aid in the assembly of this HVAC system type.

9/29/14

1097

Input-Output Reference

Group Variable Refrigerant Flow Equipment

Figure 126. Variable Refrigerant Flow Object Links

Field: Heat Pump Name
This alpha field defines a unique user-assigned name for an instance of a variable refrigerant
flow heat pump. Any reference to this heat pump will use this name. Since this object is not
listed in an AirloopHVAC object, the most likely use of this name would be for reporting
purposes.
Field: Availability Schedule Name
This alpha field defines the name of the schedule (ref: Schedule) that denotes whether the
heat pump operates during a given time period. A schedule value equal to 0 denotes that the
heat pump must be off for that time period. A value other than 0 denotes that the heat pump
is available to operate during that time period. This schedule may be used to completely
disable the heat pump (and all of its terminal units) as required. If this field is blank, the unit is
enabled the entire simulation.
Field: Gross Rated Total Cooling Capacity
This numeric field defines the total cooling capacity (sensible + latent) of the heat pump at
rated conditions in watts. The cooling capacity must be greater than 0 or set to autosize.
Field: Gross Rated Cooling COP
This numeric field defines the cooling coefficient of performance at rated conditions. The
cooling coefficient of performance includes compressor power and condenser fan power.
This COP value does not account for impacts due to the supply air fan. The nominal heat
pump cooling COP must be greater than 0. If this field is left blank, a default coefficient of
performance of 3.3 is assumed.

9/29/14

1098

Input-Output Reference

Group Variable Refrigerant Flow Equipment

Field: Minimum Outdoor Temperature in Cooling Mode

This numeric field defines the minimum outdoor dry-bulb temperature allowed for cooling
operation. Below this temperature, cooling is disabled. If this field is left blank, the default
value is -6C.
Field: Maximum Outdoor Temperature in Cooling Mode
This numeric field defines the maximum outdoor dry-bulb temperature allowed for cooling
operation. Above this temperature, cooling is disabled. If this field is left blank, the default
value is 43C.
Field: Cooling Capacity Ratio Modifier Function of Low Temperature Curve Name
This alpha field defines the cooling capacity ratio modifier at low outdoor dry-bulb
temperatures. This curve is a bi-quadratic equation using weighted average indoor wet-bulb
temperature (i.e., the indoor terminal units weighted average inlet temperatures) and
condenser entering air dry-bulb temperature as the independent variables. This performance
curve can be used to describe the cooling capacity ratio at low outdoor temperatures (i.e., the
following two curves are used) or can be used to describe the performance for all outdoor
temperatures (i.e., the following two curves are not used). For this system type it is likely that
all three of these performance curves will be required. See the Engineering Reference for
more discussion on using this input field.
Field: Cooling Capacity Ratio Boundary Curve Name
This alpha field defines the cooling capacity ratio boundary curve name. This curve is a
linear, quadratic or cubic curve that defines a change in cooling capacity at a specific
condenser entering air dry-bulb temperature as a function of indoor air wet-bulb temperature.
This curve is used when the trend in cooling capacity changes dramatically as outdoor
temperature changes. If the cooling capacity does not change dramatically with changes in
outdoor conditions, this field may be left blank. See the Engineering Reference for more
discussion on using this input field.
Field: Cooling Capacity Ratio Modifier Function of High Temperature Curve Name
This alpha field defines the cooling capacity ratio modifier at high outdoor temperatures. This
curve is a bi-quadratic equation using weighted average indoor wet-bulb temperature and
condenser entering air dry-bulb temperature as the independent variables. This curve is used
when the trend in cooling capacity changes dramatically as outdoor temperature changes. If
the cooling capacity does not change dramatically with changes in outdoor conditions, this
field may be left blank. See the Engineering Reference for more discussion on using this
input field.
Field: Cooling Energy Input Ratio Modifier Function of Low Temperature Curve Name
This alpha field defines the cooling energy input ratio modifier at low outdoor temperatures.
This curve is a bi-quadratic equation with a weighted average indoor wet-bulb temperature
and condenser entering air dry-bulb temperature as the independent variables. This
performance curve can be used to describe the cooling energy input ratio at low outdoor
temperatures (i.e., the following two curves are used) or can be used to describe the
performance for all outdoor temperatures (i.e., the following two curves are not used). For this
system type it is likely that all three of these performance curves will be required. See the
Engineering Reference for more discussion on using this input field.
Field: Cooling Energy Input Ratio Boundary Name
This alpha field defines the cooling energy input ratio boundary curve name. This curve is a
linear, quadratic or cubic curve that defines a change in cooling energy at a specific
condenser entering air dry-bulb temperature as a function of indoor air wet-bulb temperature.
This curve is used when the trend in cooling energy changes dramatically as outdoor
temperature changes. If the cooling energy does not change dramatically with changes in
9/29/14

1099

Input-Output Reference

Group Variable Refrigerant Flow Equipment

outdoor conditions, this field may be left blank. See the Engineering Reference for more
discussion on using this input field.
Field: Cooling Energy Input Ratio Modifier Function of High Temperature Curve Name
This alpha field defines the cooling energy input ratio modifier at high outdoor temperatures.
This curve is a bi-quadratic equation with weighted average indoor wet-bulb temperature and
condenser entering air dry-bulb temperature as the independent variables. This curve is used
when the trend in cooling energy changes dramatically as outdoor temperature changes. If
the cooling energy does not change dramatically with changes in outdoor conditions, this field
may be left blank. See the Engineering Reference for more discussion on using this input
field.
Field: Cooling Energy Input Ratio Modifier Function of Low Part-Load Ratio Curve Name
This alpha field defines the cooling energy input ratio modifier (function of part-load ratio
when PLR is less than or equal to 1) curve name. This curve is a linear, quadratic or cubic
equation with cooling part-load ratio used as the independent variable. The cooling energy
input ratio modifier curve is normalized to 1 at a part-load ratio of 1 and is used only when the
operating part-load ratio is less than or equal to 1.
Field: Cooling Energy Input Ratio Modifier Function of HIgh Part-Load Ratio Curve Name
This alpha field defines the cooling energy input ratio modifier (function of part-load ratio
when PLR is greater than 1) curve name. This curve is a linear, quadratic or cubic equation
with cooling part-load ratio used as the independent variable. The cooling energy input ratio
modifier curve is normalized to 1 at a part-load ratio of 1 and is used only when the operating
part-load ratio is greater than 1.
Field: Cooling Combination Ratio Correction Factor Curve Name
This alpha field defines the cooling combination ratio (CR) correction factor curve name for
combination ratios greater than or equal to 1. The combination ratio is defined as the total
rated indoor terminal unit cooling capacity divided by this heat pumps gross rated total
cooling capacity. The curve is a linear, quadratic or cubic equation and uses the minimum
value of x in the curve object to determine the maximum part-load ratio which is linearly
proportional to capacity (i.e., the minimum value of x [CR] in the curve object must be 1).
The output of this curve provides a multiplier (>1) which is applied to this heat pumps Gross
Rated Total Cooling Capacity. Between a combination ratio of 1 and the curves minimum
value of x, the multiplier is linearly interpolated. For combination ratios less than 1 (i.e., the
total indoor terminal unit capacity is less than this heat pumps rated total capacity), capacity
is directly proportional to part-load ratio and this curve will not be used.
Field: Cooling Part-Load Fraction Correlation Curve Name
This alpha field defines the cooling part-load fraction correlation curve name. This curve is
used to define the cycling losses when the condensers compressors cycle on and off. The
compressor cycles when the cooling part-load ratio is less than the Minimum Heat Pump
Part-Load Ratio specified later in this objects inputs.
Field: Gross Rated Heating Capacity
This numeric field defines the gross total heat pump heating capacity at rated conditions in
watts. The nominal heat pump heating capacity must be greater than 0 or set to autosize.
Field: Rated Heating Capacity Sizing Ratio
This numeric field defines the ratio of gross heating to gross cooling capacity. The model
assumes that when used, this value will be greater than 1. A similar input is available in the
ZoneHVAC:TerminalUnit:VariableRefrigerantFlow object. When the heating capacity is
autosized, if this field is non-blank, this ratio is used to scale the heating capacity to the gross
rated total cooling capacity regardless of the value entered in the terminal unit objects. When
9/29/14

1100

Input-Output Reference

Group Variable Refrigerant Flow Equipment

the heating capacity is not autosized, the gross rated heating capacity will be equal to the
sum of the terminal unit heating coil size. If this field is blank and the terminal unit sizing ratio
input is also blank, then the heating capacity sizing ratio is assumed to be 1. If this field is not
blank and the heating capacity sizing ratio in the terminal unit object(s) is blank, then this ratio
also applies to each heating coil. If this field is not blank and the heating capacity sizing ratio
in the terminal units is also not blank, then the terminal unit heating coil capacity sizing ratio
input applies to each heating coil.
Field: Gross Rated Heating COP
This numeric field defines the heating coefficient of performance at rated conditions. The
heating coefficient of performance includes compressor power and condenser fan power.
This gross COP value does NOT account for the supply air fan. The nominal heat pump
heating COP must be greater than 0. If this field is left blank, a coefficient of performance of
3.4 is assumed.
Field: Minimum Outdoor Temperature in Heating Mode
This numeric field defines the minimum outdoor temperature allowed for heating operation.
Below this temperature, heating is disabled. If this field is left blank, the default value is -20C.
Field: Maximum Outdoor Temperature in Heating Mode
This numeric field defines the maximum outdoor temperature allowed for heating operation.
Above this temperature, heating is disabled. If this field is left blank, the default value is 16C.
Field: Heating Capacity Ratio Modifier Function of Low Temperature Curve Name
This alpha field defines the heating capacity ratio modifier at low temperature curve name.
This curve is a bi-quadratic equation with a weighted average indoor dry-bulb temperature
(i.e., the indoor terminal units weighted average inlet temperatures) and condenser entering
air dry-bulb or wet-bulb temperature as the independent variables. Since manufacturers may
provide performance data using either outdoor dry-bulb or wet-bulb temperatures, either of
these temperature types may be used for heating performance curves as specified in the
Heating Performance Curve Outdoor Temperature Type input field below. This performance
curve can be used to describe the heating capacity ratio at low outdoor temperatures (i.e., the
following two curves are used) or can be used to describe the performance for all outdoor
temperatures (i.e., the following two curves are not used). For this system type it is likely that
all three of these performance curves will be required. See the Engineering Reference for
more discussion on using this input field.
Field: Heating Capacity Ratio Boundary Curve Name
This alpha field defines the heating capacity ratio boundary curve name. This curve is a
quadratic or cubic curve that defines a change in heating capacity at a specific condenser
entering air dry-bulb or wet-bulb temperature as a function of indoor air dry-bulb temperature.
Since manufacturers may provide performance data using either outdoor dry-bulb or wet-bulb
temperatures, either of these temperature types may be used for heating performance curves
as specified in the Heating Performance Curve Outdoor Temperature Type input field below.
This curve is used when the trend in heating capacity changes dramatically as outdoor
temperature changes. If the heating capacity does not change dramatically with changes in
outdoor conditions, this field may be left blank.
Field: Heating Capacity Ratio Modifier Function of High Temperature Curve Name
This alpha field defines the heating capacity ratio modifier at high temperature curve name.
This curve is a bi-quadratic equation with a weighted average indoor dry-bulb temperature
and condenser entering air dry-bulb or wet-bulb temperature as the independent variables.
Since manufacturers may provide performance data using either outdoor dry-bulb or wet-bulb
temperatures, either of these temperature types may be used for heating performance curves
as specified in the Heating Performance Curve Outdoor Temperature Type input field below.
9/29/14

1101

Input-Output Reference

Group Variable Refrigerant Flow Equipment

This curve is used when the trend in heating capacity changes dramatically as outdoor
temperature changes. If the heating capacity does not change dramatically with changes in
outdoor conditions, this field may be left blank.
Field: Heating Energy Input Ratio Modifier Function of Low Temperature Curve Name
This alpha field defines the heating energy input ratio modifier at low temperature curve
name. This curve is a bi-quadratic equation with a weighted average indoor dry-bulb
temperature and condenser entering air dry-bulb or wet-bulb temperature as the independent
variables. Since manufacturers may provide performance data using either outdoor dry-bulb
or wet-bulb temperatures, either of these temperature types may be used for heating
performance curves as specified in the Heating Performance Curve Outdoor Temperature
Type input field below. This performance curve can be used to describe the heating energy
input ratio at low outdoor temperatures (i.e., the following two curves are used) or can be
used to describe the performance for all outdoor temperatures (i.e., the following two curves
are not used).
Field: Heating Energy Input Ratio Boundary Curve Name
This alpha field defines the heating energy input ratio boundary curve name. This curve is a
quadratic or cubic curve that defines a change in heating energy at a specific condenser
entering air dry-bulb or wet-bulb temperature as a function of indoor air dry-bulb temperature.
Since manufacturers may provide performance data using either outdoor dry-bulb or wet-bulb
temperatures, either of these temperature types may be used for heating performance curves
as specified in the Heating Performance Curve Outdoor Temperature Type input field below.
This curve is used when the trend in heating energy changes dramatically as outdoor
temperature changes. If the heating energy does not change dramatically with changes in
outdoor conditions, this field may be left blank.
Field: Heating Energy Input Ratio Modifier Function of High Temperature Curve Name
This alpha field defines the heating energy input ratio modifier at high temperature curve
name. This curve is a bi-quadratic equation with a weighted average indoor dry-bulb
temperature and condenser entering air dry-bulb or wet-bulb temperature as the independent
variables. Since manufacturers may provide performance data using either outdoor dry-bulb
or wet-bulb temperatures, either of these temperature types may be used for heating
performance curves as specified in the Heating Performance Curve Outdoor Temperature
Type input field below. This curve is used when the trend in heating energy changes
dramatically as outdoor temperature changes. If the heating energy does not change
dramatically with changes in outdoor conditions, this field may be left blank.
Field: Heating Performance Curve Outdoor Temperature Type
This choice field defines the outdoor temperature type used for all performance curves. The
valid choices are DryBulbTemperature and WetBulbTemperature. The default value is
WetBulbTemperature. Manufacturers will typically provide heating performance data as a
function of outdoor air wet-bulb temperatures. This means that the performance (e.g.,
capacity and energy input ratio) curves will use outdoor wet-bulb temperature as one of the
independent variables. At times, manufacturers will only provide performance data as a
function of outdoor dry-bulb temperatures. In this case, all performance curves shall be
developed using outdoor dry-bulb temperature and this field shall be selected as
DryBulbTemperature.
Field: Heating Energy Input Ratio Modifier Function of Low Part-Load Ratio Curve Name
This alpha field defines the heating energy input ratio modifier (function of part-load ratio
when PLR is less than or equal to 1) curve name. This curve is a linear, quadratic, or cubic
equation with heating part-load ratio used as the independent variable. The heating energy
input ratio modifier curve is normalized to 1 at a part-load ratio of 1 and is used only when the
part-load ratio is less than or equal to 1.
9/29/14

1102

Input-Output Reference

Group Variable Refrigerant Flow Equipment

Field: Heating Energy Input Ratio Modifier Function of High Part-Load Ratio Curve Name
This alpha field defines the heating energy input ratio modifier (function of part-load ratio
when PLR is greater than 1) curve name. This curve is a linear, quadratic, or cubic equation
with heating part-load ratio used as the independent variable. The heating energy input ratio
modifier curve is normalized to 1 at a part-load ratio of 1 and is used only when the part-load
ratio is greater than 1.
Field: Heating Combination Ratio Correction Factor Curve Name
This alpha field defines the heating combination ratio (CR) correction factor curve name for
combination ratios greater than or equal to 1. The combination ratio is defined as the total
rated indoor heating capacity divided by the rated heat pump heating capacity. The curve is
either quadratic or cubic and uses the minimum value of x in the curve object to determine
the maximum part-load ratio which is linearly proportional to capacity (i.e., the minimum value
of x in the curve object must be 1). The output of this curve provides a multiplier (>1) which
is applied to the Nominal Heat Pump Heating Capacity. Between a combination ratio of 1 and
the curves minimum value of x, the multiplier is linearly interpolated. For combination ratios
less than 1, capacity is directly proportional to part-load ratio and this curve will not be used.
If this field is left blank, the Cooling Combination Ratio Correction factor will be used.
Field: Heating Part-Load Fraction Correlation Curve Name
This alpha field defines the heating part-load fraction correlation curve name. This curve is
used to define the cycling losses when the condensers compressors cycle on and off. The
compressor cycles when the indoor to outdoor heating capacity ratio is less than the
Minimum Heat Pump Part-Load Ratio specified in the following field.
Field: Minimum Heat Pump Part-Load Ratio
This numeric field specifies the minimum operating part-load ratio (PLR) of the heat pump.
When the heat pump operates at a PLR below this value, the heat pumps compressor will
cycle to meet the cooling or heating demand. Above this value, the heat pumps compressor
operates the entire time step to meet the cooling or heating demand. The minimum value for
this field is 0. If this field is left blank, the default value is 0.15. When the heat pump
compressor cycles, the previous field is used to determine cycling losses.
Field: Zone Name for Master Thermostat Location
This alpha field defines the name of the zone where the master thermostat is located. When
the heat pump is connected to multiple zone terminal units, one terminal unit must be
selected as the master thermostat. The remaining thermostats are slaves and can operate
only in the same mode as the master thermostat.
Field: Master Thermostat Priority Control Type
This choice field determines the logic used to simulate the master thermostat. Valid choices
are LoadPriority, ZonePriority, ThermostatOffsetPriority, MasterThermostatPriority, and
Scheduled. The default value is MasterThermostatPriority. When LoadPriority is selected, the
total zone load is used to choose the operating mode as either cooling or heating. When
ZonePriority is selected, the number of zones requiring cooling or heating determines the
operating mode. When ThermostatOffsetPriority is selected, the zone farthest from the
thermostat set point determines the operating mode. The MasterThermostatPriority choice
operates the system according the zone load where the master thermostat is located. The
heat pump can also be scheduled to operate in either cooling or heating mode. For
scheduled operation, a schedule name is entered in the following field.
Field: Thermostat Priority Schedule Name
This alpha field identifies the schedule used when the previous field is set to Scheduled.
Schedule values of 0 denote cooling mode while values of 1 denote heating mode. Any other
values will force the system off.
9/29/14

1103

Input-Output Reference

Group Variable Refrigerant Flow Equipment

Field: Zone Terminal Unit List Name

This alpha field defines the name of the zone terminal unit list. The name specified here
should match the name of a valid ZoneTerminalUnitList object. In addition, each name
specified in this list should match the name of a valid ZoneHVAC:TerminalUnit:
VariableRefrigerantFlow object. All terminal units connected to this heat pump must be listed
in this ZoneTerminalUnitList object.
Note: the previous field is designated at the last field necessary to simulate the variable refrigerant flow
heat pump. The following fields do not have to be entered, however, piping loses, defrost operation,
crankcase heater operation, and basin heater operation will not be modeled. Defaults for fields not entered
may also not apply. These remaining fields must be entered if that portion of the model is to be simulated.

Field: Heat Pump Waste Heat Recovery

This choice field defines the configuration of the heat pump refrigeration system. Valid
choices are Yes and No. If Yes is selected, heat recovery is enabled and the heat pump can
independently cool and heat different zones. If No is selected, the heat pump is only able to
cool or heat for any given time step.
Field: Equivalent Piping Length used for Piping Correction Factor in Cooling Mode
This numeric field defines the equivalent pipe length in meters between the farthest terminal
unit and the heat pump condenser. This value includes the gas refrigerant line length (for
both horizontal and vertical distances), fitting losses, pipe bends, and other connections that
contribute to piping losses. This field is used to calculate the piping correction factor in
cooling mode. This value defines the head losses due to the pipe length between the farthest
terminal unit and the heat pump condenser and impacts the maximum available capacity in
cooling mode.
Field: Vertical Height used for Piping Correction Factor
This numeric field defines the vertical pipe height in meters between the highest or lowest
terminal unit and the heat pump condenser. This value defines the gravitational losses due to
a change in height between the highest (positive value), or lowest (negative value) terminal
unit and the heat pump condenser. The distance specified here is applied to the piping
correction factor calculation for both cooling and heating. If the distance between the highest
terminal unit above the heat pump condenser is greater than the distance between the lowest
terminal unit below the condenser enter the difference between the highest and lowest
terminal units as a positive distance, otherwise enter this difference as a negative distance.
Example: if the distance from the heat pump condenser to the highest terminal unit above the
condenser is 10 m and the distance from the heat pump condenser to the lowest terminal unit
below the condenser is -15 m, then enter a value of -5 m in this field. This head loss impacts
the maximum available capacity in cooling mode.
Field: Piping Correction Factor for Length in Cooling Mode Curve Name
This alpha field defines the linear, quadratic, or cubic curve name used to calculate the piping
correction factor for length in cooling mode. Piping losses are a function of piping length. If
sufficient piping loss information is available where piping losses are also a function of
combination ratio (i.e., in addition to length), a biquadratic performance curve may be used.
Field: Piping Correction Factor for Height in Cooling Mode Coefficient
This numeric field defines the coefficient used to calculate the piping correction factor for
height in cooling mode.

9/29/14

1104

Input-Output Reference

Group Variable Refrigerant Flow Equipment

Field: Equivalent Piping Length used for Piping Correction Factor in Heating Mode
This numeric field defines the equivalent pipe length in meters between the farthest terminal
unit and the heat pump condenser. This value includes the liquid refrigerant line length (for
both horizontal and vertical distances), fitting losses, pipe bends, and other connections that
contribute to piping losses. This field is used to calculate the piping correction factor in
heating mode. This value defines the head losses due to the pipe length between the farthest
terminal unit and the heat pump condenser and impacts the maximum available capacity in
heating mode.
Field: Piping Correction Factor for Length in Heating Mode Curve Name
This alpha field defines the linear, quadratic, or cubic curve name used to calculate the piping
correction factor for length in heating mode. Piping losses are a function of piping length. If
sufficient piping loss information is available where piping losses are also a function of
combination ratio (i.e., in addition to length), a biquadratic performance curve may be used.
Field: Piping Correction Factor for Height in Heating Mode Coefficient
This numeric field defines the coefficient used to calculate the piping correction factor for
height in heating mode.
Field: Crankcase Heater Power per Compressor
This numeric field defines the electrical power consumed by the crankcase heater in watts for
each compressor. This crankcase heater power is consumed when the outdoor temperature
is below the maximum outdoor dry-bulb temperature for crankcase heater operation. The
minimum value for this field is 0. If this field is left blank, the default value is 33 watts.
Crankcase heater electrical consumption is applied only when the compressor is off or is
applied during the off cycle when the compressor is cycling below the Minimum Heat Pump
Part-Load Ratio. This field is only used to calculate crankcase heater power and has no
impact on heat pump performance.
Field: Number of Compressors
This numeric field defines the number of compressors in the heat pump condensing unit and
is used exclusively to determine the operating characteristics of the crankcase heater. For
example, if the number of compressors is 3, one crankcase heater will operate when the heat
pump condensing units part-load ratio is less than or equal to 0.67 (when the ratio of
compressor size to total compressor capacity input is 0.33) and the outdoor temperature is
below the maximum outdoor temperature for crankcase heater operation. Similarly, two
crankcase heaters will operate when the heat pump condensing units PLR is less than or
equal to 0.33 and the outdoor temperature is below the maximum outdoor temperature for
crankcase heater operation. If the heat pump condensing unit is off, all 3 crankcase heaters
will operate if the outdoor temperature is below the maximum outdoor temperature for
crankcase heater operation. The minimum value for this field is 1. If this field is left blank, the
default value is 2. This field is only used to calculate crankcase heater power and has no
impact on heat pump performance.
Field: Ratio of Compressor Size to Total Compressor Capacity
This numeric field defines the size of the first stage compressor to the total compressor
capacity and is used exclusively for calculating crankcase heater energy. If this field and the
previous field are left blank, the default value is 0.5. If this field is left blank and the previous
field is not blank, the compressors are assumed to be equally sized. When the number of
compressors is greater than 2, the 2 nd stage compressor and all additional compressors are
assumed to be equally sized. This field is only used to calculate crankcase heater power and
has no impact on heat pump performance.

9/29/14

1105

Input-Output Reference

Group Variable Refrigerant Flow Equipment

Field: Maximum Outdoor Dry-bulb Temperature for Crankcase Heater

This numeric field defines the maximum outdoor temperature, in degrees Celsius, below
which the crankcase heater will operate. If this field is left blank, the default value is 0 C. This
field is only used to calculate crankcase heater power and has no impact on heat pump
performance.
Field: Defrost Strategy
This alpha field has two choices: reverse-cycle or resistive. If the reverse-cycle strategy is
selected, the heating cycle is reversed periodically to provide heat to melt frost accumulated
on the outdoor coil. If a resistive defrost strategy is selected, the frost is melted using an
electric resistance heater. If this input field is left blank, the default defrost strategy is reversecycle. Defrost can be disabled by entering a resistive defrost strategy using a timed defrost
control, a 0 defrost time period fraction and a 0 resistive defrost heater capacity in the
following inputs fields. This method is used when the Maximum Outdoor Dry-Bulb
Temperature for Defrost Operation field value is greater than the expected minimum outdoor
dry-bulb temperature simulated in the weather file.
Field: Defrost Control
This alpha field has two choices: timed or on-demand. If timed control is selected, the defrost
time period is calculated based on a fixed value of compressor runtime whether or not frost
has actually accumulated. For timed defrost control, the fractional amount of time the unit is
in defrost is entered in the input field Defrost Time Period Fraction described below. If ondemand defrost control is selected, the defrost time period is calculated based on outdoor
weather (humidity ratio) conditions. Regardless of which defrost control is selected, defrost
does not occur above the user specified outdoor temperature entered in the input field
Maximum Outdoor Dry-bulb Temperature for Defrost Operation described above. If this
input field is left blank, the default defrost control is timed.
Field: Defrost Energy Input Ratio Modifier Function of Temperature Curve Name
This alpha field defines the name of a bi-quadratic performance curve (ref: Performance
Curves) that parameterizes the variation of the energy input ratio (EIR) during reverse-cycle
defrost periods as a function of the outdoor air dry-bulb temperature and the weighted
average wet-bulb temperature of the air entering the indoor terminal units. The output of this
curve is multiplied by the coil capacity, the fractional defrost time period and the runtime
fraction of the heating coil to give the defrost power at the specific temperatures at which the
indoor and outdoor coils are operating. The curve is normalized to a value of 1.0 at the rating
point conditions.
Field: Defrost Time Period Fraction
This numeric field defines the fraction of compressor runtime when the defrost cycle is active.
For example, if the defrost cycle is active for 3.5 minutes for every 60 minutes of compressor
runtime, then the user should enter 3.5/60 = 0.058333. The value for this input field must be
greater than or equal to 0. If this input field is left blank, the default value is 0.058333.
Field: Resistive Defrost Heater Capacity
This numeric field defines the capacity of the resistive defrost heating element in Watts. This
input field is used only when the selected defrost strategy is resistive (see input field Defrost
Strategy above). The value for this input field must be greater than or equal to 0. If this input
field is left blank, the default value is 0.
Field: Maximum Outdoor Dry-bulb Temperature for Defrost Operation
This numeric field defines the outdoor air dry-bulb temperature above which outdoor coil
defrosting is disabled. If this input field is left blank, the default value is 5 C. Defrost can be
completely eliminated by selecting a temperature lower than the minimum expected outdoor
temperature found in the weather file.
9/29/14

1106

Input-Output Reference

Group Variable Refrigerant Flow Equipment

Field: Condenser Type

This choice field defines the configuration of the heat pump condenser. Valid choices are
AirCooled, EvaporativelyCooled, and WaterCooled.
Field: Condenser Inlet Node Name
This alpha field defines the name of the condenser inlet air or water node. For Condenser
type = AirCooled, this node name should also be listed in an OutdoorAir:Node or
OutdoorAir:NodeList object. If this field is blank, the model assumes an air-cooled condenser
and the weather file is used to define the outdoor conditions entering the condenser. If this
field is not blank, the node conditions are used to define the outdoor air or inlet water
conditions entering the condenser. A node name is typically entered here for air-cooled
systems when conditions other than those found in the weather file should be used (ref.
OutdoorAir:Node related to height above ground).
Field: Condenser Outlet Node Name
This alpha field defines the name of the condenser outlet water node. This field is only used
for water-cooled systems.
Field: Water Condenser Volume Flow Rate
This numeric field defines the condenser water volume flow rate in cubic meters per second.
This field is autosizable and only used for water-cooled systems.
Field: Evaporative Condenser Effectiveness
The effectiveness of the evaporative condenser, which is used to determine the temperature
of the air entering the outdoor condenser coil as follows:

Tcond inlet

Twb, o

1 EvapCondEffectiveness Tdb, o Twb, o

where
Tcond inlet = the temperature of the air entering the condenser coil (C)
Twb,o = the wet-bulb temperature of the outdoor air (C)
Tdb,o = the dry-bulb temperature of the outdoor air (C)
The resulting condenser inlet air temperature is used by the Cooling Capacity Ratio Modifier
Curve (function of temperature) and the Cooling Energy Input Ratio Modifier Curve (function
of temperature). The default value for this field is 0.9, although valid entries can range from
0.0 to 1.0. This field is not used when Condenser Type = Air Cooled and the simulation is
calculating heating performance.
If the user wants to model an air-cooled condenser, they should simply specify AirCooled in
the field Condenser Type. In this case, the Cooling Capacity Ratio Modifier Curve (function of
temperature) and the Cooling Energy Input Ratio Modifier Curve (function of temperature)
input fields for this object should reference performance curves that are a function of outdoor
dry-bulb temperature.
If the user wishes to model an evaporative-cooled condenser AND they have performance
curves that are a function of the wet-bulb temperature of air entering the condenser coil, then
the user should specify Condenser Type = EvapCooled and the evaporative condenser
effectiveness value should be entered as 1.0. In this case, the Cooling Capacity Ratio
Modifier Curve (function of temperature) and the Cooling Energy Input Ratio Modifier Curve
(function of temperature) input fields for this object should reference performance curves that
are a function of the wet-bulb temperature of air entering the condenser coil.
If the user wishes to model an air-cooled condenser that has evaporative media placed in
front of it to cool the air entering the condenser coil, then the user should specify Condenser
Type = EvapCooled. The user must also enter the appropriate evaporative effectiveness for
9/29/14

1107

Input-Output Reference

Group Variable Refrigerant Flow Equipment

the media. In this case, the Cooling Capacity Ratio Modifier Curve (function of temperature)
and the Cooling Energy Input Ratio Modifier Curve (function of temperature) input fields for
this object should reference performance curves that are a function of outdoor dry-bulb
temperature. Be aware that the evaporative media will significantly reduce the dry-bulb
temperature of the air entering the condenser coil, so the Cooling Capacity and Cooling EIR
Modifier Curves must be valid for the expected range of dry-bulb temperatures that will be
entering the condenser coil.
Field: Evaporative Condenser Air Flow Rate
The air volume flow rate, in m 3 per second, entering the evaporative condenser. This value is
used to calculate the amount of water used to evaporatively cool the condenser inlet air. The
minimum value for this field must be greater than zero, and this input field is autosizable
(equivalent to 0.000144 m 3/s per watt of rated total cooling capacity [850 cfm/ton]). This field
is not used when Condenser Type = AirCooled.
Field: Evaporative Condenser Pump Rated Power Consumption
The rated power of the evaporative condenser water pump in Watts. This value is used to
calculate the power required to pump the water used to evaporatively cool the condenser
inlet air. The default value for this input field is zero, but it is autosizable (equivalent to
0.004266 W per watt [15 W/ton] of rated total cooling capacity). This field is not used when
Condenser Type = AirCooled.
Field: Supply Water Storage Tank Name
This alpha field defines the name of the water storage tank when an evaporatively-cooled
condenser is used.
Field: Basin Heater Capacity
This numeric field contains the capacity of the heat pumps electric basin heater in watts per
degree Kelvin. This field only applies for Condenser Type = EvaporativelyCooled. This field is
used in conjunction with the Basin Heater Setpoint Temperature described in the following
field. The basin heater electric power is equal to this field multiplied by the difference between
the basin heater set point temperature and the outdoor dry-bulb temperature. The basin
heater only operates when the heat pump compressor(s) is off, regardless of the basin heater
schedule described below. The basin heater capacity must be greater than or equal to zero,
with a default value of zero if this field is left blank.
Field: Basin Heater Setpoint Temperature
This numeric field contains the set point temperature (C) for the basin heater described in
the previous field. This field only applies for Condenser Type = EvaporativelyCooled. The
basin heater is active when the outdoor air dry-bulb temperature falls below this setpoint
temperature, as long as the heat pump is off. This set point temperature must be greater than
or equal to 2C, and the default value is 2C if this field is left blank.
Field: Basin Heater Operating Schedule Name
This alpha field contains the name of the basin heater operating schedule. This field only
applies for Condenser Type = EvaporativelyCooled. The basin heater operating schedule is
assumed to be an on/off schedule and the heater is available to operate any time the
schedule value is greater than 0. The basin heater operates when scheduled on and the
outdoor air dry-bulb temperature is below the set point temperature described in the previous
field. If this field is left blank, the basin heater is available to operate throughout the
simulation. Regardless of this schedule, the basin heater may only operate when the heat
pump is off.

9/29/14

1108

Input-Output Reference

Group Variable Refrigerant Flow Equipment

Field: Fuel Type

This alpha field determines the type of fuel that this variable refrigerant flow system uses.
This field has seven choices: Electricity, NaturalGas, PropaneGas, Diesel, Gasoline,
FuelOil#1, FuelOil#2, OtherFuel1, and OtherFuel2. The default is Electricity. The use of
alternate fuel types assumes an engine drives the variable speed compression system and
also accounts for condenser air flow (i.e., a fan attached to the engine provides air flow
through the outdoor condenser.
Field: Minimum Outdoor Temperature in Heat Recovery Mode
This numeric field defines the minimum outdoor dry-bulb temperature allowed for heat
recovery operation. Below this temperature, heat recovery is disabled. This input must be
greater than the larger of the minimum outdoor temperature in cooling or heating mode. If this
field is left blank, the default value is the higher of the Minimum Outdoor Temperature in
Cooling Mode or Minimum Outdoor Temperature in Heating Mode inputs. This system may
still operate in cooling or heating only mode when outdoor temperatures are below the
minimum outdoor temperature in heat recovery mode. This input is only used when Heat
Pump Waste Heat Recovery is selected as Yes.
Field: Maximum Outdoor Temperature in Heat Recovery Mode
This numeric field defines the maximum outdoor dry-bulb temperature allowed for heat
recovery operation. Above this temperature, heat recovery is disabled. This input must be
less than the smaller of the maximum outdoor temperature in cooling or heating mode. If this
field is left blank, the default value is the lower of the Maximum Outdoor Temperature in
Cooling Mode or Maximum Outdoor Temperature in Heating Mode inputs.. This system may
still operate in cooling or heating only mode when outdoor temperatures are above the
maximum outdoor temperature in heat recovery mode. This input is only used when Heat
Pump Waste Heat Recovery is selected as Yes.
Field: Heat Recovery Cooling Capacity Modifier Curve Name
This alpha field defines the cooling capacity modifier when heat recovery mode is active. This
modifier is used as a multiplier for available cooling capacity, and when in heat recovery
mode, this modifier is usually less than 1. This curve is either a bi-quadratic equation using
weighted average indoor temperature (i.e., the indoor terminal units weighted average inlet
temperatures) and condenser entering air temperature as the independent variables or a
cubic curve based on part-load ratio. This performance curve can be used to describe the
cooling capacity modifier as either a constant (e.g., temperature or part-load ratio term
coefficients are 0), a cooling modifier that varies with either indoor temperature and/or
outdoor temperature, or part-load ratio (e.g., one or more temperature or part-load ratio term
coefficients are 0), or varies with both indoor and outdoor temperatures or part-load ratio
(e.g., all temperature or part-load ratio term coefficients are non-zero). If this field is left blank,
and heat recovery operating mode is selected, the default constant modifier is 0.9. This
modifier is applied only when heat recovery mode is active. To model a heat recovery system
which has no degradation in cooling performance when heat recovery mode is active, or if the
degradation is not constant at different operating conditions, a performance curve object must
be used. This input is only used when Heat Pump Waste Heat Recovery is selected as Yes
and the system changes from cooling only mode to heat recovery mode.
Field: Initial Heat Recovery Cooling Capacity Fraction
This numeric field defines the fraction of cooling capacity available when the system
transitions from cooling only operation to simultaneous cooling and heating. It is common for
the cooling capacity to decrease before the system recovers. If this field is left blank, a default
value of 0.5 is used (50% reduction in cooling capacity at the start of heat recovery mode).
The system will recovery according to the time constant entered in Heat Recovery Cooling
Capacity Time Constant input field. If the transition period will not be modeled, this input field
must be set to 1. This input is only used when Heat Pump Waste Heat Recovery is selected
9/29/14

1109

Input-Output Reference

Group Variable Refrigerant Flow Equipment

as Yes and the system changes from cooling only mode to heat recovery mode. Refer to the
engineering reference document discussion on the variable refrigerant flow heat pump model
section for transition from cooling only mode to heat recovery mode for a more detailed
description.
Field: Heat Recovery Cooling Capacity Time Constant
This numeric field defines the cooling capacity time constant, in hours, used to model the
time it takes for the system to change from cooling only operation to simultaneous cooling
and heating. Total response time is defined as 5 time constants. If this field is left blank, a
default value of 0.083 is used. If the transition period will not be modeled, the Initial Heat
Recovery Cooling Capacity Fraction field must be set to 1. This input is only used when Heat
Pump Waste Heat Recovery is selected as Yes and the system changes from cooling only
mode to heat recovery mode. Refer to the engineering reference document discussion on the
variable refrigerant flow heat pump model section for transition from cooling only mode to
heat recovery mode for a more detailed description.
Field: Heat Recovery Cooling Energy Modifier Curve Name
This alpha field defines the cooling energy modifier when heat recovery mode is active. This
modifier is used as a multiplier for operating cooling energy, and when in heat recovery
mode, this modifier is usually greater than 1. This curve is a bi-quadratic equation using
weighted average indoor temperature (i.e., the indoor terminal units weighted average inlet
temperatures) and condenser entering air temperature as the independent variables. This
performance curve can be used to describe the cooling energy modifier as either a constant
(e.g., temperature term coefficients are 0), a cooling energy modifier that varies with indoor
and/or outdoor temperatures (e.g., one or more temperature term coefficients are 0), or
varies with both indoor and outdoor temperatures (e.g., temperature term coefficients are
non-zero). If this field is left blank, and heat recovery operating mode is selected, the default
constant modifier is 1.1. This modifier is applied only when heat recovery mode is active. To
model a heat recovery system which has no degradation in cooling performance when heat
recovery mode is active, or if the degradation is not constant at different operating conditions,
a performance curve object must be used. This input is only used when Heat Pump Waste
Heat Recovery is selected as Yes and the system changes from cooling only mode to heat
recovery mode.
Field: Initial Heat Recovery Cooling Energy Fraction
This numeric field defines the fraction of cooling energy consumed when the system
transitions from cooling only operation to simultaneous cooling and heating. It is common for
the cooling energy to drop before the system recovers. If this field is left blank, a default value
of 1 is used (no change in energy at the start of heat recovery mode). If the transition period
will not be modeled, this input field must be set to 1. This input is only used when Heat Pump
Waste Heat Recovery is selected as Yes and the system changes from cooling only mode to
heat recovery mode. Refer to the engineering reference document discussion on the variable
refrigerant flow heat pump model section for transition from cooling only mode to heat
recovery mode for a more detailed description.
Field: Heat Recovery Cooling Energy Time Constant
This numeric field defines the cooling energy time constant, in hours, used to model the time
it takes for the system to transition from cooling only operation to simultaneous cooling and
heating. Total response time is defined as 5 time constants. If this field is left blank, a default
value of 0.0 is used. If the transition period will not be modeled, the Initial Heat Recovery
Cooling Energy Fraction field must be set to 1. This input is only used when Heat Pump
Waste Heat Recovery is selected as Yes and the system changes from cooling only mode to
heat recovery mode. Refer to the engineering reference document discussion on the variable
refrigerant flow heat pump model section for transition from cooling only mode to heat
recovery mode for a more detailed description.

9/29/14

1110

Input-Output Reference

Group Variable Refrigerant Flow Equipment

Field: Heat Recovery Heating Capacity Modifier Curve Name

This alpha field defines the heating capacity modifier when heat recovery mode is active. This
modifier is used as a multiplier for available heating capacity, and when in heat recovery
mode, this modifier is usually less than 1. This curve is a bi-quadratic equation using
weighted average indoor temperature (i.e., the indoor terminal units weighted average inlet
temperatures) and condenser entering air temperature as the independent variables. This
performance curve can be used to describe the heating capacity modifier as either a constant
(e.g., temperature term coefficients are 0), a heating modifier that varies with indoor and/or
outdoor temperatures (e.g., one or more temperature term coefficients are 0), or varies with
both indoor and outdoor temperatures (e.g., temperature term coefficients are non-zero). If
this field is left blank, and heat recovery operating mode is selected, the default constant
modifier is 0.9. This modifier is applied only when heat recovery mode is active. To model a
heat recovery system which has no degradation in heating performance when heat recovery
mode is active, or if the degradation is not constant at different operating conditions, a
performance curve object must be used. This input is only used when Heat Pump Waste
Heat Recovery is selected as Yes and the system changes from heating only mode to heat
recovery mode.
Field: Initial Heat Recovery Heating Capacity Fraction
This numeric field defines the fraction of heating capacity available when the system changes
from heating only operation to simultaneous heating and cooling. It is common for the heating
capacity to decrease before the system recovers. If this field is left blank, a default value of
0.5 is used (50% reduction in heating capacity at the start of heat recovery mode). The
system will recovery according to the time constant entered in Heat Recovery Heating
Capacity Time Constant input field. If the transition period will not be modeled, this input field
must be set to 1. This input is only used when Heat Pump Waste Heat Recovery is selected
as Yes and the system changes from heating only mode to heat recovery mode. Refer to the
engineering reference document discussion on the variable refrigerant flow heat pump model
section for transition from cooling only mode to heat recovery mode for a more detailed
description.
Field: Heat Recovery Heating Capacity Time Constant
This numeric field defines the heating capacity time constant, in hours, used to model the
time it takes for the system to transition from cooling only operation to simultaneous cooling
and heating. Total response time is defined as 5 time constants. If this field is left blank, a
default value of 0.083 is used. If the transition period will not be modeled, the Initial Heat
Recovery Heating Capacity Fraction field must be set to 1. This input is only used when Heat
Pump Waste Heat Recovery is selected as Yes and the system changes from heating only
mode to heat recovery mode. Refer to the engineering reference document discussion on the
variable refrigerant flow heat pump model section for transition from cooling only mode to
heat recovery mode for a more detailed description.
Field: Heat Recovery Heating Energy Modifier Curve Name
This alpha field defines the heating energy modifier when heat recovery mode is active. This
modifier is used as a multiplier for operating heating energy, and when in heat recovery
mode, this modifier is usually greater than 1. This curve is a bi-quadratic equation using
weighted average indoor temperature (i.e., the indoor terminal units weighted average inlet
temperatures) and condenser entering air temperature as the independent variables. This
performance curve can be used to describe the heating energy modifier as either a constant
(e.g., temperature term coefficients are 0), a heating energy modifier that varies with indoor
and/or outdoor temperatures (e.g., one or more temperature term coefficients are 0), or
varies with both indoor and outdoor temperatures (e.g., temperature term coefficients are
non-zero). If this field is left blank, and heat recovery operating mode is selected, the default
constant modifier is 1.1. This modifier is applied only when heat recovery mode is active. To
model a heat recovery system which has no degradation in heating performance when heat
9/29/14

1111

Input-Output Reference

Group Variable Refrigerant Flow Equipment

recovery mode is active, or if the degradation is not constant at different operating conditions,
a performance curve object must be used. This input is only used when Heat Pump Waste
Heat Recovery is selected as Yes and the system changes from heating only mode to heat
recovery mode.
Field: Initial Heat Recovery Heating Energy Fraction
This numeric field defines the fraction of heating energy consumed when the system changes
from heating only operation to simultaneous heating and cooling. It is common for the heating
energy to decrease before the system recovers. If this field is left blank, a default value of 0.5
is used (50% reduction in heating energy at the start of heat recovery mode). The system will
recovery according to the time constant entered in Heat Recovery Heating Energy Time
Constant input field. If the transition period will not be modeled, this input field must be set to
1. This input is only used when Heat Pump Waste Heat Recovery is selected as Yes and the
system changes from heating only mode to heat recovery mode. Refer to the engineering
reference document discussion on the variable refrigerant flow heat pump model section for
transition from cooling only mode to heat recovery mode for a more detailed description.
Field: Heat Recovery Heating Energy Time Constant
This numeric field defines the heating energy time constant, in hours, used to model the time
it takes for the system to change from cooling only operation to simultaneous cooling and
heating. Total response time is defined as 5 time constants. If this field is left blank, a default
value of 0.0 is used. If the transition period will not be modeled, the Initial Heat Recovery
Heating Energy Fraction field must be set to 1. This input is only used when Heat Pump
Waste Heat Recovery is selected as Yes and the system changes from heating only mode to
heat recovery mode. Refer to the engineering reference document discussion on the variable
refrigerant flow heat pump model section for transition from cooling only mode to heat
recovery mode for a more detailed description.
Following is an example input for a AirConditioner:VariableRefrigerantFlow system.

9/29/14

1112

Input-Output Reference

Group Variable Refrigerant Flow Equipment

AirConditioner:VariableRefrigerantFlow,
VRF Heat Pump,
!- Heat Pump Name
VRFCondAvailSched,
!- Availability Schedule Name
autosize,
!- Gross Rated Total Cooling Capacity {W}
3.16038,
!- Gross Rated Cooling COP {W}
-5,
!- Minimum Outdoor Temperature in Cooling Mode {C}
43,
!- Maximum Outdoor Temperature in Cooling Mode {C}
VRFCoolCapFT,
!- Cooling Capacity Ratio Modifier Function of Low Temperature Curve Name
VRFCoolCapFTBoundary, !- Cooling Capacity Ratio Boundary Curve Name
VRFCoolCapFTHi,
!- Cooling Capacity Ratio Modifier Function of High Temperature Curve Name
VRFCoolEIRFT,
!- Cooling Energy Input Ratio Modifier Function of Low Temperature Curve Name
VRFCoolEIRFTBoundary, !- Cooling Energy Input Ratio Boundary Curve Name
VRFCoolEIRFTHi,
!- Cooling Energy Input Ratio Modifier Function of High Temperature Curve Name
CoolingEIRLowPLR,
!- Cooling Energy Input Ratio Modifier Function of Low Part-Load Ratio Curve Name
CoolingEIRHiPLR,
!- Cooling Energy Input Ratio Modifier Function of High Part-Load Ratio Curve Name
CoolingCombRatio,
!- Cooling Combination Ratio Correction Factor Curve Name
VRFCPLFFPLR,
!- Cooling Part-Load Fraction Correlation Curve Name
autosize,
!- Gross Rated Heating Capacity {W}
,
!- Rated Heating Capacity Sizing Ratio (W/W)
3.40909,
!- Gross Rated Heating COP
-20,
!- Minimum Outdoor Temperature in Heating Mode {C}
15.5,
!- Maximum Outdoor Temperature in Heating Mode {C}
VRFHeatCapFT,
!- Heating Capacity Ratio Modifier Function of Low Temperature Curve Name
VRFHeatCapFTBoundary, !- Heating Capacity Ratio Boundary Curve Name
VRFHeatCapFTHi,
!- Heating Capacity Ratio Modifier Function of High Temperature Curve Name
VRFHeatEIRFT,
!- Heating Energy Input Ratio Modifier Function of Low Temperature Curve Name
VRFHeatEIRFTBoundary, !- Heating Energy Input Ratio Boundary Curve Name
VRFHeatEIRFTHi,
!- Heating Energy Input Ratio Modifier Function of High Temperature Curve Name
WetBulbTemperature,
!- Heating Performance Curve Outdoor Temperature Type
HeatingEIRLowPLR,
!- Heating Energy Input Ratio Modifier Function of Low Part-Load Ratio Curve Name
HeatingEIRHiPLR,
!- Heating Energy Input Ratio Modifier Function of High Part-Load Ratio Curve Name
HeatingCombRatio,
!- Heating Combination Ratio Correction Factor Curve Name
VRFCPLFFPLR,
!- Heating Part-Load Fraction Correlation Curve Name
0.25,
!- Minimum Heat Pump Part-Load Ratio
SPACE1-1,
!- Zone Name for Master Thermostat Location
LoadPriority,
!- Master Thermostat Priority Control Type
,
!- Thermostat Priority Schedule Name
VRF Heat Pump TU List, !- Zone Terminal Unit List Name
No,
!- Heat Pump Waste Heat Recovery
30,
!- Equivalent Piping Length used for Piping Correction Factor in Cooling Mode {m}
10,
!- Vertical Height used for Piping Correction Factor {m}
CoolingLengthCorrectionFactor, !- Piping Correction Factor for Length in Cooling Mode Curve Name
-0.000386,
!- Piping Correction Factor for Height in Cooling Mode Coefficient
30,
!- Equivalent Piping Length used for Piping Correction Factor in Heating Mode {m}
,
!- Piping Correction Factor for Length in Heating Mode Curve Name
,
!- Piping Correction Factor for Height in Heating Mode Coefficient
15,
!- Crankcase Heater Power per Compressor {W}
3,
!- Number of Compressors
0.33,
!- Ratio of Compressor Size to Total Compressor Capacity
7,
!- Maximum Outdoor Dry-bulb Temperature for Crankcase Heater {C}
Resistive,
!- Defrost Strategy
Timed,
!- Defrost Control
,
!- Defrost Energy Input Ratio Modifier Function of Temperature Curve Name
,
!- Defrost Time Period Fraction
autosize,
!- Resistive Defrost Heater Capacity {W}
7,
!- Maximum Outdoor Dry-bulb Temperature for Defrost Operation {C}
EvaporativelyCooled, !- Condenser Type
MyVRFOANode,
!- Condenser Inlet Node Name
,
!- Condenser Outlet Node Name
,
!- Water Condenser Volume Flow Rate
,
!- Evaporative Condenser Effectiveness {dimensionless}
autosize,
!- Evaporative Condenser Air Flow Rate {m3/s}
autosize,
!- Evaporative Condenser Pump Rated Power Consumption {W}
,
!- Supply Water Storage Tank Name
200,
!- Basin Heater Capacity {W/K}
,
!- Basin Heater Set Point Temperature (C)
,
!- Basin Heater Operating Schedule Name
,
!- Fuel Type
,
!- Minimum Outdoor Temperature in Heat Recovery Mode (C)
,
!- Maximum Outdoor Temperature in Heat Recovery Mode (C)
,
!- Heat Recovery Cooling Capacity Modifier Function of Temperature Curve Name

9/29/14

1113

Input-Output Reference
,
,
,
,
,
,
,
,
,
,
;

!!!!!!!!!!!-

Group Variable Refrigerant Flow Equipment

Initial Heat Recovery
Heat Recovery Cooling
Heat Recovery Cooling
Initial Heat Recovery
Heat Recovery Cooling
Heat Recovery Heating
Initial Heat Recovery
Heat Recovery Heating
Heat Recovery Heating
Initial Heat Recovery
Heat Recovery Heating

Cooling Capacity Fraction

Capacity Time Constant (hr)
Energy Modifier Function of Temperature Curve Name
Cooling Energy Fraction
Energy Time Constant (hr)
Capacity Modifier Function of Temperature Curve Name
Heating Capacity Fraction
Capacity Time Constant (hr)
Energy Modifier Function of Temperature Curve Name
Heating Energy Fraction
Energy Time Constant (hr)

Variable Refrigerant Flow (VRF) Air Conditioner Outputs

HVAC,Average,VRF Heat Pump Total Cooling Rate [W]
HVAC,Average,VRF Heat Pump Total Heating Rate [W]
HVAC,Average,VRF Heat Pump Cooling COP []
HVAC,Average,VRF Heat Pump Heating COP []
HVAC,Average,VRF Heat Pump COP []
HVAC,Average,VRF Heat Pump Part Load Ratio []
HVAC,Average,VRF Heat Pump Runtime Fraction []
HVAC,Average,VRF Heat Pump Cycling Ratio []
HVAC,Average,VRF Heat Pump Operating Mode []
HVAC,Average,VRF Heat Pump Condenser Inlet Temperature [C]
HVAC,Average,VRF Heat Pump Maximum Capacity Cooling Rate [W]
HVAC,Average,VRF Heat Pump Maximum Capacity Heating Rate [W]
HVAC,Average,VRF Heat Pump Crankcase Heater Electric Power [W]
HVAC,Sum,VRF Heat Pump Crankcase Heater Electric Energy [J]
HVAC,Average,VRF Heat Pump Terminal Unit Heating Load Rate [W]
HVAC,Average,VRF Heat Pump Terminal Unit Cooling Load Rate [W]
Heat Recovery:
HVAC,Average,VRF Heat Pump Heat Recovery Status Change Multiplier []
Evap-cooled:
HVAC,Sum,VRF Heat Pump Evaporative Condenser Water Use Volume [m3]
HVAC,Average,VRF Heat Pump Evaporative Condenser Pump Electric Power [W]
HVAC,Sum,VRF Heat Pump Evaporative Condenser Pump Electric Energy [J]
HVAC,Average,VRF Heat Pump Basin Heater Electric Power [W]
HVAC,Average,VRF Heat Pump Basin Heater Electric Energy [J]
HVAC,Average,VRF Heat Pump Heat Recovery Status Change Multiplier []
Water-cooled:
HVAC,Average,VRF Heat Pump Condenser Outlet Temperature [C]
HVAC,Average,VRF Heat Pump Condenser Mass Flow Rate [kg/s]
HVAC,Sum,VRF Heat Pump Condenser Heat Transfer Energy [J]
HVAC,Average, VRF Heat Pump Condenser Heat Transfer Rate [W]
Electric Fuel type (default):
HVAC,Average,VRF Heat Pump Cooling Electric Power [W]
HVAC,Sum,VRF Heat Pump Cooling Electric Energy [J]
HVAC,Average,VRF Heat Pump Heating Electric Power [W]
HVAC,Sum,VRF Heat Pump Heating Electric Energy [J]
Electric defrost always used for Defrost Strategy = Resistive regardless of
fuel type
HVAC,Average,VRF Heat Pump Defrost Electric Power [W]
HVAC,Sum,VRF Heat Pump Defrost Electric Energy [J]
Alternate Fuel types (e.g., FuelType = NaturalGas):
HVAC,Average,VRF Heat Pump Cooling <FuelType> Rate [W]
HVAC,Sum,VRF Heat Pump Cooling <FuelType> Energy [J]
HVAC,Average,VRF Heat Pump Heating <FuelType> Rate [W]
9/29/14

1114

Input-Output Reference

Group Variable Refrigerant Flow Equipment

HVAC,Sum,VRF Heat Pump Heating <FuelType> Energy [J]

HVAC,Average,VRF Heat Pump Defrost <FuelType> Rate [W]
HVAC,Sum,VRF Heat Pump Defrost <FuelType> Energy [J]
Note: refer to the rdd file after a simulation for exact output variable
names

VRF Heat Pump Total Cooling Rate [W]

This output field is the operating total cooling capacity of the variable refrigerant flow heat
pump in Watts. This value is calculated for each HVAC system time step being simulated,
and the results are averaged for the time step being reported. This value should match the
sum of the individual zone terminal unit output variables for Zone VRF Air Terminal Total
Cooling Rate.
VRF Heat Pump Total Heating Rate [W]
This output field is the operating total heating capacity of the variable refrigerant flow heat
pump in Watts. The capacity includes any degradation due to defrost mode. This value is
calculated for each HVAC system time step being simulated, and the results are averaged for
the time step being reported. This value should match the sum of the individual zone terminal
unit output variables for Zone VRF Air Terminal Total Heating Rate.
VRF Heat Pump Cooling Electric Power [W]
This output field is the cooling mode electricity consumption rate of the variable refrigerant
flow heat pump in Watts. The consumption includes electricity used by the compressor
(including crankcase heater), and the condenser fan. This value is calculated for each HVAC
system time step being simulated, and the results are averaged for the time step being
reported. The choice of an alternate fuel type (see Fuel Type input) will result in a change in
the output variable name (e.g., Variable Refrigerant Flow Heat Pump Cooling NaturalGas
Consumption Rate).
VRF Heat Pump Cooling Electric Energy [J]
This output field is the cooling mode electricity consumption of the variable refrigerant flow
heat pump in Joules for the time period being reported. The consumption includes electricity
used by the compressor (including crankcase heater), and the condenser fan. This value is
calculated for each HVAC system time step being simulated, and the results are summed for
the time step being reported. This output is also added to a meter with Resource Type =
Electricity, End Use Key = Cooling, Group Key = System (Ref. Output:Meter objects). The
choice of an alternate fuel type (see Fuel Type input) will result in a change in the output
variable name (e.g., Variable Refrigerant Flow Heat Pump Cooling NaturalGas
Consumption). The resource type meter will also be modified to reflect the chosen fuel type
(e.g., Resource Type = NaturalGas).
VRF Heat Pump Heating Electric Power [W]
This output field is the heating mode electricity consumption rate of the variable refrigerant
flow heat pump in Watts. The consumption includes electricity used by the compressor
(including crankcase heater), additional energy required for defrost, and the condenser fan.
This value is calculated for each HVAC system time step being simulated, and the results are
averaged for the time step being reported. The choice of an alternate fuel type (see Fuel
Type input) will result in a change in the output variable name (e.g., Variable Refrigerant Flow
Heat Pump Heating NaturalGas Consumption Rate).
VRF Heat Pump Heating Electric Energy [J]
This output field is the heating mode electricity consumption of the variable refrigerant flow
heat pump in Joules for the time period being reported. The consumption includes electricity

9/29/14

1115

Input-Output Reference

Group Variable Refrigerant Flow Equipment

used by the compressor (including crankcase heater), additional energy required for defrost,
and the condenser fan. This value is calculated for each HVAC system time step being
simulated, and the results are summed for the time step being reported. This output is also
added to a meter with Resource Type = Electricity, End Use Key = Heating, Group Key =
System (Ref. Output:Meter objects). The choice of an alternate fuel type (see Fuel Type
input) will result in a change in the output variable name (e.g., Variable Refrigerant Flow Heat
Pump Heating NaturalGas Consumption). The resource type meter will also be modified to
reflect the chosen fuel type (e.g., Resource Type = NaturalGas).
VRF Heat Pump Cooling COP[]
This is the operating cooling coefficient of performance for the heat pump. This value is
calculated using the ratio of VRF Heat Pump Total Cooling Rate and Variable Refrigerant
Flow Heat Pump Cooling Electric Consumption Rate output variables. Crankcase heater
(usually 0 in cooling mode), evaporative condenser water pump, and defrost (usually 0 in
cooling mode) consumption rate output variables are included in this calculation. This value is
specific to outdoor unit performance in cooling mode, is calculated for each HVAC system
time step being simulated, and the results are averaged for the time step being reported.
VRF Heat Pump Heating COP[]
This is the operating heating coefficient of performance for the heat pump. This value is
calculated using the ratio of VRF Heat Pump Total Heating Rate and Variable Refrigerant
Flow Heat Pump Heating Electric Consumption Rate output variables. Crankcase heater,
evaporative condenser water pump (usually 0 in heating mode), and defrost consumption
rate output variables are included in this calculation. This value is specific to outdoor unit
performance in heating mode, is calculated for each HVAC system time step being simulated,
and the results are averaged for the time step being reported.
VRF Heat Pump COP[]
This is the operating coefficient of performance for the heat pump. This value is calculated
using the ratio of the total terminal unit coil capacity (cooling plus heating and accounts for
piping losses) and total system electric consumption rate (compressor, crankcase heater,
evaporative condenser water pump, defrost, and terminal unit parasitic electric consumption
rate). This output variable does not include pump power for a water-cooled system. This
value is specific to overall system performance, is calculated for each HVAC system time
step being simulated, and the results are averaged for the time step being reported.
VRF Heat Pump Defrost Electric Power [W]
This is the electricity consumption rate of the heat pump defrost in Watts when the unit is in
defrost mode (timed, reverse-cycle). . The choice of an alternate fuel type (see Fuel Type
input) will result in a change in the output variable name (e.g., Variable Refrigerant Flow Heat
Pump NaturalGas Defrost Consumption Rate).
VRF Heat Pump Defrost Electric Energy [J]
This is the electricity consumption of the heat pump in Joules for the time step being
reported. This consumption is applicable when the unit is in defrost mode (reverse-cycle or
resistive). This output is also added to a meter with Resource Type = Electricity, End Use Key
= Heating, Group Key = System (Ref. Output:Meter objects). The choice of an alternate fuel
type (see Fuel Type input) will result in a change in the output variable name (e.g., Variable
Refrigerant Flow Heat Pump NaturalGas Defrost Consumption). The resource type meter will
also be modified to reflect the chosen fuel type (e.g., Resource Type = NaturalGas).
VRF Heat Pump Part Load Ratio
This output field is the part-load ratio of the heat pump condenser. Heat pump part-load ratio
is defined as the total coil load divided by the heat pumps maximum available capacity at the

9/29/14

1116

Input-Output Reference

Group Variable Refrigerant Flow Equipment

current operating conditions. This value is calculated for each HVAC system time step being
simulated, and the results are averaged for the time step being reported.
VRF Heat Pump Runtime Fraction []
This output field is the runtime fraction of the heat pump condensers first stage compressor.
Heat pump runtime fraction is defined as the fraction of time the first stage compressor is on
during a given time period and includes cycling losses. This value is calculated as the ratio of
the VRF Heat Pump Cycling Ratio and the output of the Cooling Part-Load Fraction
Correlation Curve object as the specific cycling ratio. This value is calculated for each HVAC
system time step being simulated, and the results are averaged for the time step being
reported.
VRF Heat Pump Cycling Ratio []
This output field is the cycling ratio of the heat pump condensers first stage compressor.
Heat pump cycling ratio is defined as the fraction of time the first stage compressor is on
during a given time period. This value is calculated for each HVAC system time step being
simulated, and the results are averaged for the time step being reported.
VRF Heat Pump Operating Mode []
This output field is an integer representation of the operating mode of the variable refrigerant
flow heat pump. The operating mode for cooling mode is indicated by a 1 and heating mode
is indicated by a 2. A value of 0 is reported if the heat pump is off. This value is calculated for
each HVAC system time step being simulated, and the results are averaged for the time step
being reported.
VRF Heat Pump Condenser Inlet Temperature [C]
This is the inlet air temperature entering the condenser coil in degrees C. This value can
represent the outdoor air dry-bulb temperature, wet-bulb temperature, or somewhere in
between from the weather data being used, depending on the value used in the input field
Evaporative Condenser Effectiveness. The temperature reported here is used in the various
modifier curves related to temperature (e.g., Total Cooling Capacity Modifier Curve [function
of temperature]). (The use of the word Condenser here is taken from cooling operation -- the
same device can also be an evaporator during heating operation.)
VRF Heat Pump Condenser Outlet Temperature [C]
This is the condenser coil outlet water temperature in degrees C. This value is calculated for
each HVAC system time step being simulated, and the results are averaged for the time step
being reported. This value is only reported for water-cooled systems. (The use of the word
Condenser here is taken from cooling operation -- the same device can also be an
evaporator during heating operation.)
VRF Heat Pump Condenser Mass Flow Rate [kg/s]
This is the condenser coil outlet water mass flow rate in kilograms per second. This value is
calculated for each HVAC system time step being simulated, and the results are averaged for
the time step being reported. This value is only reported for water-cooled systems. (The use
of the word Condenser here is taken from cooling operation -- the same device can also be
an evaporator during heating operation.)
VRF Heat Pump Condenser Heat Transfer Rate [W]
This is the condenser coil heat transfer rate in Watts. This value is calculated for each HVAC
system time step being simulated, and the results are averaged for the time step being
reported. This value is only reported for water-cooled systems. (The use of the word
Condenser here is taken from cooling operation -- the same device can also be an
evaporator during heating operation.)

9/29/14

1117

Input-Output Reference

Group Variable Refrigerant Flow Equipment

VRF Heat Pump Condenser Heat Transfer Energy [J]

This is the condenser coil heat transfer in Joules. This value is calculated for each HVAC
system time step being simulated, and the results are summed for the time step being
reported. This value is only reported for water-cooled systems. (The use of the word
Condenser here is taken from cooling operation -- the same device can also be an
evaporator during heating operation.)
VRF Heat Pump Maximum Capacity Cooling Rate [W]
This output field is the maximum available terminal unit cooling capacity in Watts allowed for
the current time step being reported. If the terminal units request more capacity than is
actually available from the variable refrigerant flow heat pump, the individual terminal units
will be limited to this value. A maximum limit of 1E+20 is reported when there is sufficient
capacity available to meet all requests from the terminal units. This output variable easily
identifies times when the total terminal unit cooling load exceeds the heat pumps available
cooling capacity.
VRF Heat Pump Maximum Capacity Heating Rate [W]
This output field is the maximum available terminal unit heating capacity in Watts allowed for
the current time step being reported. If the terminal units request more capacity than is
actually available from the variable refrigerant flow heat pump, the individual terminal units
will be limited to this value. A maximum limit of 1E+20 is reported when there is sufficient
capacity available to meet all requests from the terminal units. This output variable easily
identifies times when the total terminal unit heating load exceeds the heat pumps available
heating capacity.
VRF Heat Pump Terminal Unit Cooling Load Rate [W]
This output field is the sum of the terminal unit cooling coil loads in Watts for the current time
step being reported. This value is derived directly from the cooling coils and represents the
total cooling load on the VRF system after piping losses have been accounted for. The total
cooling load will be less than the variable refrigerant flow total cooling capacity reported when
piping losses are modeled (i.e., when piping losses are < 1).
VRF Heat Pump Terminal Unit Heating Load Rate [W]
This output field is the sum of the terminal unit heating coil loads in Watts for the current time
step being reported. This value is derived directly from the heating coils and represents the
total heating load on the VRF system after piping losses have been accounted for. The total
heating load will be less than the variable refrigerant flow total heating capacity reported
when piping losses are modeled (i.e., when piping losses are < 1).
VRF Heat Pump Crankcase Heater Electric Power [W]
This output field is the average electricity consumption rate of the heat pumps crankcase
heaters in Watts for the time step being reported.
VRF Heat Pump Crankcase Heater Electric Energy [J]
This output field is the electricity consumption rate of the heat pumps crankcase heaters in
Joules for the time step being reported. This output is also added to a meter with Resource
Type = Electricity, End Use Key = Cooling, Group Key = System (ref. Output:Meter objects).
VRF Heat Pump Evaporative Condenser Water Use Volume [m3]
This output is the amount of water used to evaporatively cool the condenser coil inlet air, in
cubic meters. This output is also added to a meter with Resource Type = Water, End Use
Key = Cooling, Group Key = System (ref. Output:Meter objects).

9/29/14

1118

Input-Output Reference

Group Variable Refrigerant Flow Equipment

VRF Heat Pump Evaporative Condenser Pump Electric Power [W]

This is the average electricity consumption rate of the evaporative condenser water pump in
Watts for the time step being reported.
VRF Heat Pump Evaporative Condenser Pump Electric Energy [J]
This is the electricity consumption rate of the evaporative condenser water pump in Joules for
the time step being reported. This output is also added to a meter with Resource Type =
Electricity, End Use Key = Cooling, Group Key = System (ref. Output:Meter objects).
VRF Heat Pump Basin Heater Electric Power [W]
This output is the electric consumption rate of the heat pumps basin heater (for
evaporatively-cooled condenser type) in Watts. This basin heater only operates when the
variable refrigerant flow heat pumps compressor(s) is off and therefore is reported as 0
anytime the compressor operates. If the compressor is cycling (see VRF Heat Pump Cycling
Ratio output variable above), the basin heater electric power is proportional to one minus the
cycling ratio of the compressor (i.e., the basin heater is on when the compressor is off).
VRF Heat Pump Basin Heater Electric Energy [J]
This output is the electric consumption of the heat pumps basin heater (for evaporativelycooled condenser type) in Joules. This output is also added to a meter with Resource Type =
Electricity, End Use Key = Cooling, Group Key = System (Ref. Output:Meter objects).
VRF Heat Pump Heat Recovery Status Change Multiplier []
This output applies only when heat recovery is used and represents the multiplier used to
derate the capacity of the system when transitioning from cooling or heating mode to heat
recovery mode. This value is 1 when derating does not apply (i.e., the system has not
recently changed modes to provide heat recovery). Derating during a transition period is
applied according to the inputs for Heat Recovery Fraction and Heat Recovery Time
Constant. To turn transition derating off, set Heat Recovery Fraction to 1. Refer to the
engineering reference document discussion on the variable refrigerant flow heat pump model
section for transition from cooling only mode to heat recovery mode for a more detailed
description.
ZoneTerminalUnitList
The zone terminal unit list defines the names of the terminal units connected to a single
variable refrigerant flow air-conditioning system. The zone terminal unit list is used
exclusively in the variable refrigerant flow (VRF) air conditioner object (ref:
AirConditioner:VariableRefrigerantFlow). Up to 20 terminal units may be connected to a
single VRF outdoor condensing unit. This list is extensible if additional indoor terminal units
are required. The name of this zone terminal unit list object is then input into the
corresponding variable refrigerant flow air conditioner object. The following figure
demonstrates this concept.

9/29/14

1119

Input-Output Reference

Group Radiative / Convective Units

Figure 127. Zone Terminal Unit List Diagram

Field: Zone Terminal List Name
This alpha field specifies the name of the zone terminal unit list. This name must be specified
in the AirConditioner:VariableRefrigerantFlow object.
Field: Zone Terminal Unit Name <x>
This alpha field defines the name of the zone terminal unit used in a variable refrigerant air
conditioner. The zone terminal unit must be connected to a zone using the
ZoneHVAC:EquipmentConnections object. The terminal unit air inlet node is the same name
as a zone exhaust node. The terminal unit air outlet node is the same name as a zone inlet
node. The IDD is supplied with 20 fields for this. The object is extensible and you can
change the IDD by adding more fields or, if you are using text editor for your input file, just
add to the list of names.
Following is an example input for a ZoneTerminalUnitList object.
ZoneTerminalUnitList,
VRF Heat Pump TU List,
TU3,
TU4,
TU1,
TU2,
TU5;

!!!!!!-

Zone
Zone
Zone
Zone
Zone
Zone

Terminal
Terminal
Terminal
Terminal
Terminal
Terminal

Unit
Unit
Unit
Unit
Unit
Unit

List
Name
Name
Name
Name
Name

Name
1
2
3
4
5

Group Radiative / Convective Units

This section describes the radiative/convective zone equipment units. The following units are
included in this section:
ZoneHVAC:Baseboard:Convective:Electric
ZoneHVAC:Baseboard:RadiantConvective:Water
ZoneHVAC:Baseboard:RadiantConvective:Steam
ZoneHVAC:Baseboard:RadiantConvective:Electric
ZoneHVAC:Baseboard:Convective:Water
ZoneHVAC:HighTemperatureRadiant
ZoneHVAC:LowTemperatureRadiant:ConstantFlow
ZoneHVAC:LowTemperatureRadiant:Electric
ZoneHVAC:LowTemperatureRadiant:VariableFlow

9/29/14

1120

Input-Output Reference

Group Radiative / Convective Units

ZoneHVAC:Baseboard:RadiantConvective:Water
The objective of this model is to calculate the convective and radiant heat transfer from water
baseboard heaters to the people and the surfaces within a zone so that surface heat
balances can take into account the radiant heat transfer to the surfaces and thus enhance the
accuracy of thermal comfort predictions within the space. The radiant heat gains are
distributed to the surfaces by fractions defined by user input.
Field: Name
A unique user assigned name for an instance of a hot water baseboard heater unit. Any
reference to this unit by another object will use this name.
Field: Availability Schedule Name
The name of the schedule (ref: Schedule) that denotes whether the hot water baseboard
heater unit can run during a given time period. A schedule value equal to 0 denotes that the
unit must be off for that time period. A value greater than 0 denotes that the unit is available
to operate during that time period. If this field is left blank, the schedule has a value of 1 for all
time periods.
Field: Inlet Node Name
This field is the name of the hot water inlet node for the baseboard heater.
Field: Outlet Node Name
This field is the name of the hot water outlet node for the baseboard heater.
Field: Rated Average Water Temperature
This field is the rated average water temperature for the baseboard heater which is published
in the manufacturers literature in degree Celsius. It typically ranges from 65.56 C to
115.36 C in the I=B=R rating document while the lowest allowable temperature is 32.22 C.
The default value is 87.78 C. If the user does not enter this field, the default value is
assumed.
Field: Rated Water Mass Flow Rate
This field is the rated standard water flow rate in kg/s which is published as part of the
manufacturers literature. It is used by the manufacturers when determining the rated capacity
(see next field). The default value is 0.063kg/s. If it is blank or zero, the default values is
assumed.
Field: Heating Design Capacity Method
Enter the method used to determine the heating design capacity or the method for scalable
sizing. Input allowed is either HeatingDesignCapacity, CapacityPerFloorArea, and
FractionOfAutosizedHeatingCapacity. If this input field is left blank or zero, then autosizing is
assumed. HeatingDesignCapacity means user specifies the magnitude of heating capacity or
the program calculates the design heating capacity if autosize is specified.
CapacityPerFloorArea means the program calculates the design heating capacity from user
specified heating capacity per floor area and floor area of the zone served by the radiant
baseboard unit. FractionOfAutosizedHeatingCapacity means the program calculates the
design heating capacity from user specified fraction and the auto-sized design heating
capacity. The default method is HeatingDesignCapacity.
Field: Heating Design Capacity {W}
This field is the radiant-convective water baseboard rated capacity in watts at a rated water
mass flow rate (see input field Rated Mass Flow Rate). Almost all publications from
manufacturers indicate it as W/m (Btuh per linear foot). The user thus must multiply it by the
active length of the unit. The active length is available in the literature. Manufacturers are
9/29/14

1121

Input-Output Reference

Group Radiative / Convective Units

required to publish the difference between active and total length of the unit (I=B=R rating for
boilers baseboard radiation, 2009).If it is blank or zero, autosizing is assumed. Design day
sizing run must be specified for autosizing.
Field: Heating Design Capacity Per Floor Area {W/m2}
Enter the rated heating capacity per unit floor area of radiant-convective water baseboard unit
in m3/s-m2. This field is required field when the Heating Design Capacity Method is
CapacityPerFloorArea. The program calculates the heating capacity from floor area of the
zone served by the radiant baseboard unit and the heating capacity per unit floor area value
specified by the user. This field may be left blank.
Field: Fraction of Autosized Heating Design Capacity {-}
Enter the heating capacity as a fraction of the autosized heating capacity of radiantconvective water baseboard. This input field is required when the Heating Design Capacity
Method is FractionOfAutosizedHeatingCapacity. The program calculates the heating capacity
from the design autosized heating capacity and user specified fraction. Design day sizing run
must be specified. This field may be left blank. Default value is 1.0.
Field: Maximum Water Flow Rate
This field is the maximum water volumetric flow rate in m 3/sec.
EnergyPlus.

It can be autosized by

Field: Convergence Tolerance

This field is the control tolerance for the unit heating output. The unit is controlled by
matching the unit output to the zone demand. For hot water baseboards, the model must be
numerically inverted to obtain a specified output. The convergence tolerance is the error
tolerance used to terminate the numerical inversion procedure. Basically this is the fraction:

(Qbb,out QZoneLoad )
QZoneLoad

ConvergenceTolerance

The default is 0.001.

Field: Fraction Radiant
This field specifies what fraction of the power input to the baseboard heater is actually
transferred to the space as radiant heat. The fraction should be between 0 and 1. This is the
portion of the total power that is modeled as radiation. The portion that is radiant heat transfer
from the baseboard heater is distributed to people and specific surfaces using the remaining
fields. Note that the sum of the fractions in the remaining fields (people and surfaces) must
equal 1.0 so that all the radiant power is distributed properly. For more information on the
specification of this parameter, please see the Engineering Reference for EnergyPlus.
Field: Fraction of Radiant Energy Incident on People
This field specifies the fraction of radiant portion of heat transfer to the zone from the
baseboard heater that is incident directly on people within the space. This has an impact on
the predicted thermal comfort of the zone occupants. Note that although this energy is
radiant it is actually modeled in the zone heat balance as convective energy (like an internal
gain). The basic assumption here is that most radiant energy falling on people will most likely
be rereleased to the zone air by convection. This is a simplification of reality, but it maintains
the overall energy balance.

9/29/14

1122

Input-Output Reference

Group Radiative / Convective Units

Field Set: Surface Name, Fraction of Radiant Energy to Surface

The following two items are repeated up to a maximum of 20 surface/fraction pairs. At least
one surface/fraction pair must appear in an input file. In other words, at least one surface
must be identified as a recipient of radiant energy from the baseboard heater.
Field: Surface <x> Name
This field is the name of the first surface to which radiant heat transfer from the baseboard
heater is distributed. Used in conjunction with the next field, it helps to define the distribution
of the radiant energy on the surfaces within the zone. Note that up to 20 pairs of surface
names and corresponding fractions may be entered for a single radiant heater system.
Field: Fraction of Radiant Energy to Surface <x>
This field is paired with the preceding surface name (previous field) to define the fraction of
radiant heat transfer leaving the baseboard heater that is incident on a particular surface.
Users should take into account the directionality of baseboard heaters and their location
when defining the value for this input field.
Note on Fraction of Radiant Energy Incident on People and to Surfaces
The radiant energy from the baseboard heater is defined by the total energy input to the
baseboard heater from the water loop times the fraction radiant field shown above. This
radiant energy is distributed to surfaces and people using the surface and fraction pairs and
the fraction to people input by the user. These fractions to people and surfaces must add up
to 1.0. In other words, in an input file, the following relation should be maintained by the user
input:

FractionIndicentOnPeople

FractionToSurfaces 1

An example IDF for the water baseboard is shown below.

ZoneHVAC:Baseboard:RadiantConvective:Water,
SPACE2-1 Baseboard,
!- Baseboard Name
ReheatCoilAvailSched,
!- Availability Schedule Name
SPACE2-1 Zone Coil Water In Node, !- Inlet_Node
SPACE2-1 Zone Coil Water Out Node, !- Outlet_Node
76.67,
!- Average Water Temperature {C}
0.063,
!- Standard Water Mass Flow Rate {Kg/s}
HeatingDesignCapacity,
!- Heating Design Capacity Method
3000.0,
!- Heating Design Capacity{ W }
,
!- Heating Design Capacity Per Floor Area{ W / m2 }
,
!- Fraction of Autosized Heating Design Capacity{ -}
0.0013,
!- Max Water Volumetric Flow Rate {m3/s}
0.001,
!- Convergence Tolerance
0.3,
!- Fraction radiant
0.3,
!- Fraction of radiant energy incident on people
C2-1,
!- Surface 1 Name
0.1,
!- Fraction of radiant energy from heater distributed
F2-1,
!- Surface 2 Name
0.2,
!- Fraction of radiant energy from heater distributed
SB21,
!- surface 3 Name
0.1,
!- fraction of radiant energy from heater distributed
SB23,
!- surface 4 Name
0.1,
!- fraction of radiant energy from heater distributed
SB25,
!- surface 5 Name
0.1,
!- fraction of radiant energy from heater distributed
WR-1,
!- surface 6 Name
0.1;
!- fraction of radiant energy from heater distributed

to surface 1
to surface 2
to surface 3
to surface 4
to surface 5
to surface 6

Baseboard (Water) Radiant Convective (ZoneHVAC) Outputs

HVAC,Average,Baseboard Total Heating Rate [W]
HVAC,Average,Baseboard Convective Heating Rate [W]
9/29/14

1123

Input-Output Reference

Group Radiative / Convective Units

HVAC,Average,Baseboard Radiant Heating Rate [W]

HVAC,Sum,Baseboard Total Heating Energy [J]
HVAC,Sum,Baseboard Total Heating Energy [J]
HVAC,Sum,Baseboard Convective Heating Energy [J]
HVAC,Sum,Baseboard Radiant Heating Energy [J]
HVAC,Meter,Baseboard:EnergyTransfer [J]

Baseboard Total Heating Rate [W]

This is the actual convective heat addition rate of the baseboard to the zone in Watts. This
value includes the heat convected to the zone air from the baseboard unit, the heat radiated
to people in the zone from the baseboard unit, and the additional convection from surfaces
within the zone that have been heated by radiation from the baseboard unit. This value will
be different from (and almost always less than) the next field.
Baseboard Convective Heating Rate [W]
This field reports the rate at which convective heat addition is transferred from the baseboard
to the zone in Watts.
Baseboard Radiant Heating Rate [W]
This field reports the rate at which radiant heat addition is transferred from the baseboard to
the people and the surfaces within the zone in Watts.
Baseboard Total Heating Energy [J]
This is the actual, total convective energy transferred directly and indirectly from the
baseboard to the zone it is serving in Joules. Direct convective heat transfer includes the
convective portion of the baseboard unit. Indirect convective heat transfer includes heat
radiated to people that is then convected to the zone air and heat that is radiated to the
surfaces and then convected to the zone air.
Baseboard Convective Heating Energy [J]
This field reports the amount of convective energy transferred from the baseboard directly to
the zone air in Joules.
Baseboard Radiant Heating Energy [J]
This field reports the amount of radiant energy transferred from the baseboard to the zone in
Joules.
Baseboard Hot Water Mass Flow Rate [kg/s]
This field reports the water mass flow rate at the inlet node of a baseboard unit.
Baseboard Air Mass Flow Rate [kg/s]
This field reports the air mass flow rate at the inlet node of a baseboard unit.
Baseboard Water Inlet Temperature [C]
This field reports the water temperatures at the inlet node of a baseboard unit.
Baseboard Water Outlet Temperature [C]
This field reports the water temperatures at the outlet node of a baseboard unit.
Baseboard Air Inlet Temperature [C]
This field reports the air temperatures at the inlet node of a baseboard unit.
Baseboard Air Outlet Temperature [C]
This field reports the air temperatures at the outlet node of a baseboard unit.

9/29/14

1124

Input-Output Reference

Group Radiative / Convective Units

ZoneHVAC:Baseboard:RadiantConvective:Steam
The objective of this model is to calculate the convective and radiant heat transfer from steam
baseboard heaters to the people and the surfaces within a zone so that surface heat
balances can take into account the radiant heat transfer to the surfaces and thus enhance the
accuracy of thermal comfort predictions within the space. The radiant heat gains are
distributed to the surfaces by fractions defined by the user. Users are requested to provide
degree of sub cooling to estimate the outlet conditions of the condensate.
Field: Name
A unique user assigned name for an instance of a steam baseboard heater unit. Any
reference to this unit by another object will use this name.
Field: Availability Schedule Name
The name of the schedule (ref: Schedule) that denotes whether the steam baseboard heater
unit can run during a given time period. A schedule value equal to 0 denotes that the unit
must be off for that time period. A value greater than 0 denotes that the unit is available to
operate during that time period. If this field is left blank, the schedule has a value of 1 for all
time periods.
Field: Inlet Node Name
This field is the name of the steam inlet node for the baseboard heater.
Field: Outlet Node Name
This field is the name of the steam outlet node for the baseboard heater.
Field: Heating Design Capacity Method
Enter the method used to determine the heating design capacity for scalable sizing. Input
allowed is either HeatingDesignCapacity, CapacityPerFloorArea, and
FractionOfAutosizedHeatingCapacity. If this input field is left blank or zero, then autosizing is
assumed. HeatingDesignCapacity means user specifies the magnitude of maximum heating
capacity or the program calculates the maximum design heating capacity if autosize is
specified. CapacityPerFloorArea means the program calculates the design heating capacity
from user specified heating capacity per floor area and floor area of the zone served by the
radiant baseboard unit. FractionOfAutosizedHeatingCapacity means the program calculates
the design heating capacity from user specified fraction and the auto-sized design heating
capacity. The default method is HeatingDesignCapacity.
Field: Heating Design Capacity {W}
This field is for the a radiant/convective steam baseboard unit heating capacity in watts. This
field can be autosized by EnergyPlus. When the Heating Design Capacity Method is
HeatingDesignCapacity and this input is is blank, autosizing is assumed. Design day sizing
run must be specified.
Field: Heating Design Capacity Per Floor Area {W/m2}
Enter the heating capacity per unit floor area in m3/s-m2 of radiant/convective steam
baseboard. This field is required field when the Heating Design Capacity Method is
CapacityPerFloorArea. The program calculates the heating capacity from floor area of the
zone served by the steam baseboard unit and the heating capacity per unit floor area value
specified by the user. This field may be left blank.
Field: Fraction of Autosized Heating Design Capacity {-}
Enter the heating capacity as a fraction of the autosized heating capacity of a
radiant/convective steam baseboard unit. This input field is required when the Heating Design
Capacity Method is FractionOfAutosizedHeatingCapacity. The program calculates the
9/29/14

1125

Input-Output Reference

Group Radiative / Convective Units

heating capacity from the design autosized heat capacity and user specified fraction. Design
day sizing run must be specified. This field may be left blank. Default value is 1.0.
Field: Degree of SubCooling
This field is the temperature drop of the condensate in the coil of the baseboard heater. The
steam condensates in the coil and changes the phase to the water, giving up the latent heat
of steam to the air in the steam to air heat exchanger. The condensate due to the phase
change then cools by certain degree in the coil, so that this amount of heat is added to the
zone. The minimum value is 1.0 Celsius and default is 5.0 Celsius.
Field: Maximum Steam Flow Rate
This field is the maximum steam volumetric flow rate in m3/s through the steam baseboard
heater. The steam volumetric flow rate is calculated at 100C and 101325 Pa. It can be
autosized by EnergyPlus.
Field: Convergence Tolerance
This field is the control tolerance for the unit heating output. The unit is controlled by
matching the unit output to the zone demand. For steam baseboards, the model must be
numerically inverted to obtain a specified output. The convergence tolerance is the error
tolerance used to terminate the numerical inversion procedure. Basically this is the fraction:

(Qbb,out QZoneLoad )
QZoneLoad

ConvergenceTolerance

The default is 0.001.

Field: Fraction Radiant
This field specifies what fraction of the power input to the baseboard heater is actually
transferred to the space as radiant heat. The fraction should be between 0 and 1. This is the
portion of the total power that is modeled as radiation. The portion that is radiant heat transfer
from the baseboard heater is distributed to people and specific surfaces using the remaining
fields. Note that the sum of the fractions in the remaining fields (people and surfaces) must
equal 1.0 so that all the radiant power is distributed properly.
Field: Fraction of Radiant Energy Incident on People
This field specifies the fraction of radiant portion of heat transfer to the zone from the
baseboard heater that is incident directly on people within the space. This has an impact on
the predicted thermal comfort of the zone occupants. Note that although this energy is
radiant it is actually modeled in the zone heat balance as convective energy (like an internal
gain). The basic assumption here is that most radiant energy falling on people will most likely
be rereleased to the zone air by convection. This is a simplification of reality, but it maintains
the overall energy balance.
Field Set: Surface Name, Fraction of Radiant Energy to Surface
The following two items are repeated up to a maximum of 20 surface/fraction pairs. At least
one surface/fraction pair must appear in an input file. In other words, at least one surface
must be identified as a recipient of radiant energy from the baseboard heater.
Field: Surface <x> Name
This field is the name of the first surface to which radiant heat transfer from the baseboard
heater is distributed. Used in conjunction with the next field, it helps to define the distribution
of the radiant energy on the surfaces within the zone. Note that up to 20 pairs of surface
names and corresponding fractions may be entered for a single radiant heater system.

9/29/14

1126

Input-Output Reference

Group Radiative / Convective Units

Field: Fraction of Radiant Energy to Surface <x>

This field is paired with the preceding surface name (previous field) to define the fraction of
radiant heat transfer leaving the baseboard heater that is incident on a particular surface.
Users should take into account the directionality of baseboard heaters and their location
when defining the value for this input field.
Note on Fraction of Radiant Energy Incident on People and to Surfaces
The radiant energy from the baseboard heater is defined by the total energy input to the
baseboard heater from the steam loop times the fraction radiant field shown above. This
radiant energy is distributed to surfaces and people using the surface and fraction pairs and
the fraction to people input by the user. These fractions to people and surfaces must add up
to 1.0. In other words, in an input file, the following relation should be maintained by the user
input:

FractionIncidentOnPeople

FractionToSurfaces 1

An example IDF for the steam baseboard is shown below.

ZoneHVAC:Baseboard:RadiantConvective:Steam,
Zone1Baseboard,
!- Baseboard name
FanAndCoilAvailSched, !- On/off schedule
Steam Inlet Node,
!- Steam inlet node
Steam Outlet Node,
!- Steam outlet node
HeatingDesignCapacity,!- Heating Design Capacity Method
autosize,
!- Heating Design Capacity{ W }
,
!- Heating Design Capacity Per Floor Area{ W / m2 }
,
!- Fraction of Autosized Heating Design Capacity{ -}
5.0,
!- Degree of sub cooling in the coil {C}
autosize,
!- Maximum steam volumetric flow rate {m3/s}
0.001,
!- Tolerance
0.3,
!- Fraction radiant
0.3,
!- Fraction of radiant energy that is incident directly on people
OuterWall,
!- Surface 1 Name
0.4,
!- Fraction of radiant energy from heater distributed to surface 1
Ceiling,
!- Surface 2 Name
0.1,
!- Fraction of radiant energy from heater distributed to surface 2
InnerWall,
!- Surface 3 Name
0.1,
!- Fraction of radiant energy from heater distributed to surface 3
Floor,
!- Surface 4 Name
0.1;
!- Fraction of radiant energy from heater distributed to surface 4

Baseboard (Steam) Radiant Convective (ZoneHVAC) Outputs

HVAC,Average,Baseboard Total Heating Rate [W]
HVAC,Average,Baseboard Convective Heating Rate [W]
HVAC,Average,Baseboard Radiant Heating Rate [W]
HVAC,Sum,Baseboard Total Heating Energy [J]
HVAC,Sum,Baseboard Convective Heating Energy [J]
HVAC,Sum,Baseboard Radiant Heating Energy [J]
HVAC,Meter,Baseboard:EnergyTransfer [J]
HVAC,Average,Baseboard Steam Mass Flow Rate [kg/s]
HVAC,Average,Baseboard Steam Inlet temperature [C]
HVAC,Average,Baseboard Steam Outlet temperature [C]

Baseboard Total Heating Rate [W]

This is the actual convective heat addition rate of the baseboard to the zone in Watts. This
value includes the heat convected to the zone air from the baseboard unit, the heat radiated
to people in the zone from the baseboard unit, and the additional convection from surfaces
within the zone that have been heated by radiation from the baseboard unit. This value will be
different from (and almost always less than) the next field.

9/29/14

1127

Input-Output Reference

Group Radiative / Convective Units

Baseboard Convective Heating Rate [W]

This field reports the rate at which convective heat addition is transferred from the baseboard
to the zone in Watts.
Baseboard Radiant Heating Rate [W]
This field reports the rate at which radiant heat addition is transferred from the baseboard to
the people and the surfaces within the zone in Watts.
Baseboard Total Heating Energy [J]
This is the actual, total convective energy transferred directly and indirectly from the
baseboard to the zone it is serving in Joules. Direct convective heat transfer includes the
convective portion of the baseboard unit. Indirect convective heat transfer includes heat
radiated to people that is then convected to the zone air and heat that is radiated to the
surfaces and then convected to the zone air.
Baseboard Convective Heating Energy [J]
This field reports the amount of convective energy transferred from the baseboard directly to
the zone air in Joules.
Baseboard Radiant Heating Energy [J]
This field reports the amount of radiant energy transferred from the baseboard to the zone in
Joules.
Baseboard Steam Energy [J]
Baseboard Steam Rate [W]
These are the total heat addition energy and rate of steam used by the baseboard to heat the
zone it is serving in Joules and Watts.
Baseboard Steam Mass Flow Rate [kg/s]
This field reports the steam mass flow rate at the inlet node of a baseboard unit.
Baseboard Steam Inlet Temperature [C]
This field reports the steam temperatures at the inlet node of a baseboard unit.
Baseboard Steam Outlet Temperature [C]
This field reports the steam temperatures at the outlet node of a baseboard unit.
ZoneHVAC:Baseboard:RadiantConvective:Electric
The electric baseboard heater is a component in the zone equipment simulation. Heat from
this device is radiated to people and surfaces and also convected to the surrounding air. The
electric baseboard model includes the impact of the radiant heat addition to people and
surfaces so that the thermal comfort and surface heat balances are impacted. The
component is controlled to meet any remaining zone load not met by other equipment
baseboard operates to meet the remaining zone load and the total electric consumption is
calculated by dividing by the efficiency of the baseboard.
Field: Name
A unique user assigned name for an instance of an electric baseboard heater unit. Any
reference to this unit by another object will use this name.
Field: Availability Schedule Name
The name of the schedule (ref: Schedule) that denotes whether the electric baseboard heater
unit can run during a given time period. A schedule value greater than 0 (usually 1 is used)
indicates that the unit can be on during the time period. A value less than or equal to 0
9/29/14

1128

Input-Output Reference

Group Radiative / Convective Units

(usually 0 is used) denotes that the unit will be off for the time period. If this field is blank, the
schedule has values of 1 for all time periods.
Field: Heating Design Capacity Method
Enter the method used to determine the heating design capacity for scalable sizing. Input
allowed is either HeatingDesignCapacity, CapacityPerFloorArea, and
FractionOfAutosizedHeatingCapacity. If this input field is left blank or zero, then autosizing is
assumed. HeatingDesignCapacity means user specifies the magnitude of maximum or
nominal heating capacity or the program calculates the maximum or nominal design heating
capacity if autosize is specified. CapacityPerFloorArea means the program calculates the
design heating capacity from user specified heating capacity per floor area and floor area of
the zone served by the radiant baseboard unit. FractionOfAutosizedHeatingCapacity means
the program calculates the design heating capacity from user specified fraction and the autosized design heating capacity. The default method is HeatingDesignCapacity.
Field: Heating Design Capacity {W}
This field is for the radiant-convective electric baseboard unit nominal heating capacity in
watts. This field can be autosized by EnergyPlus. This input field is autosizable. When the
Heating Design Capacity Method is HeatingDesignCapacity and this input is is blank,
autosizing is assumed. Design day sizing run must be specified.
Field: Heating Design Capacity Per Floor Area {W/m2}
Enter the heating capacity per unit floor area in m3/s-m2 of radiant/convective electric
baseboard. This field is required field when the Heating Design Capacity Method is
CapacityPerFloorArea. The program calculates the heating capacity from floor area of the
zone served by the radiant baseboard unit and the heating capacity per unit floor area value
specified by the user. This field may be left blank.
Field: Fraction of Autosized Heating Design Capacity {-}
Enter the heating capacity as a fraction of the autosized heating capacity for
radiant/convective electric baseboard. This input field is required when the Heating Design
Capacity Method is FractionOfAutosizedHeatingCapacity. The program calculates the
heating capacity from the design autosized heat capacity and user specified fraction. Design
day sizing run must be specified. This field may be left blank. Default value is 1.0.
Field: Efficiency
This is the overall electrical efficiency of the electric baseboard unit. The zone load met by
this unit is divided by the electrical efficiency to obtain the total electric energy used.
Field: Fraction Radiant
This field specifies what fraction of the power input to the baseboard heater is actually
transferred to the space as radiant heat. The fraction should be between 0 and 1. This is the
portion of the total power that is modeled as radiation. The portion that is radiant heat transfer
from the baseboard heater is distributed to people and specific surfaces using the remaining
fields. Note that the sum of the fractions in the remaining fields (people and surfaces) must
equal 1.0 so that all the radiant power is distributed properly.
Field: Fraction of Radiant Energy Incident on People
This field specifies the fraction of the radiant portion of heat transfer to the zone from the
baseboard heater that is incident directly on people within the space. This has an impact on
the predicted thermal comfort of the zone occupants. Note that although this energy is
radiant it is actually modeled in the zone heat balance as a convective energy (like an
internal gain). The basic assumption here is that radiant energy falling on people will most
likely be rereleased to the zone air by convection. This is a simplification of reality, but it
maintains the overall energy balance.
9/29/14

1129

Input-Output Reference

Group Radiative / Convective Units

Field Set: Surface Name, Fraction of Radiant Energy to Surface

The following two items are repeated up to a maximum of 20 surface/fraction pairs. At least
one surface/fraction pair must appear in an input file. In other words, at least one surface
must be identified as a recipient of radiant energy from the baseboard heater.
Field Set: Surface <x> Name
This field is the name of the first surface to which radiant heat transfer from the baseboard
heater is distributed. Used in conjunction with the next field, it helps to define the distribution
of the radiant energy on the surfaces within the zone. Note that up to 20 pairs of surface
names and corresponding fractions may be entered for a single radiant heater system.
Field Set: Fraction of Radiant Energy to Surface <x>
This field is paired with the preceding surface name (previous field) to define the fraction of
radiant heat transfer leaving the baseboard heater that is incident on a particular surface.
Users should take into account the directionality of baseboard heaters and their location
when defining the value for this input field.
Note on Fraction of Radiant Energy Incident on People and to Surfaces
The radiant energy from the baseboard heater is defined by the total energy input to the
baseboard heater times the fraction radiant field shown above. This radiant energy is
distributed to surfaces and people using the surface and fraction pairs and the fraction to
people input by the user. These fractions to people and surfaces must add up to 1.0. In other
words, in an input file, the following relation should be maintained by the user input:

FractionIndicentOnPeople

FractionToSurfaces 1

Below is an example input for an Electric Baseboard Heater.

9/29/14

1130

Input-Output Reference

Group Radiative / Convective Units

ZoneHVAC:Baseboard:RadiantConvective:Electric,
Baseboard 1,
!- Name
BB Schedule,
!- Availability Schedule Name
HeatingDesignCapacity,
!- Heating Design Capacity Method
5000,
!- Heating Design Capacity{ W }
,
!- Heating Design Capacity Per Floor Area{ W / m2 }
,
!- Fraction of Autosized Heating Design Capacity{ -}
0.97,
!- Efficiency of the baseboard
0.3,
!- Fraction radiant
0.3,
!- Fraction of radiant energy that is incident directly on people
EastWall,
!- Surface 1 name
0.3,
!- Fraction of radiant energy from heater distributed to surface 1
WestWall,
!- Surface 2 name
0.1,
!- Fraction of radiant energy from heater distributed to surface 2
NorthWall,
!- Surface 3 name
0.1,
!- Fraction of radiant energy from heater distributed to surface 3
SouthWall,
!- Surface 4 name
0.1,
!- Fraction of radiant energy from heater distributed to surface 4
Ceiling,
!- Surface 5 name
0.1;
!- Fraction of radiant energy from heater distributed to surface 5

Baseboard (Electric) Radiant Convective (ZoneHVAC) Outputs

HVAC,Average,Baseboard Total Heating Rate [W]
HVAC,Average,Baseboard Radiant Heating Rate [W]
HVAC,Average,Baseboard Convective Heating Rate [W]
HVAC,Average,Baseboard Electric Power[W]
HVAC,Sum,Baseboard Total Heating Energy [J]
HVAC,Sum,Baseboard Radiant Heating Energy [J]
HVAC,Sum,Baseboard Convective Heating Energy [J]
HVAC,Sum,Baseboard Electric Energy [J]
HVAC,Meter,Baseboard:EnergyTransfer [J]
HVAC,Meter,Heating:Electricity[J]

Baseboard Total Heating Rate [W]

This is the actual convective heat addition rate of the baseboard to the zone in Watts. This
value includes the heat convected to the zone air from the baseboard unit, the heat radiated
to people in the zone from the baseboard unit, and the additional convection from surfaces
within the zone that have been heated by radiation from the baseboard unit. This value will be
different from (and almost always less than) the next field.
Baseboard Radiant Heating Rate [W]
This field reports the rate at which radiant heat addition is transferred from the baseboard to
the people and the surfaces within the zone in Watts.
Baseboard Convective Heating Rate [W]
This field reports the rate at which convective heat addition is transferred from the baseboard
to the zone in Watts.
Baseboard Electric Energy [J]
This is the electric energy used by the baseboard in Joules.
Baseboard Electric Power [J]
This is the electric power required by the baseboard to heat the zone it is serving in Watts
Baseboard Total Heating Energy [J]
This is the actual convective energy transferred directly and indirectly from the baseboard
heater to the zone it is serving in Joules. Direct convective heat transfer includes the
convective portion of the baseboard unit. Indirect convective heat transfer includes heat
radiated to people that is then convected to the zone air and heat that is radiated to the
surfaces and then convected to the zone air.

9/29/14

1131

Input-Output Reference

Group Radiative / Convective Units

Baseboard Radiant Heating Energy [J]

This field reports the amount of radiant energy transferred from the baseboard to the zone in
Joules.
Baseboard Convective Heating Energy [J]
This field reports the amount of convective energy transferred from the baseboard directly to
the zone air in Joules.
ZoneHVAC:Baseboard:Convective:Water
The hot water baseboard heater is a component of zone equipment. The component is
controlled to meet any remaining zone load not met by other equipment in the zone that have
higher heating priority. The control is accomplished by throttling the hot water flow. Input
resembles that for the simple heating coil: there is an availability schedule, an overall UA, and
a maximum hot water mass flow rate. The unit is connected to a hot water loop (demand
side) with an inlet and outlet node. Finally, there is the convergence tolerance, which is the
tolerance on how closely the baseboard outlet will meet the zone load. Of course, this
tolerance is relative to the zone load.
Field: Name
A unique user assigned name for an instance of a hot water baseboard heater unit. Any
reference to this unit by another object will use this name.
Field: Availability Schedule Name
The name of the schedule (ref: Schedule) that denotes whether the hot water baseboard
heater unit can run during a given time period. A schedule value greater than 0 (usually 1 is
used) indicates that the unit can be on during the time period. A value less than or equal to 0
(usually 0 is used) denotes that the unit must be off for the time period. If this field is blank,
the schedule has values of 1 for all time periods.
Field: Inlet Node Name
The name of the hot water inlet node for the baseboard heater.
Field: Outlet Node Name
The name of the hot water outlet node for the baseboard heater.
Field: Heating Design Capacity Method
Enter the method used to determine the heating design capacity for scalable sizing. Input
allowed is either HeatingDesignCapacity, CapacityPerFloorArea, and
FractionOfAutosizedHeatingCapacity. If this input field is left blank or zero, then autosizing is
assumed. HeatingDesignCapacity means user specifies the magnitude of maximum or
nominal heating capacity or the program calculates the maximum or nominal design heating
capacity if autosize is specified. CapacityPerFloorArea means the program calculates the
design heating capacity from user specified heating capacity per floor area and floor area of
the zone served by the hot water baseboard heater. FractionOfAutosizedHeatingCapacity
means the program calculates the design heating capacity from user specified fraction and
the auto-sized design heating capacity. The default method is HeatingDesignCapacity.
Field: Heating Design Capacity {W}
This field is for the hot water baseboard heater design heating capacity in watts. This field
can be autosized by EnergyPlus. This input field is autosizable. When the Heating Design
Capacity Method is HeatingDesignCapacity and this input is is blank, autosizing is assumed.
Design day sizing run must be specified id autosize is specified.

9/29/14

1132

Input-Output Reference

Group Radiative / Convective Units

Field: Heating Design Capacity Per Floor Area {W/m2}

Enter the heating capacity per unit floor area in m3/s-m2 of hot water baseboard heater. This
field is required field when the Heating Design Capacity Method is CapacityPerFloorArea.
The program calculates the heating capacity from floor area of the zone served by hot water
baseboard heater and the heating capacity per unit floor area value specified by the user.
This field may be left blank.
Field: Fraction of Autosized Heating Design Capacity {-}
Enter the heating capacity as a fraction of the autosized heating capacity for the hot water
baseboard heater. This input field is required when the Heating Design Capacity Method is
FractionOfAutosizedHeatingCapacity. The program calculates the heating capacity from the
design autosized heat capacity and user specified fraction. Design day sizing run must be
specified. This field may be left blank. Default value is 1.0.
Field: U-Factor Times Area Value
The overall heat transfer coefficient for the baseboard heater in watts per degree Celsius at
design conditions. The U-Factor Times Area Value (UA) is used in an NTU - effectiveness
calculation. An estimate of the UA can be obtained from:

q UA (Twater ,avg Tair ,avg )

where q is the heat transferred from water to the air in watts; T water, avg is the average water
temperature in degrees C; and Tair, avg is the average air temperature in degrees C. Or the
LMTD temperature difference can be used.
Field: Maximum Water Flow Rate
The maximum hot water volumetric flow rate in m 3/sec.
Field Convergence Tolerance
The control tolerance for the unit heating output. The unit is controlled by matching the unit
output to the zone demand. For hot water baseboards, the model must be numerically
inverted to obtain a specified output. The convergence tolerance is the error tolerance used
to terminate the numerical inversion procedure. Basically this is the fraction:

(Qbb,out QZoneLoad )
QZoneLoad

ConvergenceTolerance

The default is 0.001.

An example IDF for the hot water convective baseboard is shown below.

9/29/14

1133

Input-Output Reference

Group Radiative / Convective Units

ZoneHVAC:Baseboard:Convective:Water,
Zone3Baseboard, ! name
FanAndCoilAvailSched, ! on/off schedule
Zone 3 Reheat Water Inlet Node, ! water inlet node
Zone 3 Reheat Water Outlet Node, ! water outlet node
HeatingDesignCapacity, !- Heating Design Capacity Method
autosize,!- Heating Design Capacity{ W }
,
!- Heating Design Capacity Per Floor Area{ W / m2 }
,
!- Fraction of Autosized Heating Design Capacity{ -}
500.,
! UA
0.0013, ! maximum water flow rate m3/s
0.001;
! tolerance

Baseboard (Water) Convective (ZoneHVAC) Outputs

HVAC,Average,Baseboard Total Heating Rate [W]
HVAC,Sum,Baseboard Total Heating Energy [J]
HVAC,Sum,Baseboard Hot Water Energy [J]
HVAC,Average,Baseboard Hot Water Mass Flow Rate [kg/s]
HVAC,Average,Baseboard Air Mass Flow Rate [kg/s]
HVAC,Average,Baseboard Air Inlet Temperature [C]
HVAC,Average,Baseboard Air Outlet Temperature [C]
HVAC,Average,Baseboard Water Inlet Temperature [C]
HVAC,Average,Baseboard Water Outlet Temperature [C]

Baseboard Total Heating Rate [W]

This is the heat addition rate of the convective baseboard to the zone it is serving in Watts.
Baseboard Total Heating Energy [J]
This is the heat addition of the convective baseboard to the zone it is serving in Joules over
the timestep being reported.
Baseboard Hot Water Energy [J]
This is the energy in the hot water used by the baseboard to heat the zone, in Joules.
Baseboard Hot Water Mass Flow Rate [kg/s]
This field reports the water mass flow rate at the inlet node of a baseboard unit.
Baseboard Air Mass Flow Rate [kg/s]
This field reports the air mass flow rate at the inlet node of a baseboard unit.
Baseboard Water Inlet Temperature [C]
This field reports the water temperatures at the inlet node of a baseboard unit.
Baseboard Water Outlet Temperature [C]
This field reports the water temperatures at the outlet node of a baseboard unit.
Baseboard Air Inlet Temperature [C]
This field reports the air temperatures at the inlet node of a baseboard unit.
Baseboard Air Outlet Temperature [C]
This field reports the air temperatures at the outlet node of a baseboard unit.
ZoneHVAC:Baseboard:Convective:Electric
The electric baseboard heater is a component in the zone equipment simulation. The
component is controlled to meet any remaining zone load not met by other equipment in the

9/29/14

1134

Input-Output Reference

Group Radiative / Convective Units

zone that have higher heating priority. The control is accomplished by taking the remaining
zone load and dividing by the efficiency of the baseboard.
Field: Name
A unique user assigned name for an instance of a electric baseboard heater unit. Any
reference to this unit by another object will use this name.
Field: Availability Schedule Name
The name of the schedule (ref: Schedule) that denotes whether the electric baseboard heater
unit can run during a given time period. A schedule value greater than 0 (usually 1 is used)
indicates that the unit can be on during the time period. A value less than or equal to 0
(usually 0 is used) denotes that the unit must be off for the time period. If this field is blank,
the schedule has values of 1 for all time periods.
Field: Heating Design Capacity Method
Enter the method used to determine the heating design capacity or enter the method for
scalable sizing of heating capacity of electric baseboard unit. Input allowed is either
HeatingDesignCapacity, CapacityPerFloorArea, and FractionOfAutosizedHeatingCapacity. If
this input field is left blank or zero, then autosizing is assumed. HeatingDesignCapacity
means user specifies the magnitude of maximum or nominal heating capacity or the program
calculates the maximum or nominal design heating capacity if autosize is specified.
CapacityPerFloorArea means the program calculates the design heating capacity from user
specified heating capacity per floor area and floor area of the zone served by the electric
convective baseboard unit. FractionOfAutosizedHeatingCapacity means the program
calculates the design heating capacity from user specified fraction and the auto-sized design
heating capacity. The default method is HeatingDesignCapacity.
Field: Heating Design Capacity {W}
This field is for the convective electric baseboard nominal heating capacity in watts. This field
can be autosized by EnergyPlus. This input field is autosizable. Design day sizing run must
be specified. This input field may be left blank.
Field: Heating Design Capacity Per Floor Area {W/m2}
Enter the heating capacity per unit floor area in m3/s-m2 of electric convective baseboard
unit. This field is required field when the Heating Design Capacity Method is
CapacityPerFloorArea. The program calculates the heating capacity from floor area of the
zone served by the electric convective baseboard unit and the heating capacity per unit floor
area value specified by the user. This field may be left blank.
Field: Fraction of Autosized Heating Design Capacity {-}
Enter the heating capacity as a fraction of the autosized heating capacity for convective
electric baseboard unit. This input field is required when the Heating Design Capacity Method
is FractionOfAutosizedHeatingCapacity. The program calculates the heating capacity from
the design autosized heating capacity and user specified fraction. Design day sizing must be
specified. This field may be left blank. Default value is 1.0.
Field: Efficiency
This is the overall electrical efficiency of the electric baseboard. The zone load met by this
unit is divided by the electrical efficiency to obtain the total electric energy used.
An example IDF for the electric convective baseboard is shown below.

9/29/14

1135

Input-Output Reference

Group Radiative / Convective Units

ZoneHVAC:Baseboard:Convective:Electric,
Zone1Baseboard, !- Baseboard Name
FanAndCoilAvailSched, !- Availability Schedule Name
HeatingDesignCapacity,
!- Heating Design Capacity Method
5000,
!- Heating Design Capacity{ W }
,
!- Heating Design Capacity Per Floor Area{ W / m2 }
,
!- Fraction of Autosized Heating Design Capacity{ -}
0.97; !- Efficiency of the BaseBoard

Baseboard (Electric) Convective (ZoneHVAC) Outputs

HVAC,Average,Baseboard Total Heating Rate [W]
HVAC,Sum,Baseboard Total Heating Energy [J]
HVAC,Meter,Baseboard:EnergyTransfer [J]
HVAC,Sum,Baseboard Electric Energy [J]
HVAC,Average,Baseboard Electric Power[W]
HVAC,Meter,Heating:Electricity[J]

Baseboard Total Heating Rate [W]

This is the heat addition rate of the electric convective baseboard to the zone it is serving in
Watts.
Baseboard Total Heating Energy [J]
This is the heat addition of the convective baseboard to the zone it is serving in Joules over
the timestep being reported.
Baseboard Electric Energy [J]
This is the total electric consumption of the baseboard for the zone it is serving in Joules over
the timestep being reported.
Baseboard Electric Power [W]
This is the electric power required by the baseboard to the zone it is serving in Watts.
ZoneHVAC:LowTemperatureRadiant:VariableFlow
This low temperature radiant system (hydronic) is a component of zone equipment that is
intended to model any radiant system where water is used to supply/remove energy to/from
a building surface (wall, ceiling, or floor). The component is controlled to meet any remaining
zone load not met by other equipment in the zone that have higher priority. The control is
accomplished by throttling the hot or chilled water flow to the unit. Note that this system will
only control based on the radiant system controls defined by this input syntax and not via a
zone thermostat such as is used for forced air systems. Note also that because this unit does
not require a thermostat that in cases where no other systems are serving the zone in which
this system resides that it will use the heating equipment priority to determine which system
will run first. If the radiant system is serving a zone with forced air equipment, the radiant
system will follow the priority order established by the zone thermostat but will still base its
response on the controls defined by the user for the radiant system.
This model covers a wide range of low temperature radiant systems: heating and/or cooling,
panel or embedded pipes, etc. It is not intended to simulate high temperature electric or gas
radiant heaters. Those devices will be handled by a separate model and different input
syntax. Low temperature radiant systems that use electric resistance heating should also be
defined using separate input syntax (ref: ZoneHVAC:LowTemperatureRadiant:Electric).
Field: Name
This field is an unique user assigned name for an instance of a hydronic low temperature
radiant system. Any reference to this unit by another object will use this name.

9/29/14

1136

Input-Output Reference

Group Radiative / Convective Units

Field: Availability Schedule Name

This field is the name of the schedule (ref: Schedule) that denotes whether the hydronic low
temperature radiant system can run during a given time period. A schedule value less than or
equal to 0 (usually 0 is used) denotes that the unit must be off for that time period. A value
greater than 0 (usually 1 is used) denotes that the unit is available to operate during that time
period. If this field is left blank, the schedule has a value of 1 for all time periods.
Field: Zone Name
This field is the name of the zone (Ref: Zone) in which the hydronic low temperature radiant
system is principally located and intended to affect. A system that is between two zones will
still act upon each zone; however, the zone name referenced here should be the zone that
controls the radiant system response.
Field: Surface Name or Radiant Surface Group Name
This field is the name of the surface (Ref: BuildingSurface) or surface list (Ref:
ZoneHVAC:LowTemperatureRadiant:SurfaceGroup) in which the hydronic tubing is
embedded/contained. This specification attaches the source or sink from the radiant system
to a particular surface and the contribution of the system to the heat balances of that surface.
If this field is a surface list, then the source or sink is attached to all of the surfaces in the list
with the radiant system surface group defining the breakdown of how flow rate is split
between the various surfaces. Only base surfaces (e.g., BuildingSurface:Detailed) are valid.
Window/Door surfaces and Internal Mass are not valid surface types for embedded radiant
systems.
Field: Hydronic Tubing Inside Diameter
This field is the inside diameter of the tubes through which water is circulated for the system
being defined by this statement. The inside diameter should be recorded in meters and is
used to determine the convective heat transfer from the water to the inside surface of the
hydronic tubing.
Field: Hydronic Tubing Length
This field is the total length of pipe embedded in the surface named above in the surface
name field. The length of the tube should be entered in meters and is used to determine the
effectiveness of heat transfer from the fluid being circulated through the tubes and the
tube/surface. Longer tubing lengths result in more heat will be transferred to/from the radiant
surface to the circulating fluid. Note that if the user elects to autosize this field that a standard
zone thermostat such as would be used for a forced air system must be defined as autosizing
calculations are based on the zone thermostat value and not on the radiant system control
values.
Field: Temperature Control Type
This field specifies along with the throttling range and setpoint schedules how the user
wishes to control the hydronic radiant system. The temperature denoted in the setpoint
schedule can refer to one of five different temperatures: the zone mean air temperature, the
zone mean radiant temperature, the zone operative temperature, the outdoor dry-bulb
temperature, or the outdoor wet-bulb temperature. The choice of temperature is controlled by
the current fieldtemperature control type. The user must select from the following options:
MeanAirTemperature
MeanRadiantTemperature
OperativeTemperature
OutdoorDryBulbTemperature
OutdoorWetBulbTemperature

Operative temperature for radiant system controls is the average of Mean Air Temperature
and Mean Radiant Temperature. If the user does not select a control type,

9/29/14

1137

Input-Output Reference

Group Radiative / Convective Units

MeanAirTemperature control is assumed by EnergyPlus. See the throttling range and

control temperature schedule fields below for more information.
Field: Heating Design Capacity Method
Enter the method used to determine the heating design capacity for scalable sizing. Input
allowed is either HeatingDesignCapacity, CapacityPerFloorArea, and
FractionOfAutosizedHeatingCapacity. If this input field is left blank or zero, then autosizing is
assumed. HeatingDesignCapacity means user specifies the magnitude of maximum or
nominal heating capacity or the program calculates the design heating capacity if autosize is
specified. CapacityPerFloorArea means the program calculates the design heating capacity
from user specified heating capacity per floor area and floor area of the zone served by the
low temperature radiant variable flow unit. FractionOfAutosizedHeatingCapacity means the
program calculates the design heating capacity from user specified fraction and the autosized design heating capacity. The default method is HeatingDesignCapacity.
Field: Heating Design Capacity {W}
This field is for the low temperature radiant variable flow unit design heating capacity in watts.
This field can be autosized by EnergyPlus. This input field is autosizable. When the Heating
Design Capacity Method is HeatingDesignCapacity and this input is is blank, autosizing is
assumed. Design day sizing run must be specified if autosized.
Field: Heating Design Capacity Per Floor Area {W/m2}
Enter the heating capacity per unit floor area in m3/s-m2 of low temperature radiant variable
flow unit. This field is required field when the Heating Design Capacity Method is
CapacityPerFloorArea. The program calculates the heating capacity from floor area of the
zone served by the low temperature radiant variable flow unit and the heating capacity per
unit floor area value specified by the user. This field may be left blank.
Field: Fraction of Autosized Heating Design Capacity {-}
Enter the heating capacity as a fraction of the autosized heating capacity for low temperature
radiant variable flow unit. This input field is required when the Heating Design Capacity
Method is FractionOfAutosizedHeatingCapacity. The program calculates the heating capacity
from the design autosized heat capacity and user specified fraction. Design day sizing run
must be specified. This field may be left blank. Default value is 1.0.
Field: Maximum Hot Water Flow
This field is the maximum flow rate of hot water through the radiant system in m3/sec. The
controls for the radiant system will vary the flow rate of hot water through the surface using
zero flow and the maximum flow rate specified in this field as the lower and upper bounds,
respectively. Note that if the user elects to autosize this field that a standard zone thermostat
such as would be used for a forced air system must be defined as autosizing calculations are
based on the zone thermostat value and not on the radiant system control values.
Field: Heating Water Inlet Node Name
This field contains the name of the hot water inlet node to the radiant system. Note that this
node name must also show up in the branch description when defining the plant demand side
network in a manner identical to defining a heating coil.
Field: Heating Water Outlet Node Name
This field contains the name of the hot water oulet node to the radiant system. Note that this
node name must also show up in the branch description when defining the plant demand side
network in a manner identical to defining a heating coil.

9/29/14

1138

Input-Output Reference

Group Radiative / Convective Units

Field: Heating Control Throttling Range

This field specifies the range of temperature in degrees Celsuis over which the radiant
system throttles from zero flow rate up to the maximum defined by the maximum hot water
flow rate field described above. The throttling range parameter is used in conjunction with the
control temperature to define the response of the system to various zone conditions. The
heating control temperature schedule specifies the setpoint temperature where the flow rate
to the system is at half of the maximum flow rate. For example, if the heating control
temperature setpoint is currently 15 C and the heating throttling range is 2 C, the water flow
rate to the radiant system will be zero when the controlling temperature (MAT, MRT,
Operative Temperature, ODB, or OWB; see control type field above) is at or above 16 C and
the maximum flow rate when the controlling temperature is at or below 14 C. This represents
a throttling range of 2 C around the setpoint of 15 C. In between 14 C and 16 C, the flow
rate to the radiant system is varied linearly.
Field: Heating Control Temperature Schedule Name
This field specifies the heating setpoint or control temperature for the radiant system in
degrees Celsius. Used in conjunction with the previous field (heating control throttling range),
it will define whether or not the system is running and the current flow rate. Water flow rate to
the system is varied linearly around the setpoint temperature based on the throttling range
and the maximum heating flow rate parameters (see above). It should be noted that this
control schedule will allow different setpoint temperatures throughout the year for heating.
The control of the radiant system is based solely on the heating control temperature
schedule, the cooling control temperature schedule (see below), and the control temperature
type listed above. The radiant system will not use any zone thermostat that might be used by
other systems serving the zone in which the radiant system resides.
Field: Cooling Design Capacity Method
Enter the method used to determine the cooling design capacity for scalable sizing. Input
allowed is either CoolingDesignCapacity, CapacityPerFloorArea, and
FractionOfAutosizedCoolingCapacity. If this input field is left blank or zero, then autosizing is
assumed. CoolingDesignCapacity means user specifies the design cooling capacity or the
program calculates the design cooling capacity if autosize is specified. CapacityPerFloorArea
means the program calculates the design cooling capacity from user specified heating
capacity per floor area and floor area of the zone served by the low temperature radiant
variable flow unit. FractionOfAutosizedCoolingCapacity means the program calculates the
design cooling capacity from user specified fraction and the auto-sized design cooling
capacity. The default method is CoolingDesignCapacity.
Field: Cooling Design Capacity {W}
This field is for the low temperature radiant variable flow unit design cooling capacity in watts.
This field can be autosized by EnergyPlus. This input field is autosizable. When the Cooling
Design Capacity Method is CoolingDesignCapacity and this input is is blank, autosizing is
assumed. Design day sizing run must be specified if autosized.
Field: Cooling Design Capacity Per Floor Area {W/m2}
Enter the cooling capacity per unit floor area in m3/s-m2 of low temperature radiant variable
flow unit. This field is required field when the Cooling Design Capacity Method is
CapacityPerFloorArea. The program calculates the cooling capacity from floor area of the
zone served by the low temperature radiant variable flow unit and the cooling capacity per
unit floor area value specified by the user. This field may be left blank.
Field: Fraction of Autosized Cooling Design Capacity {-}
Enter the cooling capacity as a fraction of the autosized cooling capacity for low temperature
radiant variable flow unit. This input field is required when the Cooling Design Capacity
Method is FractionOfAutosizedCoolingCapacity. The program calculates the cooling capacity
9/29/14

1139

Input-Output Reference

Group Radiative / Convective Units

from the design autosized cooling capacity and user specified fraction. Design day sizing run
must be specified. This field may be left blank. Default value is 1.0.
Field: Maximum Cold Water Flow
This field is the maximum flow rate of cold water through the radiant system in m 3/sec. The
controls for the radiant system will vary the flow rate of cold water through the surface using
zero flow and the maximum flow rate specified in this field as the lower and upper bounds,
respectively. Note that this field is optional and not required for a heating only system. Note
also that if the user elects to autosize this field that a standard zone thermostat such as
would be used for a forced air system must be defined as autosizing calculations are based
on the zone thermostat value and not on the radiant system control values.
Field: Cooling Water Inlet Node Name
This field contains the name of the cold water inlet node to the radiant system. Note that this
node name must also show up in the branch description when defining the plant demand side
network in a manner identical to defining a cooling coil. As with the maximum cold water flow
rate, this field is optional and not required for a heating only system.
Field: Cooling Water Outlet Node Name
This field contains the name of the cold water oulet node to the radiant system. Note that this
node name must also show up in the branch description when defining the plant demand side
network in a manner identical to defining a cooling coil. As with the maximum cold water flow
rate, this field is optional and not required for a heating only system.
Field: Cooling Control Throttling Range
This field specifies the range of temperature in degrees Celsuis over which the radiant
system throttles from zero flow rate up to the maximum defined by the maximum cold water
flow rate field described above. The throttling range parameter is used in conjunction with the
control temperature to define the response of the system to various zone conditions. The
cooling control temperature schedule specifies the setpoint temperature where the flow rate
to the system is at half of the maximum flow rate. For example, if the cooling control
temperature setpoint is currently 25 C and the cooling throttling range is 2 C, the water flow
rate to the radiant system will be zero when the controlling temperature (MAT, MRT,
Operative Temperature, ODB, or OWB; see control type field above) is at or below 24 C and
the maximum flow rate when the controlling temperature is at or above 26 C. This
represents a throttling range of 2 C around the setpoint of 25 C. In between 24 C and 26 C,
the flow rate to the radiant system is varied linearly.
Field: Cooling Control Temperature Schedule Name
This field specifies the cooling setpoint or control temperature for the radiant system in
degrees Celsius. Used in conjunction with the previous field (cooling control throttling range),
it will define whether or not the system is running and the current flow rate. Water flow rate to
the system is varied linearly around the setpoint temperature based on the throttling range
and the maximum cooling flow rate parameters (see above). It should be noted that this
control schedule will allow different setpoint temperatures throughout the year for cooling.
The control of the radiant system is based solely on the heating control temperature schedule
listed above, the cooling control temperature schedule, and the control temperature type
listed above. The radiant system will not use any zone thermostat that might be used by other
systems serving the zone in which the radiant system resides.
Field: Condensation Control Type
When radiant systems do cooling, there is the possibility that condensation will occur on the
surface that is being cooled. This is due to the fact that the surface temperature may drop
below the dew-point temperature of the space. When this occurs, condensation on the
surface will occur. In EnergyPlus, users have several options for handling this situation
9/29/14

1140

Input-Output Reference

Group Radiative / Convective Units

including: Off and SimpleOff. When the user chooses the Off option, EnergyPlus will not do
anything other than produce a warning message when condensation is predicted to occur.
The program will simply continue on; no moisture will be removed from the zone air and there
will be no adjustment of the surface temperature as a result of the condensation. When the
user chooses the SimpleOff option, the program will predict cases where condensation will
occur and shut-off the radiant system to avoid this situation. With this option, the users also
have the opportunity to adjust when the system will shut down. This is specified with the next
parameter (field: condensation differential parameter). This parameter is optional and
EnergyPlus will use the SimpleOff strategy when this parameter is not specified.
Field: Condensation Control Dewpoint Offset
This optional parameter is only valid with the SimpleOff condensation handling algorithm (see
previous input parameter). It establishes the difference between the calculated dew-point
temperature of the space and the allowed surface temperature to which the surface can drop
before the radiant system shuts down in degrees Celsius. This parameter can be any
positive, negative, or zero value. When this parameter is zero, the radiant system will shut
down when the surface temperature drops to the dew-point temperature or below. When this
parameter is positive, the radiant system will shut down when the surface is the number of
degrees Celsius above the dew-point temperature. This allows some extra safety to avoid
condensation. When this parameter is negative, the radiant system will shut down when the
surface temperature is the number of degrees Celsius below the dew-point temperature.
While not recommended, this strategy allows the user to simulate a situation where small
amounts of condensation are tolerable.
Field: Number of Circuits
This optional input allows the user to choose between modeling each surface in the radiant
system as a single hydronic circuit or to allow the program to divide the surface into multiple
parallel hydronic circuits based on the next input field Circuit Length. To model as a single
circuit
choose
OnePerSurface.
To
model
as
multiple
circuits
choose
CalculateFromCircuitLength. It is recommended that CalculateFromCircuitLength be chosen.
The default is OnePerSurface for backward compatibility with older versions of EnergyPlus.
Field: Circuit Length
The length in meters of each parallel hydronic circuit in a surface. Used when the previous
input field is set to CalculateFromCircuitLength. The default is 106.7 meters (350 feet), which
is the maximum circuit length allowed in Title 24.
An example IDF with a hydronic low temperature radiant system is shown below.

9/29/14

1141

Input-Output Reference

Group Radiative / Convective Units

ZoneHVAC:LowTemperatureRadiant:VariableFlow,
SPACE1-1 Zone Radiant Floor, !- Name
RADIANTSYSAVAILSCHED,
!- Availability Schedule Name
SPACE1-1,
!- Zone Name
C1-1,
!- Surface Name or Radiant Surface Group Name
0.013,
!- Hydronic Tubing Inside Diameter {m}
autosize,
!- Hydronic Tubing Length {m}
OperativeTemperature,
!- Temperature Control Type
HeatingDesignCapacity,
!- Heating Design Capacity Method
autosize,
!- Heating Design Capacity{ W }
,
!- Heating Design Capacity Per Floor Area{ W / m2 }
,
!- Fraction of Autosized Heating Design Capacity{ -}
0.0004,
!- Maximum Hot Water Flow {m3/s}
SPACE1-1 Zone Radiant Water Inlet Node, !- Heating Water Inlet Node Name
SPACE1-1 Zone Radiant Water Outlet Node, !- Heating Water Outlet Node Name
2.0,
!- Heating Control Throttling Range {deltaC}
RADIANT HEATING SETPOINTS, !- Heating Control Temperature Schedule Name
CoolingDesignCapacity,
!- Cooling Design Capacity Method
autosize,
!- Cooling Design Capacity{ W }
,
!- Cooling Design Capacity Per Floor Area{ W / m2 }
,
!- Fraction of Autosized Cooling Design Capacity{ -}
autosize,
!- Maximum Cold Water Flow {m3/s}
SPACE1-1 Cooling Water Inlet Node, !- Cooling Water Inlet Node Name
SPACE1-1 Cooling Water Outlet Node, !- Cooling Water Outlet Node Name
2.0,
!- Cooling Control Throttling Range {deltaC}
RADIANT COOLING SETPOINTS, !- Cooling Control Temperature Schedule Name
Off,
!- Condensation Control Type
1.0,
!- Condensation Control Dewpoint Offset
CalculateFromCircuitLength,
!- Number of Circuits
106.7;
!- Circuit Length

Low Temperature Radiant Variable Flow (ZoneHVAC) Outputs

HVAC,Average,Zone Radiant HVAC Heating Rate [W]
HVAC,Sum,Zone Radiant HVAC Heating Energy [J]
HVAC,Average,Zone Radiant HVAC Cooling Rate [W]
HVAC,Sum,Zone Radiant HVAC Cooling Energy [J]
HVAC,Average,Zone Radiant HVAC Mass Flow Rate [kg/s]
HVAC,Average,Zone Radiant HVAC Inlet Temperature [C]
HVAC,Average,Zone Radiant HVAC Outlet Temperature [C]
HVAC,Sum,Zone Radiant HVAC Moisture Condensation Time[s]
HVAC,Sum,Zone Radiant HVAC Heating Fluid Energy [J]
HVAC,Sum,Zone Radiant HVAC Cooling Fluid Energy [J]

Zone Radiant HVAC Heating Rate [W]

This field reports the heating input rate to the low temperature radiant system in Watts. This
is the heat source to the surface that is defined as the radiant system. The heating rate is
determined by the zone conditions and the control scheme defined in the user input.
Zone Radiant HVAC Heating Energy [J]
This field reports the heating input to the low temperature radiant system in Joules. This is
the heat source to the surface that is defined as the radiant system. The heating rate is
determined by the zone conditions, the control scheme defined in the user input, and the
timestep.
Zone Radiant HVAC Cooling Rate [W]
This field reports the cooling input rate to the low temperature radiant system in Watts. This is
the heat sink to the surface that is defined as the radiant system. The cooling rate is
determined by the zone conditions and the control scheme defined in the user input.

9/29/14

1142

Input-Output Reference

Group Radiative / Convective Units

Zone Radiant HVAC Cooling Energy [J]

This field reports the cooling input to the low temperature radiant system in Joules. This is the
heat sink to the surface that is defined as the radiant system. The cooling rate is determined
by the zone conditions, the control scheme defined in the user input, and the timestep.
Zone Radiant HVAC Mass Flow Rate Rate [kg/s]
This field reports the mass flow rate of water through the low temperature radiant system in
kilograms per second.
Zone Radiant HVAC Inlet Temperature [C]
This field reports the temperature of water entering the low temperature radiant system in
Celsius.
Zone Radiant HVAC Outlet Temperature [C]
This field reports the temperature of water leaving the low temperature radiant system in
Celsius.
Zone Radiant HVAC Moisture Condensation Time[s]
This field reports the amount of time when condensation is occurring. When using the Off
condensation control, this simply reports the amount of time when condensation occurs.
When using the SimpleOff condensation control, this indicates the amount of time when the
system has been shut off because of the potential danger of condensation.
Zone Radiant HVAC Heating Fluid Energy [J]
This is the demand placed on the hot fluid plant loop connection serving the low temperature
radiant system, in Joules.
Zone Radiant HVAC Cooling Fluid Energy [J]
This is the demand placed on the cooling fluid plant loop connection serving the low
temperature radiant system, in Joules.
ZoneHVAC:LowTemperatureRadiant:ConstantFlow
This low temperature radiant system (hydronic) is a component of zone equipment that is
intended to model any radiant system where water is used to supply/remove energy to/from
a building surface (wall, ceiling, or floor). The component is controlled via control schedules
as described in the syntax below and does not require a zone thermostat. Note that because
this unit does not require a thermostat that in cases where no other systems are serving the
zone in which this system resides that it will use the heating equipment priority to determine
which system will run first. If the radiant system is serving a zone with forced air equipment,
the radiant system will follow the priority order established by the zone thermostat but will still
base its response on the controls defined by the user for the radiant system.
The constant flow system differs from the hydronic system describe above in what it controls.
The hydronic system varies the flow rate through the radiant system based on some control
temperature. The constant flow system keeps flow rate constant via a local circulation pump
and varies the water temperature that is sent to the radiant system. This is accomplished with
a mixing valve that is controlled by a sensor. This model covers a wide range of low
temperature radiant systems: heating and/or cooling, panel or embedded pipes, etc. It is not
intended to simulate high temperature electric or gas radiant heaters. Those devices will be
handled by a separate model and different input syntax. Low temperature radiant systems
that use electric resistance heating should also be defined using separate input syntax (ref:
ZoneHVAC:LowTemperatureRadiant:Electric). Low temperature radiant systems that vary the
flow rate through the radiant system should also be defined using separate input syntax (ref:
ZoneHVAC:LowTemperatureRadiant:VariableFlow)

9/29/14

1143

Input-Output Reference

Group Radiative / Convective Units

One of the other differences between this model and the variable flow hydronic radiant
system is that the constant flow radiant system has a built-in local secondary loop. It will
recirculate flow coming out of the system and mix this with flow from the loop to arrive at the
desired inlet temperature to the radiant system (note that this model has the temperature
sensor AFTER the pump to insure proper inlet temperature to the radiant system). The local
loop also contains a pump which is assumed to be upstream of the radiant system and after
the mixing valve. So, the local loop can have some recirculation. The flow from the main loop
may also bypass the radiant system if more than enough flow is available and the main loop
is also a constant flow system.
Field: Name
This field is an unique user assigned name for an instance of a constant flow low temperature
radiant system. Any reference to this unit by another object will use this name.
Field: Availability Schedule Name
This field is the name of the schedule (ref: Schedule) that denotes whether the constant flow
low temperature radiant system can run during a given time period. A schedule value less
than or equal to 0 (usually 0 is used) denotes that the unit must be off for that time period. A
value greater than 0 (usually 1 is used) denotes that the unit is available to operate during
that time period. If this field is left blank, the schedule has a value of 1 for all time periods.
Field: Zone Name
This field is the name of the zone (Ref: Zone) in which the constant flow low temperature
radiant system is principally located and intended to affect. A system that is between two
zones will still act upon each zone; however, the zone name referenced here should be the
zone that controls the radiant system response.
Field: Surface Name or Radiant Surface Group Name
This field is the name of the surface (Ref: BuildingSurface:Detailed) or surface list (Ref:
ZoneHVAC:LowTemperatureRadiant:SurfaceGroup) in which the hydronic tubing is
embedded/contained. This specification attaches the source or sink from the radiant system
to a particular surface and the contribution of the system to the heat balances of that surface.
If this field is a surface list, then the source or sink is attached to all of the surfaces in the list
with the radiant system surface group defining the breakdown of how flow rate is split
between the various surfaces. Only base surfaces (BuildingSurface:Detailed) are valid.
Window/Door surfaces and Internal Mass are not valid surface types for embedded radiant
systems.
Field: Hydronic Tubing Inside Diameter
This field is the inside diameter of the tubes through which water is circulated for the system
being defined by this statement. The inside diameter should be recorded in meters and is
used to determine the convective heat transfer from the water to the inside surface of the
hydronic tubing.
Field: Hydronic Tubing Length
This field is the total length of pipe embedded in the surface named above in the surface
name field. The length of the tube should be entered in meters and is used to determine the
effectiveness of heat transfer from the fluid being circulated through the tubes and the
tube/surface. Longer tubing lengths result in more heat being transferred to/from the radiant
surface to the circulating fluid. This field is autosizable.
Field: Temperature Control Type
This field specifies along with setpoint (control) and water schedules how the user wishes to
control the constant flow radiant system. The temperature denoted in the setpoint schedule
can refer to one of five different temperatures: the zone mean air temperature, the zone
9/29/14

1144

Input-Output Reference

Group Radiative / Convective Units

mean radiant temperature, the zone operative temperature, the outdoor dry-bulb
temperature, or the outdoor wet-bulb temperature. The choice of temperature is controlled by
the current fieldtemperature control type. The user must select from the following options:
MeanAirTemperature
MeanRadiantTemperature
OperativeTemperature
OutdoorDryBulbTemperature
OutdoorWetBulbTemperature

Operative temperature for radiant system controls is the average of Mean Air Temperature
and Mean Radiant Temperature. If the user does not select a control type,
MeanAirTemperature control is assumed by EnergyPlus. See the throttling range and
control temperature schedule fields below for more information.
Field: Rated Flow Rate
This field is the maximum flow rate of water through the radiant system in m 3/sec. This flow
rate is held constant by the local component pump, but the user has the option of varying this
flow rate via a schedule (see next input field). The constant flow system will accept this flow
rate and control the inlet temperature based on the control and water temperature schedules
defined below. This field is autosizable.
Field: Pump Flow Rate Schedule Name
This field modifies the maximum flow rate of water through the radiant system in m 3/sec. This
input is optional. If the user does not enter a schedule, the flow rate through the radiant
system is assumed to be constant during all hours that it is operating based on the value
entered in the previous input field. Note that the values for this schedule must be between
zero and one. The values in this schedule are multipliers on the previous field Rated Flow
Rate.
Field: Rated Pump Head
This numeric field contains the pumps rated head in Pascals.
Field: Rated Power Consumption
This numeric field contains the pumps rated power consumption in Watts.
Field: Motor Efficiency
This numeric field contains the pumps efficiency in decimal form (0 = 0%, 1 = 100%).
Field: Fraction of Motor Inefficiencies to Fluid Stream
This numeric field contains the pumps fraction of power loss to the fluid.
Field: Heating Water Inlet Node Name
This field contains the name of the hot water inlet node to the radiant system. Note that this
node name must also show up in the branch description when defining the plant demand side
network in a manner identical to defining a heating coil.
Field: Heating Water Outlet Node Name
This field contains the name of the hot water outlet node to the radiant system. Note that this
node name must also show up in the branch description when defining the plant demand side
network in a manner identical to defining a heating coil.
Field: Heating High Water Temperature Schedule Name
This field specifies the high water temperature in degrees Celsius for the temperature control
of a constant flow radiant heating system. Water and control temperatures for heating work
together to provide a linear function that determines the water temperature sent to the radiant
system. The current control temperature (see Temperature Control Type above) is compared
9/29/14

1145

Input-Output Reference

Group Radiative / Convective Units

to the high and low control temperatures at the current time. If the control temperature is
above the high temperature, then the system will be turned off and the water mass flow rate
will be zero. If the control temperature is below the low temperature, then the inlet water
temperature is set to the high water temperature. If the control temperature is between the
high and low value, then the inlet water temperature is linearly interpolated between the low
and high water temperature values. For more information and a graph of how the water and
control schedules affect the system operation, please consult the Engineering Reference
document.
Field: Heating Low Water Temperature Schedule Name
This field specifies the low water temperature in degrees Celsius for the temperature control
of a constant flow heating radiant system. For more information on its interpretation, see
Heating High Water Temperature Schedule above.
Field: Heating High Control Temperature Schedule Name
This field specifies the high control temperature in degrees Celsius for the temperature
control of a constant flow heating radiant system. For more information on its interpretation,
see Heating High Water Temperature Schedule above.
Field: Heating Low Control Temperature Schedule Name
This field specifies the low control temperature in degrees Celsius for the temperature control
of a constant flow heating radiant system. For more information on its interpretation, see
Heating High Water Temperature Schedule above.
Field: Cooling Water Inlet Node Name
This field contains the name of the cold water inlet node to the radiant system. Note that this
node name must also show up in the branch description when defining the plant demand side
network in a manner identical to defining a cooling coil. As with the maximum cold water flow
rate, this field is optional and not required for a heating only system.
Field: Cooling Water Outlet Node Name
This field contains the name of the cold water outlet node to the radiant system. Note that this
node name must also show up in the branch description when defining the plant demand side
network in a manner identical to defining a cooling coil. As with the maximum cold water flow
rate, this field is optional and not required for a heating only system.
Field: Cooling High Water Temperature Schedule Name
This field specifies the high water temperature in degrees Celsius for the temperature control
of a constant flow radiant cooling system. Water and control temperatures for heating work
together to provide a linear function that determines the water temperature sent to the radiant
system. The current control temperature (see Temperature Control Type above) is compared
to the high and low control temperatures at the current time. If the control temperature is
above the high temperature, then the inlet water temperature is set to the low water
temperature. If the control temperature is below the low temperature, then system will be
turned off and the water mass flow rate will be zero. If the control temperature is between the
high and low value, then the inlet water temperature is linearly interpolated between the low
and high water temperature values. For more information and a graph of how the water and
control schedules affect the system operation, please consult the Engineering Reference
document.
Field: Cooling Low Water Temperature Schedule Name
This field specifies the low water temperature in degrees Celsius for the temperature control
of a constant flow cooling radiant system. For more information on its interpretation, see
Cooling High Water Temperature Schedule above.

9/29/14

1146

Input-Output Reference

Group Radiative / Convective Units

Field: Cooling High Control Temperature Schedule Name

This field specifies the high control temperature in degrees Celsius for the temperature
control of a constant flow cooling radiant system. For more information on its interpretation,
see Cooling High Water Temperature Schedule above.
Field: Cooling Low Control Temperature Schedule Name
This field specifies the low control temperature in degrees Celsius for the temperature control
of a constant flow cooling radiant system. For more information on its interpretation, see
Cooling High Water Temperature Schedule above.
Field: Condensation Control Type
When radiant systems do cooling, there is the possibility that condensation will occur on the
surface that is being cooled. This is due to the fact that the surface temperature may drop
below the dew-point temperature of the space. When this occurs, condensation on the
surface will occur. In EnergyPlus, users have several options for handling this situation
including: Off and SimpleOff. When the user chooses the Off option, EnergyPlus will not do
anything other than produce a warning message when condensation is predicted to occur.
The program will simply continue on; no moisture will be removed from the zone air and there
will be no adjustment of the surface temperature as a result of the condensation. When the
user chooses the SimpleOff option, the program will predict cases where condensation will
occur and shut-off the radiant system to avoid this situation. With this option, the users also
have the opportunity to adjust when the system will shut down. This is specified with the next
parameter (field: condensation differential parameter). This parameter is optional and
EnergyPlus will use the SimpleOff strategy when this parameter is not specified.
Field: Condensation Control Dewpoint Offset
This optional parameter is only valid with the SimpleOff condensation handling algorithm (see
previous input parameter). It establishes the difference between the calculated dew-point
temperature of the space and the allowed surface temperature to which the surface can drop
before the radiant system shuts down in degrees Celsius. This parameter can be any
positive, negative, or zero value. When this parameter is zero, the radiant system will shut
down when the surface temperature drops to the dew-point temperature or below. When this
parameter is positive, the radiant system will shut down when the surface is the number of
degrees Celsius above the dew-point temperature. This allows some extra safety to avoid
condensation. When this parameter is negative, the radiant system will shut down when the
surface temperature is the number of degrees Celsius below the dew-point temperature.
While not recommended, this strategy allows the user to simulate a situation where small
amounts of condensation are tolerable.
Field: Number of Circuits
This optional input allows the user to choose between modeling each surface in the radiant
system as a single hydronic circuit or to allow the program to divide the surface into multiple
parallel hydronic circuits based on the next input field Circuit Length. To model as a single
circuit
choose
OnePerSurface.
To
model
as
multiple
circuits
choose
CalculateFromCircuitLength. It is recommended that CalculateFromCircuitLength be chosen.
The default is OnePerSurface for backward compatibility with older versions of EnergyPlus.
Field: Circuit Length
The length in meters of each parallel hydronic circuit in a surface. Used when the previous
input field is set to CalculateFromCircuitLength. The default is 106.7 meters (350 feet), which
is the maximum circuit length allowed in Title 24.
An example IDF with a constant flow low temperature radiant system is shown below.

9/29/14

1147

Input-Output Reference

Group Radiative / Convective Units

ZoneHVAC:LowTemperatureRadiant:ConstantFlow,
Resistive Zone Radiant Floor, !- name of CONSTANT FLOW low temperature radiant system
RadiantSysAvailSched, !- availability schedule
Resistive Zone, !- Zone name
Zn001:Flr001, !- Surface name or group
0.012, !- Hydronic tubing inside diameter {m}
400.0, !- Hydronic tubing length {m}
MeanAirTemperature, !- temperature control type
0.0004, !- maximum water volumetric flow rate {m3/s}
, !-schedule for flow rate (optional, non-existent means constant)
30000, !-Rated Pump Head in Pa
50, !-Rated Power Consumption in W
0.87, !-Motor Efficiency
0.1, !-Fraction of Motor Inefficiencies to Fluid Stream
Resistive Zone Radiant Water Inlet Node, !- heating water inlet node
Resistive Zone Radiant Water Outlet Node, !- heating water outlet node
RadHeatHighWaterTemp, !-high water temperature schedule
RadHeatLowWaterTemp,
!-low water temperature schedule
RadHeatHighControlTemp, !-high control temperature schedule
RadHeatLowControlTemp, !-low control temperature schedule
Zone 1 Cooling Water Inlet Node, !- cooling water inlet node
Zone 1 Cooling Water Outlet Node, !- cooling water outlet node
RadCoolHighWaterTemp, !-cooling high water temperature schedule
RadCoolLowWaterTemp, !-cooling low water temperature schedule
RadCoolHighControlTemp, !- cooling high control temperature schedule
RadCoolLowControlTemp, !- cooling low control temperature schedule
SimpleOff,
!- condensation control type
0.5,
!- condensation control dewpoint offset
CalculateFromCircuitLength,
!- Number of Circuits
106.7;
!- Circuit Length

Low Temperature Radiant Constant Flow (ZoneHVAC) Outputs

HVAC,Average,Zone Radiant HVAC Heating Rate [W]
HVAC,Sum,Zone Radiant HVAC Heating Energy [J]
HVAC,Average,Zone Radiant HVAC Cooling Rate [W]
HVAC,Sum,Zone Radiant HVAC Cooling Energy [J]
HVAC,Average,Zone Radiant HVAC Mass Flow Rate [kg/s]
HVAC,Average,Zone Radiant HVAC Injection Mass Flow Rate [kg/s]
HVAC,Average,Zone Radiant HVAC Recirculation Mass Flow Rate [kg/s]
HVAC,Average,Zone Radiant HVAC Inlet Temperature [C]
HVAC,Average,Zone Radiant HVAC Outlet Temperature [C]
HVAC,Average,Zone Radiant HVAC Pump Inlet Temperature [C]
HVAC,Average,Zone Radiant HVAC Pump Electric Power[W]
HVAC,Sum,Zone Radiant HVAC Pump Electric Energy [J]
HVAC,Average,Zone Radiant HVAC Pump Mass Flow Rate [kg/s]
HVAC,Average,Zone Radiant HVAC Pump Fluid Heat Gain Rate [W]
HVAC,Sum,Zone Radiant HVAC Pump Fluid Heat Gain Energy [J]
HVAC,Sum,Zone Radiant HVAC Moisture Condensation Time [s]
HVAC,Sum,Zone Radiant HVAC Cooling Fluid Heat Transfer Energy [J]
HVAC,Sum,Zone Radiant HVAC Heating Fluid Heat Transfer Energy [J]

Zone Radiant HVAC Heating Rate [W]

This field reports the heating input rate to the low temperature radiant system in Watts. This
is the heat source to the surface that is defined as the radiant system. The heating rate is
determined by the zone conditions and the control scheme defined in the user input.
Zone Radiant HVAC Heating Energy [J]
This field reports the heating input to the low temperature radiant system in Joules. This is
the heat source to the surface that is defined as the radiant system. The heating rate is
determined by the zone conditions, the control scheme defined in the user input, and the
timestep.
9/29/14

1148

Input-Output Reference

Group Radiative / Convective Units

Zone Radiant HVAC Cooling Rate [W]

This field reports the cooling input rate to the low temperature radiant system in Watts. This is
the heat sink to the surface that is defined as the radiant system. The cooling rate is
determined by the zone conditions and the control scheme defined in the user input.
Zone Radiant HVAC Cooling Energy [J]
This field reports the cooling input to the low temperature radiant system in Joules. This is the
heat sink to the surface that is defined as the radiant system. The cooling rate is determined
by the zone conditions, the control scheme defined in the user input, and the timestep.
Zone Radiant HVAC Mass Flow Rate [kg/s]
This field reports the mass flow rate of water through the low temperature radiant system in
kilograms per second. This should be identical to the pump flow rate for the system.
Zone Radiant HVAC Injection Mass Flow Rate [kg/s]
This field reports the mass flow rate of water that is injected into the radiant system from the
main loop. A valve will control the injection and recirculation mass flow rates (see next field)
to match the temperature controls specified by the user and dictated by the current simulation
conditions.
Zone Radiant HVAC Recirculation Mass Flow Rate [kg/s]
This field reports the mass flow rate of water that is recirculated from the radiant system
outlet and mixed with the injection flow from the main loop. A valve will control the injection
and recirculation mass flow rates (see next field) to match the temperature controls specified
by the user and dictated by the current simulation conditions.
Zone Radiant HVAC Inlet Temperature [C]
This field reports the temperature of water entering the low temperature radiant system in
Celsius. This may differ from the inlet node temperature for the component since this
component has its own local secondary loop.
Zone Radiant HVAC Outlet Temperature [C]
This field reports the temperature of water leaving the low temperature radiant system in
Celsius. This may differ from the outlet node temperature for the component since this
component has its own local secondary loop.
Zone Radiant HVAC Pump Inlet Temperature [C]
This field reports the temperature of water entering the low temperature radiant system pump
in Celsius. This may differ from the inlet node temperature for the component since this
component has its own local secondary loop. It is assumed that the pump is upstream of the
radiant system.
Zone Radiant HVAC Pump Electric Power [W]
This field reports the rate of electric power consumption for the pump which supplies flow to
the constant flow radiant system in Watts.
Zone Radiant HVAC Pump Electric Energy [J]
This field reports the electric power consumption for the pump which supplies flow to the
constant flow radiant system in Joules.
Zone Radiant HVAC Pump Mass Flow Rate [kg/s]
This field reports the mass flow rate of water through the low temperature radiant system
pump in kilograms per second. This should be identical to the flow rate for the system.

9/29/14

1149

Input-Output Reference

Group Radiative / Convective Units

Zone Radiant HVAC Pump Fluid Heat Gain Rate [W]

This field reports the rate at which heat is added to the fluid stream as it passes through the
pump in Watts. This heat is reflected in the radiant system inlet temperature which will be
different from the pump inlet temperature if this field has a non-zero value.
Zone Radiant HVAC Pump Fluid Heat Gain Energy [J]
This field reports the amount of heat energy added to the fluid stream as it passes through
the pump in Joules. This heat is reflected in the radiant system inlet temperature which will be
different from the pump inlet temperature if this field has a non-zero value.
Zone Radiant HVAC Moisture Condensation Time [s]
This field reports the amount of time when condensation is occurring. When using the Off
condensation control, this simply reports the amount of time when condensation occurs.
When using the SimpleOff condensation control, this indicates the amount of time when the
system has been shut off because of the potential danger of condensation.
Zone Radiant HVAC Cooling Fluid Heat Transfer Energy [J]
The heat transfer energy for the cooling fluid connection, in Joules.
Zone Radiant HVAC Heating Fluid Heat Transfer Energy [J]
The heat transfer energy for the heating fluid connection, in Joules.
ZoneHVAC:LowTemperatureRadiant:Electric
This low temperature radiant system (electric) is a component of zone equipment that is
intended to model any radiant system where electric resistance heating is used to supply
energy (heat) to a building surface (wall, ceiling, or floor). The component is controlled by the
radiant system controls that are defined in the syntax below and this control does not require
the use of a zone thermostat unless the unit is being autosized. Note also that because this
unit does not require a thermostat that in cases where no other systems are serving the zone
in which this system resides that it will use the heating equipment priority to determine which
system will run first. If the radiant system is serving a zone with forced air equipment, the
radiant system will follow the priority order established by the zone thermostat but will still
base its response on the controls defined by the user for the radiant system.
The control is accomplished by varying the electrical power supplied to the unit. This model
covers either a radiant panel system or wires embedded in entire walls, floors, or ceilings. It is
not intended to simulate high temperature electric or gas radiant heaters. Those devices will
be handled by a separate model and different input syntax. Low temperature radiant systems
that use water flowing through tubes to provide heat to the system should also be defined
using separate input syntax (ref: Low Temp Radiant System:Hydronic).
Field: Name
This field is an unique user assigned name for an instance of an electric low temperature
radiant system. Any reference to this unit by another object will use this name.
Field: Availability Schedule Name
This field is the name of the schedule (ref: Schedule) that denotes whether the electric low
temperature radiant system can operate during a given time period. A schedule value less
than or equal to 0 (usually 0 is used) denotes that the unit must be off for that time period. A
value greater than 0 (usually 1 is used) denotes that the unit is available to operate during
that time period. If this field is left blank, the schedule has a value of 1 for all time periods.
Field: Zone Name
This field is the name of the zone (Ref: Zone) in which the electric low temperature radiant
system is principally located and intended to affect. A system that is between two zones will
9/29/14

1150

Input-Output Reference

Group Radiative / Convective Units

still act upon each zone; however, the zone name referenced here should be the zone that
controls the radiant system response.
Field: Surface Name or Radiant Surface Group Name
This field is the name of the surface (Ref: BuildingSurface) or surface list (Ref:
ZoneHVAC:LowTemperatureRadiant:SurfaceGroup) in which the hydronic tubing is
embedded/contained. This specification attaches the source or sink from the radiant system
to a particular surface and the contribution of the system to the heat balances of that surface.
If this field is a surface list, then the source or sink is attached to all of the surfaces in the list
with the radiant system surface group defining the breakdown of how flow rate is split
between the various surfaces. Only base surfaces (e.g. BuildingSurface:Detailed) are valid.
Window/Door surfaces and Internal Mass are not valid surface types for embedded radiant
systems.
Field: Heating Design Capacity Method
Enter the method used to determine the maximum electrical power (heating design capacity )
or enter the method for scalable sizing the maximum electrical power of low temperature
radiant electric unit. Input allowed is either HeatingDesignCapacity, CapacityPerFloorArea,
and FractionOfAutosizedHeatingCapacity. If this input field is left blank or zero, then
autosizing is assumed. HeatingDesignCapacity means user specifies the magnitude of
maximum or nominal heating capacity or the program calculates the maximum or nominal
design heating capacity if autosize is specified. CapacityPerFloorArea means the program
calculates the design heating capacity from user specified heating capacity per floor area and
floor area of the zone served by the low temperature radiant electric unit.
FractionOfAutosizedHeatingCapacity means the program calculates the design heating
capacity from user specified fraction and the auto-sized design heating capacity. The default
method is HeatingDesignCapacity.
Field: Heating Design Capacity {W}
This field is for the maximum amount of electric energy rate (electric power) converted into
heat in low temperature radiant electric unit in watts. This input field is autosizable. The
controls for the radiant system will vary the amount of power supplied to the surface between
zero input and the maximum power specified in this field as the lower and upper bounds,
respectively. Note that if the user elects to autosize this field that a standard zone thermostat
such as would be used for a forced air system must be defined as autosizing calculations are
based on the zone thermostat value and not on the low temperature radiant electric unit
control values. The default input for this input field is autosize.
Field: Heating Design Capacity Per Floor Area {W/m2}
Enter the heating capacity per unit floor area in m3/s-m2 of low temperature radiant electric
system. This field is required field when the Heating Design Capacity Method is
CapacityPerFloorArea. The program calculates the heating capacity from floor area of the
zone served by the low temperature radiant electric unit and the heating capacity per unit
floor area value specified by the user. This field may be left blank.
Field: Fraction of Autosized Heating Design Capacity {-}
Enter the heating capacity as a fraction of the autosized heating capacity of low temperature
radiant electric unit. This input field is required when the Heating Design Capacity Method is
FractionOfAutosizedHeatingCapacity. The program calculates the heating capacity from the
design autosized heating capacity and user specified fraction. Design day sizing must be
specified. This field may be left blank. The default value is 1.0.
Field: Temperature Control Type
This field specifies along with the throttling range and setpoint schedules how the user
wishes to control the low temperature electric radiant system. The temperature denoted in the
9/29/14

1151

Input-Output Reference

Group Radiative / Convective Units

setpoint schedule can refer to one of three different temperatures: the zone mean air
temperature, the zone mean radiant temperature, the zone operative temperature, the
outdoor dry-bulb temperature, or the outdoor wet-bulb temperature. The choice of
temperature is controlled by the current fieldtemperature control type. The user must select
from the following options:
MeanAirTemperature
MeanRadiantTemperature
OperativeTemperature
OutdoorDryBulbTemperature
OutdoorWetBulbTemperature

Operative temperature for radiant system controls is the average of Mean Air Temperature
and Mean Radiant Temperature. If the user does not select a control type,
MeanAirTemperature control is assumed by EnergyPlus. See the throttling range and
control temperature schedule fields below for more information.
Field: Heating Throttling Range
This field specifies the range of temperature in degrees Celsuis over which the radiant
system throttles from zero heat input via the electric resistance wires up to the maximum
defined by the maximum electrical power field described above. The throttling range
parameter is used in conjunction with the control temperature (see below) to define the
response of the system to various zone conditions. The heating control temperature schedule
specifies the setpoint temperature where the power input to the system is at half of the
maximum power input. For example, if the heating control temperature setpoint is currently
15 C and the heating throttling range is 2 C, the electrical power supplied to the radiant
system will be zero when the controlling temperature (MAT, MRT, Operative Temperature,
ODB, or OWB; see control type field above) is at or above 16 C and the maximum power
input when the controlling temperature is at or below 14 C. This represents a throttling range
of 2 C around the setpoint of 15 C. In between 14 C and 16 C, the power input to the radiant
system is varied linearly.
Field: Heating Setpoint Temperature Schedule Name
This field specifies the heating setpoint or control temperature for the radiant system in
degrees Celsius. Used in conjunction with the previous field (heating throttling range), it will
define whether or not the system is running and the current power input to the radiant
surface. Power input to the system is varied linearly around the setpoint temperature based
on the throttling range and the maximum electrical power parameters (see above). It should
be noted that this control schedule will allow different setpoint temperatures throughout the
year for heating. In addition, this schedule may be different that the thermostatic control
schedule defined for overall operation of components serving the zone in which the radiant
system is located. The thermostatic control determines whether or not there is a heating or
cooling load in the space and thus whether the systems should be operating. This field simply
controls the flow rate to the radiant system.
An example IDF with an electric low temperature radiant system is shown below.
ZoneHVAC:LowTemperatureRadiant:Electric, Zone 2 Radiant Floor,
RadiantPanelAvailSched ,
! Availability schedule
EAST ZONE ,
! Zone name (name of zone system is serving)
Zn002:Flr001 ,
! Surface name (name of surface system is embedded in)
HeatingDesignCapacity,
!- Heating Design Capacity Method
10000,
!- Heating Design Capacity{ W }
,
!- Heating Design Capacity Per Floor Area{ W / m2 }
,
!- Fraction of Autosized Heating Design Capacity{ -}
MeanAirTemperature,
! control type (control on mean air temperature)
2.0 ,
! heating throttling range (in C)
Radiant Heating Setpoints ; ! heating setpoint temperatures

9/29/14

1152

Input-Output Reference

Group Radiative / Convective Units

Low Temperature Radiant Electric (ZoneHVAC) Outputs

HVAC,Average, Zone Radiant HVAC Electric Power[W]
HVAC,Sum, Zone Radiant HVAC Electric Energy [J]
HVAC,Sum,Zone Radiant HVAC Heating Energy [J]
HVAC,Average, Zone Radiant HVAC Heating Rate [W]

Zone Radiant HVAC Electric Power [W]

This field reports the rate at which electric energy is burned in the low temperature radiant
system in Watts. This is the heat source to the surface that is defined as the radiant system.
The heating rate is determined by the zone conditions and the control scheme defined in the
user input.
Zone Radiant HVAC Electric Energy [J]
This field reports the amount of electric energy burned in the low temperature radiant
system in Joules. This is the heat source to the surface that is defined as the radiant system.
The heating rate is determined by the zone conditions, the control scheme defined in the user
input, and the timestep.
Zone Radiant HVAC Heating Energy [J]
Zone Radiant HVAC Heating Rate [W]
These outputs are the heating provided by the low temperature radiant system to the zone, in
Watts or Joules.
ZoneHVAC:LowTemperatureRadiant:SurfaceGroup
A low temperature radiant system (hydronic or electric) may consist of multiple active
surfaces that are serving to condition the space. Surfaces that act serially can be specified as
multiple radiant systems using the standard radiant system input described above. However,
if the multiple surfaces act in parallet, the Radiant System Surface Group input line is used to
specify which surfaces are acting in a coordinated fashion and how flow rate is split between
the surfaces. This list of surfaces (the name it is assigned) replaces the name of a single
surface in the radiant system input described above. Note that all of the surfaces within a
single list must be a part of the same zone and that the zone of these surfaces must also
match the zone the radiant system is attempting to condition.
Field: Name
This field is an unique user assigned name for the list of surfaces that are acting in
coordination with one another. Any reference to this list by a radiant system will use this
name.
Field Set: Surface Name, Flow Fraction to Surface
The pairs of Surface Name, Flow Fraction to Surface are used in several objects. There can
be up to 10 specified. The object is extensible so more can be added.
Field: Surface <x> Name
This field is the name of a surface in the zone being conditioned by the radiant system. Only
base surfaces (walls, roofs, floors) are valid. Window/Door surfaces and Internal Mass are
not valid surface types for embedded radiant systems.
Field: Flow Fraction for Surface <x>
This field is the fraction of the total radiant system flow rate that is being sent to this particular
surface. Note that the Surface Name/Surface Flow Fraction pair can be repeated up to 10
times. Flow rate fractions must sum to unity, otherwise the program will not accept the input
as valid.
An example IDF with an electric low temperature radiant system is shown below.
9/29/14

1153

Input-Output Reference

Group Radiative / Convective Units

ZoneHVAC:LowTemperatureRadiant:SurfaceGroup,
Zone 1 Radiant Surfaces, !- name of surface list
Zn001:Flr001,
!- Surface name 1
0.75,
!- Flow fraction for surface 1
Zn001:Roof001,
!- Surface name 2
0.25;
!- Flow fraction for surface 2

ZoneHVAC:HighTemperatureRadiant
The high temperature radiant system (gas-fired or electric) is a component of zone equipment
that is intended to model any high temperature or high intensity radiant system where
electric resistance or gas-fired combustion heating is used to supply energy (heat) to a
building occupants directly as well as the building surfaces (wall, ceiling, or floor). The
component is controlled by the radiant system controls defined in the syntax below and this
control does not require the use of a zone thermostat unless the unit is being autosized. Note
also that because this unit does not require a thermostat that in cases where no other
systems are serving the zone in which this system resides that it will use the heating
equipment priority to determine which system will run first. If the radiant system is serving a
zone with forced air equipment, the radiant system will follow the priority order established by
the zone thermostat but will still base its response on the controls defined by the user for the
radiant system.
The control is accomplished by varying the electrical power supplied to or gas consumed by
the unit. It is not intended to simulate low temperature electric or hydronic radiant systems.
Those devices will be handled by a separate model and different input syntax (ref: the low
temperature systems described elsewhere).
Field: Name
This field is an unique user assigned name for an instance of the high temperature radiant
system. Any reference to this unit by another object will use this name.
Field: Availability Schedule Name
This field is the name of the schedule (ref: Schedule) that denotes whether the high
temperature radiant system can operate during a given time period. A schedule value less
than or equal to 0 (usually 0 is used) denotes that the unit must be off for that time period. A
value greater than 0 (usually 1 is used) denotes that the unit is available to operate during
that time period. If this field is left blank, the schedule has a value of 1 for all time periods.
Field: Zone Name
This field is the name of the zone (Ref: Zone) in which the high temperature radiant system is
principally located and intended to affect.
Field: Heating Design Capacity Method
Enter the method used to determine the maximum electrical power (heating design capacity )
or enter the method for scalable sizing the maximum electrical power of high temperature
radiant system unit. Input allowed is either HeatingDesignCapacity, CapacityPerFloorArea,
and FractionOfAutosizedHeatingCapacity. If this input field is left blank or zero, then
autosizing is assumed. HeatingDesignCapacity means user specifies the magnitude of
maximum or nominal heating capacity or the program calculates the maximum or nominal
design heating capacity if autosize is specified. CapacityPerFloorArea means the program
calculates the design heating capacity from user specified heating capacity per floor area and
floor area of the zone served by the high temperature radiant electric unit.
FractionOfAutosizedHeatingCapacity means the program calculates the design heating
capacity from user specified fraction and the auto-sized design heating capacity. The default
method is HeatingDesignCapacity.

9/29/14

1154

Input-Output Reference

Group Radiative / Convective Units

Field: Heating Design Capacity {W}

This field is for the maximum amount of electric energy rate (electric power) converted into
heat in high temperature radiant electric unit in watts. This input field is autosizable. The
controls for the radiant system will vary the amount of power supplied to the surface between
zero input and the maximum power specified in this field as the lower and upper bounds,
respectively. Note that if the user elects to autosize this field that a standard zone thermostat
such as would be used for a forced air system must be defined as autosizing calculations are
based on the zone thermostat value and not on the radiant system control values. The default
input for this field is autosize.
Field: Heating Design Capacity Per Floor Area {W/m2}
Enter the heating capacity per unit floor area in m3/s-m2 of high temperature radiant electric
unit. This field is required field when the Heating Design Capacity Method is
CapacityPerFloorArea. The program calculates the heating capacity from floor area of the
zone served by the high temperature radiant electric unit and the heating capacity per unit
floor area value specified by the user. This field may be left blank.
Field: Fraction of Autosized Heating Design Capacity {-}
Enter the heating capacity as a fraction of the autosized heating capacity for high
temperature radiant electric unit. This input field is required when the Heating Design
Capacity Method is FractionOfAutosizedHeatingCapacity. The program calculates the
heating capacity from the design autosized heating capacity and user specified fraction.
Design day sizing run must be specified. This field may be left blank. The default value is 1.0.
Field: Fuel Type
This field denotes the type of high temperature radiant heater: gas or electric. The user must
specify this by inputting either the keyword NaturalGas or Electricity for this field.
Field: Combustion Efficiency
This field is the combustion efficiency for a gas high temperature radiant heater. This value
should be greater than 0 and less than or equal to 1. It is intended to take into account any
potential inefficiencies in the combustion process inside the radiant heater. The heater gas
consumption is the ratio of heater output over the combustion efficiency. This parameter has
no meaning for an electric high temperature radiant heater and is ignored when the previous
field is equal to Electric.
Field: Fraction of Input Converted to Radiant Energy
This field specifies what fraction of the power input to the high temperature radiant heater is
actually radiant heat transfer. The fraction should be between 0 and 1. In conjunction with the
next two parameters, it defines the breakdown of how the power input to the heater is
distributed to the rest of the zone. The sum of these fractions must be less than or equal to 1.
If the fractions are less than one, the remaining energy is added to the zone as convective
heat transfer. The radiant heat transfer from the heat is distributed to people and surfaces
using the distribution fractions listed below.
Field: Fraction of Input Converted to Latent Energy
This field specifies the fraction of the power input to the high temperature radiant heater that
is converted to a latent heat gain within the space. This may be appropriate when a
combustion process produces moisture that is transferred into the space. The latent heat
addition from a high temperature radiant heater is handled as any other latent heat gain
within the space, affecting the moisture balance on the zone air.

9/29/14

1155

Input-Output Reference

Group Radiative / Convective Units

Field: Fraction of Input that Is Lost

This field specifies the fraction of power input to the high temperature radiant heater that is
lost. This energy is a loss term, and this fraction of the input power has no effect on the
zone heat balances.
Field: Temperature control type
This field specifies along with the throttling range and setpoint schedules how the user
wishes to control the high temperature radiant system. The temperature denoted in the
setpoint schedule can refer to one of three different temperatures: a mean air temperature, a
mean radiant temperature, or an operative temperature. The choice of temperature is
controlled by the current fieldtemperature control type. The user must select from the
following options:
MeanAirTemperature
MeanRadiantTemperature
OperativeTemperature
MeanAirTemperatureSetpoint
MeanRadiantTemperatureSetpoint
OperativeTemperatureSetpoint

If the user does not select a control type, OperativeTemperature control is assumed by
EnergyPlus. For the setpoint control strategies (those ending in Setpoint above), EnergyPlus
will attempt to find the correct heater output to meet the heating setpoint temperature (see
below) through iteration and interpolation. This will more closely match the operation of an
actual thermostat, but it will require significantly longer execution times. For more information
on the standard piecewise linear control algorithm used by the Mean Air Temperature, Mean
Radiant Temperature, and Operative Temperature control types (the non-Setpoint controls),
see the throttling range and control temperature schedule fields below for more information.
Field: Heating Throttling Range
This field specifies the range of temperature in degrees Celsuis over which the radiant
system throttles from zero heat input via the electric resistance wires up to the maximum
defined by the maximum electrical power field described above. The throttling range
parameter is used in conjunction with the control temperature (see below) to define the
response of the system to various zone conditions. The heating control temperature schedule
specifies the setpoint temperature where the power input to the system is at half of the
maximum power input. For example, if the heating control temperature setpoint is currently
15 C and the heating throttling range is 2 C, the electrical power supplied to the radiant
system will be zero when the controlling temperature (Mean Air Temperature, Mean Radiant
Temperature, and Operative Temperature; see control type field above) is at or above 16 C
and the maximum power input when the controlling temperature is at or below 14 C. This
represents a throttling range of 2 C around the setpoint of 15 C. In between 14 C and 16 C,
the power input to the radiant system is varied linearly.
Field: Heating Setpoint Temperature Schedule Name
This field specifies the heating setpoint or control temperature for the radiant system in
degrees Celsius. Used in conjunction with the previous field (heating throttling range), it will
define whether or not the system is running and the current power input to the radiant
surface. Power input to the system is varied linearly around the setpoint temperature based
on the throttling range and the maximum electrical power parameters (see above). It should
be noted that this control schedule will allow different setpoint temperatures throughout the
year for heating. In addition, this schedule may be different that the thermostatic control
schedule defined for overall operation of components serving the zone in which the radiant
system is located. The thermostatic control determines whether or not there is a heating or
cooling load in the space and thus whether the systems should be operating. This field simply
controls the flow rate to the radiant system.

9/29/14

1156

Input-Output Reference

Group Radiative / Convective Units

Field: Fraction of Radiant Energy Incident on People

This field specifies the fraction of radiant heat transfer to the zone from the radiant heater that
is incident directly on people within the space. This has an impact on the predicted thermal
comfort of the zone occupants. Note that since the thermal comfort models only use the
results of the zone heat balances this energy is accounted for within the heat balance as
convective energy, directly affecting the zone air heat balance. The basic assumption here is
that most radiant energy falling on people will most likely be convected to the surroundings.
This is a simplification of reality, but it maintains the overall energy balance.
Field Set: Surface Name, Fraction of radiant energy to Surface
The pairs of Surface Name, Fraction of Radiant Energy to Surface are used in several
objects. There can be up to 20 specified.
Field: Surface <x> Name
This field is the name of the first surface to which radiant heat transfer from the high
temperature radiant heater is distributed. Used in conjunction with the next field, it helps to
define the distribution of the radiant energy on the surfaces within the zone. Note that up to
20 pairs of surface names and corresponding fractions may be entered for a single radiant
heater system.
Field: Fraction of Radiant Energy to Surface <x>
This field is paired with the preceding surface name (previous field) to define the fraction of
radiant heat transfer leaving the high temperature radiant system that is incident on a
particular surface. Users should take into account the directionality of high temperature
radiant heaters and their location when defining the value for this input field. Note that the
sum of all fractions plus the fraction of radiant energy incident on people must add up to less
than or equal to 1.
An example IDF with a high temperature radiant system is shown below.
ZoneHVAC:HighTemperatureRadiant, Zone 2 Radiant Heater,
RadiantPanelAvailSched ,
! Availability schedule
EAST ZONE ,
! Zone name (name of zone system is serving)
10000,
!- Heating Design Capacity{ W }
,
!- Heating Design Capacity Per Floor Area{ W / m2 }
,
!- Fraction of Autosized Heating Design Capacity{ -}
Gas,
! type of heater (either gas or electric)
0.8,
! combustion efficiency (ignored for electric radiant heaters)
0.80,
! fraction radiant
0.00,
! fraction latent
0.00,
! fraction lost
OperativeTemperature,
! temperature control type (controls on operative temperature)
2.0 ,
! heating throttling range (in C)
Radiant Heating Setpoints, ! heating setpoint temperatures
0.04,
! fraction of radiant energy that is incident directly on people
Zn002:Flr001, 0.80,
! fraction of radiant energy that is incident on the surface indicated
Zn002:Wall001, 0.04,
! fraction of radiant energy that is incident on the surface indicated
Zn002:Wall002, 0.04,
! fraction of radiant energy that is incident on the surface indicated
Zn002:Wall003, 0.04,
! fraction of radiant energy that is incident on the surface indicated
Zn002:Wall004, 0.04;
! fraction of radiant energy that is incident on the surface indicated

High Temperature Radiant (ZoneHVAC) Outputs

HVAC,Average, Zone Radiant HVAC Heating Rate [W]
HVAC,Sum, Zone Radiant HVAC Heating Energy [J]
HVAC,Average, Zone Radiant HVAC Gas Rate [W]
HVAC,Sum, Zone Radiant HVAC Gas Energy [J]
HVAC,Average, Zone Radiant HVAC Electric Power[W]
HVAC,Sum, Zone Radiant HVAC Electric Energy [J]

9/29/14

1157

Input-Output Reference

Group Radiative / Convective Units

Zone Radiant HVAC Heating Rate [W]

This field reports the rate at which energy is transferred from the high temperature radiant
system to the zone in Watts. This rate is determined by the zone conditions and the control
scheme defined in the user input. Note that this amount takes into account any combustion
inefficiency and thus could be different that the gas consumption rate in a high temperature
gas radiant system.
Zone Radiant HVAC Heating Energy [J]
This field reports the amount of energy transferred from the high temperature gas radiant
system to the zone in Joules. This amount is determined by the zone conditions, the control
scheme defined in the user input, and the timestep. Note that this amount takes into account
any combustion inefficiency and thus could be different that the gas consumption in a high
temperature gas radiant system.
Zone Radiant HVAC Gas Rate [W]
This field reports the rate at which gas is burned in a high temperature gas radiant system
in Watts. This rate is determined by the zone conditions and the control scheme defined in
the user input.
Zone Radiant HVAC Gas Energy [J]
This field reports the amount of gas burned in a high temperature gas radiant system in
Joules. This amount is determined by the zone conditions, the control scheme defined in the
user input, and the timestep.
Zone Radiant HVAC Electric Power[W]
This field reports the rate at which electric energy is burned in a high temperature electric
radiant system in Watts. This rate is determined by the zone conditions and the control
scheme defined in the user input.
Zone Radiant HVAC Electric Energy [J]
This field reports the amount of electric energy burned in a high temperature electric radiant
system in Joules. This amount is determined by the zone conditions, the control scheme
defined in the user input, and the timestep.
ZoneHVAC:VentilatedSlab
Ventilated slab systems in general use outdoor air to precool slabs with colder nighttime air.
This method of precooling the thermal mass of a space can be very effective when nighttime
temperatures are low and the mass of the system is high enough to provide a significant
amount of cooling potential during the day to counteract internal heat gains within a zone.
Nearly all ventilated slabs are simple systems such as that shown in the right side of Figure
128. The fan is shown in a blow through position, but the model will allow either a blow or
draw through configuration.

9/29/14

1158

Input-Output Reference

Group Radiative / Convective Units

Figure 128. Ventilated Slab model - basic system

Field: Name
This field is a unique user assigned name for an instance of a ventilated slab system. Any
reference to this unit by another object will use this name. Other objects that use this
ventilated slab system will reference it by this name.
Field: Availability Schedule Name
This field is the name of the schedule (ref: Schedule) that denotes whether the ventilated slab
system can run during a given time period. A schedule value less than or equal to 0 (usually
0 is used) denotes that the unit must be off for that time period. A value greater than 0
(usually 1 is used) denotes that the unit is available to operate during that time period. If this
field is left blank, the schedule has a value of 1 for all time periods.

Figure 129. Example operating schedule for Ventilated Slab

Field: Zone Name
This field is the name of the zone (Ref: Zone) in which the ventilated slab system is
principally located and intended to affect. A system that is between two zones will still act
upon each zone; however, the zone name referenced here should be the zone that controls
the system response.
Field: Surface Name or Radiant Surface Group Name
This field is the name of the surface (Ref: Surface) or surface list (Ref:
ZoneHVAC:VentilatedSlab:SlabGroup) in which the hollow cores are embedded/contained.
9/29/14

1159

Input-Output Reference

Group Radiative / Convective Units

This specification attaches the source or sinks from the radiant system to a particular surface
and the contribution of the system to the heat balances of that surface. If this field is a surface
list, then the source or sink is attached to all of the surfaces in the list with the radiant system
surface group defining the breakdown of how flow rate is split between the various surfaces.
Only base surfaces (Walls, Roofs, Floors) are valid. Window/Door surfaces and Internal Mass
are not valid surface types for embedded radiant systems.
Field: Maximum Air Flow Rate
This field allows the user to enter the maximum volumetric flow rate of air through the
ventilated slab system in m 3/sec. This parameter should be some real number greater than
zero.
Field: Outdoor Air Control Type
This field allows the user to control how outdoor air is used in the ventilated slab system. The
ventilated slab system described by this syntax has its own outdoor air handler. The three
options for outdoor air control are VariablePercent, FixedTemperature and
FixedAmount. Those keywords are the only allowed choices for this parameter. In
general, the variable percent control will attempt to vary the amount of outdoor air between
some minimum and maximum schedules of fractions (see next two fields) to best meet the
current heating or cooling load. The fixed temperature control will vary the amount of outdoor
air between the minimum schedule (fraction of maximum, see next field) and 100% available
outdoor air to come as close as possible to a desired mixed air temperature (see two fields
down) that can be scheduled. The fixed amount control will fix the outdoor air flow rate as
minimum outdoor air flow rate and schedule specified by the user and automatically set the
maximum and minimum outside flow rate to be equal by ignoring the maximum outdoor air
flow rate. More information on the controls and operation of the ventilated slab are given in
the section above (preceding the IDF description).
Field: Minimum Outdoor Air Flow Rate
This field allows the user to enter the minimum volumetric flow rate of outdoor air (in m 3/sec)
that will be brought in to the ventilated slab. The actual minimum outdoor air flow rate will be
this number multiplied by the schedule value from the minimum outdoor air schedule. If
FixedAmount type is selected as the outdoor air control strategy, the outdoor air flow rate
will be fixed at the value of this field and the ventilated slab will automatically set the
maximum and minimum outside flow rate to be equal by ignoring the maximum outdoor air
flow rate.
Field: Minimum Outdoor Air Schedule Name
This field contains a schedule name (ref: Schedule) that should contain values for the
minimum outdoor air used by the ventilated slab system for IAQ or other reasons. Note that if
the ventilated slab is scheduled off or if there is no load sensed in the zone that the system
will not operate even to achieve the minimum air fraction. However, if the system is
operating, it will always bring in at least this fraction of the minimum air flow rate (see
minimum air flow rate field above). If FixedAmount type is selected as the outdoor air
control strategy, the actual outdoor air flow rate will be this number multiplied by the minimum
outdoor air flow rate in the field above. The ventilated slab will automatically set the maximum
and minimum outdoor air schedule to be equal by ignoring the maximum outdoor air
schedule.
Field: Maximum Outdoor Air Flow Rate
This field allows the user to enter the maximum volumetric flow rate of outdoor air that can be
brought into the ventilated slab in m 3/sec. This parameter should be some real number
greater than zero. Note that the value for this parameter may be less than the maximum air
flow rate of the ventilated slab and this may affect the maximum fraction of outdoor air within
the control strategy defined above. This parameter is an absolute maximum and will
9/29/14

1160

Input-Output Reference

Group Radiative / Convective Units

supercede any scheduled fraction of the ventilated slab maximum airflow rate. If
FixedAmount type is selected as the outdoor air control strategy, this field will be ignored
and be automatically set to be equal to the minimum outdoor air flow rate specified in the field
above.
Field: Maximum Outdoor Air Fraction or Temperature Schedule Name
This field can have one of two meanings depending the type of control selected in the
outdoor air control type parameter above. If VariablePercent or FixedAmount was
selected, then this field is a schedule name (ref: Schedule) corresponding to a maximum air
fraction schedule. Furthermore, if FixedAmount type is selected as the outdoor air control
strategy, this field will be ignored and be automatically set to be equal to the minimum
outdoor air fraction specified in the field below. Note that this is a fraction of the maximum
airflow rate field (see parameter above) for the ventilated slab. If FixedTemperature control
was selected, then this field is still a schedule name (ref: Schedule), but it corresponds to a
schedule of mixed air temperatures that the outdoor air control will try to attain.
Field: System Configuration Type
This field allows the user to control how the air is circulated using the ventilated slab system.
The options for system configuration are
SlabOnly
SlabAndZone
SeriesSlabs

In the SlabOnly, the ventilation air is sent to the slab only and does not enter the zone. In
the SlabAndZone, the air first enters the slab and then is delivered to the zone before
returning to the system. With the SeriesSlabs option, the user specifies a list of slabs
(ZoneHVAC:VentilatedSlab:SlabGroup). This list determines the order of slabs through which
the air passes. In this option, air is not delivered to any zone.
Field: Hollow Core Inside Diameter
This field is the inside diameter of the cores through which air is circulated for the system
being defined by this statement. The inside diameter should be recorded in meters and is
used to determine the convective heat transfer from the circulated air to the inside surface of
the ventilated slab.
Field: Hollow Core Length
This field is the length of core embedded in the surface named above in the surface name
field. In other words, this should be the distance that air travels as it through the slab. The
length of the hollow core in the slab should be entered in meters and is used to determine the
effectiveness of heat transfer from the air being circulated through the cores and the core
inside surface. Longer core lengths result in more heat transferred to/from the radiant
surface to the circulating fluid.
Field: Number of Cores
This field allows the user to specify how many cores there are in the ventilated slab. Air flow
will be divided equally among the different cores.
Field: Temperature Control Type
This field specifies along with the throttling range and setpoint schedules how the user
wishes to control the ventilated slab system. The temperature denoted in the set temperature
schedule can refer to one of seven different temperatures: the zone mean air temperature,
the zone mean radiant temperature, the zone operative temperature, the surface temperature
of the ventilated slab, the outdoor dry-bulb temperature, the outdoor wet-bulb temperature, or
the dewpoint temperature of zone mean air temperature. The choice of temperature is
controlled by the current fieldtemperature control type. The user must select from the
following options:
9/29/14

1161

Input-Output Reference

Group Radiative / Convective Units

MeanAirTemperature
MeanRadiantTemperature
OperativeTemperature
OutdoorDryBulbTemperature
OutdoorWetBulbTemperature
SurfaceTemperature
ZoneAirDewPointTemperature

If the user does not select a control type, MeanAirTemperature control is assumed by
EnergyPlus. See the control temperature schedule fields below for more information.
Field: Heating High Air Temperature Schedule Name
This field specifies the high air temperature in degrees Celsius for the temperature control of
a ventilated slab system. Air and control temperatures for heating work together to provide a
linear function that determines the air temperature sent to the ventilated slab. The current
control temperature (see Temperature Control Type above) is compared to the high and low
control temperatures at the current time.
If the control temperature is above the high
temperature, then the inlet air temperature is set to the low air temperature. If the control
temperature is below the low temperature, then the inlet air temperature is set to the high air
temperature. If the control temperature is between the high and low value, then the inlet air
temperature is linearly interpolated between the low and high air temperature values.
Field: Heating Low Air Temperature Schedule Name
This field specifies the low air temperature in degrees Celsius for the temperature control of a
ventilated slab. For more information on its interpretation, see Heating High Air Temperature
Schedule above.
Field: Heating High Control Temperature Schedule Name
This field specifies the high control temperature in degrees Celsius for the temperature
control of a ventilated slab. For more information on its interpretation, see Heating High Air
Temperature Schedule above.
Field: Heating Low Control Temperature Schedule Name
This field specifies the low control temperature in degrees Celsius for the temperature control
of a ventilated slab. For more information on its interpretation, see Heating High Air
Temperature Schedule above.
Field: Cooling High Air Temperature Schedule Name
This field specifies the high air temperature in degrees Celsius for the temperature control of
a ventilated slab system. Air and control temperatures for cooling work together to provide a
linear function that determines the air temperature sent to the ventilated slab system. The
current control temperature (see Temperature Control Type above) is compared to the high
and low control temperatures at the current time. If the control temperature is above the high
temperature, then the inlet air temperature is set to the low air temperature. If the control
temperature is below the low temperature, then the inlet air temperature is set to the high air
temperature. If the control temperature is between the high and low value, then the inlet air
temperature is linearly interpolated between the low and high air temperature values.
Field: Cooling Low Air Temperature Schedule Name
This field specifies the low air temperature in degrees Celsius for the temperature control of a
constant flow cooling radiant system. For more information on its interpretation, see Cooling
High Air Temperature Schedule above.
Field: Cooling High Control Temperature Schedule Name
This field specifies the high control temperature in degrees Celsius for the temperature
control of a constant flow cooling radiant system. For more information on its interpretation,
see Cooling High Air Temperature Schedule above.
9/29/14

1162

Input-Output Reference

Group Radiative / Convective Units

Field: Cooling Low Control Temperature Schedule Name

This field specifies the low control temperature in degrees Celsius for the temperature control
of a ventilated slab system. For more information on its interpretation, see Cooling High Air
Temperature Schedule above.
Field: Return Air Node Name
This field is a node name used to identify the node that serves as the zone return air inlet to
the ventilated slab system. This node is one of the inlets to the outdoor air mixer which is
implicit in the ventilated slab system model. For SlabAndZone configuration, the Return Air
Node will typically be the same node as a zone exhaust node. For SlabOnly or
SeriesSlabs configuration, this node name is required but will have zero flow.
Field: Slab In Node Name
This field is a node name used to identify the node that serves as the inlet of the ventilated
slab or series of slabs, after the outdoor air mixer, fan, and optional coils.
Field: Zone Supply Air Node Name
This field is a node name used to identify the node that serves as the outlet from the
ventilated slab system to the zone when using the SlabAndZone configuration. It is the node
exiting the slab section of the system. This node will typically be the same node as a zone
inlet node. In the case of SlabOnly or SeriesSlabs configuration, this field will be ignored
and it should be left BLANK.
Field: Outdoor Air Node Name
This field is a node name used to identify the node associated with fresh outdoor air brought
into the ventilated slab system outdoor air mixer. This node should also be specified in an
OutdoorAir:Node or OutdoorAir:NodeList object.
Field: Relief Air Node Name
This field is a node name used to identify the node associated with air exhausted out of the
ventilated slab system to the outdoor environment.
Field: Outdoor Air Mixer Outlet Node Name
This field is a node name used to identify the node associated with the mixed air of the
ventilated slab. These conditions are post-mixing box since they are the conditions of the
fraction of return air combined with the outdoor air. Since this is a simple system, this can
also be viewed as the conditions of the air being sent to the coils.
Field: Fan Outlet Node Name
This field is a node name used to identify the node that serves as the air outlet from the fan.
Field: Fan Name
This field is the name of a fan (ref: Fan:ConstantVolume) that is part of the ventilated slab
system. This name links the ventilated slab to particular fan data entered elsewhere in the
input data file. A fan name is required since it is the prime mover of air in the ventilated slab
system.
Field: Coil Option Type
This field allows the user to specify the coil operating options as one of the following options:
None
Heating
Cooling
HeatingAndCooling

9/29/14

1163

Input-Output Reference

Group Radiative / Convective Units

If None is selected, the ventilated slab does not have any coils, and any other input will be
ignored. If either Heating or Cooling is selected, only a heating or cooling coil, respectively,
is present. Thus, only four more inputs will be expected. If HeatingAndCooling is selected,
both heating and cooling coil input must be entered, and the ventilated slab will have both a
heating and a cooling coil.
Field: Heating Coil Object Type
This field is the type of coil (ref: Coil:Heating:Water, Coil:Heating:Electric, Coil:Heating:Gas,
Coil:Heating:Steam) that is used for heating in the ventilated slab system. This field must be
one of the following keywords: Coil:Heating:Water, Coil:Heating:Electric, Coil:Heating:Gas,
Coil:Heating:Steam. It is used in conjunction with the heating coil name (see next field) to
specify the heating coil present within the system.
Field: Heating Coil Name
This field is the name of the heating coil that is part of the ventilated slab system. It is
assumed that there is always some sort of heating coil associated with a ventilated slab
system. This name links the ventilated slab to particular heating coil data entered elsewhere
in the input data file.
Field: Hot Water or Steam Inlet Node Name
This field corresponds to the water inlet node to the heating coil for a water coil. The water
inlet node controls how a water heating coil operates. This field is ignored/not needed for gas
and electric heating coils.
Field: Cooling Coil Object Type
This
field
is
the
name
of
the
cooling
coil
(ref:
Coil:Cooling:Water,
Coil:Cooling:Water:DetailedGeometry,
CoilSystem:Cooling:Water:HeatExchangerAssisted)
that is part of the ventilated slab system. This name links the ventilated slab system to
particular cooling coil data entered elsewhere in the input data file. If no cooling coil is
present, the previous field may be followed by a semi-colon and the remaining parameters in
this statement may be ignored.
Field: Cooling Coil Name
This field is the name of the cooling coil that is part of the ventilated slab system. It is
assumed that there is always some sort of cooling coil associated with a ventilated slab
system. This name links the ventilated slab to particular cooling coil data entered elsewhere
in the input data file.
Field: Cold Water Inlet Node Name
This field corresponds to the water inlet node to the cooling coil. The water inlet node
controls how a water cooling coil operates and is required for the ventilated slab system that
has a cooling coil associated with it to function properly.
Field: Availability Manager List Name
This optional input field is the name of an AvailabilityManagerAssignmentList object. An
Availability Manager Assignment List is a list of Availability Managers giving both Availability
Manager type and name. The availability managers in the list apply to this ventilated slab
objects fan. If the ventilated slab is available (per the Availability Schedule Name input field
above) and this input field has a valid availability manager assignment list name, then the
availability managers in the list determine when and if the fan of this ventilated slab object
should be on or off.
Field: Design Specification ZoneHVAC Sizing Object Name
This optional input field is the name of a DesignSpecificationZoneHVACSizing object. The
name must correspond to unique name of a DesignSpecification:ZoneHVAC:Sizing object. A
9/29/14

1164

Input-Output Reference

Group Radiative / Convective Units

Design Sepcification Zone HVAC Sizing object defines scalable sizing methods for sizing
input fields such as Maximum Air Flow Rate in this Ventilated Slab zone HVAC object. The
scaled Maximum Air Flow Rate in turn is used to size cooling and heating capacity of the
coils.
An example IDF with a ventilated slab is shown below.
ZoneHVAC:VentilatedSlab,
Zone4VentSlab,
!- Name
VentSlabAvailability,
!- Availability Schedule Name
SPACE4-1,
!- Zone Name
F4-1,
!- Surface Name or Radiant Surface Group Name
0.84,
!- Maximum Air Flow Rate {m3/s}
VariablePercent,
!- Outdoor Air Control Type
0.168,
!- Minimum Outdoor Air Flow Rate {m3/s}
U2MinOASched,
!- Minimum Outdoor Air Schedule Name
0.84,
!- Maximum Outdoor Air Flow Rate {m3/s}
VentSlabMaxOA,
!- Maximum Outdoor Air Fraction or Temperature Schedule Name
SlabAndZone,
!- System Configuration Type
0.050,
!- Hollow Core Inside Diameter {m}
15.0,
!- Hollow Core Length {m}
50.0,
!- Number of Cores
MeanRadiantTemperature, !- Temperature Control Type
VentSlabHotHighAir,
!- Heating High Air Temperature Schedule Name
VentSlabHotLowAir,
!- Heating Low Air Temperature Schedule Name
VentSlabHotHighControl, !- Heating High Control Temperature Schedule Name
VentSlabHotLowControl,
!- Heating Low Control Temperature Schedule Name
VentSlabCoolHighAir,
!- Cooling High Air Temperature Schedule Name
VentSlabCoolLowAir,
!- Cooling Low Air Temperature Schedule Name
VentSlabCoolHighControl, !- Cooling High Control Temperature Schedule Name
VentSlabCoolLowControl, !- Cooling Low Control Temperature Schedule Name
Zone4VentSlabReturnAirNode, !- Return Air Node Name
Zone4VentslabSlabInNode, !- Slab In Node Name
Zone4Inlets,
!- Zone Supply Air Node Name
Zone4VentSlabOAInNode,
!- Outdoor Air Node Name
Zone4VentSlabExhNode,
!- Relief Air Node Name
Zone4VentSlabOAMixerOutletNode, !- Outdoor Air Mixer Outlet Node Name
Zone4VentSlabFanOutletNode, !- Fan Outlet Node Name
Zone4VentSlabFan,
!- Fan Name
HeatingAndCooling,
!- Coil Option Type
Coil:Heating:Electric,
!- Heating Coil Object Type
Zone4VentSlabHeatingCoil,!- Heating Coil Name
,
!- Hot Water or Steam Inlet Node Name
Coil:Cooling:Water,
!- Cooling Coil Object Type
Zone4VentSlabCoolingCoil,!- Cooling Coil Name
Zone4VentSlabChWInletNode; !- Cold Water Inlet Node Name

Ventilated Slab (ZoneHVAC) Outputs

HVAC,Average,Zone Ventilated Slab Radiant Heating Rate [W]
HVAC,Sum,Zone Ventilated Slab Radiant Heating Energy [J]
HVAC,Average,Zone Ventilated Slab Radiant Cooling Rate [W]
HVAC,Sum,Zone Ventilated Slab Radiant Cooling Energy [J]
HVAC,Average,Zone Ventilated Slab Coil Heating Rate [W]
HVAC,Sum,Zone Ventilated Slab Coil Heating Energy [J]
HVAC,Average,Zone Ventilated Slab Coil Total Cooling Rate [W]
HVAC,Sum,Zone Ventilated Slab Coil Total Cooling Energy [J]
HVAC,Average,Zone Ventilated Slab Coil Sensible Cooling Rate [W]
HVAC,Sum,Zone Ventilated Slab Coil Sensible Cooling Energy [J]
HVAC,Average,Zone Ventilated Slab Coil Latent Cooling Rate [W]
HVAC,Sum,Zone Ventilated Slab Coil Latent Cooling Energy [J]
HVAC,Average, Zone Ventilated Slab Air Mass Flow Rate [kg/s]
HVAC,Average, Zone Ventilated Slab Fan Electric Power [W]
HVAC,Sum,Zone Ventilated Slab Fan Electric Energy [J]
HVAC,Average,Zone Ventilated Slab Inlet Air Temperature [C]
HVAC,Average,Zone Ventilated Slab Outlet Air Temperature [C]
HVAC,Average,Zone Ventilated Slab Zone Inlet Air Temperature [C]
9/29/14

1165

Input-Output Reference

Group Radiative / Convective Units

HVAC,Average,Zone Ventilated Slab Return Air Temperature [C]

HVAC,Average,Zone Ventilated Slab Fan Outlet Air Temperature [C]
HVAC,Average,Zone Ventilated Slab Fan Availability Status []

Zone Ventilated Slab Radiant Heating Rate [W]

This field reports the radiant heating input rate of the ventilated slab system to the zone it is
serving in Watts. This is determined by outlet and zone air conditions and the mass flow rate
through the ventilated slab system.
Zone Ventilated Slab Radiant Heating Energy [J]
This field is the heating radiant input of the ventilated slab system to the zone it is serving in
Joules over the timestep being reported. This is determined by outlet and zone air
conditions, the mass flow rate through the ventilated slab system, and the timestep.
Zone Ventilated Slab Radiant Cooling Rate [W]
This field reports the radiant cooling input rate to the ventilated slab system in Watts. This is
the heat sink to the surface that is defined as the ventilated slab system. The cooling rate is
determined by the zone conditions and the control scheme defined in the user input.
Zone Ventilated Slab Radiant Cooling Energy [J]
This field reports the radiant cooling input to the ventilated slab system in Joules. This is the
heat sink to the surface that is defined as the radiant system. The cooling rate is determined
by the zone conditions, the control scheme defined in the user input, and the timestep.
Zone Ventilated Slab Coil Heating Rate [W]
This field reports the heating input rate of the heating coil of ventilated slab system the zone it
is serving in Watts. This is determined by return air and zone air conditions and the mass
flow rate through the ventilation slab system.
Zone Ventilated Slab Coil Heating Energy [J]
This field is the heating output of the heating coil of the ventilated slab system the zone it is
serving in Joules over the timestep being reported. This is determined by return air and zone
air conditions, the mass flow rate through the ventilation slab system, and the timestep.
Zone Ventilated Slab Coil Total Cooling Rate [W]
This field reports the total cooling (sensible plus latent) output rate of the cooling coil of the
ventilated slab system to the zone it is serving in Watts. This is determined by outlet and
zone air conditions and the mass flow rate through the ventilation slab system.
Zone Ventilated Slab Coil Total Cooling Energy [J]
This field is the total cooling (sensible plus latent) output of the cooling coil of the ventilated
slab system to the zone it is serving in Joules over the timestep being reported. This is
determined by outlet and zone air conditions, the mass flow rate through the ventilation slab
system, and the timestep.
Zone Ventilated Slab Coil Sensible Cooling Rate [W]
This field reports the sensible cooling output rate of the cooling coil of the ventilated slab
system to the zone it is serving in Watts. This is determined by outlet and zone air conditions
and the mass flow rate through the ventilation slab system.
Zone Ventilated Slab Coil Sensible Cooling Energy [J]
This field is the sensible cooling output of the cooling coli of the ventilated slab system to the
zone it is serving in Joules over the timestep being reported. This is determined by outlet and
zone air conditions, the mass flow rate through the ventilation slab system, and the timestep.

9/29/14

1166

Input-Output Reference

Group Radiative / Convective Units

Zone Ventilated Slab Coil Latent Cooling Rate [W]

This field reports the latent cooling output rate of the cooling coil of the ventilated slab system
to the zone it is serving in Watts. This is determined by outlet and zone air conditions and the
mass flow rate through the ventilation slab system.
Zone Ventilated Slab Coil Latent Cooling Energy [J]
This field is the latent cooling output of the cooling coli of the ventilated slab system to the
zone it is serving in Joules over the timestep being reported. This is determined by outlet and
zone air conditions, the mass flow rate through the ventilation slab system, and the timestep.
Zone Ventilated Slab Air Mass Flow Rate [kg/s]
This field reports the mass flow rate of air through the ventilated slab system in kilograms per
second.
Zone Ventilated Slab Fan Electric Power [W]
This field reports the electric power consumption rate of the fan of the ventilated slab system
in Watts.
Zone Ventilated Slab Fan Electric Energy [J]
This field reports the electric power consumed by the fan of the ventilated slab system over
the timestep in Joules.
Zone Ventilated Slab Inlet Air Temperature [C]
This field reports the temperature of air entering the ventilated slab system in Celsius.
Zone Ventilated Slab Outlet Air Temperature [C]
This field reports the temperature of air leaving the ventilated slab system in Celsius.
Zone Ventilated Slab Zone Inlet Air Temperature [C]
This field reports the temperature of air entering the zone in Celsius.
Zone Ventilated Slab Return Air Temperature [C]
This field reports the temperature of air leaving the zone in Celsius. When system does not
circulate air to zone(SlabOnly Configuration), the slab outlet temperature and return air
temperature will be the same.
Zone Ventilated Slab Fan Outlet Air Temperature [C]
This field reports the fan outlet air temperature for the ventilated slab system in Celsius.
Zone Ventilated Slab Fan Availability Status []
This is the availability status of the ventilated slab fan. This status flag is a result of the
calculations
made
by
the
Availability
Manager(s)
listed
in
an
AvailabilityManagerAssignmentList object and/or calculations made by Hybrid Ventilation
Manager object. The AvailabilityManagerAssignmentList is an optional input in the ventilated
slab object. When a single availability manager is used in an Availability Manager
Assignment List, this is also the availability status reported by the specific availability
manager (Ref. AvailabilityManager:* Outputs). For multiple availability managers in an
Availability Manager Assignment List along with Hybrid Ventilation Manager, rules to
determine fan availability status are described in the section Group System Availability
Managers. The control status outputs are represented using integers 0 through 3. These
integers represent NoAction (0), ForceOff (1), CycleOn (2), and CycleOnZoneFansOnly (3).
Since the status output is averaged, the output result may not correspond to the values
described here when output variable frequencies other than detailed are used. Use the

9/29/14

1167

Input-Output Reference

Group Radiative / Convective Units

detailed reporting frequency (Ref. Output:Variable object) to view the availability status at
each simulation timestep.
ZoneHVAC:VentilatedSlab:SlabGroup
A ventilated slab system may consist of multiple active slabs that are serving to condition the
zone. Slabs that act serially can be specified as multiple radiant systems using the standard
ventilated slab input described above. This list of surfaces (the name it is assigned) replcaces
the name of a single surface in the ventilated slab system input described above.
Field : Name of Ventilated Slab Surface Group
This field is a unique user assigned name for the list of surfaces that are acting in
coordination with one another. Any reference to this list by a ventilated slab system will use
this name.
Field: Zone Name
This field is the name of the zone in which the surface is principally located and intended to
affect.
Field: Surface Name
This field is the name of a surface in the zone being conditioned by the ventilated slab
system. Only base surfaces like walls, floors and roofs are valid. Door/Window Surface and
Internal Mass are not valid surface types for the ventilated slab system.
Field: Core Diameter
This field is the inside diameter of the cores through which air is circulated for the surface
being defined by this statement. The inside diameter should be recorded in meters and is
used to determine the convective heat transfer from the circulated air to the inside surface of
the ventilated slab.
Field: Core length
This field is the length of core embedded in the surface named above in the surface name
field. In other words, this should be the distance that air travels as it through the slab. The
length of the hollow core in the surface should be entered in meters and is used to determine
the effectiveness of heat transfer from the air being circulated through the cores and the core
inside surface. Longer core lengths result in more heat transferred to/from the radiant
surface to the circulating fluid.
Field: Number of Cores
This field allows the user to specify how many cores there are in the ventilated slab. Air flow
will be divided equally among the different cores.
Field: Slab Inlet Node Name
This field is a node name (character string) used to identify the node that serves as the inlet
(air side) to the surface. In EnergyPlus, nodes represent points between components or at
various points in the loops. While a node name may be referenced more than once in an
input data file, each node must have a unique name.
Field: Slab Outlet Node Name
This field is a node name (character string) used to identify the node that serves as the outlet
(air side) of the surface. In EnergyPlus, nodes represent points between components or at
various points in the loops. While a node name may be referenced more than once in an
input data file, each node must have a unique name.
An Example IDF with a ventilated slab system is shown below

9/29/14

1168

Input-Output Reference

Group Refrigeration

ZoneHVAC:VentilatedSlab:SlabGroup,
Z125,
!- Name
SPACE1-1,
!- Zone 1 Name
C1-1,
!- Surface 1 Name
0.05,
!- Core Diameter for Surface 1
30,
!- Core Length for Surface 1
20,
!- Core Numbers for Surface 1
Z1VentslabIn,
!- Slab In Node Name for Surface 1
Z1VentSlabout,
!- Slab Outlet Node Name for Surface 1
SPACE2-1,
!- Zone 2 Name
C2-1,
!- Surface 2 Name
0.05,
!- Core Diameter for Surface 2
15,
!- Core Length for Surface 2
20,
!- Core Numbers for Surface 2
Z2VentSlabIn,
!- Slab In Node Name for Surface 2
Z2VentSlabOut,
!- Slab Outlet Node Name for Surface 2
SPACE5-1,
!- Zone 3 Name
C5-1,
!- Surface 3 Name
0.05,
!- Core Diameter for Surface 3
30,
!- Core Length for Surface 3
20,
!- Core Numbers for Surface 3
Z5VentSlabIn,
!- Slab In Node Name for Surface 3
Z5VentSlabOut;
!- Slab Outlet Node Name for Surface 3

Group Refrigeration
There are two ways to model a supermarket refrigeration system. The first, and simplest,
approach models the combination of compressor(s) and condenser as a single refrigeration
compressor rack object. (A list is used to enter multiple case or walk-in names.)
For the first approach, the input objects needed are:
One Refrigeration:CompressorRack object
At least one refrigeration load, which may be any combination of:
Refrigeration:Case or
Refrigeration:WalkIn or
Refrigeration:CaseAndWalkInList objects .
The second approach requires more input objects but also allows the user to model more
complex systems. This detailed approach must be used whenever loads are transferred from
one system to another, such as with secondary loops, cascade condensers, or mechanical
subcoolers. Again lists are used to enter multiple load or compressor names.
For the detailed approach, the input objects needed are:
One Refrigeration:System object
At least one refrigeration load object which may include any combination of:
Refrigeration:Case,
Refrigeration:WalkIn,
Refrigeration:CaseAndWalkInList (may include any combination of cases and walk in
cooler names, OR, a list of air chiller names)
Refrigeration:SecondarySystem,
Refrigeration:Condenser:Cascade (as a load, cooling a lower-temperature system)
objects,
Refrigeration:TransferLoadList (may include cascade condenser loads and/or
secondary loop loads)
Refrigeration:AirChiller
At least one Refrigeration:Compressor object (multiple compressors are entered using a
Refrigeration:CompressorList),
One condenser object which may be either:
9/29/14

1169

Input-Output Reference

Group Refrigeration

Refrigeration:Condenser:AirCooled,
Refrigeration:Condenser:EvaporativeCooled,
Refrigeration:Condenser:WaterCooled, or
Refrigeration:Condenser:Cascade (rejecting heat from this system)
The object Refrigeration:Subcooler may optionally be included to describe either a liquid
suction or mechanical subcooler.
Output variables are also available to describe the total heat exchange between all
refrigeration objects and the zones containing these objects. These variables are described
at the end of this section after all the refrigeration objects.
Refrigeration:CompressorRack
The refrigeration compressor rack object works in conjunction with the refrigeration case and
walkin objects (Ref. Refrigeration:Case and Refrigeration:WalkIn) to simulate the
performance of a refrigerated case system. This object models the electric consumption of
the rack compressors and the condenser fans. Heat removed from the refrigerated cases,
walkins, and compressor/condenser fan heat can be rejected either outdoors or to a zone.
Compressor rack waste heat can also be reclaimed for use by an optional air- or waterheating coil (Ref. Coil:Heating:Desuperheater and Coil:WaterHeating:Desuperheater).
If heat is rejected outdoors, condenser cooling can either be accomplished by direct air flow,
evaporative water cooling, or a by water-cooled condenser with appropriate plant loop piping.
With evaporative cooling, water is sprayed through the air stream to effectively lower the air
temperature experienced by the condenser coil as a result of water evaporation. The use of a
water-cooled condenser requires the definition of a plant loop to supply cooling to the
condenser. Waste heat can be reclaimed and stored using a water storage device.
The inputs for the compressor rack object include a name, the heat rejection location, the
compressor rack coefficient of performance (COP) at design conditions, the design
condenser fan power, and the type of condenser cooling. The model requires two curve
objects to describe performance at off-design conditions. If the condenser is water-cooled,
the inlet and outlet node names as well as the water outlet temperature schedule name are
required. If the condenser has evaporative cooling, additional inputs for evaporative
condenser effectiveness, condenser air flow rate, basin heater parameters, water pump
power, water source, and an evaporative cooling availability schedule are available. The
names of refrigerated cases and walkins connected to the compressor rack are the final
inputs to the model.
Field: Name
A unique user-assigned name for an instance of a refrigeration compressor rack. Any
reference to this compressor rack by another object will use this name.
Field: Heat Rejection Location
The location of the compressor racks condenser. The compressor rack condenser heat can
be directed Outdoors to model an outdoor air or water-cooled condenser or Zone to model
a condenser located in a zone (e.g., a stand-alone packaged refrigerated case with integral
condenser located in a conditioned zone). The default for this field is Outdoors. If the heat
rejection location is Zone and no walk-in coolers are served by this compressor rack, then
all refrigerated cases connected to this compressor rack must be located in the same zone. If
however, walk-in coolers are also served by this compressor rack, then the heat rejection
zone name must be specified (see Heat Rejection Zone Name field below) and cases and
walk-ins can be located in multiple zones.

9/29/14

1170

Input-Output Reference

Group Refrigeration

NOTE: When modeling a heat reclaim coil, the heat rejection location must be Outdoors. If the heat
rejection location is Zone, the total amount of waste heat available for reclaim (e.g., by a desuperheater
heating coil) is set to zero by this compressor rack object and the simulation proceeds.

Field: Design Compressor Rack COP

The coefficient of performance (COP) for the compressor rack at design conditions
(compressors only, excluding condenser fan power). This value must be greater than zero,
with a default value of 2.0 if this field is left blank. This value should represent the compressor
rack COP corresponding to the lowest evaporating temperature of any case or walkin served
by the rack.
Field: Compressor Rack COP Function of Temperature Curve Name
The name of the curve object defining the change in compressor rack COP as a function of
the temperature of air entering the condenser. The curve object will be evaluated using the
zone air dry-bulb temperature when rack heat rejection location equals Zone and the
outdoor air dry-bulb temperature when rack heat rejection location equals Outdoors and the
condenser type is air-cooled. As explained below, if the condenser is cooled by evaporative
or water loop cooling, the curve object is evaluated using an effective temperature. The
output from this curve is multiplied by the design compressor rack COP to yield the actual
COP at the specific air temperature entering the condenser. This curve must be cubic or
quadratic (Curve:Cubic or Curve:Quadratic), and should be normalized to 1.0 at the
condenser entering air temperature at which the design compressor rack COP occurs. This
curve should represent the compressor rack COP corresponding to the lowest evaporating
temperature of any case served by the rack.
Field: Design Condenser Fan Power
This field defines the design power for the condenser fan(s) in Watts. This field is applicable
for air or evaporative cooling only. If the condenser is water-cooled, the fan power is
captured in the cooling object (e.g., cooling tower). If applicable, this value must be greater
than 0.0, with a default value of 250 Watts if this field is left blank.
Field: Condenser Fan Power Function of Temperature Curve Name
This field is the name of the curve object defining the change in condenser fan power as a
function of the temperature of air entering the condenser. This curve is used to simulate the
modulation of air flow by the condenser fans (e.g., staging, multi-speed, or variable speed) as
a function of temperature. The curve object will be evaluated using the zone air dry-bulb
temperature when rack heat rejection location equals Zone and the outdoor air dry-bulb
temperature when rack heat rejection location equals Outdoors and the condenser type is
air-cooled. As explained below, if the condenser is cooled by evaporative cooling, the curve
object is evaluated using an effective temperature. The output from this curve is multiplied by
the design condenser fan power to yield the actual fan power at the specific air temperature
entering the condenser. This curve must be cubic or quadratic (Curve:Cubic or
Curve:Quadratic), and should be normalized to 1.0 at the condenser entering air temperature
at which the design condenser fan power occurs. The actual condenser fan power is not
allowed to exceed the design condenser fan power defined in the previous input field or go
below zero (i.e., the output of the curve object is limited to values from 0.0 to 1.0). If this field
is left blank, then the model assumes the condenser fan power is at the design power level
when any of the refrigerated cases connected to this rack are operating.
Field: Condenser Type
When the heat rejection location is Outdoors, the condenser may be either cooled by dry air
by specifying AirCooled, by wet evaporative cooling by specifying EvaporativelyCooled, or
by a water loop by specifying WaterCooled. If the condenser type is WaterCooled, then a
9/29/14

1171

Input-Output Reference

Group Refrigeration

plant cooling loop will need to be defined using other EnergyPlus objects, e.g., plant loop,
pump, cooling tower, etc. The default value is AirCooled.
Field: Water-cooled Condenser Inlet Node Name
When the condenser type is WaterCooled, a node name for the water-side condenser inlet
must be provided.
Field: Water-cooled Condenser Outlet Node Name
When the condenser type is WaterCooled, a node name for the water-side condenser outlet
must be provided.
Field: Water-cooled Loop Flow Type
When the condenser type is WaterCooled, the type of flow loop should be specified. The
two choices are VariableFlow, in which a Pump:VariableSpeed needs to be included in the
plant loop, or ConstantFlow, in which the loop circuit has a constant flow rate, typically
associated with a Pump:ConstantSpeed object. If the flow type is VariableFlow, the flow
needed to remove the condenser heat energy will be calculated and requested of the pump.
If the flow type is Constant Flow, the outlet water temperature will be determined based on
the fixed loop flow rate and heat energy to be removed. The default type is VariableFlow.
Refer to additional discussion in the Engineering Reference.
Field: Water-cooled Condenser Outlet Temperature Schedule Name
When the condenser type is WaterCooled, and when the water-cooled loop flow type is
Variable Flow, the name of a schedule (Ref: Schedule) that defines the desired condenser
water outlet temperature must be provided. The schedule may define an outlet temperature
that varies through time.
Field: Water-cooled Condenser Design Flow Rate
When the condenser type is WaterCooled, and when the water-cooled loop flow type is
Constant Flow, this is the design water flow rate in m 3/s that will be requested initially. This
requested flow will be passed to the loop simulation, and resulting actual flow will be
dependent upon supply system capabilities (e.g., pump capability). The design flow rate
must always be less than the maximum flow rate, defined below.
Field: Water-cooled Condenser Maximum Flow Rate
When the condenser type is Water Cooled, this is the maximum water flow rate in m3/s that
will be allowed through the condenser. When the loop flow type is Variable Flow, if the
calculated flow rate is higher than the maximum flow rate, an error message will be
generated, and the flow rate will be reset to the maximum flow rate.
Field: Water-cooled Condenser Maximum Water Outlet Temperature
When the condenser type is WaterCooled, this field specifies the maximum allowed water
temperature in degrees C leaving the compressor rack condenser. The default value is 55
degrees C.
Field: Water-cooled Condenser Minimum Water Inlet Temperature
When the condenser type is WaterCooled, this field specifies the minimum allowed water
temperature in degrees C entering the compressor rack condenser. The default value is 10
degrees C. Refer to additional discussion in the Engineering Reference.
Field: Evaporative Condenser Availability Schedule Name
When the condenser type is EvaporativelyCooled, the name of the optional schedule (Ref:
Schedule) that specifies the time periods that evaporative cooling is available/unavailable. In
some colder climates, evaporative cooling is periodically discontinued and the basin sumps
drained to avoid freezing. In these times, the condenser runs as a typical dry air cooled
9/29/14

1172

Input-Output Reference

Group Refrigeration

condenser, and related evaporative cooling systems (e.g., water pump, basin heaters) do not
operate. Use of this optional schedule permits modeling of planned, seasonal interruptions of
evaporative cooling. All schedule values must be greater than or equal to zero. Typically, an
ON/OFF schedule type is used with values being either 0 or 1. A schedule value of 1
indicates that evaporative cooling is available during the defined time period, and a value of 0
denotes that evaporative cooling is not available during the defined time period. If the
schedule name is omitted (blank) and Condenser Type = Evap Cooled, then the model
assumes that evaporative cooling of the condenser is available for the entire simulation
period.
Field: Evaporative Condenser Effectiveness
When the condenser type is EvaporativelyCooled, this field specifies the effectiveness of
the evaporative system in modifying the temperature of the air entering the condenser coil.
The resulting effective temperature is determined as

Teffective

Towb

(1

)*[Todb Towb ]

where:

Teffective

= effective dry-bulb temperature of air entering the condenser cooling coil (C)

Towb

= outdoor air wet-bulb temperature (C)

Todb

= outdoor air dry-bulb temperature (C)

= evaporative condenser effectiveness.

The resulting condenser inlet air temperature is used by the Compressor Rack COP as a
Function of Temperature Curve and the Condenser Fan Power as a Function of Temperature
Curve. The default value for this field is 0.9, although valid entries can range from 0.0 to 1.0.
If the two function-of-temperature curves (i.e., Compressor Rack COP as a Function of
Temperature Curve and Condenser Fan Power as a Function of Temperature Curve) are
based on wet-bulb temperature rather than dry-bulb temperature, the evaporative condenser
effectiveness should be set to 1.0 for consistency.
Field: Evaporative Condenser Air Flow Rate
When the condenser type is EvaporativelyCooled, the air volume flow rate, in m 3 per
second, entering the evaporative condenser. This value is used to calculate the amount of
water evaporated when evaporatively cooling the condenser inlet air. The value for this field
must be greater than zero. This input field is also autocalculatable, equivalent to 0.000144
m3/s per watt of total cooling capacity [850 cfm/ton] where the total cooling capacity is the
sum of the rated total cooling capacities for the refrigerated cases connected to this
compressor rack (Ref. Refrigeration:Case).
Field: Basin Heater Capacity
When the condenser type is EvaporativelyCooled, this field defines the power level of the
basin heater, if applicable, used to avoid water freezing in an outdoor evaporative cooler
basin. This numeric field contains the capacity of the electric basin heater in Watts per
degree Kelvin. This field is used in conjunction with the Basin Heater Set Point Temperature
described in the following field. The basin heater electric power is equal to this field multiplied
by the difference between the basin heater set point temperature and the dry-bulb
temperature of the condenser coil inlet air. The basin heater only operates when the
condenser fan is off (i.e., no compressor heat rejection). The basin heater capacity must be
greater than or equal to zero, with a default value of 200 W/K if this field is left blank.

9/29/14

1173

Input-Output Reference

Group Refrigeration

Field: Basin Heater Setpoint Temperature

When the condenser type is EvaporativelyCooled, this numeric field contains the set point
temperature (C) for the basin heater described in the previous field. The basin heater is
active when the outdoor air dry-bulb temperature falls below this set point temperature, as
long as the condenser fan is off. The default value is 2C if this field is left blank.
Field: Design Evaporative Condenser Water Pump Power
When the condenser type is EvaporativelyCooled, the rated power of the evaporative
condenser water pump in Watts. This value is used to calculate the power required to pump
the water used to evaporatively cool the condenser inlet air. The value for this field must be
greater than or equal to 0, with a default value of 1000 Watts if this field is left blank. This
input field is also autocalculatable, equivalent to 0.004266 W per watt [15 W/ton] of total
cooling capacity where the total cooling capacity is the sum of the rated total cooling
capacities for the refrigerated cases and walk-ins connected to this compressor rack (Ref.
Refrigeration:Case and Refrigeration:WalkIn)).
Field: Evaporative Water Supply Tank Name
When the condenser type is EvaporativelyCooled, this field is used to define where the
compressor rack obtains water used for evaporative cooling of its condenser. If this field is
left blank, the unit will obtain water directly from the mains (Ref. Water Mains Temperatures).
If the name of a Water Storage Tank object is used here, then the unit will obtain its water
from that tank.
Field: Condenser Air Inlet Node Name
This optional alpha field contains the name of the node from which the outdoor compressor
rack condenser draws its outdoor air. This field is applicable only when the heat rejection
location is Outdoors (if the heat rejection location is Zone, this field is disregarded). If this
field is left blank, the outdoor air temperature entering the condenser (dry-bulb or wet-bulb) is
taken directly from the weather data. If this field is not blank, this node name must also be
specified in an OutdoorAir:Node object where the height of the node is taken into
consideration when calculating outdoor air temperature from the weather data. Alternately,
the node name may be specified in an OutdoorAir:NodeList object where the outdoor air
temperature is taken directly from the weather data.
Field: End-Use Subcategory
This field allows the specification of a user-defined end-use subcategory (e.g., "Low
Temperature Rack"). A new meter for reporting is created for each unique subcategory (Ref:
Output:Meter objects). Subcategories are also reported in the ABUPS table. If this field is left
blank, the equipment will be assigned to the "General" end-use subcategory.
Field: Refrigeration Case Name or WalkIn Name or CaseAndWalkInList Name
This alpha field is the name of a single refrigerated case, a single walk in cooler, the name of
a CaseAndWalkInList for multiple refrigerated cases and/or walk-ins, the name of a
refrigeration chiller, or the name of a CaseAndWalkInList for multiple refrigeration chillers
connected to this compressor rack. Note that if a CaseAndWalkInList contains the name(s) of
refrigeration chillers, it CANNOT have the name(s) or any refrigerated cases or walkins . This
field is required.
Field: Heat Rejection Zone Name
If the Heat Rejection Location is Zone and any walk-in coolers are connected to this
compressor rack, then this field is required. The compressor rack heat rejection will impact
the air heat balance in this zone.

9/29/14

1174

Input-Output Reference

Group Refrigeration

The following is an example input for a Refrigeration Compressor Rack with water cooled
condenser.

9/29/14

1175

Input-Output Reference
Refrigeration:CompressorRack,
MediumTempRack,
!Outdoors,
!1.7,
!RackCOPfTCurve,
!1025.0,
!RackCondFanCurve,
!WaterCooled,
!Condenser Inlet Node,
!Condenser Outlet Node,
!VariableFlow,
!Cond Outlet Temp Sch,
!,
!0.003,
!55,
!,
!,
!,
!,
!,
!,
!,
!,
!,
!,
!MediumTempCaseList;
!-

Group Refrigeration

Name
Heat Rejection Location
Design Compressor Rack COP {W/W}
Compressor Rack COP as a Function of Temperature Curve Name
Design Condenser Fan Power {W}
Condenser Fan Power as a Function of Temperature Curve Name
Condenser Type
Water-cooled Condenser Inlet Node Name
Water-cooled Condenser Outlet Node Name
Water-cooled Loop Flow Type
Water-cooled Condenser Outlet Temperature Schedule Name
Water-cooled Condenser Design Flow Rate {m3/s}
Water-cooled Condenser Maximum Flow Rate {m3/s}
Water-cooled Condenser Maximum Water Outlet Temperature {C}
Water-cooled Condenser Minimum Water Inlet Temperature {C}
Evaporative Condenser Availability Schedule Name
Evaporative Condenser Effectiveness {dimensionless}
Evaporative Condenser Air Volume Flow Rate {m3/s}
Basin Heater Capacity {W/K}
Basin Heater Set Point Temperature {C}
Design Evaporative Condenser Water Pump Power {W}
Evaporative Water Supply Tank Name
Condenser Air Inlet Node Name
End-Use Subcategory
Refrigeration Case Name or WalkIn Name or CaseAndWalkInList Name

Refrigeration Compressor Rack Outputs

If Condenser Type = Water Cooled:
System,Average, Refrigeration Compressor Rack Condenser Refrigerant Mass Flow Rate [kg/s]
System,Average, Refrigeration Compressor Rack Condenser Heat Transfer Rate [W]
System,Sum, Refrigeration Compressor Rack Condenser Heat Transfer Energy [J]
IF THE RACK SERVES CASES AND/OR WALKINS:
Zone,Average, Refrigeration Compressor Rack Electric Power [W]
Zone,Sum, Refrigeration Compressor Rack Electric Energy [J]
Zone,Average, Refrigeration Compressor Rack Condenser Fan Electric Power [W]
Zone,Sum, Refrigeration Compressor Rack Condenser Fan Electric Energy [J]
Zone,Average, Refrigeration Compressor Rack Total Heat Transfer Rate [W]
Zone,Sum, Refrigeration Compressor Rack Total Heat Transfer Energy [J]
Zone,Average, Refrigeration Compressor Rack COP [W/W]
If Condenser Type = Evap Cooled:
Zone,Average, Refrigeration Compressor Rack Evaporative Condenser Pump Electric Power [W]
Zone,Sum, Refrigeration Compressor Rack Evaporative Condenser Pump Electric Energy [J]
Zone,Average, Refrigeration Compressor Rack Evaporative Condenser Basin Heater Electric Power [W]
Zone,Sum, Refrigeration Compressor Rack Evaporative Condenser Basin Heater Electric Energy [J]
Zone,Average, Refrigeration Compressor Rack Evaporative Condenser Water Volume Flow Rate [m3/s]
Zone,Sum, Refrigeration Compressor Rack Evaporative Condenser Water Volume [m3]
If Heat Rejection Location = Zone:
Zone,Average, Refrigeration Compressor Rack Zone Sensible Heating Rate [W]
Zone,Sum, Refrigeration Compressor Rack Zone Sensible Heating Energy [J]
Zone,Average, Refrigeration Compressor Rack Return Air Sensible Heating Rate [W]
Zone,Sum, Refrigeration Compressor Rack Return Air Sensible Heating Energy [J]
IF THE RACK SERVES REFRIGERATION CHILLERS
HVAC,Average, Refrigeration Air Chiller Compressor Rack Electric Power [W]
HVAC,Sum, Refrigeration Air Chiller Compressor Rack Electric Energy [J]
HVAC,Average,Refrigeration Air Chiller System Compressor Runtime Fraction []
HVAC,Average, Refrigeration Air Chiller Compressor Rack Condenser Fan Electric Power [W]
HVAC,Sum, Refrigeration Air Chiller Compressor Rack Condenser Fan Electric Energy [J]
HVAC,Average, Refrigeration Air Chiller Compressor Rack Total Heat Transfer Rate [W]
HVAC,Sum, Refrigeration Air Chiller Compressor Rack Total Heat Transfer Energy [J]
HVAC,Average, Refrigeration Air Chiller Compressor Rack COP [W/W]

If Condenser Type = Evap Cooled:

9/29/14

1176

Input-Output Reference

Group Refrigeration

HVAC,Average, Refrigeration Air Chiller Compressor Rack Evaporative Condenser Pump Electric Power [W]
HVAC,Sum, Refrigeration Air Chiller Compressor Rack Evaporative Condenser Pump Electric Energy [J]
HVAC,Average, Refrigeration Air Chiller Compressor Rack Evaporative Condenser Basin Heater Electric Power
[W]
HVAC,Sum, Refrigeration Air Chiller Compressor Rack Electric PowerRefrigeration Air Chiller Compressor
Rack Evaporative Condenser Basin Heater Electric Energy [J]
HVAC,Average, Refrigeration Air Chiller Compressor Rack Evaporative Condenser Water Volume Flow Rate
[m3/s]
HVAC,Sum, Refrigeration Air Chiller Compressor Rack Evaporative Condenser Water Volume [m3]
If Heat Rejection Location = Zone:
HVAC,Average, Refrigeration Air Chiller Compressor Rack Zone Sensible Heating Rate [W]
HVAC,Sum, Refrigeration Air Chiller Compressor Rack Zone Sensible Heating Energy [J]
HVAC,Average, Refrigeration Air Chiller Compressor Rack Return Air Sensible Heating Rate [W]
HVAC,Sum, Refrigeration Air Chiller Compressor Rack Return Air Sensible Heating Energy [J]

Refrigeration Compressor Rack Condenser Mass Flow Rate [kg/s]

When condenser type is Water Cooled, this is the mass flow rate of water flowing through the
water cooled condenser.
Refrigeration Compressor Rack Condenser Heat Transfer Rate [W]
When condenser type is Water Cooled, this is the total heat transfer across the condenser
(i.e., compressor energy and case cooling).
Refrigeration Compressor Rack Condenser Heat Transfer Energy [J]
When condenser type is Water Cooled, this is the total heat energy flowing across the
condenser for the timestep being reported.
IF THE RACK SERVES CASES AND OR WALKINS:
Refrigeration Compressor Rack Electric Power [W]
This output is the electric power input to the rack compressor(s) in Watts.
Refrigeration Compressor Rack Electric Energy [J]
This is the electricity consumption of the rack compressor(s) in Joules for the timestep being
reported. This output is also added to a meter with Resource Type = Electricity, End Use Key
= Refrigeration, Group Key = Plant (Ref. Output:Meter objects).
Refrigeration Compressor Runtime Fraction []
This is the runtime operating ratio for the compressor.
Refrigeration Compressor Rack Condenser Fan Electric Power [W]
This output is the electric input to the rack condenser fan(s) in Watts.
Refrigeration Compressor Rack Condenser Fan Electric Energy [J]
This is the electricity consumption of the rack condenser fan(s) in Joules for the timestep
being reported. This output is also added to a meter with Resource Type = Electricity, End
Use Key = Refrigeration, Group Key = Plant (Ref. Output:Meter objects).
Refrigeration Compressor Rack Total Heat Transfer Rate [W]
This output is the total heat transfer rate of the refrigeration compressor rack in Watts. It is
the sum of all of the heat transfer rates for the refrigerated cases and walk-ins that are
connected to this rack. This value does not include compressor or condenser fan heat.
Refrigeration Compressor Rack Total Heat Transfer Energy [J]
This is the total heat transfer of the refrigeration compressor rack in Joules for the timestep
being reported. This output is also added to a meter with Resource Type = EnergyTransfer,
End Use Key = Refrigeration, Group Key = Plant (Ref. Output:Meter objects).
9/29/14

1177

Input-Output Reference

Group Refrigeration

Refrigeration Compressor Rack COP [W/W]

This field is the refrigeration compressor rack coefficient of performance. It is the actual
compressor rack COP for the timestep being reported, accounting for the COP variation as a
function of temperature. It is calculated as the Design Compressor Rack COP times the
Compressor Rack COP as a Function of Temperature Curve evaluated at the effective
condenser entering air temperature for the timestep being reported.
Refrigeration Compressor Rack Evaporative Condenser Pump Electric Power [W]
This is the electrical power requirement in Watts for the timestep being reported for the water
pump used with evaporative cooling of the compressor rack condenser.
Refrigeration Compressor Rack Evaporative Condenser Pump Electric Energy [J]
This is the electricity consumption in Joules of the water pump used with evaporative cooling
of the compressor rack condenser for the timestep being reported. This output is also added
to a meter with Resource Type = Electricity, End Use Key = Refrigeration, Group Key = Plant.
Use of an optional subkey category is also available, with default to the General end-use
subcategory (Ref. Output:Meter objects).
Refrigeration Compressor Rack Evaporative Condenser Basin Heater Electric Power [W]
This is the electrical power requirement in Watts for the timestep being reported for the water
heater in the basin of the evaporative system used to cool the compressor rack condenser.
Refrigeration Compressor Rack Evaporative Condenser Basin Heater Electric Energy [J]
This is the electricity consumption in Joules of the water heater used to prevent freezing of
the evaporative cooling system for the compressor rack condenser for the timestep being
reported. This output is also added to a meter with Resource Type = Electricity, End Use Key
= Refrigeration, Group Key = Plant. Use of an optional subkey category is also available, with
default to the General end-use subcategory (Ref. Output:Meter objects).
Refrigeration Compressor Rack Evaporative Condenser Water Volume Flow Rate [m3/s]
The volumetric flow rate in m 3/s of water consumed while providing evaporative cooling of the
compressor rack condenser.
Refrigeration Compressor Rack Evaporative Condenser Water Volume [m3]
This is the water consumed by evaporation in m 3 while providing evaporative cooling of the
compressor rack condenser for the timestep being reported. This output is also added to a
meter with Resource Type = Water, End Use Key = Refrigeration, Group Key = Plant. Use of
an optional subkey category is also available, with default to the General end-use
subcategory (Ref. Output:Meter objects).
Refrigeration Compressor Rack Zone Sensible Heating Rate [W]
This field is the rate of sensible heating in Watts provided to the zone by condenser waste
heat rejection, which impacts the zone air heat balance.
Refrigeration Compressor Rack Zone Sensible Heating Energy [J]
This field is the sensible heating energy in Joules provided to the zone by condenser waste
heat rejection for the timestep being reported.
Refrigeration Compressor Rack Return Air Sensible Heating Rate [W]
This field is the rate of sensible heating in Watts provided by condenser waste heat rejection
to the HVAC return air (zone return air path outlet node), which impacts the HVAC return air
temperature. If the HVAC system is off for a simulation timestep (no return air mass flow),
then this sensible heating is actually provided to the zone air instead (even though a non-zero
value is reported here).

9/29/14

1178

Input-Output Reference

Group Refrigeration

Refrigeration Compressor Rack Return Air Sensible Heating Energy [J]

This field is the sensible heating energy in Joules provided by condenser waste heat rejection
to the HVAC return air (zone return air path outlet node) for the timestep being reported. If the
HVAC system is off for a simulation timestep (no return air mass flow), then this sensible
heating is actually provided to the zone air instead (even though a non-zero value is reported
here).
IF THE RACK SERVES CHILLERS
Refrigeration Air Chiller Compressor Rack Electric Power [W]
This output is the electric power input to the rack compressor(s) in Watts.
Refrigeration Air Chiller Compressor Rack Electric Energy [J]
This is the electricity consumption of the rack compressor(s) in Joules for the timestep being
reported. This output is also added to a meter with Resource Type = Electricity, End Use Key
= Refrigeration, Group Key = Plant (Ref. Output:Meter objects).
Refrigeration Air Chiller System Compressor Runtime Fraction []
This is the runtime fraction for the compressor serving air chillers.
Refrigeration Air Chiller Compressor Rack Condenser Fan Electric Power [W]
This output is the electric input to the rack condenser fan(s) in Watts.
Refrigeration Air Chiller Compressor Rack Condenser Fan Electric Energy [J]
This is the electricity consumption of the rack condenser fan(s) in Joules for the timestep
being reported. This output is also added to a meter with Resource Type = Electricity, End
Use Key = Refrigeration, Group Key = Plant (Ref. Output:Meter objects).
Refrigeration Air Chiller Compressor Rack Total Heat Transfer Rate [W]
This output is the total heat transfer rate of the refrigeration compressor rack in Watts. It is
the sum of all of the heat transfer rates for the refrigerated cases and walk-ins that are
connected to this rack. This value does not include compressor or condenser fan heat.
Refrigeration Air Chiller Compressor Rack Total Heat Transfer Energy [J]
This is the total heat transfer of the refrigeration compressor rack in Joules for the timestep
being reported. This output is also added to a meter with Resource Type = EnergyTransfer,
End Use Key = Refrigeration, Group Key = Plant (Ref. Output:Meter objects).
Refrigeration Air Chiller Compressor Rack COP [W/W]
This field is the refrigeration compressor rack coefficient of performance. It is the actual
compressor rack COP for the timestep being reported, accounting for the COP variation as a
function of temperature. It is calculated as the Design Compressor Rack COP times the
Compressor Rack COP as a Function of Temperature Curve evaluated at the effective
condenser entering air temperature for the timestep being reported.
Refrigeration Air Chiller Compressor Rack Evaporative Condenser Pump Electric Power
[W]
This is the electrical power requirement in Watts for the timestep being reported for the water
pump used with evaporative cooling of the compressor rack condenser.
Refrigeration Air Chiller Compressor Rack Evaporative Condenser Pump Electric Energy
[J]
This is the electricity consumption in Joules of the water pump used with evaporative cooling
of the compressor rack condenser for the timestep being reported. This output is also added
to a meter with Resource Type = Electricity, End Use Key = Refrigeration, Group Key = Plant.
9/29/14

1179

Input-Output Reference

Group Refrigeration

Use of an optional subkey category is also available, with default to the General end-use
subcategory (Ref. Output:Meter objects).
Refrigeration Air Chiller Compressor Rack Evaporative Condenser Basin Heater Electric
Power [W]
This is the electrical power requirement in Watts for the timestep being reported for the water
heater in the basin of the evaporative system used to cool the compressor rack condenser.
Refrigeration Air Chiller Compressor Rack Evaporative Condenser Basin Heater Electric
Energy [J]
This is the electricity consumption in Joules of the water heater used to prevent freezing of
the evaporative cooling system for the compressor rack condenser for the timestep being
reported. This output is also added to a meter with Resource Type = Electricity, End Use Key
= Refrigeration, Group Key = Plant. Use of an optional subkey category is also available, with
default to the General end-use subcategory (Ref. Output:Meter objects).
Refrigeration Air Chiller Compressor Rack Evaporative Condenser Water Volume Flow
Rate [m3/s]
The volumetric flow rate in m 3/s of water consumed while providing evaporative cooling of the
compressor rack condenser.
Refrigeration Air Chiller Compressor Rack Evaporative Condenser Water Volume [m3]
This is the water consumed by evaporation in m 3 while providing evaporative cooling of the
compressor rack condenser for the timestep being reported. This output is also added to a
meter with Resource Type = Water, End Use Key = Refrigeration, Group Key = Plant. Use of
an optional subkey category is also available, with default to the General end-use
subcategory (Ref. Output:Meter objects).
Refrigeration Air Chiller Compressor Rack Zone Sensible Heating Rate [W]
This field is the rate of sensible heating in Watts provided to the zone by condenser waste
heat rejection, which impacts the zone air heat balance.
Refrigeration Air Chiller Compressor Rack Zone Sensible Heating Energy [J]
This field is the sensible heating energy in Joules provided to the zone by condenser waste
heat rejection for the timestep being reported.
Refrigeration Air Chiller Compressor Rack Return Air Sensible Heating Energy [J]
Refrigeration Air Chiller Compressor Rack Return Air Sensible Heating Rate [W]
These are the sensible heating energy, in Joules or Watts, provided to the HVAC system
return air node by condenser heat rejection at the compressor rack.
Refrigeration:Case
The Refrigeration Case object works in conjunction with a compressor rack, a refrigeration
system, or a secondary loop object (Refrigeration:CompressorRack, Refrigeration:System, or
Refrigeration:SecondarySystem) to simulate the performance of a refrigerated case system.
The refrigerated case model uses performance information at rated conditions along with
performance curves for latent case credits and defrost heat load to determine performance at
off-rated conditions. Energy use for lights, fans and anti-sweat heaters is modeled based on
inputs for nominal power, schedules, and control type. The refrigerated case model accounts
for the sensible and latent heat exchange with the surrounding environment (termed "case
credits") which impacts the temperature and humidity in the zone where the case is located.
A dataset has been provided containing refrigerated case input data for a large number
of refrigerated cases from multiple manufacturers. See RefrigerationCases.idf.

9/29/14

1180

Input-Output Reference

Group Refrigeration

The Refrigeration Case object inputs include a case name, an availability schedule name, the
zone name for the location of the case, and the temperature and relative humidity of the
ambient (zone) air surrounding the refrigerated case at the rating conditions for case
performance. Additional inputs include the total cooling capacity, latent heat ratio, and run
time fraction of the refrigerated case at rated conditions. The case length and operating
temperature (average temperature of air/products within the case) must also be specified.
The refrigerated case model requires two curves to describe performance at off-rated
conditions (i.e., at different zone temperature and humidity levels): the latent case credit
curve and the defrost energy correction curve. The user must enter cubic performance curves
with the independent variable being user selectable (case temperature, zone relative
humidity, or zone dewpoint temperature).
The user can select from eight case defrost types, with additional inputs being required
depending on the type selected. The user must enter a defrost schedule (unless Case
Defrost Type = None), and an optional defrost drip-down schedule can be specified to allow
additional time for melted frost to drain from the cooling coil following the regular defrost
period.
Inputs are required for case fans, lights, and anti-sweat heaters. Case lighting can be
controlled by the user through entering a schedule. The case fans operate whenever the
cooling coil is operating and during defrost periods for certain case defrost types. Anti-sweat
heater power can be controlled by several methods which are user selectable. The model
assumes that the fans are contained within the thermal envelope of the case and provide a
direct heat load on the case cooling coil. For lighting and anti-sweat heaters, the user can
specify the fraction of their respective heat loads that directly impact the case cooling coil
(with the remainder of their heat load impacting the surrounding zone air).
The user has the option of specifying a case restocking schedule and a schedule for
modifying the case credits if needed. Finally, the user can specify the under case HVAC
return air fraction which determines the portion of the case credits that directly impact the
HVAC return air conditions (with the remainder of the case credits impacting the zone
sensible and latent loads).
Field: Name
A unique user-assigned name for an instance of a refrigerated case. Any reference to this
case by another object will use this name.
Field: Availability Schedule Name
The name of the schedule (ref: Schedule) that denotes whether the refrigerated case can
operate during a given time period. A schedule value greater than 0 (maximum schedule
value of 1.0 is typically used) indicates that the case will operate during a given time period. A
value equal to 0 denotes that the case does not operate (everything is OFF: refrigeration,
fans, lights, anti-sweat, etc.). Typically the refrigerated case will operate throughout the day
(i.e., the schedule will contain 1 for all time periods); however, cases require maintenance
and/or cleaning and this can be modeled accordingly using this schedule if desired. If this
field is left blank, the case is assumed to be available at all time periods.
Field: Zone Name
The name of the zone where the refrigerated case is located. The refrigerated case will
impact the air heat balance in this zone. When modeling multiple refrigerated cases
connected to a single compressor rack where the condenser heat is rejected to the zone (ref:
Refrigeration:CompressorRack), all of the refrigerated cases connected to that compressor
rack must be located in the same zone.

9/29/14

1181

Input-Output Reference

Group Refrigeration

Field: Rated Ambient Temperature

Dry-bulb temperature of the ambient (zone) air surrounding the refrigerated case at the rating
conditions for refrigerated case performance. The default value for this field is 23.9C (75F).
This temperature must be greater than 0C and greater than the case operating temperature.
Field: Rated Ambient Relative Humidity
Relative humidity of the ambient (zone) air surrounding the refrigerated case at the rating
conditions for refrigerated case performance. The default value for this field is 55% RH.
Field: Rated Total Cooling Capacity per Unit Length
The total, full load cooling capacity (sensible plus latent) in watts per unit length of
refrigerated case (W/m) at rated conditions (i.e., at the Rated Ambient Temperature, Rated
Ambient Relative Humidity, Case Operating Temperature, and with the Standard Case Fan
Power per Unit Length and the Standard Case Lighting Power per Unit Length). The value
entered for this field must be greater than zero, with a default value of 1900 W/m if the field is
blank.
Field: Rated Latent Heat Ratio
The latent heat ratio (LHR=latent capacity divided by total cooling capacity) of the refrigerated
case at rated conditions (i.e., at the Rated Ambient Temperature, Rated Ambient Relative
Humidity, Case Operating Temperature, and with the Standard Case Fan Power per Unit
Length and the Standard Case Lighting Power per Unit Length). The value for this field can
range from zero to 1.0, with a default value of 0.3 if the field is blank.
Field: Rated Runtime Fraction
The runtime fraction of the refrigerated case at rated conditions (i.e., at the Rated Ambient
Temperature, Rated Ambient Relative Humidity, and Case Operating Temperature). Even at
rated conditions, refrigerated cases typically include additional cooling capacity to account for
product stocking and recovery from defrost. The rated runtime fraction for refrigerated cases
typically ranges from 0.8 to 0.9. The entered value for this field must be greater than 0.0 and
less than or equal to 1.0, and the default value is 0.85 if the field is blank.
Field: Case Length
The length of the refrigerated case in meters. The entered value for this field must be greater
than 0.0, and the default value is 3 meters if the field is blank.
Field: Case Operating Temperature
The average temperature of the air and products within the refrigerated case in C. The
refrigerated case manufacturer typically provides this information in the product literature.
Typical operating temperatures for medium temperature cases are 1.6C to 7.2C (35F to
45F). Typical operating temperatures for low temperatures cases are -28.9C to -17.8C
(-20F to 0F). The entered value for this field must be less than 20C and lower than the
Rated Ambient Temperature. The default value is 1.1C if the field is blank.
Field: Latent Case Credit Curve Type
This alpha field defines the form of the curve used to modify the latent case credits (latent
heat removed from the zone where the refrigerated case is located) at off-rated conditions.
The valid choices for this field are:
CaseTemperatureMethod
This method defines the variation in latent case credits as a cubic function of Case
Operating Temperature. The result from the cubic curve is multiplied by the
difference between the rated ambient relative humidity and the actual zone relative
humidity, and one minus this value is multiplied by the Rated LHR to give the
operating LHR at the actual zone humidity condition. (Representative cooefficient
9/29/14

1182

Input-Output Reference

Group Refrigeration

values for single-shelf horizontal and multi-shelf vertical display cases are given in
the EnergyPlus Engineering Reference.)
RelativeHumidityMethod
This method defines the variation in latent case credits as a cubic function of ambient
(zone) air relative humidity.
DewpointMethod
This method defines the variation in latent case credits as a cubic function of ambient
(zone) air dewpoint temperature.
The default curve type is the Case Temperature Method. Refer to the Engineering Reference
for further information on how latent case credits are modeled.
Field: Latent Case Credit Curve Name
The name of a cubic performance curve (ref: Performance Curves) that parameterizes the
variation of the latent case credits at off-rated conditions. The curve should be normalized to
have a value of 1.0 at the rated ambient air conditions defined above.
Field: Standard Case Fan Power per Unit Length
The total standard fan power in Watts per unit length of refrigerated case (W/m). This value
represents the fan power included in the field Rated Total Cooling Capacity per Unit Length,
and is used to determine the sensible case credits. The entered value for this field must be
greater than or equal to zero, and the default value is 75.0 W/m if the field is blank.
Field: Operating Case Fan Power per Unit Length
The total operating fan power in Watts per unit length of refrigerated case (W/m). Enter the
actual power for the installed fans. The entered value for this field must be greater than or
equal to zero, and the value is set equal to the standard case fan powers if the field is blank.
Field: Standard Case Lighting Power per Unit Length
The total standard lighting power in Watts per unit length of refrigerated case (W/m). This
value should represent the lighting power provided by the case manufacturer and included in
the Rated Total Cooling Capacity per Unit Length field and is used to determine the
sensible case credits. For cases where the manufacturer does not include the lights in the
Rated Total Cooling Capacity, this value should be zero (0.0). The entered value for this field
must be greater than or equal to zero, and the default value is 90.0 W/m if the field is blank.
Field: Installed Case Lighting Power per Unit Length
The total installed lighting power in Watts per unit length of refrigerated case (W/m). Enter the
actual power for the installed lights. This number may be greater or less than the standard
lighting power value, depending upon the manufacturers practice in specifying the case rated
cooling capacity and whether or not energy-efficient lights are being modeled. The next field
(i.e. Case Lighting Schedule Name) may be used to specify the name of a schedule that
contains the fraction of the Installed Case Lighting Power per Unit Length to be modeled for
each timestep of the simulation period. The entered value for this field must be greater than
or equal to zero, and the value is set equal to the standard case lighting power if the field is
blank.
Field: Case Lighting Schedule Name
The name of the schedule (ref: Schedule) that denotes the fraction of installed refrigerated
case lights that operate during a given time period. A schedule value greater than 0 indicates
that the lights will operate during that time period (maximum schedule value of 1.0 means
lights are fully on at the Installed Case Lighting Power per Unit Length level). A schedule
value of zero denotes that the lights are off. The refrigerated case lights will typically operate
only when the store is open for business and can be scheduled off as desired via this
schedule. If this field is left blank, the default schedule has a value of 1 for all time periods.
9/29/14

1183

Input-Output Reference

Group Refrigeration

Field: Fraction of Lighting Energy To Case

The fraction of the lighting energy that directly contributes to the case heat load. The
remainder of the lighting energy (1 fraction) is a heating load to the zone where the case is
located. This field can be used to model lighting ballasts and bulbs located outside the air
curtain of the refrigerated case. The value for this field can range from zero to 1.0, with a
default value of 1.0 if the field is blank.
Field: Case Anti-Sweat Heater Power per Unit Length
The electric anti-sweat heater power in watts per unit length of refrigerated case (W/m). The
entered value for this field must be greater than or equal to zero, and the default value is 0
W/m if the field is blank.
Field: Minimum Anti-Sweat Heater Power per Unit Length
The minimum electric anti-sweat heater power in watts per unit length of refrigerated case
(W/m). Anti-sweat heater power will remain at or above this value for anti-sweat heater
control types linear, dewpoint method, or heat balance method. Other anti-sweat heater
control types disregard this field. The entered value for this field must be greater than or
equal to zero, and the default value is 0 W/m if the field is blank.
Field: Anti-Sweat Heater Control Type
The type of anti-sweat heater control used for this refrigerated case. Valid choices are None,
Constant, Linear, DewpointMethod, or HeatBalanceMethod. The default is None if the field is
blank. Refer to the Engineering Reference for further information on how the different antisweat heater controls are modeled.
Field: Humidity at Zero Anti-Sweat Heater Energy
The value of this numeric field is only used when the Linear anti-sweat heater control type is
selected. Enter the zone relative humidity where anti-sweat heater energy use is zero.
Negative values for relative humidity may be entered. Other anti-sweat heater control types
disregard this field. The value entered for this field must be less than the Rated Ambient
Relative Humidity specified above. The default for this field is -10.0.
Field: Case Height
The value of this numeric field is used when Heat Balance Method anti-sweat heater control
is selected. Enter the case height in meters. Other anti-sweat heater control types disregard
this field. The entered value for this field must be greater than zero when Heat Balance
Method anti-sweat heater control is selected, and the default value is 1.5 meters if the field is
blank.
Field: Fraction of Anti-Sweat Heater Energy To Case
This value denotes the fraction of anti-sweat heater energy that results in a direct heat load to
the refrigerated case. The remainder of the anti-sweat heater energy (1-fraction) is a heating
load to the zone where the refrigerated case is located. The value for this field can range
from zero to 1.0, with a default value of 1.0 if the field is blank.
Field: Case Defrost Power per Unit Length
The defrost power in watts per unit length of refrigerated case (W/m). This input is required
for hot-gas, hot-fluid, or electric defrost types and is used to evaluate the load on the case as
well as power or heat consumption. Refrigerated case manufacturers do not typically provide
information on the heat input for hot-gas and hot-fluid defrost. Information provided for
electric defrost power can be substituted here for refrigerated cases using hot-gas or hot-fluid
defrost if other information is not available. Only electric Case Defrost Types consume
electricity during the defrost period. The entered value for this field must be greater than or
equal to zero, and the default value is 0 W/m if the field is blank.

9/29/14

1184

Input-Output Reference

Group Refrigeration

Field: Case Defrost Type

The type of defrost used for this refrigerated case. Valid choices are None, OffCycle, HotGas,
HotGaswithTemperatureTermination, Electric, ElectricwithTemperatureTermination, HotFluid,
and HotFluidwithTemperatureTermination. The default defrost type is OffCycle if the field is
blank. Refer to the Engineering Reference for further information on how the different case
defrost types are modeled. In particular, hot-fluid defrost systems may be effective with much
shorter defrost times than other systems, which should be reflected in the defrost and dripdown schedules.
Field: Case Defrost Schedule Name
The name of the schedule (ref: Schedule) that denotes whether the refrigerated case requires
defrosting. A schedule value of 1.0 indicates that defrost will be on during a given time period.
A value equal to 0 denotes that the defrost is off. Defrost schedules normally repeat the
duration and number of defrost cycles for each day of the year. The refrigerated case
manufacturer typically provides this information with the product literature. The use of
Compact Schedules (ref. Schedules) are ideal for this purpose. In a typical supermarket with
many cases, it is important to diversify the defrost schedules in order to avoid large swings in
the load placed upon the remainder of the refrigeration system.
Field: Case Defrost Drip-Down Schedule Name
The name of the schedule (ref: Schedule) that denotes whether the refrigerated case requires
additional time for draining condensate after the defrost period. A schedule value of 1.0
indicates that the defrost drip-down period is on during a given time period. A value equal to 0
denotes that the defrost drip-down period is over. The refrigerated case manufacturer
typically provides this information with the product literature.
Each defrost drip-down period specified in this schedule should start at the same time as the
corresponding defrost period specified in the schedule for Case Defrost Schedule, and the
drip-down schedule defrost period should always be longer than or equal to the length of the
defrost schedule time period. For example, if the case defrost schedule contains a defrost
period from 7:00 to 7:15, you would specify a case defrost drip-down period from 7:00 to 7:20
if you wanted to model a 5 minute condensate drip-down period after the regular defrost
period. If no drip-down schedule is entered, then the case defrost schedule (specified for the
previous input field) will be used. The use of Compact Schedules (ref. Schedules) are ideal
for this purpose.
Field: Defrost Energy Correction Curve Type
This alpha field defines the form of the correction curve used to modify the defrost energy use
(and the associated load on the case cooling coil) at off-rated conditions. The valid choices
for this field are:
None
This choice specifies that a defrost energy correction curve will not be used.
CaseTemperatureMethod
This method defines the variation in defrost energy as a cubic function of Case Operating
Temperature. The result from the cubic curve is multiplied by the difference between
the rated ambient relative humidity and the actual zone relative humidity, and one
minus this value is multiplied by the Case Defrost Power to give the (average)
operating defrost power at the actual zone humidity condition. (Representative
cooefficient values for single-shelf horizontal and multi-shelf vertical display cases
are given in the EnergyPlus Engineering Reference.)
RelativeHumidityMethod
This method defines the variation in defrost energy as a cubic function of ambient (zone)
air relative humidity.
DewpointMethod
9/29/14

1185

Input-Output Reference

Group Refrigeration

This method defines the variation in defrost energy as a cubic function of ambient (zone)
air dewpoint temperature.
The default curve type is None. The methods described here (e.g. Case Temperature,
Relative Humidity, and Dewpoint) are applicable only to Electric with Temperature
Termination, Hot-Gas with Temperature Termination, and Hot-Brine with Temperature
Termination case defrost types. Refer to the Engineering Reference for further information on
how the defrost energy correction types are modeled.
Field: Defrost Energy Correction Curve Name
The name of a cubic performance curve (ref: Performance Curves) that parameterizes the
variation of the defrost energy (and the associated load on the case cooling coil) at off-rated
conditions. The curve should be normalized to have the value of 1.0 at the rated ambient air
conditions defined above. The defrost energy correction curve name is used only for the
Electric with Temperature Termination, Hot-Gas with Temperature Termination, and HotBrine with Temperature Termination case defrost types.
Field: Under Case HVAC Return Air Fraction
This field denotes the fraction of HVAC system (air loop) return air that passes beneath the
refrigerated case, if any. At times it is necessary to design HVAC systems with under case
returns to avoid overcooling the area around the refrigerated case, thus providing a more
comfortable environment for the zone occupants. This return air fraction affects the portion of
the case credits (sensible and latent) that are applied to the air returning to the HVAC
system, while the remainder of the case credits directly impacts the zone air heat balance.
Refer to the Engineering Reference for further information on how this is modeled. The sum
of the Under Case HVAC Return Air Fractions for all refrigerated cases located in a single
zone must be less than or equal to 1.0. The value for this field can range from zero to 1.0,
with a default value of 0 if the field is blank.
Field: Refrigerated Case Restocking Schedule Name
The name of the schedule (ref: Schedule) that denotes whether the refrigerated case is being
restocked with product. The schedule should contain values in units of Watts per unit length
of refrigerated case (W/m). This field can be used to denote the additional load imposed on
the refrigerated case from stocking the case with product that is warmer than the refrigerated
case temperature. This information is difficult to find and may require additional research for
proper modeling; however, this schedule is available for this purpose if desired. If restocking
of the refrigerated case will not be simulated, enter a schedule with values of zero for all time
periods or leave this field blank.
Field: Case Credit Fraction Schedule Name
The name of the schedule (ref: Schedule) that denotes a fraction of both the sensible and
latent case credits to be applied to the zone and/or the HVAC system return air. Schedule
values must be from 0 to 1. This allows correction of the case credits for various refrigerated
case types. For instance, if glass door refrigerated display cases are installed in a store that
is operated 12 hours per day, then the doors will remain closed during the unoccupied times
and would therefore reduce the sensible and latent case credits during the unoccupied time.
Leaving this field blank will result in no case credit fraction being applied during the
simulation.
Field: Design Evaporator Temperature or Brine Inlet Temperature
The value of this numeric field is used only with the detailed refrigeration system and is not
read for the compressor-rack system. For the refrigeration system, it is used to evaluate
compressor performance and is also used when the evaporator pressure and temperature
are allowed to float at loads less than the design load. If the case is cooled by a secondary
system (ref: Refrigeration:SecondarySystem), this value is the brine inlet temperature. The

9/29/14

1186

Input-Output Reference

Group Refrigeration

minimum value is -70C and the maximum value is 40C. The default value is 5C less than the
case temperature.
Field: Average Refrigerant Charge Inventory
The value of this optional field is the refrigerant inventory present in the refrigerated case
during ordinary operation. The value is used to produce an estimate of the total refrigerant
present in the refrigeration system. The value is entered in kg/m.
The following is an example input for a refrigerated case.
Refrigeration:Case,
Multi-Deck Dairy/Deli Merchandiser with Synergy-E, !- Name
[Based on Hill Phoenix 6DMLH-NRG]
,
!- Availability Schedule [Used to turn case on/off including all power draws (ie fans, lights, etc)]
UserProvideZoneName,
!- Zone Name [Location of Fixture]
23.89,
!- Rated Ambient Temperature {C} [75F]
55,
!- Rated Ambient Relative Humidity {percent}
1394,
!- Rated Total Cooling Capacity per Unit length {W/m} [1,450 Btu/hr/ft = 11,600 Btu/hr]
0.30,
!- Rated Latent Heat Ratio [ Rated Latent Capacity]
0.85,
!- Rated Runtime Fraction
2.4,
!- Case Length {m} [8 ft]
3.33,
!- Case Operating Temperature {C} [38F]
CaseTemperatureMethod, !- Latent Case Credit Curve Type
Multi_Shelf_Vertical_Latent_Case_Credit_Curve,
!- Latent Case Credit Curve Name
27.3,
!- Standard Case Fan Power per Unit Length {W/m} [8.3 W/ft]
27.3,
!- Operating Case Fan Power per Unit Length {W/m} [8.3 W/ft = 67 W]
0.0,
!- Standard Case Lighting Power per Unit Length {W/m} [0.0 W/ft]
114.8,
!- Installed Case Lighting Power per Unit Length {W/m} [35.0 W/ft = 280 W]
,
!- Case Lighting Schedule Name
1.0,
!- Fraction Of Lighting Energy To Case
0.0,
!- Case Anti-Sweat Heater Power per Unit Length {W/m} [0.0 W/ft = 0 W]
,
!- Minimum Anti-Sweat Heater Power per Unit Length {W/m} []
None,
!- Anti-Sweat Heater Control Type
,
!- Humidity At Zero Anti-Sweat Heater Energy {%}
,
!- Case Height {m} []
1.0,
!- Fraction of Anti-Sweat Heater Energy To Case
0.0,
!- Case Defrost Power per Unit Length {W/m} [0.0 W/ft 0 W]
Off Cycle,
!- Case Defrost Type
UserProvideDefSched6PerDay45MinEa,
!- Case Defrost Schedule Name
UserProvideDefSched4PerDay42MinEa,
!- Case Defrost Drip-Down Schedule
CaseTemperatureMethod, !- Defrost Energy Correction Curve Type
Multi Shelf Vertical,
!- Defrost Energy Correction Curve Name
0.00,
!- Under Case HVAC Return Air Fraction
,
!- Refrigerated Case Restocking Schedule Name [Not modeling any restocking]
,
!- Case Credit Fraction Schedule Name
-3.33,
!- Design Evaporator Temperature or Brine Inlet Temperature {C} [26F]
;
!- Average Refrigerant Charge Inventory {kg/m} [ = ]

Refrigeration:Case Outputs
Zone,Average,Refrigeration Case Evaporator Total Cooling Rate [W]
Zone,Sum,Refrigeration Case Evaporator Total Cooling Energy [J]
Zone,Average,Refrigeration Case Evaporator Sensible Cooling Rate [W]
Zone,Sum,Refrigeration Case Evaporator Sensible Cooling Energy [J]
Zone,Average, Refrigeration Case Evaporator Latent Cooling Rate [W]
Zone,Sum, Refrigeration Case Evaporator Latent Cooling Energy [J]
Zone,Average,Refrigeration Case Zone Sensible Cooling Rate [W]
Zone,Sum,Refrigeration Case Zone Sensible Cooling Energy [J]
Zone,Average,Refrigeration Case Zone Sensible Heating Rate [W]
Zone,Sum,Refrigeration Case Zone Sensible Heating Energy [J]
Zone,Average,Refrigeration Case Zone Latent Rate [W]
Zone,Sum,Refrigeration Case Zone Latent Energy [J]
Zone,Average,Refrigeration Case Return Air Sensible Cooling Rate [W]
Zone,Sum,Refrigeration Case Return Air Sensible Cooling Energy [J]
Zone,Average,Refrigeration Case Return Air Sensible Heating Rate [W]
Zone,Sum,Refrigeration Case Return Air Sensible Heating Energy [J]
9/29/14

1187

Input-Output Reference

Group Refrigeration

Zone,Average,Refrigeration Case Return Air Latent Rate [W]

Zone,Sum,Refrigeration Case Return Air Latent Energy [J]
Zone,Average,Refrigeration Case Evaporator Fan Electric Power [W]
Zone,Sum,Refrigeration Case Evaporator Fan Electric Energy [J]
Zone,Average,Refrigeration Case Lighting Electric Power [W]
Zone,Sum,Refrigeration Case Lighting Electric Energy [J]
Zone,Average,Refrigeration Case Latent Credit Curve Value []
If case defrost type is Electric, Hot-Gas, or Hot-Brine with Temperature
Termination
Zone,Average,Refrigeration Case Defrost Energy Correction Curve Value
If anti-sweat heater control type is not equal to None:
Zone,Average,Refrigeration Case Anti Sweat Electric Power [W]
Zone,Sum,Refrigeration Case Anti Sweat Electric Energy [J]
If case defrost type is Electric or Electric with Temperature Termination:
Zone,Average,Refrigeration Case Defrost Electric Power [W]
Zone,Sum,Refrigeration Case Defrost Electric Energy [J]

Refrigeration Case Evaporator Total Cooling Rate [W]

This field is the total (sensible plus latent) cooling rate of the refrigerated case evaporator coil
in Watts.
Refrigeration Case Evaporator Total Cooling Energy [J]
This field is the total (sensible plus latent) cooling of the refrigerated case evaporator coil in
Joules over the timestep being reported. This output is also added to a meter with Resource
Type = EnergyTransfer, End Use Key = Refrigeration, Group Key = Building (Ref.
Output:Meter objects).
Refrigeration Case Evaporator Sensible Cooling Rate [W]
This field is the sensible cooling rate of the refrigerated case evaporator coil in Watts.
Refrigeration Case Evaporator Sensible Cooling Energy [J]
This field is the sensible cooling of the refrigerated case evaporator coil in Joules over the
timestep being reported.
Refrigeration Case Evaporator Latent Cooling Rate [W]
This field is the latent cooling (dehumidification) rate of the refrigerated case evaporator coil
in Watts.
Refrigeration Case Evaporator Latent Cooling Energy [J]
This field is the latent cooling (dehumidification) of the refrigerated case evaporator coil in
Joules over the timestep being reported.
Refrigeration Case Zone Sensible Cooling Rate [W]
This field is the rate of sensible cooling case credits delivered to the zone in Watts. If an
under case return duct is simulated, only a portion of the sensible case credits are applied to
the zone. A positive value is reported when the zone is cooled by sensible case credits,
otherwise a zero is reported.
Refrigeration Case Zone Sensible Cooling Energy [J]
This field is the amount of sensible cooling case credit energy delivered to the zone in Joules.
If an under case return duct is simulated, only a portion of the sensible case credits are
applied to the zone. A positive value is reported when the zone is cooled by sensible case
credits, otherwise a zero is reported.
Refrigeration Case Zone Sensible Heating Rate [W]
This field is the rate of sensible heating case credits delivered to the zone in Watts. If an
under case return duct is simulated, only a portion of the sensible case credits are applied to
9/29/14

1188

Input-Output Reference

Group Refrigeration

the zone. A positive value is reported when the zone is heated by sensible case credits,
otherwise a zero is reported.
Refrigeration Case Zone Sensible Heating Energy [J]
This field is the amount of sensible heating case credit energy delivered to the zone in
Joules. If an under case return duct is simulated, only a portion of the sensible case credits
are applied to the zone. A positive value is reported when the zone is heated by sensible
case credits, otherwise a zero is reported.
Refrigeration Case Zone Latent Rate [W]
This field is the rate of latent cooling (dehumidification) case credits delivered to the zone in
Watts. If an under case return duct is simulated, only a portion of the latent case credits are
applied to the zone. A negative value (or zero) will be reported when the refrigerated case
provides dehumidification (thereby reducing the zone latent load).
Refrigeration Case Zone Latent Energy [J]
This field is the amount of latent cooling (dehumidification) case credit energy delivered to the
zone in Joules. If an under case return duct is simulated, only a portion of the latent case
credits are applied to the zone. A negative value (or zero) will be reported when the
refrigerated case provides dehumidification (thereby reducing the zone latent load).
Refrigeration Case Return Air Sensible Cooling Rate [W]
This field is the rate of sensible cooling case credits delivered to the return air duct (zone
return air node) in Watts. If an under case return duct is simulated, a portion of the sensible
case credits are applied to the HVAC (zone) return air. A positive value is reported when the
return air is cooled by sensible case credits, otherwise a zero is reported. If the HVAC system
is off for a simulation timestep (no return air mass flow), then this sensible cooling is actually
provided to the zone air instead (even though a non-zero value is reported here).
Refrigeration Case Return Air Sensible Cooling Energy [J]
This field is the amount of sensible cooling case credit energy delivered to the return air duct
(zone return air node) in Joules. If an under case return duct is simulated, a portion of the
sensible case credits are applied to the HVAC (zone) return air. A positive value is reported
when the return air is cooled by sensible case credits, otherwise a zero is reported. If the
HVAC system is off for a simulation timestep (no return air mass flow), then this sensible
cooling is actually provided to the zone air instead (even though a non-zero value is reported
here).
Refrigeration Case Return Air Sensible Heating Rate [W]
This field is the rate of sensible heating case credits delivered to the return air duct (zone
return air node) in Watts. If an under case return duct is simulated, a portion of the sensible
case credits are applied to the HVAC (zone) return air. A positive value is reported when the
return air is heated by sensible case credits, otherwise a zero is reported. If the HVAC
system is off for a simulation timestep (no return air mass flow), then this sensible heating is
actually provided to the zone air instead (even though a non-zero value is reported here).
Refrigeration Case Return Air Sensible Heating Energy [J]
This field is the amount of sensible heating case credit energy delivered to the return air duct
(thereby reducing the zone latent load). If the HVAC system is off for a simulation timestep
(no return air mass flow), then this latent energy is actually provided to the zone air instead
(even though a non-zero value is reported here).

9/29/14

1189

Input-Output Reference

Group Refrigeration

Refrigeration Case Return Air Latent Energy [J]

Refrigeration Case Return Air Latent Rate [W]
These are the amount of latent cooling (dehumidification) case credit energy delivered to the
return air duct (zone return air node) in Joules or Watts. If an under case return duct is
simulated, only a portion of the latent case credits are applied to the HVAC (zone) return air.
A negative value (or zero) will be reported since the refrigerated case provides
dehumidification (thereby reducing the zone latent load). If the HVAC system is off for a
simulation timestep (no return air mass flow), then this latent energy is actually provided to
the zone air instead (even though a non-zero value is reported here).
Refrigeration Case Evaporator Fan Electric Power [W]
This field is the electric power input to the refrigerated case fan(s) in Watts.
Refrigeration Case Evaporator Fan Electric Energy [J]
This field is the electricity consumption of the refrigerated case fan(s) in Joules over the
timestep being reported. This output is also added to a meter with Resource Type =
Electricity, End Use Key = Refrigeration, Group Key = Building (Ref. Output:Meter objects).
Refrigeration Case Lighting Electric Power [W]
This field is the electric power input to the refrigerated case lights in Watts.
Refrigeration Case Lighting Electric Energy [J]
This field is the electricity consumption of the refrigerated case lights in Joules over the
timestep being reported. This output is also added to a meter with Resource Type =
Electricity, End Use Key = Refrigeration, Group Key = Building (Ref. Output:Meter objects).
Refrigeration Case Defrost Energy Correction Curve Value
This field is the output of the Defrost Energy Correction Curve which denotes the variation in
defrost energy at off-rated conditions. The output of the defrost energy correction curve
directly impacts the energy used during the defrost time period. It does not, however, impact
the duration of the defrost period. This output is available only for Electric with Temperature
Termination, Hot-Gas with Temperature Termination, or Hot-Brine with Temperature
Termination case defrost types.
Refrigeration Case Latent Credit Curve Value []
This field is the output of the Latent Case Credit Curve which denotes the variation in latent
case credits at off-rated conditions. The output of the latent case credit curve directly impacts
the amount of frost formation on the refrigerated case evaporator coil and the requirement for
defrost.
Refrigeration Case Anti Sweat Electric Power [W]
This field is the electric power input to the refrigerated case anti-sweat heater in Watts. This
output is available unless anti-sweat heater control type is specified as NONE.
Refrigeration Case Anti Sweat Electric Energy [J]
This field is the total electricity consumption of the refrigerated case anti-sweat heater in
Joules over the timestep being reported. This output is also added to a meter with Resource
Type = Electricity, End Use Key = Refrigeration, Group Key = Building (Ref. Output:Meter
objects). This output is available unless anti-sweat heater control type is specified as NONE.
Refrigeration Case Defrost Electric Power [W]
This field is the electric power input to the refrigerated case electric defrost heater(s) in Watts.
This output is available if case defrost type is Electric or Electric with Temperature
Termination.
9/29/14

1190

Input-Output Reference

Group Refrigeration

Refrigeration Case Defrost Electric Energy [J]

This field is the total electricity consumption of the refrigerated case electric defrost heater(s)
in Joules over the timestep being reported. This output is also added to a meter with
Resource Type = Electricity, End Use Key = Refrigeration, Group Key = Building (Ref.
Output:Meter objects). This output is available if case defrost type is Electric or Electric with
Temperature Termination.
Refrigeration:CaseAndWalkInList
This object provides a list of all the refrigerated cases and/or walk in coolers cooled by a
single refrigeration system (ref: Refrigeraion:CompressorRack and Refrigeration:System).
This list is extensible. Note that the names of all cases, walk-ins,air chillers, and
caseandwalkinlists must be unique. That is, you cannot give a list the same name as one of
the cases. Similarly, a walkin cannot have the same name as a case.This list may contain a
combination of case and walk-in names OR a list of air chiller names. Air chillers may not be
included in any list that also includes cases or walk-ins.
Field: Name
A unique user-assigned name for an instance of a CaseAndWalkInList. Any reference to this
list by another object will use this name.
Field: Case or WalkIn or Air Chiller <x> Name
Identifies a particular refrigerated case or walk-in. The name will be validated against the
Refrigeration Case, Refrigeration WalkIn, and Air Chiller names (ref: Refrigeration:Case,
Refrigeration:WalkIn, and Refrigeration:AirChiller) in the input file. Up to 20 are provided in
the IDD; this object is extensible.
The following is an example input for a CaseAndWalkInList.
Refrigeration:CaseAndWalkInList,
MediumTempCaselist,
!- Name
UprightDairyCase,
!- Refrigeration
LunchmeatCase,
!- Refrigeration
MeatWalkIn,
!- Refrigeration
DeliCaseOne;
!- Refrigeration

Case
Case
Case
Case

or
or
or
or

WalkIn
WalkIn
WalkIn
WalkIn

Name
Name
Name
Name

#1
#2
#3
#4

Refrigeration:WalkIn
The Refrigeration WalkIn object works in conjunction with a compressor rack, a refrigeration
system, or a refrigeration secondary system object (Ref. Refrigeration:CompressorRack,
Refrigeration:System, or Refrigeration:SecondarySystem) to simulate the performance of a
walk-in cooler. The walk-in cooler model uses information at rated conditions along with input
descriptions for heat transfer surfaces facing multiple zones to determine performance.
Energy use for lights, fans, and floor and anti-sweat heaters is modeled based on inputs for
nominal power, schedules, and control type. The walk-in cooler model accounts for the
sensible and latent heat exchange with the surrounding environment (termed "case credits")
which impacts the temperature and humidity in each zone adjacent to the walk-in.
The walk-in cooler object inputs include a name, an availability schedule name, the rated
cooling capacity, the rated operating temperature, the rated cooling source temperature, the
rated total heating power and heating power schedule, the rated fan and lighting power and
schedules, defrost type, defrost control type, defrost schedule name, drip-down schedule
name, defrost power, the portion of the defrost energy used to melt ice (only for temperature
termination control type), restocking schedule, refrigerant inventory, and the floor area and Uvalue.
For each zone adjacent to the walk-in, the user must input the zone name and the insulated
surface area and U-value facing that zone. The user must also specify, for two types of
doors, the door area, height, U-value, door opening schedule name, and any door opening
protection.
9/29/14

1191

Input-Output Reference

Group Refrigeration

Under case HVAC return air fraction, available for refrigerated cases, is not available for
walk-in coolers.
Field: Name
A unique user-assigned name for an instance of a refrigerated walk-in. Any reference to this
walk-in by another object will use this name.
Field: Availability Schedule Name
The name of the schedule (ref: Schedule) that denotes whether the walk in can operate
during a given time period. A schedule value greater than 0 (maximum schedule value of 1.0
is typically used) indicates that the walkin will operate during a given time period. A value
equal to 0 denotes that the case does not operate (everything is OFF: refrigeration, fans,
lights, anti-sweat, etc.). Typically the walkin will operate throughout the day (i.e., the schedule
will contain 1 for all time periods); however, walkins require maintenance and/or cleaning and
this can be modeled accordingly using this schedule if desired. If this field is left blank, the
default schedule has a value of 1 for all time periods.
Field: Rated Coil Cooling Capacity
The total, full load cooling capacity (sensible plus latent) in watts (W) at rated conditions The
value entered for this field must be greater than zero, with no default value.
Field: Operating Temperature
The rated average temperature of the air and products within the walk-in cooler in C. The
entered value for this field must be less than 20C. There is no default value.
Field: Rated Cooling Source Temperature
For a DX evaporator coil, enter the saturated evaporating temperature in C. For a fluid coil,
enter the fluid coil entrance temperature in C. There is no default value. This number is
used, with temperatures for other refrigeration loads on any one system, to set that systems
minimum suction pressure or minimum circulating fluid temperature. (This value is not used if
the walkin is cooled by a compressor rack object.)
Field: Rated Total Heating Power
The total heating power in watts including all anti-sweat, door, drip-pan, and floor heaters
(W). This value is required and has no default value.
Field: Heating Power Schedule Name
The name of the schedule (ref: Schedule) that denotes the fraction of heater power that
operates during a given time period. A schedule value of zero denotes that all heaters are off.
A schedule value greater than 0 indicates that some portion of the total heater power will
operate during that time period (maximum schedule value of 1.0 means all heaters are fully
on). For example, if door and floor heaters represent 50% of the total heater power and are
on all the time, the minimum schedule value would be 0.5. If anti-sweat heaters represent
40% of the total heater power and are only on during certain hours, the schedule value during
those hours would be increased by 0.4. If this field is left blank, the default schedule has a
value of 1 for all time periods.
Field: Rated Cooling Coil Fan Power
The cooling coil fan power in watts (W). This value has a default value of 375W. This fan is
assumed to run continuously except during electric, hot brine, or hot gas defrost periods.
Field: Rated Circulation Fan Power
The circulation fan power in watts (W). This value has a default value of 0 W. This fan is
assumed to run continuously.

9/29/14

1192

Input-Output Reference

Group Refrigeration

Field: Rated Total Lighting Power

The total lighting power in watts including both display and task lighting (W). This value is
required and has no default value.
Field: Lighting Schedule Name
The name of the schedule (ref: Schedule) that denotes the fraction of walk-in lights that
operate during a given time period. A schedule value greater than 0 indicates that the lights
will operate during that time period (maximum schedule value of 1.0 means lights are fully
on). A schedule value of zero denotes that the lights are off. If this field is left blank, the
default schedule has a value of 1 for all time periods.
Field: Defrost Type
The type of defrost used for this walk-in. Valid choices are None, Off-Cycle, HotFluid, and
Electric. The default defrost type is Electric if the field is blank. HotFluid includes both hot gas
and hot brine defrost systems. Refer to the Engineering Reference for further information on
how the different defrost types are modeled.
Field: Defrost Control Type
The type of defrost control used for this walkin. Valid choices are TimeSchedule and
TemperatureTermination. The default is TimeSchedule if the field is blank. Refer to the
Engineering Reference for further information on how the different defrost controls are
modeled.
Field: Defrost Schedule Name
The name of the schedule (ref: Schedule) that denotes when the walkin requires defrosting. A
schedule value of 1.0 indicates that defrost will be on during a given time period if the defrost
control type is TimeSchedule. For the TemperatureTermination defrost control type, the
defrost will start with the schedule value changes from 0 to 1, but will end when the ice is
melted. A value equal to 0 denotes that the defrost is off. Defrost schedules normally repeat
the duration and number of defrost cycles for each day of the year. The walkin manufacturer
typically provides this information with the product literature. If TemperatureTermination
control type is used, the defrost schedule is used for the defrost cycle start time and the
defrost cycle end time is not allowed to extend beyond the scheduled off time. The use of
Compact Schedules (ref. Schedules) are ideal for this purpose.
Field: Defrost Drip-Down Schedule Name
The name of the schedule (ref: Schedule) that denotes whether the walkin requires additional
time for draining condensate after the defrost period. A schedule value of 1.0 indicates that
the defrost drip-down period is on during a given time period. A value equal to 0 denotes that
the defrost drip-down period is over. The walkin manufacturer typically provides this
information with the product literature.
Each defrost drip-down period specified in this schedule should start at the same time as the
corresponding defrost period specified in the schedule for Defrost Schedule, and the dripdown schedule defrost period should always be longer than or equal to the length of the
defrost schedule time period. For example, if the defrost schedule contains a defrost period
from 7:00 to 7:15, you would specify a case defrost drip-down period from 7:00 to 7:20 if you
wanted to model a 5 minute condensate drip-down period after the regular defrost period. If
no drip-down schedule is entered, then the defrost schedule (specified for the previous input
field) will be used. The use of Compact Schedules (ref. Schedules) are ideal for this purpose.
Field: Defrost Power
The defrost power in watts. This input is required for hot-fluid (hot gas or hot brine), or electric
defrost types. Walkin manufacturers do not typically provide information on the heat input for
hot gas and hot brine defrost. Information provided for electric defrost power can be
substituted here for walkins using hot-gas or hot-brine defrost if other information is not
9/29/14

1193

Input-Output Reference

Group Refrigeration

available. Only electric Defrost Types consume electricity during the defrost period. The
entered value for this field must be greater than or equal to zero.
Field: Temperature Termination Defrost Fraction to Ice
When cooling coils go through a defrost cycle, only a portion of the defrost energy is actually
used to melt the ice. The rest of the defrost energy goes to increasing the temperature of the
coils themselves and to the walkin environment. The Temperature Termination defrost control
type calculates the end of the defrost cycle that corresponds to melting all the ice. Therefore,
the user must input this fractional value. The default value is 0.7 for electric defrost and 0.3
for hot fluid defrost. Refer to the Engineering Reference for further information on how the
defrost energy control types are modeled.
Field: Restocking Schedule Name
The name of the schedule (ref: Schedule) that denotes whether the walkin is being restocked
with product. The schedule should contain values in units of Watts (note this is different from
the restocking schedule values for cases that are entered per unit length). This field can be
used to denote the additional load imposed on the walkin from stocking the walkin with
product that is warmer than the walkin temperature. This information is difficult to find and
may required additional research for proper modeling; however, this schedule is available for
this purpose if desired. If restocking of the refrigerated walkin will not be simulated, enter a
schedule with values of zero for all time periods or leave this field blank.
Field: Average Refrigerant Charge Inventory
The value of this optional field is the refrigerant inventory present in the walkin during
ordinary operation. The value is used to produce an estimate of the total refrigerant present in
the refrigeration system. The value is entered in kg.
Field: Insulated Floor Surface Area
The floor area in square meters. This value is required and has no default value.
Field: Insulated Floor U-Value
The floor themal transmittance (in W/m 2-K). This value has a default value of 0.3154. (This
corresponds to R18 in Archaic American Insulation Units. To convert other R-values to
thermal transmittance, divide 5.678 by the R-value. For example, R15 is 0.3785 W/m 2-K and
R5 is 1.136 W/m2-K.)
THE REMAINING 12 FIELDS FOR THE WALK-IN COOLER MUST BE REPEATED FOR
EACH ZONE WHICH IS IN CONTACT WITH A WALK-IN WALL, CEILING, OR DOOR. The
IDD includes fields for 3 zones, but can be extended by repeating the last 12 values in
the object.
Field: Zone <x> Name
The name of a zone adjoining the walkin. The walkin will impact the air heat balance in this
zone. This zone must represent a conditioned space, that is, it must appear in a
ZoneHVAC:EquipmentConnections object.
Field: Total Insulated Surface Area Facing Zone <x>
The total surface area (walls and ceilings) facing this particular zone in square meters. This
value is required and has no default value.
Field: Insulated Surface U-Value Facing Zone <x>
The surface (walls and ceilings) themal transmittance (in W/m 2-K). This value has a default
value of 0.3154. (This corresponds to R18 in Archaic American Insulation Units. To convert
other R-values to thermal transmittance, divide 5.678 by the R-value. For example, R15 is
0.3785 W/m2-K and R5 is 1.136 W/m2-K.)

9/29/14

1194

Input-Output Reference

Group Refrigeration

Field: Area of Glass Reach In Doors Facing Zone <x>

The total area of glass doors facing this particular zone in square meters. The default is 0.0.
Field: Height of Glass Reach In Doors Facing Zone <x>
The glass reach in door height in meters. The default is 1.5.
Field: Glass Reach In Door U-Value Facing Zone <x>
The glass door themal transmittance (in W/m 2-K). This field has a default value of 1.136.
(This corresponds to R5 in Archaic American Insulation Units.)
Field: Glass Reach In Door Opening Schedule Name Facing Zone <x>
The name of the schedule (ref: Schedule) that denotes the fraction of time glass doors are
open during a given time period. The schedule values should be between 0 and 1.0. If no
schedule is specified, the doors are assumed to be open 5% of the time (corresponding to a
schedule value of 0.05).
Field: Area of Stocking Doors Facing Zone <x>
The total area of stock doors facing this particular zone in square meters. The default is 0.0.
Field: Height of Stocking Doors Facing Zone <x>
The stocking door height in meters. The default is 2.0.
Field: Stocking Door U-Value Facing Zone <x>
The stocking door themal transmittance (in W/m2-K). This value has a default value of
0.3785. (This corresponds to R15 in Archaic American Insulation Units.)
Field: Stocking Door Opening Schedule Name Facing Zone <x>
The name of the schedule (ref: Schedule) that denotes the fraction of time stocking doors are
open during a given time period. The schedule values should be between 0 and 1.0. If no
schedule is specified, the doors are assumed to be open 5% of the time (corresponding to a
schedule value of 0.05).
Field: Stocking Door Opening Protection Type Facing Zone <x>
The type of stocking door opening protection used for this walkin. Valid choices are None,
AirCurtain, and StripCurtain. The default is AirCurtain if the field is blank. Use the type,
StripCurtain, for both hanging strips and airlock vestibules. Refer to the Engineering
Reference for further information on how the door protection types are modeled.
The following is an example input for a refrigeration walkin.

9/29/14

1195

Input-Output Reference
Refrigeration:WalkIn,
WalkInFreezer,
CaseOperatingSched,
4690.,
-2.22,
-6.67,
0.0,
CaseOperatingSched,
735.,
0.0,
120.,
CaseLightingSched2,
Electric,
TimeSchedule,
CaseDefrostSched3,
CaseDripDownSched3,
5512.,
,
WalkInStockingSched,
,
13.0,
0.207,
BackRoom,
43.4,
.235,
,
,
,
,
2.0,
2.0,
,
WIStockDoorOpenSch,
StripCurtain;

Group Refrigeration

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!-

Name
Availability Schedule Name
Rated Coil Cooling Capacity {W}
Operating Temperature {C}
Rated Cooling Source Temperature {C}
Rated Total Heating Power {W}
Heating Power Schedule Name
Rated Cooling Coil Fan Power {W}
Rated Circulation Fan Power {W}
Rated Total Lighting Power {W}
Lighting Schedule Name
Defrost Type
Defrost Control Type
Defrost Schedule Name
Defrost Drip-Down Schedule Name
Defrost Power {W}
Temperature Termination Defrost Fraction to Ice {dimensionless}
Restocking Schedule Name
Average Refrigerant Charge Inventory {kg}
Insulated Floor Surface Area {m2}
Insulated Floor U-Value {W/m2-C}
Zone Name
Total Insulated Surface Area Facing this Zone {m2}
Insulated Surface U-Value Facing this Zone {W/m2-C}
Area of Glass Reach In Doors Facing this Zone {m2}
Height of Glass Reach In Doors Facing this Zone {m}
Glass Reach In Door U Value Facing this Zone {W/m2-C}
Glass Reach In Door Opening Schedule Name Facing this Zone
Area of Stocking Doors Facing this Zone {m2}
Height of Stocking Doors Facing this Zone {m}
Stocking Door U Value Facing this Zone {W/m2-C}
Stocking Door Opening Schedule Name Facing this Zone
Stocking Door Opening Protection Type Facing this Zone

Refrigeration Case and WalkIn Outputs

Zone,Average,Refrigeration Walk In Evaporator Total Cooling Rate [W]
Zone,Sum,Refrigeration Walk In Evaporator Total Cooling Energy [J]
Zone,Average,Refrigeration Walk In Evaporator Sensible Cooling Rate [W]
Zone,Sum,Refrigeration Walk In Evaporator Sensible Cooling Energy [J]
Zone,Average,Refrigeration Walk In Evaporator Latent Cooling Rate [W]
Zone,Sum,Refrigeration Walk In Evaporator Latent Cooling Energy [J]
Zone,Average,Refrigeration Walk In Ancillary Electric Power [W]
Zone,Sum,Refrigeration Walk In Ancillary Electric Energy [J]
Zone,Average,Refrigeration Walk In Fan Electric Power [W]
Zone,Sum,Refrigeration Walk In Fan Electric Energy [J]
Zone,Average,Refrigeration Walk In Lighting Electric Power [W]
Zone,Sum,Refrigeration Walk In Lighting Electric Energy [J]
Zone,Average,Refrigeration Walk In Heater Electric Power [W]
Zone,Sum,Refrigeration Walk In Heater Electric Energy [J]
Report only for WalkIns using electric defrost
Zone,Average,Refrigeration Walk In Defrost Electric Power [W]
Zone,Sum,Refrigeration Walk In Defrost Electric Energy [J]
Report for each Zone exchanging energy with the WalkIn
Zone,Average,Refrigeration Walk In Zone Sensible Cooling Rate [W]
Zone,Sum,Refrigeration Walk In Zone Sensible Cooling Energy [J]
Zone,Average, Zone,Average,Refrigeration Walk In Zone Sensible Heating Rate [W]
Zone,Sum,Refrigeration Walk In Zone Sensible Heating Energy [J]
Zone,Average,Zone,Average,Refrigeration Walk In Zone Latent Rate [W]
Zone,Sum,Refrigeration Walk In Zone Latent Energy [J]

9/29/14

1196

Input-Output Reference

Group Refrigeration

Refrigeration Walk In Evaporator Total Cooling Rate [W]

This field is the total (sensible plus latent) cooling rate of the WalkIn evaporator coil in Watts.
Refrigeration Walk In Evaporator Total Cooling Energy [J]
This field is the total (sensible plus latent) cooling of the WalkIn evaporator coil in Joules over
the timestep being reported. This output is also added to a meter with Resource Type =
EnergyTransfer, End Use Key = Refrigeration, Group Key = Building (Ref. Output:Meter
objects).
Refrigeration Walk In Evaporator Sensible Cooling Rate [W]
This field is the sensible cooling rate of the WalkIn evaporator coil in Watts.
Refrigeration Walk In Evaporator Sensible Cooling Energy [J]
This field is the sensible cooling of the WalkIn evaporator coil in Joules over the timestep
being reported.
Refrigeration Walk In Evaporator Latent Cooling Rate [W]
This field is the latent cooling (dehumidification) rate of the WalkIn evaporator coil in Watts.
Refrigeration Walk In Evaporator Latent Cooling Energy [J]
This field is the latent cooling (dehumidification) of the WalkIn evaporator coil in Joules over
the timestep being reported.
Refrigeration Walk In Ancillary Electric Power [W]
This field is the total electricity (fan, heaters, lights, and electric defrost) used by the walkin in
Watts.
Refrigeration Walk In Ancillary Electric Energy [J]
This field is the electricity (fan, heaters, lights, and electric defrost)used by the WalkIn in
Joules over the timestep being reported.
Refrigeration Walk In Fan Electric Power [W]
This field is the electric power input to the WalkIn fan(s) in Watts.
Refrigeration Walk In Fan Electric Energy [J]
This field is the electricity consumption of the WalkIn fan(s) in Joules over the timestep being
reported. This output is also added to a meter with Resource Type = Electricity, End Use Key
= Refrigeration, Group Key = Building (Ref. Output:Meter objects).
Refrigeration Walk In Lighting Electric Power [W]
This field is the electric power input to the WalkIn lights in Watts.
Refrigeration Walk In Lighting Electric Energy [J]
This field is the electricity consumption of the WalkIn lights in Joules over the timestep being
reported. This output is also added to a meter with Resource Type = Electricity, End Use Key
= Refrigeration, Group Key = Building (Ref. Output:Meter objects).
Refrigeration Walk In Heater Electric Power [W]
This field is the electric power input to the WalkIn heaters in Watts.
Refrigeration Walk In Heater Electric Energy [J]
This field is the total electricity consumption of the WalkIn heaters in Joules over the timestep
being reported. This output is also added to a meter with Resource Type = Electricity, End
Use Key = Refrigeration, Group Key = Building (Ref. Output:Meter objects).
9/29/14

1197

Input-Output Reference

Group Refrigeration

Refrigeration Walk In Defrost Electric Power [W]

This field is the electric power input to the WalkIn electric defrost heater(s) in Watts. This
output is available if case defrost type is Electric.
Refrigeration Walk In Defrost Electric Energy [J]
This field is the total electricity consumption of the WalkIn electric defrost heater(s) in Joules
over the timestep being reported. This output is also added to a meter with Resource Type =
Electricity, End Use Key = Refrigeration, Group Key = Building (Ref. Output:Meter objects).
This output is available if case defrost type is Electric.
The following output variables are available for each zone adjacent to the walkin. An output
variable identification is created for each zone exchanging energy with the walkin. For
example if the walkin, DairyWalkIn, were exchanging energy with the zone, SalesArea, the
output variable identification would be DairyWalkInInZoneSalesArea.
Refrigeration Walk In Zone Sensible Cooling Rate [W]
This field is the rate of sensible cooling case credits delivered to the zone in Watts. A positive
value is reported when the zone is cooled by sensible case credits, otherwise a zero is
reported.
Refrigeration Walk In Zone Sensible Cooling Energy [J]
This field is the amount of sensible cooling case credit energy delivered to the zone in Joules.
A positive value is reported when the zone is cooled by sensible case credits, otherwise a
zero is reported.
Refrigeration Walk In Zone Sensible Heating Rate [W]
This field is the rate of sensible heating case credits delivered to the zone in Watts. A positive
value is reported when the zone is heated by sensible case credits, otherwise a zero is
reported.
Refrigeration Walk In Zone Sensible Heating Energy [J]
This field is the amount of sensible heating case credit energy delivered to the zone in
Joules. A positive value is reported when the zone is heated by sensible case credits,
otherwise a zero is reported.
Refrigeration Walk In Zone Latent Rate [W]
This field is the rate of latent cooling (dehumidification) case credits delivered to the zone in
Watts. A negative value (or zero) will be reported when the WalkIn provides dehumidification
(thereby reducing the zone latent load).
Refrigeration Walk In Zone Latent Energy [J]
This field is the amount of latent cooling (dehumidification) case credit energy delivered to the
zone in Joules. A negative value (or zero) will be reported when the WalkIn provides
dehumidification (thereby reducing the zone latent load).
Refrigeration:System
The refrigeration system object simulates the performance of a supermarket refrigeration
system when used along with other objects to define the refrigeration load(s), the
compressor(s), and the condenser.
At least one refrigeration load object must be defined which may be one of four types of load,
a refrigerated case, a walk-in cooler, a chiller providing refrigeration to a secondary loop, or a
cascade condenser which absorbs heat rejected by a lower-temperature system (Ref.
Refrigeration:Case,
Refrigeration:WalkIn,
Refrigeration:SecondarySystem,
and
Refrigeration:Condenser:Cascade) If multiple loads are served by the same system , the user
should use one or both of the list objects available to assign loads to the system. The first list
9/29/14

1198

Input-Output Reference

Group Refrigeration

includes
all
cases
and
walkins
cooled
directly by this
system
(Ref.
Refrigeration:CaseAndWalkInList). The second list includes any transfer loads, that is
refrigeration loads borne by this system that are transferred from another refrigeration system
via
either
a
secondary
loop
chiller
or
a
cascade
condenser
(Ref.
Refrigeration:TransferLoadList, see the Engineering Reference for more information about
these types of systems).
The refrigeration system object is capable of modeling both single-stage and two-stage
compression refrigeration systems. The name of at least one compressor must be defined
and a list object is available if the system is served by more than one compressor (Ref.
Refrigeration:Compressor and Refrigeration:CompressorList).
Heat is rejected outdoors in a condenser by direct air flow, evaporative water cooling, by a
water-cooled condenser with appropriate plant loop piping, or to a cascade condenser cooled
by
another
refrigeration
system(ref:
Refrigeration:Condenser:AirCooled,
Refrigeration:Condenser:EvaporativeCooled,
Refrigeration:Condenser:WaterCooled,
Refrigeration:Condenser:Cascade). With evaporative cooling, water is sprayed through the
air stream to effectively lower the air temperature experienced by the condenser coil as a
result of water evaporation. The use of a water-cooled condenser requires the definition of a
plant loop to supply cooling to the condenser. If a cascade condenser is specified, the
refrigeration system absorbing the rejected heat must also be defined.
The refrigeration system may also include a liquid suction and/or mechanical subcooler (Ref.
Refrigeration:Subcooler).
The system object coordinates the energy flows between the other refrigeration objects and
is used to set system parameters. Compressor waste heat can also be reclaimed for use by
an optional air- or water-heating coil (Ref. Coil:Heating:Desuperheater and
Coil:WaterHeating:Desuperheater).
The inputs for the refrigeration system object, in addition to the names of the other
refrigeration objects described above, include a name for this system, the minimum
condensing temperature, the refrigeration system working fluid, and the type of saturated
suction temperature control. Optional input fields are also provided for users seeking to keep
track of refrigerant inventory and suction pipe heat gains.
Field: Name
A unique user-assigned name for an instance of a refrigeration system. Any reference to this
refrigeration system by another object will use this name.
Field: Refrigerated Case or WalkIn or CaseAndWalkInList Name
Identifies a single case, a single walkin, single air chiller, or a particular list of refrigerated
cases and walkins or air chillers, that is cooled by this refrigeration system. The name will be
validated against the case, walkin, air chiller and CaseAndWalkInList names
(ref:
Refrigeration:Case,
Refrigeration:WalkIn,
Refrigeration:AirChiller,
and
Refrigeration:CaseAndWalkInList) in the input file. Only cases and walkins or air chillers
served directly by the system should be included in this list. Any cases, walkins, or air
chillers served indirectly via a secondary loop should NOT be included in this list. Note that
any system that serves an air chiller cannot also serve a case or walkin.
Field: Refrigeration Transfer Load or TransferLoad List Name
Identifies a single SecondarySystem, a single Cascade Condenser, OR or a list of Transfer
Loads (where the list is comprised of SecondarySystems and/or Cascade Condensers) that
are cooled by this refrigeration system. The name will be validated against the secondary
system,
cascade
condenser,
and
TransferLoad
list
names
(ref:
Refrigeration:SecondarySystem,
Refrigeration:Condenser:Cascade,
and
Refrigeration:TransferLoadList) in the input file. Only secondary systems and cascade
condensers served directly by the system should be included in this list. (NOTE this entry is

9/29/14

1199

Input-Output Reference

Group Refrigeration

for a cascade condenser cooled by this system, not a condenser absorbing heat rejected by
this system.)
Field: Condenser Name
The name of the condenser that is used to reject heat from this refrigeration system. The
name
will
be
validated
against
the
condenser
names
(ref:
Refrigeration:Condenser:AirCooled,
Refrigeration:Condenser:WaterCooled,
Refrigeration:Condenser:EvaporativeCooled, and Refrigeration:Condenser:Cascade) in the
input file.
Field:Compressor or Compressor List Name
Identifies a single compressor, or a particular list of compressors, that provide cooling energy
to this refrigeration system. The name will be validated against the compressor list names
(ref: List:Refrigeration:Compressors) in the input file. If the refrigeration systems contains two
stages of compression, this field identifies the low-stage compressors connected to the twostage system.
Field: Minimum Condensing Temperature
This numeric field specifies the minimum condensing temperature (C), which is usually
determined by the temperature required to maintain acceptable thermal expansion valve
performance.
Field: Refrigeration System Working Fluid Type
The type of refrigerant used by the system. Valid choices are R11, R123, R134A, R12, R22,
R404A, R507A, or R410A. This name will be validated against Fluid Names (ref: Fluid
Properties section) in the input file. Note that the corresponding property data, available in
FluidPropertiesRefData.idf, must by supplied in the input file.
Field: Suction Temperature Control Type
The type of saturated suction temperature control used by the system. Valid choices are
FloatSuctionTemperature and ConstantSuctionTemperature. If the field is blank, the
default will be ConstantSuctionTemperature. See the Engineering Reference section,
Variable Evaporator Temperature, for a discussion of this option.
Field: Mechanical Subcooler Name
This optional field identifies a mechanical subcooler that absorbs heat from this refrigeration
system. This field should not be used for a mechanical subcooler that absorbs heat from
another system. The name will be validated against the subcooler names (ref:
Refrigeration:Subcooler) in the input file.
Field: Liquid Suction Heat Exchanger Subcooler Name
This optional field Identifies a particular liquid suction heat exchanger (LSHX) subcooler
present in this refrigeration system. The name will be validated against the subcooler names
(ref: Refrigeration:Subcooler) in the input file.
Field: Sum UA Suction Piping
This optional field is typically used when trying to determine the impact of pipe heat gains on
system performance and zone heat balance, particularly in comparing a DX system to a
secondary system. Enter the value for suction piping heat gain (in W/C). That is, sum up the
product of the pipe wall insulation conductance times the outer surface area of the pipe
insulation. Please see the Engineering Reference for guidance in calculating this value. If the
Sum UA Suction Piping is entered, the Suction Piping Zone Name is also required.

9/29/14

1200

Input-Output Reference

Group Refrigeration

Field: Suction Piping Zone Name

This optional field is typically used when trying to determine the impact of pipe heat gains on
system performance, particularly in comparing a DX system to a secondary system. (If the
previous field, Sum UA Suction Piping, is blank, this field will not be used.) Enter the name of
the zone where the suction piping is located. The suction piping heat gains will be calculated
based upon the air temperature within this zone. The heat balance of this zone will also be
affected by the piping heat exchange. Additional output variables are described at the end of
this Group-Refrigeration section for the total impact of refrigeration on zones, including
suction pipe heat exchange.
Field: End-Use Subcategory
This field allows the specification of a user-defined end-use subcategory (e.g., "Low
Temperature Rack"). A new meter for reporting is created for each unique subcategory (Ref:
Output:Meter objects). Subcategories are also reported in the ABUPS table. If this field is left
blank, the equipment will be assigned to the "General" end-use subcategory.
Field: Number of Compressor Stages
This field determines whether the refrigeration system contains one or two stages of
compression. In this field, enter either 1 for single-stage compression systems or 2 for
two-stage compression systems. If two stages of compression are selected, then an
intercooler will be used between the compressor stages to cool the discharge of the lowstage compressors. The default value is 1.
Field: Intercooler Type
This field determines the type of intercooler which is used for two-stage compression
systems. Valid choices for this field include None, Flash Intercooler or Shell-and-Coil
Intercooler. Single-stage systems require None while two-stage systems require either
Flash Intercooler or Shell-and-Coil Intercooler.
The default selection is None,
corresponding to a single-stage compression system.
Field: Shell-and-Coil Intercooler Effectiveness
When a shell-and-coil intercooler is selected for two-stage compression systems, this field
allows the specification of the shell-and-coil intercooler effectiveness. Values in this field will
only be valid if Shell-and-Coil Intercooler is selected in the Intercooler Type field above.
The valid range of values for this field is between 0.0 and 1.0. A default value of 0.80 will be
used if none is specified.
Field: High-Stage Compressor or CompressorList Name
Identifies a single compressor, or a particular list of compressors, that comprise the highstage compression of a two-stage compression refrigeration system. The name will be
validated against the compressor list names (ref: List:Refrigeration:Compressors) in the input
file. Names in this field are only valid if two compressor stages have been specified in the
Number of Compressor Stages field above.
The following is an example input for a single-stage compression refrigeration system.

9/29/14

1201

Input-Output Reference

Group Refrigeration

Refrigeration:System,
MediumTempSystem,
!- Refrigeration System Name
MediumTempCaselist,
!- Refrigeration Case or Walkin or CaseAndWalkInList Name
,
!- Refrigeration Transfer Load or TransferLoad List Name
AirCooledCondenserA,
!- Refrigeration Condenser Name
MediumTempCompressorlist, !- Refrigeration Compressor or CompressorList Name
25.0,
!- Minimum Condensing Temperture {C}
R134a,
!- Refrigeration System Working Fluid
ConstantSuctionTemperature, !- Suction Temperature Control Type
,
!- Optional mechanical subcooler name
,
!- Optional LSHX subcooler name
,
!- Sum UA Distribution Piping {W/K}
,
!- Distribution Piping Zone Name
MedTempRefrig;
!- End-Use Subcategory

The following is an example input for a two-stage compression refrigeration system.

Refrigeration:System,
LowTempSystem,
!LowTempCaselist,
!,
!AirCooledCondenserB,
!LowStageCompressorList, !25.0,
!R404A,
!ConstantSuctionTemperature,
,
!,
!,
!,
!LowTempRefrig,
!2,
!Shell-and-Coil Intercooler,
0.7,
!HiStageCompressorList
!-

Refrigeration System Name

Refrigeration Case or Walkin or CaseAndWalkInList Name
Refrigeration Transfer Load or TransferLoad List Name
Refrigeration Condenser Name
Refrigeration Compressor or CompressorList Name
Minimum Condensing Temperture {C}
Refrigeration System Working Fluid
!- Suction Temperature Control
Optional mechanical subcooler name
Optional LSHX subcooler name
Sum UA Distribution Piping {W/K}
Distribution Piping Zone Name
End-Use Subcategory
Number of Compressor Stages
!- Intercooler Type
Shell-and-Coil Intercooler Effectiveness
High-Stage Compressor or CompressorList Name

Refrigeration System Outputs

THE FOLLOWING OUTPUTS ARE AVAILABLE FOR SYSTEMS THAT SERVE CASES AND/OR
WALKINS:
Zone,Average, Refrigeration System Total Compressor Electric Power [W]
Zone,Sum, Refrigeration System Total Compressor Electric Energy [J]
Zone,Average, Refrigeration System Average Compressor COP [W/W]
Zone,Average, Refrigeration System Total Compressor Heat Transfer Rate [W]
Zone,Sum, Refrigeration System Total Compressor Heat Transfer Energy [J]
Zone,Average, Refrigeration System Total Cases and Walk Ins Heat Transfer
Rate [W]
Zone,Sum, Refrigeration System Total Cases and Walk Ins Heat Transfer Energy
[J]
Zone,Average, Refrigeration System Total Transferred Load Heat Transfer Rate
[W]
Zone,Sum, Refrigeration System Total Transferred Load Heat Transfer Energy
[J]
Zone,Average, Refrigeration System Total Suction Pipe Heat Gain Rate [W]
Zone,Sum, Refrigeration System Total Suction Pipe Heat Gain Energy [J]
Zone,Average, Refrigeration System Net Rejected Heat Transfer Rate [W]
Zone,Sum, Refrigeration System Net Rejected Heat Transfer Energy [J]
Zone,Average,Refrigeration System Estimated Refrigerant Inventory Mass [kg]
Zone,Average, Refrigeration System Liquid Suction Subcooler Heat Transfer
Rate [W]
Zone, Sum, Refrigeration System Liquid Suction Subcooler Heat Transfer Energy
[J]
Zone,Average, Refrigeration System Estimated Refrigerant Inventory [kg]
Zone,Average, Refrigeration System Estimated Refrigerant Mass Flow Rate
[kg/s]
9/29/14

1202

Input-Output Reference

Group Refrigeration

Zone,Average, Refrigeration System Condensing Temperature [C]'

Zone,Average, Refrigeration System Evaporating Temperature [C]
Zone,Average, Refrigeration System Suction Pipe Suction Temperature [C]
Zone,Average, Refrigeration System Thermostatic Expansion Valve Liquid
Temperature [C]
Zone,Average, Refrigeration System Estimated High Stage Refrigerant Mass Flow
Rate [kg/s]
Zone,Sum,Refrigeration System Total High Stage Compressor Electric Energy [J]
Zone,Average,Refrigeration System Total High Stage Compressor Electric Power
[W]
Zone,Sum,Refrigeration System Total High Stage Compressor Heat Transfer
Energy [J]
Zone,Average,Refrigeration System Total High Stage Compressor Heat Transfer
Rate [W]
Zone,Sum,Refrigeration System Total Low and High Stage Compressor Electric
Energy [J]
Zone,Sum,Refrigeration System Total Low Stage Compressor Electric Energy [J]
Zone,Average,Refrigeration System Total Low Stage Compressor Electric Power
[W]
Zone,Sum,Refrigeration System Total Low Stage Compressor Heat Transfer Energy
[J]
Zone,Average,Refrigeration System Total Low Stage Compressor Heat Transfer
Rate [W]
Zone,Average,Refrigeration System Estimated Low Stage Refrigerant Mass Flow
Rate [kg/s]
THE FOLLOWING OUTPUTS ARE AVAILABLE FOR SYSTEMS THAT SERVE AIR CHILLERS:
HVAC,Average, Refrigeration Air Chiller System Total Compressor Electric
Power [W]
HVAC,Sum, Refrigeration Air Chiller System Total Compressor Electric Energy
[J]
HVAC,Average, Refrigeration Air Chiller System Average Compressor COP [W/W]
HVAC,Average, Refrigeration Air Chiller System Total Compressor Heat Transfer
Rate [W]
HVAC,Sum, Refrigeration Air Chiller System Total Compressor Heat Transfer
Energy [J]
HVAC,Average, Refrigeration Air Chiller System Total Air Chiller Heat
Transfer Rate [W]
HVAC,Sum, Refrigeration Air Chiller System Total Case and Walk In Heat
Transfer Energy [J]
HVAC,Average, Refrigeration Air Chiller System Total Transferred Load Heat
Transfer Rate [W]
HVAC,Sum, Refrigeration Air Chiller System Total Transferred Load Heat
Transfer Energy [J]
HVAC,Average, Refrigeration Air Chiller System Total Suction Pipe Heat Gain
Rate [W]
HVAC,Sum, Refrigeration Air Chiller System Total Suction Pipe Heat Gain
Energy [J]
HVAC,Average, Refrigeration Air Chiller System Net Rejected Heat Transfer
Rate [W]
HVAC,Sum, Refrigeration Air Chiller System Net Rejected Heat Transfer Energy
[J]
HVAC,Average, Refrigeration Air Chiller System Liquid Suction Subcooler Heat
Transfer Rate [W]
HVAC, Sum, Refrigeration Air Chiller System Liquid Suction Subcooler Heat
Transfer Energy [J]
HVAC,Average, Refrigeration Air Chiller System Estimated Refrigerant
Inventory Mass [kg]
HVAC,Average, Refrigeration Air Chiller System Estimated Refrigerant Mass
Flow Rate [kg/s]
HVAC,Average,Refrigeration Air Chiller System Intercooler Temperature [C]
HVAC,Average,Refrigeration Air Chiller System Intercooler Pressure [Pa]
9/29/14

1203

Input-Output Reference

Group Refrigeration

HVAC,Average, Refrigeration Air Chiller System Condensing Temperature [C]'

HVAC,Average, Refrigeration Air Chiller System Evaporating Temperature [C]
HVAC,Average, Refrigeration Air Chiller System Suction Temperature [C]
HVAC,Average, Refrigeration Air Chiller System TXV Liquid Temperature [C]
HVAC,Average,Refrigeration Air Chiller System Estimated High Stage
Refrigerant Mass Flow Rate [kg/s]
HVAC,Sum,Refrigeration Air Chiller System Total High Stage Compressor
Electric Energy [J]
HVAC,Average,Refrigeration Air Chiller System Total High Stage Compressor
Electric Power [W]
HVAC,Sum,Refrigeration Air Chiller System Total High Stage Compressor Heat
Transfer Energy [J]
HVAC,Average,Refrigeration Air Chiller System Total High Stage Compressor
Heat Transfer Rate [W]
HVAC,Sum, Refrigeration Air Chiller System Total Low and High Stage
Compressor Electric Energy [J]
HVAC,Sum,Refrigeration Air Chiller System Total Low Stage Compressor Electric
Energy [J]
HVAC,Average,Refrigeration Air Chiller System Total Low Stage Compressor
Electric Power [W]
HVAC,Sum, Refrigeration Air Chiller System Total Low Stage Compressor Heat
Transfer Energy [J]
HVAC,Average,Refrigeration Air Chiller System Total Low Stage Compressor Heat
Transfer Rate [W]
HVAC,Average,Refrigeration Air Chiller System Estimated Low Stage Refrigerant
Mass Flow Rate [kg/s]

THE FOLLOWING OUTPUTS ARE AVAILABLE FOR SYSTEMS THAT SERVE CASES
AND/OR WALKINS
Refrigeration System Total Compressor Electric Power [W]
This output is the total electric power input to the system compressor(s) in Watts.
Refrigeration System Total Compressor Electric Consumption [J]
This is the electricity consumption of the systems compressor(s) in Joules for the timestep
being reported. The individual consumption for each compressor is also added to a meter
with Resource Type = Electricity, End Use Key = Refrigeration, Group Key = Plant (Ref.
Output:Meter objects).
Refrigeration System Total Low Stage Compressor Electric Power [W]
This output is the total electric power input to the systems low-stage compressor(s) in Watts.
This output is valid only for two-stage compression systems.
Refrigeration System Total Low Stage Compressor Electric Energy [J]
This is the electricity consumption of the systems low-stage compressor(s) in Joules for the
timestep being reported. The individual consumption for each compressor is also added to a
meter with Resource Type = Electricity, End Use Key = Refrigeration, Group Key = Plant
(Ref. Output:Meter objects). This output is valid only for two-stage compression systems.
Refrigeration System Total High Stage Compressor Electric Power [W]
This output is the total electric power input to the systems high-stage compressor(s) in
Watts. This output is valid only for two-stage compression systems.
Refrigeration System Total High Stage Compressor Electric Energy [J]
This is the electricity consumption of the systems high-stage compressor(s) in Joules for the
timestep being reported. The individual consumption for each compressor is also added to a

9/29/14

1204

Input-Output Reference

Group Refrigeration

meter with Resource Type = Electricity, End Use Key = Refrigeration, Group Key = Plant
(Ref. Output:Meter objects). This output is valid only for two-stage compression systems.
Refrigeration System Total Low and High Stage Compressor Electric Energy [J]
This is the total electricity consumption of the systems low- and high-stage compressor(s) in
Joules for the timestep being reported. The individual consumption for each compressor is
also added to a meter with Resource Type = Electricity, End Use Key = Refrigeration, Group
Key = Plant (Ref. Output:Meter objects). This output is valid only for two-stage compression
systems.
Refrigeration System Average Compressor COP [W/W]
This output is the system average compressor COP, the total refrigeration effect divided by
the total power to the compressors.
Refrigeration System Total Compressor Heat Transfer Rate [W]
This output is the total heat transfer rate of the Refrigeration Compressor rack in Watts. It is
the sum of all of the heat transfer rates for the refrigerated cases, walk-ins, secondary loops,
cascade condensers, and mechanical subcoolers that are cooled by this system. This value
does not include compressor or condenser fan heat. If specified as in input value, the suction
pipe heat gains are included in this value.
Refrigeration System Total Compressor Heat Transfer Energy [J]
This is the total heat transfer of the Refrigeration Compressor rack in Joules for the timestep
being reported. This output is also added to a meter with Resource Type = EnergyTransfer,
End Use Key = Refrigeration, Group Key = Plant (Ref. Output:Meter objects).
Refrigeration System Total Low Stage Compressor Heat Transfer Rate [W]
This output is the total heat transfer rate of the low-stage compressors in Watts. It is the sum
of all of the heat transfer rates for the refrigerated cases, walk-ins, secondary loops, cascade
condensers, and mechanical subcoolers that are cooled by this system. This value does not
include compressor or condenser fan heat. If specified as in input value, the suction pipe heat
gains are included in this value. This output is valid only for two-stage compression systems.
Refrigeration System Total Low Stage Compressor Heat Transfer Energy [J]
This is the total heat transfer of the low-stage compressors in Joules for the timestep being
reported. This output is also added to a meter with Resource Type = EnergyTransfer, End
Use Key = Refrigeration, Group Key = Plant (Ref. Output:Meter objects). This output is valid
only for two-stage compression systems.
Refrigeration System Total High Stage Compressor Heat Transfer Rate [W]
This output is the total heat transfer rate of the high-stage compressors in Watts. It is the sum
of all of the heat transfer rates for the refrigerated cases, walk-ins, secondary loops, cascade
condensers, and mechanical subcoolers that are cooled by this system. This value does not
include compressor or condenser fan heat. If specified as in input value, the suction pipe heat
gains are included in this value. This output is valid only for two-stage compression systems.
Refrigeration System Total High Stage Compressor Heat Transfer Energy [J]
This is the total heat transfer of the high-stage compressors in Joules for the timestep being
reported. This output is also added to a meter with Resource Type = EnergyTransfer, End
Use Key = Refrigeration, Group Key = Plant (Ref. Output:Meter objects). This output is valid
only for two-stage compression systems.
Refrigeration System Total Cases and Walk Ins Heat Transfer Rate [W]
This output is the total heat transfer rate from the refrigerated cases and walk-ins served
directly by this system in Watts. It is the sum of all of the heat transfer rates for the
9/29/14

1205

Input-Output Reference

Group Refrigeration

refrigerated cases and walk-ins that are connected directly to this system. This value does
not include compressor or condenser fan heat or the heat transfer for cases and walk-ins
served by any connected secondary systems.
Refrigeration System Total Cases and Walk Ins Heat Transfer Energy [J]
This output is the total heat transfer energy from the refrigerated cases and walk-ins served
directly by this system in Joules. It is the sum of all of the heat transfered for the refrigerated
cases and walk-ins that are connected directly to this system. This value does not include
compressor or condenser fan heat or the heat transfer for cases and walk-ins served by any
connected secondary systems.
Refrigeration System Total Transferred Load Heat Transfer Rate [W]
This output is the sum of the heat transfer rates for any secondary loops, cascade
condensers, and mechanical subcoolers cooled by this system, minus the benefit of any
mechanical subcooler providing cooling to this system in Watts. Therefore, if the only transfer
load between two systems is a mechanical subcooler, the same amount will show as a
negative value for the system receiving the cooling effect and as a positive number for the
system serving that cooling load. It also includes the pump energy for any secondary loops
and the compressor energy for any cascade condenser systems that are cooled by this
system. (See the Engineering Reference for more details about the loads placed by
secondary systems upon the primary system.)
Refrigeration System Total Transferred Load Heat Transfer Energy [J]
This output is the sum of the heat transfered for any secondary loops, cascade condensers,
and mechanical subcoolers cooled by this system, minus the benefit of any mechanical
subcooler providing cooling to this system in Joules. Therefore, if the only transfer load
between two systems is a mechanical subcooler, the same amount will show as a negative
value for the system receiving the cooling effect and as a positive number for the system
serving that cooling load. It also includes the pump energy for any secondary loops and the
compressor energy for any cascade condenser systems that are cooled by this system. (See
the Engineering Reference for more details about the loads placed by secondary systems
upon the primary system.)
Refrigeration System Total Suction Pipe Heat Gain Rate [W]
This output is the total heat transfer rate for suction piping served by this system in Watts.
Note this is an optional input, and is only available if the user has described the suction piping
heat gain characteristics in the input.
Refrigeration System Total Suction Pipe Heat Gain Energy [J]
This output is the total heat transfer rate for suction piping served by this system in Watts.
Note this is an optional input, and is only available if the user has described the suction piping
heat gain characteristics in the input.
Refrigeration System Net Rejected Heat Transfer Rate [W]
This output is the total heat rejected by this system to the system condenser in Watts. It does
not include system heat rejection that has been recovered for useful purposes. However, if a
water-cooled condenser was used to provide heat to a separate water loop, the energy
transferred to that loop is included here.
Refrigeration System Net Rejected Heat Transfer Energy [J]
This output is the total heat rejected by this system to the system condenser in Joules for the
timestep being reported. It does not include system heat rejection that has been recovered
for useful purposes. However, if a water-cooled condenser was used to provide heat to a
separate water loop, the energy transferred to that loop is included here.

9/29/14

1206

Input-Output Reference

Group Refrigeration

Refrigeration System Liquid Suction Subcooler Heat Transfer Rate [W]

This output is the total heat transferred from the liquid condensate before the thermal
expansion valve to the suction gas.
Refrigeration System Liquid Suction Subcooler Heat Transfer Energy [J]
This output is the total heat transferred from the liquid condensate before the thermal
expansion valve to the suction gas.
Refrigeration System Estimated Refrigerant Inventory Mass [kg]
This output is the sum of the input inventory values for the condenser, receiver, cases, and
liquid pipes that are a part of this system.
Refrigeration System Estimated Refrigerant Mass Flow Rate [kg/s]
This output is the calculated refrigerant mass flow through the compressors for this system.
Refrigeration System Estimated Low Stage Refrigerant Mass Flow Rate [kg/s]
This output is the calculated refrigerant mass flow through the low-stage compressors for this
system. This output is valid only for two-stage compression systems.
Refrigeration System Estimated High Stage Refrigerant Mass Flow Rate [kg/s]
This output is the calculated refrigerant mass flow through the high-stage compressors for
this system. This output is valid only for two-stage compression systems.
Refrigeration System Intercooler Temperature [C]
This is the saturation temperature in the intercooler. This output is valid only for two-stage
compression systems.
Refrigeration System Intercooler Pressure [Pa]
This is the saturation pressure in the intercooler. This output is valid only for two-stage
compression systems.
Refrigeration System Condensing Temperature [C]
This is the saturated condensing temperature.
Refrigeration System Evaporating Temperature [C]
This is the saturated evaporating temperature.
Refrigeration System Suction Pipe Suction Temperature [C]
This is the temperature at the compressor inlet including superheat after the cases and
superheat from any liquid suction heat exchangers.
Refrigeration System Thermostatic Expansion Valve Liquid Temperature [C]
This is the temperature entering the thermal expansion valve before the cases, equal to the
condensing temperature minus any subcooling included in the condenser or provided by
mechanical and/or liquid suction heat exchanger subcoolers.
THE FOLLOWING OUTPUTS ARE AVAILABLE FOR SYSTEMS THAT SERVE AIR
CHILLERS
Refrigeration Air Chiller System Total Compressor Electric Power [W]
This output is the total electric power input to the system compressor(s) in Watts.
Refrigeration Chiller System Total Compressor Electric Consumption [J]
This is the electricity consumption of the systems compressor(s) in Joules for the timestep
being reported. The individual consumption for each compressor is also added to a meter
9/29/14

1207

Input-Output Reference

Group Refrigeration

with Resource Type = Electricity, End Use Key = Refrigeration, Group Key = Plant (Ref.
Output:Meter objects).
Refrigeration Air Chiller System Total Low Stage Compressor Electric Power [W]
This output is the total electric power input to the systems low-stage compressor(s) in Watts.
This output is valid only for two-stage compression systems.
Refrigeration Air Chiller System Total Low Stage Compressor Electric Energy [J]
This is the electricity consumption of the systems low-stage compressor(s) in Joules for the
timestep being reported. The individual consumption for each compressor is also added to a
meter with Resource Type = Electricity, End Use Key = Refrigeration, Group Key = Plant
(Ref. Output:Meter objects). This output is valid only for two-stage compression systems.
Refrigeration Air Chiller System Total High Stage Compressor Electric Power [W]
This output is the total electric power input to the systems high-stage compressor(s) in
Watts. This output is valid only for two-stage compression systems.
Refrigeration Air Chiller System Total High Stage Compressor Electric Energy [J]
This is the electricity consumption of the systems high-stage compressor(s) in Joules for the
timestep being reported. The individual consumption for each compressor is also added to a
meter with Resource Type = Electricity, End Use Key = Refrigeration, Group Key = Plant
(Ref. Output:Meter objects). This output is valid only for two-stage compression systems.
Refrigeration Air Chiller System Total Low and High Stage Compressor Electric Energy [J]
This is the total electricity consumption of the systems low- and high-stage compressor(s) in
Joules for the timestep being reported. The individual consumption for each compressor is
also added to a meter with Resource Type = Electricity, End Use Key = Refrigeration, Group
Key = Plant (Ref. Output:Meter objects). This output is valid only for two-stage compression
systems.
Refrigeration Air Chiller System Average Compressor COP [W/W]
This output is the system average compressor COP, the total refrigeration effect divided by
the total power to the compressors
Refrigeration Air Chiller System Total Compressor Heat Transfer Rate [W]
This output is the total heat transfer rate of the Refrigeration Compressor rack in Watts. It is
the sum of all of the heat transfer rates for the refrigerated cases, walk-ins, secondary loops,
cascade condensers, and mechanical subcoolers that are cooled by this system. This value
does not include compressor or condenser fan heat. If specified as in input value, the suction
pipe heat gains are included in this value.
Refrigeration Air Chiller System Total Compressor Heat Transfer Energy [J]
This is the total heat transfer of the Refrigeration Compressor rack in Joules for the timestep
being reported. This output is also added to a meter with Resource Type = EnergyTransfer,
End Use Key = Refrigeration, Group Key = Plant (Ref. Output:Meter objects).
Refrigeration Air Chiller System Total Low Stage Compressor Heat Transfer Rate [W]
This output is the total heat transfer rate of the low-stage compressors in Watts. It is the sum
of all of the heat transfer rates for the refrigerated cases, walk-ins, secondary loops, cascade
condensers, and mechanical subcoolers that are cooled by this system. This value does not
include compressor or condenser fan heat. If specified as in input value, the suction pipe heat
gains are included in this value. This output is valid only for two-stage compression systems.

9/29/14

1208

Input-Output Reference

Group Refrigeration

Refrigeration Air Chiller System Total Low Stage Compressor Heat Transfer Energy [J]
This is the total heat transfer of the low-stage compressors in Joules for the timestep being
reported. This output is also added to a meter with Resource Type = EnergyTransfer, End
Use Key = Refrigeration, Group Key = Plant (Ref. Output:Meter objects). This output is valid
only for two-stage compression systems.
Refrigeration Air Chiller System Total High Stage Compressor Heat Transfer Rate [W]
This output is the total heat transfer rate of the high-stage compressors in Watts. It is the sum
of all of the heat transfer rates for the refrigerated cases, walk-ins, secondary loops, cascade
condensers, and mechanical subcoolers that are cooled by this system. This value does not
include compressor or condenser fan heat. If specified as in input value, the suction pipe heat
gains are included in this value. This output is valid only for two-stage compression systems.
Refrigeration Air Chiller System Total High Stage Compressor Heat Transfer Energy [J]
This is the total heat transfer of the high-stage compressors in Joules for the timestep being
reported. This output is also added to a meter with Resource Type = EnergyTransfer, End
Use Key = Refrigeration, Group Key = Plant (Ref. Output:Meter objects). This output is valid
only for two-stage compression systems.
Refrigeration Air Chiller System Total Air Chiller Heat Transfer Rate [W]
This output is the total heat transfer rate from the refrigerated cases and walk-ins served
directly by this system in Watts. It is the sum of all of the heat transfer rates for the
refrigerated cases and walk-ins that are connected directly to this system. This value does
not include compressor or condenser fan heat or the heat transfer for cases and walk-ins
served by any connected secondary systems.
Refrigeration Air Chiller System Total Case and Walk In Heat Transfer Energy [J]
This output is the total heat transfer energy from the refrigerated cases and walk-ins served
directly by this system in Joules. It is the sum of all of the heat transfered for the refrigerated
cases and walk-ins that are connected directly to this system. This value does not include
compressor or condenser fan heat or the heat transfer for cases and walk-ins served by any
connected secondary systems.
Refrigeration Air Chiller System Total Transferred Load Heat Transfer Rate [W]
This output is the sum of the heat transfer rates for any secondary loops, cascade
condensers, and mechanical subcoolers cooled by this system, minus the benefit of any
mechanical subcooler providing cooling to this system in Watts. Therefore, if the only transfer
load between two systems is a mechanical subcooler, the same amount will show as a
negative value for the system receiving the cooling effect and as a positive number for the
system serving that cooling load. It also includes the pump energy for any secondary loops
and the compressor energy for any cascade condenser systems that are cooled by this
system. (See the Engineering Reference for more details about the loads placed by
secondary systems upon the primary system.)
Refrigeration Air Chiller System Total Transferred Load Heat Transfer Energy [J]
This output is the sum of the heat transfered for any secondary loops, cascade condensers,
and mechanical subcoolers cooled by this system, minus the benefit of any mechanical
subcooler providing cooling to this system in Joules. Therefore, if the only transfer load
between two systems is a mechanical subcooler, the same amount will show as a negative
value for the system receiving the cooling effect and as a positive number for the system
serving that cooling load. It also includes the pump energy for any secondary loops and the
compressor energy for any cascade condenser systems that are cooled by this system. (See
the Engineering Reference for more details about the loads placed by secondary systems
upon the primary system.)

9/29/14

1209

Input-Output Reference

Group Refrigeration

Refrigeration Air Chiller System Total Suction Pipe Heat Gain Rate [W]
This output is the total heat transfer rate for suction piping served by this system in Watts.
Note this is an optional input, and is only available if the user has described the suction piping
heat gain characteristics in the input.
Refrigeration Air Chiller System Total Suction Pipe Heat Gain Energy [J]
This output is the total heat transfer rate for suction piping served by this system in Watts.
Note this is an optional input, and is only available if the user has described the suction piping
heat gain characteristics in the input.
Refrigeration Air Chiller System Net Rejected Heat Transfer Rate [W]
This output is the total heat rejected by this system to the system condenser in Watts. It does
not include system heat rejection that has been recovered for useful purposes. However, if a
water-cooled condenser was used to provide heat to a separate water loop, the energy
transferred to that loop is included here.
Refrigeration Air Chiller System Net Rejected Heat Transfer Energy [J]
This output is the total heat rejected by this system to the system condenser in Joules for the
timestep being reported. It does not include system heat rejection that has been recovered
for useful purposes. However, if a water-cooled condenser was used to provide heat to a
separate water loop, the energy transferred to that loop is included here.
Refrigeration Air Chiller System Liquid Suction Subcooler Heat Transfer Rate [W]
This output is the total heat transferred from the liquid condensate before the thermal
expansion valve to the suction gas.
Refrigeration Air Chiller System Liquid Suction Subcooler Heat Transfer Energy [J]
This output is the total heat transferred from the liquid condensate before the thermal
expansion valve to the suction gas.
Refrigeration Air Chiller System Mechanical Subcooler Heat Transfer Energy [J]
Refrigeration Air Chiller System Estimated Refrigerant Inventory Mass [kg]
This output is the sum of the input inventory values for the condenser, receiver, cases, and
liquid pipes that are a part of this system.
Refrigeration Air Chiller System Estimated Refrigerant Mass Flow Rate [kg/s]
This output is the calculated refrigerant mass flow through the compressors for this system.
Refrigeration Air Chiller System Estimated Low Stage Refrigerant Mass Flow Rate [kg/s]
This output is the calculated refrigerant mass flow through the low-stage compressors for this
system. This output is valid only for two-stage compression systems.
Refrigeration Air Chiller System Estimated High Stage Refrigerant Mass Flow Rate [kg/s]
This output is the calculated refrigerant mass flow through the high-stage compressors for
this system. This output is valid only for two-stage compression systems.
Refrigeration Air Chiller System Intercooler Temperature [C]
This is the saturation temperature in the intercooler. This output is valid only for two-stage
compression systems.
Refrigeration Air Chiller System Intercooler Pressure [Pa]
This is the saturation pressure in the intercooler. This output is valid only for two-stage
compression systems.

9/29/14

1210

Input-Output Reference

Group Refrigeration

Refrigeration Air Chiller System Condensing Temperature [C]

This is the saturated condensing temperature.
Refrigeration Air Chiller System Evaporating Temperature [C]
This is the saturated evaporating temperature.
Refrigeration Air Chiller System Suction Temperature [C]
This is the temperature at the compressor inlet including superheat after the cases and
superheat from any liquid suction heat exchangers.
Refrigeration Air Chiller System TXV Liquid Temperature [C]
This is the temperature entering the thermal expansion valve before the cases, equal to the
condensing temperature minus any subcooling included in the condenser or provided by
mechanical and/or liquid suction heat exchanger subcoolers.
Refrigeration:TranscriticalSystem
The Refrigeration:TranscriticalSystem object allows users to model detailed transcritical
carbon dioxide (CO2) booster refrigeration systems used in supermarkets. The object allows
for modeling either a single stage system with medium-temperature loads or a two stage
system with both medium- and low-temperature loads.
The input objects required to model a detailed transcritical CO 2 refrigeration system include
the following:
One Refrigeration:TranscriticalSystem object,
At least one refrigeration load object which may include any combination of the following:
Refrigeration:Case,
Refrigeration:WalkIn,
Refrigeration:CaseAndWalkInList (may include both cases and/or walk-in cooler
names),
At least one Refrigeration:Compressor object (multiple compressors are entered using a
Refrigeration:CompressorList),
One Refrigeration:GasCooler:AirCooled object,
Output variables are available to describe the total heat exchange between all the
refrigeration objects and the zones containing these objects. These variables are described
at the end of this section.
At least one refrigeration load object must be defined which may be one of two types of
loads, including a refrigerated display case and a walk-in cooler, (Ref. Refrigeration:Case,
and Refrigeration:WalkIn). If multiple loads are served by the same system, the user should
use the refrigerated case and walk-in list object available to assign all cases and walk-ins
cooled directly by this system (Ref. Refrigeration:CaseAndWalkInList).
The name of at least one compressor must be defined and a list object is available if the
system is served by more than one compressor (Ref. Refrigeration:Compressor and
Refrigeration:CompressorList).
Heat is rejected to the outdoors via an air-cooled gas cooler (Ref.
Refrigeration:GasCooler:AirCooled).
The Refrigeration:TranscriticalSystem object coordinates the energy flows between the other
refrigeration objects and is used to set system parameters.
The inputs for the refrigeration system object, in addition to the names of the other
refrigeration objects described above, include a name for this system, the receiver pressure,
the subcooler effectiveness, and the refrigeration system working fluid. Optional input fields
are also provided for users seeking to keep track of suction pipe heat gains.

9/29/14

1211

Input-Output Reference

Group Refrigeration

A detailed description of the transcritical CO 2 booster refrigeration system may be found in

the Refrigeration section of the Engineering Reference.
Field: Name
A unique user-assigned name for an instance of a transcritical CO 2 refrigeration system. Any
reference to this refrigeration system by another object will use this name.
Field: System Type
Identifies the transcritical CO2 refrigeration system as either a single-stage system with only
medium-temperature loads, or a two-stage system with both medium- and low-temperature
loads. Valid choices are: SingleStage for single stage systems or TwoStage for two stage
systems.
Field: Medium Temperature Refrigerated Case or WalkIn or CaseAndWalkInList Name
Identifies a single case, a single walk-in, or a particular list of refrigerated cases and walk-ins,
that is cooled by the medium-temperature stage of the refrigeration system. The name will
be validated against the case, walk-in, and CaseAndWalkInList names (Ref.
Refrigeration:Case, Refrigeration:WalkIn, and Refrigeration:CaseAndWalkInList) in the input
file. Only medium temperature cases and walk-ins served directly by the system should be
included in this list. Note that this entry is required for both single-stage and two-stage
systems.
Field: Low Temperature Refrigerated Case or WalkIn or CaseAndWalkInList Name
Identifies a single case, a single walk-in, or a particular list of refrigerated cases and walk-ins,
that is cooled by the low-temperature stage of the refrigeration system. The name will be
validated against the case, walk-in, and CaseAndWalkInList names (Ref. Refrigeration:Case,
Refrigeration:WalkIn, and Refrigeration:CaseAndWalkInList) in the input file. Only low
temperature cases and walk-ins served directly by the system should be included in this list.
Note that this entry is valid only for two-stage systems.
Field: Refrigeration Gas Cooler Name
The name of the gas cooler that is used to reject heat from the transcritical refrigeration
system.
The name will be validated against the gas cooler names (Ref.
Refrigeration:GasCooler:AirCooled) in the input file.
Field: High Pressure Compressor or Compressor List Name
Identifies a single compressor, or a particular list of compressors, that provides compression
for a single-stage system or the high pressure stage of a two-stage system. The name will
be validated against the compressor list names (Ref. List:Refrigeration:Compressors) in the
input file. Note that this entry is required for both single-stage and two-stage systems.
Field: Low Pressure Compressor or Compressor List Name
Identifies a single compressor, or a particular list of compressors, that provides compression
for the low pressure stage of a two-stage system. The name will be validated against the
compressor list names (Ref. List:Refrigeration:Compressors) in the input file. Note that this
entry is valid only for two-stage systems.
Field: Receiver Pressure
This numeric field specifies the refrigerant pressure (Pa) in the receiver. The default value for
the receiver pressure is 4.0 106 Pa.
Field: Subcooler Effectiveness
This numeric field specifies the heat exchanger effectiveness of the subcooler. The default
value for the subcooler effectiveness is 0.4.

9/29/14

1212

Input-Output Reference

Group Refrigeration

Field: Refrigeration System Working Fluid Type

The type of refrigerant used by the system. It is assumed that carbon dioxide will be the
refrigerant used in the transcritical CO 2 refrigeration system. However, the user must specify
the name used in the input file which refers to carbon dioxide. This name will be validated
against Fluid Names (Ref. Fluid Properties section) in the input file. Note that the
corresponding
property
data
for
carbon
dioxide
(R744),
available
in
FluidPropertiesRefData.idf, must be supplied in the input file.
Field: Sum UA Suction Piping for Medium Temperature Loads
This optional field is typically used to determine the impact of pipe heat gains on system
performance and zone heat balance. Enter the value for suction piping heat gain (in W/C) for
the medium-temperature suction line, i.e., sum up the product of the pipe wall insulation
conductance times the outer surface area of the pipe insulation. Please see the Engineering
Reference for guidance in calculating this value. If the Sum UA Suction Piping for Medium
Temperature Loads is entered, the Medium Temperature Suction Piping Zone Name is also
required.
Field: Medium Temperature Suction Piping Zone Name
This optional field is typically used to determine the impact of pipe heat gains on system
performance. If the previous field, Sum UA Suction Piping for Medium Temperature Loads, is
blank, this field will not be used. Enter the name of the zone where the medium-temperature
suction piping is located. The suction piping heat gains will be calculated based upon the air
temperature within this zone. The heat balance of this zone will also be affected by the
piping heat exchange. Additional output variables are described at the end of this section for
the total impact of refrigeration on zones, including suction pipe heat exchange.
Field: Sum UA Suction Piping for Low Temperature Loads
This optional field is typically used to determine the impact of pipe heat gains on system
performance and zone heat balance. Enter the value for suction piping heat gain (in W/C) for
the low-temperature suction line, i.e., sum up the product of the pipe wall insulation
conductance times the outer surface area of the pipe insulation. Please see the Engineering
Reference for guidance in calculating this value. If the Sum UA Suction Piping for Low
Temperature Loads is entered, the Low Temperature Suction Piping Zone Name is also
required. Note that this entry is valid only for two-stage systems.
Field: Low Temperature Suction Piping Zone Name
This optional field is typically used to determine the impact of pipe heat gains on system
performance. If the previous field, Sum UA Suction Piping for Low Temperature Loads, is
blank, this field will not be used. Enter the name of the zone where the low-temperature
suction piping is located. The suction piping heat gains will be calculated based upon the air
temperature within this zone. The heat balance of this zone will also be affected by the
piping heat exchange. Additional output variables are described at the end of this section for
the total impact of refrigeration on zones, including suction pipe heat exchange. Note that
this entry is valid only for two-stage systems.
Field: End-Use Subcategory
This field allows the specification of a user-defined end-use subcategory (e.g., "Medium
Temperature System"). A new meter for reporting is created for each unique subcategory
(Ref. Output:Meter objects). Subcategories are also reported in the ABUPS table. If this field
is left blank, the equipment will be assigned to the "General" end-use subcategory.
The following is an example input for a transcritical CO 2 refrigeration system.

9/29/14

1213

Input-Output Reference

Group Refrigeration

Refrigeration:TranscriticalSystem,
TransRefrigSys,
!- Name
TwoStage,
!- System Type
MTLoads,
!- Medium Temperature Refrigerated Case or Walkin or CaseAndWalkInList Name
LTLoads,
!- Low Temperature Refrigerated Case or Walkin or CaseAndWalkInList Name
RefrigGasCooler,
!- Refrigeration Gas Cooler Name
HPCompressors,
!- High Pressure Compressor or CompressorList Name
LPCompressors,
!- Low Pressure Compressor or CompressorList Name
4000000,
!- Receiver Pressure
0.4,
!- Subcooler Effectiveness
R744,
!- Refrigeration System Working Fluid Type
,
!- Sum UA Suction Piping for Medium Temperature Loads
,
!- Medium Temperature Suction Piping Zone Name
,
!- Sum UA Suction Piping for Low Temperature Loads
,
!- Low Temperature Suction Piping Zone Name
TransRefrigSys;
!- End-Use Subcategory

Refrigeration Transcritical System Outputs

Zone,Average, Refrigeration Transcritical System Total High Pressure Compressor Electric Power
[W]
Zone,Sum, Refrigeration Transcritical System Total High Pressure Compressor Electric Energy
[J]
Zone,Average, Refrigeration Transcritical System Low Pressure Compressor Electric Power [W]
Zone,Sum, Refrigeration Transcritical System Low Pressure Compressor Electric Energy [J]
Zone,Sum, Refrigeration Transcritical System Total Compressor Electric Energy [J]
Zone,Average, Refrigeration Transcritical System Average COP [W/W]
Zone,Average, Refrigeration Transcritical System Medium Temperature Cases and Walk Ins Heat
Transfer Rate [W]
Zone,Sum, Refrigeration Transcritical System Medium Temperature Cases and Walk Ins Heat
Transfer Energy [J]
Zone,Average, Refrigeration Transcritical System Low Temperature Cases and Walk Ins Heat
Transfer Rate [W]
Zone,Sum, Refrigeration Transcritical System Low Temperature Cases and Walk Ins Heat Transfer
Energy [J]
Zone,Sum, Refrigeration Transcritical System Total Cases and Walk Ins Heat Transfer Energy [J]
Zone,Average, Refrigeration Transcritical System Medium Temperature Suction Pipe Heat Transfer
Rate [W]
Zone,Sum, Refrigeration Transcritical System Medium Temperature Suction Pipe Heat Transfer
Energy [J]
Zone,Average, Refrigeration Transcritical System Low Temperature Suction Pipe Heat Transfer
Rate [W]
Zone,Sum, Refrigeration Transcritical System Low Temperature Suction Pipe Heat Transfer Energy
[J]
Zone,Average, Refrigeration Transcritical System High Pressure Compressor Heat Transfer Rate
[W]
Zone,Sum, Refrigeration Transcritical System High Pressure Compressor Heat Transfer Energy [J]
Zone,Average, Refrigeration Transcritical System Low Pressure Compressor Heat Transfer Rate
[W]
Zone,Sum, Refrigeration Transcritical System Low Pressure Compressor Heat Transfer Energy [J]
Zone,Average, Refrigeration Transcritical System Net Rejected Heat Transfer Rate [W]
Zone,Sum, Refrigeration Transcritical System Net Rejected Heat Transfer Energy [J]
Zone,Average, Refrigeration Transcritical System Estimated Refrigerant Inventory Mass [kg]
Zone,Average, Refrigeration Transcritical System Refrigerant Mass Flow Rate [kg/s]
Zone,Average, Refrigeration Transcritical System Medium Temperature Evaporating Temperature
[C]
Zone,Average, Refrigeration Transcritical System Medium Temperature Suction Temperature [C]
Zone,Average, Refrigeration Transcritical System Low Temperature Evaporating Temperature [C]
Zone,Average, Refrigeration Transcritical System Low Temperature Suction Temperature [C]

9/29/14

1214

Input-Output Reference

Group Refrigeration

Refrigeration Transcritical System Total High Pressure Compressor Electric Power [W]
This output is the total electric power input to the systems high pressure compressor(s) in
Watts.
Refrigeration Transcritical System Total High Pressure Compressor Electric Energy [J]
This is the electricity consumption of the systems high pressure compressor(s) in Joules for
the timestep being reported. The individual consumption for each compressor is also added
to a meter with Resource Type = Electricity, End Use Key = Refrigeration, Group Key = Plant
(Ref. Output:Meter objects).
Refrigeration Transcritical System Low Pressure Compressor Electric Power [W]
This output is the total electric power input to the systems low pressure compressor(s) in
Watts.
Refrigeration Transcritical System Low Pressure Compressor Electric Energy [J]
This is the electricity consumption of the systems low pressure compressor(s) in Joules for
the timestep being reported. The individual consumption for each compressor is also added
to a meter with Resource Type = Electricity, End Use Key = Refrigeration, Group Key = Plant
(Ref. Output:Meter objects).
Refrigeration Transcritical System Total Compressor Electric Energy [J]
This output is the total electric power input to all of the systems compressor(s) in Watts.
Refrigeration Transcritical System Average COP [W/W]
This output is the system average compressor COP, which is the total refrigeration effect
divided by the total power to all of the compressors.
Refrigeration Transcritical System Medium Temperature Cases and Walk Ins Heat Transfer
Rate [W]
This output is the total heat transfer rate from the medium temperature refrigerated cases and
walk-ins served directly by this system in Watts. It is the sum of all of the heat transfer rates
for the medium temperature refrigerated cases and walk-ins that are connected directly to
this system.
Refrigeration Transcritical System Medium Temperature Cases and Walk Ins Heat Transfer
Energy [J]
This output is the total heat transfer energy from the medium temperature refrigerated cases
and walk-ins served directly by this system in Joules. It is the sum of all of the heat
transferred for the medium temperature refrigerated cases and walk-ins that are connected
directly to this system.
Refrigeration Transcritical System Low Temperature Cases and Walk Ins Heat Transfer
Rate [W]
This output is the total heat transfer rate from the low temperature refrigerated cases and
walk-ins served directly by this system in Watts. It is the sum of all of the heat transfer rates
for the low temperature refrigerated cases and walk-ins that are connected directly to this
system.
Refrigeration Transcritical System Low Temperature Cases and Walk Ins Heat Transfer
Energy [J]
This output is the total heat transfer energy from the low temperature refrigerated cases and
walk-ins served directly by this system in Joules. It is the sum of all of the heat transferred for
the low temperature refrigerated cases and walk-ins that are connected directly to this
system.
9/29/14

1215

Input-Output Reference

Group Refrigeration

Refrigeration Transcritical System Total Cases and Walk Ins Heat Transfer Energy [J]
This output is the total heat transfer energy from all the low- and medium-temperature
refrigerated cases and walk-ins served directly by this system in Joules. It is the sum of all of
the heat transferred for all the refrigerated cases and walk-ins that are connected directly to
this system.
Refrigeration Transcritical System Medium Temperature Suction Pipe Heat Transfer Rate
[W]
This output is the total heat transfer rate for the medium-temperature suction piping served by
this system in Watts. Note this is an optional input, and is only available if the user has
described the medium-temperature suction piping heat gain characteristics in the input.
Refrigeration Transcritical System Medium Temperature Suction Pipe Heat Transfer
Energy [J]
This output is the total heat transfer rate for the medium-temperature suction piping served by
this system in Watts. Note this is an optional input, and is only available if the user has
described the medium-temperature suction piping heat gain characteristics in the input.
Refrigeration Transcritical System Low Temperature Suction Pipe Heat Transfer Rate [W]
This output is the total heat transfer rate for the low-temperature suction piping served by this
system in Watts. Note this is an optional input, and is only available if the user has described
the low-temperature suction piping heat gain characteristics in the input.
Refrigeration Transcritical System Low Temperature Suction Pipe Heat Transfer Energy [J]
This output is the total heat transfer rate for the low-temperature suction piping served by this
system in Watts. Note this is an optional input, and is only available if the user has described
the low-temperature suction piping heat gain characteristics in the input.
Refrigeration Transcritical System High Pressure Compressor Heat Transfer Rate [W]
This output is the total heat transfer rate of the high pressure Compressors in Watts. It is the
sum of all of the heat transfer rates for the low- and medium-temperature refrigerated cases
and walk-ins as well as the low pressure compressors that are cooled by this system. This
value does not include compressor or condenser fan heat. If specified as in input value, the
suction pipe heat gains are included in this value.
Refrigeration Transcritical System High Pressure Compressor Heat Transfer Energy [J]
This is the total heat transfer of the high pressure compressors in Joules for the timestep
being reported. This output is also added to a meter with Resource Type = EnergyTransfer,
End Use Key = Refrigeration, Group Key = Plant (Ref. Output:Meter objects).
Refrigeration Transcritical System Low Pressure Compressor Heat Transfer Rate [W]
This output is the total heat transfer rate of the low pressure Compressors in Watts. It is the
sum of all of the heat transfer rates for the low temperature refrigerated cases and walk-ins
that are cooled by this system. This value does not include compressor or condenser fan
heat. If specified as in input value, the suction pipe heat gains are included in this value.
Refrigeration Transcritical System Low Pressure Compressor Heat Transfer Energy [J]
This is the total heat transfer of the low pressure compressors in Joules for the timestep
being reported. This output is also added to a meter with Resource Type = EnergyTransfer,
End Use Key = Refrigeration, Group Key = Plant (Ref. Output:Meter objects).
Refrigeration Transcritical System Net Rejected Heat Transfer Rate [W]
This output is the total heat rejected by this system to the system gas cooler in Watts. It does
not include system heat rejection that has been recovered for useful purposes.
9/29/14

1216

Input-Output Reference

Group Refrigeration

Refrigeration Transcritical System Net Rejected Heat Transfer Energy [J]

This output is the total heat rejected by this system to the system gas cooler in Joules for the
timestep being reported. It does not include system heat rejection that has been recovered
for useful purposes.
Refrigeration Transcritical System Estimated Refrigerant Inventory Mass [kg]
This output is the sum of the input refrigerant inventory values for the gas cooler, receiver,
cases, and liquid pipes that are a part of this system.
Refrigeration Transcritical System Refrigerant Mass Flow Rate [kg/s]
This output is the calculated refrigerant mass flow rate through the high pressure
compressors for this system.
Refrigeration Transcritical System Medium Temperature Evaporating Temperature [C]
This is the saturated evaporating temperature for the medium temperature loads.
Refrigeration Transcritical System Medium Temperature Suction Temperature [C]
This is the temperature at the high pressure compressor inlet including superheat after the
display cases and superheat from the suction line heat exchanger.
Refrigeration Transcritical System Low Temperature Evaporating Temperature [C]
This is the saturated evaporating temperature for the low-temperature loads.
Refrigeration Transcritical System Low Temperature Suction Temperature [C]
This is the temperature at the low pressure compressor inlet including superheat after the
display cases.
Refrigeration:Compressor
The compressors are described here using manufacturers data for curves that provide the
efficiency, cooling capacity, and power consumption. The corresponding rated values for
cycle superheat and subcooling are also required.
A dataset has been provided containing the compressor rating data, including the
performance curve inputs, for a large number of compressors.
See
RefrigerationCompressorCurves.idf.
Field: Name
A unique user-assigned name for an instance of a compressor. Any reference to this
compressor by another object will use this name.
Field: Refrigeration Compressor Power Curve Name
This required field provides the name of the curve object that describes the compressor
power as a function of the evaporating and condensing temperatures, as specified in ARI
540. The curve is of the bicubic form(ref: Curve:Bicubic). However, the input order for the
Energy Plus bicubic curve does not match the ARI 540 standard order. When this curve is
entered, the user should use the following assignments:
N1 is ARI C1 and N2 is ARI C2.
N3 is ARI C4 and N4 is ARI C3.
N5 is ARI C6 and N6 is ARI C5,
N7 is ARI C7.
N8 is ARI C10, N9 is ARI C8, and N10 is ARI C9.
N11 is the Minimum evaporating temperature and N12 is the Maximum evaporating
temperature.
N13 is the the Minimum condensing temperature and N14 is the Maximum condensing
temperature
9/29/14

1217

Input-Output Reference

Group Refrigeration

Field: Refrigeration Compressor Capacity Curve Name

This required field provides the name of the curve object that describes the compressor
cooling capacity as a function of the evaporating and condensing temperatures, as specified
in ARI 540. The curve is of the bicubic form(ref: Curve:Bicubic). However, the input order for
the Energy Plus bicubic curve does not match the ARI 540 standard order. When this curve is
entered, the user should use the following assignments:
N1 is ARI C1 and N2 is ARI C2.
N3 is ARI C4 and N4 is ARI C3.
N5 is ARI C6 and N6 is ARI C5,
N7 is ARI C7.
N8 is ARI C10, N9 is ARI C8, and N10 is ARI C9.
N11 is the Minimum evaporating temperature and N12 is Maximum evaporating temperature.
N13 is the Minimum condensing temperature and N14 is the Maximum condensing
temperature
Field: Rated Superheat
Some manufacturers specify a constant return gas temperature while others specify a
constant superheat (the difference between the saturated evaporating temperature and the
actual return gas temperature). Use this field for compressors that provide their rated
superheat. (Do NOT use both this field and the Rated Return Gas Temperature field.) The
rated superheat is specified in units of delta C.
Field: Rated Return Gas Temperature
Some manufacturers specify a constant return gas temperature ( which may also be called
the Rated Suction Temperature) while others specify a constant superheat. Use this field for
compressors that provide their rated return gas temperature. (Do NOT use both this field and
the Rated Superheat field.) The rated return gas temperature is specified in units of C.
Field: Rated Liquid Temperature
Some compressor manufactures rate their equipment according to a constant subcooling (the
difference between the saturated condensing temperature and the actual liquid temperature
entering the thermal expansion valve before the refrigeration load). Other manufacturers
specify a constant liquid temperature.Use this field if the manufacturer specifies the rated
liquid temperature. (Do NOT use both this field and the Rated Subcooling field.) The units for
this field are degrees C.
Field: Rated Subcooling
Some compressor manufactures rate their equipment according to a constant subcooling (the
difference between the saturated condensing temperature and the actual liquid temperature
entering the thermal expansion valve before the refrigeration load). Other manufacturers
specify a constant liquid temperature.Use this field if the manufacturer specifies the rated
subcooling. (Do NOT use both this field and the Rated Liquid Temperature field.) The units
for this field are delta C.
Field: End-Use Subcategory
This field allows the specification of a user-defined end-use subcategory (e.g., "Low
Temperature System"). A new meter for reporting is created for each unique subcategory
(Ref: Output:Meter objects). Subcategories are also reported in the ABUPS table. If this field
is left blank, the equipment will be assigned to the "General" end-use subcategory.
The following is an example input for a refrigeration compressor.

9/29/14

1218

Input-Output Reference
Refrigeration:Compressor,
CompressorA,
PowerCurveCompA,
CapCurveCompA,
10.0,
,
,
15.0,
MedTempRefrig;

Group Refrigeration

!- Name
!- Refrigeration Compressor Power Curve Name
!- Refrigeration Compressor Capacity Curve Name
! Rated Superheat {delta C}
!- Rated Return Gas Temperature {C}
! Rated Liquid Temperature{C}
!- Rated Subcooling {delta C}
!- End-Use Subcategory

Refrigeration Compressor Outputs

THE FOLLOWING OUTPUTS ARE AVAILABLE FOR SYSTEMS THAT SERVE CASES AND/OR
WALKINS:
Zone,Average,Refrigeration Compressor Electric Power [W]
Zone,Sum,Refrigeration Compressor Electric Energy [J]
Zone,Average,Refrigeration Compressor Heat Transfer Rate [W]
Zone,Sum,Refrigeration Compressor Heat Transfer Energy [J]
Zone,Sum,Refrigeration Compressor Run Time Fraction []
THE FOLLOWING OUTPUTS ARE AVAILABLE FOR SYSTEMS THAT SERVE AIR CHILLERS:
HVAC,Average,Refrigeration Air Chiller System Compressor Electric Power [W]
HVAC,Sum,Refrigeration Air Chiller System Compressor Electric Energy [J]
HVAC,Average,Refrigeration Air Chiller System Compressor Heat Transfer Rate
[W]
HVAC,Sum,Refrigeration Air Chiller System Compressor Heat Transfer Energy [J]
HVAC,Average,Refrigeration Chiller Compressor Run TimeFraction []

THE FOLLOWING OUTPUTS ARE AVAILABLE FOR SYSTEMS THAT SERVE CASES
AND/OR WALKINS
Refrigeration Compressor Electric Power [W]
This output is the electric power input to the compressor in Watts.
Refrigeration Compressor Electric Energy [J]
This is the electric energy consumed by the compressor in Joules for the timestep being
reported. This output is also added to a meter with Resource Type = Electricity, End Use Key
= Refrigeration, Group Key = Plant (Ref. Output:Meter objects).
Refrigeration Compressor Heat Transfer Rate [W]
This output is the heat removed from the refrigerated cases by the compressor in Watts.
Refrigeration Compressor Heat Transfer Energy [J]
This is the heat removed from the refrigerated cases by the compressor in Joules for the
timestep being reported.
Refrigeration Compressor Run Time Fraction []
This is the fraction of the time step when the compressor ran to meet the load. It is a value
between 0.0 and 1.0.
THE FOLLOWING OUTPUTS ARE AVAILABLE FOR SYSTEMS THAT SERVE AIR
CHILLERS
Refrigeration Air Chiller System Compressor Electric Power [W]
This output is the electric power input to the compressor in Watts.
Refrigeration Air Chiller System Compressor Electric Energy [J]
This is the electric energy consumed by the compressor in Joules for the timestep being
reported. This output is also added to a meter with Resource Type = Electricity, End Use Key
= Refrigeration, Group Key = Plant (Ref. Output:Meter objects).

9/29/14

1219

Input-Output Reference

Group Refrigeration

Refrigeration Air Chiller System Compressor Heat Transfer Rate [W]

This output is the heat removed from the refrigerated cases by the compressor in Watts.
Refrigeration Air Chiller System Compressor Heat Transfer Energy [J]
This is the heat removed from the refrigerated cases by the compressor in Joules for the
timestep being reported.
Refrigeration Chiller Compressor Run Time Fraction []
This is the fraction of the time step when the compressor ran to meet the load. It is a value
between 0.0 and 1.0.
Refrigeration:CompressorList
This object provides a list of all the compressors included within a single refrigeration system
(Ref: Refrigeration:System). Each list must contain at least one compressor. The order in
which the individual compressors are listed here will be the order in which the compressors
are dispatched to meet the system load. That is, at very low loads, only compressor #1 will
be operating. As the load increases, the first two compressors will be operating, and so on.
This list is extensible.
Field: Name
A unique user-assigned name for an instance of a compressor list. Any reference to this
compressor list by another object will use this name. The compressor list cannot have the
same name as any individual compressor.
Field: Refrigeration Compressor <x> Name
Identifies a particular compressor that works in conjunction with the other compressors on
this list to provides cooling to a single refrigeration system. The name will be validated
against the compressor names (ref: Refrigeration:Compressor) in the input file. Up to 20 are
available in the IDD; this object is extensible.
The following is an example input for a compressor list.
Refrigeration:CompressorList,
MediumTempCompressorlist, !- Refrigeration Compressor List Name
CompressorA,
!- Refrigeration Compressor Name #1
CompressorB,
!- Refrigeration Compressor Name #2
CompressorC;
!- Refrigeration Compressor Name #3

Refrigeration:Subcooler
Two types of subcoolers are modeled by the detailed refrigeration system. As described in
the Engineering Reference, the liquid suction heat exchanger uses cool suction gas to
subcool the hot condensate after it leaves the condenser and before it reaches the thermal
expansion valve. For the liquid suction heat exchanger, both the source and sink of energy
are located within the same refrigeration system. In contrast, a mechanical subcooler is used
to transfer cooling capacity from one refrigeration system to another. The mechanical
subcooler is listed as a part of the system for which the condensate is cooled. However, the
input data for the mechanical subcooler includes a field that identifies the system that
provides the cooling capacity.
Field: Name
A unique user-assigned name for an instance of a subcooler. Any reference to this subcooler
by another object will use this name.

9/29/14

1220

Input-Output Reference

Group Refrigeration

Field: Subcooler Type

The type of subcooler. Valid choices are Mechanical and LiquidSuction. If the field is blank,
the default will be LiquidSuction.
Field: Liquid Suction Design Subcooling Temperature Difference
This numeric field is the design subcooling temperature difference (DeltaC) for a liquid
suction heat exchanger and should be blank for a mechanical subcooler.
Field: Design Liquid Inlet Temperature
This numeric field is the design inlet temperature (C) for the hot liquid entering a liquid suction
heat exchanger and should be blank for a mechanical subcooler.
Field: Design Vapor Inlet Temperature
This numeric field is the design inlet temperature (C) for the cool vapor entering a liquid
suction heat exchanger and should be blank for a mechanical subcooler.
Field: Capacity-Providing System
This field is the name of the refrigeration system object that provides the cooling capacity for
the mechanical subcooler (ref: Refrigeration:System Name). This field should be blank for a
liquid suction heat exchanger.
Field: Outlet Control Temperature
This numeric field is the controlled outlet temperature (C) for subcooled liquid exiting a
mechanical subcooler. This field should be blank for a liquid suction heat exchanger.

The following is example input for both liquid suction and mechanical subcoolers.
REFRIGERATION:SUBCOOLER,
SampleLSHx,
LiquidSuction,
6,
16,
0,
,
;

!Subcooler Name
!subcooler type
!design liquid suction subcooling {deltaC}
!design inlet temperature on liquid side {C}
!design inlet temperature on vapor side {C}
!Refrigeration System Detailed Name providing cooling capacity
!Control Temperature Out for subcooled liquid {C}

! Mechanical Subcooler (uses Med Temp System to cool low temp liquid to 10C)
REFRIGERATION:SUBCOOLER,
SampleMSC,
!Subcooler Name
Mechanical,
!subcooler type
,
!design liquid suction subcooling {C}
,
!design inlet temperature on liquid side {C}
,
!design inlet temperature on vapor side {C}
MediumTempSystem,
!Refrigeration System Detailed Name providing cooling capacity
10;
!Control Temperature Out for subcooled liquid {C}

Refrigeration Subcooler Outputs

FOR SUBCOOLERS ON SYSTEMS SERVING CASES AND/OR WALKINS:
Zone,Average, Refrigeration System Mechanical Subcooler Heat Transfer Rate
[W]
Zone,Sum, Refrigeration System Mechanical Subcooler Heat Transfer Energy [J]
FOR SUBCOOLERS ON SYSTEMS SERVING AIR CHILLERS:
Zone,Average, Refrigeration Air Chiller System Mechanical Subcooler Heat
Transfer Rate [W]
Zone,Sum, Refrigeration Air Chiller System Mechanical Subcooler Heat Transfer
Energy [J]

9/29/14

1221

Input-Output Reference

Group Refrigeration

FOR SUBCOOLERS ON SYSTEMS SERVING CASES AND/OR WALKINS:

Refrigeration System Mechanical Subcooler Heat Transfer Rate [W]
This output is the cooling energy transferred from one systems compressor group to the
refrigerant leaving the condenser for another refrigeration system in Watts.
Refrigeration System Mechanical Subcooler Heat Transfer Energy [J]
This output is the cooling energy transferred from one systems compressor group to the
refrigerant leaving the condenser for another refrigeration system in Joules.
FOR SUBCOOLERS ON SYSTEMS SERVING AIR CHILLERS
Refrigeration Air Chiller System Mechanical Subcooler Heat Transfer Rate [W]
This output is the cooling energy transferred from one systems compressor group to the
refrigerant leaving the condenser for another refrigeration system in Watts.
Refrigeration Air Chiller System Mechanical Subcooler Heat Transfer Energy [J]
This output is the cooling energy transferred from one systems compressor group to the
refrigerant leaving the condenser for another refrigeration system in Joules.
Refrigeration:Condenser:AirCooled
The refrigeration system requires a single condenser to reject the system heat. The air
cooled condenser object is one of four options for this condenser. In an air-cooled condenser,
the total heat of rejection is characterized by a linear relationship between the difference
between the inlet air (usually the outside drybulb) and condensing temperatures. This curve
is commonly found in the condenser manufacturers literature. This rating curve, which
corresponds to ARI 460 standards, also has an associated rated value for subcooling that
should be entered. The rated condenser fan power and fan speed control type must be
specified. If the condenser is not at ground level, the user may specify an air inlet node name
(ref: OutdoorAir:Node name). If the condenser is located inside a conditioned zone, the zone
name may be specified(ref: bbbZoneNamebbb). Optional input is provided to help the user
compare refrigerant inventories for different systems. These inputs represent the design
values for the refrigerant inventory within the condenser, within a receiver beneath the
condenser, and in the liquid pipes between the condenser and the refrigerated cases.
Field: Name
Identifies a particular condenser that rejects heat for a one or more refrigeration system(s).
The name must be unique and will be validated against all the condenser names (ref:
Refrigeration:Condenser:*) in the input file, including names used for evaporative-cooled,
water-cooled, and cascade-cooled condensers.
Field: Rated Effective Total Heat Rejection Rate Curve Name
This field is the name of a curve object defining the condenser heat rejection as a function of
the difference between the condensing and entering air temperatures. The curve should be
linear (Curve:Linear). See the Engineering Reference for more discussion on the curve
coefficients.
Field: Rated Subcooling Temperature Difference
This numeric field specifies the rated subcooling (DeltaC) specified by the manufacturer,
consistent with the heat rejection curve rating data.

9/29/14

1222

Input-Output Reference

Group Refrigeration

Field: Condenser Fan Speed Control Type

The type of fan speed control used by the condenser fan. Valid choices are Fixed,
FixedLinear, VariableSpeed, and TwoSpeed. If the field is blank, Fixed will be used. See
the Engineering Reference for a discussion of this options effect on fan energy consumption.
Field: Rated Fan Power
This numeric field specifies the rated fan power (W) specified by the manufacturer, under
standard rating conditions.
Field: Minimum Fan Air Flow Ratio
Fan controls often include a minimum air flow ratio to avoid overheating the fan motor or for
other reasons. This numeric field should be between 0. and 1. and has a default value of 0.2.
Field: Air Inlet Node Name or Zone Name
This optional alpha field contains the name of the node from which the condenser draws its
outdoor air or the name of the conditioned zone where the condenser is located. If this field is
left blank, the outdoor air drybulb temperature entering the condenser is taken directly from
the weather data. If this field is not blank and an outdoor air node name is entered, this node
name must also be specified in an OutdoorAir:Node object where the height of the node is
taken into consideration when calculating outdoor air temperature from the weather data.
Alternately, the node name may be specified in an OutdoorAir:NodeList object where the
outdoor air temperature is taken directly from the weather data. If a zone name is entered,
.bbb
Field: End-Use Subcategory
This field allows the specification of a user-defined end-use subcategory (e.g., "Low
Temperature Rack"). A new meter for reporting is created for each unique subcategory (Ref:
Output:Meter objects). Subcategories are also reported in the ABUPS table. If this field is left
blank, the equipment will be assigned to the "General" end-use subcategory.
Field: Condenser Refrigerant Operating Charge Inventory
This numeric field specifies the amount of refrigerant present within the condenser (kg)
specified by the manufacturer, under standard rating conditions.
Field: Condensate Receiver Refrigerant Inventory
This numeric field specifies the amount of refrigerant present within the condensate receiver
(kg) specified by the manufacturer or system designer, under standard rating conditions.
Field: Condensate Piping Refrigerant Inventory
This numeric field specifies the amount of refrigerant present within the condensate piping
(kg) specified by the system designer, under standard rating conditions.
The following is an example input for an air-cooled condenser.
Refrigeration:Condenser:AirCooled,
MediumTempCondenser,
!- Name of condenser
MediumTempCondenserHRCurve, !-name of condenser heat of rejection curve, linear
0.,
! Rated subcooling {deltaC}
VariableSpeed,
! Fan speed control type
4000.,
! Design condenser fan power {W}
0.25,
!Minimum air flow fraction through condenser fan {dimensionless}
Refrigeration MediumTempSystem CondenserNode, !- Condenser Air Inlet Node Name or Zone Name
MediumTempRefrig;
!- End-Use Subcategory

Refrigeration Condenser (AirCooled) Outputs

FOR CONDENSERS COOLING SYSTEMS SERVING CASES AND/OR WALKINS:
Zone,Average, Refrigeration System Condenser Fan Electric Power [W]
Zone, Sum, Refrigeration System Condenser Fan Electric Energy [J]
9/29/14

1223

Input-Output Reference

Group Refrigeration

Zone,Average, Refrigeration System Condenser Heat Transfer Rate [W]

Zone, Sum, Refrigeration System Condenser Heat Transfer Energy [J]
Zone,Average, Refrigeration System Condenser Total Recovered Heat Transfer
Rate [W] Zone, Sum, Refrigeration System Condenser Total Recovered Heat
Transfer Energy [J]
Zone,Average, Refrigeration System Condenser Non Refrigeration Recovered Heat
Transfer Rate [W]
Zone, Sum, Refrigeration System Condenser Heat Recovered for NonRefrigeration Purposes Energy [J]
Zone,Average, Refrigeration System Condenser Defrost Recovered Heat Transfer
Rate [W]
Zone, Sum, Refrigeration System Condenser Defrost Recovered Heat Transfer
Energy [J]
FOR CONDENSERS COOLING SYSTEMS SERVING AIR CHILLERS:
HVAC,Average, Refrigeration System Condenser Fan Electric Power [W]
HVAC, Sum, Refrigeration System Condenser Fan Electric Consumption [J]
HVAC,Average, Refrigeration Air Chiller System Condenser Heat Transfer Rate
[W]
HVAC, Sum, Refrigeration Air Chiller System Condenser Heat Transfer Energy
[J]
HVAC,Average, Refrigeration Air Chiller System Condenser Total Recovered Heat
Transfer Rate [W] HVAC, Sum, Refrigeration Air Chiller System Condenser Total
Recovered Heat Transfer Energy [J]
HVAC,Average, Refrigeration Air Chiller System Condenser Non Refrigeration
Recovered Heat Transfer Rate [W]
HVAC, Sum, Refrigeration Air Chiller System Condenser Non Refrigeration
Recovered Heat Transfer Energy [J]
HVAC,Average, Refrigeration Air Chiller System Condenser Defrost Recovered
Heat Transfer Rate [W]
HVAC, Sum, Refrigeration Air Chiller System Condenser Defrost Recovered Heat
Transfer Energy [J]

FOR CONDENSERS ON SYSTEMS SERVING CASES AND/OR WALKINS:

Refrigeration System Condenser Fan Electric Power [W]
This output is the electric input to the systems condenser fan(s) in Watts.
Refrigeration System Condenser Fan Electric Consumption [J]
This is the electricity consumption of the systems condenser fan(s) in Joules for the timestep
being reported. This output is also added to a meter with Resource Type = Electricity, End
Use Key = Refrigeration, Group Key = Plant (Ref. Output:Meter objects).
Refrigeration System Condenser Heat Transfer Rate [W]
This is the total heat transfer across the condenser (i.e., compressor energy and refrigeration
load minus any heat recovered for defrost or other purposes).
Refrigeration System Condenser Heat Transfer Energy [J]
This is the total heat energy flowing across the condenser for the timestep being reported
(i.e., compressor energy and refrigeration load minus any heat recovered for defrost or other
purposes).
Refrigeration System Condenser Total Recovered Heat Transfer Rate [W]
This is the total heat recovered from the condenser inlet flow for all purposes including
defrost and water or air heating.
Refrigeration System Condenser Total Recovered Heat Transfer Energy [J]
This is the total heat recovered from the condenser inlet flow for all purposes including
defrost and water or air heating for the timestep being reported.

9/29/14

1224

Input-Output Reference

Group Refrigeration

Refrigeration System Condenser Non Refrigeration Recovered Heat Transfer Rate [W]
This is the total heat recovered from the condenser inlet flow for purposes such as water or
air heating.
Refrigeration System Condenser Non Refrigeration Recovered Heat Transfer Energy [J]
This is the total heat recovered from the condenser inlet flow for purposes such as water or
air heating for the timestep being reported.
Refrigeration System Condenser Defrost Recovered Heat Transfer Rate [W]
This is the total heat recovered from the condenser inlet flow for defrost purposes within the
refrigeration system.
Refrigeration System Condenser Defrost Recovered Heat Transfer Energy [J]
This is the total heat recovered from the condenser inlet flow for defrost purposes within the
refrigeration system for the timestep being reported.
FOR CONDENSERS ON SYSTEMS SERVING AIR CHILLERS:
Refrigeration Air Chiller System Condenser Fan Electric Power [W]
This output is the electric input to the systems condenser fan(s) in Watts.
Refrigeration Air Chiller System Condenser Fan Electric Energy [J]
This is the electricity consumption of the systems condenser fan(s) in Joules for the timestep
being reported. This output is also added to a meter with Resource Type = Electricity, End
Use Key = Refrigeration, Group Key = Plant (Ref. Output:Meter objects).
Refrigeration Air Chiller System Condenser Heat Transfer Rate [W]
This is the total heat transfer across the condenser (i.e., compressor energy and refrigeration
load minus any heat recovered for defrost or other purposes).
Refrigeration Air Chiller System Condenser Heat Transfer Energy [J]
This is the total heat energy flowing across the condenser for the timestep being reported
(i.e., compressor energy and refrigeration load minus any heat recovered for defrost or other
purposes).
Refrigeration Air Chiller System Condenser Total Recovered Heat Transfer Rate [W]
This is the total heat recovered from the condenser inlet flow for all purposes including
defrost and water or air heating.
Refrigeration Air Chiller System Condenser Total Recovered Heat Transfer Energy [J]
This is the total heat recovered from the condenser inlet flow for all purposes including
defrost and water or air heating for the timestep being reported.
Refrigeration Air Chiller System Condenser Non Refrigeration Recovered Heat Transfer
Rate [W]
This is the total heat recovered from the condenser inlet flow for purposes such as water or
air heating.
Refrigeration Air Chiller System Condenser Non Refrigeration Recovered Heat Transfer
Energy [J]
This is the total heat recovered from the condenser inlet flow for purposes such as water or
air heating for the timestep being reported.

9/29/14

1225

Input-Output Reference

Group Refrigeration

Refrigeration Air Chiller System Condenser Defrost Recovered Heat Transfer Rate [W]
This is the total heat recovered from the condenser inlet flow for defrost purposes within the
refrigeration system.
Refrigeration Air Chiller System Condenser Defrost Recovered Heat Transfer Energy [J]
This is the total heat recovered from the condenser inlet flow for defrost purposes within the
refrigeration system for the timestep being reported.
Refrigeration:Condenser:EvaporativeCooled
Each refrigeration system requires a single condenser. The evaporative cooled condenser
object is one of four options for this condenser. In an evaporative-cooled condenser, the total
heat of rejection is characterized by a four-factor relationship between the condensing
temperature and the difference between the outside wetbulb and condensing temperatures.
This curve must be developed by regression from the condenser manufacturers literature.
This rating curve, which is based upon rated data taken according to ARI 460 standards, also
has an associated rated value for subcooling that should be entered. The rated condenser
fan power and fan speed control type must be specified. If the condenser is not at ground
level, the user may specify an air inlet node name (ref: OutdoorAir:Node name). Optional
input is provided to help the user compare refrigerant inventories for different systems.
These input represent the design values for the refrigerant inventory within the condenser,
within a receiver beneath the condenser, and in the liquid pipes between the condenser and
the refrigerated cases.
Additional inputs are needed for basin heater parameters, water pump power, and water
source. An evaporative cooling availability schedule is available.
Field: Name
Identifies a particular condenser that rejects heat for a one or more refrigeration system(s).
The name must be unique and will be validated against all the condenser names (ref:
Refrigeration:Condenser:*) in the input file, including names used for air-cooled, water-cooled
and cascade-cooled condensers.
Field: Rated Effective Total Heat Rejection Rate
This numeric field should be the rated heat rejection effect (W) at standard rating conditions
per ARI 490. Be sure the rating corresponds to the correct refrigerant.
Field: Rated Subcooling Temperature Difference
This numeric field specifies the rated subcooling (DeltaC) specified by the manufacturer,
consistent with the rated value for total heat rejection.
Field: Fan Speed Control Type
The type of fan speed control used by the condenser fan. Valid choices are Fixed,
FixedLinear, VariableSpeed, and TwoSpeed. If the field is blank, Fixed will be used. See
the Engineering Reference for a discussion of this options effect on fan energy consumption.
Field: Rated Fan Power
This numeric field specifies the rated fan power (W) specified by the manufacturer, under
standard rating conditions.
Field: Minimum Fan Air Flow Ratio
Fan controls often include a minimum air flow ratio to avoid overheating the fan motor or for
other reasons. This numeric field has a minimum value of 0. and a default value of 0.2.

9/29/14

1226

Input-Output Reference

Group Refrigeration

Field: Approach Temperature Constant Term

As described in the Engineering Reference (ref Refrigeration:Condenser:Evaporative), the
heat rejection capacity factor is specified according to the form (where Twetbulb and
Tcondense are in C):
Tcondense=A1 + A2(hrcf) + A3/(hrcf) + (1 + A4)(Twb)
This numeric field is the value for A1 and has a default value of 6.63, a minimum of 0. and a
maximum of 20. (C)
Field: Approach Temperature Coefficient 2
As described in the Engineering Reference (ref Refrigeration:Condenser:Evaporative), the
heat rejection capacity factor is specified according to the form (where Twetbulb and
Tcondense are in C):
Tcondense=A1 + A2(hrcf) + A3/(hrcf) + (1 + A4)(Twb)
This numeric field is the value for A2 and has a default value of 0.468, a minimum of 0, and a
maximum of 20 (C).
Field: Approach Temperature Coefficient 3
As described in the Engineering Reference (ref Refrigeration:Condenser:Evaporative), the
heat rejection capacity factor is specified according to the form (where Twetbulb and
Tcondense are in C):
Tcondense =A1 + A2(hrcf) + A3/(hrcf) +(1 + A4)(Twb)
This numeric field is the value for A3 and has a default value of 17.93, a minimum of 0, and a
maximum of 30 (C).
Field: Approach Temperature Coefficient 4
As described in the Engineering Reference (ref Refrigeration:Condenser:Evaporative), the
heat rejection capacity factor is specified according to the form (where Twetbulb and
Tcondense are in C):
Tcondense =A1 + A2(hrcf) + A3/(hrcf) + (1 + A4)(Twb)
This numeric field is the value for A4 and has a default value of -0.322, a minimum of -20.,
and a maximum of 20 (dimensionless).
Field: Minimum Capacity Factor
This numeric field is the minimum heat rejection capacity factor in the manufacturers data
used to develop the equation described in the preceding four fields. The default value is 0.5.
Field: Maximum Capacity Factor
This numeric field is the maximum heat rejection capacity factor in the manufacturers data
used to develop the equation described in the preceding four fields. The default value is 5.0.
Field: Air Inlet Node Name
This optional alpha field contains the name of the node from which the condenser draws its
outdoor air. If this field is left blank, the outdoor air drybulb temperature entering the
condenser is taken directly from the weather data. If this field is not blank, this node name
must also be specified in an OutdoorAir:Node object where the height of the node is taken
into consideration when calculating outdoor air temperature from the weather data.
Alternately, the node name may be specified in an OutdoorAir:NodeList object where the
outdoor air temperature is taken directly from the weather data.
Field: Rated Air Flow Rate
The air volume flow rate, in m 3 per second, entering the evaporative condenser. This value is
used to calculate the amount of water evaporated when evaporatively cooling the condenser
inlet air. The value for this field must be greater than zero. This input field is also
9/29/14

1227

Input-Output Reference

Group Refrigeration

autocalculatable, equivalent to 0.000144 m 3/s per watt of total cooling capacity [850 cfm/ton]
where the total cooling capacity is the total heat of rejection.
Field: Basin Heater Capacity
This field defines the power level of the basin heater, if applicable, used to avoid water
freezing in an outdoor evaporative cooler basin. This numeric field contains the capacity of
the electric basin heater in Watts per degree C. This field is used in conjunction with the
Basin Heater Set Point Temperature described in the following field. The basin heater electric
power is equal to this field multiplied by the difference between the basin heater set point
temperature and the dry-bulb temperature of the condenser coil inlet air. The basin heater
only operates when the condenser fan is off (i.e., no compressor heat rejection). The basin
heater capacity must be greater than or equal to zero, with a default value of 200 W/C if this
field is left blank.
Field: Basin Heater Setpoint Temperature
This numeric field contains the set point temperature (C) for the basin heater described in
the previous field. The basin heater is active when the outdoor air dry-bulb temperature falls
below this set point temperature, as long as the condenser fan is off. The default value is 2C
if this field is left blank.
Field: Rated Water Pump Power
The rated power of the evaporative condenser water pump in Watts. This value is used to
calculate the power required to pump the water used to evaporatively cool the condenser
inlet air. The value for this field must be greater than or equal to 0, with a default value of
1000 Watts if this field is left blank. This input field is also autocalculatable, equivalent to
0.004266 W per Watt [15 W/ton] of total cooling capacity.
Field: Evaporative Water Supply Tank Name
This field is used to define where the condenser obtains water used for evaporative cooling. If
this field is left blank, the unit will obtain water directly from the mains (Ref. Water Mains
Temperatures). If the name of a Water Storage Tank object is used here, then the unit will
obtain its water from that tank.
Field: Evaporative Condenser Availability Schedule Name
For evaporative cooled condensers, the name of the optional schedule (Ref: Schedule) that
specifies the time periods that evaporative cooling is available/unavailable. In some colder
climates, evaporative cooling is periodically discontinued and the basin sumps drained to
avoid freezing and to avoid ice formation on the condenser. In these times, the condenser
runs as a typical dry air cooled condenser, and related evaporative cooling systems (e.g.,
water pump, basin heaters) do not operate. Use of this optional schedule permits modeling of
planned, seasonal interruptions of evaporative cooling. All schedule values must be greater
than or equal to zero. Typically, an ON/OFF schedule type is used with values being either 0
or 1. A schedule value of 1 indicates that evaporative cooling is available during the defined
time period, and a value of 0 denotes that evaporative cooling is not available during the
defined time period. If the schedule name is omitted (blank), then the model assumes that
evaporative cooling of the condenser is available for the entire simulation period. Note: the
use of this schedule is the correct way to model an evaporative condenser in a climate
subject to freezing weather. However, because some users will take a single model
description and run it for a multiple climates, the code also includes an automatic switch from
wet to dry operation, as described in the Engineering Reference.
Field: End-Use Subcategory
This field allows the specification of a user-defined end-use subcategory (e.g., "Low
Temperature Rack"). A new meter for reporting is created for each unique subcategory (Ref:

9/29/14

1228

Input-Output Reference

Group Refrigeration

Output:Meter objects). Subcategories are also reported in the ABUPS table. If this field is left
blank, the equipment will be assigned to the "General" end-use subcategory.
Field: Condenser Refrigerant Operating Charge Inventory
This numeric field specifies the amount of refrigerant present within the condenser (kg)
specified by the manufacturer, under standard rating conditions.
Field: Condensate Receiver Refrigerant Inventory
This numeric field specifies the amount of refrigerant present within the condensate receiver
(kg) specified by the manufacturer or system designer, under standard rating conditions.
Field: Condensate Piping Refrigerant Inventory
This numeric field specifies the amount of refrigerant present within the condensate piping
(kg) specified by the system designer, under standard rating conditions.
The following is an example input for an evaporative condenser
Refrigeration:Condenser:EvaporativeCooled,
MedTempEvapCooledCondenser , !- Refrigeration Condenser Name
64800. ,
!- Rated Total Heat Rejection Effect, {W}
0. ,
!- Rated Subcooling
VariableSpeed ,
!- Condenser Fan Speed Control
746.,
!- Rated Condenser Fan Power
0.25,
!- Minimum air flow fraction through condenser fan {dimensionless}
6.63 ,
!- Evaporative Condenser Approach Temp Const, {C}
0.468 ,
!- Evaporative Condenser Approach Temp HRCF Cooefficient
17.93 ,
!- Evaporative Condenser Approach Temp 1/hrcf coefficient
-0.322,
!- Evaporative Condenser Approach Temp Twb coefficient {1/C}
0.6 ,
!- Minimum Condenser Capacity Factor
4.8 ,
!- Maximum Condenser Capacity Factor
Outside Air Inlet Node,
!- Condenser Air Inlet Node Name
1.79 ,
!- Rated Air Flow Rate {m3/s}
66.7 ,
!- Basin Heater Capacity {W/C}
1.0 ,
!- Basin Heater Set Point Temperature {C}
250. ,
!- Rated Water Pump Power {W}
EvapWaterStorageTank,
!- Evaporative Water Supply Tank Name
EvapCondAvail,
!- Evaporative Condenser Availability Schedule Name
,
!- End-UseSubcategory
21.9 ,
!- Condenser Refrigerant Operating Charge {kg}
10. ,
!- Condensate Receiver Refrigerant Inventory
25. ;
!- Condensate Piping Refrigerant Inventory

9/29/14

1229

Input-Output Reference

Group Refrigeration

Refrigeration Condenser (EvaporativeCooled) Outputs

Zone,Average, Refrigeration System Condenser Fan Electric Power [W]
Zone, Sum, Refrigeration System Condenser Fan Electric Consumption [J]
FOR CONDENSERS COOLING SYSTEMS SERVING CASES AND/OR WALKINS:
Zone,Average, Refrigeration System Condenser Heat Transfer Rate [W]
Zone, Sum, Refrigeration System Condenser Heat Transfer Energy [J]
Zone,Average, Refrigeration System Condenser Total Recovered Heat Transfer Rate [W]
Zone, Sum, Refrigeration System Condenser Total Recovered Heat Transfer Energy [J]
Zone,Average, Refrigeration System Condenser Non Refrigeration Recovered Heat Transfer Rate [W]
Zone, Sum, Refrigeration System Condenser Non Refrigeration Recovered Heat Transfer Energy [J]
Zone,Average, Refrigeration System Condenser Defrost Recovered Heat Transfer Rate [W]
Zone, Sum, Refrigeration System Condenser Defrost Recovered Heat Transfer Energy [J]
Zone,Average, Refrigeration System Condenser Pump Electric Power [W]
Zone, Sum, Refrigeration System Condenser Pump Electric Energy [J]
Zone,Average, Refrigeration System Condenser Basin Heater Electric Power [W]
Zone, Sum, Refrigeration System Condenser Basin Heater Electric Energy [J]
Zone,Average, Refrigeration System Condenser Evaporated Water Volume Flow Rate [m3/s]
Zone, Sum, Refrigeration System Condenser Evaporated Water Volume [m3]
FOR CONDENSERS COOLING SYSTEMS SERVING AIR CHILLERS:
HVAC,Average, Refrigeration Air Chiller System Condenser Heat Transfer Rate [W]
HVAC, Sum, Refrigeration Air Chiller System Condenser Heat Transfer Energy [J]
HVAC,Average, Refrigeration Air Chiller System Condenser Total Recovered Heat Transfer Rate [W]
HVAC, Sum, Refrigeration Air Chiller System Condenser Total Recovered Heat Transfer Energy [J]
HVAC,Average, Refrigeration Air Chiller System Condenser Non Refrigeration Recovered Heat Transfer Rate
[W]
HVAC, Sum, Refrigeration Air Chiller System Condenser Non Refrigeration Recovered Heat Transfer Energy [J]
HVAC,Average, Refrigeration Air Chiller System Condenser Defrost Recovered Heat Transfer Rate [W]
HVAC, Sum, Refrigeration Air Chiller System Condenser Defrost Recovered Heat Transfer Energy [J]
HVAC,Average, Refrigeration Air Chiller System Condenser Pump Electric Power [W]
HVAC, Sum, Refrigeration Air Chiller System Condenser Pump Electric Energy [J]
HVAC,Average, Refrigeration Air Chiller System Condenser Basin Heater Electric Power [W]
HVAC, Sum, Refrigeration Air Chiller System Condenser Basin Heater Electric Energy [J]
HVAC,Average, Refrigeration Air Chiller System Condenser Evaporated Water Volume Flow Rate [m3/s]
HVAC, Sum, Refrigeration Air Chiller System Condenser Evaporated Water Volume [m3]

FOR CONDENSERS ON SYSTEMS SERVING CASES AND/OR WALKINS:

Refrigeration System Condenser Fan Electric Power [W]
This output is the electric input to the systems condenser fan(s) in Watts.
Refrigeration System Condenser Fan Electric Energy [J]
This is the electricity consumption of the systems condenser fan(s) in Joules for the timestep
being reported. This output is also added to a meter with Resource Type = Electricity, End
Use Key = Refrigeration, Group Key = Plant (Ref. Output:Meter objects).
Refrigeration System Condenser Heat Transfer Rate [W]
This is the total heat transfer across the condenser (i.e., compressor energy and refrigeration
loads) in Watts.
Refrigeration System Condenser Heat Transfer Energy [J]
This is the total heat energy flowing across the condenser for the timestep being reported.
Refrigeration System Condenser Total Recovered Heat Transfer Rate [W]
This is the total heat recovered from the condenser refrigerant inlet flow for any purpose.
Refrigeration System Condenser Total Recovered Heat Transfer Energy [J]
This is the total heat recovered from the condenser refrigerant inlet flow for any purpose for
the timestep being reported.
Refrigeration System Condenser Non Refrigeration Recovered Heat Transfer Rate [W]
This is the total heat recovered from the condenser refrigerant inlet flow for purposes such as
water or air heating.
9/29/14

1230

Input-Output Reference

Group Refrigeration

Refrigeration System Condenser Heat Recovered for Non-Refrigeration Purposes Energy

[J]
This is the total heat recovered from the condenser refrigerant inlet flow for purposes such as
water or air heating for the timestep being reported.
Refrigeration System Condenser Defrost Recovered Heat Transfer Rate [W]
This is the total heat recovered from the condenser refrigerant inlet flow for defrost purposes
within the refrigeration system..
Refrigeration System Condenser Defrost Recovered Heat Transfer Energy [J]
This is the total heat recovered from the condenser refrigerant inlet flow for defrost purposes
within the refrigeration system for the timestep being reported.
Refrigeration System Condenser Pump Electric Power [W]
This is the electrical power requirement in Watts for the timestep being reported for the water
pump used with evaporative cooling of the condenser.
Refrigeration System Condenser Pump Electric Energy [J]
This is the electricity consumption in Joules of the water pump used with evaporative cooling
of the condenser for the timestep being reported. This output is also added to a meter with
Resource Type = Electricity, End Use Key = Refrigeration, Group Key = Plant. Use of an
optional subkey category is also available, with default to the General end-use subcategory
(Ref. Output:Meter objects).
Refrigeration System Condenser Basin Heater Electric Power [W]
This is the electrical power requirement in Watts for the timestep being reported for the water
heater in the basin of the evaporative system used to cool the condenser.
Refrigeration System Condenser Basin Heater Electric Energy [J]
This is the electricity consumption in Joules of the water heater used to prevent freezing of
the evaporative cooling system for the condenser for the timestep being reported. This output
is also added to a meter with Resource Type = Electricity, End Use Key = Refrigeration,
Group Key = Plant. Use of an optional subkey category is also available, with default to the
General end-use subcategory (Ref. Output:Meter objects).
Refrigeration System Condenser Evaporated Water Volume Flow Rate [m3/s]
The volumetric flow rate in m3/s of water consumed while providing evaporative cooling of the
condenser.
Refrigeration System Condenser Evaporated Water Volume [m3]
This is the water consumed by evaporation in m 3 while providing evaporative cooling of the
condenser for the timestep being reported. This output is also added to a meter with
Resource Type = Water, End Use Key = Refrigeration, Group Key = Plant. Use of an optional
subkey category is also available, with default to the General end-use subcategory (Ref.
Output:Meter objects).
FOR CONDENSERS ON SYSTEMS SERVING AIR CHILLERS:
Refrigeration Air Chiller System Condenser Fan Electric Power [W]
This output is the electric input to the systems condenser fan(s) in Watts.
Refrigeration Air Chiller System Condenser Fan Electric Energy [J]
This is the electricity consumption of the systems condenser fan(s) in Joules for the timestep
being reported. This output is also added to a meter with Resource Type = Electricity, End
Use Key = Refrigeration, Group Key = Plant (Ref. Output:Meter objects).
9/29/14

1231

Input-Output Reference

Group Refrigeration

Refrigeration Air Chiller System Condenser Heat Transfer Rate [W]

This is the total heat transfer across the condenser (i.e., compressor energy and refrigeration
loads) in Watts.
Refrigeration Air Chiller System Condenser Heat Transfer Energy [J]
This is the total heat energy flowing across the condenser for the timestep being reported.
Refrigeration Air Chiller System Condenser Total Recovered Heat Transfer Rate [W]
This is the total heat recovered from the condenser refrigerant inlet flow for any purpose.
Refrigeration Air Chiller System Condenser Total Recovered Heat Transfer Energy [J]
This is the total heat recovered from the condenser refrigerant inlet flow for any purpose for
the timestep being reported.
Refrigeration Air Chiller System Condenser Non Refrigeration Recovered Heat Transfer
Rate [W]
This is the total heat recovered from the condenser refrigerant inlet flow for purposes such as
water or air heating.
Refrigeration Air Chiller System Condenser Non Refrigeration Recovered Heat Transfer
Energy [J]
This is the total heat recovered from the condenser refrigerant inlet flow for purposes such as
water or air heating for the timestep being reported.
Refrigeration Air Chiller System Condenser Defrost Recovered Heat Transfer Rate [W]
This is the total heat recovered from the condenser refrigerant inlet flow for defrost purposes
within the refrigeration system.
Refrigeration Air Chiller System Condenser Defrost Recovered Heat Transfer Energy [J]
This is the total heat recovered from the condenser refrigerant inlet flow for defrost purposes
within the refrigeration system for the timestep being reported.
Refrigeration Air Chiller System Condenser Pump Electric Power [W]
This is the electrical power requirement in Watts for the timestep being reported for the water
pump used with evaporative cooling of the condenser.
Refrigeration Air Chiller System Condenser Pump Electric Energy [J]
This is the electricity consumption in Joules of the water pump used with evaporative cooling
of the condenser for the timestep being reported. This output is also added to a meter with
Resource Type = Electricity, End Use Key = Refrigeration, Group Key = Plant. Use of an
optional subkey category is also available, with default to the General end-use subcategory
(Ref. Output:Meter objects).
Refrigeration Air Chiller System Condenser Basin Heater Electric Power [W]
This is the electrical power requirement in Watts for the timestep being reported for the water
heater in the basin of the evaporative system used to cool the condenser.
Refrigeration Air Chiller System Condenser Basin Heater Electric Energy [J]
This is the electricity consumption in Joules of the water heater used to prevent freezing of
the evaporative cooling system for the condenser for the timestep being reported. This output
is also added to a meter with Resource Type = Electricity, End Use Key = Refrigeration,
Group Key = Plant. Use of an optional subkey category is also available, with default to the
General end-use subcategory (Ref. Output:Meter objects).

9/29/14

1232

Input-Output Reference

Group Refrigeration

Refrigeration Air Chiller System Condenser Evaporated Water Volume Flow Rate [m3/s]
The volumetric flow rate in m 3/s of water consumed while providing evaporative cooling of the
condenser.
Refrigeration Air Chiller System Condenser Evaporated Water Volume [m3]
This is the water consumed by evaporation in m 3 while providing evaporative cooling of the
condenser for the timestep being reported. This output is also added to a meter with
Resource Type = Water, End Use Key = Refrigeration, Group Key = Plant. Use of an optional
subkey category is also available, with default to the General end-use subcategory (Ref.
Output:Meter objects).
Refrigeration:Condenser:WaterCooled
The refrigeration system requires a single condenser. The water cooled condenser object is
one of four options for this condenser. Manufacturers data is required for the rated total heat
rejection, the rated condensing temperature, and the rated leaving liquid refrigerant
temperature, all per ARI 450. These values are used to calculate the subcooling included in
the rated capacity. The inlet and outlet node names as well as the water outlet temperature
schedule name are required. Optional input is provided to help the user compare refrigerant
inventories for different systems. These input represent the design values for the refrigerant
inventory within the condenser, within a receiver beneath the condenser, and in the liquid
pipes between the condenser and the refrigerated cases.
Field: Name
Identifies a particular condenser that rejects heat for one or more refrigeration system(s). The
name must be unique and will be validated against all the condenser names (ref:
Refrigeration:Condenser) in the input file, including names used for air-cooled, evaporativecooled, and cascade-cooled condensers.
Field: Rated Effective Total Heat Rejection Rate
This numeric field should be the rated heat rejection effect (W) at standard rating conditions
per ARI 450. Be sure the rating corresponds to the correct refrigerant.
Field: Rated Condensing Temperature
This numeric field provides the rated condensing temperature (C) corresponding to the rated
heat rejection capacity.
Field: Rated Subcooling Temperature Difference
This numeric field provides the rated liquid refrigerant subcooling (DeltaC) corresponding to
the rated heat rejection capacity. Note this is equal to the difference between the saturated
condensing temperature and the leaving liquid refrigerant temperature.
Field: Rated Water Inlet Temperature
This numeric field provides the rated water inlet temperature (C) corresponding to the rated
heat rejection capacity at the rated condensing temperature.
Field: Water Inlet Node Name
A node name for the water-side condenser inlet must be provided.
Field: Water Outlet Node Name
A node name for the water-side condenser outlet must be provided.

9/29/14

1233

Input-Output Reference

Group Refrigeration

Field: Water-Cooled Loop Flow Type

The type of flow loop should be specified. The two choices are VariableFlow, in which a
Pump:VariableSpeed must be included in the plant loop, or ConstantFlow, in which the loop
circuit has a constant flow rate, typically associated with a Pump:ConstandSpeed object. If
the flow type is VariableFlow, the flow needed to remove the condenser heat energy will be
calculated and requested of the pump. If the flow type is ConstantFlow, the outlet water
temperature will be determined based on the fixed loop flow rate and heat energy to be
removed. The default type is VariableFlow. Refer to additional discussion in the Engineering
Reference.
Field: Water Outlet Temperature Schedule Name
When the water-cooled loop flow type is VariableFlow, the name of a schedule (Ref:
Schedule) that defines the desired condenser water outlet temperature must be provided.
The schedule may define an outlet temperature that varies through time.
Field: Water Design Flow Rate
When the water-cooled loop flow type is ConstantFlow, this is the design water flow rate in
m3/s that will be requested initially. This requested flow will be passed to the loop simulation,
and resulting actual flow will be dependent upon supply system capabilities (e.g., pump
capability). The design flow rate must always be less than the maximum flow rate, defined
below.
Field: Water Maximum Flow Rate
This numeric field is the maximum water flow rate in m 3/s that will be allowed through the
condenser. When the loop flow type is Variable Flow, if the calculated flow rate is higher than
the maximum flow rate, an error message will be generated, and the flow rate will be reset to
the maximum flow rate.
Field: Maximum Water Outlet Temperature
This numeric field specifies the maximum allowed water temperature in degrees C leaving
the condenser. The default value is 55 degrees C.
Field: Minimum Water Inlet Temperature
This numeric field specifies the minimum allowed water temperature in degrees C entering
the compressor rack condenser. The default value is 10 degrees C. Refer to additional
discussion in the Engineering Reference.
Field: End-Use Subcategory
This field allows the specification of a user-defined end-use subcategory (e.g., "Low
Temperature System"). A new meter for reporting is created for each unique subcategory
(Ref: Output:Meter objects). Subcategories are also reported in the ABUPS table. If this field
is left blank, the equipment will be assigned to the "General" end-use subcategory.
Field: Condenser Refrigerant Operating Charge Inventory
This numeric field specifies the amount of refrigerant present within the condenser (kg)
specified by the manufacturer, under standard rating conditions.
Field: Condensate Receiver Refrigerant Inventory
This numeric field specifies the amount of refrigerant present within the condensate receiver
(kg) specified by the manufacturer or system designer, under standard rating conditions.
Field: Condensate Piping Refrigerant Inventory
This numeric field specifies the amount of refrigerant present within the condensate piping
(kg) specified by the system designer, under standard rating conditions.

9/29/14

1234

Input-Output Reference

Group Refrigeration

The following is an example input for a water cooled condenser.

Refrigeration:Condenser:WaterCooled,
MediumTempCondenser ,
!- Name
58000. ,
!- Rated Effective Total Heat Rejection Rate {W}
29.4 ,
!- Rated Condensing Temperature {C}
0.0 ,
!- Rated Subcooling Temperature Difference{deltaC}
10.0,
!- Rated Water Inlet Temperature {C}
Condenser Inlet Node,
!- Water Inlet Node Name
Condenser Outlet Node,
!- Water- Outlet Node Name
Variable Flow,
!- Water-cooled Loop Flow Type
Cond Outlet Temp Sch,
!- Water Outlet Temperature Schedule Name
,
!- Water Design Flow Rate {m3/s}
0.003,
!- Water Maximum Flow Rate {m3/s}
55.,
!- Maximum Water Outlet Temperature {C}
,
!- Minimum Water Inlet Temperature {C}
,
!- End-Use Subcategory
30. ,
!- Condenser Refrigerant Operating Charge {kg}
65. ,
!- Condensate Receiver Refrigerant Inventory {kg}
20. ;
!- Condensate Piping Refrigerant Inventory {kg}

Refrigeration Condenser (WaterCooled) Outputs

FOR CONDENSERS COOLING SYSTEMS SERVING CASES AND/OR WALKINS:
Zone,Average, Refrigeration System Condenser Heat Transfer Rate [W]
Zone, Sum, Refrigeration System Condenser Heat Transfer Energy [J]
Zone,Average, Refrigeration System Condenser Total Recovered Heat Transfer
Rate [W] Zone, Sum, Refrigeration System Condenser Total Recovered Heat
Transfer Energy [J]
Zone,Average, Refrigeration System Condenser Non Refrigeration Recovered Heat
Transfer Rate [W]
Zone, Sum, Refrigeration System Condenser Heat Recovered for NonRefrigeration Purposes Energy [J]
Zone,Average, Refrigeration System Condenser Defrost Recovered Heat Transfer
Rate [W]
Zone, Sum, Refrigeration System Condenser Defrost Recovered Heat Transfer
Energy [J]
Zone,Average, Refrigeration System Condenser Water Mass Flow Rate [kg/s]
FOR CONDENSERS COOLING SYSTEMS SERVING AIR CHILLERS:
HVAC,Average, Refrigeration Air Chiller System Condenser Heat Transfer Rate
[W]
HVAC, Sum, Refrigeration Air Chiller System Condenser Heat Transfer Energy
[J]
HVAC,Average, Refrigeration Air Chiller System Condenser Total Recovered Heat
Transfer Rate [W] HVAC, Sum, Refrigeration Air Chiller System Condenser Total
Recovered Heat Transfer Energy [J]
HVAC,Average, Refrigeration Air Chiller System Condenser Non Refrigeration
Recovered Heat Transfer Rate [W]
HVAC, Sum, Refrigeration Air Chiller System Condenser Non Refrigeration
Recovered Heat Transfer Energy [J]
HVAC,Average, Refrigeration Air Chiller System Condenser Defrost Recovered
Heat Transfer Rate [W]
HVAC, Sum, Refrigeration Air Chiller System Condenser Defrost Recovered Heat
Transfer Energy [J]
HVAC,Average, Refrigeration Air Chiller System Condenser Fluid Mass Flow Rate
[kg/s]

FOR CONDENSERS ON SYSTEMS SERVING CASES AND/OR WALKINS:

Refrigeration System Condenser Heat Transfer Rate [W]
This is the total heat transfer across the condenser (i.e., compressor energy and refrigeration
loads) in Watts.
9/29/14

1235

Input-Output Reference

Group Refrigeration

Refrigeration System Condenser Heat Transfer Energy [J]

This is the total heat energy flowing across the condenser for the timestep being reported.
Refrigeration System Condenser Total Recovered Heat Transfer Rate [W]
This is the total heat recovered from the condenser refrigerant inlet flow for any purpose.
Refrigeration System Condenser Total Recovered Heat Transfer Energy [J]
This is the total heat recovered from the condenser refrigerant inlet flow for any purpose for
the timestep being reported.
Refrigeration System Condenser Non Refrigeration Recovered Heat Transfer Rate [W]
This is the total heat recovered from the condenser inlet flow for purposes such as water or
air heating.
Refrigeration System Condenser Heat Recovered for Non-Refrigeration Purposes Energy
[J]
This is the total heat recovered from the condenser inlet flow for purposes such as water or
air heating for the timestep being reported.
Refrigeration System Condenser Defrost Recovered Heat Transfer Rate [W]
This is the total heat recovered from the condenser inlet flow for defrost purposes within the
refrigeration system..
Refrigeration System Condenser Heat Energy Recovered for Refrigeration Defrost Energy
[J]
This is the total heat recovered from the condenser inlet flow for defrost purposes within the
refrigeration system for the timestep being reported.
Refrigeration System Condenser Water Mass Flow Rate [kg/s]
This is the mass flow rate of the water used to cool the condenser in kg/s.
FOR CONDENSERS ON SYSTEMS SERVING AIR CHILLERS:
Refrigeration Air Chiller System Condenser Heat Transfer Rate [W]
This is the total heat transfer across the condenser (i.e., compressor energy and refrigeration
loads) in Watts.
Refrigeration Air Chiller System Condenser Heat Transfer Energy [J]
This is the total heat energy flowing across the condenser for the timestep being reported.
Refrigeration Air Chiller System Condenser Total Recovered Heat Transfer Rate [W]
This is the total heat recovered from the condenser refrigerant inlet flow for any purpose.
Refrigeration Air Chiller System Condenser Total Recovered Heat Transfer Energy [J]
This is the total heat recovered from the condenser refrigerant inlet flow for any purpose for
the timestep being reported.
Refrigeration Air Chiller System Condenser Non Refrigeration Recovered Heat Transfer
Rate [W]
This is the total heat recovered from the condenser inlet flow for purposes such as water or
air heating.

9/29/14

1236

Input-Output Reference

Group Refrigeration

Refrigeration Air Chiller System Condenser Non Refrigeration Recovered Heat Transfer
Energy [J]
This is the total heat recovered from the condenser inlet flow for purposes such as water or
air heating for the timestep being reported.
Refrigeration Air Chiller System Condenser Defrost Recovered Heat Transfer Rate [W]
This is the total heat recovered from the condenser inlet flow for defrost purposes within the
refrigeration system.
Refrigeration Chiller System Condenser Heat Energy Recovered for Refrigeration Defrost
Energy [J]
This is the total heat recovered from the condenser inlet flow for defrost purposes within the
refrigeration system for the timestep being reported.
Refrigeration Air Chiller System Condenser Fluid Mass Flow Rate [kg/s]
This is the mass flow rate of the water used to cool the condenser in kg/s.
Refrigeration:Condenser:Cascade
The refrigeration system requires a single condenser. The cascade condenser object is one
of four options for this condenser. The cascade condenser is unlike the other condenser
options because it rejects heat to another, higher-temperature, refrigeration system. That is,
the cascade condenser acts as a heat rejection object for one system, but acts as a
refrigeration load for another system. Therefore, this object will be referenced twice: first for
the system rejecting heat (see the field Refrigeration Condenser Name for the object
Refrigeration:System), and second for the system absorbing the heat (see the input for the
field Refrigeration Transfer Load or TransferLoad List Name for the object
Refrigeration:System or the field Cascade Condenser Name or Secondary System Name for
the object Refrigeration:TransferLoadList).
Manufacturers data is required for the rated condensing temperature and the rated approach
temperature difference. The user must also specify the condensing temperature control type.
There are two choices. The user can specify Fixed and the condensing temperature will be
held constant at the input value. The user can specify Float if they want the condensing
temperature to be set by other refrigeration loads served by the higher-temperature system.
The rated heat rejection capacity is not used except as a rough input value check on the
overall system sizing. Optional input is provided to help the user compare refrigerant
inventories for different systems. These inputs represent the design values for the refrigerant
inventory within the condenser, within a receiver beneath the condenser, and in the liquid
pipes between the condenser and the refrigerated cases.
Field: Name
Identifies a particular condenser that rejects heat for a single refrigeration system. The name
must be unique and will be validated against all the condenser names (ref:
Refrigeration:Condenser:*) in the input file, including names used for air-cooled, evaporativecooled, and water-cooled condensers.
Field: Rated Condensing Temperature
This numeric field provides the rated condensing temperature (C).
Field: Rated Approach Temperature Difference
This numeric field provides the rated difference (Delta C) between the saturated condensing
temperature for the system rejecting heat and the saturated evaporating refrigerant
temperature for the system absorbing heat. The default value is 3.0 C.

9/29/14

1237

Input-Output Reference

Group Refrigeration

Field: Rated Effective Total Heat Rejection Rate

This numeric field should be the rated heat rejection effect (W). Be sure the rating
corresponds to the correct refrigerant(s). This value is used for system sizing error checking.
Field: Condensing Temperature Control Type
The type of control used to set the saturated condensing temperature. Valid choices are
Fixed and Float. If the field is blank, Fixed will be used. Fixed will hold the condensing
temperature constant at the value specified. Float will consider the specified input as a
minimum condensing temperature. This value will be compared to the evaporating
temperatures required by other loads on the higher-temperature refrigeration system, and will
use the lowest temperature required to meet those loads, along with the Approach
Temperature Difference, to set the condensing temperature.
Field: Condenser Refrigerant Operating Charge Inventory
This numeric field specifies the amount of refrigerant present within the condenser (kg)
specified by the manufacturer, under standard rating conditions. This refrigerant is on the
side of the condenser rejecting heat, not on the side of the condenser absorbing the heat.
Field: Condensate Receiver Refrigerant Inventory
This numeric field specifies the amount of refrigerant present within the condensate receiver
(kg) specified by the manufacturer or system designer, under standard rating conditions.
Field: Condensate Piping Refrigerant Inventory
This numeric field specifies the amount of refrigerant present within the condensate piping
(kg) specified by the system designer, under standard rating conditions.
The following is an example input for a cascade condenser.
Refrigeration:Condenser:Cascade,
CascadeCondenser1 ,
!- Name
-4. ,
!- Rated Condensing Temperature {C}
3. ,
!- Rated Approach Temperature Difference {DeltaC}
20000.0 ,
!- Rated Effective Total Heat Rejection Rate {W}
Fixed;
!- Condensing Temperature Control Type

Refrigeration Condenser (Cascade) Outputs

FOR CONDENSERS COOLING SYSTEMS SERVING CASES AND/OR WALKINS:
Zone,Average, Refrigeration System Condenser Heat Transfer Rate [W]
Zone, Sum, Refrigeration System Condenser Heat Transfer Energy [J]
FOR CONDENSERS COOLING SYSTEMS SERVING AIR CHILLERS:
HVAC,Average, Refrigeration Air Chiller System Condenser Heat Transfer Rate
[W]
HVAC, Sum, Refrigeration Air Chiller System Condenser Heat Transfer Energy
[J]

FOR CONDENSERS ON SYSTEMS SERVING CASES AND/OR WALKINS:

Refrigeration System Condenser Heat Transfer Rate [W]
This is the total heat transfer across the condenser (i.e., compressor energy and refrigeration
loads) in Watts.
Refrigeration System Condenser Heat Transfer Energy [J]
This is the total heat energy flowing across the condenser for the timestep being reported.

9/29/14

1238

Input-Output Reference

Group Refrigeration

FOR CONDENSERS ON SYSTEMS SERVING AIR CHILLERS:

Refrigeration Air Chiller System Condenser Heat Transfer Rate [W]
This is the total heat transfer across the condenser (i.e., compressor energy and refrigeration
loads) in Watts.
Refrigeration Air Chiller System Condenser Heat Transfer Energy [J]
This is the total heat energy flowing across the condenser for the timestep being reported.
Refrigeration:GasCooler:AirCooled
The transcritical refrigeration system requires a single gas cooler to reject the system heat.
The total heat of rejection is characterized by a linear relationship between the difference
between the outside dry-bulb and gas cooler outlet temperatures. The rated gas cooler fan
power and fan speed control type must be specified. If the gas cooler is not at ground level,
the user may specify an air inlet node name (Ref. OutdoorAir:Node name). Optional input is
provided to help the user track refrigerant inventories. These inputs represent the design
values for the refrigerant inventory within the gas cooler, within a receiver, and in the liquid
pipes between the gas cooler and the refrigerated cases.
Field: Name
Identifies a particular gas cooler that rejects heat for a single refrigeration system. The name
must be unique and will be validated against all the gas cooler names (Ref.
Refrigeration:GasCooler:AirCooled) in the input file.
Field: Rated Total Heat Rejection Rate Curve Name
This field is the name of a curve object defining the gas cooler heat rejection as a function of
the difference between the gas cooler outlet and entering air temperatures. The curve should
be linear (Curve:Linear). See the Engineering Reference for more discussion on the curve
coefficients.
Field: Gas Cooler Fan Speed Control Type
The type of fan speed control used by the gas cooler fan. Valid choices are Fixed,
FixedLinear, VariableSpeed, and TwoSpeed. If the field is blank, Fixed will be used. Note
that fan energy consumption for the air-cooled gas cooler is computed in the same way as
that of the air-cooled condenser. For further information on fan energy calculations, see the
discussion regarding air-cooled condenser fan energy in the Engineering Reference.
Field: Rated Fan Power
This numeric field specifies the rated fan power (W) specified by the manufacturer, under
standard rating conditions. If this field is blank, the default value of 5000 W will be used
Field: Minimum Fan Air Flow Ratio
Fan controls often include a minimum air flow ratio to avoid overheating the fan motor or for
other reasons. This numeric field should be between 0. and 1. and has a default value of 0.2.
Field: Transition Temperature
This is the temperature (C) at which the gas cooler and the refrigeration system transitions
between subcritical and transcritical operation. If this field is blank, the default value of
27.0C will be used.

9/29/14

1239

Input-Output Reference

Group Refrigeration

Field: Transcritical Approach Temperature

This is the temperature difference (C) between the refrigerant (CO 2) exiting the gas cooler
and the air entering the gas cooler during transcritical operation. If this field is blank, the
default value of 3.0C will be used.
Field: Subcritical Temperature Difference
This is the temperature difference (C) between the condensing temperature and the ambient
air temperature during subcritical operation. If this field is blank, the default value of 10.0C
will be used.
Field: Minimum Condensing Temperature
This numeric field specifies the minimum condensing temperature (C) required to maintain
stable subcritical operation. If this field is blank, the default value of 10.0C will be used.
Field: Air Inlet Node Name
This optional alpha field contains the name of the node from which the gas cooler draws its
outdoor air. If this field is left blank, the outdoor air dry-bulb temperature entering the gas
cooler is taken directly from the weather data. If this field is not blank, this node name must
also be specified in an OutdoorAir:Node object where the height of the node is taken into
consideration when calculating outdoor air temperature from the weather data. Alternately,
the node name may be specified in an OutdoorAir:NodeList object where the outdoor air
temperature is taken directly from the weather data.
Field: End-Use Subcategory
This field allows the specification of a user-defined end-use subcategory (e.g., "Low
Temperature Rack"). A new meter for reporting is created for each unique subcategory (Ref.
Output:Meter objects). Subcategories are also reported in the ABUPS table. If this field is left
blank, the equipment will be assigned to the "General" end-use subcategory.
Field: Gas Cooler Refrigerant Operating Charge Inventory
This numeric field specifies the amount of refrigerant present within the gas cooler (kg)
specified by the manufacturer, under standard rating conditions. If this field is blank, the
default value of 0.0 kg will be used.
Field: Gas Cooler Receiver Refrigerant Inventory
This numeric field specifies the amount of refrigerant present within the gas cooler receiver
(kg) specified by the manufacturer or system designer, under standard rating conditions. If
this field is blank, the default value of 0.0 kg will be used.
Field: Gas Cooler Outlet Piping Refrigerant Inventory
This numeric field specifies the amount of refrigerant present within the gas cooling outlet
piping (kg) specified by the system designer, under standard rating conditions. If this field is
blank, the default value of 0.0 kg will be used.
The following is an example input for an air-cooled gas cooler.

9/29/14

1240

Input-Output Reference

Group Refrigeration

Refrigeration:GasCooler:AirCooled,
RefrigGasCooler,
!- Name
GasCoolerHRCurve,
!- Rated Total Heat Rejection Rate Curve Name
Fixed,
!- Gas Cooler Fan Speed Control Type
6400,
!- Rated Fan Power
0.2,
!- Minimum Fan Air Flow Ratio
27.0,
!- Transition Temperature
3.0,
!- Transcritical Approach Temperature
10.0,
!- Subcritical Temperature Difference
10.0,
!- Minimum Condensing Temperature
,
!- Air Inlet Node Name
RefrigGasCooler,
!- End-Use Subcategory
,
!- Gas Cooler Refrigerant Operating Charge Inventory
,
!- Gas Cooler Receiver Refrigerant Inventory
;
!- Gas Cooler Outlet Piping Refrigerant Inventory

Refrigeration GasCooler (AirCooled) Outputs

Zone,Average, Refrigeration Transcritical System
Rate [W]
Zone,Sum, Refrigeration Transcritical System Gas
[J]
Zone,Average, Refrigeration Transcritical System
Power [W]
Zone,Sum, Refrigeration Transcritical System Gas
[J]
Zone,Average, Refrigeration Transcritical System
Temperature [C]
Zone,Average, Refrigeration Transcritical System
[Pa]
Zone,Average, Refrigeration Transcritical System
Heat Transfer Rate [W]
Zone,Sum, Refrigeration Transcritical System Gas
Heat Transfer Energy [J]

Gas Cooler Heat Transfer

Cooler Heat Transfer Energy
Gas Cooler Fan Electric
Cooler Fan Electric Energy
Gas Cooler Outlet
Gas Cooler Outlet Pressure
Gas Cooler Defrost Recovered
Cooler Defrost Recovered

Refrigeration Transcritical System Gas Cooler Heat Transfer Rate [W]

This output is the total heat transfer rate from the gas cooler in Watts, and includes
compressor energy and the refrigeration load.
Refrigeration Transcritical System Gas Cooler Heat Transfer Energy [J]
This output is the total heat transferred from the gas cooler to the surroundings, in Joules, for
the timestep being reported.
Refrigeration Transcritical System Gas Cooler Fan Electric Power [W]
This output is the electric input to the systems gas cooler fan(s) in Watts.
Refrigeration Transcritical System Gas Cooler Fan Electric Energy [J]
This is the electricity consumption of the systems gas cooler fan(s) in Joules for the timestep
being reported. This output is also added to a meter with Resource Type = Electricity, End
Use Key = Refrigeration, Group Key = Plant (Ref. Output:Meter objects).
Refrigeration Transcritical System Gas Cooler Outlet Temperature [C]
This output is the temperature (in C) of the refrigerant exiting the gas cooler.
Refrigeration Transcritical System Gas Cooler Outlet Pressure [Pa]
This output is the pressure (in Pa) of the refrigerant exiting the gas cooler.

9/29/14

1241

Input-Output Reference

Group Refrigeration

Refrigeration Transcritical System Gas Cooler Defrost Recovered Heat Transfer Rate [W]
This is the total heat recovered from the gas cooler inlet flow for defrost purposes within the
refrigeration system.
Refrigeration Transcritical System Gas Cooler Defrost Recovered Heat Transfer Energy [J]
This is the total heat recovered from the gas cooler inlet flow for defrost purposes within the
refrigeration system for the timestep being reported.
Refrigeration:TransferLoadList
A refrigeration system may provide cooling to other, secondary, systems through either a
secondary loop or a cascade condenser (Ref. Refrigeration:SecondarySystem and
Refrigeration:Condenser:Cascade). If multiple transfer loads are served by a single primary
system, use this list to group them together for reference by the primary system (see the field
Refrigeration Transfer Load or TransferLoad List Name in the Refrigeration:System object).
Field: Name
A unique user-assigned name for an instance of a refrigeration transfer load list. Any
reference to this list by another object will use this name. In particular, the primary
refrigeration system absorbing the heat from all the loads listed here will use this name to
reference those loads.
Field: Cascade Condenser Name or Secondary System Name
Identifies a cascade condenser or secondary loop that is cooled, along with the other transfer
loads listed here, by a single system. The name will be validated against the
Refrigeration:SecondarySystem and Refrigeration:Condenser:Cascade names in the input
file (the name will also be compared against all the other condenser names, but an error will
be issued if it refers to any type of condenser other than a cascade condenser).
The list is extensible; ten fields are provided in the IDD.
The following is an example input for a transfer load list.
Refrigeration:TransferLoadList,
MedTempTransferLoads ,
!- Name
CascadeCondFrozen,
!- Cascade Condenser Name or Secondary System Name
SecondLoopDairy;
!- Cascade Condenser Name or Secondary System Name

Refrigeration:SecondarySystem
A refrigeration secondary system works in conjunction with refrigerated cases and walkins
(Ref. Refrigeration:SecondarySystem, Refrigeration:CaseAndWalkInList, Refrigeration:Case,
and Refrigeration:WalkIn) to simulate the performance of a secondary loop supermarket
refrigeration system. Heat from the refrigeration loads served by the secondary loop is
absorbed by a primary refrigeration system (ref: Refrigeration:System). The
SecondarySystem object simulates a heat exchanger that is an evaporator, or refrigeration
load, on the primary refrigeration system.
The inputs for the refrigeration secondary system object include a name, which is also
referenced to identify the load placed upon the primary refrigeration system. The inputs that
describe the loads placed upon the secondary loop include the name of a single refrigerated
case, the name of a single walk-in cooler, or a list of cases and walkin coolers. The
circulating fluid type specifies whether or not the secondary fluid remains in the liquid state
throughout the loop (e.g., a glycol or brine solution) or undergoes a partial phase change
while serving the refrigeration loads (e.g., a CO 2 liquid overfeed system). The circulating fluid
name must also be specified and must correspond to a name used to provide the fluid
properties.

9/29/14

1242

Input-Output Reference

Group Refrigeration

If the secondary fluid remains a liquid, the heat exchanger between the primary and
secondary systems functions as an evaporator on the primary side and chills the circulating
fluid on the secondary side. Inputs that describe the evaporator performance at rated
conditions are used to calculate the heat exchanger effectiveness. These values include the
rated evaporator capacity (which can be specified in terms of energy or fluid flow rate), the
rated evaporating temperature, the rated approach temperature difference, and the rated
range temperature difference.
If the secondary fluid undergoes a partial phase change, the heat exchanger between the
primary and secondary systems functions as an evaporator on the primary side and as a
condenser on the secondary side. The evaporator capacity, evaporating temperature, and
approach temperature difference, all at full-load design conditions, are input.
The balance of the secondary system object describes the pumping system. The pumping
options include a single constant speed pump, multiple constant speed pumps, or a variable
frequency-drive pump. The user can also keep track of distribution piping and receiver shell
heat gains.
Field: Name
A unique user-assigned name for an instance of a refrigeration secondary system. Any
reference to this refrigeration secondary system by another object will use this name. In
particular, the primary refrigeration system absorbing the heat from this system will use this
name to define that load.
Field: Refrigerated Case or WalkIn or CaseAndWalkInList Name
Identifies a single case, or walkin, or a particular list of refrigerated cases and walkins, that
are cooled by this refrigeration secondary system. The name will be validated against the
case, walkin, and CaseAndWalkInList names (ref. Refrigeration:Case, Refrigeration:WalkIn
and Refrigeration:CaseAndWalkInList) in the input file.
Field: Circulating Fluid Type
Specifies whether the fluid is always liquid (e.g., glycol solution), or undergoes a partial phase
change (e.g., CO2 liquid overfeed system). The options are FluidAlwaysLiquid and
FluidPhaseChange.
Field: Circulating Fluid Name
The name of the secondary circulating fluid.
For FluidAlwaysLiquid, this name must correspond to either an ethylene or propylene glycol
(ref:
FluidProperties:GlycolConcentration)
or
to
a
user-defined
glycol
(ref:
FluidProperties:Name and FluidProperties: GlycolConcentration) in the input file. Note that
the
corresponding
property
data,
including
FluidProperties:Concentration,
FluidProperties:Temperatures, and FluidProperties:GlycolConcentration must also be
included in the input file and are provided in GlycolPropertiesRefData.idf for typical ethylene
and propylene glycols.
For FluidPhaseChange, the refrigerant used by the secondary system must be listed in the
FluidProperties:Name object. The corresponding property data must also be supplied in the
input file. Property data for many refrigererants, including R11, R123, R134A, R12, R22,
R404A, R507A, R410A, and R744, are available in FluidPropertiesRefData.idf.
Field: Evaporator Capacity
For FluidAlwaysLiquid, this numeric field should be the rated heat evaporator capacity (W).
Be sure the rating corresponds to the correct refrigerant and secondary circulating fluid. If this
variable is specified and the rated evaporator flow rate for secondary fluid is not, then the flow
rate will be calculated. At least one of these two input variables is required.
For FluidPhaseChange, this numeric field should be the evaporator capacity (W) at full-load
design conditions. If this input is left blank, the capacity will be set to the sum of the
9/29/14

1243

Input-Output Reference

Group Refrigeration

capacities of the cases and walk-ins served by the secondary loop plus the pump motor load
at full-load design conditions.
Field: Evaporator Flow Rate for Secondary Fluid
For FluidAlwaysLiquid systems, this is the rated evaporator secondary fluid flow rate in
m3/s. If this variable is specified and the rated evaporator capacity in watts is not, then the
rated capacity will be calculated. At least one of these two input variables is required.
For FluidPhaseChange, this field is not used (see Phase Cange Circulating Rate).
Field:Evaporator Evaporating Temperature
This numeric field provides the evaporating temperature (C) corresponding to the evaporator
capacity. This is the evaporating temperature on the primary side of the heat exchanger used
to chill or condense the secondary loop circulating fluid. It is NOT the temperature in any
cases or walkins served by the secondary loop.
Field: Evaporator Approach Temperature Difference
For FluidAlwaysLiquid, this numeric field is the rated temperature difference (DeltaC)
between the circulating secondary fluid leaving the heat exchanger and the heat exchangers
evaporating temperature.
For FluidPhaseChange, this is the temperature difference (DeltaC) between the primary
refrigerant evaporating and secondary refrigerant condensing temperatures at full-load
design conditions.
Field: Evaporator Range Temperature Difference
For FluidAlwaysLiquid, this numeric field is the rated temperature difference (DeltaC)
between the circulating secondary fluid entering and leaving the heat exchanger. This value
is not used for FluidPhaseChange.
Field: Number of Pumps in Loop
This numeric field provides the integer number of pumps used to circulate the secondary heat
transfer fluid. The default value is 1. Unless a variable speed pump is specified, pump energy
will be calculated in linear steps to achieve the necessary flow rate.
Field: Total Pump Flow Rate
This is the secondary fluid circulating flow rate in m3/s at full-load design conditions. For
FluidAlwaysLiquid, if no value is input, the Evaporator Flow Rate for Secondary Fluid will be
used. For FluidPhaseChange, if no value is input, the flow rate will be calculated using the
Evaporator Capacity and the PhaseChange Circulating Rate.
Field: Total Pump Power
This numeric field should be the pump power (W) at full-load design conditions. Be sure the
rating corresponds to the correct secondary circulating fluid at the design fluid temperature.
EITHER the Total Pump Power OR the Total Pump Head is required.
Field: Total Pump Head
This numeric field should be the design pressure drop, or head, across the secondary loop
(Pa) at full load design conditions. Be sure the rating corresponds to the correct secondary
circulating fluid at the design fluid temperature. EITHER the Total Pump Power OR the Total
Head is required.
Field: PhaseChange Circulating Rate
This field is not used for FluidAlwaysLiquid.
For FluidPhaseChange, the Circulating Rate is defined as the total mass flow at the pump
divided by the mass flow rate of vapor returning to the separator. Values between 2.1 and 3
9/29/14

1244

Input-Output Reference

Group Refrigeration

are common for CO2 systems and the default is 2.5. If Total Pump Flow Rate is also defined,
the PhaseChange Circulating Rate will only be used to check whether the two values are
consistent.
Field: Pump Drive Type
Specifies whether the pump(s) is constant speed or variable speed. The options are
Constant and Variable. The default is Constant.
Field: Variable Speed Pump Cubic Curve Name
The name of a cubic performance curve (ref: Performance Curves) that parameterizes the
variation of the variable speed pump power (and the associated load on the secondary
refrigeration load) at off-rated conditions. The curve should be normalized to have the value
of 1.0 at full-load design conditions. The variable speed pump cubic curve name is used only
for the a pump drive type of Variable.
Field: Pump Motor Heat to Fluid
This choice field determines how much of the pump motor heat will be added to the
circulating secondary fluid. This represents the motor efficiency for a non-hermetic motor.
The default is 0.85. For a semi-hermetic motor, enter 1.0. The value entered must be
between 0.5 and 1.0.
Field: Sum UA Distribution Piping
This optional field is typically used when trying to compare the impact of pipe heat gains on
system performance, particularly in comparing a DX system to a secondary system. Enter the
value for secondary loop distribution piping heat gain (in W/C). That is, sum up the product of
the pipe insulation conductance times the outer piping insulation surface area. Please see the
Engineering Reference for guidance in calculating this value.
Field: Distribution Piping Zone Name
This optional field is used when trying to determine the impact of pipe heat gains on system
performance, particularly in comparing a DX system to a secondary system. (If the previous
field, Sum UA Distribution Piping, is blank, this field will not be used.) Enter the name of the
zone where the Distribution piping is located. The distribution piping heat gains will be
calculated based upon the air temperature within this zone and will count as a cooling credit
for this zone.
Field: Sum UA Receiver/Separator Shell
This optional field is typically used when trying to compare the impact of refrigeration
component heat gains on system performance, particularly in comparing a conventional
primary DX system to a secondary system. Enter the value for receiver/separator heat gain
(in W/C). That is, sum up the product of the tank insulaton conductance times the outer tank
insulation surface area. Please see the Engineering Reference for guidance in calculating
this value.
Field: Receiver/Separator Zone Name
This optional field is used when trying to determine the impact of refrigeration component
heat gains on system performance, particularly in comparing a conventional primary DX
system to a secondary system. (If the previous field, Sum UA Receiver/Separator, is blank,
this field will not be used.) Enter the name of the zone where the receiver/separator is
located. The heat gains will be calculated based upon the air temperature within this zone
and will count as a cooling credit for this zone.

9/29/14

1245

Input-Output Reference

Group Refrigeration

Field: Evaporator Refrigerant Inventory

The secondary loop is chilled by a primary system via a heat exchanger. This field is the
refrigerant inventory on the cold (primary) side of that heat exchanger, in kg. The default
value is zero.
Field: End-Use Subcategory
This field allows the specification of a user-defined end-use subcategory (e.g., "Low
Temperature Rack"). A new meter for reporting is created for each unique subcategory (Ref:
Output:Meter objects). Subcategories are also reported in the ABUPS table. If this field is left
blank, the equipment will be assigned to the "General" end-use subcategory.

The following is an example input for a brine-type (FluidAlwaysLiquid)refrigeration

secondary system.
Refrigeration:SecondarySystem,
SecondaryMedLoop,
!- Name
MedTempCaseList,
!- Refrigerated Case or Walkin or CaseAndWalkInList Name
FluidAlwaysLiquid,
!- Circulating Fluid Type
ProGly30Percent,
!- Circulating Fluid Name
3.5E4,
!- Evaporator Capacity {W}
0.0021,
!- Evaporator Flow Rate for Secondary Fluid {M3/s}
-12.6,
!- Evaporator Evaporating Temperature {C}
2.7,
!- Evaporator Approach Temperature Difference {DeltaC}
4.,
!- Evaporator Range Temperature Difference {DeltaC}
3,
!- Number of Pumps in Loop
.0023,
!- Total Pump Flow Rate {M3/s}
,
!- Total Pump Power {W}
2.09E5,
!- Total Pump Head {Pa}
,
!- PhaseChange Circulating Rate
,
!- Pump Drive Type
,
!- Variable Speed Pump Cubic Curve Name
1.0,
!- Pump Motor Heat to Fluid
21.,
!- Sum UA Distribution Piping {W/C}
SalesFloor,
!- Distribution Piping Zone Name
,
!- Sum UA Receiver/Separator Shell
,
!- Receiver/Separator Zone Name
,
!- Evaporator Refrigerant Inventory {kg}
;
!- End-Use Subcategory

The following is an example input for a liquid-overfeed-type (FluidPhaseChange)

refrigeration secondary system.

9/29/14

1246

Input-Output Reference

Group Refrigeration

Refrigeration:SecondarySystem,
SecondaryLowLoop,
!- Name
LowTempCaseList,
!- Refrigerated Case or Walkin or CaseAndWalkInList Name
FluidPhaseChange,
!- Circulating Fluid Type
R744,
!- Circulating Fluid Name
,
!- Evaporator Capacity {W}
,
!- Evaporator Flow Rate for Secondary Fluid {M3/s}
-39.2,
!- Evaporator Evaporating Temperature {C}
2.,
!- Evaporator Approach Temperature Difference {DeltaC}
,
!- Evaporator Range Temperature Difference {DeltaC}
3,
!- Number of Pumps in Loop
,
!- Total Pump Flow Rate {M3/s}
,
!- Total Pump Power {W}
2.09E5,
!- Total Pump Head {Pa}
2.5,
!- PhaseChange Circulating Rate
Variable,
!- Pump Drive Type
SecondaryVarSpeedPump,
!- Variable Speed Pump Cubic Curve Name
1.0,
!- Pump Motor Heat to Fluid
10.4,
!- Sum UA Distribution Piping {W/C}
SalesFloor,
!- Distribution Piping Zone Name
1.4,
!- Sum UA Receiver/Separator Shell
BackRoom,
!- Receiver/Separator Zone Name
,
!- Evaporator Refrigerant Inventory {kg}
;
!- End-Use Subcategory

Refrigeration Secondary System Outputs

FOR SECONDARY SYSTEMS SERVING CASES AND/OR WALKINS:
Zone,Average,Refrigeration Secondary Loop Pump Electric Power [W]
Zone,Sum,Refrigeration Secondary Loop Pump Electric Energy [J]
Zone,Average,Refrigeration Secondary Loop Load Heat Transfer Rate [W]
Zone,Sum,Refrigeration Secondary Loop Load Heat Transfer Energy [J]
Zone,Average,Refrigeration Secondary Loop Total Heat Transfer Rate [W]
Zone,Sum,Refrigeration Secondary Loop Total Heat Transfer Energy [J]
Zone,Average,Refrigeration Secondary Loop Estimated Refrigerant Inventory
Mass[kg] Zone,Average,Refrigeration Secondary Loop Volume Flow Rate [m3/s]
Zone,Average,Refrigeration Secondary Loop Pipe Heat Gain Rate [W]
Zone,Average,Refrigeration Secondary Loop Pipe Heat Gain Energy [J]
Zone,Average,Refrigeration Secondary Loop Receiver Heat Gain Rate [W]
Zone,Average,Refrigeration Secondary Loop Receiver Heat Gain Energy [J]
FOR SECONDARY SYSTEMS SERVING AIR CHILLERS:
HVAC,Average,Refrigeration Air Chiller Secondary Loop Pump Electric Power [W]
HVAC,Sum,Refrigeration Air Chiller Secondary Loop Pump Electric Energy [J]
HVAC,Average,Refrigeration Air Chiller Secondary Loop Load Heat Transfer Rate
[W]
HVAC,Sum,Refrigeration Air Chiller Secondary Loop Load Heat Transfer Energy
[J]
HVAC,Average,Refrigeration Air Chiller Secondary Loop Total Heat Transfer
Rate [W]
HVAC,Sum,Refrigeration Air Chiller Secondary Loop Total Heat Transfer Energy
[J]
HVAC,Average,Refrigeration Air Chiller Secondary Loop Estimated Refrigerant
Inventory Mass[kg]
HVAC,Average,Refrigeration Air Chiller Secondary Loop Volume Flow Rate [m3/s]
HVAC,Average,Refrigeration Air Chiller Secondary Loop Pipe Heat Gain Rate [W]
HVAC,Average,Refrigeration Air Chiller Secondary Loop Pipe Heat Gain Energy
[J]
HVAC,Average,Refrigeration Air Chiller Secondary Loop Receiver Heat Gain Rate
[W]
HVAC,Average,Refrigeration Air Chiller Secondary Loop Receiver Heat Gain
Energy [J]

9/29/14

1247

Input-Output Reference

Group Refrigeration

FOR SECONDARY SYSTEMS SERVING CASES AND/OR WALKINS:

Refrigeration Secondary Loop Pump Electric Power [W]
This output is the total electric power input to the pump(s) in Watts.
Refrigeration Secondary Loop Pump Electric Energy [J]
This is the electricity consumption of the systems pump(s) in Joules for the timestep being
reported. This output is also added to a meter with Resource Type = Electricity, End Use Key
= Refrigeration, Group Key = Plant (Ref. Output:Meter objects).
Refrigeration Secondary Loop Load Heat Transfer Rate [W]
This is the amount of refrigeration provided to the cases and walkins served by the secondary
loop in W.
Refrigeration Secondary Loop Load Heat Transfer Energy [J]
This is the amount of refrigeration provided to the cases and walkins served by the secondary
loop in Joules for the timestep being reported.
Refrigeration Secondary Loop Total Heat Transfer Rate [W]
This is the total amount of refrigeration load placed upon the primary refrigeration system
(including loads due to the cases and walkins plus the loads from the secondary loop pumps
and any energy absorbed by the loop via pipe heat gains) in W.
Refrigeration Secondary Loop Total Heat Transfer Energy [J]
This is the total amount of energy placed upon the primary refrigeration system by the
secondary loop in Joules for the timestep being reported.
Refrigeration Secondary Loop Estimated Refrigerant Inventory Mass [kg]
This output is the sum of the input inventory values for the cases and walkins and the
refrigerant circulating through the loop.
Refrigeration Secondary Loop Volume Flow Rate [m3/]s
This output is the calculated volume flow through the pumps for this secondary loop.
Refrigeration Secondary Loop Pipe Heat Gain Rate [W]
This output is the total heat transferred to the pipes in Watts.
Refrigeration Secondary Loop Pipe Heat Gain Energy [J]
This is the total heat transferred to the pipes in Joules for the timestep being reported.
Refrigeration Secondary Loop Receiver Heat Gain Rate [W]
This output is the total heat transferred to the receiver in Watts.
Refrigeration Secondary Loop Receiver Heat Gain Energy [J]
This is the total heat transferred to the receiver in Joules for the timestep being reported.
FOR SECONDARY SYSTEMS SERVING AIR CHILLERS:
Refrigeration Air Chiller Secondary Loop Pump Electric Power [W]
This output is the total electric power input to the pump(s) in Watts.
Refrigeration Air Chiller Secondary Loop Pump Electric Energy [J]
This is the electricity consumption of the systems pump(s) in Joules for the timestep being
reported. This output is also added to a meter with Resource Type = Electricity, End Use Key
= Refrigeration, Group Key = Plant (Ref. Output:Meter objects).
9/29/14

1248

Input-Output Reference

Group Refrigeration

Refrigeration Air Chiller Secondary Loop Load Heat Transfer Rate [W]
This is the amount of refrigeration provided to the air chillers served by the secondary loop in
W.
Refrigeration Air Chiller Secondary Loop Load Heat Transfer Energy [J]
This is the amount of refrigeration provided to the air chillers served by the secondary loop in
Joules for the timestep being reported.
Refrigeration Air Chiller Secondary Loop Total Heat Transfer Rate [W]
This is the total amount of refrigeration load placed upon the primary refrigeration system
(including loads due to the air chillers plus the loads from the secondary loop pumps and any
energy absorbed by the loop via pipe heat gains) in W.
Refrigeration Air Chiller Secondary Loop Total Heat Transfer Energy [J]
This is the total amount of energy placed upon the primary refrigeration system by the
secondary loop in Joules for the timestep being reported.
Refrigeration Air Chiller Secondary Loop Estimated Refrigerant Inventory Mass [kg]
This output is the sum of the input inventory values for the air chillers and the refrigerant
circulating through the loop.
Refrigeration Air Chiller Secondary Loop Volume Flow Rate [m3/]s
This output is the calculated volume flow of coolant through the pumps for this secondary
loop.
Refrigeration Air Chiller Secondary Loop Pipe Heat Gain Rate [W]
This output is the total heat transferred to the pipes in Watts.
Refrigeration Air Chiller Secondary Loop Pipe Heat Gain Energy [J]
This is the total heat transferred to the pipes in Joules for the timestep being reported.
Refrigeration Air Chiller Secondary Loop Receiver Heat Gain Rate [W]
This output is the total heat transferred to the receiver in Watts.
Refrigeration Air Chiller Secondary Loop Receiver Heat Gain Energy [J]
This is the total heat transferred to the receiver in Joules for the timestep being reported.
Additional Refrigeration Outputs Available for Each Zone
Multiple refrigeration cases and walkins may be located within a single zone. Each zone may
also exchange heat with refrigeration system suction piping, secondary loop distribution
piping, and secondary loop receivers. Output variables have been prepared to sum up the
total heat exchange due to all refrigeration objects within a single zone. The output variables
that start with Zone Refrigeration do not account for refrigeration provided by refrigeration
chiller sets or any piping from systems serving air chillers. The output variables that start with
Zone Chillers account for all the refrigeration system elements serving air chillers.
Additional Refrigeration Outputs for Each Zone
FOR THE SUM OF ALL COOLING SYSTEMS SERVING CASES AND/OR WALKINS:
Zone,Average, Refrigeration Zone Case and Walk In Sensible Cooling Rate [W]
Zone,Sum, Refrigeration Zone Case and Walk In Sensible Cooling Energy [J]
Zone,Average, Refrigeration Zone Case and Walk In Heating Rate [W]
Zone,Sum, Refrigeration Zone Case and Walk In Heating Energy [J]
Zone,Average, Refrigeration Zone Case and Walk In Total Sensible Cooling Rate
[W]

9/29/14

1249

Input-Output Reference

Group Refrigeration

Zone,Sum, Refrigeration Zone Case and Walk In Total Sensible Cooling Energy
[J]
Zone,Average, Refrigeration Zone Case and Walk In Total Latent Cooling Rate
[W]
Zone,Sum, Refrigeration Zone Case and Walk In Total Latent Cooling Energy [J]
Zone,Sum, Refrigeration Zone Case and Walk In Total Cooling Energy [J]
Zone,Average,Refrigeration Zone Case and Walk In Total Cooling Rate [W]
Zone,Average, Refrigeration Zone Case and Walk In Total Heat Transfer Rate
[W]
Zone,Sum, Refrigeration Zone Case and Walk In Total Heat Transfer Energy [J]
FOR THE SUM OF ALL
HVAC,Average,
Refrigeration Zone
[W]
HVAC,Sum,
Refrigeration Zone
[J]
HVAC,Average,
Refrigeration Zone
[W]
HVAC,Sum,
Refrigeration Zone
[J]
HVAC,Average,
Refrigeration Zone
[W]
HVAC,Sum,
Refrigeration Zone
[J]

COOLING SYSTEMS SERVING CHILLERS:

Air Chiller Sensible Heat Transfer Rate
Air Chiller Sensible Heat Transfer Energy
Air Chiller Latent Cooling Rate
Air Chiller Latent Cooling Energy
Air Chiller Total Cooling Rate
Air Chiller Total Cooling Energy

FOR THE SUM OF ALL COOLING SYSTEMS SERVING CASES AND/OR WALKINS:
Refrigeration Zone Case and Walk In Total Sensible Cooling Rate [W]
This output is the total sensible heat transfer between all refrigeration objects located in the
zone in Watts. A negative value will be reported when the refrigeration objects cool (that is,
remove heat from) the zone.
Refrigeration Zone Case and Walk In Total Sensible Cooling Energy [J]
This is the total sensible heat transfer between all refrigeration objects located in the zone in
Joules for for the timestep being reported. A negative value will be reported when the
refrigeration objects cool (that is, remove heat from) the zone.
Refrigeration Zone Case and Walk In Total Latent Cooling Rate [W]
This output is the total latent heat transfer between all refrigeration objects located in the
zone in Watts. A negative value will be reported when the refrigeration equipment provides
dehumidification (thereby reducing the zone latent load).
Refrigeration Zone Case and Walk In Total Latent Cooling Energy [J]
This is the total latent heat transfer between all refrigeration objects located in the zone in
Joules for for the timestep being reported. A negative value will be reported when the
refrigeration equipment provides dehumidification (thereby reducing the zone latent load).
Refrigeration Zone Case and Walk In Total Heat Transfer Rate [W]
This output is the total heat transfer (sensible plus latent) between all refrigeration objects
located in the zone in Watts. A negative value will be reported when the refrigeration objects
cool (that is, remove heat from) the zone.
Refrigeration Zone Case and Walk In Total Heat Transfer Energy [J]

9/29/14

1250

Input-Output Reference

Group Refrigeration

This is the total heat transfer (sensible plus latent) between all refrigeration objects located in
the zone in Joules for for the timestep being reported. A negative value will be reported when
the refrigeration objects cool (that is, remove heat from) the zone.
Refrigeration Zone Case and Walk In Sensible Cooling Rate [W]
This output is the total sensible cooling from all refrigeration objects located in the zone in
Watts.
Refrigeration Zone Case and Walk In Sensible Cooling Energy [J]
This is the total sensible cooling from all refrigeration objects located in the zone in Joules for
for the timestep being reported.
Refrigeration Zone Case and Walk In Heating Rate [W]
This output is the total heating from all refrigeration objects located in the zone in Watts.
Refrigeration Zone Case and Walk In Heating Energy [J]
This is the total heating from all refrigeration objects located in the zone in Joules for for the
timestep being reported.
Refrigeration Zone Case and Walk In Total Cooling Rate [W]
This output is the total cooling (sensible plus latent) from all refrigeration objects located in
the zone in Watts.
Refrigeration Zone Case and Walk In Total Cooling Energy [J]
This is the total cooling (sensible plus latent) from all refrigeration objects located in the zone
in Joules for for the timestep being reported.
FOR THE SUM OF ALL COOLING SYSTEMS SERVING AIR CHILLERS:
Refrigeration Zone Air Chiller Heating Rate [W]
This output is the total heating from all air chillers located in the zone in Watts.
Refrigeration Zone Air Chiller Heating Energy [J]
This is the total heating from all air chillers located in the zone in Joules for for the timestep
being reported.
Refrigeration Zone Air Chiller Sensible Cooling Rate [W]
This output is the total sensible cooling from all air chillers located in the zone in Watts.
Refrigeration Zone Air Chiller Sensible Cooling Energy [J]
This is the total sensible cooling from all air chillers located in the zone in Joules for for the
timestep being reported.
Refrigeration Zone Air Chiller Sensible Heat Transfer Rate [W]
This output is the total sensible heat transfer from all air chillers located in the zone in Watts.
A negative value will be reported when the refrigeration objects cool (that is, remove heat
from) the zone.
Refrigeration Zone Air Chiller Sensible Heat Transfer Energy [J]
This is the total sensible heat transfer from all air chillers located in the zone in Joules for for
the timestep being reported. A negative value will be reported when the refrigeration objects
cool (that is, remove heat from) the zone.
Refrigeration Zone Air Chiller Latent Cooling Rate [W]
This output is the total latent cooling from all air chillers located in the zone in Watts.
Refrigeration Zone Air Chiller Latent Cooling Energy [J]

9/29/14

1251

Input-Output Reference

Group Refrigeration

This is the total latent cooling from all air chillers located in the zone in Joules for for the
timestep being reported.
Refrigeration Zone Air Chiller Water Removed Mass Flow Rate [kg/s]
This is the total amount of water removed by all air chillers located in the zone in kg/s for for
the timestep being reported.
Refrigeration Zone Air Chiller Total Cooling Rate [W]
This output is the total cooling (sensible plus latent) from all air chillers located in the zone in
Watts.
Refrigeration Zone Air Chiller Total Cooling Energy [J]
This is the total cooling (sensible plus latent) from all air chillers located in the zone in Joules
for for the timestep being reported.
Refrigeration:AirChiller
The Refrigeration:AirChiller object works in conjunction with a refrigeration chiller set,
compressor rack, a refrigeration system, or a refrigeration secondary system object (Ref.
ZoneHvac:RefrigerationChillerSet,
and
a
Refrigeration:CompressorRack,
Refrigeration:System, or Refrigeration:SecondarySystem) to simulate the performance of an
air chiller, similar to one found in a refrigerated warehouse. The air chiller model uses
information at rated conditions along with the zone conditions to determine performance.
Energy use for fans and heaters is modeled based on inputs for nominal power, schedules,
and control type. The refrigeration chiller model accounts for the sensible and latent heat
exchange with the surrounding environment.
The refrigeration chiller cooler object inputs include a name, an availability schedule name,
the rated cooling capacity, the rated operating temperature, the rated cooling source
temperature, the rated total heating power and heating power schedule, the rated fan power
and schedules, defrost type, defrost control type, defrost schedule name, drip-down schedule
name, defrost power, the portion of the defrost energy used to melt ice (only for temperature
termination control type), and refrigerant inventory.
Chiller coils are rated under multiple conventions. Each rating is typically based upon a
selected fin material and refrigerant cycle, with correction factors for other materials or
refrigerants. Fields are provided here for those correction factors. The performance of all
chiller coils depends upon the inlet air temperature, relative humidity, and flow rate. Multiple
methods of expressing this relationship are provided here to accommodate the way
information is provided by different manufacturers.
Field: Name
A unique user-assigned name for an instance of a refrigeration chiller. Any reference to this
refrigeration chiller by another object will use this name.
Field: Availability Schedule Name
The name of the schedule (ref: Schedule) that denotes whether the refrigeration chiller can
operate during a given time period. A schedule value greater than 0 (maximum schedule
value of 1.0 is typically used) indicates that the refrigeration chiller will operate during a given
time period. A value equal to 0 denotes that the case does not operate (everything is OFF:
refrigeration, fans, lights, anti-sweat, etc.). Typically the refrigeration chiller will operate
throughout the day (i.e., the schedule will contain 1 for all time periods); however,
refrigeration chillers require maintenance and/or cleaning and this can be modeled
accordingly using this schedule if desired. If this field is left blank, the default schedule has a
value of 1 for all time periods.

9/29/14

1252

Input-Output Reference

Group Refrigeration

Field: Capacity Rating Type

The type of capacity rating used for this refrigeration chiller. Valid choices are
UnitLoadFactorSensibleOnly,
CapacityTotalSpecificConditions,
EuropeanSC1Standard,
EuropeanSC1NominalWet,
EuropeanSC2Standard,
EuropeanSC2NominalWet,
EuropeanSC3Standard,
EuropeanSC3NominalWet,
EuropeanSC4Standard,
EuropeanSC4NominalWet, EuropeanSC5Standard, and EuropeanSC5NominalWet. In each
case, select the rating option that corresponds to the expected service conditions. For
example, U.S. manufacturers quote a separate Unit Load Factor for wet or frosted coils. If
the evaporating temperature is less than 0C, input the frosted coil value. Within the European
convention, select SC1, 2, 3, 4, or 5 depending upon the expected evaporating temperature.
This field is required and there is no default value. Refer to the Engineering Reference for
further information on these rating types. NOTE: If the CapacityTotalSpecificConditions rating
type is specified, the input file must include the manufacturers coil capacity correction curve
in tabular form using the Table:MultiVariableLookup object. An example of this may be found
in the RefrigeratedWarehouse.idf example file.
NOTE ONLY ONE OF THE FOLLOWING TWO FIELDS IS USED
Field: Rated Unit Load Factor
The sensible cooling capacity in watts (W/C) at rated conditions. The value entered for this
field must be greater than zero, with no default value. This value is only used if the Capacity
Rating Type is UnitLoadFactorSensibleOnly. The value given must be based upon the
difference between the chiller inlet and outlet air temperatures, not on the difference between
the zone mean temperature and the outlet air temperature.
Field: Rated Capacity
The cooling capacity in watts (W) at rated conditions. The value entered for this field must be
greater than zero, with no default value. This field is only used if the Capacity Rating Type is
CapacityTotalSpecificConditions,
EuropeanSC1Standard,
EuropeanSC1NominalWet,
EuropeanSC2Standard,
EuropeanSC2NominalWet,
EuropeanSC3Standard,
EuropeanSC3NominalWet,
EuropeanSC4Standard,
EuropeanSC4NominalWet,
EuropeanSC5Standard, or EuropeanSC5NominalWet. For CapacityTotalSpecificConditions,
this capacity includes both sensible and latent at the conditions given in the next two fields.
Note that the European Standard ratings are sensible only and the European Nominal ratings
include latent capacity as well. The value given here must correspond to the capacity rating
type given previously.
Field: Rated Relative Humidity
This field is ONLY used if the Capacity Rating Type is CapacityTotalSpecificConditions and
represents the relative humidity at rated conditions, expressed as a percent. The default is
85.
Field: Rated Cooling Source Temperature
For a DX evaporator coil, enter the saturated evaporating temperature in C. For a fluid coil,
enter the fluid coil entrance temperature in C. There is no default value. This number is
used, with temperatures for other refrigeration loads on any one system, to set that systems
minimum suction pressure or minimum circulating fluid temperature.
Field: Rated Temperature Difference DT1
The rated difference between the air entering the refrigeration chiller and the cooling source
temperature in C. The entered value for this field must be less than 20C. There is no default
value.

9/29/14

1253

Input-Output Reference

Group Refrigeration

Field: Maximum Difference Between Inlet Air and Evaporating Temperature

The maximum difference between the air entering the refrigeration chiller and the cooling
source temperature in C used to limit capacity during pull-down. The default is 1.3 times the
Rated Temperature Difference DT1.
Field: Coil Material Correction Factor
This field is used to enter the manufacturers correction factor for coil material corresponding
to the rating previously input. The default is 1.0 (dimensionless).
Field: Refrigerant Correction Factor
This field is used to enter the manufacturers correction factor for refrigerant corresponding to
the rating previously input. The default is 1.0 (dimensionless). (Note, the refrigerant itself is
specified for the detailed system or secondary loop providing the refrigerant to this coil.)
Field: Capacity Correction Curve Type
The type of capacity correction curve used to account for the impact of the room air
conditions on the chiller capacity. Valid choices are LinearSHR60, QuadraticSHR, European,
and TabularRHxDT1xTRoom. This field will default to LinearSHR60, unless the
CapacityTotalSpecificConditions rating type is specified, in which case, the
TabularRHxDT1xTRoom correction curve type must be used. Refer to the Engineering
Reference for further information on these curve types. The resulting correction factor for
LinearSHR60, QuadraticSHR, and European types will be applied to the sensible capacity
and must have output values between 1 and 2. The resulting correction factor for
TabularRHxDT1xTRoom will be applied to the CapacityTotalSpecificConditions capacity and
can have values between 0.2 and 2. If TabularRHxDT1xTRoom is used, the curve type within
the table must be specified as Quadratic.
Field: Capacity Correction Curve Name
The name of the curve object defining the total refrigerating capacity. For correction curve
types LinearSHR60 and QuadraticSHR, the independent variable is the Sensible Heat Ratio
and the output values are between 1.0 and 2.0. For correction curve type European,
EnergyPlus contains built-in capacity correction curves and specification of a capacity
correction curve name is not required. For correction curve type TabularRHxDT1xTRoom,
enter the name of a Table:MultiVariableLookup object that gives the total capacity (in W) as a
function of RH, DT1, and Room Temperature; IN THAT ORDER. An example of a
TabularRHxDT1xTRoom correction curve using the Table:MultiVariableLoopkup object may
be found in the RefrigeratedWarehouse.idf example file.
Field: SHR60 Correction Factor
This field is only used when the capacity correction curve type is LinearSHR60. It should
correspond to the capacity factor, that is, the total capacity divided by the sensible capacity
corresponding to a Sensible Heat Ratio of 0.6. The default is 1.48 (dimensionless).
Field: Rated Total Heating Power
The total heating power in watts including drip-pan and any other heaters (W). This value is
required and has no default value.
Field: Heating Power Schedule Name
The name of the schedule (ref: Schedule) that denotes the fraction of heater power that
operates during a given time period. A schedule value of zero denotes that all heaters are off.
A schedule value greater than 0 indicates that some portion of the total heater power will
operate during that time period (maximum schedule value of 1.0 means all heaters are fully
on). If this field is left blank, the default schedule has a value of 1 for all time periods.

9/29/14

1254

Input-Output Reference

Group Refrigeration

Field: Fan Speed Control Type

The type of fan speed control used by the cooling coils fan(s). Valid choices are Fixed,
FixedLinear, VariableSpeed, and TwoSpeed. If the field is blank, Fixed will be used. See
the Engineering Reference for a discussion of this options effect on fan energy consumption.
Field: Rated Fan Power
The cooling coil fan power in watts (W). This value has a default value of 375W. This fan is
assumed to run continuously except during electric, hot brine, or hot gas defrost periods.
Field: Rated Air Flow
The cooling coil fan rated air flow in cubic meters per second (m 3/s). This value has no
default value and must be input.
Field: Minimum Fan Air Flow Ratio
The minimum fraction of the rated air flow for part-load fan operation, must be between 0.
and 1.0. The default value is 0.2.
Field: Defrost Type
The type of defrost used for this refrigeration chiller. Valid choices are None, Off-Cycle,
HotFluid, and Electric. The default defrost type is Electric if the field is blank. HotFluid
includes both hot gas and hot brine defrost systems. Refer to the Engineering Reference for
further information on how the different defrost types are modeled.
Field: Defrost Control Type
The type of defrost control used for this refrigeration chiller. Valid choices are TimeSchedule
and TemperatureTermination. The default is TimeSchedule if the field is blank. Refer to the
Engineering Reference for further information on how the different defrost controls are
modeled.
Field: Defrost Schedule Name
The name of the schedule (ref: Schedule) that denotes when the refrigeration chiller requires
defrosting. A schedule value of 1.0 indicates that defrost can be on during a given time
period. A value equal to 0 denotes that the defrost is off. Defrost schedules normally repeat
the duration and number of defrost cycles for each day of the year. The refrigeration chiller
manufacturer typically provides this information with the product literature. If
TemperatureTermination control type is used, the defrost schedule is used for the defrost
cycle start time and the defrost cycle end time is not allowed to extend beyond the scheduled
off time. The use of Compact Schedules (ref. Schedules) are ideal for this purpose.
Field: Defrost Drip-Down Schedule Name
The name of the schedule (ref: Schedule) that denotes whether the refrigeration chiller
requires additional time for draining condensate after the defrost period. A schedule value of
1.0 indicates that the defrost drip-down period is on during a given time period. A value equal
to 0 denotes that the defrost drip-down period is over. The refrigeration chiller manufacturer
typically provides this information with the product literature.
Each defrost drip-down period specified in this schedule should start at the same time as the
corresponding defrost period specified in the schedule for Defrost Schedule, and the dripdown schedule defrost period should always be longer than or equal to the length of the
defrost schedule time period. For example, if the defrost schedule contains a defrost period
from 7:00 to 7:15, you would specify a case defrost drip-down period from 7:00 to 7:20 if you
wanted to model a 5 minute condensate drip-down period after the regular defrost period. If
no drip-down schedule is entered, then the defrost schedule (specified for the previous input
field) will be used. The use of Compact Schedules (ref. Schedules) are ideal for this purpose.

9/29/14

1255

Input-Output Reference

Group Refrigeration

Field: Defrost Power

The defrost power in watts. This input is required for hot-fluid (hot gas or hot brine), or electric
defrost types. Refrigeration chiller manufacturers do not typically provide information on the
heat input for hot gas and hot brine defrost. Information provided for electric defrost power
can be substituted here for refrigeration chillers using hot-gas or hot-brine defrost if other
information is not available. Only electric Defrost Types consume electricity during the defrost
period. The entered value for this field must be greater than or equal to zero.
Field: Temperature Termination Defrost Fraction to Ice
When cooling coils go through a defrost cycle, only a portion of the defrost energy is actually
used to melt the ice. The rest of the defrost energy goes to increasing the temperature of the
coils themselves and to the refrigeration chiller environment. The Temperature Termination
defrost control type calculates the end of the defrost cycle that corresponds to melting all the
ice. Therefore, the user must input this fractional value. The default value is 0.7 for electric
defrost and 0.3 for hot fluid defrost. Refer to the Engineering Reference for further information
on how the defrost energy control types are modeled.
Field: Vertical Location
The vertical location for this refrigeration chiller. Valid choices are Floor, Middle, and Ceiling.
The default is Middle if the field is blank. The vertical location is used to transform the mixed
zone air temperature to the coil inlet air temperature. Refer to the Engineering Reference for
further information on how the different vertical locations are modeled.
Field: Average Refrigerant Charge Inventory
The value of this optional field is the refrigerant inventory present in the refrigeration chiller
during ordinary operation. The value is used to produce an estimate of the total refrigerant
present in the refrigeration system. The value is entered in kg.
The following is an example input for a refrigeration air chiller.
Refrigeration:AirChiller,
Freezer_1AirChiller_1,
!- Name
AvailAllYear,
!- Availability Schedule Name
UnitLoadFactorSensibleOnly, !- Capacity Rating Type
10900.,
!- Rated Unit Load Factor {W/deltaC}
,
!- Rated Capacity {W}
,
!- Rated Relative Humidity
-26.,
!- Rated Cooling Source Temperature {C}
8.,
!- Rated Temperature Difference DT1 {DeltaC}
11.,
!- Maximum Temperature Difference DT1 {DeltaC}
,
!- Material Correction Factor
,
!- Refrigerant Correction Factor
LinearSHR60,
!- Capacity Correction Curve Type
,
!- Capacity Correction Curve Name
1.5,
!- SHR60 Correction Factor {dimensionless}
200.,
!- Rated Total Heating Power {W}
AirChillerDripDownSched1,
!- Heating Power Schedule Name
,
!- Fan Speed Control Type
375.,
!- Rated Fan Power {W}
12.4,
!- Rated Air Flow {m3/s}
,
!- Minimum Fan Air Flow Ratio
Electric,
!- Defrost Type
TimeSchedule,
!- Defrost Control Type
AirChillerDefrostSched1, !- Defrost Schedule Name
AirChillerDripDownSched1, !- Defrost Drip-Down Schedule Name
55066.,
!- Defrost Power {W}
,
!- Temperature Termination Defrost Fraction to Ice
,
!- Vertical Location
;
!- Average Refrigerant Charge Inventory {kg}

The following is an example input for a refrigeration air chiller.

9/29/14

1256

Input-Output Reference

Group Refrigeration

Refrigeration:AirChiller,
Freezer_1AirChiller_1,
!- Name
AvailAllYear,
!- Availability Schedule Name
UnitLoadFactorSensibleOnly, !- Capacity Rating Type
10900.,
!- Rated Unit Load Factor {W/deltaC}
,
!- Rated Capacity {W}
,
!- Rated Relative Humidity
-26.,
!- Rated Cooling Source Temperature {C}
8.,
!- Rated Temperature Difference DT1 {DeltaC}
11.,
!- Maximum Temperature Difference DT1 {DeltaC}
,
!- Material Correction Factor
,
!- Refrigerant Correction Factor
LinearSHR60,
!- Capacity Correction Curve Type
,
!- Capacity Correction Curve Name
1.5,
!- SHR60 Correction Factor {dimensionless}
200.,
!- Rated Total Heating Power {W}
AirChillerDripDownSched1,
!- Heating Power Schedule Name
,
!- Fan Speed Control Type
375.,
!- Rated Fan Power {W}
12.4,
!- Rated Air Flow {m3/s}
,
!- Minimum Fan Air Flow Ratio
Electric,
!- Defrost Type
TimeSchedule,
!- Defrost Control Type
AirChillerDefrostSched1, !- Defrost Schedule Name
AirChillerDripDownSched1, !- Defrost Drip-Down Schedule Name
55066.,
!- Defrost Power {W}
,
!- Temperature Termination Defrost Fraction to Ice
,
!- Vertical Location
;
!- Average Refrigerant Charge Inventory {kg}

Refrigeration Air Chiller Outputs

HVAC,Average,Refrigeration Zone Air Chiller Total Cooling Rate [W]
HVAC,Sum,Refrigeration Zone Air Chiller Total Cooling Energy [J]
HVAC,Average,Refrigeration Zone Air Chiller Sensible Cooling Rate [W]
HVAC,Sum,Refrigeration Zone Air Chiller Sensible Cooling Energy [J]
HVAC,Average,Refrigeration Zone Air Chiller Latent Cooling Rate [W]
HVAC,Sum,Refrigeration Zone Air Chiller Latent Cooling Energy [J]
HVAC,Average, Refrigeration Zone Air Chiller Water Removed Mass Flow Rate
[kg/s]
HVAC,Average,Refrigeration Zone Air Chiller Total Electric Power [W]
HVAC,Sum,Refrigeration Zone Air Chiller Total Electric Energy [J]
HVAC,Average,Refrigeration Zone Air Chiller Fan Electric Power [W]
HVAC,Sum,Refrigeration Zone Air Chiller Fan Electric Energy [J]
HVAC,Average,Refrigeration Zone Air Chiller Heater Electric Power [W]
HVAC,Sum,Refrigeration Zone Air Chiller Heater Electric Energy [J]
HVAC,Average,Refrigeration Zone Air Chiller Sensible Heat Ratio []
HVAC,Average,Refrigeration Zone Air Chiller Frost Accumulation Mass [kg]
HVAC,Average,Refrigeration Zone Air Chiller Zone Total Cooling Rate [W]
HVAC,Sum,Refrigeration Zone Air Chiller Zone Total Cooling Energy [J]
HVAC,Average,Refrigeration Zone Air Chiller Zone Sensible Cooling Rate [W]
HVAC,Sum,Refrigeration Zone Air Chiller Zone Sensible Cooling Energy [J]
HVAC,Average,Refrigeration Zone Air Chiller Zone Heating Rate [W]
HVAC,Sum,Refrigeration Zone Air Chiller Zone Heating Energy [J]
Report only for Air Chillers using electric defrost
HVAC,Average,Refrigeration Zone Air Chiller Defrost Electric Power [W]
HVAC,Sum,Refrigeration Zone Air Chiller Defrost Electric Energy [J]
Report for each Zone exchanging energy with the Air Chiller
HVAC,Average,Refrigeration Zone Air Chiller Sensible Cooling Rate [W]
HVAC,Sum,Refrigeration Zone Air Chiller Sensible Cooling Energy [J]
HVAC,Average, Refrigeration Zone Air Chiller Heating Rate [W]
HVAC,Sum,Refrigeration Zone Air Chiller Heating Energy [J]
9/29/14

1257

Input-Output Reference

Group Refrigeration

HVAC,Average, Refrigeration Zone Air Chiller Latent Cooling Rate [W]

HVAC,Sum,Refrigeration Zone Air Chiller Latent Cooling Energy [J
HVAC,Average,Refrigeration Zone Air Chiller Total Cooling Rate [W]
HVAC,Sum,Refrigeration Zone Air Chiller Total Cooling Energy [J]
HVAC,Average,Refrigeration Zone Air Chiller Water Removed Mass Flow Rate [kg/s]

Refrigeration Zone Air Chiller Total Cooling Rate [W]

This field is the total (sensible plus latent) cooling rate of the Air Chiller evaporator coil in
Watts.
Refrigeration Zone Air Chiller Total Cooling Energy [J]
This field is the total (sensible plus latent) cooling of the Air Chiller evaporator coil in Joules
over the timestep being reported. This output is also added to a meter with Resource Type =
EnergyTransfer, End Use Key = Refrigeration, Group Key = Building (Ref. Output:Meter
objects).
Refrigeration Zone Air Chiller Sensible Cooling Rate [W]
Refrigeration Zone Air Chiller Sensible Heat Transfer Rate [W]
This field is the sensible cooling rate of the Air Chiller evaporator coil in Watts.
Refrigeration Zone Air Chiller Sensible Cooling Energy [J]
Refrigeration Zone Air Chiller Sensible Heat Transfer Energy [J]
This field is the sensible cooling of the Air Chiller evaporator coil in Joules over the timestep
being reported.
Refrigeration Zone Air Chiller Latent Cooling Rate [W]
This field is the latent cooling (dehumidification) rate of the Air Chiller evaporator coil in
Watts.
Refrigeration Zone Air Chiller Latent Cooling Energy [J]
This field is the latent cooling (dehumidification) of the Air Chiller evaporator coil in Joules
over the timestep being reported.
Refrigeration Zone Air Chiller Water Removed Mass Flow Rate [kg/s]
This field is the latent cooling (dehumidification) of the Air Chiller evaporator coil in kilograms
per second over the timestep being reported.
Refrigeration Zone Air Chiller Total Electric Power [W]
This field is the total electricity (fan, heaters, lights, and electric defrost) used by the Air
Chiller in Watts.
Refrigeration Zone Air Chiller Total Electric Energy [J]
This field is the electricity (fan, heaters, lights, and electric defrost)used by the Refrigeration
chiller in Joules over the timestep being reported.
Refrigeration Zone Air Chiller Fan Electric Power [W]
This field is the electric power input to the Air Chiller fan(s) in Watts.
Refrigeration Zone Air Chiller Fan Electric Energy [J]
This field is the electricity consumption of the Air Chiller fan(s) in Joules over the timestep
being reported. This output is also added to a meter with Resource Type = Electricity, End
Use Key = Refrigeration, Group Key = Building (Ref. Output:Meter objects).

9/29/14

1258

Input-Output Reference

Group Refrigeration

Refrigeration Zone Air Chiller Heater Electric Power [W]

This field is the electric power input to the Air Chiller heaters in Watts.
Refrigeration Zone Air Chiller Heater Electric Energy [J]
This field is the total electricity consumption of the Air Chiller heaters in Joules over the
timestep being reported. This output is also added to a meter with Resource Type =
Electricity, End Use Key = Refrigeration, Group Key = Building (Ref. Output:Meter objects).
Refrigeration Zone Air Chiller Defrost Electric Power [W]
This field is the electric power input to the Air Chiller electric defrost heater(s) in Watts. This
output is available if case defrost type is Electric.
Refrigeration Zone Air Chiller Defrost Electric Energy [J]
This field is the total electricity consumption of the Air Chiller electric defrost heater(s) in
Joules over the timestep being reported. This output is also added to a meter with Resource
Type = Electricity, End Use Key = Refrigeration, Group Key = Building (Ref. Output:Meter
objects). This output is available if case defrost type is Electric.
Refrigeration Zone Air Chiller Sensible Heat Ratio
This field is the Sensible Cooling Energy Rate divided by the Total Cooling Energy Rate.
Refrigeration Zone Air Chiller Frost Accumulation Mass [kg]
This field is the total amount of frost present on the coil during the timestep being reported.
Refrigeration Zone Air Chiller Zone Total Cooling Rate [W]
This field is the rate of total cooling delivered to the zone in Watts. A positive value is
reported when the zone is cooled by the air chiller, otherwise a zero is reported.
Refrigeration Zone Air Chiller Zone Total Cooling Energy [J]
This field is the amount of total cooling energy delivered to the zone in Joules. A positive
value is reported when the zone is cooled by the air chiller, otherwise a zero is reported.
Refrigeration Zone Air Chiller Zone Sensible Cooling Rate [W]
This field is the rate of sensible cooling delivered to the zone in Watts. A positive value is
reported when the zone is cooled by the air chiller, otherwise a zero is reported.
Refrigeration Zone Air Chiller Zone Sensible Cooling Energy [J]
This field is the amount of sensible cooling energy delivered to the zone in Joules. A positive
value is reported when the zone is cooled by the air chiller, otherwise a zero is reported.
Refrigeration Zone Air Chiller Zone Heating Rate [W]
This field is the rate of sensible heating delivered to the zone in Watts. A positive value is
reported when the zone is heated by the air chiller (typically only occurs during defrost),
otherwise a zero is reported.
Refrigeration Zone Air Chiller Zone Heating Energy [J]
This field is the amount of sensible heating energy delivered to the zone in Joules. A positive
value is reported when the zone is heated by the air chiller (typically only occurs during
defrost), otherwise a zero is reported.
The following output variables are available for each zone served by any Air Chiller. An
output variable identification is created for each zone exchanging energy with the Air Chiller.
For example if the Air Chiller, DairyRefrigeration chiller, were exchanging energy with the
zone, SalesArea, the output variable identification would be DairyRefrigeration
chillerInZoneSalesArea.
9/29/14

1259

Input-Output Reference

Group Zone Controls Thermostats and Humidistats

Refrigeration Zone Air Chiller Sensible Cooling Rate [W]

This field is the rate of sensible cooling delivered to the zone, net of any auxiliary heat input,
in Watts..
Refrigeration Zone Air Chiller Sensible Cooling Energy [J]
This field is the amount of sensible cooling energy, net of any auxiliary heat input, delivered
to the zone in Joules.
Refrigeration Zone Air Chiller Latent Cooling Rate [W]
This field is the rate of latent cooling (dehumidification) delivered to the zone in Watts. A
negative value will be reported when the Air Chiller provides dehumidification (thereby
reducing the zone latent load).
Refrigeration Zone Air Chiller Water Removed Mass Flow Rate [kg/s]
This field is the rate of latent cooling (dehumidification) delivered to the zone in kg/s. A
negative value (or zero) will be reported when the Air Chiller provides dehumidification
(thereby reducing the zone latent load).
Refrigeration Zone Air Chiller Latent Cooling Energy [J]
This field is the amount of latent cooling (dehumidification) energy delivered to the zone in
Joules. A negative value (or zero) will be reported when the Air Chiller provides
dehumidification (thereby reducing the zone latent load).
Refrigeration Zone Air Chiller Total Cooling Rate [W]
This field is the total rate of cooling, sensible plus latent, delivered to the zone in Watts.
Refrigeration Zone Air Chiller Total Cooling Energy [J]
This field is the total amount of cooling, sensible plus latent, energy delivered to the zone in
Joules.
Refrigeration Zone Air Chiller Heating Rate [W]
This field is the rate of net heating due to any auxiliary or defrost heat input delivered to the
zone, in Watts.
Refrigeration Zone Air Chiller Heating Energy [J]
This field is the amount of net heating energy due to any auxiliary heat input, delivered to the
zone in Joules.

Group Zone Controls Thermostats and Humidistats

Zone Control objects are used to control zone conditions to a specific setpoint. The six types
of zone control are described in this section. They are, by name, ZoneControl:<name>..
These types are:
Thermostat The object provides the traditional approach to space control using air
temperatures. Each controlled zone contains a thermostat object.
Humidistat The object is used to control a zone to a specified relative humidity.
Thermostat:ThermalComfort The object provides a method to control a zone to a dry-bulb
temperature setpoint based on a thermal comfort model (e.g. Fanger) and a userspecified thermal comfort setpoint schedule.
Thermostat:OperativeTemperature The operative temperature control is formulated to
reuse all of the traditional thermostat objects. One input object will be used for each
thermal zone to indicate if that zones thermostat control mode should be overridden
to effect operative temperature control rather than traditional air temperature control.
9/29/14

1260

Input-Output Reference

Group Zone Controls Thermostats and Humidistats

The user will still have to input all the traditional ZoneControl:Thermostat and setpoint
objects.
Thermostat:TemperatureAndHumidity This thermostat control works together with the
traditional ZoneControl:Thermostat object to modify temperature control based on
zone air humidity conditions. Currently, this object resets the thermostats cooling
setpoint temperature downward based on elevated zone air humidity levels, typically
yielding additional cooling coil operation and associated dehumidification. A
ZoneControl:Thermostat:TemperatureAndHumidity object should be specified to
indicate if a zones traditional thermostat control mode should be overridden to
provide enhanced dehumidification. The user must still input the traditional
ZoneControl:Thermostat and setpoint objects.
Thermostat:StagedDualSetpoint This thermostat control works alone with Duel Setpoint
type only. The object provides heating and cooling setpoints, throttling range and
offsets, so that zone temperature setpoint used for system load calculation is
adjusted by the setpoint and throttling range based on the zone temperature at the
previous time step. The stage number is determined by the temperature difference
between the setpoint and zone temperature at the previous time step, and offset
values. If this object and other zone control thermostat and humidistat are assigned
to the same controlled zone, this object takes precedence when the controlled zone
is specified in the Controlling Zone or Thermostat Location field of the
AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed object.
ZoneControl:Thermostat
The thermostatic zone control object is used to control a zone to a specified temperature.
ZoneControl:Thermostat references a control type schedule and one or more control type
objects which in turn reference one or more setpoint schedules. The example at the end of
this section illustrates a complete zone thermostat specification including the control type and
setpoint schedules.
The control type schedule and the list of control type/name pairs are directly related. The
schedule defines the type of control that is to be used throughout the simulation. Valid
Control Types are:
0 - Uncontrolled (No specification or default)
1 - Single Heating Setpoint
2 - Single Cooling SetPoint
3 - Single Heating/Cooling Setpoint
4 - Dual Setpoint (Heating and Cooling) with deadband
Thus, if the schedule referenced in the ZoneControl:Thermostat statement has a control type
of 4 for a particular time period, this indicates that during that time period "Dual Setpoint with
deadband control is to be used. The specific "Dual Setpoint (Heating and Cooling) with
deadband" control object to be used is specified in the list of control type/name pairs. Then
the specific control type objects reference the thermostat setpoint temperature schedule to be
used. Because only one control can be specified for each control type in a
ZoneControl:Thermostat statement, there are only four pairs possible in a particular
ZoneControl:Thermostat type/name list. This is because individual controls can be defined
throughout the simulation, thus giving the user a full range of flexibility. Since putting in the
name of the control type directly in the schedule would be very cumbersome, the control
types are assigned a number which is used in the schedule profile.
Field: Name
Unique identifying name for the thermostat.

9/29/14

1261

Input-Output Reference

Group Zone Controls Thermostats and Humidistats

Field: Zone or ZoneList Name

Name of the zone or set of zones that is being controlled. When the ZoneList option is used
then this thermostat definition is applied to each of the zones in the zone list effecting a global
definition for thermostatic control in the zone.
Field: Control Type Schedule Name
Schedule which defines what type of control is active during the simulation. Valid Control
Types are:
0 - Uncontrolled (No specification or default)
1 - Single Heating Setpoint
2 - Single Cooling SetPoint
3 - Single Heating Cooling Setpoint
4 - Dual Setpoint with Deadband (Heating and Cooling)
Each non-zero control type which is used in this schedule must appear in the following fields
which list the specific thermostat control objects to be used for this zone.
Field Set (Control Object Type, Control Name)
Up to four pairs of Control Object Type and Control Name may be listed to specify which
control objects are used for this zone. This list is not order-dependent, and the position in this
list has no impact on the control type schedule. In the control type schedule, a value of 1
always means "Single Heating Setpoint", even if that control type is not first in this list.
Field: Control Object <x>Type
This field specifies the control type to be used for this zone. Available control types are:
ThermostatSetpoint:SingleHeating
ThermostatSetpoint:SingleCooling
ThermostatSetpoint:SingleHeatingOrCooling
ThermostatSetpoint:DualSetpoint

Field: Control <x> Name

The corresponding control type name. The name is used in an object with the name of the
control type and specifies the schedule.
An example of this statement in an IDF is:
ZoneControl:Thermostat, Zone 3 Thermostat, NORTH ZONE,
Zone Control Type Sched,
DUAL SETPOINT WITH DEADBAND, VAV Setpoints;

An example of a global thermostat:

ZoneList,AllControlledZones,SPACE1-1,SPACE2-1,SPACE3-1,SPACE4-1,SPACE5-1;
ZoneControl:Thermostat,
AllControlledZones Thermostat,
!- Name
AllControlledZones,
!- Zone Name
Zone Control Type Sched, !- Control Type Schedule Name
ThermostatSetpoint:SingleCooling, !- Control 1 Object Type
CoolingSetPoint,
!- Control 1 Name
ThermostatSetpoint:SingleHeating, !- Control 2 Object Type
HeatingSetpoint,
!- Control 2 Name
ThermostatSetpoint:DualSetpoint, !- Control 3 Object Type
DualSetPoint;
!- Control 3 Name

A complete zone thermostat example showing this statement and all of the objects it must
reference is:

9/29/14

1262

Input-Output Reference

Group Zone Controls Thermostats and Humidistats

! Zone control object which links thermostats to a particular zone

ZoneControl:Thermostat, Zone 2 Thermostat, EAST ZONE,
Zone Control Type Sched,
ThermostatSetpoint:SingleCooling, Cooling Setpoint with SB,
ThermostatSetpoint:SingleHeating,, Heating Setpoint with SB;

! Control type objects these may be used in more than one zone
ThermostatSetpoint:SingleCooling,,
Cooling Setpoint with SB,
Cooling Setpoints;
ThermostatSetpoint:SingleHeating,,
Heating Setpoint with SB,
Heating Setpoints;

! Schedule type definitions

ScheduleTypeLimits,Temperature,-60:200,CONTINUOUS;
ScheduleTypeLimits,Control Type,0:4,DISCRETE;
! Control type schedule definition
Schedule:Compact, Zone Control Type Sched, Control Type,
Through: 3/31,
For: AllDays,
Until: 24:00, 1, !- Single Heating
Through: 9/30,
For: AllDays,
Until: 24:00, 2, !- Single Cooling
Through: 12/31,
For: AllDays,
Until: 24:00, 1; !- Single Heating

! Heating setpoint schedule definition

Schedule:Compact, Heating Setpoints, Temperature,
Through: 12/31,
For: AllDays,
Until: 7:00, 15.,
Until: 17:00,20.,
Until: 24:00,15.;

! Cooling setpoint schedule definition

Schedule:Compact, Cooling Setpoints, Temperature,
Through: 12/31,
For: AllDays,
Until: 7:00, 30.,
Until: 20:00,23.,
Until: 24:00,30.;

ZoneControl Thermostat Outputs

Outputs available from controlled zones. The key in the below is the Zone Name.
HVAC,Average,Zone Predicted Sensible Load to Setpoint Heat Transfer Rate [W]
HVAC,Average,Zone Predicted Sensible Load to Heating Setpoint Heat Transfer
Rate [W]
HVAC,Average,Zone Predicted Sensible Load to Cooling Setpoint Heat Transfer
Rate [W]
Zone,Average,Zone Thermostat Control Type []
Zone,Average,Zone Thermostat Heating Setpoint Temperature [C]
Zone,Average,Zone Thermostat Cooling Setpoint Temperature [C]
HVAC,Sum,Facility Any Zone Oscillating Temperatures Time [hr]
Zone,Sum,Zone Heating Setpoint Not Met Time [hr]
Zone,Sum,Zone Heating Setpoint Not Met While Occupied Time [hr]
Zone,Sum,Zone Cooling Setpoint Not Met Time [hr]
Zone,Sum,Zone Cooling Setpoint Not Met While Occupied Time [hr]
9/29/14

1263

Input-Output Reference
Zone,Sum,Facility
Zone,Sum,Facility
Zone,Sum,Facility
Zone,Sum,Facility

Group Zone Controls Thermostats and Humidistats

Heating
Cooling
Heating
Cooling

Setpoint
Setpoint
Setpoint
Setpoint

Not
Not
Not
Not

Met
Met
Met
Met

Time [hr]
Time [hr]
While Occupied Time [hr]
While Occupied Time [hr]

Zone Predicted Sensible Load to Setpoint Heat Transfer Rate [W]

This is the predicted sensible load in W required to meet the current zone thermostat
setpoint. A positive value indicates a heating load, a negative value indicates a cooling load.
This is calculated and reported from the Predict step in the Zone Predictor-Corrector module.
For nearly all equipment types, the Predictor-Corrector evaluates the active heating and/or
cooling setpoints, determines if the zone requires heating or cooling or is in the deadband,
and then passes this single load to the equipment. This value is not multiplied by zone or
group multipliers.
Zone Predicted Sensible Load to Heating Setpoint Heat Transfer Rate [W]
This is the predicted sensible load in W required to meet the current zone thermostat heating
setpoint. A positive value indicates a heating load, a negative value indicates a cooling load.
This is calculated and reported from the Predict step in the Zone Predictor-Corrector module.
This value is not multiplied by zone or group multipliers.
Zone Predicted Sensible Load to Cooling Setpoint Heat Transfer Rate [W]
This is the predicted sensible load in W required to meet the current zone thermostat cooling
setpoint. A positive value indicates a heating load, a negative value indicates a cooling load.
This is calculated and reported from the Predict step in the Zone Predictor-Corrector module.
This value is not multiplied by zone or group multipliers.
Zone Thermostat Control Type []
This is the current zone thermostat control type (0 through 4). This value is set at each zone
timestep. Using the averaged value for longer reporting frequencies (hourly, for example)
may not be meaningful in some applications.
Zone Thermostat Heating Setpoint Temperature [C]
This is the current zone thermostat heating setpoint in degrees C. If there is no heating
thermostat active, then the value will be 0. This value is set at each zone timestep. Using the
averaged value for longer reporting frequencies (hourly, for example) may not be meaningful
in some applications.
When the Thermostat:StagedDualSetpoint object is applied to the current zone, this output
variable reports staged zone heating setpoint. When the staged number is not equal to zero,
both staged heating and cooling setpoints are the same. When no cooling or heating is
required, the staged heating setpoint is equal to the scheduled heating setpoint 0.5 *
heating throttling range, and the staged cooling setpoint is equal to the scheduled cooling
setpoint + 0.5 * cooling throttling range.
Zone Thermostat Cooling Setpoint Temperature [C]
This is the current zone thermostat cooling setpoint in degrees C. If there is no cooling
thermostat active, then the value will be 0. This value is set at each zone timestep. Using the
averaged value for longer reporting frequencies (hourly, for example) may not be meaningful
in some applications.
When the Thermostat:StagedDualSetpoint object is applied to the current zone, this output
variable reports staged zone cooling setpoint. When the staged number is not equal to zero,
both staged heating and cooling setpoints are the same. When no cooling or heating is
required, the staged heating setpoint is equal to the scheduled heating setpoint 0.5 *
heating throttling range, and the staged cooling setpoint is equal to the scheduled cooling
setpoint + 0.5 * cooling throttling range.
9/29/14

1264

Input-Output Reference

Group Zone Controls Thermostats and Humidistats

Zone Thermostat Stage Number []

This
is
the
current
zone
thermostat
stage
number
when
the
ZoneControl:Thermostat:StagedDualSetpoint object is specified in this zone. When no
heating or cooling is required, the stage number is set to 0. When heating is required, the
stage number is positive. When cooling is required, the stage number is negative. The
absolute number is sent to the AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed object to
specify the speed number accordingly.
Zone Heating Setpoint Not Met Time [hr]
Hours when the zone temperature is lower than 0.2 (default) degrees C below the heating
setpoint. See the OutputControl:ReportingTolrances object to change the reporting range
from 0.2 degrees C.
Zone Heating Setpoint Not Met While Occupied Time [hr]
Hours when the zone temperature is lower than 0.2 (default) degrees C below the heating
setpoint and when people are present in the zone. To change the reporting range from 0.2
degrees C, see the OutputControl:ReportingTolrances object.
Zone Cooling Setpoint Not Met Time [hr]
Hours when the zone temperature is greater than 0.2 (default) degrees C above the cooling
setpoint. See the OutputControl:ReportingTolrances object to change the reporting range
from 0.2 degrees C.
Zone Cooling Setpoint Not Met While Occupied Time [hr]
Hours when the zone temperature is greater than 0.2 (default) degrees C above the cooling
setpoint and when people are present in the zone. To change the reporting range from 0.2
degrees C, see the OutputControl:ReportingTolrances object.
Facility Heating Setpoint Not Met Time [hr]
Hours when the zone temperature is lower than 0.2 (default) degrees C below the heating
setpoint in any one or more zones. See the OutputControl:ReportingTolrances object to
change the reporting range from 0.2 degrees C.
Facility Heating Setpoint Not Met While Occupied Time [hr]
Hours when the zone temperature is lower than 0.2 (default) degrees C below the heating
setpoint and when people are present in any one or more zones. To change the reporting
range from 0.2 degrees C, see the OutputControl:ReportingTolrances object.
Facility Cooling Setpoint Not Met Time [hr]
Hours when the zone temperature is greater than 0.2 (default) degrees C above the cooling
setpoint in any one or more zones. See the OutputControl:ReportingTolrances object to
change the reporting range from 0.2 degrees C.
Facility Cooling Setpoint Not Met While Occupied Time [hr]
Hours when the zone temperature is greater than 0.2 (default) degrees C above the cooling
setpoint and when people are present in any one or more zones. To change the reporting
range from 0.2 degrees C, see the OutputControl:ReportingTolrances object.
Zone Oscillating Temperatures Time[hr]
Hours when the temperature in the zone is oscillating back and forth. Oscillation is defined as
times when the three differences between zone temperatures during successive timesteps
are greater in magnitude than 0.15 degrees C and the sign of the differences changes from
positive to negative to positive or from negative to positive to negative.

9/29/14

1265

Input-Output Reference

Group Zone Controls Thermostats and Humidistats

This may indicate a simulation with reduced reliability during the oscillation. Some oscillating
hours should be expected in all simulations but excessive oscillations call into question the
overall validity of the results. If excessive oscillations are occurring, try reducing the minimum
system timestep (see ConvergenceLimits object) and the zone timestep (see the TimeStep
object). Reducing these timestep lengths does increase the total computer time needed to
complete the simulation. Having the zone timestep and the minimum system timestep the
same length of time can also cause more oscillations. What amount of oscillations is
considered excessive is difficult to quantify. One approach is comparing the number of
oscillations to the case with 15 minute zone timesteps (4 per hour) and 1 minute minimum
system timesteps. Often this variable is used as an indicator of the validity of the results when
trying to decrease the time needed to perform the simulation.
Facility Any Zone Oscillating Temperatures Time[hr]
Hours when any zone in the building has oscillations. See Zone Oscillating Temperatures
Time definition above.
Zone Thermostat Setpoints
The syntax for the current set of four zone thermostat setpoint objects is given below. In each
case, the keyword is accompanied by an identifying name and either one or two schedule
names (depending on whether the control is a single or dual setpoint control). The schedule
defines a temperature setpoint for the control type. The schedule would be defined through
the standard schedule syntax described earlier in this document. For an uncontrolled zone no
thermostat is specified or necessary.
ThermostatSetpoint:SingleHeating
This would be for a heating only thermostat. The setpoint can be scheduled and varied
throughout the simulation but only heating is allowed with this control type.
Field: Name
Unique name for this control type.
Field: Setpoint Temperature Schedule Name
The name of the associated schedule. Values in the schedule are temperatures {C}.
ThermostatSetpoint:SingleCooling
This would be for a cooling only thermostat. The setpoint can be scheduled and varied
throughout the simulation but only cooling is allowed.
Field: Name
Unique name for this control type.
Field: Setpoint Temperature Schedule Name
The name of the associated schedule. Values in the schedule are temperatures {C}.
ThermostatSetpoint:SingleHeatingOrCooling
This would be for heating and cooling thermostat but only heating or cooling can be
scheduled at any given time period. The setpoint can be scheduled and varied throughout the
simulation for both heating and cooling.
Field: Name
Unique name for this control type.
Field: Setpoint Temperature Schedule Name
The name of the associated schedule. Values in the schedule are temperatures {C}.
9/29/14

1266

Input-Output Reference

Group Zone Controls Thermostats and Humidistats

ThermostatSetpoint:DualSetpoint
This would be for heating and cooling thermostat where both a heating and cooling setpoint
can be scheduled for any given time period. The setpoint can be scheduled and varied
throughout the simulation for both heating and cooling.
Field: Name
Unique name for this control type.
Field: Heating Setpoint Temperature Schedule Name
The heating temperature schedule. Values in the schedule are temperatures {C}.
Field: Cooling Setpoint Temperature Schedule Name
The cooling temperature schedule. Values in the schedule are temperatures {C}.
Examples of these statements in an IDF are:
ThermostatSetpoint:SingleHeating, Heating Setpoint with SB, Heating Setpoints;
ThermostatSetpoint:SingleCooling, Cooling Setpoint with SB, Cooling Setpoints;
ThermostatSetpoint:SingleHeatingOrCooling, Heating Cooling Setpoint Sched, Heating Cooling Setpoints;
ThermostatSetpoint:DualSetpoint, VAV Setpoints, Heating Setpoints, Cooling Setpoints;

ZoneControl:Thermostat:OperativeTemperature
This object is used to modify the programs behavior for ZoneControl:Thermostat objects.
One input object is used for each thermal zone to indicate if that zones thermostat control
mode should be overridden to effect operative temperature control rather than traditional air
temperature control. Zone Control:Thermostatic and related set point objects also need to be
included in the input file. When this object is used, the zone can be controlled by a weighted
mixture of radiant and air temperatures (rather than just air temperatures).
This thermostatic operative temperature,

TOP

TMRT

(1

TOP , is defined as:

)Tdrybulb

where,
is the radiative fraction,

TMRT is the mean radiant temperature for the thermal zone, and
Tdrybulb is the mean zone air temperature.
The radiative fraction
is selected by the user and can be scheduled to vary during the
simulation. A typical value is 0.5. The maximum value needs to be less than 0.9 and the
minimum is 0.0. A value of 0.0 is the same as controlling on only zone air temperature. If air
velocities are higher than 0.2 m/s, then lower values for radiative fraction might apply. Niu
and Burnett (1998) cite International Standard ISO 77300 in recommending the values for
this fraction listed in the following table.
Table 28. Radiative Fraction vs Air Velocity (Operative Temperature Control)
Air Velocity (m/s)

< 0.2

0.2 to 0.6

0.6 to 1.0

0.5

0.4

0.3

Reference: J. Niu and J. Burnett. 1998. Integrating Radiant/Operative Temperature Controls

into Building Energy Simulations. ASHRAE Transactions Vol. 104. Part 2. page 210.
ASHRAE. Atlanta, GA.
9/29/14

1267

Input-Output Reference

Group Zone Controls Thermostats and Humidistats

Field: Thermostat Name

Name of ZoneControl:Thermostat object defined elsewhere in the input file whose operation
is to be modified to effect control based on operative temperature. If the
ZoneControl:Thermostat references a ZoneList (set of zones) then, this operative
temperature thermostat will be applied to each of those zones. If only a single
thermostat/zone is desired, then the name to be put here is <zone name> <Thermostat
Name> where the Thermostat name is the thermostat that referenced the set of zones.
Field: Radiative Fraction Input Mode
This field controls whether the input for radiative fraction is a constant value or if it is entered
using a schedule. Enter Constant here to use a fixed radiative fraction defined in the
following field. Enter Scheduled to vary the radiative fraction according to the schedule
named in the second field below.
Field: Fixed Radiative Fraction
This is the fraction,
, of the operative temperature that is due to the mean radiant
temperature in the zone. This field is used by the program if the previous field is set to
Constant.
Field: Radiative Fraction Schedule Name
This field contains the name of a schedule, defined elsewhere, that determines the value for
radiative fraction
during the simulation period. This schedule should have fractional values
from 0.0 to 0.9. When the value of this schedule is 0.0, the controlling will be equivalent to
control based only on zone air temperature. This field is used by the program if the Input
Mode field is set to Scheduled.
Note that by setting the values in this schedule separately for design days, the user can
control how operative temperature control is applied during autosizing. (Operative
temperature control tends to increase the equipment capacities calculated during sizing.)
An example of this object follows.
ZoneControl:Thermostat:OperativeTemperature,
Zone 1 Thermostat, !- ZoneControl:Thermostat Name
Constant,
!- Radiative Fraction Input Mode
0.5,
!- Fixed Radiative Fraction
; !- Radiative Fraction Schedule

Global operative temperature applied to all zones for a global thermostat:

ZoneList,AllControlledZones,SPACE1-1,SPACE2-1,SPACE3-1,SPACE4-1,SPACE5-1;
ZoneControl:Thermostat,
AllControlledZones Thermostat,
!- Name
AllControlledZones,
!- Zone Name
Zone Control Type Sched, !- Control Type Schedule Name
ThermostatSetpoint:SingleCooling, !- Control 1 Object Type
CoolingSetPoint,
!- Control 1 Name
ThermostatSetpoint:SingleHeating, !- Control 2 Object Type
HeatingSetpoint,
!- Control 2 Name
ThermostatSetpoint:DualSetpoint, !- Control 3 Object Type
DualSetPoint;
!- Control 3 Name
ZoneControl:Thermostat:OperativeTemperature,
AllControlledZones Thermostat,
!- Thermostat Name
CONSTANT,
!- Radiative Fraction Input Mode
0.4;
!- Fixed Radiative Fraction

Global operative temperature referencing a single zone from the list:

9/29/14

1268

Input-Output Reference

Group Zone Controls Thermostats and Humidistats

ZoneList,AllControlledZones,SPACE1-1,SPACE2-1,SPACE3-1,SPACE4-1,SPACE5-1;
ZoneControl:Thermostat,
AllControlledZones Thermostat,
!- Name
AllControlledZones,
!- Zone Name
Zone Control Type Sched, !- Control Type Schedule Name
ThermostatSetpoint:SingleCooling, !- Control 1 Object Type
CoolingSetPoint,
!- Control 1 Name
ThermostatSetpoint:SingleHeating, !- Control 2 Object Type
HeatingSetpoint,
!- Control 2 Name
ThermostatSetpoint:DualSetpoint, !- Control 3 Object Type
DualSetPoint;
!- Control 3 Name
ZoneControl:Thermostat:OperativeTemperature,
SPACE3-1 AllControlledZones Thermostat,
!- Thermostat Name
CONSTANT,
!- Radiative Fraction Input Mode
0.4;
!- Fixed Radiative Fraction

Zone Control Themostatic Operative Temperature Outputs

Zone,Average,Zone Thermostat Operative Temperature [C]

Zone Thermostat Operative Temperature [C]

Operative temperature (OT) is a weighted mixture of Zone Mean Air Temperature (MAT) and
Zone Mean Radiant Temperature (MRT), using the current value of Radiative Fraction (RF):
OT = (1-RF)*MAT + RF*MAT. This output variable does not include the direct effect of high
temperature radiant systems. See also Zone Operative Temperature.
ZoneControl:Thermostat:TemperatureAndHumidity
This object is used to modify the behavior of ZoneControl:Thermostat objects (control types
ThermostatSetpoint:SingleCooling and ThermostatSetpoint:DualSetpoint only) based on
zone air humidity conditions. Specifically, this TemperatureAndHumidity zone control resets
the ZoneControl:Thermostats cooling setpoint temperature downward when the zone air
relative humidity exceeds the Dehumidifying Relative Humidity Setpoint defined in this object.
The reduced cooling setpoint temperature typically results in longer cooling coil runtimes and
additional dehumidification. The rate at which the cooling setpoint temperature is reduced is
dictated by the user-specified Overcool Control Ratio. The maximum reduction in cooling
setpoint temperature is defined by the user-entered OverCool Range (user choice of a
constant value for the entire simulation or a schedule that can define how the overcool range
varies over time). For details regarding the calculations, see the EnergyPlus Engineering
Reference.
Note: As described above, this ZoneControl:Thermostat:TemperatureAndHumidity control object modifies
the
cooling
setpoint
temperature
of
ZoneControl:Thermostat
objects.
The
ZoneControl:Thermostat:TemperatureAndHumidity
object
works
independently
of
the
ZoneControl:Humidistat object; that is, it does not replace the need for, or coordinate its input fields with,
ZoneControl:Humidistat objects that are required for other types of high humidity control (e.g.,
ZoneControl:Humidstat
objects
are
required
for
ZoneHVAC:Dehumidifier:DX
objects,
AirLoopHVAC:Unitary* objects with CoolReheat or MultiMode dehumidification control types, etc.)

Field: Thermostat Name

Name of ZoneControl:Thermostat object defined elsewhere in the input file whose operation
is to be modified to effect temperature control based on zone air humidity conditions. If the
ZoneControl:Thermostat references a ZoneList (set of zones), then simply enter the name of
the ZoneControl:Thermostat object and this TemperatureAndHumidity thermostat control will
be applied to all zones in the ZoneList. If the ZoneControl:Thermostat references a ZoneList
9/29/14

1269

Input-Output Reference

Group Zone Controls Thermostats and Humidistats

but it is desired that only a single zone within the ZoneList be controlled based on
TemperatureAndHumidity control, then the name to be put here is <zone name> <Thermostat
Name> where the Thermostat Name is the name of the ZoneControl:Thermostat object.
Field: Dehumidifying Relative Humidity Setpoint Schedule Name
Name of a schedule that defines the dehumidifying relative humidity setpoint, expressed as a
percentage (0-100), for each timestep of the simulation. This input field is required. This
input field has absolutely no relationship or influence on the Dehumidifying Relative Humidity
Setpoint Schedule Name optional input field in the ZoneControl:Humidistat object.
Field: Dehumidification Control Type
This input field defines what type of dehumidification control is active during the simulation.
Valid control types are None and Overcool. The default is Overcool if this field is left blank.
Overcool resets the thermostats cooling setpoint temperature lower based on the zone air
relative humidity level. None means no overcooling (i.e., traditional zone air temperature
control based on the associated ZoneControl:Thermostat object [Thermostat Name input field
above] will be in effect).
Field: Overcool Range Input Method
This field controls whether the input for the overcool (temperature) range is a constant value
or if it is entered using a schedule. Enter Constant here to use a constant overcool range
defined in the Overcool Constant Range input field below. Enter Scheduled to vary the
overcool range according to the schedule named in the Overcool Range Schedule Name
input field below. The default is Constant if this field is left blank.
Field: Overcool Constant Range
This field specifies a fixed maximum overcool temperature range for cooling setpoint
temperature reduction for zone overcool dehumidification in units of deltaC. This field is used
if the Overcool Range Input Method is specified as Constant. The Overcool dehumidification
control
type
only
works
with
ZoneControl:Thermostat
control
types
ThermostatSetpoint:SingleCooling
and
ThermostatSetpoint:DualSetpoint.
For
ThermostatSetpoint:DualSetpoint, the model will use the smaller of the Overcool Constant
Range input value or the difference between the cooling and heating setpoint temperatures
specified in the ThermostatSetpoint:DualSetpoint object. The Overcool Constant Range
must be greater than or equal to zero with a maximum value of 3C. A value of 0.0 indicates
no zone air overcooling. The default value is 1.7C (3F) if this input field is left blank.
Field: Overcool Range Schedule Name
This field contains the name of a schedule, defined elsewhere, that determines the value for
the overcool range during the simulation period. This schedule should contain values from
0.0 to <=3.0 (deltaC). When the value of this schedule is 0.0, the zone air temperature control
will be based only on zone air dry-bulb temperature (i.e., no zone overcooling). This field is
used by the program if the Overcool Range Input Method field is set to Scheduled. Overcool
dehumidification control type only works with ZoneControl:Thermostat control types
ThermostatSetpoint:SingleCooling
and
ThermostatSetpoint:DualSetpoint.
For
ThermostatSetpoint:DualSetpoint, the model will use the smaller of the Overcool Range
values specified in this schedule or the difference between the cooling and heating setpoint
temperatures specified in the ThermostatSetpoint:DualSetpoint object.
Note that by setting the values in this schedule separately for design days, the user can
control how Overcool Dehumidification Control is applied during autosizing. (Overcool
dehumidification control tends to increase the cooling equipment capacities calculated during
sizing.)

9/29/14

1270

Input-Output Reference

Group Zone Controls Thermostats and Humidistats

Field: Overcool Control Ratio

The value of this input field is used to adjust the cooling setpoint temperature (established by
the associated ZoneControl:Thermostat object) downward based on the difference between
the zone air relative humidity level and the Dehumidifying Relative Humidity Setpoint. This
input field is only used with Dehumidification Control Type = Overcool. Input values must be
greater than or equal to 0.0 %RH/K. The default value is 3.6 if this field is left blank.
An example of this object follows.
ZoneControl:Thermostat:TemperatureAndHumidity,
Zone Thermostat,
!- Thermostat Name
Seasonal Relative Humidity Sch, !- Dehumidifying Relative Humidity Setpoint Schedule Name
Overcool,
!- Dehumidification Control Type
Constant,
!- Overcool Range Input Method
1.7,
!- Overcool Constant Range {deltaC}
,
!- Overcool Range Schedule Name
3.0;
!- Overcool Control Ratio {percent/K}

ZoneControl:Thermostat:StagedDualSetpoint
The thermostatic zone control staged dual setpoint object is used to control a zone to a
specified temperature based on multiple stages. The other types of ZoneControl:Thermostat
objects reference a control type schedule and one or more control type objects which in turn
reference one or more setpoint schedules. This control object does not require a control type
schedule and associated one or more control type objects. Instead, the object is defined as a
Dual Setpoint type only and has two fields to provide heating and cooling setpoints. The
object also provides two fields to specify heating and cooling throttling temperature ranges,
so that predicted zone loads may be varied within the throttling ranges for both heating and
cooling. The number of stages for both heating and cooling varies from 1 to 4 for the time
being
to
match
the
number
of
speeds
used
in
the
AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed object. The number of stages may be
expanded later to accommodate other objects with the number of speeds higher than 4. The
object requires inputs temperature offsets for both heating and cooling based on the number
of stages. The stage number is determined by the temperature difference between the
setpoint and zone temperature at the previous time step, and offset values. The staged
number
will
be
assigned
to
the
speed
number
for
the
AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed system type.
It should be pointed out that If this object and other zone control thermostat and humidistat
are assigned to the same controlled zone, this object takes precedence when the controlled
zone is specified in the Controlling Zone or Thermostat Location field of the
AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed object.
Field: Name
Unique identifying name for the staged dual-setpoint thermostat.
Field: Zone or ZoneList Name
Name of the zone or set of zones that is being controlled. When the ZoneList option is used
then this thermostat definition is applied to each of the zones in the zone list effecting a global
definition for thermostatic control in the zone.
Field: Number of Heating Stages
This numerical field defines the number of heating stages, and must be less than or equal to
the number of heating speeds defined in the associated heating coil, such as
Coil:Heating:DX:MultiSpeed. The value for this input field defines the number of heating
temperature offsets that must be defined for heating in the fields below. The minimum value
for this field is one (1) and the maximum value is four (4).

9/29/14

1271

Input-Output Reference

Group Zone Controls Thermostats and Humidistats

Field: Heating Temperature Setpoint Schedule Name

The name of the associated schedule to specify heating temperature setpoint. Values in the
schedule are temperatures {C}.
Field: Heating Throttling Temperature Range
This numeric field defines the heating throttling temperature range in the units of deltaC.
When the zone temperature at the previous time step is below the heating temperature
setpoint, the zone heating setpoint will be set to the heating temperature setpoint + 0.5 *
heating throttling temperature range. Otherwise, the zone heating setpoint will be set to the
heating temperature setpoint - 0.5 * heating throttling temperature range. The zone heating
setpoint is used in the predictor to calculate how much the heating system load is needed to
maintain the zone at the heating setpoint.
Field: Stage 1 Heating Temperature Offset
This numeric field defines the heating temperature offset in the units of deltaC for Stage 1.
The value entered here must be equal to or less than 0. The heating temperature offset fields
are
used
to
determine
the
heating
stage
number
for
AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed object. When the temperature
difference between the heating setpoint and the controlled zone temperature at previous time
step is less than Stage 1 offset value and greater than Stage 2 offset value, the heating stage
number is 1. When the AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed object is called,
Speed 1 is specified.
Field: Stage 2 Heating Temperature Offset
This numeric field defines the heating temperature offset in the units of deltaC for Stage 2.
The value entered here must be less than the value at the previous field: Stage 1 Heating
Temperature Offset. The heating temperature offset fields are used to determine the heating
stage number for AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed object. When the
temperature difference between the heating setpoint and the controlled zone temperature at
previous time step is less than Stage 2 offset value and greater than Stage 3 offset value, the
heating stage number is 2. When the AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed
object is called, Speed 2 is specified.
Field: Stage 3 Heating Temperature Offset
This numeric field defines the heating temperature offset in the units of deltaC for Stage 3.
The value entered here must be less than the value at the previous field: Stage 3 Heating
Temperature Offset. The heating temperature offset fields are used to determine the heating
stage number for AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed object. When the
temperature difference between the heating setpoint and the controlled zone temperature at
previous time step is less than Stage 3 offset value and greater than Stage 4 offset value, the
heating stage number is 3. When the AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed
object is called, Speed 3 is specified.
Note: If the stage number is not equal to the number of heating speed in the
AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed object, the minimum value is set to the speed
number for the heat pump object.

Field: Stage 4 Heating Temperature Offset

This numeric field defines the heating temperature offset in the units of deltaC for Stage 4.
The value entered here must be less than the value at the previous field: Stage 4 Heating
Temperature Offset. The heating temperature offset fields are used to determine the heating
stage number for AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed object. When the
temperature difference between the heating setpoint and the controlled zone temperature at
9/29/14

1272

Input-Output Reference

Group Zone Controls Thermostats and Humidistats

previous time step is less than Stage 4 offset value, the heating stage number is 4. When the
AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed object is called, Speed 4 is specified.
Note: If the stage number is not equal to the number of heating speed in the
AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed object, the minimum value is set to the speed
number for the heat pump object.

Field: Number of Cooling Stages

This field defines the number of cooling stages, and must be less than or equal to the number
of cooling speeds defined in the associated cooling coil, such as Coil:Cooling:DX:MultiSpeed.
The value for this input field defines the number of cooling temperature offsets that must be
defined for cooling in the fields below. The minimum value for this field is one (1) and the
maximum value is four (4).
Field: Cooling Temperature Setpoint Base Schedule Name
The name of the associated schedule to specify cooling temperature base setpoint. Values in
the schedule are temperatures {C}.
Field: Cooling Throttling Temperature Range
This numeric field defines the cooling throttling temperature range in the units of deltaC.
When the zone temperature at the previous time step is above the cooling temperature
setpoint, the zone cooling setpoint will be set to the cooling temperature setpoint - 0.5 *
cooling throttling temperature range. Otherwise, the zone cooling setpoint will be set to the
cooling temperature setpoint + 0.5 * cooling throttling temperature range. The zone cooling
setpoint is used in the predictor to calculate how much the cooling system load is needed to
maintain the zone at the cooling setpoint.
Field: Stage 1 Cooling Temperature Offset
This numeric field defines the cooling temperature offset in the units of deltaC for Stage 1.
The value entered here must be equal to or greater than 0. The cooling temperature offset
fields
are
used
to
determine
the
cooling
stage
number
for
AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed object. When the temperature
difference of the cooling setpoint and the controlled zone temperature at previous time step is
greater than Stage 1 offset value and less than Stage 2 offset value, the cooling stage
number is 1. When the AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed object is called,
Speed 1 is specified.
Field: Stage 2 Cooling Temperature Offset
This numeric field defines the cooling temperature offset in the units of deltaC for Stage 2.
The value entered here must be greater than the value at the previous field: Stage 1 Cooling
Temperature Offset. When the number of cooling stage is equal to 1, this filed is not used in
the program. The cooling temperature offset fields are used to determine the cooling stage
number for AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed object. When the
temperature difference of the cooling setpoint and the controlled zone temperature at
previous time step is greater than Stage 2 offset value and less than Stage 3 offset value, the
cooling stage number is 2. When the AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed
object is called, Speed 2 is specified.
Field: Stage 3 Cooling Temperature Offset
This numeric field defines the cooling temperature offset in the units of deltaC for Stage 3.
The value entered here must be greater than the value at the previous field: Stage 3 Cooling
Temperature Offset. When the number of cooling stage is less than 3, this filed is not used in
the program. The cooling temperature offset fields are used to determine the cooling stage
9/29/14

1273

Input-Output Reference

Group Zone Controls Thermostats and Humidistats

number for AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed object. When the

temperature difference of the cooling setpoint and the controlled zone temperature at
previous time step is greater than Stage 3 offset value and less than Stage 4 offset value, the
cooling stage number is 3. When the AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed
object is called, Speed 3 is specified.
Note: If the stage number is not equal to the number of cooling speed in the
AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed object, the minimum value is set to the speed
number for the heat pump object.

Field: Stage 4 Cooling Temperature Offset

This numeric field defines the cooling temperature offset in the units of deltaC for Stage 4.
The value entered here must be greater than the value at the previous field: Stage 4 Cooling
Temperature Offset. When the number of cooling stage is less than 4, this filed is not used in
the program. The cooling temperature offset fields are used to determine the cooling stage
number for AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed object. When the
temperature difference of the cooling setpoint and the controlled zone temperature at
previous time step is greater than Stage 4 offset value, the cooling stage number is 4. When
the AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed object is called, Speed 4 is
specified.
Note: If the stage number is not equal to the number of cooling speed in the
AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed object, the minimum value is set to the speed
number for the heat pump object.

An example of this statement in an IDF is:

ZoneControl:Thermostat:StagedDualSetpoint,
ZoneThermostat,
!- Name
AllZones,
!- Zone or ZoneList Name
2,
!- Number of Heating Stages
Heating Setpoints,
!- Heating Temperature Setpoint Schedule Name
1.1,
!- Heating Throttling Temperature Range {deltaC}
0.0,
!- Stage 1 Heating Temperature Offset {deltaC}
-0.5,
!- Stage 2 Heating Temperature Offset {deltaC}
-1.0,
!- Stage 3 Heating Temperature Offset {deltaC}
-1.5,
!- Stage 4 Heating Temperature Offset {deltaC}
4,
!- Number of Cooling Stages
Cooling Setpoints,
!- Cooling Setpoint Temperature Schedule Name
1.1,
!- Cooling Throttling Temperature Range {deltaC}
0.0,
!- Stage 1 Cooling Temperature Offset {deltaC}
1.0,
!- Stage 2 Cooling Temperature Offset {deltaC}
2.0,
!- Stage 3 Cooling Temperature Offset {deltaC}
3.0;
!- Stage 4 Cooling Temperature Offset {deltaC}

ZoneControl:Humidistat
The humidistat zone control object is used to control a zone to a single relative humidity
setpoint schedule, or to dual humidity setpoint schedules (humidifying/ dehumidifying
setpoints with deadband). The single setpoint humidistat requires single setpoint input only,
and the dual-setpoint humidistat requires inputs of both humidifying and dehumidifying
setpoints. The schedules consist of relative humidities, expressed as a percentage (0-100), to
be used during the simulation for that zones moisture prediction calculation. Only one
humidistat control statement can be specified for each zone. For a single setpoint humidistat,
if the zone relative humidity is below the control relative humidity setpoint and the equipment
9/29/14

1274

Input-Output Reference

Group Zone Controls Thermostats and Humidistats

specified can humidify then that equipment will try and meet the zones humidification load.
The opposite is true if the zone relative humidity is above the control relative humidity
setpoint and the equipment can dehumidify. For a dual setpoint humidistat, if the zone
relative humidity is below the humidifying relative humidity setpoint and the equipment
specified can humidify then that equipment will try and meet the zones humidification load.
The opposite is true if the zone relative humidity is above the dehumidifying relative
humidity setpoint and the equipment can dehumidify.
If the ZoneControl:Humidistat is used by a furnace or unitary system (Ref. Furnace and
Unitary Systems) no other objects are required. The signal from the humidistat is used
directly by that component. If the Zone Control:Humidistat object is used to control a
Humidifier or used in conjunction with a Controller:WaterCoil object with control variable
TemperatureAndHumidityRatio or HumidityRatio, the following objects are required to
determine a setpoint for those components for a single setpoint humidistat:
SetpointManager:SingleZone:Humidity:Minimum
SetpointManager:MultiZone:MinimumHumidity:Average
SetpointManager:MultiZone:MaximumHumidity:Average
SetpointManager:MultiZone:Humidity:Minimum
SetpointManager:MultiZone:Humidity:Maximum
SetpointManager:SingleZone:Humidity:Minimum
For a dual setpoint humidistat, both a maximum humidity setpoint manager object:
SetpointManager:SingleZone:Humidity:Maximum
SetpointManager:MultiZone:MaximumHumidity:Average
SetpointManager:MultiZone:Humidity:Maximum
and a minimum humidity setpoint manager object:
SetpointManager:SingleZone:Humidity:Minimum
SetpointManager:MultiZone:MinimumHumidity:Average
SetpointManager:MultiZone:Humidity:Minimum
are required to determine the setpoints for the corresponding humidification and
dehumidification components.
Field: Name
Unique identifying name for the humidistat.
Field: Zone Name
Name of the zone that is being controlled.
Field: Humidifying Relative Humidity Setpoint Schedule Name
Name of a schedule that defines the humidifying relative humidity setpoint, expressed as a
percentage (0-100), for each timestep of the simulation.
Note: If only a single setpoint humidistat is desired, then input the single schedule name in the Humidifying
Setpoint Schedule Name field (and leave the Dehumidifying Setpoint Schedule Name blank).

Field: Dehumidifying Relative Humidity Setpoint Schedule Name

Name of a schedule that defines the dehumidifying relative humidity setpoint, expressed as a
percentage (0-100), for each timestep of the simulation. This field is optional, only used if a
dual setpoint humidistat is to be modeled.
An example of this statement in an IDF is:

9/29/14

1275

Input-Output Reference
ZoneControl:Humidistat,
Zone 2 Humidistat,
EAST ZONE,
Min Rel Hum Set Sch,
Max Rel Hum Set Sch;

Group Zone Controls Thermostats and Humidistats

!- Humidistat Name
!- Zone Name
!- Humidifying Relative Humidity Setpoint SCHEDULE Name
!- Dehumidifying Relative Humidity Setpoint SCHEDULE Name

An example schedule for the Zone Control:Humidistat

ScheduleTypeLimits,Humidity,0:100,CONTINUOUS;
Schedule:Compact,
Min Rel Hum Set Sch,
Humidity,
Through: 12/31,
For: AllDays,
Until: 24:00,
30.0;
Schedule:Compact,,
Max Rel Hum Set Sch,
Humidity,
Through: 12/31,
For: AllDays,
Until: 24:00,
55.0;

!- Name
!- ScheduleType
!- Complex Field
!- Complex Field
!- Complex Field
!- Complex Field

#1
#2
#3
#4

!- Name
!- ScheduleType
!- Complex Field
!- Complex Field
!- Complex Field
!- Complex Field

#1
#2
#3
#4

ZoneControl Humidistat Outputs

Outputs available from the ZoneControl:Humidistat:
HVAC,Average,Zone Predicted Moisture Load Moisture Transfer Rate [kgWater/s]
HVAC,Average,Zone Predicted Moisture Load to Humidifying Setpoint Moisture Transfer Rate
[kgWater/s]
HVAC,Average,Zone Predicted Moisture Load to Dehumidifying Setpoint Moisture Transfer Rate
[kgWater/s]

Zone Predicted Moisture Load Moisture Transfer Rate [kgWater/s]

This is the predicted latent (moisture) load in kgwater/s required to meet the current zone
humidistat setpoint. A positive value indicates a humidification load, a negative value
indicates a dehumidification load. For a dual setpoint humidistat, the value is zero when the
controlled zones relative humidity is between the defined humidifying and dehumidifying
setpoints. This moisture load rate is calculated and reported from the Predict step in the Zone
Predictor-Corrector module. For nearly all equipment types, the Predictor-Corrector evaluates
the active humidistat setpoints, determines if the zone requires humidification or
dehumidification, and then passes this single load to the equipment for the single setpoint
humidistat case. This value is not multiplied by zone or group multipliers.
Zone Predicted Moisture Load to Humidifying Setpoint Moisture Transfer Rate [kgWater/s]
This is the predicted latent (moisture) load in kgwater/s required to meet the current zone
humidistat humidifying setpoint. This is calculated and reported from the Predict step in the
Zone Predictor-Corrector module. For nearly all equipment types, the Predictor-Corrector
evaluates the active humidistat humidifying setpoints, determines if the zone requires
humidification or not, and then passes this load to the equipment for the case of a dual
setpoint humidistat (see Zone Predicted Moisture Load Moisture Transfer Rate, above, for
single setpoint humidistat case). This value is multiplied by zone or group multipliers.
Zone Predicted Moisture Load to Dehumidifying Setpoint Moisture Transfer Rate
[kgWater/s]
This is the predicted latent (moisture) load in kgwater/s required to meet the current zone
humidistat dehumidifying setpoint. This is calculated and reported from the Predict step in
the Zone Predictor-Corrector module. For nearly all equipment types, the Predictor-Corrector
evaluates the active humidistat humidifying setpoints, determines if the zone requires
dehumidification or not, and then passes this load to the equipment for a dual setpoint
9/29/14

1276

Input-Output Reference

Group Zone Controls Thermostats and Humidistats

humidistat (see Zone Predicted Moisture Load Moisture Transfer Rate, above, for single
setpoint humidistat case). This value is multiplied by zone or group multipliers.
ZoneControl:Thermostat:ThermalComfort
The thermal comfort zone control provides a method to control a zone to a dry-bulb
temperature setpoint based on a thermal comfort model (e.g. Fanger) and a user-specified
thermal comfort setpoint schedule.
This object references a control type schedule and one or more thermal comfort control type
objects which in turn reference one or more setpoint schedules. The example at the end of
this section illustrates a complete zone thermal comfort control specification including the
control type and setpoint schedules. The control type schedule and the list of control
type/name pairs are directly related. The schedule defines the type of control that is to be
used during for each hour. Valid Control Types are
0 Uncontrolled (No thermal comfort control)
1 - Single Thermal Comfort Heating Setpoint:Fanger
2 - Single Thermal Comfort Cooling Setpoint:Fanger
3 - Single Thermal Comfort Heating Cooling Setpoint:Fanger
4 - Dual Thermal Comfort Setpoint with Deadband:Fanger
Thus, if the schedule referenced in the ZoneControl:Thermostat:ThermalComfort statement
has a value of 4 for a particular hour, this indicates that during that hour "Dual Thermal
Comfort Setpoint with Deadband:Fanger" is to be used. The specific "Dual Thermal Comfort
Setpoint with Deadband:Fanger " control object to be used is specified in the list of control
type/name pairs. Then the specific control type objects reference the thermal comfort control
setpoint schedule to be used. Because only one control can be specified for each control type
in a ZoneControl:Thermostat:ThermalComfort statement, there are only four pairs possible in
a particular ZoneControl:Thermostat:ThermalComfort type/name list. This is because
individual controls can be defined hourly, thus giving the user a full range of flexibility. Since
putting in the name of the control type directly in the schedule would be very cumbersome,
the control types are assigned a number which is used in the hourly schedule profile.
The ZoneControl:Thermostat:ThermalComfort object can be used alone, or with a
ZoneControl:Thermostat object. When both control objects co-exist for a specific zone and
the thermal comfort control type value in the thermal comfort control type schedule is nonzero the thermal comfort object will override the value from the zone thermostat object. If the
thermal comfort control is specified as Uncontrolled (thermal comfort control type value of 0)
for a particular period, then control will revert to thermostat control if specified. If the thermal
comfort control is specified as Uncontrolled for a particular period and thermostat control is
not specified in the input, then conditions will float.
This object currently allows only Fanger comfort control (Ref. Thermal Comfort in Engineering
Reference). It requires one or more people objects in a specific zone. It also requires inputs
of Fields Activity Level Schedule Name, Work Efficiency Schedule Name, Clothing Insulation
Schedule Name and Air Velocity Schedule Name in the people object(s). When thermal
comfort control is used in a zone, the air velocity entered in the Air Velocity Schedule (Ref.
People) should be greater than or equal to 0.1 and less than or equal to 0.5 m/s. A warning
message will be issued if thermal comfort control is active and the air velocity is outside this
range.
This object reads input PMV values from a given PMV setpoint schedule to calculate a drybulb temperature setpoint based on the selected thermal comfort model. The dry-bulb
temperature setpoint calculation uses zone air humidity ratio at the previous system timestep
and surface temperatures at the previous zone timestep, along with other conditions at the
current timestep (e.g., activity level, clothing level and air velocity from the PEOPLE object).
Field: Name
Unique identifying name for this thermal comfort control object.
9/29/14

1277

Input-Output Reference

Group Zone Controls Thermostats and Humidistats

Field: Zone or ZoneList Name

Name of the zone or set of zones that is being controlled. When the ZoneList option is used
then this thermostat definition is applied to each of the zones in the zone list effecting a global
definition for thermostatic control in the zone.
Field: Averaging Method
This choice field specifies the method for calculating the thermal comfort dry-bulb
temperature setpoint for a zone with multiple People objects defined. The available choices
are: SpecificObject, ObjectAverage, and PeopleAverage. This field is only used when
multiple people objects are defined for this zone. If this field is specified as PeopleAverage
and the total number of people for all people objects is zero for a particular timestep, the
PeopleAverage method cannot be applied and the program automatically uses the
ObjectAverage method for this timestep. The default input is PeopleAverage.
Field: Object Name for Specific Object Averaging Method
This choice field specifies the name of the specific People object to be used for calculating
comfort control when multiple People objects are defined. Only used if the Averaging Method
is specified as SpecificObject.
Field: Minimum Dry-Bulb Temperature Setpoint
This field specifies the minimum dry-bulb temperature setpoint allowed for this zone. If the
dry-bulb temperature calculated by the thermal comfort setpoint model is below this value,
then the temperature setpoint will be set to this value. The default value is 0 C.
Field: Maximum Dry-Bulb Temperature Setpoint
This field specifies the maximum dry-bulb temperature setpoint allowed for this zone. If the
dry-bulb temperature calculated by the thermal comfort setpoint model exceeds this value,
then the temperature setpoint will be set to this value. The default value is 50 C.
Note the minimum and maximum temperature setpoint fields are provided to allow the user to
bound the temperature control In a specific zone if necessary. These fields are used to
provide boundaries for the dry-bulb temperature setpoint calculated at each system timestep
when unrealistic inputs have been specified.
Field: Thermal Comfort Control Type Schedule Name
Schedule which defines what type of thermal comfort control is active during each simulation
timestep.
Valid Control Types are
0 No thermal comfort control
1 - Single Thermal Comfort Heating Setpoint:Fanger
2 - Single Thermal Comfort Cooling Setpoint:Fanger
3 - Single Thermal Comfort Heating Cooling Setpoint:Fanger
4 - Dual Thermal Comfort Setpoint with Deadband:Fanger
Each non-zero control type used in this schedule must appear in the following fields which list
the specific thermal comfort control objects to be used for this zone.
Field Set (Thermal Comfort Control Object Type, Thermal Comfort Control Name)
Up to four pairs of Thermal Comfort Control Type and Thermal Comfort Control Type Name
fields may be listed to specify which thermal comfort control type objects are used for this
zone. This list is not order-dependent, and the position in this list has no impact on the control
type schedule. In the control type schedule, a value of 1 always means "Single Thermal
Comfort Heating Setpoint:Fanger", even if that control type is not first in this list.
9/29/14

1278

Input-Output Reference

Group Zone Controls Thermostats and Humidistats

Field: Thermal Comfort Control <x> Object Type

This field specifies the first control type name to be used for this zone. Available control types
are:
ThermostatSetpoint:ThermalComfort:Fanger:SingleHeating
ThermostatSetpoint:ThermalComfort:Fanger:SingleCooling
ThermostatSetpoint:ThermalComfort:Fanger:SingleHeatingOrCooling
ThermostatSetpoint:ThermalComfort:Fanger:DualSetpoint

Field: Thermal Comfort Control <x> Name

The unique name for the corresponding thermal comfort control type.
An example of this statement in an IDF is:
ZoneControl:Thermostat:ThermalComfort,
Zone 2 Comfort Control,
!- Thermal Comfort Control Name
EAST ZONE,
!- Zone Name
SpecificObject,
!- Averaging Method for Zones with Multiple People Objects
EAST ZONE,
!- Object Name for Specific Object Averaging Method
12.8,
!- Minimum dry-bulb temperature setpoint
40.0,
!- Maximum dry-bulb temperature setpoint
Zone Comfort Control Type Sched, !- Thermal Comfort Control Type SCHEDULE Name
Dual Thermal Comfort Setpoint WITH DEADBAND:Fanger, !- Control Type #1
Dual Comfort Setpoint;
!- Thermal Comfort Control Type Name #1

Global thermal comfort thermostat example:

ZoneList,AllControlledZones,SPACE1-1,SPACE2-1,SPACE3-1,SPACE4-1,SPACE5-1;
ZoneControl:Thermostat:ThermalComfort,
ControlledZones Comfort Control, !- Name
AllControlledZones,
!- Zone Name
PeopleAverage,
!- Averaging Method
,
!- Specific People Name
12.8,
!- Minimum Dry-Bulb Temperature Setpoint {C}
40.0,
!- Maximum Dry-Bulb Temperature Setpoint {C}
Zone Comfort Control Type Sched, !- Thermal Comfort Control Type Schedule Name
ThermostatSetpoint:ThermalComfort:Fanger:SingleHeating, !- Thermal Comfort Control 1 Object Type
Single Heating Comfort Setpoint, !- Thermal Comfort Control 1 Name
ThermostatSetpoint:ThermalComfort:Fanger:SingleCooling, !- Thermal Comfort Control 2 Object Type
Single Cooling Comfort Setpoint, !- Thermal Comfort Control 2 Name
ThermostatSetpoint:ThermalComfort:Fanger:SingleHeatingOrCooling, !- Thermal Comfort Control 3 Object
Type
Single Heating Cooling Comfort Setpoint, !- Thermal Comfort Control 3 Name
ThermostatSetpoint:ThermalComfort:Fanger:DualSetpoint, !- Thermal Comfort Control 4 Object Type
Dual Comfort Setpoint;
!- Thermal Comfort Control 4 Name

ZoneControl Thermostat ThermalComfort Outputs

Three outputs are available from the ZoneControl:Thermostat:ThermalComfort object. Two
output variables used primarily for the ZoneControl:Thermost object are also described here
to explain their meaning when using thermal comfort control.
ZoneControl:ThermalComfort
Zone,Average,Zone Thermal Comfort Control Type []
Zone,Average,Zone Thermal Comfort Control Fanger Low Setpoint PMV []
Zone,Average,Zone Thermal Comfort Control Fanger High Setpoint PMV []
ZoneControl:Thermostat
Zone,Average,Zone Thermostat Heating Setpoint Temperature [C]
Zone,Average,Zone Thermostat Cooling Setpoint Temperature [C]

Zone Thermal Comfort Control Type []

This is the current zone thermal comfort control type (0 through 4). This value is set at each
system timestep and averaged over the reporting interval. Using the averaged value for
9/29/14

1279

Input-Output Reference

Group Zone Controls Thermostats and Humidistats

longer reporting frequencies (hourly, for example) may not be meaningful in some
applications.
Zone Thermal Comfort Control Fanger Low Setpoint PMV []
This is the current zone thermal comfort low Predicted Mean Vote value. Values range
between -3 and +3. If there is no heating thermal comfort active, then the value reported will
be -999. This value is set at each system timestep and averaged over the reporting interval.
Using the averaged value for longer reporting frequencies (hourly, for example) may not be
meaningful in some applications.
Zone Thermal Comfort Control Fanger High Setpoint PMV []
This is the current zone thermal comfort high Predicted Mean Vote value. Values range
between -3 and +3. If there is no cooling thermal comfort active, then the value reported will
be 999. This value is set at each system timestep and averaged over the reporting interval.
Using the averaged value for longer reporting frequencies (hourly, for example) may not be
meaningful in some applications.
Zone Thermostat Heating Setpoint Temperature [C]
The Zone Control:Thermal Comfort object shares the same output variable and overwrites
the thermal setpoints defined in object Zone Control:Thermostatic when both objects of Zone
Control:Thermostatic and Zone Control:Thermal Comfort co-exist. It outputs the current zone
thermal comfort heating setpoint in degrees C when thermal comfort control is active,
otherwise this output variable will report the thermostat heating setpoint (Ref. Zone
Control:Thermostatic Outputs). If there is no heating thermal comfort active and no
thermostat heating setpoint is defined for this zone, this value will be 0. This value is set at
each system timestep and averaged over the reporting interval. Using the averaged value for
longer reporting frequencies (hourly, for example) may not be meaningful in some
applications.
Zone Thermostat Cooling Setpoint Temperature [C]
This output variable defined in object Zone Control:Thermostatic. The Thermal Comfort
object shares the same output variable and overwrites the thermal setpoints defined in object
Zone Control:Thermostatic when both objects of Zone Control:Thermostatic and Zone
Control:Thermal Comfort co-exist. It outputs the current zone thermal comfort cooling setpoint
in degrees C when thermal comfort control is active, otherwise this output variable will report
the thermostat cooling setpoint (Ref. Zone Control:Thermostatic Outputs). If there is no
cooling thermal comfort active and no thermostat cooling setpoint is defined for this zone, this
value will be 0. This value is set at each system timestep and averaged over the reporting
interval. Using the averaged value for longer reporting frequencies (hourly, for example) may
not be meaningful in some applications.
Thermal Comfort Setpoints
The syntax for the current set (4) of zone thermal comfort control types is given below. In
each case, the keyword is accompanied by an identifying name and either one or two
schedule names (depending on whether the control type is a single or dual setpoint control).
The schedule defines a Predicted Mean Vote (PMV) setpoint for the control type. The
schedule would be defined through the standard schedule syntax described earlier in this
document. For an uncontrolled thermal comfort zone, no Fanger thermal comfort object is
specified or necessary. However, the Fanger thermal comfort output variables, Zone
Thermal Comfort Fanger Model PMV and Zone Thermal Comfort Fanger Model PPD, are
reported for thermal comfort uncontrolled conditions as well (e.i., free floating thermal comfort
condition) just like a free floating temperature and humidity ratio. These are indicative of the
actual thermal comfort level in uncontrolled thermal comfort zone, and are outputs variables
under People objects.

9/29/14

1280

Input-Output Reference

Group Zone Controls Thermostats and Humidistats

ThermostatSetpoint:ThermalComfort:Fanger:SingleHeating
This would be used for heating only thermal comfort control. The PMV setpoint can be
scheduled and varied throughout the simulation but only heating is allowed with this control
type.
Field: Name
Unique name for this control type.
Field: Fanger Thermal Comfort Schedule Name
The name of the associated schedule containing Zone Thermal Comfort Fanger Model PMV
values.
ThermostatSetpoint:ThermalComfort:Fanger:SingleCooling
This would be used for cooling only thermal comfort control. The PMV setpoint can be
scheduled and varied throughout the simulation but only cooling is allowed with this control
type.
Field: Name
Unique name for this control type.
Field: Fanger Thermal Comfort Schedule Name
The name of the associated schedule, containing Zone Thermal Comfort Fanger Model PMV
values.
ThermostatSetpoint:ThermalComfort:Fanger:SingleHeatingOrCooling
This would be used for heating and cooling thermal comfort control but only heating or
cooling can be scheduled at any given time period. The PMV setpoint can be scheduled and
varied throughout the simulation for both heating and cooling.
Field: Name
Unique name for this control type.
Field: Fanger Thermal Comfort Schedule Name
The name of the associated schedule containing Zone Thermal Comfort Fanger Model PMV
values.
ThermostatSetpoint:ThermalComfort:Fanger:DualSetpoint
This would be used for heating and cooling thermal comfort control where both a heating and
cooling PMV setpoint can be scheduled for any given time period. The PMV setpoint can be
scheduled and varied throughout the simulation for both heating and cooling.
Field: Name
Unique name for this control type.
Field: Fanger Thermal Comfort Heating Schedule Name
The name of the associated schedule containing heating setpoint Zone Thermal Comfort
Fanger Model PMV values.
Field: Fanger Thermal Comfort Cooling Schedule Name
The name of the associated schedule containing cooling setpoint Zone Thermal Comfort
Fanger Model PMV values.
An example of this statement in an IDF is:

9/29/14

1281

Input-Output Reference

Group Zone Controls Thermostats and Humidistats

ThermostatSetpoint:ThermalComfort:Fanger:SingleHeating,
Heating Comfort Setpoint,!- Name
Heating PMV Setpoints;
!- Setpoint Temperature SCHEDULE Name
ThermostatSetpoint:ThermalComfort:Fanger:SingleCooling,
Cooling Comfort Setpoint,!- Name
Cooling PMV Setpoints;
!- Setpoint Temperature SCHEDULE Name
ThermostatSetpoint:ThermalComfort:Fanger:SingleHeatingOrCooling,
Heating Cooling Comfort Setpoint,!- Name
Heating Cooling PMV Setpoints;
!- Setpoint Temperature SCHEDULE Name
ThermostatSetpoint:ThermalComfort:Fanger:DualSetpoint,
Dual Comfort Setpoint,
!- Name
Heating PMV Setpoints,
!- Fanger Thermal Comfort Heating Setpoint PMV SCHEDULE Name
Cooling PMV Setpoints;
!- Fanger Thermal Comfort Cooling Setpoint PMV SCHEDULE Name

ZoneControl:ContaminantController
The ZoneControl:ContaminantController object is used for any of the following two purposes
based on the system outdoor air method specified in the Controller:MechanicalVentilation.
1) To control a zone to a specified indoor level of contaminants. When this zone is served

by an AirLoopHVAC, the other zones served by the same AirLoopHVAC will have the
same specified indoor level, if no objects in the other zones served by the same AirLoop
are specified. Currently, the available contaminant controls are carbon dioxide and
generic contaminant controls. The specified carbon dioxide setpoint is used to calculate
the required outdoor airflow rate through the HVAC system to reach the setpoint. The
AirLoopHVAC
system
outdoor
flow
rate
is
realized
by
the
Controller:MechanicalVentilation object with System Outdoor Air Method =
IndoorAirQualityProcedure. The specified generic contaminant setpoint is used to
calculate the required outdoor airflow rate through the HVAC system to reach the
setpoint. The AirLoopHVAC system outdoor flow rate is realized by the
Controller:MechanicalVentilation object with System Outdoor Air Method =
IndoorAirQualityProcedure-GenericContaminant.

2) To specify minimum CO2 concentration schedule name for a zone. The AirLoopHVAC

system outdoor flow rate is realized by the Controller:MechanicalVentilation object with

System Outdoor Air Method = ProportionalControl. Carbon Dioxide Control Availability
Schedule Name determines the availability of ProportionalControl.
For the first purpose above, when multiple zones are served by an AirLoop, those zones that
do not have a contaminant controller object specified in the input data file are automatically
assigned a carbon dioxide setpoint. Zone objects entered in the input data file are internally
assigned an index number from 1 to n (first defined Zone object = 1, next Zone object defined
in the input file = 2, etc.). For zones served by an AirLoop that do not have a contaminant
controller specified, the zones carbon dioxide setpoint will be the same as the zone with the
next highest zone index number that has a contaminant controller specified. If a zone with a
higher index number and contaminant controller specified does not exist, then the zone with
the next lowest zone index number that has a contaminant controller specified will be used.
For example, assume an AirLoop serves zones 1 through 5, but one
ZoneControl:ContaminantController object is specified for zone 2, a second
ZoneControl:ContaminantController object is specified for zone 4, and no
ZoneControl:ContaminantController objects are specified for zones 1, 3 and 5. In this case,
zone 1 will be assigned the carbon dioxide setpoint schedule that was specified for zone 2,
and zones 3 and 5 will be assigned the carbon dioxide setpoint schedule that was specified
for zone 4.
Field: Name
Unique identifying name for the ZoneControl:ContaminantController.

9/29/14

1282

Input-Output Reference

Group Zone Controls Thermostats and Humidistats

Field: Controlled Zone Name

Name of the zone that is being controlled.
Field: Carbon Dioxide Control Availability Schedule Name
This field contains the name of a schedule that determines whether or not the
ZoneControl:ContaminantController is available. When the schedule value is zero, the
ZoneControl:ContaminantController is bypassed (not available to operate). When the
schedule value is greater than zero, the ZoneControl:ContaminantController is available and
will be used to calculate the required outdoor airflow rate to reach the carbon dioxide
setpoint. If this field is left blank, the schedule has a value of 1 for all time periods. Schedule
values must be between 0 and 1.
Field: Carbon Dioxide Setpoint Schedule Name
This field contains the name of a schedule that contains the zone carbon dioxide
concentration setpoint as a function of time. The units for carbon dioxide setpoint are ppm.
The setpoint values in the schedule must be between 0 and 2000 ppm. . This field is used
when the field System Outdoor Air Method = IndoorAirQualityProcedure in the
Controller:MechanicalVentilation object.
Field: Minimum Carbon Dioxide Concentration Schedule Name
This field contains the name of a schedule that contains the minimum zone carbon dioxide
concentration setpoint as a function of time. The units for carbon dioxide setpoint are ppm.
This field is used when the field System Outdoor Air Method = ProportionalControl in the
Controller:MechanicalVentilation object.
Field: Generic Contaminant Control Availability Schedule Name
This field contains the name of a schedule that determines whether or not the
ZoneControl:ContaminantController is available. When the schedule value is zero, the
generic contaminant control will not be performed. When the schedule value is greater than
zero, the ZoneControl:ContaminantController is available and will be used to calculate the
required outdoor airflow rate to reach the generic contaminant setpoint. If this field is left
blank, the schedule has a value of 1 for all time periods. Schedule values must be between 0
and 1.
Field: Generic Contaminant Setpoint Schedule Name
This field contains the name of a schedule that contains the zone generic contaminant
concentration setpoint as a function of time. The units for generic contaminant setpoint are
ppm. The setpoint values in the schedule must be>=0.
An IDF example is provided below:
ZoneControl:ContaminantController,
CO2 Controller1,
!- Name
EAST ZONE,
!- Controlled Zone Name
CO2AvailSchedule,
!- Carbon Dioxide Control Availability Schedule
Name
CO2SetpointSchedule,
!- Carbon Dioxide Setpoint Schedule Name
,
!- Minimum Carbon Dioxide Concentration Schedule
Name
GCAvailSchedule,
!- Generic Contaminant Control Availability
Schedule Name
GCSetpointSchedule;
!- Generic Contaminant Setpoint Schedule Name

9/29/14

1283

Input-Output Reference

Group -- Air Path

ZoneControl Contaminant Controller Outputs

The following output variables are available when the ZoneControl:ContaminantController
object is specified.
HVAC,Average,Zone
HVAC,Average,Zone
HVAC,Average,Zone
Flow Rate [kg/s]
HVAC,Average,Zone

Air CO2 Predicted Load to Setpoint Mass Flow Rate [kg/s]

Air CO2 Setpoint Concentration [ppm]
Generic Air Contaminant Predicted Load to Setpoint Mass
Generic Air Contaminant Setpoint Concentration [ppm]

Zone Air CO2 Predicted Load to Setpoint Mass Flow Rate [kg/s]
This output is the average predicted outdoor airflow rate in kg/s required to meet the current
zone carbon dioxide setpoint for the time step being reported. This value is calculated and
reported from the Predict step in the Zone Contaminant Predictor-Corrector module. The
calculated outdoor airflow rate will be specified in the Controller:MechanicalVentilation object
with System Outdoor Air Method = IndoorAirQualityProcedure to provide enough outdoor
ventilation air to keep the zone air carbon dioxide concentration level at or below the setpoint.
Zone Air CO2 Setpoint Concentration [ppm]
This output variable is the average carbon dioxide setpoint value, in parts per million, for the
time step being reported.
Zone Generic Air Contaminant Predicted Load to Setpoint Mass Flow Rate [kg/s]
This output is the average predicted outdoor airflow rate in kg/s required to meet the current
zone generic contaminant setpoint for the time step being reported. This value is calculated
and reported from the Predict step in the Zone Contaminant Predictor-Corrector module. The
calculated outdoor airflow rate will be specified in the Controller:MechanicalVentilation object
with System Outdoor Air Method = IndoorAirQualityProcedure-GenericContaminant to
provide enough outdoor ventilation air to keep the zone air generic contaminant concentration
level at or below the setpoint.
Zone Generic Air Contaminant Setpoint Concentration [ppm]
This output variable is the average generic contaminant setpoint value, in parts per million,
for the time step being reported.

Group -- Air Path

AirLoopHVAC:SupplyPath, AirLoopHVAC:ReturnPath
The zone supply and return air paths are used to describe the configuration of the flow path
that the supply air takes in moving from the main air handler to the zone terminal units and
that the return air takes on leaving the zones and returning to the central return air duct. The
air paths consist of a group of components AirLoopHVAC:ZoneSplitters and
AirLoopHVAC:SupplyPlenums for the supply path and AirLoopHVAC:ReturnPlenums and
AirLoopHVAC:ZoneMixers for the return path. The connectivity of the paths is established by
the components node connections. There are no branches defined in the zone air path
constructs.
For a typical single duct air system there will be one AirLoopHVAC:SupplyPath and one
AirLoopHVAC:ReturnPath.
A
typical
dual
duct
system
would
have
2
AirLoopHVAC:SupplyPaths one for the hot air and one for the cold air and 1
AirLoopHVAC:ReturnPath.
The AirLoopHVAC:SupplyPlenum component provides the capability to have supply air
distributed to the conditioned zones through one or more plenum zones such as would occur
in an underfloor air distribution system (UFAD). The AirLoopHVAC:ReturnPlenum component
9/29/14

1284

Input-Output Reference

Group -- Air Path

allows the program to model return air plenums. Of course plenums are always optional. The
simplest AirLoopHVAC:SupplyPath would consist of only an AirLoopHVAC:ZoneSplitter;
similarly the simplest return air path consists of a single AirLoopHVAC:ZoneMixer. A UFAD
system supply air path might consist of a single AirLoopHVAC:ZoneSplitter connecting to
multiple AirLoopHVAC:SupplyPlenums which in turn could each supply one or more
conditioned zones. A system with return plenums would have an AirLoopHVAC:ReturnPath in
which the conditioned zones connect to the return plenum inlets and the return plenums
outlets connect to a single AirLoopHVAC:ZoneMixer.
Both the zone supply and return plenums are solved in the heat balance as thermal zones
which couple through heat conduction with adjacent zones. Since they are solved as thermal
zones the solution scheme involves the zone predictor-corrector technique which will lag the
temperature at the system timestep in every zone. See Summary of Predictor-Corrector
Procedure in the EnergyPlus Engineering Reference.
Below are the descriptions of the zone supply and return path statements. Note that each
statement type has an identifying name, a single inlet/outlet node name, and a list of
component type/name pairs. For a single zone being served by an air loop, the inlet to its air
distribution unit and the zone return air outlet can be the zone equipment inlet and outlet
nodes directly, thus eliminating the need to specify an AirLoopHVAC:SupplyPath and an
AirLoopHVAC:ReturnPath.
AirLoopHVAC:SupplyPath
The AirLoopHVAC:SupplyPath lists one or more AirLoopHVAC:ZoneSplitter and
AirLoopHVAC:SupplyPlenum components comprising the path. The components are listed in
flow order: upstream to downstream and may be in series, parallel, or both. Connectivity is
established by means of the individual component inlet and outlet nodes.
Field: Name
Unique name to identify the supply air path..
Field: Supply Air Path Inlet Node Name
The name of an inlet node for the zone equipment half of the air loop. This should be one of
the nodes named in the AirLoopHVAC field: Demand Side Inlet Node Names.
Field Set Component Type and Name
The remaining fields are sets of two repeated times: a component type and a name. These
pairs of fields define the components on the supply air path.
Field: Component <#> Object Type
Start of the component list for the AirLoopHVAC:SupplyPath. This field should contain either
AirLoopHVAC:SupplyPlenum or AirLoopHVAC:ZoneSplitter.
Field: Component <#> Name
Unique name of the AirLoopHVAC:SupplyPlenum or AirLoopHVAC:ZoneSplitter component.
AirLoopHVAC:ReturnPath
The AirLoopHVAC:ReturnPath lists one or more AirLoopHVAC:ZoneMixer and
AirLoopHVAC:ReturnPlenum components comprising the path. The components are listed in
flow order: upstream to downstream and may be in series, parallel, or both. Connectivity is
established by means of the individual component inlet and outlet nodes. At this time there
can only be 1 AirLoopHVAC:ZoneMixer in an AirLoopHVAC:ReturnPath.
Field: Name
Unique name to identify the return air path.

9/29/14

1285

Input-Output Reference

Group -- Air Path

Field: Return Air Path Outlet Node Name

The name of the node that is the outlet to the air loop from the AirLoopHVAC:ReturnPath.
This should be the same node named in the AirLoopHVAC field: Demand Side Outlet Node
Name.
Field Set Component Type and Name
The remaining fields are sets of two repeated times: a component type and a name. These
pairs of fields define the components on the return air path.
Field: Component <#> Object Type
Start of the component list for the AirLoopHVAC:ReturnPath. This field should contain either
AirLoopHVAC:ReturnPlenum or AirLoopHVAC:ZoneMixer.
Field: Component <#> Name
Unique name of the AirLoopHVAC:ReturnPlenum or AirLoopHVAC:ZoneMixer.
Example inputs are shown below
AirLoopHVAC:SupplyPath,
SupplyAirPath 1,
Zone Equip In Node,
AirLoopHVAC:SupplyPlenum,
Supply-Plenum-1,
AirLoopHVAC:ZoneSplitter,
Zone Supply Air Splitter 1;
AirLoopHVAC:ReturnPath,
ReturnAirPath1,
PLENUM-1 Out Node,
Zone Return Plenum,
Return-Plenum-1;

!!!!!!-

Name
Supply Air Path Inlet Node Name
Component 1 Object Type
Component 1 Name
Component 2 Object Type
Component 2 Name

!!!!-

Name
Return Air Path Outlet Node Name
Component 1 Object Type
Component 1 Name

AirLoopHVAC:ReturnPlenum
The simple building shown in the figure below consists of a controlled zone and a return
plenum zone that is used for the return air. This simple configuration contains a ground floor
controlled zone with a window and a return plenum zone which handles the roof load. The
return air plenum is a special type of component since there is both a heat balance
connection and building description and a system airflow connection that transfers the airflow
directly from the controlled zone to the return plenum zone in the system air simulation. The
input described in this section is mainly just for the system airflow connections in the HVAC
algorithms. In addition the return plenum zone must be fully input as a zone object for the
heat balance calculation. The zone description needs to contain the wall descriptions - the
interzone ceiling and floor, and for this simple case the roof. All the other attributes of a zone
that can be specified in the building description can be used with a return plenum zone if
necessary: scheduled loads, windows, etc.

9/29/14

1286

Input-Output Reference

Group -- Air Path

Figure 130. Illustration of Zone Return Plenum

After all the building zone attributes are specified, the AirLoopHVAC:ReturnPlenum object is
specified and included as one of the named components in an AirLoopHVAC:ReturnPath.
Field: Name
A unique identifying name identifying the AirLoopHVAC:ReturnPlenum system component.
Field: Zone Name
The zone name specified in the heat balance portion of the input. This piece of input
connects the zone return plenum system component to the heat balance data structure.
Field: Zone Node Name
The name of the zone node. The zone node name connects the heat balance data structure
to the system airflow data structure through this node. This node name is defined by the user
in the field Zone Air Node Name in the ZoneHVAC:EquipmentConnections object for the
zone named in the previous field.
Field: Outlet Node Name
The name of the return plenum outlet node. For the zone return plenum there is only one
outlet node that can be specified.
Field: Induced Air Outlet Node or NodeList Name
The name of an induced air outlet node or the name of a NodeList of such nodes. These
nodes are to be used as the secondary inlet air nodes of powered induction terminal units
(See AirTerminal:SingleDuct:SeriesPIU:Reheat and
AirTerminal:SingleDuct:ParallelPIU:Reheat).
Field: Inlet <#> Node Name
The name of a plenum inlet node. There is no limit to the number of inlet nodes, and there
may be no duplicate inlet node names. (Note that some EnergyPlus editing tools may allow
only 500 inlet node names, but this may be increased by extending the object in the
Energy+.idd file.)
An IDF example of a zone return plenum component specification:

9/29/14

1287

Input-Output Reference

Group -- Air Path

AirLoopHVAC:ReturnPlenum,
Return-Plenum-1,
PLENUM-1,
PLENUM-1 Node,
PLENUM-1 Out Node,
PLENUM-1 Induced Air Nodes,
SPACE1-1 Out Node,
SPACE2-1 Out Node,
SPACE3-1 Out Node,
SPACE4-1 Out Node,
SPACE5-1 Out Node;
NodeList,
PLENUM-1
SPACE1-1
SPACE2-1
SPACE3-1
SPACE4-1

Induced
ATU Sec
ATU Sec
ATU Sec
ATU Sec

Air Nodes,
Node,
Node,
Node,
Node;

!!!!!!!!!!-

Name
Zone Name
Zone Node Name
Outlet Node Name
Induced Air Outlet Node or NodeList Name
Inlet 1 Node Name
Inlet 2 Node Name
Inlet 3 Node Name
Inlet 4 Node Name
Inlet 5 Node Name
!!!!!-

Name
Node
Node
Node
Node

1
2
3
4

Name
Name
Name
Name

Below is an example of the AirLoopHVAC:ReturnPath for the simple case shown above.
AirLoopHVAC:ReturnPath,
ReturnAirPath1,
!PLENUM-1 Out Node,
!AirLoopHVAC:ReturnPlenum,!Return-Plenum-1;
!-

Name
Return Air Path Outlet Node Name
Component 1 Object Type
Component 1 Name

AirLoopHVAC:SupplyPlenum
The building shown in the figure below consists of three controlled zones served by an
AirLoopHVAC:SupplyPlenum beneath the floor.

Figure 131. Illustration of AirLoopHVAC:SupplyPlenum

The AirLoopHVAC:SupplyPlenum has a heat balance connection and building description,
and a system airflow connection which transfers the airflow from the supply plenum zone to
the controlled zones in the system simulation. The input described in this section is mainly
just for the system airflow connections in the HVAC algorithms. In addition the supply plenum
zone must be fully input in the building zone description. The supply plenum zone description
needs to contain the wall descriptions, the interzone ceiling and floor, and the ground

9/29/14

1288

Input-Output Reference

Group -- Air Path

connection. All the other attributes of a zone that can be specified in the building description
can be utilized with a supply plenum zone if necessary, i.e. scheduled loads, windows, etc.
After all the building zone attributes are specified, the AirLoopHVAC:SupplyPlenum object is
specified and included as one of the named components in an AirLoopHVAC:SupplyPath.
Field: Name
A unique identifying name identifying the AirLoopHVAC:SupplyPlenum system component.
Field: Zone Name
The zone name specified in the heat balance portion of the input. This piece of input
connects the AirLoopHVAC:SupplyPlenum system component to the heat balance data
structure.
Field: Zone Node Name
The name of the zone node. The zone node name connects the heat balance data structure
to the system airflow data structure through this node. This node name is defined by the user
in the field Zone Air Node Name in the ZoneHVAC:EquipmentConnections object for the
zone named in the previous field.
Field: Inlet Node Name
The name of the inlet node to the supply plenum. The AirLoopHVAC:SupplyPlenum
component can send air to many outlets, but there is only one inlet.
Field: Outlet <#> Node Name
The name of a plenum outlet node. There is no limit to the number of outlet nodes, and there
may be no duplicate outlet node names. (Note that some EnergyPlus editing tools may allow
only 500 outlet node names, but this may be increased by extending the object in the
Energy+.idd file.)
An IDF example of an AirLoopHVAC:SupplyPlenum component specification:
AirLoopHVAC:SupplyPlenum,
Supply Plenum 1,
SUPPLY PLENUM ZONE,
Supply Plenum 1 Zone Node,
Zone Equipment Inlet Node,
Supply Plenum 1 Outlet Node;

!
!
!
!
!

Name
Zone Name
Zone Node Name
Inlet Node Name
Outlet 1 Node Name

Below is an example of the AirLoopHVAC:SupplyPath for the building shown above.

AirLoopHVAC:SupplyPath,
TermReheatSupplyPath,
Zone Equipment Inlet Node,
AirLoopHVAC:SupplyPlenum,
Supply Plenum 1,
AirLoopHVAC:ZoneSplitter,
Zone Supply Air Splitter;

!
!
!
!
!
!

Name
Supply Air Path Inlet Node Name
Component 1 Object Type
Component 1 Name
Component 2 Object Type
Component 2 Name

AirLoopHVAC:ZoneSplitter
The AirLoopHVAC:ZoneSplitter is a component that splits airflow from a single inlet to
multiple outlets. This component must be referenced in an AirLoopHVAC:SupplyPath object.
The input contains only node connection information.
Field: Name
Unique name for this zone splitter.
Field: Inlet Node Name
The name of the single inlet node going into the splitter.

9/29/14

1289

Input-Output Reference

Group -- Non-Zone Equipment

Field: Outlet <#> Node Name

The name of a splitter outlet node. There is no limit to the number of outlet nodes, and there
may be no duplicate outlet node names. (Note that some EnergyPlus editing tools may allow
only 500 outlet node names, but this may be increased by extending the object in the
Energy+.idd file.)
An example is shown below.
AirLoopHVAC:ZoneSplitter,
Zone Supply Air Splitter,
Zone Equipment Inlet Node,
Zone 1 Damper Inlet Node,
Zone 2 Damper Inlet Node,
Zone 3 Damper Inlet Node;

!
!
!
!
!

Name
Inlet Node Name
Outlet 1 Node Name
Outlet 2 Node Name
Outlet 3 Node Name

AirLoopHVAC:ZoneMixer
The AirLoopHVAC:ZoneMixer takes the air from multiple inlets and mixes the streams
together to be sent out of a single outlet node. This is a simple process of summing flows and
averaging the air properties. This compoment may be part of an air loop return path or part of
an induction terminal unit. When used as a return air mixer, this component must be listed in
an AirLoopHVAC:ReturnPath object, and the inlets may be zone return air nodes or
AirLoopHVAC:ReturnPlenum outlet nodes. When used in an induction terminal unit (ref.
AirTerminal:SingleDuct:SeriesPIU:Reheat, AirTerminal:SingleDuct:ParallelPIU:Reheat, and
AirTerminal:SingleDuct:ConstantVolume:FourPipeInduction), one inlet node is the supply
(primary) air inlet from the central air handler, and the second inlet node is the induced
(secondary) air inlet. These node names should match equivalent node names in the terminal
unit.
Field: Name
Unique name for this zone mixer.
Field: Outlet Node Name
The name of the single outlet node leaving the mixer.
Field: Inlet <#> Node Name
The name of a mixer inlet node. There is no limit to the number of inlet nodes, and there may
be no duplicate inlet node names. (Note that some EnergyPlus editing tools may allow only
500 inlet node names, but this may be increased by extending the object in the Energy+.idd
file.)
An input example is shown below.
AirLoopHVAC:ZoneMixer,
Zone Return Air Mixer,
! Name
Return Air Mixer Outlet Node, ! Outlet Node Name
Zone 1 Outlet Node,
! Inlet 1 Node Name
Zone 2 Outlet Node,
! Inlet 2 Node Name
Zone 3 Outlet Node;
! Inlet 3 Node Name

Group -- Non-Zone Equipment

The non-zone equipment group consists of plant objects that connect to the demand side of
the plant loop but are not associated with a a specific Zone (and do not have their own
group). There is currently one non-zone equipment object called LoadProfile:Plant. This
object places a scheduled demand load on the plant.
Non-zone equipment allows the option of performing a plant-only EnergyPlus simulation, i.e.
without any zones. This can be useful for comparing the performance of various plant
configurations or components without the added complexity of a full building description.

9/29/14

1290

Input-Output Reference

Group -- Non-Zone Equipment

LoadProfile:Plant
The LoadProfile:Plant object is used to simulate a scheduled demand profile. This can be
useful when the building loads are already known. Demanded load and flow rate are
schedules specified in the object definition. The load profile can specify heating and cooling
loads. Cooling loads are entered as negative numbers. The actual load met is dependent on
the performance of the supply loop components.
The LoadProfile:Plant object must be connected on the demand side of the plant loop. It
should be located on a Branch with its control type set to Active. If desired, multiple
LoadProfile:Plant objects can be combined in series and/or parallel.
Field: Name
The unique name of the LoadProfile:Plant object.
Field: Inlet Node Name
The name of the inlet node connection to the plant loop.
This node should be on the demand side.
Field: Outlet Node Name
The name of the outlet node connection to the plant loop.
Field: Load Schedule Name
Reference to the schedule object specifying the load profile [W].
Field: Peak Flow Rate
The peak demanded water flow rate [m 3/s]. This value is multiplied by the flow rate fraction
schedule values (below) to determine the actual volumetric flow rate.
Field: Flow Rate Fraction Schedule Name
Reference to the schedule object specifying the flow rate fraction relative to the value in the
field Peak Flow Rate (above).
An example of this object follows.
LoadProfile:Plant,
Load Profile 1,
Demand Load Profile
Demand Load Profile
Load Profile 1 Load
0.003,
Load Profile 1 Flow

1 Inlet Node,
1 Outlet Node,
Schedule,
Frac Schedule;

!!!!!!-

Name
Inlet Node Name
Outlet Node Name
Load Schedule Name {W}
Peak Flow Rate {m3/s}
Flow Rate Fraction Schedule Name

LoadProfile Plant Outputs

The following output variables and meters are reported for the LoadProfile:Plant object:
HVAC,Average,Plant Load Profile Mass Flow Rate [kg/s]
HVAC,Average,Plant Load Profile Heat Transfer Rate [W]
HVAC,Sum,Plant Load Profile Heat Transfer Energy [J]
HVAC,Sum,Plant Load Profile Heating Energy [J]
HVAC,Sum,Plant Load Profile Cooling Energy [J]

Plant Load Profile Mass Flow Rate [kg/s]

This is the mass flow of the fluid passing through the load profile object, in kg/s.

9/29/14

1291

Input-Output Reference

Group Solar Collectors

Plant Load Profile Heat Transfer Rate [W]

Plant Load Profile Heat Transfer Energy [J]
These report the overall heat transfer rate and energy for the load profile object, in Watts or
Joules.
Plant Load Profile Cooling Energy [J]Plant Load Profile Heating Energy [J]
These report the overall cooling or heating energy that the load profile object places on the
plant loop, in Joules.
The inlet and outlet node temperatures and mass flow rates can be monitored using the
system node output variables:
HVAC,Average,System Node Temperature [C]
HVAC,Average,System Node Mass Flow Rate [kg/s]

Group Solar Collectors

Solar collectors are thermal devices that convert solar energy into thermal energy by raising
the temperature of a circulating heat transfer fluid. The fluid can then be used to heat water
for domestic hot water usage or space heating.
In EnergyPlus solar collectors are components that are connected to the plant loop. A solar
heating system can be constructed with a combination of solar collectors, pumps, and hot
water tanks.
Flate plate solar collectors are defined using two objects: SolarCollector:FlatPlate:Water and
SolarCollectorPerformance:FlatPlate. Similarly, Integral-Collector-Storage (ICS) solar
collectors are defined using two objects: SolarCollector:IntegralCollectorStorage, and
SolarCollectorPerformance:IntegralCollectorStorage. The SolarCollector:FlatPlate:Water and
SolarCollector:IntegralCollectorStorage objects describe the plant component connections.
These
object
also
reference
SolarCollectorPerformance:FlatPlate
and
SolarCollectorPerformance:IntegralCollectorStorage performance objects which contains the
thermal and optical performance test data for a specific make and model of collector.
Parameters are defined separately so that these values can be organized into a reference
data set and need only be entered once if for an array of the same type of collectors.
SolarCollector:FlatPlate:Water
The flat-plate solar collector model simulates glazed, unglazed, and tubular (i.e. evacuated
tube) collectors. The SolarCollector:FlatPlate:Water object represents a single collector
module connected to the plant loop. The thermal and optical properties of the collector
module are taken from the referenced SolarCollectorPerformance:FlatPlate object. A surface
or shading object defines the collector tilt, azimuth, and gross area. The collector surface
participates normally in all shading calculations if the "FullExterior," "FullInteriorAndExterior,"
FullExteriorWithReflections , or FullInteriorAndExteriorWithReflections flags are set in the
Solar Distribution field of the Building object. Inlet and outlet nodes are specified for plant
connections on the demand side of the plant loop.
Field: Name
The unique name of the SolarCollector:FlatPlate:Water object.
Field: Solar Collector Performance Name
Reference name of a SolarCollectorPerformance:FlatPlate object that defines the thermal
and optical properties of the collector.

9/29/14

1292

Input-Output Reference

Group Solar Collectors

Field: Surface Name

Reference to one of the many different types of surfaces such as the
BuildingSurface:Detailed or the Shading:Zone:Detailed objects. The surface named here is
used to define the solar collector tilt, azimuth, and gross area.
Field: Inlet Node Name
The name of the inlet node connection to the plant loop.
Field: Outlet Node Name
The name of the outlet node connection to the plant loop.
Field: Maximum Flow Rate
The maximum flow rate [m 3/s] allowed through the collector. This field is optional. If not
specified, the collector will allow as much flow as the rest of the plant can deliver.
An example follows.
SolarCollector:FlatPlate:Water,
Collector 1,
ACR Solar International Fireball 2001,
Collector Surface,
Collector Inlet Node,
Collector Outlet Node,
0.00005;

!!!!!!-

Name
Solar Collector Performance Name
Surface Name
Inlet Node Name
Outlet Node Name
Maximum Flow Rate (m3/s)

Solar Collector FlatPlate Water Output

The following output variables are reported for the SolarCollector:FlatPlate:Water object:
HVAC,Average,Solar Collector Incident Angle Modifier []
HVAC,Average,Solar Collector Efficiency []
HVAC,Average,Solar Collector Heat Transfer Rate [W]
HVAC,Average,Solar Collector Heat Gain Rate [W]
HVAC,Average,Solar Collector Heat Loss Rate [W]
HVAC,Sum,Solar Collector Heat Transfer Energy [J]

Solar Collector Incident Angle Modifier [ ]

The incident angle modifier is an important intermediate value used in the SRCC calculation
of solar collector performance. The value reported here is the combined result for the current
time that includes incident angles of beam solar, diffuse solar from sky, and diffuse solar from
ground.
Solar Collector Efficiency [ ]
The overall collector efficiency. This is the ratio of collected energy and the incident solar
energy. The efficiency can be greater than 1 at times when the outdoor air temperature is
warm enough.
Solar Collector Heat Transfer Rate [W]
Solar Collector Heat Transfer Energy [J]
These are the overall rate (in W) and amount of energy ( in J) transferred to the collectors
circulating fluid. Positive values indicate heating of the fluid while negative values indicate
cooling of the fluid.
Solar Collector Heat Gain Rate [W]
This is the overall rate of heat addition to the collectors circulating fluid in Watts. Values are
always positive or zero. If the fluid is actually cooled then the value is zero.

9/29/14

1293

Input-Output Reference

Group Solar Collectors

Solar Collector Heat Loss Rate [W]

This is the overall rate of heat loss from the collectors circulating fluid in Watts. Values are
always positive or zero. If the fluid is actually heated then the value is zero.
In addition, several surface variables are also relevant for the collectors surface object
(BuildingSurface:Detailed or Shading:Zone:Detailed):
Zone,Average,Surface
Zone,Average,Surface
Zone,Average,Surface
[W/m2]
Zone,Average,Surface
[W/m2]
Zone,Average,Surface
per Area [W/m2]
Zone,Average,Surface
Rate per Area [W/m2]
Zone,Average,Surface

Outside Face Sunlit Area [m2]

Outside Face Sunlit Fraction []
Outside Face Incident Solar Radiation Rate per Area
Outside Face Incident Beam Solar Radiation Rate per Area
Outside Face Incident Sky Diffuse Solar Radiation Rate
Outside Face Incident Ground Diffuse Solar Radiation
Outside Face Beam Solar Incident Angle Cosine Value []

The temperatures at the inlet and outlet nodes and the collector mass flow rate can be
monitored using the system node output variables:
HVAC,Average,System Node Temperature [C]
HVAC,Average,System Node Mass Flow Rate [kg/s]

SolarCollectorPerformance:FlatPlate
The SolarCollectorPerformance:FlatPlate object contains the thermal and optical
performance parameters for a single collector module. These parameters are based on the
testing methodologies described in ASHRAE Standards 93 and 96. The Solar Rating and
Certification Corporation (SRCC) applies these standards in their rating procedures of solar
collectors. The ratings for commercially available collectors in North America are published in
the Directory of SRCC Certified Solar Collector Ratings. The SRCC database has also been
converted into an EnergyPlus data set of SolarCollectorPerformance:FlatPlate objects that is
included with the program (see SolarCollectors.idf in the DataSets folder).
The coefficients for the energy conversion efficiency and incident angle modifier allow first
order (linear) or second order (quadratic) correlations. To use a first order correlation, the
second order coefficient must be left blank or set to zero.
In order for the model to work correctly, the test conditions for which the performance
coefficients were measured must be specified in the fields: Test Fluid, Test Volumetric Flow
Rate, and Test Correlation Type. Currently, only water is allowed as the Test Fluid.
For more detailed information about the performance coefficients, see the EnergyPlus
Engineering Reference Document.
Field: Name
The unique name of the SolarCollectorPerformance:FlatPlate object.
Field: Gross Area
The gross area of the collector module [m 2]. This value is mainly for reference. The area of
the associated collector surface object is used in all calculations.
Field: Test Fluid
The fluid that was used in the testing procedure that resulted in the thermal and optical
performance coefficients below. Currently only Water is allowed. This the fluid during the
collector testing, not the fluid used during a particular EnergyPlus run.

9/29/14

1294

Input-Output Reference

Group Solar Collectors

Field: Test Flow Rate

The volumetric flow rate during testing [m 3/s]. If the value is available as flow rate per unit
area, it is recommended to multiply by the Gross Area of the collector module, not the net
aperture area.
Field: Test Correlation Type
This field specifies type of temperature used to develop the correlation equations. The
testing procedure is based on an experimental correlation using either Inlet, Average, or
Outlet temperature. Enter one of these choices. The ASHRAE Standards 93 and 96 always
use Inlet temperature.
Field: Coefficient 1 of Efficiency Equation
First coefficient of efficiency equation for energy conversion [dimensionless]. This is the Yintercept term.
Field: Coefficient 2 of Efficiency Equation
Second coefficient of efficiency equation for energy conversion [W/m 2-K]. This is the firstorder term.
Field: Coefficient 3 of Efficiency Equation
Third coefficient of efficiency equation for energy conversion [W/m 2-K2]. This field is optional.
This is the second-order term. If left blank or set to zero, a first-order linear correlation is
used.
Field: Coefficient 2 of Incident Angle Modifier
Second coefficient of the incident angle modifier equation. This the first-order term. (There is
no Coefficient 1 of Incident Angle Modifier because that number is always 1.0.)
Field: Coefficient 3 of Incident Angle Modifier
Third coefficient of the incident angle modifier equation. This is the second-order term. This
field is optional. If left blank or set to zero, a first order linear correlation is used.
An example of this object follows.
SolarCollectorPerformance:FlatPlate,
Alternate Energy Technologies AE-32, !- Name
2.9646,
!- Gross Area {m2}
WATER,
!- Test Fluid
0.0000388,
!- Test Flow Rate {m3/s}
INLET,
!- Test Correlation Type
0.691,
!- Coefficient 1 of Efficiency Equation {dimensionless}
-3.396,
!- Coefficient 2 of Efficiency Equation {W/m2-K}
-0.00193,
!- Coefficient 3 of Efficiency Equation {W/m2-K2}
-0.1939,
!- Coefficient 2 of Incident Angle Modifier
-0.0055;
!- Coefficient 3 of Incident Angle Modifier

SolarCollectorPerformance:FlatPlate Output
This object does not generate any output; see SolarCollector:FlatPlate:Water Output
SolarCollector:IntegralCollectorStorage
The Integral-Collector-Storage (ICS) solar collector model simulates glazed collectors with
integral storage unit. The SolarCollector:IntegralCollectorStorage object represents a single
collector module connected to the plant loop. The thermal and optical properties of the
collector
module
are
calculated
from
inputs
in
SolarCollectorPerformance:IntegralCollectorStorage object. A surface or shading object
defines the collector tilt, and azimuth. The collector surface participates normally in all
shading
calculations
if
the
"FullExterior,"
"FullInteriorAndExterior,"
9/29/14

1295

Input-Output Reference

Group Solar Collectors

FullExteriorWithReflections , or FullInteriorAndExteriorWithReflections flags are set in the

Solar Distribution field of the Building object. Inlet and outlet nodes are specified for plant
connections
on
the
demand
side
of
the
plant
loop.
The
SurfaceProperty:ExteriorNaturalVentedCavity, object is required to describe the surface
properties, the characteristics of the cavity and opening for natural ventilation if
OtherSideConditionsModel is specified as the collector bottom surface outside boundary
condition type.
Field: Name
The unique name of the SolarCollector:IntegralCollectorStorage object.
Field: Solar Collector Performance Name
Reference name of a SolarCollectorPerformance:IntegralCollectorStorage object that defines
the thermal and optical properties of the collector.
Field: Surface Name
Reference to one of the many different types of surfaces such as the
BuildingSurface:Detailed or the Shading:Zone:Detailed objects. The surface named here is
used to define the solar collector tilt, and azimuth. The collector shades the surface it is
mounted on and hence impacts the surface heat balance.
Field: Bottom surface Boundary Conditions Type
This field contains the type of boundary conditions applicable to the ICS collector bottom
surface. Allowed boundary condition types are: AmbientAir and OtherSideConditionsModel.
If the other side conditions model is selected, specify the name of the
SurfaceProperty:OtherSideConditionsModel object in the next input field, otherwise, leave the
next input field blank. The AmbientAir boundary condition uses outdoor air temperature as
boundary condition, hence the subsurface is assumed to be exposed to the sun and wind.
Field: Other Side Conditions Model Name
This field contains the name of a SurfaceProperty:OtherSideConditionsModel object declared
elsewhere in the input file. This will connect the collector to the exterior boundary conditions
for the underlying heat transfer surface specified above..
Field: Inlet Node Name
The name of the inlet node connection to the plant loop.
Field: Outlet Node Name
The name of the outlet node connection to the plant loop.
Field: Maximum Flow Rate
The maximum flow rate [m3/s] allowed through the collector. This field is optional. If not
specified, the collector will allow as much flow as the rest of the plant can deliver.
An example follows.

9/29/14

1296

Input-Output Reference
SolarCollector:IntegralCollectorStorage,
Collector 1,
ICS Solar Collector,
ICS Collector Surface,
OtherSideConditionsModel,
ICS OSCM,
Collector Inlet Node,
Collector Outlet Node,
0.00005;

Group Solar Collectors

!!!!!!!!-

Name
Solar Collector Performance Name
Surface Name
Bottom Surface Boundary Conditions Type
Boundary Condition Model Name
Inlet Node Name
Outlet Node Name
Maximum Flow Rate (m3/s)

SolarCollectorPerformance:IntegralCollectorStorage
The SolarCollectorPerformance:IntegralCollectorStorage object contains the thermal and
optical performance parameters for a single collector module. The transmittance-absorptance
product of the absorber and cover system is determined from optical properties specified. For
more detailed information about the calculation procedure, see the EnergyPlus Engineering
Reference Document.
Field: Name
The unique name of the SolarCollectorPerformance:IntegralCollectorStorage object.
Field: ICS Collector Type
This input field is the ICS collector type. Currently only RectangularTank type is allowed.
Field: Gross Area
This input field is the gross area of the collector module in m2. This gross area is used in the
energy balance equations.
Field: Collector Water Volume
This input field is the volume of water in the solar collector in m3.
Field: Bottom Heat Loss Conductance
This input field is the collector bottom heat loss conductance in W/m2K.
calculated from thermal conductivity and thickness of the bottom insulation.

This value is

Field: Side Heat Loss Conductance

This input field is the collector side heat loss conductance in W/m2K. This value is calculated
from thermal conductivity and thickness of the side insulation.
Field: Collector Aspect Ratio
This input field is the ratio of the short side (width) of the collector to the long side (length) of
the collector. This value is used only for calculating the collector side area along with the
collector side height specified in the next input filed. This ratio is less or equal to 1.0.
Field: Collector Side Height
This input field is height of collector side in m. This height is used to estimate the collector
side area for heat loss calculations along with heat loss coefficient specified in the input field
above.
Field: Thermal Mass of Absorber Plate
This input field is thermal-mass of the absorber plate per unit area of the collector in [J/m2 K].
This input value multiplied by the absorber gross area determines the thermal mass of the
absorber plate. It is estimated from the specific heat, density and average thickness of the
absorber plate. If zero is specified then the absorber plate energy balance reduces to steady
state form.

9/29/14

1297

Input-Output Reference

Group Solar Collectors

Field: Number of Covers

Number of transparent collector covers. Common practice is to use two covers: glass as the
outer cover and Teflon as the inner cover. If single cover is specified leave the inner cover
optical and thermal properties input fields blank.
Field: Cover Spacing
This input field provides the spacing between the two transparent covers, and the spacing
between the inner cover and the absorber plate in m. Default value is 0.05m.
Field: Refractive Index of Outer Cover
This is the average Refractive index for solar spectrum range of the outer transparent cover
material. Glass is used as the outer cover. Average refractive index value for non-absorbing
glass used in solar collectors over solar spectrum range is 1.526.
Field: Extinction Coefficient Times Thickness of Outer Cover
This input field is the product of the extinction coefficient and the thickness of the out cover
material. The extinction coefficient for glass types approximately varies from 4m -1 to 32 m-1.
The extinction coefficient for low-iron glass, which is the default outer cover material, is 15 m1. The default value for extinction coefficient times thickness (KL) is 0.045 (=15.0 x0.003),
which is the product of the default extinction coefficient of 15m-1 and 3.0mm thick glass.
Field: Emissivity of Outer Cover
This input field value is thermal emissivity of the outer collector cover. The default value
assumes low-iron glass with thermal emissivity of 0.88.
Field: Refractive Index of Inner Cover
This input field is the average Refractive index of the inner transparent cover of the collector.
Commonly Teflon (PolytetraFluoroethylene) is used as the inner cover. The average
refractive index value over the solar spectrum range for Teflon is 1.37.
Field: Extinction Coefficient Times Thickness of Inner Cover
This input field is the product of the extinction coefficient (K) and the thickness (L) of the inner
cover material. The inner cover material is more transparent than the out cover, very thin and
hence their thickness can be assumed to be negligible. The default value for extinction
coefficient times thickness (KL) is 0.008 (=40.0x0.0002), which is the product of extinction
coefficient of 40m-1 and a thickness of 0.2mm.
Field: Emissivity of Inner Cover
This input field value is thermal emissivity of the inner transparent collector cover. The
default value assumes plastic sheet with thermal emissivity of 0.30. This value is used in the
thermal analysis only.
Field: Absorptance of Absorber Plate
This input field is shortwave or solar absorptance of the absorber plate. The default value is
0.96.
Field: Emissivity of Absorber Plate
This input field value is thermal emissivity of the absorber plate. Default value is 0.30. This
input value is used in the thermal analysis only.
An example follows.

9/29/14

1298

Input-Output Reference

Group Solar Collectors

SolarCollectorPerformance:IntegralCollectorStorage,
ICS Experimental,
!- Name
RectangularTank,
!- ICS Collector Type
0.37275,
!- Gross Area {m2}
0.0195875,
!- Collector Water Volume {m3}
0.10,
!- Bottom Heat Loss Conductance
1.00,
!- Side Heat Loss Conductance
0.8,
!- Collector Aspect Ratio {dimensionless}
0.08,
!- Collector Side Height {m}
5800.0,
!- Thermal Mass of Absorber Plate {J/m2K}
1,
!- Number of Covers {dimensionless}
0.05,
!- Cover Spacing {m}
1.526,
!- Refractive Index of Outer Cover {dimensionless}
0.0125,
!- Extinction Coefficient Times Thickness of Outer Cover {dimensionless}
0.88,
!- Emmissivity of Outer Cover
1.126,
!- Refractive Index of Inner Cover {dimensionless}
0.0126,
!- Extinction Coefficient Times Thickness of Inner Cover {dimensionless}
0.88,
!- Emmissivity of Inner Cover {dimensionless}
0.96,
!- Absorptance of Absorber Plate {dimensionless}
0.60;
!- Emmissivity of Absorber Plate {dimensionless}

Solar Collector Integral Collector Storage Outputs

The following output variables are reported for the SolarCollector:IntegralCollectorStorage
object:
HVAC,Average,Solar Collector Storage Water Temperature [C]
HVAC,Average,Solar Collector Absorber Plate Temperature [C]
HVAC,Average,Solar Collector Overall Top Heat Loss Coefficient [W/m2-C]
HVAC,Average,Solar Collector Thermal Efficiency []
HVAC,Average,Solar Collector Storage Heat Transfer Rate [W]
HVAC,Sum,Solar Collector Storage Heat Transfer Energy [J]
HVAC,Average,Solar Collector Heat Transfer Rate [W]
HVAC,Sum,Solar Collector Heat Transfer Energy [J]
HVAC,Average,Solar Collector Skin Heat Transfer Rate [W]
HVAC,Sum, Solar Collector Skin Heat Transfer Energy [J]
HVAC,Average,Solar Collector Transmittance Absorptance Product []

Solar Collector Storage Water Temperature [C]

This output variable is the ICS collector stored water average temperature at a given time
steps in degree Celsius. This temperature is the same as the collector ICS collector leaving
water temperature.
Solar Collector Absorber Plate Temperature [C]
This output variable is the ICS collector absorber plate average temperature at a given time
steps in degree Celsius.
Solar Collector Thermal Efficiency [ ]
This output variable is the instantaneous thermal efficiency of the ICS solar collector in per
cent. This value is determined from net useful energy collected and the total incident solar
radiation for each time step. The net useful energy collected is the sum of the energy stored
in the collector and net useful energy delivered.
Solar Collector Storage Heat Transfer Rate [W]
Solar Collector Storage Heat Transfer Energy [J]
These output variables are the instantaneous rate of change of the energy and the change in
energy of the water in the ICS solar collector in Watts, and Joules, respectively.

9/29/14

1299

Input-Output Reference

Group Solar Collectors

Solar Collector Skin Heat Transfer Rate [W]

Solar Collector Skin Heat Transfer Energy [J]
These output variables are the instantaneous skin heat loss rate and the heat loss energy of
the ICS solar collector for each time steps in Watts, and Joules respectively. The skin heat
loss rate is the sum of the heat losses through the top, bottom and sides of the collector
surfaces. This value is mostly negative, but can have a positive value (heat gain) when the
outdoor air temperature is warmer than the collector.
Solar Collector Heat Transfer Rate [W]
Solar Collector Heat Transfer Energy [J]
This output variable is the heat rate and Energy transferred from the ICS collector to the
collector loop fluid (water) in Watts and Joule, respectively. This value is determined from the
collector water mass flow rate, specific heat of water and the temperature difference between
the collector water outlet and inlet nodes at each time step. The value is positive when the
fluid is heated or negative when cooled.
Solar Collector Transmittance Absorptance Product [ ]
This output variable is the transmittance-absorptance product of the covers and absorber
system of the ICS solar collector. This value ranges from 0.0 to less than 1.0.
Solar Collector Overall Top Heat Loss Coefficient [W/m2-C]
This output variable is the overall heat loss coefficient from the absorber plate to the ambient
air calculated for each time step.
SolarCollector:FlatPlate:PhotovoltaicThermal
This object is used to model hybrid photovoltaic-thermal (PVT) solar collectors that convert
incident solar energy into both electricity and useful thermal energy. This object describes
the PVT solar collector by referencing other objects that provide more detail or connections to
other parts of the EnergyPlus model.
The PVT solar collectors need to be connected to either an HVAC air system or a plant loop
for collected thermal energy to be utilized. The input field for the type of thermal working fluid
informs the program how the PVT collector is expected to be connected. If the the working
fluid is air, then the PVT collectors are modeled as a ventilation air pretreatment component
and connected to an outdoor air system. If the working fluid is water, then the PVT collectors
are modeled as a hot water solar collector and are connected to a plant loop with a water
thermal storage tank.
Field: Name
This field should contain a unique name chosen by the user to identify a specific PVT
collector in the building model.
Field: Surface Name
This field is the user-defined name of a surface object (defined elsewhere) to which the PVT
module is attached. These can be any type of building surface that is exposed to the exterior
environment. The model uses the named surfaces geometry for the PVT solar collector.
Field: Photovoltaic-Thermal Model Performance Name
This field is the user-defined name of an object (defined elsewhere) that provides the
performance details of the PVT module.
This should be the name of a
SolarCollectorPerformance:PhotovoltaicThermal:Simple
object.
Multiple
different
SolarCollector:FlatPlate:PhotovoltaicThermal objects can reference the same object that
provides performance details.

9/29/14

1300

Input-Output Reference

Group Solar Collectors

Field: Photovoltaic Generator Name

This field is the user-defined name of a Generator:Photovoltaic object (defined elsewhere)
that will be used to model the solar electric portion of the PVT solar collector. The PVT
models make any adjustments needed to model PV performance in the context of the PVT
collector.
Field: Thermal Working Fluid Type
This field is the users choice for the type of fluid used to collect thermal energy. PVT solar
collectors can capture thermal energy in either air or water streams. The choices available
for this field are Water or Air. If the choice is Air then the PVT collector needs to be
connected to an HVAC air system loop. The PVT collector should be situated as the first
component on an outdoor air inlet stream. If the choice is Water then the PVT collector
needs to be connected to a Plant water system loop. The connections are made via node
names which are defined in the following fields, depending on the working fluid type.
Field: Water Inlet Node Name
This field is the name of Plant loop node that serves as the inlet to the PVT collector. This
field is only used if the Thermal Working Fluid Type is set to Plant/Water.
Field: Water Outlet Node Name
This field is the name of a plant loop node that seves as the outlet from the PVT collector.
This field is only used if the Thermal Working Fluid Type is set to Plant/Water.
Field: Air Inlet Node Name
This field is the name of HVAC air loop node that serves as the inlet to the PVT collector.
This field is only used if the Thermal Working Fluid Type is set to HVAC/Air.
Field: Air Outlet Node Name
This field is the name of HVAC air loop node that serves as the outlet from the PVT collector.
This field is only used if the Thermal Working Fluid Type is set to HVAC/Air.
Field: Design Flow Rate
This field is used to describe the nominal volume flow rate of the thermal working fluid. The
units are m3/s. The volume flow rate is autosizable.
An example of this object follows.
SolarCollector:FlatPlate:PhotovoltaicThermal,
PVT: 1_Ceiling ,
!- Name
1_Ceiling ,
!- Surface Name
30percentPVThalfArea ,
!- Photovoltaic-Thermal Model Performance Name
PV:ZN_1_FLR_1_SEC_1_Ceiling ,
!- Photovoltaic Name
Air ,
!- Thermal Working Fluid Type
,
!- Water Inlet Node Name
,
!- Water Outlet Node Name
ZN_1_FLR_1_SEC_1:Sys_OAInlet Node ,
!- Air Inlet Node Name
PVT:ZN_1_FLR_1_SEC_1_Ceiling Outlet , !- Air Outlet Node Name
Autosize ;
!- Design Flow Rate

Solar Collector FlatPlate PhotovoltaicThermal Outputs

The output variables that are available for flat plate PVT include the following.

9/29/14

1301

Input-Output Reference

Group Solar Collectors

HVAC,Average,Generator Produced Thermal Rate [W]

HVAC,Sum,Generator Produced Thermal Energy [J]
HVAC,Average,Generator PVT Fluid Bypass Status [ ]
HVAC,Average,Generator PVT Fluid Inlet Temperature [C]
HVAC,Average,Generator PVT Fluid Outlet Temperature [C]
HVAC,Average,Generator PVT Fluid Mass Flow Rate [kg/s]

Generator Produced Thermal Rate [W]

Generator Produced Thermal Energy [J]
These outputs are the thermal energy and power produced by the PVT collector. PVT
collectors are a type of cogenerator, producing both electrical and thermal power and these
variables report the thermal portion in the same manner as other fuel-based cogenerators.
The thermal energy is placed on HeatProduced meter and is attributed to SolarWater or
SolarAir depending on the type of working fluid. The generator thermal production is also
reported at the load center level.
Generator PVT Fluid Bypass Status [ ]
This output variable indicates the status a bypass damper. It is only available for air-based
PVT. There are no dimensions and the range is between 0.0 and 1.0. If the value is 0.0,
then there is no bypassing and all the working fluid goes through the collector. If the value is
1.0, then there is complete bypassing and all the working fluid goes around the collector. If
the value is between 0.0 and 1.0, then the model is effectively mixing bypass and collector
streams to target a temperature setpoint placed on the outlet node.
Generator PVT Fluid Inlet Temperature [C]
This report is the inlet temperature of the working fluid that enters the PVT collector
Generator PVT Fluid Outlet Temperature [C]
This report is the outlet temperature of the working fluid that leaves the PVT collector
Generator PVT Fluid Mass Flow Rate [kg/s]
This report is the mass flow rate of the working fluid through the PVT collector. This is the
overall mass flow rate, portions of the flow may be internally bypassed around the collector
itself for control modulation.
SolarCollectorPerformance:PhotovoltaicThermal:Simple
This object is used to provide performance details for the simple PVT model. This is a simple
user-defined efficiency model. Thermal conversion efficiency is a constant or scheduled
value. There are no output variable for this object, reporting is done by the parent PVT
object.
Field: Name
This field is the unique name for this object.
Field: Fraction of Surface Area with Active Thermal Collector
This field is the fraction of the surface area that is active. It should be a decimal fraction
between 0.0 and 1.0. The area of the PVTs surface will be multiplied by this fraction to
determine the active area of the PVT collector(s).
Field: Thermal Conversion Efficiency Input Mode Type
This field is used to determine how the thermal efficiency is input. There are two choices,
Fixed or Scheduled. If this field is set to Fixed, then a constant value for thermal efficiency
will be used (set in next field). If this field is set to Scheduled, then the thermal efficiency
values are defined in a schedule.

9/29/14

1302

Input-Output Reference

Group Solar Collectors

Field: Value for Thermal Conversion Efficiency if Fixed

This field is used to provide a value for the efficiency with which solar energy is collected in
the working fluid. This field is only used if the input mode is set to Fixed in the previous
field. Efficiency is defined as the thermal energy collected divided by the incident solar
radiation. The value should be between 0.0 and 1.0. The user should be careful that the
thermal efficiency and the electrical efficiency be consistent with each other because the
overall efficiency of the PVT collector is the combination of both thermal and electrical.
Field: Name of Schedule for Thermal Conversion Efficiency
This field is used for the name of a schedule that provides values for the efficiency with which
solar energy is collected in the working fluid. This field is only used if the input mode is set to
Scheduled in the field above. Efficiency is defined as the thermal energy collected divided
by the incident solar radiation. The values in the named schedule should be between 0.0 and
1.0. The user should be careful that the thermal efficiency and the electrical efficiency be
consistent with each other because the overall efficiency of the PVT collector is the
combination of both thermal and electrical.
Field: Front Surface Emittance
This field is used to describe an average value for the total hemispherical emittance of the
collectors front face exposed to the sky. This is used to model cooling applications where
the PVT collectors are operated at night to cool the working fluid.
An example input object follows.
SolarCollectorPerformance:PhotovoltaicThermal:Simple,
20percentEffPVhalfArea ,
!- Name
0.5 ,
!- Fraction of Surface Area with Active Thermal Collector
Fixed ,
!- Thermal Conversion Efficiency Input Mode Type
0.2 ,
!- Value for Thermal Conversion Efficiency if Fixed
,
!- Name of Schedule for Thermal Conversion Efficiency
0.84 ;
!- Front Surface Emittance

Solar Collector Heating System Plant Connections

This section provides an overview of how to model solar heating systems. A solar heating
system can be constructed using a combination of solar collectors, pumps, water tanks and
water heaters. The solar collector must be connected on the demand side of the plant loop.
Multiple collector modules can be combined in series and parallel using the normal plant
connection rules. The supply side of the plant loop should contain a water heater with the
solar collector loop connecting to the Source Side Inlet and Source Side Outlet nodes. As
usual, the pump must be the first component on the supply side.
If the solar heating system is for domestic hot water (or service water heating) usage only,
the field Use Flow Rate Fraction Schedule Name of the WaterHeater:Mixed object can be
used to avoid additional plant connections. If the system has more complicated hot water
requirements or if the system is for space heating, the Use Side Inlet and Use Side Outlet
nodes must be connected to another plant loop to serve zone and non-zone equipment. (See
the WaterHeater:Mixed object documentation for more information.)

9/29/14

1303

Input-Output Reference

Group Solar Collectors

Figure 132. Solar Collector Plant Loop Connection Diagram

NOTE: The EnergyPlus plant simulation requires the pump to be the first component on the supply side.
This may be different from the way the solar heating system is actually configured. This should not affect
the validity of the simulation results.

In order to realize energy savings with a solar heating system, it is best to use a two-tank
system with a storage tank and auxiliary water heater. The storage tank gathers heat directly
from the solar collectors and stores it for later use. The storage tank is modeled using a
WaterHeater:Mixed object with the Heater Maximum Capacity set to zero. The auxiliary water
heater is positioned downstream of the storage tank on the supply side of the main plant
loop. The auxiliary water heater, or booster water heater, provides additional heat if the
storage tank water is not hot enough. The auxiliary water heater can be modeled as an
instantaneous/tankless water heater or as a standard tanked water heater with heating
source (see WaterHeater:Mixed).

9/29/14

1304

Input-Output Reference

Group Solar Collectors

Figure 133. Two-Tank Solar Heating System Connection Diagram

Another strategy to consider for solar heating systems is to allow the storage tank to reach a
much higher temperature than necessary for the end use. This allows the tank to store more
energy from the solar collectors, when it is available. However, for applications such as
domestic hot water, it is undesirable and unsafe to supply excessive hot water temperatures
at the point of demand. To take advantage of higher storage temperatures, yet still avoid
scalding temperatures at the faucet, the hot water leaving the storage tank can be tempered
with cold water using a three-way valve to achieve the target temperature. See the
TemperingValve object documentation for more details.
A complete two-tank solar heating system with tempering valve is shown below.

9/29/14

1305

Input-Output Reference

Group Solar Collectors

Figure 134. Two-Tank Solar Heating System with Tempering Valve

Solar Heating System Control
There are several options for controlling a solar heating system in EnergyPlus. Since the
solar collectors request a constant flow demand based on their Maximum Flow Rate, the
limiting factor is actually the flow rate determined by the loop pump. Therefore the entire
system can be controlled using the Pump Flow Rate Schedule of the pump. If the schedule is
omitted, the pump and system will run all the time (without any other controls specified). This
is usually not the best way to operate a solar heating system.
To better control the collector loop, a differential thermostat can be used to compare the
temperature in the water heater to the temperature in the collector so that the pump is only
turned on when there is a useful heat gain. The differential thermostat is simulated using the
AvailabilityManager:DifferentialThermostat object. For a typical system, the Hot Node Name
field refers to an outlet node of one of the collector modules. The Cold Node Name field
refers to the Source Side Outlet node, i.e. the cold storage water leaving the water heater.
The fields Temperature Difference On Limit and Temperature Difference Off Limit are usually
8 12 C and 1 3 C respectively. If the two temperature differences are too close, it is
possible for the system to turn on and off rapidly without much useful heat gain. This can also

9/29/14

1306

Input-Output Reference

Group Solar Collectors

occur if the flow rate through the collector is too high. Without flow the fluid in the collector
heats up more quickly; when high flow is turned on, all of the hot fluid is removed and the
temperature drops, forcing the system off again.
Another control method is to use a photovoltaic panel to power the pump. The system begins
pumping when there is enough solar radiation to operate the pump. This is not yet
implemented in EnergyPlus.
Freeze Prevention
In climates with a cold season, the solar heating system must be designed to avoid the risk of
fluid freezing in the solar collector or exposed pipes and causing damage. This is not a
problem if air is the heat transfer fluid. With water, however, there are several strategies that
can minimize the risk.
Seasonal schedule. The simplest strategy is to not use the system during the cold season.
This is a hassle because it requires the collector to be manually drained of all fluid. The
benefits of the solar heating system are also lost during this time. This can be simulated in
EnergyPlus with the appropriate pump schedule for the collector system.
Antifreeze. The freezing point of the liquid is decreased by adding antifreeze to the water or
using a different heat transfer liquid with a lower freezing point. This cannot yet be simulated
in EnergyPlus because only pure water is currently allowed in plant loops.
Drain-back system. This strategy automatically empties the collector when the pump is not
running. This scenario is modeled by default in EnergyPlus, although the extra pump energy
required to start the system is not taken into account.
Recirculation system. This strategy automatically recirculates warm liquid from the storage
tank back through the collector to maintain the system above the freezing point. There are
system losses using this method. This can be simulated in EnergyPlus by using
AvailabilityManager:LowTemperatureTurnOn to force the system to turn on when the outdoor
air temperature or collector outlet temperature falls below a specified minimum.
Additional Controls
In addition to freeze prevention, it is also necessary to prevent the system from becoming too
hot. This is usually a safety issue for the water heater. For this case it is important to have a
high temperature cutoff to stop the pump before damaging the water heater. This is
accomplished with a AvailabilityManager:HighTemperatureTurnOff.
System Availability Manager List Example
To use the availability managers for the control cases described above, a
AvailabilityManagerAssignmentList must be defined and referenced in the PlantLoop object
of the collector loop. An example of a differential thermostat, recirculation for freeze
prevention, and high temperature cutoff is shown below:

9/29/14

1307

Input-Output Reference
AvailabilityManagerAssignmentList,
Collector Loop Availability Manager List,
AvailabilityManager:HighTemperatureTurnOff,
High Temperature Turn Off Availability Manager,
AvailabilityManager:HighTemperatureTurnOn,
Low Temperature Turn On Availability Manager,
AvailabilityManager:DifferentialThermostat,
Differential Thermostat Availability Manager;

Group Solar Collectors

!!!!!!!-

Name
Availability
Availability
Availability
Availability
Availability
Availability

Manager
Manager
Manager
Manager
Manager
Manager

1
1
2
2
3
3

Object Type
Name
Object Type
Name
Object Type
Name

AvailabilityManager:HighTemperatureTurnOff,
High Temperature Turn Off Availability Manager,
Water Heater Use Outlet Node,
60.0;

! For water heater safety

!- Name
!- Sensor Node Name
!- Temperature (C)

AvailabilityManager:HighTemperatureTurnOn,
Low Temperature Turn On Availability Manager,
Collector Outlet Node,
0.0;

! For freeze prevention by recirculation

!- Name
!- Sensor Node Name
!- Temperature (C)

AvailabilityManager:DifferentialThermostat,
Differential Thermostat Availability Manager,
Collector Outlet Node,
Water Heater Source Outlet Node,
10.0,
2.0;

! For useful heat gain from collector to tank

!- Name
!- Hot Node Name
!- Cold Node Name
!- Temperature Difference On Limit (delta C)
!- Temperature Difference Off Limit (delta C)

The AvailabilityManager:DifferentialThermostat object must always be the last manager in the

availability manager list. See the AvailabilityManagerAssignmentList object documentation for
more information.
SolarCollector:UnglazedTranspired
This object is used to model unglazed transpired solar collectors (UTSC) used to condition
outdoor air. These collectors are generally used to heat air drawn through perforated
absorbers that are heated by the sun and also recover heat conducted out through the
underlying wall. The SolarCollector:UnglazedTranspired object represents a single collector
attached to one or more BuildingSurface:Detailed objects and to one or more outdoor air
systems. Therefore the transpired collector is part of both the thermal envelope and the
HVAC system. An example file is provided called TranspiredCollectors.idf.
The area and orientation of the collector is obtained from BuildingSurface:Detailed objects,
which are referenced by name. Although the collector surface itself is slightly detached from
the underlying building wall (or roof), no additional surface object is needed to represent the
collector itself. When modeling transpired collectors, it is important to consider the size of the
collector when developing the building models BuildingSurface:Detailed objects because the
underlying surfaces must match the collector. For example, if the collector covers only part of
the wall, then that wall should be split into separate surfaces where one matches the size of
the collector. A single collector can be associated with as many BuildingSurface:Detailed
objects as desired (although if you need to use more than 10 surfaces, then the IDD will need
to be extended). The collector can be arranged at any tilt angle by describing the surfaces
appropriately. The surfaces need not be contiguous nor have the same orientation, but the
program will issue warnings if surfaces have widely ranging tilts and azimuths.
The collector conditions outdoor air and is connected to the outdoor air system using the
usual method of specifying node names. Using the UTSC model requires specifying a
relatively complete HVAC air system that includes an outdoor air path. This will typically
require using a set of objects that, at a minimum, will include: AirLoopHVAC:ControllerList,
AirLoopHVAC:OutdoorAirSystem:EquipmentList,
AirLoopHVAC:OutdoorAirSystem,
OutdoorAir:NodeList,
OutdoorAir:Mixer,
SetpointManager:MixedAir,
and
Controller:OutdoorAir. A single UTSC can serve more than one outdoor air system but
requires also using a separate object, called SolarCollector:UnglazedTranspired:MultiSystem
to specify node connections.

9/29/14

1308

Input-Output Reference

Group Solar Collectors

Controls for the UTSC involve setting the rate of air flow and the status of a bypass damper.
If the bypass damper is open, then all the ventilation air goes straight into the outdoor air
mixer; if it closed, then all the air first passes through the UTSC. The bypass damper is
modeled as completely open or completely closed. The UTSC bypass damper control is
determined by an availability manager, the airflow set by the outdoor air mixer controls, and
thermostatic type controls that decide if heating is useful. An availability schedule is used to
bypass the collector for certain times of the year, eg. summer cooling season. The air flow
rates are set by controls associated with the outdoor air mixer (see
SetpointManager:MixedAir, and Controller:OutdoorAir). Thermostatic type control decides if
the collector will provide useful heating based on either of two types of setpoints. The first
type of temperature setpoint is managed by SetpointManager:MixedAir, where the UTSC
model looks at a control node, usually the mixed air node. The second type is an extra
setpoint especially for free heating that is managed within this object where the UTSC model
looks at the zone air node.
Field: Name
This field contains a unique name for the unglazed transpired solar collector.
Field: Boundary Conditions Model Name
This field contains the name of a SurfaceProperty:OtherSideConditionsModel object declared
elsewhere in the input file. This will connect the collector to the exterior boundary conditions
for the underlying heat transfer surface.
Field: Availability Schedule Name
This field contains the name of a schedule that determines whether or not the UTSC is
available. When the schedule value is less than or equal to zero, the UTSC is always
bypassed. When the schedule value is greater than zero, the UTSC is available and will be
used when other conditions are met, such as outdoor air requested by mixer and preheating
has been determined to be beneficial based on thermostatic control. If this field is blank, the
schedule has values of 1 for all time periods.
Field: Inlet Node Name
This field contains the name of an air node that provides air into the UTSC. This node name
should also be assigned to be an outdoor air node using the OutdoorAir:NodeList or
OutdoorAir:Node objects. This node should also be named as the actuated node in a
Controller:OutdoorAir object. If the UTSC is connected to more than one air system, then this
field can be left blank and the SolarCollector:UnglazedTranspired:MultiSystem object should
be used to define the nodes.
Field: Outlet Node Name
This field contains the name of an air node that is the outlet of the UTSC. This node name will
typically be the inlet to the OutdoorAir:Mixer (if there is no other equipment on the outdoor air
path). If the UTSC is connected to more than one air system, then this field can be left blank
and the SolarCollector:UnglazedTranspired:MultiSystem object should be used to define the
nodes.
Field: Setpoint Node Name
This field contains the name of an air node that has a setpoint manager controlling its
temperature setpoint. This node name will typically be named as the control node in a a
Controller:OutdoorAir object. If the UTSC is connected to more than one air system, then this
field can be left blank and the SolarCollector:UnglazedTranspired:MultiSystem object should
be used to define the nodes.

9/29/14

1309

Input-Output Reference

Group Solar Collectors

Field: Zone Node Name

This field contains the name of an air node for a thermal zone that is ultimately connected to
the air system. This node is used with the setpoint schedule, defined in the following field, to
provide an added layer of thermostatic control for the UTSC without affecting the control of
auxiliary heating. If there is a single air system that is connected to more than one zone, then
a single zone should be selected based on where the thermostat might be located. If the
UTSC is connected to more than one air system, then this field can be left blank and the
SolarCollector:UnglazedTranspired:MultiSystem object should be used to define the nodes.
Field: Free Heating Setpoint Schedule Name
This field contains the name of a temperature schedule defined elsewhere in the input file.
This schedule should define temperatures desired in the zone, but not necessarily required.
This secondary setpoint schedule is used to allow the UTSC to operate as if it has its own
thermostat that is separate from the primary control mechanism. When the UTSC is used
with auxiliary heating, the usual setpoint managers and temperature controllers will determine
how the auxiliary heaters are controlled. This allows using a higher zone air temperature
setpoint for controlling UTSC bypass than for the auxiliary heating system.
Field: Diameter of Perforations in Collector
This field is used to enter the effective diameter of the perforations in the collector surface.
The diameter should be entered in meters. For perforations other than round, use an
equivalent diameter for a round hole that would have the same area.
Field: Distance Between Perforations in Collector
This field is used to enter the pitch, or average, shortest distance between perforations.
Field: Thermal Emissivity of Collector Surface
This field is used to enter the thermal emissivity of the collector. This surface property is for
longwave infrared radiation. The property is used for both sides of collector. Most painted
materials have an emissivity of 0.9.
Field: Solar Absorbtivity of Collector Surface
This field is used to enter the solar absorbtivity of the collector. This surface property is for
shortwave, solar radiation. The property is used for the front side of the collector that faces
the environment. Darker colors have a higher absorbtivity. While black is the highest
performance, other colors might be used to match the color scheme of the rest of the facade.
The following table provides sample solar absorbtivities for different colors (source:
Conserval Engineering Inc., Toronto, Ontario, Canada).

9/29/14

Color Name of
Kynar6 Paint

Solar Absorptivity

Black
Classic Bronze
Chocolate Brown
Hartford Green
Med. Bronze
Boysenberry
Rocky Grey
Regal Blue

0.94
0.91
0.90
0.90
0.89
0.86
0.85
0.85

Kynar is a registered trademark of Elf Atochem North America, Inc.

1310

Input-Output Reference

Group Solar Collectors

Forest Green
Hemlock Green
Slate Blue
Redwood
Teal
Slate Grey
Patina Green
Mint Green
Dove Grey
Mission Red
Sierra Tan
Brite Red
Rawhide
Sandstone
Silversmith
Coppertone
Concord Cream
Ascot White
Bone White

0.84
0.82
0.80
0.79
0.79
0.79
0.77
0.71
0.69
0.69
0.65
0.59
0.57
0.54
0.53
0.51
0.45
0.40
0.30

Field: Effective Overall Height of Collector

This field is used to enter a nominal height for the collector. This value is used in the program
to determine a length scale in the vertical direction for the buoyancy-driven portion of natural
ventilation that occurs when the collector is inactive. (Note that most of the geometry
information is obtained from the underlying surfaces.) The value entered here is adjusted
inside the program to account for tilt of the collector. While the value here would generally
correspond to the actual distance/height, its value is not critical and it can be used to adjust
modeling the air exchange rates in passive mode. If the collector is horizontal, then the length
scale is obtained from the following field.
Field: Effective Gap Thickness of Plenum Behind Collector
This field is used to enter a nominal gap thickness for the collector. This distance value is
only used when the collector is near horizontal to determine a length scale in the vertical
direction for buoyancy calculations. For example, if the collector is mounted on a flat roof, its
tilt-adjusted height is zero and the program will use this gap thickness as a length scale
rather than the height from the previous field.
Field: Effective Cross Section Area of Plenum Behind Collector
This field is used to enter the nominal cross sectional area of the gap behind the collector.
This area is used to determine a velocity scale for surface convection heat transfer
correlations when the collector is active. This value is generally the average gap thickness
times the average width of the collector.
Field: Hole Layout Pattern for Pitch
This field is used to describe the pattern of perforations in the collector surface. There are
currently two choices available: Square and Triangle. Note that the hole layout pattern
should be consistent with how the value for pitch was determined.

9/29/14

1311

Input-Output Reference

Group Solar Collectors

Field: Heat Exchange Effectiveness Correlation

This field is used to select which correlation is used to model heat transfer from the collector
surface to the incoming air when the collector is active. There are two choices available:
Kutscher1994, and VanDeckerHollandsBrunger2001. See the Engineering Reference for
details and references.
Field: Ratio of Actual Collector Surface Area to Projected Surface Area
This field is used to enter a factor that accounts for the extra surface area resulting from
corrugations in the collector surface. Corrugations help stiffen the collector. The projected
surface area is obtained by the program from the (flat) underlying surfaces. If the collector is
flat then this ratio is 1.0. If the collector is corrugated, then this ratio will be greater than one.
A typical value might be 1.165.
Field: Roughness of Collector
This field is used to describe the relative roughness of the collector material. This field is
similar to one in the Material object. This parameter only influences the convection
coefficients, more specifically the outside convection coefficient. A special keyword is
expected in this field with the options being VeryRough, Rough, MediumRough,
MediumSmooth, Smooth, and VerySmooth in order of roughest to smoothest options.
Field: Collector Thickness
This field is used to enter the thickness of the collector material. This value is only needed for
the Van Decker Hollands Brunger 2001 correlation. The material thickness should be entered
in meters.
Field: Effectiveness for Perforations with Respect to Wind
This field is used to enter a value for the coefficient used to determine natural air exchanges
from wind, or Cv. When the collector is inactive, wind will cause exterior air to move in and
out of the collector. Cv is an arbitrary coefficient used to model the effectiveness of openings
and depends on opening geometry and the orientation with respect to the wind. Cv should
probably be in the range 0.25 to 0.65. Increasing Cv will increase the amount of natural
ventilation.
Field: Discharge Coefficient for Openings with Respect to Buoyancy Driven Flow
This field is used to enter a value for the coefficient used to determine natural air exchanges
from buoyancy, or Cd. When the collector is inactive, stack or buoyancy effects will cause
exterior air to move in and out of the collector. Cd is an arbitrary discharge coefficient that
depends on the geometry of the opening. Cd should probably be in the range 0.4 to 1.0.
Increasing Cd will increase the amount of natural ventilation.
Field: Surface <#> Name
The remaining fields are used to name the BuildingSurface:Detailed objects that are
associated with the UTSC. These are the underlying heat transfer surfaces and are defined
elsewhere in the input file. These other surfaces should all specify OtherSideConditionsModel
as their exterior environment. The input object can currently accommodate up to ten
surfaces, but it is extensible.
An example of this object follows.

9/29/14

1312

Input-Output Reference

Group Solar Collectors

SolarCollector:UnglazedTranspired,
Shop OA UTSC ZN11,
! Name
UTSC OSCM ZN11,
! Boundary Conditions Model Name
HeatingAvailSched ,
! Availability Schedule Name
Outside Air Inlet Node ZN11 ,
! Inlet Node Name
UTSC Outlet Node ZN11 ,
! Outlet Node Name
Mixed Air Node ZN11 ,
! Setpoint Node Name
ZN11 Node,
! Zone Node Name
ShopFreeHeatingSetpoints,
! Free Heating Setpoint Schedule Name
0.0016,
! Diameter of Perforations in Collector
0.01689,
! Distance Between Perforations in Collector
0.9,
! Thermal Emissivity of Collector Surface
0.9,
! Solar Absorbtivity of Collector Surface
4.0,
! Effective Overall Height of Collector
0.1,
! Effective Gap Thickness of Plenum Behind Collector
2.0,
! Effective Cross Section Area of Plenum Behind Collector
Triangle,
! Hole Layout Pattern for Pitch
Kutscher1994,
! Heat Exchange Effectiveness Correlation
1.165,
! Ratio of Actual Collector Surface Area to Projected Surface Area
MediumRough ,
! Roughness of Collector
0.00086,
! Collector Thickness
0.25,
! Effectiveness for Perforations with Respect to Wind
0.5,
! Discharge Coefficient for Openings with Respect to Buoyancy Driven Flow
ZN11_Shop_1:ExtWall:South;
! Surface 1 Name

Solar Collector Unglazed Transpired Outputs

In addition to related output that can be obtained for air nodes and surfaces, these outputs
are available for UTSC systems:
HVAC,Average,Solar Collector Heat Exchanger Effectiveness []
HVAC,Average,Solar Collector Leaving Air Temperature [C]
HVAC,Average,Solar Collector Outside Face Suction Velocity [m/s]
HVAC,Average,Solar Collector Surface Temperature [C]
HVAC,Average,Solar Collector Plenum Air Temperature [C]
HVAC,Average,Solar Collector Sensible Heating Rate [W]
Zone,Meter,SolarAir:Facility [J]
Zone,Meter,SolarAir:HVAC [J]
Zone,Meter,HeatProduced:SolarAir [J]
HVAC,Sum,Solar Collector Sensible Heating Energy [J]
HVAC,Average,Solar Collector Natural Ventilation Air Change Rate [ACH]
HVAC,Average,Solar Collector Natural Ventilation Mass Flow Rate [kg/s]
HVAC,Average,Solar Collector Wind Natural Ventilation Mass Flow Rate [kg/s]
HVAC,Average,Solar Collector Buoyancy Natural Ventilation Mass Flow Rate
[kg/s]
HVAC,Average,Solar Collector Incident Solar Radiation [W/m2]
HVAC,Average,Solar Collector System Efficiency []
HVAC,Average,Solar Collector Surface Efficiency []

Solar Collector Heat Exchanger Effectiveness []

The results from UTSC correlations defined by

Ta , HX
HX

Tamb

Ts ,coll Tamb

Solar Collector Leaving Air Temperature [C]

The temperature of air entering the plenum after being heated by the collector.
Solar Collector Outside Face Suction Velocity [m/s]
The bulk velocity of air approaching the collector.

9/29/14

1313

Input-Output Reference

Group Solar Collectors

Solar Collector Surface Temperature [C]

The surface temperature of the collector itself.
Solar Collector Plenum Air Temperature [C]
The temperature of air inside, and leaving, the plenum behind the collector.
Solar Collector Sensible Heating Rate [W]
The overall rate at which heat is being added to the outdoor air stream.
SolarAir:Facility [J]
A meter that includes the heating energy provided by the UTSC.
SolarAir:HVAC [J]
A meter that includes the heating energy provided by the UTSC.
HeatProduced:SolarAir [J]
A meter that includes the heating energy provided by the UTSC.
Solar Collector Sensible Heating Energy [J]
The overall sum of energy added to the outdoor air stream.
Solar Collector Natural Ventilation Air Change Rate [ACH]
The rate of natural ventilation air exchange between the plenum and ambient when the
collector is inactive in Air Changes per Hour.
Solar Collector Natural Ventilation Mass Flow Rate [kg/s]
The mass flow rate of natural ventilation air exchange between the plenum and ambient
when the collector is inactive.
Solar Collector Wind Natural Ventilation Mass Flow Rate [kg/s]
The part of mass flow rate of natural ventilation air exchange between the plenum and
ambient when the collector is inactive due to wind-driven forces.
Solar Collector Buoyancy Natural Ventilation Mass Flow Rate [kg/s]
The part of mass flow rate of natural ventilation air exchange between the plenum and
ambient when the collector is inactive due to bouyancy-driven forces.
Solar Collector Incident Solar Radiation [W/m2]
The intensity of solar radiation incident on the UTSC collector from all sources.
Solar Collector System Efficiency []
The overall efficiency of the UTSC system including collected solar energy and heat
recovered from the underlying surface.
Solar Collector Surface Efficiency []
The efficiency of the UTSC solar collector.
SolarCollector:UnglazedTranspired:MultiSystem
This object is used to model unglazed transpired solar collectors (UTSC) that are connected
to
multiple
outdoor
air
systems.
This
object
supplements
the
SolarCollector:UnglazedTranspired object and is only necessary if more than one air system
is connected to a single transpired collector. After the name field, there are sets of four node
names used to define the connections of each air system. Each set contains node names for
9/29/14

1314

Input-Output Reference

Group Solar Collectors

inlet, outlet, control, and zone. If more than five air systems are needed, this object is
extensible.
Field: Solar Collector Name
This field is used to identify the name of the SolarCollector:UnglazedTranspired object that
needs to be connected to more than one air system. This field must match the name.
Field Set: Inlet Node, Outlet Node, Mixed Air Node, Zone Node
The following four fields form a repeating set of four fields. One set is used for each outdoor
air system that is connected to the collector.
Field: Outdoor Air System <#> Collector Inlet Node
This field contains the name of an air node that provides air into the UTSC. This node name
should also be assigned to be an outdoor air node using the OutdoorAir:NodeList and
OutdoorAir:Node objects. This node is also be named as the actuator node in a
Controller:OutdoorAir object.
Field: Outdoor Air System <#> Collector Outlet Node
This field contains the name of an air node that is the outlet of the UTSC. This node name will
typically be the Outdoor Air Stream Node Name in the OutdoorAir:Mixer (if there is no other
equipment on the outdoor air path).
Field: Outdoor Air System <#> Mixed Air Node
This field contains the name of an air node that has a setpoint manager controlling its
temperature setpoint. This node name will typically be named as the mixed air node in a
Controller:OutdoorAir object.
Field: Outdoor Air System <#> Zone Node
This field contains the name of an air node for a thermal zone that is ultimately connected to
the air system. This node is used with the setpoint schedule, defined in the following field, to
provide an added layer of thermostatic control for the UTSC without affecting the control of
auxiliary heating. If there is a single air system that is connected to more than one zone, then
a single zone should be selected based on where the thermostat might be located.
An example of this object follows.
SolarCollector:UnglazedTranspired:Multisystem,
OFFICE MultiSystem OA UTSC , ! Solar Collector Name
Outside Air Inlet Node ZN1,
! Outdoor Air System 1
UTSC Outlet Node ZN1,
! Outdoor Air System 1
Mixed Air Node ZN1,
! Outdoor Air System 1
ZN1 Node,
! Outdoor Air System 1
Outside Air Inlet Node ZN2,
! Outdoor Air System 2
UTSC Outlet Node ZN2,
! Outdoor Air System 2
Mixed Air Node ZN2,
! Outdoor Air System 2
ZN2 Node,
! Outdoor Air System 2
Outside Air Inlet Node ZN3,
! Outdoor Air System 3
UTSC Outlet Node ZN3,
! Outdoor Air System 3
Mixed Air Node ZN3,
! Outdoor Air System 3
ZN3 Node,
! Outdoor Air System 3
Outside Air Inlet Node ZN4,
! Outdoor Air System 4
UTSC Outlet Node ZN4,
! Outdoor Air System 4
Mixed Air Node ZN4,
! Outdoor Air System 4
ZN4 Node,
! Outdoor Air System 4
Outside Air Inlet Node ZN5,
! Outdoor Air System 5
UTSC Outlet Node ZN5,
! Outdoor Air System 5
Mixed Air Node ZN5,
! Outdoor Air System 5
ZN5 Node;
! Outdoor Air System 5

9/29/14

Collector
Collector
Mixed Air
Zone Node
Collector
Collector
Mixed Air
Zone Node
Collector
Collector
Mixed Air
Zone Node
Collector
Collector
Mixed Air
Zone Node
Collector
Collector
Mixed Air
Zone Node

Inlet Node
Outlet Node
Node
Inlet Node
Outlet Node
Node
Inlet Node
Outlet Node
Node
Inlet Node
Outlet Node
Node
Inlet Node
Outlet Node
Node

1315

Input-Output Reference

Group Pumps

Group Pumps
EnergyPlus plant and condenser loops need pump components to drive liquid flow around
the loop. There are various types of pump models available.
Pump:VariableSpeed
Pumps are needed in both plant and condenser loops. The syntax for a variable speed pump
is given below.
Field: Name
This alpha field contains the identifying a unique name for the pump.
Field: Inlet Node Name
This alpha field contains the identifying name for the pump inlet node.
Field: Outlet Node Name
This alpha field contains the identifying name for the pump outlet node.
Field: Rated Flow Rate
This numeric field contains the pumps rated volumetric flow rate in cubic meters per second.
Field: Rated Pump Head
This numeric field contains the pumps rated head pressure in Pascals.
Field: Rated Power Consumption
This numeric field contains the pumps rated power consumption in Watts. If the user is
performing a pressure simulation on the loop in which this pump is found, this value would
only be used to estimate pump efficiency. During reported calculations, the pump would use
the loop pressure drop and current flow conditions along with efficiency to calculate pump
power dynamically.
Field: Motor Efficiency
This numeric field contains the pumps efficiency in decimal form (0 = 0%, 1 = 100%).
Field: Fraction of Motor Inefficiencies to Fluid Stream
This numeric field contains the pumps fraction of power loss to the fluid.
Field: Coefficient 1 of the Part Load Performance Curve
This numeric field contains the first coefficient in the part load ratio curve. The fraction of full
load power is determined by the cubic equation:

FractionFullLoadPower

C1 C2 PLR C3 PLR2 C4 PLR3

where C1,C2,C3,and C4 are Coefficients 1 4 (below) and PLR is the Part Load Ratio.
Field: Coefficient 2 of the Part Load Performance Curve
This numeric field contains the second coefficient in the part load ratio curve.
Field: Coefficient 3 of the Part Load Performance Curve
This numeric field contains the third coefficient in the part load ratio curve.
Field: Coefficient 4 of the Part Load Performance Curve
This numeric field contains the fourth coefficient in the part load ratio curve.
9/29/14

1316

Input-Output Reference

Group Pumps

Field: Minimum Flow Rate

This field contains the minimum volumetric flow rate while operating in variable flow capacity
rate in cubic meters per second.
Field: Pump Control Type
This is a choice field of Continuous or Intermittent. A variable speed pump is defined with
maximum and minimum flow rates that are the physical limits of the device. If there is no load
on the loop and the pump is operating intermittently, then the pump can shutdown. For any
other condition such as the loop having a load and the pump is operating intermittently or the
pump is continuously operating (regardless of the loading condition), the pump will operate
and select a flow somewhere between the minimum and maximum limits. In these cases
where the pump is running, it will try to meet the flow request made by demand side
components. Applicable availability managers (ref. AvailabilityManagerAssignmentList) may
override this control by forcing the pump to be on or off.
Field: Pump Flow Rate Schedule Name
The schedule values modify the value for Rated Flow Rate of the pump on a time basis. The
default is that the pump is ON and runs according to its other operational requirements
specified above. This schedule is for special, not typical pump operations.
Field: Pump Curve Name
This references a pump curve to be used during pump flow-loop head resolution. This is only
applicable for loop simulations which include pressure components on at least a single
branch.
More information regarding pressure system simulation is available in the
engineering reference.
Field: Impeller Diameter
For pressure simulation cases, this is the impeller diameter used during calculations which is
used in non-dimensionalizing the pump curve described in the previous field. The units of
this value are meters.
Field: VFD Control Type
This string defines which type of VFD control type to perform. PressureSetPointControl is a
realistic approach which requires inputs of pressure range schedules to control the pump rpm
to maintain a certain pressure drop (head). ManualControl is an idealized control strategy in
which the pump RPM is maintained at a scheduled value throughout the simulation, abiding
by other flow restrictions in the loop.
Field: Pump RPM Schedule Name
For VFD Control Type = ManualControl, this defines the pump RPM schedule to use during
the simulation. For VFD Control Type = PressureSetPointControl, this field is not interpreted.
The value of the schedule is RPM.
Field: Minimum Pressure Schedule
For VFD Control Type = PressureSetPointControl, this field defines the minimum pressure
range setpoint value, or the lower bound of pressure drop (head) to use when determining
the required pump speed. For VFD Control Type = ManualControl, this field is not
interpreted. The value of the schedule is Pascals.
Field: Maximum Pressure Schedule
For VFD Control Type = PressureSetPointControl, this field defines the maximum pressure
range setpoint value, or the upper bound of pressure drop (head) to use when determining
the required pump speed. For VFD Control Type = ManualControl, this field is not
interpreted. The value of the schedule is Pascals.

9/29/14

1317

Input-Output Reference

Group Pumps

Field: Minimum RPM Schedule

For VFD Control Type = PressureSetPointControl, this field defines the minimum allowable
RPM, or the lower bound of pump speed to use when determining the required pump speed.
For VFD Control Type = ManualControl, this field is not interpreted. The value of the
schedule is RPM.
Field: Maximum RPM Schedule
For VFD Control Type = PressureSetPointControl, this field defines the maximum allowable
RPM, or the upper bound of pump speed to use when determining the required pump speed.
For VFD Control Type = ManualControl, this field is not interpreted. The value of the
schedule is RPM.
Field: Zone Name
This field is optional. It can be used to input the name of the Zone in which the pump is
located in the model. If the pump is outdoors, or skin losses are not to be modeled, then
leave this field blank. If a valid Zone name is entered, then the portion of electrical power
consumed by the pump that is not added to the working fluid is added to the surrounding
Zone.
Field: Skin Loss Radiative Fraction
This field is optional. If a Zone is named in the previous field and pump losses are to be
added to a surrounding thermal zone, then this input determines the split between thermal
radiation and thermal convection for the heat losses from the pump. If it is left blank then all
the losses will be convective.
Examples of this object in the IDF follow.
Pump:VariableSpeed,
HW Circ Pump,
HW Supply Inlet Node,
HW Pump Outlet Node,
autosize,
179352,
autosize,
0.9,
0.0,
0,
1,
0,
0,
0,
Intermittent;

!!!!!!!!!!!!!!-

Name
Inlet Node Name
Outlet Node Name
Rated Flow Rate {m3/s}
Rated Pump Head {Pa}
Rated Power Consumption {W}
Motor Efficiency
Fraction of Motor Inefficiencies to Fluid Stream
Coefficient 1 of the Part Load Performance Curve
Coefficient 2 of the Part Load Performance Curve
Coefficient 3 of the Part Load Performance Curve
Coefficient 4 of the Part Load Performance Curve
Minimum Flow Rate {m3/s}
Pump Control Type

Pump:VariableSpeed,
Circ Pump,
CW Supply Inlet Node,
CW Pump Outlet Node,
.0011,
300000,
500,
.87,
0.0,
0,
1,
0,
0,
0,
Intermittent;

!!!!!!!!!!!!!!-

Name
Inlet Node Name
Outlet Node Name
Rated Flow Rate {m3/s}
Rated Pump Head {Pa}
Rated Power Consumption {W}
Motor Efficiency
Fraction of Motor Inefficiencies to Fluid Stream
Coefficient 1 of the Part Load Performance Curve
Coefficient 2 of the Part Load Performance Curve
Coefficient 3 of the Part Load Performance Curve
Coefficient 4 of the Part Load Performance Curve
Minimum Flow Rate {m3/s}
Pump Control Type

9/29/14

1318

Input-Output Reference

Group Pumps

Variable Speed Pump Outputs

HVAC,Average,Pump Electric Power [W]
HVAC,Sum,Pump Electric Energy [J]
HVAC,Average,Pump Shaft Power [W]
HVAC,Average,Pump Fluid Heat Gain Rate [W]
HVAC,Sum,Pump Fluid Heat Gain Energy [J]
HVAC,Average,Pump Outlet Temperature [C]
HVAC,Average,Pump Mass Flow Rate [kg/s]
HVAC,Average,Pump Zone Total Heating Rate [W]
HVAC,Sum,Pump Zone Total Heating Energy [J]
HVAC,Average,Pump Zone Convective Heating Rate [W]
HVAC,Average,Pump Zone Radiative Heating Rate [W]

Pump Electric Power [W]

Pump Electric Energy [J]
These outputs are the electric power input to the pump motor. Consumption is metered on
Pumps:Electricity, Electricity:Plant, and Electricity:Facility.
Pump Shaft Power [W]
This is the shaft power delivered from the motor to the pump.
Pump Fluid Heat Gain Rate [W]
Pump Fluid Heat Gain Energy [J]
These outputs are the energy added to the fluid as heat. For the current algorithm, this is
equal to Pump Shaft Power, because the loops are closed and all energy added to the fluid
will ultimately become heat due to friction.
Pump Outlet Temperature [C]
Pump Mass Flow Rate [kg/s]
These outputs are the water outlet temperature and mass flow rate.
Pump Zone Total Heating Rate [W]
Pump Zone Total Heating Energy [J]
These outputs are the thermal losses from the pump to the surrounding Zone. They are only
available if a Zone was named in the pumps input. These indicate the amount of heat added
to the zone from the pumps inefficiencies. They are the total heat loss including both
convection and radiation.
Pump Zone Convective Heating Rate [W]
This output is the thermal loss from the pump to the surrounding Zone in the form of
convective gains directly to the zone air. It is only available if a Zone was named in the pump
input.
Pump Zone Radiative Heating Rate [W]
This output is the thermal loss from the pump to the surrounding Zone in the form of thermal
radiation gains directly to the inside face of the zones surfaces. It is only available if a Zone
was named in the pump input.

9/29/14

1319

Input-Output Reference

Group Pumps

Pump:ConstantSpeed
Pumps may be found in both plant and condenser loops. The syntax for a constant speed
pump is given below.
Field: Name
This alpha field contains the identifying name for the pump.
Field: Inlet Node Name
This alpha field contains the identifying name for the pump inlet node.
Field: Outlet Node Name
This alpha field contains the identifying name for the pump outlet node.
Field: Rated Flow Rate
This numeric field contains the pumps rated volumetric flow rate in cubic meters per second.
Field: Rated Pump Head
This numeric field contains the pumps rated head pressure in Pascals.
Field: Rated Power Consumption
This numeric field contains the pumps rated power consumption in Watts. If the user is
performing a pressure simulation on the loop in which this pump is found, this value would
only be used to estimate pump efficiency. During reported calculations, the pump would use
the loop pressure drop and current flow conditions along with efficiency to calculate pump
power dynamically.
Field: Motor Efficiency
This numeric field contains the pumps efficiency in decimal form (0 = 0%, 1 = 100%).
Field: Fraction of Motor Inefficiencies to Fluid Stream
This numeric field contains the pumps fraction of power loss to the fluid.
Field: Pump Control Type
This is a choice field of Continuous or Intermittent. The operation of a constant speed pump
is fairly straightforward. If the user designates a constant speed pump that is operating
continuously, the pump will run regardless of whether or not there is a load. This may have
the net effect of adding heat to the loop if no equipment is turned on. If the pump is constant
speed and operates intermittently, the pump will run at its capacity if a load is sensed and will
shut off if there is no load on the loop. Applicable availability managers (ref.
AvailabilityManagerAssignmentList) may override this control by forcing the pump to be on or
off.
Field: Pump Flow Rate Schedule Name
The schedule values modify the Rated Flow Rate of the pump on a time basis. The default is
that the pump is ON and runs according to its other operational requirements specified
above. This schedule is for special, not typical pump operations.
Field: Pump Curve Name
This field is only used if the user is performing a pressure-based simulation in the plantloop of
the LoopFlowCorrection type (see PlantLoop section for how to enable this).
This field references a separate pressure head curve that the user has input separately in the
input file. The pressure curve represents a non-dimensional regression of pressure-flow rate
data. The equation should be of the following form:

9/29/14

1320

Input-Output Reference

Group Pumps
4

C4

C3

C2

C1

C0 .

In this equation, the two dimensionless parameters, X and X are defined in terms of physical
pump and flow parameters as:

P
N D2
2

m
ND3
Where Delta P is the pressure drop, mdot is the fluid mass flow rate, rho is a representative
fluid density, N is the rotational speed of the pump, and D is the pump impeller diameter.
Since the user may not need a full fourth order expansion of this, the user may use linear
(first order), quadratic (second order), cubic (third order), or full quartic (fourth order). These
are available in the objects Curve:Linear, Curve:Quadratic, Curve:Cubic, Curve:Quartic.
Once this curve is input properly (along with the following two fields), the pump will respond
to the plant loop pressure drop when resolving the flow rate. Note that this simulation method
will likely result in a plant loop that does not exactly hit the setpoint as the current simulation
method does. This is due to the loop flow rate now being pressure-based and not
decision-based.
Field: Impeller Diameter
This field is only used if the user is performing a pressure-based simulation in the plantloop of
the LoopFlowCorrection type (see PlantLoop section for how to enable this).
To re-dimensionalize the dimensionless pump curve, the impeller diameter must be known.
This value is entered in meters.
Field: Rotational Speed
This field is only used if the user is performing a pressure-based simulation in the plantloop of
the LoopFlowCorrection type (see PlantLoop section for how to enable this).
To re-dimensionalize the dimensionless pump curve, the rotational speed must be known.
This value is entered in RPM (revolutions per minute).
Field: Zone Name
This field is optional. It can be used to input the name of the Zone in which the pump is
located in the model. If the pump is outdoors, or skin losses are not to be modeled, then
leave this field blank. If a valid Zone name is entered, then the portion of electrical power
consumed by the pump that is not added to the working fluid is added to the surrounding
Zone.
Field: Skin Loss Radiative Fraction
This field is optional. If a Zone is named in the previous field and pump losses are to be
added to a surrounding thermal zone, then this input determines the split between thermal
radiation and thermal convection for the heat losses from the pump. If it is left blank then all
the losses will be convective.
An example of this object follows.

9/29/14

1321

Input-Output Reference
Pump:ConstantSpeed,
Circ Pump,
CW Supply Inlet Node,
PumpChiller Node,
0.0011,
300000,
700,
0.87,
0.0,
Intermittent;

Group Pumps

!!!!!!!!!-

Name
Inlet Node Name
Outlet Node Name
Rated Flow Rate
Rated Pump Head
Rated Power Consumption
Motor Efficiency
Fraction of Motor Inefficiencies to Fluid Stream
Pump Control Type

Constant Speed Pump Outputs

HVAC,Average,Pump Electric Power [W]
HVAC,Sum,Pump Electric Energy [J]
HVAC,Average,Pump Shaft Power [W]
HVAC,Average,Pump Fluid Heat Gain Rate [W]
HVAC,Sum,Pump Fluid Heat Gain Energy [J]
HVAC,Average,Pump Outlet Temperature [C]
HVAC,Average,Pump Mass Flow Rate [kg/s]
HVAC,Average,Pump Zone Total Heating Rate [W]
HVAC,Sum,Pump Zone Total Heating Energy [J]
HVAC,Average,Pump Zone Convective Heating Rate [W]
HVAC,Average,Pump Zone Radiative Heating Rate [W]

Pump Electric Power [W]

Pump Electric Energy [J]
These outputs are the electric power input to the pump motor. Consumption is metered on
Pumps:Electricity, Electricity:Plant, and Electricity:Facility.
Pump Shaft Power [W]
This is the shaft power delivered from the motor to the pump.
Pump Fluid Heat Gain Rate [W]
Pump Fluid Heat Gain Energy [J]
These outputs are the energy added to the fluid as heat. For the current algorithm, this is
equal to Pump Shaft Power, because the loops are closed and all energy added to the fluid
will ultimately become heat due to friction.
Pump Outlet Temperature [C]
Pump Mass Flow Rate [kg/s]
These outputs are the water outlet temperature and mass flow rate.
Pump Zone Convective Heating Rate [W]
This output is the thermal loss from the pump to the surrounding Zone in the form of
convective gains directly to the zone air. It is only available if a Zone was named in the pump
input.
Pump Zone Radiative Heating Rate [W]
This output is the thermal loss from the pump to the surrounding Zone in the form of thermal
radiation gains directly to the inside face of the zones surfaces. It is only available if a Zone
was named in the pump input.

9/29/14

1322

Input-Output Reference

Group Pumps

Pump Zone Total Heating Energy [J]

Pump Zone Total Heating Rate [W]
These outputs are the thermal losses from the pump to the surrounding Zone. They are only
available if a Zone was named in the pumps input. These indicate the amount of heat added
to the zone from the pumps inefficiencies. They are the total heat loss including both
convection and radiation.
Pump:VariableSpeed:Condensate
The Pump:VariableSpeed:Condensate object can only be used in steam system simulation
for the condensate side of the loop. This is a variable speed pump, which pumps the
condensate back to the steam boiler. The syntax for condensate pump is given below.
Field: Name
This alpha field contains the identifying unique name for the pump.
Field: Inlet Node Name
This alpha field contains the identifying name for the pump inlet node.
Field: Outlet Node Name
This alpha field contains the identifying name for the pump outlet node.
Field: Rated Flow Rate
This numeric field contains the pumps rated volumetric flow rate in cubic meters per second.
Field: Rated Pump Head
This numeric field contains the pumps rated head in Pascals.
Field: Rated Power Consumption
This numeric field contains the pumps rated power consumption in Watts. If the user is
performing a pressure simulation on the loop in which this pump is found, this value would
only be used to estimate pump efficiency. During reported calculations, the pump would use
the loop pressure drop and current flow conditions along with efficiency to calculate pump
power dynamically.
Field: Motor Efficiency
This numeric field contains the pumps efficiency in decimal form (0 = 0%, 1 = 100%).
Field: Fraction of Motor Inefficiencies to Fluid Stream
This numeric field contains the pumps fraction of power loss to the fluid.
Field: Coefficient 1 of the Part Load Performance Curve
This numeric field contains the first coefficient in the part load ratio curve. The fraction of full
load power is determined by the cubic equation:

FractionFullLoadPower

C1 C2 PLR C3 PLR2 C4 PLR3

where C1,C2,C3,and C4 are Coefficients 1 4 (below) and PLR is the Part Load Ratio.
Field: Coefficient 2 of the Part Load Performance Curve
This numeric field contains the second coefficient in the part load ratio curve.
Field: Coefficient 3 of the Part Load Performance Curve
This numeric field contains the third coefficient in the part load ratio curve.
9/29/14

1323

Input-Output Reference

Group Pumps

Field: Coefficient 4 of the Part Load Performance Curve

This numeric field contains the fourth coefficient in the part load ratio curve.
Field: Pump Flow Rate Schedule Name
The schedule values modify the Rated Flow Rate of the pump on a time basis the default is
that the pump is ON and runs according to its other operational requirements specified
above. The schedule is for special, not typical pump operations.
Field: Zone Name
This field is optional. It can be used to input the name of the Zone in which the pump is
located in the model. If the pump is outdoors, or skin losses are not to be modeled, then
leave this field blank. If a valid Zone name is entered, then the portion of electrical power
consumed by the pump that is not added to the working fluid is added to the surrounding
Zone.
Field: Skin Loss Radiative Fraction
This field is optional. If a Zone is named in the previous field and pump losses are to be
added to a surrounding thermal zone, then this input determines the split between thermal
radiation and thermal convection for the heat losses from the pump. If it is left blank then all
the losses will be convective.
Examples of this object in the IDF follow.
Pump:VariableSpeed:Condensate,
Steam Boiler Plant Steam Circ Pump,
!- Name
Steam Boiler Plant Steam Supply Inlet Node, !- Inlet Node Name
Steam Boiler Plant Steam Pump Outlet Node, !- Outlet Node Name
0.36,
!- Rated Flow Rate {m3/s}
179352,
!- Rated Pump Head {Pa}
400,
!- Rated Power Consumption {W}
0.9,
!- Motor Efficiency
0.0,
!- Fraction of Motor Inefficiencies to Fluid Stream
0,
!- Coefficient 1 of the Part Load Performance Curve
1,
!- Coefficient 2 of the Part Load Performance Curve
0,
!- Coefficient 3 of the Part Load Performance Curve
0;
!- Coefficient 4 of the Part Load Performance Curve
Pump:VariableSpeed:Condensate,
Steam Boiler Plant Steam Circ Pump,
!- Name
Steam Boiler Plant Steam Supply Inlet Node, !- Inlet Node Name
Steam Boiler Plant Steam Pump Outlet Node, !- Outlet Node Name
0.36,
!- Rated Flow Rate {m3/s}
179352,
!- Rated Pump Head {Pa}
autosize,
!- Rated Power Consumption {W}
0.9,
!- Motor Efficiency
0.0,
!- Fraction of Motor Inefficiencies to Fluid Stream
0,
!- Coefficient 1 of the Part Load Performance Curve
1,
!- Coefficient 2 of the Part Load Performance Curve
0,
!- Coefficient 3 of the Part Load Performance Curve
0;
!- Coefficient 4 of the Part Load Performance Curve

Variable Speed Condensate Pump Outputs

HVAC,Average,Pump Electric Power [W]
HVAC,Sum,Pump Electric Energy [J]
HVAC,Average,Pump Shaft Power [W]
HVAC,Average,Pump Fluid Heat Gain Rate [W]
HVAC,Sum,Pump Fluid Heat Gain Energy [J]
HVAC,Average,Pump Outlet Temperature [C]
HVAC,Average,Pump Mass Flow Rate [kg/s]
HVAC,Average, Pump Zone Total Heating Rate [W]
9/29/14

1324

Input-Output Reference

Group Pumps

HVAC, Sum, Pump Zone Total Heating Energy [J]

HVAC, Average, Pump Zone Convective Heating Rate [W]
HVAC, Average, Pump Zone Radiative Heating Rate [W]

Pump Electric Power [W]

Pump Electric Energy [J]
These outputs are the electric power input to the pump motor. Consumption is metered on
Pumps:Electricity, Electricity:Plant, and Electricity:Facility.
Pump Shaft Power [W]
This is the shaft power delivered from the motor to the pump.
Pump Fluid Heat Gain Rate [W]
Pump Fluid Heat Gain Energy [J]
These outputs are the energy added to the fluid as heat. For the current algorithm, this is
equal to Pump Shaft Power, because the loops are closed and all energy added to the fluid
will ultimately become heat due to friction.
Pump Outlet Temperature [C]
Pump Mass Flow Rate [kg/s]
These outputs are the water outlet temperature and mass flow rate.
Pump Zone Total Heating Rate [W]
Pump Zone Total Heating Energy [J]
These outputs are the thermal losses from the pump to the surrounding Zone. They are only
available if a Zone was named in the pumps input. These indicate the amount of heat added
to the zone from the pumps inefficiencies. They are the total heat loss including both
convection and radiation.
Pump Zone Convective Heating Rate [W]
This output is the thermal loss from the pump to the surrounding Zone in the form of
convective gains directly to the zone air. It is only available if a Zone was named in the pump
input.
Pump Zone Radiative Heating Rate [W]
This output is the thermal loss from the pump to the surrounding Zone in the form of thermal
radiation gains directly to the inside face of the zones surfaces. It is only available if a Zone
was named in the pump input.
HeaderedPumps:ConstantSpeed
Headered pumps are components with more than one identical pumps connected in parallel.
The syntax for HeaderedPumps:ConstantSpeed is as follows.
Field: Name
This alpha field contains the identifying name for the pump bank.
Field: Inlet Node Name
This alpha field contains the identifying name for the pump bank inlet node.

9/29/14

1325

Input-Output Reference

Group Pumps

Field: Outlet Node Name

This alpha field contains the identifying name for the pump bank outlet node.
Field: Total Rated Flow Rate
This numeric field contains the pump banks rated volumetric flow rate in cubic meters per
second. This is equal to the product of number of pumps and the flow rate of each individual
pump. The field can be autosized.
Field: Number of Pumps in Bank
The numeric field specifies the number of pumps present in the pump bank. All these pumps
are connected in parallel internally.
Field: Flow Sequencing Control Scheme
The alpha field specifies the scheme for sequencing flow. Currently the only choice is
Sequential, where a pump in the pump bank will be turned ON only after fully loading the
previous pump.
Field: Rated Pump Head
This numeric field contains the pumps rated head pressure in Pascals.
Field: Rated Power Consumption
This numeric field contains the pump banks total power consumption in Watts. This field is
equal to the product of number of pumps and the rated power consumption of each individual
pump. If the user is performing a pressure simulation on the loop in which this pump bank is
found, this value would only be used to estimate pump efficiency. During reported
calculations, the pump would use the loop pressure drop and current flow conditions along
with efficiency to calculate pump power dynamically.
Field: Motor Efficiency
This numeric field contains the pumps efficiency in decimal form (0 = 0%, 1 = 100%).
Field: Fraction of Motor Inefficiencies to Fluid Stream
This numeric field contains the pumps fraction of power loss to the fluid.
Field: Pump Control Type
This is a choice field of Continuous or Intermittent. The operation of a constant speed pump
bank is fairly straightforward. If the user designates a constant speed pump bank that is
operating continuously, the pump bank will run regardless of whether or not there is a load.
This may have the net effect of adding heat to the loop if no equipment is turned on. If the
pump bank is constant speed and operates intermittently, the pump bank will run at its
capacity if a load is sensed and will shut off if there is no load on the loop. Applicable
availability managers (ref. AvailabilityManagerAssignmentList) may override this control by
forcing the pump to be on or off.
Field: Pump Flow Rate Schedule Name
The schedule values modify the Total Rated Flow Rate of the pump on a time basis. The
default is that the pump is ON and runs according to its other operational requirements
specified above. This schedule is for special, not typical pump operations.
Field: Zone Name
This field is optional. It can be used to input the name of the Zone in which the pump is
located in the model. If the pump is outdoors, or skin losses are not to be modeled, then
leave this field blank. If a valid Zone name is entered, then the portion of electrical power

9/29/14

1326

Input-Output Reference

Group Pumps

consumed by the pump that is not added to the working fluid is added to the surrounding
Zone.
Field: Skin Loss Radiative Fraction
This field is optional. If a Zone is named in the previous field and pump losses are to be
added to a surrounding thermal zone, then this input determines the split between thermal
radiation and thermal convection for the heat losses from the pump. If it is left blank then all
the losses will be convective.
An example for constant speed pump bank follows.
HeaderedPumps:ConstantSpeed,
Chilled Water Headered Pumps,
CW Supply Inlet Node,
CW Pumps Outlet Node,
autosize,
2,
SEQUENTIAL,
179352,
autosize,
0.9,
0.0,
INTERMITTENT,
CoolingPumpAvailSched;

!!!!!!!!!!!!-

Name
Inlet Node Name
Outlet Node Name
Total Rated Flow Rate
Number of Pumps in Bank
Flow Sequencing Control Scheme
Rated Pump Head
Rated Power Consumption
Motor Efficiency
Fraction of Motor Inefficiencies to Fluid Stream
Pump Control Type
Pump Flow Rate Schedule Name

Constant Speed Headered Pumps Outputs

HVAC,Average,Pump Electric Power [W]
HVAC,Sum, Pump Electric Energy [J]
HVAC,Average,Pump Shaft Power [W]
HVAC,Average, Pump Fluid Heat Gain Rate [W]
HVAC,Sum, Pump Fluid Heat Gain Energy [J]
HVAC,Average, Pump Outlet Temperature [C]
HVAC,Average,Pump Mass Flow Rate [kg/s]
HVAC,Average,Number of Pumps Operating []
HVAC, Average, Pump Zone Total Heating Rate [W]
HVAC, Sum, Pump Zone Total Heating Energy [J]
HVAC, Average, Pump Zone Convective Heating Rate [W]
HVAC, Average, Pump Zone Radiative Heating Rate [W]

Pump Electric Power [W]

Pump Electric Energy [J]
These outputs are the electric power input to the pump motor. Consumption is metered on
Pumps:Electricity, Electricity:Plant, and Electricity:Facility.
Pump Shaft Power [W]
This is the shaft power delivered from the motor to the pump.
Pump Fluid Heat Gain Rate [W]
Pump Fluid Heat Gain Energy [J]
These outputs are the energy added to the fluid as heat. For the current algorithm, this is
equal to Pump Shaft Power, because the loops are closed and all energy added to the fluid
will ultimately become heat due to friction.
Pump Outlet Temperature [C]
Pump Mass Flow Rate [kg/s]
These outputs are the water outlet temperature and mass flow rate.
9/29/14

1327

Input-Output Reference

Group Pumps

Pump Operating Pumps Count []

This output tells the number of pumps in the pump bank operating at any reporting frequency.
Pump Zone Total Heating Rate [W]
Pump Zone Total Heating Energy [J]
These outputs are the thermal losses from the pump to the surrounding Zone. They are only
available if a Zone was named in the pumps input. These indicate the amount of heat added
to the zone from the pumps inefficiencies. They are the total heat loss including both
convection and radiation.
Pump Zone Convective Heating Rate [W]
This output is the thermal loss from the pump to the surrounding Zone in the form of
convective gains directly to the zone air. It is only available if a Zone was named in the pump
input.
Pump Zone Radiative Heating Rate [W]
This output is the thermal loss from the pump to the surrounding Zone in the form of thermal
radiation gains directly to the inside face of the zones surfaces. It is only available if a Zone
was named in the pump input.
HeaderedPumps:VariableSpeed
Headered pumps are components with more than one identical pumps connected in parallel.
Currently this object may be found only in plant loops. The syntax for a
HeaderedPumps:VariableSpeed pump is given below.
Field: Name
This alpha field contains the identifying unique name for the pump bank.
Field: Inlet Node Name
This alpha field contains the identifying name for the pump bank inlet node.
Field: Outlet Node Name
This alpha field contains the identifying name for the pump bank outlet node.
Field: Total Rated Flow Rate
This numeric field contains the pump banks rated volumetric flow rate in cubic meters per
second. This is equal to the product of number of pumps and the flow rate of each individual
pump. The field can be autosized.
Field: Number of Pumps in Bank
The numeric field specifies the number of pumps present in the pump bank. All these pumps
are connected in parallel internally.
Field: Flow Sequencing Control Scheme
The alpha field specifies the scheme for sequencing flow. Currently the only choice is
Sequential, where a pump in the pump bank will be turned ON only after fully loading the
previous pump.
Field: Rated Pump Head
This numeric field contains the pumps rated head in Pascals.

9/29/14

1328

Input-Output Reference

Group Pumps

Field: Rated Power Consumption

This numeric field contains the pump banks total power consumption in Watts. This field is
equal to the product of number of pumps and the rated power consumption of each individual
pump. If the user is performing a pressure simulation on the loop in which this pump bank is
found, this value would only be used to estimate pump efficiency. During reported
calculations, the pump would use the loop pressure drop and current flow conditions along
with efficiency to calculate pump power dynamically.
Field: Motor Efficiency
This numeric field contains the efficiency of the individual pump (which will be equivalent to
pump bank efficiency) in decimal form (0 = 0%, 1 = 100%).
Field: Fraction of Motor Inefficiencies to Fluid Stream
This numeric field contains the individual pumps fraction of power loss to the fluid.
Field: Coefficient 1 of the Part Load Performance Curve
This numeric field contains the first coefficient (C1) in the part load ratio curve. The fraction of
full load power is determined by the cubic equation:

FractionFullLoadPower

C1 C2 PLR C3 PLR2 C4 PLR3

where C1,C2,C3,and C4 are Coefficients 1 4 (below) and PLR is the Part Load Ratio.
Field: Coefficient 2 of the Part Load Performance Curve
This numeric field contains the second coefficient (C2) in the part load ratio curve.
Field: Coefficient 3 of the Part Load Performance Curve
This numeric field contains the third coefficient (C3) in the part load ratio curve.
Field: Coefficient 4 of the Part Load Performance Curve
This numeric field contains the fourth coefficient (C4) in the part load ratio curve.
Field: Minimum Flow Rate
The numeric field specifies the minimum flow allowed for the pump bank as a fraction of the
nominal flow. If the requested flow is less than minimum flow pump bank runs at minimum
flow.
Field: Pump Control Type
This is a choice field of Continuous or Intermittent. A variable speed pump bank is defined
with maximum and minimum flow rates that are the physical limits of the device. If there is no
load on the loop and the pump bank is operating intermittently, then the bank can shutdown.
For any other condition such as the loop having a load and the pump bank is operating
intermittently or the pump bank is continuously operating (regardless of the loading
condition), the bank will operate and select a flow somewhere between the minimum and
maximum limits. In these cases where the pump bank is running, it will try to meet the flow
request made by demand side components. Applicable availability managers (ref.
AvailabilityManagerAssignmentList) may override this control by forcing the pump to be on or
off.
Field: Pump Flow Rate Schedule Name
Modifies the Rated Volumetric Flow Rate of the pump on a time basis. The default is that the
pump is ON and runs according to its other operational requirements specified above. This
schedule is for special, not typical pump operations.

9/29/14

1329

Input-Output Reference

Group Pumps

Field: Zone Name

This field is optional. It can be used to input the name of the Zone in which the pump is
located in the model. If the pump is outdoors, or skin losses are not to be modeled, then
leave this field blank. If a valid Zone name is entered, then the portion of electrical power
consumed by the pump that is not added to the working fluid is added to the surrounding
Zone.
Field: Skin Loss Radiative Fraction
This field is optional. If a Zone is named in the previous field and pump losses are to be
added to a surrounding thermal zone, then this input determines the split between thermal
radiation and thermal convection for the heat losses from the pump. If it is left blank then all
the losses will be convective.
An example of this object follows.
HeaderedPumps:VariableSpeed,
Chilled Water Headered Pumps, !- Name
CW Supply Inlet Node,
!- Inlet Node Name
CW Pumps Outlet Node,
!- Outlet Node Name
autosize,
!- Total Rated Flow Rate {m3/s}
2,
!- Number of Pumps in Bank
SEQUENTIAL,
!- Flow Sequencing Control Scheme
179352,
!- Rated Pump Head {Pa}
autosize,
!- Rated Power Consumption {W}
0.9,
!- Motor Efficiency
0.0,
!- Fraction of Motor Inefficiencies to Fluid Stream
0,
!- Coefficient 1 of the Part Load Performance Curve
1,
!- Coefficient 2 of the Part Load Performance Curve
0,
!- Coefficient 3 of the Part Load Performance Curve
0,
!- Coefficient 4 of the Part Load Performance Curve
0.1,
!- Minimum Flow Rate {m3/s}
INTERMITTENT,
!- Pump Control Type
CoolingPumpAvailSched;
!- Pump Flow Rate Schedule Name

Variable Speed Headered Pumps Outputs

HVAC,Average,Pump Electric Power [W]
HVAC,Sum, Pump Electric Energy [J]
HVAC,Average,Pump Shaft Power [W]
HVAC,Average, Pump Fluid Heat Gain Rate [W]
HVAC,Sum, Pump Fluid Heat Gain Energy [J]
HVAC,Average, Pump Outlet Temperature [C]
HVAC,Average,Pump Mass Flow Rate [kg/s]
HVAC,Average,Number of pumps operating []
HVAC, Average, Pump Zone Total Heating Rate [W]
HVAC, Sum, Pump Zone Total Heating Energy [J]
HVAC, Average, Pump Zone Convective Heating Rate [W]
HVAC, Average, Pump Zone Radiative Heating Rate [W]

Pump Electric Power [W]

Pump Electric Energy [J]
These outputs are the electric power input to the pump motor. Consumption is metered on
Pumps:Electricity, Electricity:Plant, and Electricity:Facility.
Pump Shaft Power [W]
This is the shaft power delivered from the motor to the pump.

9/29/14

1330

Input-Output Reference

Group Heating and Cooling Coils

Pump Fluid Heat Gain Rate [W]

Pump Fluid Heat Gain Energy [J]
These outputs are the energy added to the fluid as heat. For the current algorithm, this is
equal to Pump Shaft Power, because the loops are closed and all energy added to the fluid
will ultimately become heat due to friction.
Pump Outlet Temperature [C]
Pump Mass Flow Rate [kg/s]
These outputs are the water outlet temperature and mass flow rate.
Pump Operating Pumps Count []
This output tells the number of pumps in the pump bank operating at any reporting frequency.
Pump Zone Total Heating Rate [W]
Pump Zone Total Heating Energy [J]
These outputs are the thermal losses from the pump to the surrounding Zone. They are only
available if a Zone was named in the pumps input. These indicate the amount of heat added
to the zone from the pumps inefficiencies. They are the total heat loss including both
convection and radiation.
Pump Zone Convective Heating Rate [W]
This output is the thermal loss from the pump to the surrounding Zone in the form of
convective gains directly to the zone air. It is only available if a Zone was named in the pump
input.
Pump Zone Radiative Heating Rate [W]
This output is the thermal loss from the pump to the surrounding Zone in the form of thermal
radiation gains directly to the inside face of the zones surfaces. It is only available if a Zone
was named in the pump input.

Group Heating and Cooling Coils

Several different coils may be added to zone equipment and air loops. This includes simple
heating (gas, electric, and hot water) and a simple water-cooling coil as well as a more
detailed flat fin water-cooling coil model. In general, the heating coil description can be used
for a heating coil, a reheat coil, or a preheat coil in the air loop simulation or for zone
equipment. Figure 135 is an example of a heating and cooling coil in the air loop simulation in
a dual duct system. This does show the basic node structure that will be referenced in the
input description. The figure does show water coils since they are the most complex to input
in the simulation compared to the Electric and Gas coils which only have air connections.

9/29/14

1331

Input-Output Reference

Group Heating and Cooling Coils

Figure 135. Example Air Loop Heating & Cooling Coil

Coil:Cooling:Water
The water cooling coil (Coil:Cooling:Water) has the ability to give detailed output with
simplified inputs, inputting complicated coil geometry is not required by the user for this
model instead the coil is sized in terms of auto-sizeable thermodynamic inputs. The coil
requires thermodynamic inputs such as temperatures, mass flow rates and humidity ratios.
The coil is sized using auto-sized/user design input conditions and the UA values are
calculated from the design conditions. A rough estimate of the coil area is provided along with
percentage of surface wet and/or dry. This model uses the NTU-effectiveness approach to
model heat transfer and has two types of flow arrangements cross-flow or counter-flow.
The basic underlying idea is - use auto sizable thermodynamic design inputs, calculate the
coil UAs, use these UA values and operating conditions from the nodes connections,
calculate the outlet stream conditions, and calculate the heat transfer rates.
See section Cooling Coil Model in the EnergyPlus Engineering Document for further details
regarding this model.
Field: Name
A unique user-assigned name for an instance of a cooling coil. Any reference to this cooling
coil by another object will use this name.
Field: Availability Schedule Name
Schedule that defines when the coil is available. The name of the schedule (ref: Schedule)
that denotes whether the cooling coil can run during a given time period. A schedule value
greater than 0 (usually 1 is used) indicates that the unit can be on during a given time period.
A value less than or equal to 0 (usually 0 is used) denotes that the unit is off. If this field is
blank, the schedule has a value of 1 for all time periods.
Field: Design Water Flow Rate
The maximum possible water volume flow rate (m 3/sec) through the coil. This is an auto
sizable design input.
Field: Design Air Flow Rate
The maximum possible air volume flow rate (m 3/sec) through the coil. This is an auto sizable
design input.

9/29/14

1332

Input-Output Reference

Group Heating and Cooling Coils

Field: Design Inlet Water Temperature

The inlet water temperature for the design flow (C). This is an auto sizable design input.
Field: Design Inlet Air Temperature
The inlet air temperature for the design flow (C). This is an auto sizable design input.
Field: Design Outlet Air Temperature
The outlet air condition desired for design flow (C). This is an auto sizable design input.
Field: Design Inlet Air Humidity Ratio
The highest value of humidity ratio possible
(kgWater/kgDryAir). This is an auto sizable input.

for

the

Design

inlet

air

stream

Field: Design Outlet Air Humidity Ratio

The value of humidity ratio for the Design outlet air stream (kgWater/kgDryAir), it is an auto
sizable input.
Field: Water Inlet Node Name
The name of the water coil inlet from the chilled water loop, i.e. Cooling Coil Water Inlet
Node. It is from this node the operating inputs for water are transferred to the coil.
Field: Water Outlet Node Name
The name of the water coil outlet from the chilled water loop, i.e. Cooling Coil Water Outlet
Node. It is from this node the operating output for water are reported to the coil.
Field: Air Inlet Node Name
The name of the air inlet to the water coil, i.e. Cooling Coil Air Inlet Node. It is from this node
the operating inputs for air are transferred to the coil.
Field: Air Outlet Node Name
The name of the air outlet from the water coil, i.e. Cooling Coil Air Outlet Node. It is from this
node the operating output for airside is reported to the coil.
Field: Type of Analysis
The coil has two modes of operation, termed as SimpleAnalysis and DetailedAnalysis. The
difference between the two modes being, the simple mode reports the value of surface area
fraction wet of the coil as dry or wet. The detailed mode give the exact value, however the
execution time in detailed mode is noticeably higher.
Field: Heat Exchanger Configuration
The coil is operable in two modes, Cross Flow for general A/C applications and Counter flow
mode. Air-conditioning systems generally use cross flow heat exchangers, hence the default
is set to cross flow.
Field: Condensate Collection Water Storage Tank Name
This field is optional. It is used to describe where condensate from the coil is collected. If
blank or omitted, then any coil condensate is discarded. Enter the name of Water Storage
Tank object defined elsewhere and the condensate will then be collected in that tank.
Examples when auto sized in an IDF are as below:

9/29/14

1333

Input-Output Reference

Group Heating and Cooling Coils

Coil:Cooling:Water,
Main Cooling Coil 1,
!- Coil Name
CoolingCoilAvailSched, !- Availability Schedule Name
autosize,
!- Design Water Volume Flow Rate of Coil {m3/s}
autosize,
!- Design Air Flow Rate of Coil {m3/s}
autosize,
!- Design Inlet Water Temperature {C}
autosize,
!- Design Inlet Air Temperature {C}
autosize,
!- Design Outlet Air Temperature {C}
autosize,
!- Design Inlet Air Humidity Ratio (kgWater/kgDryAir)
autosize,
!- Design Outlet Air Humidity Ratio (kgWater/kgDryAir)
Main Cooling Coil 1 Water Inlet Node,
!- Coil_Water_Inlet_Node
Main Cooling Coil 1 Water Outlet Node, !- Coil_Water_Outlet_Node
Mixed Air Node 1,
!- Coil_Air_Inlet_Node
Main Cooling Coil 1 Outlet Node;
!- Coil_Air_Outlet_Node

Examples when values (hard-sized) are input in an IDF are as below:

Coil:Cooling:Water,
Main Cooling Coil 1,
!- Coil Name
CoolingCoilAvailSched, !- Availability Schedule Name
0.0022,
!- Design Water Volume Flow Rate of Coil {m3/s}
1.45,
!- Design Air Flow Rate of Coil {m3/s}
6.1,
!- Design Inlet Water Temperature {C}
25,
!- Design Inlet Air Temperature {C}
10,
!- Design Outlet Air Temperature {C}
0.012,
!- Design Inlet Air Humidity Ratio
0.008,
!- Design Outlet Air Humidity Ratio
Main Cooling Coil 1 Water Inlet Node,
!- Coil_Water_Inlet_Node
Main Cooling Coil 1 Water Outlet Node, !- Coil_Water_Outlet_Node
Mixed Air Node 1,
!- Coil_Air_Inlet_Node
Main Cooling Coil 1 Outlet Node;
!- Coil_Air_Outlet_Node

Cooling Coil (Water) Outputs

Following are the list of possible output output variables from this coil model:
HVAC,Sum,Cooling Coil Total Cooling Energy [J]
HVAC,Sum,Cooling Coil Sensible Cooling Energy [J]
HVAC,Average,Cooling Coil Total Cooling Rate [W]
HVAC,Average,Cooling Coil Sensible Cooling Rate [W]
HVAC,Average,Cooling Coil Wetted Area Fraction []
HVAC,Average,Cooling Coil Condensate Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Coil Source Side Heat Transfer Energy [J]
HVAC,Sum,Cooling Coil Condensate Volume [m3]

Cooling Coil Total Cooling Energy (J)

Cooling Coil Total Cooling Energy is the total amount of heat transfer taking place in the coil
at the operating conditions.
Cooling Coil Sensible Cooling Energy (J)
Cooling Coil Sensible Cooling Energy is the total amount of Sensible heat transfer taking
place in the coil at the operating conditions. It only takes into account temperature difference
in the inlet and outlet air streams at operating conditions.
Cooling Coil Total Cooling Rate (W)
Cooling Coil Total Cooling Rate is the Rate of heat transfer taking place in the coil at the
operating conditions. The units are (J/sec) or Watts.
Cooling Coil Sensible Cooling Rate (W)
Cooling Coil Sensible Cooling Rate is the Rate of Sensible heat transfer taking place in the
coil at the operating conditions.

9/29/14

1334

Input-Output Reference

Group Heating and Cooling Coils

Cooling Coil Wetted Area Fraction []

It defines the fraction of total surface area of coil which is wet due to moisture condensation
on the surface of the coil. Value varies between 0.0 and 1.0.
In addition, if a Water Storage Tank is used to collect coil condensate, then the following
outputs will be available.
Cooling Coil Condensate Volume Flow Rate [m3/s]
Cooling Coil Condensate Volume [m3]
These reports provide the rate and amount of condensate from the coil. Condensate is water
condensed out of the air as a result of cooling. The condensate volume is also reported on
the meter for OnSiteWater.
Cooling Coil Source Side Heat Transfer Energy [J]
This is the energy extracted from the chilled water serving the coil, in Joules.
Coil:Heating:Water
This simple heating coil model only does sensible heating of the air. The simple heating coil
uses the Effectiveness-NTU algorithm and assumes a cross-flow heat exchanger.
Field: Name
A unique identifying name for each coil.
Field: Availability Schedule Name
Schedule that defines when the coil is available. A schedule value greater than 0 (usually 1 is
used) indicates that the unit can be on during a given time period. A value less than or equal
to 0 (usually 0 is used) denotes that the unit is off. If this field is blank, the schedule has a
value of 1 for all time periods.
Field: U-Factor Times Area Value
The UA value for the coil needed for the Effectiveness-NTU heat exchanger model. An
estimate of the UA can be obtained from:

q UA (Twater ,avg Tair ,avg )

where q is the heat transferred from water to the air in watts; T water, avg is the average water
temperature in degrees C; and Tair, avg is the average air temperature in degrees C. Or the
LMTD temperature difference can be used. This field is used when Performance Input
Method = UFactorTimesAreaAndDesignWaterFlowRate.This field is autosizable.
Field: Maximum Water Flow Rate
The maximum possible water flow rate (m 3/sec) through the coil. This field is used when Coil
Performance Input Method = UFactorTimesAreaAndDesignWaterFlowRate. This field is
autosizable.
Field: Water Inlet Node Name
The name of the coils water inlet node from the hot water loop.
Field: Water Outlet Node Name
The name of the coils water outlet node from the hot water loop.
Field: Air Inlet Node Name
The name of the air inlet node to the water coil.

9/29/14

1335

Input-Output Reference

Group Heating and Cooling Coils

Field: Air Outlet Node Name

The name of the air outlet node from the water coil.
Field: Performance Input Method
The
user
can
choose
either
UFactorTimesAreaAndDesignWaterFlowRate
or
NominalCapacity. If UFactorTimesAreaAndDesignWaterFlowRate is selected, the user must
input values for UA of the Coil and Max Water FlowRate of the Coil (and Rated Capacity is
ignored). If NominalCapacity is chosen, the user must input a Rated Capacity for the coil; UA
of the Coil and Max Water FlowRate of the Coil will be ignored. Rated capacity is defined as
the heating capacity in watts of the coil at the rating points (i.e., the rated inlet and outlet
water/air temperatures defined in the input fields below). The rated capacity is used to
calculate a water mass flow rate and a UA for the coil. The default is NominalCapacity.
To autosize the capacity, choose UfactorTimesAreaAndDesignWaterFlowRate and put
autosize as the inputs for U-Factor Times Area Value, Maximum Water Flow Rate, and Rated
Capacity. The program will use the Sizing inputs to size the coil. The rated temperatures (see
below) are ignored in autosizing. These are used only when the user is specifying coil
performance using the NominalCapacity input method.
Field: Gross Rated Heating Capacity
The heating capacity of the coil in watts at the rated inlet and outlet air and water
temperatures. The gross rated heating capacity does not account for the effect of supply air
fan heat. This field is used when the Performance Input Method = Nominal Capacity. This
field is autosizable. The rating points are given in the four subsequent input fields.
Field: Rated Inlet Water Temperature
The inlet water temperature (degrees C) corresponding to the rated heating capacity. The
default is 82.2 degrees C (180 degrees F).
Field: Rated Inlet Air Temperature
The inlet air temperature (degrees C) corresponding to the rated heating capacity. The
default is 16.6 degrees C (60 degrees F).
Field: Rated Outlet Water Temperature
The outlet water temperature (degrees C) corresponding to the rated heating capacity. The
default is 71.1 degrees C (160 degrees F).
Field: Rated Outlet Air Temperature
The outlet air temperature (degrees C) corresponding to the nominal heating capacity. The
default is 32.2 degrees C (90 degrees F).
Field: Rated Ratio for Air and Water Convection
This is the ratio of convective heat transfers between air side and water side of the heating
coil at the rated operating conditions. The default is .5. This ratio describes the geometry
and the design of the coil and is defined by:

ratio

hA

hA

air

water

where,
f

is the fin efficiency, (dimensionless)

h is the surface convection heat transfer coefficient

A is the surface area
An example input of the object is:
9/29/14

1336

Input-Output Reference

Group Heating and Cooling Coils

Coil:Heating:Water,
SPACE3-1 Zone Coil,
!- Coil Name
ReheatCoilAvailSched,
!- Availability Schedule Name
,
!- UA of the Coil {W/K}
,
!- Max Water Flow Rate of Coil {m3/s}
SPACE3-1 Zone Coil Water In Node, !- Coil_Water_Inlet_Node
SPACE3-1 Zone Coil Water Out Node, !- Coil_Water_Outlet_Node
SPACE3-1 Zone Coil Air In Node, !- Coil_Air_Inlet_Node
SPACE3-1 In Node,
!- Coil_Air_Outlet_Node
NominalCapacity,
!- Coil Performance Input Method
10000.,
!- Gross Rated Heating Capacity
0.55;
!- Rated Ratio for Air and Water Convection

Heating Coil (Water) Outputs

HVAC,Sum, Heating Coil Heating Energy [J]
HVAC,Sum,Heating Coil Source Side Heat Transfer Energy [J]
HVAC,Average,Heating Coil Heating Rate [W]
HVAC,Average, Heating Coil U Factor Times Area Value [W/K]

Heating Coil Heating Energy [J]

Heating Coil Heating Energy is the total amount of heat transfer taking place in the coil at the
operating conditions.
Heating Coil Heating Rate [W]
Heating Coil Heating Rate is the Rate of heat transfer taking place in the coil at the operating
conditions. The units are (J/sec) or Watts.
Heating Coil U Factor Times Area Value [W/K]
This characterizes the overall heat transfer UA value, or U-factor times Area. The simple
heating coil model adjusts UA value based on inlet temperatures and flow rates and this
output contains the results from that adjustment.
Heating Coil Source Side Heat Transfer Energy [J]
This is the same has the Heating Coil Heating Energy but it is also metered as a plant loop
heating demand. This represents the heat in Joules extracted from the hot water serving the
coil.
Coil:Heating:Steam
The simple steam to air heating coil model only does sensible heating of the air. The steam to
air coils condenses the steam and sub cools steam at loop pressure and discharges the
condensate through steam traps at low pressure condensate line.
Field: Name
A unique identifying name for each steam coil.
Field: Availability Schedule Name
Schedule that defines when the coil is available. If the schedules value is less than or equal
to 0.0, then the coil is not available and flow will not be requested. If the schedules value is >
0.0 (usually 1 is used), the coil is available. If this field is blank, the schedule has values of 1
for all time periods.
Field: Maximum Steam Flow Rate
The maximum possible steam volumetric flow rate in m 3/s through the steam heating coil.
The steam volumetric flow rate is calculated at 100C and 101325 Pa. This field is
autosizable.

9/29/14

1337

Input-Output Reference

Group Heating and Cooling Coils

Field: Degree of SubCooling

Ideally the steam trap located at the outlet of steam coil should remove all the condensate
immediately, however there is a delay in this process in actual systems which causes the
condensate to SubCool by certain degree in the coil before leaving the coil, this SubCool
occurs in the steam coil and this SubCool-heat is added to the zone. The minimum value is
2 Celsius and default is 5 Celsius.
Field: Degree of Loop SubCooling
This essentially represents the heat loss to the atmosphere due to uninsulated condensate
return piping to the boiler. Condensate return piping operates at atmospheric pressure and is
not insulated. The condensate sub cools to certain degree before it is pumped back to the
boiler. The minimum value is 10 Celsius and default is 20 Celsius.
Field: Water Inlet Node Name
The name of the steam coil inlet from the steam loop, i.e. Steam Coil steam inlet node.
Field: Water Outlet Node Name
The name of the steam coil outlet to the condensate loop, i.e. Steam Coil condensate outlet
node.
Field: Air Inlet Node Name
The name of the air inlet to the steam coil, i.e. Steam Coil Air Inlet Node.
Field: Air Outlet Node Name
The name of the air outlet from the steam coil, i.e. Steam Coil Air Outlet Node.
Field: Coil Control Type
Choice of either ZoneLoadControl steam coil or TemperatureSetpointControl steam coil.
A zone coil is load controlled and an air loop steam coil is temperature controlled.
Field: Temperature Setpoint Node Name
If the coil is used in the air loop simulation and is temperature controlled using a Set Point
Manager (i.e., the previous file is TemperatureSetpointConrtol), then the node that is the
control node needs to be specified here. If the coil is used in an air terminal unit, the coil is
load controlled and a control node set point is not required (i.e., the previous field is
ZoneLoadControl).
An example of a Steam Coil input statement (one each for Temperature Controlled and Load
Controlled) from an IDF is given below:
Coil:Heating:Steam,
VAV SYS 1 Heating Coil,
!- Coil Name
ReheatCoilAvailSched,
!- Availability Schedule Name
0.06,
!- Max Steam volume Flow rate
5.0,
!- Deg of Subcooling Desired
15.0,
!- Loop Subcooling Desired
VAV SYS 1 Heating Coil Steam Inlet, !- Coil Steam Inlet Node
VAV SYS 1 Heating Coil Steam Outlet, !- Coil Water Outlet Node
VAV SYS 1 Cooling Coil Outlet,
!- Coil Air Inlet Node
VAV SYS 1 Heating Coil Outlet,
!- Coil Air Outlet Node
TemperatureSetPointControl,
!- field Coil Control Type
VAV SYS 1 Heating Coil Outlet;
!- field Coil Temp Setpoint Node
Coil:Heating:Steam,
SPACE1-1 Reheat Coil,
ReheatCoilAvailSched,
autosize,
5.0,
9/29/14

!!!!-

Coil Name
Availability Schedule Name
Max Steam volume Flow rate
Deg of Subcooling Desired
1338

Input-Output Reference

Group Heating and Cooling Coils

15.0,
!- Loop Subcooling Desired
SPACE1-1 Reheat Coil Steam Inlet,
!- Coil Steam Inlet Node
SPACE1-1 Reheat Coil Steam Outlet, !- Coil Water Outlet Node
SPACE1-1 Damper Outlet,
!- Coil Air Inlet Node
SPACE1-1 Supply Inlet, !- Coil Air Outlet Node
ZoneLoadControl;
!- field Coil Control Type

Heating Coil (Steam) Outputs:

HVAC,Sum, Heating Coil Heating Energy [J]
HVAC,Average,Total Steam Coil Heating Rate [W]
HVAC,Average,Heating Coil Steam Trap Loss Rate [W]
HVAC, Average, Heating Coil Steam Inlet Temperature [C]
HVAC, Average, Heating Coil Steam Outlet Temperature [C]
HVAC, Average, Heating Coil Steam Mass Flow Rate [kg/s]

Heating Coil Heating Energy [J]

Heating Coil Heating Energy is the total amount of heat transfer taking place in the coil at the
operating conditions.
Heating Coil Heating Rate [W]
Heating Coil Heating Rate is the Rate of heat transfer taking place in the coil at the operating
conditions. The units are (J/sec) or Watts.
Heating Coil Steam Trap Loss Rate [W]
Loop losses represent the unavoidable loss due to degree of sub cooling in the condensate
return piping back to the boiler and the loss occurring due to flashing of steam across the
steam trap due to pressure differential between the steam and the condensate side.
Heating Coil Steam Inlet Temperature [C]
Heating Coil Steam Outlet Temperature [C]
Heating Coil Steam Mass Flow Rate [kg/s]
These outputs are the Steam inlet and condensate outlet temperatures and steam flow rate
for the boiler.
Coil:Heating:Electric
The electric heating coil is a simple capacity model with a user-inputted efficiency. In many
cases, this efficiency for the electric coil will be 100%. This coil will be simpler than shown in
Figure 135 since it will only have air nodes to connect it in the system. The coil can be used
in the air loop simulation or in the zone equipment as a reheat coil. Depending on where it is
used determines if this coil is temperature or capacity controlled. If used in the air loop
simulation it will be controlled to a specified temperature scheduled from the SetPoint
Manager. If it is used in zone equipment, it will be controlled from the zone thermostat by
meeting the zone demand.
Field: Name
A unique identifying name for each coil.
Field: Availability Schedule Name
Schedule that defines when the coil is available. If the schedules value is 0.0, then the coil is
not available and flow will not be requested. If the schedules value is > 0.0 (usually 1 is
used), the coil is available. If this field is blank, the schedule has values of 1 for all time
periods. Schedule values must be >= 0 and <= 1.

9/29/14

1339

Input-Output Reference

Group Heating and Cooling Coils

Field: Efficiency
This is user-inputted efficiency (decimal units, not percent) and can account for any loss. In
most cases for the electric coil, this will be 100%.
Field: Nominal Capacity
This is the maximum capacity of the coil (W). This controlled coil will only provide the needed
capacity to meet the control criteria whether it is temperature or capacity controlled. This field
is autosizable.
Field: Air Inlet Node Name
The name of the air inlet to the electric coil, i.e. Heating Coil Air Inlet Node.
Field: Air Outlet Node Name
The name of the air outlet from the electric coil, i.e. Heating Coil Air Outlet Node.
Field: Temperature Setpoint Node Name
If the coil is used in the air loop simulation and is temperature controlled using a Set Point
Manager, then the node that is the control node needs to be specified here. If the coil is used
in an air terminal unit, the coil is load controlled and a control node set point is not required.
An example of IDF usage:
Coil:Heating:Electric,
AHU Reheater,
2,
0.99,
600000,
DOAS Supply Fan Outlet,
AHU Reheater Outlet,
AHU Reheater Outlet;

!!!!!!!-

Name
Availability Schedule Name
Efficiency
Nominal Capacity {W}
Air Inlet Node Name
Air Outlet Node Name
Temperature Setpoint Node Name

Heating Coil (Electric) Outputs

HVAC,Sum,Heating Coil Air Heating Energy [J]
HVAC,Average,Heating Coil Air Heating Rate [W]
HVAC,Sum,Heating Coil Electric Energy [J]
HVAC,Average,Heating Coil Electric Power [W]

Heating Coil Air Heating Energy (J)

Heating Coil Air Heating Energy is the total amount of heat transfer taking place in the coil at
the operating conditions.
Heating Coil Air Heating Rate [W]
Heating Coil Air Heating Rate is the Rate of heat transfer taking place in the coil at the
operating conditions. The units are (J/sec) or Watts.
Heating Coil Electric Energy [J]
Heating Coil electric consumption after the efficiency of the coil has been taken into account
in Joules for the timestep reported.
Heating Coil Electric Power [W]
This field is the average Heating Coil electric power after the efficiency of the coil has been
taken into account in Watts for the timestep reported.
Coil:Heating:Electric:MultiStage
The multi stage electric heating coil is a simple capacity model with a user-inputted
efficiencies at different stages. In many cases, the efficiencies for the electric coil will be
9/29/14

1340

Input-Output Reference

Group Heating and Cooling Coils

100%. This coil will only have air nodes to connect it in the system. The coil can be used in
the air loop simulation or in the zone equipment as a reheat coil. Depending on where it is
used determines if this coil is temperature or capacity controlled. If used in the air loop
simulation it will be controlled to a specified temperature scheduled from the SetPoint
Manager. If it is used in zone equipment, it will be controlled from the zone thermostat by
meeting the zone demand. For the time being, this coil model can only be called by the
parent object AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed.
Field: Name
A unique identifying name for each coil.
Field: Availability Schedule Name
Schedule that defines when the coil is available. If the schedules value is 0.0, then the coil is
not available and flow will not be requested. If the schedules value is > 0.0 (usually 1 is
used), the coil is available. If this field is blank, the schedule has values of 1 for all time
periods. Schedule values must be >= 0 and <= 1.
Field: Air Inlet Node Name
The name of the air inlet to the electric coil, i.e. Heating Coil Air Inlet Node.
Field: Air Outlet Node Name
The name of the air outlet from the electric coil, i.e. Heating Coil Air Outlet Node.
Field: Temperature Setpoint Node Name
If the coil is used in the air loop simulation and is temperature controlled using a Set Point
Manager, then the node that is the control node needs to be specified here. If the coil is used
in an air terminal unit, the coil is load controlled and a control node set point is not required.
At present, the multistage electric heating coil does not model temperature setoint control.
Field: Stage 1 Efficiency
This is stage 1 user-inputted efficiency (decimal units, not percent) and can account for any
loss. In most cases for the electric coil, this will be 100%.
Field: Stage 1 Nominal Capacity
This is stage 1 capacity of the coil (W). This field is autosizable.
Field: Stage 2 Efficiency
This is stage 2 user-inputted efficiency (decimal units, not percent) and can account for any
loss. In most cases for the electric coil, this will be 100%.
Field: Stage 2 Nominal Capacity
This is stage 2 capacity of the coil (W). This field is autosizable.
Field: Stage 3 Efficiency
This is stage 3 user-inputted efficiency (decimal units, not percent) and can account for any
loss. In most cases for the electric coil, this will be 100%.
Field: Stage 3 Nominal Capacity
This is stage 3 capacity of the coil (W). This field is autosizable.
Field: Stage 4 Efficiency
This is stage 4 user-inputted efficiency (decimal units, not percent) and can account for any
loss. In most cases for the electric coil, this will be 100%.

9/29/14

1341

Input-Output Reference

Group Heating and Cooling Coils

Field: Stage 4 Nominal Capacity

This is stage 4 capacity of the coil (W). This field is autosizable.
An example in IDF form:
Coil:Heating:Electric:MultiStage,
Heat Pump Heating Coil 1,
!- Name
FanAndCoilAvailSched,
!- Availability Schedule Name
Heating Coil Air Inlet Node,
!- Air Inlet Node Name
SuppHeating Coil Air Inlet Node, !- Air Outlet Node Name
,
!- Temp Setpoint node name
3,
!- Number of Stages
1,
!- Stage 1 Efficiency
Autosize,
!- Stage 1 Nominal Capacity {W}
1,
!- Stage 2 Efficiency
Autosize,
!- Stage 2 Nominal Capacity {W}
1,
!- Stage 3 Efficiency
Autosize;
!- Stage 3 Nominal Capacity {W}

Heating Coil (Electric Multistage) Outputs

HVAC,Sum,Heating Coil Energy[J]
HVAC,Average,Heating Coil Rate[W]
HVAC,Sum,Heating Coil Electric Consumption [J]
HVAC,Average,Heating Coil Electric Power [W]

Heating Coil Energy (J)

Heating Coil Energy is the total amount of heat transfer taking place in the coil at the
operating conditions.
Heating Coil Rate[W]
Heating Coil Rate is the Rate of heat transfer taking place in the coil at the operating
conditions. The units are (J/sec) or Watts.
Heating Coil Electric Consumption [J]
Heating Coil electric consumption after the efficiency of the coil has been taken into account
in Joules for the timestep reported.
Heating Coil Electric Power [W]
This field is the average Heating Coil electric power after the efficiency of the coil has been
taken into account in Watts for the timestep reported.
Coil:Heating:Desuperheater
A simplified approach is used to determine the performance of this air heating coil. The model
assumes that the heating energy provided by this coil is reclaimed from the superheated
refrigerant gas leaving a compressor (i.e., a desuperheating refrigerant-to-air heating coil)
and does not impact the performance of the compressor. This coil can be used in air loop
simulations
but
cant
be
used
by
certain
compound
objects
(e.g.,
AirLoopHVAC:UnitaryHeatPump:AirToAir, AirLoopHVAC:UnitaryHeatPump:WaterToAir, or
Dehumidifier:Desiccant:NoFans)
or
any
air
distribution
equipment
(e.g.,
AirTerminal:SingleDuct:ConstantVolume:Reheat, AirTerminal:SingleDuct:VAV:Reheat, or
AirTerminal:SingleDuct:SeriesPIU:Reheat).
The desuperheater heating coil input requires a coil name, an availability schedule, and a
heat reclaim recovery efficiency. The reclaim recovery efficiency determines the amount of
heat available for use by this heating coil. Approximately 25-30% of the energy rejected by
typical refrigeration system condensers is to reduce the superheated refrigerant vapor
temperature to the condensing temperature. Recovery efficiencies higher than 30% may
cause the refrigerant gas to condense which in turn impacts the performance of the
9/29/14

1342

Input-Output Reference

Group Heating and Cooling Coils

refrigeration system. For this reason, the maximum heat reclaim recovery efficiency for this
coil is 30% for most sources of waste heat, including refrigeration compressor racks. The one
exception to this 30% limit is a condenser that is part of a detailed refrigeration system. In a
detailed refrigeration system, the portion of the rejected heat that lies within the superheated
region is explicitly calculated. Therefore, the desuperheater coils supplied by a condenser
attached to a detailed refrigeration system are subject to a maximum reclaim recovery
efficiency of 90% of the heat within the superheated region.
The next two input items for the desuperheater heating coil are the node names for the inlet
and outlet air streams. The following two input fields define the source of heating energy for
the coil. This desuperheater heating coil may only be used with direct expansion (DX) cooling
or refrigeration equipment. The first of these two inputs is the heating source object type
while the second defines the name of the heating source. For proper modeling, the
desuperheater heating coil must be placed downstream of a DX cooling coil when reclaiming
heat from that cooling coil. Desuperheating heating coil placement is unrestricted when
reclaiming heat from a Refrigeration:CompressorRack or Refrigeration:Condenser.
The next input field is optional and defines the set point node name if the desuperheater
heating coil is to be controlled based on temperature. When a load-based control scheme is
used, this field is left blank. A final optional input is used to model parasitic electric energy
use of auxiliary equipment associated with the desuperheater heating coil (e.g., solenoid
valve).
Field: Name
This alpha field defines a unique user-assigned name for an instance of a desuperheater
heating coil. Any reference to this desuperheater heating coil by another object will use this
name.
Field: Availability Schedule Name
This alpha field defines the name of the schedule (ref: Schedule) that denotes whether the
desuperheater heating coil can run during a given time period. Schedule values must range
from 0 to 1. A schedule value greater than 0 indicates that the coil can operate during the
time period. A value equal to 0 denotes that the coil must be off for that time period. If this
field is blank, the schedule has values of 1 for all time periods.
Field: Heat Reclaim Recovery Efficiency
This numeric field defines the ratio of recovered waste heat from the superheated refrigerant
gas to the total rejected waste heat from the heating source (as if no heat reclaim occurred).
Values can range from 0.0 up to a maximum of 0.9 if the source is a refrigeration condenser
and 0.3 for all other waste heat sources. If this input field is left blank, the default value is 0.8
for a refrigeration condenser source type and 0.25 for all other sources.
Field: Air Inlet Node Name
This alpha field defines the name of the HVAC system node from which the desuperheater
heating coil draws its inlet air.
Field: Air Outlet Node Name
This alpha field defines the name of the HVAC system node to which the desuperheater
heating coil sends its outlet air.
Field: Heating Source Object Type
This alpha field defines the source of superheated refrigerant gas from which the
desuperheater heating coil recovers energy. Valid choices are:
Coil:Cooling:DX:SingleSpeed
Coil:Cooling:DX:TwoSpeed
Coil:Cooling:DX:TwoStageWithHumidityControlMode
Refrigeration:CompressorRack
9/29/14

1343

Input-Output Reference

Group Heating and Cooling Coils

Refrigeration:Condenser:AirCooled
Refrigeration:Condenser:EvaporativeCooled
Refrigeration:Condenser:WaterCooled

When the heating coil source is a DX Coil, the air loops supply air fan control mode may be
auto fan (cycling fan cycling coil), constant fan, or variable volume. When the heating source
is a compressor rack for refrigerated cases or a refrigeration condenser, the supply air fan
control mode should be either variable volume or constant fan.
NOTE: Use of the desuperheater heating coil in variable air volume systems should be done with caution
since the model assumption of a fixed heat reclaim recovery efficiency may not be valid if the air flow rate
over the coil varies significantly.

Field: Heating Source Name

This alpha field defines the name of the desuperheater heating coil source (e.g., the name of
a specific valid coil (as mentioned in the previous field) which provides waste heat to this
desuperheater heating coil).
NOTE: When the heating source is a Refrigeration Compressor rack, the heat rejection location in the
Refrigeration:CompressorRack object must be Outdoors. If the compressor rack heat rejection location is
Zone, the total amount of heat rejection available for reclaim (e.g., by this desuperheater heating coil) is
set to zero by the compressor rack object and the simulation proceeds.

Field: Temperature Setpoint Node Name

This optional alpha field defines the name of the HVAC system node used for temperaturebased control (e.g., controlling the heating coils outlet air dry-bulb temperature to a setpoint).
If the desuperheater heating coil is temperature controlled through the use of a Set Point
Manager, then the control node specified in the Set Point Manager will be entered here. If the
desuperheater heating coil is controlled based on a certain heating load to be met (e.g., using
this heating coil as part of AirLoopHVAC:Unitary:Furnace:HeatCool for high humidity control),
this field should be left blank.
Field: Parasitic Electric Load
This optional numeric field defines the parasitic electric load (in Watts) due to control valves
or other devices specific to the desuperheater heating coil. The load is applied whenever the
coil is heating the air. The model assumes that this electric load is small and does not
contribute to heating the air.
Following is an example input for a desuperheater heating coil.
Coil:Heating:Desuperheater,
DesuperheaterCoil,
!- Coil Name
FanAndCoilAvailSched,
!- Availability Schedule
0.3,
!- Heat Reclaim Recovery Efficiency
Cooling Coil Air Outlet Node,
!- Coil Air Inlet Node Name
Air Loop Outlet Node,
!- Coil Air Outlet Node Name
Coil:Cooling:DX:SingleSpeed, !- Heating Source Type
Furnace ACDXCoil 1,
!- Heating Source Name
,
!- Coil Temperature Setpoint Node Name
0.1;
!- Parasitic Electric Load {W}

Heating Coil (Desuperheater) Outputs

HVAC,Average,Heating Coil Rate [W]
HVAC,Sum,Heating Coil Energy [J]
HVAC,Average,Heating Coil Electric Power [W]
HVAC,Sum,Heating Coil Electric Consumption [J]
9/29/14

1344

Input-Output Reference

Group Heating and Cooling Coils

HVAC,Average,Heating Coil Runtime Fraction []

HVAC,Average,Heating Coil Air Heating Rate [W]
HVAC,Sum,Heating Coil Air Heating Energy [J]
HVAC,Average,Heating Coil Electric Power [W]
HVAC,Sum,Heating Coil Electric Energy [J]
HVAC,Average,Heating Coil Runtime Fraction

Heating Coil Air Heating Rate [W]

This output is the average heating rate of the desuperheater heating coil in Watts over the
timestep being reported. This is determined by the coil inlet and outlet air conditions and the
air mass flow rate through the coil.
Heating Coil Air Heating Energy [J]
This output is the total heating output of the desuperheater heating coil in Joules over the
timestep being reported. This is determined by the coil inlet and outlet air conditions and the
air mass flow rate through the coil. This output is also added to a meter with Resource Type =
EnergyTransfer, End Use Key = HeatingCoils, Group Key = System (ref. Output:Meter
objects).
Heating Coil Electric Power [W]
This output is the average electric consumption rate for the parasitic load associated with the
desuperheater heating coil in Watts.
Heating Coil Electric Energy [J]
This output is the electric consumption of the desuperheater heating coil parasitic load in
Joules for the timestep being reported. This output is also added to a meter with Resource
Type = Electricity, End Use Key = Heating, Group Key = System (ref. Output:Meter objects).
Heating Coil Runtime Fraction []
This is the runtime fraction of the desuperheater heating coil for the timestep being reported.
Since the desuperheater heating coil can only provide heat when the heat source object is
active, the runtime fraction of the desuperheater heating coil will always be less than or equal
to the runtime fraction of the heat source object.
Coil:Cooling:DX:VariableRefrigerantFlow
The variable refrigerant flow (VRF) DX cooling coil model is nearly identical to the singlespeed DX cooling coil model (Ref. Coil:Cooling:DX:SingleSpeed). For this reason, an
adaptation of the single-speed DX cooling coil model is used to model the variable-speed
compression system used in VRF AC systems. The model inputs are quite similar to the input
requirements for the single-speed DX cooling coil model, however, the location of a majority
of the inputs have been moved to the variable refrigerant flow air conditioner object since
multiple DX cooling coils will use the same DX compression system (Ref.
AirConditioner:VariableRefrigerantFlow).
Field: Coil Name
This alpha field defines a unique user-assigned name for an instance of a VRF DX cooling
coil. Any reference to this DX cooling coil by another object will use this name. This cooling
coil name must be entered in the AirConditioner:VariableRefrigerantFlow object. No other
sytem type uses this specific coil.
Field: Availability Schedule Name
This alpha field defines the name of the DX cooling coil availabiltiy schedule. Schedule
values of 0 denote the DX cooling coil is off. A schedule value greater than 0 indicates that
the coil can operate during the time period. If this field is blank, the schedule has values of 1
for all time periods.
9/29/14

1345

Input-Output Reference

Group Heating and Cooling Coils

Field: Gross Rated Total Cooling Capacity

This numeric field defines the gross rated total cooling capacity of the DX cooling coil in
watts. The total cooling capacity should be a gross, i.e., the effect of supply air fan heat
NOT accounted for.
Field: Gross Ratio Sensible Heat Ratio
This numeric field defines the gross sensible heat ratio (sensible capacity divided by total
cooling capacity) of the DX cooling coil at rated conditions. Both the sensible and total cooling
capacities used to define the Rated SHR should be gross (i.e., the effect of supply air fan
heat is NOT accounted for)
Field: Rated Air Flow Rate
The air volume flow rate, in m 3 per second, across the DX cooling coil at rated conditions.
The rated air volume flow rate should be between 0.00004027 m3/s and 0.00006041 m 3/s per
watt of rated total cooling capacity (300 to 450 cfm/ton). The gross rated total cooling
capacity and gross rated SHR should be performance information for the unit with at this
rated air volume flow rate.
Field: Cooling Capacity Ratio Modifier Function of Temperature Curve Name
This alpha field defines the cooling capacity ratio modifier as a function of indoor wet-bulb
temperature or indoor wet-bulb and outdoor dry-bulb temperatures. This curve is a linear,
quadratic, or cubic curve if the cooling capacity is soley a function of indoor wet-bulb
temperature (i.e., the indoor terminal units weighted average inlet air wet-bulb temperatures).
Without specific manufacturers data indicating otherwise, the use of a single independent
variable is recommended for this coil type. If, however, the user has reason to believe the
cooling capacity is both a function of indoor wet-bulb temperature and outdoor dry-bulb
temperature (and has manufacturers data to create the performance curve), a bi-quadratic
equation using weighted average indoor wet-bulb temperature and condenser entering air
dry-bulb temperature as the independent variables may be used. See the Engineering
Reference for more discussion on using this input field.
Field: Cooling Capacity Modifier Curve Function of Flow Fraction Name
This alpha field defines the name of a linear, quadratic or cubic performance curve (ref:
Performance Curves) that parameterizes the variation of total cooling capacity as a function
of the ratio of actual air flow rate across the cooling coil to the rated air flow rate (i.e., fraction
of full load flow). The output of this curve is multiplied by the gross rated total cooling capacity
and the total cooling capacity modifier curve (function of temperature) to give the gross total
cooling capacity at the specific temperature and air flow conditions at which the coil is
operating. The curve is normalized to have the value of 1.0 when the actual air flow rate
equals the rated air flow rate.
Field: Coil Air Inlet Node Name
This alpha field defines the name of the air inlet node entering the DX cooling coil.
Field: Coil Air Outlet Node Name
This alpha field defines the name of the air outlet node exiting the DX cooling coil.
Field: Name of Water Storage Tank for Condensate Collection
This field is optional. It is used to describe where condensate from the coil is collected. If
blank or omitted, then any coil condensate is discarded. Enter the name of Water Storage
Tank object defined elsewhere and the condensate will then be collected in that tank.
Following is an example input for a Coil:Cooling:DX:VariableRefrigerantFlow object.

9/29/14

1346

Input-Output Reference

Group Heating and Cooling Coils

COIL:Cooling:DX:VariableRefrigerantFlow,
TU1 VRF DX Cooling Coil, !- Coil Name
VRFAvailSched,
!- Availability Schedule Name
autosize,
!- Gross Rated Total Cooling Capacity {W}
autosize,
!- Gross Rated Sensible Heat Ratio
autosize,
!- Rated Air Flow Rate {m3/s}
VRFTUCoolCapFT,
!- Cooling Capacity Ratio Modifier Function of Temperature Curve Name
VRFACCoolCapFFF,
!- Cooling Capacity Modifier Curve Function of Flow Fraction Name
TU1 VRF DX CCoil Inlet Node, !- Coil Air Inlet Node
TU1 VRF DX CCoil Outlet Node; !- Coil Air Outlet Node

Cooling DX Coil (VariableRefrigerantFlow) Outputs

HVAC,Average, Cooling Coil Total Cooling Rate [W]
HVAC,Sum, Cooling Coil Total Cooling Energy [J]
HVAC,Average, Cooling Coil Sensible Cooling Rate [W]
HVAC,Sum, Cooling Coil Sensible Cooling Energy [J]
HVAC,Average, Cooling Coil Latent Cooling Rate [W]
HVAC,Sum, Cooling Coil Latent Cooling Energy [J]
HVAC,Average, Cooling Coil Runtime Fraction []
Evaporative-cooled condenser:
HVAC,Average,Cooling Coil Condensate Volume Flow Rate [m3/s]
Zone,Meter,Condensate:OnSiteWater [m3]
HVAC,Sum,Cooling Coil Condensate Volume [m3]

Cooling Coil Total Cooling Rate [W]

This field is the total (sensible and latent) cooling rate output of the DX coil in Watts. This is
determined by the coil inlet and outlet air conditions and the air mass flow rate through the
coil.
Cooling Coil Total Cooling Energy [J]
This is the total (sensible plus latent) cooling output of the DX coil in Joules over the time step
being reported. This is determined by the coil inlet and outlet air conditions and the air mass
flow rate through the coil. This output is also added to a meter with Resource Type =
EnergyTransfer, End Use Key = CoolingCoils, Group Key = System (Ref. Output:Meter
objects).
Cooling Coil Sensible Cooling Rate [W]
This output is the moist air sensible cooling rate output of the DX coil in Watts. This is
determined by the inlet and outlet air conditions and the air mass flow rate through the coil.
Cooling Coil Sensible Cooling Energy [J]
This is the moist air sensible cooling output of the DX coil in Joules for the time step being
reported. This is determined by the inlet and outlet air conditions and the air mass flow rate
through the coil.
Cooling Coil Latent Cooling Rate [W]
This is the latent cooling rate output of the DX coil in Watts. This is determined by the inlet
and outlet air conditions and the air mass flow rate through the coil.
Cooling Coil Latent Cooling Energy [J]
This is the latent cooling output of the DX coil in Joules for the time step being reported. This
is determined by the inlet and outlet air conditions and the air mass flow rate through the coil.
Cooling Coil Runtime Fraction []
This is the runtime fraction of the DX coil compressor and condenser fan(s) for the time step
being reported.
9/29/14

1347

Input-Output Reference

Group Heating and Cooling Coils

Cooling Coil Condensate Volume Flow Rate [m3/s]

Cooling Coil Condensate Volume [m3]
These outputs are the rate and volume of water collected as condensate from the coil. These
reports only appear if a water storage tank is named in the input object.
Coil:Heating:DX:VariableRefrigerantFlow
The variable refrigerant flow (VRF) DX heating coil model uses performance information at
rated conditions along with performance curves for variations in total capacity, energy input
ratio and part load fraction to determine performance at part-load conditions. The impacts of
defrost operation is modeled based a combination of user inputs and empirical models taken
from the air-to-air heat pump algorithms in DOE-2.1E.
The VRF DX heating coil input requires an availability schedule, the gross rated heating
capacity and the rated air volume flow rate. The rated air volume flow rate should be between
0.00008056 m3/s and 0.00002684 m3/s per watt of gross rated heating capacity.
Two performance curves are required. The first performance curve defines the heating
capacity as a function of indoor air dry-bulb and outdoor condenser entering air wet-bulb
temperature. This curve object is specified in the variable refrigerant flow air-to-air heat pump
object. The second performance curve is specific the each VRF DX heating coil and defines
the change in heating capacity as a function of air flow fraction. Each of these performance
curves are further discussed here.
1) Heating capacity modifier curve (function of temperature, specified in Heat Pump)

The heating capacity modifier curve (function of temperature) can be a function of both
the outdoor wet-bulb temperature and indoor air dry-bulb temperature. Users have the
choice of a bi-quadratic curve with two independent variables or a tri-quadratic curve with
three independent variable. The tri-quadratic curve is recommended if sufficient
manufacturer data is available as it provides sensitivity to the combined total capacity of
all indoor units connected to the heat pump condenser and a more realistic output. The
output of this curve is multiplied by the gross rated heating capacity to give the gross
heating capacity at specific temperature operating conditions (i.e., at an outdoor or indoor
air temperature different from the rating point temperature) and the combination ratio of
the installed system.
2) Heating capacity modifier curve (function of flow fraction, specified in DX coil)

The heating capacity modifier curve (function of flow fraction) is a quadratic or cubic
curve with the independent variable being the ratio of the actual air flow rate across the
heating coil to the rated air flow rate (i.e., fraction of full load flow). The output of this
curve is multiplied by the gross rated heating capacity and the heating capacity modifier
curve (function of temperature) to give the gross heating capacity at the specific
temperature and air flow conditions at which the coil is operating.
Field: Name
This alpha field defines a unique user-assigned name for an instance of a VRF DX heating
coil. Any reference to this DX heating coil by another object will use this name.
Field: Availability Schedule Name
This alpha field defines the name of the schedule (ref: Schedule) that denotes whether the
DX heating coil can run during a given time period. A schedule value greater than 0 (usually 1
is used) indicates that the unit can be on during the time period. A value less than or equal to
0 (usually 0 is used) denotes that the unit must be off for the time period. If this field is blank,
the schedule has values of 1 for all time periods.
Field: Gross Rated Heating Capacity
This numeric field defines the total, full load gross heating capacity in watts of the DX coil unit
at rated conditions (outside air dry-bulb temperature of 8.33 C, outside air wet-bulb
9/29/14

1348

Input-Output Reference

Group Heating and Cooling Coils

temperature of 6.11 C, heating coil entering air dry-bulb temperature of 21.11 C, heating coil
entering air wet-bulb temperature of 15.55 C, and a heating coil air flow rate defined by field
rated air flow volume below). The value entered here must be greater than 0. The gross
total heating capacity should not account for the effect of supply air fan heat.
Field: Rated Air Flow Rate
This numeric field defines the volume air flow rate, in m 3 per second, across the DX heating
coil at rated conditions. The value entered here must be greater than 0. The rated air volume
flow rate should be between 0.00004027 m 3/s and 0.00006041 m 3/s per watt of gross rated
heating capacity. The gross rated heating capacity and the gross rated COP should be
performance information for the unit with outside air dry-bulb temperature of 8.33 C, outside
air wet-bulb temperature of 6.11 C, heating coil entering air dry-bulb temperature of 21.11 C,
heating coil entering air wet-bulb temperature of 15.55 C, and the rated air volume flow rate
defined here.
Field: Coil Air Inlet Node
This alpha field defines the name of the HVAC system node from which the DX heating coil
draws its inlet air.
Field: Coil Air Outlet Node
This alpha field defines the name of the HVAC system node to which the DX heating coil
sends its outlet air.
Field: Heating Capacity Ratio Modifier Function of Temperature Curve Name
This alpha field defines the heating capacity ratio modifier as a function of indoor dry-bulb
temperature or indoor dry-bulb and outdoor wet-bulb temperatures. This curve is a linear,
quadratic, or cubic curve if the heating capacity is soley a function of indoor dry-bulb
temperature (i.e., the indoor terminal units weighted average inlet air dry-bulb temperatures).
Without specific manufacturers data indicating otherwise, the use of a single independent
variable is recommended for this coil type. If, however, the user has reason to believe the
heating capacity is both a function of indoor dry-bulb temperature and outdoor wet-bulb
temperature (and has manufacturers data to create the performance curve), a bi-quadratic
equation using weighted average indoor dry-bulb temperature and condenser entering air
wet-bulb temperature as the independent variables may be used. See the Engineering
Reference for more discussion on using this input field.
Note: The choice of using either outdoor dry-bulb temperature or outdoor wet-bulb temperature as the
independent variable in this performance curve is set in the parent object AirConditioner:
VariableRefrigerantFlow.

Field: Heating Capacity Ratio Modifier Function of Flow Fraction Curve Name
This alpha field defines the name of a linear, quadratic or cubic performance curve (ref:
Performance Curves) that parameterizes the variation of heating capacity as a function of the
ratio of actual air flow rate across the heating coil to the rated air flow rate (i.e., fraction of full
load flow). The output of this curve is multiplied by the gross rated heating capacity and the
heating capacity modifier curve (function of temperature) to give the gross heating capacity at
the specific temperature and air flow conditions at which the coil is operating. The curve is
normalized to have the value of 1.0 when the actual air flow rate equals the rated air flow
rate.
Following is an example input for the object.

9/29/14

1349

Input-Output Reference

Group Heating and Cooling Coils

COIL:Heating:DX:VariableRefrigerantFlow,
TU1 VRF DX Heating Coil, !- Coil Name
VRFAvailSched,
!- Availability Schedule
autosize,
!- Gross Rated Heating Capacity {W}
autosize,
!- Rated Air Flow Rate {m3/s}
TU1 VRF DX CCoil Outlet Node, !- Coil Air Inlet Node
TU1 VRF DX HCoil Outlet Node, !- Coil Air Outlet Node
VRFTUHeatCapFT,
!- Heating Capacity Ratio Modifier Function of Temperature Curve Name
VRFACCoolCapFFF;
!- Total heating capacity modifier curve Function of Flow Fraction

Heating DX Coil (VariableRefrigerantFlow) Outputs

HVAC,Average, Heating Coil Total Heating Rate [W]
HVAC,Sum, Heating Coil Total Heating Energy [J]
HVAC,Average, Heating Coil Runtime Fraction []

Heating Coil Total Heating Rate [W]

This field is the total heating rate output of the DX coil in Watts. This is determined by the coil
inlet and outlet air conditions and the air mass flow rate through the coil.
Heating Coil Total Heating Energy [J]
This is the total heating output of the DX coil in Joules over the time step being reported. This
is determined by the coil inlet and outlet air conditions and the air mass flow rate through the
coil. This output is also added to a meter with Resource Type = EnergyTransfer, End Use
Key = HeatingCoils, Group Key = System (ref. Output:Meter objects).
Heating Coil Runtime Fraction []
This is the runtime fraction of the DX coil compressor and condenser fan(s) for the time step
being reported.
Coil:Heating:Gas
The gas heating coil is a simple capacity model with a user inputted gas burner efficiency.
The default for the gas burner efficiency is 80%. This coil will be simpler than shown in Figure
135 since it will only have air nodes to connect it in the system. The coil can be used in the
air loop simulation or in the zone equipment as a reheat coil. Depending on where it is used
determines if this coil is temperature or capacity controlled. If used in the air loop simulation it
will be controlled to a specified temperature scheduled from the Setpoint Manager. If it is
used in zone equipment, it will be controlled from the zone thermostat by meeting the zone
demand.
Field: Name
A unique identifying name for each coil.
Field: Availability Schedule Name
Schedule that defines when the coil is available. If the schedules value is 0.0, then the coil is
not available and flow will not be requested. If the schedules value is > 0.0 (usually 1 is
used), the coil is available. If this field is blank, the schedule has values of 1 for all time
periods. Schedule values must be >= 0 and <= 1.
Field: Gas Burner Efficiency
This is user inputted gas burner efficiency (decimal, not percent) and is defaulted to 80%.
Field: Nominal Capacity
This is the maximum capacity of the coil (W). This controlled coil will only provide the needed
capacity to meet the control criteria whether it is temperature or capacity controlled. This field
is autosizable.

9/29/14

1350

Input-Output Reference

Group Heating and Cooling Coils

Field: Air Inlet Node Name

The name of the air inlet to the gas coil, i.e. Heating Coil Air Inlet Node.
Field: Air Outlet Node Name
The name of the air outlet from the gas coil, i.e. Heating Coil Air Outlet Node.
Field: Temperature Setpoint Node Name
If the coil is used in the air loop simulation and is temperature controlled using a Set Point
Manager, then the node that is the control node needs to be specified here. If the coil is used
in an air terminal unit, the coil is load controlled and a control node set point is not required.
Field: Parasitic Electric Load
This is the parasitic electric load associated with the gas coil operation, such as an inducer
fan, etc.. This will be modified by the PLR (or coil runtime fraction if a part-load fraction
correlation is provided in the next input field) to reflect the time of operation in a simulation
timestep.
Field: Part Load Fraction Correlation Curve Name
This alpha field defines the name of a quadratic or cubic performance curve (Ref:
Performance Curves) that parameterizes the variation of gas consumption rate by the heating
coil as a function of the part load ratio (PLR, sensible heating load/nominal capacity of the
heating coil). For any simulation timestep, the nominal gas consumption rate (heating
load/burner efficiency) is divided by the part-load fraction (PLF) if a part-load curve has been
defined. The part-load curve accounts for efficiency losses due to transient coil operation.
The part-load fraction correlation should be normalized to a value of 1.0 when the part load
ratio equals 1.0 (i.e., no efficiency losses when the heating coil runs continuously for the
simulation timestep). For PLR values between 0 and 1 ( 0 <= PLR < 1), the following rules
apply:
PLF >= 0.7 and PLF >= PLR
If PLF < 0.7 a warning message is issued, the program resets the PLF value to 0.7, and the
simulation proceeds. The runtime fraction of the heating coil is defined a PLR/PLF. If PLF <
PLR, then a warning message is issues and the runtime fraction of the coil is limited to 1.0.
A typical part load fraction correlation for a conventional gas heating coil (e.g., residential
furnace) would be:
PLF = 0.8 + 0.2(PLR)
Field: Parasitic Gas Load
This numeric field is the parasitic gas load associated with the gas coils operation (Watts),
such as a standing pilot light. The model assumes that this parasitic load is consumed only
for the portion of the simulation timestep where the gas heating coil is not operating.
Heating Coil (Gas) Outputs
HVAC,Sum,Heating Coil Air Heating Energy [J]
HVAC,Average,Heating Coil Air Heating Rate [W]
HVAC,Sum,Heating Coil Gas Energy [J]
HVAC,Average,Heating Coil Gas Rate [W]
HVAC,Sum,Heating Coil Electric Energy [J]
HVAC,Average,Heating Coil Electric Power [W]
HVAC,Average,Heating Coil Runtime Fraction []
HVAC,Sum,Heating Coil Ancillary Gas Energy [J]
HVAC,Average,Heating Coil Ancillary Gas Rate [W]

9/29/14

1351

Input-Output Reference

Group Heating and Cooling Coils

Heating Coil Air Heating Energy [J]

This field is the total heating output of the coil in Joules over the timestep being reported. This
output is also added to a meter with Resource Type = EnergyTransfer, End Use Key =
HeatingCoils, Group Key = System (ref. Output:Meter objects).
Heating Coil Air Heating Rate [W]
This field is the average heating rate output of the coil in Watts over the timestep being
reported.
Heating Coil Gas Energy [J]
This field is the gas consumption of the heating coil in Joules over the timestep being
reported, including the impacts of part-load performance if a part load fraction correlation is
specified. This output is also added to a meter with Resource Type = Gas, End Use Key =
Heating, Group Key = System (ref. Output:Meter objects).
Heating Coil Gas Rate [W]
This field is the average gas consumption rate of the coil in Watts over the timestep being
reported, including the impacts of part-load performance if a part load fraction correlation is
specified.
Heating Coil Electric Energy [J]
This field is the electric consumption of the heating coil auxiliaries in Joules over the timestep
being reported (e.g., inducer fan). This output is also added to a meter with Resource Type =
Electricity, End Use Key = Heating, Group Key = System (ref. Output:Meter objects).
Heating Coil Electric Power [W]
This field is the average electric consumption rate of the heating coil auxiliaries (e.g., inducer
fan) in Watts over the timestep being reported.
Heating Coil Runtime Fraction []
This field is the runtime fraction of the coil over the timestep being reported.
Heating Coil Ancillary Gas Energy [J]
This field is the parasitic gas consumption of the heating coil in Joules over the timestep
being reported (e.g., standing pilot light). The model assumes that the parasitic load is
accumulated only for the portion of the simulation timestep where the gas heating coil is not
operating. This output is also added to a meter with Resource Type = Gas, End Use Key =
Heating, Group Key = System (ref. Output:Meter objects).
Heating Coil Ancillary Gas Rate [W]
This field is the average parasitic gas consumption rate of the heating coil (e.g., standing pilot
light) in Watts over the timestep being reported. The model assumes that the parasitic load is
present only for the portion of the simulation timestep where the gas heating coil is not
operating.
Coil:Heating:Gas:MultiStage
The multi stage gas heating coil is a simple capacity model with a user inputted gas burner
efficiencies at different stages. This coil will only have air nodes to connect it in the system.
The coil can be used in the air loop simulation or in the zone equipment as a reheat coil.
Depending on where it is used determines if this coil is temperature or capacity controlled. If
used in the air loop simulation it will be controlled to a specified temperature scheduled from
the Setpoint Manager. If it is used in zone equipment, it will be controlled from the zone
thermostat by meeting the zone demand. For the time being, this coil model can only be
called by the parent object AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed.
9/29/14

1352

Input-Output Reference

Group Heating and Cooling Coils

Field: Name
A unique identifying name for each coil.
Field: Availability Schedule Name
Schedule that defines when the coil is available. If the schedules value is 0.0, then the coil is
not available and flow will not be requested. If the schedules value is > 0.0 (usually 1 is
used), the coil is available. If this field is blank, the schedule has values of 1 for all time
periods. Schedule values must be >= 0 and <= 1.
Field: Air Inlet Node Name
The name of the air inlet to the gas coil, i.e. Heating Coil Air Inlet Node.
Field: Air Outlet Node Name
The name of the air outlet from the gas coil, i.e. Heating Coil Air Outlet Node.
Field: Temperature Setpoint Node Name
If the coil is used in the air loop simulation and is temperature controlled using a Set Point
Manager, then the node that is the control node needs to be specified here. If the coil is used
in an air terminal unit, the coil is load controlled and a control node set point is not required.
At present, the multistage gas heating coil does not model temperature setoint control.
Field: Part Load Fraction Correlation Curve Name
This alpha field defines the name of a quadratic or cubic performance curve (Ref:
Performance Curves) that parameterizes the variation of gas consumption rate by the heating
coil as a function of the part load ratio (PLR, sensible heating load/nominal capacity of the
heating coil). For any simulation timestep, the nominal gas consumption rate (heating
load/burner efficiency) is divided by the part-load fraction (PLF) if a part-load curve has been
defined. The part-load curve accounts for efficiency losses due to transient coil operation.
The part-load fraction correlation should be normalized to a value of 1.0 when the part load
ratio equals 1.0 (i.e., no efficiency losses when the heating coil runs continuously for the
simulation timestep). For PLR values between 0 and 1 ( 0 <= PLR < 1), the following rules
apply:
PLF >= 0.7 and PLF >= PLR
If PLF < 0.7 a warning message is issued, the program resets the PLF value to 0.7, and the
simulation proceeds. The runtime fraction of the heating coil is defined a PLR/PLF. If PLF <
PLR, then a warning message is issues and the runtime fraction of the coil is limited to 1.0.
A typical part load fraction correlation for a conventional gas heating coil (e.g., residential
furnace) would be:
PLF = 0.8 + 0.2(PLR)
Field: Parasitic Gas Load
This numeric field is the parasitic gas load associated with the gas coils operation (Watts),
such as a standing pilot light. The model assumes that this parasitic load is consumed only
for the portion of the simulation timestep where the gas heating coil is not operating.
Field: Stage 1 Gas Burner Efficiency
This is user inputted stage 1 gas burner efficiency (decimal, not percent) and is defaulted to
80%.
Field: Stage 1 Nominal Capacity
This is the stage 1 capacity of the coil (W). This controlled coil will only provide the needed
capacity to meet the control criteria whether it is temperature or capacity controlled. This field
is autosizable.
9/29/14

1353

Input-Output Reference

Group Heating and Cooling Coils

Field: Stage 1 Parasitic Electric Load

This is the stage 1 parasitic electric load associated with the gas coil operation, such as an
inducer fan, etc.. This will be modified by the PLR (or coil runtime fraction if a part-load
fraction correlation is provided in the next input field) to reflect the time of operation in a
simulation timestep.
Field: Stage 2 Gas Burner Efficiency
This is user inputted stage 2 gas burner efficiency (decimal, not percent) and is defaulted to
80%.
Field: Stage 2 Nominal Capacity
This is the stage 2 capacity of the coil (W). This controlled coil will only provide the needed
capacity to meet the control criteria whether it is temperature or capacity controlled. This field
is autosizable.
Field: Stage 2 Parasitic Electric Load
This is the stage 2 parasitic electric load associated with the gas coil operation, such as an
inducer fan, etc.. This will be modified by the PLR (or coil runtime fraction if a part-load
fraction correlation is provided in the next input field) to reflect the time of operation in a
simulation timestep.
Field: Stage 3 Gas Burner Efficiency
This is user inputted stage 3 gas burner efficiency (decimal, not percent) and is defaulted to
80%.
Field: Stage 3 Nominal Capacity
This is the stage 3 capacity of the coil (W). This controlled coil will only provide the needed
capacity to meet the control criteria whether it is temperature or capacity controlled. This field
is autosizable.
Field: Stage 3 Parasitic Electric Load
This is the stage 3 parasitic electric load associated with the gas coil operation, such as an
inducer fan, etc.. This will be modified by the PLR (or coil runtime fraction if a part-load
fraction correlation is provided in the next input field) to reflect the time of operation in a
simulation timestep.
Field: Stage 4 Gas Burner Efficiency
This is user inputted stage 4 gas burner efficiency (decimal, not percent) and is defaulted to
80%.
Field: Stage 4 Nominal Capacity
This is the stage 4 capacity of the coil (W). This controlled coil will only provide the needed
capacity to meet the control criteria whether it is temperature or capacity controlled. This field
is autosizable.
Field: Stage 4 Parasitic Electric Load
This is the stage 4 parasitic electric load associated with the gas coil operation, such as an
inducer fan, etc.. This will be modified by the PLR (or coil runtime fraction if a part-load
fraction correlation is provided in the next input field) to reflect the time of operation in a
simulation timestep.
An example in IDF form:
Coil:Heating:Gas:MultiStage,
Heat Pump Heating Coil 1,
9/29/14

!- Name
1354

Input-Output Reference

Group Heating and Cooling Coils

FanAndCoilAvailSched,
!- Availability Schedule Name
Heating Coil Air Inlet Node,
!- Air Inlet Node Name
SuppHeating Coil Air Inlet Node, !- Air Outlet Node Name
,
!- Temp Setpoint node name
,
!- Part Load Fraction Correlation Curve Name
,
!- Parasitic Gas Load
3,
!- Number of Speeds
0.92,
!- Speed 1 Gas burner Efficiency
Autosize,
!- Speed 1 Nominal Capacity {W}
,
!- Stage 1 Parasitic Electric Load {W}
0.88,
!- Speed 2 Gas burner Efficiency
Autosize,
!- Speed 2 Nominal Capacity {W}
,
!- Stage 2 Parasitic Electric Load {W}
0.84,
!- Speed 3 Gas burner Efficiency
Autosize,
!- Speed 3 Nominal Capacity {W}
;
!- Stage 3 Parasitic Electric Load {W}

Heating Coil (Gas Multistage) Outputs

HVAC,Sum,Heating Coil Energy[J]
HVAC,Average,Heating Coil Rate[W]
HVAC,Sum,Heating Coil Gas Consumption [J]
HVAC,Average,Heating Coil Gas Consumption Rate [W]
HVAC,Sum,Heating Coil Electric Consumption [J]
HVAC,Average,Heating Coil Electric Power [W]
HVAC,Average,Heating Coil Runtime Fraction
HVAC,Sum,Heating Coil Parasitic Gas Consumption [J]
HVAC,Average,Heating Coil Parasitic Gas Consumption Rate [W]

Heating Coil Energy [J]

This field is the total heating output of the coil in Joules over the timestep being reported. This
output is also added to an output meter with Resource Type = EnergyTransfer, End Use Key
= HeatingCoils, Group Key = System (ref. Output:Meter objects).
Heating Coil Rate [W]
This field is the average heating rate output of the coil in Watts over the timestep being
reported.
Heating Coil Gas Consumption [J]
This field is the gas consumption of the heating coil in Joules over the timestep being
reported, including the impacts of part-load performance if a part load fraction correlation is
specified. This output is also added to an output meter with Resource Type = Gas, End Use
Key = Heating, Group Key = System (ref. Output:Meter objects).
Heating Coil Gas Consumption Rate [W]
This field is the average gas consumption rate of the coil in Watts over the timestep being
reported, including the impacts of part-load performance if a part load fraction correlation is
specified.
Heating Coil Electric Consumption [J]
This field is the electric consumption of the heating coil auxiliaries in Joules over the timestep
being reported (e.g., inducer fan). This output is also added to an output meter with Resource
Type = Electricity, End Use Key = Heating, Group Key = System (ref. Output:Meter objects).
Heating Coil Electric Power [W]
This field is the average electric consumption rate of the heating coil auxiliaries (e.g., inducer
fan) in Watts over the timestep being reported.
9/29/14

1355

Input-Output Reference

Group Heating and Cooling Coils

Heating Coil Parasitic Gas Consumption [J]

This field is the parasitic gas consumption of the heating coil in Joules over the timestep
being reported (e.g., standing pilot light). The model assumes that the parasitic load is
accumulated only for the portion of the simulation timestep where the gas heating coil is not
operating. This output is also added to an output meter with Resource Type = Gas, End Use
Key = Heating, Group Key = System (ref. Output:Meter objects).
Heating Coil Parasitic Gas Consumption Rate [W]
This field is the average parasitic gas consumption rate of the heating coil (e.g., standing pilot
light) in Watts over the timestep being reported. The model assumes that the parasitic load is
present only for the portion of the simulation timestep where the gas heating coil is not
operating.
Coil:Cooling:Water:DetailedGeometry
This detailed flat fin coil model is for continuous plate fins. First, found in Type 12 from
MODSIM, but now programmed directly from Elmahdy, A.H. and Mitalas, G.P. Then there
was a discontinuity in their original model that was fixed in the EnergyPlus implementation.
Now this model can be used in an interval halving solution technique for controlling this coil
without the problems of non-convergence.
"A Model for Cooling and Dehumidifying Coils for Use in Energy Requirements for Buildings"
ASHRAE Transactions, Vol. 83, Part 2, pp. 103-117 (1977). For fin efficiency see K.A.
Gardner, "Efficiency of Extended ," Transactions ASME, Vol. 67, pp. 621-631, 1945.
The following figures illustrate the geometry and circuits in a cooling coil.

Figure 136. Geometry of a Cooling Coil (CC)

9/29/14

1356

Input-Output Reference

Group Heating and Cooling Coils

Figure 137. Number of Coolant Circuits (CCNCC)

Field: Name
A unique identifying name for each coil.
Field: Availability Schedule Name
Schedule that defines when the coil is available. If the schedules value is 0.0, then the coil is
not available and flow will not be requested. If the schedules value is > 0.0 (usually 1 is
used), the coil is available. If this field is blank, the schedule has values of 1 for all time
periods.
Field: Maximum Water Flow Rate
The maximum possible water flow rate (m 3/sec) through the coil.
Field: Tube Outside Surface Area
The outside surface area (m 2) of the tubes that is exposed to air (i.e. the outside area of the
unfinned tubes minus the area of tubes covered by the fins).
Field: Total Tube Inside Area
The total surface area (m 2) inside the tubes (water side).
Field: Fin Surface Area
The total surface area (m 2) of the fins attached to the coil.
9/29/14

1357

Input-Output Reference

Group Heating and Cooling Coils

Field: Minimum Air Flow Area

The minimum cross sectional area (m 2) available for air passage. Frequently calculated as
Amin = (Amin/Afr)*Afr
where Afr is the frontal area of the heat exchanger, and (Amin/Afr) is the ratio of the minimum
airflow area to frontal area.
Field: Coil Depth
The distance (m) from the front of the coil to the back of the coil in the airflow direction. Also
called the fin depth. Illustrated in the figure (Figure 136. Geometry of a Cooling Coil (CC)).
Field: Fin Diameter
The outside diameter (m) of the fins. Used instead of COIL HEIGHT
Field: Fin Thickness
Thickness (m) of the air side fins.
Field: Tube Inside Diameter
The inside diameter (m) of the tubes.
Field: Tube Outside Diameter
The outside diameter (m) of the tubes.
Field: Tube Thermal Conductivity
The thermal conductivity (W/m-K) of the tube material.
Field: Fin Thermal Conductivity
The thermal conductivity (W/m-K) of the fin material.
Field: Fin Spacing
The spacing (m) of the fins, centerline to centerline.
Field: Tube Depth Spacing
The spacing (m) of the tube rows, centerline to centerline. Also called tube longitudinal
spacing.
Field: Number of Tube Rows
The number of tube rows in the direction of the airflow.
Field: Number of Tubes per Row
The number of tubes per row. (NTPR in the above diagram)
Field: Water Inlet Node Name
The name of the water coil inlet from the chilled water loop, i.e. Cooling Coil Water Inlet
Node.
Field: Water Outlet Node Name
The name of the water coil outlet from the chilled water loop, i.e. Cooling Coil Water Outlet
Node.
Field: Air Inlet Node Name
The name of the air inlet to the water coil, i.e. Cooling Coil Air Inlet Node.

9/29/14

1358

Input-Output Reference

Group Heating and Cooling Coils

Field: Air Outlet Node Name

The name of the air outlet from the water coil, i.e. Cooling Coil Air Outlet Node.
Field: Condensate Collection Water Storage Tank Name
This field is optional. It is used to describe where condensate from the coil is collected. If
blank or omitted, then any coil condensate is discarded. Enter the name of Water Storage
Tank object defined elsewhere and the condensate will then be collected in that tank.
Examples of these statements in an IDF are:
Coil:Cooling:Water:DetailedGeometry,
Detailed Cooling Coil, !Name of cooling coil
CoolingCoilAvailSched, !Cooling Coil Schedule
0.0011,
!Max Water Flow Rate of Coil m3/sec
6.23816,
!Tube Outside Surf Area
6.20007018,
!Tube Inside Surf Area
101.7158224,
!Fin Surf Area
0.300606367,
!Min Air Flow Area
0.165097968,
!Coil Depth
0.43507152,
!Coil Height
0.001499982,
!Fin Thickness
0.014449958,
!Tube Inside Diameter
0.015879775,
!Tube Outside Diameter
386.0,
!Tube Thermal Conductivity
204.0,
!Fin Thermal Conductivity
0.001814292,
!Fin Spacing
0.02589977,
!Tube Depth
6,
!Number of Tube Rows
16,
!Number of Tubes per Row
NODE_32,NODE_33, !Coil Water Side Inlet & Outlet Node
NODE_5, NODE_6; !Coil Air Side Inlet & Outlet Node

Detailed Geometry Cooling Coil (Water) Outputs

HVAC,Sum,Cooling Coil Total Cooling Energy [J]
HVAC,Sum,Cooling Coil Sensible Cooling Energy [J]
HVAC,Average,Cooling Coil Total Cooling Rate [W]
HVAC,Average,Cooling Coil Sensible Cooling Rate [W]
HVAC,Average,Cooling Coil Condensate Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Coil Source Side Heat Transfer Energy [J]
HVAC,Sum,Cooling Coil Condensate Volume [m3]

Cooling Coil Total Cooling Energy (J)

Cooling Coil Total Cooling Energy is the total amount of heat transfer taking place in the coil
at the operating conditions.
Cooling Coil Sensible Cooling Energy (J)
Cooling Coil Sensible Cooling Energy is the total amount of Sensible heat transfer taking
place in the coil at the operating conditions. It only takes into account temperature difference
in the inlet and outlet air streams at operating conditions.
Cooling Coil Total Cooling Rate (W)
Cooling Coil Total Cooling Rate is the Rate of heat transfer taking place in the coil at the
operating conditions. The units are (J/sec) or Watts.
Cooling Coil Sensible Cooling Rate (W)
Cooling Coil Sensible Cooling Rate is the Rate of Sensible heat transfer taking place in the
coil at the operating conditions.
In addition, if a Water Storage Tank is used to collect coil condensate, then the following
outputs will be available.

9/29/14

1359

Input-Output Reference

Group Heating and Cooling Coils

Cooling Coil Condensate Volume Flow Rate [m3/s]

Cooling Coil Condensate Volume [m3]
These reports provide the rate and amount of condensate from the coil. Condensate is water
condensed out of the air as a result of cooling. The condensate volume is also reported on
the meter for OnSiteWater.
Cooling Coil Source Side Heat Transfer Energy [J]
This is the energy extracted from the chilled water serving the cooling coil, in Joules.
Coil:Cooling:DX:SingleSpeed
This DX cooling coil input requires an availability schedule, the gross rated total cooling
capacity, the gross rated SHR, the gross rated COP, and the rated air volume flow rate. The
latter 4 inputs determine the coil performance at the rating point (air entering the cooling coil
at 26.7C drybulb/19.4C wetbulb and air entering the outdoor condenser coil at 35C
drybulb/23.9C wetbulb). The rated air volume flow rate should be between .00004027 m3/s
and .00006041 m 3/s per watt of gross rated total cooling capacity (300 to 450 cfm/ton).
The rated volumetric air flow to total cooling capacity ratio for 100% dedicated outdoor air
(DOAS) application DX cooling coils should be between 0.00001677 (m3/s)/W (125 cfm/ton)
and 0.00003355 (m3/s)/W (250 cfm/ton).
This model requires 5 curves as follows:
1. The total cooling capacity modifier curve (function of temperature) is a biquadratic curve
with two independent variables: wet-bulb temperature of the air entering the cooling coil,
and dry-bulb temperature of the air entering the air-cooled condenser coil (wet-bulb
temperature if modeling an evaporative-cooled condenser). The output of this curve is
multiplied by the gross rated total cooling capacity to give the gross total cooling capacity
at specific temperature operating conditions (i.e., at temperatures different from the rating
point temperatures).
2. The total cooling capacity modifier curve (function of flow fraction) is a quadratic or cubic
curve with the independent variable being the ratio of the actual air flow rate across the
cooling coil to the rated air flow rate (i.e., fraction of full load flow). The output of this
curve is multiplied by the gross rated total cooling capacity and the total cooling capacity
modifier curve (function of temperature) to give the gross total cooling capacity at the
specific temperature and air flow conditions at which the coil is operating.
3. The energy input ratio (EIR) modifier curve (function of temperature) is a biquadratic
curve with two independent variables: wet-bulb temperature of the air entering the cooling
coil, and dry-bulb temperature of the air entering the air-cooled condenser coil (wet-bulb
temperature if modeling an evaporative-cooled condenser). The output of this curve is
multiplied by the rated EIR (inverse of the rated COP) to give the EIR at specific
temperature operating conditions (i.e., at temperatures different from the rating point
temperatures).
4. The energy input ratio (EIR) modifier curve (function of flow fraction) is a quadratic or
cubic curve with the independent variable being the ratio of the actual air flow rate across
the cooling coil to the rated air flow rate (i.e., fraction of full load flow). The output of this
curve is multiplied by the rated EIR (inverse of the rated COP) and the EIR modifier curve
(function of temperature) to give the EIR at the specific temperature and air flow
conditions at which the coil is operating.
5. The part load fraction correlation (function of part load ratio) is a quadratic or cubic curve
with the independent variable being part load ratio (sensible cooling load / steady-state
sensible cooling capacity). The output of this curve is used in combination with the rated
EIR and EIR modifier curves to give the effective EIR for a given simulation timestep.
The part load fraction (PLF) correlation accounts for efficiency losses due to compressor
cycling. The curve should be normalized to a value of 1.0 when the part-load ratio equals
1.0 (i.e., the compressor(s) run continuously for the simulation timestep).
9/29/14

1360

Input-Output Reference

Group Heating and Cooling Coils

The curves are simply specified by name. Curve inputs are described in the curve manager
section of this document (see Performance Curves in this document).
The next four input fields are optional and relate to the degradation of latent cooling capacity
when the supply air fan operates continuously while the cooling coil/compressor cycle on and
off to meet the cooling load. The fan operating mode is determined in the partent object and
is considered to either be constant (e.g. CoilSystem:Cooling:DX) or can be scheduled (e.g.
AirLoopHVAC:UnitaryHeatCool). When scheduled, the schedule value must be greater than
0 to calculate degradation of latent cooling capacity. At times when the parent objects supply
air fan operating mode schedule is 0, latent degradation will be ignored. When modeling
latent capacity degradation, these next four input fields must all have positive values.
The next input specifies the outdoor air node used to define the conditions of the air entering
the outdoor condenser. If this field is left blank, the outdoor temperature entering the
condenser is taken directly from the weather data. If this field is not blank, the node name
specified must be listed in an OutdoorAir:Node object where the height of the node is taken
into consideration when calculating outdoor temperature from the weather data. Alternately,
the node name must be specified in an OutdoorAir:NodeList object where the outdoor
temperature entering the condenser is taken directly from the weather data.
The next input describes the type of outdoor condenser coil used with the DX cooling coil (Air
Cooled or Evap Cooled). The following three inputs are required when modeling an
evaporative-cooled condenser: evaporative condenser effectiveness, evaporative condenser
air volume flow rate, and the power consumed by the evaporative condenser pump.
Crankcase heater capacity and cutout temperature are entered in the next two input fields.
These two fields for this object define the name of the water storage tank for supply and
condensate collection. See section DX Cooling Coil Model in the EnergyPlus Engineering
Document for further details regarding this model.
The last two input fields following the Basin Heater Operating Schedule Name are the
Sensible Heat Ratio (SHR) modifier cruve names for temperature and flow fraction. These
two input fields are optional and used only when a user intends to override SHR calculated
using the apparatus dew point (ADP) and bypass factor (BF) method. See section SHR
Calculation Using User Specified SHR Modifier Curves in the EnergyPlus Engineering
Document for further details.
Field: Name
A unique user-assigned name for an instance of a DX cooling coil. Any reference to this DX
coil by another object will use this name.
Field: Availability Schedule Name
The name of the schedule (ref: Schedule) that denotes whether the DX cooling coil can run
during a given time period. A schedule value greater than 0 (usually 1 is used) indicates that
the unit can be on during a given time period. A value less than or equal to 0 (usually 0 is
used) denotes that the unit must be off. If this field is blank, the schedule has values of 1 for
all time periods.
Field: Gross Rated Total Cooling Capacity
The total, full load gross cooling capacity (sensible plus latent) in watts of the DX coil unit at
rated conditions (air entering the cooling coil at 26.7C drybulb/19.4C wetbulb, air entering
the outdoor condenser coil at 35C drybulb/23.9C wetbulb7, and a cooling coil air flow rate
defined by field rated air flow rate below). Capacity should be gross (i.e., the effect of
supply air fan heat is NOT accounted for). When used in a heat pump, the gross rated total
cooling capacity should be within 20% of the gross rated heating capacity, otherwise a
warning message is issued.

9/29/14

The 23.9C wet-bulb temperature condition is not applicable for air-cooled condensers which do not evaporate condensate.

1361

Input-Output Reference

Group Heating and Cooling Coils

Field: Gross Rated Sensible Heat Ratio

The sensible heat ratio (SHR= gross sensible cooling capacity divided by gross total cooling
capacity) of the DX cooling coil at rated conditions (air entering the cooling coil at 26.7C
drybulb/19.4C wetbulb, air entering the outdoor condenser coil at 35C drybulb/23.9C
wetbulb), and a cooling coil air flow rate defined by field rated air flow rate below). Both the
sensible and total cooling capacities used to define the Rated SHR should be gross (i.e.,
the effect of supply air fan heat is NOT accounted for).
Field: Gross Rated Cooling COP
The coefficient of performance is the ratio of the gross total cooling capacity in watts to
electrical power input in watts of the DX cooling coil unit at rated conditions (air entering the
cooling coil at 26.7C drybulb/19.4C wetbulb, air entering the outdoor condenser coil at 35C
drybulb/ 23.9C wetbulb, and a cooling coil air flow rate defined by field rated air flow rate
below). The input power includes electric power for the compressor(s) and condenser fan(s)
but does not include the power consumption of the supply air fan. The gross COP should
NOT account for the supply air fan. If this input field is left blank, the default value is 3.0.
Field: Rated Air Flow Rate
The air volume flow rate, in m 3 per second, across the DX cooling coil at rated conditions.
The rated air volume flow rate should be between 0.00004027 m3/s and 0.00006041 m 3/s per
watt of gross rated total cooling capacity (300 to 450 cfm/ton). For DOAS applications the
rated air volume flow rate should be between 0.00001677 m3/s and 0.00003355 m3/s per watt
of gross rated total cooling capacity (125 to 250 cfm/ton). The gross rated total cooling
capacity, gross rated SHR and gross rated COP should be performance information for the
unit with air entering the cooling coil at 26.7C drybulb/19.4C wetbulb, air entering the
outdoor condenser coil at 35C drybulb/23.9C wetbulb, and the rated air volume flow rate
defined here.
Field: Rated Evaporator Fan Power Per Volume Flow Rate
This field is the electric power for the evaporator (cooling coil) fan per air volume flow rate
through the coil at the rated conditions in W/(m 3/s). The default value is 773.3 W/(m3/s) (365
W/1000 cfm) if this field is left blank. If a value is entered, it must be >= 0.0 and <= 1250
W/(m3/s). This value is only used to calculate Seasonal Energy Efficiency Ratio (SEER),
Energy Efficiency Ratio (EER), Integrated Energy Efficiency Ratio (IEER) and the Standard
Rating (Net) Cooling Capacity which will be outputs in the EnergyPlus eio file (ref.
EnergyPlus Engineering Reference, Single Speed DX Cooling Coil, Standard Ratings). This
value is not used for modeling the evaporator (cooling coil) fan during simulations; instead, it
is used for calculating SEER, EER, IEER and Standard Rating Cooling Capacity to assist the
user in verifying their inputs for modeling this type of equipment.
Field: Air Inlet Node Name
The name of the HVAC system node from which the DX cooling coil draws its inlet air.
Field: Air Outlet Node Name
The name of the HVAC system node to which the DX cooling coil sends its outlet air.
Field: Total Cooling Capacity Function of Temperature Curve Name
The name of a biquadratic performance curve (ref: Performance Curves) that parameterizes
the variation of the gross total cooling capacity as a function of the wet-bulb temperature of
the air entering the cooling coil, and the dry-bulb temperature of the air entering the aircooled condenser coil (wet-bulb temperature if modeling an evaporative-cooled condenser).
The output of this curve is multiplied by the gross rated total cooling capacity to give the
gross total cooling capacity at specific temperature operating conditions (i.e., at temperatures
different from the rating point temperatures). The curve is normalized to have the value of 1.0
at the rating point.
9/29/14

1362

Input-Output Reference

Group Heating and Cooling Coils

Field: Total Cooling Capacity Function of Flow Fraction Curve Name

The name of a quadratic or cubic performance curve (ref: Performance Curves) that
parameterizes the variation of the gross total cooling capacity as a function of the ratio of
actual air flow rate across the cooling coil to the rated air flow rate (i.e., fraction of full load
flow). The output of this curve is multiplied by the gross rated total cooling capacity and the
total cooling capacity modifier curve (function of temperature) to give the gross total cooling
capacity at the specific temperature and air flow conditions at which the coil is operating. The
curve is normalized to have the value of 1.0 when the actual air flow rate equals the rated air
flow rate.
Field: Energy Input Ratio Function of Temperature Curve Name
The name of a biquadratic performance curve (ref: Performance Curves) that parameterizes
the variation of the energy input ratio (EIR) as a function of the wet-bulb temperature of the
air entering the cooling coil, and the dry-bulb temperature of the air entering the air-cooled
condenser coil (wet-bulb temperature if modeling an evaporative-cooled condenser). The EIR
is the inverse of the COP. The output of this curve is multiplied by the rated EIR (inverse of
rated COP) to give the EIR at specific temperature operating conditions (i.e., at temperatures
different from the rating point temperatures). The curve is normalized to a value of 1.0 at the
rating point.
Field: Energy Input Ratio Function of Flow Fraction Curve Name
The name of a quadratic or cubic performance curve (Ref: Performance Curves) that
parameterizes the variation of the energy input ratio (EIR) as a function of the ratio of actual
air flow rate across the cooling coil to the rated air flow rate (i.e., fraction of full load flow). The
EIR is the inverse of the COP. The output of this curve is multiplied by the rated EIR and the
EIR modifier curve (function of temperature) to give the EIR at the specific temperature and
air flow conditions at which the cooling coil is operating. This curve is normalized to a value of
1.0 when the actual air flow rate equals the rated air flow rate.
Field: Part Load Fraction Correlation Curve Name
This alpha field defines the name of a quadratic or cubic performance curve (Ref:
Performance Curves) that parameterizes the variation of electrical power input to the DX unit
as a function of the part load ratio (PLR, sensible cooling load/steady-state sensible cooling
capacity). The product of the rated EIR and EIR modifier curves is divided by the output of
this curve to give the effective EIR for a given simulation timestep. The part load fraction
(PLF) correlation accounts for efficiency losses due to compressor cycling.
The part load fraction correlation should be normalized to a value of 1.0 when the part load
ratio equals 1.0 (i.e., no efficiency losses when the compressor(s) run continuously for the
simulation timestep). For PLR values between 0 and 1 (0 <= PLR < 1), the following rules
apply:
PLF >= 0.7 and PLF >= PLR
If PLF < 0.7 a warning message is issued, the program resets the PLF value to 0.7, and the
simulation proceeds. The runtime fraction of the coil is defined as PLR/PLF. If PLF < PLR,
then a warning message is issued and the runtime fraction of the coil is limited to 1.0.
A typical part load fraction correlation for a conventional, single-speed DX cooling coil (e.g.,
residential unit) would be:
PLF = 0.85 + 0.15(PLR)
If the user wishes to model no efficiency degradation due to compressor cycling, the part load
fraction correlation should be defined as follows:
PLF = 1.0 + 0.0(PLR)

9/29/14

1363

Input-Output Reference

Group Heating and Cooling Coils

Field: Nominal Time for Condensate Removal to Begin

The nominal time (in seconds) after startup for condensate to begin leaving the coil's
condensate drain line at the coil's rated airflow and temperature conditions, starting with a dry
coil. Nominal time is equal to the ratio of the energy of the coil's maximum condensate
holding capacity (J) to the coil's steady-state latent capacity (W). Suggested value is 1000;
zero value means the latent degradation model is disabled. The default value for this field is
zero. The supply air fan operating mode must be continuous (i.e., the supply air fan operating
mode may be specified in other parent objects and is assumed continuous in some objects
(e.g., CoilSystem:Cooling:DX) or can be scheduled in other objects [e.g.,
AirloopHVAC:UnitaryHeatCool]), and this field as well as the next three input fields for this
object must have positive values in order to model latent capacity degradation.
Field: Ratio of Initial Moisture Evaporation Rate and Steady State Latent Capacity
Ratio of the initial moisture evaporation rate from the cooling coil (when the compressor first
turns off, in Watts) and the coil's steady-state latent capacity (Watts) at rated airflow and
temperature conditions. Suggested value is 1.5; zero value means the latent degradation
model is disabled. The default value for this field is zero. The supply air fan operating mode
must be continuous (i.e., the supply air fan operating mode may be specified in other parent
objects and is assumed continuous in some objects (e.g., CoilSystem:Cooling:DX) or can be
scheduled in other objects [e.g., AirloopHVAC:UnitaryHeatCool]); and this field, the previous
field and the next two fields must have positive values in order to model latent capacity
degradation.
Field: Maximum Cycling Rate
The maximum on-off cycling rate for the compressor (cycles per hour), which occurs at 50%
run time fraction. Suggested value is 3; zero value means latent degradation model is
disabled. The default value for this field is zero. The supply air fan operating mode must be
continuous (i.e., the supply air fan operating mode may be specified in other parent objects
and is assumed continuous in some objects (e.g., CoilSystem:Cooling:DX) or can be
scheduled in other objects [e.g., AirloopHVAC:UnitaryHeatCool]); and this field, the previous
two fields and the next field must have positive values in order to model latent capacity
degradation.
Field: Latent Capacity Time Constant
Time constant (in seconds) for the cooling coil's latent capacity to reach steady state after
startup. Suggested value is 45: supply air fan operating mode must be continuous. That is,
the supply air fan operating mode may be specified in other parent objects and is assumed
continuous in some objects (e.g., CoilSystem:Cooling:DX) or can be scheduled in other
objects (e.g., AirloopHVAC:UnitaryHeatCool), and this field as well as the previous three
input fields for this object must have positive values in order to model latent capacity
degradation.
Field: Condenser Air Inlet Node Name
This optional alpha field specifies the outdoor air node name used to define the conditions of
the air entering the outdoor condenser. If this field is left blank, the outdoor air temperature
entering the condenser (dry-bulb or wet-bulb) is taken directly from the weather data. If this
field is not blank, the node name specified must also be specified in an OutdoorAir:Node
object where the height of the node is taken into consideration when calculating outdoor air
temperature from the weather data. Alternately, the node name may be specified in an
OutdoorAir:NodeList object where the outdoor air temperature is taken directly from the
weather data.
Field: Condenser Type
The type of condenser used by the DX cooling coil. Valid choices for this input field are
AirCooled or EvaporativelyCooled. The default for this field is AirCooled.
9/29/14

1364

Input-Output Reference

Group Heating and Cooling Coils

Field: Evaporative Condenser Effectiveness

The effectiveness of the evaporative condenser, which is used to determine the temperature
of the air entering the outdoor condenser coil as follows:

Tcond inlet

Twb, o

1 EvapCondEffectiveness Tdb, o Twb, o

where

Tcond inlet = the temperature of the air entering the condenser coil (C)
Twb,o = the wet-bulb temperature of the outdoor air (C)
Tdb,o = the dry-bulb temperature of the outdoor air (C)
The resulting condenser inlet air temperature is used by the Total Cooling Capacity Modifier
Curve (function of temperature) and the Energy Input Ratio Modifier Curve (function of
temperature). The default value for this field is 0.9, although valid entries can range from 0.0
to 1.0. This field is not used when Condenser Type = Air Cooled.
If the user wants to model an air-cooled condenser, they should simply specify AirCooled in
the field Condenser Type. In this case, the Total Cooling Capacity Modifier Curve (function of
temperature) and the Energy Input Ratio Modifier Curve (function of temperature) input fields
for this object should reference performance curves that are a function of outdoor dry-bulb
temperature.
If the user wishes to model an evaporative-cooled condenser AND they have performance
curves that are a function of the wet-bulb temperature of air entering the condenser coil, then
the user should specify Condenser Type = Evap Cooled and the evaporative condenser
effectiveness value should be entered as 1.0. In this case, the Total Cooling Capacity
Modifier Curve (function of temperature) and the Energy Input Ratio Modifier Curve (function
of temperature) input fields for this object should reference performance curves that are a
function of the wet-bulb temperature of air entering the condenser coil.
If the user wishes to model an air-cooled condenser that has evaporative media placed in
front of it to cool the air entering the condenser coil, then the user should specify Condenser
Type = Evap Cooled. The user must also enter the appropriate evaporative effectiveness for
the media. In this case, the Total Cooling Capacity Modifier Curve (function of temperature)
and the Energy Input Ratio Modifier Curve (function of temperature) input fields for this object
should reference performance curves that are a function of outdoor dry-bulb temperature. Be
aware that the evaporative media will significantly reduce the dry-bulb temperature of the air
entering the condenser coil, so the Total Cooling Capacity and EIR Modifier Curves must be
valid for the expected range of dry-bulb temperatures that will be entering the condenser coil.
Field: Evaporative Condenser Air Flow Rate
The air volume flow rate, in m 3 per second, entering the evaporative condenser. This value is
used to calculate the amount of water used to evaporatively cool the condenser inlet air. The
minimum value for this field must be greater than zero, and this input field is autosizable
(equivalent to 0.000144 m 3/s per watt of rated total cooling capacity [850 cfm/ton]). This field
is not used when Condenser Type = Air Cooled.
Field: Evaporative Condenser Pump Rated Power Consumption
The rated power of the evaporative condenser water pump in Watts. This value is used to
calculate the power required to pump the water used to evaporatively cool the condenser
inlet air. The default value for this input field is zero, but it is autosizable (equivalent to
0.004266 W per watt [15 W/ton] of rated total cooling capacity). This field is not used when
Condenser Type = Air Cooled.

9/29/14

1365

Input-Output Reference

Group Heating and Cooling Coils

Field: Crankcase Heater Capacity

This numeric field defines the crankcase heater capacity in Watts. When the outdoor air drybulb temperature is below the value specified in the input field Maximum Outdoor Dry-bulb
Temperature for Crankcase Heater Operation (described below), the crankcase heater is
enabled during the time that the compressor is not running. If this cooling coil is used as part
of an air-to-air heat pump (Ref. AirLoopHVAC:UnitaryHeatPump:AirToAir or
PackageTerminal: HeatPump:AirToAir), the crankcase heater defined for this DX cooling coil
is ignored and the crankcase heater power defined for the DX heating coil (Ref.
Coil:Heating:DX:SingleSpeed) is enabled during the time that the compressor is not running
for either heating or cooling. The value for this input field must be greater than or equal to 0,
and the default value is 0. To simulate a DX cooling coil without a crankcase heater, enter a
value of 0.
Field: Maximum Outdoor Dry-Bulb Temperature for Crankcase Heater Operation
This numeric field defines the outdoor air dry-bulb temperature above which the compressors
crankcase heater is disabled. The value for this input field must be greater than or equal to
0.0C, and the default value is 10C.
Field: Supply Water Storage Tank Name
This field is optional. It is used to describe where the coil obtains water used for evaporative
cooling of its condenser. If blank or omitted, then the unit will obtain water directly from the
mains. If the name of a Water Storage Tank object is used here, then the unit will obtain its
water from that tank. If a tank is specified, the unit will attempt to obtain all the water it uses
from the tank. However if the tank cannot provide all the water the condenser needs, then the
unit will still operate and obtain the rest of the water it needs from the mains (referred to as
StarvedWater).
Field: Condensate Collection Water Storage Tank Name
This field is optional. It is used to describe where condensate from the coil is collected. If
blank or omitted, then any coil condensate is discarded. Enter the name of Water Storage
Tank object defined elsewhere and the condensate will then be collected in that tank.
Field: Basin Heater Capacity
This numeric field contains the capacity of the DX coils electric evaporative cooler basin
heater in watts per degree Kelvin. This field only applies for Condenser Type =
EvaporativelyCooled. This field is used in conjunction with the Basin Heater Setpoint
Temperature described in the following field. The basin heater electric power is equal to this
field multiplied by the difference between the basin heater set point temperature and the
outdoor dry-bulb temperature. The basin heater only operates when the DX coil is off,
regardless of the basin heater schedule described below. The basin heater capacity must be
greater than or equal to zero, with a default value of zero if this field is left blank.
Field: Basin Heater Setpoint Temperature
This numeric field contains the set point temperature (C) for the basin heater described in
the previous field. This field only applies for Condenser Type = EvaporativelyCooled. The
basin heater is active when the outdoor air dry-bulb temperature falls below this setpoint
temperature, as long as the DX coil is off. This set point temperature must be greater than or
equal to 2C, and the default value is 2C if this field is left blank.
Field: Basin Heater Operating Schedule Name
This alpha field contains the name of the basin heater operating schedule. This field only
applies for Condenser Type = EvaporativelyCooled. The basin heater operating schedule is
assumed to be an on/off schedule and the heater is available to operate any time the
schedule value is greater than 0. The basin heater operates when scheduled on and the
outdoor air dry-bulb temperature is below the set point temperature described in the previous
9/29/14

1366

Input-Output Reference

Group Heating and Cooling Coils

field. If this field is left blank, the basin heater is available to operate throughout the
simulation. Regardless of this schedule, the basin heater may only operate when the DX coil
is off.
Field: Sensible Heat Ratio Function of Temperature Curve Name
The name of a biquadratic normalized curve (Ref: Performance Curves) that parameterizes
the variation of the sensible heat ratio (SHR) as a function of DX cooling coil entering air wetbulb and dry-bulb temperatures. The output of this curve is multiplied by the rated SHR and
the SHR modifier curve (function of flow fraction) to give the SHR at the specific coil entering
air temperature and air flow conditions at which the cooling coil is operating. This curve is
normalized to a value of 1.0 at the rated condition. This input field is optional.
Field: Sensible Heat Ratio Function of Flow Fraction Curve Name
The name of a quadratic or cubic normalized curve (Ref: Performance Curves) that
parameterizes the variation of the sensible heat ratio (SHR) as a function of the ratio of actual
air flow rate across the cooling coil to the rated air flow rate (i.e., fraction of full load flow). The
output of this curve is multiplied by the rated SHR and the SHR modifier curve (function of
temperature) to give the SHR at the specific temperature and air flow conditions at which the
cooling coil is operating. This curve is normalized to a value of 1.0 when the actual air flow
rate equals the rated air flow rate. This input field is optional.
Following is an example input for a Coil:Cooling:DX:SingleSpeed coil.
Coil:Cooling:DX:SingleSpeed,
Zone1WindACDXCoil,
! Coil Name
FanAndCoilAvailSched,
! Availability Schedule
10548,
! Gross Rated Total Cooling Capacity
0.75,
! Gross Rated Sensible Heat Ratio
3.0,
! Gross Rated Cooling COP
0.637,
! Rated Air Flow Rate (m3/s)
773.3,
! Rated Evaporator Fan Power Per Volume Flow Rate {W/(m3/s)}
Zone1WindACFanOutletNode, ! Coil Air Inlet Node
Zone1WindACAirOutletNode, ! Coil Air Outlet Node
WindACCoolCapFT,
! Total Cooling Capacity Modifier Curve (function of temperature)
WindACCoolCapFFF,
! Total Cooling Capacity Modifier Curve (function of flow fraction)
WindACEIRFT,
! Energy Input Ratio Modifier Curve (function of temperature)
WindACEIRFFF,
! Energy Input Ratio Modifier Curve (function of flow fraction)
WindACPLFFPLR,
! Part Load Fraction Correlation (function of part load ratio)
1000.,
! Nominal Time for Condensate Removal to Begin {s}
1.5,
! Ratio of Initial Moisture Evaporation Rate and Steady-state Latent Capacity
3.0,
! Maximum ON/OFF Cycling Rate {cycles/hr}
45.0,
! Latent Capacity Time Constant {s}
,
! Condenser Air Inlet Node Name
AirCooled,
! Condenser Type
,
! Evaporative Condenser Effectiveness
,
! Evaporative Condenser Air Volume Flow Rate {m3/s}
,
! Evaporative Condenser Pump Rated Power Consumption {W}
30.,
! Crankcase Heater Capacity {W}
10.;
! Maximum Outdoor Dry-bulb Temperature for Crankcase Heater Operation {C}

Coil:Cooling:DX:TwoSpeed
This component models a two-speed (or variable speed) DX compressor and fan. The
method is based on the model used for the cycling, single speed DX unit. The single speed
unit is described by single full load capacity, SHR, COP, and air flow rate at rated conditions.
Off rated full load performance is obtained by the use of 4 modifier curves. At partial load the
unit cycles on/off and the cycling losses are described by a part load fraction curve.
The multispeed unit is described by specifying the performance at two states: high speed
compressor, high speed fan; and low speed compressor, low speed fan. When the unit load
is above the high speed capacity, the unit runs with high speed compressor and fan. When
the load on the unit is below the high speed capacity but above the low speed capacity, the
unit will run with performance intermediate between high speed and low speed. When the
9/29/14

1367

Input-Output Reference

Group Heating and Cooling Coils

load is less than the low speed capacity, the unit will cycle on/off just like the single speed
unit.
The multispeed unit model requires 2 full sets of performance data. There must be a high and
low speed capacity, SHR, COP, and evaporator air flow rate; as well as high and low speed
performance curves total cooling capacity modifier curve (function of temperature) and
energy input ratio modifier curve (function of temperature).
The multispeed DX component should be used for all cases in which a DX VAV system is
being simulated. Obviously this model in which performance is obtained by interpolating
between 2 specified states - is an oversimplification of how real multi-speed and variable
speed DX cooling units are controlled. But detailed descriptions of how actual units perform
and are controlled are not available. This model should give a good average prediction of
multispeed and variable speed DX cooling unit performance. The last four input fields
following the Basin Heater Operating Schedule Name are the Sensible Heat Ratio (SHR)
modifier cruve names for temperature and flow fraction for high and low speed DX cooling
coils. These four input fields are optional and used only when a user intends to override
SHR calculated using the apparatus dew point (ADP) and bypass factor (BF) method. See
section SHR Calculation Using User Specified SHR Modifier Curves in the EnergyPlus
Engineering Document for further details..
Field: Name
A unique user-assigned name for an instance of a multispeed DX cooling coil. Any reference
to this DX coil by another object will use this name.
Field: Availability Schedule Name
The name of the schedule (ref: Schedule) that denotes whether the DX cooling coil can run
during a given time period. A schedule value greater than 0 (usually 1 is used) indicates that
the unit can be on during the time period. A value less than or equal to 0 (usually 0 is used)
denotes that the unit must be off for the time period. If this field is blank, the schedule has
values of 1 for all time periods.
Field: High Speed Gross Rated Total Cooling Capacity
The total, full load gross cooling capacity (sensible plus latent) in watts of the DX coil unit for
high speed compressor and high speed fan at rated conditions (air entering the cooling coil at
26.7C drybulb/19.4C wetbulb, air entering the outdoor condenser coil at 35C
drybulb/23.9C wetbulb, and a cooling coil air flow rate defined by field rated air flow rate
below). Capacity should be gross (i.e., the effect of supply air fan heat is NOT accounted
for).
Field: High Speed Gross Rated Sensible Heat Ratio
The sensible heat ratio (gross sensible capacity divided by gross total cooling capacity) of the
DX cooling coil for high speed compressor and high speed fan at rated conditions (air
entering the cooling coil at 26.7C drybulb/19.4C wetbulb, air entering the outdoor
condenser coil at 35C drybulb/23.9C wetbulb8, and a cooling coil air flow rate defined by
field rated air flow rate below). Both the sensible and total cooling capacities used to define
the Rated SHR should be gross (i.e., the effect of supply air fan heat is NOT accounted for).
Field: High Speed Gross Rated Cooling COP
The coefficient of performance is the ratio of the gross total cooling capacity in watts to
electrical power input in watts) of the DX cooling coil unit for high speed compressor and high
speed fan at rated conditions (air entering the cooling coil at 26.7C drybulb/19.4C wetbulb,
air entering the outdoor condenser coil at 35C drybulb/23.9C wetbulb, and a cooling coil air
flow rate defined by field rated air flow rate below). The input power includes electric power
for the compressor(s) and condenser fan(s) but does not include the power consumption of
8

9/29/14

The 23.9C wet-bulb temperature condition is not applicable for air-cooled condensers which do not evaporate condensate.

1368

Input-Output Reference

Group Heating and Cooling Coils

the supply air fan. The gross COP should NOT account for the supply air fan. If this input field
is left blank, the default value is 3.0.
Field: High Speed Rated Air Flow Rate
The high speed air volume flow rate, in m 3 per second, across the DX cooling coil at rated
conditions. The rated air volume flow rate should be between 0.00004027 m3/s and
0.00006041 m3/s per watt of gross rated total cooling capacity. For DOAS applications the
rated air volume flow rate should be between 0.00001677 m3/s and 0.00003355 m3/s per watt
of gross rated total cooling capacity (125 to 250 cfm/ton). The gross rated total cooling
capacity, gross rated SHR and gross rated COP should be performance information for the
unit with air entering the cooling coil at 26.7C drybulb/19.4C wetbulb, air entering the
outdoor condenser coil at 35C drybulb/23.9C wetbulb, and the rated air volume flow rate
defined here.
Field: Unit Internal Static Air Pressure
If this coil is used with a Fan:VariableVolume to model a packaged variable-air-volume unit,
then ratings for standard rated net capacity, EER, and IEER will be calculated per ANSI/AHRI
Standard 340/360-2007 with Addenda 1 and 2. This field is to specify the internal static air
pressure, in units of Pascals, associated with the units supply air flow for rating purposes.
This field does not affect the performance during operation. This field is optional. If this field
is used, then the internal static air pressure is used with the associated fan characteristics
when calculating standard rated net capacity, EER, and IEER. If this field is not used, then
the standard ratings are still performed but use a default for specific fan power of 773.3
(W/(m3/s)). The air pressure drop/rise input here should be internal in the sense that it is for
the entire package of unitary equipment as it would be tested in a laboratory (including other
non-cooling sections inside the package for filters, dampers, and.or heating coils) but none of
the external pressure drop for distributing supply air throughout the building. This is
different from the input field called Pressure Rise in the fan object which includes both the
external static pressure and the internal static pressure. The results of standard rating
calculations are reported to the EIO file and to predefined output tables called DX Cooling
Coils and VAV DX Cooling Standard Rating Details.
Field: Air Inlet Node
The name of the HVAC system node from which the DX cooling coil draws its inlet air.
Field: Air Outlet Node
The name of the HVAC system node to which the DX cooling coil sends its outlet air.
Field: Total Cooling Capacity Function of Temperature Curve Name
The name of a biquadratic performance curve (ref: Performance Curves) that parameterizes
the variation of the gross total cooling capacity as a function of the wet-bulb temperature of
the air entering the cooling coil, and the dry-bulb temperature of the air entering the aircooled condenser (wet-bulb temperature if modeling an evaporative-cooled condenser). The
output of this curve is multiplied by the gross rated total cooling capacity to give the gross
total cooling capacity at specific temperature operating conditions (i.e., at temperatures
different from the rating point temperatures). The curve is normalized to have the value of 1.0
at the rating point. This curve is used for performance at the high speed compressor, high
speed fan operating point.
Field: Total Cooling Capacity Function of Flow Fraction Curve Name
The name of a quadratic performance curve (ref: Performance Curves) that parameterizes
the variation of gross total cooling capacity as a function of the ratio of actual air flow rate
across the cooling coil to the rated air flow rate (i.e., fraction of full load flow). The output of
this curve is multiplied by the gross rated total cooling capacity and the total cooling capacity
modifier curve (function of temperature) to give the gross total cooling capacity at the specific
9/29/14

1369

Input-Output Reference

Group Heating and Cooling Coils

temperature and air flow conditions at which the coil is operating. The curve is normalized to
have the value of 1.0 when the actual air flow rate equals the rated air flow rate. This curve is
applied only at the high speed compressor, high speed fan operating point. There is no
corresponding curve for the low speed operating point.
Field: Energy Input Ratio Function of Temperature Curve Name
The name of a biquadratic performance curve (ref: Performance Curves) that parameterizes
the variation of the energy input ratio (EIR) as a function of the wet-bulb temperature of the
air entering the cooling coil and the dry-bulb temperature of the air entering the air-cooled
condenser (wet-bulb temperature if modeling an evaporative-cooled condenser). The EIR is
the inverse of the COP. The output of this curve is multiplied by the rated EIR (inverse of
rated COP) to give the EIR at specific temperature operating conditions (i.e., at temperatures
different from the rating point temperatures). The curve is normalized to a value of 1.0 at the
rating point. This curve is used for performance at the high speed compressor, high speed
fan operating point.
Field: Energy Input Ratio Function of Flow Fraction Curve Name
The name of a quadratic performance curve (Ref: Performance Curves) that parameterizes
the variation of the energy input ratio (EIR) as a function of the ratio of actual air flow rate
across the cooling coil to the rated air flow rate (i.e., fraction of full load flow). The EIR is the
inverse of the COP. The output of this curve is multiplied by the rated EIR and the EIR
modifier curve (function of temperature) to give the EIR at the specific temperature and air
flow conditions at which the cooling coil is operating. This curve is normalized to a value of
1.0 when the actual air flow rate equals the rated air flow rate. This curve is applied only at
the high speed compressor, high speed fan operating point. There is no corresponding curve
for the low speed operating point.
Field: Part Load Fraction Correlation Curve Name
This alpha field defines the name of a quadratic or cubic performance curve (Ref:
Performance Curves) that parameterizes the variation of electrical power input to the DX unit
as a function of the part load ratio (PLR, sensible cooling load/steady-state sensible cooling
capacity). The product of the rated EIR and EIR modifier curves is divided by the output of
this curve to give the effective EIR for a given simulation timestep. The part load fraction
(PLF) correlation accounts for efficiency losses due to compressor cycling.
The part load fraction correlation should be normalized to a value of 1.0 when the part load
ratio equals 1.0 (i.e., no efficiency losses when the compressor(s) run continuously for the
simulation timestep). For PLR values between 0 and 1 (0 <= PLR < 1), the following rules
apply:
PLF >= 0.7 and PLF >= PLR
If PLF < 0.7 a warning message is issued, the program resets the PLF value to 0.7, and the
simulation proceeds. The runtime fraction of the coil is defined as PLR/PLF. If PLF < PLR,
then a warning message is issued and the runtime fraction of the coil is limited to 1.0.
A typical part load fraction correlation for a conventional, single-speed DX cooling coil (e.g.,
residential unit) would be:
PLF = 0.85 + 0.15(PLR)
If the user wishes to model no efficiency degradation due to compressor cycling, the part load
fraction correlation should be defined as follows:
PLF = 1.0 + 0.0(PLR)
Field: Low Speed Gross Rated Total Cooling Capacity
The total, full load gross total cooling capacity (sensible plus latent) in watts of the DX coil
unit for low speed compressor and low speed fan at rated conditions (air entering the cooling
coil at 26.7C drybulb/19.4C wetbulb, air entering the outdoor condenser coil at 35C
drybulb/23.9C wetbulb, and a cooling coil air flow rate defined by field rated air flow rate,
9/29/14

1370

Input-Output Reference

Group Heating and Cooling Coils

low speed below). Capacity should be gross (i.e., the effect of supply air fan heat is NOT
accounted for).
Field: Low Speed Gross Rated Sensible Heat Ratio
The sensible heat ratio (SHR= gross sensible capacity divided by gross total cooling
capacity) of the DX cooling coil for low speed compressor and low speed fan at rated
conditions (air entering the cooling coil at 26.7C drybulb/19.4C wetbulb, air entering the
outdoor condenser coil at 35C drybulb/23.9C wetbulb, and a cooling coil air flow rate
defined by field rated air flow rate, low speed below). Both the sensible and total cooling
capacities used to define the Rated SHR should be gross (i.e., the effect of supply air fan
heat is NOT accounted for).
Field: Low Speed Gross Rated Cooling COP
The coefficient of performance is the ratio of gross total cooling capacity in watts to electrical
power input in watts) of the DX cooling coil unit for low speed compressor and low speed fan
at rated conditions (air entering the cooling coil at 26.7C drybulb/19.4C wetbulb, air entering
the outdoor condenser coil at 35C drybulb/23.9C wetbulb, and a cooling coil air flow rate
defined by field rated air volume flow rate, low speed below). The input power includes
power for the compressor(s) and condenser fan(s) but does not include the power
consumption of the supply air fan. The gross COP should NOT account for the supply air fan.
If this input field is left blank, the default value is 3.0.
Field: Low Speed Rated Air Flow Rate
The low speed volume air flow rate, in m 3 per second, across the DX cooling coil at rated
conditions. The rated air volume flow rate should be between 0.00004027 m3/s and
0.00006041 m3/s per watt of the gross rated total cooling capacity. For DOAS applications the
rated air volume flow rate should be between 0.00001677 m3/s and 0.00003355 m3/s per watt
of gross rated total cooling capacity (125 to 250 cfm/ton). The gross rated total cooling
capacity, gross rated SHR and gross rated COP should be performance information for the
unit with air entering the cooling coil at 26.7C drybulb/19.4C wetbulb, air entering the
outdoor condenser coil at 35C drybulb/23.9C wetbulb, and the rated air volume flow rate
defined here.
Field: Low Speed Total Cooling Capacity Function of Temperature Curve Name
The name of a biquadratic performance curve (ref: Performance Curves) that parameterizes
the variation of the gross total cooling capacity as a function of the wet-bulb temperature of
the air entering the cooling coil, and the dry-bulb temperature of the air entering the aircooled condenser (wet-bulb temperature if modeling an evaporative-cooled condenser). The
output of this curve is multiplied by the gross rated total cooling capacity to give the gross
total cooling capacity at specific temperature operating conditions (i.e., at temperatures
different from the rating point temperatures). The curve is normalized to have the value of 1.0
at the rating point. This curve is used for performance at the low speed compressor, low
speed fan operating point.
Field: Low Speed Energy Input Ratio Function of Temperature Curve Name
The name of a biquadratic performance curve (ref: Performance Curves) that parameterizes
the variation of the energy input ratio (EIR) as a function of the wetbulb temperature of the air
entering the cooling coil and the drybulb temperature of the air entering the air-cooled
condenser (wetbulb temperature if modeling an evaporative-cooled condenser). The EIR is
the inverse of the COP. The output of this curve is multiplied by the rated EIR (inverse of
rated COP) to give the EIR at specific temperature operating conditions (i.e., at temperatures
different from the rating point temperatures). The curve is normalized to a value of 1.0 at the
rating point. This curve is used for performance at the low speed compressor, low speed fan
operating point.

9/29/14

1371

Input-Output Reference

Group Heating and Cooling Coils

Field: Condenser Air Inlet Node Name

This optional alpha field specifies the outdoor air node name used to define the conditions of
the air entering the outdoor condenser. If this field is left blank, the outdoor air temperature
entering the condenser (dry-bulb or wet-bulb) is taken directly from the weather data. If this
field is not blank, the node name specified must also be specified in an OutdoorAir:Node
object where the height of the node is taken into consideration when calculating outdoor air
temperature from the weather data. Alternately, the node name may be specified in an
OutdoorAir:NodeList object where the outdoor air temperature is taken directly from the
weather data.
Field: Condenser Type
The type of condenser used by the multi-speed DX cooling coil. Valid choices for this input
field are AirCooled or EvaporativelyCooled. The default for this field is AirCooled.
Field: High Speed Evaporative Condenser Effectiveness
The effectiveness of the evaporative condenser at high compressor/fan speed, which is used
to determine the temperature of the air entering the outdoor condenser coil as follows:

Tcond inlet

Twb, o

1 EvapCondEffectivenessHighSpeed Tdb, o Twb, o

where

Tcond inlet = the temperature of the air entering the condenser coil (C)
Twb,o = the wet-bulb temperature of the outdoor air (C)
Tdb,o = the dry-bulb temperature of the outdoor air (C)
The resulting condenser inlet air temperature is used by the Total Cooling Capacity Modifier
Curve (function of temperature) and the Energy Input Ratio Modifier Curve (function of
temperature). The default value for this field is 0.9, although valid entries can range from 0.0
to 1.0. This field is not used when Condenser Type = Air Cooled.
If the user wants to model an air-cooled condenser, they should simply specify AirCooled in
the field Condenser Type. In this case, the Total Cooling Capacity Modifier Curve (function of
temperature) and the Energy Input Ratio Modifier Curve (function of temperature) input fields
for this object should reference performance curves that are a function of outdoor dry-bulb
temperature.
If the user wishes to model an evaporative-cooled condenser AND they have performance
curves that are a function of the wet-bulb temperature of air entering the condenser coil, then
the user should specify Condenser Type = Evap Cooled and the evaporative condenser
effectiveness value should be entered as 1.0. In this case, the Total Cooling Capacity
Modifier Curve (function of temperature) and the Energy Input Ratio Modifier Curve (function
of temperature) input fields for this object should reference performance curves that are a
function of the wet-bulb temperature of air entering the condenser coil.
If the user wishes to model an air-cooled condenser that has evaporative media placed in
front of it to cool the air entering the condenser coil, then the user should specify Condenser
Type = Evap Cooled. The user must also enter the appropriate evaporative effectiveness for
the media. In this case, the Total Cooling Capacity Modifier Curve (function of temperature)
and the Energy Input Ratio Modifier Curve (function of temperature) input fields for this object
should reference performance curves that are a function of outdoor dry-bulb temperature. Be
aware that the evaporative media will significantly reduce the dry-bulb temperature of the air
entering the condenser coil, so the Total Cooling Capacity and EIR Modifier Curves must be
valid for the expected range of dry-bulb temperatures that will be entering the condenser coil.

9/29/14

1372

Input-Output Reference

Group Heating and Cooling Coils

Field: High Speed Evaporative Condenser Air Flow Rate

The air volume flow rate, in m 3 per second, entering the evaporative condenser at high
compressor/fan speed. This value is used to calculate the amount of water used to
evaporatively cool the condenser inlet air. The minimum value for this field must be greater
than zero, and this input field is autosizable (equivalent to 0.000144 m 3/s per watt of rated
high-speed total cooling capacity [850 cfm/ton]). This field is not used when Condenser Type
= Air Cooled.
Field: High Speed Evaporative Condenser Pump Rated Power Consumption
The rated power of the evaporative condenser water pump in Watts at high compressor/fan
speed. This value is used to calculate the power required to pump the water used to
evaporatively cool the condenser inlet air. The default value for this input field is zero, but it is
autosizable (equivalent to 0.004266 W per watt [15 W/ton] of rated high-speed total cooling
capacity). This field is not used when Condenser Type = Air Cooled.
Field: Low Speed Evaporative Condenser Effectiveness
The effectiveness of the evaporative condenser at low compressor/fan speed, which is used
to determine the temperature of the air entering the outdoor condenser coil as follows:

Tcond inlet

Twb, o

1 EvapCondEffectivenessLowSpeed Tdb, o Twb, o

where

Tcond inlet = the temperature of the air entering the condenser coil (C)
Twb,o = the wet-bulb temperature of the outdoor air (C)
Tdb,o = the dry-bulb temperature of the outdoor air (C)
The resulting condenser inlet air temperature is used by the Total Cooling Capacity Modifier
Curve, low speed (function of temperature) and the Energy Input Ratio Modifier Curve, low
speed (function of temperature). The default value for this field is 0.9, although valid entries
can range from 0.0 to 1.0. This field is not used when Condenser Type = Air Cooled. See
field Evaporative Condenser Effectiveness, High Speed above for further information.
Field: Low Speed Evaporative Condenser Air Flow Rate
The air volume flow rate, in m 3 per second, entering the evaporative condenser at low
compressor/fan speed. This value is used to calculate the amount of water used to
evaporatively cool the condenser inlet air. The minimum value for this field must be greater
than zero, and this input field is autosizable (equivalent to 0.000048 m 3/s per watt of rated
high-speed total cooling capacity [280 cfm/ton]). This field is not used when Condenser Type
= Air Cooled.
Field: Low Speed Evaporative Condenser Pump Rated Power Consumption
The rated power of the evaporative condenser water pump in Watts at low compressor/fan
speed. This value is used to calculate the power required to pump the water used to
evaporatively cool the condenser inlet air. The default value for this input field is zero, but it is
autosizable (equivalent to 0.001422 W per watt [5 W/ton] of rated high-speed total capacity).
This field is not used when Condenser Type = Air Cooled.
Field: Supply Water Storage Tank Name
This field is optional. It is used to describe where the coil obtains water used for evaporative
cooling. If blank or omitted, then the cooler will obtain water directly from the mains. If the
name of a Water Storage Tank object is used here, then the cooler will obtain its water from
that tank. If a tank is specified, the coil will attempt to obtain all the water it uses from the
tank. However if the tank cannot provide all the water the cooler needs, then the cooler will
9/29/14

1373

Input-Output Reference

Group Heating and Cooling Coils

still operate and obtain the rest of the water it needs from the mains (referred to as
StarvedWater).
Field: Condensate Collection Water Storage Tank Name
This field is optional. It is used to describe where condensate from the coil is collected. If
blank or omitted, then any coil condensate is discarded. Enter the name of Water Storage
Tank object defined elsewhere and the condensate will then be collected in that tank.
Field: Basin Heater Capacity
This numeric field contains the capacity of the DX coils electric evaporative cooler basin
heater in watts per degree Kelvin. This field only applies for Condenser Type =
EvaporativelyCooled. This field is used in conjunction with the Basin Heater Setpoint
Temperature described in the following field. The basin heater electric power is equal to this
field multiplied by the difference between the basin heater set point temperature and the
outdoor dry-bulb temperature. The basin heater only operates when the DX coil is off,
regardless of the basin heater schedule described below. The basin heater capacity must be
greater than or equal to zero, with a default value of zero if this field is left blank.
Field: Basin Heater Setpoint Temperature
This numeric field contains the set point temperature (C) for the basin heater described in
the previous field. This field only applies for Condenser Type = EvaporativelyCooled. The
basin heater is active when the outdoor air dry-bulb temperature falls below this setpoint
temperature, as long as the DX coil is off. This set point temperature must be greater than or
equal to 2C, and the default value is 2C if this field is left blank.
Field: Basin Heater Operating Schedule Name
This alpha field contains the name of the basin heater operating schedule. This field only
applies for Condenser Type = EvaporativelyCooled. The basin heater operating schedule is
assumed to be an on/off schedule and the heater is available to operate any time the
schedule value is greater than 0. The basin heater operates when scheduled on and the
outdoor air dry-bulb temperature is below the set point temperature described in the previous
field. If this field is left blank, the basin heater is available to operate throughout the
simulation. Regardless of this schedule, the basin heater may only operate when the DX coil
is off.
Field: Sensible Heat Ratio Function of Temperature Curve Name
The name of a biquadratic normalized curve (Ref: Performance Curves) that parameterizes
the variation of the sensible heat ratio (SHR) as a function of DX cooling coil entering air wetbulb and dry-bulb temperatures. The output of this curve is multiplied by the rated SHR and
the SHR modifier curve (function of flow fraction) to give the SHR at the specific coil entering
air temperature and air flow conditions at which the cooling coil is operating. This curve is
normalized to a value of 1.0 at the rated condition. This input field is optional.
Field: Sensible Heat Ratio Function of Flow Fraction Curve Name
The name of a quadratic or cubic normalized curve (Ref: Performance Curves) that
parameterizes the variation of the sensible heat ratio (SHR) as a function of the ratio of actual
air flow rate across the cooling coil to the rated air flow rate (i.e., fraction of full load flow). The
output of this curve is multiplied by the rated SHR and the SHR modifier curve (function of
temperature) to give the SHR at the specific temperature and air flow conditions at which the
cooling coil is operating. This curve is normalized to a value of 1.0 when the actual air flow
rate equals the rated air flow rate. This input field is optional.
Field: Low Sensible Heat Ratio Function of Temperature Curve Name
The name of a biquadratic normalized curve (Ref: Performance Curves) that parameterizes
the variation of the sensible heat ratio (SHR) as a function of DX cooling coil entering air wet9/29/14

1374

Input-Output Reference

Group Heating and Cooling Coils

bulb and dry-bulb temperatures. The output of this curve is multiplied by the rated SHR and
the SHR modifier curve (function of flow fraction) to give the SHR at the specific coil entering
air temperature and air flow conditions at which the cooling coil is operating. This curve is
normalized to a value of 1.0 at the rated condition. This input field is optional.
Field: Low Sensible Heat Ratio Function of Flow Fraction Curve Name
The name of a quadratic or cubic normalized curve (Ref: Performance Curves) that
parameterizes the variation of the sensible heat ratio (SHR) as a function of the ratio of actual
air flow rate across the cooling coil to the rated air flow rate (i.e., fraction of full load flow). The
output of this curve is multiplied by the rated SHR and the SHR modifier curve (function of
temperature) to give the SHR at the specific temperature and air flow conditions at which the
cooling coil is operating. This curve is normalized to a value of 1.0 when the actual air flow
rate equals the rated air flow rate. This input field is optional.
Following are example inputs for the object.
Coil:Cooling:DX:TwoSpeed,
Main Cooling Coil 1,
!- Name
CoolingCoilAvailSched,
!- Availability Schedule Name
autosize,
!- Gross Rated High Speed Total Cooling Capacity {W}
0.68,
!- Gross Rated High Speed Sensible Heat Ratio
3.0,
!- Gross Rated High Speed Cooling COP
autosize,
!- Rated High Speed Air Flow Rate {m3/s}
,
!- Unit Internal Static Air Pressure Drop {Pa}
Mixed Air Node 1,
!- Air Inlet Node Name
Main Cooling Coil 1 Outlet Node, !- Air Outlet Node Name
VarSpeedCoolCapFT,
!- Total Cooling Capacity Function of Temperature Curve Name
PackagedRatedCoolCapFFlow, !- Total Cooling Capacity Function of Flow Fraction Curve Name
VarSpeedCoolEIRFT,
!- Energy Input Ratio Function of Temperature Curve Name
PackagedRatedCoolEIRFFlow, !- Energy Input Ratio Function of Flow Fraction Curve Name
VarSpeedCyclingPLFFPLR, !- Part Load Fraction Correlation Curve Name
autosize,
!- Rated Low Speed Total Cooling Capacity {W}
0.69,
!- Rated Low Speed Sensible Heat Ratio
4.2,
!- Rated Low Speed COP
autosize,
!- Rated Low Speed Air Flow Rate {m3/s}
VarSpeedCoolCapLSFT,
!- Low Speed Total Cooling Capacity Function of Temperature Curve Name
VarSpeedCoolEIRLSFT,
!- Low Speed Energy Input Ratio Function of Temperature Curve Name
Main Cooling Coil 1 Condenser Node; !- Condenser Air Inlet Node Name

9/29/14

1375

Input-Output Reference

Group Heating and Cooling Coils

Coil:Cooling:DX:TwoSpeed,
Main Cooling Coil 1,
!- Name
CoolingCoilAvailSched,
!- Availability Schedule Name
autosize,
!- High Speed Rated Total Cooling Capacity {W}
0.68,
!- High Speed Rated Sensible Heat Ratio
3.0,
!- High Speed Rated Cooling COP
autosize,
!- High Speed Rated Air Flow Rate {m3/s}
,
!- Unit Internal Static Air Pressure Drop {Pa}
Mixed Air Node 1,
!- Air Inlet Node Name
Main Cooling Coil 1 Outlet Node, !- Air Outlet Node Name
VarSpeedCoolCapFT,
!- Total Cooling Capacity Function of Temperature Curve Name
PackagedRatedCoolCapFFlow, !- Total Cooling Capacity Function of Flow Fraction Curve Name
VarSpeedCoolEIRFT,
!- Energy Input Ratio Function of Temperature Curve Name
PackagedRatedCoolEIRFFlow, !- Energy Input Ratio Function of Flow Fraction Curve Name
VarSpeedCyclingPLFFPLR, !- Part Load Fraction Correlation Curve Name
autosize,
!- Low Speed Rated Total Cooling Capacity {W}
0.69,
!- Low Speed Rated Sensible Heat Ratio
4.2,
!- Low Speed Rated Cooling COP
autosize,
!- Low Speed Rated Air Flow Rate {m3/s}
VarSpeedCoolCapLSFT,
!- Low Speed Total Cooling Capacity Function of Temperature Curve Name
VarSpeedCoolEIRLSFT,
!- Low Speed Energy Input Ratio Function of Temperature Curve Name
Main Cooling Coil 1 Condenser Node; !- Condenser Air Inlet Node Name
,
!- Condenser Type
,
!- High Speed Evaporative Condenser Effectiveness {dimensionless}
,
!- High Speed Evaporative Condenser Air Flow Rate {m3/s}
,
!- High Speed Evaporative Condenser Pump Rated Power Consumption {W}
,
!- Low Speed Evaporative Condenser Effectiveness {dimensionless}
,
!- Low Speed Evaporative Condenser Air Flow Rate {m3/s}
,
!- Low Speed Evaporative Condenser Pump Rated Power Consumption {W}
,
!- Supply Water Storage Tank Name
,
!- Condensate Collection Water Storage Tank Name
,
!- Basin Heater Capacity {W/K}
,
!- Basin Heater Setpoint Temperature {C}
,
!- Basin Heater Operating Schedule Name
DOAS DX Coil SHR-FT,
!- High Speed Sensible Heat Ratio Function of Temperature Curve Name
DOAS DX Coil SHR-FF,
!- High Speed Sensible Heat Ratio Function of Flow Fraction Curve Name
DOAS DX Coil SHR-FT,
!- Low Speed Sensible Heat Ratio Function of Temperature Curve Name
DOAS DX Coil SHR-FF;
!- Low Speed Sensible Heat Ratio Function of Flow Fraction Curve Name

Curve:Quadratic,
DOAS DX Coil SHR-FF,
0.9317,
-0.0077,
0.0760,
0.69,
1.30;

!!!!!!-

Name
Coefficient1 Constant
Coefficient2 x
Coefficient3 x**2
Minimum Value of x
Maximum Value of x

Curve:Biquadratic,
DOAS DX Coil SHR-FT,
1.3294540786,
-0.0990649255,
0.0008310043,
0.0652277735,
-0.0000793358,
-0.0005874422,
24.44,
26.67,
29.44,
46.1,
0.6661,
1.6009,
Temperature,
Temperature,
Dimensionless;

!!!!!!!!!!!!!!!!-

Name
Coefficient1 Constant
Coefficient2 x
Coefficient3 x**2
Coefficient4 y
Coefficient5 y**2
Coefficient6 x*y
Minimum Value of x
Maximum Value of x
Minimum Value of y
Maximum Value of y
Minimum Curve Output
Maximum Curve Output
Input Unit Type for X
Input Unit Type for Y
Output Unit Type

9/29/14

1376

Input-Output Reference

Group Heating and Cooling Coils

Coil:Cooling:DX:TwoStageWithHumidityControlMode
The multimode DX coil is functionally equivalent to Coil:Cooling:DX:SingleSpeed but with
multiple performance modes. It is capable of modeling two-stage DX units and units with an
enhanced dehumidification mode such as coil bypass or subcool reheat. This object contains
one-time specifications for the DX unit such as node names and crankcase heater
specifications. It references one or more CoilPerformance:DX:Cooling objects which define
the performance for each mode of operation. It can have up to 4 performance modes to
accommodate a 2-stage 2-mode unit.
The multimode DX coil can be used only as a component of CoilSystem:Cooling:DX or
AirLoopHVAC:UnitaryHeatCool:VAVChangeoverBypass (parent object). These parent
objects pass a load and dehumidification mode to this coil. If the coil has 2 capacity stages,
the multimode coil model determines the stage sequencing.
Field: Name
A unique user-assigned name for an instance of a DX cooling coil. Any reference to this DX
coil by another object will use this name.
Field: Availability Schedule Name
The name of the schedule (ref: Schedule) that denotes whether the DX cooling coil can run
during a given time period. A schedule value greater than 0 (usually 1 is used) indicates that
the unit can be on during a given time period. A value less than or equal to 0 (usually 0 is
used) denotes that the unit must be off. If this field is blank, the schedule has values of 1 for
all time periods.
Field: Air Inlet Node Name
The name of the HVAC system node from which the DX cooling coil draws its inlet air.
Field: Air Outlet Node Name
The name of the HVAC system node to which the DX cooling coil sends its outlet air.
Field: Crankcase Heater Capacity
This numeric field defines the crankcase heater capacity in Watts. When the outdoor air drybulb temperature is below the value specified in the input field Maximum Outdoor Dry-bulb
Temperature for Crankcase Heater Operation (described below), the crankcase heater is
enabled during the time that the compressor is not running. If this cooling coil is used as part
of an air-to-air heat pump (Ref. AirLoopHVAC:UnitaryHeatCool:VAVChangeoverBypass), the
crankcase heater defined for this DX cooling coil is ignored and the crankcase heater power
defined for the DX heating coil (Ref. Coil:Heating:DX:SingleSpeed) is enabled during the time
that the compressor is not running for either heating or cooling. The value for this input field
must be greater than or equal to 0, and the default value is 0. To simulate a DX cooling coil
without a crankcase heater, enter a value of 0.
Field: Maximum Outdoor Dry-Bulb Temperature for Crankcase Heater Operation
This numeric field defines the outdoor air dry-bulb temperature above which the compressors
crankcase heater is disabled. The value for this input field must be greater than or equal to
0.0C, and the default value is 10C.
Field: Number of Capacity Stages
This integer field defines the number of capacity stages. The value for this input field must be
either 1 or 2, and the default value is 1. Larger DX units often have two capacity stages,
which are often two completely independent compressor/coil circuits with the evaporator coils
arranged in parallel in the supply air stream. 2-stage operation affects cycling losses and
latent degradation due to re-evaporation of moisture with continuous fan operation.

9/29/14

1377

Input-Output Reference

Group Heating and Cooling Coils

Field: Number of Enhanced Dehumidification Modes

This integer field defines the number of enhanced dehumidification modes available. The
value for this input field must be 0 or 1, and the default value is 0. If the DX unit can switch
operating modes to increase dehumidification based on a humidistat signal, then set this to 1.
This field just specified the availability of enhanced dehumidification. Actual control of the
operating mode is handled by the coil's parent component.
Field: Normal Mode Stage 1 Coil Performance Object Type
Field: Normal Mode Stage 1 Coil Performance Object Name
This pair of fields specifies the object type and name for the coil performance object which
specifies the DX coil performance for stage 1 operation without enhanced dehumidification
(normal mode). The only valid performance object type is CoilPerformance:DX:Cooling.
Field: Normal Mode Stage 1+2 Coil Performance Object Type
Field: Normal Mode Stage 1+2 Coil Performance Object Name
This pair of fields specifies the object type and name for the coil performance object which
specifies the DX coil performance for stage 1+2 operation (both stages active) without
enhanced dehumidification (normal mode). The only valid performance object type is
CoilPerformance:DX:Cooling.
Field: Dehumidification Mode 1 Stage 1 Coil Performance Object Type
Field: Dehumidification Mode 1 Stage 1 Coil Performance Object Name
This pair of fields specifies the object type and name for the coil performance object which
specifies the DX coil performance for stage 1 operation with enhanced dehumidification
active. The only valid performance object type is CoilPerformance:DX:Cooling.
Field: Dehumidification Mode 1 Stage 1+2 Coil Performance Object Type
Field: Dehumidification Mode 1 Stage 1+2 Coil Performance Object Name
This pair of fields specifies the object type and name for the coil performance object which
specifies the DX coil performance for stage 1+2 operation (both stages active) with enhanced
dehumidification
active.
The
only
valid
performance
object
type
is
CoilPerformance:DX:Cooling.
Field: Supply Water Storage Tank Name
This field is optional. It is used to describe where the coil obtains water used for evaporative
cooling. If blank or omitted, then the cooler will obtain water directly from the mains. If the
name of a Water Storage Tank object is used here, then the cooler will obtain its water from
that tank. If a tank is specified, the coil will attempt to obtain all the water it uses from the
tank. However if the tank cannot provide all the water the cooler needs, then the cooler will
still operate and obtain the rest of the water it needs from the mains (referred to as
StarvedWater).
Field: Condensate Collection Water Storage Tank Name
This field is optional. It is used to describe where condensate from the coil is collected. If
blank or omitted, then any coil condensate is discarded. Enter the name of Water Storage
Tank object defined elsewhere and the condensate will then be collected in that tank.
Field: Basin Heater Capacity
This numeric field contains the capacity of the DX coils electric evaporative cooler basin
heater in watts per degree Kelvin. This field only applies for Condenser Type =
EvaporativelyCooled. This field is used in conjunction with the Basin Heater Setpoint
Temperature described in the following field. The basin heater electric power is equal to this
9/29/14

1378

Input-Output Reference

Group Heating and Cooling Coils

field multiplied by the difference between the basin heater set point temperature and the
outdoor dry-bulb temperature. The basin heater only operates when the DX coil is off,
regardless of the basin heater schedule described below. The basin heater capacity must be
greater than or equal to zero, with a default value of zero if this field is left blank.
Field: Basin Heater Setpoint Temperature
This numeric field contains the set point temperature (C) for the basin heater described in
the previous field. This field only applies for Condenser Type = EvaporativelyCooled. The
basin heater is active when the outdoor air dry-bulb temperature falls below this setpoint
temperature, as long as the DX coil is off. This set point temperature must be greater than or
equal to 2C, and the default value is 2C if this field is left blank.
Field: Basin Heater Operating Schedule Name
This alpha field contains the name of the basin heater operating schedule. This field only
applies for Condenser Type = EvaporativelyCooled. The basin heater operating schedule is
assumed to be an on/off schedule and the heater is available to operate any time the
schedule value is greater than 0. The basin heater operates when scheduled on and the
outdoor air dry-bulb temperature is below the set point temperature described in the previous
field. If this field is left blank, the basin heater is available to operate throughout the
simulation. Regardless of this schedule, the basin heater may only operate when the DX coil
is off.
Following is an example IDF use of the object:
Coil:Cooling:DX:TwoStageWithHumidityControlMode,
DOAS Cooling Coil,
!- Name
HVACTemplate-Always 1,
!- Availability Schedule Name
DOAS Supply Fan Outlet,
!- Air Inlet Node Name
DOAS Cooling Coil Outlet,
!- Air Outlet Node Name
,
!- Crankcase Heater Capacity
,
!- Maximum Outdoor Dry-Bulb Temperature for Crankcase Heater
2,
!- Number of Capacity Stages
1,
!- Number of Enhanced Dehumidification Modes
CoilPerformance:DX:Cooling,
!- Normal Mode Stage 1 Coil Performance Object Type
DOAS Standard Perf 1,
!- Normal Mode Stage 1 Coil Performance Name
CoilPerformance:DX:Cooling,
!- Normal Mode Stage 1+2 Coil Performance Object Type
DOAS Standard Perf 1+2,
!- Normal Mode Stage 1+2 Coil Performance Name
CoilPerformance:DX:Cooling,
!- Dehumidification Mode 1 Stage 1 Coil Performance Object Type
DOAS Dehumid Perf 1,
!- Dehumidification Mode 1 Stage 1 Coil Performance Name
CoilPerformance:DX:Cooling,
!- Dehumidification Mode 1 Stage 1+2 Coil Performance Object Type
DOAS Dehumid Perf 1+2;
!- Dehumidification Mode 1 Stage 1+2 Coil Performance Name

Coil:Cooling:DX:MultiSpeed
This component models a DX cooling unit with multiple discrete levels of cooling capacity.
Depending on input choices, the user can model a single compressor with multiple operating
speeds, or a unit with a single cooling coil fed by multiple compressors (e.g., row split or
intertwined coil circuiting). Currently, this cooling coil can only be referenced by a
AirLoopHVAC:UnitaryHeatPump:AirToAir:Multispeed
object.
Refer
to
Coil:Cooling:DX:TwoStageWithHumidityControlMode if the user wishes to model a cooling
coil with discrete levels of cooling and the possibility of air bypass during low speed operation
(e.g. face-split coil circuiting), or if cooling coil operation based on dehumidification
requirements is desired.
The multispeed DX cooling coil can have from two to four operating speeds. When the coil
operates at Speed 1 (the lowest speed), its performance is very similar to the single speed
DX coil where the impacts of part-load ratio and latent capacity degradation can be included.
When the coil operates at higher speeds (above Speed 1), the linear approximation
methodology is applied. The coil outputs at two consecutive speeds are linearly interpolated
to meet the required cooling capacity during an HVAC system timestep. When the coil
performs above the lowest speed, the user can chose if they want to include part-load ratio
and latent capacity degradation impacts at the higher speeds.
9/29/14

1379

Input-Output Reference

Group Heating and Cooling Coils

The multispeed unit is described by specifying the performance at different operating speeds.
Each speed has its own set of input specifications: full load capacity, SHR, COP and air flow
rate at rated conditions, along with modifier curves to determine performance when actual
operating conditions are different from the rated conditions.
The coil operates to meet the sensible capacity being requested. When this requested
capacity is above the sensible capacity of the highest operating speed, the coil runs
continuously at the highest speed. When the requested capacity is between the sensible
capacities of two consecutive speeds, the unit will operate a portion of the time at each speed
to meet the request. When the requested capacity is less than the low speed (Speed 1)
capacity, the unit will cycle on/off as needed.
Field: Name
A unique user-assigned name for an instance of a multispeed DX cooling coil. Any reference
to this DX coil by another object will use this name.
Field: Availability Schedule Name
The name of the schedule (ref: Schedule) that denotes whether the DX cooling coil can run
during a given time period. A schedule value greater than 0 (usually 1 is used) indicates that
the unit can be on during the time period. A value less than or equal to 0 (usually 0 is used)
denotes that the unit must be off for the time period. If this field is blank, the schedule has
values of 1 for all time periods.
Field: Air Inlet Node Name
The name of the HVAC system node from which the DX cooling coil draws its inlet air.
Field: Air Outlet Node Name
The name of the HVAC system node to which the DX cooling coil sends its outlet air.
Field: Condenser Air Inlet Node Name
This optional alpha field specifies the outdoor air node name used to define the conditions of
the air entering the outdoor condenser. If this field is left blank, the outdoor air temperature
entering the condenser (dry-bulb or wet-bulb) is taken directly from the weather data. If this
field is not blank, the node name specified must also be specified in an OutdoorAir:Node
object where the height of the node is taken into consideration when calculating outdoor air
temperature from the weather data. Alternately, the node name may be specified in an
OutdoorAir:NodeList object where the outdoor air temperature is taken directly from the
weather data.
Field: Condenser Type
The type of condenser used by the multispeed DX cooling coil. Valid choices for this input field
are AirCooled or EvaporativelyCooled. The default for this field is AirCooled.
Field: Supply Water Storage Tank Name
This field is optional. It is used to describe where the coil obtains water used for evaporative
cooling. If blank or omitted, then the evaporative cooler will obtain water directly from the
mains. If the name of a Water Storage Tank object is used here, then the cooler will obtain its
water from that tank. If a tank is specified, the coil will attempt to obtain all the water it uses
from the tank. However if the tank cannot provide all the water the cooler needs, then the
cooler will still operate and obtain the rest of the water it needs from the mains (referred to as
StarvedWater).
Field: Condensate Collection Water Storage Tank Name
This field is optional. It is used to describe where condensate from the coil is collected. If
blank or omitted, then any coil condensate is discarded. Enter the name of Water Storage
Tank object defined elsewhere and the condensate will then be collected in that tank.
9/29/14

1380

Input-Output Reference

Group Heating and Cooling Coils

Field: Apply Part Load Fraction to Speeds Greater than 1

This field determines whether part-load impacts on coil energy use are applied when the coil
is operating at speeds greater than speed 1. The allowed choices are Yes or No, with the
default being No if this field is left blank. Other input fields in this object allow the user to
specify a part-load fraction correlation for each speed to account for compressor start up
losses (cycle on/off). For the case of a single multi-speed compressor, the part load losses
may only be significant when the compressor cycles between speed 1 and off, but the losses
may be extremely small when the compressor operates between speed 1 and speed 2 (or
between speeds 2 and 3, etc.). In this case, the user may chose to specify NO for this input
field to neglect part-load impacts on energy use at higher operating speeds. If part-load
impacts on coil energy use are thought to be significant (e.g., interwined cooling coil with
multiple compressors feeding individual refrigerant circuits), then the user may chose to
specify YES and the part-load fraction correlations specified for speeds 2 through 4 will be
applied as appropriate. The selection for this input field does not affect part-load impacts
when the compressor cycles between speed 1 and off (i.e., the part-load fraction correlation
for speed 1 is always applied).
Field: Apply Latent Degradation to Speeds Greater than 1
This field determines whether latent capacity degradation is applied when the coil is operating
at speeds greater than speed 1. The allowed choices are Yes or No, with the default being
No if this field is left blank. Other input fields in this object allow the user to specify latent
capacity degradation at each speed.
The
latent
capacity
degradation
model
only
applies
when
the
ContinuousFanWithCyclingCompressor supply air fan operating mode is specified, to account
for moisture evaporation from the wet cooling coil when the compressor cycles off but the
supply air fan continues to operate. For the case of a single multi-speed compressor, latent
capacity degradation may only be significant when the compressor cycles between speed 1
and off, but the losses may be extremely small when the compressor operates between
speed 1 and speed 2 (or between speeds 2 and 3, etc.). In this case, the user may chose to
specify NO for this input field to neglect latent capacity degradation impacts at higher
operating speeds. If latent capacity degradation is thought to be significant (e.g., interwined
or row-split cooling coil with multiple compressors feeding individual refrigerant circuits), then
the user may chose to specify YES and the latent capacity degradation model will be applied
for speeds 2 through 4 as appropriate. The selection for this input field does not affect latent
capacity degradation between speed 1 and off.
Field: Crankcase Heater Capacity
This numeric field defines the crankcase heater capacity in Watts. When the outdoor air drybulb temperature is below the value specified in the input field Maximum Outdoor Dry-bulb
Temperature for Crankcase Heater Operation (described below), the crankcase heater is
enabled during the time that the compressor is not running. The value for this input field must
be greater than or equal to 0. If this input field is left blank, the default value is 0. To simulate
a unit without a crankcase heater, enter a value of 0.
Field: Maximum Outdoor Dry-Bulb Temperature for Crankcase Heater Operation
This numeric field defines the outdoor air dry-bulb temperature above which the compressors
crankcase heater is disabled. The value for this input field must be greater than or equal to
0.0C. If this input field is left blank, the default value is 10C.
Field: Basin Heater Capacity
This numeric field contains the capacity of the DX coils electric evaporative cooler basin
heater in watts per degree Kelvin. This field only applies for Condenser Type =
EvaporativelyCooled. This field is used in conjunction with the Basin Heater Setpoint
Temperature described in the following field. The basin heater electric power is equal to this
field multiplied by the difference between the basin heater set point temperature and the
9/29/14

1381

Input-Output Reference

Group Heating and Cooling Coils

outdoor dry-bulb temperature. The basin heater only operates when the DX coil is off,
regardless of the basin heater schedule described below. The basin heater capacity must be
greater than or equal to zero, with a default value of zero if this field is left blank.
Field: Basin Heater Setpoint Temperature
This numeric field contains the set point temperature (C) for the basin heater described in
the previous field. This field only applies for Condenser Type = EvaporativelyCooled. The
basin heater is active when the outdoor air dry-bulb temperature falls below this setpoint
temperature, as long as the DX coil is off. This set point temperature must be greater than or
equal to 2C, and the default value is 2C if this field is left blank.
Field: Basin Heater Operating Schedule Name
This alpha field contains the name of the basin heater operating schedule. This field only
applies for Condenser Type = EvaporativelyCooled. The basin heater operating schedule is
assumed to be an on/off schedule and the heater is available to operate any time the
schedule value is greater than 0. The basin heater operates when scheduled on and the
outdoor air dry-bulb temperature is below the set point temperature described in the previous
field. If this field is left blank, the basin heater is available to operate throughout the
simulation. Regardless of this schedule, the basin heater may only operate when the DX coil
is off.
Field: Fuel Type
This alpha field determines the type of fuel that this cooling coil uses. This field has seven
choices: Electricity, NaturalGas, PropaneGas, Coal, Diesel, Gasoline, FuelOil#1, FuelOil#2,
OtherFuel1 and OtherFuel2. The default is NaturalGas.
Field: Number of Speeds
This field specifies the number of sets of data being entered for rated specifications,
performance curves, evaporative condenser data, latent degradation data, and waste heat
specifications for each cooling speed. The rated specifications consist of gross rated
capacity, gross rated SHR, gross rated COP, and rated air flow rate. The performance curves
consist of a total capacity modifier curve as a function of temperature, total capacity modifier
curve as a function of flow fraction, energy input ratio modifier curve as a function of
temperature, energy input ratio modifier curve as a function of flow fraction, and part load
fraction correlation as a function of part load ratio. The evaporative condenser data consists
of effectiveness, condenser air volume flow rate, and rated pump power consumption. The
latent degradation data consists of nominal time for condensate removal to begin, ratio of
initial moisture evaporation rate and steady-state latent capacity, maximum On/Off cycling
rate, and latent capacity time constant. The latent degradation data are only applied if the
supply air fan operation mode is specified as ContinuousFanWithCyclingCompressor. The
waste heat specifications include the fraction of energy input to the cooling coil at the fully
loaded and rated conditions, and a temperature modifier. The minimum number of speeds for
cooling is 2 and the maximum number is 4. The number of speeds should be the same as the
number
of
speeds
for
cooling
defined
in
its
parent
object
(AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed). The first set of performance inputs is
for Speed 1 and should be for low speed, and the last set of performance inputs should be for
high speed. For example, if only three cooling speeds are defined, the first set should be for
low speed (Speed 1), the second set should be for medium speed (Speed 2), and the third
set should be for high speed (Speed 3). In this example, any performance inputs for Speed 4
would be neglected (since this input field specifies that the coil only has three cooling
speeds).

9/29/14

1382

Input-Output Reference

Group Heating and Cooling Coils

Field Group: Rated Specification, Performance Curves, Latent Capacity Degradation

Inputs, and Evaporative Cooled Condenser Data
The performance for each cooling speed must be specified as shown below. All inputs for
Speed 1 are required first, followed by the inputs for Speed 2, Speed 3 and Speed 4.
Field: Speed <x> Gross Rated Total Cooling Capacity
The total, full load gross cooling capacity (sensible plus latent) in watts of the DX coil unit for
Speed <x> operation at rated conditions (air entering the cooling coil at 26.7C
drybulb/19.4C wetbulb, air entering the outdoor condenser coil at 35C drybulb/23.9C
wetbulb9, and a cooling coil air flow rate defined by field Rated Air Flow Rate, Speed <x>
below). Capacity should be gross (i.e., the effect of supply air fan heat is NOT accounted
for).
Field: Speed <x> Gross Rated Sensible Heat Ratio
The sensible heat ratio (SHR= gross sensible capacity divided by gross total cooling
capacity) of the DX cooling coil for Speed <x> operation at rated conditions (air entering the
cooling coil at 26.7C drybulb/19.4C wetbulb, air entering the outdoor condenser coil at 35C
drybulb/23.9C wetbulb, and a cooling coil air flow rate defined by field Rated Air Flow Rate,
Speed <x> below). Both the sensible and total cooling capacities used to define the Rated
SHR should be gross (i.e., the effect of supply air fan heat is NOT accounted for).
Field: Speed <x> Gross Rated Cooling COP
The coefficient of performance is the ratio of the gross total cooling capacity in watts to
electrical power input in watts) of the DX cooling coil unit for Speed <x> operation at rated
conditions (air entering the cooling coil at 26.7C drybulb/19.4C wetbulb, air entering the
outdoor condenser coil at 35C drybulb/23.9C wetbulb, and a cooling coil air flow rate
defined by field Rated Air Flow Rate, Speed <x> below). The input power includes power for
the compressor(s) and condenser fan(s) but does not include the power consumption of the
supply air fan. The gross COP should NOT account for the supply air fan. If this input field is
left blank, the default value is 3.0.
Field: Speed <x> Rated Air Flow Rate
The volumetric air flow rate for Speed <x>, in m 3 per second, across the DX cooling coil at
rated conditions. The rated air volume flow rate for Speed <x> should be between
0.00004027 m 3/s and 0.00006041 m 3/s per watt of the gross rated total cooling capacity for
Speed <x>. The gross rated total cooling capacity, gross rated SHR and gross rated COP for
Speed <x> should be performance information for the unit with air entering the cooling coil at
26.7C drybulb/19.4C wetbulb, air entering the outdoor condenser coil at 35C
drybulb/23.9C wetbulb, and the rated air volume flow rate defined here.
Field: Speed <X> Rated Evaporator Fan Power Per Volume Flow Rate
This field is the electric power for the evaporator (cooling coil) fan per air volume flow rate
through the coil at the rated conditions for Speed <x> in W/(m3/s). The default value is 773.3
W/(m3/s) (365 W/1000 cfm) if this field is left blank. If a value is entered, it must be >= 0.0
and <= 1250 W/(m3/s). This value is only used to calculate Seasonal Energy Efficiency Ratio
(SEER), and the Standard Rating (Net) Cooling Capacity which will be outputs in the
EnergyPlus eio file (ref. EnergyPlus Engineering Reference, Multi-Speed DX Cooling Coil,
Standard Ratings). This value is not used for modeling the evaporator (cooling coil) fan
during simulations; instead, it is used for calculating SEER and Standard Rating Cooling
Capacity to assist the user in verifying their inputs for modeling this type of equipment.
Field: Speed <x> Total Cooling Capacity Function of Temperature Curve Name
The name of a biquadratic performance curve (ref: Performance Curves) that parameterizes
the variation of the gross total cooling capacity for Speed <x> as a function of the wet-bulb
9

9/29/14

The 23.9C wet-bulb temperature condition is not applicable for air-cooled condensers which do not evaporate condensate.

1383

Input-Output Reference

Group Heating and Cooling Coils

temperature of the air entering the cooling coil, and the dry-bulb temperature of the air
entering the air-cooled condenser (wet-bulb temperature if modeling an evaporative-cooled
condenser). The output of this curve is multiplied by the gross rated total cooling capacity for
Speed <x> to give the gross total cooling capacity at specific temperature operating
conditions (i.e., at temperatures different from the rating point temperatures). The curve is
normalized to have the value of 1.0 at the rating point.
Field: Speed <x> Total Cooling Capacity Function of Flow Fraction Curve Name
The name of a quadratic performance curve (ref: Performance Curves) that parameterizes
the variation of the gross total cooling capacity for Speed <x> as a function of the ratio of
actual air flow rate across the cooling coil to the rated air flow rate for Speed <x> (i.e., fraction
of full load flow). The output of this curve is multiplied by the gross rated total cooling capacity
and the total cooling capacity modifier curve (function of temperature) to give the gross total
cooling capacity for Speed <x> at the specific temperature and air flow conditions at which
the coil is operating. The curve is normalized to have the value of 1.0 when the actual air flow
rate equals the rated air flow rate for Speed <x>.
Field: Speed <x> Energy Input Ratio Function of Temperature Curve Name
The name of a biquadratic performance curve (ref: Performance Curves) that parameterizes
the variation of the energy input ratio (EIR) for Speed <x> as a function of the wetbulb
temperature of the air entering the cooling coil and the drybulb temperature of the air entering
the air-cooled condenser (wetbulb temperature if modeling an evaporative-cooled
condenser). The EIR is the inverse of the COP. The output of this curve is multiplied by the
rated EIR for Speed <x> (inverse of rated COP for Speed <x>) to give the EIR for Speed <x>
at specific temperature operating conditions (i.e., at temperatures different from the rating
point temperatures). The curve is normalized to a value of 1.0 at the rating point.
Field: Speed <x> Energy Input Ratio Function of Flow Fraction Curve Name
The name of a quadratic performance curve (Ref: Performance Curves) that parameterizes
the variation of the energy input ratio (EIR) for Speed <x> as a function of the ratio of actual
air flow rate across the cooling coil to the rated air flow rate for Speed <x> (i.e., fraction of full
load flow). The EIR is the inverse of the COP. The output of this curve is multiplied by the
rated EIR and the EIR modifier curve (function of temperature) to give the EIR for Speed <x>
at the specific temperature and air flow conditions at which the cooling coil is operating. This
curve is normalized to a value of 1.0 when the actual air flow rate equals the rated air flow
rate for Speed <x>.
Field: Speed <x> Part Load Fraction Correlation Curve Name
This alpha field defines the name of a quadratic or cubic performance curve (Ref:
Performance Curves) that parameterizes the variation of electrical power input to the DX unit
as a function of the part load ratio (PLR, sensible cooling load/steady-state sensible cooling
capacity for Speed <x>). The product of the rated EIR and EIR modifier curves is divided by
the output of this curve to give the effective EIR for a given simulation timestep for Speed
<x>. The part load fraction (PLF) correlation accounts for efficiency losses due to compressor
cycling.
The part load fraction correlation should be normalized to a value of 1.0 when the part load
ratio equals 1.0 (i.e., no efficiency losses when the compressor(s) run continuously for the
simulation timestep). For PLR values between 0 and 1 (0 <= PLR < 1), the following rules
apply:
PLF >= 0.7 and PLF >= PLR
If PLF < 0.7 a warning message is issued, the program resets the PLF value to 0.7, and the
simulation proceeds. The runtime fraction of the coil is defined as PLR/PLF. If PLF < PLR,
then a warning message is issued and the runtime fraction of the coil is limited to 1.0.

9/29/14

1384

Input-Output Reference

Group Heating and Cooling Coils

A typical part load fraction correlation for a conventional DX cooling coil (Speed <x>) would
be:
PLF = 0.85 + 0.15(PLR)
If the user wishes to model no efficiency degradation due to compressor cycling, the part load
fraction correlation should be defined as follows:
PLF = 1.0 + 0.0(PLR)
Field: Speed <x> Nominal Time for Condensate Removal to Begin
For Speed <x>, the nominal time (in seconds) after startup for condensate to begin leaving
the coil's condensate drain line at the coil's rated airflow and temperature conditions, starting
with a dry coil. Nominal time is equal to the ratio of the energy of the coil's maximum
condensate holding capacity (J) to the coil's steady-state latent capacity (W). Suggested
value is 1000; zero value means the latent degradation model is disabled. The default value
for this field is zero. The supply air fan operating mode must be continuous (i.e., the supply
air fan operating mode may be specified in other parent objects and is assumed continuous
in some objects (e.g., CoilSystem:Cooling:DX) or can be scheduled in other objects [e.g.,
AirloopHVAC:UnitaryHeatCool]), and this field as well as the next three input fields for this
object must have positive values in order to model latent capacity degradation for Speed <x>.
Field: Speed <x> Ratio of Initial Moisture Evaporation Rate and Steady State Latent
Capacity
For Speed <x>, the ratio of the initial moisture evaporation rate from the cooling coil (when
the compressor first turns off, in Watts) and the coil's steady-state latent capacity (Watts) for
Speed <x> at rated airflow and temperature conditions. Suggested value is 1.5; zero value
means the latent degradation model is disabled. The default value for this field is zero. The
supply air fan operating mode must be continuous (i.e., the supply air fan operating mode
may be specified in other parent objects and is assumed continuous in some objects (e.g.,
CoilSystem:Cooling:DX)
or
can
be
scheduled
in
other
objects
[e.g.,
AirloopHVAC:UnitaryHeatCool]); and this field, the previous field and the next two fields must
have positive values in order to model latent capacity degradation for Speed <x>.
Field: Speed <x> Maximum Cycling Rate
For Speed <x>, the maximum on-off cycling rate for the compressor (cycles per hour), which
occurs at 50% run time fraction. Suggested value is 3; zero value means latent degradation
model is disabled. The default value for this field is zero. The supply air fan operating mode
must be continuous (i.e., the supply air fan operating mode may be specified in other parent
objects and is assumed continuous in some objects (e.g., CoilSystem:Cooling:DX) or can be
scheduled in other objects [e.g., AirloopHVAC:UnitaryHeatCool]); and this field, the previous
two fields and the next field must have positive values in order to model latent capacity
degradation for Speed <x>.
Field: Speed <x> Latent Capacity Time Constant
For Speed <x>, the time constant (in seconds) for the cooling coil's latent capacity to reach
steady state after startup. Suggested value is 45; zero value means latent degradation model
is disabled. The default value for this field is zero. The supply air fan operating mode must be
continuous (i.e., the supply air fan operating mode may be specified in other parent objects
and is assumed continuous in some objects (e.g., CoilSystem:Cooling:DX) or can be
scheduled in other objects [e.g., AirloopHVAC:UnitaryHeatCool]), and this field as well as the
previous three input fields for this object must have positive values in order to model latent
capacity degradation for Speed <x>.
Field: Speed <x> Rated Waste Heat Fraction of Power Input
The fraction of energy input to the cooling coil that is available as recoverable waste heat at
full load and rated conditions for Speed <x>.

9/29/14

1385

Input-Output Reference

Group Heating and Cooling Coils

Field: Speed <x> Waste Heat Function of Temperature Curve Name

The name of a biquadratic performance curve (ref: Performance Curves) that parameterizes
the variation of the waste heat recovery as a function of outdoor dry-bulb temperature and the
entering coil dry-bulb temperature at Speed <x>. The output of this curve is multiplied by the
rated waste heat fraction at specific temperature operating conditions (i.e., at temperatures
different from the rating point). The curve is normalized to a value of 1.0 at the rating point.
When the fuel type is electricity, this field can remain blank since it is ignored by the program
in this instance.
Field: Speed <x> Evaporative Condenser Effectiveness
The effectiveness of the evaporative condenser at Speed <x>, which is used to determine the
temperature of the air entering the outdoor condenser coil as follows:

Tcond inlet

Twb, o

1 EvapCondEffectivenessSpeed 1 Tdb, o Twb, o

where

Tcond inlet = the temperature of the air entering the condenser coil (C)
Twb,o = the wet-bulb temperature of the outdoor air (C)
Tdb,o = the dry-bulb temperature of the outdoor air (C)
The resulting condenser inlet air temperature is used by the Total Cooling Capacity Modifier
Curve, Speed <x> (function of temperature) and the Energy Input Ratio Modifier Curve,
Speed <x> (function of temperature). The default value for this field is 0.9, although valid
entries can range from 0.0 to 1.0. This field is not used when Condenser Type = Air Cooled.
If the user wants to model an air-cooled condenser, they should simply specify AirCooled in
the field Condenser Type. In this case, the Total Cooling Capacity Modifier Curve, Speed <x>
(function of temperature) and the Energy Input Ratio Modifier Curve, Speed <x> (function of
temperature) input fields for this object should reference performance curves that are a
function of outdoor dry-bulb temperature.
If the user wishes to model an evaporative-cooled condenser AND they have performance
curves that are a function of the wet-bulb temperature of air entering the condenser coil, then
the user should specify Condenser Type = Evap Cooled and the evaporative condenser
effectiveness value should be entered as 1.0. In this case, the Total Cooling Capacity
Modifier Curve, Speed <x> (function of temperature) and the Energy Input Ratio Modifier
Curve, Speed <x> (function of temperature) input fields for this object should reference
performance curves that are a function of the wet-bulb temperature of air entering the
condenser coil.
If the user wishes to model an air-cooled condenser that has evaporative media placed in
front of it to cool the air entering the condenser coil, then the user should specify Condenser
Type = Evap Cooled. The user must also enter the appropriate evaporative effectiveness for
the media. In this case, the Total Cooling Capacity Modifier Curve, Speed <x> (function of
temperature) and the Energy Input Ratio Modifier Curve, Speed <x> (function of temperature)
input fields for this object should reference performance curves that are a function of outdoor
dry-bulb temperature. Be aware that the evaporative media will significantly reduce the drybulb temperature of the air entering the condenser coil, so the Total Cooling Capacity and
EIR Modifier Curves for Speed <x> must be valid for the expected range of dry-bulb
temperatures that will be entering the condenser coil.
Field: Speed <x> Evaporative Condenser Air Flow Rate
The air volume flow rate, in m 3 per second, entering the evaporative condenser at Speed
<x>. This value is used to calculate the amount of water used to evaporatively cool the
condenser inlet air. The minimum value for this field must be greater than zero, and this input

9/29/14

1386

Input-Output Reference

Group Heating and Cooling Coils

field is autosizable (equivalent to 0.000114 m 3/s per watt of rated total cooling capacity for
Speed <x> [850 cfm/ton]). This field is not used when Condenser Type = Air Cooled.
Field: Speed <x> Rated Evaporative Condenser Pump Power Consumption
The rated power of the evaporative condenser water pump in Watts at Speed <x>. This value
is used to calculate the power required to pump the water used to evaporatively cool the
condenser inlet air. The default value for this input field is zero, but it is autosizable
(equivalent to 0.004266 W per watt [15 W/ton] of rated total capacity for Speed <x>). This
field is not used when Condenser Type = Air Cooled.
Following is an example input for this multispeed DX cooling coil.
Coil:Cooling:DX:MultiSpeed,
Heat Pump ACDXCoil 1,
!- Coil Name
FanAndCoilAvailSched,
!- Availability Schedule
DX Cooling Coil Air Inlet Node, !- Coil Air Inlet Node
Heating Coil Air Inlet Node,
!- Coil Air Outlet Node
Outdoor Condenser Air Node,
!- Condenser Air Inlet Node Name
AirCooled,
!- Condenser Type
,
!- Name of Water Storage Tank for Supply
,
!- Name of Water Storage Tank for Condensate Collection
No,
!- Apply Part Load Fraction to Speeds greater than 1
No,
!- Apply latent degradation to Speeds greater than 1
200.0,
!- Crankcase Heater Capacity {W}
10.0,
!- Maximum Outdoor Dry-bulb Temperature for Crankcase Heater Operation
,
!- Basin Heater Capacity {W/K}
,
!- Basin Heater Setpoint Temperature {C}
,
!- Basin Heater Operating Schedule Name
NaturalGas,
!- Fuel Type
4,
!- Number of speeds
7500,
!- Gross Rated Total Cooling Capacity, Speed 1 {W}
0.75,
!- Gross Rated Sensible Heat Ratio, Speed 1 {dimensionless}
3.0,
!- Gross Rated Cooling COP, Speed 1 {dimensionless}
0.40,
!- Rated Air Flow Rate, Speed 1 {m3/s}
,
!- Rated Evaporator Fan Power Per Volume Flow Rate, Speed 1 {W/(m3/s)}
HPACCoolCapFT Speed 1,
!- Total Cooling Capacity Modifier Curve, Speed 1 (temperature)
HPACCoolCapFF Speed 1,
!- Total Cooling Capacity Modifier Curve, Speed 1 (flow fraction)
HPACCOOLEIRFT Speed 1,
!- Energy Input Ratio Modifier Curve, Speed 1 (temperature)
HPACCOOLEIRFF Speed 1,
!- Energy Input Ratio Modifier Curve, Speed 1 (flow fraction)
HPACCOOLPLFFPLR Speed 1, !- Part Load Fraction Correlation, Speed 1 (part load ratio)
1000.0,
!- Nominal Time for Condensate Removal to Begin, Speed 1 {s}
1.5,
!- Ratio of Initial Moisture Evaporation Rate and Steady-state Latent
3.0,
!- Maximum ON/OFF Cycling Rate, Speed 1 {cycles/hr}
45.0,
!- Latent Capacity Time Constant, Speed 1 {s}
0.2,
!- Rated waste heat fraction of power input, Speed 1 {dimensionless}
HAPCCoolWHFT Speed 1,
!- Waste heat modifier curve, Speed 1 (temperature)
0.9,
!- Evaporative Condenser Effectiveness, Speed 1 {dimensionless}
0.05,
!- Evaporative Condenser Air Volume Flow Rate, Speed 1 {m3/s}
50,
!- Evaporative Condenser Pump Rated Power Consumption, Speed 1 {W}
17500,
!- Gross Rated Total Cooling Capacity, Speed 2 {W}
0.75,
!- Gross Rated Sensible Heat Ratio, Speed 2 {dimensionless}
3.0,
!- Gross Rated Cooling COP, Speed 2 {dimensionless}
0.85,
!- Rated Air Flow Rate, Speed 2 {m3/s}
,
!- Rated Evaporator Fan Power Per Volume Flow Rate, Speed 2 {W/(m3/s)}
HPACCoolCapFT Speed 2,
!- Total Cooling Capacity Modifier Curve, Speed 2 (temperature)
HPACCoolCapFF Speed 2,
!- Total Cooling Capacity Modifier Curve, Speed 2 (flow fraction)
HPACCOOLEIRFT Speed 2,
!- Energy Input Ratio Modifier Curve, Speed 2 (temperature)
HPACCOOLEIRFF Speed 2,
!- Energy Input Ratio Modifier Curve, Speed 2 (flow fraction)
HPACCOOLPLFFPLR Speed 1, !- Part Load Fraction Correlation, Speed 2 (part load ratio)
1000.0,
!- Nominal Time for Condensate Removal to Begin, Speed 2
1.5,
!- Ratio of Initial Moisture Evaporation Rate and Steady-state Latent
3.0,
!- Maximum ON/OFF Cycling Rate, Speed 2
45.0,
!- Latent Capacity Time Constant, Speed 2
0.2,
!- Rated waste heat fraction of power input, Speed 2 {dimensionless}

9/29/14

1387

Input-Output Reference

Group Heating and Cooling Coils

HAPCCoolWHFT Speed 2,
!- Waste heat modifier curve, Speed 2 (temperature)
0.9,
!- Evaporative Condenser Effectiveness, Speed 2 {dimensionless}
0.1,
!- Evaporative Condenser Air Volume Flow Rate, Speed 2 {m3/s}
60,
!- Evaporative Condenser Pump Rated Power Consumption, Speed 2 {W}
25500,
!- Gross Rated Total Cooling Capacity, Speed 3 {W}
0.75,
!- Gross Rated Sensible Heat Ratio, Speed 3 {dimensionless}
3.0,
!- Gross Rated Cooling COP, Speed 3 {dimensionless}
1.25,
!- Rated Air Flow Rate, Speed 3 {m3/s}
,
!- Rated Evaporator Fan Power Per Volume Flow Rate, Speed 3 {W/(m3/s)}
HPACCoolCapFT Speed 3,
!- Total Cooling Capacity Modifier Curve, Speed 3 (temperature)
HPACCoolCapFF Speed 3,
!- Total Cooling Capacity Modifier Curve, Speed 3 (flow fraction)
HPACCOOLEIRFT Speed 3,
!- Energy Input Ratio Modifier Curve, Speed 3 (temperature)
HPACCOOLEIRFF Speed 3,
!- Energy Input Ratio Modifier Curve, Speed 3 (flow fraction)
HPACCOOLPLFFPLR Speed 1, !- Part Load Fraction Correlation, Speed 3 (part load ratio)
1000.0,
!- Nominal Time for Condensate Removal to Begin, Speed 3 {s}
1.5,
!- Ratio of Initial Moisture Evaporation Rate and Steady-state Latent
3.0,
!- Maximum ON/OFF Cycling Rate, Speed 3 {cycles/hr}
45.0,
!- Latent Capacity Time Constant, Speed 3 {s}
0.2,
!- Rated waste heat fraction of power input, Speed 3 {dimensionless}
HAPCCoolWHFT Speed 3,
!- Waste heat modifier curve, Speed 3 (temperature)
0.9,
!- Evaporative Condenser Effectiveness, Speed 3 {dimensionless}
0.2,
!- Evaporative Condenser Air Volume Flow Rate, Speed 3 {m3/s}
80,
!- Evaporative Condenser Pump Rated Power Consumption, Speed 3 {W}
35500,
!- Gross Rated Total Cooling Capacity, Speed 4 {W}
0.75,
!- Gross Rated Sensible Heat Ratio, Speed 4 {dimensionless}
3.0,
!- Gross Rated Cooling COP, Speed 4 {dimensionless}
1.75,
!- Rated Air Flow Rate, Speed 4 {m3/s}
,
!- Rated Evaporator Fan Power Per Volume Flow Rate, Speed 4 {W/(m3/s)}
HPACCoolCapFT Speed 4,
!- Total Cooling Capacity Modifier Curve, Speed 4 (temperature)
HPACCoolCapFF Speed 4,
!- Total Cooling Capacity Modifier Curve, Speed 4 (flow fraction)
HPACCOOLEIRFT Speed 4,
!- Energy Input Ratio Modifier Curve, Speed 4 (temperature)
HPACCOOLEIRFF Speed 4,
!- Energy Input Ratio Modifier Curve, Speed 4 (flow fraction)
HPACCOOLPLFFPLR Speed 1, !- Part Load Fraction Correlation, Speed 4 (part load ratio)
1000.0,
!- Nominal Time for Condensate Removal to Begin, Speed 4 {s}
1.5,
!- Ratio of Initial Moisture Evaporation Rate and Steady-state Latent
!- Capacity, Speed 4 {dimensionless}
3.0,
!- Maximum ON/OFF Cycling Rate, Speed 4 {cycles/hr}
45.0,
!- Latent Capacity Time Constant, Speed 4 {s}
0.2,
!- Rated waste heat fraction of power input, Speed 4 {dimensionless}
HAPCCoolWHFT Speed 4,
!- Waste heat modifier curve, Speed 4 (temperature)
0.9,
!- Evaporative Condenser Effectiveness, Speed 4 {dimensionless}
0.3,
!- Evaporative Condenser Air Volume Flow Rate, Speed 4 {m3/s}
100;
!- Evaporative Condenser Pump Rated Power Consumption, Speed 4 {W}

DX Cooling Coil Outputs

HVAC,Average,Cooling Coil Total Cooling Rate [W]
HVAC,Sum,Cooling Coil Total Cooling Energy [J]
HVAC,Average,Cooling Coil Sensible Cooling Rate [W]
HVAC,Sum,Cooling Coil Sensible Cooling Energy [J]
HVAC,Average,Cooling Coil Latent Cooling Rate [W]
HVAC,Sum,Cooling Coil Latent Cooling Energy [J]
HVAC,Average,Cooling Coil Electric Power[W]
HVAC,Sum,Cooling Coil Electric Energy [J]
HVAC,Average,Cooling Coil Runtime Fraction []
If not part of AirLoopHVAC:UnitaryHeatPump:AirToAir (if part of a heat pump,
crankcase heater is reported only for the heating coil):
HVAC,Average,Cooling Coil Crankcase Heater Electric Power[W]
HVAC,Sum,Cooling Coil Crankcase Heater Electric Energy [J]
Evaporative-cooled condenser:
HVAC,Average,Cooling Coil Condenser Inlet Temperature [C]
HVAC,Sum,Cooling Coil Evaporative Condenser Water Volume[m3]
HVAC,Average,Cooling Coil Evaporative Condenser Pump Electric Power[W]
HVAC,Sum,Cooling Coil Evaporative Condenser Pump Electric Energy [J]
HVAC,Average,Cooling Coil Basin Heater Electric Power[W]
HVAC,Sum,Cooling Coil Basin Heater Electric Energy [J]
9/29/14

1388

Input-Output Reference

Group Heating and Cooling Coils

HVAC,Sum,Cooling Coil Evaporative Condenser Mains Supply Water Volume [m3]

Additional variables for Coil:Cooling:DX:TwoStageWithHumidityControlMode
only:
HVAC,Average,Cooling Coil Stage 2 Runtime Fraction []
HVAC,Average,Cooling Coil Dehumidification Mode []
Additional variables when condensate is collected using a storage tank:
HVAC,Average,Cooling Coil Condensate Volume Flow Rate [m3/s]
Zone,Meter,Condensate:OnSiteWater [m3]
HVAC,Sum,Cooling Coil Condensate Volume [m3]
Additional variables for Coil:Cooling:DX:Multispeed:
If Fuel Type is not Electricity:
HVAC,Average,DX Cooling Coil <Fuel Type> Power[W]
HVAC,Sum,DX Cooling Coil <Fuel Type> Consumption[J]

Cooling Coil Total Cooling Rate [W]

This field is the total (sensible and latent) cooling rate output of the DX coil in Watts. This is
determined by the coil inlet and outlet air conditions and the air mass flow rate through the
coil.
Cooling Coil Total Cooling Energy [J]
This is the total (sensible plus latent) cooling output of the DX coil in Joules over the timestep
being reported. This is determined by the coil inlet and outlet air conditions and the air mass
flow rate through the coil. This output is also added to a meter with Resource Type =
EnergyTransfer, End Use Key = CoolingCoils, Group Key = System (Ref. Output:Meter
objects).
Cooling Coil Sensible Cooling Rate [W]
This output is the moist air sensible cooling rate output of the DX coil in Watts. This is
determined by the inlet and outlet air conditions and the air mass flow rate through the coil.
Cooling Coil Sensible Cooling Energy [J]
This is the moist air sensible cooling output of the DX coil in Joules for the timestep being
reported. This is determined by the inlet and outlet air conditions and the air mass flow rate
through the coil.
Cooling Coil Latent Cooling Rate [W]
This is the latent cooling rate output of the DX coil in Watts. This is determined by the inlet
and outlet air conditions and the air mass flow rate through the coil.
Cooling Coil Latent Cooling Energy [J]
This is the latent cooling output of the DX coil in Joules for the timestep being reported. This
is determined by the inlet and outlet air conditions and the air mass flow rate through the coil.
Cooling Coil Electric Power [W]
This output is the electricity consumption rate of the DX coil compressor and condenser
fan(s) in Watts. This value is calculated for each HVAC system timestep, and the results are
averaged for the timestep being reported.
Cooling Coil Electric Energy [J]
This is the electricity consumption of the DX coil compressor and condenser fan(s) in Joules
for the timestep being reported. This output is also added to a meter with Resource Type =
Electricity, End Use Key = Cooling, Group Key = System (Ref. Output:Meter objects).
9/29/14

1389

Input-Output Reference

Group Heating and Cooling Coils

Cooling Coil Runtime Fraction []

This is the runtime fraction of the DX coil compressor and condenser fan(s) for the timestep
being reported.
Cooling Coil Crankcase Heater Electric Power[W]
This is the average electricity consumption rate of the DX coil compressors crankcase heater
in Watts for the timestep being reported. If the DX Cooling Coil is used in a heat pump, the
crankcase heater is reported only for the heating coil.
Cooling Coil Crankcase Heater Electric Energy [J]
This is the electricity consumption of the DX coil compressors crankcase heater in Joules for
the timestep being reported. This output is also added to a meter with Resource Type =
Electricity, End Use Key = Cooling, Group Key = System (ref. Output:Meter objects). This
output variable appears only when the DX Cooling Coil is not used as part of a heat pump,
otherwise the crankcase heater is reported only for the heating coil.
Cooling Coil Condenser Inlet Temperature [C]
This is the inlet air temperature to the condenser coil in degrees C. This value can represent
the outdoor air dry-bulb temperature, wet-bulb temperature, or somewhere in between from
the weather data being used, depending on the value used in the input field Evaporative
Condenser Effectiveness. The temperature reported here is used in the various modifier
curves related to temperature (e.g., Total Cooling Capacity Modifier Curve [function of
temperature]). This output variable appears only when the DX Cooling Coil is not used as
part of a heat pump, otherwise the crankcase heater is reported only for the heating coil.
Cooling Coil Evaporative Condenser Water Volume [m3]
This output is the amount of water used to evaporatively cool the condenser coil inlet air, in
cubic meters. This output is also added to a meter with Resource Type = Water, End Use
Key = Cooling, Group Key = System (ref. Output:Meter objects). This output variable appears
only when the DX Cooling Coil is evaporatively cooled.
Cooling Coil Evaporative Condenser Mains Supply Water Volume [m3]
This is the volume of water drawn from mains water service for the evaporatively cooled
condenser.
Cooling Coil Evaporative Condenser Pump Electric Power [W]
This is the average electricity consumption rate of the evaporative condenser water pump in
Watts for the timestep being reported. This output variable appears only when the DX
Cooling Coil is evaporatively cooled.
Cooling Coil Evaporative Condenser Pump Electric Energy [J]
This is the electricity consumption rate of the evaporative condenser water pump in Joules for
the timestep being reported. This output is also added to a meter with Resource Type =
Electricity, End Use Key = Cooling, Group Key = System (ref. Output:Meter objects). This
output variable appears only when the DX Cooling Coil is evaporatively cooled.
Cooling Coil Stage 2 Runtime Fraction []
This is the runtime fraction of the stage 2 DX coil compressor and condenser fan(s) for the
timestep
being
reported.
Applicable
only
for
COIL
Coil:Cooling:DX:TwoStageWithHumidityControlMode when 2 capacity stages are specified.
For 2-stage systems, Cooling Coil Runtime Fraction is the stage 1 runtime fraction. These
runtime fractions overlap, because stage 2 will not run unless stage 1 is already running. For
example, a system where stage 1 is 60% of total capacity is passed a load of 70%. The
Cooling Coil Runtime Fraction (stage 1) will be 1.0, and the Cooling Coil Stage 2 Runtime
Fraction will be 0.25 [(70%-60%)/(100%-60%)].
9/29/14

1390

Input-Output Reference

Group Heating and Cooling Coils

Cooling Coil Dehumidification Mode []

This is the dehumidification mode for the timestep being reported. Applicable only for
Coil:Cooling:DX:TwoStageWithHumidityControlMode when enhanced dehumidification mode
is available. A value of 0 indicates normal mode (extra dehumidification not active). A value of
1 indicates dehumidification mode 1 is active. Note that this is an averaged variable, so
fractional values are likely to be reported for reporting frequencies longer than "detailed".
Cooling Coil Condensate Volume Flow Rate [m3/s]
Cooling Coil Condensate Volume [m3]
These outputs are the rate and volume of water collected as condensate from the coil. These
reports only appear if a water storage tank is named in the input object.
Cooling Coil Evaporative Condenser Mains Supply Water Volume [m3]
This is the water consumed by the DX Cooling Coil evaporatively cooled condenser that is
met by the mains water. This output variable appears only when the DX Cooling Coil is
evaporatively cooled.
Cooling Coil Basin Heater Electric Power [W]
This is the average electricity consumption rate of the basin heater in Watts for the timestep
being reported. This output variable appears only when the DX Cooling Coil is evaporatively
cooled and the Basin Heater Capacity is greater than 0.
Cooling Coil Basin Heater Electric Energy [J]
This is the electricity consumption rate of the basin heater in Joules for the timestep being
reported. This output is also added to a meter with Resource Type = Electricity, End Use Key
= Cooling, Group Key = System (ref. Output:Meter objects). This output variable appears only
when the DX Cooling Coil is evaporatively cooled and the Basin Heater Capacity is greater
than 0.
Cooling Coil <Fuel Type> Power [W]
This output variable appears only when using the Coil:Cooling:DX:Multispeed object and a
fuel type other than electricity is used. This variable describes the input fuel type power for
the cooling coil in Watts, averaged during the timestep being reported.
Cooling Coil <Fuel Type> Energy [J]
This output variable appears only when using the Coil:Cooling:DX:Multispeed object and a
fuel type other than electricity is used. This variable describes the input fuel type consumption
for the multispeed cooling coil in the unit of Joules, summed for the timestep being reported.
The electric consumption is excluded..This output is added to a meter with Resource Type =
<Fuel Type>, End Use Key = Cooling, Group Key = System (ref. Output:Meter objects).
Note: <Fuel Type> in the above two output variables depends on the user specified input for the Fuel Type
field. In addition to Electricity, valid fuel types are NaturalGas, Propane, FuelOil#1, FuelOil#2, Coal, Diesel,
Gasoline, OtherFuel1 and OtherFuel2.

Coil:Cooling:DX:VariableSpeed
The Variable-Speed DX Cooling Coil is a collection of performance curves that represent the
cooling coil at various speed levels. The performance curves should be generated from a
Reference Unit data. This is an equation-fit model that resembles a black box with no usage
of heat transfer equations. On the other hand, the model uses the bypass factor approach to
calculate sensible heat transfer rate, similar to the one used in the single-speed DX coil. The
number of speed levels can range from 1 to 10. The cooling coil has two indoor air side
9/29/14

1391

Input-Output Reference

Group Heating and Cooling Coils

connections, and one optional condenser air node connection. The user needs to specify a
nominal speed level, at which the gross rated total cooling capacity, and rated volumetric air
rate are sized. The rated capacity and rated volumetric flow rate represent the real situation
in the air loop, and are used to determine and flow rates at various speed levels in the parent
objects,
e.g.
of
AirLoopHVAC:UnitaryHeatCool,
ZoneHVAC:PackagedTerminalAirConditioner, AirLoopHVAC:UnitaryHeatPump:AirToAir and
ZoneHVAC:PackagedTerminalHeatPump. It shall be mentioned that the performance
correction curves, i.e. the temperature and flow fraction correction curves, should be
normalized to the capacity and flow rate at each individual speed and at the rated conditions,
similar to the performance curves used in the single-speed DX coil. However, the
performance values, e.g. capacities, COPs, SHRs and flow rates at individual speed levels,
should be given regarding a specific unit from the Reference Unit catalog data. In the
following content, the statement started with Reference Unit means the actual Reference
Unit catalog data. The rated conditions for obtaining the capacities, COPs and SHRs are at
indoor dry-bulb temperature of 26.67 C (80 F), wet bulb temperature of 19.44 C (67 F),
and the condenser entering air temperature of 35 C (95 F). Some equations are provided
below to help explain the function of the various performance curves and data fields.
Field: Name
This alpha field contains the identifying name for the variable-speed cooling coil.
Field: Air Inlet Node Name
This alpha field contains the cooling coil load side inlet node name.
Field: Air Outlet Node Name
This alpha field contains the cooling coil load side outlet node name.
Field: Number of Speeds
This numeric field contains the maximum number of speed levels that the module uses. The
number of speeds, for which the user input the performance data and curves, should be
equal or higher than the maximum number. The performance inputs at higher speed levels
are ignored.
Field: Nominal Speed Level
This numeric field defines the nominal speed level, at which the rated capacity and rated air
rate are correlated.
Field: Gross Rated Total Cooling Capacity at Selected Nominal Speed Level
This numeric field contains the gross rated total cooling capacity at the nominal speed level.
This field is autosizable. The gross rated total cooling capacity is used to determine a
capacity scaling factor, as compared to the Reference Unit capacity at the nominal speed
level.

CapacityScaleFactor

Gross Rated Total Cooling Capacity

Reference Unit Capacity@ Nominal Speed Level

And then, this scaling factor is used to determine capacities at rated conditions for other
speed levels, as below,

Gross Rated Capacity @Speed Level x

CapacityScaleFactor
Reference Unit Capacity @Speed Level(x)
9/29/14

1392

Input-Output Reference

Group Heating and Cooling Coils

Field: Rated Air Flow Rate at Selected Nominal Speed Level

This numeric field contains the rated volumetric air flow rate on the load side of the DX unit,
corresponding to the nominal speed level. This field is autosizable. The value is used to
determine an internal scaling factor, and calculate the air flow rates in the parent objects. It is
recommended that the ratio of the rated volumetric air flow rate to the rated capacity is the
same as the unit performance from the Reference Unit data.

AirFlowScaleFactor

Rated Volumetric Air Flow Rate

Reference Unit Vol Air Flow Rate@ Nominal Speed Level CapacityScaleFactor

And the volumetric air flow rates in the parent objects are calculated as below,

Loop Volumetric Air Flow Rate@Speed Level x

AirFlowScaleFactor
Reference Unit Vol Air Flow Rate@Speed Level(x)
CapacityScaleFactor
Field: Nominal Time for Condensate Removal to Begin
This numeric field defines the nominal time (in seconds) after startup for condensate to begin
leaving the coil's condensate drain line at the coil's rated airflow and temperature conditions,
starting with a dry coil. Nominal time is equal to the ratio of the energy of the coil's maximum
condensate holding capacity (J) to the coil's steady-state latent capacity (W). Suggested
value is 1000; zero value means the latent degradation model is disabled. The default value
for this field is zero.
Field: Ratio of Initial Moisture Evaporation Rate and Steady State Latent Capacity
This numeric field defines ratio of the initial moisture evaporation rate from the cooling coil
(when the compressor first turns off, in Watts) and the coil's steady-state latent capacity
(Watts) at rated airflow and temperature conditions. Suggested value is 1.5; zero value
means the latent degradation model is disabled. The default value for this field is zero.
Field: Part Load Fraction Correlation Curve Name
This alpha field defines the name of a quadratic or cubic performance curve (Ref:
Performance Curves) that parameterizes the variation of electrical power input to the unit as
a function of the part load ratio (PLR, sensible or latent load/steady-state sensible or latent
cooling capacity for Speed 1), in the case that the unit operates under the lowest speed, i.e.
on/off. The product of the rated EIR and EIR modifier curves is divided by the output of this
curve to give the effective EIR for a given simulation timestep for Speed 1. The part load
fraction (PLF) correlation accounts for efficiency losses due to compressor cycling. The part
load fraction correlation should be normalized to a value of 1.0 when the part load ratio
equals 1.0 (i.e., no efficiency losses when the compressor(s) run continuously for the
simulation timestep).
Field: Condenser Air Inlet Node Name
This optional alpha field specifies the outdoor air node name used to define the conditions of
the air entering the outdoor condenser. If this field is left blank, the outdoor air temperature
entering the condenser (dry-bulb or wet-bulb) is taken directly from the weather data. If this
field is not blank, the node name specified must also be specified in an OutdoorAir:Node
object where the height of the node is taken into consideration when calculating outdoor air
temperature from the weather data. Alternately, the node name may be specified in an

9/29/14

1393

Input-Output Reference

Group Heating and Cooling Coils

OutdoorAir:NodeList object where the outdoor air temperature is taken directly from the
weather data.
Field: Condenser Type
The type of condenser used by the DX cooling coil. Valid choices for this input field are
AirCooled or EvaporativelyCooled. The default for this field is AirCooled.
Field: Evaporative Condenser Pump Rated Power Consumption
The rated power of the evaporative condenser water pump in Watts. This value is used to
calculate the power required to pump the water used to evaporatively cool the condenser
inlet air. The default value for this input field is zero, but it is autosizable (equivalent to
0.004266 W per watt [15 W/ton] of rated total cooling capacity). This field is not used when
Condenser Type = Air Cooled.
Field: Crankcase Heater Capacity
This numeric field defines the crankcase heater capacity in Watts. When the outdoor air
drybulb temperature is below the value specified in the input field Maximum Outdoor Drybulb Temperature for Crankcase Heater Operation (described below), the crankcase heater
is enabled during the time that the compressor is not running. If this cooling coil is used as
part of an air-to-air heat pump, the crankcase heater defined for this DX cooling coil is
ignored and the crankcase heater power defined for the DX heating coil (Ref.
Coil:Heating:DX:SingleSpeed) is enabled during the time that the compressor is not running
for either heating or cooling. The value for this input field must be greater than or equal to 0,
and the default value is 0. To simulate a DX cooling coil without a crankcase heater, enter a
value of 0.
Field: Maximum Outdoor Dry-Bulb Temperature for Crankcase Heater Operation
This numeric field defines the outdoor air dry-bulb temperature above which the compressors
crankcase heater is disabled. The value for this input field must be greater than or equal to
0.0C, and the default value is 10C.
Field: Supply Water Storage Tank Name
This field is optional. It is used to describe where the coil obtains water used for evaporative
cooling of its condenser. If blank or omitted, then the unit will obtain water directly from the
mains. If the name of a Water Storage Tank object is used here, the unit will obtain its water
from that tank. If a tank is specified, the unit will attempt to obtain all the water it uses from
the tank. However if the tank cannot provide all the water the condenser needs, then the unit
will still operate and obtain the rest of the water it needs from the mains (referred to as
StarvedWater).
Field: Condensate Collection Water Storage Tank Name
This field is optional. It is used to describe where condensate from the coil is collected. If
blank or omitted, then any coil condensate is discarded. Enter the name of Water Storage
Tank object defined elsewhere and the condensate will then be collected in that tank.
Field: Basin Heater Capacity
This numeric field contains the capacity of the DX coils electric evaporative cooler basin
heater in watts per degree Kelvin. This field only applies for Condenser Type =
EvaporativelyCooled. This field is used in conjunction with the Basin Heater Setpoint
temperature described in the following field. The basin heater electric power is equal to this
field multiplied by the difference between the basin heater set point temperature and the
outdoor dry-bulb temperature. The basin heater only operates when the DX coil is off,
regardless of the basin heater schedule described below. The basin heater capacity must be
greater than or equal to zero, with a default value of zero if this field is left blank.

9/29/14

1394

Input-Output Reference

Group Heating and Cooling Coils

Field: Basin Heater Setpoint Temperature

This numeric field contains the set point temperature (C) for the basin heater described in
the previous field. This field only applies for Condenser Type = EvaporativelyCooled. The
basin heater is active when the outdoor air dry-bulb temperature falls below this setpoint
temperature, as long as the DX coil is off. This set point temperature must be greater than or
equal to 2C, and the default value is 2C if this field is left blank.
Field: Basin Heater Operating Schedule Name
This alpha field contains the name of the basin heater operating schedule. This field only
applies for Condenser Type = EvaporativelyCooled. The basin heater operating schedule is
assumed to be an on/off schedule and the heater is available to operate any time the
schedule value is greater than 0. The basin heater operates when scheduled on and the
outdoor air dry-bulb temperature is below the set point temperature described in the previous
field. If this field is left blank, the basin heater is available to operate throughout the
simulation. Regardless of this schedule, the basin heater may only operate when the DX coil
is off.
Field Group: Rated specification, performance curves
The performance for each cooling speed must be specified as shown below. They should be
directly given from the Reference Unit catalog data. All inputs for Speed 1 are required,
followed by the optional inputs for other speeds.
Field: Speed <x> Reference Unit Gross Rated Total Cooling Capacity
This numeric field defines the total, full load gross cooling capacity in watts of the air-to-air
cooling coil unit at rated conditions for Speed <x> operation. The value entered here must be
greater than 0. Capacity should not account for supply air fan heat.
Field: Speed <x> Reference Unit Gross Rated Sensible Heat Ratio
This numeric field defines sensible heat transfer ratio (SHR = gross sensible cooling capacity
divided by gross total cooling capacity) of the cooling coil unit at rated conditions for Speed
<x> operation. The value entered here must be greater than 0.0 and less than 1.0. This value
should be obtained from the Reference Unit data.
Field: Speed <x> Reference Unit Gross Rated Cooling COP
This numeric field defines the coefficient of performance (COP= the gross total cooling
capacity in watts divided by electrical power input in watts) of the cooling coil unit at rated
conditions for Speed <x> operation. The value entered here must be greater than 0. The
input power includes power for the compressor(s), condenser fan and accessories, but does
not include the supply air fan. The gross COP should Not account for the supply air fan.
Field: Speed <x> Reference Unit Rated Air Flow Rate
This numeric field defines the volumetric air flow rate, in m 3 per second, across the cooling
coil at rated conditions for Speed <x> operation. The value entered here should be directly
from the Reference Unit data, corresponding to the given cooling capacity and COP at the
speed, as above.
Field: Speed <x> Reference Unit Rated Condenser Air Flow Rate
This numeric field defines the condenser volumetric air flow rate, in m 3 per second, across
the condenser coil at rated conditions for Speed <x> operation. The value entered here
should be directly from the Reference Unit data. This field is used to calculate water
evaporation rate for an evaporatively-cooled condenser. For an air-cooled condenser, this
input is not used.

9/29/14

1395

Input-Output Reference

Group Heating and Cooling Coils

Field: Speed <x> Reference Unit Rated Pad Effectiveness of Evap Precooling
This numeric field defines the effectiveness of condenser evaporative precooling pad at rated
condition. The values of effectiveness are given at individual speed levels, since varied
condenser air flow rates impact the effectiveness.
Field: Speed <x> Total Cooling Capacity Function of Temperature Curve Name
This alpha field defines the name of a bi-quadratic performance curve for Speed <x> (ref:
Performance Curves) that parameterizes the variation of the gross total cooling capacity as a
function of the both the indoor wet-bulb and source side entering air temperature, from the
Reference Unit. The output of this curve is multiplied by the gross rated total cooling capacity
at the speed to give the gross total cooling capacity at specific temperature operating
conditions (i.e., at an indoor air wet-bulb temperature or outdoor entering air temperature
different from the rating point temperature). It should be noted that the curve is normalized to
the cooling capacity at Speed<x> from the Reference Unit data, and have the value of 1.0 at
the rating point.
Field: Speed <x> Total Cooling Capacity Function of Air Flow Fraction Curve Name
This alpha field defines the name of a quadratic or cubic performance curve for Speed <x>
(ref: Performance Curves) that parameterizes the variation of the gross total cooling capacity
as a function of the ratio of actual air flow rate across the cooling coil to the design air flow
rate (i.e., fraction of full load flow at Speed <x>, from the Reference Unit data). The curve is
normalized to have the value of 1.0 when the actual air flow rate equals the design air flow
rate, at Speed <x>.
Field: Speed <x> Energy Input Ratio Function of Temperature Curve Name
This alpha field defines the name of a bi-quadratic performance curve for Speed <x> (ref:
Performance Curves) that parameterizes the variation of the energy input ratio (EIR) as a
function of the both the indoor air wet-bulb and condenser entering air temperatures The EIR
is the inverse of the COP. The output of this curve is multiplied by the rated EIR (inverse of
rated COP at Speed <x> from the Reference Unit data) to give the EIR at specific
temperature operating conditions (i.e., at an indoor air wet-bulb temperature or condenser
entering air temperature different from the rating point temperature). The curve is normalized
to have the value of 1.0 at the rating point.
Field: Speed <x> Energy Input Ratio Function of Air Flow Fraction Curve Name
This alpha field defines the name of a quadratic or cubic performance curve for Speed <x>
(ref: Performance Curves) that parameterizes the variation of the energy input ratio (EIR) as
a function of the ratio of actual air flow rate across the cooling coil to the design air flow rate
(i.e., fraction of full load flow, at Speed <x> from the Reference Unit data). The EIR is the
inverse of the COP. This curve is normalized to a value of 1.0 when the actual air flow rate
equals the design air flow rate.
An example of this statement in an IDF is:

9/29/14

1396

Input-Output Reference

Group Heating and Cooling Coils

Coil:Cooling:DX:VariableSpeed,
Heat Pump ACDXCoil 1,
!- Name
DX Cooling Coil Air Inlet Node, !- Air Inlet Node Name
Heating Coil Air Inlet Node,
!- Air Outlet Node Name
10.0,
!- Number of Speeds {dimensionless}
10.0,
!- Nominal Speed Level {dimensionless}
32000,
!- Gross Rated Total Cooling Capacity {W}
1.7,
!- Rated Air Flow Rate {m3/s}
0.0,
!- Nominal Time for Condensate to Begin Leaving the Coil {s}
0.0, !- Initial Moisture Evaporation Rate Divided by Steady-State AC Latent Capacity {dimensionless}
HPACCOOLPLFFPLR,
!- Part Load Fraction Correlation Curve Name
,
! - Condenser Air Inlet Node Name
AirCooled,
! - Condenser Type
,
! - Evaporative Condenser Pump Rated Power Consumption
200.0,
! - Crankcase Heater Capacity, {w}
10.0,
!- Maximum Outdoor Dry-Bulb Temperature for Crankcase Heater Operation {C}
,
! - Supply Water Storage Tank Name
,
! - Condensate Collection Water Storage Tank Name
,
! - Basin Heater Capacity
,
! - Basin Heater Setpoint Temperature
,
! - Basin Heater Operating Schedule Name
1524.1,
!- Speed 1 Gross Rated Total Cooling Capacity {w}
0.75,
!- Speed 1 Gross Rated Sensible Heat Ratio {dimensionless}
4.0,
!- Speed 1 Gross Rated Cooling COP {dimensionless}
0.1359072,
!- Speed 1 Rated Air Flow Rate {m3/s}
0.26,
! - Speed 1 Rated Condenser Air Flow Rate {m3/s}, for evaporatively cooled
,
! - Evaporative precooling effectiveness
HPACCoolCapFT,
!- Total Cooling Capacity Function of Temperature Curve Name
HPACCoolCapFFF,
!- Total Cooling Capacity Function of Flow Fraction Curve Name
HPACCOOLEIRFT,
!- Energy Input Ratio Function of Temperature Curve Name
HPACCOOLEIRFFF,
!- Energy Input Ratio Function of Flow Fraction Curve Name
1877.9,
!- Speed 2 Gross Rated Total Cooling Capacity {w}
0.75,
!- Speed 2 Gross Rated Sensible Heat Ratio {dimensionless}
4.0,
!- Speed 2 Gross Rated Cooling COP {dimensionless}
0.151008,
!- Speed 2 Rated Air Flow Rate {m3/s}
0.30,
! - Speed 2 Rated Condenser Air Flow Rate {m3/s}, for evaporatively cooled
,
! - Evaporative precooling effectiveness
HPACCoolCapFT,
!- Total Cooling Capacity Function of Temperature Curve Name
HPACCoolCapFFF,
!- Total Cooling Capacity Function of Flow Fraction Curve Name
HPACCOOLEIRFT,
!- Energy Input Ratio Function of Temperature Curve Name
HPACCOOLEIRFFF,
!- Energy Input Ratio Function of Flow Fraction Curve Name
2226.6,
!- Speed 3 Gross Rated Total Cooling Capacity {w}
0.75,
!- Speed 3 Gross Rated Sensible Heat Ratio {dimensionless}
4.0,
!- Speed 3 Gross Rated Cooling COP {dimensionless}
0.1661088,
!- Speed 3 Rated Air Flow Rate {m3/s}
0.33,
!- Speed 3 Rated Condenser Air Flow Rate {m3/s}, for evaporatively cooled
,
!- Evaporative precooling effectiveness
HPACCoolCapFT,
!- Total Cooling Capacity Function of Temperature Curve Name
HPACCoolCapFFF,
!- Total Cooling Capacity Function of Flow Fraction Curve Name
HPACCOOLEIRFT,
!- Energy Input Ratio Function of Temperature Curve Name
HPACCOOLEIRFFF,
!- Energy Input Ratio Function of Flow Fraction Curve Name
2911.3,
!- Speed 4 Gross Rated Total Cooling Capacity {w}
0.75,
!- Speed 4 Gross Rated Sensible Heat Ratio {dimensionless}
4.0,
!- Speed 4 Gross Rated Cooling COP {dimensionless}
0.1963104,
!- Speed 4 Rated Air Flow Rate {m3/s}
0.38,
!- Speed 4 Rated Condenser Air Flow Rate {m3/s}, for evaporatively cooled
,
!- Evaporative precooling effectiveness
HPACCoolCapFT,
!- Total Cooling Capacity Function of Temperature Curve Name
HPACCoolCapFFF,
!- Total Cooling Capacity Function of Flow Fraction Curve Name
HPACCOOLEIRFT,
!- Energy Input Ratio Function of Temperature Curve Name
HPACCOOLEIRFFF,
!- Energy Input Ratio Function of Flow Fraction Curve Name
3581.7,
!- Speed 5 Gross Rated Total Cooling Capacity {w}
0.75,
!- Speed 5 Gross Rated Sensible Heat Ratio {dimensionless}
4.0,
!- Speed 5 Gross Rated Cooling COP {dimensionless}
0.226512,
!- Speed 5 Rated Air Flow Rate {m3/s}
0.44,
!- Speed 5 Rated Condenser Air Flow Rate {m3/s}, for evaporatively cooled
,
!- Evaporative precooling effectiveness
HPACCoolCapFT,
!- Total Cooling Capacity Function of Temperature Curve Name
HPACCoolCapFFF,
!- Total Cooling Capacity Function of Flow Fraction Curve Name
HPACCOOLEIRFT,
!- Energy Input Ratio Function of Temperature Curve Name
HPACCOOLEIRFFF,
!- Energy Input Ratio Function of Flow Fraction Curve Name

9/29/14

1397

Input-Output Reference
4239.5,
0.75,
4.0,
0.2567136,
0.50,
,
HPACCoolCapFT,
HPACCoolCapFFF,
HPACCOOLEIRFT,
HPACCOOLEIRFFF,
4885.7,
0.75,
4.0,
0.2869152,
0.57,
,
HPACCoolCapFT,
HPACCoolCapFFF,
HPACCOOLEIRFT,
HPACCOOLEIRFFF,
5520.7,
0.75,
4.0,
0.3171168,
0.63,
,
HPACCoolCapFT,
HPACCoolCapFFF,
HPACCOOLEIRFT,
HPACCOOLEIRFFF,
6144.8,
0.75,
4.0,
0.3473184,
0.69,
,
HPACCoolCapFT,
HPACCoolCapFFF,
HPACCOOLEIRFT,
HPACCOOLEIRFFF,
6758.0,
0.75,
4.0,
0.37752,
0.74,
,
HPACCoolCapFT,
HPACCoolCapFFF,
HPACCOOLEIRFT,
HPACCOOLEIRFFF;

Group Heating and Cooling Coils

!- Speed 6 Gross Rated Total Cooling Capacity {w}
!- Speed 6 Gross Rated Sensible Heat Ratio {dimensionless}
!- Speed 6 Gross Rated Cooling COP {dimensionless}
!- Speed 6 Rated Air Flow Rate {m3/s}
! - Speed 6 Rated Condenser Air Flow Rate {m3/s}, for evaporatively cooled
! - Evaporative precooling effectiveness
!- Total Cooling Capacity Function of Temperature Curve Name
!- Total Cooling Capacity Function of Flow Fraction Curve Name
!- Energy Input Ratio Function of Temperature Curve Name
!- Energy Input Ratio Function of Flow Fraction Curve Name
!- Speed 7 Gross Rated Total Cooling Capacity {w}
!- Speed 7 Gross Rated Sensible Heat Ratio {dimensionless}
!- Speed 7 Gross Rated Cooling COP {dimensionless}
!- Speed 7 Rated Air Flow Rate {m3/s}
! - Speed 7 Rated Condenser Air Flow Rate {m3/s}, for evaporatively cooled
! - Evaporative precooling effectiveness
!- Total Cooling Capacity Function of Temperature Curve Name
!- Total Cooling Capacity Function of Flow Fraction Curve Name
!- Energy Input Ratio Function of Temperature Curve Name
!- Energy Input Ratio Function of Flow Fraction Curve Name
!- Speed 8 Gross Rated Total Cooling Capacity {w}
!- Speed 8 Gross Rated Sensible Heat Ratio {dimensionless}
!- Speed 8 Gross Rated Cooling COP {dimensionless}
!- Speed 8 Rated Air Flow Rate {m3/s}
! - Speed 8 Rated Condenser Air Flow Rate {m3/s}, for evaporatively cooled
! - Evaporative precooling effectiveness
!- Total Cooling Capacity Function of Temperature Curve Name
!- Total Cooling Capacity Function of Flow Fraction Curve Name
!- Energy Input Ratio Function of Temperature Curve Name
!- Energy Input Ratio Function of Flow Fraction Curve Name
!- Speed 9 Gross Rated Total Cooling Capacity {w}
!- Speed 9 Gross Rated Sensible Heat Ratio {dimensionless}
!- Speed 9 Rated Cooling COP {dimensionless}
!- Speed 9 Rated Air Flow Rate {m3/s}
! - Speed 9 Rated Condenser Air Flow Rate {m3/s}, for evaporatively cooled
! - Evaporative precooling effectiveness
!- Total Cooling Capacity Function of Temperature Curve Name
!- Total Cooling Capacity Function of Flow Fraction Curve Name
!- Energy Input Ratio Function of Temperature Curve Name
!- Energy Input Ratio Function of Flow Fraction Curve Name
!- Speed 10 Gross Rated Total Cooling Capacity {w}
!- Speed 10 Gross Rated Sensible Heat Ratio {dimensionless}
!- Speed 10 Gross Rated Cooling COP {dimensionless}
!- Speed 10 Rated Air Flow Rate {m3/s}
! - Speed 10 Rated Condenser Air Flow Rate {m3/s}, for evaporatively cooled
! - Evaporative precooling effectiveness
!- Total Cooling Capacity Function of Temperature Curve Name
!- Total Cooling Capacity Function of Flow Fraction Curve Name
!- Energy Input Ratio Function of Temperature Curve Name
!- Energy Input Ratio Function of Flow Fraction Curve Name

Variable Speed DX Cooling Coil Outputs

HVAC,Average,Cooling Coil Electric Power [W]
HVAC,Average,Cooling Coil Total Cooling Rate [W]
HVAC,Average,Cooling Coil Sensible Cooling Rate [W]
HVAC,Average,Cooling Coil Source Side Heat Transfer Rate [W]
HVAC,Average,Cooling Coil Part Load Ratio []
HVAC,Average, Cooling Coil Runtime Fraction []
HVAC,Average, Cooling Coil Air Mass Flow Rate [kg/s]
HVAC,Average,Cooling Coil Air Inlet Temperature [C]
HVAC,Average,Cooling Coil Air Inlet Humidity Ratio [kgWater/kgDryAir]
HVAC,Average,Cooling Coil Air Outlet Temperature [C]
HVAC,Average,Cooling Coil Air Outlet Humidity Ratio [kgWater/kgDryAir]
HVAC,Average,Cooling Coil Upper Speed Level []
HVAC,Average,Cooling Coil Neighboring Speed Levels Ratio []
HVAC,Average,VSAirtoAirHP Recoverable Waste Heat [W]
HVAC,Sum,Cooling Coil Electric Energy [J]
HVAC,Sum,Cooling Coil Total Cooling Energy [J]
9/29/14

1398

Input-Output Reference

Group Heating and Cooling Coils

HVAC,Sum,Cooling Coil Sensible Cooling Energy [J]

HVAC,Sum,Cooling Coil Latent Cooling Energy [J]
HVAC,Sum,Cooling Coil Source Side Heat Transfer Energy [J]
HVAC,Average,Cooling Coil Crankcase Heater Electric Power [W]
HVAC,Sum,Cooling Coil Crankcase Heater Electric Energy [J]
HVAC,Average,Cooling Coil Condensate Volume Flow Rate [m3/s]
HVAC,Sum,Cooling Coil Condensate Volume [m3]
HVAC,Average,Cooling Coil Condenser Inlet Temperature [C]
HVAC,Sum,Cooling Coil Evaporative Condenser Water Volume [m3]
HVAC,Sum,Cooling Coil Evaporative Condenser Mains Water Volume [m3]
HVAC,Average,Cooling Coil Evaporative Condenser Pump Electric Power[W]
HVAC,Sum,Cooling Coil Evaporative Condenser Pump Electric Energy [J]
HVAC,Average,Cooling Coil Basin Heater Electric Power [W]
HVAC,Sum,Cooling Coil Basin Heater Electric Energy [J]

Cooling Coil Electric Power [W]

This output variable is the average electric consumption rate of the heat pump in Watts over
the timestep being reported.
Cooling Coil Total Cooling Rate [W]
The output variable is the average total cooling load provide by the heat pump which includes
the sensible and latent load in Watts over the timestep being reported.
Cooling Coil Sensible Cooling Rate [W]
The output variable is the average sensible cooling load provide by the heat pump in Watts
over the timestep being reported.
Cooling Coil Source Side Heat Transfer Rate [W]
The output variable is the average heat rejected to the water at the heat pump condenser in
Watts over the timestep being reported.
Cooling Coil Part Load Ratio []
This output variable is the ratio of the part-load capacity to the steady state capacity of the
VSAirtoAirHP coil. For the cycling fan mode, the runtime fraction for the heat pump
compressor may be different from the compressor part-load ratio reported here due to the
part-load performance of the VSAirtoAirHP coil (delay at start-up to reach steady-state
output). In general, runtime fractions are reported by individual components where
appropriate.
Cooling Coil Runtime Fraction []
This output variable is the function of the part load ratio (PLR, part-load capacity/ steady state
capacity). The runtime fraction, or duty factor, accounts for efficiency losses due to
compressor cycling.
Cooling Coil Air Mass Flow Rate [kg/s]
The output variable is the average air mass flow rate on the load side going through the heat
pump over the timestep being reported.
Cooling Coil Air Inlet Temperature [C]
The output variable is the average entering air dry-bulb temperature over the timestep being
reported.
Cooling Coil Air Inlet Humidity Ratio [kgWater/kgDryAir]
The output variable is the average entering air dry humidity ratio over the timestep being
reported.

9/29/14

1399

Input-Output Reference

Group Heating and Cooling Coils

Cooling Coil Air Outlet Temperature [C]

The output variable is the average leaving air dry-bulb temperature over the timestep being
reported.
Cooling Coil Air Outlet Humidity Ratio [kgWater/kgDryAir]
The output variable is the average leaving air dry humidity ratio over the timestep being
reported.
Cooling Coil Upper Speed Level []
The output variable is the average upper speed level, for interpolating performances between
two neighboring speed levels.
Cooling Coil Neighboring Speed Levels Ratio []
The output variable is the average speed ratio, for interpolating performances between two
neighboring speed levels.
Cooling Coil Electric Energy [J]
The output variable is the electric consumption of the heat pump in Joules over the timestep
being reported.
Cooling Coil Total Cooling Energy [J]
The output variable is the total cooling output of the coil in Joules over the timestep being
reported.
Cooling Coil Sensible Cooling Energy [J]
The output variable is the total sensible cooling output of the coil in Joules over the timestep
being reported
Cooling Coil Latent Cooling Energy [J]
Cooling Coil Latent Cooling Rate [W]
These output variables are the total latent cooling output of the coil in Joules or Watts over
the timestep being reported.
Cooling Coil Source Side Heat Transfer Energy [J]
The output variable is the total source side heat transfer of the coil in Joules over the
timestep being reported.
Cooling Coil Crankcase Heater Electric Power [W]
The output variable is the average power used for crankcase heater, in Watts over the
timestep being reported.
Cooling Coil Crankcase Heater Electric Energy [J]
The output variable is the total electric energy usage of the coil for crankcase heater, in
Joules over the timestep being reported.
Cooling Coil Condensate Volume Flow Rate [m3/s]
The output variable is the average water condensate volumetric flow rate from the cooling
coil, in m3/s over the timestep being reported, if choosing to use CondensatetoTank.
Cooling Coil Condensate Volume [m3]
The output variable is the total water condensate volume from the cooling coil, in m 3 over the
timestep being reported.

9/29/14

1400

Input-Output Reference

Group Heating and Cooling Coils

Cooling Coil Condenser Inlet Temperature [C]

The output variable is the average air temperature entering the condenser coil, in C over the
timestep being reported.
Cooling Coil Evaporative Condenser Water Volume [m3]
The output variable is the total water volume consumed for condenser evaporative precooling, in m3 over the timestep being reported.
Cooling Coil Evaporative Condenser Mains Water Volume [m3]
The output variable is the total water volume for condenser evaporative pre-cooling, obtained
from the Mains Water supply, in m3 over the timestep being reported.
Cooling Coil Evaporative Condenser Pump Electric Power[W]
The output variable is the average power consumption rate of the evaporative condenser
pump, in Watts over the timestep being reported.
Cooling Coil Evaporative Condenser Pump Electric Energy [J]
The output variable is the total power consumption of the evaporative condenser pump, in
Joules over the timestep being reported.
Cooling Coil Basin Heater Electric Power [W]
The output variable is the average power consumption rate by the basin heater, in Watts over
the timestep being reported.
Cooling Coil Basin Heater Electric Energy [J]
The output variable is the total power consumption by the basin heater, in Joules over the
timestep being reported.
CoilPerformance:DX:Cooling
This coil performance object is used to specify DX coil performance for one mode of
operation
for
a
Coil:Cooling:DX:TwoStageWithHumidityControlMode.
A
single
Coil:Cooling:DX:TwoStageWithHumidityControlMode object will reference one to four
CoilPerformance:DX:Cooling objects depending on the number of available stages and
dehumidification modes as specified in the two stage DX object. For example, a standard 2stage DX system will use two of these performance objects, one to defined the capacity and
performance for stage 1 operation, and a second one for stage 1+2 (both stages active)
operation. In nearly all cases, the Rated Air Volume Flow Rate will be the same for all
performance objects associated with a given multimode DX coil. If bypass is specified, the
Rated Air Volume Flow Rate includes both the bypassed flow and the flow through the active
coil.
This DX coil model is identical to Coil:Cooling:DX:SingleSpeed with addition of bypass and
multi-stage capabilities. This DX cooling coil model and input are quite different from that for
the heating and cooling water coils. The simple water coils use an NTU-effectiveness heat
exchanger model. The single speed DX coil model uses performance information at rated
conditions along with curve fits for variations in total capacity, energy input ratio and part-load
fraction to determine performance at part-load conditions. Sensible/latent capacity splits are
determined by the rated sensible heat ratio (SHR) and the apparatus dewpoint/bypass factor
(ADP/BF) approach. This approach is analogous to the NTU-effectiveness calculations used
for sensible-only heat exchanger calculations, extended to a cooling and dehumidifying coil.
An alternative to ADP/BF method for sensible/latent capacity split is to use SHR modifier
curves for temperature and flow fraction. These two optional input fields are used only when
a user specified SHR calculation method desired over the (ADP/BF) method. Sensible heat
ratio calculated using these two SHR modifier curves override the value calculated by

9/29/14

1401

Input-Output Reference

Group Heating and Cooling Coils

ADP/BF method. See section SHR Calculation Using User Specified SHR Modifier Curves
in the EnergyPlus Engineering Document for further details.
The DX cooling coil input requires the gross rated total cooling capacity, the gross rated SHR,
the gross rated COP, the rated air volume flow rate, and the fraction of air flow which is
bypassed around the coil. The first 4 inputs determine the coil performance at the rating point
(air entering the cooling coil at 26.7C drybulb/19.4C wetbulb and air entering the outdoor
condenser coil at 35C drybulb/23.9C wetbulb). The rated air volume flow rate (less any
bypassed fraction) should be between .00004027 m 3/s and .00006041 m 3/s per watt of gross
rated total cooling capacity (300 to 450 cfm/ton). The rated volumetric air flow to gross total
cooling capacity ratio for 100% dedicated outdoor air (DOAS) application DX cooling coils
should be between 0.00001677 (m3/s)/W (125 cfm/ton) and 0.00003355 (m3/s)/W (250
cfm/ton).
This model requires 5 curves as follows:
1. The total cooling capacity modifier curve (function of temperature) is a biquadratic curve
with two independent variables: wet-bulb temperature of the air entering the cooling coil,
and dry-bulb temperature of the air entering the air-cooled condenser coil (wet-bulb
temperature if modeling an evaporative-cooled condenser). The output of this curve is
multiplied by the gross rated total cooling capacity to give the gross total cooling capacity
at specific temperature operating conditions (i.e., at temperatures different from the rating
point temperatures).
2. The total cooling capacity modifier curve (function of flow fraction) is a quadratic or cubic
curve with the independent variable being the ratio of the actual air flow rate across the
cooling coil to the rated air flow rate (i.e., fraction of full load flow). The output of this
curve is multiplied by the gross rated total cooling capacity and the total cooling capacity
modifier curve (function of temperature) to give the gross total cooling capacity at the
specific temperature and air flow conditions at which the coil is operating.
3. The energy input ratio (EIR) modifier curve (function of temperature) is a biquadratic
curve with two independent variables: wet-bulb temperature of the air entering the cooling
coil, and dry-bulb temperature of the air entering the air-cooled condenser coil (wet-bulb
temperature if modeling an evaporative-cooled condenser). The output of this curve is
multiplied by the rated EIR (inverse of the rated COP) to give the EIR at specific
temperature operating conditions (i.e., at temperatures different from the rating point
temperatures).
4. The energy input ratio (EIR) modifier curve (function of flow fraction) is a quadratic or
cubic curve with the independent variable being the ratio of the actual air flow rate across
the cooling coil to the rated air flow rate (i.e., fraction of full load flow). The output of this
curve is multiplied by the rated EIR (inverse of the rated COP) and the EIR modifier curve
(function of temperature) to give the EIR at the specific temperature and air flow
conditions at which the coil is operating.
5. The part load fraction correlation (function of part load ratio) is a quadratic or cubic curve
with the independent variable being part load ratio (sensible cooling load / steady-state
sensible cooling capacity). The output of this curve is used in combination with the rated
EIR and EIR modifier curves to give the effective EIR for a given simulation timestep.
The part load fraction (PLF) correlation accounts for efficiency losses due to compressor
cycling. The curve should be normalized to a value of 1.0 when the part-load ratio equals
1.0 (i.e., the compressor(s) run continuously for the simulation timestep).
The curves are simply specified by name. Curve inputs are described in the curve manager
section of this document (see Performance Curves in this document).
The next four input fields are optional and relate to the degradation of latent cooling capacity
when the supply air fan operates continuously while the cooling coil/compressor cycle on and
off to meet the cooling load. The fan operating mode is either considered to be constant (e.g.
CoilSystem:Cooling:DX) or can be scheduled in the parent object (e.g.
AirLoopHVAC:UnitaryHeatCool). When scheduled, the schedule value must be greater than
0 to calculate degradation of latent cooling capacity. At times when the parent objects supply
9/29/14

1402

Input-Output Reference

Group Heating and Cooling Coils

air fan operating mode schedule is 0, latent degradation will be ignored. When used, these
next four input fields must all have positive values in order to model latent capacity
degradation.
The next input specifies the outdoor air node used to define the conditions of the air entering
the outdoor condenser. If this field is not blank, the node name specified must be listed in an
OutdoorAir:Node object where the height of the node is taken into consideration when
calculating outdoor temperature from the weather data. Alternately, the node name must be
specified in an OutdoorAir:NodeList object where the outdoor temperature entering the
condenser is taken directly from the weather data. This field may also be left blank, if this is
the case then the outdoor temperature entering the condenser is taken directly from the
weather data.
The next input describes the type of outdoor condenser coil used with the DX cooling coil (Air
Cooled or Evap Cooled). The following three inputs are required when modeling an
evaporative-cooled condenser: evaporative condenser effectiveness, evaporative condenser
air volume flow rate, and the power consumed by the evaporative condenser pump. See
section DX Cooling Coil Model in the EnergyPlus Engineering Document for further details
regarding this model.
Field: Name
This alpha field is a unique user-assigned name for an instance of DX cooling coil
performance. Any reference to this DX coil performance object by another object will use this
name.
Field: Gross Rated Total Cooling Capacity
The total, full load gross cooling capacity (sensible plus latent) in watts of the DX coil unit at
rated conditions (air entering the cooling coil at 26.7C drybulb/19.4C wetbulb, air entering
the outdoor condenser coil at 35C drybulb/23.9C wetbulb10, and a cooling coil air flow rate
defined by field rated air flow rate below). Capacity should be gross (i.e., the effect of
supply air fan heat is NOT accounted for).
Field: Gross Rated Sensible Heat Ratio
The sensible heat ratio (SHR=gross sensible capacity divided by gross total cooling capacity)
of the DX cooling coil at rated conditions (air entering the cooling coil at 26.7C
drybulb/19.4C wetbulb, air entering the outdoor condenser coil at 35C drybulb/23.9C
wetbulb, and a cooling coil air flow rate defined by field rated air flow rate below). Both the
sensible and total cooling capacities used to define the Rated SHR should be gross (i.e.,
the effect of supply air fan heat is NOT accounted for).
Field: Gross Rated Cooling COP
The coefficient of performance is the ratio of the gross total cooling capacity in watts to
electrical power input in watts) of the DX cooling coil unit at rated conditions (air entering the
cooling coil at 26.7C drybulb/19.4C wetbulb, air entering the outdoor condenser coil at 35C
drybulb/ 23.9C wetbulb, and a cooling coil air flow rate defined by field rated air flow rate
below). The input power includes electric power for the compressor(s) and condenser fan(s)
but does not include the power consumption of the supply air fan. If this input field is left
blank, the default value is 3.0.
Field: Rated Air Flow Rate
The air volume flow rate, in m 3 per second, across the DX cooling coil at rated conditions.
The gross rated total cooling capacity, gross rated SHR and gross rated COP should be
performance information for the unit with air entering the cooling coil at 26.7C
drybulb/19.4C wetbulb, air entering the outdoor condenser coil at 35C drybulb/23.9C
wetbulb, and the rated air volume flow rate defined here.
10

9/29/14

The 23.9C wet-bulb temperature condition is not applicable for air-cooled condensers which do not evaporate condensate.

1403

Input-Output Reference

Group Heating and Cooling Coils

Field: Fraction of Air Flow Bypassed Around Coil

This numeric field specifies the fraction of the Rated Air Volume Flow Rate which bypasses
the active cooling coil for this performance mode. The remaining portion of the flow should be
between 0.00004027 m3/s and .00006041 m3/s per watt of gross rated total cooling capacity
(300 to 450 cfm/ton) for this performance mode. For DOAS applications the remaining portion
of rated air volume flow rate should be between 0.00001677 m3/s and 0.00003355 m3/s per
watt of gross rated total cooling capacity (125 to 250 cfm/ton). This is used to model facesplit coils on multi-stage units or bypass dampers. If total flow rate varies during simulation,
the same fraction is bypassed. This input may range from 0.0 to <1.0. The default is 0.0. For
a multi-stage face-split coil in which stage 1 is 60% of total capacity, this field would be set to
0.4 for the Stage 1 performance and set to 0.0 for the Stage 1+2 performance. For a DX
system which activates a bypass damper for improved dehumidification, this field would be
set to 0.0 for normal mode performance and set to something greater than zero for enhanced
dehumidification mode performance.
Field: Total Cooling Capacity Function of Temperature Curve Name
The name of a biquadratic performance curve (ref: Performance Curves) that parameterizes
the variation of the total gross cooling capacity as a function of the wet-bulb temperature of
the air entering the cooling coil, and the dry-bulb temperature of the air entering the aircooled condenser coil (wet-bulb temperature if modeling an evaporative-cooled condenser).
The output of this curve is multiplied by the gross rated total cooling capacity to give the
gross total cooling capacity at specific temperature operating conditions (i.e., at temperatures
different from the rating point temperatures). The curve is normalized to have the value of 1.0
at the rating point.
Field: Total Cooling Capacity Function of Flow Fraction Curve Name
The name of a quadratic or cubic performance curve (ref: Performance Curves) that
parameterizes the variation of the gross total cooling capacity as a function of the ratio of
actual air flow rate across the cooling coil to the rated air flow rate (i.e., fraction of full load
flow). The output of this curve is multiplied by the gross rated total cooling capacity and the
total cooling capacity modifier curve (function of temperature) to give the gross total cooling
capacity at the specific temperature and air flow conditions at which the coil is operating. The
curve is normalized to have the value of 1.0 when the actual air flow rate equals the rated air
flow rate.
Field: Energy Input Ratio Function of Temperature Curve Name
The name of a biquadratic performance curve (ref: Performance Curves) that parameterizes
the variation of the energy input ratio (EIR) as a function of the wet-bulb temperature of the
air entering the cooling coil, and the dry-bulb temperature of the air entering the air-cooled
condenser coil (wet-bulb temperature if modeling an evaporative-cooled condenser). The EIR
is the inverse of the COP. The output of this curve is multiplied by the rated EIR (inverse of
rated COP) to give the EIR at specific temperature operating conditions (i.e., at temperatures
different from the rating point temperatures). The curve is normalized to a value of 1.0 at the
rating point.
Field: Energy Input Ratio Function of Flow Fraction Curve Name
The name of a quadratic or cubic performance curve (Ref: Performance Curves) that
parameterizes the variation of the energy input ratio (EIR) as a function of the ratio of actual
air flow rate across the cooling coil to the rated air flow rate (i.e., fraction of full load flow). The
EIR is the inverse of the COP. The output of this curve is multiplied by the rated EIR and the
EIR modifier curve (function of temperature) to give the EIR at the specific temperature and
air flow conditions at which the cooling coil is operating. This curve is normalized to a value of
1.0 when the actual air flow rate equals the rated air flow rate.

9/29/14

1404

Input-Output Reference

Group Heating and Cooling Coils

Field: Part Load Fraction Correlation Curve Name

This alpha field defines the name of a quadratic or cubic performance curve (Ref:
Performance Curves) that parameterizes the variation of electrical power input to the DX unit
as a function of the part load ratio (PLR, sensible cooling load/steady-state sensible cooling
capacity). The product of the rated EIR and EIR modifier curves is divided by the output of
this curve to give the effective EIR for a given simulation timestep. The part load fraction
(PLF) correlation accounts for efficiency losses due to compressor cycling.
The part load fraction correlation should be normalized to a value of 1.0 when the part load
ratio equals 1.0 (i.e., no efficiency losses when the compressor(s) run continuously for the
simulation timestep). For PLR values between 0 and 1 (0 <= PLR < 1), the following rules
apply:
PLF >= 0.7 and PLF >= PLR
If PLF < 0.7 a warning message is issued, the program resets the PLF value to 0.7, and the
simulation proceeds. The runtime fraction of the coil is defined as PLR/PLF. If PLF < PLR,
then a warning message is issued and the runtime fraction of the coil is limited to 1.0.
A typical part load fraction correlation for a conventional, single-speed DX cooling coil (e.g.,
residential unit) would be:
PLF = 0.85 + 0.15(PLR)
If the user wishes to model no efficiency degradation due to compressor cycling, the part load
fraction correlation should be defined as follows:
PLF = 1.0 + 0.0(PLR)
Field: Nominal Time for Condensate Removal to Begin
The nominal time (in seconds) after startup for condensate to begin leaving the coil's
condensate drain line at the coil's rated airflow and temperature conditions, starting with a dry
coil. Nominal time is equal to the ratio of the energy of the coil's maximum condensate
holding capacity (J) to the coil's steady-state latent capacity (W). Suggested value is 1000;
zero value means the latent degradation model is disabled. The default value for this field is
zero. The supply air fan operating mode must be continuous (i.e., the supply air fan operating
mode may be specified in other parent objects and is assumed continuous in some objects
(e.g., CoilSystem:Cooling:DX) or can be scheduled in other objects [e.g.,
AirloopHVAC:UnitaryHeatCool]), and this field as well as the next three input fields for this
object must have positive values in order to model latent capacity degradation.
Field: Ratio of Initial Moisture Evaporation Rate and Steady State Latent Capacity
Ratio of the initial moisture evaporation rate from the cooling coil (when the compressor first
turns off, in Watts) and the coil's steady-state latent capacity (Watts) at rated airflow and
temperature conditions. Suggested value is 1.5; zero value means the latent degradation
model is disabled. The default value for this field is zero. The supply air fan operating mode
must be continuous (i.e., the supply air fan operating mode may be specified in other parent
objects and is assumed continuous in some objects (e.g., CoilSystem:Cooling:DX) or can be
scheduled in other objects [e.g., AirloopHVAC:UnitaryHeatCool]); and this field, the previous
field and the next two fields must have positive values in order to model latent capacity
degradation.
Field: Maximum Cycling Rate
The maximum on-off cycling rate for the compressor (cycles per hour), which occurs at 50%
run time fraction. Suggested value is 3; zero value means latent degradation model is
disabled. The default value for this field is zero. The supply air fan operating mode must be
continuous (i.e., the supply air fan operating mode may be specified in other parent objects
and is assumed continuous in some objects (e.g., CoilSystem:Cooling:DX) or can be
scheduled in other objects [e.g., AirloopHVAC:UnitaryHeatCool]); and this field, the previous

9/29/14

1405

Input-Output Reference

Group Heating and Cooling Coils

two fields and the next field must have positive values in order to model latent capacity
degradation.
Field: Latent Capacity Time Constant
Time constant (in seconds) for the cooling coil's latent capacity to reach steady state after
startup. Suggested value is 45; zero value means latent degradation model is disabled. The
default value for this field is zero. The supply air fan operating mode must be continuous (i.e.,
the supply air fan operating mode may be specified in other parent objects and is assumed
continuous in some objects (e.g., CoilSystem:Cooling:DX) or can be scheduled in other
objects [e.g., AirloopHVAC:UnitaryHeatCool]), and this field as well as the previous three
input fields for this object must have positive values in order to model latent capacity
degradation.
Field: Condenser Air Inlet Node Name
This optional alpha field specifies the outdoor air node name used to define the conditions of
the air entering the outdoor condenser. If this field is left blank, the outdoor air temperature
entering the condenser (dry-bulb or wet-bulb) is taken directly from the weather data. If this
field is not blank, the node name specified must also be specified in an OutdoorAir:Node
object where the height of the node is taken into consideration when calculating outdoor air
temperature from the weather data. Alternately, the node name may be specified in an
OutdoorAir:NodeList object where the outdoor air temperature is taken directly from the
weather data.
Field: Condenser Type
The type of condenser used by the DX cooling coil. Valid choices for this input field are
AirCooled or EvaporativelyCooled. The default for this field is AirCooled.
Field: Evaporative Condenser Effectiveness
The effectiveness of the evaporative condenser, which is used to determine the temperature
of the air entering the outdoor condenser coil as follows:

Tcond inlet

Twb, o

1 EvapCondEffectiveness Tdb, o Twb, o

where

Tcond inlet = the temperature of the air entering the condenser coil (C)
Twb,o = the wet-bulb temperature of the outdoor air (C)
Tdb,o = the dry-bulb temperature of the outdoor air (C)
The resulting condenser inlet air temperature is used by the Total Cooling Capacity Modifier
Curve (function of temperature) and the Energy Input Ratio Modifier Curve (function of
temperature). The default value for this field is 0.9, although valid entries can range from 0.0
to 1.0. This field is not used when Condenser Type = Air Cooled.
If the user wants to model an air-cooled condenser, they should simply specify AirCooled in
the field Condenser Type. In this case, the Total Cooling Capacity Modifier Curve (function of
temperature) and the Energy Input Ratio Modifier Curve (function of temperature) input fields
for this object should reference performance curves that are a function of outdoor dry-bulb
temperature.
If the user wishes to model an evaporative-cooled condenser AND they have performance
curves that are a function of the wet-bulb temperature of air entering the condenser coil, then
the user should specify Condenser Type = Evap Cooled and the evaporative condenser
effectiveness value should be entered as 1.0. In this case, the Total Cooling Capacity
Modifier Curve (function of temperature) and the Energy Input Ratio Modifier Curve (function

9/29/14

1406

Input-Output Reference

Group Heating and Cooling Coils

of temperature) input fields for this object should reference performance curves that are a
function of the wet-bulb temperature of air entering the condenser coil.
If the user wishes to model an air-cooled condenser that has evaporative media placed in
front of it to cool the air entering the condenser coil, then the user should specify Condenser
Type = Evap Cooled. The user must also enter the appropriate evaporative effectiveness for
the media. In this case, the Total Cooling Capacity Modifier Curve (function of temperature)
and the Energy Input Ratio Modifier Curve (function of temperature) input fields for this object
should reference performance curves that are a function of outdoor dry-bulb temperature. Be
aware that the evaporative media will significantly reduce the dry-bulb temperature of the air
entering the condenser coil, so the Total Cooling Capacity and EIR Modifier Curves must be
valid for the expected range of dry-bulb temperatures that will be entering the condenser coil.
Field: Evaporative Condenser Air Flow Rate
The air volume flow rate, in m 3 per second, entering the evaporative condenser. This value is
used to calculate the amount of water used to evaporatively cool the condenser inlet air. The
minimum value for this field must be greater than zero, and this input field is autosizable
(equivalent to 0.000144 m 3/s per watt of rated total cooling capacity [850 cfm/ton]). This field
is not used when Condenser Type = Air Cooled.
Field: Evaporative Condenser Pump Rated Power Consumption
The rated power of the evaporative condenser water pump in Watts. This value is used to
calculate the power required to pump the water used to evaporatively cool the condenser
inlet air. The default value for this input field is zero, but it is autosizable (equivalent to
0.004266 W per watt [15 W/ton] of rated total cooling capacity). This field is not used when
Condenser Type = AirCooled.
Field: Sensible Heat Ratio Function of Temperature Curve Name
The name of a biquadratic normalized curve (Ref: Performance Curves) that parameterizes
the variation of the sensible heat ratio (SHR) as a function of DX cooling coil entering air wetbulb and dry-bulb temperatures. The output of this curve is multiplied by the rated SHR and
the SHR modifier curve (function of flow fraction) to give the SHR at the specific coil entering
air temperature and air flow conditions at which the cooling coil is operating. This curve is
normalized to a value of 1.0 at the rated condition. This input field is optional.
Field: Sensible Heat Ratio Function of Flow Fraction Curve Name
The name of a quadratic or cubic normalized curve (Ref: Performance Curves) that
parameterizes the variation of the sensible heat ratio (SHR) as a function of the ratio of actual
air flow rate across the cooling coil to the rated air flow rate (i.e., fraction of full load flow). The
output of this curve is multiplied by the rated SHR and the SHR modifier curve (function of
temperature) to give the SHR at the specific temperature and air flow conditions at which the
cooling coil is operating. This curve is normalized to a value of 1.0 when the actual air flow
rate equals the rated air flow rate. This input field is optional.
Following is an example input for a Coil:Cooling:DX:TwoStageWithHumidityControlMode with
2 capacity stages and one enhanced dehumidification mode so it requires four
CoilPerformance:DX:Cooling objects.

9/29/14

1407

Input-Output Reference

Group Heating and Cooling Coils

Coil:Cooling:DX:TwoStageWithHumidityControlMode,
DXSystem 1 Cooling Coil, !- Coil Name
OfficeHeatCoolAvail,
!- Availability Schedule
DXSystem 1 Mixed Air Node, !- Coil Air Inlet Node
DXSystem 1 Fan Air Inlet Node, !- Coil Air Outlet Node
,
!- Crankcase Heater Capacity {W}
,
!- Maximum Outdoor Dry-bulb Temperature for Crankcase Heater Operation {C}
2,
!- Number of Capacity Stages
1,
!- Number of Enhanced Dehumidification Modes
CoilPerformance:DX:Cooling, !- Normal Mode Stage 1 Coil Performance Object Type
DXSystem 1 DX Coil Standard Mode-Stage 1, !- Normal Mode Stage 1 Coil Performance Object Name
CoilPerformance:DX:Cooling, !- Normal Mode Stage 1+2 Coil Perf Object Type
DXSystem 1 DX Coil Standard Mode-Stage 1&2, !- Normal Mode Stage 1+2 Coil Perf Object Name
CoilPerformance:DX:Cooling, !- Dehumid Mode 1 Stage 1 Coil Perf Object Type
DXSystem 1 DX Coil SubCoolReheat Mode-Stage 1, !- Dehumid Mode 1 Stage 1 Coil Perf Object Name
CoilPerformance:DX:Cooling, !- Dehumid Mode 1 Stage 1+2 Coil Perf Object Type
DXSystem 1 DX Coil SubCoolReheat Mode-Stage 1&2; !- Dehumid Mode 1 Stage 1+2 Coil Perf Object Name

CoilPerformance:DX:Cooling,
DXSystem 1 DX Coil Standard Mode-Stage 1, !- Coil Performance Specification Name
21327.57812,
!- Gross Rated Total Cooling Capacity {W}
0.68,
!- Gross Rated Sensible Heat Ratio
3.56,
!- Gross Rated Cooling COP
1.695372105,
!- Rated Air Flow Rate {m3/s}
0.4,
!- Fraction of Air Flow Bypassed Around Coil
HPACCoolCapFT,
!- Total Cooling Capacity Modifier Curve (function of temperature)
HPACCoolCapFFF,
!- Total Cooling Capacity Modifier Curve (function of flow fraction)
HPACCOOLEIRFT,
!- Energy Input Ratio Modifier Curve (function of temperature)
HPACCOOLEIRFFF,
!- Energy Input Ratio Modifier Curve (function of flow fraction)
HPACCOOLPLFFPLR,
!- Part Load Fraction Correlation (function of part load ratio)
1000,
!- Nominal Time for Condensate Removal to Begin {s}
1.5, !- Ratio of Initial Moisture Evaporation Rate and Steady-state Latent Capacity {dimensionless}
3,
!- Maximum ON/OFF Cycling Rate {cycles/hr}
45,
!- Latent Capacity Time Constant {s}
,
!- Condenser Air Inlet Node Name
,
!- Condenser Type
,
!- Evaporative Condenser Effectiveness
,
!- Evaporative Condenser Air Flow Rate
,
!- Evaporative Condenser Pump Rated Power Consumption
DOAS DX Coil SHR-FT,
!- Sensible Heat Ratio Function of Temperature Curve Name
DOAS DX Coil SHR-FF;
!- Sensible Heat Ratio Function of Flow Fraction Curve Name

CoilPerformance:DX:Cooling,
DXSystem 1 DX Coil Standard Mode-Stage 1&2, !- Coil Performance Specification Name
35545.96484,
!- Gross Rated Total Cooling Capacity {W}
0.68,
!- Gross Rated Sensible Heat Ratio
3.56,
!- Gross Rated Cooling COP
1.695372105,
!- Rated Air Flow Rate {m3/s}
0.0,
!- Fraction of Air Flow Bypassed Around Coil
HPACCoolCapFT,
!- Total Cooling Capacity Modifier Curve (function of temperature)
HPACCoolCapFFF,
!- Total Cooling Capacity Modifier Curve (function of flow fraction)
HPACCOOLEIRFT,
!- Energy Input Ratio Modifier Curve (function of temperature)
HPACCOOLEIRFFF,
!- Energy Input Ratio Modifier Curve (function of flow fraction)
HPACCOOLPLFFPLR,
!- Part Load Fraction Correlation (function of part load ratio)
1000,
!- Nominal Time for Condensate Removal to Begin {s}
1.5, !- Ratio of Initial Moisture Evaporation Rate and Steady-state Latent Capacity {dimensionless}
3,
!- Maximum ON/OFF Cycling Rate {cycles/hr}
45,
!- Latent Capacity Time Constant {s}
,
!- Condenser Air Inlet Node Name
,
!- Condenser Type
,
!- Evaporative Condenser Effectiveness
,
!- Evaporative Condenser Air Flow Rate
,
!- Evaporative Condenser Pump Rated Power Consumption
DOAS DX Coil SHR-FT,
!- Sensible Heat Ratio Function of Temperature Curve Name
DOAS DX Coil SHR-FF;
!- Sensible Heat Ratio Function of Flow Fraction Curve Name

9/29/14

1408

Input-Output Reference

Group Heating and Cooling Coils

CoilPerformance:DX:Cooling,
DXSystem 1 DX Coil SubCoolReheat Mode-Stage 1, !- Coil Performance Specification Name
19962.61328,
!- Gross Rated Total Cooling Capacity (gross) {W}
0.60,
!- Gross Rated SHR
3.31,
!- Gross Rated Cooling COP
1.695372105,
!- Rated Air Flow Rate {m3/s}
0.4,
!- Fraction of Air Flow Bypassed Around Coil
SubCoolReheatCoolCapFT, !- Total Cooling Capacity Modifier Curve (function of temperature)
SubCoolReheatCoolCapFFF, !- Total Cooling Capacity Modifier Curve (function of flow fraction)
SubCoolReheatCOOLEIRFT, !- Energy Input Ratio Modifier Curve (function of temperature)
SubCoolReheatCoolEIRFFF, !- Energy Input Ratio Modifier Curve (function of flow fraction)
SubCoolReheatCoolPLFFPLR, !- Part Load Fraction Correlation (function of part load ratio)
1000,
!- Nominal Time for Condensate Removal to Begin {s}
1.5, !- Ratio of Initial Moisture Evaporation Rate and Steady-state Latent Capacity {dimensionless}
3,
!- Maximum ON/OFF Cycling Rate {cycles/hr}
45,
!- Latent Capacity Time Constant {s}
,
!- Condenser Air Inlet Node Name
,
!- Condenser Type
,
!- Evaporative Condenser Effectiveness
,
!- Evaporative Condenser Air Flow Rate
,
!- Evaporative Condenser Pump Rated Power Consumption
DOAS DX Coil SHR-FT,
!- Sensible Heat Ratio Function of Temperature Curve Name
DOAS DX Coil SHR-FF;
!- Sensible Heat Ratio Function of Flow Fraction Curve Name

CoilPerformance:DX:Cooling,
DXSystem 1 DX Coil SubCoolReheat Mode-Stage 1&2, !- Coil Performance Specification Name
33271.01953,
!- Gross Rated Total Cooling Capacity (gross) {W}
0.60,
!- Gross Rated SHR
3.31,
!- Gross Rated Cooling COP
1.695372105,
!- Rated Air Flow Rate {m3/s}
0.0,
!- Fraction of Air Flow Bypassed Around Coil
SubCoolReheatCoolCapFT, !- Total Cooling Capacity Modifier Curve (function of temperature)
SubCoolReheatCoolCapFFF, !- Total Cooling Capacity Modifier Curve (function of flow fraction)
SubCoolReheatCOOLEIRFT, !- Energy Input Ratio Modifier Curve (function of temperature)
SubCoolReheatCoolEIRFFF, !- Energy Input Ratio Modifier Curve (function of flow fraction)
SubCoolReheatCoolPLFFPLR, !- Part Load Fraction Correlation (function of part load ratio)
1000,
!- Nominal Time for Condensate Removal to Begin {s}
1.5, !- Ratio of Initial Moisture Evaporation Rate and Steady-state Latent Capacity {dimensionless}
3,
!- Maximum ON/OFF Cycling Rate {cycles/hr}
45,
!- Latent Capacity Time Constant {s}
,
!- Condenser Air Inlet Node Name
,
!- Condenser Type
,
!- Evaporative Condenser Effectiveness
,
!- Evaporative Condenser Air Flow Rate
,
!- Evaporative Condenser Pump Rated Power Consumption
DOAS DX Coil SHR-FT,
!- Sensible Heat Ratio Function of Temperature Curve Name
DOAS DX Coil SHR-FF;
!- Sensible Heat Ratio Function of Flow Fraction Curve Name

Coil Performance DX Cooling Outputs

The CoilPerformance:DX:Cooling object does not have specific output variables. To request
reports, use the parent object Coil:Cooling:DX:TwoStageWithHumidityControlMode output
variable options (ref. DX Cooling Coil Outputs). When requesting specific output variables by
name, use the name of the parent object as the Key Value for Output:Variable reporting
objects (ref. Output:Variable object). The name of the CoilPerformance:DX:Cooling object
cannot be used as a Key Value in the Output:Variable object.
Coil:Heating:DX:SingleSpeed
The single speed heating DX coil model uses performance information at rated conditions
along with curve fits for variations in total capacity, energy input ratio and part load fraction to
determine performance at part-load conditions. The impacts of various defrost strategies
(reverse cycle, resistive, timed or on-demand) are modeled based on a combination of user
inputs and empirical models taken from the air-to-air heat pump algorithms in DOE-2.1E.
The single speed heating DX coil input requires an availability schedule, the gross rated
heating capacity, the gross rated COP and the rated air volume flow rate. The latter 3 inputs
9/29/14

1409

Input-Output Reference

Group Heating and Cooling Coils

determine the coil performance at the rating point (outdoor air dry-bulb temperature of 8.33 C,
outdoor air wet-bulb temperature of 6.11 C, coil entering air dry-bulb temperature of 21.11 C,
coil entering air wet-bulb temperature of 15.55 C). The rated air volume flow rate should be
between .00004027 m3/s and .00006041 m3/s per watt of gross rated heating capacity.
Up to 6 curves are required depending on the defrost strategy selected.
1) The heating capacity modifier curve (function of temperature) can be a function of
both the outdoor and indoor air dry-bulb temperature or only the outdoor air dry-bulb
temperature. User has the choice of a bi-quadratic curve with two independent
variables or a quadratic curve as well as a cubic curve with a single independent
variable. The bi-quadratic curve is recommended if sufficient manufacturer data is
available as it provides sensitivity to the indoor air dry-bulb temperature and a more
realistic output. The output of this curve is multiplied by the gross rated heating
capacity to give the gross heating capacity at specific temperature operating
conditions (i.e., at an outdoor or indoor air temperature different from the rating point
temperature).
2) The heating capacity modifier curve (function of flow fraction) is a quadratic or cubic
curve with the independent variable being the ratio of the actual air flow rate across
the heating coil to the rated air flow rate (i.e., fraction of full load flow). The output of
this curve is multiplied by the gross rated heating capacity and the heating capacity
modifier curve (function of temperature) to give the gross heating capacity at the
specific temperature and air flow conditions at which the coil is operating.
3) The energy input ratio (EIR) modifier curve (function of temperature) can be a
function of both the outdoor and indoor air dry-bulb temperature or only the outdoor
air dry-bulb temperature. User has the choice of a bi-quadratic curve with two
independent variables or a quadratic curve as well as a cubic curve with a single
independent variable. The bi-quadratic curve is recommended if sufficient
manufacturer data is available as it provides sensitivity to the indoor air dry-bulb
temperature and a more realistic output. The output of this curve is multiplied by the
rated EIR (inverse of the rated COP) to give the EIR at specific temperature
operating conditions (i.e., at an outdoor or indoor air temperature different from the
rating point temperature).
4) The energy input ratio (EIR) modifier curve (function of flow fraction) is a quadratic or
cubic curve with the independent variable being the ratio of the actual air flow rate
across the heating coil to the rated air flow rate (i.e., fraction of full load flow). The
output of this curve is multiplied by the rated EIR (inverse of the rated COP) and the
EIR modifier curve (function of temperature) to give the EIR at the specific
temperature and air flow conditions at which the coil is operating.
5) The part load fraction correlation (function of part load ratio) is a quadratic or cubic
curve with the independent variable being part load ratio (sensible heating load /
steady-state heating capacity). The output of this curve is used in combination with
the rated EIR and EIR modifier curves to give the effective EIR for a given
simulation timestep. The part load fraction correlation accounts for efficiency losses
due to compressor cycling.
6) The defrost energy input ratio (EIR) modifier curve (function of temperature) is a biquadratic curve with two independent variables: outdoor air dry-bulb temperature and
the heating coil entering air wet-bulb temperature. The output of this curve is
multiplied by the heating coil capacity, the fractional defrost time period and the
runtime fraction of the heating coil to give the defrost power at the specific
temperatures at which the coil is operating. This curve is only required when a
reverse-cycle defrost strategy is specified.
The curves are simply specified by name. Curve inputs are described in the curve manager
section of this document (ref. Performance Curves).
The next input item for the coil is the supply air fan operation mode. Either the supply air fan
runs continuously while the DX coil cycles on/off, or the fan and coil cycle on/off together. The
9/29/14

1410

Input-Output Reference

Group Heating and Cooling Coils

next two inputs define the minimum outdoor dry-bulb temperature that the heat pump
compressor will operate and the maximum outdoor dry-bulb temperature for defrost
operation. Crankcase heater capacity and cutout temperature are entered in the following two
inputs. The final four inputs cover the type of defrost strategy (reverse-cycle or resistive),
defrost control (timed or on-demand), the fractional defrost time period (timed defrost control
only), and the resistive defrost heater capacity if a resistive defrost strategy is selected.
Field: Name
This alpha field defines a unique user-assigned name for an instance of a DX heating coil.
Any reference to this DX heating coil by another object will use this name.
Field: Availability Schedule Name
This alpha field defines the name of the schedule (ref: Schedule) that denotes whether the
DX heating coil can run during a given time period. A schedule value greater than 0 (usually 1
is used) indicates that the unit can be on during the time period. A value less than or equal to
0 (usually 0 is used) denotes that the unit must be off for the time period. If this field is blank,
the schedule has values of 1 for all time periods.
Field: Gross Rated Heating Capacity
This numeric field defines the total, full load gross heating capacity in watts of the DX coil unit
at rated conditions (outdoor air dry-bulb temperature of 8.33 C, outdoor air wet-bulb
temperature of 6.11 C, heating coil entering air dry-bulb temperature of 21.11 C, heating coil
entering air wet-bulb temperature of 15.55 C, and a heating coil air flow rate defined by field
rated air flow volume below). The value entered here must be greater than 0. Capacity
should not account for supply air fan heat. The gross rated heating capacity should be within
20% of the gross rated total cooling capacity, otherwise a warning message is issued. The
gross heating capacity should NOT include the effect of supply air fan heat.
Field: Gross Rated Heating COP
This numeric field defines the coefficient of performance (COP= the gross heating capacity in
watts divided by electrical power input in watts) of the DX heating coil unit at rated conditions
(outdoor air dry-bulb temperature of 8.33 C, outdoor air wet-bulb temperature of 6.11 C, coil
entering air dry-bulb temperature of 21.11 C, coil entering air wet-bulb temperature of 15.55
C, and a heating coil air flow rate defined by field rated air flow volume rate below). The
value entered here must be greater than 0. The input power includes power for the
compressor(s) and outdoor fan(s) but does not include the power consumption of the indoor
supply air fan. The gross COP should NOT account for the supply air fan.
Field: Rated Air Flow Rate
This numeric field defines the volume air flow rate, in m 3 per second, across the DX heating
coil at rated conditions. The value entered here must be greater than 0. The rated air volume
flow rate should be between 0.00004027 m3/s and 0.00006041 m 3/s per watt of the gross
rated heating capacity. The gross rated heating capacity and gross rated COP should be
performance information for the unit with outdoor air dry-bulb temperature of 8.33 C, outdoor
air wet-bulb temperature of 6.11 C, heating coil entering air dry-bulb temperature of 21.11 C,
heating coil entering air wet-bulb temperature of 15.55 C, and the rated air volume flow rate
defined here.
Field: Rated Evaporator Fan Power Per Volume Flow Rate
This field is the electric power for the evaporator (heating coil) fan per air volume flow rate
through the coil at the rated conditions in W/(m 3/s). The default value is 773.3 W/(m3/s) (365
W/1000 cfm) if this field is left blank. If a value is entered, it must be >= 0.0 and <= 1250
W/(m3/s). This value is only used to calculate High Temperature Heating Standard (Net)
Rating Capacity, Low Temperature Heating Standard (Net) Rating Capacity and Heating
Seasonal Performance Factor (HSPF) which will be outputs in the EnergyPlus eio file (ref.
9/29/14

1411

Input-Output Reference

Group Heating and Cooling Coils

EnergyPlus Engineering Reference, Single Speed DX Heating Coil, Standard Ratings). This
value is not used for modeling the evaporator (heating coil) fan during simulations; instead, it
is used for calculating the above standard ratings to assist the user in verifying their inputs for
modeling this type of equipment.
Field: Air Inlet Node Name
This alpha field defines the name of the HVAC system node from which the DX heating coil
draws its inlet air.
Field: Air Outlet Node Name
This alpha field defines the name of the HVAC system node to which the DX heating coil
sends its outlet air.
Field: Heating Capacity Function of Temperature Curve Name
This alpha field defines the name of a bi-quadratic, quadratic or cubic performance curve (ref:
Performance Curves) that parameterizes the variation of the total heating capacity as a
function of the both the indoor and outdoor air dry-bulb temperature or just the outdoor air
dry-bulb temperature depending on the type of curve selected. The bi-quadratic curve is
recommended if sufficient manufacturer data is available as it provides sensitivity to the
indoor air dry-bulb temperature and a more realistic output. The output of this curve is
multiplied by the gross rated heating capacity to give the gross total heating capacity at
specific temperature operating conditions (i.e., at an indoor air dry-bulb temperature or
outdoor air dry-bulb temperature different from the rating point temperature). The curve is
normalized to have the value of 1.0 at the rating point.
Field: Heating Capacity Function of Flow Fraction Curve Name
This alpha field defines the name of a quadratic or cubic performance curve (ref:
Performance Curves) that parameterizes the variation of total heating capacity as a function
of the ratio of actual air flow rate across the heating coil to the rated air flow rate (i.e., fraction
of full load flow). The output of this curve is multiplied by the gross rated heating capacity and
the heating capacity modifier curve (function of temperature) to give the gross heating
capacity at the specific temperature and air flow conditions at which the coil is operating. The
curve is normalized to have the value of 1.0 when the actual air flow rate equals the rated air
flow rate.
Field: Energy Input Ratio Function of Temperature Curve Name
This alpha field defines the name of a bi-quadratic, quadratic or cubic performance curve (ref:
Performance Curves) that parameterizes the variation of the energy input ratio (EIR) as a
function of the both the indoor and outdoor air dry-bulb temperature or just the outdoor air
dry-bulb temperature depending on the type of curve selected. The bi-quadratic curve is
recommended if sufficient manufacturer data is available as it provides sensitivity to the
indoor air dry-bulb temperature and a more realistic output. The EIR is the inverse of the
COP. The output of this curve is multiplied by the rated EIR (inverse of rated COP) to give the
EIR at specific temperature operating conditions (i.e., at an indoor air dry-bulb temperature or
outdoor air dry-bulb temperature different from the rating point temperature). The curve is
normalized to have the value of 1.0 at the rating point.
Field: Energy Input Ratio Function of Flow Fraction Curve Name
This alpha field defines the name of a quadratic or cubic performance curve (ref:
Performance Curves) that parameterizes the variation of the energy input ratio (EIR) as a
function of the ratio of actual air flow rate across the heating coil to the rated air flow rate (i.e.,
fraction of full load flow). The EIR is the inverse of the COP. The output of this curve is
multiplied by the rated EIR and the EIR modifier curve (function of temperature) to give the
EIR at the specific temperature and air flow conditions at which the coil is operating. This

9/29/14

1412

Input-Output Reference

Group Heating and Cooling Coils

curve is normalized to a value of 1.0 when the actual air flow rate equals the rated air flow
rate.
Field: Part Load Fraction Correlation Curve Name
This alpha field defines the name of a quadratic or cubic performance curve (Ref:
Performance Curves) that parameterizes the variation of electrical power input to the DX unit
as a function of the part load ratio (PLR, sensible cooling load/steady-state sensible cooling
capacity). The product of the rated EIR and EIR modifier curves is divided by the output of
this curve to give the effective EIR for a given simulation timestep. The part load fraction
(PLF) correlation accounts for efficiency losses due to compressor cycling.
The part load fraction correlation should be normalized to a value of 1.0 when the part load
ratio equals 1.0 (i.e., no efficiency losses when the compressor(s) run continuously for the
simulation timestep). For PLR values between 0 and 1 (0 <= PLR < 1), the following rules
apply:
PLF >= 0.7 and PLF >= PLR
If PLF < 0.7 a warning message is issued, the program resets the PLF value to 0.7, and the
simulation proceeds. The runtime fraction of the coil is defined as PLR/PLF. If PLF < PLR,
then a warning message is issued and the runtime fraction of the coil is limited to 1.0.
A typical part load fraction correlation for a conventional, single-speed DX cooling coil (e.g.,
residential unit) would be:
PLF = 0.85 + 0.15(PLR)
If the user wishes to model no efficiency degradation due to compressor cycling, the part load
fraction correlation should be defined as follows:
PLF = 1.0 + 0.0(PLR)
Field: Defrost Energy Input Ratio Function of Temperature Curve Name
This alpha field defines the name of a bi-quadratic performance curve (ref: Performance
Curves) that parameterizes the variation of the energy input ratio (EIR) during reverse-cycle
defrost periods as a function of the outdoor air dry-bulb temperature and the wet-bulb
temperature of the air entering the indoor coil. The EIR is the inverse of the COP. The output
of this curve is multiplied by the coil capacity, the fractional defrost time period and the
runtime fraction of the heating coil to give the defrost power at the specific temperatures at
which the indoor and outdoor coils are operating. This curve is only required when a reversecycle defrost strategy is selected. The curve is normalized to a value of 1.0 at the rating point
conditions.
Field: Minimum Outdoor Dry-Bulb Temperature for Compressor Operation
This numeric field defines the minimum outdoor air dry-bulb temperature where the heating
coil compressor turns off. The temperature for this input field must be greater than or equal to
20 C. If this input field is left blank, the default value is -8 C.
Field: Outdoor Dry-Bulb Temperature to Turn On Compressor
This numeric field defines the outdoor air dry-bulb temperature when the compressor is
automatically turned back on following an automatic shut off because of low outdoor
temperature. This field is only used for the calculation heating seasonal performance factor
(HSPF) of heating coil. If this field is not provided, outdoor bin temperature is always
considered to be greater than this temperature and Minimum Outdoor dry-bulb Temperature
for Compressor Operation field described above.
Field: Maximum Outdoor Dry-Bulb Temperature for Defrost Operation
This numeric field defines the outdoor air dry-bulb temperature above which outdoor coil
defrosting is disabled. The temperature for this input field must be greater than or equal to 0
C and less than or equal to 7.22 C. If this input field is left blank, the default value is 5 C.

9/29/14

1413

Input-Output Reference

Group Heating and Cooling Coils

Field: Crankcase Heater Capacity

This numeric field defines the crankcase heater capacity in Watts. When the outdoor air drybulb temperature is below the value specified in the input field Maximum Outdoor Dry-bulb
Temperature for Crankcase Heater Operation (described below), the crankcase heater is
enabled during the time that the compressor is not running. If this heating coil is used as part
of an air-to-air heat pump (Ref. AirLoopHVAC:UnitaryHeatPump:AirToAir or
ZoneHVAC:PackagedTerminalHeatPump), the crankcase heater defined for this DX heating
coil is enabled during the time that the compressor is not running for either heating or cooling
(and the crankcase heater power defined in the DX cooling coil object is disregarded in this
case). The value for this input field must be greater than or equal to 0. If this input field is left
blank, the default value is 0. To simulate a unit without a crankcase heater, enter a value of 0.
Field: Maximum Outdoor Dry-Bulb Temperature for Crankcase Heater Operation
This numeric field defines the outdoor air dry-bulb temperature above which the compressors
crankcase heater is disabled. The value for this input field must be greater than or equal to
0.0 C. If this input field is left blank, the default value is 10 C.
Field: Defrost Strategy
This alpha field has two choices: reverse-cycle or resistive. If the reverse-cycle strategy is
selected, the heating cycle is reversed periodically to provide heat to melt frost accumulated
on the outdoor coil. If a resistive defrost strategy is selected, the frost is melted using an
electric resistance heater. If this input field is left blank, the default defrost strategy is reversecycle.
Field: Defrost Control
This alpha field has two choices: timed or on-demand. If timed control is selected, the defrost
time period is calculated based on a fixed value or compressor runtime whether or not frost
has actually accumulated. For timed defrost control, the fractional amount of time the unit is
in defrost is entered in the input field Defrost Time Period Fraction described below. If ondemand defrost control is selected, the defrost time period is calculated based on outdoor
weather (humidity ratio) conditions. Regardless of which defrost control is selected, defrost
does not occur above the user specified outdoor temperature entered in the input field
Maximum Outdoor Dry-bulb Temperature for Defrost Operation described above. If this
input field is left blank, the default defrost control is timed.
Field: Defrost Time Period Fraction
This numeric field defines the fraction of compressor runtime when the defrost cycle is active,
and only applies to timed defrost (see Defrost Control input field above). For example, if the
defrost cycle is active for 3.5 minutes for every 60 minutes of compressor runtime, then the
user should enter 3.5/60 = 0.058333. The value for this input field must be greater than or
equal to 0. If this input field is left blank, the default value is 0.058333.
Field: Resistive Defrost Heater Capacity
This numeric field defines the capacity of the resistive defrost heating element in Watts. This
input field is used only when the selected defrost strategy is resistive (see input field Defrost
Strategy above). The value for this input field must be greater than or equal to 0. If this input
field is left blank, the default value is 0.
Field: Region Number
This optional numeric field defines the region number which is used to calculate HSPF of
heating coil. The value for this input field must be between 1 and 6. If this input field is left
blank, the default value is 4.

9/29/14

1414

Input-Output Reference

Group Heating and Cooling Coils

Field: Evaporator Air Inlet Node Name

This optional alpha field specifies the outdoor air node name used to define the conditions of
the air entering the outdoor evaporator. If this field is left blank, the outdoor air temperature
entering the evaporator is taken directly from the weather data. If this field is not blank, the
node name specified must also be specified in an OutdoorAir:Node object where the height of
the node is taken into consideration when calculating outdoor air temperature from the
weather data. Alternately, the node name may be specified in an OutdoorAir:NodeList object
where the outdoor air temperature is taken directly from the weather data.
Following is an example input for the object.
Coil:Heating:DX:SingleSpeed,
Heat Pump DX Heating Coil 1,
! Name of heating coil
FanAndCoilAvailSched,
! Heating coil schedule
35000,
! Gross Rated Heating Capacity
2.75,
! Gross Rated Heating COP
1.7,
!rated air flow rate (m3/s)
,
!rated evaporator fan power per volume flow rate (m3/s)
Heating Coil Air Inlet Node,
!heating coil air side inlet node
SuppHeating Coil Air Inlet Node, !Heating coil air side outlet node
HPACHeatCapFT,
! heating cap modifier curve (temperature, C)
HPACHeatCapFFF, ! heating cap modifier curve (flow fraction)
HPACHeatEIRFT,
! energy input ratio modifier curve (temperature, C)
HPACHeatEIRFFF, ! energy input ratio modifier curve (flow fraction)
HPACCOOLPLFFPLR, ! part load fraction modifier curve (function of part load ratio)
,
! defrost EIR modifier curve (temp, C) not required for resistive defrost
-5.0,
! minimum OAT for compressor operation (C)
,
! outdoor dry-bulb temperature to turn on compressor (C)
5.0,
! maximum outdoor dry-bulb temp for defrost operation (C)
200.0,
! Crankcase heater capacity (W)
10.0,
! Maximum outdoor temp for crankcase heater operation (C)
Resistive,
! Defrost strategy (resistive or reverse-cycle)
Timed,
! Defrost control (timed or on-demand)
0.166667,
! Defrost time period fraction (used for timed defrost control only)
20000;! Resistive defrost heater capacity (used for resistive defrost strategy only)

DX Heating Coil Outputs

HVAC,Average,Heating Coil Total Heating Rate [W]
HVAC,Sum,Heating Coil Total Heating Energy [J]
HVAC,Average,Heating Coil Electric Power[W]
HVAC,Sum,Heating Coil Electric Energy [J]
HVAC,Average,Heating Coil Defrost Electric Power[W]
HVAC,Sum,Heating Coil Defrost Electric Energy [J]
HVAC,Average,Heating Coil Crankcase Heater Electric Power[W]
HVAC,Sum,Heating Coil Crankcase Heater Electric Energy [J]
HVAC,Average,Heating Coil Runtime Fraction []

Heating Coil Total Heating Rate [W]

This field is the total heating rate output of the DX coil in Watts. This is determined by the coil
inlet and outlet air conditions and the air mass flow rate through the coil.
Heating Coil Total Heating Energy [J]
This is the total heating output of the DX coil in Joules over the timestep being reported. This
is determined by the coil inlet and outlet air conditions and the air mass flow rate through the
coil. This output is also added to a meter with Resource Type = EnergyTransfer, End Use
Key = CoolingCoils, Group Key = System (ref. Output:Meter objects).

9/29/14

1415

Input-Output Reference

Group Heating and Cooling Coils

Heating Coil Electric Power [W]

This output is the electricity consumption rate of the DX coil compressor and outdoor fan(s) in
Watts. This rate is applicable when the unit is providing heating to the conditioned zone(s),
and excludes periods when the unit is in reverse-cycle defrost mode.
Heating Coil Electric Energy [J]
This is the electricity consumption of the DX coil compressor and condenser fan(s) in Joules
for the timestep being reported. This consumption is applicable when the unit is providing
heating to the conditioned zone(s), and excludes periods when the unit is in reverse-cycle
defrost mode. This output is also added to a meter with Resource Type = Electricity, End Use
Key = Cooling, Group Key = System (ref. Output:Meter objects).
Heating Coil Defrost Electric Power [W]
This is the electricity consumption rate of the DX coil unit in Watts when the unit is in defrost
mode (reverse-cycle or resistive).
Heating Coil Defrost Electric Energy [J]
This is the electricity consumption of the DX coil unit in Joules for the timestep being
reported. This consumption is applicable when the unit is in defrost mode (reverse-cycle or
resistive).
Heating Coil Crankcase Heater Electric Power [W]
This is the average electricity consumption rate of the DX coil compressors crankcase heater
in Watts for the timestep being reported.
Heating Coil Crankcase Heater Electric Energy [J]
This is the electricity consumption of the DX coil compressors crankcase heater in Joules for
the timestep being reported. This output is also added to a meter with Resource Type =
Electricity, End Use Key = Miscellaneous, Group Key = System (ref. Output:Meter objects).
Heating Coil Runtime Fraction []
This is the runtime fraction of the DX heating coil compressor and outdoor fan(s) for the
timestep being reported.
Coil:Heating:DX:MultiSpeed
Coil:Heating:DX:MultiSpeed
This component models a DX heating unit with multiple discrete levels of heating capacity.
Currently,
this
heating
coil
can
only
be
referenced
by
a
AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed compound object. The multispeed DX
heating coil can have from two to four operating speeds. When the coil operates at Speed 1
(the lowest speed), its performance is very similar to the Coil:Heating:DX:SingleSpeed object
where the impacts of part-load ratio can be included. When the coil operates at higher
speeds (above Speed 1), the linear approximation methodology is applied. The coil outputs at
two consecutive speeds are linearly interpolated to meet the required heating capacity during
an HVAC system timestep. When the coil performs above the lowest speed, the user can
choose if they want to include part-load ratio impacts at the higher speeds.
The multispeed unit is described by specifying the performance at different operating speeds.
Each speed has its own set of input specifications: full load capacity, COP and air flow rate at
rated conditions, along with modifier curves to determine performance when actual operating
conditions are different from the rated conditions.
The coil operates to meet the sensible capacity being requested. When this requested
capacity is above the sensible capacity of the highest operating speed, the coil runs
continuously at the highest speed. When the requested capacity is between the sensible
9/29/14

1416

Input-Output Reference

Group Heating and Cooling Coils

capacities of two consecutive speeds, the unit will operate a portion of the time at each speed
to meet the request. When the requested capacity is less than the low speed (Speed 1)
capacity, the unit will cycle on/off as needed.
The next input defines the minimum outdoor dry-bulb temperature where the compressor will
operate. The followed two inputs are related to crankcase heater operation: capacity and
maximum outdoor dry-bulb temperature for crankcase heater operation. The next six inputs
cover defrost operation: defrost EIR modifier curve, the maximum outdoor dry-bulb
temperature for defrost operation, the type of defrost strategy (reverse-cycle or resistive),
defrost control (timed or on-demand), the fractional defrost time period (timed defrost control
only), and the resistive defrost heater capacity if a resistive defrost strategy is selected. The
activation of defrost is dependent on outdoor conditions. The capacity reduction and energy
use modification are independent of speed. The defrost EIR modifier is described below:
The defrost energy input ratio (EIR) modifier curve (function of temperature) is a bi-quadratic
curve with two independent variables: outdoor air dry-bulb temperature and the heating coil
entering air wet-bulb temperature. The output of this curve is multiplied by the heating coil
capacity, the fractional defrost time period and the runtime fraction of the heating coil to give
the defrost power at the specific temperatures at which the coil is operating. This curve is
only required when a reverse-cycle defrost strategy is specified.
The next input allows the user to choose whether to apply the part load fraction correlation to
speeds greater than 1 or not. The following input is the type of fuel.
Then the number of speed for heating is entered. The rest of inputs are speed dependent.
Each set of data consists of gross rated heating capacity, gross rated COP, and the rated air
volume flow rate. These three inputs determine the coil performance at the rating point
(outdoor air dry-bulb temperature of 8.33C, outdoor air wet-bulb temperature of 6.11C, coil
entering air dry-bulb temperature of 21.11C, coil entering air wet-bulb temperature of
15.55C). The rated air volume flow rate should be between .00004027 m3/s and .00006041
m3/s per watt of gross rated heating capacity. The rated waste heat fraction is needed to
calculate how much waste heat is available at the rated conditions. In addition, up to 6
modifier curves are required per speed.
1) The heating capacity modifier curve (function of temperature) can be a function of
both the outdoor and indoor air dry-bulb temperature or only the outdoor air dry-bulb
temperature. User has the choice of a bi-quadratic curve with two independent
variables or a quadratic curve as well as a cubic curve with a single independent
variable. The bi-quadratic curve is recommended if sufficient manufacturer data is
available as it provides sensitivity to the indoor air dry-bulb temperature and a more
realistic output. The output of this curve is multiplied by the gross rated heating
capacity to give the gross total heating capacity at specific temperature operating
conditions (i.e., at an outdoor or indoor air temperature different from the rating point
temperature).
2) The heating capacity modifier curve (function of flow fraction) is a quadratic or cubic
curve with the independent variable being the ratio of the actual air flow rate across
the heating coil to the rated air flow rate (i.e., fraction of full load flow). The output of
this curve is multiplied by the gross rated heating capacity and the heating capacity
modifier curve (function of temperature) to give the gross heating capacity at the
specific temperature and air flow conditions at which the coil is operating.
3) The energy input ratio (EIR) modifier curve (function of temperature) can be a
function of both the outdoor and indoor air dry-bulb temperature or only the outdoor
air dry-bulb temperature. User has the choice of a bi-quadratic curve with two
independent variables or a quadratic curve as well as a cubic curve with a single
independent variable. The bi-quadratic curve is recommended if sufficient
manufacturer data is available as it provides sensitivity to the indoor air dry-bulb
temperature and a more realistic output. The output of this curve is multiplied by the
rated EIR (inverse of the rated COP) to give the EIR at specific temperature

9/29/14

1417

Input-Output Reference

Group Heating and Cooling Coils

operating conditions (i.e., at an outdoor or indoor air temperature different from the
rating point temperature).
4) The energy input ratio (EIR) modifier curve (function of flow fraction) is a quadratic or
cubic curve with the independent variable being the ratio of the actual air flow rate
across the heating coil to the rated air flow rate (i.e., fraction of full load flow). The
output of this curve is multiplied by the rated EIR (inverse of the rated COP) and the
EIR modifier curve (function of temperature) to give the EIR at the specific
temperature and air flow conditions at which the coil is operating.
5) The part load fraction correlation (function of part load ratio) is a quadratic or cubic
curve with the independent variable being part load ratio (sensible heating load /
steady-state heating capacity). The output of this curve is used in combination with
the rated EIR and EIR modifier curves to give the effective EIR for a given
simulation timestep. The part load fraction correlation accounts for efficiency losses
due to compressor cycling.
6) The waste heat modifier curve (function of temperature) is a bi-quadratic curve with
two independent variables: outdoor air dry-bulb temperature and the heating coil
entering air dry-bulb temperature. The output of this curve is multiplied by the heating
input energy, the waste heat fraction of heat input to give the recoverable waste heat.
The curves are simply specified by name. Curve inputs are described in the curve manager
section of this document (ref. Performance Curves).
Field: Name
This alpha field defines a unique user-assigned name for an instance of a multispeed DX
heating coil. Any reference to this DX heating coil by another object will use this name. The
only allowed parent is AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed.
Field: Availability Schedule Name
This alpha field defines the name of the schedule (ref: Schedule) that denotes whether the
multispeed DX heating coil can run during a given time period. A schedule value greater than
0 (usually 1 is used) indicates that the unit can be on during the time period. A value less
than or equal to 0 (usually 0 is used) denotes that the unit must be off for the time period. If
this field is blank, the schedule has values of 1 for all time periods.
Field: Air Inlet Node name
This alpha field defines the name of the HVAC system node from which the DX heating coil
draws its inlet air.
Field: Air Outlet Node Name
This alpha field defines the name of the HVAC system node to which the DX heating coil
sends its outlet air.
Field: Minimum Outdoor Dry-Bulb Temperature for Compressor Operation
This numeric field defines the minimum outdoor air dry-bulb temperature where the heating
coil compressor turns off. The temperature for this input field must be greater than or equal to
20C. If this input field is left blank, the default value is -8C.
Field: Crankcase Heater Capacity
This numeric field defines the crankcase heater capacity in Watts. When the outdoor air drybulb temperature is below the value specified in the input field Maximum Outdoor Dry-bulb
Temperature for Crankcase Heater Operation (described below), the crankcase heater is
enabled during the time that the compressor is not running. The value for this input field must
be greater than or equal to 0. If this input field is left blank, the default value is 0. To simulate
a unit without a crankcase heater, enter a value of 0.

9/29/14

1418

Input-Output Reference

Group Heating and Cooling Coils

Field: Maximum Outdoor Dry-Bulb Temperature for Crankcase Heater Operation

This numeric field defines the outdoor air dry-bulb temperature above which the compressors
crankcase heater is disabled. The value for this input field must be greater than or equal to
0.0C. If this input field is left blank, the default value is 10C.
Field: Defrost Energy Input Ratio Function of Temperature Curve Name
This alpha field defines the name of a bi-quadratic performance curve (ref: Performance
Curves) that parameterizes the variation of the energy input ratio (EIR) during reverse-cycle
defrost periods as a function of the outdoor air dry-bulb temperature and the wet-bulb
temperature of the air entering the indoor coil. The EIR is the inverse of the COP. The output
of this curve is multiplied by the coil capacity, the fractional defrost time period and the
runtime fraction of the heating coil to give the defrost power at the specific temperatures at
which the indoor and outdoor coils are operating. This curve is only required when a reversecycle defrost strategy is selected. The curve is normalized to a value of 1.0 at the rating point
conditions.
Field: Maximum Outdoor Dry-Bulb Temperature for Defrost Operation
This numeric field defines the outdoor air dry-bulb temperature above which outdoor coil
defrosting is disabled. The temperature for this input field must be greater than or equal to
0C and less than or equal to 7.22C. If this input field is left blank, the default value is 5C.
Field: Defrost Strategy
This alpha field has two choices: reverse-cycle or resistive. If the reverse-cycle strategy is
selected, the heating cycle is reversed periodically to provide heat to melt frost accumulated
on the outdoor coil. If a resistive defrost strategy is selected, the frost is melted using an
electric resistance heater. If this input field is left blank, the default defrost strategy is reversecycle.
Field: Defrost Control
This alpha field has two choices: timed or on-demand. If timed control is selected, the defrost
time period is calculated based on a fixed value or compressor runtime whether or not frost
has actually accumulated. For timed defrost control, the fractional amount of time the unit is
in defrost is entered in the input field Defrost Time Period Fraction described below. If ondemand defrost control is selected, the defrost time period is calculated based on outdoor
weather (humidity ratio) conditions. Regardless of which defrost control is selected, defrost
does not occur above the user specified outdoor temperature entered in the input field
Maximum Outdoor Dry-bulb Temperature for Defrost Operation described above. If this
input field is left blank, the default defrost control is timed.
Field: Defrost Time Period Fraction
This numeric field defines the fraction of compressor runtime when the defrost cycle is active,
and only applies to timed defrost (see Defrost Control input field above). For example, if the
defrost cycle is active for 3.5 minutes for every 60 minutes of compressor runtime, then the
user should enter 3.5/60 = 0.058333. The value for this input field must be greater than or
equal to 0. If this input field is left blank, the default value is 0.058333.
Field: Resistive Defrost Heater Capacity
This numeric field defines the capacity of the resistive defrost heating element in Watts. This
input field is used only when the selected defrost strategy is resistive (see input field Defrost
Strategy above). The value for this input field must be greater than or equal to 0. If this input
field is left blank, the default value is 0.
Field: Apply Part Load Fraction to Speeds Greater than 1
This field determines whether part-load impacts on coil energy use are applied when the coil
is operating at speeds greater than speed 1. The allowed choices are Yes or No, with the
9/29/14

1419

Input-Output Reference

Group Heating and Cooling Coils

default being No if this field is left blank. Other input fields in this object allow the user to
specify a part-load fraction correlation for each speed to account for compressor start up
losses (cycle on/off). For the case of a single multi-speed compressor, the part load losses
may only be significant when the compressor cycles between speed 1 and off, but the losses
may be extremely small when the compressor operates between speed 1 and speed 2 (or
between speeds 2 and 3, etc.). In this case, the user may chose to specify No for this input
field to neglect part-load impacts on energy use at higher operating speeds. If part-load
impacts on coil energy use are thought to be significant (e.g., interwined cooling coil with
multiple compressors feeding individual refrigerant circuits), then the user may chose to
specify Yes and the part-load fraction correlations specified for speeds 2 through 4 will be
applied as appropriate. The selection for this input field does not affect part-load impacts
when the compressor cycles between speed 1 and off (i.e., the part-load fraction correlation
for speed 1 is always applied).
Field: Fuel Type
This alpha field determines the type of fuel that the chiller uses. This field has seven choices:
Electricity, NaturalGas, PropaneGas, Coal, Diesel, Gasoline, FuelOil#1, FuelOil#2,
OtherFuel1 and OtherFuel2. The default is NaturalGas.
Field: Number of Speeds
This field specifies the number of sets of data being entered for rated specifications,
performance curves, and waste heat specifications for each cooling speed. The rated
specifications consist of gross rated capacity, gross rated COP, and rated air flow rate. The
performance curves consist of a total capacity modifier curve as a function of temperature,
total capacity modifier curve as a function of flow fraction, energy input ratio modifier curve as
a function of temperature, energy input ratio modifier curve as a function of flow fraction, and
part load fraction correlation as a function of part load ratio. The waste heat specifications
include the fraction of energy input to the heating coil at the fully loaded and rated conditions,
and a temperature modifier. The minimum number of speeds for heating is 2 and the
maximum number is 4. The number of speeds should be the same as the number of speeds
for
heating
defined
in
its
parent
object
(AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed). The first set of performance inputs is
for Speed 1 and should be for low speed, and the last set of performance inputs should be for
high speed. For example, if only three heating speeds are defined, the first set should be for
low speed (Speed 1), the second set should be for medium speed (Speed 2), and the third
set should be for high speed (Speed 3). In this example, any performance inputs for Speed 4
would be neglected (since this input field specifies that the coil only has three heating
speeds).
Field Group: Rated Specification, Performance Curves, and Waste Heat Data
The performance for each heating speed must be specified as shown below. All inputs for
Speed 1 are required first, followed by the inputs for Speed 2, Speed 3 and Speed 4.
Field: Speed <x> Gross Rated Heating Capacity
This numeric field defines the total, full load gross heating capacity in watts of the DX coil unit
at rated conditions for Speed <x> operation (outdoor air dry-bulb temperature of 8.33C,
outdoor air wet-bulb temperature of 6.11C, heating coil entering air dry-bulb temperature of
21.11C, heating coil entering air wet-bulb temperature of 15.55C, and a heating coil air flow
rate defined by field Rated Air Flow Rate, Speed <x> below). The value entered here must
be greater than 0. The gross heating capacity should not account for the effect of supply air
fan heat.
Field: Speed <x> Gross Rated Heating COP
This numeric field defines the coefficient of performance (COP=gross heating capacity in
watts divided by electrical power input in watts) of the DX heating coil unit at rated conditions
9/29/14

1420

Input-Output Reference

Group Heating and Cooling Coils

for Speed <x> operation (outdoor air dry-bulb temperature of 8.33C, outdoor air wet-bulb
temperature of 6.11C, coil entering air dry-bulb temperature of 21.11C, coil entering air wetbulb temperature of 15.55C, and a heating coil air flow rate defined by field Speed <x>
Rated Air Flow Rate below). The value entered here must be greater than 0. The input
power includes power for the compressor(s) and outdoor fan(s) but does not include the
power consumption of the indoor supply air fan. The gross heating capacity is the value
entered above in the field Gross Rated Heating Capacity. The gross COP should NOT
account for the supply air fan.
Field: Speed <x> Rated Air Flow Rate
This numeric field defines the volume air flow rate, in m 3 per second, across the DX heating
coil at rated conditions for Speed <x> operation. The value entered here must be greater than
0. The rated air volume flow rate should be between 0.00004027 m3/s and 0.00006041 m 3/s
per watt of gross rated heating capacity. The gross rated heating capacity and gross rated
COP should be performance information for the unit with outdoor air dry-bulb temperature of
8.33C, outdoor air wet-bulb temperature of 6.11C, heating coil entering air dry-bulb
temperature of 21.11C, heating coil entering air wet-bulb temperature of 15.55C, and the
rated air volume flow rate defined here.
Field: Speed <x> Heating Capacity Function of Temperature Curve Name
This alpha field defines the name of a bi-quadratic, quadratic or cubic performance curve for
Speed <x> (ref: Performance Curves) that parameterizes the variation of the total heating
capacity as a function of the both the indoor and outdoor air dry-bulb temperature or just the
outdoor air dry-bulb temperature depending on the type of curve selected. The bi-quadratic
curve is recommended if sufficient manufacturer data is available as it provides sensitivity to
the indoor air dry-bulb temperature and a more realistic output. The output of this curve is
multiplied by the gross rated heating capacity to give the gross total heating capacity at
specific temperature operating conditions (i.e., at an indoor air dry-bulb temperature or
outdoor air dry-bulb temperature different from the rating point temperature). The curve is
normalized to have the value of 1.0 at the rating point.
Field: Speed <x> Heating Capacity Function of Flow Fraction Curve Name
This alpha field defines the name of a quadratic or cubic performance curve for Speed <x>
(ref: Performance Curves) that parameterizes the variation of heating capacity as a function
of the ratio of actual air flow rate across the heating coil to the rated air flow rate (i.e., fraction
of full load flow). The output of this curve is multiplied by the gross rated heating capacity and
the gross heating capacity modifier curve (function of temperature) to give the gross heating
capacity at the specific temperature and air flow conditions at which the coil is operating. The
curve is normalized to have the value of 1.0 when the actual air flow rate equals the rated air
flow rate.
Field: Speed <x> Energy Input Ratio Function of Temperature Curve Name
This alpha field defines the name of a bi-quadratic, quadratic or cubic performance curve for
Speed <x> (ref: Performance Curves) that parameterizes the variation of the energy input
ratio (EIR) as a function of the both the indoor and outdoor air dry-bulb temperature or just
the outdoor air dry-bulb temperature depending on the type of curve selected. The biquadratic curve is recommended if sufficient manufacturer data is available as it provides
sensitivity to the indoor air dry-bulb temperature and a more realistic output. The EIR is the
inverse of the COP. The output of this curve is multiplied by the rated EIR (inverse of rated
COP) to give the EIR at specific temperature operating conditions (i.e., at an indoor air drybulb temperature or outdoor air dry-bulb temperature different from the rating point
temperature). The curve is normalized to have the value of 1.0 at the rating point.

9/29/14

1421

Input-Output Reference

Group Heating and Cooling Coils

Field: Speed <x> Energy Input Ratio Function of Flow Fraction Curve Name
This alpha field defines the name of a quadratic or cubic performance curve for Speed <x>
(ref: Performance Curves) that parameterizes the variation of the energy input ratio (EIR) as
a function of the ratio of actual air flow rate across the heating coil to the rated air flow rate
(i.e., fraction of full load flow). The EIR is the inverse of the COP. The output of this curve is
multiplied by the rated EIR and the EIR modifier curve (function of temperature) to give the
EIR at the specific temperature and air flow conditions at which the coil is operating. This
curve is normalized to a value of 1.0 when the actual air flow rate equals the rated air flow
rate.
Field: Speed <x>Part Load Fraction Correlation Curve Name
This alpha field defines the name of a quadratic or cubic performance curve for Speed <x>
(Ref: Performance Curves) that parameterizes the variation of electrical power input to the
DX unit as a function of the part load ratio (PLR, sensible cooling load/steady-state sensible
cooling capacity). The product of the rated EIR and EIR modifier curves is divided by the
output of this curve to give the effective EIR for a given simulation timestep. The part load
fraction (PLF) correlation accounts for efficiency losses due to compressor cycling.
The part load fraction correlation should be normalized to a value of 1.0 when the part load
ratio equals 1.0 (i.e., no efficiency losses when the compressor(s) run continuously for the
simulation timestep). For PLR values between 0 and 1 (0 <= PLR < 1), the following rules
apply:
PLF >= 0.7 and PLF >= PLR
If PLF < 0.7 a warning message is issued, the program resets the PLF value to 0.7, and the
simulation proceeds. The runtime fraction of the coil is defined as PLR/PLF. If PLF < PLR,
then a warning message is issued and the runtime fraction of the coil is limited to 1.0.
A typical part load fraction correlation for a conventional DX heating coil (Speed <x>) would
be:
PLF = 0.85 + 0.15(PLR)
If the user wishes to model no efficiency degradation due to compressor cycling, the part load
fraction correlation should be defined as follows:
PLF = 1.0 + 0.0(PLR)
Field: Speed <x> Rated Waste Heat Fraction of Power Input
The fraction of heat input to heating that is available as recoverable waste heat at full load
and rated conditions for Speed <x> operation.
Field: Speed <x> Waste Heat Function of Temperature Curve Name
The name of a bi-quadratic performance curve (ref: Performance Curves) that parameterizes
the variation of the waste heat recovery as a function of outdoor dry-bulb temperature and the
entering coil dry-bulb temperature for Speed <x>. The output of this curve is multiplied by the
rated recoverable waste heat at specific temperature operating conditions (i.e., at
temperatures different from the rating point). The curve is normalized to a value of 1.0 at the
rating point. When the fuel type is electricity, the field is either left blank or ignored by the
program.
Following is an example input for a multi-speed heating DX coil.

9/29/14

1422

Input-Output Reference

Group Heating and Cooling Coils

COIL:Heating:DX:MultiSpeed,
Heat Pump DX Heating Coil 1, !- Name of heat pump heating coil
FanAndCoilAvailSched,
!- Availability Schedule
Heating Coil Air Inlet Node, !- Coil Air Inlet Node
SuppHeating Coil Air Inlet Node, !- Coil Air Outlet Node
-8.0,
!- Minimum Outdoor Dry-bulb Temperature for Compressor Operation {C}
200.0,
!- Crankcase Heater Capacity {W}
10.0,
!- Maximum Outdoor Dry-bulb Temperature for Crankcase Heater Operation {C}
HPACDefrostCAPFT,
!- Defrost energy input ratio modifier curve (temperature)
7.22,
!- Maximum Outdoor Dry-bulb Temperature for Defrost Operation
reverse-cycle,
!- Defrost Strategy
timed,
!- Defrost Control
0.058333,
!- Defrost Time Period Fraction
2000.0,
!- Resistive Defrost Heater Capacity {W}
No,
!- Apply Part Load Fraction to Speeds greater than 1
NaturalGas,
!- Fuel type
4,
!- Number of speeds
7500,
!- Gross Rated Heating Capacity, Speed 1 {W}
2.75,
!- Gross Rated Heating COP, Speed 1
0.45,
!- Rated Air Flow Rate, Speed 1 {m3/s}
HPACHeatCapFT Speed 1,
!- Heating Capacity Modifier Curve, Speed 1 (temperature)
HPACHeatCapFF Speed 1,
!- Heating capacity modifier curve, Speed 1 (flow fraction)
HPACHeatEIRFT Speed 1,
!- Energy input ratio modifier curve, Speed 1 (temperature)
HPACHeatEIRFF Speed 1,
!- Energy input ratio modifier curve, Speed 1 (flow fraction)
HPACHeatPLFFPLR Speed 1, !- Part load fraction correlation, Speed 1 (part load ratio)
0.2,
!- Rated waste heat fraction of power input, Speed 1
HAPCHeatWHFT Speed 1,
!- Waste heat modifier curve, Speed 1 (temperature)
17500,
!- Gross Rated Heating Capacity, Speed 2 {W}
2.75,
!- Gross Rated Heating COP, Speed 2
0.85,
!- Rated Air Flow Rate, Speed 2 {m3/s}
HPACHeatCapFT Speed 2,
!- Heating Capacity Modifier Curve, Speed 2 (temperature)
HPACHeatCapFF Speed 2,
!- Heating capacity modifier curve, Speed 2 (flow fraction)
HPACHeatEIRFT Speed 2,
!- Energy input ratio modifier curve, Speed 2 (temperature)
HPACHeatEIRFF Speed 2,
!- Energy input ratio modifier curve, Speed 2 (flow fraction)
HPACHeatPLFFPLR Speed 2, !- Part load fraction correlation, Speed 2 (part load ratio)
0.2,
!- Rated waste heat fraction of power input, Speed 2
HAPCHeatWHFT Speed 2,
!- Waste heat modifier curve, Speed 2 (temperature)

25500,
2.75,
1.25,
HPACHeatCapFT Speed 3,
HPACHeatCapFF Speed 3,
HPACHeatEIRFT Speed 3,
HPACHeatEIRFF Speed 3,
HPACHeatPLFFPLR Speed 3,
0.2,
HAPCHeatWHFT Speed 3,
35500,
2.75,
1.75,
HPACHeatCapFT Speed 4,
HPACHeatCapFF Speed 4,
HPACHeatEIRFT Speed 4,
HPACHeatEIRFF Speed 4,
HPACHeatPLFFPLR Speed 4,
0.2,
HAPCHeatWHFT Speed 4;

!!!!!!!!!!!!!!!!!!!!-

Gross Rated Heating Capacity, Speed 3 {W}

Gross Rated Heating COP, Speed 3
Rated Air Flow Rate, Speed 3 {m3/s}
Heating Capacity Modifier Curve, Speed 3 (temperature)
Heating capacity modifier curve, Speed 3 (flow fraction)
Energy input ratio modifier curve, Speed 3 (temperature)
Energy input ratio modifier curve, Speed 3 (flow fraction)
Part load fraction correlation, Speed 3 (part load ratio)
Rated waste heat fraction of power input, Speed 3
Waste heat modifier curve, Speed 3 (temperature)
Gross Rated Heating Capacity, Speed 4 {W}
Gross Rated Heating COP, Speed 4
Rated Air Flow Rate, Speed 4 {m3/s}
Heating Capacity Modifier Curve, Speed 4 (temperature)
Heating capacity modifier curve, Speed 4 (flow fraction)
Energy input ratio modifier curve, Speed 4 (temperature)
Energy input ratio modifier curve, Speed 4 (flow fraction)
Part load fraction correlation, Speed 4 (part load ratio)
Rated waste heat fraction of power input, Speed 4
Waste heat modifier curve, Speed 4 (temperature)

MultiSpeed DX Heating Coil Outputs

HVAC,Average,Heating Coil Total Heating Rate [W]
HVAC,Sum,Heating Coil Total Heating Energy [J]
HVAC,Average,Heating Coil Electric Power[W]
HVAC,Sum,Heating Coil Electric Energy [J]
HVAC,Average,Heating Coil Defrost Electric Power[W]
9/29/14

1423

Input-Output Reference

Group Heating and Cooling Coils

HVAC,Sum,Heating Coil Defrost Electric Energy [J]

HVAC,Average,Heating Coil Defrost Gas Rate [W]
HVAC,Sum,Heating Coil Defrost Gas Energy [J]
HVAC,Average,Heating Coil Crankcase Heater Electric Power[W]
HVAC,Sum,Heating Coil Crankcase Heater Electric Energy [J]
HVAC,Average,Heating Coil Runtime Fraction []
If Fuel Type is not Electricity:
HVAC,Average, Heating Coil <Fuel Type> Rate [W]
HVAC,Sum, Heating Coil <Fuel Type> Energy [J]

Heating Coil Total Heating Rate [W]

This field is the total heating rate output of the DX coil in Watts. This is determined by the coil
inlet and outlet air conditions and the air mass flow rate through the coil.
Heating Coil Total Heating Energy [J]
This is the total heating output of the DX coil in Joules over the timestep being reported. This
is determined by the coil inlet and outlet air conditions and the air mass flow rate through the
coil. This output is also added to a meter with Resource Type = EnergyTransfer, End Use
Key = HeatingCoil, Group Key = System (ref. Output:Meter objects).
Heating Coil Electric Power [W]
This output variable is the input fuel type power for the heating coil in the unit of Watts,
averaged during the report period. If Fuel Type is not Electricity, the value is zero.
Cooling Coil Electric Energy [J]
This output variable is the input fuel type consumption for the multispeed heating coil in the
unit of Joules, summed during the report period. This output is also added to a meter with
Resource Type = Electricity, End Use Key = Heating, Group Key = System (ref. Output:Meter
objects). If Fuel Type is not Electricity, the value is zero.
Heating Coil Defrost Electric Power [W]
This is the electricity consumption rate of the DX coil unit in Watts when the unit is in defrost
mode (reverse-cycle or resistive). The variable is available when the defrost mode is resistive
or the fuel type is electricity.
Heating Coil Defrost Electric Energy [J]
This is the electricity consumption of the DX coil unit in Joules for the timestep being
reported. This consumption is applicable when the unit is in defrost mode (reverse-cycle or
resistive). The variable is available when the defrost mode is resistive or the fuel type is
electricity.
Heating Coil Defrost <Fuel Type> Rate [W]
This is the fuel consumption rate of the DX coil unit in Watts when the unit is in defrost mode
(reverse-cycle). The variable is available when the defrost mode is reverse-cycle and the fuel
type is non-electricity.
Heating Coil Defrost <Fuel Type> Energy [J]
This is the fuel consumption of the DX coil unit in Joules for the timestep being reported. This
consumption is applicable when the unit is in defrost mode (reverse-cycle). The variable is
available when the defrost mode is reverse-cycle and the fuel type is non-electricity.
Heating Coil Crankcase Heater Electric Power [W]
This is the average electricity consumption rate of the DX coil compressors crankcase heater
in Watts for the timestep being reported. When a companion cooling coil exits, the crankcase
heater power of the companion cool coil is alos reported in this variable.
9/29/14

1424

Input-Output Reference

Group Heating and Cooling Coils

Heating Coil Crankcase Heater Electric Energy [J]

This is the electricity consumption of the DX coil compressors crankcase heater in Joules for
the timestep being reported. This output is also added to a meter with Resource Type =
Electricity, End Use Key = Heating, Group Key = System (ref. Output:Meter objects). When a
companion cooling coil exits, the crankcase heater power of the companion cool coil is alos
reported in this variable.
Heating Coil Runtime Fraction []
This is the runtime fraction of the DX heating coil compressor and outdoor fan(s) for the
timestep being reported. When the heating speed is above 1, this output is the run time
fraction for the higher speed.
Heating Coil <Fuel Type> Rate [W]
This output variable is the input fuel type power for the heating coil in the unit of Watts,
averaged during the report period. The electric power is excluded. If Fuel Type is Electricity,
this output variable is not reported.
Cooling Coil <Fuel Type> Energy [J]
This output variable is the input fuel type consumption for the multispeed heating coil in the
unit of Joules, summed during the report period. The electric consumption is excluded. This
output is also added to a meter with Resource Type = <Fuel Type>, End Use Key = Heating,
Group Key = System (ref. Output:Meter objects). If Fuel Type is Electricity, this output
variable is not reported.
Note: The Fuel Type defined in the above two output variables depends on the input in the fuel type filed.
In addition to Electricity, Valid fuel types are NaturalGas, Propane, FuelOil#1, FuelOil#2, Coal, Diesel,
Gasoline, OtherFuel1 and OtherFuel2.

Coil:Heating:DX:VariableSpeed
The Variable-Speed Air-to-Air Heating DX Coil is a collection of performance curves that
represent the heating coil at various speed levels. The performance curves should be
generated from the heat pump Reference Unit catalog data. This is an equation-fit model that
resembles a black box with no usage of heat transfer equations. The number of speed levels
can range from 1 to 10. The heating coil has two air side node connections. The user needs
to specify a nominal speed level, at which the gross rated capacity and rated volumetric air
flow rate are sized. The gross rated capacity and rated volumetric flow rate represent the real
situation in the air loop, and are used to determine the flow rates at various speed levels in
the
parent
objects,
e.g.
AirLoopHVAC:UnitaryHeatPump:AirToAir,
ZoneHVAC:PackagedTerminalHeatPump, etc. It shall be mentioned that the performance
correction curves, i.e. the temperature and flow fraction correction curves, should be
normalized to the capacity and flow rate at each individual speed and at the rated operating
conditions, similar to the performance curves used in the single-speed DX coil. On the other
hand, the performance values at individual speed levels, e.g. capacities, COPs and flow
rates, should be given regarding a specific unit from the Reference Unit catalog data. In the
following content, the statement started with Reference Unit means the actual Reference
Unit catalog data. The rated conditions for obtaining the capacities and COPs are at indoor
dry-bulb temperature of 21.1 C (70 F) and the source side entering air temperature of 8.3 C
(47 F). Some equations are provided below to help explain the function of the various
performance curves and data fields.
Field: Name
This alpha field contains the identifying name for the variable speed heating coil.

9/29/14

1425

Input-Output Reference

Group Heating and Cooling Coils

Field: Air Inlet Node Name

This alpha field contains the heating coil load side inlet node name.
Field: Air Outlet Node Name
This alpha field contains the heating coil load side outlet node name.
Field: Number of Speeds
This numeric field contains the maximum number of speed levels that the module uses. The
number of speeds, for which the user input the performance data and curves, has to be equal
to or higher than the maximum number. The performance inputs at higher speeds are
ignored.
Field: Nominal Speed Level
This numeric field defines the nominal speed level, at which the rated capacity, rated air and
volumetric flow rate are correlated.
Field: Gross Rated Heating Capacity at Selected Nominal Speed Level
This numeric field contains the rated capacity at the nominal speed level. This field is
autosizable. The gross rated heating capacity is used to determine a capacity scaling factor,
as compared to the Reference Unit capacity at the nominal speed level.

CapacityScaleFactor

Gross Rated Total Heating Capacity

Reference Unit Capacity@ Nominal Speed Level

And then, this scaling factor is used to determine capacities at rated conditions for other
speed levels, as below,

Gross Rated Capacity @Speed Level x

CapacityScaleFactor
Reference Unit Capacity @Speed Level(x)
Field: Rated Volumetric Air Flow Rate
This numeric field contains the rated volumetric air flow rate on the load side of the heat
pump corresponding to the nominal speed level. This field is autosizable. The value is used
to determine an internal scaling factor, and calculate the air flow rates in the parent objects.
It is recommended that the ratio of the rated volumetric air flow rate to the rated capacity is
the same as the unit performance from the Reference Unit data.

AirFlowScaleFactor

Rated Volumetric Air Flow Rate

Reference Unit Vol Air Flow Rate@ Nominal Speed Level CapacityScaleFactor

And the volumetric air flow rates in the parent objects are calculated as below,

9/29/14

1426

Input-Output Reference

Group Heating and Cooling Coils

Loop Volumetric Air Flow Rate@Speed Level x

AirFlowScaleFactor
Reference Unit Vol Air Flow Rate@Speed Level(x)
CapacityScaleFactor
Field: Part Load Fraction Correlation Curve Name
This alpha field defines the name of a quadratic or cubic performance curve (Ref:
Performance Curves) that parameterizes the variation of electrical power input to the unit as
a function of the part load ratio (PLR, heating load/steady-state heating capacity for Speed 1),
in the case that the unit operates under the lowest speed, i.e. on/off. The product of the rated
EIR and EIR modifier curves is divided by the output of this curve to give the effective EIR
for a given simulation timestep for Speed 1. The part load fraction (PLF) correlation accounts
for efficiency losses due to compressor cycling. The part load fraction correlation should be
normalized to a value of 1.0 when the part load ratio equals 1.0 (i.e., no efficiency losses
when the compressor(s) run continuously for the simulation timestep).
Field: Defrost Energy Input Ratio Function of Temperature Curve Name
This alpha field defines the name of a bi-quadratic performance curve (ref: Performance
Curves) that parameterizes the variation of the energy input ratio (EIR) during reverse-cycle
defrost periods as a function of the outdoor air dry-bulb temperature and the wet-bulb
temperature of the air entering the indoor coil. The EIR is the inverse of the COP. The output
of this curve is multiplied by the coil capacity at the maximum speed level, the fractional
defrost time period and the runtime fraction of the heating coil to give the defrost power at the
specific temperatures at which the indoor and outdoor coils are operating. This curve is only
required when a reverse cycle defrost strategy is selected. The curve is normalized to a value
of 1.0 at the rating point conditions.
Field: Minimum Outdoor Dry-Bulb Temperature for Compressor Operation
This numeric field defines the minimum outdoor air dry-bulb temperature where the heating
coil compressor turns off. If this input field is left blank, the default value is -8 C.
Field: Outdoor Dry-Bulb Temperature to Turn On Compressor
This numeric field defines the outdoor temperature when the compressor is automatically
turned back on following an automatic shut off because of low outdoor dry-bulb temperature.
This field is only used for the calculation of HSPF. If this field is not provided, then outdoor bin
temperature used in the HSPF calculation is always considered to be greater than this
temperature and 'Minimum Outdoor Dry-Bulb Temperature for Compressor Operation' field
described above. This assumption is based on AHRI standard 210/240 (2008) and can
introduce significant error in the final value of HSPF.
Field: Maximum Outdoor Dry-Bulb Temperature for Defrost Operation
This numeric field defines the outdoor air dry-bulb temperature above which outdoor coil
defrosting is disabled. The temperature for this input field must be greater than or equal to 0
C and less than or equal to 7.22 C. If this input field is left blank, the default value is 5 C.
Field: Crankcase Heater Capacity
This numeric field defines the crankcase heater capacity in Watts. When the outdoor air
drybulb temperature is below the value specified in the input field Maximum Outdoor Drybulb Temperature for Crankcase Heater Operation (described below), the crankcase heater
is enabled during the time that the compressor is not running. The value for this input field
must be greater than or equal to 0. If this input field is left blank, the default value is 0. To
simulate a unit without a crankcase heater, enter a value of 0.

9/29/14

1427

Input-Output Reference

Group Heating and Cooling Coils

Field: Maximum Outdoor Dry-Bulb Temperature for Crankcase Heater Operation

This numeric field defines the outdoor air dry-bulb temperature above which the compressors
crankcase heater is disabled. The value for this input field must be greater than or equal to
0.0 C. If this input field is left blank, the default value is 10 C.
Field: Defrost Strategy
This alpha field has two choices: reverse-cycle or resistive. If the reverse-cycle strategy is
selected, the heating cycle is reversed periodically to provide heat to melt frost accumulated
on the outdoor coil. If a resistive defrost strategy is selected, the frost is melted using an
electric resistance heater. If this input field is left blank, the default defrost strategy is reverse
cycle.
Field: Defrost Control
This alpha field has two choices: timed or on-demand. If timed control is selected, the defrost
time period is calculated based on a fixed value or compressor runtime whether or not frost
has actually accumulated. For timed defrost control, the fractional amount of time the unit is
in defrost is entered in the input field Defrost Time Period Fraction described below. If ondemand defrost control is selected, the defrost time period is calculated based on outdoor
weather (humidity ratio) conditions. Regardless of which defrost control is selected, defrost
does not occur above the user specified outdoor temperature entered in the input field
Maximum Outdoor Dry-bulb Temperature for Defrost Operation described above. If this
input field is left blank, the default defrost control is timed.
Field: Defrost Time Period Fraction
This numeric field defines the fraction of compressor runtime when the defrost cycle is active,
and only applies to timed defrost (see Defrost Control input field above). For example, if the
defrost cycle is active for 3.5 minutes for every 60 minutes of compressor runtime, then the
user should enter 3.5/60 = 0.058333. The value for this input field must be greater than or
equal to 0. If this input field is left blank, the default value is 0.058333.
Field: Resistive Defrost Heater Capacity
This numeric field defines the capacity of the resistive defrost heating element in Watts. This
input field is used only when the selected defrost strategy is resistive (see input field Defrost
Strategy above). The value for this input field must be greater than or equal to 0. If this input
field is left blank, the default value is 0.
Field Group: Rated specification and performance curves
The performance for each heating speed must be specified as shown below. They should be
directly given from the Reference Unit data. All inputs for Speed 1 are required, followed by
the optional inputs for other speeds.
Field: Speed <x> Reference Unit Gross Rated Heating Capacity
This numeric field defines the total, full load gross heating capacity in watts of the air-to-air
heating coil unit at rated conditions for Speed <x> operation. The value entered here must be
greater than 0. The gross heating capacity should not account for the effects of supply air fan
heat.
Field: Speed <x> Reference Unit Gross Rated Heating COP
This numeric field defines the coefficient of performance (COP=gross heating capacityin
watts divided by electrical power input in watts) of the heating coil unit at rated conditions for
Speed <x> operation. The value entered here must be greater than 0. The input power
includes power for the compressor(s), the outdoor coil fan and accessories, but does not
include the power consumption of the indoor supply air fan. The gross COP should NOT
account for the supply air fan.

9/29/14

1428

Input-Output Reference

Group Heating and Cooling Coils

Field: Speed <x> Reference Unit Rated Air Flow Rate

This numeric field defines the volume air flow rate, in m 3 per second, across the heating coil
at rated conditions for Speed <x> operation. The value entered here should be directly from
the Reference Unit data, corresponding to the given gross rated heating capacity and gross
rated heating COP at the speed, as above.
Field: Speed <x> Heating Capacity Function of Temperature Curve Name
This alpha field defines the name of a bi-quadratic performance curve for Speed <x> (ref:
Performance Curves) that parameterizes the variation of the total heating capacity as a
function of the indoor dry-bulb and source side entering air temperature, from the Reference
Unit. The output of this curve is multiplied by the gross rated heating capacity at the speed to
give the gross heating capacity at specific temperature operating conditions (i.e., at an indoor
air dry-bulb temperature or entering air temperature different from the rating point
temperature). It should be noted that the curve is normalized to the heating capacity at
Speed<x> from the Reference Unit data, and have the value of 1.0 at the rating point.
Field: Speed <x> Heating Capacity Function of Air Flow Fraction Curve Name
This alpha field defines the name of a quadratic or cubic performance curve for Speed <x>
(ref: Performance Curves) that parameterizes the variation of the gross heating capacity as a
function of the ratio of actual air flow rate across the heating coil to the design air flow rate
(i.e., fraction of full load flow), at Speed <x> from the Reference Unit data. The curve is
normalized to have the value of 1.0 when the actual air flow rate equals the design air flow
rate at Speed <x>.
Field: Speed <x> Energy Input Ratio Function of Temperature Curve Name
This alpha field defines the name of a bi-quadratic performance curve for Speed <x> (ref:
Performance Curves) that parameterizes the variation of the energy input ratio (EIR) as a
function of the both the indoor air dry-bulb and entering air temperatures. The EIR is the
inverse of the COP. The output of this curve is multiplied by the rated EIR (inverse of rated
COP at Speed <x> from the Reference Unit data) to give the EIR at specific temperature
operating conditions (i.e., at an indoor air dry bulb temperature or entering air temperature
different from the rating point temperature). The curve is normalized to have the value of 1.0
at the rating point.
Field: Speed <x> Energy Input Ratio Function of Air Flow Fraction Curve Name
This alpha field defines the name of a quadratic or cubic performance curve for Speed <x>
(ref: Performance Curves) that parameterizes the variation of the energy input ratio (EIR) as
a function of the ratio of actual air flow rate across the heating coil to the design air flow rate
(i.e., fraction of full load flow, at Speed <x> from the Reference Unit data). The EIR is the
inverse of the COP. This curve is normalized to a value of 1.0 when the actual air flow rate
equals the design air flow rate.
An example of this statement in an IDF is:

9/29/14

1429

Input-Output Reference

Group Heating and Cooling Coils

Coil:Heating:DX:VariableSpeed,
Heat Pump DX Heating Coil 1,
!- Name
Heating Coil Air Inlet Node,
!- Air Inlet Node Name
SuppHeating Coil Air Inlet Node, !- Air Outlet Node Name
10.0,
!- Number of Speeds {dimensionless}
10.0,
!- Nominal Speed Level {dimensionless}
35000,
!- Gross Rated Heating Capacity {W}
1.7,
!- Rated Air Flow Rate {m3/s}
HPACCOOLPLFFPLR,
!- Part Load Fraction Correlation Curve Name
,
!- Defrost Energy Input Ratio Function of Temperature Curve Name
-5.0,
!- Minimum Outdoor Dry-Bulb Temperature for Compressor Operation {C}
,
!- Outdoor Dry-Bulb Temperature to Turn Back On Compressor{C}
5.0,
!- Maximum Outdoor Dry-Bulb Temperature for Defrost Operation {C}
200.0,
!- Crankcase Heater Capacity {W}
10.0,
!- Maximum Outdoor Dry-Bulb Temperature for Crankcase Heater Operation {C}
Resistive,
!- Defrost Strategy
TIMED,
!- Defrost Control
0.166667,
!- Defrost Time Period Fraction
20000,
!- Resistive Defrost Heater Capacity {W}
1838.7,
!- Speed 1 Gross Rated Heating Capacity {w}
5.0,
!- Speed 1 Gross Rated Heating COP {dimensionless}
0.1661088,
!- Speed 1 Rated Air Flow Rate {m3/s}
HPACHeatCapFT,
!- Heating Capacity Function of Temperature Curve Name
HPACHeatCapFFF,
!- Heating Capacity Function of Flow Fraction Curve Name
HPACHeatEIRFT,
!- Energy Input Ratio Function of Temperature Curve Name
HPACHeatEIRFFF,
!- Energy Input Ratio Function of Flow Fraction Curve Name
2295.5,
!- Speed 2 Gross Rated Heating Capacity {w}
5.0,
!- Speed 2 Gross Rated Heating COP {dimensionless}
0.179322,
!- Speed 2 Rated Air Flow Rate {m3/s}
HPACHeatCapFT,
!- Heating Capacity Function of Temperature Curve Name
HPACHeatCapFFF,
!- Heating Capacity Function of Flow Fraction Curve Name
HPACHeatEIRFT,
!- Energy Input Ratio Function of Temperature Curve Name
HPACHeatEIRFFF,
!- Energy Input Ratio Function of Flow Fraction Curve Name
2751.3,
!- Speed 3 Gross Rated Heating Capacity {w}
5.0,
!- Speed 3 Gross Rated Heating COP {dimensionless}
0.1925352,
!- Speed 3 Rated Air Flow Rate {m3/s}
HPACHeatCapFT,
!- Heating Capacity Function of Temperature Curve Name
HPACHeatCapFFF,
!- Heating Capacity Function of Flow Fraction Curve Name
HPACHeatEIRFT,
!- Energy Input Ratio Function of Temperature Curve Name
HPACHeatEIRFFF,
!- Energy Input Ratio Function of Flow Fraction Curve Name
3659.6,
!- Speed 4 Gross Rated Heating Capacity {w}
5.0,
!- Speed 4 Gross Rated Heating COP {dimensionless}
0.2189616,
!- Speed 4 Rated Air Flow Rate {m3/s}
HPACHeatCapFT,
!- Heating Capacity Function of Temperature Curve Name
HPACHeatCapFFF,
!- Heating Capacity Function of Flow Fraction Curve Name
HPACHeatEIRFT,
!- Energy Input Ratio Function of Temperature Curve Name
HPACHeatEIRFFF,
!- Energy Input Ratio Function of Flow Fraction Curve Name

9/29/14

1430

Input-Output Reference
4563.7,
5.0,
0.245388,
HPACHeatCapFT,
HPACHeatCapFFF,
HPACHeatEIRFT,
HPACHeatEIRFFF,
5463.3,
5.0,
0.2718144,
HPACHeatCapFT,
HPACHeatCapFFF,
HPACHeatEIRFT,
HPACHeatEIRFFF,
6358.4,
5.0,
0.2982408,
HPACHeatCapFT,
HPACHeatCapFFF,
HPACHeatEIRFT,
HPACHeatEIRFFF,
7248.5,
5.0,
0.3246672,
HPACHeatCapFT,
HPACHeatCapFFF,
HPACHeatEIRFT,
HPACHeatEIRFFF,
8133.6,
5.0,
0.3510936,
HPACHeatCapFT,
HPACHeatCapFFF,
HPACHeatEIRFT,
HPACHeatEIRFFF,
9013.2,
5.0,
0.37752,
HPACHeatCapFT,
HPACHeatCapFFF,
HPACHeatEIRFT,
HPACHeatEIRFFF;

Group Heating and Cooling Coils

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!-

Speed 5 Gross Rated Heating Capacity {w}

Speed 5 Gross Rated Heating COP {dimensionless}
Speed 5 Rated Air Flow Rate {m3/s}
Total Heating Capacity Function of Temperature Curve Name
Total Heating Capacity Function of Flow Fraction Curve Name
Energy Input Ratio Function of Temperature Curve Name
Energy Input Ratio Function of Flow Fraction Curve Name
Speed 6 Gross Rated Heating Capacity {w}
Speed 6 Gross Rated Heating COP {dimensionless}
Speed 6 Rated Air Flow Rate {m3/s}
Heating Capacity Function of Temperature Curve Name
Heating Capacity Function of Flow Fraction Curve Name
Energy Input Ratio Function of Temperature Curve Name
Energy Input Ratio Function of Flow Fraction Curve Name
Speed 7 Gross Rated Heating Capacity {w}
Speed 7 Gross Rated Heating COP {dimensionless}
Speed 7 Rated Air Flow Rate {m3/s}
Heating Capacity Function of Temperature Curve Name
Heating Capacity Function of Flow Fraction Curve Name
Energy Input Ratio Function of Temperature Curve Name
Energy Input Ratio Function of Flow Fraction Curve Name
Speed 8 Gross Rated Heating Capacity {w}
Speed 8 Gross Rated Heating COP {dimensionless}
Speed 8 Rated Air Flow Rate {m3/s}
Heating Capacity Function of Temperature Curve Name
Heating Capacity Function of Flow Fraction Curve Name
Energy Input Ratio Function of Temperature Curve Name
Energy Input Ratio Function of Flow Fraction Curve Name
Speed 9 Gross Rated Heating Capacity {w}
Speed 9 Gross Rated Heating COP {dimensionless}
Speed 9 Rated Air Flow Rate {m3/s}
Heating Capacity Function of Temperature Curve Name
Heating Capacity Function of Flow Fraction Curve Name
Energy Input Ratio Function of Temperature Curve Name
Energy Input Ratio Function of Flow Fraction Curve Name
Speed 10 Gross Rated Heating Capacity {w}
Speed 10 Gross Rated Heating COP {dimensionless}
Speed 10 Rated Air Flow Rate {m3/s}
Heating Capacity Function of Temperature Curve Name
Heating Capacity Function of Flow Fraction Curve Name
Energy Input Ratio Function of Temperature Curve Name
Energy Input Ratio Function of Flow Fraction Curve Name

Variable Speed DX Heating Coil Outputs

HVAC,Average,Heating Coil Electric Power [W]
HVAC,Average,Heating Coil Heating Rate [W]
HVAC,Average,Heating Coil Sensible Heating Rate [W]
HVAC,Average,Heating Coil Source Side Heat Transfer Rate [W]
HVAC,Average,Heating Coil Part Load Ratio []
HVAC,Average, Heating Coil Runtime Fraction []
HVAC,Average, Heating Coil Air Mass Flow Rate [kg/s]
HVAC,Average,Heating Coil Air Inlet Temperature [C]
HVAC,Average,Heating Coil Air Inlet Humidity Ratio [kgWater/kgDryAir]
HVAC,Average,Heating Coil Air Outlet Temperature [C]
HVAC,Average,Heating Coil Air Outlet Humidity Ratio [kgWater/kgDryAir]
HVAC,Average,Heating Coil Upper Speed Level []
HVAC,Average,Heating Coil Neighboring Speed Levels Ratio []
HVAC,Average,VSAirtoAirHP Recoverable Waste Heat [W]
HVAC,Sum,Heating Coil Electric Energy [J]
HVAC,Sum,Heating Coil Heating Energy [J]
HVAC,Sum,Heating Coil Source Side Heat Transfer Energy [J]
HVAC,Average,Heating Coil Defrost Electric Power [W]
HVAC,Sum,Heating Coil Defrost Electric Energy [J]
HVAC,Average,Heating Coil Crankcase Heater Electric Power[W]
HVAC,Sum,Heating Coil Crankcase Heater Electric Energy [J]

9/29/14

1431

Input-Output Reference

Group Heating and Cooling Coils

Heating Coil Electric Power [W]

This output variable is the average electric consumption rate of the heat pump in Watts over
the timestep being reported.
Heating Coil Heating Rate [W]
The output variable is the average total heating capacity provide by the heat pump in Watts
over the timestep being reported.
Heating Coil Sensible Heating Rate [W]
The output variable is the average sensible heating capacity provide by the heat pump in
Watts over the timestep being reported. For heating mode, the sensible capacity is equal to
the total capacity.
Heating Coil Source Side Heat Transfer Rate [W]
The output variable is the average heat absorbed at the heat pump evaporator in Watts over
the timestep being reported.
Heating Coil Part Load Ratio []
This output variable is the ratio of the part-load capacity to the steady state capacity of the
heating coil. For the cycling fan mode, the runtime fraction for the heat pump compressor
may be different from the compressor part-load ratio reported here due to the part-load
performance of the heating coil (delay at start-up to reach steady-state output). In general,
runtime fractions are reported by individual components where appropriate.
Heating Coil Runtime Fraction []
This output variable is the function of the part load ratio (PLR, part-load capacity/ steady state
capacity). The duty factor or part load fraction accounts for efficiency losses due to
compressor cycling.
Heating Coil Air Mass Flow Rate [kg/s]
The output variable is the average air mass flow rate on the load side going through the heat
pump over the timestep being reported.
Heating Coil Air Inlet Temperature [C]
The output variable is the average entering air dry-bulb temperature over the timestep being
reported.
Heating Coil Air Inlet Humidity Ratio [kgWater/kgDryAir]
The output variable is the average entering air dry humidity ratio over the timestep being
reported.
Heating Coil Air Outlet Temperature [C]
The output variable is the average leaving air dry-bulb temperature over the timestep being
reported.
Heating Coil Air Outlet Humidity Ratio [kgWater/kgDryAir]
The output variable is the average leaving air dry humidity ratio over the timestep being
reported.
Heating Coil Upper Speed Level []
The output variable is the average upper speed level, for interpolating performances between
two neighboring speed levels.

9/29/14

1432

Input-Output Reference

Group Heating and Cooling Coils

Heating Coil Neighboring Speed Levels Ratio []

The output variable is the average speed ratio, for interpolating performances between two
neighboring speed levels.
Heating Coil Electric Energy [J]
The output variable is the total electric consumption of the heat pump in Joules over the
timestep being reported.
Heating Coil Heating Energy [J]
The output variable is the total cooling output of the coil in Joules over the timestep being
reported.
Heating Coil Source Side Heat Transfer Energy [J]
The output variable is the total source side heat transfer of the coil in Joules over the
timestep being reported.
Heating Coil Defrost Electric Power[W]
The output variable is the average electric power used for defrosting, in Watts over the
timestep being reported.
Heating Coil Defrost Electric Energy [J]
The output variable is the total electric defrosting energy usage of the coil in Joules over the
timestep being reported.
Heating Coil Crankcase Heater Electric Power [W]
The output variable is the average power used for crankcase heater, in Watts over the
timestep being reported.
Heating Coil Crankcase Heater Electric Energy [J]
The output variable is the total electric energy usage of the coil for crankcase heater, in
Joules over the timestep being reported.
Coil:WaterHeating:Desuperheater
A simplified approach is used to determine the performance of this water heating coil. The
model assumes that the heating energy provided by this coil is reclaimed from the
superheated refrigerant gas leaving a compressor (i.e., a desuperheating refrigerant-to-water
heating coil) and does not impact the performance of the compressor. This coil must be used
with a water heater tank (e.g., WaterHeater:Mixed) which can supply heated potable water
and/or hot water for use in a plant loop (e.g., hydronic air reheat coils).
Except for detailed refrigeration system models, the amount of available superheat is simply
a percentage of the total heat being rejected by the DX systems condenser. Approximately
25-30% of the energy rejected by typical refrigeration system condensers is to reduce the
superheated refrigerant vapor temperature to the condensing temperature. Recovery
efficiencies higher than 30% may cause the refrigerant gas to condense which in turn impacts
the performance of the refrigeration system. For this reason, the maximum heat reclaim
recovery efficiency for this coil is 30% for most sources of waste heat, including refrigeration
compressor racks. The one exception to this 30% limit is a condenser that is part of a
detailed refrigeration system. In a detailed refrigeration system, the portion of the rejected
heat that lies within the superheated region is explicitly calculated. Therefore, the
desuperheater coils supplied by a condenser attached to a detailed refrigeration system are
subject to a maximum reclaim recovery efficiency of 90% of the heat within the superheated
region.
The model includes the ability to modify the heat reclaim recovery efficiency based on
variations in inlet water temperature and outdoor air dry-bulb temperature.
9/29/14

1433

Input-Output Reference

Group Heating and Cooling Coils

This coil model performs the following major functions:

calculates the amount of heat delivered to the water tank
calculates the electricity consumption of the integral water pump and on/off-cycle
parasitic loads
The input fields for this object are described below in detail:
Field: Name
This alpha field contains a unique user-assigned name for an instance of a desuperheater
water heating coil. Any reference to this desuperheater coil by another object will use this
name.
Field: Availability Schedule Name
This alpha field contains the name of the schedule (ref: Schedule) that denotes whether the
desuperheater coil is available to operate during a given time period. A schedule value equal
to 0 denotes that the desuperheater coil is off for that time period. A value other than 0
denotes that the desuperheater coil is available to operate during that time period. During
times when the desuperheater coil is scheduled off, the heater (element or burner) in the
water tank object operates based on its tank set point temperature schedule and the
desuperheater coils parasitic electric power is also off for that time period. If this field is
blank, the schedule has values of 1 for all time periods.
Field: Setpoint Temperature Schedule Name
This alpha field contains the name of the schedule (ref: Schedule) that specifies the set point
(or cut-out) temperature for the desuperheater coil. Temperature values used in this
schedule should be in degrees Celsius. The desuperheater coil turns off when the tank water
reaches this set point temperature. Once the desuperheater coil is off, the tank water
temperature floats downward until it falls below the set point temperature minus the dead
band temperature difference defined below (i.e., the cut-in temperature). At this point, the
desuperheater coil turns on and remains on until the desuperheater coil set point temperature
is reached.
Field: Dead Band Temperature Difference
This numeric field contains the dead band temperature difference in degrees Celsius. The
desuperheater coil cut-in temperature is defined as the desuperheater coil set point
temperature defined above minus this dead band temperature difference. The desuperheater
coil turns on when the water temperature in the tank falls below the cut-in temperature. The
desuperheater coil remains on until the water temperature in the tank rises above the
desuperheater coil set point (cut-out) temperature defined above. The dead band
temperature difference must be greater than 0C and less than or equal to 20C. If this field is
left blank, the default value is 5C.
Desuperheater water heating coils are typically used to offset energy consumption by the water tanks
heater (element or burner). Therefore, the cut-in temperature for the desuperheater coil (set point minus
dead band temperature difference) is usually higher than the set point temperature for the heater (element
or burner) in the associated water heater tank object. At times when the water heater tank set point
temperature is greater than the cut-in temperature of the desuperheater coil, the model disables the
desuperheater coil and the tanks heater is used to heat the water.

Field: Rated Heat Reclaim Recovery Efficiency

This numeric field defines the ratio of recovered waste heat from the superheated refrigerant
gas to the total rejected waste heat from the heating source (as if no heat reclaim occurred).
Input values must be greater than 0 up to a maximum value is 0.3 (with a defaults of 0.25)
for most sources of waste heat, including refrigeration compressor racks. The one exception
9/29/14

1434

Input-Output Reference

Group Heating and Cooling Coils

to this 0.3 limit is a source that is a condenser that is part of a detailed refrigeration system. In
a detailed refrigeration system, the portion of the rejected heat that lies within the
superheated region is explicitly calculated. Therefore, the desuperheater coils supplied by a
condenser attached to a detailed refrigeration system are subject to a maximum reclaim
recovery efficiency of 0.9. with a default value is 0.8.
Field: Rated Inlet Water Temperature
This numeric field defines the coil inlet water temperature, in degrees Celsius, that
corresponds to the rated heat reclaim recovery efficiency. Also see field Heat Reclaim
Efficiency Modifier Curve Name (function of temperature) below.
Field: Rated Outdoor Air Temperature
This numeric field defines the outdoor air dry-bulb temperature, in degrees Celsius, that
corresponds to the rated heat reclaim recovery efficiency. The outdoor air dry-bulb
temperature impacts the desuperheater coil refrigerant temperature and the amount of heat
available for reclaim. Also see field Heat Reclaim Efficiency Modifier Curve Name(function of
temperature) below.
Field: Maximum Inlet Water Temperature for Heat Reclaim
This numeric field defines the maximum coil inlet water temperature in degrees Celsius. Any
time the inlet water temperature to the desuperheater coil is above this maximum allowed
temperature, heat reclaim is restricted so that the tank water does not exceed this
temperature.
Field: Heat Reclaim Efficiency Function of Temperature Curve Name
This alpha field specifies the name of a bi-quadratic curve object (ref: Performance Curves)
that defines the variation in heat reclaim efficiency as a function of inlet fluid (air and water)
temperatures. The bi-quadratic curve uses the coil inlet water temperature and outdoor air
dry-bulb temperature (entering the DX coil condenser) as the independent variables. The
output of this curve is multiplied by the rated heat reclaim recovery efficiency to give the heat
reclaim efficiency at specific operating conditions (i.e., at temperatures different from the
rating point temperatures). The curve should be normalized to have the value of 1.0 at the
rating point temperatures. If this field is left blank, the heat reclaim efficiency remains
constant (curve value assumed to be 1.0 for all conditions). The model restricts the product of
the output of this curve and the rated heat reclaim recovery efficiency to a maximum of 0.9 for
refrigeration condenser sources and 0.3 for all other sources..
Field: Water Inlet Node Name
This alpha field defines the name of the water node from which the desuperheater heating
coil draws its inlet water. This node name must also match the source side outlet node name
for the water heater tank used with this coil (ref. Water Heaters).
Field: Water Outlet Node Name
This alpha field defines the name of the water node to which the desuperheater heating coil
sends its outlet water. This node name must also match the source side inlet node name for
the water heater tank used with this coil (ref. Water Heaters).
Field: Tank Object Type
This alpha (choice) field contains the type of water heater tank used by this desuperheater
heating coil. Currently, the only valid choice is WaterHeater:Mixed.
Field: Tank Name
This alpha field contains the name of the specific water heater tank (WaterHeater:Mixed
object) used by this desuperheater heating coil.

9/29/14

1435

Input-Output Reference

Group Heating and Cooling Coils

Field: Heating Source Object Type

This alpha (choice) field defines the source of superheated refrigerant gas from which the
desuperheater water heating coil recovers energy through heat reclaim. Valid choices are:
This alpha (choice) field defines the source of superheated refrigerant gas from which the
desuperheater water heating coil recovers energy through heat reclaim. Valid choices are:
Coil:Cooling:DX:SingleSpeed
Coil:Cooling:DX:TwoSpeed
Coil:Cooling:DX:TwoStageWithHumidityControlMode
Refrigeration:CompressorRack
Refrigeration:Condenser:AirCooled
Refrigeration:Condenser:EvaporativeCooled
Refrigeration:Condenser:WaterCooled

Field: Heating Source Name

This alpha field defines the name of the desuperheater coils heat source (e.g., the name of a
specific coil of the type mentioned in the previous field which provides waste heat to this
desuperheater water heating coil).
Field: Water Flow Rate
This numeric field defines the desuperheater coils water flow rate in cubic meters per
second. The model assumes that this flow rate is constant (throughout the simulation period)
when the desuperheater coil operates, and that it corresponds to the heat reclaim recovery
efficiency performance specified by the user. This water flow rate must be greater than zero.
Field: Water Pump Power
This numeric field defines the coils water circulation pump power in Watts. This is the
operating pump power as installed. Values must be greater than or equal to 0. If this field is
left blank, the default value is 0. A warning message will be issued if the ratio of water pump
power to desuperheater water volumetric flow rate exceeds 7.9264E6 W/m3/s, but the
simulation will continue using the user-defined values. The model assumes that this integral
pump (i.e., no need to define a separate pump object) cycles on and off with the
desuperheater heating coil.
Field: Fraction of Pump Heat to Water
This numeric field defines the fraction of water circulation pump heat that is transferred to the
water. The pump is assumed to be downstream of the desuperheater water heating coil, and
this field is used to determine the desuperheater water outlet temperature. Values must be
greater than or equal to 0 and less than or equal to 1. If this field is left blank, the default
value is 0.2.
Field: On-Cycle Parasitic Electric Load
This optional numeric field contains the on-cycle parasitic electric power in Watts. This is the
parasitic electric power consumed by controls or other electrical devices associated with the
desuperheater water heating coil. This parasitic electric load is consumed whenever the
desuperheater coil is operating, and the model assumes that this parasitic power does not
contribute to heating the water nor does it affect the zone air heat balance. The minimum
value for this field is 0.0, and the default value is also 0.0 if this field is left blank.
Field: Off-Cycle Parasitic Electric Load
This optional numeric field contains the off-cycle parasitic electric power in Watts. This is the
parasitic electric power consumed by controls or other electrical devices associated with the
desuperheater water heating coil. This parasitic electric load is consumed whenever the
desuperheater coil is available but is not operating, and the model assumes that this parasitic
power does not contribute to heating the water nor does it affect the zone air heat balance.

9/29/14

1436

Input-Output Reference

Group Heating and Cooling Coils

The minimum value for this field is 0.0, and the default value is also 0.0 if this field is left
blank.
Following is an example input for a desuperheater water heating coil.
Coil:WaterHeating:Desuperheater,
WaterHeatingCoil,
!- Coil Name
DesuperheaterSched,
!- Availability Schedule Name
DesuperheaterTempSch,
!- Desuperheater Coil Set Point Temperature Schedule Name
5.0,
!- Dead Band Temperature Difference {deltaC}
0.25,
!- Rated Heat Reclaim Recovery Efficiency
50.0,
!- Rated Inlet Water Temperature {C}
35.0,
!- Rated Outdoor Air Temperature {C}
60.0,
!- Maximum Inlet Water Temperature for Heat Reclaim {C}
HEffFTemp,
!- Heat Reclaim Efficiency Modifier Curve Name (function of temperature)
WaterHeatingCoilInletNode,
!- Desuperheater Water Inlet Node Name
WaterHeatingCoilOutletNode, !- Desuperheater Water Outlet Node Name
WaterHeater:Mixed,
!- Water Heater Tank Type
WaterHeatingCoilTank,
!- Water Heater Tank Name
Coil:Cooling:DX:SingleSpeed, !- Heating Source Type
Furnace ACDXCoil 1,
!- Heating Source Name
0.0001,
!- Desuperheater Water Volumetric Flow Rate {m3/s}
100.0,
!- Water Pump Power {W}
0.2,
!- Fraction of Pump Heat to Water
10.0,
!- On-Cycle Parasitic Electric Load {W}
10.0;
!- Off-Cycle Parasitic Electric Load {W}

WaterHeating Coil (Desuperheater) Outputs

HVAC,Average,Water Heater Part Load Ratio
HVAC,Average,Water Heater Heating Rate [W]
HVAC,Sum,Water Heater Heating Energy [J]
HVAC,Average,Water Heater Pump Electric Power [W]
HVAC,Sum,Water Heater Pump Electric Energy [J]
HVAC,Average,Water Heater Heat Reclaim Efficiency Modifier Multiplier []
HVAC,Average,Water Heater On Cycle Parasitic Electric Power [W]
HVAC,Sum,Water Heater On Cycle Parasitic Electric Energy [J]
HVAC,Average,Water Heater Off Cycle Parasitic Electric Power [W]
HVAC,Sum,Water Heater Off Cycle Parasitic Electric Energy [J]

Water Heater Part Load Ratio []This output field contains the part load ratio of the
desuperheater heating coil for the timestep being reported. This ratio represents the fraction
of the timestep that the desuperheater heating coil is operating.
Water Heater Heating Rate [W]
This output field contains the average heating rate output of the desuperheater heating coil in
Watts for the timestep being reported. This value includes the portion of circulation pump
heat attributed to heating the water.
Water Heater Heating Energy [J]
This output field contains the total heating output of the desuperheater heating coil in Joules
for the timestep being reported. This value includes the portion of circulation pump heat
attributed to heating the water.
Water Heater Pump Electric Power [W]
This output field contains the average electricity consumption rate for the water circulation
pump in Watts for the timestep being reported.

9/29/14

1437

Input-Output Reference

Group Heating and Cooling Coils

Water Heater Pump Electric Energy [J]

This output field contains the electricity consumption of the water circulation pump in Joules
for the timestep being reported. This output is also added to a meter with Resource Type =
Electricity, End Use Key= DHW, Group Key= Plant (ref. Output:Meter objects).
Water Heater Heat Reclaim Efficiency Modifier Multiplier []
This output field contains the average output of the Heat Reclaim Efficiency Modifier Curve
(function of temperature) for the timestep being reported.
Water Heater On Cycle Parasitic Electric Power [W]
Water Heater On Cycle Parasitic Electric Energy [J]
Water Heater Off Cycle Parasitic Electric Power [W]
Water Heater Off Cycle Parasitic Electric Energy [J]
These outputs are the parasitic electric power and consumption associated with the
desuperheater water heating coil. Specific outputs represent parasitic electrical usage during
the coil on and off cycles. These outputs represent electronic controls or other electric
component. The model assumes that the parasitic power does not contribute to heating the
water nor does it impact the zone air heat balance. The parasitic electric consumption outputs
are also added to a meter with Resource Type = Electricity, End Use Key = DHW, Group Key
= Plant (ref. Output:Meter objects).
CoilSystem:Cooling:DX
The CoilSystem:Cooling:DX object is a virtual container component that consists of a DX
cooling coil component and its associated controls, as shown in the Figure below. This
control object supports several different types of DX cooling coils (see field Cooling Coil
Object Type).
This component may be used as a cooling coil in constant volume or variable volume
systems, as blow through or draw through, with or without humidity controls. Unlike
AirLoopHVAC:Unitary system types, this component controls only the DX coil, not the supply
fan. CoilSystem:Cooling:DX is added to a system by placing it in an air loop branch (see
Branch object) or in an AirLoopHVAC:OutdoorAirSystem:EquipmentList or in a
ZoneHVAC:OutdoorAirUnit:EquipmentList . It requires one or more setpoint manager (see
SetpointManager:*) objects to specify temperature and/or humidity setpoints (unless it is used
in a ZoneHVAC:OutdoorAirUnit which has its own temperature setpoints). This object is the
one that is listed in the Branch or equipment list object rather than the coil itself. A constant
volume or variable volume fan is modeled separately from this cooling system. These are the
only fan types allowed for this system type (ref. Fan:ConstantVolume and
Fan:VariableVolume).
Cycling fan operation is not available with this model. The
CoilSystem:Cooling:DX object can also be placed on dedicated outdoor air system (DOAS)
airloop branches or in arloop branches where the air flow to capacity ratio range is between
100 300 cfm/ton. 100% DOAS DX cooling coils operate in lower flow to capacity ratio range
compared to regular DX cooling coils. The CoilSystem:Cooling:DX is selected to operate in
DOAS application or in low flow to capacity ratio range by specifying YES to the input field
Use Outdoor Air DX Cooling Coil. If this optional input field is left blank or specified as NO,
then the coil is modeled as regular DX cooling coil. If the CoilSystem:Cooling:DX object is in
an
AirLoopHVAC:OutdoorAirSystem:EquipmentList
or
in
a
ZoneHVAC:OutdoorAirUnit:EquipmentList then it is treated as 100% DOAS DX cooling coil
only if the choice input field Use Outdoor Air DX Cooling Coil is set too YES. All the control
options of the regular DX cooling coils are available to DOAS DX coils as well. Heating DX
coils in DOAS airloop operate at the same flow to capacity ratio limits as the DOAS DX
cooling coils.

9/29/14

1438

Input-Output Reference

Group Heating and Cooling Coils

DX System in Air Loop

Air
Loop

Fan

Dx
Cooling
Coil

Zone
Equipment

Zone
1

Zone 2
etc...

Terminal
Reheat Unit

Terminal
Reheat Unit

Figure 138. Schematic of CoilSystem:Cooling:DX Object in an Air Loop for a Blow Through Application
Field: Name
This alpha field contains the identifying name for this component.
Field: Availability Schedule Name
This alpha field contains the schedule name that contains information on the availability of the
DX coil to operate. A schedule value of 0 indicates that the coil is off for that time period. A
schedule value greater than 0 indicates that the coil can operate during the time period. If this
field is blank, the schedule has values of 1 for all time periods.
Field: DX Cooling Coil System Inlet Node Name
This alpha field contains the identifying name given to the DX cooling coil inlet node, as
specified in the DX cooling coil object.
Field: DX Cooling Coil System Outlet Node Name
This alpha field contains the identifying name given to the DX cooling coil outlet node, as
specified in the cooling coil object.
Field: DX Cooling Coil System Sensor Node Name
This alpha field contains the identifying name given to the DX cooling coil control node, this is
the node at which the temperature set point is specified by the set point manager.
Field: Cooling Coil Object Type
This alpha field specifies the type of DX cooling coil. The valid choices for this field are:
Coil:Cooling:DX:SingleSpeed
CoilSystem:Cooling:DX:HeatExchangerAssisted
Coil:Cooling:DX:TwoSpeed
Coil:Cooling:DX:TwoStageWithHumidityControlMode
Coil:Cooling:DX:VariableSpeed

9/29/14

1439

Input-Output Reference

Group Heating and Cooling Coils

Field: Cooling Coil Name

This alpha field contains the identifying name of the DX cooling coil.
As shown in the example below, correct specification of this system requires specification of
the DX Cooling Coil object in addition to the CoilSystem:Cooling:DX object.
Field: Dehumidification Control Type
This alpha field contains the type of dehumidification control. The following options are valid
for this field:
None - meet sensible load only, no active dehumidification control
MultiMode - activate enhanced dehumidification mode as needed and operate to meet
the sensible load. If a sensible load exists, the system will operate to meet that
sensible load and may not meet the latent load. If no sensible load exists, and Run
on Latent Load = Yes, the system will operate to meet the entire latent load. This
option is used to model DX equipment with a switchable option such as subcool
reheat.
It
is
valid
only
with
Cooling
coil
type=
Coil:Cooling:DX:TwoStageWithHumidityControlMode
or
CoilSystem:Cooling:DX:HeatExchangerAssisted. If the Run on Latent Load option
below is set to Yes, this option may require the use of a heating coil and heating coil
outlet air temperature set point manager downstream of this cooling coil to maintain
the temperature set point.
CoolReheat - cool beyond the dry-bulb setpoint as required to meet the humidity
setpoint.
It
is
valid
only
with
Cooling
coil
type=Coil:Cooling:DX:TwoStageWithHumidityControlMode. This option requires the
use of a heating coil and heating coil outlet air temperature set point manager
downstream of this cooling coil to maintain the temperature set point.
The default is None. For all dehumidification controls, the max humidity setpoint on the
control node is used. This must be set using a ZoneControl:Humidistat
ZoneControl:Humidistat and one of:
SetpointManager:SingleZone:Humidity:Maximum
SetpointManager:MultiZone:Humidity:Maximum
SetpointManager:MultiZone:MaximumHumidity:Average
objects and SetpointManager:OutdoorAirPretreat (optional) objects. When extra
dehumidification is required, the equipment may not be able to meet the humidity setpoint if
its full capacity is not adequate.
Field: Run on Sensible Load
This alpha field specifies if the unit will operate to meet a sensible load as determined by the
inlet node dry-bulb temperature and the dry-bulb temperature setpoint on the control node.
There are two valid choices, Yes or No. If Yes, unit will run if there is a sensible load. If No,
unit will not run if there is only a sensible load. The default is Yes.
Field: Run on Latent Load
This alpha field specifies if the unit will operate to meet a latent load as determined by the
inlet node humidity ratio and the max humidity setpoint on the control node. There are two
valid choices, Yes or No. If Yes, unit will run if there is a latent load. If both a sensible and
latent load exist, the system will operate to maintain the temperature set point. When only a
latent load exists, the system will operate to meet the humidity ratio set point and requires the
use of a heating coil and heating coil outlet air temperature set point manager downstream of
this cooling coil to maintain the temperature set point. If No, unit will not run if there is only a
latent load. The default is No.

9/29/14

1440

Input-Output Reference

Group Heating and Cooling Coils

Field: Use Outdoor Air DX Cooling Coil

This input field enables the Coil System DX Coil to be used for low air flow to capacity ratio
range ( 100 300 cfm/ton). This flow to capacity ratio range is common in 100% dedicated
outdoor air system (DOAS) applications. Other airloop or zone HVAC systems may use this
input filed if they operate at such a low flow to capacity ratio range. There are two valid
choices, Yes or No. If Yes, the DX cooling coil is forced to operate in this flow to capacity
ratio range or runs as 100% DOAS DX coil. If No, DX coil is used as regular DX coil. This
input field is optional.
Field: Outdoor Air DX Cooling Coil Leaving Minimum Air Temperature
This input field is the DX cooling coil leaving supply air minimum temperature specified for
frost control. The DX cooling coil leaving air temperature is not allowed to exceed this
minimum coil leaving air temperature. The DX cooling coil frost controller adjusts or limits the
desired coil outlet air setpoint temperature when the coil outlet temperature exceeds this
minimum temperature limit specified. This input field is optional and only used along with in
the input field above. The minimum and maximum values of this input field are 0.0 C and
7.2 C, and the default value is 2.0C.
An example IDF specification:
CoilSystem:Cooling:DX,
DX Cooling Coil System 1,!- Name
CoolingCoilAvailSched,
!- Availability Schedule Name
Cooling Coil Air Inlet Node, !- DX Cooling Coil System Inlet Node Name
Air Loop Outlet Node,
!- DX Cooling Coil System Outlet Node Name
Air Loop Outlet Node,
!- DX Cooling Coil System Sensor Node Name
Coil:Cooling:DX:SingleSpeed, !- Cooling Coil Object Type
ACDXCoil 1,
!- Cooling Coil Name
None,
!- Dehumidification Control Type
Yes,
!- Run on Sensible Load
No,
!- Run on Latent Load
Yes,
!- Use DOAS DX Cooling Coil
2.0;
!- DOAS DX Cooling Coil Leaving Minimum Air Temperature
Coil:Cooling:DX:SingleSpeed,
ACDXCoil 1,
!- Name
CoolingCoilAvailSched,
!- Availability Schedule Name
25000,
!- Gross Rated Total Cooling Capacity {W}
0.75,
!- Gross Rated Sensible Heat Ratio
3.0,
!- Gross Rated Cooling COP
1.3,
!- Rated Air Flow Rate {m3/s}
Cooling Coil Air Inlet Node, !- Air Inlet Node Name
Air Loop Outlet Node,
!- Air Outlet Node Name
WindACCoolCapFT,
!- Total Cooling Capacity Function of Temperature Curve Name
WindACCoolCapFFF,
!- Total Cooling Capacity Function of Flow Fraction Curve Name
WindACEIRFT,
!- Energy Input Ratio Function of Temperature Curve Name
WindACEIRFFF,
!- Energy Input Ratio Function of Flow Fraction Curve Name
WindACPLFFPLR;
!- Part Load Fraction Correlation Curve Name

DX Cooling Coil System Outputs

All DX Coils:
HVAC,Average,Coil System Frost Control Status
Coil Type= Coil:Cooling:DX:TwoStageWithHumidityControlMode
HVAC,Average,Coil System Cycling Ratio
HVAC,Average,Coil System Compressor Speed Ratio
Coil types=Coil:Cooling:DX:SingleSpeed &
CoilSystem:Cooling:DX:HeatExchangerAssisted
HVAC,Average,Coil System Part Load Ratio

9/29/14

1441

Input-Output Reference

Group Heating and Cooling Coils

Coil System Cycling Ratio

The system may operate for the entire system timestep, but to meet the load the compressor
can cycle on and off. This reports the fraction of the system timestep that the compressor is
operating. (1.0 is continuous, 0.0 is off).
Coil System Compressor Speed Ratio
This is the ratio of time in a system timestep that the compressor is at rated speed. The
compressor speed ratio reports (1.0 is max, 0.0 is min) and any value in between as it is
averaged over the timestep.
Coil System Part Load Ratio
The DX system can operate with a cycling compressor or a varying speed compressor, This
variable reports the fraction of the Full Load that is met during the system timestep. This can
differ from the cycling part load ratio or the compressor speed ratio. (1.0 is Full Load and 0.0
is no load)
Coil System Frost Control Status
This is a flag indicating whether frost control is active at current time step or not. Frost
control is activated or enforced when the sensible load control requires DX cooling coil outlet
air temperature below the user specified minimum temperature or when the dehumidification
load control requires DX cooling coil outlet air humidity ratio below the saturation humidity
ratio corresponding to the user specified minimum temperature for frost control. Frost control
status of zero means no active frost control, a value of 1 or 2 indicates that frost control is
active. If frost control status is 1, then the frost control was enforced when the cooling coil is
run to meet sensible load. If the frost control status value is 2, then the control was enforced
when the cooling coil is run to meet latent load. When frost control is active the DX cooling
coil setpoint value is modified based on user specified limit.
CoilSystem:Heating:DX
The CoilSystem:Heating:DX object is a virtual container component for a DX heating coil
that provides the controls needed to operate the coil. Only single speed DX air-to-air heating
coils are supported.
This component may be used as a heating coil in constant volume or variable volume air
handlers.
It can also be used in an outside air system (by including it in an
AirLoopHVAC:OutdoorAirSystem:EquipmentList object) or in a zone outdoor air unit (by
including it in an ZoneHVAC:OutdoorAirUnit:EquipmentList object). This object is the one
that is listed in the Branch or equipment list object rather than the coil itself.
The inlet and outlet nodes for the DX heat pump system are defined in the heating coil object.
The control node is always the outlet node of the coil. This DX heat pump heating system
requires that a (drybulb) temperature setpoint be placed on the outlet node using either a
setpoint manager or the energy management system. The coil is controlled to attempt to
meet that setpoint using a part load ratio modeling approach.
This model only supports continuous fan and cycling compressor operation -- cycling fan
modeling is not available with this model.
Field: Name
This alpha field contains the identifying name for this component.
Field: Availability Schedule Name
This alpha field contains the schedule name that contains information on the availability of the
DX coil to operate. A schedule value of 0 indicates that the coil is off for that time period. A
9/29/14

1442

Input-Output Reference

Group Heating and Cooling Coils

schedule value greater than 0 indicates that the coil can operate during the time period. If this
field is blank, the schedule has values of 1 for all time periods.
Field: Heating Coil Object Type
This alpha field specifies the type of DX heating coil. This model currently supports only
single speed DX heat pump heating coils and the only options for this field are
Coil:Heating:DX:SingleSpeed and Coil:Heating:DX:VariableSpeed.
Field: Heating Coil Name
This alpha field specifies the unique name of the DX heating coil. This field references the
name of a Coil:Heating:DX:SingleSpeed that needs to be defined elsewhere in the input file.
An example of a DX heating coil system follows.
CoilSystem:Heating:DX,
HeatPump DX Coil 1, !- Name
FanAndCoilAvailSched , !- Availability Schedule Name
Coil:Heating:DX:SingleSpeed, !- Heating Coil Object Type
Heat Pump DX Heating Coil 1; !- Heating Coil Name
Coil:Heating:DX:SingleSpeed,
Heat Pump DX Heating Coil 1, !- Name
FanAndCoilAvailSched,
!- Availability Schedule Name
autosize,
!- Gross Rated Heating Capacity {W}
2.75,
!- Gross Rated Heating COP {W/W}
autosize,
!- Rated Air Flow Rate {m3/s}
Heating Coil Air Inlet Node, !- Air Inlet Node Name
SuppHeating Coil Air Inlet Node, !- Air Outlet Node Name
HPACHeatCapFT,
!- Heating Capacity Function of Temperature Curve Name
HPACHeatCapFFF,
!- Heating Capacity Function of Flow Fraction Curve Name
HPACHeatEIRFT,
!- Energy Input Ratio Function of Temperature Curve Name
HPACHeatEIRFFF,
!- Energy Input Ratio Function of Flow Fraction Curve Name
HPACCOOLPLFFPLR,
!- Part Load Fraction Correlation Curve Name
,
!- Defrost Energy Input Ratio Function of Temperature Curve Name
-8.0,
!- Minimum Outdoor Dry-Bulb Temperature for Compressor Operation {C}
5.0,
!- Maximum Outdoor Dry-Bulb Temperature for Defrost Operation {C}
200.0,
!- Crankcase Heater Capacity {W}
10.0,
!- Maximum Outdoor Dry-Bulb Temperature for Crankcase Heater Operation {C}
Resistive,
!- Defrost Strategy
TIMED,
!- Defrost Control
0.166667,
!- Defrost Time Period Fraction
autosize,
!- Resistive Defrost Heater Capacity {W}
Heat Pump 1 Evaporator Node;

DX Heating Coil System Outputs

Coil System Part Load Ratio
The DX system can operate with a cycling compressor or a varying speed compressor, This
variable reports the fraction of the Full Load that is met during the system timestep. This can
differ from the cycling part load ratio or the compressor speed ratio. (1.0 is Full Load and 0.0
is no load)
CoilSystem:Cooling:DX:HeatExchangerAssisted
The heat exchanger-assisted DX cooling coil is a virtual component consisting of a direct
expansion (DX) cooling coil and an air-to-air heat exchanger as shown in Figure 139 below.
The air-to-air heat exchanger pre-conditions the air entering the cooling coil, and reuses this
energy to post-condition the supply air leaving the cooling coil. This heat exchange process
improves the latent removal performance of the cooling coil by allowing it to dedicate more of
its cooling capacity toward dehumidification (lower sensible heat ratio).
This compound object models the basic operation of an air-to-air heat exchanger in
conjunction with a cooling coil. The heat exchanger-assisted DX cooling coil does not have
9/29/14

1443

Input-Output Reference

Group Heating and Cooling Coils

an operating schedule of its own; its operating schedule is governed by the availability
schedules for the DX cooling coil and the air-to-air heat exchanger. This compound object is
used in place of where a DX cooling coil object would normally be used by itself.
To model a heat exchanger-assisted DX cooling coil, the input data file should include the
following objects:
CoilSystem:Cooling:DX:HeatExchangerAssisted object
Air-to-air
heat
exchanger
object
(HeatExchanger:AirToAir:FlatPlate,
HeatExchanger:AirToAir:SensibleAndLatent,
or
HeatExchanger:Desiccant:BalancedFlow)
DX cooling coil object (Coil:Cooling:DX:SingleSpeed)
In terms of controlling the operation of the heat exchanger, the heat exchanger is assumed to
always provide its heat transfer when the associated DX cooling coil is operating and no high
humidity control mechanism is specified. However, the heat exchangers energy transfer may
be controlled (i.e., turned on and off) based on a zone air humidity level using either a
humidistat (ref. AirLoopHVAC:Unitary:Furnace:HeatCool or AirLoopHVAC:UnitaryHeatCool)
or a humidistat and a maximum humidity set point manager to place a humidity ratio set point
on the appropriate control node (ref. CoilSystem:Cooling:DX). This model may also be used
with the unitary changeover bypass system and the unitary air-to-air heat pump system (ref.
AirLoopHVAC:UnitaryHeatCool:VAVChangeoverBypass
and
AirLoopHVAC:UnitaryHeatPump:AirToAir); however, the heat exchanger is assumed to
always provide its heat transfer when the cooling coil operates and cannot be turned on and
off based on a zone air humidity set point. Two zone air conditioners may also use this model
for improved dehumidification. The first type is the packaged terminal heat pump (ref.
ZoneHVAC:PackagedTerminalHeatPump) where the heat exchangers heat transfer is
always active whenever the cooling coil operates. The second type is the window air
conditioner (ref. ZoneHVAC:WindowAirConditioner) where the heat exchangers heat transfer
is always active when the cooling coil operates and no high humidity control mechanism is
specified, OR the heat exchangers heat transfer may be controlled based on zone air
humidity level if a humidistat and high humidity set point manager are specified (maximum
humidity ratio set point placed on the heat exchangers exhaust air outlet node, ref. Figure
139).
Links to the cooling coil and air-to-air heat exchanger specifications are provided in the input
data syntax for this compound object. A description of each input field for this compound
object is provided below.

9/29/14

1444

Input-Output Reference

Group Heating and Cooling Coils

Figure 139. Schematic of the CoilSystem:Cooling:DX:HeatExchangerAssisted compound object

NOTE:
Node
naming
shown
in
Figure
139
is
representative
for
HeatExchanger:AirToAir:SensibleAndLatent. For HeatExchanger:AirToAir:FlatPlate, the exhaust air nodes
are referred to as secondary air nodes. For HeatExchanger:Desiccant:BalancedFlow, the supply air
nodes are referred to as regeneration air nodes and the exhaust air nodes as process air nodes.

Field: Name
A unique user-assigned name for the heat exchanger-assisted DX cooling coil. Any reference
to this compound component by another object will use this name.
Field: Heat Exchanger Object Type
This alpha field denotes the type of heat exchanger being modeled. Valid choices are:
HeatExchanger:AirToAir:FlatPlate
HeatExchanger:AirToAir:SensibleAndLatent
HeatExchanger:Desiccant:BalancedFlow

Field: Heat Exchanger Name

This alpha field denotes the name of the air-to-air heat exchanger being modeled.
Field: Cooling Coil Object Type
This alpha field denotes the type of DX cooling coil being modeled. The only valid choice is
Coil:Cooling:DX:SingleSpeed.
Field: Cooling Coil Name
This alpha field denotes the name of the DX cooling coil being modeled.
Following is an example input for this compound object:

9/29/14

1445

Input-Output Reference

Group Heating and Cooling Coils

CoilSystem:Cooling:DX:HeatExchangerAssisted,
HeatExchangerAssistedCoolingCoil,
! Name of the heat exchanger assisted cooling coil
HeatExchanger:AirToAir:SensibleAndLatent,
! Heat exchanger type
Air to Air Heat Exchanger 1,
! Heat exchanger name
Coil:Cooling:DX:SingleSpeed,
! Cooling coil type
DX Cooling Coil 1;
! Cooling coil name
HeatExchanger:AirToAir:SensibleAndLatent,
Air to Air Heat Exchanger 1,
!- Heat exchanger name
FanAndCoilAvailSched,
!- Availability schedule name
1.3,
!- Nominal supply air flow rate {m3/s}
.2,
!- Sensible effectiveness at 100% airflow heating condition
.0,
!- Latent effectiveness at 100% airflow heating condition
.23,
!- Sensible effectiveness at 75% airflow heating condition
.0,
!- Latent effectiveness at 75% airflow heating condition
.2,
!- Sensible effectiveness at 100% airflow cooling condition
.0,
!- Latent effectiveness at 100% airflow cooling condition
.23,
!- Sensible effectiveness at 75% airflow cooling condition
.0,
!- Latent effectiveness at 75% airflow cooling condition
HeatExchangerSupplyAirInletNode,
!- Supply air inlet node name
DX Cooling Coil Air Inlet Node,
!- Supply air outlet node name
HeatExchangerExhaustAirInletNode, !- Exhaust air inlet node name
HeatExchangerExhaustAirOutletNode, !- Exhaust air outlet node name
50.0,
!- Nominal electric power {W}
No,
!- Supply air outlet temperature control
Rotary,
!- Heat exchanger type
None;
!- Frost control type

Coil:Cooling:DX:SingleSpeed,
DX Cooling Coil 1,
!- Coil Name
FanAndCoilAvailSched,
!- Availability Schedule
25000,
!- Gross Rated Total Cooling Capacity {W}
0.75,
!- Gross Rated Sensible Heat Ratio
3.0,
!- Gross Rated Cooling COP
1.3,
!- Rated Air Flow Rate {m3/s}
DX Cooling Coil Air Inlet Node,
!- Coil Air Inlet Node
HeatExchangerExhaustAirInletNode, !- Coil Air Outlet Node
ACCoolCapFT,
!- Total Cooling Capacity Modifier Curve (function of temperature)
ACCoolCapFFF,
!- Total Cooling Capacity Modifier Curve (function of flow fraction)
ACEIRFT,
!- Energy Input Ratio Modifier Curve (function of temperature)
ACEIRFFF,
!- Energy Input Ratio Modifier Curve (function of flow fraction)
ACPLFFPLR;
!- Part Load Fraction Correlation (function of part load ratio)

CoilSystem:Cooling:DX:HeatExchangerAssisted Outputs
No variables are reported for this compound object. However, outputs are provided by the
cooling coil and heat exchanger that are specified.
CoilSystem:Cooling:Water:HeatExchangerAssisted
The heat exchanger-assisted water cooling coil is a virtual component consisting of a
chilled-water cooling coil and an air-to-air heat exchanger as shown in Figure 140 below. The
air-to-air heat exchanger precools the air entering the cooling coil, and reuses this energy to
reheat the supply air leaving the cooling coil. This heat exchange process improves the latent
removal performance of the cooling coil by allowing it to dedicate more of its cooling capacity
toward dehumidification (lower sensible heat ratio).

9/29/14

1446

Input-Output Reference

Group Heating and Cooling Coils

Figure 140. Schematic of the CoilSystem:Cooling:Water:HeatExchangerAssisted compound object

Note: Node naming shown in Figure 140 is representative for HeatExchanger:AirToAir:SensibleAndLatent.

For HeatExchanger:AirToAir:FlatPlate, the exhaust air nodes are referred to as secondary air nodes.

This compound object models the basic operation of an air-to-air heat exchanger in
conjunction with a chilled-water cooling coil. The heat exchanger-assisted water cooling coil
does not have an operating schedule of its own; its operating schedule is governed by the
availability schedules for the chilled-water cooling coil and the air-to-air heat exchanger. Heat
exchange will occur whenever the heat exchanger is available to operate (via its availability
schedule) and a temperature difference exists between the two air streams -- there is
currently no method to enable or disable heat exchange based on zone air humidity level.
This compound object is used in place of where a chilled-water cooling coil object would
normally be used by itself.
To model a heat exchanger-assisted water cooling coil, the input data file should include the
following objects:
CoilSystem:Cooling:Water:HeatExchangerAssisted compound object
Air-to-air
heat
exchanger
object
(HeatExchanger:AirToAir:FlatPlate
or
HeatExchanger:AirToAir:SensibleAndLatent)
Chilled-water
cooling
coil
object
(Coil:Cooling:Water
or
Coil:Cooling:Water:DetailedGeometry)
Links to the cooling coil and air-to-air heat exchanger specifications are provided in the input
data syntax for this compound object. A description of each input field for this compound
object is provided below.
Field: Name
A unique user-assigned name for the heat exchanger-assisted water cooling coil. Any
reference to this compound component by another object (e.g., ZoneHVAC:UnitVentilator,
ZoneHVAC:FourPipeFanCoil, component in an air loop Branch object) will use this name.

9/29/14

1447

Input-Output Reference

Group Heating and Cooling Coils

Field: Heat Exchanger Object Type

This alpha field denotes the type of heat exchanger being modeled. Valid choices are:
HeatExchanger:AirToAir:FlatPlate
HeatExchanger:AirToAir:SensibleAndLatent

Field: Heat Exchanger Name

This alpha field denotes the name of the air-to-air heat exchanger being modeled.
Field: Cooling Coil Object Type
This alpha field denotes the type of chilled-water cooling coil being modeled. Valid choices
are:
Coil:Cooling:Water
Coil:Cooling:Water:DetailedGeometry

Field: Cooling Coil Name

This alpha field denotes the name of the chilled-water cooling coil being modeled.
Following is an example input for this compound object:
CoilSystem:Cooling:Water:HeatExchangerAssisted,
Heat Exchanger Assisted Cooling Coil 1, !- Name of the heat exchanger assisted cooling coil
HeatExchanger:AirToAir:FlatPlate,
!- Heat exchanger type
Heat Exchanger Assisting Cooling Coil, !- Heat exchanger name
Coil:Cooling:Water:DetailedGeometry,
!- Cooling coil type
Main Cooling Coil 1;
!- Cooling coil name
HeatExchanger:AirToAir:FlatPlate,
Heat Exchanger Assisting Cooling Coil, !- Name
CoolingCoilAvailSched,
!- Availability Schedule Name
Counter Flow,
!- flow arrangement
Yes,
!- Economizer lockout
1.0,
!- hA ratio
1.32,
!- Nominal supply air flow rate {m3/s}
24.0,
!- Nominal supply air inlet temperature {C}
21.0,
!- Nominal supply air outlet temperature {C}
1.32,
!- Nominal secondary air flow rate {m3/s}
12.0,
!- Nominal secondary air inlet temperature {C}
100.0,
!- Nominal electric power {W}
Mixed Air Node 1,
!- Supply air inlet node
Main Cooling Coil 1 Inlet Node, !- Supply air outlet node
Main Cooling Coil 1 Outlet Node, !- Secondary air inlet node
Main Heating Coil 1 Inlet Node; !- Secondary air outlet node

9/29/14

1448

Input-Output Reference

Group Heating and Cooling Coils

Coil:Cooling:Water:DetailedGeometry,
Main Cooling Coil 1,
!- Coil Name
CoolingCoilAvailSched,
!- Availability Schedule Name
autosize,
!- Max Water Flow Rate of Coil {m3/s}
autosize,
!- Tube Outside Surf Area {m2}
autosize,
!- Total Tube Inside Area {m2}
autosize,
!- Fin Surface Area {m2}
autosize,
!- Minimum Air Flow Area {m2}
autosize,
!- Coil Depth {m}
autosize,
!- Fin Diameter {m}
,
!- Fin Thickness {m}
,
!- Tube Inside Diameter {m}
,
!- Tube Outside Diameter {m}
,
!- Tube Thermal Conductivity {W/m-K}
,
!- Fin Thermal Conductivity {W/m-K}
,
!- Fin Spacing {m}
,
!- Tube Depth Spacing {m}
,
!- Number of Tube Rows
autosize,
!- Number of Tubes per Row
Main Cooling Coil 1 Water Inlet Node, !- Coil_Water_Inlet_Node
Main Cooling Coil 1 Water Outlet Node, !- Coil_Water_Outlet_Node
Main Cooling Coil 1 Inlet Node,
!- Coil_Air_Inlet_Node
Main Cooling Coil 1 Outlet Node; !- Coil_Air_Outlet_Node

CoilSystem:Cooling:Water:HeatExchangerAssisted Outputs
No variables are reported for this compound object. However, outputs are provided by the
cooling coil and heat exchanger that are specified.
Coil:WaterHeating:AirToWaterHeatPump
EnergyPlus can model a heat pump water heater (HPWH) consisting of a water heater tank
(e.g., WaterHeater:Mixed), a direct expansion (DX) coil (i.e., an air-to-water DX
compression system which includes a water heating coil, air coil, compressor, and water
pump), and a fan to provide air flow across the air coil associated with the DX compression
system. These objects work together to model a system which heats water using zone air,
outdoor air, or a combination of zone and outdoor air as the primary heat source.
The WaterHeater:HeatPump compound object, water heater tank object (e.g.,
WaterHeater:Mixed), and fan object (e.g., Fan:OnOff) are defined elsewhere in this reference
document. Coil:WaterHeating:AirToWaterHeatPump object described here models an air-towater DX compression system to determine its air-side and water-side performance. This DX
coil object calculates the air-side sensible and latent cooling capacity at the specific operating
conditions for each simulation timestep, as well as the condensers water-side temperature
difference at a given condenser water flow rate.
The heat pump water heater DX coil model performs the following major functions:
calculates the electric consumption of the DX compressor and water pump
calculates the amount of heat delivered to the water tank
calculates the electric consumption of the compressors crankcase heater
calculates the air-side performance of the DX coil
The input fields for this object are described below in detail:
Field: Name
This alpha field defines a unique user-assigned name for an instance of a heat pump water
heater DX coil. Any reference to this coil by another object (e.g., WaterHeater:HeatPump) will
use this name.
Field: Rated Heating Capacity
This numeric field defines the DX coil heating capacity in Watts at the rated evaporator inlet
air temperatures, rated condenser inlet water temperature, rated evaporator air flow rate, and
rated condenser water flow rate specified below. Values must be greater than 0. This value
9/29/14

1449

Input-Output Reference

Group Heating and Cooling Coils

represents water heating capacity, and it may or may not include the impact of condenser
pump heat (see field Condenser Pump Heat Included in Rated Heating Capacity below).
Field: Rated COP
This numeric field defines the DX coils water heating coefficient of performance (COP=water
heating capacity in watts divided by electrical power input in watts) at rated conditions (rated
inlet temperatures and flow rates specified below). This input not only determines the electric
energy use of the heat pump DX coil, but also the amount of total air cooling provided by the
evaporator. The rated COP includes compressor power, and may or may not include
condenser pump power or evaporator fan power (see field Evaporator Fan Power Included in
Rated COP and field Condenser Pump Power Included in Rated COP). Values must be
greater than 0. If this field is left blank, the default value is 3.2.
Field: Rated Sensible Heat Ratio
This numeric field defines the air-side sensible heat ratio (SHR=sensible cooling capacity
divided by total cooling capacity) of the DX coil at rated conditions (rated inlet temperatures
and flow rates specified below). This value should not include the effect of evaporator fan
heat. Values must be greater than or equal to 0.5, and less than or equal to 1.0. The default
value is 0.85.
Field: Rated Evaporator Inlet Air Dry-Bulb Temperature
This numeric field defines the evaporator inlet air dry-bulb temperature, in degrees Celsius,
that corresponds to rated coil performance (heating capacity, COP and SHR). Values must
be greater than 5C. If this field is left blank, the default value is 19.7C.
Field: Rated Evaporator Inlet Air Wet-Bulb Temperature
This numeric field defines the evaporator inlet air wet-bulb temperature, in degrees Celsius,
that corresponds to rated coil performance (heating capacity, COP and SHR). Values must
be greater than 5C. If this field is left blank, the default value is 13.5C.
Field: Rated Condenser Inlet Water Temperature
This numeric field defines the condenser inlet water temperature, in degrees Celsius, that
corresponds to rated coil performance (heating capacity, COP and SHR). Values must be
greater than 25C. If this field is left blank, the default value is 57.5C.
Field: Rated Evaporator Air Flow Rate
This numeric field defines the evaporator air volume flow rate in cubic meters per second at
rated conditions. Values must be greater than 0. If this field is left blank or autocalculated
(field value = autocalculate), the default value is 5.035E-5 m3/s/W (31.25 cfm/MBH)
multiplied by the Rated Heating Capacity specified above. When autocalculating the rated
evaporator air volumetric flow rate, a zone sizing object is not required.
Field: Rated Condenser Water Flow Rate
This numeric field defines the condenser water volumetric flow rate in cubic meters per
second at rated conditions. Values must be greater than 0. If this field is left blank or
autocalculated (field value = autocalculate), the default value is 4.487E-8 m3/s/W (0.208
gpm/MBH) multiplied by the Rated Heating Capacity specified above. When autocalculating
the rated condenser water volumetric flow rate, a zone sizing object is not required. A
warning message will be issued if the ratio of Rated Condenser Water Volumetric Flow Rate
to Rated Heating Capacity is less than 1.79405E-8 m3/s/W (0.083 gpm/MBH) or greater than
8.97024E-8 m3/s/W (0.417 gpm/MBH), but the simulation will continue.
Field: Evaporator Fan Power Included in Rated COP
This choice field specifies if evaporator fan power is included in the rated COP defined
above. This input impacts the calculation of compressor electric power and total air cooling
9/29/14

1450

Input-Output Reference

Group Heating and Cooling Coils

provided by the evaporator for each simulation timestep. If Yes is selected, the evaporator
fan power is subtracted from the total electric heating power when calculating total evaporator
cooling capacity. If No is selected, it is assumed that the total heating power does not include
evaporator fan power. If this field is left blank, the default is Yes. See the Engineering
Reference section for Coil:WaterHeating:AirToWaterHeatPump for further details.
Field: Condenser Pump Power Included in Rated COP
This choice field specifies if condenser pump power is included in the rated COP defined
above. This input impacts the calculation of compressor electric power which then impacts
the total air cooling provided by the evaporator for each simulation timestep. If Yes is
selected, the condenser pump power is subtracted from the total electric heating power when
calculating total evaporator cooling capacity. If No is selected, it is assumed that the total
heating power does not include the condenser pump. If this field is left blank, the default is
No. See Engineering Reference section for Coil:WaterHeating:AirToWaterHeatPump for
further details.
Field: Condenser Pump Heat Included in Rated Heating Capacity and Rated COP
This choice field specifies if condenser pump heat is included in the rated heating capacity
and rated COP defined above. This input impacts the calculation of compressor electric
power and total air cooling provided by the evaporator for each simulation timestep. If Yes is
selected, the condenser pump heat is already included in the rated heating capacity and
rated COP. If No is selected, it is assumed that the rated heating capacity and rated COP do
not include the condenser pump heat, and pump heat is added to the total water heating
capacity based on the Condenser Water Pump Power and Fraction of Condenser Pump Heat
to Water fields below. If this field is left blank, the default is No. See Engineering Reference
section for Coil:WaterHeating:AirToWaterHeatPump for further details.
Field: Condenser Water Pump Power
This numeric field defines the DX coils condenser pump power in Watts. This is the operating
pump power as installed. Values must be greater than or equal to 0. If this field is left blank,
the default value is 0. A warning message will be issued if the ratio of Condenser Water
Pump Power to Rated Heating Capacity exceeds 0.1422 W/W (41.67 Watts/MBH), but the
simulation will continue.
Field: Fraction of Condenser Pump Heat to Water
This numeric field defines the fraction of condenser pump heat that is transferred to the
condenser water. The pump is assumed to be downstream of the condenser water coil, and
this field is used to determine the water temperature at the condenser outlet node when the
field Condenser Pump Power Included in Rated Heating Capacity is set to No. Values must
be greater than or equal to 0 and less than or equal to 1. If this field is left blank, the default
value is 0.2.
Field: Evaporator Air Inlet Node Name
This alpha field defines the name of the air node from which the evaporator coil draws its inlet
air.
Field: Evaporator Air Outlet Node Name
This alpha field defines the name of the air node to which the evaporator coil sends its outlet
air.
Field: Condenser Water Inlet Node Name
This alpha field defines the name of the node from which the DX coil condenser draws its
inlet water. This node name must also match the source side outlet node name for the water
heater tank connected to this DX coil (ref: Water Heaters).

9/29/14

1451

Input-Output Reference

Group Heating and Cooling Coils

Field: Condenser Water Outlet Node Name

This alpha field defines the name of the node to which the heat pump condenser sends it
outlet water. This node name must also match the source side inlet node name for the water
heater tank connected to this DX coil (ref: Water Heaters).
Field: Crankcase Heater Capacity
This numeric field defines the compressors crankcase heater capacity in Watts. The
crankcase heater only operates when the compressor is off and the air surrounding the
compressor is below the Maximum Ambient Temperature for Crankcase Heater Operation
specified below.
Field: Maximum Ambient Temperature for Crankcase Heater Operation
This numeric field defines the maximum ambient temperature for crankcase heater operation
in degree Celsius. The crankcase heater only operates when the air surrounding the
compressor is below this maximum temperature value and the compressor is off The
ambient temperature surrounding the compressor is set by the Heat Pump:Water Heater
parent object (field Compressor Location).
Field: Evaporator Air Temperature Type for Curve Objects
This choice field specifies the air temperature type used for the heating capacity and COP
modifier curve objects below. The valid selections are Dry-bulb Temperature and Wet-bulb
Temperature. If dry-bulb temperature is selected, the inlet air dry-bulb temperature entering
the heat pump DX coil and fan section is used to evaluate the curve objects. If wet-bulb
temperature is selected, the inlet air wet-bulb temperature entering the heat pump DX coil
and fan section is used to evaluate the curve objects. If this field is left blank and the following
curve names are defined, the default value is wet-bulb temperature. If the following curve
names are not defined, this field is not used.
Field: Heating Capacity Function of Temperature Curve Name
This alpha field specifies the name of a biquadratic or cubic performance curve object (ref:
Performance Curves) that defines the variation in DX coil heating capacity as a function of
inlet fluid (air and water) temperatures. The biquadratic curve uses evaporator inlet air
temperature (dry-bulb or wet-bulb temperature based on the field Evaporator Air Temperature
Type for Curve Objects defined above) and condenser inlet water temperature as the
independent variables. The cubic curve uses evaporator inlet air (dry-bulb or wet-bulb)
temperature as the independent variable. The output of this curve is multiplied by the rated
heating capacity to give the heating capacity at specific operating conditions (i.e., at
temperatures different from the rating point temperatures). The curve should be normalized to
have the value of 1.0 at the rating point temperatures. If this field is left blank, the heating
capacity remains constant (curve value assumed to be 1.0 for all conditions).
Field: Heating Capacity Function of Air Flow Fraction Curve Name
This alpha field specifies the name of a quadratic or cubic performance curve object (ref:
Performance Curves) that defines the variation in DX coil heating capacity as a function of
the ratio of actual air flow rate across the evaporator coil to the rated evaporator air flow rate.
The output of this curve is multiplied by the rated heating capacity and the heating capacity
modifier curve (function of temperature) to give the DX coil heating capacity at the specific
inlet fluid temperatures and air flow rate at which the coil is operating. The curve should be
normalized to have the value of 1.0 at the rated evaporator air flow rate (air flow fraction of
1.0). If this field is left blank, the heating capacity remains constant (curve value assumed to
be 1.0 for all air flow rates).
Field: Heating Capacity Function of Water Flow Fraction Curve Name
This alpha field specifies the name of a quadratic or cubic performance curve object (ref:
Performance Curves) that defines the variation in DX coil heating capacity as a function of
9/29/14

1452

Input-Output Reference

Group Heating and Cooling Coils

the ratio of actual water flow rate through the condenser to the rated condenser water flow
rate. The output of this curve is multiplied by the rated heating capacity and the output from
the two other heating capacity modifier curves (function of temperature and function of air
flow fraction) to give the DX coil heating capacity at the specific inlet fluid temperatures and
flow rates at which the coil is operating. The curve should be normalized to have the value of
1.0 at the rated condenser water flow rate (water flow fraction of 1.0). If this field is left blank,
the heating capacity remains constant (curve value assumed to be 1.0 for all water flow
rates).
Field: Heating COP Function of Temperature Curve Name
This alpha field specifies the name of a biquadratic or cubic performance curve object (ref:
Performance Curves) that defines the variation in DX coil heating COP as a function of inlet
fluid (air and water) temperatures. The biquadratic curve uses evaporator inlet air
temperature (dry-bulb or wet-bulb temperature based on the field Evaporator Air Temperature
Type for Curve Objects defined above) and condenser inlet water temperature as the
independent variables. The cubic curve uses evaporator inlet air (dry-bulb or wet-bulb)
temperature as the independent variable. The output of this curve is multiplied by the rated
COP to give the heating COP at specific operating conditions (i.e., at temperatures different
from the rating point temperatures). The curve should be normalized to have the value of 1.0
at the rating point temperatures. If this field is left blank, the COP remains constant (curve
value assumed to be 1.0 for all conditions).
Field: Heating COP Function of Air Flow Fraction Curve Name
This alpha field specifies the name of a quadratic or cubic performance curve object (ref:
Performance Curves) that defines the variation in DX coil heating COP as a function of the
ratio of actual air flow rate across the evaporator coil to the rated evaporator air flow rate. The
output of this curve is multiplied by the rated COP and the heating COP modifier curve
(function of temperature) to give the heating COP at the specific inlet fluid temperatures and
air flow rate at which the coil is operating. The curve should be normalized to have the value
of 1.0 at the rated evaporator air flow rate (air flow fraction of 1.0). If this field is left blank, the
heating COP remains constant (curve value assumed to be 1.0 for all air flow rates).
Field: Heating COP Function of Water Flow Fraction Curve Name
This alpha field specifies the name of a quadratic or cubic performance curve object (ref:
Performance Curves) that defines the variation in DX coil heating COP as a function of the
ratio of actual water flow rate through the condenser to the rated condenser water flow rate..
The output of this curve is multiplied by the rated COP and the output from the two other
heating COP modifier curves (function of temperature and function of air flow fraction) to give
the DX coil heating COP at the specific inlet fluid temperatures and flow rates at which the
coil is operating. The curve should be normalized to have the value of 1.0 at the rated
condenser water flow rate (water flow fraction of 1.0). If this field is left blank, the heating
COP remains constant (curve value assumed to be 1.0 for all water flow rates).
Field: Part Load Fraction Correlation Curve Name
This alpha field defines the name of a quadratic or cubic performance curve (Ref:
Performance Curves) that parameterizes the variation of electrical power input to the DX unit
as a function of the part load ratio (PLR, sensible cooling load/steady-state sensible cooling
capacity). The product of the rated EIR and EIR modifier curves is divided by the output of
this curve to give the effective EIR for a given simulation timestep. The part load fraction
(PLF) correlation accounts for efficiency losses due to compressor cycling.
The part load fraction correlation should be normalized to a value of 1.0 when the part load
ratio equals 1.0 (i.e., no efficiency losses when the compressor(s) run continuously for the
simulation timestep). For PLR values between 0 and 1 (0 <= PLR < 1), the following rules
apply:
PLF >= 0.7 and PLF >= PLR
9/29/14

1453

Input-Output Reference

Group Heating and Cooling Coils

If PLF < 0.7 a warning message is issued, the program resets the PLF value to 0.7, and the
simulation proceeds. The runtime fraction of the coil is defined as PLR/PLF. If PLF < PLR,
then a warning message is issued and the runtime fraction of the coil is limited to 1.0.
A typical part load fraction correlation for a conventional, single-speed DX cooling coil (e.g.,
residential unit) would be:
PLF = 0.85 + 0.15(PLR)
If the user wishes to model no efficiency degradation due to compressor cycling, the part load
fraction correlation should be defined as follows:
PLF = 1.0 + 0.0(PLR)
Following is an example input for the Coil:WaterHeating:AirToWaterHeatPump object.
Coil:WaterHeating:AirToWaterHeatPump,
Zone4HPWHDXCoil,
!- Coil Name
4000.0,
!- Heating Capacity {W}
3.2,
!- Rated COP {W/W}
0.6956,
!- Rated SHR (gross)
19.7,
!- Rated Evaporator Inlet Air Dry-Bulb Temperature {C}
13.5,
!- Rated Evaporator Inlet Air Wet-Bulb Temperature {C}
57.5,
!- Rated Condenser Inlet Water Temperature {C}
autocalculate,
!- Rated Evaporator Air Volumetric Flow Rate {m3/s}
autocalculate,
!- Rated Condenser Water Volumetric Flow Rate {m3/s}
No,
!- Evaporator Fan Power Included in Rated COP
No,
!- Condenser Pump Power Included in Rated COP
No,
!- Condenser Pump Heat Included in Rated Heating Capacity and Rated COP
150.0,
!- Condenser Water Pump Power {W}
0.1,
!- Fraction of Condenser Pump Heat to Water
Zone4AirOutletNode,
!- Evaporator Air Inlet Node Name
Zone4DXCoilAirOutletNode,
!- Evaporator Air Outlet Node Name
Zone4WaterInletNode,
!- Condenser Water Inlet Node Name
Zone4WaterOutletNode,
!- Condenser Water Outlet Node Name
100.0,
!- Crankcase Heater Capacity {W}
5.0,
!- Maximum Ambient Temperature for Crankcase Heater Operation {C}
wet-bulb temperature,
!- Evaporator Air Temperature Type for Curve Objects
HPWHHeatingCapFTemp,
!- Heating Capacity Modifier Curve Name (function of temperature)
,
!- Heating Capacity Modifier Curve Name (function of air flow fraction)
,
!- Heating Capacity Modifier Curve Name (function of water flow fraction)
HPWHHeatingCOPFTemp,
!- Heating COP Modifier Curve Name (function of temperature)
,
!- Heating COP Modifier Curve Name (function of air flow fraction)
,
!- Heating COP Modifier Curve Name (function of water flow fraction)
HPWHPLFFPLR;
!- Part Load Fraction Correlation Name (function of part load ratio)

Coil:WaterHeating:AirToWaterHeatPump Outputs
HVAC,Average,Cooling Coil Total Cooling Rate [W]
HVAC,Sum,Cooling Coil Total Cooling Energy [J]
HVAC,Average,Cooling Coil Sensible Cooling Rate [W]
HVAC,Sum,Cooling Coil Sensible Cooling Energy [J]
HVAC,Average,Cooling Coil Latent Cooling Rate [W]
HVAC,Sum,Cooling Coil Latent Cooling Energy [J]
HVAC,Average, Cooling Coil Runtime Fraction []
HVAC,Average,DX Cooling Coil Crankcase Heater Electric Power [W]
HVAC,Sum, Cooling Coil Crankcase Heater Electric Energy [J]
HVAC,Average,Cooling Coil Total Water Heating Rate [W]
HVAC,Sum,Cooling Coil Total Water Heating Energy [J]
HVAC,Average,Cooling Coil Water Heating Electric Power[W]
HVAC,Sum,Cooling Coil Water Heating Electric Energy [J]

Cooling Coil Total Cooling Rate [W]

This output field is the average total (sensible and latent) cooling rate output of the DX coil in
Watts for the timestep being reported. This is determined by the coil inlet and outlet air
conditions and the air mass flow rate through the coil.

9/29/14

1454

Input-Output Reference

Group Heating and Cooling Coils

Cooling Coil Total Cooling Energy [J]

This output field is the total (sensible plus latent) cooling output of the DX coil in Joules for
the timestep being reported. This is determined by the coil inlet and outlet air conditions and
the air mass flow rate through the coil.
Cooling Coil Sensible Cooling Rate [W]
This output field is the average moist air sensible cooling rate output of the DX coil in Watts
for the timestep being reported. This is determined by the inlet and outlet air conditions and
the air mass flow rate through the coil.
Cooling Coil Sensible Cooling Energy [J]
This output field is the moist air sensible cooling output of the DX coil in Joules for the
timestep being reported. This is determined by the inlet and outlet air conditions and the air
mass flow rate through the coil.
DX Coil Latent Cooling Rate [W]
This output field is the average latent cooling rate output of the DX coil in Watts for the
timestep being reported. This is determined by the inlet and outlet air conditions and the air
mass flow rate through the coil.
Cooling Coil Latent Cooling Energy [J]
This output field is the latent cooling output of the DX coil in Joules for the timestep being
reported. This is determined by the inlet and outlet air conditions and the air mass flow rate
through the coil.
Cooling Coil Runtime Fraction []
This output field is the average runtime fraction of the DX coil compressor for the timestep
being reported. This also represents the runtime fraction of the condenser water pump.
Cooling Coil Crankcase Heater Electric Power[W]
This output field is the average electricity consumption rate of the DX coil compressors
crankcase heater in Watts for the timestep being reported. The crankcase heater operates
only when the compressor is off and the air surrounding the compressor is below the
Maximum Ambient Temperature for Crankcase Heater Operation, otherwise this output
variable is set equal to 0.
Cooling Coil Crankcase Heater Electric Energy [J]
This output field is the total electricity consumption of the DX coil compressors crankcase
heater in Joules for the timestep being reported. This output is also added to a meter with
Resource Type = Electricity, End Use Key = DHW, Group Key = Plant (ref. Output:Meter
objects).
Cooling Coil Total Water Heating Rate [W]
This output field is the average water heating rate output of the DX coil (condenser coil plus
condenser water pump) in Watts for the timestep being reported. This is determined using the
inlet and outlet water temperatures and the water mass flow rate through the condenser coil.
Cooling Coil Total Water Heating Energy [J]
This output field is the total water heating output of the DX coil (condenser coil plus
condenser water pump) in Joules for the timestep being reported. This is determined using
the inlet and outlet water temperatures and the water mass flow rate through the condenser
coil.

9/29/14

1455

Input-Output Reference

Group Heating and Cooling Coils

Cooling Coil Water Heating Electric Power[W]

This output field is the average electricity consumption rate of the DX coil compressor and
condenser pump in Watts for the timestep being reported.
Cooling Coil Water Heating Electric Energy [J]
This output field is the electricity consumption of the DX coil compressor and condenser
pump in Joules for the timestep being reported. This output is also added to a meter with
Resource Type = Electricity, End Use Key = DHW, Group Key = Plant (ref. Output:Meter
objects).
Coil:Cooling:WaterToAirHeatPump:ParameterEstimation
The Coil:Cooling:WaterToAirHeatPump:ParameterEstimation coil is a deterministic
model that requires parameters to describe the operating conditions of the heat pumps
components. The parameters are generated from the manufacturer catalog data using multivariable optimization method. In addition, the cooling coil model can be used for 3 type of
compressors: reciprocating, rotary and scroll. Descriptions and strength of each respective
model is available in the following references:
Jin, Hui. 2002. Parameter Estimation Based Models of Water Source Heat Pumps. Phd.
Thesis, Department of Mechanical and Aerospace Engineering, Oklahoma State University.
(downloadable from http://www.hvac.okstate.edu/)
Tang,C. C. 2005. Modeling Packaged Heat Pumps in Quasi-Steady State Energy Simulation
Program. M.S. Thesis. Department of Mechanical and Aerospace Engineering, Oklahoma
State University. (downloadable from http://www.hvac.okstate.edu/)
Field: Name
This alpha field contains the identifying name for the coil. Any reference to this coil by another
object (e.g., AirLoopHVAC:UnitaryHeatPump:WaterToAir) will use this name.
Field: Compressor Type
Type of compressor mode used for the heat pump. Choices available are reciprocating,
rotary and scroll compressor. Note that the parameters vary for different compressor.
Field: Refrigerant Type
This alpha field contains the type of refrigerant used by the heat pump.
Field: Design Source Side Flow Rate
This numeric field defines the water flow rate though the coil in m3/sec
Field: Nominal Cooling Coil Capacity
This numeric field defines the nominal cooling capacity for the WatertoAirHP cooling coil in
Watts.
Field: Nominal Time for Condensate Removal to Begin
This numeric field defines the nominal time (in seconds) after startup for condensate to begin
leaving the coil's condensate drain line at the coil's rated airflow and temperature conditions,
starting with a dry coil. Nominal time is equal to the ratio of the energy of the coil's maximum
condensate holding capacity (J) to the coil's steady-state latent capacity (W). Suggested
value is 1000; zero value means the latent degradation model is disabled. The default value
for this field is zero.
Field: Ratio of Initial Moisture Evaporation Rate and Steady State Latent Capacity
This numeric field defines ratio of the initial moisture evaporation rate from the cooling coil
(when the compressor first turns off, in Watts) and the coil's steady-state latent capacity

9/29/14

1456

Input-Output Reference

Group Heating and Cooling Coils

(Watts) at rated airflow and temperature conditions. Suggested value is 1.5; zero value
means the latent degradation model is disabled. The default value for this field is zero.
Field: High Pressure Cutoff
This numeric field defines the compressors maximum allowable pressure in Pascal (N/m2)
Field: Low Pressure Cutoff
This numeric field defines the compressors minimum allowable pressure in Pascal (N/m2)
Field: Water Inlet Node Name
This alpha field contains the cooling coil source side inlet node name.
Field: Water Outlet Node Name
This alpha field contains the cooling coil source side outlet node name.
Field: Air Inlet Node Name
This alpha field contains the cooling coil air inlet node name.
Field: Air Outlet Node Name
This alpha field contains the cooling coil air outlet node name.
Cooling Coil Parameters
Depending on the type of compressor and the source side fluid specified, the type of
parameters and values also differs. An Excel Spreadsheet is developed to estimate the
parameters based on the manufacturer data. The general parameters are listed first followed
by specific parameters required by the respective compressor model. Lastly, parameters are
listed based on the type of source side fluid used.
Field: Load Side Total Heat Transfer Coefficient
This numeric field defines the estimated parameter load side total heat transfer coefficient
in W/K. This field was previously known as Parameter 1.
Field: Load Side Outside Surface Heat Transfer Coefficient
This numeric field defines the estimated parameter load side outside surface heat transfer
coefficient in W/K. This field was previously known as Parameter 2.
Field: Superheat Temperature at the Evaporator Outlet
This numeric field defines the estimated parameter superheat temperature at the
evaporator outlet in C. This field was previously known as Parameter 3.
Field: Compressor Power Losses
This numeric field defines the estimated parameter compressor power losses, which
accounts for the loss of work due to mechanical and electrical losses in the compressor in
Watts. This field was previously known as Parameter 4.
Field: Compressor Efficiency
This numeric field defines the estimated parameter of the compressors efficiency. The
compressor efficiency is formulated as the equation below:

WTheoritical
WCompInput WLoss
This field was previously know as Parameter 5.

9/29/14

1457

Input-Output Reference

Group Heating and Cooling Coils

Field: Compressor Piston Displacement

This numeric field defines the estimated parameter piston displacement of the
compressor in m3/s. This field was part of what was previously known as Parameter 6. It
should be used when the Compressor type is either Reciprocating and Rotary. The field
should be left blank when Compressor type is Scroll.
Field: Compressor Suction/Discharge Pressure Drop
This numeric field defines the estimated parameter pressure drop at the compressor suction
and discharge in Pascals (N/m2). This field was part of what was previously known as
Parameter 7. It should be used when the Compressor type is either Reciprocating and
Rotary. The field should be left blank when Compressor type is Scroll.
Field: Compressor Clearance Factor
This numeric field defines the estimated parameter clearance factor of the compressor.
This parameter is dimensionless. This field was part of what was previously known as
Parameter 8. It should only be used when the Compressor type is Reciprocating. The field
should be left blank when Compressor type is Scroll or Rotary.
Field: Refrigerant Volume Flow Rate
This numeric field defines the refrigerant volume flow rate at the beginning of the
compression [m3/s]. This field was part of what was previously known as Parameter 6. It
should only be used when the Compressor type is Scroll. The field should be left blank when
Compressor type is Reciprocating or Rotary.
Field: Volume Ratio
This numeric field defines the built-in-volume ratio. This field was part of what was
previously known as Parameter 7. It should only be used when the Compressor type is Scroll.
The field should be left blank when Compressor type is Reciprocating or Rotary.
Field: Leak Rate Coefficient
This numeric field defines the leak rate coefficient for the relationship between pressure
ratio and leakage rate. This field was part of what was previously known as Parameter 8. It
should only be used when the Compressor type is Scroll. The field should be left blank when
Compressor type is Reciprocating or Rotary.
Field: Source Side Heat Transfer Coefficient
This numeric field defines the estimated parameter source side heat transfer coefficient in
W/K. This field was part of what was previously known as Parameter 9. It should only be
used when the Source Side Fluid Name is Water.
Field: Source Side Heat Transfer Resistance1
This numeric field defines the estimated parameter source side heat transfer resistance 1.
Unit is dimensionless. This field was part of what was previously known as Parameter 9. It
should only be used when the Source Side Fluid Name is an antifreeze.
Field: Source Side Heat Transfer Resistance2
This numeric field defines the estimated parameter source side heat transfer resistance 2.
Unit is W/K. This field was previously known as Parameter 10. It should only be used when
the Source Side Fluid Name is an antifreeze.
Following is an example for COIL:WaterToAirHP:ParameterEstimation:Cooling coil input

9/29/14

1458

Input-Output Reference

Group Heating and Cooling Coils

Coil:Cooling:WaterToAirHeatPump:ParameterEstimation,
Heat Pump Cooling Mode AHU1, !- Name
Scroll,
!- Compressor Type
R22,
!- Refrigerant Type
0.0015,
!- Design Source Side Flow Rate {m3/s}
38000,
!- Nominal Cooling Coil Capacity {W}
0,
!- Nominal Time for Condensate Removal to Begin {s}
0,
!- Ratio of Initial Moisture Evaporation Rate and Steady State Latent Capacity {dimensionless}
3000000,
!- High Pressure Cutoff {Pa}
0,
!- Low Pressure Cutoff {Pa}
AHU1 Water to Air Heat Pump Source Side1 Inlet Node, !- Water Inlet Node Name
AHU1 Water to Air Heat Pump Source Side1 Outlet Node, !- Water Outlet Node Name
AHU 1 Supply Fan Outlet, !- Air Inlet Node Name
Cooling Coil Air Outlet Node AHU1, !- Air Outlet Node Name
3.78019E+03,
!- Load Side Total Heat Transfer Coefficient {W/K}
3.41103E+03,
!- Load Side Outside Surface Heat Transfer Coefficient {W/K}
1.57066E+00,
!- Superheat Temperature at the Evaporator Outlet {C}
2.23529E+03,
!- Compressor Power Losses {W}
1.34624E+00,
!- Compressor Efficiency
,
!- Compressor Piston Displacement {m3/s}
,
!- Compressor Suction/Discharge Pressure Drop {Pa}
,
!- Compressor Clearance Factor {dimensionless}
9.74424E-03,
!- Refrigerant Volume Flow Rate {m3/s}
2.30803E+00,
!- Volume Ratio {dimensionless}
2.06530E-02,
!- Leak Rate Coefficient
1.92757E+03,
!- Source Side Heat Transfer Coefficient {W/K}
,
!- Source Side Heat Transfer Resistance1 {dimensionless}
;
!- Source Side Heat Transfer Resistance2 {W/K}

Coil:Cooling:WaterToAirHeatPump:EquationFit
The Coil:Cooling:WaterToAirHeatPump:EquationFit is a simple curve-fit model that requires
coefficients generated from the heat pump catalog data. This is an equation-fit model that
resembles a black box with no usage of heat transfer equations. The performance of the heat
pump is modeled using curves fitted from the catalog data. Description of the equation-fit
model is available in the following reference:
Tang,C. C. 2005. Modeling Packaged Heat Pumps in Quasi-Steady State Energy Simulation
Program. M.S. Thesis. Department of Mechanical and Aerospace Engineering, Oklahoma
State University. (downloadable from http://www.hvac.okstate.edu/)
Field: Name
This alpha field contains the identifying name for the coil. Any reference to this coil by another
object (e.g., AirLoopHVAC:UnitaryHeatPump:WaterToAir) will use this name.
Field: Water Inlet Node Name
This alpha field contains the cooling coil source side inlet node name.
Field: Water Outlet Node Name
This alpha field contains the cooling coil source side outlet node name.
Field: Air Inlet Node Name
This alpha field contains the cooling coil air inlet node name.
Field: Air Outlet Node Name
This alpha field contains the cooling coil air outlet node name.
Field: Rated Air Flow Rate
This numeric field contains the rated volumetric air flow rate on the load side of the heat
pump in m3/s. This field is autosizable.

9/29/14

1459

Input-Output Reference

Group Heating and Cooling Coils

Field: Rated Water Flow Rate

This numeric field contains the rated volumetric water flow rate on the source side of the heat
pump in m3/s. This field is autosizable.
Field: Gross Rated Total Cooling Capacity
This numeric field contains the gross rated total cooling capacity of the heat pump in W. This
field is autosizable.The gross rated total cooling capacity should be within 20% of the gross
rated heating capacity, otherwise a warning message is issued. The gross rated total cooling
capacity should not account for the effect of supply air fan heat.
Field: Gross Rated Sensible Cooling Capacity
This numeric field contains the gross rated sensible capacity of the heat pump in W. This field
is autosizable. The gross rated sensible cooling capacity should not account for the effect of
supply air fan heat.
Field: Rated Cooling Coefficient of Performance
This numeric field contains the rated cooling coefficient of performance of the heat pump.
Field: Total Cooling Capacity Coefficient 1 to 5
These numeric fields contain the first to fifth coefficient for the heat pump total cooling
capacity.
Field: Sensible Cooling Capacity Coefficient 1 to 6
These numeric fields contain the first to sixth coefficient for the heat pump sensible cooling
capacity.
Field: Cooling Power Consumption Coefficient 1 to 5
These numeric fields contain the first to fifth coefficient for the heat pump power
consumption.
Field: Nominal Time for Condensate Removal to Begin
This numeric field defines the nominal time (in seconds) after startup for condensate to begin
leaving the coil's condensate drain line at the coil's rated airflow and temperature conditions,
starting with a dry coil. Nominal time is equal to the ratio of the energy of the coil's maximum
condensate holding capacity (J) to the coil's steady-state latent capacity (W). Suggested
value is 1000; zero value means the latent degradation model is disabled. The default value
for this field is zero.
Field: Ratio of Initial Moisture Evaporation Rate and Steady State Latent Capacity
This numeric field defines ratio of the initial moisture evaporation rate from the cooling coil
(when the compressor first turns off, in Watts) and the coil's steady-state latent capacity
(Watts) at rated airflow and temperature conditions. Suggested value is 1.5; zero value
means the latent degradation model is disabled. The default value for this field is zero.
Following is an example of the input for Coil:WaterToAirHP:EquationFit:Cooling coil

9/29/14

1460

Input-Output Reference

Group Heating and Cooling Coils

Coil:Cooling:WaterToAirHeatPump:EquationFit,
Heat Pump Cooling Mode,!- Name of Coil
Water to Air Heat Pump Source Side1 Inlet Node,!- Coil Water Inlet Node Name
Water to Air Heat Pump Source Side1 Outlet Node,!- Coil Water Outlet Node Name
Cooling Coil Air Inlet Node,!- Coil Air Inlet Node Name
Heating Coil Air Inlet Node,!- Coil Air Outlet Node Name
4.6015E-01,!- Rated Air Volumetric Flow Rate
2.8391E-04,!- Rated Water Volumetric Flow Rate
23125.59,!- Gross Rated Total Cooling Capacity
16267.05,!- Gross Rated Sensible Cooling Capacity
4.7,!- Rated Cooling Coefficient of Performance
-0.68126221,!- Total Cooling Capacity Coefficient 1
1.99529297,!- Total Cooling Capacity Coefficient 2
-0.93611888,!- Total Cooling Capacity Coefficient 3
0.02081177,!- Total Cooling Capacity Coefficient 4
0.008438868,!- Total Cooling Capacity Coefficient 5
2.24209455,!- Sensible Cooling Capacity Coefficient 1
7.28913391,!- Sensible Cooling Capacity Coefficient 2
-9.06079896,!- Sensible Cooling Capacity Coefficient 3
-0.36729404,!- Sensible Cooling Capacity Coefficient 4
0.218826161,!- Sensible Cooling Capacity Coefficient 5
0.00901534,!- Sensible Cooling Capacity Coefficient 6
-3.20456384,!- Cooling Power Consumption Coefficient 1
0.47656454,!- Cooling Power Consumption Coefficient 2
3.16734236,!- Cooling Power Consumption Coefficient 3
0.10244637,!- Cooling Power Consumption Coefficient 4
-0.038132556,!- Cooling Power Consumption Coefficient 5
0,!- Nominal Time for Condensate Removal to Begin
0;!- Ratio of Initial Moisture Evaporation Rate and Steady-state Latent Capacity

Water to Air Heat Pump Cooling Coil (Parameter Estimation and Equation Fit)
Outputs
Coil:Cooling:WaterToAirHeatPump:ParameterEstimation
and
Coil:Cooling:WaterToAirHeatPump:EquationFit have the same output variables listed as
follows;
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,

Average,
Average,
Average,
Average,
Average,
Average,

Cooling
Cooling
Cooling
Cooling
Cooling
Cooling

Coil
Coil
Coil
Coil
Coil
Coil

Electric Power [W]

Total Cooling Rate [W]
Sensible Cooling Rate [W]
Source Side Heat Transfer Rate [W]
Part Load Ratio []
Runtime Fraction []

HVAC,
HVAC,
HVAC,
HVAC,
HVAC,

Average,
Average,
Average,
Average,
Average,

Cooling
Cooling
Cooling
Cooling
Cooling

Coil
Coil
Coil
Coil
Coil

Air
Air
Air
Air
Air

Mass Flow Rate [kg/s]

Inlet Temperature [C]
Inlet Humidity Ratio [kgWater/kgDryAir]
Outlet Temperature [C]
Outlet Humidity Ratio [kgWater/kgDryAir]

HVAC, Average, Cooling Coil Source Side Mass Flow Rate [kg/s]
HVAC, Average, Cooling Coil Source Side Inlet Temperature [C]
HVAC, Average, Cooling Coil Source Side Outlet Temperature [C]
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,

Sum, Cooling Coil Electric Energy [J]

Sum, Cooling Coil Total Cooling Energy [J]
Sum, Cooling Coil Sensible Cooling Energy [J]
Sum, Cooling Coil Latent Cooling Energy [J]
Average, Cooling Coil Latent Cooling Rate [W]
Sum, Cooling Coil Source Side Heat Transfer Energy [J]

Cooling Coil Electric Power [W]

This output variable is the average electric consumption rate of the heat pump in Watts over
the timestep being reported.

9/29/14

1461

Input-Output Reference

Group Heating and Cooling Coils

Cooling Coil Total Cooling Rate [W]

The output variable is the average total cooling load provide by the heat pump which includes
the sensible and latent load in Watts over the timestep being reported.
Cooling Coil Sensible Cooling Rate [W]
The output variable is the average sensible cooling load provide by the heat pump in Watts
over the timestep being reported.
Cooling Coil Source Side Heat Transfer Rate [W]
The output variable is the average heat rejected to the water at the heat pump condenser in
Watts over the timestep being reported.
Cooling Coil Part Load Ratio []
This output variable is the ratio of the part-load capacity to the steady state capacity of the
WatertoAirHP coil. For the cycling fan mode, the runtime fraction for the heat pump
compressor may be different from the compressor part-load ratio reported here due to the
part-load performance of the WatertoAirHP coil (delay at start-up to reach steady-state
output). In general, runtime fractions are reported by individual components where
appropriate.
Cooling Coil Runtime Fraction []
This output variable is the function of the part load ratio (PLR, part-load capacity/ steady state
capacity). The duty factor or part load fraction accounts for efficiency losses due to
compressor cycling.
Cooling Coil Air Mass Flow Rate [kg/s]
The output variable is the average air mass flow rate going through the heat pump over the
timestep being reported.
Cooling Coil Air Inlet Temperature [C]
The output variable is the average entering air dry-bulb temperature over the timestep being
reported.
Cooling Coil Air Inlet Humidity Ratio [kgWater/kgDryAir]
The output variable is the average entering air dry humidity ratio over the timestep being
reported.
Cooling Coil Air Outlet Temperature [C]
The output variable is the average leaving air dry-bulb temperature over the timestep being
reported.
Cooling Coil Air Outlet Humidity Ratio [kgWater/kgDryAir]
The output variable is the average leaving air dry humidity ratio over the timestep being
reported.
Cooling Coil Source Side Mass Flow Rate [kg/s]
The output variable is the average water mass flow rate going through the heat pump over
the timestep being reported.
Cooling Coil Source Side Inlet Temperature [C]
The output variable is the average entering water temperature over the timestep being
reported.

9/29/14

1462

Input-Output Reference

Group Heating and Cooling Coils

Cooling Coil Source Side Outlet Temperature [C]

The output variable is the average leaving water temperature over the timestep being
reported.
Cooling Coil Electric Energy [J]
The output variable is the electric consumption of the heat pump in Joules over the timestep
being reported. This output is also added to a meter with Resource Type = Electricity, End
Use Key = Cooling, Group Key = System (ref. Output:Meter objects).
Cooling Coil Total Cooling Energy [J]
The output variable is the total cooling output of the coil in Joules over the timestep being
reported. Resource Type = EnergyTransfer, End Use Key = CoolingCoils, Group Key =
System (ref. Output:Meter objects).
Cooling Coil Sensible Cooling Energy [J]
The output variable is the total sensible cooling output of the coil in Joules over the timestep
being reported
Cooling Coil Latent Cooling Energy [J]
Cooling Coil Latent Cooling Rate [W]
These output variables are the total latent cooling output of the coil in Joules or Watts over
the timestep being reported.
Cooling Coil Source Side Heat Transfer Energy [J]
The output variable is the total source side heat transfer of the coil in Joules over the
timestep being reported
Coil:Cooling:WaterToAirHeatPump:VariableSpeedEquationFit
The Variable-Speed Water-to-Air Cooling Equation Fit Coil is a collection of performance
curves that represent the cooling coil at various speed levels. The performance curves should
be generated from the heat pump Reference Unit data. This is an equation-fit model that
resembles a black box with no usage of heat transfer equations. On the other hand, the
model uses the bypass factor approach to calculate sensible heat transfer rate, similar to the
one used in the single-speed DX coil. The number of speed levels can range from 2 to 10.
The cooling coil has four node connections, i.e. two air sides and two water sides. The user
needs to specify a nominal speed level, at which the gross rated total cooling capacity, rated
volumetric air and water flow rates are sized. The rated capacity, rated volumetric flow rates
represent the real situation in the air and water loops, and are used to determine and flow
rates
at
various
speed
levels
in
the
parent
objects,
e.g.
AirLoopHVAC:UnitaryHeatPump:WaterToAir and ZoneHVAC:WaterToAirHeatPump. It shall
be mentioned that the performance correction curves, i.e. the temperature and flow fraction
correction curves, should be normalized to the capacity and flow rates at each individual
speed and at the rated conditions, similar to the performance curves used in the DX coils.
However, the performance values, e.g. gross capacities, gross COPs, gross SHRs and flow
rates at individual speed levels, should be given regarding a specific unit from the Reference
Unit catalog data. In the following content, the statement started with Reference Unit means
the actual Reference Unit catalog data. The rated conditions for obtaining the capacities,
COPs and SHRs are at indoor dry-bulb temperature of 26.67 C (80 F), wet bulb
temperature of 19.44 C (67 F), and the source side entering water temperature of 29.4 C
(85 F). Some equations are provided below to help explain the function of the various
performance curves and data fields. For a detailed description of the algorithm and how the
curves are used in the calculations, please see the Engineering Reference.

9/29/14

1463

Input-Output Reference

Group Heating and Cooling Coils

Field: Name
This alpha field contains the identifying name for the variable speed cooling coil. Any
reference to this coil by another object (e.g., AirLoopHVAC:UnitaryHeatPump:WaterToAir)
will use this name.
Field: Water Inlet Node Name
This alpha field contains the cooling coil source side inlet node name.
Field: Water Outlet Node Name
This alpha field contains the cooling coil source side outlet node name.
Field: Air Inlet Node Name
This alpha field contains the cooling coil load side inlet node name.
Field: Air Outlet Node Name
This alpha field contains the cooling coil load side outlet node name.
Field: Number of Speeds
This numeric field contains the maximum number of speed levels that the module uses. The
number of speeds, for which the user input the performance data and curves, should be
equal or higher than the maximum number. The performance inputs at higher speed levels
are ignored.
Field: Nominal Speed Level
This numeric field defines the nominal speed level, at which the rated capacity, rated air and
water volumetric flow rates are correlated.
Field: Gross Rated Total Cooling Capacity at Selected Nominal Speed Level
This numeric field contains the gross rated total cooling capacity at the nominal speed level.
This field is autosizable. The gross rated total cooling capacity is used to determine a
capacity scaling factor, as compared to the Reference Unit capacity at the nominal speed
level.

CapacityScaleFactor

Gross Rated Total Cooling Capacity

ReferenceUnit Capacity @ Nominal Speed Level

And then, this scaling factor is used to determine capacities at rated conditions for other
speed levels, as below,

Gross Rated Capacity @ Speed Level x

CapacityScaleFactor

ReferenceUnit Capacity @ Speed Level ( x)

Field: Rated Volumetric Air Flow Rate
This numeric field contains the rated volumetric air flow rate on the load side of the heat
pump corresponding to the nominal speed level. This field is autosizable. The value is used
to determine an internal scaling factor, and calculate the air flow rates in the parent objects.
It is recommended that the ratio of the rated volumetric air flow rate to the rated capacity is
the same as the unit performance from the Reference Unit data.

9/29/14

1464

Input-Output Reference

Group Heating and Cooling Coils

AirFlowScaleFactor
Rated Volumetric Air Flow Rate
ReferenceUnitVol Air Flow Rate @ Nominal Speed Level CapacityScaleFactor
And the volumetric air flow rates in the parent objects are calculated as below,

LoopVolumetric Air Flow Rate @ Speed Level x

AirFlowScaleFactor

ReferenceUnitVol Air Flow Rate @ Speed Level ( x)

CapacityScaleFactor
Field: Rated Volumetric Water Flow Rate
This numeric field contains the rated volumetric water flow rate on the source side of the heat
pump at the nominal speed level. This field is autosizable. The value is used to determine an
internal scaling factor, and calculate the water flow rates in the water loop. It is
recommended that the ratio of the rated volumetric water flow rate to the rated capacity is the
same as the unit performance from the Reference Unit data.

WaterFlowScaleFactor
Rated VolumetricWater Flow Rate
ReferenceUnitVolWater Flow Rate @ Nominal Speed Level CapacityScaleFactor
And the required volumetric water flow rates at the speed levels in the parent objects, other
than the nominal speed, are calculated as below,

LoopVolumetricWater Flow Rate @ Speed Level x

WaterFlowScaleFactor

ReferenceUnitVolWater Flow Rate @ Speed Level ( x)

CapacityScaleFactor
Field: Nominal Time for Condensate Removal to Begin
This numeric field defines the nominal time (in seconds) after startup for condensate to begin
leaving the coil's condensate drain line at the coil's rated airflow and temperature conditions,
starting with a dry coil. Nominal time is equal to the ratio of the energy of the coil's maximum
condensate holding capacity (J) to the coil's steady-state latent capacity (W). Suggested
value is 1000; zero value means the latent degradation model is disabled. The default value
for this field is zero.
Field: Ratio of Initial Moisture Evaporation Rate and Steady State Latent Capacity
This numeric field defines ratio of the initial moisture evaporation rate from the cooling coil
(when the compressor first turns off, in Watts) and the coil's steady-state latent capacity
(Watts) at rated airflow and temperature conditions. Suggested value is 1.5; zero value
means the latent degradation model is disabled. The default value for this field is zero.
Field: Flag for Using Hot Gas Reheat, 0 or 1
This numeric field dictates whether to use the recoverable waste heat for reheating the
supply air, downstream of the coil. The value 1 means using the hot gas reheating, and 0
means not using. If the hot gas reheating is turned on, the recoverable waste heat is
subtracted from both the total cooling capacity and the sensible cooling capacity. The default
value for this field is zero.

9/29/14

1465

Input-Output Reference

Group Heating and Cooling Coils

Field: Part Load Fraction Correlation Curve Name

This alpha field defines the name of a quadratic or cubic performance curve (Ref:
Performance Curves) that parameterizes the variation of electrical power input to the unit as
a function of the part load ratio (PLR, sensible or latent load/steady-state sensible or latent
cooling capacity for Speed 1), in the case that the unit operates under the lowest speed, i.e.
on/off. The product of the rated EIR and EIR modifier curves is divided by the output of this
curve to give the effective EIR for a given simulation timestep for Speed 1. The part load
fraction (PLF) correlation accounts for efficiency losses due to compressor cycling. The part
load fraction correlation should be normalized to a value of 1.0 when the part load ratio
equals 1.0 (i.e., no efficiency losses when the compressor(s) run continuously for the
simulation timestep). For PLR values between 0 and 1 (0 <= PLR < 1), the following rules
apply:
PLF >= 0.7 and PLF >= PLR
If PLF < 0.7, the program resets the PLF value to 0.7, and the simulation proceeds. The
runtime fraction of the coil is defined as PLR/PLF. If PLF < PLR, the runtime fraction of the
coil is limited to 1.0. A typical part load fraction correlation would be:

PLF

0.85 0.15 PLR

If the user wishes to model no efficiency degradation due to compressor cycling, the part load
fraction correlation should be defined as follows:

PLF

0.85 0.0 PLR

Field Group: rated specification, performance curves, and waste heat data
The performance for each cooling speed must be specified as shown below. They should be
directly given from the Reference Unit catalog data. All inputs for Speed 1 are required,
followed by the optional inputs for other speeds.
Field: Speed <x> Reference Unit Gross Rated Total Cooling Capacity
This numeric field defines the total, full load cooling capacity in watts of the water-to-air
cooling coil unit at rated conditions for Speed <x> operation. The value entered here must be
greater than 0. The gross rated total capacity should not account for the effect of supply air
fan heat.
Field: Speed <x> Reference Unit Gross Rated Sensible Heat Ratio
This numeric field defines sensible heat transfer ratio (SHR = gross sensible cooling capacity
divided by gross total cooling capacity) of the cooling coil unit at rated conditions for Speed
<x> operation. The value entered here must be greater than 0.0 and less than 1.0. This value
should be obtained from the Reference Unit data. The gross rated SHR should not account
for the effect of supply air fan heat.
Field: Speed <x> Reference Unit Gross Rated Cooling COP
This numeric field defines the coefficient of performance (COP=gross total cooling capacity in
watts divided by electrical power input in watts) of the cooling coil unit at rated conditions for
Speed <x> operation. The value entered here must be greater than 0. The input power
includes power for the compressor(s) and accessories, but does not include the power
consumptions of the indoor supply air fan and water pump. The gross COP should not
account for the supply air fan.

9/29/14

1466

Input-Output Reference

Group Heating and Cooling Coils

Field: Speed <x> Reference Unit Rated Air Flow Rate

This numeric field defines the volumetric air flow rate, in m3 per second, across the cooling
coil at rated conditions for Speed <x> operation. The value entered here should be directly
from the Reference Unit data, corresponding to the given gross rated total cooling capacity
and gross rated cooling COP at the speed, as above.
Field: Speed <x> Reference Unit Rated Water Flow Rate
This numeric field defines the volumetric water flow rate, in m3 per second, flowing at the
source side of the cooling coil at rated conditions for Speed <x> operation. The value entered
here should be directly from the Reference Unit data, corresponding to the given gross rated
total cooling capacity and gross rated cooling COP at the speed, as above.
Field: Speed <x> Total Cooling Capacity Function of Temperature Curve Name
This alpha field defines the name of a bi-quadratic performance curve for Speed <x> (ref:
Performance Curves) that parameterizes the variation of the gross total cooling capacity as a
function of the both the indoor wet-bulb and source side entering water temperature, from the
Reference Unit. The output of this curve is multiplied by the gross rated total cooling capacity
at the speed to give the gross total cooling capacity at specific temperature operating
conditions (i.e., at an indoor air wet-bulb temperature or entering water temperature different
from the rating point temperature). It should be noted that the curve is normalized to the
cooling capacity at Speed<x> from the Reference Unit data, and have the value of 1.0 at the
rating point.
Field: Speed <x> Total Cooling Capacity Function of Air Flow Fraction Curve Name
This alpha field defines the name of a quadratic or cubic performance curve for Speed <x>
(ref: Performance Curves) that parameterizes the variation of the gross total cooling capacity
as a function of the ratio of actual air flow rate across the cooling coil to the design air flow
rate (i.e., fraction of full load flow at Speed <x>, from the Reference Unit data). The curve is
normalized to have the value of 1.0 when the actual air flow rate equals the design air flow
rate, at Speed <x>.
Field: Speed <x> Total Cooling Capacity Function of Water Flow Fraction Curve Name
This alpha field defines the name of a quadratic or cubic performance curve for Speed <x>
(ref: Performance Curves) that parameterizes the variation of the gross total cooling capacity
as a function of the ratio of actual water flow rate across the cooling coil to the design water
flow rate (i.e., fraction of full load flow), at Speed <x>, from the Reference Unit data. The
curve is normalized to have the value of 1.0 when the actual water flow rate equals the
design air flow rate, at Speed <x>.
The actual total cooling capacity at Speed <x>, considering variations in temperatures, air
and water flow rates is calculated as below:

Actual Capacity @ Speed Level x

CapacityScaleFactor

ReferenceUnit Capacity @ Speed Level ( x)

TotCapTempModFac @ Speed Level ( x)
TotCapAirFlowModFac @ Speed Level ( x)
TotCapWaterFlowModFac @ Speed Level ( x)
Field: Speed <x> Energy Input Ratio Function of Temperature Curve Name
This alpha field defines the name of a bi-quadratic, quadratic or cubic performance curve for
Speed <x> (ref: Performance Curves) that parameterizes the variation of the energy input
ratio (EIR) as a function of the both the indoor air wet-bulb and entering water temperatures
9/29/14

1467

Input-Output Reference

Group Heating and Cooling Coils

The EIR is the inverse of the COP. The output of this curve is multiplied by the rated EIR
(inverse of rated COP at Speed <x> from the Reference Unit data) to give the EIR at specific
temperature operating conditions (i.e., at an indoor air wet-bulb temperature or entering water
temperature different from the rating point temperature). The curve is normalized to have the
value of 1.0 at the rating point.
Field: Speed <x> Energy Input Ratio Function of Air Flow Fraction Curve Name
This alpha field defines the name of a quadratic or cubic performance curve for Speed <x>
(ref: Performance Curves) that parameterizes the variation of the energy input ratio (EIR) as
a function of the ratio of actual air flow rate across the cooling coil to the design air flow rate
(i.e., fraction of full load flow, at Speed <x> from the Reference Unit data). The EIR is the
inverse of the COP. This curve is normalized to a value of 1.0 when the actual air flow rate
equals the design air flow rate.
Field: Speed <x> Energy Input Ratio Function of Water Flow Fraction Curve Name
This alpha field defines the name of a quadratic or cubic performance curve for Speed <x>
(ref: Performance Curves) that parameterizes the variation of the energy input ratio (EIR) as
a function of the ratio of actual water flow rate across the cooling coil to the design water flow
rate (i.e., fraction of full load flow, at Speed <x> from the Reference Unit data). This curve is
normalized to a value of 1.0 when the actual air flow rate equals the design air flow rate.
The actual EIR at Speed <x>, considering variations in temperatures, air and water flow rates
is calculated as below:

1.0
ReferenceUnit COP @ Speed Level ( x)
EIRTempModFac @ Speed Level ( x)
EIRAirFlowModFac @ Speed Level ( x)
EIRWaterFlowModFac @ Speed Level ( x)

Actual EIR @ Speed Level x

And, the actual power consumption is calculated:

Actual Power @ Speed Level x

Actual Capacity @ Speed Level x

Actual EIR @ Speed Level x

Field: Speed <x> Reference Unit Waste Heat Fraction of Power Input
The fraction of heat input to cooling that is available as recoverable waste heat at full load
and rated conditions for Speed <x> operation. The part of heat is not discharged to the water
loop. And it can be used for hot gas reheating during dehumidification operation, by setting 1
to Flag for Using Hot Gas Reheat.
Field: Speed <x> Waste Heat Function of Temperature Curve Name
The name of a bi-quadratic performance curve (ref: Performance Curves) that parameterizes
the variation of the waste heat recovery as a function of indoor wet-bulb temperature and the
entering water temperature for Speed <x> from the Reference Unit data. The output of this
curve is multiplied by the design recoverable waste heat at specific temperature operating
conditions (i.e., at temperatures different from the rating point). The curve is normalized to a
value of 1.0 at the rating point.
The actual recoverable waste heat at Speed <x> is calculated as below:

9/29/14

1468

Input-Output Reference

Group Heating and Cooling Coils

ActualWaste Heat @ Speed Level x

Actual Power @ Speed Level x

WasteHeatFrac @ Speed Level ( x)

WasteHeatTempModFac @ Speed Level ( x)
An example of this statement in an IDF is:

9/29/14

1469

Input-Output Reference

Group Heating and Cooling Coils

Coil:Cooling:WaterToAirHeatPump:VariableSpeedEquationFit,
Sys 1 Heat Pump Cooling Mode,
!- Name
Sys 1 Water to Air Heat Pump Source Side1 Inlet Node, !- Water Inlet Node Name
Sys 1 Water to Air Heat Pump Source Side1 Outlet Node, !- Water Outlet Node Name
Sys 1 Cooling Coil Air Inlet Node,
!- Air Inlet Node Name
Sys 1 Heating Coil Air Inlet Node,
!- Air Outlet Node Name
10.0,
!- Number of Speeds
10.0,
!- Nominal Speed Level
Autosize,
!- Gross Rated Total Cooling Capacity {W}
Autosize,
!- Rated Air Flow Rate {m3/s}
Autosize,
!- Rated Water Flow Rate {m3/s}
0.0,
!Nominal time for Condensate to Begin Leaving the Coil
0.0,
!Initial Moisture Evaporation Rate Divided by Steady-State AC Latent Capacity
1,
!Flag for Using Hot Gas Reheat or Not, 0 = false; 1 = true
VS Energy Part Load Fraction 1, !Energy Part Load Fraction Curve
1524.1,
!-Speed 1 Reference Unit Gross Rated Total Cooling Capacity
0.75,
!-Speed 1 Reference Unit Gross Sensible Heat Ratio
4.0,
!-Speed 1 Reference Unit Gross Cooling COP
0.1359072,
!-Speed 1 Reference Unit Rated air flow rate
0.000381695,
!-Speed 1 Reference Unit Rated water flow rate
TC VS Temp1 Test,
!-Speed 1 Total Cooling Capacity Function of Temperature Curve Name
TC VS AirFrac Test,
!-Speed 1 Total Cooling Capacity Function of Air Flow Fraction Curve Name
TC VS WaterFrac Test,
!-Speed 1 Total Cooling Capacity Function of Water Flow Fraction Curve Name
EIR VS Temp1 Test,
!-Speed 1 Energy Input Ratio Function of Temperature Curve Name
EIR VS AirFrac Test,
!-Speed 1 Energy Input Ratio Function of Air Flow Fraction Curve Name
EIR VS WaterFrac Test,
!-Speed 1 Energy Input Ratio Function of Water Flow Fraction Curve Name
0.1,
!-Speed 1 Waste Heat fraction to power input
wasteHeat VS Temp1 Test, !-Speed 1 Waste Heat Function of Temperature Curve Name
1877.9,
!-Speed 2 Reference Unit Gross Rated Total Cooling Capacity
0.75,
!-Speed 2 Reference Unit Gross Sensible Heat Ratio
4.0,
!-Speed 2 Reference Unit Gross Cooling COP
0.151008,
!-Speed 2 Reference Unit Rated air flow rate
0.000381695,
!-Speed 2 Reference Unit Rated water flow rate
TC VS Temp1 Test,
!-Speed 2 Total Cooling Capacity Function of Temperature Curve Name
TC VS AirFrac Test,
!-Speed 2 Total Cooling Capacity Function of Air Flow Fraction Curve Name
TC VS WaterFrac Test,
!-Speed 2 Total Cooling Capacity Function of Water Flow Fraction Curve Name
EIR VS Temp1 Test,
!-Speed 2 Energy Input Ratio Function of Temperature Curve Name
EIR VS AirFrac Test,
!-Speed 2 Energy Input Ratio Function of Air Flow Fraction Curve Name
EIR VS WaterFrac Test,
!-Speed 2 Energy Input Ratio Function of Water Flow Fraction Curve Name
0.1,
!-Speed 2 Waste Heat fraction to power input
wasteHeat VS Temp1 Test, !-Speed 2 Waste Heat Function of Temperature Curve Name
2226.6,
!-Speed 3 Reference Unit Gross Rated Total Cooling Capacity
0.75,
!-Speed 3 Reference Unit Gross Sensible Heat Ratio
4.0,
!-Speed 3 Reference Unit Gross Cooling COP
0.1661088,
!-Speed 3 Reference Unit Rated air flow rate
0.000381695,
!-Speed 3 Reference Unit Rated water flow rate
TC VS Temp1 Test,
!-Speed 3 Total Cooling Capacity Function of Temperature Curve Name
TC VS AirFrac Test,
!-Speed 3 Total Cooling Capacity Function of Air Flow Fraction Curve Name
TC VS WaterFrac Test, !-Speed 3 Total Cooling Capacity Function of Water Flow Fraction Curve Name
EIR VS Temp1 Test,
!-Speed 3 Energy Input Ratio Function of Temperature Curve Name
EIR VS AirFrac Test,
!-Speed 3 Energy Input Ratio Function of Air Flow Fraction Curve Name
EIR VS WaterFrac Test, !-Speed 3 Energy Input Ratio Function of Water Flow Fraction Curve Name
0.1,
!-Speed 3 Waste Heat fraction to power input
wasteHeat VS Temp1 Test,!-Speed 3 Waste Heat Function of Temperature Curve Name
2911.3,
!-Speed 4 Reference Unit Gross Rated Total Cooling Capacity
0.75,
!-Speed 4 Reference Unit Gross Sensible Heat Ratio
4.0,
!-Speed 4 Reference Unit Gross Cooling COP
0.1963104,
!-Speed 4 Reference Unit Rated air flow rate
0.000381695,
!-Speed 4 Reference Unit Rated water flow rate
TC VS Temp1 Test,
!-Speed 4 Total Cooling Capacity Function of Temperature Curve Name
TC VS AirFrac Test,
!-Speed 4 Total Cooling Capacity Function of Air Flow Fraction Curve Name
TC VS WaterFrac Test, !-Speed 4 Total Cooling Capacity Function of Water Flow Fraction Curve Name
EIR VS Temp1 Test,
!-Speed 4 Energy Input Ratio Function of Temperature Curve Name
EIR VS AirFrac Test,
!-Speed 4 Energy Input Ratio Function of Air Flow Fraction Curve Name
EIR VS WaterFrac Test, !-Speed 4 Energy Input Ratio Function of Water Flow Fraction Curve Name
0.1,
!-Speed 4 Waste Heat fraction to power input
wasteHeat VS Temp1 Test, !-Speed 4 Waste Heat Function of Temperature Curve Name
3581.7,
!- Speed 5 Reference Unit Gross Rated Total Cooling Capacity
0.75,
!- Speed 5 Reference Unit Gross Sensible Heat Ratio
4.0,
!- Speed 5 Reference Unit Gross Cooling COP
0.226512,
!- Speed 5 Reference Unit Rated air flow rate

9/29/14

1470

Input-Output Reference

Group Heating and Cooling Coils

0.000381695,
!- Speed 5 Reference Unit Rated water flow rate
TC VS Temp1 Test,
!- Speed 5 Total Cooling Capacity Function of Temperature Curve Name
TC VS AirFrac Test,
!- Speed 5 Total Cooling Capacity Function of Air Flow Fraction Curve Name
TC VS WaterFrac Test, !- Speed 5 Total Cooling Capacity Function of Water Flow Fraction Curve Name
EIR VS Temp1 Test,
!- Speed 5 Energy Input Ratio Function of Temperature Curve Name
EIR VS AirFrac Test,
!- Speed 5 Energy Input Ratio Function of Air Flow Fraction Curve Name
EIR VS WaterFrac Test, !- Speed 5 Energy Input Ratio Function of Water Flow Fraction Curve Name
0.1,
!- Speed 5 Waste Heat fraction to power input
wasteHeat VS Temp1 Test, !- Speed 5 Waste Heat Function of Temperature Curve Name
4239.5,
!-Speed 6 Reference Unit Gross Total Cooling Capacity
0.75,
!-Speed 6 Reference Unit Gross Sensible Heat Ratio
4.0,
!-Speed 6 Reference Unit Gross Cooling COP
0.2567136,
!-Speed 6 Reference Unit Rated air flow rate
0.000381695,
!-Speed 6 Reference Unit Rated water flow rate
TC VS Temp1 Test,
!-Speed 6 Total Cooling Capacity Function of Temperature Curve Name
TC VS AirFrac Test,
!-Speed 6 Total Cooling Capacity Function of Air Flow Fraction Curve Name
TC VS WaterFrac Test, !-Speed 6 Total Cooling Capacity Function of Water Flow Fraction Curve Name
EIR VS Temp1 Test,
!-Speed 6 Energy Input Ratio Function of Temperature Curve Name
EIR VS AirFrac Test,
!-Speed 6 Energy Input Ratio Function of Air Flow Fraction Curve Name
EIR VS WaterFrac Test, !-Speed 6 Energy Input Ratio Function of Water Flow Fraction Curve Name
0.1,
!-Speed 6 Waste Heat fraction to power input
wasteHeat VS Temp1 Test, !-Speed 6 Waste Heat Function of Temperature Curve Name
4885.7,
!-Speed 7 Reference Unit Gross Rated Total Cooling Capacity
0.75,
!-Speed 7 Reference Unit Gross Sensible Heat Ratio
4.0,
!-Speed 7 Reference Unit Gross Cooling COP
0.2869152,
!-Speed 7 Reference Unit Rated air flow rate
0.000381695,
!-Speed 7 Reference Unit Rated water flow rate
TC VS Temp1 Test,
!-Speed 7 Total Cooling Capacity Function of Temperature Curve Name
TC VS AirFrac Test,
!-Speed 7 Total Cooling Capacity Function of Air Flow Fraction Curve Name
TC VS WaterFrac Test, !-Speed 7 Total Cooling Capacity Function of Water Flow Fraction Curve Name
EIR VS Temp1 Test,
!-Speed 7 Energy Input Ratio Function of Temperature Curve Name
EIR VS AirFrac Test,
!-Speed 7 Energy Input Ratio Function of Air Flow Fraction Curve Name
EIR VS WaterFrac Test, !-Speed 7 Energy Input Ratio Function of Water Flow Fraction Curve Name
0.1,
!-Speed 7 Waste Heat fraction to power input
wasteHeat VS Temp1 Test, !-Speed 7 Waste Heat Function of Temperature Curve Name
5520.7,
!-Speed 8 Reference Unit Gross Rated Total Cooling Capacity
0.75,
!-Speed 8 Reference Unit Gross Sensible Heat Ratio
4.0,
!-Speed 8 Reference Unit Gross Cooling COP
0.3171168,
!-Speed 8 Reference Unit Rated air flow rate
0.000381695,
!-Speed 8 Reference Unit Rated water flow rate
TC VS Temp1 Test,
!-Speed 8 Total Cooling Capacity Function of Temperature Curve Name
TC VS AirFrac Test,
!-Speed 8 Total Cooling Capacity Function of Air Flow Fraction Curve Name
TC VS WaterFrac Test, !-Speed 8 Total Cooling Capacity Function of Water Flow Fraction Curve Name
EIR VS Temp1 Test,
!-Speed 8 Energy Input Ratio Function of Temperature Curve Name
EIR VS AirFrac Test,
!-Speed 8 Energy Input Ratio Function of Air Flow Fraction Curve Name
EIR VS WaterFrac Test, !-Speed 8 Energy Input Ratio Function of Water Flow Fraction Curve Name
0.1,
!-Speed 8 Waste Heat fraction to power input
wasteHeat VS Temp1 Test, !-Speed 8 Waste Heat Function of Temperature Curve Name
6144.8,
!-Speed 9 Reference Unit Gross Rated Total Cooling Capacity
0.75,
!-Speed 9 Reference Unit Gross Sensible Heat Ratio
4.0,
!-Speed 9 Reference Unit Gross Cooling COP
0.3473184,
!-Speed 9 Reference Unit Rated air flow rate
0.000381695,
!-Speed 9 Reference Unit Rated water flow rate
TC VS Temp1 Test,
!-Speed 9 Total Cooling Capacity Function of Temperature Curve Name
TC VS AirFrac Test,
!-Speed 9 Total Cooling Capacity Function of Air Flow Fraction Curve Name
TC VS WaterFrac Test,
!-Speed 9 Total Cooling Capacity Function of Water Flow Fraction Curve Name
EIR VS Temp1 Test,
!-Speed 9 Energy Input Ratio Function of Temperature Curve Name
EIR VS AirFrac Test,
!-Speed 9 Energy Input Ratio Function of Air Flow Fraction Curve Name
EIR VS WaterFrac Test, !-Speed 9 Energy Input Ratio Function of Water Flow Fraction Curve Name
0.1,
!-Speed 9 Waste Heat fraction to power input
wasteHeat VS Temp1 Test, !-Speed 9 Waste Heat Function of Temperature Curve Name
6758.0,
!-Speed 10 Reference Unit Gross Rated Total Cooling Capacity
0.75,
!-Speed 10 Reference Unit Gross Sensible Heat Ratio
4.0,
!-Speed 10 Reference Unit Gross Cooling COP
0.37752,
!-Speed 10 Reference Unit Rated air flow rate
0.000381695,
!-Speed 10 Reference Unit Rated water flow rate
TC VS Temp1 Test,
!-Speed 10 Total Cooling Capacity Function of Temperature Curve Name
TC VS AirFrac Test,
!-Speed 10 Total Cooling Capacity Function of Air Flow Fraction Curve Name
TC VS WaterFrac Test,
!-Speed 10 Total Cooling Capacity Function of Water Flow Fraction Curve Name
EIR VS Temp1 Test,
!-Speed 10 Energy Input Ratio Function of Temperature Curve Name
EIR VS AirFrac Test,
!-Speed 10 Energy Input Ratio Function of Air Flow Fraction Curve Name

9/29/14

1471

Input-Output Reference

Group Heating and Cooling Coils

EIR VS WaterFrac Test, !-Speed 10 Energy Input Ratio Function of Water Flow Fraction Curve Name
0.1,
!-Speed 10 Waste Heat fraction to power input
wasteHeat VS Temp1 Test; !-Speed 10 Waste Heat Function of Temperature Curve Name

Variable Speed Water to Air Heat Pump Cooling Coil Outputs

HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,

Average, Cooling Coil Electric Power [W]

Average, Cooling Coil Total Cooling Rate [W]
Average, Cooling Coil Sensible Cooling Rate [W]
Average, Cooling Coil Source Side Heat Transfer Rate [W]
Average, Cooling Coil Part Load Ratio []
Average, Cooling Coil Runtime Fraction []
Average, Cooling Coil Air Mass Flow Rate [kg/s]
Average, Cooling Coil Air Inlet Temperature [C]
Average, Cooling Coil Air Inlet Humidity Ratio [kgWater/kgDryAir]
Average, Cooling Coil Air Outlet Temperature [C]
Average, Cooling Coil Air Outlet Humidity Ratio [kgWater/kgDryAir]
Average, Cooling Coil Source Side Mass Flow Rate [kg/s]
Average, Cooling Coil Source Side Inlet Temperature [C]
Average, Cooling Coil Source Side Outlet Temperature [C]
Average, Cooling Coil Upper Speed Level []
Average, Cooling Coil Neighboring Speed Levels Ratio []
Average, Cooling Coil Recoverable Heat Transfer Rate [W]
Sum, Cooling Coil Electric Energy [J]
Sum, Cooling Coil Total Cooling Energy [J]
Sum, Cooling Coil Sensible Cooling Energy [J]
Sum, Cooling Coil Latent Cooling Energy [J]
Average, Cooling Coil Latent Cooling Rate [W]
Sum, Cooling Coil Source Side Heat Transfer Energy [J]

Cooling Coil Electric Power [W]

This output variable is the average electric consumption rate of the heat pump in Watts over
the timestep being reported.
Cooling Coil Total Cooling Rate [W]
The output variable is the average total cooling load provide by the heat pump which includes
the sensible and latent load in Watts over the timestep being reported.
Cooling Coil Sensible Cooling Rate [W]
The output variable is the average sensible cooling load provide by the heat pump in Watts
over the timestep being reported.
Cooling Coil Source Side Heat Transfer Rate [W]
The output variable is the average heat rejected to the water at the heat pump condenser in
Watts over the timestep being reported.
Cooling Coil Part Load Ratio []
This output variable is the ratio of the part-load capacity to the steady state capacity of the
VSWatertoAirHP coil. For the cycling fan mode, the runtime fraction for the heat pump
compressor may be different from the compressor part-load ratio reported here due to the
part-load performance of the VSWatertoAirHP coil (delay at start-up to reach steady-state
output). In general, runtime fractions are reported by individual components where
appropriate.
Cooling Coil Runtime Fraction []
This output variable is the function of the part load ratio (PLR, part-load capacity/ steady state
capacity). The duty factor or runtime fraction accounts for efficiency losses due to
compressor cycling.

9/29/14

1472

Input-Output Reference

Group Heating and Cooling Coils

Cooling Coil Air Mass Flow Rate [kg/s]

The output variable is the average air mass flow rate going through the heat pump over the
timestep being reported.
Cooling Coil Air Inlet Temperature [C]
The output variable is the average entering air dry-bulb temperature over the timestep being
reported.
Cooling Coil Air Inlet Humidity Ratio [kgWater/kgDryAir]
The output variable is the average entering air dry humidity ratio over the timestep being
reported.
Cooling Coil Air Outlet Temperature [C]
The output variable is the average leaving air dry-bulb temperature over the timestep being
reported.
Cooling Coil Air Outlet Humidity Ratio [kgWater/kgDryAir]
The output variable is the average leaving air dry humidity ratio over the timestep being
reported.
Cooling Coil Source Side Mass Flow Rate [kg/s]
The output variable is the average water mass flow rate going through the heat pump over
the timestep being reported.
Cooling Coil Source Side Inlet Temperature [C]
The output variable is the average entering water temperature over the timestep being
reported.
Cooling Coil Source Side Outlet Temperature [C]
The output variable is the average leaving water temperature over the timestep being
reported.
Cooling Coil Upper Speed Level []
The output variable is the average upper speed level, for interpolating performances between
two neighboring speed levels.
Cooling Coil Neighboring Speed Levels Ratio []
The output variable is the average speed ratio, for interpolating performances between two
neighboring speed levels.
Cooling Coil Recoverable Heat Transfer Rate [W]
This output variable is the average recoverable waste heat rate of the heat pump in Watts
over the timestep being reported.
Cooling Coil Electric Energy [J]
The output variable is the electric consumption of the heat pump in Joules over the timestep
being reported.
Cooling Coil Total Cooling Energy [J]
The output variable is the total cooling output of the coil in Joules over the timestep being
reported.

9/29/14

1473

Input-Output Reference

Group Heating and Cooling Coils

Cooling Coil Sensible Cooling Energy [J]

The output variable is the total sensible cooling output of the coil in Joules over the timestep
being reported
Cooling Coil Latent Cooling Energy [J]
Cooling Coil Latent Cooling Rate [W]
These output variables are the total latent cooling output of the coil in Joules or Watts over
the timestep being reported.
Cooling Coil Source Side Heat Transfer Energy [J]
The output variable is the total source side heat transfer of the coil in Joules over the
timestep being reported.
Coil:Heating:WaterToAirHeatPump:ParameterEstimation
The Water to Air heat pump heating coil is a deterministic model that requires parameters to
describe the operating conditions of the heat pumps components. The parameters are
generated from the manufacturer catalog data using multi-variable optimization method.
However, the parameters required for WatertoAirHP heating coil is similar to WatertoAirHP
cooling except (source side outside heat transfer coefficient) parameter is not required for
heating. In addition, the heating coil model can be used for 3 type of compressors which are
reciprocating, rotary and scroll.
Field: Name
This alpha field contains the identifying name for the coil. Any reference to this coil by another
object (e.g., AirLoopHVAC:UnitaryHeatPump:WaterToAir) will use this name.
Field: Compressor Type
Type of compressor mode used for the heat pump. Choices available are reciprocating,
rotary and scroll compressor. Note that the parameters vary for different compressor.
Field: Refrigerant Type
This alpha field contains the type of refrigerant used by the heat pump.
Field: Design Source Side Flow Rate
This numeric field defines the water flow rate though the coil in m3/sec
Field: Gross Rated Heating Capacity
This numeric field defines the gross heating capacity for the WatertoAirHP heating coil at the
rated condition in Watts. The gross heating capacity should Not inlcude the ffect of supply air
fan heat.
Field: High Pressure Cutoff
This numeric field defines the compressors maximum allowable pressure in Pascal (N/m2)
Field: Low Pressure Cutoff
This numeric field defines the compressors minimum allowable pressure in Pascal (N/m2)
Field: Water Inlet Node Name
This alpha field contains the heating coil source side inlet node name.
Field: Water Outlet Node Name
This alpha field contains the heating coil source side outlet node name.

9/29/14

1474

Input-Output Reference

Group Heating and Cooling Coils

Field: Air Inlet Node Name

This alpha field contains the heating coil air inlet node name.
Field: Air Outlet Node Name
This alpha field contains the heating coil air outlet node name.
Heating Coil Parameters
Depending on the type of compressor specified, the type of parameters and values also
differs. An Excel Spreadsheet is in the final stage of development that is capable of
estimating the parameters based on the manufacturer data. The general parameters are
listed first followed by specific parameters required by the respective compressor model.
Lastly, parameters are listed based on the type of source side fluid used.
Field: Load Side Total Heat Transfer Coefficient
This numeric field defines the estimated parameter load side total heat transfer coefficient
in W/K. This field was previously known as Parameter 1.
Field: Superheat Temperature at the Evaporator Outlet
This numeric field defines the estimated parameter superheat temperature at the
evaporator outlet in C. This field was previously known as Parameter 2.
Field: Compressor Power Losses
This numeric field defines the estimated parameter compressor power losses, which
accounts for the loss of work due to mechanical and electrical losses in the compressor in
Watts. This field was previously known as Parameter 3.
Field: Compressor Efficiency
This numeric field defines the estimated parameter of the compressors efficiency. The
compressor efficiency is formulated as the equation below:

WTheoritical
WCompInput WLoss
This field was previously know as Parameter 4.
Field: Compressor Piston Displacement
This numeric field defines the estimated parameter piston displacement of the
compressor in m3/s. This field was part of what was previously known as Parameter 5. It
should be used when the Compressor type is either Reciprocating and Rotary. The field
should be left blank when Compressor type is Scroll.
Field: Compressor Suction/Discharge Pressure Drop
This numeric field defines the estimated parameter pressure drop at the compressor
suction and discharge in Pascals (N/m2). This field was part of what was previously known
as Parameter 6. It should be used when the Compressor type is either Reciprocating and
Rotary. The field should be left blank when Compressor type is Scroll.
Field: Compressor Clearance Factor
This numeric field defines the estimated parameter clearance factor of the compressor.
This parameter is dimensionless. This field was part of what was previously known as
Parameter 7. It should only be used when the Compressor type is Reciprocating. The field
should be left blank when Compressor type is Scroll or Rotary.

9/29/14

1475

Input-Output Reference

Group Heating and Cooling Coils

Field: Refrigerant Volume Flow Rate

This numeric field defines the refrigerant volume flow rate at the beginning of the
compression [m3/s]. This field was part of what was previously known as Parameter 6. It
should only be used when the Compressor type is Scroll. The field should be left blank when
Compressor type is Reciprocating or Rotary.
Field: Volume Ratio
This numeric field defines the built-in-volume ratio. This field was part of what was
previously known as Parameter 6. It should only be used when the Compressor type is Scroll.
The field should be left blank when Compressor type is Reciprocating or Rotary.
Field: Leak Rate Coefficient
This numeric field defines the coefficient for the relationship between pressure ratio and
leakage rate. This field was part of what was previously known as Parameter 7. It should
only be used when the Compressor type is Scroll. The field should be left blank when
Compressor type is Reciprocating or Rotary.
Field: Source Side Heat Transfer Coefficient
This numeric field defines the estimated parameter source side heat transfer coefficient in
W/K. This field was part of what was previously known as Parameter 8. It should only be
used when the Source Side Fluid Name is Water.
Field: Source Side Heat Transfer Resistance1
This numeric field defines the estimated parameter source side heat transfer resistance 1.
Unit is dimensionless. This field was part of what was previously known as Parameter 8. It
should only be used when the Source Side Fluid Name is an antifreeze.
Field: Source Side Heat Transfer Resistance2
This numeric field defines the estimated parameter source side heat transfer resistance 2.
Unit is W/K. This field was previously known as Parameter 9. It should only be used when the
Source Side Fluid Name is an antifreeze.
Following is an example input for Coil:WatertoAirHP:ParameterEstimation:Heating

9/29/14

1476

Input-Output Reference

Group Heating and Cooling Coils

Coil:Heating:WaterToAirHeatPump:ParameterEstimation,
Heat Pump HEATING Mode AHU1, !- Name
Scroll,
!- Compressor Type
R22,
!- Refrigerant Type
0.0015,
!- Design Source Side Flow Rate {m3/s}
38000,
!- Gross Rated Heating Capacity {W}
3000000,
!- High Pressure Cutoff
0,
!- Low Pressure Cutoff {Pa}
AHU1 Water to Air Heat Pump Source Side2 Inlet Node, !- Water Inlet Node Name
AHU1 Water to Air Heat Pump Source Side2 Outlet Node, !- Water Outlet Node Name
Cooling Coil Air Outlet Node AHU1, !- Air Inlet Node Name
Heating Coil Air Outlet Node AHU1, !- Air Outlet Node Name
5.79505E+03,
!- Load Side Total Heat Transfer Coefficient {W/K}
1.56696E+00,
!- Superheat Temperature at the Evaporator Outlet {C}
3.91338E+03,
!- Compressor Power Losses {W}
1.26356E+00,
!- Compressor Efficiency
,
!- Compressor Piston Displacement {m3/s}
,
!- Compressor Suction/Discharge Pressure Drop {Pa}
,
!- Compressor Clearance Factor {dimensionless}
6.99573E-03,
!- Refrigerant Volume Flow Rate {m3/s}
4.96167E+00,
!- Volume Ratio {dimensionless}
2.07750E-06,
!- Leak Rate Coefficient {dimensionless}
4.00322E+03,
!- Source Side Heat Transfer Coefficient {W/K}
,
!- Source Side Heat Transfer Resistance1 {dimensionless}
;
!- Source Side Heat Transfer Resistance2 {W/K}

Coil:Heating:WaterToAirHeatPump:EquationFit
The Water to Air Heating Equation Fit Coil is a simple curve-fit model that requires
coefficients generated from the heat pump catalog data. This is an equation-fit model that
resembles a black box with no usage of heat transfer equations. The performance of the heat
pump is modeled using curves fitted from the catalog data.
Field: Name
This alpha field contains the identifying name for the coil. Any reference to this coil by another
object (e.g., AirLoopHVAC:UnitaryHeatPump:WaterToAir) will use this name.
Field: Water Inlet Node Name
This alpha field contains the heating coil source side inlet node name.
Field: Water Outlet Node Name
This alpha field contains the heating coil source side outlet node name.
Field: Air Inlet Node Name
This alpha field contains the heating coil air inlet node name.
Field: Air Outlet Node Name
This alpha field contains the heating coil air outlet node name.
Field: Rated Air Flow Rate
This numeric field contains the rated volumetric air flow rate on the load side of the heat
pump in m3/s. This field is autosizable.
Field: Rated Water Flow Rate
This numeric field contains the rated volumetric water flow rate on the source side of the heat
pump in m3/s. This field is autosizable.
Field: Gross Rated Heating Capacity
This numeric field contains the gross heating capacity of the heat pump at the rated condition
in W. The gross heating capacity should not account for the effect of supply air fan heat. This
field is autosizable.
9/29/14

1477

Input-Output Reference

Group Heating and Cooling Coils

Field: Gross Rated Heating COP

This numeric field contains the gross rated heating coefficient of performance of the heat
pump. The gross rated COP of the heat pump should not account for the effect of supply air
fan heat.
Field: Heating Capacity Coefficient 1-5
These numeric fields contain the first to fifth coefficient for the heat pump capacity.
Field: Heating Power Consumption Coefficient 1-5
These numeric fields contain the first to fifth coefficient for the heat pump power
consumption.
Water to Air Heat Pump Heating Coil (parameter Estimation and Equation Fit)
Outputs
Coil:Heating:WaterToAirHeatPump:ParameterEstimation
and
Coil:Heating:WaterToAirHeatPump:EquationFit have the same output variables listed as
follows;
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,

Average,
Average,
Average,
Average,
Average,
Average,

Heating
Heating
Heating
Heating
Heating
Heating

Coil
Coil
Coil
Coil
Coil
Coil

Electric Power [W]

Heating Rate [W]
Sensible Heating Rate [W]
Source Side Heat Transfer Rate [W]
Part Load Ratio
Runtime Fraction []

HVAC,
HVAC,
HVAC,
HVAC,
HVAC,

Average,
Average,
Average,
Average,
Average,

Heating
Heating
Heating
Heating
Heating

Coil
Coil
Coil
Coil
Coil

Air
Air
Air
Air
Air

Mass Flow Rate [kg/s]

Inlet Temperature [C]
Inlet Humidity Ratio [kgWater/kgDryAir]
Outlet Temperature [C]
Outlet Humidity Ratio [kgWater/kgDryAir]

HVAC, Average, Heating Coil Source Side Mass Flow Rate [kg/s]
HVAC, Average, Heating Coil Source Side Inlet Temperature [C]
HVAC, Average, Heating Coil Source Side Outlet Temperature [C]
HVAC, Sum, Heating Coil Electric Energy [J]
HVAC, Sum, Heating Coil Heating Energy [J]
HVAC, Sum, Heating Coil Source Side Heat Transfer Energy [J]

Heating Coil Electric Power [W]

This output variable is the average electric consumption rate of the heat pump in Watts over
the timestep being reported.
Heating Coil Heating Rate [W]
The output variable is the average total heating capacity provide by the heat pump which
includes the sensible and latent capacity in Watts over the timestep being reported.
Heating Coil Sensible Heating Rate [W]
The output variable is the average sensible heating capacity provide by the heat pump in
Watts over the timestep being reported. For heating mode, the sensible capacity is equal to
the total capacity.
Heating Coil Source Side Heat Transfer Rate [W]
The output variable is the average heat absorbed at the heat pump evaporator in Watts over
the timestep being reported.
9/29/14

1478

Input-Output Reference

Group Heating and Cooling Coils

Heating Coil Part Load Ratio []

This output variable is the ratio of the part-load capacity to the steady state capacity of the
WatertoAirHP coil. For the cycling fan mode, the runtime fraction for the heat pump
compressor may be different from the compressor part-load ratio reported here due to the
part-load performance of the WatertoAirHP coil (delay at start-up to reach steady-state
output). In general, runtime fractions are reported by individual components where
appropriate.
Heating Coil Runtime Fraction []
This output variable is the function of the part load ratio (PLR, part-load capacity/ steady state
capacity). The duty factor or part load fraction accounts for efficiency losses due to
compressor cycling.
Heating Coil Air Mass Flow Rate [kg/s]
The output variable is the average air mass flow rate going through the heat pump over the
timestep being reported.
Heating Coil Air Inlet Temperature [C]
The output variable is the average entering air dry-bulb temperature over the timestep being
reported.
Heating Coil Air Inlet Humidity Ratio [kgWater/kgDryAir]
The output variable is the average entering air dry humidity ratio over the timestep being
reported.
Heating Coil Air Outlet Temperature [C]
The output variable is the average leaving air dry-bulb temperature over the timestep being
reported.
Heating Coil Air Outlet Humidity Ratio [kgWater/kgDryAir]
The output variable is the average leaving air dry humidity ratio over the timestep being
reported.
Heating Coil Source Side Mass Flow Rate [kg/s]
The output variable is the average water mass flow rate going through the heat pump over
the timestep being reported.
Heating Coil Source Side Inlet Temperature [C]
The output variable is the average entering water temperature over the timestep being
reported.
Heating Coil Source Side Outlet Temperature [C]
The output variable is the average leaving water temperature over the timestep being
reported.
Heating Coil Electric Energy [J]
The output variable is the total electric consumption of the heat pump in Joules over the
timestep being reported. This output is also added to a meter with Resource Type =
Electricity, End Use Key = Heating, Group Key = System (ref. Output:Meter objects).
Heating Coil Heating Energy [J]
The output variable is the total cooling output of the coil in Joules over the timestep being
reported. Resource Type = EnergyTransfer, End Use Key = HeatingCoils, Group Key =
System (ref. Output:Meter objects).
9/29/14

1479

Input-Output Reference

Group Heating and Cooling Coils

Heating Coil Source Side Heat Transfer Energy [J]

The output variable is the total source side heat transfer of the coil in Joules over the
timestep being reported.
Coil:Heating:WaterToAirHeatPump:VariableSpeedEquationFit
The Variable-Speed Water-to-Air Heating Equation Fit Coil is a collection of performance
curves that represent the heating coil at various speed levels. The performance curves
should be generated from the heat pump Reference Unit catalog data. This is an equation-fit
model that resembles a black box with no usage of heat transfer equations. The number of
speed levels can range from 2 to 10. The heating coil has four node connections, i.e. two air
sides and two water sides. The user needs to specify a nominal speed level, at which the
rated capacity, rated volumetric air and water flow rates are sized. The rated capacity, rated
volumetric flow rates represent the real situation in the air and water loops, and are used to
determine the flow rates at various speed levels in the parent objects, e.g.
AirLoopHVAC:UnitaryHeatPump:WaterToAir and ZoneHVAC:WaterToAirHeatPump. It shall
be mentioned that the performance correction curves, i.e. the temperature and flow fraction
correction curves, should be normalized to the capacity and flow rates at each individual
speed and at the rated operating conditions, similar to the performance curves used in the
DX coils. On the other hand, the performance values at individual speed levels, e.g.
capacities, COPs and flow rates, should be given regarding a specific unit from the
Reference Unit catalog data. In the following content, the statement started with Reference
Unit means the actual Reference Unit catalog data. The rated conditions for obtaining the
capacities and COPs are at indoor dry-bulb temperature of 21.1 C (70 F) and the source
side entering water temperature of 21.1 C (70 F). Some equations are provided below to
help explain the function of the various performance curves and data fields. For a detailed
description of the algorithm and how the curves are used in the calculations, please see the
Engineering Reference.
Field: Name
This alpha field contains the identifying name for the variable speed heating coil. Any
reference to this coil by another object (e.g., AirLoopHVAC:UnitaryHeatPump:WaterToAir)
will use this name.
Field: Water Inlet Node Name
This alpha field contains the heating coil source side inlet node name.
Field: Water Outlet Node Name
This alpha field contains the heating coil source side outlet node name.
Field: Air Inlet Node Name
This alpha field contains the heating coil load side inlet node name.
Field: Air Outlet Node Name
This alpha field contains the heating coil load side outlet node name.
Field: Number of Speeds
This numeric field contains the maximum number of speed levels that the module uses. The
number of speeds, for which the user input the performance data and curves, has to be equal
to or higher than the maximum number. The performance inputs at higher speeds are
ignored.
Field: Nominal Speed Level
This numeric field defines the nominal speed level, at which the rated capacity, rated air and
water volumetric flow rates are correlated.
9/29/14

1480

Input-Output Reference

Group Heating and Cooling Coils

Field: Gross Rated Heating Capacity at Selected Nominal Speed Level

This numeric field contains the gross rated capacity at the nominal speed level. This field is
autosizable. The gross rated heating capacity is used to determine a capacity scaling factor,
as compared to the Reference Unit capacity at the nominal speed level.

CapacityScaleFactor

Gross Rated Heating Capacity

ReferenceUnit Capacity @ Nominal Speed Level

And then, this scaling factor is used to determine capacities at rated conditions for other
speed levels, as below,

Gross Rated Capacity @ Speed Level x

CapacityScaleFactor ReferenceUnit Capacity @ Speed Level ( x)
Field: Rated Volumetric Air Flow Rate
This numeric field contains the rated volumetric air flow rate on the load side of the heat
pump corresponding to the nominal speed level. This field is autosizable. The value is used
to determine an internal scaling factor, and calculate the air flow rates in the parent objects.
It is recommended that the ratio of the rated volumetric air flow rate to the rated capacity is
the same as the unit performance from the Reference Unit data.

AirFlowScaleFactor
Rated Volumetric Air Flow Rate
ReferenceUnitVol Air Flow Rate @ Nominal Speed Level CapacityScaleFactor
And the volumetric air flow rates in the parent objects are calculated as below,

LoopVolumetric Air Flow Rate @ Speed Level x

AirFlowScaleFactor
ReferenceUnitVol Air Flow Rate @ Speed Level ( x)
CapacityScaleFactor
Field: Rated Volumetric Water Flow Rate
This numeric field contains the rated volumetric water flow rate on the source side of the heat
pump at the nominal speed level. This field is autosizable. The value is used to determine an
internal scaling factor, and calculate the water flow rates at other speed levels. It is
recommended that the ratio of the rated volumetric water flow rate to the rated capacity is the
same as the unit performance from the Reference Unit data.

WaterFlowScaleFactor

Rated VolumetricWater Flow Rate

ReferenceUnitVolWater Flow Rate @ Nominal Speed Level CapacityScaleFactor

And the required volumetric water flow rates in the water loop are calculated as below,

LoopVolumetricWater Flow Rate @ Speed Level x

9/29/14

WaterFlowScaleFactor ReferenceUnitVolWater Flow Rate

1481

Input-Output Reference

Group Heating and Cooling Coils

Field: Part Load Fraction Correlation Curve Name

This alpha field defines the name of a quadratic or cubic performance curve (Ref:
Performance Curves) that parameterizes the variation of electrical power input to the unit as
a function of the part load ratio (PLR, heating load/steady-state heating capacity for Speed 1),
in the case that the unit operates under the lowest speed, i.e. on/off. The product of the rated
EIR and EIR modifier curves is divided by the output of this curve to give the effective EIR
for a given simulation timestep for Speed 1. The part load fraction (PLF) correlation accounts
for efficiency losses due to compressor cycling. The part load fraction correlation should be
normalized to a value of 1.0 when the part load ratio equals 1.0 (i.e., no efficiency losses
when the compressor(s) run continuously for the simulation timestep). For PLR values
between 0 and 1 (0 <= PLR < 1), the following rules apply:
PLF >= 0.7 and PLF >= PLR
If PLF < 0.7, the program resets the PLF value to 0.7, and the simulation proceeds. The
runtime fraction of the coil is defined as PLR/PLF. If PLF < PLR, the runtime fraction of the
coil is limited to 1.0. A typical part load fraction correlation would be:

PLF

0.85 0.15 PLR

If the user wishes to model no efficiency degradation due to compressor cycling, the part load
fraction correlation should be defined as follows:

PLF

0.85 0.0 PLR

Field Group: Rated Specification, Performance Curves, and Waste Heat Data
The performance for each heating speed must be specified as shown below. They should be
directly given from the Reference Unit data. All inputs for Speed 1 are required, followed by
the optional inputs for other speeds.
Field: Speed <x> Reference Unit Gross Rated Heating Capacity
This numeric field defines the total, full load gross heating capacity in watts of the water-to-air
heating coil unit at rated conditions for Speed <x> operation. The value entered here must be
greater than 0. Capacity should not account for the effect of supply air fan heat.
Field: Speed <x> Reference Unit Gross Rated Heating COP
This numeric field defines the coefficient of performance (COP= gross heating capacity in
watts divided by electrical power input in watts) of the heating coil unit at rated conditions for
Speed <x> operation. The value entered here must be greater than 0. The input power
includes power for the compressor(s) and accessories, but does not include the power
consumption of the indoor supply air fan and water pump. The gross COP should not account
for the supply air fan.
Field: Speed <x> Reference Unit Rated Air Flow Rate
This numeric field defines the volume air flow rate, in m3 per second, across the heating coil
at rated conditions for Speed <x> operation. The value entered here should be directly from
the Reference Unit data, corresponding to the given gross rated heating capacity and gross
rated heating COP at the speed, as above.
Field: Speed <x> Reference Unit Rated Water Flow Rate
This numeric field defines the volume water flow rate, in m3 per second, flowing at the source
side of the heating coil at rated conditions for Speed <x> operation. The value entered here
should be directly from the Reference Unit data, corresponding to the given gross rated
heating capacity and gross rated heating COP at the speed, as above.

9/29/14

1482

Input-Output Reference

Group Heating and Cooling Coils

Field: Speed <x> Heating Capacity Function of Temperature Curve Name

This alpha field defines the name of a bi-quadratic performance curve for Speed <x> (ref:
Performance Curves) that parameterizes the variation of the total heating capacity as a
function of the indoor dry-bulb and source side entering water temperature, from the
Reference Unit. The output of this curve is multiplied by the gross rated heating capacity at
the speed to give the gross total heating capacity at specific temperature operating conditions
(i.e., at an indoor air dry-bulb temperature or entering water temperature different from the
rating point temperature). It should be noted that the curve is normalized to the heating
capacity at Speed<x> from the Reference Unit data, and have the value of 1.0 at the rating
point.
Field: Speed <x> Heating Capacity Function of Air Flow Fraction Curve Name
This alpha field defines the name of a quadratic or cubic performance curve for Speed <x>
(ref: Performance Curves) that parameterizes the variation of the gross total heating capacity
as a function of the ratio of actual air flow rate across the heating coil to the design air flow
rate (i.e., fraction of full load flow), at Speed <x> from the Reference Unit data. The curve is
normalized to have the value of 1.0 when the actual air flow rate equals the design air flow
rate at Speed <x>.
Field: Speed <x> Heating Capacity Function of Water Flow Fraction Curve Name
This alpha field defines the name of a quadratic or cubic performance curve for Speed <x>
(ref: Performance Curves) that parameterizes the variation of total heating capacity as a
function of the ratio of actual water flow rate across the heating coil to the design water flow
rate (i.e., fraction of full load flow), at Speed <x> from the Reference Unit data. The curve is
normalized to have the value of 1.0 when the actual water flow rate equals the design air flow
rate at Speed <x>.
The actual total heating capacity at Speed <x>, considering variations in temperatures, air
and water flow rates is calculated as below:

Actual Capacity @ Speed Level x

CapacityScaleFactor

ReferenceUnit Capacity @ Speed Level ( x)

TotCapTempModFac @ Speed Level ( x)
TotCapAirFlowModFac @ Speed Level ( x)
TotCapWaterFlowModFac @ Speed Level ( x)
Field: Speed <x> Energy Input Ratio Function of Temperature Curve Name
This alpha field defines the name of a bi-quadratic, quadratic or cubic performance curve for
Speed <x> (ref: Performance Curves) that parameterizes the variation of the energy input
ratio (EIR) as a function of the both the indoor air dry-bulb and entering water temperatures
The EIR is the inverse of the COP. The output of this curve is multiplied by the rated EIR
(inverse of rated COP at Speed <x> from the Reference Unit data) to give the EIR at specific
temperature operating conditions (i.e., at an indoor air dry bulb temperature or entering water
temperature different from the rating point temperature). The curve is normalized to have the
value of 1.0 at the rating point.
Field: Speed <x> Energy Input Ratio Function of Air Flow Fraction Curve Name
This alpha field defines the name of a quadratic or cubic performance curve for Speed <x>
(ref: Performance Curves) that parameterizes the variation of the energy input ratio (EIR) as
a function of the ratio of actual air flow rate across the heating coil to the design air flow rate
(i.e., fraction of full load flow, at Speed <x> from the Reference Unit data). The EIR is the

9/29/14

1483

Input-Output Reference

Group Heating and Cooling Coils

inverse of the COP. This curve is normalized to a value of 1.0 when the actual air flow rate
equals the rated air flow rate.
Field: Speed <x> Energy Input Ratio Function of Water Flow Fraction Curve Name
This alpha field defines the name of a quadratic or cubic performance curve for Speed <x>
(ref: Performance Curves) that parameterizes the variation of the energy input ratio (EIR) as
a function of the ratio of actual water flow rate across the heating coil to the rated water flow
rate (i.e., fraction of full load flow, at Speed <x> from the Reference Unit data). This curve is
normalized to a value of 1.0 when the actual air flow rate equals the design air flow rate.
The actual EIR at Speed <x>, considering variations in temperatures, air and water flow rates
is calculated as below:

1.0
ReferenceUnit COP @ Speed Level ( x)
EIRTempModFac @ Speed Level ( x)
EIRAirFlowModFac @ Speed Level ( x)
EIRWaterFlowModFac @ Speed Level ( x)

Actual EIR @ Speed Level x

And, the actual power consumption is calculated:

Actual Power @ Speed Level x

Actual Capacity @ Speed Level x

Actual EIR @ Speed Level x

Field: Speed <x> Rated Waste Heat Fraction of Power Input

The fraction of heat input to heating that is available as recoverable waste heat at full load
and rated conditions for Speed <x> operation. The part of heat is not delivered to the indoor
side.
Field: Speed <x> Waste Heat Function of Temperature Curve Name
The name of a bi-quadratic performance curve (ref: Performance Curves) that parameterizes
the variation of the waste heat recovery as a function of indoor dry-bulb temperature and the
entering water temperature for Speed <x> from the Reference Unit data. The output of this
curve is multiplied by the rated recoverable waste heat at specific temperature operating
conditions (i.e., at temperatures different from the rating point). The curve is normalized to a
value of 1.0 at the rating point.
The actual recoverable waste heat at Speed <x> is calculated as below:

ActualWaste Heat @ Speed Level x

Actual Power @ Speed Level x

WasteHeatFrac @ Speed Level ( x)

WasteHeatTempModFac @ Speed Level ( x)
An example of this statement in an IDF is:

9/29/14

1484

Input-Output Reference

Group Heating and Cooling Coils

Coil:Heating:WaterToAirHeatPump:VariableSpeedEquationFit,
Sys 1 Heat Pump Heating Mode,
!- Name
Sys 1 Water to Air Heat Pump Source Side2 Inlet Node,
!- Water Inlet Node Name
Sys 1 Water to Air Heat Pump Source Side2 Outlet Node,
!- Water Outlet Node Name
Sys 1 Heating Coil Air Inlet Node,
!- Air Inlet Node Name
Sys 1 SuppHeating Coil Air Inlet Node,
!- Air Outlet Node Name
10.0,
!- Number of Speeds
10.0,
!- Nominal Speed Level
Autosize,
!- Rated Heating Capacity {W}
Autosize,
!- Rated Air Flow Rate {m3/s}
Autosize,
!- Rated Water Flow Rate {m3/s}
VS Energy Part Load Fraction 1,
!- Energy part load fraction curve
1838.7,
!- Speed 1 Reference Unit Gross Rated Heating Capacity
5.0,
!- Speed 1 Reference Unit Gross Rated Heating COP
0.1661088,
!- Speed 1 Reference Unit Rated Air Flow Rate
0.000381695,
!- Speed 1 Reference Unit Rated Water Flow Rate
Heating VS Temp1 Test,
!- Speed 1 Heating Capacity Function of Temperature Curve Name
Heating VS AirFrac Test, !- Speed 1 Heating Capacity Function of Air Flow Fraction Curve Name
Heating VS WaterFrac Test,!- Speed 1 Heating Capacity Function of Water Flow Fraction Curve Name
EIRH VS Temp1 Test,
!- Speed 1 Energy Input Ratio Function of Temperature Curve Name
EIRH VS AirFrac Test,
!- Speed 1 Energy Input Ratio Function of Air Flow Fraction Curve Name
EIRH VS WaterFrac Test,
!- Speed 1 Energy Input Ratio Function of Water Flow Fraction Curve Name
0.1,
!- Speed 1 Waste Heat Fraction to Power Input
Heating wasteHeat VS Temp1 Test,
!- Speed 1 Waste Heat Function of Temperature Curve Name
2295.5,
!- Speed 2 Reference Unit Gross Rated Heating Capacity
5.0,
!- Speed 2 Reference Unit Gross Rated Heating COP
0.179322,
!- Speed 2 Reference Unit Rated air flow rate
0.000381695,
!- Speed 2 Reference Unit Rated water flow rate
Heating VS Temp1 Test,
!- Speed 2 Heating Capacity Function of Temperature Curve Name
Heating VS AirFrac Test, !- Speed 2 Heating Capacity Function of Air Flow Fraction Curve Name
Heating VS WaterFrac Test,!- Speed 2 Heating Capacity Function of Water Flow Fraction Curve Name
EIRH VS Temp1 Test,
!- Speed 2 Energy Input Ratio Function of Temperature Curve Name
EIRH VS AirFrac Test,
!- Speed 2 Energy Input Ratio Function of Air Flow Fraction Curve Name
EIRH VS WaterFrac Test,
!- Speed 2 Energy Input Ratio Function of Water Flow Fraction Curve Name
0.1,
!- Speed 2 Waste Heat Fraction to Power Input
Heating wasteHeat VS Temp1 Test, !- Speed 2 Waste Heat Function of Temperature Curve Name
2751.3,
!- Speed 3 Reference Unit Gross Rated Heating Capacity
5.0,
!- Speed 3 Reference Unit Gross COP
0.1925352,
!- Speed 3 Reference Unit Rated Air Flow Rate
0.000381695,
!- Speed 3 Reference Unit Rated Water Flow Rate
Heating VS Temp1 Test,
!- Speed 3 Heating Capacity Function of Temperature Curve Name
Heating VS AirFrac Test,
!- Speed 3 Heating Capacity Function of Air Flow Fraction Curve Name
Heating VS WaterFrac Test,!- Speed 3 Heating Capacity Function of Water Flow Fraction Curve Name
EIRH VS Temp1 Test,
!- Speed 3 Energy Input Ratio Function of Temperature Curve Name
EIRH VS AirFrac Test,
!- Speed 3 Energy Input Ratio Function of Air Flow Fraction Curve Name
EIRH VS WaterFrac Test,
!- Speed 3 Energy Input Ratio Function of Water Flow Fraction Curve Name
0.1,
!- Speed 3 Waste Heat fraction to power input
Heating wasteHeat VS Temp1 Test, !- Speed 3 Waste Heat Function of Temperature Curve Name
3659.6,
!- Speed 4 Reference Unit Gross Rated Heating Capacity
5.0,
!- Speed 4 Reference Unit Gross Rated Heating COP
0.2189616,
!- Speed 4 Reference Unit Rated air flow rate
0.000381695,
!- Speed 4 Reference Unit Rated water flow rate
Heating VS Temp1 Test,
!- Speed 4 Heating Capacity Function of Temperature Curve Name
Heating VS AirFrac Test,
!- Speed 4 Heating Capacity Function of Air Flow Fraction Curve Name
Heating VS WaterFrac Test,!- Speed 4 Heating Capacity Function of Water Flow Fraction Curve Name
EIRH VS Temp1 Test,
!- Speed 4 Energy Input Ratio Function of Temperature Curve Name
EIRH VS AirFrac Test,
!- Speed 4 Energy Input Ratio Function of Air Flow Fraction Curve Name
EIRH VS WaterFrac Test,
!- Speed 4 Energy Input Ratio Function of Water Flow Fraction Curve Name
0.1,
!- Speed 4 Waste Heat fraction to power input
Heating wasteHeat VS Temp1 Test, !- Speed 4 Waste Heat Function of Temperature Curve Name

9/29/14

1485

Input-Output Reference

Group Heating and Cooling Coils

4563.7,
!- Speed 5 Reference Unit Gross Rated Heating Capacity
5.0,
!- Speed 5 Reference Unit Gross Rated Heating COP
0.245388,
!- Speed 5 Reference Unit Rated air flow rate
0.000381695,
!- Speed 5 Reference Unit Rated water flow rate
Heating VS Temp1 Test,
!- Speed 5 Heating Capacity Function of Temperature Curve Name
Heating VS AirFrac Test,
!- Speed 5 Heating Capacity Function of Air Flow Fraction Curve Name
Heating VS WaterFrac Test,!- Speed 5 Heating Capacity Function of Water Flow Fraction Curve Name
EIRH VS Temp1 Test,
!- Speed 5 Energy Input Ratio Function of Temperature Curve Name
EIRH VS AirFrac Test,
!- Speed 5 Energy Input Ratio Function of Air Flow Fraction Curve Name
EIRH VS WaterFrac Test,
!- Speed 5 Energy Input Ratio Function of Water Flow Fraction Curve Name
0.1,
!- Speed 5 Waste Heat fraction to power input
Heating wasteHeat VS Temp1 Test, !- Speed 5 Waste Heat Function of Temperature Curve Name
5463.3,
!- Speed 6 Reference Unit Gross Rated Heating Capacity
5.0,
!- Speed 6 Reference Unit Gross Rated Heating COP
0.2718144,
!- Speed 6 Reference Unit Rated air flow rate
0.000381695,
!- Speed 6 Reference Unit Rated water flow rate
Heating VS Temp1 Test,
!- Speed 6 Heating Capacity Function of Temperature Curve Name
Heating VS AirFrac Test, !- Speed 6 Heating Capacity Function of Air Flow Fraction Curve Name
Heating VS WaterFrac Test,!- Speed 6 Heating Capacity Function of Water Flow Fraction Curve Name
EIRH VS Temp1 Test,
!- Speed 6 Energy Input Ratio Function of Temperature Curve Name
EIRH VS AirFrac Test,
!- Speed 6 Energy Input Ratio Function of Air Flow Fraction Curve Name
EIRH VS WaterFrac Test,
!- Speed 6 Energy Input Ratio Function of Water Flow Fraction Curve Name
0.1,
!- Speed 6 Waste Heat fraction to power input
Heating wasteHeat VS Temp1 Test, !- Speed 6 Waste Heat Function of Temperature Curve Name
6358.4,
!- Speed 7 Reference Unit Gross Rated Heating Capacity
5.0,
!- Speed 7 Reference Unit Gross Rated Heating COP
0.2982408,
!- Speed 7 Reference Unit Rated air flow rate
0.000381695,
!- Speed 7 Reference Unit Rated water flow rate
Heating VS Temp1 Test,
!- Speed 7 Heating Capacity Function of Temperature Curve Name
Heating VS AirFrac Test, !- Speed 7 Heating Capacity Function of Air Flow Fraction Curve Name
Heating VS WaterFrac Test,!- Speed 7 Heating Capacity Function of Water Flow Fraction Curve Name
EIRH VS Temp1 Test,
!- Speed 7 Energy Input Ratio Function of Temperature Curve Name
EIRH VS AirFrac Test,
!- Speed 7 Energy Input Ratio Function of Air Flow Fraction Curve Name
EIRH VS WaterFrac Test,
!- Speed 7 Energy Input Ratio Function of Water Flow Fraction Curve Name
0.1,
!- Speed 7 Waste Heat fraction to power input
Heating wasteHeat VS Temp1 Test,!- Speed 7 Waste Heat Function of Temperature Curve Name
7248.5,
!- Speed 8 Reference Unit Gross Rated Heating Capacity
5.0,
!- Speed 8 Reference Unit Gross Rated Heating COP
0.3246672,
!- Speed 8 Reference Unit Rated air flow rate
0.000381695,
!- Speed 8 Reference Unit Rated water flow rate
Heating VS Temp1 Test,
!- Speed 8 Heating Capacity Function of Temperature Curve Name
Heating VS AirFrac Test, !- Speed 8 Heating Capacity Function of Air Flow Fraction Curve Name
Heating VS WaterFrac Test,!- Speed 8 Heating Capacity Function of Water Flow Fraction Curve Name
EIRH VS Temp1 Test,
!- Speed 8 Energy Input Ratio Function of Temperature Curve Name
EIRH VS AirFrac Test,
!- Speed 8 Energy Input Ratio Function of Air Flow Fraction Curve Name
EIRH VS WaterFrac Test,
!- Speed 8 Energy Input Ratio Function of Water Flow Fraction Curve Name
0.1,
!- Speed 8 Waste Heat fraction to power input
Heating wasteHeat VS Temp1 Test, !- Speed 8 Waste Heat Function of Temperature Curve Name
8133.6,
!- Speed 9 Reference Unit Gross Heating Capacity
5.0,
!- Speed 9 Reference Unit Gross Rated Heating COP
0.3510936,
!- Speed 9 Reference Unit Rated air flow rate
0.000381695,
!- Speed 9 Reference Unit Rated water flow rate
Heating VS Temp1 Test,
!- Speed 9 Heating Capacity Function of Temperature Curve Name
Heating VS AirFrac Test, !- Speed 9 Heating Capacity Function of Air Flow Fraction Curve Name
Heating VS WaterFrac Test,!- Speed 9 Heating Capacity Function of Water Flow Fraction Curve Name
EIRH VS Temp1 Test,
!- Speed 9 Energy Input Ratio Function of Temperature Curve Name
EIRH VS AirFrac Test,
!- Speed 9 Energy Input Ratio Function of Air Flow Fraction Curve Name
EIRH VS WaterFrac Test,
!- Speed 9 Energy Input Ratio Function of Water Flow Fraction Curve Name
0.1,
!- Speed 9 Waste Heat fraction to power input
Heating wasteHeat VS Temp1 Test, !- Speed 9 Waste Heat Function of Temperature Curve Name

9/29/14

1486

Input-Output Reference

Group Heating and Cooling Coils

9013.2,
!- Speed 10 Reference Unit Gross Rated Heating Capacity
5.0,
!- Speed 10 Reference Unit Gross Rated Heating COP
0.37752,
!- Speed 10 Reference Unit Rated air flow rate
0.000381695,
!- Speed 10 Reference Unit Rated water flow rate
Heating VS Temp1 Test, !- Speed 10 Heating Capacity Function of Temperature Curve Name
Heating VS AirFrac Test, !- Speed 10 Heating Capacity Function of Air Flow Fraction Curve Name
Heating VS WaterFrac Test,!- Speed 10 Heating Capacity Function of Water Flow Fraction Curve
EIRH VS Temp1 Test,
!- Speed 10 Energy Input Ratio Function of Temperature Curve Name
EIRH VS AirFrac Test, !- Speed 10 Energy Input Ratio Function of Air Flow Fraction Curve Name
EIRH VS WaterFrac Test, !- Speed 10 Energy Input Ratio Function of Water Flow Fraction Curve Name
0.1,
!- Speed 10 Waste Heat fraction to power input
Heating wasteHeat VS Temp1 Test; !- Speed 10 Waste Heat Function of Temperature Curve Name

Variable Speed Water to Air Heat Pump Heating Coil Outputs

HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,
HVAC,

Average, Heating Coil Electric Power [W]

Average, Heating Coil Heating Rate [W]
Average, Heating Coil Sensible Heating Rate [W]
Average, Heating Coil Source Side Heat Transfer Rate [W]
Average, Heating Coil Part Load Ratio
Average, Heating Coil Runtime Fraction []
Average, Heating Coil Air Mass Flow Rate [kg/s]
Average, Heating Coil Air Inlet Temperature [C]
Average, Heating Coil Air Inlet Humidity Ratio [kgWater/kgDryAir]
Average, Heating Coil Air Outlet Temperature [C]
Average, Heating Coil Air Outlet Humidity Ratio [kgWater/kgDryAir]
Average, Heating Coil Source Side Mass Flow Rate [kg/s]
Average, Heating Coil Source Side Inlet Temperature [C]
Average, Heating Coil Source Side Outlet Temperature [C]
Average, Heating Coil Upper Speed Level []
Average, Heating Coil Neighboring Speed Levels Ratio []
Average, Heating Coil Recoverable Heat Transfer Rate [W]
Sum, Heating Coil Electric Energy [J]
Sum, Heating Coil Heating Energy [J]
Sum, Heating Coil Source Side Heat Transfer Energy [J]

Heating Coil Electric Power [W]

This output variable is the average electric consumption rate of the heat pump in Watts over
the timestep being reported.
Heating Coil Heating Rate [W]
The output variable is the average total heating capacity provide by the heat pump in Watts
over the timestep being reported.
Heating Coil Sensible Heating Rate [W]
The output variable is the average sensible heating capacity provide by the heat pump in
Watts over the timestep being reported. For heating mode, the sensible capacity is equal to
the total capacity.
Heating Coil Source Side Heat Transfer Rate [W]
The output variable is the average heat absorbed at the heat pump evaporator in Watts over
the timestep being reported.
Heating Coil Part Load Ratio []
This output variable is the ratio of the part-load capacity to the steady state capacity of the
VSWatertoAirHP coil. For the cycling fan mode, the runtime fraction for the heat pump
compressor may be different from the compressor part-load ratio reported here due to the
part-load performance of the VSWatertoAirHP coil (delay at start-up to reach steady-state
output). In general, runtime fractions are reported by individual components where
appropriate.
9/29/14

1487

Input-Output Reference

Group Heating and Cooling Coils

Heating Coil Runtime Fraction []

This output variable is the function of the part load ratio (PLR, part-load capacity/ steady state
capacity). The duty factor or part load fraction accounts for efficiency losses due to
compressor cycling.
Heating Coil Air Mass Flow Rate [kg/s]
The output variable is the average air mass flow rate going through the heat pump over the
timestep being reported.
Heating Coil Air Inlet Temperature [C]
The output variable is the average entering air dry-bulb temperature over the timestep being
reported.
Heating Coil Air Inlet Humidity Ratio [kgWater/kgDryAir]
The output variable is the average entering air dry humidity ratio over the timestep being
reported.
Heating Coil Air Outlet Temperature [C]
The output variable is the average leaving air dry-bulb temperature over the timestep being
reported.
Heating Coil Air Outlet Humidity Ratio [kgWater/kgDryAir]
The output variable is the average leaving air dry humidity ratio over the timestep being
reported.
Heating Coil Source Side Mass Flow Rate [kg/s]
The output variable is the average water mass flow rate going through the heat pump over
the timestep being reported.
Heating Coil Source Side Inlet Temperature [C]
The output variable is the average entering water temperature over the timestep being
reported.
Heating Coil Source Side Outlet Temperature [C]
The output variable is the average leaving water temperature over the timestep being
reported.
Heating Coil Upper Speed Level []
The output variable is the average upper speed level, for interpolating performances between
two neighboring speed levels.
Heating Coil Neighboring Speed Levels Ratio []
The output variable is the average speed ratio, for interpolating performances between two
neighboring speed levels.
Heating Coil Recoverable Heat Transfer Rate [W]
This output variable is the average recoverable waste heat rate of the heat pump in Watts
over the timestep being reported.
Heating Coil Electric Energy [J]
The output variable is the total electric consumption of the heat pump in Joules over the
timestep being reported.

9/29/14

1488

Input-Output Reference

Group Heating and Cooling Coils

Heating Coil Heating Energy [J]

The output variable is the total cooling output of the coil in Joules over the timestep being
reported.
Heating Coil Source Side Heat Transfer Energy [J]
The output variable is the total source side heat transfer of the coil in Joules over the
timestep being reported.
Coil:Cooling:DX:SingleSpeed:ThermalStorage
This object models a special direct expansion (DX) cooling coil that includes methods of
storing thermal energy within the cooling coil package. This packaged thermal storage
cooling coil model includes all of the equipment needed to charge and discharge and the
Thermal Energy Storage (TES) tank itself.
This coil object is used with
CoilSystem:Cooling:DX object and a constant volume supply fan, but all other
subcomponents are contained within the package.
Some types of devices may have a process air cooling section that actually has two coils,
one an evaporator and the second some other kind of coil that cools by discharging the TES
tank. There may also be two separate heat engines inside the package with two
compressors. The model wraps these complexities inside of the model which considers just
one process air cooling section that combines both types of coils and one heat rejection
condenser section that rejects heat from both engines. The operating modes that are likely to
have two heat engines offer dual sets of rating points and performance curves to model the
energy and capacity implications separately.
The model offers various modes of operation that can be controlled over time using either a
schedule or EMS actuators. The user can choose which of the five operating modes are
present in the device. Each of the modes has its own separate set of performance
characteristics and curves and the model can change abruptly from one mode to the next.
For example when using the schedule control, the TES coil can be put into Charge Only
Mode for some number of hours at night, operated in Cooling Only Mode during the mild
morning hours, and run in Discharge Only Mode during the hottest part of the day. Custom
control routines can be programmed using EMS to obtain a dynamic, supervisory control
algorithm.
Off Mode. This mode is always present. Although the coil will not do any cooling, the
state of the TES tank is still modeled since it can continue to exchange heat with the
surrounding ambient air.
Cooling Only Mode. This mode is where the coil cools air at the evaporator using a
model that is very similar to the regular, single speed DX cooling coil. The same five
performance curves are used to describe cooling capacity and electric power use.
The sensible heat ratio is described using two performance curves in the same as is
available for 100% outdoor air coils. The TES tank is neither charged or discharged
but it continues to exchange heat with the surrounding ambient air.
Cooling And Charge Mode. This mode is where the coil both cools air at the
evaporator and cools the TES tank at the same time. The model supports separate
performance characteristics when there two separate heat engines, one for
evaporator cooling and one for charging the TES tank.
Cooling and Discharge Mode. This mode is where the coil cools process air and heat
is rejected to both the condenser section and the TES tank at the same time. The
model supports separate performance characteristics when there two separate heat
engines, one for evaporator cooling and one for TES cooling.
Charge Only Mode. This mode is where the coil charges the TES tank but does not
provide any cooling at the process air cooling section.

9/29/14

1489

Input-Output Reference

Group Heating and Cooling Coils

Discharge Only Mode. This mode is where the coil cools process air by discharging
the TES tank.
This cooling coil can be autosized. The cooling capacity for the cooling only mode is sized to
meet the air systems final design cooling capacity. The cooling capacity for the other modes,
and the storage capacity, can all be scaled relative to that one capacity using sizing factors
that can be input by the user.
Field: Name
A unique name for this TES coil object, assigned by user.
Field: Availability Schedule Name
The name of a schedule that determines whether the TES coil is available for cooling during
a given time period. A schedule value greater than 0 (usually 1 is used) indicates that the
unit can be on during a given time period. A value less than or equal to 0 (usually 0 is used)
denotes that unit must be in off mode. If this field is blank, the schedule has values of 1 for
all time periods.
Field: Operating Mode Control Method
This field determines how the TES coil is to be controlled in terms of which operating mode is
in effect for a given time period.
There are two choices, ScheduledModes or
EMSControlled.
Choosing ScheduledModes indicates that the operating mode is
determined by the values in a schedule that is named in the following input field. Choosing
EMSControlled indicates that the operating mode is determined by the state of an EMS
actuator called Coil:Cooling:DX:SingleSpeed:ThermalStorage with the control type
Operating Mode.
Field: Operation Mode Control Schedule Name
This field is used (and required) if the operating model control method is set to
ScheduledModes in the previous input field. The control schedule consists of a series of
integer values that indicate what mode the TES coil should operate in for a given time period.
The values for various operating modes have been programmed to be as follows:
0. Off Mode
1. Cooling Only Mode
2. Cooling And Charge Mode
3. Cooling And Discharge Mode
4. Charge Only Mode
5. Discharge Only Mode
Field: Storage Type
This field is used to determine what type of material is used for thermal storage. There are
two basic types of thermal storage material, fluid or ice. For fluid tanks, the material can be
water or a user-defined fluid such as a glycol and the storage of thermal energy accompanies
changes in the temperature of the fluid in the tank. For ice tanks, the material is water ice
and the storage of thermal energy accompanies changes in the fraction of ice. This input
field has three possible choices: Water, UserDefinedFluidType, Or Ice. Choose Water for
a fluid tank TES based on water. Choose UserDefinedFluidType for a fluid tank TES based
on custom or glycol type fluid. Choose Ice for ice-based TES tank.
Field: User Defined Fluid Type
This field is used to declare what type of user defined fluid is contained in the TES tank. This
input field is only used (and required) if the previous field is set to UserDefinedFluidType.
Water, EthyleneGlycol, and PropoleneGlycol have fluid properties built-in to EnergyPlus.
9/29/14

1490

Input-Output Reference

Group Heating and Cooling Coils

Using a FluidProperties:GlycolConcentration object allows specifying a mixture of water and

a glycol and the name of one can be entered here. For other types of fluids, a complete set
of fluid property data is needed, see FluidProperties:Name, FluidProperties:Temperature, etc.
Field: Fluid Storage Volume [m3]
This field is used to describe the size of fluid-based TES tank, in m3. The storage volume can
be automatically calculated based on the cooling capacity and sizing factor.
Field: Ice Storage Capacity [GJ]
This field is used to describe the size of ice-based TES tank, in GJ. The storage capacity can
be automatically calculated based on the cooling capacity and a sizing factor.
Field: Storage Capacity Sizing Factor [hr]
This field is used if one of the previous two fields is set to autocalculate. The value entered
here is a time duration, in hours. This time period is used for calculating a storage capacity.
The basic idea is that storage be sized such that the TES can provide cooling at rated
capacity for this amount of time. The rated capacity used in the sizing calculation is the
Discharge Only Mode Rated Storage Discharging Capacity unless the Discharge Only mode
is not available in which case it is the Cooling Only Mode Rated Total Evaporator Cooling
Capacity. This sizing factor approach allows scaling the storage size relative to the TES
coils capacity. The sizing factor is applied for an ice-based TES by simply multiplying the
rated capacity by the time duration (converted to seconds). For fluid-based TES, a change in
fluid temperature of 10C is assumed to calculate the tank volume.
Field: Storage Tank Ambient Temperature Node Name
This field is used to assign the environmental conditions surrounding the TES coil. The
thermal storage tank exchanges heat with its surroundings and the boundary conditions for
those surrounding are taken from this node named in this field. Typically this is the name of a
node declared to be an outdoor air node. This field is required.
Field: Storage Tank to Ambient U-value Times Area Heat Transfer Coefficient [W/K]
This field is used to characterize the rate at which heat is exchanged between the TES tank
and the surrounding ambient conditions, in W/K. This is an overall UA value for the tank
where the U-factor and surface area are combined into one coefficient. Heat loss or gain to
the TES tank is modeled using

UA

Tank

TTES TAmb . This field is required.

Field: Fluid Storage Tank Rating Temperature [C]

This field is used to define what temperature is used for rating conditions when using a fluid
storage tank. This field is only used for Storage Type of Water or UserDefinedFluidType.
The temperature here is used for declaring the state of the TES fluid tank that corresponds to
Rated conditions. The temperature entered here is used to define fluid properties and to
characterize the performance curves that depend on the state of the TES.
Field: Rated Evaporator Air Flow Rate [m3/s]
This field is the air volume flow rate through the coil, in m 3/s, at rating conditions. This is the
rated air flow rate through the evaporator (and any other air cooling devices that are in series
with the main evaporator). The coil can be operated with a different flow rate than this rated
flow rate and the performance of the unit scales accordingly using the curves that are of the
type Function of Flow Fraction Curve. All of the other rated values for capacity, COP, and
SHR values, for all the various modes, should be determined at the same air flow rate used
here. This field can be autosized.

9/29/14

1491

Input-Output Reference

Group Heating and Cooling Coils

Field: Evaporator Air Inlet Node Name

This field is the name of an HVAC system node that the coil draws in as its inlet air. This for
the evaporators connection to air system but it may include other air cooling devices that are
in series with the evaporator and contained within the packaged TES coil. This node must be
unique across the model. This field is required.
Field: Evaporator Air Outlet Node Name
This field is the name of an HVAC system node that the coils sends its outlet air. This for the
evaporators connection to air system but it may include other air cooling devices that are in
series with the evaporator and contained within the packaged TES coil. This node must be
unique across the model. This field is required.
Field: Cooling Only Mode Available
This field is used to indicate if the packaged TES coil includes a mode with only cooling and
no equipment is interacting with TES tank to charge or discharge it. The choices are Yes or
No. This field is required.
Field: Cooling Only Mode Rated Total Evaporator Cooling Capacity [W]
This field is used to specify the total, full load cooling capacity (sensible plus latent), in Watts,
of the TES coil at rated conditions, while operating in Cooling Only Mode. The rating
conditions are air entering the cooling coil at 26.7C drybulb, 19.4C wetbulb and air entering
the outdoor condenser section at 35C drybulb and 23.9C wetbulb, and the air flow rate
specified in Rated Evaporator Air Flow Rate. Capacity should be gross (i.e. supply air fan
heat is NOT included). This total cooling capacity is a central value for TES coil in the sense
that it is the basis for various autocalculated sizes for the rest of the model which can be
scaled off of this one value. This field is required if Cooling Only Mode is available or if
another operating modes capacity, or storage capacity, will be autocalculated from this
value. This field is autosizable.
Field: Cooling Only Mode Rated Sensible Heat Ratio
This field is used to specify the sensible heat ratio (SHR) at rating conditions while operating
in Cooling Only Mode. SHR is the sensible cooling capacity divided by the total (sensible
plus latent) cooling capacity and is dimensionless. The rating conditions are air entering the
cooling coil at 26.7C drybulb, 19.4C wetbulb, air entering the outdoor condenser section at
35C drybulb and 23.9C wetbulb, and cooling coil air flow rate specified in Rated Evaporator
Air Flow Rate. Both the sensible and total cooling capacities used to define the rated SHR
should be gross and not include supply fan heat. The packaged TES coil model uses SHR
curves to modify the rated SHR as conditions move away from the rating conditions. This
field is only used if Cooling Only Mode is available. If this input is left blank, the default is 0.7.
Field: Cooling Only Mode Rated COP
This field is used to specify the coefficient of performance (COP) at rating conditions while
operating in Cooling Only Mode. COP is the total cooling power output in watts divided by
the electric power input in watts and is dimensionless. The rating conditions are air entering
the cooling coil at 26.7C drybulb, 19.4C wetbulb, air entering the outdoor condenser section
at 35C drybulb and 23.9C wetbulb, and cooling coil air flow rate specified in Rated
Evaporator Air Flow Rate. The electric input power includes power for the compressor(s),
condenser fan(s), and internal controls but does not include the electric power for the supply
fan (which is modeled separately in EnergyPlus). The total cooling power output is the same
as the value for the Cooling Only Mode Rated Total Evaporator Cooling Capacity and is
gross cooling without the fan heat. This field is only used if Cooling Only Mode is available. If
this input is left blank, the default is 3.0.

9/29/14

1492

Input-Output Reference

Group Heating and Cooling Coils

Field: Cooling Only Mode Total Evaporator Cooling Capacity Function of Temperature
Curve Name
This field is the name of a separate performance curve object that parameterizes the
variation of the total cooling capacity as a function of (1) the wetbulb temperature of air
entering the evaporator section of the TES coil and (2) the drybulb temperature of the air
entering the condenser section. The performance curve can be any curve or table based on
two
independent
variables,
x
and
y,
including:
Curve:Biquadratic,
Table:TwoIndependentVariables, Curve:Bicubic, and Curve:QuadraticLinear. The x values
for the performance curve are the wetbulb temperature of air entering the evaporator section.
The y values for the performance curve are the drybulb temperature of air entering the
condenser section (which if using evaporatively-cooled condenser the temperature will be
adjusted to approach the wetbulb temperature depending on effectiveness). The performance
curve is normalized to have a value of 1.0 at the rating point which is defined to be x = 19.4C
and y= 35.0C. The result of the curve is multiplied by Cooling Only Mode Rated Total
Evaporator Cooling Capacity to model capacity at temperatures away from the rating point.
This field is required if Cooling Only Mode is available.
Field: Cooling Only Mode Total Evaporator Cooling Capacity Function of Flow Fraction
Curve Name
This field is the name of a separate performance curve object that parameterizes the
variation of the total cooling capacity as a function of the ratio of actual air flow rate across
the cooling coil to the value of the Rated Evaporator Air Flow Rate. The performance curve
can be any curve or table based on one independent variable, x, including: Curve:Linear,
Curve:Quadratic,
Curve:Cubic,
Curve:Quartic,
Curve:Exponent,
Curve:ExponentialSkewNormal,
Curve:Sigmoid,
Curve:RectuangularHyperbola1,
Curve:RectangularHyperbola2, Curve:ExponentialDecay, Curve:DoubleExponentialDecay,
and Table:OneIndependentVariable. The performance curve is normalized to have a value of
1.0 at the rating point which is defined to be x = 1.0. The result of the curve is multiplied by
the Cooling Only Mode Rated Total Evaporator Cooling Capacity to model capacity at air flow
rates away from the rating point. This field is required if Cooling Only Mode is available.
Field: Cooling Only Mode Energy Input Ratio Function of Temperature Curve Name
This field is the name of a separate performance curve object that parameterizes the
variation of the energy input ratio (EIR) as a function of (1) the wetbulb temperature of air
entering the evaporator section of the TES coil and (2) the drybulb temperature of the air
entering the condenser section. The performance curve can be any curve or table based on
two
independent
variables,
x
and
y,
including:
Curve:Biquadratic,
Table:TwoIndependentVariables, Curve:Bicubic, and Curve:QuadraticLinear. The x values
for the performance curve are the wetbulb temperature of air entering the evaporator section.
The y values for the performance curve are the drybulb temperature of air entering the
condenser section (which if using evaporatively-cooled condenser the temperature will be
adjusted to approach the wetbulb temperature depending on effectiveness).
The
performance curve is normalized to have a value of 1.0 at the rating point which is defined to
be x = 19.4C and y= 35.0C. The result of this curve is multiplied by the inverse of the
Cooling Only Mode Rated COP to model electric energy consumption at temperatures away
from the rating point. This field is required if Cooling Only Mode is available.
Field: Cooling Only Mode Energy Input Ratio Function of Flow Fraction Curve Name
This field is the name of a separate performance curve object that parameterizes the
variation of the energy input ratio (EIR) as a function of the ratio of actual air flow rate across
the cooling coil to the value of the Rated Evaporator Air Flow Rate. The performance curve
can be any curve or table based on one independent variable, x, including: Curve:Linear,
Curve:Quadratic,
Curve:Cubic,
Curve:Quartic,
Curve:Exponent,
Curve:ExponentialSkewNormal,
Curve:Sigmoid,
Curve:RectuangularHyperbola1,
Curve:RectangularHyperbola2, Curve:ExponentialDecay, Curve:DoubleExponentialDecay,
9/29/14

1493

Input-Output Reference

Group Heating and Cooling Coils

and Table:OneIndependentVariable. The performance curve is normalized to have a value of

1.0 at the rating point which is defined to be x = 1.0. The result of the curve is multiplied by
the inverse of the Cooling Only Mode Rated COP to model electric energy consumption at air
flow rates away from the rating point. This field is required if Cooling Only Mode is available.
Field: Cooling Only Mode Part Load Fraction Correlation Curve Name
This field is the name of a separate performance curve object that parameterizes the
variation of the energy input ratio (EIR) as a function of the part load ratio (PLR). PLR is the
ratio of current cooling load to the current cooling capacity. The performance curve can be
any curve or table based on one independent variable, x, including: Curve:Linear,
Curve:Quadratic,
Curve:Cubic,
Curve:Quartic,
Curve:Exponent,
Curve:ExponentialSkewNormal,
Curve:Sigmoid,
Curve:RectuangularHyperbola1,
Curve:RectangularHyperbola2, Curve:ExponentialDecay, Curve:DoubleExponentialDecay,
and Table:OneIndependentVariable. The performance curve is normalized to have a value of
1.0 at the rating point which is defined to be x = 1.0. The result of the curve is the part load
fraction (PLF) and the runtime fraction of the coil is defined as PLR divided by PLF. The
runtime fraction is then multiplied by the energy input ratio to model electric energy
consumption at part load to account for inefficiencies because of compressor cycling. This
field is required if Cooling Only Mode is available.
Field: Cooling Only Mode Sensible Heat Ratio Function of Temperature Curve Name
This field is the name of a separate performance curve object that parameterizes the
variation of the sensible heat ratio (SHR) as a function of (1) the wetbulb temperature of air
entering the evaporator section of the TES coil and (2) the drybulb temperature of the air
entering the evaporator section. The performance curve can be any curve or table based on
two
independent
variables,
x
and
y,
including:
Curve:Biquadratic,
Table:TwoIndependentVariables, Curve:Bicubic, and Curve:QuadraticLinear. The x values
for the performance curve are the wetbulb temperature of air entering the evaporator section.
The y values for the performance curve are the drybulb temperature of air entering the
evaporator section. The performance curve is normalized to have a value of 1.0 at the rating
point which is defined to be x = 19.4C and y= 26.7C. The result of the curve is multiplied by
the Cooling Only Mode Rated Sensible Heat Ratio to model the SHR at coil entering
temperatures that differ from the rating point. This field is required if Cooling Only Mode is
available.
Field: Cooling Only Mode Sensible Heat Ratio Function of Flow Fraction Curve Name
This field is the name of a separate performance curve object that parameterizes the
variation of the sensible heat ratio (SHR) as a function of the ratio of actual air flow rate
across the cooling coil to the value of the Rated Evaporator Air Flow Rate. The performance
curve can be any curve or table based on one independent variable, x, including:
Curve:Linear,
Curve:Quadratic,
Curve:Cubic,
Curve:Quartic,
Curve:Exponent,
Curve:ExponentialSkewNormal,
Curve:Sigmoid,
Curve:RectuangularHyperbola1,
Curve:RectangularHyperbola2, Curve:ExponentialDecay, Curve:DoubleExponentialDecay,
and Table:OneIndependentVariable. The performance curve is normalized to have a value of
1.0 at the rating point which is defined to be x = 1.0. The result of the curve is multiplied by
the Cooling Only Mode Rated Sensible Heat Ratio to model the SHR at coil air flow rates that
differ from the rating point. This field is required if Cooling Only Mode is available.
Field: Cooling And Charge Mode Available
This field is used to indicate if the packaged TES coil includes a mode with both cooling at
the coil and charging of the TES tank at the same time. The choices are Yes or No. This
field is required.

9/29/14

1494

Input-Output Reference

Group Heating and Cooling Coils

Field: Cooling And Charge Mode Rated Total Evaporator Cooling Capacity [W]
This field is used to specify the total, full load cooling capacity (sensible plus latent), in Watts,
of the TES coil at rated conditions, while operating in Cooling And Charge Mode. The rating
conditions are air entering the cooling coil at 26.7C drybulb, 19.4C wetbulb and air entering
the outdoor condenser section at 35C drybulb and 23.9C wetbulb, the air flow rate specified
in Rated Evaporator Air Flow Rate, and the state of TES at either the Fluid Storage Tank
Rating Temperature (for water or fluid storage type) or an ice fraction of 0.5 (for ice storage
type). Capacity should be gross (i.e. supply air fan heat is NOT included). The Cooling and
Charge Mode has two capacities, this first one is for cooling and would typically be for a
heat engine operating between the condenser and the evaporator. This field is required if
Cooling And Charge Mode is available.
This field is autocalculatable. When autocalculating the capacity, the following sizing factor
field is used to scale this capacity relative to the Cooling Only Mode Rated Total Evaporator
Cooling Capacity.
Field: Cooling And Charge Mode Capacity Sizing Factor
This field is used if the previous input field is set to autocalculate. This sizing factor is
multiplied by the Cooling Only Mode Rated Total Evaporator Cooling Capacity to obtain a
scaled value for Cooling and Charge Mode Rated Total Evaporator Cooling Capacity, in
Watts. If this field is left blank the default values is 0.5.
Field: Cooling And Charge Mode Rated Storage Charging Capacity [W]
This field is used to specify the total, full load charging capacity, in Watts, of the TES coil at
rated conditions, while operating in Cooling And Charge Mode. The rating conditions are air
entering the cooling coil at 26.7C drybulb, 19.4C wetbulb and air entering the outdoor
condenser section at 35C drybulb and 23.9C wetbulb, the air flow rate specified in Rated
Evaporator Air Flow Rate, and the state of TES at either the Fluid Storage Tank Rating
Temperature (for water or fluid storage type) or an ice fraction of 0.5 (for ice storage type).
Capacity should be net (i.e. any ancillary equipment inside the package needed for charging
is included). The Cooling and Charge Mode has two capacities, this second one is for
charging and would typically be for a heat engine operating between the condenser and the
TES tank. This field is required if Cooling And Charge Mode is available.
This field is autocalculatable. When autocalculating the capacity, the following sizing factor
field is used to scale this capacity relative to the Cooling Only Mode Rated Total Evaporator
Cooling Capacity.
Field: Cooling And Charge Mode Storage Capacity Sizing Factor
This field is used if the previous input field is set to autocalculate. This sizing factor is
multiplied by the Cooling Only Mode Rated Total Evaporator Cooling Capacity to obtain a
scaled value for Cooling and Charge Mode Rated Storage Charging Capacity, in Watts. If this
field is left blank the default values is 0.5.
Field: Cooling And Charge Mode Rated Sensible Heat Ratio
This field is used to specify the sensible heat ratio (SHR) at rating conditions while operating
in Cooling And Charge Mode. SHR is the sensible cooling capacity divided by the total
(sensible plus latent) cooling capacity and is dimensionless. The rating conditions are air
entering the cooling coil at 26.7C drybulb, 19.4C wetbulb, air entering the outdoor
condenser section at 35C drybulb and 23.9C wetbulb, and cooling coil air flow rate
specified in Rated Evaporator Air Flow Rate. Both the sensible and total cooling capacities
used to define the rated SHR should be gross and not include supply fan heat. The
packaged TES coil model uses SHR curves to modify the rated SHR as conditions move
away from the rating conditions. This field is only used if Cooling And Charge Mode is
available. If this input is left blank, the default is 0.7.

9/29/14

1495

Input-Output Reference

Group Heating and Cooling Coils

Field: Cooling And Charge Mode Cooling Rated COP

This field is used to specify the coefficient of performance (COP) at rating conditions while
operating in Cooling And Charge Mode to cool air at the evaporator. COP is the total cooling
power output in watts divided by the electric power input in watts and is dimensionless. The
rating conditions are air entering the cooling coil at 26.7C drybulb, 19.4C wetbulb, air
entering the outdoor condenser section at 35C drybulb and 23.9C wetbulb, cooling coil air
flow rate specified in Rated Evaporator Air Flow Rate, and the state of TES at either the Fluid
Storage Tank Rating Temperature (for water or fluid storage type) or an ice fraction of 0.5 (for
ice storage type). The electric input power includes power for the compressor(s), condenser
fan(s), and internal controls but does not include the electric power for the supply fan (which
is modeled separately in EnergyPlus). The total cooling power output is the same as the
value for the Cooling And Charge Mode Rated Total Evaporator Cooling Capacity and is
gross cooling without the fan heat. The Cooling And Charge Mode has two COP values and
this first COP is for cooling and would typically be for a heat engine operating between the
condenser and the evaporator. This field is only used if Cooling And Charge Mode is
available. If this input is left blank, the default is 3.0.
Field: Cooling And Charge Mode Charging Rated COP
This field is used to specify the coefficient of performance (COP) at rating conditions while
operating in Cooling And Charge Mode to charge the TES. COP is the total cooling power
output in watts divided by the electric power input in watts and is dimensionless. The rating
conditions are air entering the cooling coil at 26.7C drybulb, 19.4C wetbulb, air entering the
outdoor condenser section at 35C drybulb and 23.9C wetbulb, cooling coil air flow rate
specified in Rated Evaporator Air Flow Rate, and the state of TES at either the Fluid Storage
Tank Rating Temperature (for water or fluid storage type) or an ice fraction of 0.5 (for ice
storage type). The electric input power includes power for the compressor(s), condenser
fan(s), and internal controls. The charging power output is the same as the value for the
Cooling And Charge Mode Rated Storage Charging Capacity and is net charging including
any internal equipment. The Cooling And Charge Mode has two COP values and this second
COP is for charging and would typically be for a heat engine operating between the
condenser and the TES tank. This field is only used if Cooling And Charge Mode is
available. If this input is left blank, the default is 3.0.
Field: Cooling And Charge Mode Total Evaporator Cooling Capacity Function of
Temperature Curve Name
This field is the name of a separate performance curve object that parameterizes the
variation of the total cooling capacity as a function of (1) the wetbulb temperature of air
entering the evaporator section of the TES coil, (2) the drybulb temperature of the air entering
the condenser section, and (3) the state of TES tank (in C or fraction). The performance
curve can be any curve or table based on three independent variables, x, y, and z, including:
Curve:Triquadratic and Table:MultiVariableLookup. The x values for the performance curve
are the wetbulb temperature of air entering the evaporator section. The y values for the
performance curve are the drybulb temperature of air entering the condenser section (which if
using evaporatively-cooled condenser the temperature will be adjusted to approach the
wetbulb temperature depending on effectiveness). The z values are the state of the TES
tank which are the tanks temperature for water or fluid storage type or the storage fraction for
ice storage types. The performance curve is normalized to have the value of 1.0 at the rating
point which is defined to be x = 19.4C, y=35.0C, and z=0.5 for Ice storage type or z = Fluid
Storage Tank Rating Temperature when storage type is Water or UserDefinedFluidType. The
result of the curve is multiplied by Cooling And Charge Mode Rated Total Evaporator Cooling
Capacity to model capacity at temperatures away from the rating point. This field is required
if Cooling And Charge Mode is available.

9/29/14

1496

Input-Output Reference

Group Heating and Cooling Coils

Field: Cooling And Charge Mode Total Evaporator Cooling Capacity Function of Flow
Fraction Curve Name
This field is the name of a separate performance curve object that parameterizes the
variation of the total cooling capacity as a function of the ratio of actual air flow rate across
the cooling coil to the value of the Rated Evaporator Air Flow Rate. The performance curve
can be any curve or table based on one independent variable, x, including: Curve:Linear,
Curve:Quadratic,
Curve:Cubic,
Curve:Quartic,
Curve:Exponent,
Curve:ExponentialSkewNormal,
Curve:Sigmoid,
Curve:RectuangularHyperbola1,
Curve:RectangularHyperbola2, Curve:ExponentialDecay, Curve:DoubleExponentialDecay,
and Table:OneIndependentVariable. The performance curve is normalized to have a value of
1.0 at the rating point which is defined to be x = 1.0. The result of the curve is multiplied by
the Cooling And Charge Mode Rated Total Evaporator Cooling Capacity to model capacity at
air flow rates away from the rating point. This field is required if Cooling And Charge Mode is
available.
Field: Cooling And Charge Mode Evaporator Energy Input Ratio Function of Temperature
Curve Name
This field is the name of a separate performance curve object that parameterizes the
variation of the energy input ratio (EIR) for evaporator cooling as a function of (1) the wetbulb
temperature of air entering the evaporator section of the TES coil, (2) the drybulb
temperature of the air entering the condenser section, and (3) the state of TES tank (in C or
fraction). The performance curve can be any curve or table based on three independent
variables, x, y, and z, including: Curve:Triquadratic and Table:MultiVariableLookup. The x
values for the performance curve are the wetbulb temperature of air entering the evaporator
section. The y values for the performance curve are the drybulb temperature of air entering
the condenser section (which if using evaporatively-cooled condenser the temperature will be
adjusted to approach the wetbulb temperature depending on effectiveness). The z values
are the state of the TES tank which are the tanks temperature for water or fluid storage type
or the storage fraction for ice storage types. The performance curve is normalized to have the
value of 1.0 at the rating point which is defined to be x = 19.4C, y=35.0C, and z=0.5 for Ice
storage type or z = Fluid Storage Tank Rating Temperature when storage type is Water or
UserDefinedFluidType. The performance curve is normalized to have the value of 1.0 at the
rating point. The result of this curve is multiplied by the inverse of the Cooling And Charge
Mode Cooling Rated COP to model electric energy consumption at temperatures away from
the rating point. This field is required if Cooling And Charge Mode is available.
Field: Cooling And Charge Mode Evaporator Energy Input Ratio Function of Flow Fraction
Curve Name
This field is the name of a separate performance curve object that parameterizes the
variation of the energy input ratio (EIR) for evaporator cooling as a function of the ratio of
actual air flow rate across the cooling coil to the value of the Rated Evaporator Air Flow Rate.
The performance curve can be any curve or table based on one independent variable, x,
including: Curve:Linear, Curve:Quadratic, Curve:Cubic, Curve:Quartic, Curve:Exponent,
Curve:ExponentialSkewNormal,
Curve:Sigmoid,
Curve:RectuangularHyperbola1,
Curve:RectangularHyperbola2, Curve:ExponentialDecay, Curve:DoubleExponentialDecay,
and Table:OneIndependentVariable. The performance curve is normalized to have a value of
1.0 at the rating point which is defined to be x = 1.0. The result of the curve is multiplied by
the inverse of the Cooling And Charge Mode Cooling Rated COP to model electric energy
consumption at air flow rates away from the rating point. This field is required if Cooling And
Charge Mode is available.
Field: Cooling And Charge Mode Evaporator Part Load Fraction Correlation Curve Name
This field is the name of a separate performance curve object that parameterizes the
variation of the energy input ratio (EIR) (for evaporator cooling) as a function of the part load
ratio (PLR). PLR is the ratio of current cooling load to the current cooling capacity. The
9/29/14

1497

Input-Output Reference

Group Heating and Cooling Coils

performance curve can be any curve or table based on one independent variable, x,
including: Curve:Linear, Curve:Quadratic, Curve:Cubic, Curve:Quartic, Curve:Exponent,
Curve:ExponentialSkewNormal,
Curve:Sigmoid,
Curve:RectuangularHyperbola1,
Curve:RectangularHyperbola2, Curve:ExponentialDecay, Curve:DoubleExponentialDecay,
and Table:OneIndependentVariable. The performance curve is normalized to have a value of
1.0 at the rating point which is defined to be x = 1.0. The result of the curve is the part load
fraction (PLF) and the runtime fraction of the coil is defined as PLR divided by PLF. The
runtime fraction is then multiplied by the energy input ratio to model electric energy
consumption at part load to account for inefficiencies because of compressor cycling. This
field is required if Cooling And Charge Mode is available.
Field: Cooling And Charge Mode Storage Charge Capacity Function of Temperature
Curve Name
This field is the name of a separate performance curve object that parameterizes the
variation of the storage charging capacity as a function of (1) the wetbulb temperature of air
entering the evaporator section of the TES coil, (2) the drybulb temperature of the air entering
the condenser section, and (3) the state of TES tank (in C or fraction). The performance
curve can be any curve or table based on three independent variables, x, y, and z, including:
Curve:Triquadratic and Table:MultiVariableLookup. The x values for the performance curve
are the wetbulb temperature of air entering the evaporator section. The y values for the
performance curve are the drybulb temperature of air entering the condenser section (which if
using evaporatively-cooled condenser the temperature will be adjusted to approach the
wetbulb temperature depending on effectiveness). The z values are the state of the TES
tank which are the tanks temperature for water or fluid storage type or the storage fraction for
ice storage types. The performance curve is normalized to have the value of 1.0 at the rating
point which is defined to be x = 19.4C, y=35.0C, and z=0.5 for Ice storage type or z = Fluid
Storage Tank Rating Temperature when storage type is Water or UserDefinedFluidType.
The result of the curve is multiplied by Cooling And Charge Mode Rated Storage Charging
Capacity to model capacity at temperatures away from the rating point. This field is required
if Cooling And Charge Mode is available.
Field: Cooling And Charge Mode Storage Charge Capacity Function of Total Evaporator
PLR Curve Name
This field is the name of a separate performance curve object that parameterizes the
variation of the storage charging capacity as a function of part load ratio (PLR) at the
evaporator. PLR is the ratio of current evaporator cooling load to the current evaporator
cooling capacity. This curve allows increasing the storage charging capacity when loads at
the evaporator are low. The performance curve can be any curve or table based on one
independent variable, x, including:
Curve:Linear, Curve:Quadratic, Curve:Cubic,
Curve:Quartic,
Curve:Exponent,
Curve:ExponentialSkewNormal,
Curve:Sigmoid,
Curve:RectuangularHyperbola1, Curve:RectangularHyperbola2, Curve:ExponentialDecay,
Curve:DoubleExponentialDecay, and Table:OneIndependentVariable.
The performance
curve is normalized to have a value of 1.0 at the rating point which is defined to be x = 1.0.
The result of the curve is multiplied by Cooling And Charge Mode Rated Storage Charging
Capacity to model capacity at evaporator PLR less than 1.0. This field is required if Cooling
And Charge Mode is available.
Field: Cooling And Charge Mode Storage Energy Input Ratio Function of Temperature
Curve Name
This field is the name of a separate performance curve object that parameterizes the
variation of the energy input ratio (EIR) for charging as a function of (1) the wetbulb
temperature of air entering the evaporator section of the TES coil, (2) the drybulb
temperature of the air entering the condenser section, and (3) the state of TES tank (in C or
fraction). The performance curve can be any curve or table based on three independent
variables, x, y, and z, including: Curve:Triquadratic and Table:MultiVariableLookup. The x
9/29/14

1498

Input-Output Reference

Group Heating and Cooling Coils

values for the performance curve are the wetbulb temperature of air entering the evaporator
section. The y values for the performance curve are the drybulb temperature of air entering
the condenser section (which if using evaporatively-cooled condenser the temperature will be
adjusted to approach the wetbulb temperature depending on effectiveness). The z values
are the state of the TES tank which are the tanks temperature for water or fluid storage type
or the storage fraction for ice storage types. The performance curve is normalized to have the
value of 1.0 at the rating point which is defined to be x = 19.4C, y = 35.0C, and z = 0.5 for
Ice storage type or z = Fluid Storage Tank Rating Temperature when storage type is Water or
UserDefinedFluidType. The result of this curve is multiplied by the inverse of the Cooling And
Charge Mode Charging Rated COP to model electric energy consumption at temperatures
away from the rating point. This field is required if Cooling And Charge Mode is available.
Field: Cooling And Charge Mode Storage Energy Input Ratio Function of Flow Fraction
Curve Name
This field is the name of a separate performance curve object that parameterizes the
variation of the energy input ratio (EIR) for charging as a function of the ratio of actual air flow
rate across the cooling coil to the value of the Rated Evaporator Air Flow Rate. The
performance curve can be any curve or table based on one independent variable, x,
including: Curve:Linear, Curve:Quadratic, Curve:Cubic, Curve:Quartic, Curve:Exponent,
Curve:ExponentialSkewNormal,
Curve:Sigmoid,
Curve:RectuangularHyperbola1,
Curve:RectangularHyperbola2, Curve:ExponentialDecay, Curve:DoubleExponentialDecay,
and Table:OneIndependentVariable. The performance curve is normalized to have a value of
1.0 at the rating point which is defined to be x = 1.0. The result of the curve is multiplied by
the inverse of the Cooling And Charge Mode Charging Rated COP to model electric energy
consumption at air flow rates away from the rating point. This field is required if Cooling And
Charge Mode is available.
Field: Cooling And Charge Mode Storage Energy Part Load Fraction Correlation Curve
Name
This field is the name of a separate performance curve object that parameterizes the
variation of the energy input ratio (EIR) (for storage charging) as a function of the part load
ratio (PLR). PLR is the ratio of current cooling load to the current cooling capacity (at the
evaporator). The performance curve can be any curve or table based on one independent
variable, x, including:
Curve:Linear, Curve:Quadratic, Curve:Cubic, Curve:Quartic,
Curve:Exponent,
Curve:ExponentialSkewNormal,
Curve:Sigmoid,
Curve:RectuangularHyperbola1, Curve:RectangularHyperbola2, Curve:ExponentialDecay,
Curve:DoubleExponentialDecay, and Table:OneIndependentVariable.
The performance
curve is normalized to have a value of 1.0 at the rating point which is defined to be x = 1.0.
The result of the curve is the part load fraction (PLF) and the runtime fraction is defined as
PLR divided by PLF. The runtime fraction is then multiplied by the energy input ratio to
model electric energy consumption at part load to account for inefficiencies because of
compressor cycling. This field is required if Cooling And Charge Mode is available.
Field: Cooling And Charge Mode Sensible Heat Ratio Function of Temperature Curve
Name
This field is the name of a separate performance curve object that parameterizes the
variation of the sensible heat ratio (SHR) as a function of temperature and optionally state of
TES tank. The user can enter the name of a curve or table object that has either two or three
independent variables.
For a curve or table with two independent variables the SHR is a function of (1) the wetbulb
temperature of air entering the evaporator section of the TES coil and (2) the drybulb
temperature of the air entering the evaporator section. The performance curve can be any
curve or table based on two independent variables, x and y, including: Curve:Biquadratic,
Table:TwoIndependentVariables, Curve:Bicubic, and Curve:QuadraticLinear. The x values
for the performance curve are the wetbulb temperature of air entering the evaporator section.
9/29/14

1499

Input-Output Reference

Group Heating and Cooling Coils

The y values for the performance curve are the drybulb temperature of air entering the
evaporator section.
For a curve or table with three independent variables the SHR is a function of (1) the wetbulb
temperature of air entering the evaporator section of the TES coil, (2) the drybulb
temperature of the air entering the evaporator section and (3) the state of TES tank (in C or
fraction). The performance curve can be any curve or table based on three independent
variables, x, y, and z, including: Curve:Triquadratic and Table:MultiVariableLookup. The x
and y values for the curve are the same as for two independent variables while the z
values are the state of the TES tank which are the tanks temperature for water or fluid
storage type or the storage fraction for ice storage types.
The performance curve is normalized to have a value of 1.0 at the rating point which is
defined to be x = 19.4C, y = 26.7C, and z = 0.5 for Ice storage type or z = Fluid Storage
Tank Rating Temperature when storage type is Water or UserDefinedFluidType. The result
of the curve is multiplied by the Cooling And Charge Mode Rated Sensible Heat Ratio to
model the SHR at coil entering temperatures that differ from the rating point. This field is
required if Cooling And Charge Mode is available.
Field: Cooling And Charge Mode Sensible Heat Ratio Function of Flow Fraction Curve
Name
This field is the name of a separate performance curve object that parameterizes the
variation of the sensible heat ratio (SHR) as a function of the ratio of actual air flow rate
across the cooling coil to the value of the Rated Evaporator Air Flow Rate. The performance
curve can be any curve or table based on one independent variable, x, including:
Curve:Linear,
Curve:Quadratic,
Curve:Cubic,
Curve:Quartic,
Curve:Exponent,
Curve:ExponentialSkewNormal,
Curve:Sigmoid,
Curve:RectuangularHyperbola1,
Curve:RectangularHyperbola2, Curve:ExponentialDecay, Curve:DoubleExponentialDecay,
and Table:OneIndependentVariable. The performance curve is normalized to have a value of
1.0 at the rating point which is defined to be x = 1.0. The result of the curve is multiplied by
the Cooling And Charge Mode Rated Sensible Heat Ratio to model the SHR at coil air flow
rates that differ from the rating point. This field is required if Cooling And Charge Mode is
available.
Field: Cooling And Discharge Mode Available
This field is used to indicate if the packaged TES coil includes a mode with both cooling at
the coil and discharging of the TES tank at the same time. The choices are Yes or No.
This field is required.
Field: Cooling And Discharge Mode Rated Total Evaporator Cooling Capacity [W]
This field is used to specify the total, full load cooling capacity (sensible plus latent), in Watts,
of the TES evaporator coil at rated conditions, while operating in Cooling And Discharge
Mode. The rating conditions are air entering the cooling coil at 26.7C drybulb, 19.4C
wetbulb and air entering the outdoor condenser section at 35C drybulb and 23.9C wetbulb,
the air flow rate specified in Rated Evaporator Air Flow Rate, and the state of TES at either
the Fluid Storage Tank Rating Temperature (for water or fluid storage type) or an ice fraction
of 0.5 (for ice storage type). Capacity should be gross (i.e. supply air fan heat is NOT
included). The Cooling and Discharge Mode has two capacities (and may have two separate
cooling coils contained within), this first one is for Evaporator cooling and would typically be
for a heat engine operating between the condenser and the evaporator. This field is required
if Cooling And Discharge Mode is available.
This field is autocalculatable. When autocalculating the capacity, the following sizing factor
field is used to scale this capacity relative to the Cooling Only Mode Rated Total Evaporator
Cooling Capacity.

9/29/14

1500

Input-Output Reference

Group Heating and Cooling Coils

Field: Cooling And Discharge Mode Evaporator Capacity Sizing Factor

This field is used if the previous input field is set to autocalculate. This sizing factor is
multiplied by the Cooling Only Mode Rated Total Evaporator Cooling Capacity to obtain a
scaled value for Cooling and Discharge Mode Rated Total Evaporator Cooling Capacity, in
Watts. If this field is left blank the default values is 1.0.
Field: Cooling And Discharge Mode Rated Storage Discharging Capacity
This field is used to specify the total, full load discharging capacity, in Watts, of the TES coil
at rated conditions, while operating in Cooling And Discharge Mode. The rating conditions
are air entering the cooling coil at 26.7C drybulb, 19.4C wetbulb and air entering the
outdoor condenser section at 35C drybulb and 23.9C wetbulb, the air flow rate specified in
Rated Evaporator Air Flow Rate, and the state of TES at either the Fluid Storage Tank Rating
Temperature (for water or fluid storage type) or an ice fraction of 0.5 (for ice storage type).
Capacity should be net (i.e. any ancillary equipment inside the package needed for
discharging is included). The Cooling and Discharge Mode has two capacities, this second
one is for discharging and would typically be for a heat transfer loop operating between the
TES tank and a coil in series with the evaporator. This field is required if Cooling And
Discharge Mode is available.
This field is autocalculatable. When autocalculating the capacity, the following sizing factor
field is used to scale this capacity relative to the Cooling Only Mode Rated Total Evaporator
Cooling Capacity.
Field: Cooling And Discharge Mode Storage Discharge Capacity Sizing Factor
This field is used if the previous input field is set to autocalculate. This sizing factor is
multiplied by the Cooling Only Mode Rated Total Evaporator Cooling Capacity to obtain a
scaled value for Cooling and Discharge Mode Rated Storage Discharging Capacity, in Watts.
If this field is left blank the default value is 1.0.
Field: Cooling And Discharge Mode Rated Sensible Heat Ratio
This field is used to specify the sensible heat ratio (SHR) at rating conditions while operating
in Cooling And Discharge Mode. SHR is the sensible cooling capacity divided by the total
(sensible plus latent) cooling capacity and is dimensionless. The rating conditions are air
entering the cooling coil at 26.7C drybulb, 19.4C wetbulb, air entering the outdoor
condenser section at 35C drybulb and 23.9C wetbulb, cooling coil air flow rate specified in
Rated Evaporator Air Flow Rate, and the state of TES at either the Fluid Storage Tank Rating
Temperature (for water or fluid storage type) or an ice fraction of 0.5 (for ice storage type).
Both the sensible and total cooling capacities used to define the rated SHR should be gross
and not include supply fan heat. The packaged TES coil model uses SHR curves to modify
the rated SHR as conditions move away from the rating conditions. Cooling and discharge
mode may have two separate coils in series all contained within the package and this SHR
should be for the combined performance of the entire package. This field is only used if
Cooling And Discharge Mode is available. If this input is left blank, the default is 0.7.
Field: Cooling And Discharge Mode Cooling Rated COP
This field is used to specify the coefficient of performance (COP) at rating conditions while
operating in Cooling And Discharge Mode to cool air at the evaporator. COP is the total
cooling power output in watts divided by the electric power input in watts and is
dimensionless. The rating conditions are air entering the cooling coil at 26.7C drybulb,
19.4C wetbulb, air entering the outdoor condenser section at 35C drybulb and 23.9C
wetbulb, cooling coil air flow rate specified in Rated Evaporator Air Flow Rate, and the state
of TES at either the Fluid Storage Tank Rating Temperature (for water or fluid storage type)
or an ice fraction of 0.5 (for ice storage type). The electric input power includes power for the
compressor(s), condenser fan(s), and internal controls but does not include the electric power
for the supply fan (which is modeled separately in EnergyPlus). The total cooling power
output is the same as the value for the Cooling And Discharge Mode Rated Total Evaporator
9/29/14

1501

Input-Output Reference

Group Heating and Cooling Coils

Cooling Capacity and is gross cooling without the fan heat. The Cooling And Discharge
Mode has two COP values and this first COP is for evaporator cooling and would typically
be for a heat engine operating between the condenser and the evaporator. This field is only
used if Cooling And Discharge Mode is available. If this input is left blank, the default is 3.0.
Field: Cooling And Discharge Mode Discharging Rated COP
This field is used to specify the coefficient of performance (COP) at rating conditions while
operating in Cooling And Discharge Mode to discharge the TES. COP is the total cooling
power output in watts divided by the electric power input in watts and is dimensionless. The
rating conditions are air entering the cooling coil at 26.7C drybulb, 19.4C wetbulb, air
entering the outdoor condenser section at 35C drybulb and 23.9C wetbulb, cooling coil air
flow rate specified in Rated Evaporator Air Flow Rate, and the state of TES at either the Fluid
Storage Tank Rating Temperature (for water or fluid storage type) or an ice fraction of 0.5 (for
ice storage type). The electric input power includes power for the compressor or circulation
pumps and internal controls. The discharging power output is the same as the value for the
Cooling And Discharge Mode Rated Storage Discharging Capacity and is net discharging
including any internal equipment. The Cooling And Discharge Mode has two COP values
and this second COP is for discharging and would typically be for a heat transfer loop
operating between the TES tank and a coil in series with the evaporator. This field is only
used if Cooling And Discharge Mode is available. If this input is left blank, the default is 3.0.
Field: Cooling And Discharge Mode Total Evaporator Cooling Capacity Function of
Temperature Curve Name
This field is the name of a separate performance curve object that parameterizes the
variation of the total cooling capacity as a function of (1) the wetbulb temperature of air
entering the evaporator section of the TES coil, (2) the drybulb temperature of the air entering
the condenser section, and (3) the state of TES tank (in C or fraction). The performance
curve can be any curve or table based on three independent variables, x, y, and z, including:
Curve:Triquadratic and Table:MultiVariableLookup. The x values for the performance curve
are the wetbulb temperature of air entering the evaporator section. The y values for the
performance curve are the drybulb temperature of air entering the condenser section (which if
using evaporatively-cooled condenser the temperature will be adjusted to approach the
wetbulb temperature depending on effectiveness). The z values are the state of the TES
tank which are the tanks temperature for water or fluid storage type or the storage fraction for
ice storage types. The performance curve is normalized to have the value of 1.0 at the rating
point which is defined to be x = 19.4C, y = 35.0C, and z = 0.5 for Ice storage type or z =
Fluid Storage Tank Rating Temperature when storage type is Water or
UserDefinedFluidType. The result of the curve is multiplied by Cooling And Discharge Mode
Rated Total Evaporator Cooling Capacity to model capacity at temperatures away from the
rating point. This field is required if Cooling And Discharge Mode is available.
Field: Cooling And Discharge Mode Total Evaporator Cooling Capacity Function of Flow
Fraction Curve Name
This field is the name of a separate performance curve object that parameterizes the
variation of the total cooling capacity as a function of the ratio of actual air flow rate across
the cooling coil to the value of the Rated Evaporator Air Flow Rate. The performance curve
can be any curve or table based on one independent variable, x, including: Curve:Linear,
Curve:Quadratic,
Curve:Cubic,
Curve:Quartic,
Curve:Exponent,
Curve:ExponentialSkewNormal,
Curve:Sigmoid,
Curve:RectuangularHyperbola1,
Curve:RectangularHyperbola2, Curve:ExponentialDecay, Curve:DoubleExponentialDecay,
and Table:OneIndependentVariable. The performance curve is normalized to have a value of
1.0 at the rating point which is defined to be x = 1.0. The result of the curve is multiplied by
the Cooling And Discharge Mode Rated Total Evaporator Cooling Capacity to model capacity
at air flow rates away from the rating point. This field is required if Cooling And Discharge
Mode is available.

9/29/14

1502

Input-Output Reference

Group Heating and Cooling Coils

Field: Cooling And Discharge Mode Evaporator Energy Input Ratio Function of
Temperature Curve Name
This field is the name of a separate performance curve object that parameterizes the
variation of the energy input ratio (EIR) for evaporator cooling as a function of (1) the wetbulb
temperature of air entering the evaporator section of the TES coil, (2) the drybulb
temperature of the air entering the condenser section, and (3) the state of TES tank (in C or
fraction). The performance curve can be any curve or table based on three independent
variables, x, y, and z, including: Curve:Triquadratic and Table:MultiVariableLookup. The x
values for the performance curve are the wetbulb temperature of air entering the evaporator
section. The y values for the performance curve are the drybulb temperature of air entering
the condenser section (which if using evaporatively-cooled condenser the temperature will be
adjusted to approach the wetbulb temperature depending on effectiveness). The z values
are the state of the TES tank which are the tanks temperature for water or fluid storage type
or the storage fraction for ice storage types. The performance curve is normalized to have the
value of 1.0 at the rating point which is defined to be x = 19.4C, y = 35.0C, and z = 0.5 for
Ice storage type or z = Fluid Storage Tank Rating Temperature when storage type is Water or
UserDefinedFluidType. The result of this curve is multiplied by the inverse of the Cooling And
Discharge Mode Cooling Rated COP to model electric energy consumption at temperatures
away from the rating point. This field is required if Cooling And Discharge Mode is available.
Field: Cooling And Discharge Mode Evaporator Energy Input Ratio Function of Flow
Fraction Curve Name
This field is the name of a separate performance curve object that parameterizes the
variation of the energy input ratio (EIR) for evaporator cooling as a function of the ratio of
actual air flow rate across the cooling coil to the value of the Rated Evaporator Air Flow Rate.
The performance curve can be any curve or table based on one independent variable, x,
including: Curve:Linear, Curve:Quadratic, Curve:Cubic, Curve:Quartic, Curve:Exponent,
Curve:ExponentialSkewNormal,
Curve:Sigmoid,
Curve:RectuangularHyperbola1,
Curve:RectangularHyperbola2, Curve:ExponentialDecay, Curve:DoubleExponentialDecay,
and Table:OneIndependentVariable. The performance curve is normalized to have a value of
1.0 at the rating point which is defined to be x = 1.0. The result of the curve is multiplied by
the inverse of the Cooling And Discharge Mode Cooling Rated COP to model electric energy
consumption at air flow rates away from the rating point. This field is required if Cooling And
discharge Mode is available.
Field: Cooling And Discharge Mode Evaporator Part Load Fraction Correlation Curve
Name
This field is the name of a separate performance curve object that parameterizes the
variation of the energy input ratio (EIR) (for evaporator cooling) as a function of the part load
ratio (PLR). PLR is the ratio of current cooling load to the current cooling capacity. The
performance curve can be any curve or table based on one independent variable, x,
including: Curve:Linear, Curve:Quadratic, Curve:Cubic, Curve:Quartic, Curve:Exponent,
Curve:ExponentialSkewNormal,
Curve:Sigmoid,
Curve:RectuangularHyperbola1,
Curve:RectangularHyperbola2, Curve:ExponentialDecay, Curve:DoubleExponentialDecay,
and Table:OneIndependentVariable. The performance curve is normalized to have a value of
1.0 at the rating point which is defined to be x = 1.0. The result of the curve is the part load
fraction (PLF) and the runtime fraction of the coil is defined as PLR divided by PLF. The
runtime fraction is then multiplied by the energy input ratio to model electric energy
consumption at part load to account for inefficiencies because of compressor cycling. This
field is required if Cooling And Discharge Mode is available.
Field: Cooling And Discharge Mode Storage Discharge Capacity Function of Temperature
Curve Name
This field is the name of a separate performance curve object that parameterizes the
variation of the storage discharging capacity as a function of (1) the wetbulb temperature of
9/29/14

1503

Input-Output Reference

Group Heating and Cooling Coils

air entering the evaporator section of the TES coil, (2) the drybulb temperature of the air
entering the condenser section, and (3) the state of TES tank (in C or fraction). The
performance curve can be any curve or table based on three independent variables, x, y, and
z, including: Curve:Triquadratic and Table:MultiVariableLookup. The x values for the
performance curve are the wetbulb temperature of air entering the evaporator section. The
y values for the performance curve are the drybulb temperature of air entering the
condenser section (which if using evaporatively-cooled condenser the temperature will be
adjusted to approach the wetbulb temperature depending on effectiveness). The z values
are the state of the TES tank which are the tanks temperature for water or fluid storage type
or the storage fraction for ice storage types. The performance curve is normalized to have
the value of 1.0 at the rating point which is defined to be x = 19.4C, y = 35.0C, and z = 0.5
for Ice storage type or z = Fluid Storage Tank Rating Temperature when storage type is
Water or UserDefinedFluidType. The result of the curve is multiplied by Cooling And
Discharge Mode Rated Storage Discharging Capacity to model capacity at temperatures
away from the rating point. This field is required if Cooling And Discharge Mode is available.
Field: Cooling And Discharge Mode Storage Discharge Capacity Function of Flow
Fraction Curve Name
This field is the name of a separate performance curve object that parameterizes the
variation of the storage discharge capacity as a function of the ratio of actual air flow rate
across the cooling coil to the value of the Rated Evaporator Air Flow Rate. The performance
curve can be any curve or table based on one independent variable, x, including:
Curve:Linear,
Curve:Quadratic,
Curve:Cubic,
Curve:Quartic,
Curve:Exponent,
Curve:ExponentialSkewNormal,
Curve:Sigmoid,
Curve:RectuangularHyperbola1,
Curve:RectangularHyperbola2, Curve:ExponentialDecay, Curve:DoubleExponentialDecay,
and Table:OneIndependentVariable. The performance curve is normalized to have a value of
1.0 at the rating point which is defined to be x = 1.0. The result of the curve is multiplied by
the Cooling And Discharge Mode Rated Storage Discharging Capacity to model capacity at
air flow rates away from the rating point. This field is required if Cooling And Discharge Mode
is available.
Field: Cooling And Discharge Mode Storage Discharge Capacity Function of Total
Evaporator PLR Curve Name
This field is the name of a separate performance curve object that parameterizes the
variation of the storage discharging capacity as a function of part load ratio (PLR) at the
evaporator. PLR is the ratio of current evaporator cooling load to the current evaporator
cooling capacity. This curve allows varying the storage discharging capacity based on loads
at the evaporator. The performance curve can be any curve or table based on one
independent variable, x, including:
Curve:Linear, Curve:Quadratic, Curve:Cubic,
Curve:Quartic,
Curve:Exponent,
Curve:ExponentialSkewNormal,
Curve:Sigmoid,
Curve:RectuangularHyperbola1, Curve:RectangularHyperbola2, Curve:ExponentialDecay,
Curve:DoubleExponentialDecay, and Table:OneIndependentVariable.
The performance
curve is normalized to have a value of 1.0 at the rating point which is defined to be x = 1.0.
The result of the curve is multiplied by Cooling And Discharge Mode Rated Storage
Discharging Capacity to model capacity at different evaporator PLR values. This field is
required if Cooling And Discharge Mode is available.
Field: Cooling And Discharge Mode Storage Energy Input Ratio Function of Temperature
Curve Name
This field is the name of a separate performance curve object that parameterizes the
variation of the energy input ratio (EIR) for discharging as a function of (1) the wetbulb
temperature of air entering the evaporator section of the TES coil, (2) the drybulb
temperature of the air entering the condenser section, and (3) the state of TES tank (in C or
fraction). The performance curve can be any curve or table based on three independent
variables, x, y, and z, including: Curve:Triquadratic and Table:MultiVariableLookup. The x
9/29/14

1504

Input-Output Reference

Group Heating and Cooling Coils

values for the performance curve are the wetbulb temperature of air entering the evaporator
section. The y values for the performance curve are the drybulb temperature of air entering
the condenser section (which if using evaporatively-cooled condenser the temperature will be
adjusted to approach the wetbulb temperature depending on effectiveness). The z values
are the state of the TES tank which are the tanks temperature for water or fluid storage type
or the storage fraction for ice storage types. The performance curve is normalized to have the
value of 1.0 at the rating point which is defined to be x = 19.4C, y = 35.0C, and z = 0.5 for
Ice storage type or z = Fluid Storage Tank Rating Temperature when storage type is Water or
UserDefinedFluidType. The result of this curve is multiplied by the inverse of the Cooling And
Discharge Mode Discharging Rated COP to model electric energy consumption at
temperatures away from the rating point. This field is required if Cooling And Discharge Mode
is available.
Field: Cooling And Discharge Mode Storage Energy Input Ratio Function of Flow Fraction
Curve Name
This field is the name of a separate performance curve object that parameterizes the
variation of the energy input ratio (EIR) for discharging as a function of the ratio of actual air
flow rate across the cooling coil to the value of the Rated Evaporator Air Flow Rate. The
performance curve can be any curve or table based on one independent variable, x,
including: Curve:Linear, Curve:Quadratic, Curve:Cubic, Curve:Quartic, Curve:Exponent,
Curve:ExponentialSkewNormal,
Curve:Sigmoid,
Curve:RectuangularHyperbola1,
Curve:RectangularHyperbola2, Curve:ExponentialDecay, Curve:DoubleExponentialDecay,
and Table:OneIndependentVariable. The performance curve is normalized to have a value of
1.0 at the rating point which is defined to be x = 1.0. The result of the curve is multiplied by
the inverse of the Cooling And Discharge Mode Discharging Rated COP to model electric
energy consumption at air flow rates away from the rating point. This field is required if
Cooling And Discharge Mode is available.
Field: Cooling And Discharge Mode Storage Energy Part Load Fraction Correlation Curve
Name
This field is the name of a separate performance curve object that parameterizes the
variation of the energy input ratio (EIR) (for storage discharging) as a function of the part load
ratio (PLR). PLR is the ratio of current cooling load to the current cooling capacity (at the
evaporator). The performance curve can be any curve or table based on one independent
variable, x, including:
Curve:Linear, Curve:Quadratic, Curve:Cubic, Curve:Quartic,
Curve:Exponent,
Curve:ExponentialSkewNormal,
Curve:Sigmoid,
Curve:RectuangularHyperbola1, Curve:RectangularHyperbola2, Curve:ExponentialDecay,
Curve:DoubleExponentialDecay, and Table:OneIndependentVariable.
The performance
curve is normalized to have a value of 1.0 at the rating point which is defined to be x = 1.0.
The result of the curve is the part load fraction (PLF) and the runtime fraction is defined as
PLR divided by PLF. The runtime fraction is then multiplied by the energy input ratio to
model electric energy consumption at part load to account for inefficiencies because of
compressor cycling. This field is required if Cooling And Discharge Mode is available.
Field: Cooling And Discharge Mode Sensible Heat Ratio Function of Temperature Curve
Name
This field is the name of a separate performance curve object that parameterizes the
variation of the sensible heat ratio (SHR) as a function of temperature and optionally state of
TES tank. The user can enter the name of a curve or table object that has either two or three
independent variables.
For a curve or table with two independent variables the SHR is a function of (1) the wetbulb
temperature of air entering the evaporator section of the TES coil and (2) the drybulb
temperature of the air entering the evaporator section. The performance curve can be any
curve or table based on two independent variables, x and y, including: Curve:Biquadratic,
Table:TwoIndependentVariables, Curve:Bicubic, and Curve:QuadraticLinear. The x values
9/29/14

1505

Input-Output Reference

Group Heating and Cooling Coils

for the performance curve are the wetbulb temperature of air entering the evaporator section.
The y values for the performance curve are the drybulb temperature of air entering the
evaporator section.
For a curve or table with three independent variables the SHR is a function of (1) the wetbulb
temperature of air entering the evaporator section of the TES coil, (2) the drybulb
temperature of the air entering the evaporator section and (3) the state of TES tank (in C or
fraction). The performance curve can be any curve or table based on three independent
variables, x, y, and z, including: Curve:Triquadratic and Table:MultiVariableLookup. The x
and y values for the curve are the same as for two independent variables while the z
values are the state of the TES tank which are the tanks temperature for water or fluid
storage type or the storage fraction for ice storage types.
The performance curve is normalized to have a value of 1.0 at the rating point which is
defined to be x = 19.4C, y = 26.7C, and z = 0.5 for Ice storage type or z = Fluid Storage
Tank Rating Temperature when storage type is Water or UserDefinedFluidType. The result
of the curve is multiplied by the Cooling And Discharge Mode Rated Sensible Heat Ratio to
model the SHR at coil entering temperatures that differ from the rating point. This field is
required if Cooling And Discharge Mode is available.
Field: Cooling And Discharge Mode Sensible Heat Ratio Function of Flow Fraction Curve
Name
This field is the name of a separate performance curve object that parameterizes the
variation of the sensible heat ratio (SHR) as a function of the ratio of actual air flow rate
across the cooling coil to the value of the Rated Evaporator Air Flow Rate. The performance
curve can be any curve or table based on one independent variable, x, including:
Curve:Linear,
Curve:Quadratic,
Curve:Cubic,
Curve:Quartic,
Curve:Exponent,
Curve:ExponentialSkewNormal,
Curve:Sigmoid,
Curve:RectuangularHyperbola1,
Curve:RectangularHyperbola2, Curve:ExponentialDecay, Curve:DoubleExponentialDecay,
and Table:OneIndependentVariable. The performance curve is normalized to have a value of
1.0 at the rating point which is defined to be x = 1.0. The result of the curve is multiplied by
the Cooling And Discharge Mode Rated Sensible Heat Ratio to model the SHR at coil air flow
rates that differ from the rating point. This field is required if Cooling And Discharge Mode is
available.
Field: Charge Only Mode Available
This field is used to indicate if the packaged TES coil includes a mode with only charging of
the TES tank. The choices are Yes or No. This field is required.
Field: Charge Only Mode Rated Storage Charging Capacity [W]
This field is used to specify the total, full load charging capacity, in Watts, of the TES coil at
rated conditions, while operating in Charge Only Mode. The rating conditions are air entering
the outdoor condenser section at 35C drybulb and 23.9C wetbulb and the state of TES at
either the Fluid Storage Tank Rating Temperature (for water or fluid storage type) or an ice
fraction of 0.5 (for ice storage type). Capacity should be net (i.e. any ancillary equipment
inside the package needed for charging is included). The Charge Only Mode capacity would
typically be for a heat engine operating between the condenser and the TES tank. This field
is required if Charge Only Mode is available.
This field is autocalculatable. When autocalculating the capacity, the following sizing factor
field is used to scale this capacity relative to the Cooling Only Mode Rated Total Evaporator
Cooling Capacity.
Field: Charge Only Mode Capacity Sizing Factor
This field is used if the previous input field is set to autocalculate. This sizing factor is
multiplied by the Cooling Only Mode Rated Total Evaporator Cooling Capacity to obtain a
scaled value for Charge Only Mode Rated Storage Charging Capacity, in Watts. If this field is
left blank the default values is 1.0.
9/29/14

1506

Input-Output Reference

Group Heating and Cooling Coils

Field: Charge Only Mode Charging Rated COP

This field is used to specify the coefficient of performance (COP) at rating conditions while
operating in Charge Only Mode to charge the TES. COP is the total cooling power output in
watts divided by the electric power input in watts and is dimensionless. The rating conditions
are air entering the outdoor condenser section at 35C drybulb and 23.9C wetbulb and the
state of TES at either the Fluid Storage Tank Rating Temperature (for water or fluid storage
type) or an ice fraction of 0.5 (for ice storage type). The electric input power includes power
for the compressor(s), condenser fan(s), and internal controls. The charging power output is
the same as the value for the Charge Only Mode Rated Storage Charging Capacity and is
net charging including any internal equipment. This field is only used if Charge Only Mode is
available. If this input is left blank, the default is 3.0.
Field: Charge Only Mode Storage Charge Capacity Function of Temperature Curve Name
This field is the name of a separate performance curve object that parameterizes the
variation of the storage charging capacity as a function of (1) the drybulb temperature of the
air entering the condenser section, and (2) the state of TES tank (in C or fraction). The
performance curve can be any curve or table based on two independent variables, x and y,
including:
Curve:Biquadratic, Table:TwoIndependentVariables, Curve:Bicubic, and
Curve:QuadraticLinear.
The x values for the performance curve are the drybulb
temperature of air entering the condenser section (which if using evaporatively-cooled
condenser the temperature will be adjusted to approach the wetbulb temperature depending
on effectiveness). The y values are the state of the TES tank which are the tanks
temperature for water or fluid storage type or the storage fraction for ice storage types. The
performance curve is normalized to have the value of 1.0 at the rating point which is defined
to be x = 35.0C, and y = 0.5 for Ice storage type or y = Fluid Storage Tank Rating
Temperature when storage type is Water or UserDefinedFluidType. The result of the curve is
multiplied by Charge Only Mode Rated Storage Charging Capacity to model capacity at
temperatures away from the rating point. This field is required if Charge Only Mode is
available.
Field: Charge Only Mode Storage Energy Input Ratio Function of Temperature Curve
Name
This field is the name of a separate performance curve object that parameterizes the
variation of the energy input ratio (EIR) for charging as a function of (1) the drybulb
temperature of the air entering the condenser section, and (2) the state of TES tank (in C or
fraction). The performance curve can be any curve or table based on two independent
variables, x and y, including:
Curve:Biquadratic, Table:TwoIndependentVariables,
Curve:Bicubic, and Curve:QuadraticLinear. The x values for the performance curve are the
drybulb temperature of air entering the condenser section (which if using evaporativelycooled condenser the temperature will be adjusted to approach the wetbulb temperature
depending on effectiveness). The y values are the state of the TES tank which are the
tanks temperature for water or fluid storage type or the storage fraction for ice storage types.
The performance curve is normalized to have the value of 1.0 at the rating point which is
defined to be x = 35.0C, and y = 0.5 for Ice storage type or y = Fluid Storage Tank Rating
Temperature when storage type is Water or UserDefinedFluidType. The result of this curve is
multiplied by the inverse of the Charge Only Mode Charging Rated COP to model electric
energy consumption at temperatures away from the rating point. This field is required if
Charge Only Mode is available.
Field: Discharge Only Mode Available
This field is used to indicate if the packaged TES coil includes a mode with only discharging
of the TES tank. The choices are Yes or No. This field is required.

9/29/14

1507

Input-Output Reference

Group Heating and Cooling Coils

Field: Discharge Only Mode Rated Storage Discharging Capacity [W]

This field is used to specify the total, full load discharging capacity, in Watts, of the TES coil
at rated conditions, while operating in Discharge Only Mode. The rating conditions are air
entering the cooling coil at 26.7C drybulb, 19.4C wetbulb, the air flow rate specified in
Rated Evaporator Air Flow Rate, and the state of TES at either the Fluid Storage Tank Rating
Temperature (for water or fluid storage type) or an ice fraction of 0.5 (for ice storage type).
Capacity should be net (i.e. any ancillary equipment inside the package needed for
discharging is included) with regard to TES discharge, and gross with regard to supply fan
heat. Discharge Only Mode would typically be for a heat transfer loop operating between the
TES tank and a coil in series with the evaporator. This field is required if Discharge Only
Mode is available.
This field is autocalculatable. When autocalculating the capacity, the following sizing factor
field is used to scale this capacity relative to the Cooling Only Mode Rated Total Evaporator
Cooling Capacity.
Field: Discharge Only Mode Capacity Sizing Factor
This field is used if the previous input field is set to autocalculate. This sizing factor is
multiplied by the Cooling Only Mode Rated Total Evaporator Cooling Capacity to obtain a
scaled value for Discharge Only Mode Rated Storage Discharging Capacity, in Watts. If this
field is left blank the default value is 1.0.
Field: Discharge Only Mode Rated Sensible Heat Ratio
This field is used to specify the sensible heat ratio (SHR) at rating conditions while operating
in Discharge Only Mode. SHR is the sensible cooling capacity divided by the total (sensible
plus latent) cooling capacity and is dimensionless. The rating conditions are air entering the
cooling coil at 26.7C drybulb, 19.4C wetbulb, cooling coil air flow rate specified in Rated
Evaporator Air Flow Rate, and the state of TES at either the Fluid Storage Tank Rating
Temperature (for water or fluid storage type) or an ice fraction of 0.5 (for ice storage type).
Both the sensible and total cooling capacities used to define the rated SHR should be gross
and not include supply fan heat. The packaged TES coil model uses SHR curves to modify
the rated SHR as conditions move away from the rating conditions. This field is only used if
Discharge Only Mode is available. If this input is left blank, the default is 0.7.
Field: Discharge Only Mode Rated COP
This field is used to specify the coefficient of performance (COP) at rating conditions while
operating in Discharge Only Mode to discharge the TES. COP is the total cooling power
output in watts divided by the electric power input in watts and is dimensionless. The rating
conditions are air entering the cooling coil at 26.7C drybulb, 19.4C wetbulb, cooling coil air
flow rate specified in Rated Evaporator Air Flow Rate, and the state of TES at either the Fluid
Storage Tank Rating Temperature (for water or fluid storage type) or an ice fraction of 0.5 (for
ice storage type). The electric input power includes power for the compressor or circulation
pumps and internal controls. The discharging power output is the same as the value for the
Discharge Only Mode Rated Storage Discharging Capacity and is net discharging including
any internal equipment. This field is only used if Discharge Only Mode is available. If this
input is left blank, the default is 3.0.
Field: Discharge Only Mode Storage Discharge Capacity Function of Temperature Curve
Name
This field is the name of a separate performance curve object that parameterizes the
variation of the storage discharging capacity as a function of (1) the wetbulb temperature of
air entering the evaporator section of the TES coil, and (2) the state of TES tank (in C or
fraction). The performance curve can be any curve or table based on two independent
variables, x and y, including:
Curve:Biquadratic, Table:TwoIndependentVariables,
Curve:Bicubic, and Curve:QuadraticLinear. The x values for the performance curve are the
wetbulb temperature of air entering the evaporator section. The y values are the state of
9/29/14

1508

Input-Output Reference

Group Heating and Cooling Coils

the TES tank which are the tanks temperature for water or fluid storage type or the storage
fraction for ice storage types. The performance curve is normalized to have the value of 1.0
at the rating point which is defined to be x = 19.4C and y = 0.5 for Ice storage type or y =
Fluid Storage Tank Rating Temperature when storage type is Water or
UserDefinedFluidType. The result of the curve is multiplied by Discharge Only Mode Rated
Storage Discharging Capacity to model capacity at temperatures away from the rating point.
This field is required if Discharge Only Mode is available.
Field: Discharge Only Mode Storage Discharge Capacity Function of Flow Fraction Curve
Name
This field is the name of a separate performance curve object that parameterizes the
variation of the storage discharge capacity as a function of the ratio of actual air flow rate
across the cooling coil to the value of the Rated Evaporator Air Flow Rate. The performance
curve can be any curve or table based on one independent variable, x, including:
Curve:Linear,
Curve:Quadratic,
Curve:Cubic,
Curve:Quartic,
Curve:Exponent,
Curve:ExponentialSkewNormal,
Curve:Sigmoid,
Curve:RectuangularHyperbola1,
Curve:RectangularHyperbola2, Curve:ExponentialDecay, Curve:DoubleExponentialDecay,
and Table:OneIndependentVariable. The performance curve is normalized to have a value of
1.0 at the rating point which is defined to be x = 1.0. The result of the curve is multiplied by
the Cooling Discharge Only Mode Rated Storage Discharging Capacity to model capacity at
air flow rates away from the rating point. This field is required if Discharge Only Mode is
available.
Field: Discharge Only Mode Energy Input Ratio Function of Temperature Curve Name
This field is the name of a separate performance curve object that parameterizes the
variation of the energy input ratio (EIR) for discharging as a function of (1) the wetbulb
temperature of air entering the evaporator section of the TES coil, and (2) the state of TES
tank (in C or fraction). The performance curve can be any curve or table based on two
independent
variables,
x
and
y,
including:
Curve:Biquadratic,
Table:TwoIndependentVariables, Curve:Bicubic, and Curve:QuadraticLinear. The x values
for the performance curve are the wetbulb temperature of air entering the evaporator section.
The y values are the state of the TES tank which are the tanks temperature for water or
fluid storage type or the storage fraction for ice storage types. The performance curve is
normalized to have the value of 1.0 at the rating point which is defined to be x = 19.4C and y
= 0.5 for Ice storage type or y = Fluid Storage Tank Rating Temperature when storage type is
Water or UserDefinedFluidType. The result of this curve is multiplied by the inverse of the
Discharge Only Mode Rated COP to model electric energy consumption at temperatures
away from the rating point. This field is required if Discharge Only Mode is available.
Field: Discharge Only Mode Energy Input Ratio Function of Flow Fraction Curve Name
This field is the name of a separate performance curve object that parameterizes the
variation of the energy input ratio (EIR) for discharging as a function of the ratio of actual air
flow rate across the cooling coil to the value of the Rated Evaporator Air Flow Rate. The
performance curve can be any curve or table based on one independent variable, x,
including: Curve:Linear, Curve:Quadratic, Curve:Cubic, Curve:Quartic, Curve:Exponent,
Curve:ExponentialSkewNormal,
Curve:Sigmoid,
Curve:RectuangularHyperbola1,
Curve:RectangularHyperbola2, Curve:ExponentialDecay, Curve:DoubleExponentialDecay,
and Table:OneIndependentVariable. The performance curve is normalized to have a value of
1.0 at the rating point which is defined to be x = 1.0. The result of the curve is multiplied by
the inverse of the Discharge Only Mode Rated COP to model electric energy consumption at
air flow rates away from the rating point. This field is required if Discharge Only Mode is
available.

9/29/14

1509

Input-Output Reference

Group Heating and Cooling Coils

Field: Discharge Only Mode Part Load Fraction Correlation Curve Name
This field is the name of a separate performance curve object that parameterizes the
variation of the energy input ratio (EIR) (for storage discharging) as a function of the part load
ratio (PLR). PLR is the ratio of current cooling load to the current cooling capacity. The
performance curve can be any curve or table based on one independent variable, x,
including: Curve:Linear, Curve:Quadratic, Curve:Cubic, Curve:Quartic, Curve:Exponent,
Curve:ExponentialSkewNormal,
Curve:Sigmoid,
Curve:RectuangularHyperbola1,
Curve:RectangularHyperbola2, Curve:ExponentialDecay, Curve:DoubleExponentialDecay,
and Table:OneIndependentVariable. The performance curve is normalized to have a value of
1.0 at the rating point which is defined to be x = 1.0. The result of the curve is the part load
fraction (PLF) and the runtime fraction is defined as PLR divided by PLF. The runtime
fraction is then multiplied by the energy input ratio to model electric energy consumption at
part load to account for inefficiencies because of compressor cycling. This field is required if
Discharge Only Mode is available.
Field: Discharge Only Mode Sensible Heat Ratio Function of Temperature Curve Name
This field is the name of a separate performance curve object that parameterizes the
variation of the sensible heat ratio (SHR) as a function of temperature and optionally state of
TES tank. The user can enter the name of a curve or table object that has either two or three
independent variables.
For a curve or table with two independent variables the SHR is a function of (1) the wetbulb
temperature of air entering the evaporator section of the TES coil and (2) the drybulb
temperature of the air entering the evaporator section. The performance curve can be any
curve or table based on two independent variables, x and y, including: Curve:Biquadratic,
Table:TwoIndependentVariables, Curve:Bicubic, and Curve:QuadraticLinear. The x values
for the performance curve are the wetbulb temperature of air entering the evaporator section.
The y values for the performance curve are the drybulb temperature of air entering the
evaporator section.
For a curve or table with three independent variables the SHR is a function of (1) the wetbulb
temperature of air entering the evaporator section of the TES coil, (2) the drybulb
temperature of the air entering the evaporator section and (3) the state of TES tank (in C or
fraction). The performance curve can be any curve or table based on three independent
variables, x, y, and z, including: Curve:Triquadratic and Table:MultiVariableLookup. The x
and y values for the curve are the same as for two independent variables while the z
values are the state of the TES tank which are the tanks temperature for water or fluid
storage type or the storage fraction for ice storage types.
The performance curve is normalized to have a value of 1.0 at the rating point which is
defined to be x = 19.4C, y = 26.7C, and z = 0.5 for Ice storage type or z = Fluid Storage
Tank Rating Temperature when storage type is Water or UserDefinedFluidType. The result of
the curve is multiplied by the Discharge Only Mode Rated Sensible Heat Ratio to model the
SHR at coil entering temperatures that differ from the rating point. This field is required if
Discharge Only Mode is available.
Field: Discharge Only Mode Sensible Heat Ratio Function of Flow Fraction Curve Name
This field is the name of a separate performance curve object that parameterizes the
variation of the sensible heat ratio (SHR) as a function of the ratio of actual air flow rate
across the cooling coil to the value of the Rated Evaporator Air Flow Rate. The performance
curve can be any curve or table based on one independent variable, x, including:
Curve:Linear,
Curve:Quadratic,
Curve:Cubic,
Curve:Quartic,
Curve:Exponent,
Curve:ExponentialSkewNormal,
Curve:Sigmoid,
Curve:RectuangularHyperbola1,
Curve:RectangularHyperbola2, Curve:ExponentialDecay, Curve:DoubleExponentialDecay,
and Table:OneIndependentVariable. The performance curve is normalized to have a value of
1.0 at the rating point which is defined to be x = 1.0. The result of the curve is multiplied by

9/29/14

1510

Input-Output Reference

Group Heating and Cooling Coils

the Discharge Only Mode Rated Sensible Heat Ratio to model the SHR at coil air flow rates
that differ from the rating point. This field is required if Discharge Only Mode is available.
Field: Ancillary Electric Power [W]
This field is the electric power level for miscellaneous ancillary controls and standby draws, in
Watts. This power is not linked to any particular operating mode and will always be on,
except when the device is scheduled to not be available by the Availability Schedule. This
field is optional.
Field: Cold Weather Operation Minimum Outdoor Air Temperature [C]
This field is the outdoor temperature at which the device operates additional electric
components to protect from cold weather, in Degrees Celsius. When the outdoor
temperature is below this value, the power draw specified in the next field will be turned on.
The outdoor temperature is obtained from the node specified in the input field called
Storage Tank Ambient Temperature Node Name.
Field: Cold Weather Operation Ancillary Power [W]
This field is the electric power level for cold weather protection. Cold weather protection is in
effect whenever the outdoor temperature is lower than the limit set in the previous field,
except when the device is scheduled to not be available by the Availability Schedule.
Field: Condenser Air Inlet Node Name
This field is the name of system node that serves as the inlet to the condenser section of the
packaged TES coil. This node is typically specified to be an outdoor air node. The
conditions exposed to the condenser are obtained from this system node. This field is
required.
Field: Condenser Air Outlet Node Name
This field is the name of system node that serves as the outlet to the condenser section of the
packaged TES coil. This node is typically not connected to anything else. The conditions
leaving the condenser are applied to this system node. This field is required.
Field: Condenser Design Air Flow Rate [m3/s]
This field is the rate of air flow through the condenser section, in m 3/s. The model assumes
constant, single-speed condenser fans. The flow rate is not used to determine coil operation
but is used to determine the conditions leaving the condenser section. This field is required,
for both air-cooled and evaporatively-cooled condenser types.
This field is autocalulatable. When autocalculated, the design flow rate is determined using
the sizing factor in the following input field.
Field: Condenser Air Flow Sizing Factor
This field is used if the previous input field is set to autocalculate. This sizing factor is
multiplied by the Rated Evaporator Air Flow Rate to obtain a scaled value for Condenser
Design Air Flow Rate, in m 3/s. If this field is left blank the default value is 1.0.
Field: Condenser Type
This field is the type of condenser used by the TES coil. There are two options, AirCooled or
EvaporativelyCooled. The default is AirCooled. The next six put fields are used when the
condenser section is evaporatively cooled.
Field: Evaporative Condenser Effectiveness
This field is the wetbulb effectiveness for the evaporatively-cooled condenser. The
effectiveness is used to model the temperature of air exposed to the condenser section as
follows:

9/29/14

1511

Input-Output Reference

TCond inlet

Group Heating and Cooling Coils

Twb,o

1 EvapCondEffectiveness Tdb,o Twb,o

where

Tcond inlet = the temperature of air entering the condenser section, in C. This value will be
used when evaluating performance curves that depend on the drybulb entering the
condenser section.

Twb ,o = the wetbulb temperature of outdoor air, in C

Tdb ,o = the drybulb temperature of outdoor air, in C.

This field is required if the condenser type is set to EvaporativelyCooled. If the field is left
blank then a default of 0.7 is used.
Field: Evaporative Condenser Pump Rated Power Consumption [W]
This field is the rated power of the evaporative condenser water pump, in Watts. This value
is used to calculate the power required to pump the water used to evaporatively cool the
condenser inlet air. The default is zero, but this field is autosizable using a sizing factor of
0.004266 W of electricity per W of cooling. This field is only used when the condenser type is
set to EvaporativelyCooled.
Field: Basin Heater Capacity [W/K]
This input field is the capacity of the evaporative cooler water basin heater for freeze
protection in Watts per Kelvin. This field is only used when the condenser type is set to
EvaporativelyCooled. This field is used with the following field to determine the electricity
consumption rate for freeze protection of the water in a basin needed for evaporative cooling.
The basin heater electric power is equal to this field multiplied by the difference between the
Basin Heater Setpoint Temperature and the outdoor drybulb temperature. The default is
zero.
Field: Basin Heater Setpoint Temperature [C]
This input field contains the setpoint temperature for basin heater operation, in C. This field
is only used when the condenser type is set to EvaporativelyCooled. The basin heater is
active when the outdoor drybulb temperatures falls below this setpoint temperature. The
default is 2.0C.
Field: Basin Heater Availability Schedule Name
This alpha field contains the name of the basin heater operating schedule. This field is only
used when the condenser type is set to EvaporativelyCooled. The basin heater operating
schedule is assumed to be an on/off schedule and the heater is available to operate any time
the schedule value is greater than 0. The basin heater operates whenever the schedule is on
and the outdoor air drybulb is lower than the setpoint temperature in the previous field. If the
field is left blank, the basin heater is available to operate throughout the simulation.
Field: Supply Water Storage Tank Name
This optional field is used to describe where the TES coil obtains water used for evaporative
cooling of its condenser. If blank or omitted, then the unit will obtain water directly from the
mains. If the name of a Water Storage Tank object is used here, then the unit will attempt to
obtain all its water from that tank. However, if the tank cannot provide all the water the
condenser needs, then the unit will still operate and obtains the rest of the water it needs
form the mains (referred to as Starved Water).

9/29/14

1512

Input-Output Reference

Group Heating and Cooling Coils

Field: Condensate Collection Water Storage Tank Name

This optional field is used to describe where condensate from the coil is collected. If blank or
omitted, then any coil condensate is discarded. Enter the name of a Water Storage Tank
defined elsewhere and the condensate will be collected in that tank.
Field: Storage Tank Plant Connection Inlet Node Name
This is the name of a system node that is the inlet to the TES tank. This field is optional and
is only used if the TES tank is directly connected to a plant loop.
Field: Storage Tank Plant Connection Outlet Node Name
This is the name of a system node that is the inlet to the TES tank. This field is optional and
is only used if the TES tank is directly connected to a plant loop.
Field: Storage Tank Plant Connection Design Flow Rate
This field is the design flow rate for the plant connection to the TES tank, in m 3/s. The TES
tank will make a passive request for this amount of flow. This field is required if the storage
tank is connected to plant.
Field: Storage Tank Plant Connection Heat Transfer Effectiveness
This field specifies the heat transfer effectiveness between the plant connection and the TES
tank. If the effectiveness is set to 1 then ideal heat transfer occurs, as if the fluids were
completely mixed and the fluid leaving the tank is the same temperature as the tank. If the
effectiveness is less than 1.0, then the leaving fluid temperature approaches that of the tank
as would be the case with a heat exchanger. If left blank, the default is 0.7.
Field: Storage Tank Minimum Operating Limit Fluid Temperature [C]
This field is used for fluid-based TES tank (Storage Type of Water or UserDefinedFluidType)
to set the a lower limit on the operating temperatures, in Degrees Celsius. This value
represents the temperature of the fluid-based TES tank when fully charged. This field is
optional. When left blank, the model uses the lowest temperature for which fluid properties
are defined.
Field:: Storage Tank Maximum Operating Limit Fluid Temperature [C]
This field is used for fluid-based TES tank (Storage Type of Water or UserDefinedFluidType)
to set the an upper limit on the operating temperatures, in Degrees Celsius. This value
represents the temperature of the fluid-based TES tank when fully discharged. This field is
optional. When left blank, the model uses the highest temperature for which fluid properties
are defined.
Coil:Cooling:DX:SingleSpeed:ThermalStorage Outputs
HVAC,Average,Cooling Coil Operating Mode Index []
HVAC,Average,Cooling Coil Total Cooling Rate [W]
HVAC,Sum,Cooling Coil Total Cooling Energy [J]
HVAC,Average,Cooling Coil Sensible Cooling Rate [W]
HVAC,Sum,Cooling Coil Sensible Cooling Energy [J]
HVAC,Average,Cooling Coil Latent Cooling Rate [W]
HVAC,Sum,Cooling Coil Latent Cooling Energy [J]
HVAC,Average,Cooling Coil Electric Power [W]
HVAC,Sum,Cooling Coil Electric Energy [J]
HVAC,Average,Cooling Coil Runtime Fraction []
HVAC,Sum,Cooling Coil Cold Weather Protection Electric Energy [J]
HVAC,Average,Cooling Coil Cold Weather Protection Electric Power [W]
HVAC,Average,Cooling Coil Thermal Storage Mechanical Heat Transfer Rate [W]
HVAC,Sum,Cooling Coil Thermal Storage Mechanical Heat Transfer Energy [J]
HVAC,Average,Cooling Coil Thermal Storage Ambient Heat Transfer Rate [W]
HVAC,Sum,Cooling Coil Thermal Storage Ambient Heat Transfer Energy [J]
9/29/14

1513

Input-Output Reference

Group Heating and Cooling Coils

HVAC,Average,Cooling Coil Ice Thermal Storage End Fraction []

HVAC,Average,Cooling Coil Condenser Inlet Temperature [C]
HVAC,Sum,Cooling Coil Evaporative Condenser Water Volume [m3]
HVAC,Sum,Cooling Coil Evaporative Condenser Mains Supply Water Volume [m3]
HVAC,Average,Cooling Coil Evaporative Condenser Pump Electric Power [W]
HVAC,Sum,Cooling Coil Evaporative Condenser Pump Electric Energy [J]
HVAC,Average,Cooling Coil Basin Heater Electric Power [W]
HVAC,Sum,Cooling Coil Basin Heater Electric Energy [J]
HVAC,Average,Cooling Coil Thermal Storage Plant Heat Transfer Rate [W]
HVAC,Sum,Cooling Coil Thermal Storage Plant Heat Transfer Energy [J]
HVAC,Average,Cooling Coil Fluid Thermal Storage End Temperature [C]

Cooling Coil Operating Mode Index [ ]

This output variable reports the operating mode for the cooling coil. The numbers in this
output are integer codes that correspond to the operating modes as described in the following
table. These codes match the values used for input in schedules and EMS actuators to
control operation.
Code

Operating Mode

Off

Cooling Only

Cooling and Charge

Cooling and Discharge

Charge Only

Discharge Only

Cooling Coil Total Cooling Rate [W]

This output is the total (sensible and latent) cooling rate of the coil in Watts.
Cooling Coil Total Cooling Energy [J]
This output is the total (sensible and latent) cooling energy transfer by the coil in Joules. This
output is metered as EnergyTransfer for CoolingCoils.
Cooling Coil Sensible Cooling Rate [W]
This output is the moist air sensible cooling rate of the coil in Watts.
Cooling Coil Sensible Cooling Energy [J]
This output is the moist air sensible cooling energy transfer by the coil in Joules.
Cooling Coil Latent Cooling Rate [W]
This output is the latent cooling rate of the coil in Watts.
Cooling Coil Latent Cooling Energy [J]
This output is the latent cooling energy transfer by the coil in Joules.
Cooling Coil Electric Power [W]
This output is the electricity consumption rate, in Watts, of the compressor(s), pump(s),
condenser fan(s) that are inside the package to drive heat transfer for the cooling coil. This
does not include ancillary electrical consumption for such things as cold weather protection,
off cycle ancillary power, or supply fans.

9/29/14

1514

Input-Output Reference

Group Heating and Cooling Coils

Cooling Coil Electric Energy [J]

This output is the electricity consumption, in Joules, of the compressor(s), pump(s),
condenser fan(s) that are inside the package to drive heat transfer for the cooling coil. This
does not include ancillary electrical consumption for such things as cold weather protection,
off cycle ancillary power, or supply fans.
Cooling Coil Runtime Fraction []
This output is the runtime fraction of cooling coil.
Cooling Coil Cold Weather Protection Electric Power [W]
Cooling Coil Cold Weather Protection Electric Energy [J]
These are the power and energy outputs associated with Cold Weather Operation Ancillary
Power, in Watts and Joules respectively.
Cooling Coil Thermal Storage Mechanical Heat Transfer Rate [W]
Cooling Coil Thermal Storage Mechanical Heat Transfer Energy [J]
These are the power and energy outputs for the coils heat exchange with the TES tank, in
Watts and Joules respectively. The sign convection is that negative values are cooling the
TES tank, or charging it, and positive values are heating the TES tank, or discharging. This
heat transfer is driven by the mechanical systems used inside the package to charge or
discharge the TES tank.
Cooling Coil Thermal Storage Ambient Heat Transfer Rate [W]
Cooling Coil Thermal Storage Ambient Heat Transfer Energy [J]
These are the power and energy outputs for the TES tanks heat exchange with the
surrounding ambient conditions, in Watts and Joules respectively. The sign convection is
that negative values are cooling the TES tank, or charging it, and positive values are heating
the TES tank, or discharging. This heat transfer is driven by the temperature difference
between the media in the tank and the surrounding ambient and is governed by the UA
factor.
Cooling Coil Ice Thermal Storage End Fraction []
This output is the state of the TES tank as fraction of the storage capacity. Because the tank
storage model is dynamic, this value corresponds to the point in time right at the end of the
timestep. This output variable is only available for a storage type of Ice.
Cooling Coil Fluid Thermal Storage End Temperature [C]
This output is the state of the TES tank as the temperature of the fluid in the tank, in C.
Because the tank storage model is dynamic, this value corresponds to the point in time right
at the end of the timestep. This output variable is only available for a storage type of Water
or UserDefinedFluidType.
Cooling Coil Condenser Inlet Temperature [C]
This output is the inlet temperature entering the condenser section of an evaporatively cooled
condenser, in C. This temperature is for the air stream after the evaporative assist and
before entering the condenser. This is the temperature used for condenser entering drybulb
conditions when evaluating performance curves for evaporatively cooled condensers. This
output is only available for evaporatively cooled condensers.
Cooling Coil Evaporative Condenser Water Volume [m3]
This output is the amount of water used to evaporatively cool the condenser inlet air, in cubic
meters. This output is only available for evaporatively cooled condensers.

9/29/14

1515

Input-Output Reference

Group Fans

Cooling Coil Evaporative Condenser Mains Supply Water Volume [m3]

This output is the volume of water drawn from mains water service for the evaporatively
cooled condenser. This output is only available for evaporatively cooled condensers.
Cooling Coil Evaporative Condenser Pump Electric Power [W]
This output is the average electricity consumption rate of the evaporative condenser water
pump, in Watts. This output is only available for evaporatively cooled condensers.
Cooling Coil Evaporative Condenser Pump Electric Energy [J]
This output is the electricity consumption of the evaporative condenser water pump, in
Joules. This output is only available for evaporatively cooled condensers.
Cooling Coil Basin Heater Electric Power [W]
This output is the average electricity consumption rate of the basin heater, in Watts. This
output is only available for evaporatively cooled condensers.
Cooling Coil Basin Heater Electric Energy [J]
This output is the electricity consumption of the basin heater, in Joules. This output is only
available for evaporatively cooled condensers.
Cooling Coil Thermal Storage Plant Heat Transfer Rate [W]
Cooling Coil Thermal Storage Plant Heat Transfer Energy [J]
These are the power and energy outputs for the TES tanks heat exchange with the plant
loop, in Watts and Joules respectively. This output is only available if the plant connection to
the tank is used. The sign convection is that negative values are cooling the TES tank, or
charging it, and positive values are heating the TES tank, or discharging. This heat transfer
is driven by the temperature difference between the media in the tank and the plant loop fluid
and is governed by the effectiveness and plant fluid mass flow rate.

Group Fans
The following fans may be defined either in the air loop or as a zone equipment component:
Fan:ConstantVolume,
Fan:OnOff,
Fan:VariableVolume,
Fan:ZoneExhaust,
and
FanPerformance:NightVentilation. The data that are common to these fan types include an
identifying name, an availability schedule name, a total efficiency rating, a rated pressure
rise, and inlet and outlet air node names. In the case of a variable volume fan, additional
input includes parameters for modeling fan performance over a range of fan speeds. See the
engineering documentation for the variable speed fan for a further description of what these
coefficients represent. Commonly-used values for different variable volume systems are
shown in the following table.
Table 29. Fan Coefficient Values
Fan Coeff. 1

Fan Coeff. 2

Fan Coeff. 3

Fan Coeff. 4

Fan Coeff. 5

Inlet Vane Dampers

Type of Fan

0.35071223

0.30850535

-0.54137364

0.87198823

0.000

Discharge Dampers

0.37073425

0.97250253

-0.34240761

0.000

0.000

Var. Speed Motor

0.0015302446

0.0052080574

1.1086242

-0.11635563

0.000

Fan:ConstantVolume
This object models a constant air volume fan that is intended to operate continuously based
on a time schedule. This fan will not cycle on and off based on cooling/heating load or other
control signals (Ref: Fan:OnOff).

9/29/14

1516

Input-Output Reference

Group Fans

Field: Name
A unique user-assigned name for an instance of a Fan:ConstantVolume. Any reference to
this fan by another object will use this name.
Field: Availability Schedule Name
The name of the schedule (ref: Schedule) that denotes whether the fan can run during a
given time period. A schedule value of 0 indicates that the fan is off for that time period. A
schedule value greater than 0 indicates that the fan can operate during the time period. If this
field is blank, the schedule has values of 1 for all time periods. Applicable availability
managers (ref. AvailabilityManagerAssignmentList) may override this schedule by forcing the
fan to be on or off.
Field: Fan Total Efficiency
This value is the overall efficiency of the fan, i.e., the ratio of the power delivered to the fluid
to the electrical input power. It is the product of the motor efficiency and the impeller
efficiency. The motor efficiency is the power delivered to the shaft divided by the electrical
power input to the motor. The impeller efficiency is power delivered to the fluid (air) divided by
the shaft power. The power delivered to the fluid is the mass flow rate of the air multiplied by
the pressure rise divided by the air density. This input value must be between 0 and 1.The
default is 0.7.
Field: Pressure Rise
The pressure rise in Pascals at full flow and standard (sea level) conditions (20C and
101325 Pa).
Field: Maximum Flow Rate
The full load air volumetric flow rate (m 3/sec) at standard temperature and pressure (dry air at
20C drybulb). The program does use local barometric pressure to account for altitude using
equation for "standard atmospheric" pressure on p 6.1 of the ASHRAE 1997 HOF (SI edition)
to initialize the air systems being simulated.
p=101325*(1-2.25577E-05*Z)**5.2559
where p=pressure in Pa and Z=altitude in m
Field: Motor Efficiency
The shaft power divided by the electrical power consumed. Must be between 0 and 1. The
default is 0.9.
Field: Motor In Airstream Fraction
The fraction of the motor heat that is added to the air stream. A value of 0 means that the
motor is completely outside the air stream. A value of 1 means that all of the motor heat loss
will go into the air stream and act to cause a temperature rise. Must be between 0 and 1. The
default is 1.0.
Field: Air Inlet Node Name
The name of the HVAC system node which supplies the inlet air conditions to the fan.
Field: Air Outlet Node Name
The name of the HVAC system node to which the fan sends its outlet air.
Field: End-Use Subcategory
Allows you to specify a user-defined end-use subcategory, e.g., "Central System", etc. A new
meter for reporting is created for each unique subcategory (ref: Output:Meter objects).
Subcategories are also reported in the ABUPS table. If this field is omitted or blank, the fan
will be assigned to the "General" end-use subcategory.
9/29/14

1517

Input-Output Reference

Group Fans

Constant Volume Fan Outputs

HVAC,Average,Fan Electric Power[W]
HVAC,Average,Fan Rise in Air Temperature [deltaC]
HVAC,Sum,Fan Electric Energy [J]

Fan Electric Power [W]

This output field contains the average electricity consumption rate for the fan in Watts for the
timestep being reported.
Fan Rise in Air Temperature [deltaC]
This output field contains the average rise in air temperature across the fan (outlet air
temperature minus inlet air temperature) in degrees Celsius for the timestep being reported.
Fan Electric Energy [J]
This output field contains the electricity consumption of the fan in Joules for the timestep
being reported. This output is also added to a meter with Resource Type = Electricity, End
Use Key= Fans, Group Key= System (ref. Output:Meter objects).
Fan:OnOff
This object models a constant air volume fan that is intended to cycle on and off in tandem
with a cooling or heating system (i.e., AUTO fan control mode). The fan can also operate
continuously like Fan:ConstantVolume. If modeling continuous operation and this object is
used as part of a system that utilizes Coil:Heating:Gas, Coil:Cooling:DX:SingleSpeed or
Coil:Heating:DX:SingleSpeed, the user should confirm proper air flow rates (coil and fan max
flows are equal) and that the coil part-load fraction correlation(s) are appropriate (e.g., partload fraction is less than or equal to 1 for all values of coil part-load ratio). If modeling multispeed fan operation, this object must be used as part of a compound object that allows
multiple
fan
speeds
(e.g.,
AirLoopHVAC:Unitary:Furnace:HeatCool,
ZoneHVAC:PackagedTerminalAirConditioner, etc.). In this case, the ratio of the compound
object air flow rate to the fans maximum air flow rate is used to determine the power at
alternate fan speeds. The optional input for Fan Power Ratio Function of Speed Ratio Curve
Name must be entered to model multi-speed fan operation. An optional fan total efficiency
ratio curve is also available to model efficiency differences at alternate fan speeds.
Field: Name
A unique user-assigned name for an instance of a Fan:OnOff. Any reference to this fan by
another object will use this name.
Field: Availability Schedule Name
The name of the schedule (ref: Schedule) that denotes whether the fan can run during a
given time period. A schedule value of 0 indicates that the fan is off for that time period. A
schedule value greater than 0 indicates that the fan can operate during the time period. If this
field is blank, the schedule has values of 1 for all time periods. Applicable availability
managers (ref. AvailabilityManagerAssignmentList) may override this schedule by forcing the
fan to be on or off.
Field: Fan Total Efficiency
This value is the overall efficiency of the fan, i.e., the ratio of the power delivered to the fluid
to the electrical input power. It is the product of the motor efficiency and the impeller
efficiency. The motor efficiency is the power delivered to the shaft divided by the electrical
power input to the motor. The impeller efficiency is power delivered to the fluid (air) divided by
the shaft power. The power delivered to the fluid is the mass flow rate of the air multiplied by
the pressure rise divided by the air density. This input value must be between 0 and 1.The
default is 0.6.
9/29/14

1518

Input-Output Reference

Group Fans

Field: Pressure Rise

The pressure rise in Pascals at full flow and standard (sea level) conditions (20C and
101325 Pa).
Field: Maximum Flow Rate
The full load air volumetric flow rate (m 3/sec) at standard temperature and pressure (dry air at
20C drybulb). The program does use local barometric pressure to account for altitude using
equation for "standard atmospheric" pressure on p 6.1 of the ASHRAE 1997 HOF (SI edition)
to initialize the air systems being simulated.
p=101325*(1-2.25577E-05*Z)**5.2559
where p=pressure in Pa and Z=altitude in m
Field: Motor Efficiency
The shaft power divided by the electrical power consumed. Must be between 0 and 1. The
default is 0.8.
Field: Motor In Airstream Fraction
The fraction of the motor heat that is added to the air stream. A value of 0 means that the
motor is completely outside the air stream. A value of 1 means that all of the motor heat loss
will go into the air stream and act to cause a temperature rise. Must be between 0 and 1. The
default is 1.0.
Field: Air Inlet Node Name
The name of the HVAC system node which supplies the inlet air conditions to the fan.
Field: Air Outlet Node Name
The name of the HVAC system node to which the fan sends its outlet air.
Field: Fan Power Ratio Function of Speed Ratio Curve Name
Enter the name of an exponent performance curve. This optional alpha field must be used to
simulate multi-speed fan motors. This curve represents the ratio of actual fan power to rated
fan power when a change in fan speed occurs. Leave this field blank when simulating
constant-speed fan motors.
Field: Fan Efficiency Ratio Function of Speed Ratio Curve Name
Enter the name of a quadratic or cubic performance curve. This optional alpha field is used to
simulate multi-speed fan motors. This curve represents the ratio of actual fan total efficiency
to rated fan total efficiency when a change in fan speed occurs. Leave this field blank when
simulating constant-speed fan motors.
Field: End-Use Subcategory
Allows you to specify a user-defined end-use subcategory, e.g., "Main Fans", etc. A new
meter for reporting is created for each unique subcategory (ref: Output:Meter objects).
Subcategories are also reported in the ABUPS table. If this field is omitted or blank, the fan
will be assigned to the "General" end-use subcategory.
Following is an example input for an OnOff Fan.

9/29/14

1519

Input-Output Reference

Group Fans

Fan:OnOff,
Supply Fan 1,
! Fan Name
FanAndCoilAvailSched, ! Fan Schedule
0.7,
! Fan Total Efficiency
600.0,
! Delta Pressure [N/M^2]
1.3,
! Max Flow Rate [m^3/Sec]
0.9,
! Motor Efficiency
1.0,
! Motor in Airstream Fraction (1.0 means motor in air stream)
Air Loop Inlet Node, Cooling Coil Air Inlet Node; !Inlet Node, Outlet Node

On Off Fan Outputs

HVAC,Average,Fan Electric Power[W]
HVAC,Average,Fan Rise in Air Temperature [deltaC]
HVAC,Sum,Fan Electric Energy [J]
HVAC,Average,Fan Runtime Fraction []

Fan Electric Power [W]

This output field contains the average electricity consumption rate for the fan in Watts for the
timestep being reported.
Fan Rise in Air Temperature [deltaC]
This output field contains the average rise in air temperature across the fan (outlet air
temperature minus inlet air temperature) in degrees Celsius for the timestep being reported.
Fan Electric Energy [J]
This output field contains the electricity consumption of the fan in Joules for the timestep
being reported. This output is also added to a meter with Resource Type = Electricity, End
Use Key= Fans, Group Key= System (ref. Output:Meter objects).
Fan Runtime Fraction []
This output field contains the fraction of time that this fan operated for the timestep being
reported.
Fan:VariableVolume
Field: Name
A unique user-assigned name for an instance of a Fan:VariableVolume. Any reference to this
fan by another object will use this name.
Field: Availability Schedule Name
The name of the schedule (ref: Schedule) that denotes whether the fan can run during a
given time period. A schedule value of 0 indicates that the fan is off for that time period. A
schedule value greater than 0 indicates that the fan can operate during the time period. If this
field is blank, the schedule has values of 1 for all time periods. Applicable availability
managers (ref. AvailabilityManagerAssignmentList) may override this schedule by forcing the
fan to be on or off.
Field: Fan Total Efficiency
This value is the overall efficiency of the fan, i.e., the ratio of the power delivered to the fluid
to the electrical input power. It is the product of the motor efficiency and the impeller
efficiency. The motor efficiency is the power delivered to the shaft divided by the electrical
power input to the motor. The impeller efficiency is power delivered to the fluid (air) divided by
the shaft power. The power delivered to the fluid is the mass flow rate of the air multiplied by
the pressure rise divided by the air density. This input value must be between 0 and 1. The
default is 0.7.

9/29/14

1520

Input-Output Reference

Group Fans

Field: Pressure Rise

The pressure rise in Pascals at full flow and standard (sea level) conditions (20C and
101325 Pa).
Field: Maximum Flow Rate
The full load air volumetric flow rate (m 3/sec) at standard temperature and pressure (dry air at
20C drybulb). The program does use local barometric pressure to account for altitude using
equation for "standard atmospheric" pressure on p 6.1 of the ASHRAE 1997 HOF (SI edition)
to initialize the air systems being simulated.
p=101325*(1-2.25577E-05*Z)**5.2559
where p=pressure in Pa and Z=altitude in m
Field: Fan Power Minimum Flow Rate Input Method
This field is a key/choice field that tells which of the next two fields is filled and is descriptive
of how the minimum flow rate is specified for calculating the fan power. The key/choices are:
Fraction
With this choice, the fan power will be calculated using the value specified in the Fan Power
Minimum Flow Fraction field. (The Fan Power Minimum Flow Fraction field should be filled.)
FixedFlowRate
With this choice, the fan power will be calculated using the value specified in the Fan Power
Minimum Air Flow Rate field. (The Fan Power Minimum Air Flow Rate field should be filled.)
The default is Fraction.
Field: Fan Power Minimum Flow Fraction
The minimum air volumetric flow rate for fan power, specified as a fraction of maximum
system air flow rate. Must be between 0 and 1. Note that this field is only used to calculate
the fan power. This field does not enforce the system air flow rate during simulation. The
default is 0.25.
Field: Fan Power Minimum Air Flow Rate
The minimum air volumetric flow rate for fan power, specified as a constant minimum air flow
rate (m3/sec). Note that this field is only used to calculate the fan power. This field does not
enforce the system air flow rate during simulation.
Field: Motor Efficiency
The shaft power divided by the electrical power consumed. Must be between 0 and 1. The
default is 0.9.
Field: Motor In Airstream Fraction
The fraction of the motor heat that is added to the air stream. A value of 0 means that the
motor is completely outside the air stream. A value of 1 means that all of the motor heat loss
will go into the air stream and act to cause a temperature rise. Must be between 0 and 1. The
default is 1.0.
Field: Fan Power Coefficient 1
The constant coefficient (C1) in a fourth order polynomial curve giving the fraction of full load
power (PLF) as a function of flow fraction (FF). Flow fraction is the air mass flow rate divided
by the maximum air mass flow rate. The curve is:
PLF = C1 + C2. FF + C3. FF2 + C4. FF3 + C5. FF4

9/29/14

1521

Input-Output Reference

Group Fans

Field: Fan Power Coefficient 2

The linear coefficient (C2) in a fourth order polynomial curve giving the fraction of full load
power (PLF) as a function of flow fraction (FF). Flow fraction is the air mass flow rate divided
by the maximum air mass flow rate. The curve is:
PLF = C1 + C2. FF + C3. FF2 + C4. FF3 + C5. FF4
Field: Fan Power Coefficient 3
The quadratic coefficient (C3) in a fourth order polynomial curve giving the fraction of full load
power (PLF) as a function of flow fraction (FF). Flow fraction is the air mass flow rate divided
by the maximum air mass flow rate. The curve is:
PLF = C1 + C2. FF + C3. FF2 + C4. FF3 + C5. FF4
Field: Fan Power Coefficient 4
The cubic coefficient (C1) in a fourth order polynomial curve giving the fraction of full load
power (PLF) as a function of flow fraction (FF). Flow fraction is the air mass flow rate divided
by the maximum air mass flow rate. The curve is:
PLF = C1 + C2. FF + C3. FF2 + C4. FF3 + C5. FF4
Field: Fan Power Coefficient 5
The coefficient C5 in a fourth order polynomial curve giving the fraction of full load power
(PLF) as a function of flow fraction (FF). Flow fraction is the air mass flow rate divided by the
maximum air mass flow rate. The curve is:
PLF = C1 + C2. FF + C3. FF2 + C4. FF3 + C5. FF4
Field: Air Inlet Node Name
The name of the HVAC system node which supplies the inlet air conditions to the fan.
Field: Air Outlet Node Name
The name of the HVAC system node to which the fan sends its outlet air.
Field: End-Use Subcategory
Allows you to specify a user-defined end-use subcategory, e.g., "Central System", etc. A new
meter for reporting is created for each unique subcategory (ref: Output:Meter objects).
Subcategories are also reported in the ABUPS table. If this field is omitted or blank, the fan
will be assigned to the "General" end-use subcategory.
Variable Volume Fan Outputs
HVAC,Average,Fan Electric Power[W]
HVAC,Average,Fan Rise in Air Temperature [deltaC]
HVAC,Sum,Fan Electric Energy [J]

Fan Electric Power [W]

This output field contains the average electricity consumption rate for the fan in Watts for the
timestep being reported.
Fan Rise in Air Temperature [deltaC]
This output field contains the average rise in air temperature across the fan (outlet air
temperature minus inlet air temperature) in degrees Celsius for the timestep being reported.
Fan Electric Energy [J]
This output field contains the electricity consumption of the fan in Joules for the timestep
being reported. This output is also added to a meter with Resource Type = Electricity, End
Use Key= Fans, Group Key= System (ref. Output:Meter objects).
9/29/14

1522

Input-Output Reference

Group Fans

Fan:ZoneExhaust
This fan object differs from the other fans in that it stands on its own in a zone rather than
serving as one part of an HVAC air system.
This object appears directly in a
ZoneHVAC:EquipmentList object and all the controls are contained within the fan object. The
zone exhaust fan model provides a way to include the electrical power used by the fan. It
can also impact air flows in central air handlers by decreasing the flow of return air and
sometimes increasing the outdoor air flow rate.
There are several control options available for the exhaust fan including: an on/off availability
schedule, interaction with system availability managers, minimum zone air temperature
control limits and a variable flow fraction schedule.
The way in which the exhaust fan impacts central air system can be controlled by declaring
what portion of the flow has been balanced by simple airflow from infiltration, ventilation, or
mixing. However it is important to note that presence of an exhaust fan does not by itself
drive any simple airflow such as infiltration, ventilation, or zone mixing. There is no
comprehensive automatic mass balancing between air system flows, exhaust flows, and the
separate simple airflows. For balancing, the simple airflows need to have their own input
objects that need to be coordinated with the exhaust fan.
Field: Name
A unique user-assigned name for an instance of a Fan:ZoneExhaust. Any reference to this
fan by another object will use this name.
Field: Availability Schedule Name
The name of the schedule (ref: Schedule) that denotes whether the fan can run during a
given time period. A schedule value of 0 indicates that the fan is off for that time period. A
schedule value greater than 0 indicates that the fan can operate during the time period. If this
field is blank, the schedule has values of 1 for all time periods. Applicable availability
managers (ref. AvailabilityManagerAssignmentList) may override this schedule by forcing the
fan to be on or off.
Field: Fan Total Efficiency
This value is the overall efficiency of the fan, i.e., the ratio of the power delivered to the fluid
to the electrical input power. It is the product of the motor efficiency and the impeller
efficiency. The motor efficiency is the power delivered to the shaft divided by the electrical
power input to the motor. The impeller efficiency is power delivered to the fluid (air) divided by
the shaft power. The power delivered to the fluid is the mass flow rate of the air multiplied by
the pressure rise divided by the air density. This input value must be between 0 and 1. The
default is 0.6.
Field: Pressure Rise
The pressure rise in Pascals at full flow and standard (sea level) conditions (20C and
101325 Pa).
Field: Maximum Flow Rate
The full load air volumetric flow rate (m 3/sec) at standard temperature and pressure (dry air at
20C drybulb). The program does use local barometric pressure to account for altitude using
equation for "standard atmospheric" pressure on p 6.1 of the ASHRAE 1997 HOF (SI edition)
to initialize the air systems being simulated.
p=101325*(1-2.25577E-05*Z)**5.2559
where p=pressure in Pa and Z=altitude in m

9/29/14

1523

Input-Output Reference

Group Fans

Field: Air Inlet Node Name

The name of the HVAC system node which supplies the inlet air conditions to the fan. This
node
should
be
listed
as
a
zone
exhaust
node
in
an
associated
ZoneHVAC:EquipmentConnections object.
Field: Air Outlet Node Name
The name of the HVAC system node to which the fan sends its outlet air.
Field: End-Use Subcategory
Allows you to specify a user-defined end-use subcategory, e.g., "Kitchen Exhaust", "Fume
Hoods", etc. A new meter for reporting is created for each unique subcategory (ref:
Output:Meter objects). Subcategories are also reported in the ABUPS table. If this field is
omitted or blank, the fan will be assigned to the "General" end-use subcategory.
Field: Flow Fraction Schedule Name
This field is optional. If it is not used then the fan operates at the maximum flow rate. If a
schedule is input here, then it should contain fractional values between 0.0 and 1.0, inclusive.
The flow rate that the fan operates will be this fraction times the maximum flow rate. This
allows a variable speed exhaust fan to be modeled according to a schedule.
Field: System Availability Manager Coupling Mode
This field is optional. If if is not used then the exhaust fan is assumed to be integrated with
the central air handlers system availability manager. This field can be used to control if the
exhaust fan should operate independently or not. For example, when a night cycle
availability manager turns on the central air system for freeze protection, this field can be
used to control if the zone exhaust fans should also run at the same time or not. The key
choice Coupled indicates that the exhaust fan should be integrated with the system
availability manager so that the fan runs when the air system is forced to run. The key
choice Decoupled indicates that the exhaust fan should operate on its own and ignore the
system availability managers requests so that the exhaust fan can remain off when the air
system runs. The default is Coupled.
Field: Minimum Zone Temperature Limit Schedule Name
This field is optional. If it is not used then there will be no temperature-related control over the
operation of the exhaust fan. If the field is used, then enter the name of a schedule with
values for zone temperature values (C). The fans control will be based on a comparison
between the current zone air temperature and the schedule values. If the zone is warmer
than the scheduled limit, then the fan will operate. When balancing with simple ventilation,
this feature can be used to coordinate exhaust fan operation with ZoneVentilation:* controls
for minimum indoor temperature.
Field: Balanced Exhaust Fraction Schedule Name
This field is optional. If it is not used, then all the exhaust air flow is assumed to be
unbalanced by any simple airflows, such as infiltration, ventilation, or zone mixing.
Unbalanced exhaust is then modeled as being provided by the outdoor air system in the
central air system. The modeling of unbalanced will reduce the flow rates at the zones return
air node by the flow rate that is being exhausted and will insure that the outdoor air flow rate
is sufficient to serve the exhaust. If this field is used, then enter the name of a schedule with
fractional values between 0.0 and 1.0, inclusive. This fraction is applied to the exhaust fan
flow rate and the model tracks the portion of the exhaust that is balanced. Balanced
exhaust is then modeled as being provided by simple airflows and does not impact the
central air system return air or outdoor air flow rates. For example, if a kitchen zone with an
exhaust fan is designed to draw half of its make up air from a neighboring dining room and
the other half from the outdoor air system, then a schedule value of 0.5 could be used here.

9/29/14

1524

Input-Output Reference

Group Fans

Zone Exhaust Fan Outputs

HVAC,Average,Fan Electric Power [W]
HVAC,Average,Fan Rise in Air Temperature[deltaC]
HVAC,Sum,Fan Electric Energy [J]
HVAC,Average,Fan Unbalanced Air Mass Flow Rate [kg/s]
HVAC,Average,Fan Balanced Air Mass Flow Rate [kg/s]

Fan Electric Power [W]

This output field contains the average electricity consumption rate for the fan in Watts for the
timestep being reported.
Fan Rise in Air Temperature [deltaC]
This output field contains the average rise in air temperature across the fan (outlet air
temperature minus inlet air temperature) in degrees Celsius for the timestep being reported.
Fan Electric Energy [J]
This output field contains the electricity consumption of the fan in Joules for the timestep
being reported. This output is also added to an output meter with Resource Type = Electricity,
End Use Key= Fans, Group Key= System (ref. Output:Meter objects).
Fan Unbalanced Air Mass Flow Rate [kg/s]
Fan Balanced Air Mass Flow Rate [kg/s]
These two output variables are available when the exhaust fan uses the input field called
Balanced Exhaust Fraction Schedule Name. The balanced air flow is the result of the current
flow rate times the balance fraction. The unbalanced air flow is the difference between the
current flow rate and the balanced flow rate. These outputs are the resulting flow rates in
kg/s.
Examples of Fan:ConstantVolume, Fan:VariableVolume, Fan:ZoneExhaust, and , Fan:OnOff,
fans in an IDF are:
Fan:ConstantVolume,
Supply Fan 1, !- Name
FanAndCoilAvailSched,
!- Availability Schedule Name
0.7,
!- Fan Total Efficiency
600.0,
!- Pressure Rise {Pa}
1.3,
!- Maximum Flow Rate {m3/sec}
0.9,
!- Motor Efficiency
1.0,
!- Motor in Airstream Fraction
Air Loop Inlet Node, Cooling Coil Air Inlet Node; !- Air Inlet Node Name, Air Outlet Node Name

Fan:VariableVolume,
Var Vol Supply Fan 1, !- Name
FanAndCoilAvailSched, !- Availability Schedule Name
0.7,
!- Fan Total Efficiency
600.0,
!- Pressure Rise {Pa}
1.3,
!- Maximum Flow Rate {m3/s}
0.20,
!- Minimum Flow Rate {m3/s}
0.9,
!- Motor Efficiency
1.0,
!- Motor in Airstream Fraction
0.35071223,
!- Fan Coefficient 1
0.30850535,
!- Fan Coefficient 2
-0.54137364,
!- Fan Coefficient 3
0.87198823,
!- Fan Coefficient 4
0.000,
!- Fan Coefficient 5
Air Loop Inlet Node, Cooling Coil Air Inlet Node; !- Air Inlet Node Name, Air Outlet Node Name

9/29/14

1525

Input-Output Reference

Group Fans

Fan:ZoneExhaust,
Zone 2 Exhaust Fan,
FanAndCoilAvailSched,
0.6,
125,
0.1,
Zone 2 Exhaust Node,
Zone 2 Exhaust Fan Outlet Node,
Kitchen Exhaust;

Fan:OnOff,
AHU 1 Supply Fan,
FanAvailSched,
0.7,
600.0,
2.0,
0.9,
1.0,
AHU 1 Air Loop Inlet,
AHU 1 Supply Fan Outlet;

!!!!!!!!!-

!!!!!!!!-

Name
Availability Schedule Name
Fan Total Efficiency
Pressure Rise {Pa}
Maximum Flow Rate {m3/s}
Air Inlet Node Name
Air Outlet Node Name
End-Use Subcategory

Name
Availability Schedule Name
Fan Total Efficiency
Pressure Rise {Pa}
Maximum Flow Rate {m3/s}
Motor Efficiency
Motor in Airstream Fraction
Air Inlet Node Name
Air Outlet Node Name

FanPerformance:NightVentilation
This object is used for specifying an alternate set of performance parameters for a fan. These
alternate
parameters
are
used
when
a
system
manager
(such
as
AvailabilityManager:NightVentilation) sets a specified flow rate for a central forced air system.
At this time, it can be used with Fan:ConstantVolume, Fan:VariableVolume,
Fan:ZoneExhaust, and , Fan:OnOff fans, but not with Fan:ComponentModel fans. The fan
model checks whether a fixed flow rate has been set; if it has the fan model will use these
alternate performance parameters. Note that it is assumed that the fan will run at a fixed
speed in the alternate mode. The inputs needed by this object are the fan name, fan total
efficiency, pressure rise, flow rate, motor efficiency, and motor in airstream fraction.
Field: Fan Name
This is the name of a fan defined elsewhere in the input file. The night vent performance
parameters will be applied to the named fan when a system manager has set the air system
flow rate.
Field: Fan Total Efficiency
This value is the overall efficiency of the fan, i.e., the ratio of the power delivered to the fluid
to the electrical input power. It is the product of the motor efficiency and the impeller
efficiency. The motor efficiency is the power delivered to the shaft divided by the electrical
power input to the motor. The impeller efficiency is power delivered to the fluid (air) divided by
the shaft power. The power delivered to the fluid is the mass flow rate of the air multiplied by
the pressure rise divided by the air density. This input value must be between 0 and 1. This is
a required field with no default.
Field: Pressure Rise
The pressure rise in Pascals at full flow and standard (sea level) conditions (20C and
101325 Pa).
Field: Maximum Flow Rate
The design volumetric flow rate of the fan (m3/sec) at standard conditions. This input is not
currently used by the night ventilation manager. The flow rate during night ventilation is
specified using the SystemAvailabilityManager:NightVentilation "Night Venting Flow Fraction"
field. This fraction is multiplied times the fan object's design flow rate.

9/29/14

1526

Input-Output Reference

Group Fans

Field: Motor Efficiency

The shaft power divided by the electrical power consumed. Must be between 0 and 1. This is
a required field with no default.
Field: Motor in Airstream Fraction
The fraction of the motor heat that is added to the air stream. A value of 0 means that the
motor is completely outside the air stream. A value of 1 means that all of the motor heat loss
will go into the air stream and act to cause a temperature rise. Must be between 0 and 1. The
default is 1.0.
An example of use in an IDF:
Fan:VariableVolume,
Supply Fan 1,
!- Name
FanAvailSched,
!- Availability Schedule Name
0.7,
!- Fan Efficiency
600.0,
!- Pressure Rise {Pa}
autosize,
!- Maximum Flow Rate {m3/s}
autosize,
!- Minimum Flow Rate {m3/s}
0.9,
!- Motor Efficiency
1.0,
!- Motor In Airstream Fraction
0.35071223,
!- Fan Coefficient 1
0.30850535,
!- Fan Coefficient 2
-0.54137364,
!- Fan Coefficient 3
0.87198823,
!- Fan Coefficient 4
0.000,
!- Fan Coefficient 5
Main Heating Coil 1 Outlet Node, !- Air Inlet Node Name
VAV Sys 1 Outlet Node;
!- Air Outlet Node Name
FanPerformance:NightVentilation,
Supply Fan 1,
!- Fan Name
0.7,
!- Fan Total Efficiency
67.0,
!- Pressure Rise {Pa}
autosize,
!- Maximum Flow Rate {m3/s}
0.9,
!- Motor Efficiency
1.0;
!- Motor in Airstream Fraction

Fan:ComponentModel
The Fan:ComponentModel fan is a more detailed fan type that can be defined in the air loop
for central constant-air-volume (CAV) and variable-air-volume (VAV) systems. It includes
inputs that describe the air-distribution system as well as the fan, its drive belt (if used), its
motor, and its variable-frequency-drive (if used). See the engineering documentation for
further descriptions about the inputs for this fan type.
Field: Name
The required unique user-assigned alpha name for an instance of a Fan:ComponentModel.
Any reference to this fan by another object will use this name.
Field: Air Inlet Node Name
The required alpha name of the HVAC system node which supplies the inlet air conditions to
the fan.
Field: Air Outlet Node Name
The required alpha name of the HVAC system node to which the fan sends its outlet air.
Field: Availability Schedule Name
The required alpha name of the schedule (ref: Schedule) that denotes whether the fan can
run during a given time period. A schedule value of 0 indicates that the fan is off for that time
period. A schedule value greater than 0 indicates that the fan can operate during the time
period. If this field is blank, the schedule has values of 1 for all time periods. Applicable

9/29/14

1527

Input-Output Reference

Group Fans

availability managers (ref. AvailabilityManagerAssignmentList) may override this schedule by

forcing the fan to be on or off.
Field: Maximum Flow Rate
The full-load volumetric airflow (m 3/sec) through the fan at standard temperature and
pressure (dry air at 20C dry-bulb). To initialize the air systems being simulated, the program
uses local barometric pressure adjusted for altitude, based on the equation for "standard
atmospheric" pressure on p.6.1 of the 1997 ASHRAE Handbook of Fundamentals (SI
edition):
p=101325 * (1 - 2.25577E-05 * Z)**5.2559
where p = pressure in Pa and Z = altitude in m. Can be autosized.
Specified or autosized maximum airflow rate (including effects of scaling by Field: Fan Sizing
Factor) along with corresponding fan static pressure rise and fan shaft power are reported in
the .eio file as, respectively, Design Fan Airflow [m3/s], Design Fan Static Pressure Rise [Pa],
and Design Fan Shaft Power [W].
Field: Minimum Flow Rate
The minimum volumetric airflow (m 3/sec) through the fan at standard temperature and
pressure (see Maximum Flow Rate field above for condition details). Can be autosized.
Field: Fan Sizing Factor
The numeric dimensionless factor (Ffan) used to multiply the specified or autosized full-load
volumetric airflow (see Maximum Flow Rate field above for details) for fan sizing. If specified,
minimum value is 1.0. Default is 1.0 if field is blank.
Field: Fan Wheel Diameter
The required numeric outer diameter of the fan wheel (Dfan, m). This value is determined from
manufacturers data. In general, larger diameter fans have higher maximum efficiency than
smaller diameter fans of the same type (Ref: AMCA Standard 205-10: Energy Efficiency
Classification for Fans). Must be greater than zero.
Field: Fan Outlet Area
The required numeric outlet area of the fan (Afan,out, m2). This value is determined from
manufacturers data. It is used to convert fan total pressure rise to fan static pressure rise.
Fan static pressure rise is the fan total pressure rise minus the fan outlet velocity pressure; it
is not the difference between fan outlet and inlet static pressures (Ref: ANSI/AMCA Standard
210-07, ANSI/ASHRAE Standard 51-07: Laboratory Methods of Testing Fans for Certified
Aerodynamic Performance Rating). Must be greater than zero.
Field: Maximum Fan Static Efficiency
The required numeric maximum ratio (fan,max) between the power delivered to the air (Hair, W)
and the fan shaft input power (Hfan, W). For this parameter, Hair is the volumetric airflow
through the fan multiplied by the fan static pressure rise. Maximum fan static efficiency is
determined from analyses of manufacturers data using:

fan ,max

max

Pfan Q fan
H fan

where Pfan is fan static pressure rise (Pa) and Qfan is airflow through the fan (m 3/sec).
Typically, do not select curves on fan performance maps of pressure rise versus flow
correspond to or are near maximum efficiency. Must be greater than zero and less than or
equal to 1.0.
Calculated fan static efficiency at design flow condition (including part-load effects of
oversized fan) is reported in the .eio file as Design Fan Efficiency [-].
9/29/14

1528

Input-Output Reference

Group Fans

Field: Euler Number at Maximum Fan Static Efficiency

The required numeric Euler number (Eumax), which is also called the throttling or pressure
coefficient, and is the ratio of pressure forces to inertial forces. The Euler number is
determined from analyses of manufacturers data using:

Eu

Pfan D 4fan
Q 2fan

where Pfan is fan static pressure rise (Pa; see Fan Pressure Rise Curve Name field), Dfan is
wheel diameter (m), is the manufacturers reference air density (kg/m 3), and Qfan is airflow
through the fan (m 3/sec). Eumax is calculated using any pair of pressure rise and airflow
values that correspond with maximum fan static efficiency for the specified fan. Must be
greater than zero.
Field: Maximum Dimensionless Fan Airflow
The required numeric maximum dimensionless airflow (max) through the fan, which
corresponds to the maximum ratio between the airflow through the fan (Qfan, m3/sec) and the
fan shaft rotational speed (fan, rpm) for the specified fan wheel diameter (Dfan, m). max is
determined from manufacturers data using:
max

Q fan
30
*
max
D3fan
fan

max occurs at minimum Eu, which corresponds to maximum speed (high flow) with zero
pressure rise. The factor (30/) converts revolutions per minute (rpm) to rad/s. Must be
greater than zero.
Field: Motor Fan Pulley Ratio
The numeric dimensionless ratio of the motor pulley diameter to the fan pulley diameter
(Dmotor,pulley / Dfan,pulley). If specified, must be greater than zero. This ratio can be adjusted to
account for belt slip if the fractional slip is known (multiply the drive ratio with no slip by 1+s,
where s is the belt fractional slip). Default is 1.0 if field is blank (leave blank if no belt; i.e.,
direct drive). Can be autosized (assumes no slip).
Specified or autosized motor/fan pulley diameter ratio is reported in the .eio file as Drive Ratio
[-]. Autosized ratio is based on fan speed in revolutions per minute (rpm), calculated at design
flow condition, divided by Field: Motor Maximum Speed.
Field: Belt Maximum Torque
The required numeric maximum output torque capacity of the fan drive belt ( belt,max, Nm). If
specified, must be greater than zero. Can be autosized. Use autosize if no belt (i.e., direct
drive).
Specified or autosized belt maximum output torque (including effects of scaling by Field: Belt
Sizing Factor) is reported in the .eio file as Design Belt Output Torque [Nm]. Also, calculated
maximum belt efficiency corresponding to Design Fan Shaft Power, along with belt efficiency
at design flow condition (including part-load effects of oversized belt), are reported in the .eio
file as, respectively, Maximum Belt Efficiency [-] and Design Belt Efficiency [-].
Field: Belt Sizing Factor
The numeric dimensionless factor (Fbelt) used to multiply the specified or autosized fan shaft
maximum output torque (belt,max). If specified, minimum value is 1.0. Default is 1.0 if field is
blank.

9/29/14

1529

Input-Output Reference

Group Fans

Field: Belt Fractional Torque Transition

The numeric transition point (xbelt,trans) between performance curves for Regions 1 and 2 for
the drive belt normalized part-load efficiency. Must be between 0.0 and 1.0. Default is 0.167
(corresponds to generic V-belt) if field is blank.
Field: Motor Maximum Speed
The required numeric maximum rotational speed of the fan motor shaft (motor,max) in
revolutions per minute (rpm). Typical values for motors supplied by 60 Hz power are near
900, 1200, 1800, and 3600 rpm. Must be greater than zero.
Field: Maximum Motor Output Power
The required numeric maximum output power (input power to the fan drive belt) by the motor
(Hbelt,max, W). If specified, must be greater than zero. Can be autosized. In the case of direct
drive, Hbelt,max corresponds to the maximum fan shaft power (Hfan,max).
Specified or autosized maximum motor output power (including effects of scaling by Field:
Motor Sizing Factor) is reported in the .eio file as Design Motor Output Power [W]. Also,
calculated maximum motor efficiency corresponding to Design Motor Output Power, along
with motor efficiency at design flow condition (including part-load effects of oversized motor),
are reported in the .eio file as, respectively, Maximum Motor Efficiency [-] and Design Motor
Efficiency [-]. Note that maximum motor efficiency often occurs at less than full load.
Field: Motor Sizing Factor
The numeric dimensionless sizing factor (Fmotor) used to multiply the specified or autosized
fan motor output power (Hbelt,max). If specified, minimum value is 1.0. Default is 1.0.
Field: Motor In Airstream Fraction
The numeric fraction of the combined motor and belt heat that is added to the air stream. A
value of 0.0 means that the motor and belt are completely outside the air stream. A value of
1.0 means that all of the motor and belt heat loss will go into the air stream and act to cause
an air enthalpy rise. Must be between 0.0 and 1.0. Default is 1.0.
Field: VFD Efficiency Type
The alpha basis for calculating fan variable-frequency-drive (VFD) efficiency: Power, which
corresponds to a function of the fraction of full-load motor input power (Hmotor / Hmotor,max), or
Speed, which corresponds to a function of the fraction of full-load speed (motor / motor,max).
If this field is blank, then it is assumed that the VFD efficiency is 0.97. If no VFD is used, then
specify Power and also specify a VFD efficiency curve with a constant value of 1.0 (see
VFD Efficiency Curve Name field for details).
Field: Maximum VFD Output Power
The required numeric maximum output power (input power to the fan motor) by the variable
frequency drive (Hmotor,max, W). If specified, must be greater than zero. Can be autosized.
Specified or autosized maximum VFD output power (including effects of scaling by Field:
VFD Sizing Factor) and corresponding VFD input power are reported in the .eio file as,
respectively, Design VFD Output Power [W] and Rated Power [W]. Also, calculated VFD
efficiency corresponding to Design VFD Output Power (including part-load effects of
oversized VFD) along with corresponding combined system efficiency (fan, belt, motor, and
VFD efficiencies multiplied together) at design flow condition are reported in the .eio file as,
respectively, Design VFD Efficiency [-] and Design Combined Efficiency [-].
Field: VFD Sizing Factor
The numeric dimensionless factor (FVFD) used to multiply the specified or autosized motor
maximum input power (Hmotor,max). If specified, minimum value is 1.0. Default is 1.0 if field is
blank.
9/29/14

1530

Input-Output Reference

Group Fans

Field: Fan Pressure Rise Curve Name

The required alpha name of the fan total pressure rise performance curve (ref:
Curve:FanPressureRise in Performance Curves) that parameterizes the variation of fan total
pressure rise (Pfan,tot, Pa) as a function of volumetric flow through the fan (Qfan, m3/s) and
duct static pressure set point (Psm, Pa). The fan outlet velocity pressure is subtracted from the
output of this curve to determine fan static pressure rise, which is then used to calculate a
dimensionless Euler number at each time step. The Euler number is in turn used to
determine fan efficiency, speed, and torque (the Euler number is defined in the Euler Number
at Maximum Fan Static Efficiency field). This curve should be valid for the range of volumetric
flows, distribution system leakage, duct static pressures, and static pressures surrounding the
ducts anticipated for the simulation period.
Field: Duct Static Pressure Reset Curve Name
The required alpha name of the performance curve that parameterizes the variation of the
duct static pressure set point (Psm, Pa) as a function of volumetric flow through the fan (Qfan,
m3/s), which is used so that the resistance associated with VAV box damper operation is
reduced.
The output of this curve is used to calculate the duct static pressure set point at each time
step. This curve should be valid for the range of duct static pressure set points and volumetric
flows, anticipated for the simulation period.
For an ad hoc linear duct static pressure reset scheme, the relation (ref: Curve:Linear in
Performance Curves) between duct static pressure (Psm, Pa) and flow through the fan (Qfan,
m3/s) for Qfan,min Qfan Qfan,max is:

Psm

where C1

Psm,min

Psm,max

Psm,min *

Q fan Q fan,min
Q fan,max Q fan,min

Psm,min C2 * Q fan,min and C2

Psm,max

C1 C2 * Q fan

Psm,min

Q fan,max Q fan,min

For Qfan < Qfan,min, Psm = Psm,min; for Qfan > Qfan,max, Psm = Psm,max
The minimum and maximum fan airflows (Qfan,min and Qfan,max) correspond respectively to the
minimum and maximum duct static pressure set points (Psm,min and Psm,max).
If no duct static pressure reset scheme is used and the duct static pressure set point is
constant, then parameter C2 is set to zero and C1 represents the constant duct static
pressure set point.
Field: Normalized Fan Static Efficiency Curve Name Non-Stall Region
The required alpha name of the exponential-modified skew normal performance curve (ref:
Curve:ExponentialSkewNormal in Performance Curves) that parameterizes the normalized
fan static efficiency (fan (xfan) / fan,max) at each time step for the normal operating (non-stall)
region of the fan performance map as a function of xfan, which is defined as log-base-10 of Eu
at the fan flow and pressure rise operating point divided by Eu at maximum fan static
efficiency [log10(Eu / Eumax)]. In this region, xfan<=0.
The output of this curve is used to calculate the fan efficiency fan (xfan) at each time step by
modifying fan,max (see Maximum Fan Static Efficiency field). This curve should have a
maximum of 1.0 and should be valid for the range of volumetric flows and fan pressure rises
anticipated for the simulation period.

9/29/14

1531

Input-Output Reference

Group Fans

Field: Normalized Fan Static Efficiency Curve Name Stall Region

The required alpha name of the exponential-modified skew normal performance curve (ref:
Curve:ExponentialSkewNormal in Performance Curves) that parameterizes the normalized
fan static efficiency (fan (xfan) / fan,max) at each time step for the stall region of the fan
performance map as a function of xfan (see Normalized Fan Static Efficiency Curve Name
Non-Stall Region field). In this region, xfan>0.
The output of this curve is used to calculate the fan efficiency fan (xfan) at each time step by
modifying fan,max (see Maximum Fan Static Efficiency field). This curve should have a
maximum of 1.0 and should be valid for the range of volumetric flows and fan pressure rises
anticipated for the simulation period.
Field: Normalized Dimensionless Airflow Curve Name Non-Stall Region
The required alpha name of the sigmoid performance curve (ref: Curve:Sigmoid in
Performance Curves) that parameterizes the normalized dimensionless airflow through the
fan ( (xfan) / max) at each time step for the normal operating (non-stall) region of the fan
performance map as a function of xfan, which is defined as log-base-10 of Eu at the fan flow
and pressure rise operating point divided by Eu at maximum fan static efficiency [log10(Eu /
Eumax)]. In this region, xfan <=0.
The output of this curve is used to calculate the dimensionless airflow (xfan) at each time
step by modifying max (see Maximum Dimensionless Fan Airflow field). This curve should
have a maximum of 1.0 and should be valid for the range of volumetric flows and fan
pressure rises anticipated for the simulation period.
Field: Normalized Dimensionless Airflow Curve Name Stall Region
The required alpha name of the sigmoid performance curve (ref: Curve:Sigmoid in
Performance Curves) that parameterizes the normalized dimensionless airflow through the
fan ( (xfan) / max) at each time step for the stall region of the fan performance map as a
function of xfan (see Normalized Dimensionless Airflow Curve Name Non-Stall Region field).
In this region, xfan >0.
The output of this curve is used to calculate the dimensionless airflow (xfan) at each time
step by modifying max (see Maximum Dimensionless Fan Airflow field). This curve should
have a maximum of 1.0 and should be valid for the range of volumetric flows and fan
pressure rises anticipated for the simulation period.
Field: Maximum Belt Efficiency Curve Name
The alpha name of the quartic polynomial performance curve (ref: Curve:Quartic in
Performance Curves) that determines the maximum fan drive belt efficiency in logarithmic
space (belt,max,ln) as a function of xbelt,max. The curve is:
belt ,max,ln

2
C1 C2 xbelt ,max C3 xbelt
,max

3
C4 xbelt
,max

4
C5 xbelt
,max

where xbelt,max = ln(Fbelt*Hfan,max) with Hfan,max expressed in terms of hp.

Note that belt,max = exp(belt,max,ln).
The output of this curve must be greater than zero and less than or equal to 1.0. If belt,max is
known, it is represented by coefficient C1 (=ln(belt,max)). In this case, coefficients C2 through
C5 are set to zero. If this field is left blank (e.g., there is no belt), the model assumes that the
output of the modifier curve is 1.0 for the entire simulation (maximum belt efficiency = 1.0).
Field: Normalized Belt Efficiency Curve Name Region 1
The alpha name of the single rectangular hyperbola type 2 performance curve (ref:
Curve:RectangularHyperbola2 in Performance Curves) that determines the normalized (parload) fan drive belt efficiency (belt (xbelt) / belt,max) as a function of xbelt. Normalized belt
efficiency is represented by a segmented curve with three different regions. The curve for
Region 1 (0 <= xbelt < xbelt,trans) is:
9/29/14

1532

Input-Output Reference

Group Fans

belt (xbelt) / belt,max = (C1* xbelt) / (C2+xbelt) + C3* xbelt

where xbelt = belt / belt,max; belt is the belt output torque that corresponds to the calculated
power input to the fan shaft (Hfan, W) by the drive belt and the calculated fan shaft speed
(fan, rpm).
The output of this curve is used to calculate the belt efficiency belt (xbelt) in Region 1 at each
time step by modifying belt,max (see Maximum Belt Efficiency Curve Name field). The output
of this curve must be greater than zero and less than or equal to 1.0 and should be valid for
the range of volumetric flows and fan pressure rises anticipated for the simulation period.
If this field is left blank, the model assumes that the output of the modifier curve is 1.0 for the
entire simulation (i.e., constant belt efficiency at belt,max in Region 1).
Field: Normalized Belt Efficiency Curve Name Region 2
The alpha name of the exponential decay performance curve (ref: Curve:ExponentialDecay in
Performance Curves) that determines the normalized (part-load) fan drive belt efficiency (belt
(xbelt) / belt,max) as a function of xbelt. Normalized belt efficiency is represented by a segmented
curve with three different regions. The curve for Region 2 (xbelt,trans <= xbelt <= 1) is:
belt (xbelt) / belt,max = C1 + C2 * exp(C3*xbelt)
where xbelt = belt / belt,max; belt is the belt output torque that corresponds to the calculated
power input to the fan shaft (Hfan, W) by the drive belt and the calculated fan shaft speed
(fan, rpm).
The output of this curve is used to calculate the belt efficiency belt (xbelt) in Region 2 at each
time step by modifying belt,max (see Maximum Belt Efficiency Curve Name field). The output
of this curve must be greater than zero and less than or equal to 1.0 and should be valid for
the range of volumetric flows and fan pressure rises anticipated for the simulation period.
If this field is left blank, the model assumes that the output of the modifier curve is 1.0 for the
entire simulation (i.e., constant belt efficiency at belt,max in Region 2).
Field: Normalized Belt Efficiency Curve Name Region 3
The alpha name of the single rectangular hyperbola type 2 performance curve (ref:
Curve:RectangularHyperbola2 in Performance Curves) that determines the normalized (partload) fan drive belt efficiency (belt (xbelt) / belt,max) as a function of xbelt. Normalized belt
efficiency is represented by a segmented curve with three different regions. The curve for
Region 3 (xbelt > 1) is:
belt (xbelt) / belt,max = (C1* xbelt) / (C2+xbelt) + C3* xbelt
where xbelt = belt / belt,max; belt is the belt output torque that corresponds to the calculated
power input to the fan shaft (Hfan, W) by the drive belt and the calculated fan shaft speed
(fan, rpm).
The output of this curve is used to calculate the belt efficiency belt (xbelt) in Region 3 at each
time step by modifying belt,max (see Maximum Belt Efficiency Curve Name field). The output
of this curve must be greater than zero and less than or equal to 1.0 and should be valid for
the range of volumetric flows and fan pressure rises anticipated for the simulation period.
If this field is left blank, the model assumes that the output of the modifier curve is 1.0 for the
entire simulation (i.e., constant belt efficiency at belt,max in Region 3).
Field: Maximum Motor Efficiency Curve Name
The alpha name of the single rectangular hyperbola type 1 performance curve (ref: Curve:
RectangularHyperbola1 in Performance Curves) that determines the maximum fan motor
efficiency (motor,max) as a function of xmotor,max. The curve is:
motor,max = (C1 * xmotor,max) / (C2 + xmotor,max) + C3

9/29/14

1533

Input-Output Reference

Group Fans

where xmotor,max=ln(Fmotor * Hbelt,max) with Hbelt,max expressed in terms of hp. Hbelt,max is the
maximum output power from the motor to the belt, which corresponds to the calculated
maximum power input to the fan shaft (Hfan,max, W).
The output of this curve must be greater than zero and less than or equal to 1.0. If motor,max is
known, it is represented by coefficient C3. In this case, coefficients C1 and C2 are set to zero.
If this field is left blank, the model assumes that the output of the modifier curve is 1.0 for the
entire simulation (maximum motor efficiency = 1.0).
Field: Normalized Motor Efficiency Curve Name
The name of the HVAC system node to which the fan sends its outlet air.
The alpha name of the single rectangular hyperbola type 2 performance curve (ref:
Curve:RectangularHyperbola2 in Performance Curves) that determines the normalized (partload) fan motor efficiency (motor (xmotor) / motor,max) as a function of the motor load fraction
xmotor. The curve is:
motor (xmotor) / motor,max = (C1 * xmotor) / (C2 + xmotor) + (C3* xmotor)
where xmotor = Hbelt / Hbelt,max. Hbelt is the calculated output power from the motor to the belt
(W), which corresponds to the calculated power input to the fan shaft (Hfan, W).
The output of this curve is used to calculate the motor efficiency (motor (xmotor)) at each time
step by modifying motor,max (see Maximum Motor Efficiency Curve Name field). The output of
this curve must be greater than zero and less than or equal to 1.0 and should be valid for the
range of volumetric flows and fan pressure rises anticipated for the simulation period.
If this field is left blank, the model assumes that the output of the modifier curve is 1.0 for the
entire simulation (i.e., constant motor efficiency at motor,max).
Field: VFD Efficiency Curve Name
The alpha name of the single rectangular hyperbola type 2 performance curve (e.g.,
Curve:RectangularHyperbola2 in Performance Curves) that determines the VFD efficiency
(VFD (xVFD)) as a function of the fractional input power of the motor or fractional motor speed
(xVFD). An example of the curve is:
VFD (xVFD) = (C1 * xVFD) / (C2+xVFD) + C3 * xVFD
where xVFD = Hmotor / Hmotor,max or motor / motor,max
The output of this curve is used to calculate the VFD efficiency VFD (xVFD) at each time step.
The output of this curve must be greater than zero and less than or equal to 1.0 and should
be valid for the range of volumetric flows and fan pressure rises anticipated for the simulation
period.
If this field is left blank, the model assumes that the output of the modifier curve is 0.97 for the
entire simulation (i.e., constant VFD efficiency of 0.97).
Field: End-Use Subcategory
Allows you to specify a user-defined end-use subcategory, e.g., "Central System". A new
meter for reporting is created for each unique subcategory (ref: Output:Meter objects).
Subcategories are also reported in the ABUPS table. If this field is omitted or blank, the fan
will be assigned to the "General" end-use subcategory.
An example of use in an IDF:

9/29/14

1534

Input-Output Reference

Group Fans

Fan:ComponentModel,
Supply Fan 1,
! Fan Name
Main Heating Coil 1 Outlet Node, ! Inlet Node Name
VAV Sys 1 Outlet Node,
! Outlet Node Name
FanAvailSched,
! Fan Schedule
autosize,
! Maximum Flow Rate [m3/s]
autosize,
! Minimum Flow Rate [m3/s]
1.0,
! Fan Sizing Factor [-]
0.3048,
! Fan Wheel Diameter [m]
0.0873288576,
! Fan Outlet Area [m2]
0.514,
! Maximum Fan Static Efficiency [-]
9.76,
! Euler Number at Maximum Fan Static Efficiency [-]
0.160331811647483,
! Maximum Dimensionless Fan Airflow [-]
autosize,
! Motor/Fan Pulley Ratio [-]
autosize,
! Belt Maximum Torque [N m]
1.0,
! Belt Sizing Factor [-]
0.167,
! Belt Fractional Torque Transition [-]
1800,
! Motor Maximum Speed [rpm]
autosize,
! Maximum Motor Output Power [W]
1.0,
! Motor Sizing Factor [-]
1.0,
! Motor In Airstream Fraction [-]
Power,
! VFD Efficiency Type
autosize,
! Maximum VFD Output Power [W]
1.0,
! VFD Sizing Factor [-]
VSD Example,
! Fan Pressure Rise Curve Name
DiagnosticSPR,
! Duct Static Pressure Reset Curve Name
FanEff120CPLANormal,
! Fan Efficiency Curve Name Non-Stall
FanEff120CPLAStall,
! Fan Efficiency Curve Name - Stall
FanDimFlowNormal,
! Dimensionless Airflow Curve Name-Non-Stall
FanDimFlowStall,
! Dimensionless Airflow Curve Name-Stall
BeltMaxEffMedium,
! Maximum Belt Efficiency Curve Name
BeltPartLoadRegion1,
! Normalized Belt Efficiency Curve Name
BeltPartLoadRegion2,
! Normalized Belt Efficiency Curve Name
BeltPartLoadRegion3,
! Normalized Belt Efficiency Curve Name
MotorMaxEffAvg,
! Maximum Motor Efficiency Curve Name
MotorPartLoad,
! Normalized Motor Efficiency Curve Name
VFDPartLoad;
! VFD Efficiency Curve Name

Component Model Fan Outputs

HVAC,Average,Fan Electric Power[W]
HVAC,Average,Fan Rise in Air Temperature [deltaC]
HVAC,Sum,Fan Electric Energy [J]

Fan Electric Power [W]

This output field contains the average electricity consumption rate for the fan in Watts for the
timestep being reported.
Fan Rise in Air Temperature [deltaC]
This output field contains the average rise in air temperature across the fan (outlet air
temperature minus inlet air temperature) in degrees Celsius for the timestep being reported.
Fan Electric Energy [J]
This output field contains the electricity consumption of the fan in Joules for the timestep
being reported. This output is also added to a meter with Resource Type = Electricity, End
Use Key= Fans, Group Key= System (ref. Output:Meter objects).
Other Outputs
Several parameters input by the user or calculated during component sizing for the design
condition (maximum system airflow) are reported separately in the <filename>.eio file. These
parameters include fan airflow and pressure rise; fan shaft input, motor output, VFD output,
and VFD input (rated) power; pulley drive ratio; belt output torque; and fan, belt, motor, VFD,
and combined system efficiencies. They can be identified by lines in the .eio file beginning
9/29/14

1535

Input-Output Reference

Group -- Humidifiers

with Component Sizing Information, Fan:ComponentModel. The same values are also
reported under the ComponentSizingSummary heading in the <filename>Table.html file.

Group -- Humidifiers
Humidifier:Steam:Electric
The electric steam humidifier is a component that represents an electrically heated, self
contained steam humidifier. The component uses electrical energy to convert ordinary tap
water to steam which it then injects into the supply air stream by means of a blower fan. The
actual unit might be an electrode-type humidifier or a resistance-type humidifier.
The humidifier model includes local control of the humidifier unit to meet a humidity ratio
setpoint on its air outlet node. A set point manager is needed to put a setpoint on the exit
node but no other local controllers are needed. The humidifier will add moisture to meet the
humidity ratio setpoint.
Field: Name
A unique user assigned name for a particular humidifier unit. Any reference to this unit by
another object will use this name.
Field: Availability Schedule Name
The name of the schedule (ref: Schedule) that denotes whether the unit can run during a
given time period. A schedule value of 0 indicates that the unit is off for that time period. A
schedule value greater than 0 indicates that the unit can operate during the time period. If this
field is blank, the schedule has values of 1 for all time periods.
Field: Rated Capacity
The nominal full output water addition rate of the unit in m 3/sec of water at 5.05 C. This field is
autosizable.
Field: Rated Power
The nominal full output power consumption of the unit in watts, exclusive of the blower fan
power consumption and any standby power. This field can be autosized. When it is
autosized, its calculated from the rated capacity in kg/s and the enthalpy rise in J/kg of the
feed water from the a reference temperature of liquid water at 20C to a saturated steam at
100C.
Field: Rated Fan Power
The nominal full output power consumption of the blower fan in watts.
Field: Standby Power
The standby power consumption in watts. This amount of power will be consumed whenever
the unit is available (as defined by the availability schedule).
Field: Air Inlet Node Name
The name of the HVAC system node from which the unit draws inlet air.
Field: Air Outlet Node Name
The name of the HVAC system node to which the unit sends its outlet air.
Field: Water Storage Tank Name
This field is optional. If left blank or omitted, then the humidifier obtains its water directly from
the mains water. If the name of a Water Storage Tank is specified, then the humidifier will try
to obtain its water from that tank. If the tank cant provide all the water then the rest will be
drawn from the mains and the humidifier will still operate.
9/29/14

1536

Input-Output Reference

Group -- Humidifiers

An IDF example:
Humidifier:Steam:Electric,
Humidifier 1,
!- Name
FanAndCoilAvailSched, !- Availability Schedule Name
0.00000379,
!- Rated Capacity {m3/s}
10200.,
!- Rated Power {W}
27.,
!- Rated Fan Power {W}
2.,
!- Standby Power {W}
Cooling Coil Air Outlet Node, !- Air Inlet Node Name
Air Loop Outlet Node; !- Air Outlet Node Name

Steam Electric Humidfier Outputs

HVAC,Average,Humidifier Water Volume Flow Rate [m3/s]
HVAC,Sum,Humidifier Water Volume[m3]
HVAC,Average,Humidifier Electric Power[W]
HVAC,Sum,Humidifier Electric Energy [J]
Zone,Meter,Humidifier:Water [m3]
Zone,Meter,Humidifier:Electricity [J]
HVAC,Average,Humidifier Storage Tank Water Volume Flow Rate [m3/s]
HVAC,Sum,Humidifier Storage Tank Water Volume [m3]
HVAC,Average,Humidifier Starved Storage Tank Water Volume Flow Rate [m3/s]
HVAC,Sum,Humidifier Starved Storage Tank Water Volume [m3]
Zone,Meter,Humidifier:MainsWater [m3]
HVAC,Sum,Humidifier Mains Water Volume [m3]

Humidifier Water Volume Flow Rate [m3/s]

This field reports the water consumption rate of the steam humidifier in cubic meters of water
per second.
Humidifier Water Volume[m3]
This ouput is the cubic meters of water consumed by the steam humidifier over the timestep
being reported.
Humidifier Electric Power[W]
This output is the electricity consumption rate in Watts of the steam humidifier.
Humidifier Electric Energy [J]
This is the electricity consumption in Joules of the steam humidifier over the timestep being
reported.
Humidifier:Water [m3]
This meter output contains the sum of the water consumed (in cubic neters of water during
the report timestep) by all the steam humidifiers at the HVAC level in the simulation.
Humidifier:Electricity [J]
This meter output contains the sum of the electricity consumed (in Joules during the report
timestep) by all the steam humidifiers at the HVAC level in the simulation.
Humidifier Storage Tank Water Volume Flow Rate [m3/s]
Humidifier Storage Tank Water Volume [m3]
These outputs contain the rate and volume of water obtained from water storage tank. These
are only present if the humidifier is connected to a Water Storage Tank for its water supply.

9/29/14

1537

Input-Output Reference

Group Desiccant Dehumidifiers

Humidifier Starved Storage Tank Water Volume Flow Rate [m3/s]

Humidifier Starved Storage Tank Water Volume [m3]
These outputs contain the rate and volume of water that could not be obtained from the water
storage tank. The component will still operate as if it did get all the water with the balance
obtained directly from the mains
Humidifier Mains Water Volume [m3]
This output contains the volume of water obtained from the mains.

Group Desiccant Dehumidifiers

Dehumidifier:Desiccant:NoFans
This object models a solid desiccant dehumidifier (excluding associated fans). The process
air stream is the air which is dehumidified. The regen air stream is the air which is heated to
regenerate the desiccant. This object determines the process air outlet conditions, the load
on the regeneration heating coil, the electric power consumption for the wheel rotor motor,
and the regeneration air fan mass flow rate. All other heat exchangers are modeled as
separate objects connected to the inlet and outlet nodes of the dehumidifier. The solid
desiccant dehumidifier is typically used in an AirLoopHVAC:OutdoorAirSystem object, but
can also be specified in any AirLoopHVAC. The regeneration heating coil can be Gas,
Electric, Steam , or Hot Water coil. When hot water coil is selected as regeneration heating
coil user-defined curves designed for lower temperature operation must be specified in the
input field Performance Model Type along with the Nominal Regeneration Temperature input
field. The default performance model type is valid for higher nominal regeneration
temperature (e.g. 121C).
Field: Name
This alpha field contains the identifying name for the desiccant dehumidifier.
Field: Availability Schedule Name
The name of the schedule (ref: Schedule) that denotes whether the desiccant unit can run
during a given time period. A schedule value of 0 indicates that the unit is off for that time
period. A schedule value greater than 0 indicates that the unit can operate during the time
period. If this field is blank, the schedule has values of 1 for all time periods.
Field: Process Air Inlet Node Name
The name of the node entering the process side of the desiccant wheel.
Field: Process Air Outlet Node Name
The name of the node leaving the process side of the desiccant wheel.
Field: Regeneration Air inlet Node Name
The name of the node entering the regeneration side of the desiccant wheel after the
regeneration coil.
Field: Regeneration Fan Inlet Node Name
Node name for air entering the regeneration fan, mass flow is set by this desiccant
dehumidifier model.
Field: Control Type
Type of setpoint control. Options are
LeavingMaximumHumidityRatioSetpoint

9/29/14

1538

Input-Output Reference

Group Desiccant Dehumidifiers

SystemNodeMaximumHumidityRatioSetpoint
LeavingMaximumHumidityRatioSetpoint means that the unit is controlled to deliver air at
the Leaving Maximum Humidity Ratio Setpoint, using bypass dampers to prevent overdrying.
SystemNodeMaximumHumidityRatioSetpoint means that the unit is controlled to deliver
air at the maximum humidity ratio setpoint (System Node Humidity Ratio Max) on the Process
Air outlet node, using bypass dampers to prevent overdrying. This setpoint must be
established using a set point manager which sets the MaximumHumidityRatio control
variable:
SetpointManager:SingleZone:Humidity:Maximum
SetpointManager:MultiZone:MaximumHumidity:Average
SetpointManager:MultiZone:Humidity:Maximum
This will also require the use of a ZoneControl:Humidistat object. If the dehumidifer is
located in the outdoor air stream, it may also be necessary to use
SetpointManager:OutdoorAirPretreat.
Field: Leaving Maximum Humidity Ratio Setpoint
Fixed setpoint for maximum process air leaving humidity ratio. Applicable only when Control
Type = LeavingMaximumHumidityRatioSetpoint.
Field: Nominal Process Air Flow Rate
Process air flow rate in m 3/s at nominal conditions. This field is autosizable.
Field: Nominal Process Air Velocity
Process air velocity in m/s at nominal flow. The default value is 3m/s.
Field: Rotor Power
Power input to wheel rotor motor in W. If this field is unknown, electricity consumption of the
unit can be obtained from nominal power per unit air flow rate below.
Field: Regeneration Coil Object Type
Type of heating coil object for regeneration air. The hot water and steam heating coils require
specifying plant loop, branches, and connector objects to support the heating coils, and are
placed on the demand side of the plantloop. The hot water flow modulation through the
regeneration air heating coil does not require additional controller or Controller:WaterCoil
object. The parent object (Dehumidifier:Desiccant:NoFans) itself provides the "controller"
function of modulating water flow. The valid choices are:
Coil:Heating:Electric
Coil:Heating:Gas
Coil:Heating:Water
Coil:Heating:Steam

Field: Regeneration Coil Name

Name of heating coil object for regeneration air.
Field: Regeneration Fan Object Type
Type of fan object for regeneration air. For UserCurves performance (see below)
Fan:VariableVolume and Fan:ConstantVolume are valid. For Default performance (see
below) only Fan:VariableVolume is valid.
Field: Regeneration Fan Name
Name of fan object for regeneration air.

9/29/14

1539

Input-Output Reference

Group Desiccant Dehumidifiers

Field: Performance Model Type

Specifies whether the Default performance model or UserCurves curves should be used to
model the performance. The default model is a generic solid desiccant wheel using
performance curves of the form:
curve = C1 + C2*edb + C3*edb**2 + C4*ew + C5*ew**2 +
C6*vel + C7*vel**2 + C8*edb*ew + C9*edb**2*ew**2 +
C10*edb*vel + C11*edb**2*vel**2 + C12*ew*vel + C13*ew**2*vel**2 +
C14*ALOG(edb) + C15*ALOG(ew) + C16*ALOG(vel)
edb = process entering drybulb temperature [C]
ew = process entering humidity ratio [kgWater/kgDryAir]
vel = process air velocity [m/s]
The Default curves are valid for the following range of process inlet conditions: dry-bulb
temperatures of 1.67C (35F) to 48.9C (120F) and humidity ratios of 0.002857
kgWater/kgDryAir (20 gr/lb) to 0.02857 kgWater/kgDryAir (200 gr/lb). If the process inlet
conditions are outside this range, the dehumidifier will not operate.
If UserCurves are specified, then performance is calculated as follows:
Leaving Dry-bulb = (Leaving Dry-Bulb Function of Entering Dry-Bulb and Humidity Ratio
Curve) * (Leaving Dry-Bulb Function of Air Velocity Curve)
Leaving Humidity Ratio = (Leaving Humidity Ratio Function of Entering Dry-Bulb and
Humidity Ratio Curve) * (Leaving Humidity Ratio Function of Air Velocity Curve)
Regeneration Energy = (Regeneration Energy Function of Entering Dry-Bulb and Humidity
Ratio Curve) * (Regeneration Energy Function of Air Velocity Curve)
Regeneration Velocity = (Regeneration Velocity Function of Entering Dry-Bulb and Humidity
Ratio Curve) * (Regeneration Velocity Function of Air Velocity Curve)
The UserCurves are limited to the following range of process inlet conditions (essentially not
limited): dry-bulb temperatures of 73.3C (-100F) to 65.6C (150F) and humidity ratios of 0.0
kgWater/kgDryAir (0 gr/lb) to 0.21273 kgWater/kgDryAir (1490 gr/lb). If the process inlet
conditions are outside this range, the dehumidifier will not operate.
When the Default performance model is selected, the remaining fields are ignored.
Field: Leaving Dry-Bulb Function of Entering Dry-Bulb and Humidity Ratio Curve Name
This field is applicable only when UserCurves performance model type is specified.
Leaving dry-bulb of process air as a function of entering dry-bulb and entering humidity ratio,
biquadratic curve.
curve = C1 + C2*edb + C3*edb**2 + C4*ew + C5*ew**2 + C6*edb*ew
edb = process entering drybulb temperature [C]
ew = process entering humidity ratio [kgWater/kgDryAir]
Field: Leaving Dry-Bulb Function of Air Velocity Curve Name
This field is applicable only when UserCurves performance model type is specified.
Leaving dry-bulb of process air as a function of air velocity, quadratic curve.
curve = C1 + C2*v + C3*v**2
v = process air velocity [m/s]
Field: Leaving Humidity Ratio Function of Entering Dry-Bulb and Humidity Ratio Curve
Name
This field is applicable only when UserCurves performance model type is specified.

9/29/14

1540

Input-Output Reference

Group Desiccant Dehumidifiers

Leaving humidity ratio of process air as a function of entering dry-bulb and entering humidity
ratio, biquadratic curve
curve = C1 + C2*edb + C3*edb**2 + C4*ew + C5*ew**2 + C6*edb*ew
edb = process entering drybulb temperature [C]
ew = process entering humidity ratio [kgWater/kgDryAir]
Field: Leaving Humidity Ratio Function of Air Velocity Curve Name
This field is applicable only when UserCurves performance model type is specified.
Leaving humidity ratio of process air as a function of process air velocity, quadratic curve.
curve = C1 + C2*v + C3*v**2
v = process air velocity [m/s]
Field: Regeneration Energy Function of Entering Dry-Bulb and Humidity Ratio Curve Name
This field is applicable only when UserCurves performance model type is specified.
Regeneration energy [J/kg of water removed] as a function of entering dry-bulb and entering
humidity ratio, biquadratic curve
curve = C1 + C2*edb + C3*edb**2 + C4*ew + C5*ew**2 + C6*edb*ew
edb = process entering drybulb temperature [C]
ew = process entering humidity ratio [kgWater/kgDryAir]
Field: Regeneration Energy Function of Air Velocity Curve Name
This field is applicable only when UserCurves performance model type is specified.
Regeneration energy [J/kg of water removed] as a function of process air velocity, quadratic
curve.
curve = C1 + C2*v + C3*v**2
v = process air velocity [m/s]
Field: Regeneration Velocity Function of Entering Dry-Bulb and Humidity Ratio Curve
Name
This field is applicable only when UserCurves performance model type is specified.
Regeneration velocity [m/s] as a function of entering dry-bulb and entering humidity ratio,
biquadratic curve
curve = C1 + C2*edb + C3*edb**2 + C4*ew + C5*ew**2 + C6*edb*ew
edb = process entering drybulb temperature [C]
ew = process entering humidity ratio [kgWater/kgDryAir]
Field: Regeneration Velocity Function of Air Velocity Curve Name
This field is applicable only when UserCurves performance model type is specified.
Regeneration velocity [m/s] as a function of process air velocity, quadratic curve.
curve = C1 + C2*v + C3*v**2
v = process air velocity [m/s]
Field: Nominal Regeneration Temperature
This field is applicable only when UserCurves performance model type is specified.
Nominal regeneration temperature upon which the regeneration energy modifier curve is
based. This input is ignored when Performance Model Type = Default, which assume a
regeneration temperature of 121C.

9/29/14

1541

Input-Output Reference

Group Desiccant Dehumidifiers

Field: Nominal Power Per Unit Air Flow Rate

This field is nominal power consumption per unit air flow rate. It is used to calculate electricity
consumption of the unit when no rotor power is entered.
An example of this statement in an IDF is:
Dehumidifier:Desiccant:NoFans,
Desiccant 1,
!- Name
FanAndCoilAvailSched,
!- Availability Schedule Name
Outside Air Inlet Node, !- Process Air Inlet Node Name
Desiccant Process Outlet Node, !- Process Air Outlet Node Name
Regen Coil Out Node,
!- Regeneration Air Inlet Node Name
Outside Air Inlet Node 2,!- Regeneration Fan Inlet Node Name
SystemNodeMaximumHumidityRatioSetpoint, !- Control Type
0.007,
!- Leaving Maximum Humidity Ratio Setpoint {kgWater/kgDryAir}
1,
!- Nominal Process Air Flow Rate {m3/s}
2.5,
!- Nominal Process Air Velocity {m/s}
10,
!- Rotor Power {W}
Coil:Heating:Gas,
!- Regeneration Coil Object Type
Desiccant Regen Coil,
!- Regeneration Coil Name
Fan:VariableVolume,
!- Regeneration Fan Object Type
Desiccant Regen Fan,
!- Regeneration Fan Name
UserCurves,
!- Performance Model Type
Desiccant DryBulb fTW Curve, !- Leaving Dry-Bulb Function of Entering Dry-Bulb and Humidity Ratio
!
Curve Name
Desiccant DryBulb fV Curve, !- Leaving Dry-Bulb Function of Air Velocity Curve Name
Desiccant HumRat fTW Curve, !- Leaving Humidity Ratio Function of Entering Dry-Bulb and Humidity
Ratio Curve Name
Desiccant HumRat fV Curve,
!- Leaving Humidity Ratio Function of Air Velocity Curve Name
Desiccant RegenEnergy fTW Curve, !- Regeneration Energy Function of Entering Dry-Bulb and Humidity
Ratio Curve Name
Desiccant RegenEnergy fV Curve, !- Regeneration Energy Function of Air Velocity Curve Name
Desiccant RegenVel fTW Curve,
!- Regeneration Velocity Function of Entering Dry-Bulb and Humidity
Ratio Curve Name
Desiccant RegenVel fV Curve,
!- Regeneration Velocity Function of Air Velocity Curve Name
121,
!- Nominal Regeneration Temperature {C}
;
!- Nominal Power Per Unit Air Flow Rate {W/m3/s}

Desiccant Dehumidifier (NoFans) Outputs

HVAC,Sum,Dehumidifier Removed Water Mass [kg]
HVAC,Average,Dehumidifier Removed Water Mass Flow Rate [kg/s]
HVAC,Average,Dehumidifier Part Load Ratio []
HVAC,Average,Dehumidifier Electric Power [W]
HVAC,Sum,Dehumidifier Electric Energy [J]
HVAC,Average,Dehumidifier Regeneration Specific Energy [J/kgWater]
HVAC,Average,Dehumidifier Regeneration Rate [W]
HVAC,Sum,Dehumidifier Regeneration Energy [J]
HVAC,Average,Dehumidifier Regeneration Air Speed [m/s]
HVAC,Average,Dehumidifier Regeneration Air Mass Flow Rate [kg/s]
HVAC,Average,Dehumidifier Process Air Mass Flow Rate [kg/s]

Dehumidifier Removed Water Mass [kg]

Mass of water removed from process air stream.
Dehumidifier Removed Water Mass Flow Rate [kg/s]
Rate of water removal from process air stream.
Dehumidifier Part Load Ratio []
Dehumidifier water removal rate divided by full-load water removal rate.
Dehumidifier Electric Power [W]
Dehumidifier rotor electric power.
9/29/14

1542

Input-Output Reference

Group Desiccant Dehumidifiers

Dehumidifier Electric Energy [J]

Dehumidifier rotor electric energy.
Dehumidifier Regeneration Specific Energy [J/kgWater]
Regeneration heating coil energy divided by water removed.
Dehumidifier Regeneration Rate [W]
Regeneration heating coil output rate.
Dehumidifier Regeneration Energy [J]
Regeneration heating coil output energy.
Dehumidifier Regeneration Air Speed[m/s]
Regeneration air velocity.
Dehumidifier Regeneration Air Mass Flow Rate [kg/s]
Regeneration air mass flow rate.
Dehumidifier Process Air Mass Flow Rate [kg/s]
Process air mass flow rate.
Dehumidifier:Desiccant:System
The Dehumidifier:Desiccant:System object models the dehumidification of an air stream,
normally called the process air stream. A second heated air stream, called the regeneration
air stream, is used to remove the collected moisture from the desiccant heat exchanger and
this moisture-laden air is then usually exhausted from the building. This
Dehumidifier:Desiccant:System object is similar to the Dehumidifier:Desiccant:NoFans object
but has some additional modeling capabilities.
The Dehumidifier:Desiccant:System object in EnergyPlus is a compound object that can be
placed anywhere in an air loop (AirLoopHVAC). Common locations for this object are in an
AirLoopHVAC:OutdoorAirSystem or in the main air loop (AirLoopHVAC) downstream of a
cooling coil (postcooling desiccant dehumidifier). This compound object coordinates the
operation of several children objects: a desiccant heat exchanger, a regeneration air fan,
and an optional regeneration air heater. Gas, Electric, Steam, or Hot Water heating coils can
be used for regenerator air heaters. If this dehumidifier is placed in the main air loop
immediately downstream of a direct expansion (DX) cooling coil, then the dehumidifiers
operation can be coordinated with the operation of the companion DX coil and it is also
possible to specify that the DX systems condenser waste heat can be used to help
regenerate the desiccant heat exchanger. For the case of condenser waste heat
regeneration, an optional exhaust fan can also be modeled by this desiccant dehumidifier
compound object to help maintain a set point temperature for air entering the regeneration
side of the desiccant heat exchanger.
It is important to note that the optional exhaust air fan is modeled internal to the
Dehumidifier:Desiccant:System and a separate fan object should not be added to the input data file (idf) for
this fan. On the other hand, a separate fan object is required in the input data file for the regeneration air
fan.

9/29/14

1543

Input-Output Reference

Group Desiccant Dehumidifiers

Figure 141. Schematic of Dehumidifier:Desiccant:System with Draw Through Regeneration Fan

Placement

A schematic of the compound object Dehumidifier:Desiccant:System is shown in Figure 141

with the draw through regeneration air fan placement. Figure 142 shows the
Dehumidifier:Desiccant:System object configured with the blow through regeneration air fan
placement.

NOTE: As with any air loop compound object, the Dehumidifier:Desiccant:System object itself is specified
on the AirLoopHVAC Branch or in the AirLoopHVAC:OutdoorAirSystem:EquipmentList for an
AirLoopHVAC:OutdoorAirSystem. The children objects (e.g., desiccant heat exchanger, regeneration air
fan, and optional regeneration air heater) must be specified separately in the input data file and their
inlet/outlet connections must be as shown in Figure 141 or Figure 142.

9/29/14

1544

Input-Output Reference

Group Desiccant Dehumidifiers

Figure 142. Schematic of Dehumidifier:Desiccant:System with Blow Through Regeneration Fan

Placement
Currently the only heat exchanger choice for this object is HeatExchanger:Desiccant:
BalancedFlow. So to model a Dehumidifier:Desiccant:System located in an air loop, the input
data file should include the following objects:
Dehumidifier:Desiccant:System (in an air loop (AirLoopHVAC) Branch or
AirLoopHVAC:OutdoorAirSystem:EquipmentList for an AirLoopHVAC:OutdoorAirSystem)
HeatExchanger:Desiccant:BalancedFlow (desiccant heat exchanger child object)
HeatExchanger:Desiccant:BalancedFlow:PerformanceDataType1
exchanger data object)

(desiccant

heat

ZoneControl:Humidistat, and one of:

SetpointManager:SingleZone:Humidity:Maximum
SetpointManager:MultiZone:Humidity:Maximum
SetpointManager:MultiZone:MaximumHumidity:Average
(when in an air loop (AirLoopHVAC) Branch), and SetpointManager:OutdoorAirPretreat
(when in an AirLoopHVAC:OutdoorAirSystem) to place a maximum humidity ratio set
point on the sensor node, typically the process air outlet node
Fan:OnOff or Fan:ConstantVolume (regeneration air fan)
Coil:Heating:Electric or Coil:Heating:Gas (optional regeneration air heater)
Coil:Cooling:DX:SingleSpeed or
(optional companion cooling coil)

Coil:Cooling:DX:TwoStageWithHumidityControlMode

If
the
user
wants
to
model
the
Dehumidifier:Desiccant:System
in
an
AirLoopHVAC:OutdoorAirSystem, then the process air path of the dehumidifier should be
located in the outdoor air stream and the regeneration air path may be placed in the relief air
stream or modeled by the desiccant dehumidifier itself where the first node for the
regeneration inlet air stream must be an outdoor air node. If the user wants to model the
Dehumidifier:Desiccant:System in an air loop (AirLoopHVAC) Branch, then the process air
path of the dehumidifier should be located in the air loop Branch object. For this case, the
9/29/14

1545

Input-Output Reference

Group Desiccant Dehumidifiers

regeneration air stream is modeled by the desiccant dehumidifier object itself (i.e., not part of
an air loop Branch statement) and the first node for the regeneration inlet air stream must be
an outdoor air node (ref. Figure 141 or Figure 142).
A description of each input field for this object is provided below:
Field: Name
A unique, user-assigned name for a particular Dehumidifier:Desiccant:System. Any reference
to this dehumidifier by another object will use this name.
Field: Availability Schedule Name
The name of the schedule (ref: Schedule) that denotes whether the dehumidifier can operate
during a given time period. A schedule value greater than 0 (usually 1 is used) indicates that
the dehumidifier can operate. A value less than or equal to 0 (usually 0 is used) denotes that
the dehumidifier will not operate (i.e., no heat exchange will take place and the regeneration
air fan does not operate). If the field is blank, the schedule has a value of 1 for all time
periods. For the case where companion cooling coil regeneration air heating has been
specified, the desiccant dehumidifiers exhaust fan serves as the condenser air fan for the
cooling coil system so this availability schedule will not disable exhaust fan operation.
Field: Desiccant Heat Exchanger Object Type
This alpha field contains the type of desiccant heat exchanger used with this dehumidifier.
Currently, the only valid choice is HeatExchanger:Desiccant:BalancedFlow.
Field: Desiccant Heat Exchanger Name
This alpha field contains the name of the desiccant heat exchanger used with this
dehumidifier.
Field: Sensor Node Name
This alpha field specifies the name of the air loop node used to control desiccant heat
exchanger operation. A set point manager must be used to place a maximum humidity ratio
set point on this node (e.g., SetpointManager:SingleZone:Humidity:Maximum or
SetpointManager:OutdoorAirPretreat).
Field: Regeneration Air Fan Object Type
This alpha field contains the type of regeneration air fan used. Available fan types are
Fan:OnOff and Fan:ConstantVolume.
Field: Regeneration Air Fan Name
This alpha field contains the name of the regeneration air fan used with this dehumidifier.
Field: Regeneration Air Fan Placement
This alpha field specifies the fan configuration used in the desiccant dehumidifier. Valid
choices are BlowThrough and DrawThrough, with a default of DrawThrough if this field is
left blank.
Field: Regeneration Air Heater Object Type
This alpha field contains the type of heating coil used to heat the regeneration air stream.
This field may be left blank when no regeneration air heater is required. The hot water and
steam heating coils require specifying plant loop, branches, and connector objects to support
the heating coils, and are placed on the demand side of the plantloop. The hot water flow
modulation through the regeneration air heating coil does not require additional controller or
Controller:WaterCoil object. The parent object (Dehumidifier:Desiccant:System) itself
provides the "controller" function of modulating water flow. Valid choices are:
Coil:Heating:Electric
Coil:Heating:Gas
9/29/14

1546

Input-Output Reference

Group Desiccant Dehumidifiers

Coil:Heating:Water
Coil:Heating:Steam

Field: Regeneration Air Heater Name

This alpha field contains the name of the heating coil used to heat the regeneration air
stream. This field may be left blank when no regeneration air heater is required.
Field: Regeneration Inlet Air Setpoint Temperature
This optional numeric field specifies the regeneration air inlet temperature setpoint in Celsius.
The regeneration air heater and/or the companion coil regeneration air heating will be
controlled to this temperature to the extent possible. This field may be left blank when no
regeneration air heater is required or when control of the exhaust fan used with the
companion coil regeneration air heating option is not required.
Field: Companion Cooling Coil Object Type
This optional alpha field contains the type of companion cooling coil used with this desiccant
dehumidifier.
The
only
valid
choices
are
Coil:Cooling:DX:SingleSpeed
and
Coil:Cooling:DX:TwoStageWithHumidityControlMode.
Field: Companion Cooling Coil Name
This optional alpha field contains the name of the companion cooling coil used with this
desiccant dehumidifier. This field may be left blank when no companion cooling coil is being
modeled.
Field: Companion Cooling Coil Upstream of Dehumidifier Process Inlet
This choice field specifies if the companion cooling coil is located immediately upstream of
the dehumidifiers process inlet. Valid choices are Yes and No. If Yes is selected, then the
outlet air node for the companion cooling coil must be the same as the dehumidifiers process
air inlet node (i.e., the process air inlet node name for the desiccant heat exchanger specified
for this desiccant dehumidifier). For this case, the companion cooling coil and the desiccant
dehumidifier are assumed to operate in tandem; that is, if the simulation determines that the
companion cooling coil is unable to meet the humidity set point specified on the sensor node
based on its own operation, then the desiccant dehumidifier operates at the same time and
for the same duration as the cooling coil to provide improved dehumidification. If No is
selected, then the dehumidifier will control to the humidity set point specified on the sensor
node to the extent possible. The default value is No if this field is left blank.
Field: Companion Coil Regeneration Air Heating
This choice field determines if the companion cooling coils condenser waste heat is used to
heat the regeneration inlet air. Valid choices are Yes and No. The default value is No if this
field is left blank.
Field: Exhaust Fan Maximum Flow Rate
This optional numeric field contains the maximum fan volumetric flow rate for the exhaust fan
in cubic meters per second. As noted previously, this exhaust fan is modeled internally by the
Dehumidifier:Desiccant:System object and a separate fan object should NOT be specified in
the input data file for this fan. This field is used only when a companion cooling coil is
specified and the Companion Coil Regeneration Air Heating field is set to Yes. This field
must be used in conjunction with the Exhaust Fan Maximum Power and the Exhaust Fan
Power Curve Name input fields. The model assumes that the exhaust fan will operate as
needed to maintain the Regeneration Inlet Air Setpoint Temperature, up to the maximum
flow rate specified in this input field. If the desiccant dehumidifier is OFF for a simulation
timestep but its companion cooling coil is operating and is specified to provide regeneration
air heating, then the exhaust fan operates at this maximum air flow rate (i.e., this fan serves
as the condenser fan for the companion cooling coil system when regeneration air heating is
9/29/14

1547

Input-Output Reference

Group Desiccant Dehumidifiers

specified, so the inputs to the companion cooling coil object should not include the condenser
fan energy since the condenser fan energy is modeled by the Dehumidifier:Desiccant:System
object).
Field: Exhaust Fan Maximum Power
This optional numeric field contains the maximum power for the exhaust fan in Watts (i.e., at
the Exhaust Fan Maximum Flow Rate). This field is used only when a companion cooling coil
is used and the Companion Coil Regeneration Air Heating field is set to Yes. This field
must be used in conjunction with the Exhaust Fan Maximum Flow Rate and the Exhaust
Fan Power Curve Name input fields.
Field: Exhaust Fan Power Curve Name
This optional alpha field contains the name of the exhaust fan power modifier curve. This field
is used only when a companion cooling coil is used and the Companion Coil Regeneration
Air Heating field is set to Yes. This field must be used in conjunction with the Exhaust Fan
Maximum Flow Rate and the Exhaust Fan Maximum Power input fields. If this field is blank,
the exhaust fan operates (when required) at the maximum power specified in the field above.
The curve object type for this Exhaust Fan Power Curve Name must be Curve:Cubic or
Curve:Quadratic. The curve object (Curve:Cubic or Curve:Quadratic) defines the change in
exhaust fan power as a function of the ratio of the actual exhaust air flow rate divided by the
maximum flow rate.
Following is an example input for this object:
Dehumidifier:Desiccant:System,
Desiccant 1,
!- Name
FanAvailSched,
!- Availability Schedule Name
HeatExchanger:Desiccant:BalancedFlow, !- Desiccant Heat Exchanger Object Type
Desiccant Heat Exchanger 1, !- Desiccant Heat Exchanger Name
HX Process Outlet Node, !- Sensor Node Name
Fan:ConstantVolume,
!- Regeneration Air Fan Object Type
Desiccant Regen Fan,
!- Regeneration Air Fan Name
DrawThrough,
!- Regeneration Air Fan Placement
Coil:Heating:Gas,
!- Regeneration Air Heater Object Type
Desiccant Regen Coil,
!- Regeneration Air Heater Name
46.111111,
!- Regeneration Inlet Air Setpoint Temperature {C}
Coil:Cooling:DX:SingleSpeed, !- Companion Cooling Coil Object Type
Desiccant DXSystem Cooling Coil, !- Companion Cooling Coil Name
Yes,
!- Companion Cooling Coil Upstream of Dehumidifier Process Inlet
Yes,
!- Companion Coil Regeneration Air Heating
1.05,
!- Exhaust Fan Maximum Flow Rate {m3/s}
50,
!- Exhaust Fan Maximum Power {W}
EXHAUSTFANPLF;
!- Exhaust Fan Power Curve Name

Desiccant Dehumidifier Outputs

HVAC,Sum,Dehumidifier Removed Water Mass [kg]
HVAC,Average,Dehumidifier Removed Water Mass Flow Rate [kg/s]
HVAC,Average,Dehumidifier Part Load Ratio []
HVAC,Average,Dehumidifier Exhaust Fan Electric Power [W]
HVAC,Sum,Dehumidifier Exhaust Fan Electric Energy [J]

Dehumidifier Removed Water Mass [kg]

This output is the mass of water removed from the process air stream in kilograms for the
timestep being reported.
Dehumidifier Removed Water Mass Flow Rate [kg/s]
This output is the average rate of water removal from the process air stream in kilograms per
second for the timestep being reported.

9/29/14

1548

Input-Output Reference

Group Energy Management System (EMS)

Dehumidifier Part Load Ratio [ ]

This output is the fraction of time that the desiccant heat exchanger (and associated
regeneration air heater and fans, if appropriate) operate for the timestep being reported.
Dehumidifier Exhaust Fan Electric Power [W]
This output is the average electric consumption rate for the exhaust fan in Watts for the
timestep being reported.
Dehumidifier Exhaust Fan Electric Energy [J]
This output is the electric consumption for the exhaust fan in Joules for the timestep being
reported. This output is also added to a meter with Resource Type = Electricity, EndUseKey
= Cooling, GroupKey = System (ref. Output:Meter objects).

Group Energy Management System (EMS)

The Energy Management System (EMS) is one of the high-level control methods available in
EnergyPlus. An EMS is able to access a wide variety of sensor data and use this data to
direct various types of control actions. The concept is to emulate, inside EnergyPlus, the
types of controls possible with the digital energy management systems used in real buildings.
In the hierarchy of EnergyPlus controls, the EMS module is a high-level, generalized,
supervisory control for building systems. The EMS replicates the functionality of many of the
existing high-level control objects in EnergyPlus. Similar to the AvailabilityManager objects,
the EMS can turn on and off pumps and fans. Similar to the DemandManager objects, the
EMS can turn on and off lights and electric equipment, change the set points on zone
thermostats, and dispatch on-site generation. Similar to the SetpointManager objects, the
EMS can change the set points on system nodes. Similar to the PlantEquipmentOperation
objects, the EMS can turn on and off supply-side heating, cooling, and heat rejection
equipment,
i.e.,
boilers,
chillers,
cooling
towers,
etc.
Similar
to
the
ElectricLoadCenter:Distribution, the EMS can turn on and off on-site generation equipment.
A separate document called Application Guide for EMS contains much more information on
how to use the EMS. The EMS uses the EnergyPlus Runtime Language (Erl) for custom
programming of control routines.
EnergyManagementSystem:Sensor
The EnergyManagmentSystem:Sensor object is used to declare an Erl variable that is linked
to EnergyPlus output variables or meters. EMS sensors are used to get information from
elsewhere in the model for use in control calculations. The separate output files called
eplusout.rdd and eplusout.mdd provide a listing of the output variables and meters that can
be used as sensors.
Field: Name
This field contains a unique name for the sensor that becomes the name of a variable for use
in Erl programs. No spaces are allowed in the object name. This name will be a global
variable in Erl programs and cannot duplicate any other global scope Erl variable.
Field: Output:Variable or Output:Meter Index Key Name
The key reference for the specified output variable. For example, if System Node
Temperature is the output variable, the unique node name is the key. The Key Name field
should be omitted for weather variables and meters because they do not have a key.
Field: Output:Variable or Output:Meter Name
The name of the output variable or meter that is to be mapped to the Erl variable for the
sensor. The names that can be used in a specific model are included in the .RDD output file.

9/29/14

1549

Input-Output Reference

Group Energy Management System (EMS)

Examples of this object follow.

EnergyManagementSystem:Sensor,
T1, !Name
Perimeter_ZN_1 , ! Output:Variable or Output:Meter Index Key Name
Zone Mean Air Temperature ; ! Output:Variable or Output:Meter Name

EnergyManagementSystem:Sensor,
PMV5, !Name
Core_ZN , ! Output:Variable Index Key Name
Zone Thermal Comfort Fanger Model PMV ; ! Output:Variable Name
EnergyManagementSystem:Sensor,
T_VAV5FanIn, !Name
VAV_5_HeatC-VAV_5_FanNode , ! Output:Variable Index Key Name
System Node Temperature ; ! Output:Variable Name
EnergyManagementSystem:Sensor,
cooling_setpoint,
! Name
CLGSETP_SCH ,
! Output:Variable Index Key Name
Schedule Value ; ! Output:Variable Name

EnergyManagementSystem:Actuator
This object maps an Erl variable to a control actuator elsewhere in EnergyPlus. The EMS
then initiates control actions by changing the value of this variable inside an Erl program. The
Application Guide for EMS contains much more information on EMS actuators. The
eplusout.EDD file can contain a listing of the actuators available for a specific model.
Field: Name
The field contains a unique name for the actuator that becomes the name of a variable for
use in Erl programs. No spaces are allowed in the object name. This name will be a global
variable in Erl programs and cannot duplicate any other global scope Erl variable.
Field: Actuated Component Unique Name
This field defines a unique name for the specific entity that is to be controlled. The names for
each individual component are listed in the EDD output file when Verbose mode is used
see the input object Output:EnergyManagementSystem for more on the EDD file. These will
often be user-defined names of input objects or system nodes, but some actuators are
automatically setup by the program and will not be completely user-defined.
Field: Actuated Component Type
The field defines the type of the entity that is to be controlled by the actuator. The component
types available vary with the specifics of individual models. The types of components that can
be used as actuators in a specific model are listed in the EDD output file see the input
object Output:EnergyManagementSystem for more on the EDD file. Components can be
object types defined elsewhere in the IDD but there are other types of entities such as nodes
and system-level actuators that do not directly correspond to IDF objects.
Field: Actuated Component Control Type
This field defines the type of control to be done on the specific entity being controlled. The
control types available are listed in the EDD output. Specific components may have more
than one type of control available, such as flow rate or temperature, and this field is used to
distinguish between them.
Example input objects.
9/29/14

1550

Input-Output Reference

Group Energy Management System (EMS)

EnergyManagementSystem:Actuator,
VAV_5_NightCycleStatus,
! Name
VAV_5,
! Actuated Component Unique Name
AirLoopHVAC,
! Actuated Component Type
Availability Status;
! Actuated Component Control Type

EnergyManagementSystem:Actuator,
VAV_1_SAT_setpoint,
VAV_1 Supply Equipment Outlet Node ,
System Node Setpoint,
Temperature Setpoint;

!
!
!
!

EnergyManagementSystem:Actuator,
myCLGSETP_SCH_Override,
CLGSETP_SCH,
Schedule:Constant,
Schedule Value;

! Name
!- Actuated Component Unique Name
! Actuated Component Type
! Actuated Component Control Type

Name
Actuated Component Unique Name
Actuated Component Type
Actuated Component Control Type

EnergyManagementSystem:ProgramCallingManager
The EnergyManagementSystem:ProgramCallingManager object is used to specify when
individual Erl programs are run. This object manages two temporal aspects of running Erl
programs. The first is when they are run relative to the rest of EnergyPlus, and the second is
when they are run relative to each other. EMS applications can use multiple
EnergyManagementSystem:ProgramCallingManager objects. For example, one manager
may execute an initialization program once at the beginning of the run period while additional
managers call various sets of programs from different EMS Calling Points.
Control schemes can be organized using a multiple Erl programs and this object this
specifies the order in which they are executed. Program Name 1 is run first, Program Name 2
is run second, etc. The run order can be important if there are interactions or dependencies
between two or more programs. Within each program there may be calls to execute
subroutine programs but only calling managers are used to execute main-level programs.
Field: Name
This is a unique name for this particular program manager.
Field: EnergyPlus Model Calling Point
This field describes when the Erl programs managed under this object are called during an
EnergyPlus simulation. All of the programs listed are called at this same calling point. There
are 15 possible calling points summarized below. For more information see the section on
EMS Calling Points in the Application Guide for EMS.
BeginNewEnvironment. This calling point occurs near the beginning of each environment
period. Environment periods include sizing periods such as design days and run periods.
This calling point will not be useful for control actions but is useful for initialization of Erl
program variables and other one-time set up actions for EMS.
AfterNewEnvironmentWarmUpIsComplete. This calling point occurs at the beginning of
each environment period but after warm up days are complete. Warm up days are used
to condition the transient aspects of the model with the first day before proceeding. This
calling point will not be useful for control actions but is useful for re-initializing Erl
programs with fresh values after warm up is complete. Programs called from this point
might be used to reset counters or summed variables that would change during warmup.
BeginTimestepBeforePredictor. This calling point happens near the beginning of each
timestep but before predictor executes. Predictor refers to the step in EnergyPlus
modeling where the zones thermal loads are calculated. This calling point is useful for
9/29/14

1551

Input-Output Reference

Group Energy Management System (EMS)

controlling components that affect the thermal loads that the systems will be attempting to
meet. Programs called from this point might actuate the building envelope or internal
gains based on current weather and the results from the previous timestep.
AfterPredictorBeforeHVACManagers. This calling point happens each timestep just after
predictor executes but before the traditional supervisory control models for
SetpointManager and AvailabilityManager are called. This calling point is useful for a
variety of control actions. However, if there are conflicts, the EMS control actions may be
overwritten by the actions of any traditional SetpointManagers or AvailabilityManagers in
the model.
AfterPredictorAfterHVACManagers. This calling point happens each timestep after
predictor executes and after the SetpointManager and AvailabilityManager models are
called. This calling point is useful for a variety of control actions. However, if there are
conflicts, SetpointManager or AvailabilityManager actions may be overwritten by EMS
control actions.
InsideHVACSystemIterationLoop. This calling point happens each HVAC iteration. The
HVAC systems solvers iterate to convergence within each timestep and this calling point
is inside this iteration loop. This calling point is useful for a variety of control actions.
Being inside the interation loop, this calling point has the advantage that input data need
not necessarily be lagged from prior timestep results and can, in some cases, improve
the accuracy of controls. The disadvantage is that programs may run an excessive
number of times slowing down the execution of the program.
EndOfZoneTimestepBeforeZoneReporting. This calling point happens each zone
timestep just before the output reports are updated for zone-timestep variables and
meters. This calling point is useful for custom output variables with Zone frequency
because they will be in sync with the rest of the zone output variables.
EndOfZoneTimestepAfterZoneReporting. This calling point happens each zone timestep
just after the output reports are updated for zone-timestep variables and meters. This
calling point is the last one of a timestep and is useful for making control decisions for the
next zone timestep using the final meter values for the current zone timestep.
EndOfSystemTimestepBeforeHVACReporting. This calling point happens each system
timestep just before the output reports are updated for HVAC-timestep variables and
meters. This calling point is useful for custom output variables with HVAC frequency
because they will be in sync with the rest of the system output variables.
EndOfSystemTimestepAfterHVACReporting. This calling point happens each system
timestep just after the output reports are updated for HVAC-timestep variables and
meters. This calling point is useful for making control decisions for the next system
timestep using the final meter values for the current system timestep.
EndOfZoneSizing. This calling point happens once during each simulation and only if the
run is set to do zone sizing. The calling point occurs just after the native zone sizing
calculations are completed but before the sizing results are finalized. This calling point is
useful for taking the intermediate results of zone sizing calculations and modifying them
based on custom calculations.
EndOfSystemSizing. This calling pont happens once during each simulation and only if
the run is set to do system sizing. The calling point occurs just after the native air system
sizing calculations are completed but before the sizing results are finalized. This calling
point is useful for taking the intermediate results of zone and system sizing calculations
and modifying them based on custom calculations.
AfterComponentInputReadIn. This calling point occurs early in the simulation when
HVAC components input data has been processed but before any component-level
calculations for automatic sizing. This calling point occurs once for each of the types of
HVAC components that have EMS actuators for autosize overrides. This calling point is
not directly useful for control actions but is useful for overriding the results of sizing at the
component level.
9/29/14

1552

Input-Output Reference

Group Energy Management System (EMS)

UserDefinedComponentModel. This calling point occurs when user-defined HVAC and

plant component models are called to be simulated. This calling point is only used for the
programs that model custom components. This calling point differs from the others in
that when it is being used the calls to trigger include a reference to a specific
EnergyManagementSystem:ProgramCallingManager and only the one manger is
executed.
UnitarySystemSizing. This calling point occurs when Unitary systems begin their
calculations for determining the size values for autosized input fields. This calling point is
used for overriding the autosizing outcomes for unitary systems. Each unitary system in
the simulation will call this point one time. This calling point is used to override sizing in
the
following
input
objects:
AirLoopHVAC:UnitarySystem,
AirLoopHVAC:Unitary:Furnace:HeatOnly,
AirLoopHVAC:UnitaryHeatOnly,
AirLoopHVAC:UnitaryHeatCool,AirLoopHVAC:Unitary:Furnace:HeatCool,
AirLoopHVAC:UnitaryHeatPump:AirToAir,
and
AirLoopHVAC:UnitaryHeatPump:WaterToAir.
Field: Program Name 1
The name of the EnergyManagementSystem:Program object that will be the first to run for
the calling point.
Field: Program Name 2 .. N
The name of the EnergyManagementSystem:Program object that will be the second to run.
Additional programs can be listed. The object is automatically extensible to accommodate as
many programs as needed.
IDF examples:
EnergyManagementSystem:ProgramCallingManager,
Initialize EMS for Run , ! Name
BeginNewEnvironment ,
! EnergyPlus Model Calling Point
InitializeMyEMS;
! Program Name 1
EnergyManagementSystem:ProgramCallingManager,
EMS-based Setpoint Managers , ! Name
AfterPredictorAfterHVACManagers , ! EnergyPlus Model Calling Point
VAV_5_SchedSetpoint , !Program Name 2
VAV5MixedAirManagers,
VAV_1_SchedSetpoint,
VAV1MixedAirManagers,
VAV_3_SchedSetpoint,
VAV3MixedAirManagers,
VAV_2_SchedSetpoint,
VAV2MixedAirManagers,
CoolSys1_SchedSetpoint,
HeatSys1_SchedSetpoint,
SHWSys1_SchedSetpoint,
VAV_5_NightCycleMGR,
VAV_1_NightCycleMGR,
VAV_2_NightCycleMGR,
VAV_3_NightCycleMGR;

EnergyManagementSystem:Program
The EnergyManagementSystem:Program object is the central processor of the EMS and the
primary container
for
the
EnergyPlus
Runtime
Language,
or
Erl.
The
EnergyManagementSystem:Program objects are run in the order and point during an
EnergyPlus
simulation
that
is
specified
in
an
EnergyManagementSystem:ProgramCallingManager
object.
Multiple
EnergyManagementSystem:Program objects are allowed and may interact (or interfere) with
9/29/14

1553

Input-Output Reference

Group Energy Management System (EMS)

each other. The Application Guide for EMS provides a comprehensive overview of Erl
programming.
The object definition is very simple. There is a name followed by lines of Erl program code.
Field: Name
This field is the unique name of the Erl program. The name can be used to call the program
to run from another program or subroutine. No spaces are allowed in the name.
Field Set: Program lines 1 to N
Each remaining field contains a single line of code for the EnergyPlus Runtime Language, or
Erl. Erl is a little programming language with its own syntax. The commas separating fields
can be thought of as end of line characters. The Application Guide for EMS provides a the
details on Erl program code.
Example IDF input objects follow.
EnergyManagementSystem:Program,
RH_OpeningController ,
! Name
IF ZoneRH < 25,
SET MyOpenFactor = 0.0 ,
ELSEIF ZoneRH > 60,
SET MyOpenFactor = 1.0 ,
ELSE,
SET MyOpenFactor = (ZoneRH - 25) / (60 - 25),
ENDIF;
EnergyManagementSystem:Program,
AverageZoneTemps , ! Name
SET Zn1vol = 346.0225, ! zone air volume
SET Zn2vol = 205.2650, ! zone air volume
SET Zn3vol = 346.0225, ! zone air volume
SET Zn4vol = 205.2650, ! zone air volume
SET Zn5vol = 456.4551, ! zone air volume
SET SumNumerator = T1*Zn1vol + T2*Zn2vol + T3*Zn3vol + T4*Zn4vol + T5*Zn5vol,
SET SumDenominator = Zn1vol + Zn2vol + Zn3vol + Zn4vol + Zn5vol,
SET AverageBuildingTemp = SumNumerator / SumDenominator;
EnergyManagementSystem:Program,
VAV2MixedAirManagers , ! Name
SET VAV_2_CoolC_Setpoint = Seasonal_Reset_SAT_Sched - ( T_VAV2FanOut - T_VAV2FanIn),
SET VAV_2_HeatC_Setpoint = Seasonal_Reset_SAT_Sched - ( T_VAV2FanOut - T_VAV2FanIn),
SET VAV_2_OA_Setpoint = Seasonal_Reset_SAT_Sched - ( T_VAV2FanOut - T_VAV2FanIn);

EnergyManagementSystem:Subroutine
The EnergyManagementSystem:Subroutine object contains a block of code written in the
EnergyPlus Runtime Language that can be run from another Erl program. If the subroutine is
never called, it will never run by itself. Subroutines are useful for encapsulating code that is
called in multiple places. It is also helpful for organizing and structuring code. When the
subroutine finishes running, control is returned to the object that called it. See the Application
Guide for EMS for information on writing Erl programs.
Field: Name
The name uniquely identifying the subroutine. The name can be used to call the subroutine to
run from a program or another subroutine or even itself. No spaces are allowed in the name.
Field set: Lines 1 to N
Each remaining field contains a single line of code for the EnergyPlus Runtime Language, or
Erl. Erl is a little programming language with its own special syntax. The commas separating
fields can be thought of as end of line characters. The Application Guide for EMS contains
the details on the rules for Erl program code.
IDF examples:
9/29/14

1554

Input-Output Reference
EnergyManagementSystem:Subroutine,
Add4ToN,
SET N = N + 4;
EnergyManagementSystem:Subroutine,
manage_ext_lights,
IF inc_solar > 0,
SET ext_lights_pwr = Off,
ELSE,
SET ext_lights_pwr = On,
ENDIF;
EnergyManagementSystem:Subroutine,
manage_solar_collector,
IF Tout_F < 32,
SET pump_pwr = On,
EXIT,
ENDIF,
SET delta_T = Tcollector Ttank,
IF delta_T > 0,
SET pump_pwr = On,
ELSE,
SET pump_pwr = Off,
ENDIF;

Group Energy Management System (EMS)

!- Name
!- EnergyPlus Runtime Language
!- Name
!- EnergyPlus Runtime Language

!- Name
!- EnergyPlus Runtime Language

EnergyManagementSystem:GlobalVariable
The EnergyManagementSystem:GlobalVariable object declares one or more global variables
that can be accessed by all Erl programs in the EMS. Erl variables declared by the user as
sensor and actuators objects are already global variables. Global scope variables are needed
to move date in and out of subroutines because Erl does not support passing arguments
within such calls. Global scope variables are also needed to pass an Erl variable result to an
output variable. Each field in this object names a new global Erl variable.
Field: Erl Variable (1..N) Name
The name becomes the global Erl variable name that can be referenced in the EnergyPlus
Runtime Language. No spaces are allowed in the object name. The name must be unique
across all global scope variables including those declared as sensor and actuators and the
built-in variables.
IDF examples using this object follow:
EnergyManagementSystem:GlobalVariable,
global_var;

!- Name

EnergyManagementSystem:GlobalVariable, Temp_C;
EnergyManagementSystem:GlobalVariable, Temp_F;
EnergyManagementSystem:Subroutine,
CalcFahrenheit,
SET Temp_F = Temp_C * (9/5) + 32;
EnergyManagementSystem:Program,
DummyProgram,
SET Temp_C = Tout,
RUN CalcFahrenheit,
SET Tout_F = Temp_F,
IF Tout_F > 32,
RUN FreezeProtect,
ENDIF;

9/29/14

!- Name

!- Name

1555

Input-Output Reference

Group Energy Management System (EMS)

EnergyManagementSystem:OutputVariable
The EnergyManagementSystem:OutputVariable object creates a custom output variable
that is mapped to an EMS variable. These can be declared by an
EnergyManagementSystem:Sensor object, an EnergyManagementSystem:Actuator
object, or an EnergyManagementSystem:GlobalVariable object, or any local variable in an
Erl program. The custom output variable can then be reported to the output file using the
standard EnergyPlus output mechanisms such as with the Output:Variable object.
The EnergyManagementSystem:OutputVariable object is a primary way to obtain data from
an Erl program and is likely to be essential for developing and debugging programs. This
object also provides a powerful mechanism to create custom output variables. See the
Application Guide for EMS for more information.
Field: Name
This field contains the user-defined name for the new output variable. This is the name that
will appear in the RDD output file and can be referenced in other input for output such as an
Output:Variable object. By convention, the name is in title case for capitalization. Units are
provided in the Units field.
Field: EMS Variable Name
This field contains the EMS variable name that is to be mapped to the custom output
variable. This must be used elsewhere in Erl programs and cannot have spaces.
Field: Type of Data in Variable
This field describes the nature of the variable. There are two choices, Averaged or Summed.
Averaged variables are state variables such as temperature, power, or flow rate. Summed
variables are quantities such as energy that accumulate across time.
Field: Update Frequency
This field describes which timestep the variable is associated with. There are two choices,
ZoneTimestep or SystemTimestep. Variables that are related to the building or zone loads
are generally associated with the zone timestep. Variables that are related to HVAC system
operation are generally associated with the system timestep.
Field: EMS Program or Subroutine Name
If the EMS variables is a local scope variable, i.e., not declared as a global scope variable,
then this field identifies which program uses the variable. The field references the object
name of the Erl program or subroutine object. For global variables, this field should be
omitted.
Field: Units
This field should contain the units for the output variable in standard EnergyPlus units. It does
not need to be enclosed in square brackets.
Examples of this object follow.
EnergyManagementSystem:OutputVariable,
Weighted Average Building Zone Air Temperature, ! Name
AverageBuildingTemp, ! EMS Variable Name
Averaged, ! Type of Data in Variable
ZoneTimeStep , ! Update Frequency
,
! EMS Program or Subroutine Name
C;
EnergyManagementSystem:OutputVariable,
Main CW Coil Total Cooling Rate, !- Name
CWcoil1_tot_cool_Power, !- EMS Variable Name
Averaged,
!- Type of Data in Variable
9/29/14

1556

Input-Output Reference
SystemTimestep,
MainCWCoil1_ModelOuput,
W;

Group Energy Management System (EMS)

!- Update Frequency
!- EMS Program or Subroutine Name
!- Units

EnergyManagementSystem:MeteredOutputVariable,
The EnergyManagementSystem:MeteredOutputVariable object creates a custom output
variable that is mapped to an EMS variable and is also included in the metering system that
EnergyPlus has for aggregating results for different resources across the model. This object
is very similar to EnergyManagementSystem:OutputVariable with the main differences being
that only summed types of data in the Erl variable and the quantity is to be added to a
meter. This allows for custom output variables that also impact the results for the amount of
electricity or gas consumed.
Field: Name
This field contains the user-defined name for the new output variable. This is the name that
will appear in the RDD and MTD output files and can be referenced in other input for output
such as an Output:Variable object. Units are provided in the Units field.
Field: EMS Variable Name
This field contains the EMS variable name that is to be mapped to the custom output
variable. This must be used elsewhere in Erl programs and cannot have spaces.
Field: Update Frequency
This field describes which timestep the variable is associated with. There are two choices,
ZoneTimestep or SystemTimestep. Variables that are related to the building or zone loads
are generally associated with the zone timestep. Variables that are related to HVAC system
operation are generally associated with the system timestep.
Field: EMS Program or Subroutine Name
If the EMS variables is a local scope variable, i.e., not declared as a global scope variable,
then this field identifies which program uses the variable. The field references the object
name of the Erl program or subroutine object. For global variables, this field should be
omitted.
Field: Resource Type
This field is used to specify the type of resource that the output variable consumes or
produces. The choice here will determine which of the meters the output should be added to
when EnergyPlus aggregates results for overall consumption. The following keywords can
be used to choose the type of resource that should be metered:
Electricity, this selects the main meter for electricity consumption, in units of Joules [J],
NaturalGas, this selects the meter for natural gas consumption, in units of Joules [J],
Gasoline, this selects the meter for gasoline consumption, in units of Joules [J],
Diesel, this selects the meter for diesel consumption, in units of Joules [J],
Coal, this selects the meter for coal consumption, in units of Joules [J],
FuelOil#1, this selects the meter for #1 Fuel Oil consumption, in units of Joules [J],
FuelOil#2, this selects the meter for #2 Fuel Oil consumption, in units of Joules [J],
Propane, this selects the meter for propane consumption, in units of Joules [J],
WaterUse, this selects the meter for overall water consumption, in units of cubic meters
[m3],
OnSiteWaterProduced, this selects the meter for overall on-site water collection, in units
of cubic meters [m 3],

9/29/14

1557

Input-Output Reference

Group Energy Management System (EMS)

MainsWaterSupply, this selects the meter for water supplied by utility mains, in units of
cubic meters [m 3],
RainWaterCollected, this selects the meter for water collected from rain, in units of cubic
meters [m3],
WellWaterDrawn, this selects the meter for water drawn from a local well, in units of
cubic meters [m 3],
CondensateWaterCollected, this selects the meter for water collected from cooling coils
as condensate, in units of cubic meters [m 3],
EnergyTransfer, this selects the general meter for energy transfers, in units of Joules [J],
Steam, this selects the meter for steam energy consumption, in units of Joules [J],
DistrictCooling, this selects the meter for district chilled water energy consumption, in
units of Joules [J],
DistrictHeating, this selects the meter for district hot water energy consumption, in units
of Joules [J],
ElectricityProducedOnSite, this selects the meter for electricity produced on the site, in
units of Joules [J],
SolarWaterHeating, this selects the meter for hot water heating energy from solar
collectors, in units of Joules [J], and,
SolarAirHeating, this selects the meter for air heating energy from solar collectors in
units of Joules [J],.
Field: Group Type
This field is used to specify how the output variable fits into the categorization scheme used
by the metering system in EnergyPlus to identify what part of the model is involved. Metered
output variables are classified as being in one of the following general groups:
Building, this category includes all the meters associated with parts of the building that
are not related to HVAC or Plant. This includes internal and exterior services such as
lights, electric equipment, exterior lights, etc.
HVAC, this category includes all the meters associated with parts of the HVAC system
that are related to air and zone thermal conditioning and ventilation (but not hydronic
plant systems). This includes things like fans, air conditioners, furnaces etc.
Plant, this category includes all the meters associated with parts of the hydronic plant
system that are related to heating, cooling, service water heating, and heat rejection.
This includes things like boilers, chillers, water heaters, towers, etc.
Field: End-Use Category
This field is used to specify the end use category that should be assigned to the resource
associated with the output variable. EnergyPlus reporting includes the breakdown of how
resources are used across different end uses. Metered output variables must be classified
as being in one of the following end use categories:
Heating
Cooling
InteriorLights
ExteriorLights
InteriorEquipment
ExteriorEquipment
Fans
Pumps
HeatRejection
Humidifier
9/29/14

1558

Input-Output Reference

Group Energy Management System (EMS)

HeatRecovery
WaterSystems
Refrigeration
OnSiteGeneration
Field: End-Use Subcategory
This field is used to specify the end use subcategory that will be assigned to the output
variable. EnergyPlus reporting includes the breakdown of how resources are used across
different end uses with added breakdown for the different subcategories within a particular
end use. This user can define his or her own subcategories and enter them in this field. If
left blank, then no subcategory classification is made and the output is included in the general
subcategory for the end use category determined in the previous field.
Field: Units
This field should contain the units for the output variable in standard EnergyPlus units. It does
not need to be enclosed in square brackets.
Examples of this object follow.
EnergyManagementSystem:MeteredOutputVariable,
Zone 1 WinAC Electricity Consumption, !- Name
Zone1WinAC_ElectEnergy, !- EMS Variable Name
SystemTimestep,
!- Update Frequency
Zone1_WinAC_ModelOuput, !- EMS Program or Subroutine Name
Electricity,
!- Resource Type
HVAC,
!- Group Type
Cooling,
!- End-Use Category
Window Air Conditioners, !- End-Use Subcategory
J;
!- Units

EnergyManagementSystem:TrendVariable
The EnergyManagementSystem:TrendVariable object declares a global trend EMS variable
that can be accessed by all Erl programs in the EMS. Trend variables store the recent history
of the Erl variable they are associated with. The trend data are useful for examining the
progression of time series data. The user declares a new trend variable using this object and
associates it with another global Erl variable that will be logged. Trend data are pushed into a
stack so that the most recent data are always at the beginning of the stack. Once the stack is
full, the oldest data are lost from the trend log. Each value in the trend log is for a zone
timestep into the past. The first value in the trend is the one from the previous zone time step.
Field: Name
The object name becomes the global EMS trend variable name that can be referenced in the
EnergyPlus Runtime Language. No spaces are allowed in the name. Then name must be
unique across all global scope variables including those declared as sensor and actuators
and the built-in variables.
Field: EMS Variable Name
This field contains the EMS variable name that is to be mapped to the trend variable. This
must be a global EMS variable defined elsewhere and cannot have spaces.
Field: Number of Timesteps to be Logged
This field describes how much data are to be held in the trend variable. The trended data are
held in an array with one value for each data point going back in time. This field determines
how many elements are in that array. If there are six timesteps per hour and this field is set to
144, then the trend will contain data for the most recent 24 hours period.
Examples of this object follow.
9/29/14

1559

Input-Output Reference

Group Energy Management System (EMS)

EnergyManagementSystem:TrendVariable,
AvgTemptrendLog1,
!- Name
AverageBuildingTemp,
!- EMS Variable Name
300;
!- Number of Timesteps to be Logged
EnergyManagementSystem:TrendVariable,
PMVtrendLog1, ,
!- Name
PMV5,
!- EMS Variable Name
144;
!- Number of Timesteps to be Logged

EnergyManagementSystem:InternalVariable
The EMS also provides a method to obtain static data from elsewhere in the model. Whereas
EMS sensors are used for time-varying data, there are also data that describe certain design
parameters for the building which may be useful for EMS calculations. A method for
accessing internal data is provided as a time saver and means of better generalizing Erl
programs for wider applicability. Information needed for this input object is output by
EnergyPlus to the eplusout.edd file see the Output:EnergyManagementSystem input
object. The EDD file can list the internal data index keys and types that are available for use
with this object. The Application Guide for EMS discusse internal variables in more depth.
Field: Name
This field contains a unique name for the internal variable that becomes the name of a
variable for use in Erl programs. No spaces are allowed in the name. This name will be a
global variable in Erl programs and cannot duplicate any other global scope EMS variable.
Field: Internal Data Index Key Name
This field contains the unique identifier for the internal variable. This is usually a name
defined by the user elsewhere in an IDF input object. For example, for an internal variable for
the floor area of a zone, this would be the name of the zone.
Field: Internal Data Type
This field defines the type of internal data source that is to be mapped to the EMS variable.
The types of internal source data that can be used as internal variables are listed in the EIO
output file whan an input file has any EMS-related objects.
An example of this object follows.
EnergyManagementSystem:InternalVariable,
Zn1vol,
!- Name
Perimeter_ZN_1, !- Internal Data Index Key Name
Zone Air Volume; !- Internal Data Type

EnergyManagementSystem:CurveOrTableIndexVariable
The EMS provides a method for reusing curve and table input objects from elsewhere in the
model.
Input
objects,
such
as
Curve:Cubic,
Curve:Biquadratic,
or
Table:TwoIndependetVariables, are used by various component models to describe
performance
relationships
in
a
generic
way.
By
using
an
EnergyManagementSystem:CurveOrTableIndexVariable input object, these curves and
tables can be used in your own Erl programs. This object sets up an Erl variable that
contains an index that points to specific curve or table. This index variable is then used as
the first argument in a call to the built-in function called @CurveValue so that the correct
curve or table is evaluated.
Field: Name
This field contains a unique name for the index variable that becomes the name of a variable
for use in Erl programs. No spaces are allowed in the name. This name will be a global
variable in Erl programs and cannot duplicate any other global scope EMS variable. The
9/29/14

1560

Input-Output Reference

Group ExternalInterface

variable will be filled by the EMS system to have a value that points to the curve or table
object named in the following field.
Field: Curve or Table Object Name
This field contains the unique name of a Curve:* or Table:* object defined elsewhere in the
input file. The Erl variable in the previous field will be filled with the index for the curve or
table named here. The value of this index tracks the order that Curve: and Table: input
objects are listed in the input file.
An example IDF object is:
EnergyManagementSystem:CurveOrTableIndexVariable,
Curve_Quadratic_Ptr,
!- Name
HPACCOOLPLFFPLR_curve;
!- Curve or Table Object Name

EnergyManagementSystem:ConstructionIndexVariable
The EMS provides actuators for overriding the type of construction used by a surface. The
EnergyManagementSystem:ConstructionIndexVariable input object is used to setup an Erl
variable that contains an index that points to specific Construction. This index variable is
then used with a special actuator called Surface with the control type Construction State.
See the Application Guide for EMS for more information on how to use this index variable
and the associated actuator.
Field: Name
This field contains a unique name for the index variable that becomes the name of a variable
for use in Erl programs. No spaces are allowed in the name. This name will be a global
variable in Erl programs and cannot duplicate any other global scope EMS variable. The
variable will be filled by the EMS system to have a value that points to the Construction
object named in the following field.
Field: Construction Object Name
This field contains the unique name of a Construction object defined elsewhere in the input
file. The Erl variable in the previous field will be filled with the index for the Construction
named here. The value of this index tracks the order that Construction input objects are
listed in the input file.
An example IDF object is:
Construction,
TCwindow_25,
Clear3PPG,
AIR 3MM,
WO18RT25,
AIR 8MM,
SB60Clear3PPG;

!- Name
!- Outside Layer
!- Layer 2
!- Layer 3
!- Layer 4
!- Layer 5

EnergyManagementSystem:ConstructionIndexVariable,
TCwindow_25,
TCwindow_25;

Group ExternalInterface
The ExternalInterface allows coupling EnergyPlus to the Building Controls Virtual Test Bed
(BCVTB). It supports the import of Functional Mock-up Units (FMUs) for co-simulation as well
as the export of EnergyPlus as a FMU for co-simulation. BCVTB is a software environment
that allows expert users to couple different simulation programs for distributed simulation or
for a real-time simulation that is connected to a building control system. For example, the
BCVTB allows simulation of the building envelope and HVAC system in EnergyPlus and the
control logic in MATLAB/Simulink, while exchanging data between the two programs as they
9/29/14

1561

Input-Output Reference

Group ExternalInterface

simulate. The BCVTB can be downloaded from http://simulationresearch.lbl.gov/bcvtb. A

FMU is a component which implements the Functional Mock-up Interface (FMI) standard
(http://www.modelisar.com).
ExternalInterface
This object activates the external interface of EnergyPlus. If the object ExternalInterface is
present, then the external interface objects listed below will receive their values from the
BCVTB interface or from FMUs at each zone time step. If this object is not present, then the
values of these objects will be fixed at the value declared in the initial value field of the
corresponding object, and a warning will be written to the EnergyPlus error file.
Field: Name
The name of the external interface. The only valid entries are PtolemyServer,
FunctionalMockupUnitImport, and FunctionalMockupUnitExport.
An example IDF object is:
ExternalInterface,
PtolemyServer;

!- Object to activate the external interface

!- Name of external interface

Building Controls Virtual Test Bed (BCVTB)

The following objects are designed to couple EnergyPlus with the BCVTB.
ExternalInterface:Schedule
This input object is similar to Schedule:Compact. However, during the time stepping, its value
is set to the value received from the external interface. During the warm-up period and the
system sizing, its value is set to the value specified by the field initial value.
Field: Name
This field should contain a unique (within all DaySchedules) designation for this schedule. It
is referenced by WeekSchedules to define the appropriate schedule values.
Field: Schedule Type Limits Name
This field contains a reference to the Schedule Type Limits object. If found in a list of
Schedule Type Limits (see above), then the restrictions from the referenced object will be
used to validate the current field values.
Field: Initial Value
This field contains the schedule value that is used during the warm-up period and during the
system sizing.
! Cooling schedule. This schedule is set directly by the external interface.
! During warm-up and system-sizing, it is fixed at 24 degC.
ExternalInterface:Schedule,
TSetCoo,
!- Name
Temperature,
!- ScheduleType
24;
!- Initial value, used during warm-up
! Heating schedule. This schedule is set directly by the external interface.
! During warm-up and system-sizing, it is fixed at 20 degC.
ExternalInterface:Schedule,
TSetHea,
!- Name
Temperature,
!- ScheduleType
20;
!- Initial value, used during warm-up

ExternalInterface:Actuator
This object maps a value received from the external interface to an actuator of the Energy
Management System. The object is similar to EnergyManagementSystem:Actuator. However,
9/29/14

1562

Input-Output Reference

Group ExternalInterface

during the time stepping, its value is set to the value received from the external interface.
During the warm-up period and the system sizing, its value is set to the value specified by the
field initial value.
Field: Name
This field contains a unique name for the actuator. No spaces are allowed in the object name.
This name will be a global read-only variable in Erl programs and cannot duplicate any other
global scope Erl variable.
Field: Actuated Component Unique Name
This field defines a unique name for the specific entity that is to be controlled. The names for
each individual component are listed in the EDD output file when Verbose mode is used
see the input object Output:EnergyManagementSystem for more on the EDD file. These
will often be user-defined names of input objects or system nodes, but some actuators are
automatically setup by the program and will not be completely user-defined.
Field: Actuated Component Type
The field defines the type of the entity that is to be controlled by the actuator. The component
types available vary with the specifics of individual models. The types of components that can
be used as actuators in a specific model are listed in the EDD output file see the input
object Output:EnergyManagementSystem for more on the EDD file. Components can be
object types defined elsewhere in the IDD but there are other types of entities such as nodes
and system-level actuators that do not directly correspond to IDF objects.
Field: Actuated Component Control Type
This field defines the type of control to be done on the specific entity being controlled. The
control types available are listed in the EDD output. Specific components may have more
than one type of control available, such as flow rate or temperature, and this field is used to
distinguish between them.
Field: Initial Value
This field contains the initial value. If a value is specified, then this value is used during the
warm-up period and the system sizing. If no value is specified, then the actuated component
will only be updated once the time stepping starts, i.e., after the warm-up and the systemsizing. This allows, for example, to schedule a setpoint with a Schedule:Compact during
warm-up and system-sizing, and then overwrite the value of this schedule during each zone
time step based on a feedback control loop that is implemented in the BCVTB.
ExternalInterface:Actuator,
Zn001_Wall001_Win001_Shading_Deploy_Status, !- Name
Zn001:Wall001:Win001,
!- Actuated Component Unique Name
Window Shading Control, !- Actuated Component Type
Control Status,
!- Actuated Component Control Type
;
! initial value

ExternalInterface:Variable
This input object is similar to EnergyManagementSystem:GlobalVariable. However, during
the time stepping, its value is set to the value received from the external interface. During the
warm-up period and the system sizing, its value is set to the value specified by the field initial
value. This object can be used to move data into Erl subroutines.
Field: Name
This field becomes the global Erl variable name that can be referenced in the EnergyPlus
Runtime Language. No spaces are allowed in the object name. The name must be unique
across all global scope variables including those declared as sensor and actuators and the
built-in variables.
9/29/14

1563

Input-Output Reference

Group ExternalInterface

Field: Initial Value

This field contains the initial value that is used during the warm-up period and during the
system sizing.
ExternalInterface:Variable,
yShade,
1;

!- Name of Erl variable

!- Initial value

Functional Mock-up Unit (FMU) Import

The following objects are designed to couple EnergyPlus with FMUs for co-simulation.
ExternalInterface:FunctionalMockupUnitImport
This object defines the FMU that will be linked to EnergyPlus.
Field: FMU File Name
This field contains the name of the FMU file including the extension. The field should include
a full path with file name, for best results. The field must be <= 100 characters. The file name
must not include commas or an exclamation point. A relative path or a simple file name
should work with version 7.0 or later when using EP-Launch even though EP-Launch uses
temporary directories as part of the execution of EnergyPlus. If using RunEPlus.bat to run
EnergyPlus from the command line, a relative path or a simple file name may work if
RunEPlus.bat is run from the folder that contains EnergyPlus.exe.
Field: FMU Timeout
This field contains the communication timeout value in milli-seconds to allow interprocess
communication to take place.
Field: FMU LoggingOn
This field contains the loggingOn value to enable or disable debug in FMU. If loggingOn=1,
debug logging is enabled. If loggingOn=0, debug logging is disabled.
ExternalInterface:FunctionalMockupUnitImport,
MoistAir.fmu,
!- FMU File Name
15,
!- FMU Timeout
0;
!- FMU LoggingOn

ExternalInterface:FunctionalMockupUnitImport:From:Variable
This input object maps the names of the output variables of EnergyPlus to the input variables
of the FMU.
Field: EnergyPlus Key Value
This input object maps the names of the EnergyPlus output variables (Output:Variable or
EnergyManagementSystem:OutputVariable) to the input variables of the FMU.
Field: EnergyPlus Variable Name
This field contains the output variable name as defined in the InputOutput Reference. For an
EnergyManagementSystem:OutputVariable, the EnergyPlus Variable Name is the name of
the EnergyManagementSystem:OutputVariables object.
Field: FMU File Name
This field contains the name of the FMU file including the extension. The field should include
a full path with file name, for best results. The field must be <= 100 characters. The file name
must not include commas or an exclamation point. A relative path or a simple file name
should work with version 7.0 or later when using EP-Launch even though EP-Launch uses
temporary directories as part of the execution of EnergyPlus. If using RunEPlus.bat to run

9/29/14

1564

Input-Output Reference

Group ExternalInterface

EnergyPlus from the command line, a relative path or a simple file name may work if
RunEPlus.bat is run from the folder that contains EnergyPlus.exe.
Field: FMU Instance Name
This field contains the EnergyPlus instance name of the FMU. See External Interface
Application guide for more details.
Field: FMU Variable Name
This field contains the name of the variable in the FMU that will be mapped to the
corresponding variable in EnergyPlus.
ExternalInterface:FunctionalMockupUnitImport:From:Variable,
Environment,
!- EnergyPlus Key Value
Site Outdoor Air Drybulb Temperature,
!- EnergyPlus Variable Name
MoistAir.fmu,
!- FMU File Name
Model1,
!- FMU Instance Name
TDryBul;
!- FMU Variable Name
ExternalInterface:FunctionalMockupUnitImport:From:Variable,
ZONE ONE,
!- EnergyPlus Key Value
Zone Mean Air Temperature, !- EnergyPlus Variable Name
MoistAir.fmu,
!- FMU File Name
Model1,
!- FMU Instance Name
TRooMea;
!- FMU Variable Name
ExternalInterface:FunctionalMockupUnitImport:From:Variable,
Environment,
!- EnergyPlus Key Value
Site Outdoor Air Relative Humidity, !- EnergyPlus Variable Name
MoistAir.fmu,
!- FMU File Name
Model1,
!- FMU Instance Name
outRelHum;
!- FMU Variable Name
ExternalInterface:FunctionalMockupUnitImport:From:Variable,
ZONE ONE,
!- EnergyPlus Key Value
Zone Air Relative Humidity, !- EnergyPlus Variable Name
MoistAir.fmu,
!- FMU File Name
Model1,
!- FMU Instance Name
rooRelHum;
!- FMU Variable Name

ExternalInterface:FunctionalMockupUnitImport:To:Schedule
This input object is similar to Schedule:Compact. However, during the time stepping, its value
is set to the value received from the external interface. During the system sizing, its value is
set to the value specified by the field initial value.
Field: EnergyPlus Variable Name
This field contains a unique (within all Schedules) designation for this schedule in
EnergyPlus.
Field: Schedule Type Limits Name
This field contains a reference to the Schedule Type Limits object. If found in a list of
Schedule Type Limits (see above), then the restrictions from the referenced object will be
used to validate the current field values.
Field: FMU File Name
This field contains the name of the FMU file including the extension. The field should include
a full path with file name, for best results. The field must be <= 100 characters. The file name
must not include commas or an exclamation point. A relative path or a simple file name
should work with version 7.0 or later when using EP-Launch even though EP-Launch uses
temporary directories as part of the execution of EnergyPlus. If using RunEPlus.bat to run
9/29/14

1565

Input-Output Reference

Group ExternalInterface

EnergyPlus from the command line, a relative path or a simple file name may work if
RunEPlus.bat is run from the folder that contains EnergyPlus.exe.
Field: FMU Instance Name
This field contains the EnergyPlus instance name of the FMU. See External Interface
Application guide for more details.
Field: FMU Variable Name
This field contains the name of the variable in the FMU that will be mapped to the schedule in
EnergyPlus.
Field: Initial Value
This field contains the schedule value that is used during the system sizing.
ExternalInterface:FunctionalMockupUnitImport:To:Schedule,
FMU_OthEquSen_ZoneOne,
!- EnergyPlus Variable Name
Any Number,
!- Schedule Type Limits Names
MoistAir.fmu,
!- FMU File Name
Model1,
!- FMU Instance Name
QSensible,
!- FMU Variable Name
0;
!- Initial Value
ExternalInterface:FunctionalMockupUnitImport:To:Schedule,
FMU_OthEquLat_ZoneOne,
!- EnergyPlus Variable Name
Any Number,
!- Schedule Type Limits Names
MoistAir.fmu,
!- FMU File Name
Model1,
!- FMU Instance Name
QLatent,
!- FMU Variable Name
0;
!- Initial Value

ExternalInterface:FunctionalMockupUnitImport:To:Actuator
This object maps a value received from the external interface to an actuator of the Energy
Management System. The object is similar to EnergyManagementSystem:Actuator. However,
during the warm-up and time stepping, its value is set to the value received from the external
interface. During the system sizing, its value is set to the value specified by the field initial
value.
Field: EnergyPlus Variable Name
This field contains a unique name for the actuator. No spaces are allowed in the object name.
This name will be a global read-only variable in Erl programs and cannot duplicate any other
global scope Erl variable.
Field: Actuated Component Unique Name
This field defines a unique name for the specific entity that is to be controlled. The names for
each individual component are listed in the EDD output file when Verbose mode is used
see the input object Output:EnergyManagementSystem for more on the EDD file. These
will often be user-defined names of input objects or system nodes, but some actuators are
automatically setup by the program and will not be completely user-defined.
Field: Actuated Component Type
The field defines the type of the entity that is to be controlled by the actuator. The component
types available vary with the specifics of individual models. The types of components that can
be used as actuators in a specific model are listed in the EDD output file see the input
object Output:EnergyManagementSystem for more on the EDD file. Components can be
object types defined elsewhere in the IDD but there are other types of entities such as nodes
and system-level actuators that do not directly correspond to IDF objects.

9/29/14

1566

Input-Output Reference

Group ExternalInterface

Field: Actuated Component Control Type

This field defines the type of control to be done on the specific entity being controlled. The
control types available are listed in the EDD output. Specific components may have more
than one type of control available, such as flow rate or temperature, and this field is used to
distinguish between them.
Field: FMU File Name
This field contains the name of the FMU file including the extension. The field should include
a full path with file name, for best results. The field must be <= 100 characters. The file name
must not include commas or an exclamation point. A relative path or a simple file name
should work with version 7.0 or later when using EP-Launch even though EP-Launch uses
temporary directories as part of the execution of EnergyPlus. If using RunEPlus.bat to run
EnergyPlus from the command line, a relative path or a simple file name may work if
RunEPlus.bat is run from the folder that contains EnergyPlus.exe.
Field: FMU Instance Name
This field contains the EnergyPlus instance name of the FMU. See External Interface
Application guide for more details.
Field: FMU Variable Name
This field contains the name of the variable in the FMU that will be mapped to the actuator in
EnergyPlus.
Field: Initial Value
This field contains the value that is used during the system sizing.
ExternalInterface:FunctionalMockupUnitImport:To:Actuator,
Zn001_Wall001_Win001_Shading_Deploy_Status, !- EnergyPlus Variable Name
Zn001:Wall001:Win001,
!- Actuated Component Unique Name
Window Shading Control,
!- Actuated Component Type
Control Status,
!- Actuated Component Control Type
ShadingController.fmu,
!- FMU File Name
Model1,
!- FMU Instance Name
yShade,
!- FMU Variable Name
6;
!- Initial Value

ExternalInterface:FunctionalMockupUnitImport:To:Variable
This input object is similar to EnergyManagementSystem:GlobalVariable. However, during
the warm-up and time stepping, its value is set to the value received from the external
interface. During the system sizing its value is set to the value specified by the field initial
value. This object can be used to move data into Erl subroutines.
Field: EnergyPlus Variable Name
This field becomes the global Erl variable name that can be referenced in the EnergyPlus
Runtime Language. No spaces are allowed in the object name. The name must be unique
across all global scope variables including those declared as sensor and actuators and the
built-in variables.
Field: FMU File Name
This field contains the name of the FMU file including the extension. The field should include
a full path with file name, for best results. The field must be <= 100 characters. The file name
must not include commas or an exclamation point. A relative path or a simple file name
should work with version 7.0 or later when using EP-Launch even though EP-Launch uses
temporary directories as part of the execution of EnergyPlus. If using RunEPlus.bat to run
EnergyPlus from the command line, a relative path or a simple file name may work if
RunEPlus.bat is run from the folder that contains EnergyPlus.exe.
9/29/14

1567

Input-Output Reference

Group ExternalInterface

Field: FMU Instance Name

This field contains the EnergyPlus instance name of the FMU. See External Interface
Application guide for more details.
Field: FMU Variable Name
This field contains the name of the variable in the FMU that will be mapped to the
corresponding variable in EnergyPlus.
Field: Initial Value
This field contains the initial value that is used during the system sizing.
ExternalInterface:FunctionalMockupUnitImport:To:Variable,
Shade_Signal,
!- EnergyPlus Variable Name
ShadingController.fmu,
!- FMU File Name
Model1,
!- FMU Instance Name
yShade,
!- FMU Variable Name
1;
!- Initial Value

Functional Mock-up Unit (FMU) Export

The following objects are designed to support the export of EnergyPlus as a FMU for cosimulation.
ExternalInterface:FunctionalMockupUnitExport:From:Variable
This object exposes the EnergyPlus output variables (Output:Variable
EnergyManagementSystem:OutputVariable) to the outside simulation program.

or

Field: EnergyPlus Key Value

This field contains a Key Value for an EnergyPlus output variable (ref Output:Variable/.rdd
file). For an EnergyManagementSystem:OutputVariable, the EnergyPlus Key Value needs
to be set to EMS.
Field: EnergyPlus Variable Name
This field contains the Variable Name as defined in the InputOutput Reference. For an
EnergyManagementSystem:OutputVariable, the EnergyPlus Variable Name is the name of
the EnergyManagementSystem:OutputVariables object.
Field: FMU Variable Name
This field contains the name of the variable in the model description file of the FMU that will
be mapped to the corresponding variable in EnergyPlus.
ExternalInterface:FunctionalMockupUnitExport:From:Variable,
Environment,
!- EnergyPlus Key Value
Site Outdoor Air Drybulb Temperature, !- EnergyPlus Variable Name
TDryBul;
!- FMU Variable Name
ExternalInterface: FunctionalMockupUnitExport:From:Variable,
ZONE ONE,
!- EnergyPlus Key Value
Zone Mean Air Temperature, !- EnergyPlus Variable Name
TRooMea;
!- FMU Variable Name
ExternalInterface: FunctionalMockupUnitExport:From:Variable,
Environment,
!- EnergyPlus Key Value
Site Outdoor Air Relative Humidity, !- EnergyPlus Variable Name
outRelHum;
!- FMU Variable Name
ExternalInterface:FunctionalMockupUnitExport:From:Variable,
ZONE ONE,
!- EnergyPlus Key Value
Zone Air Relative Humidity, !- EnergyPlus Variable Name
9/29/14

1568

Input-Output Reference
rooRelHum;

Group ExternalInterface
!- FMU Variable Name

ExternalInterface:FunctionalMockupUnitExport:To:Schedule
This object is similar to Schedule:Compact. However, during the time stepping, its value is
set to the value received from the external interface. During the warm-up period and the
system sizing, its value is set to the value specified by the field initial value.
Field: EnergyPlus Variable Name
This field contains a unique (within all Schedules) designation for this schedule in
EnergyPlus.
Field: Schedule Type Limits Name
This field contains a reference to the Schedule Type Limits object. If found in a list of
Schedule Type Limits (see above), then the restrictions from the referenced object will be
used to validate the current field values.
Field: FMU Variable Name
This field contains the name of the variable in the model description file of the FMU that will
be mapped to the schedule in EnergyPlus.
Field: Initial Value
This field contains the schedule value that is used during the warm-up period and during the
system sizing.
ExternalInterface:FunctionalMockupUnitExport:To:Schedule,
FMU_OthEquSen_ZoneOne,
!- EnergyPlus Variable Name
Any Number,
!- Schedule Type Limits Names
QSensible,
!- FMU Variable Name
0;
!- Initial Value

ExternalInterface:FunctionalMockupUnitExport:To:Actuator
This object maps a value received from the external interface to an actuator of the Energy
Management System. The object is similar to EnergyManagementSystem:Actuator. However,
during the time stepping, its value is set to the value received from the external interface.
During the warm-up period and the system sizing, its value is set to the value specified by the
field initial value.
Field: EnergyPlus Variable Name
This field contains a unique name for the actuator. No spaces are allowed in the object name.
This name will be a global read-only variable in Erl programs and cannot duplicate any other
global scope Erl variable.
Field: Actuated Component Unique Name
This field defines a unique name for the specific entity that is to be controlled. The names for
each individual component are listed in the EDD output file when Verbose mode is used
see the input object Output:EnergyManagementSystem for more on the EDD file. These
will often be user-defined names of input objects or system nodes, but some actuators are
automatically setup by the program and will not be completely user-defined.
Field: Actuated Component Type
The field defines the type of the entity that is to be controlled by the actuator. The component
types available vary with the specifics of individual models. The types of components that can
be used as actuators in a specific model are listed in the EDD output file see the input
object Output:EnergyManagementSystem for more on the EDD file. Components can be
object types defined elsewhere in the IDD but there are other types of entities such as nodes
and system-level actuators that do not directly correspond to IDF objects.
9/29/14

1569

Input-Output Reference

Group User Defined HVAC and Plant Component Models

Field: Actuated Component Control Type

This field defines the type of control to be done on the specific entity being controlled. The
control types available are listed in the EDD output. Specific components may have more
than one type of control available, such as flow rate or temperature, and this field is used to
distinguish between them.
Field: FMU Variable Name
This field contains the name of the variable in the model description file of the FMU that will
be mapped to the actuator in EnergyPlus.
Field: Initial Value
This field contains the initial value. If a value is specified, then this value is used during the
warm-up period and the system sizing. If no value is specified, then the actuated component
will only be updated once the time stepping starts, i.e., after the warm-up and the systemsizing.
ExternalInterface:FunctionalMockupUnitExport:To:Actuator,
Zn001_Wall001_Win001_Shading_Deploy_Status, !- EnergyPlus Variable Name
Zn001:Wall001:Win001,
!- Actuated Component Unique Name
Window Shading Control,
!- Actuated Component Type
Control Status,
!- Actuated Component Control Type
yShade,
!- FMU Variable Name
6;
!- Initial Value

ExternalInterface:FunctionalMockupUnitExport:To:Variable
This input object is similar to EnergyManagementSystem:GlobalVariable. However, during
the time stepping, its value is set to the value received from the external interface. During the
warm-up period and the system sizing, its value is set to the value specified by the field initial
value. This object can be used to move data into Erl subroutines.
Field: EnergyPlus Variable Name
This field becomes the global Erl variable name that can be referenced in the EnergyPlus
Runtime Language. No spaces are allowed in the object name. The name must be unique
across all global scope variables including those declared as sensor and actuators and the
built-in variables.
Field: FMU Variable Name
This field contains the name of the variable in the model description file of the FMU that will
be mapped to the corresponding variable in EnergyPlus.
Field: Initial Value
This field contains the initial value that is used during the warm-up period and during the
system sizing.
ExternalInterface:FunctionalMockupUnitExport:To:Variable,
Shade_Signal,
!- EnergyPlus Variable Name
yShade,
!- FMU Variable Name
1;
!- Initial Value

Group User Defined HVAC and Plant Component Models

This group of EnergyPlus input objects provides methods for users to include their own
custom models for HVAC and plant components as well as plant equipment operation. This is
helpful because not every conceivable type of HVAC equipment or system configuration has
already had models implemented in EnergyPlus. HVAC or plant components, or even entire
9/29/14

1570

Input-Output Reference

Group User Defined HVAC and Plant Component Models

system configurations, might be so new, unusual, or proprietary that no model has yet been
implemented in the software. An analyst faced with project that needs to model such a
device or system could do so using one or more of the user defined components described in
this section.
Some building energy performance rating systems allow analysts to option of using
exceptional calculation methods when a simulation program cannot perform the function
required to be modeled. These user defined component models are intended to provide a
means for including such exceptional calculations within the context of a full EnergyPlus
model. This allows using EnergyPlus for everything it can model and extending it yourself to
include a new type of HVAC or Plant component.
These objects are advanced. Making good use of them requires the user to have a detailed
understanding of EnergyPlus HVAC and Plant models as well as the Energy Management
System (EMS). The EnergyPlus Runtime Language (Erl) is used to program the component
model. The Application Guide for EMS provides more discussion of how to use the objects in
this group see the chapter called User-Defined Component Models.
ZoneHVAC:ForcedAir:UserDefined
This object is used to define a generic zone air unit for custom component models. This
object has a primary air connection that connects to a zone through exhaust and inlet nodes.
There is an optional secondary air connection that can be used as an air-based source or
heat rejection connection. As many has three different plant connections can be made to the
zone unit. Water storage tanks can be connected for supply or collection. An ambient zone
can be connected for skin losses to be treated as separate internal gains.
Field: Name
This field defines a unique user-assigned name for an instance of a custom, forced-air zone
conditioning unit. Any reference to this zone unit by another object will use this name.
Field: Overall Model Simulation Program Calling Manager Name
This field specifies the Erl programs that are used to model the custom zone unit. This field
should contain the name of an EnergyManagementSystem:ProgramCallingManager that is
defined elsewhere. The program manager referenced here should include all the Erl
programs that are to be run each time the component is simulated and use the calling point
called UserDefinedComponentModel.
Field: Model Setup and Sizing Program Calling Manager Name
This field specifies the Erl programs that are used to initialize and size the custom zone unit.
This
field
should
contain
the
name
of
an
EnergyManagementSystem:ProgramCallingManager that is defined elsewhere and uses the
calling point called UserDefinedComponentModel. The program manager referenced here
should include all the Erl programs that are needed to do any initial setup that should occur
before the main modeling programs are run. These include calculating and setting values for
things that do not vary over time such as component sizes, control parameters, modeling
constants etc. The user defined component will trigger this calling manager at the beginning
of each new environment period.
Field: Primary Air Inlet Node Name
This field defines the name of the HVAC system node from which the zone unit draws its inlet
air from the zone. This node must be the name of a zone air exhaust node (ref.
ZoneHVAC:EquipmentConnection). This field is required.
Field: Primary Air Outlet Node Name
This field defines the name of the HVAC system node to which the zone unit sends its outlet
air to the zone.
This node must be the name of a zone air inlet node (ref.
ZoneHVAC:EquipmentConnection). This field is required.
9/29/14

1571

Input-Output Reference

Group User Defined HVAC and Plant Component Models

Field: Secondary Air Inlet Node Name

This field defines the name of a HVAC system node from which the zone unit can draw
additional air. This air inlet stream has a variety of possible uses including outdoor air supply
for ventilation or a condenser inlet for heat rejection. This field is optional.
Field: Secondary Air Outlet Node Name
This field defines the name of a HVAC system node to which the zone unit can send
additional air. This air outlet stream has a variety of possible uses including outdoor air relief
for exhaust or a condenser outlet for heat rejection. This field is optional.
Field: Number of Plant Loop Connections
This fields defines the number of different plant loop connections that the zone unit will use.
Up to three separate loops can be connected if desired. This field is required. Enter a 0 if
the unit does not use plant at all.
Field: Plant Connection 1 Inlet Node Name
This field defines the name of a plant system node from which the zone unit can draw fluid.
This is the inlet to the component model from the first plant loop that is connected to the zone
unit.
Field: Plant Connection 1 Outlet Node Name
This field defines the name of a plant system node to which the zone unit can send fluid.
This is the outlet from the component model to the first plant loop that is connected to the
zone unit.
Field: Plant Connection 2 Inlet Node Name
This field defines the name of a plant system node from which the zone unit can draw fluid.
This is the inlet to the component model from the second plant loop that is connected to the
zone unit.
Field: Plant Connection 2 Outlet Node Name
This field defines the name of a plant system node to which the zone unit can send fluid.
This is the outlet from the component model to the second plant loop that is connected to the
zone unit.
Field: Plant Connection 3 Inlet Node Name
This field defines the name of a plant system node from which the zone unit can draw fluid.
This is the inlet to the component model from the third plant loop that is connected to the
zone unit.
Field: Plant Connection 3 Outlet Node Name
This field defines the name of a plant system node to which the zone unit can send fluid.
This is the outlet from the component model to the third plant loop that is connected to the
zone unit.
Field: Supply Inlet Water Storage Tank Name
This field is used to describe where the zone unit obtains water if it is to be connected to a
water storage tank. This water could be used for evaporative cooling. If a name of a
WaterUse:Storage object is used here, then the unit can obtain its water from that tank. This
field is optional.
Field: Collection Outlet Water Storage Tank Name
This field is used to describe where the zone unit sends water it has collected if is to be
stored in a tank. This water could be collected from coil condensate. If a name of a
9/29/14

1572

Input-Output Reference

Group User Defined HVAC and Plant Component Models

WaterUse:Storage object is used here, then the unit can send water to that tank. This field is
optional.
Field: Ambient Zone Name
This field is used to connect ancillary losses from the zone unit to a thermal zone. The unit
may have inefficiencies, leaks, or other non-ideal operation that results in some untended
impact on the space surrounding the unit. These skin losses can be assigned to a thermal
zone and appear as internal gains for the zone named here. This does not need to be the
same thermal zone as the zone that unit is intended to condition.
An example of this input object follows.
ZoneHVAC:ForcedAir:UserDefined,
Zone1WindAC, !- Name
Zone 1 Window AC Model Program Manager , !- Overall Model Simulation Program Calling Manager Name
Zone 1 Window AC Init Program Manager , !- Model Setup and Sizing Program Calling Manager Name
Zone1WindACAirInletNode , !- Primary Air Inlet Node Name
Zone1WindACAirOutletNode, !- Primary Air Outlet Node Name
Zone1WindACOAInNode, !- Secondary Air Inlet Node Name
Zone1WindACExhNode, !- Secondary Air Outlet Node Name
0 ; !- Number of Plant Loop Connections

AirTerminal:SingleDuct:UserDefined
This object is used to define a generic single duct air terminal unit for custom component
models. This object has a primary air connection that connects a multi-zone air handler to a
zone. There is an optional secondary air connection that can be used and an air-based
source or heat rejection connection. As many as two different plant connections can be
made to the air terminal unit. Water storage tanks can be connected for supply or collection.
An ambient zone can be connected for skin losses to be treated as separate internal gains.
Field: Name
This field defines a unique user-assigned name for an instance of a custom, air terminal unit.
Any reference to this air terminal by another object will use this name.
Field: Overall Model Simulation Program Calling Manager Name
This field specifies the Erl programs that are used to model the custom air terminal unit. This
field should contain the name of an EnergyManagementSystem:ProgramCallingManager that
is defined elsewhere. The program manager referenced here should include all the Erl
programs that are to be run each time the component is simulated and use the calling point
called UserDefinedComponentModel.
Field: Model Setup and Sizing Program Calling Manager Name
This field specifies the Erl programs that are used to initialize and size the custom air terminal
unit.
This
field
should
contain
the
name
of
an
EnergyManagementSystem:ProgramCallingManager that is defined elsewhere and uses the
calling point called UserDefinedComponentModel. The program manager referenced here
should include all the Erl programs that are needed to do any initial setup that should occur
before the main modeling programs are run. These include calculating and setting values for
things that do not vary over time such as component sizes, control parameters, modeling
constants etc. The user defined component will trigger this calling manager at the beginning
of each new environment period.
Field: Primary Air Inlet Node Name
This field defines the name of the HVAC system node from which the air terminal unit draws
its inlet air. This node must be the name of a HVAC system node that is listed in a zone
splitter (ref. AirLoopHVAC:ZoneSplitter). This field is required.

9/29/14

1573

Input-Output Reference

Group User Defined HVAC and Plant Component Models

Field: Primary Air Outlet Node Name

This field defines the name of the HVAC system node to which the air terminal unit sends its
outlet air to the zone. This node must be the name of a zone air inlet node (ref.
ZoneHVAC:EquipmentConnection). This field is required.
Field: Secondary Air Inlet Node Name
This field defines the name of a HVAC system node from which the air terminal unit can draw
additional air. This air inlet stream has a variety of possible uses including outdoor air supply
for ventilation or a condenser inlet for heat rejection. This field is optional.
Field: Secondary Air Outlet Node Name
This field defines the name of a HVAC system node to which the air terminal unit can send
additional air. This air outlet stream has a variety of possible uses including outdoor air relief
for exhaust or a condenser outlet for heat rejection. This field is optional.
Field: Number of Plant Loop Connections
This fields defines the number of different plant loop connections that the air terminal unit will
use. Up to two separate loop can be connected if desired. This field is required. Enter a 0 if
the unit does not use plant at all.
Field: Plant Connection 1 Inlet Node Name
This field defines the name of a plant system node from which the air terminal unit can draw
fluid. This is the inlet to the component model from the first plant loop that is connected to
the air terminal unit.
Field: Plant Connection 1 Outlet Node Name
This field defines the name of a plant system node to which the air terminal unit can send
fluid. This is the outlet from the component model to the first plant loop that is connected to
the air terminal unit.
Field: Plant Connection 2 Inlet Node Name
This field defines the name of a plant system node from which the air terminal unit can draw
fluid. This is the inlet to the component model from the second plant loop that is connected to
the air terminal unit.
Field: Plant Connection 2 Outlet Node Name
This field defines the name of a plant system node to which the air terminal unit can send
fluid. This is the outlet from the component model to the second plant loop that is connected
to the air terminal unit.
Field: Supply Inlet Water Storage Tank Name
This field is used to describe where the air terminal unit obtains water if it is to be connected
to a water storage tank. This water could be used for evaporative cooling. If a name of a
WaterUse:Storage object is used here, then the unit can obtain its water from that tank. This
field is optional.
Field: Collection Outlet Water Storage Tank Name
This field is used to describe where the air terminal unit sends water it has collected if is to be
stored in a tank. This water could be collected from coil condensate. If a name of a
WaterUse:Storage object is used here, then the unit can send water to that tank. This field is
optional.

9/29/14

1574

Input-Output Reference

Group User Defined HVAC and Plant Component Models

Field: Ambient Zone Name

This field is used to connect ancillary losses from the air terminal unit to a thermal zone. The
unit may have inefficiencies, leaks, or other non-ideal operation that results in some untended
impact on the space surrounding the unit. These skin losses can be assigned to a thermal
zone and appear as internal gains for the zone named here. This does not need to be the
same thermal zone as the zone that terminal unit is intended to condition.
An example of this input object follows.
AirTerminal:SingleDuct:UserDefined,
SPACE1-1 VAV Reheat, !- Name
Space1 ATU Sim Programs , !- Overall Model Simulation Program Calling Manager Name
Space1 ATU Init Programs , !- Model Setup and Sizing Program Calling Manager Name
SPACE1-1 ATU In Node , !- Primary Air Inlet Node Name
SPACE1-1 In Node , !- Primary Air Outlet Node Name
, !- Secondary Air Inlet Node Name
, !- Secondary Air Outlet Node Name
1, !- Number of Plant Loop Connections
SPACE1-1 Zone Coil Water In Node , !- Plant Connection 1 Inlet Node Name
SPACE1-1 Zone Coil Water Out Node; !- Plant Connection 1 Outlet Node Name

Coil:UserDefined
This object is used to define a generic coil for custom component modeling of a device that
processes air as part of an air handeler. The Coil:UserDefined object appears directly on a
Branch object used to define the supply side of an air handler, or in the
AirLoopHVAC:OutdoorAirSystem:EquipmentList object used to define outdoor air systems.
This object has one or two air connections and an optional plant connection. Water storage
tanks can be connected for supply or collection. An ambient zone can be connected for skin
losses to be treated as separate internal gains.
Field: Name
This field defines a unique user-assigned name for an instance of a custom air coil. Any
reference to this coil by another object will use this name.
Field: Overall Model Simulation Program Calling Manager Name
This field specifies the Erl programs that are used to model the custom coil. This field should
contain the name of an EnergyManagementSystem:ProgramCallingManager that is defined
elsewhere. The program manager referenced here should include all the Erl programs that
are to be run each time the component is simulated and use the calling point called
UserDefinedComponentModel.
Field: Model Setup and Sizing Program Calling Manager Name
This field specifies the Erl programs that are used to initialize and size the custom coil. This
field should contain the name of an EnergyManagementSystem:ProgramCallingManager that
is defined elsewhere and uses the calling point called UserDefinedComponentModel. The
program manager referenced here should include all the Erl programs that are needed to do
any initial setup that should occur before the main modeling programs are run. These include
calculating and setting values for things that do not vary over time such as component sizes,
control parameters, modeling constants etc. The user defined component will trigger this
calling manager at the beginning of each new environment period.
Field: Number of Air Connections
This field defines the number of air loop connections that the coil will use. The coil must have
at least one connection but a second can be used by entering a 2.

9/29/14

1575

Input-Output Reference

Group User Defined HVAC and Plant Component Models

Field: Air Connection 1 Inlet Node Name

This field defines the name of the HVAC system node from which the coil draws its inlet air
for its first air loop connection. This node must be the outlet of the HVAC system component
located upstream, if there is one. This field is required.
Field: Air Connection 1 Outlet Node Name
This field defines the name of the HVAC system node to which the coil sends its outlet air for
its first air loop connection. This node must be the inlet of the HVAC system component
located downstream, if there is one. This field is required.
Field: Air Connection 2 Inlet Node Name
This field defines the name of the HVAC system node from which the coil draws its inlet air
for its second air loop connection. This node must be the outlet of the HVAC system
component located upstream, if there is one. This field is optional.
Field: Air Connection 2 Outlet Node Name
This field defines the name of the HVAC system node to which the coil sends its outlet air for
its second air loop connection. This node must be the inlet of the HVAC system component
located downstream, if there is one. This field is optional.
Field: Plant Connection is Used
This field defines whether or not the plant loop connection is going to be used. Enter a Yes if
the coil will use plant, enter No if not. This field is required.
Field: Plant Connection Inlet Node Name
This field defines the name of a plant system node from which the coil can draw fluid. This is
the inlet to the component model from the plant loop that is connected to the coil.
Field: Plant Connection Outlet Node Name
This field defines the name of a plant system node to which the coil can send fluid. This is
the outlet from the component model to the plant loop that is connected to the coil.
Field: Supply Inlet Water Storage Tank Name
This field is used to describe where the coil obtains water if it is to be connected to a water
storage tank. This water could be used for evaporative cooling. If a name of a
WaterUse:Storage object is used here, then the unit can obtain its water from that tank. This
field is optional.
Field: Collection Outlet Water Storage Tank Name
This field is used to describe where the coil sends water it has collected if is to be stored in a
tank. This water could be collected from coil condensate. If a name of a WaterUse:Storage
object is used here, then the unit can send water to that tank. This field is optional.
Field: Ambient Zone Name
This field is used to connect ancillary losses from the coil to a thermal zone. The coil may
have inefficiencies, leaks, or other non-ideal operation that results in some untended impact
on the space surrounding the unit. These skin losses can be assigned to a thermal zone
and appear as internal gains for the zone named here. For example, this would be the
mechanical room where the coil is located, not necessarily one of the zone served by the air
handler.
An example of this input object follows.

9/29/14

1576

Input-Output Reference

Group User Defined HVAC and Plant Component Models

Coil:UserDefined,
Main Cooling Coil 1, !- Name
Main Cooling Coil Model Program Manager , !- Overall Model Simulation Program Calling Manager Name
Main Cooling Coil Init Program Manager , !- Model Setup and Sizing Program Calling Manager Name
1 , !- Number of Air Connections
Mixed Air Node 1 , !- Air Connection 1 Inlet Node Name
Main Cooling Coil 1 Outlet Node , !- Air Connection 1 Outlet Node Name
, !- Air Connection 2 Inlet Node Name
, !- Air Connection 2 Outlet Node Name
Yes , !- Plant Connection is Used
Main Cooling Coil 1 Water Inlet Node, !- Plant Connection Inlet Node Name
Main Cooling Coil 1 Water Outlet Node; !- Plant Connection Outlet Node Name

PlantComponent:UserDefined
This object is used to define a generic plant component for custom component models. This
object can connect to up to four different plant loops. There is an optional air connection that
can be used as an air-based source or heat rejection connection. Water storage tanks can
be connected for supply or collection. An ambient zone can be connected for skin losses to
be treated as separate internal gains.
The PlantComponent:UserDefined object appears directly on the Branch object used to
describe the plant.
Field: Name
This field defines a unique user-assigned name for an instance of a custom plant component.
Any reference to this component by another object will use this name.
Field: Main Model Program Calling Manager Name
This field specifies the Erl programs that are used to model the plant component any time
that the device is called to simulate.
This field should contain the name of an
EnergyManagementSystem:ProgramCallingManager that is defined elsewhere. The program
manager referenced here should include all the Erl programs that are to be run each time the
component is simulated and use the calling point called UserDefinedComponentModel.
Field: Number of Plant Loop Connections
This fields defines the number of different plant loop connections that the component will use.
Up to four separate loops can be connected if desired. This field is required.
FeildSet: {inlet node name, outlet node name, loading mode, flow request mode,
initialization program calling manager, simulation program calling manager.}
Each of the plant loop connections used is defined by a set of 6 input fields that contain and
inlet node, and outlet node, a loading mode, a flow request mode, a program calling manager
for setup and sizing, and a program calling manager for model calculations that should run
when this loop is being simulated.
Field: Plant Connection X Inlet Node Name
This field defines the name of a plant system node from which the component can draw fluid.
This is the inlet to the component model from the x plant loop that is connected to the
component.
Field: Plant Connection X Outlet Node Name
This field defines the name of a plant system node to which the component can send fluid.
This is the outlet from the component model to the first plant loop that is connected to the
component.

9/29/14

1577

Input-Output Reference

Group User Defined HVAC and Plant Component Models

Field: Plant Connection X Loading Mode

This field defines the nature of the plant component with respect to how it affects the loads
experienced by the X plant loop connection. One of the following choices must be selected
depending on the purpose of the component model and this particular plant loop connection.
DemandsLoad. This type of loading is used for plant connections that place a load on
the loop.
MeetsLoadWithPassiveCapacity. This type of loading is used for plant connections
where the component has some capacity to meet loads but it is not really of the type that
could be actively controlled.
MeetsLoadWithNominalCapacity. This type of loading is used for plant connections
where the component has controllable capacity to meet loads and no outlet temperature
restrictions.
MeetsLoadWithNominalCapacityLowOutLimit. This type of loading is used for plant
connections where the component has controllable capacity to meet loads but with a
lower limit on the fluid temperature at the outlet node.
MeetsLoadWithNominalCapacityHiOutLimit. This type of loading is used for plant
connections where the component has controllable capacity to meet loads but with an
upper limit on the fluid temperature at the outlet node.
Field: Plant Connection X Loop Flow Request Mode
This field defines the nature of the plant component with respect to how it affects the overall
flow rate for the loop. One of the following three choices must be made depending on the
nature of the plant component and this particular loop connection.
NeedsFlowIfLoopOn. Devices with this flow request mode will contribute to the overall
loop flow rate but will not initiate flow themselves.
NeedsFlowAndTurnsLoopOn. Devices with this flow request mode will contribute to
the overall loop flow rate and initiate flow.
ReceivesWhateverFlowAvailable. Devices with this flow request mode will not
contribute to the overall loop flow rate and do not initiate flow themselves.
Field: Plant Connection X Initialization Program Calling Manager Name
This field specifies the Erl programs that are used to model the plant component and should
execute when the component is called to simulate by this particular loop connection. This
field should contain the name of an EnergyManagementSystem:ProgramCallingManager that
is defined elsewhere. The program manager referenced here should include all the Erl
programs that are to be run for this X plant loop connection and use the calling point called
UserDefinedComponentModel.
Field: Plant Connection X Simulation Program Calling Manager Name
This field specifies the Erl programs that are used to initialize and size the plant component
with regard to this particular plant connection. This field should contain the name of an
EnergyManagementSystem:ProgramCallingManager that is defined elsewhere and uses the
calling point called UserDefinedComponentModel. The program manager referenced here
should include all the Erl programs that are needed to do any initial setup that should occur
before the main modeling programs are run. These include calculating and setting values for
things that do not vary over time such as component sizes, control parameters, modeling
constants etc. The user defined component will trigger this calling manager during the intitial
setup routines for plant systems.
Field: Air Connection Inlet Node Name
This field defines the name of the HVAC system node from which the plant component draws
its inlet air for its air loop connection. This field is optional.

9/29/14

1578

Input-Output Reference

Group User Defined HVAC and Plant Component Models

Field: Air Connection Outlet Node Name

This field defines the name of the HVAC system node to which the plant component sends its
outlet air for its air loop connection. This field is optional.
Field: Supply Inlet Water Storage Tank Name
This field is used to describe where the plant component obtains water if it is to be connected
to a water storage tank. This water could be used for evaporative cooling. If a name of a
WaterUse:Storage object is used here, then the component can obtain its water from that
tank. This field is optional.
Field: Collection Outlet Water Storage Tank Name
This field is used to describe where the plant component sends water it has collected if is to
be stored in a tank. This water could be collected from coil condensate. If a name of a
WaterUse:Storage object is used here, then the unit can send water to that tank. This field is
optional.
Field: Ambient Zone Name
This field is used to connect ancillary losses from the plant component to a thermal zone.
The component may have inefficiencies, leaks, or other non-ideal operation that results in
some untended impact on the space surrounding the device. These skin losses can be
assigned to a thermal zone and appear as internal gains for the zone named here. For
example, this would be the mechanical room where the plant component is located.
An example of this input object follows:
PlantComponent:UserDefined,
Central Chiller, !- Name
, !- Main Model Program Calling Manager Name
1 , !- Number of Plant Loop Connections
Central Chiller Inlet Node,
!- Plant Connection 1 Inlet Node Name
Central Chiller Outlet Node , !- Plant Connection 1 Outlet Node Name
MeetsLoadWithNominalCapacityLowOutLimit, !- Plant Connection 1 Loading Mode
NeedsFlowIfLoopOn , !- Plant Connection 1 Loop Flow Request Mode
Chiller model init programs, !- Plant Connection 1 Initialization Program Calling Manager Name
Chiller model simulation programs ,!- Plant Connection 1 Simulation Program Calling Manager Name
, !- Plant Connection 2 Inlet Node Name
, !- Plant Connection 2 Outlet Node Name
, !- Plant Connection 2 Loading Mode
, !- Plant Connection 2 Loop Flow Request Mode
, !- Plant Connection 2 Initialization Program Calling Manager Names
, !- Plant Connection 2 Simulation Program Calling Manager Name
, !- Plant Connection 3 Inlet Node Name
, !- Plant Connection 3 Outlet Node Name
, !- Plant Connection 3 Loading Mode
, !- Plant Connection 3 Loop Flow Request Mode
, !- Plant Connection 3 Initialization Program Calling Manager Name
, !- Plant Connection 3 Simulation Program Calling Manager Name
, !- Plant Connection 4 Inlet Node Name
, !- Plant Connection 4 Outlet Node Name
, !- Plant Connection 4 Loading Mode
, !- Plant Connection 4 Loop Flow Request Mode
, !- Plant Connection 4 Initialization Program Calling Manager Name
, !- Plant Connection 4 Simulation Program Calling Manager Name
Central Chiller Condenser Inlet Node, !- Air Connection Inlet Node Name
Central Chiller Condenser Outlet Node, !- Air Connection Outlet Node Name
, !- Supply Inlet Water Storage Tank Name
, !- Collection Outlet Water Storage Tank Name
; !- Ambient Zone Name

PlantEquipmentOperation:UserDefined
This object is used to define a generic plant equipment operation scheme.
The
PlantEquipmentOperation:UserDefined
object
appears
directly
in
either
a
PlantEquipmentOperationSchemes or a CondenserEquipmentOperationSchemes object.
9/29/14

1579

Input-Output Reference

Group User Defined HVAC and Plant Component Models

The user can configure exactly how supply side equipment is dispatched to meet loads by
writing EnergyPlus Runtime Language programs and using the EMS features. There are no
output variables specifically associated with this object but the outcome of load distribution
actuators can be examined using the output variable called Plant Component Distributed
Demand Rate.
Field: Name
This field specifies the unique user-assigned name of the custom operation scheme.
Field: Main Model Program Calling Manager Name
This field specifies the Erl programs that are used to model the custom plant operation
scheme.
The
field
should
contain
the
name
of
an
EnergyManagementSystem:ProgramCallingManager that is defined elsewhere. The program
manager referenced here should include all the Erl programs that are to be run each time the
operation
scheme
is
simulated
and
use
the
calling
point
called
UserDefinedComponentModel.
Field: Initialization Program Calling Manager Name
This field specifies the Erl programs that are used to initialize and do an one-time setup
needed for the custom operation scheme. This field should contain the name of an
EnergyManagementSystem:ProgramCallingManager that is defined elsewhere and uses the
calling point called UserDefinedComponentModel. The program manager referenced here
should include all the Erl programs that are needed to do any initial setup that should occur
before the main programs are run. These include calculating and setting values for things that
do not vary over time such as component capacities, control range parameters, various
constants etc. The user defined operation scheme will trigger this calling manager at the
beginning of each new environment period.
Field Set: (Equipment Object Type, Equipment Name)
Up to ten pairs of fields can be used to define the equipment governed by this custom
operation scheme.
Field: Equipment <#> Object Type
This field specifies the type of equipment, or object name, for each machine to be controlled
by the scheme.
Field: Equipment <#> Name
This field specifies the user selected name of the equipment to be controlled by the scheme.
The following example shows control of a chilled water plant with two chillers that have
different sizes and load dispatch is scaled so that each chiller runs at the same part load
ratio.
PlantEquipmentOperation:UserDefined,
CoolSys1 Operation Scheme, !- Name
Cooling_dispatch , !- Main Model Program Calling
Init_Chiller_Capacity, !- Initialization Program
Chiller:Electric:ReformulatedEIR, !- Equipment 1
CoolSys1 Chiller 1,
!- Equipment 1 Name
Chiller:Electric:ReformulatedEIR, !- Equipment 2
CoolSys1 Chiller 2;
!- Equipment 2 Name

Manager Name
Calling Manager Name
Object Type
Object Type

EnergyManagementSystem:ProgramCallingManager,
Init_Chiller_Capacity,
UserDefinedComponentModel,
Init_Chiller_Capacity_Values;
EnergyManagementSystem:Program,

9/29/14

1580

Input-Output Reference

Group System Availability Managers

Init_Chiller_Capacity_Values,
Set totChilCap = Chil1_Cap + Chil2_Cap;
EnergyManagementSystem:GlobalVariable,
totChilCap;
EnergyManagementSystem:ProgramCallingManager,
Cooling_dispatch,
UserDefinedComponentModel,
Cooling_dispatch_Values;
EnergyManagementSystem:Program,
Cooling_dispatch_Values,
IF CoolSys1_LoopDmnd < 0.0,
Set UniformPLR = CoolSys1_LoopDmnd / totChilCap,
Set UniformPLR = @min UniformPLR 1.0,
SET Chil1_Disptch = UniformPLR*Chil1_Cap,
SET Chil2_Disptch = UniformPLR*Chil2_Cap,
ELSE,
SET Chil1_Disptch = 0.0 ,
SET Chil2_Disptch = 0.0 ,
ENDIF;
EnergyManagementSystem:InternalVariable, CoolSys1_LoopDmnd,CoolSys1 Operation
Scheme,Supply Side Current Demand Rate; !,[W]
EnergyManagementSystem:InternalVariable, Chil1_Cap, CoolSys1 Chiller 1,
Chiller Nominal Capacity;
EnergyManagementSystem:InternalVariable, Chil2_Cap, CoolSys1 Chiller 2,
Chiller Nominal Capacity;
EnergyManagementSystem:Actuator, Chil1_Disptch,CoolSys1 Operation
Scheme:CoolSys1 Chiller 1,Plant Equipment Operation,Distributed Load Rate; !
[W]
EnergyManagementSystem:Actuator, Chil2_Disptch,CoolSys1 Operation
Scheme:CoolSys1 Chiller 2,Plant Equipment Operation,Distributed Load Rate; !
[W]

Group System Availability Managers

System Availability Managers are one of the high-level control constructs in EnergyPlus. A
System Availability Manager is able to access data from any of the HVAC system nodes and
use this data to to make a decision on whether an entire AirLoopHVAC or PlantLoop should
be on or off. Some of the zone component objects (e.g. unit heater, unit ventilator, packaged
terminal air conditioner, packaged terminal heat pump, zone water source heat pump,window
air conditioner, zone terminal unit (variable refrigerant flow), energy recovery ventilator,
outdoor air unit, fan coil unit, and ventilated slab) can also individually use availability
managers to make a decision regarding whether their fan should be on or off.
System Availability Managers are executed at the start of each HVAC timestep. They reside
outside the HVAC system iteration loops. Thus, the System Availability Managers are
executed once per HVAC timestep, and they use previous timestep information (except for
zone load) to calculate their set points.
Some of the managers monitor the temperature at an air or plant node to determine whether
the system should be on or off. If the system is to be controlled on the outdoor dry-bulb
temperature, an OutdoorAir:NodeList object can be used to define a node which will have the
current outdoor air conditions.
The output from each System Availability Manager is an availability status flag. This flag can
have the values NoAction, ForceOff, CycleOn, or CycleOnZoneFansOnly. The availability
status flags for the System Availability Managers referenced by an air or plant loop are used
9/29/14

1581

Input-Output Reference

Group System Availability Managers

to set the availability status flag for each loop. For the air loops and zone components,
ForceOff takes precedence: if any of the loops (or zone components) availability managers
are showing status ForceOff, the loop (or zone component fan) status will be ForceOff. Next
in precedence is CycleOnZoneFansOnly (only for air loop), followed by CycleOn, and
NoAction. For the plant loops, there is no precedence among the System Availability
Manager status flag values. Instead, the first availability manager giving a status flag value
other than NoAction sets the status for the loop. The System Availability Managers are
executed in AvailabilityManagerAssignmentList order.
The actual action of turning on or off a loop is taken by the loop prime movers: fans for
AirLoopHVACs and zone components, and pumps for plant loops. For instance when a fan is
deciding whether it is on or off, it checks its on/off schedule and whether the loop availability
status flag is CycleOn or ForceOff. If the schedule is on and the status flag is ForceOff, the
fan will be off. If the fan schedule says off and the status flag is CycleOn, the fan will be on.
Thus the availability managers overrule the fan on/off schedule. The availability managers, air
loops, and plant loops all have output variables which may be used to verify the action of the
loop.
Availability managers for AirLoopHVAC systems also control the availability of zone exhaust
fans (Ref. Fan:ZoneExhaust) and terminal unit fans (Ref. AirTerminal:SingleDuct:SeriesPIU:
Reheat, AirTerminal:SingleDuct:ParallelPIU:Reheat, and AirTerminal:SingleDuct:VAV:
Reheat:VariableSpeedFan) in the zones served by the AirLoopHVAC system.
AvailabilityManager:Scheduled
The simplest System Availability Manager is when the availability is determined by an on/off
schedule.The syntax for implementing such an availability manager is shown below. The
identifying name refers back to the name recorded in the AvailabilityManagerAssignmentList
statement described in the Group Air Distribution section. The schedule must be the
name of a schedule defined elsewhere in the input.
Field: Name
The unique, user-assigned name of an instance of a scheduled availability manager. Other
objects that use this scheduled availability manager will reference it by this name.
Field: Schedule Name
The name of a schedule defined elsewhere in the input. Schedule values greater than zero
(usually 1 is used) indicate that the system is on. Schedule values less than or equal to zero
(usually 0 is used) denote that the system is off. This schedule overides the central fan
schedule for determining whether the fan is on.
An example of this statement in an IDF is:
AvailabilityManager:Scheduled,
VAV Sys 1 Avail, !- Name
FanAvailSched;
!- Schedule Name

AvailabilityManager:Scheduled Outputs
The scheduled availability manager has one output variable.
HVAC,Average, Availability Manager Scheduled Control Status

Availability Manager Scheduled Control Status

A value of 1 indicates the manager is signaling ForceOff. A value of 2 means the manager is
signaling CycleOn.
AvailabilityManager:ScheduledOn
The Schedule On Availability Manager is used when equipment must be turned on during a
given time period. This availability manager will not turn the equipment off, a separate
availability manager must be used to disable the equipment as necessary. The scheduled on
9/29/14

1582

Input-Output Reference

Group System Availability Managers

availability is determined by an on schedule. Schedule values other than 0 set a CycleOn

availability status. Schedule values equal to 0 set a NoAction availability status. The syntax
for implementing such an availability manager is shown below. The identifying name refers
back to the name recorded in the AvailabilityManagerAssignmentList statement described in
the Group Air Distribution section. The schedule must be the name of a schedule defined
elsewhere in the input.
Field: Name
The unique, user-assigned name of an instance of a scheduled on availability manager.
Other objects that use this scheduled on availability manager will reference it by this name.
Field: Schedule Name
The name of a schedule defined elsewhere in the input. Schedule values greater than zero
(usually 1 is used) indicate that the system is on. Schedule values less than or equal to zero
(usually 0 is used) denote that NoAction is desired. This schedule overides the central fan
schedule for determining whether the fan is on.
An example of this statement in an IDF is:
AvailabilityManager:ScheduledOn,
VAV Sys 1 Avail On, !- Name
FanAvailSched;
!- Schedule Name

AvailabilityManager:ScheduledOn Outputs
The scheduled on availability manager has one output variable.
HVAC,Average, Availability Manager Scheduled On Control Status

Availability Manager Scheduled On Control Status []

A value of 0 indicates the manager is signaling NoAction. A value of 2 means the manager is
signaling CycleOn.
AvailabilityManager:ScheduledOff
The Schedule Off Availability Manager is used when equipment must be turned off during a
given time period. This availability manager will not turn the equipment on, a separate
availability manager must be used to enable the equipment as necessary. The scheduled off
availability is determined by an off schedule. Schedule values equal to 0 set a ForceOff
availability status. Schedule values other than 0 (usually a 1 is used) set a NoAction
availability status. The syntax for mplementing such an availability manager is shown below.
The
identifying
name
refers
back
to
the
name
recorded
in
the
AvailabilityManagerAssignmentList statement described in the Group Air Distribution
section. The schedule must be the name of a schedule defined elsewhere in the input.
Field: Name
The unique, user-assigned name of an instance of a scheduled off availability manager.
Other objects that use this scheduled off availability manager will reference it by this name.
Field: Schedule Name
The name of a schedule defined elsewhere in the input. Schedule values equal to zero
indicate that the system is off. Schedule values other than (usually 0 is used) denote that
NoAction is desired.
An example of this statement in an IDF is:

9/29/14

1583

Input-Output Reference

Group System Availability Managers

AvailabilityManager:ScheduledOff,
VAV Sys 1 Avail Off,
!- Name
FanAvailSched;
!- Schedule Name

AvailabilityManager:ScheduledOff Outputs
The scheduled off availability manager has one output variable.
HVAC,Average, Availability Manager Scheduled Off Control Status

Availability Manager Scheduled Off Control Status []

A value of 0 indicates the manager is signaling NoAction. A value of 1 means the manager is
signaling ForceOff.
AvailabilityManager:NightCycle
This manager is used for cycling on an air system when one or more zones become too hot
or too cold. The usual situation is that the central air handler is turned off at night. However if
the building gets too cold there might be condensation on the walls and other damage. Thus
the control system is usually programmed to turn the system on if 1 control thermostat or any
thermostat shows a zone temperature of less than a night time set point. Similarly there might
be a concern about a building getting too hot. Again the control system is programmed to turn
the air handler back on if one or any zone temperature exceeds a night time cooling set point.
This object gives the user considerable flexibility in determining how the night time on/off
decision will be made. The manager can look at the temperature in 1 zone or it can sample
all the zones connected to the air handler. The user can specify a temperature tolerance and
a run time for the system once it switches on. There is also an applicability schedule the
user can schedule whether or not this availability manager itself is being applied.
Field: Name
A unique, user-assigned name for an instance of a night cycle availability manager. Other
objects that use this availability manager will reference it by this name.
Field: Applicability Schedule Name
The name of a schedule defined elsewhere in the input file. This schedule determines
whether or not for a given time period this availability manager is to be applied. Schedule
values greater than zero (usually 1 is used) indicate the availability manager is to be applied.
Schedule values less than or equal to zero (usually 0 is used) denote that the availability
manager is not used for this time period.
Field: Fan Schedule Name
The name of the central fan on/off schedule for the air system that this availability manager
will affect.
Field: Control Type
The
possible
inputs
are
StayOff,
CycleOnAny,
CycleOnControlZone,
CycleOnAnyZoneFansOnly. StayOff means the availability manager will have no effect air
handler on/off will be determined by the fan schedule. CycleOnAny means that if any zone
served by a system whose AvailabilityManagerAssignmentList references this system
availability manager has an air temperature outside the cooling or heating set points the
central fan will turn on even though the fan schedule indicates the fan is off.
CycleOnControlZone means the same thing except the availability manager looks at the
temperature in only one zone. CycleOnAnyZoneFansOnly is the same as CycleOnAny
except that only the zone fans are cycled on and the central air handler fan is left off. The
default is StayOff.

9/29/14

1584

Input-Output Reference

Group System Availability Managers

Field: Thermostat Tolerance

The Thermostat Tolerance defines the amount by which the zone temperature must fall
outside the current zone heating and cooling setpoints for the Night Cycle manager to turn
the system on. The zone temperature must exceed the cooling set point or fall below the
heating set point by 1/2 the Thermostat Tolerance in order for the availability manager to
signal that the system should turn on. The Thermostat Tolerance is specified in degrees
Celsius. The default is 1 degree C.
Field: Cycling Run Time
The time in seconds for which the system will run after it has cycled on. The default is 3600
seconds (1 hour).
Field: Control Zone Name
For the option CycleOnControlZone this is the name of the control zone.
An example of this statement in an IDF is:
AvailabilityManager:NightCycle,
VAV Sys 1 Avail,
! Name
SysAvailApplicSch,
! Applicability Schedule Name
FanAvailSched,
! Fan Schedule Name
CycleOnAny,
! Control Type
4.0,
! Temperature Tolerance {delta C}
7200.;
! Cycle Run Time {s}

AvailabilityManager:NightCycle Outputs
The night cycle availability manager has one output variable.
HVAC,Average, Availability Manager Night Cycle Control Status

Availability Manager Night Cycle Control Status

A value of 0 indicates the manager is signaling NoAction. A value of 2 means the manager is
signaling CycleOn. A value of 3 says that the manager is signaling CycleOnZoneFansOnly.
AvailabilityManager:DifferentialThermostat
The differential thermostat compares the temperatures at two different system nodes. If the
temperature difference ( T) is above the Temperature Difference On Limit, the system is
turned on. If the T is below the Temperature Difference Off Limit, the system is turned off.
Between the On Limit and Off Limit the system is either on or off depending on the previous
state of the thermostat. Unlike other availability managers, the differential thermostat is
always either "On" or "Off"; it does not use the "No Action" state. Therefore, the differential
thermostat must be the last manager in the AvailabilityManagerAssignmentList. Any
availability managers after the differential thermostat manager will never be simulated.
One application of the differential thermostat is to ensure a useful heat gain for solar heating
systems, i.e. the system is only turned on when there is a significant temperature difference
between the solar collector outlet node and the storage tank outlet node.
Field: Name
The name of the object. This is referenced in the AvailabilityManagerAssignmentList.
Field: Hot Node Name
The sensor node with the higher temperature.
Field: Cold Node Name
The sensor node with the colder temperature.

9/29/14

1585

Input-Output Reference

Group System Availability Managers

Field: Temperature Difference On Limit

Temperature difference [deltaC] between hot and cold nodes necessary to turn the system
on.
Field: Temperature Difference Off Limit
Temperature difference [deltaC] between hot and cold nodes necessary to turn the system
off. This field defaults to the Temperature Difference On Limit.
An example of this object in an IDF is:
AvailabilityManager:DifferentialThermostat,
Differential Thermostat Availability Manager, !- Name
Collector Outlet Node,
!- Hot Node Name
Water Heater Source Outlet Node, !- Cold Node Name
10.0, !- Temperature Difference On Limit {delta C}
2.0;
!- Temperature Difference Off Limit {delta C}

AvailabilityManager:DifferentialThermostat Outputs
The differential thermostat availability manager has one output variable.
HVAC,Average, Availability Manager Differential Thermostat Control Status

Availability Manager Differential Thermostat Control Status

A value of 1 indicates the manager is signaling ForceOff. A value of 2 means the manager is
signaling CycleOn.
AvailabilityManager:HighTemperatureTurnOff
This manager turns the system off if the temperature at the sensor node is above the
specified setpoint temperature.
Field: Name
The name of the object. This is referenced in the AvailabilityManagerAssignmentList.
Field: Sensor Node Name
The air or plant node where the temperature is monitored.
Field: Temperature
The setpoint temperature [C] at which the system is turned off.
An example of this object in an IDF is:
AvailabilityManager:HighTemperatureTurnOff,
High Temperature Turn Off Availability Manager, !- Name
Water Heater Use Outlet Node, !- Sensor Node Name
60.0; !- Temperature {C}

AvailabilityManager:HighTemperatureTurnOff Outputs
The high temperature turn off availability manager has one output variable.
HVAC,Average,Availability Manager High Temperature Turn Off Control Status

Availability Manager High Temperature Turn Off Control Status []

A value of 0 indicates the manager is signaling NoAction. A value of 1 means the manager is
signaling ForceOff.
AvailabilityManager:HighTemperatureTurnOn
This manager turns the system on if the temperature at the sensor node is above the
specified setpoint temperature.

9/29/14

1586

Input-Output Reference

Group System Availability Managers

Field: Name
The name of the object. This is referenced in the AvailabilityManagerAssignmentList.
Field: Sensor Node Name
The air or plant node where the temperature is monitored.
Field: Temperature
The setpoint temperature [C] at which the system is turned on.
An example of this object in an IDF is:
AvailabilityManager:HighTemperatureTurnOn,
High Temperature Turn On Availability Manager,
Outside Air Inlet Node, !- Sensor Node
30.0; !- Temperature {C}

!- Name

AvailabilityManager:HighTemperatureTurnOn Outputs
The high temperature turn on availability manager has one output variable.
HVAC,Average,Availability Manager High Temperature Turn On Control Status

Availability Manager High Temperature Turn On Control Status []

A value of 0 indicates the manager is signaling NoAction. A value of 2 means the manager is
signaling CycleOn.
AvailabilityManager:LowTemperatureTurnOff
This manager turns the system off if the temperature at the sensor node is below the
specified setpoint temperature.
Field: Name
The name of the object. This is referenced in the AvailabilityManagerAssignmentList.
Field: Sensor Node Name
The air or plant node where the temperature is monitored.
Field: Temperature
The setpoint temperature [C] at which the system is turned off.
Field: Applicability Schedule Name
The name of a schedule defined elsewhere in the input file. This schedule determines
whether or not for a given time period this availability manager is to be applied. Schedule
values greater than zero (usually 1 is used) indicate the availability manager is to be applied.
Schedule values less than or equal to zero (usually 0 is used) denote that the availability
manager is not used for this time period. If this field is left blank, this availability manager is
always active.
An example of this object in an IDF is:
AvailabilityManager:LowTemperatureTurnOff,
Low Temperature Turn Off Availability Manager, !- Name
Outside Air Inlet Node, !- Sensor Node Name
0.0, !- Temperature {C}
Low Temp Control Schedule; !- Applicability Schedule Name

AvailabilityManager:LowTemperatureTurnOff Outputs
The low temperature turn off availability manager has one output variable.
HVAC,Average,Availability Manager Low Temperature Turn Off Control Status

Availability Manager Low Temperature Turn Off Control Status []

9/29/14

1587

Input-Output Reference

Group System Availability Managers

A value of 0 indicates the manager is signaling NoAction. A value of 1 means the manager is
signaling ForceOff.
AvailabilityManager:LowTemperatureTurnOn
This manager turns the system on if the temperature at the sensor node is below the
specified setpoint temperature.
Field: Name
The name of the object. This is referenced in the AvailabilityManagerAssignmentList.
Field: Sensor Node Name
The air or plant node where the temperature is monitored.
Field: Temperature
The setpoint temperature [C] at which the system is turned on.
An example of this object in an IDF is:
AvailabilityManager:LowTemperatureTurnOn,
Low Temperature Turn On Availability Manager,
Collector Outlet Node, !- Sensor Node Name
0.0; !- Temperature {C}

!- Name

AvailabilityManager:LowTemperatureTurnOn Outputs
The low temperature turn on availability manager has one output variable.
HVAC,Average,Availability Manager Low Temperature Turn On Control Status []

Availability Manager Low Temperature Turn On Control Status []

A value of 0 indicates the manager is signaling NoAction. A value of 2 means the manager is
signaling CycleOn.
AvailabilityManager:NightVentilation
This manager allows the user to implement a strategy for precooling a building at night using
outdoor air. This strategy can consist of running the system fans with the outdoor air dampers
open when outdoor conditions are favorable for a precooling strategy. The zone terminal unit
air dampers may also be held at their fully open position to minimize fan energy consumption
while precooling. Fan energy consumption is the critical parameter in deciding whether a
precooling strategy will save energy.
The inputs for the night ventilation manager consist of an applicability schedule name
(determining when the manager is active), a fan schedule name (for the fan(s) that the
manager can switch on), a ventilation temperature schedule name (one zone must be above
this temperature for night venting to be active), a ventilation temperature difference (indoor
outdoor temperature difference for night venting), a low limit temperature (no conditioned
zone may fall below this temperature during night venting), a night venting flow fraction
(fraction of the design flow rate at which the fans run during night venting), and the zone
name of a control zone.
The night ventilation manager is used in conjunction with another object:
FanPerformance:NightVentilation. The performance of the fan during night venting may be
very different than during normal operation (a different fan might even be used). The
FanPerformance:NightVentilation object allows the user to specify alternate fan performance
parameters for use during night ventilation.
Field: Name
A unique, user-assigned name for an instance of a night ventilation availability manager.
Other objects that use this availability manager will reference it by this name.

9/29/14

1588

Input-Output Reference

Group System Availability Managers

Field: Applicability Schedule Name

The name of a schedule defined elsewhere in the input file. This schedule determines
whether or not for a given time period this availability manager is to be applied. Schedule
values greater than zero (usually 1 is used) indicate the availability manager is to be applied.
Schedule values less than or equal to zero (usually 0 is used) denote that the availability
manager is not used for this time period.
Field: Fan Schedule Name
The name of the central fan on/off schedule for the air system that this availability manager
will affect.
Field: Ventilation Temperature Schedule Name
The name of a temperature schedule defined elsewhere in the input file. At least one
conditioned zone in the forced air system using this availability manager must be above the
current temperature specified in this schedule for night ventilation to occur or to continue
occurring.
Field: Ventilation Temperature Difference
This field specifies an indoor / outdoor temperature difference (in degrees C). The control
zone temperature minus the outdoor air temperature must be greater than the Ventilation
Temperature Difference for night ventilation to occur or to continue occurring. The default is 2
degrees C.
Field: Ventilation Temperature Low Limit
This field specifies a lower limit (in degrees C) on zone temperatures for night ventilation. If
any conditioned zone served by the air system using this availability manager is below the
ventilation temperature low limit, night ventilation will not occur or will switch off. The default
is 15 degrees C.
Field: Night Venting Flow Fraction
The fraction (could be greater than 1) of the design flow rate at which the night ventilation will
be done. The default is 1.
Field: Control Zone Name
The name of the control zone used in the ventilation temperature difference check.
An example of this object in an input file:
AvailabilityManager:NightVentilation,
VAV Sys 1 Avail,
!- Name
NightVentSched,
!- Applicability Schedule Name
FanAvailSched,
!- Fan Schedule Name
VentTempSched,
!- Ventilation Temperature Schedule Name
2.0,
!- Ventilation Temperature Difference {C}
15.,
!- Ventilation Temperature Low Limit
0.3333,
!- Night Venting Flow Fraction
SPACE3-1;
!- Control Zone Name

System Availability Manager Night Ventilation Outputs

The night ventilation availability manager has one output variable.
HVAC,Average, Availability Manager Night Ventilation Control Status []

Availability Manager Night Ventilation Control Status []

A value of 0 indicates the manager is signaling NoAction. A value of 2 means the manager is
signaling CycleOn.

9/29/14

1589

Input-Output Reference

Group System Availability Managers

AvailabilityManager:HybridVentilation
This availability manager is executed at the start of each HVAC system timestep, before
EnergyPlus calculates airflows defined in the objects ZoneInfiltration:*, ZoneVentilation:*,
ZoneMixing, and ZoneCrossMixing, and before the AirflowNetwork model calculates
multizone airflows. It serves two purposes: 1) prevents simultaneous natural ventilation and
HVAC system operation, and 2) allows users to examine various ventilation strategies to
maximize natural ventilation in order to reduce heating/cooling loads. The natural ventilation
objects controlled by this availability manager have two groups: simple airflow group and
AirflowNetwork group. The simple airflow group consists of the ZoneVentilation;* and
ZoneMixing
objects.
The
AirflowNetwork
group
consists
of
AirflowNetwork:MultiZone:Component:DetailedOpening
and
AirflowNetwork:MultiZone:Component:SimpleOpening objects used in the AirflowNetwork
model. These two groups are not allowed to work simultaneously (see restrictions in the
Airflow Network model section). Basically, this object overrides the controls for these opening
objects or ZoneVentilation:* and ZoneMixing objects, closing the openings or shutting off
ventilation/mixing airflows under certain conditions and allowing the HVAC system
(AirLoopHVAC) to operate. If the availability manager determines that conditions are
favorable for natural ventilation, then the HVAC system (AirLoopHVAC) is disabled and the
opening objects or ventilation/mixing objects are able to operate based on the controls
specified for those objects.
Each AirLoopHVAC can have a corresponding hybrid ventilation availability manager. Each
hybrid ventilation manager can control natural ventilation in the zones served by the
AirLoopHVAC. The hybrid ventilation availability manager is triggered by zone air conditions
for the controlled zone specified in an object input field. If there is no air loop, hybrid
ventilation manager can still be applied to controlled zone specified in the object. To apply
hybrid ventilation manager to the controlled zone not served by any air loop, the HVAC air
loop name input field must be left blank. Currently, zone component objects such as unit
heater, unit ventilator, packaged terminal air conditioner, packaged terminal heat pump, zone
water source heat pump, window air conditioner, variable refrigerant flow, energy recovery
ventilator, outdoor air unit, fan coil unit, and ventilated slab can individually use hybrid
ventilation managers to make a decision regarding whether their fan should be on or off.
Also, hybrid ventilation managers can be applied to zones served by ideal load zone
components to turn them off when natural ventilation is active. Currently, hybrid ventilation
manager is restricted to one per zone. It can either be applied through the air loop or directly
to the zone. If hybrid ventilation manager is applied to an air loop and one of the zones
served by the air loop also has hybrid ventilation manager, then zone hybrid ventilation
manager is disabled. Presently, this availability manager must be used either with the
ZoneVentilation:* and ZoneMixing objects or with the AirflowNetwork model.
The inputs for this availability manager consist of the name for the air loop (AirLoopHVAC)
being controlled, the controlled zone name to determine which zone air conditions are used
to determine system availability, a ventilation control mode schedule, maximum wind speed
and rain indicator to determine whether natural ventilation is allowed or not, a low limit and
high limit for dry-bulb temperature, enthalpy and dewpoint temperature to determine the
hybrid ventilation control, and a minimum outdoor air ventilation schedule. The last control
allows user to use a wind speed modifier to adjust openness when the AirflowNetwork
opening objects are selected. The other inputs include how to control simple airflow objects
and AirflowNetwork opening objects.
The hybrid ventilation availability manager works independently of all other system availability
manager objects, so this manager is not a valid system availability manager type in the
AvailabilityManagerAssignmentList object.
Field: Name
A unique, user-assigned name for an instance of a hybrid ventilation availability manager.
Other objects that use this availability manager will reference it by this name.
9/29/14

1590

Input-Output Reference

Group System Availability Managers

Field: HVAC Air Loop Name

The name of the air loop (AirLoopHVAC object) to be controlled by this system availability
manager. If this field is left blank, hybrid ventilation manager will be applied to the controlled
zone specified in the field below.
Field: Controlled Zone Name
The name of a controlled zone served by the air loop defined in the previous field. The air
conditions in this zone are used to determine if natural ventilation should be provided.
Field: Ventilation Control Mode Schedule Name
The name of a schedule defined elsewhere in the input file. This schedule determines
whether or not for a given time the hybrid ventilation control mode is to be applied. Schedule
values equal to zero indicate no ventilation control, resulting in natural ventilation and HVAC
system operation being performed based on their own controls. Schedule values equal to one
denote temperature control for either cooling or heating, which is determined internally based
on thermostat set point and temperature control type. The temperature control is restricted
between the minimum and maximum outdoor temperatures provided in two additional input
fields (below). Schedule values equal to two denote enthalpy control, which is restricted
between minimum and maximum outdoor enthalpy values given in two additional input fields
(below). Schedule values equal to three denote dewpoint control for either dehumidification or
humidification. Schedule values equal to four represent outdoor ventilation air control. The
outdoor ventilation air control works with AirflowNetwork opening objects only, and is not
allowed to work with ZoneVentilation:* and ZoneMixing objects.
The detailed control logic is given in the EnergyPlus Engineering Reference.
Field: Use Weather File Rain Indicators
This logical alpha field indicates whether or not the rain indicator is used to shut off natural
ventilation or not. The valid choices for Rain Indicator are Yes and No, with the default being
Yes. This can help simulate conditions where one would normally close windows to avoid rain
penetration in a space. Any possible rain getting into a space will not be counted as a zone
load.
Field: Maximum Wind Speed
This is the wind speed (m/s) above which hybrid ventilation is shut off. This can help
simulate conditions where one would normally close windows to avoid wind problems in a
space (papers blowing around, etc).
Field: Minimum Outdoor Temperature
This is the outdoor temperature (in Celsius) below which hybrid ventilation is shut off when
the ventilation control mode = 1 (Temperature). This lower temperature limit is intended to
avoid overcooling a space, which could result in a heating load.
Field: Maximum Outdoor Temperature
This is the outdoor temperature (in Celsius) above which hybrid ventilation is shut off when
the ventilation control mode = 1 (Temperature). This upper temperature limit is intended to
avoid overheating a space, which could result in a cooling load.
Field: Minimum Outdoor Enthalpy
This is the outdoor enthalpy (in J/kg) below which hybrid ventilation is shut off when the
ventilation control mode = 2 (Enthalpy).
Field: Maximum Outdoor Enthalpy
This is the outdoor enthalpy (in J/kg) above which hybrid ventilation is shut off when the
ventilation control mode = 2 (Enthalpy).
9/29/14

1591

Input-Output Reference

Group System Availability Managers

Field: Minimum Outdoor Dewpoint

This is the outdoor dewpoint (in Celsius) below which hybrid ventilation is shut off when the
ventilation control mode = 3 (Dewpoint). This lower dewpoint temperature limit is intended to
avoid dehumidifying a space.
Field: Maximum Outdoor Dewpoint
This is the outdoor dewpoint temperature (in Celsius) above which hybrid ventilation is shut
off when the ventilation control mode = 3 (Dewpoint). This upper dewpoint temperature limit is
intended to avoid humidifying a space.
Field: Minimum Outdoor Ventilation Air Schedule Name
The name of a schedule defined elsewhere in the input file. This field applies only if
Ventilation Control Mode = 4 (Outdoor Ventilation Air Control). This schedule determines the
minimum outdoor ventilation air for a given time in the units of air change per hour (ACH).
The program calculates the natural (outdoor) ventilation in the controlled zone first and
compares the amount of outdoor air introduced by opening windows or doors and other small
openings to this minimum value. If the amount of outdoor air from natural ventilation is less
than the minimum value, the natural ventilation is shut off (i.e., the window or door openings
are closed) and the HVAC system may operate if needed. Otherwise, the natural ventilation
is on and the HVAC system is shut off. The amount of outdoor ventilation air entering the
controlled zone is determined as air from outdoors and not from other adjacent zones.
Therefore, this option is only applied to a zone having a window or door exposed to outdoors.
Field: Opening Factor Function of Wind Speed Curve Name
The name of a linear or quadratic performance curve (ref: Performance Curves) that
parameterizes the variation of opening factor as a function of outdoor wind speed. The output
of this curve is multiplied by the opening factor of opening objects to give the final openness.
This field only works with the AirflowNetwork opening objects.
Field: AirflowNetwork Control Type Schedule Name
The name of a schedule defined elsewhere in the input file. This field works with the
AirflowNetwork opening objects only. This schedule determines for a given simulation
timestep how the opening objects respond to the hybrid ventilation control when the hybrid
ventilation control allows the objects to operate.
Schedule values equal to zero indicate individual ventilation control based on the control
requirements specified for each individual AirflowNetwork opening object. Schedule values
equal to one denote group control. The opening objects exposed to outdoors in the
controlled zone served by the primary air loop (Ref. Field HVAC Air Loop Name) will be
considered as a master to provide group control.
Field: Simple Airflow Control Type Schedule Name
The name of a schedule defined elsewhere in the input file. This field works with
ZoneVentilation:* and ZoneMixing objects only. This schedule determines for a given
simulation timestep how the ZoneVentilation:* and ZoneMixing objects respond to the hybrid
ventilation control when the hybrid ventilation control allows the objects to operate.
Schedule values equal to zero indicate the individual ventilation control based on the control
requirements from their own objects. Schedule values equal to one denote group control. The
ZoneVentilation:* and ZoneMixing objects in the zones served by the primary air loop defined
in a previous input field (Ref. Field HVAC Air Loop Name) are controlled by a single object,
whose name is provided in the following input field.
Field: ZoneVentilation Object Name
The name of a ZoneVentilation:* object whose zone name is the controlled zone name
defined in a previous input field for this availability manager object (Ref. Field Controlled
9/29/14

1592

Input-Output Reference

Group System Availability Managers

Zone Name). The controls defined for this specific ZoneVentilation:* object to enable
ventilation air will be applied to other ZoneVentilation:* and ZoneMixing objects served by the
air loop controlled by this availability manager, regardless of the controls defined for the other
ZoneVentilation:* and ZoneMixing objects. In other words, when ventilation is enabled by this
specific ZoneVentilation:* object, the other ZoneVentilation:* and ZoneMixing objects in the
zones served by the primary air loop are also enabled.
Note: A ZoneInfiltration:* object indicates any one of ZoneInfiltration:DesignFlowRate,
ZoneInfiltration:EffectiveLeakageArea,and ZoneInfiltration:FlowCoefficient objects. A object of
ZoneVentilation:*
indicates
any
one
of
ZoneVentilation:DesignFlowRate
and
ZoneVentilation:WindandStackOpenArea objects.

AvailabilityManager:HybridVentilation Outputs
The hybrid ventilation availability manager has two output variables.
HVAC,Average,Availability Manager Hybrid Ventilation Control Mode []
HVAC,Average,Availability Manager Hybrid Ventilation Control Status []

Availability Manager Hybrid Ventilation Control Mode []

This is the hybrid ventilation control mode given in the Ventilation Control Mode Schedule.
Availability Manager Hybrid Ventilation Control Status []
This is the hybrid ventilation control status, which can have three integer values: 0, 1, and 2.
A zero value indicates no hybrid ventilation control, corresponding to zero value defined in
the previous output variable. A value of one indicates that natural ventilation is allowed. A
value of two denotes that the natural ventilation is not allowed, so all window/door openings
are closed.
AvailabilityManager:OptimumStart
When night time temperature setback and/or setup are employed, the optimum start
availability manager is used to start the HVAC system prior to occupancy to ensure that the
space is comfortable when people appear in the building.
Field: Name
A unique, user-defined name for an instance of this availability manager.
Field: Applicability Schedule Name
This schedule decides whether for a given time period this availability manager is to be
applied. Schedule value of 1 specifies the availability manager is to be applied. Schedule
value of 0 indicates that the availability manager is not used for this time period
Field: Fan Schedule Name
The name of the central fan schedule for the air system that this availability manager will
govern.
Field: Control Type
The possible inputs are StayOff, MaximumofZoneList, and ControlZone. StayOff means the
availability manager will have no effect air handler on/off will be determined by the fan
schedule. ControlZone means a specific zone mentioned in the field will govern the start time.
The default is ControlZone. MaximumofZoneList means that from all zones mentioned in the
zone list field in this availability manager maximum value of start time will be used to start the
fan.

9/29/14

1593

Input-Output Reference

Group System Availability Managers

Field: Control Zone Name

For Control type ControlZone the name of zone is added here. Start time for this zone will be
used for the air loop.
Field: Zone List Name
Zones mentioned in this list will be used to determine the start time. Maximum value of start
time for the zones mentioned in this list will be used for the air loop.
Field: Maximum Value for Optimum Start Time
To limit too early start of the system maximum value for the start time can be entered here.
Optional input, defaults to 6 hours. This is the maximum number of hours that a system can
start before occupancy.
Field: Control Algorithm
The
four
possible
inputs
are
ConstantTemperatureGradient,
AdaptiveTemperatureGradient,
AdaptiveASHRAE,
and
ConstantStartTime.
In
ConstantTemperatureGradient algorithm the temperature gradient entered by the user will be
constant throughout the simulation. The response to heating and cooling operation can be
non-linear thus two separate fields for temperature gradients are used.
AdaptiveTemperatureGradient algorithm will modify the temperature gradients based on the
arithmetic average of the actual temperature gradients calculated for the specified number of
previous days. For this algorithm user should enter two initial start values. AdaptiveASHRAE
algorithm implements equations suggested in ASHRAE Handbook HVAC Applications
(2007). This algorithm will calculate the coefficients of the equation within the code and users
need not provide temperature response related inputs. ConstantStartTime method calculates
the start time based on specified number of hours before occupancy for each day. The
AdaptiveASHRAE algorithm has not been implemented yet.
Field: Constant Temperature Gradient during Cooling
This input is required if ConstantTemperatureGradient algorithm is selected in the above
field. Temperature gradient (C/hour) for cooling operation is entered here. Such gradient
may be obtained for existing buildings from EMCS or pre-calculated by other programs. This
gradient remains constant throughout the simulation.
Field: Constant Temperature Gradient during Heating
This input is required if ConstantTemperatureGradient algorithm is selected in the Control
Algorithm field. Temperature gradient (C/hour) for heating operation is entered here. This
gradient remains constant throughout the simulation.
Field: Initial Temperature Gradient during Cooling
This input is required if AdaptiveTemperatureGradient algorithm is selected in Control
Algorithm field. Initial value of temperature gradient (C/hour) for cooling operation is entered
here. This value is used as initial guess value to start the adaptive method. Depending on
performance, this value is modified and used in the simulation.
Field: Initial Temperature Gradient during Heating
This input is required if AdaptiveTemperatureGradient algorithm is selected in Control
Algorithm field. Initial value of temperature gradient (C/hour) for heating operation is entered
here. This value is used as initial guess value to start the adaptive method. Depending on
performance, this value is modified and used in the simulation.
Field: Constant Start Time
This input is required if ConstantStartTime algorithm is selected in the Control Algorithm field.
Start time, the number of hours before occupancy occurs for a system, for heating and
9/29/14

1594

Input-Output Reference

Group Setpoint Managers

cooling operation is entered here. Irrespective of thermal response, the heating or cooling
operation starts before the occupancy at this fixed time. This start time value remains
constant throughout the simulation.
Field: Number of Previous Days
This input is required if AdaptiveTemperatureGradient algorithm is selected in the Control
Algorithm field. The values of optimal start time for number of days entered here will be used
to determine the adaptive gradients.
Sample IDFs:
AvailabilityManager:OptimumStart,
AdaptiveSetbackRecovery,
AppliSch,
FanSch,
ControlZone,
MainZone,
,
4,
AdaptiveTemperatureGradient,
,
,
5,
5;

!!!!!!!!!!!!-

Name
Applicability Schedule Name
Fan Schedule Name
Control Type
Control Zone Name
Zone List Name
Maximum Value for Optimum Start Time
Control Algorithm
Constant Temperature Gradient during Cooling
Constant Temperature Gradient during Heating
Initial Temperature Gradient during Cooling
Initial Temperature Gradient during Heating

AvailabilityManager:OptimumStart,
SetbackRecovery,
AppliSch,
FanSch,
MaximumofZoneList,
,
ZoneList,
,
AdaptiveASHRAE;

!!!!!!!!-

Name
Applicability Schedule Name
Fan Schedule Name
Control Type
Control Zone Name
Zone List Name
Maximum Value for Optimum Start Time
Control Algorithm

AvailabilityManager:OptimumStart Outputs
The optimum start availability manager has one output variable.
Availability Manager Optimum Start Hours Before Occupancy
The unit is in hour.

Group Setpoint Managers

Setpoint Managers are one of the high-level control constructs in EnergyPlus. A Setpoint
Manager is able to access data from any of the HVAC system nodes and use this data to
calculate a setpoint (usually a temperature setpoint) for one or more other HVAC system
nodes. Setpoints are then used by Controllers or Plant or Condenser Loops as a goal for their
control actions.
Setpoint Managers are executed at the start of each HVAC timestep, and they reside outside
the HVAC system iteration loops. Thus, the Setpoint Managers are executed once per HVAC
timestep, and they use previous timestep information (except for zone load) to calculate their
setpoints.
The following situations require the use of a Setpoint Manager:
1) any use of Controller:WaterCoil; either in Temperature control only or 2 Setpoint
Managers for the " TemperatureAndHumidityRatio " control variable option.
2) use of Controller:OutdoorAir with Economizer Control Type set to anything but
NoEconomizer;
9/29/14

1595

Input-Output Reference

Group Setpoint Managers

3) use of Coil:Heating:Gas or Coil: Heating: Electric with the field Temperature Setpoint
Node Name set to a node name;
4) any use of CoilSystem:Cooling:DX;
5) any use of Humidifier:Steam:Electric.
6) Any use of PlantLoop or CondenserLoop which doesn't use an environment reference
such as AIR or GROUND as a set point
Setpoint managers will place a calculated or scheduled setpoint value on the setpoint node
and overwrite any previous value. This value may represent one of several control types
(e.g., Temperature, HumidityRatio, MassFlowRate, etc.). No two setpoint managers should
use the same setpoint node for like control types.
For the case when two setpoint managers place a setpoint on the same setpoint node (e.g., a
temperature setpoint placed on the same node by two different setpoint managers), the
setpoint value on the node is calculated by the last setpoint manager simulated. Within a
specific type of setpoint manager (e.g., Scheduled), the setpoint managers are simulated in
the order found in the input data file (idf) when viewed using a text editor. It is also possible
for two different types of setpoint managers to place setpoints of like control variable on the
same node. In this case, the order of simulation for the type of setpoint manager determines
which setpoint manager is the last to write a setpoint value to the node. This conflict in
setpoint node data is most likely to cause inaccurate simulation results. For this reason, a
conflicting setpoint node name warning message is issued so that the conflict can be
resolved. Duplicate setpoint node names found within a specific node list will not typically
cause problems with the simulation (the same value is written twice to the same node). In this
case a duplicate setpoint node name warning is issued, however, this could be an error in the
spelling of the node name and should be corrected.
Simulation order for setpoint managers:
SetpointManager:Scheduled
SetpointManager:Scheduled:DualSetpoint
SetpointManager:OutdoorAirReset
SetpointManager:SingleZone:Reheat
SetpointManager: SingleZone:Heating
SetpointManager: SingleZone:Cooling
SetpointManager: SingleZone:Humidity:Minimum
SetpointManager: SingleZone:Humidity:Maximum
SetpointManager:Warmest
SetpointManager:Coldest
SetpointManager:WarmestTemperatureFlow
SetpointManager:ReturnAirBypassFlow
SetpointManager:MultiZone:Cooling:Average
SetpointManager:MultiZone:Heating:Average
SetpointManager:MultiZone:MinimumHumidity:Average
SetpointManager:MultiZone:MaximumHumidity:Average
SetpointManager:MultiZone:Humidity:Minimum
SetpointManager:MultiZone:Humidity:Maximum
SetpointManager:FollowOutdoorAirTemperature
SetpointManager:FollowSystemNodeTemperature
SetpointManager:FollowGroundTemperature
SetpointManager:CondenserEnteringReset
SetpointManager:CondenserEnteringReset:Ideal
9/29/14

1596

Input-Output Reference

Group Setpoint Managers

SetpointManager:MixedAir
SetpointManager:OutdoorAirPretreat
SetpointManager:Scheduled
The simplest Setpoint Manager simply uses a schedule to determine one or more setpoints.
No node data is used as input. The input consists of the Setpoint Manager name, the control
variable, the schedule name, and the name of a node list. The node list contains the name of
those nodes at which the setpoint is to be applied. Of course, a node list name can always be
simply the name of a single node.
Note that although this object provides a very general method of setting the values of many
different control variables on nodes, the component models and system solvers may or may
not be able to use them. Therefore, it is important to understand that simply setting a control
variable using this object will not necessarily always produce the desired behavior.
Field: Name
A unique, user-assigned name for an instance of a scheduled setpoint manager. Anywhere in
the input that this setpoint manager is used, it is referred to by this name.
Field: Control Variable
The type of variable that will be controlled. There are several choices for this type of set point
manager. The most common control variable is Temperature but other major choices include:
HumidityRatio and MassFlowRate. The versatility of control variables available here
(probably) exceeds what is actually available in the component and systems models.
However, a large number of possible control variables are made available here for maximum
flexibility and because some (but not all) component models will be able to use them. The
complete list of key words and the units required in the associated schedules follow.
Temperature

Temperture of fluid at node (C)

MaximumTemperature

Maximum temperature of fluid at node (C)

MinimumTemperature

Minimum temperature of fluid at node (C)

HumidityRatio

Humidity ratio of fluid at node (kgWater/kgDryAir)

MaximumHumidityRatio Maximum humidity ratio of fluid at node (kgWater/kgDryAir)

MinimumHumidityRatio Minimum humidity ratio of fluid at node (kgWater/kgDryAir)
MassFlowRate

Mass flow rate of fluid at node (kg/s)

MaximumMassFlowRate

Maximum mass flow rate of fluid at node (kg/s)

MinimumMassFlowRate

Minimum mass flow rate of fluid at node (kg/s)

Field: Schedule Name

The name of a schedule whose values are to be used as setpoints on the node or node list.
The schedule value for each time period is the setpoint for this type of setpoint manager. The
schedule must have values that are in the appropriate units as defined in the previous field.
Field: Setpoint Node or NodeList Name
The name of a NodeList object containing the names of the HVAC system nodes or the
HVAC System Node Name for which setpoints will be established by this setpoint manager.
Following is an example of the input for a Scheduled Setpoint Manager.

9/29/14

1597

Input-Output Reference
SetpointManager:Scheduled,
Supply Air Temp Manager 1, !Temperature,
!Seasonal Reset Supply Air Temp
VAV Sys 1 Outlet Node;
!-

Group Setpoint Managers

Name
Control Variable
Sch, !- Schedule Name
Setpoint Node or NodeList Name

SetpointManager:Scheduled:DualSetpoint
This setpoint manager places a high and low schedule value on one or more nodes. The
input consists of the Setpoint Manager name, the control variable, the high and low set point
schedule names, and the name of a node list. The node list contains the name of those
nodes at which the setpoint is to be applied. Of course, a node list name can simply be the
name of a single node. Currently the DualSetpoint Manager will be used with PlantLoop when
the Plant Loop Demand Calculation Scheme is set to DualSetpointDeadband.
Field: Name
A unique, user-assigned name for an instance of this scheduled setpoint manager. Anywhere
in the input that this setpoint manager is used, it is referred to by this name.
Field: Control Variable
The type of variable that will be controlled. There is only one choice for this type of setpoint
manager: Temperature.
Field: High Setpoint Schedule Name
The name of a schedule that contains the high setpoint values. The schedule value for each
time period is the high setpoint for this type of setpoint manager.
Field: Low Setpoint Schedule Name
The name of a schedule that contains the low setpoint values. The schedule value for each
time period is the low setpoint for this type of setpoint manager.
Field: Setpoint Node or NodeList Name
The name of a NodeList object containing the names of the HVAC system nodes or the
HVAC System Node Name for which temperature setpoints will be established by this
setpoint manager.
Following is an example of the input for a SetpointManager:Scheduled:DualSetpoint object.
SetpointManager:Scheduled:DualSetpoint,
Water Loop Setpoint Manager,
!- Name
Temperature,
!- Control Variable
Plant Loop High Temp Schedule, !- High Setpoint Schedule Name
Plant Loop Low Temp Schedule,
!- Low Setpoint Schedule Name
Plant Supply Outlet Node;
!- Setpoint Node or NodeList Name

SetpointManager:OutdoorAirReset
The Outdoor Air Reset Setpoint Manager sets the supply air temperature according to the
outdoor air temperature using a reset rule. The reset rule is determined by 2 points: the
supply air setpoint temperature at the outdoor high temperature (SATOH) and the supply air
setpoint temperature at the outdoor low temperature (SATOL). If the outdoor temperature is
above the outdoor high temperature, the supply air temperature is set to SATOH. If the
outdoor temperature is below the outdoor low temperature, the supply air temperature is set
to SATOL. If the outdoor temperature is between the outdoor high and outdoor low
temperatures, the supply air temperature is linearly interpolated between SATOH and
SATOL.
The input consists of the setpoint manager name, the type of control variable, a node list
name of the nodes affected by the setpoint, and the data for the reset rule: the supply air
setpoint temperature at the outdoor low temperature, the outdoor low temperature, the supply
air setpoint temperature at the outdoor high temperature, and the outdoor high temperature.
9/29/14

1598

Input-Output Reference

Group Setpoint Managers

There are optional inputs for a second reset rule. First there is the name of a schedule that
indicates which rule to use: a schedule value of 1 means use the first rule; a schedule value
of 2 means use the second rule. Next, there are the 4 inputs specifying the second reset rule.
Field: Name
A unique, user-assigned name for an instance of an outdoor air reset setpoint manager.
Anywhere in the input that this setpoint manager is used, it is referred to by this name.
Field: Control Variable
The type of variable that will be controlled. There is only one choice for this type of setpoint
manager: Temperature.
Field: Setpoint at Outdoor Low Temperature
The supply air temperature setpoint in
rule.

oC

at the outdoor low temperature for the first reset

Field: Outdoor Low Temperature

The outdoor air low temperature in oC for the first supply air temperature reset rule.
Generally, at this outdoor air temperature the supply temperature is at its maximum.
Field: Setpoint at Outdoor High Temperature
The supply air temperature setpoint in
rule.

oC

at the outdoor high temperature for the first reset

Field: Outdoor High Temperature

The outdoor air high temperature in oC for the first supply air temperature reset rule.
Generally, at this outdoor air temperature the supply temperature is at its minimum.
Field: Setpoint Node or NodeList Name
The name of a NodeList object containing the names of the HVAC system nodes or the
HVAC System Node Name for which temperature setpoints will be established by this
setpoint manager.
Field: Schedule Name
The name of a schedule whose values indicate which reset rule to use. Schedule values of 1
indicate that the first reset rule will be used. Schedule values of 2 select the second reset
rule.
Field: Setpoint at Outdoor Low Temperature 2
The supply air temperature setpoint in oC at the outdoor low temperature for the second reset
rule.
Field: Outdoor Low Temperature 2
The outdoor air low temperature in oC for the second supply air temperature reset rule.
Generally, at this outdoor air temperature the supply temperature is at its maximum.
Field: Setpoint at Outdoor High Temperature 2
The supply air temperature setpoint in oC at the outdoor high temperature for the second
reset rule.
Field: Outdoor High Temperature 2
The outdoor air high temperature in oC for the second supply air temperature reset rule.
Generally, at this outdoor air temperature the supply temperature is at its minimum.
Below is an example of the input for an Outdoor Air Reset Setpoint Manager:

9/29/14

1599

Input-Output Reference

Group Setpoint Managers

SetpointManager:OutdoorAirReset,
Supply Air Temp Manager 1, !- Name
Temperature, !- Control Variable
16.7, !- Setpoint at Outdoor Low Temperature {C}
0.0,
!- Outdoor Low Temperature {C}
12.8, !- Setpoint at Outdoor High Temperature {C}
32.0, !- Outdoor High Temperature {C}
Supply Air Temp Nodes; !- Setpoint Node or NodeList Name
NodeList,
Supply Air Temp Nodes, !- Name
Air Loop Outlet Node; !- Node 1 Name

SetpointManager:SingleZone:Reheat
The Single Zone Reheat Setpoint Manager allows the simulation of a single zone reheat
system. This setpoint manager detects the control zone load, zone inlet node flow rate, and
zone node temperature and calculates a setpoint temperature for the supply air that will
satisfy the zone load for the control zone. This setpoint manager creates a variable
temperature system. The input consists of the setpoint manager name, the control variable
type, the minimum and maximum supply air temperatures, the name of the control zone, the
name of the control zone node, the name of the control zone inlet node, and the name of a
node or node list containing the nodes whose setpoint temperatures are to be set by this
manager.
Field: Name
A unique, user-assigned name for an instance of this setpoint manager. Anywhere in the
input that this setpoint manager is used, it is referred to by this name.
Field: Control Variable
The type of variable that will be controlled. There is only one choice for this type of setpoint
manager: Temperature.
Field: Minimum Supply Air Temperature
The minimum supply air temperature (in oC) that is allowed for this system (as set by this
setpoint manager).
Field: Maximum Supply Air Temperature
The maximum supply air temperature (in oC) that is allowed for this system (as set by this
setpoint manager)
Field: Control Zone Name
The name of the control zone for this single zone reheat system. The heating or cooling load
for this zone determines the supply air temperature setpoint.
Field: Zone Node Name
The name of the zone node for the control zone.
Field: Zone Inlet Node Name
The name of the zone inlet node that is supplying air to the control zone.
Field: Setpoint Node or NodeList Name
The name of a NodeList object containing the names of the HVAC system nodes or the
HVAC System Node Name for which temperature setpoints will be established by this
setpoint manager.
Below is an example input for a SetpointManager:SingleZone:Reheat object.

9/29/14

1600

Input-Output Reference

Group Setpoint Managers

SetpointManager:SingleZone:Reheat,
Supply Air Temp Manager, !- Name
Temperature, !- Control Variable
13., !- Minimum Supply Air Temperature {C}
45., !- Maximum Supply Air Temperature {C}
NORTH ZONE,
!- Control Zone Name
Zone 3 Node, !- Zone Node Name
Zone 3 Inlet Node, !- Zone Inlet Node Name
Supply Air Temp Nodes; !- Setpoint Node or NodeList Name
NodeList,
Supply Air Temp Nodes, !- Name
Heating Coil Air Inlet Node, !- Node 1 Name
Air Loop Outlet Node; !- Node 2 Name

SetpointManager:SingleZone:Heating
The Single Zone Heating Setpoint Manager allows a component to be controlled based on
the load required to meet the zone heating setpoint. Ths setpoint manager detects the control
zone load to meet the current heating setpoint, zone inlet node flow rate, and zone node
temperature, and calculates a setpoint temperature for the supply air that will satisfy the zone
heating load for the control zone. This setpoint manager creates a variable temperature
system. The input consists of the setpoint manager name, the controlled variable type, the
minimum and maximum supply air temperatures, the name of the control zone, the name of
the control zone node, the name of the control zone inlet node, and the name of a node or
node list containing the nodes whose setpoint temperatures are to be set by this manager.
Field: Name
A unique, user-assigned name for an instance of a single zone heating setpoint manager.
Anywhere in the input that this setpoint manager is used, it is referred to by this name.
Field: Control Variable
The type of variable that will be controlled. There is only one choice for this type of setpoint
manager: Temperature.
Field: Minimum Supply Air Temperature
The minimum supply air temperature (in oC) that is allowed for this system (as set by this
setpoint manager).
Field: Maximum Supply Air Temperature
The maximum supply air temperature (in oC) that is allowed for this system (as set by this
setpoint manager)
Field: Control Zone Name
The name of the control zone for this setpoint manager. The heating load for this zone (to
meet the zone heating setpoint) determines the supply air temperature setpoint.
Field: Zone Node Name
The name of the zone node for the control zone.
Field: Zone Inlet Node Name
The name of the zone inlet node that is supplying air to the control zone.
Field: Setpoint Node or NodeList Name
The name of a NodeList object containing the names of the HVAC system nodes or the
HVAC System Node Name for which temperature setpoints will be established by this
setpoint manager.
Below is an example input for a SetpointManager:SingleZone:Heating object.
9/29/14

1601

Input-Output Reference

Group Setpoint Managers

SetpointManager:SingleZone:Heating,
Zone 1 Heating Supply Air Temp Manager, !- Name
Temperature,
!- Control Variable
7.22,
!- Minimum Supply Air Temperature {C}
45.,
!- Maximum Supply Air Temperature {C}
Zone 1,
!- Control Zone Name
Zone 1 Zone Node,
!- Zone Node Name
Zone 1 Supply Inlet,
!- Zone Inlet Node Name
Zone 1 Heating Coil Outlet; !- Setpoint Node or NodeList Name

SetpointManager:SingleZone:Cooling
The Single Zone Cooling Setpoint Manager allows a component to be controlled based on
the load required to meet the zone cooling setpoint. This setpoint manager detects the control
zone load to meet the current cooling setpoint, zone inlet node flow rate, and zone node
temperature, and calculates a setpoint temperature for the supply air that will satisfy the zone
cooling load for the control zone. This setpoint manager creates a variable temperature
system. The input consists of the setpoint manager name, the controlled variable type, the
minimum and maximum supply air temperatures, the name of the control zone, the name of
the control zone node, the name of the control zone inlet node, and the name of a node or
node list containing the nodes whose setpoint temperatures are to be set by this manager.
Field: Name
A unique, user-assigned name for an instance of a single zone cooling setpoint manager.
Anywhere in the input that this setpoint manager is used, it is referred to by this name.
Field: Control Variable
The type of variable that will be controlled. There is only one choice for this type of setpoint
manager: Temperature.
Field: Minimum Supply Air Temperature
The minimum supply air temperature (in oC) that is allowed for this system (as set by this
setpoint manager).
Field: Maximum Supply Air Temperature
The maximum supply air temperature (in oC) that is allowed for this system (as set by this
setpoint manager)
Field: Control Zone Name
The name of the control zone for this setpoint manager. The cooling load of this zone (to
meet the zone cooling set point) determines the supply air temperature setpoint.
Field: Zone Node Name
The name of the zone node for the control zone.
Field: Zone Inlet Node Name
The name of the zone inlet node that is supplying air to the control zone.
Field: Setpoint Node or NodeList Name
The name of a Node List object containing the names of the HVAC system nodes or the
HVAC System Node Name for which temperature setpoints will be established by this
setpoint manager.
Below is an example input for a SetpointManager:SingleZone:Cooling object.

9/29/14

1602

Input-Output Reference

Group Setpoint Managers

SetpointManager:SingleZone:Cooling,
Zone 1 Cooling Supply Air Temp Manager, !- Name
Temperature,
!- Control Variable
7.22,
!- Minimum Supply Air Temperature {C}
45.,
!- Maximum Supply Air Temperature {C}
Zone 1,
!- Control Zone Name
Zone 1 Zone Node,
!- Zone Node Name
Zone 1 Supply Inlet,
!- Zone Inlet Node Name
Zone 1 Cooling Coil Outlet; !- Setpoint Node or NodeList Name

SetpointManager:SingleZone:Humidity:Minimum
The Single Zone Minimum Humidity Setpoint Manager allows the control of a single zone
minimum humidity level. This setpoint manager detects the humidity level in a control zone
and, using air and moisture mass balance, calculates the supply air humidity ratio needed to
maintain the zone relative humidity at or above a given setpoint. The calculated supply air
humidity ratio is then used as the setpoint for the designated setpoint node. A humidifier
component placed upstream of the setpoint node can then use the humidity ratio setpoint to
control its moisture addition rate.
The use of this object requires that a ZoneControl:Humidistat object be specified with a
humidifying relative humidity schedule for the controlling zone. The humidistats controlling
zone must correspond with the control zone air node name specified in this setpoint
manager.
Field: Name
A unique, user-assigned name for an instance of a single zone minimum humidity setpoint
manager. Anywhere in the input that this setpoint manager is used, it is referred to by this
name.
Field: Control Variable
Deprecated Field. This field is not used and will be deleted in a future release.
Field: Schedule Name
Deprecated Field. This field is not used and will be deleted in a future release.
Field: Setpoint Node or NodeList Name
The name of the HVAC system node where the calculated humidity ratio setpoint is set. If the
setpoint is being placed on more than one node, this input should be the name of a NodeList.
Field: Control Zone Air Node Name
The name of the zone node for the humidity control zone (as specified in the object
ZoneHVAC:EquipmentConnections).
An IDF example for this setpoint manager is shown below with the required humidistat:

9/29/14

1603

Input-Output Reference

Group Setpoint Managers

SetpointManager:SingleZone:Humidity:Minimum,
Zone Min Set Point Manager, !- Name
, !- Control Variable
, !- Schedule Name
Air Loop Outlet Node, !- Setpoint Node or NodeList Name
Zone 2 Node;
!- Control Zone Air Node Name
ZoneControl:Humidistat,
Zone 2 Humidistat,
ZONE 2,
Min rel Hum Set Sch2;

!- Name
!- Zone Name
!- Humidifying Relative Humidity Setpoint Schedule Name

SetpointManager:SingleZone:Humidity:Maximum
The Single Zone Maximum Humidity Setpoint Manager allows the control of a single zone
maximum humidity level. This setpoint manager, used in conjunction with object
ZoneControl:Humidistat, detects the air humidity level in a single control zone and uses
air/moisture mass balances to calculate the supply air humidity ratio needed to maintain the
zone relative humidity at or below a given setpoint. The calculated supply air humidity ratio is
then used as the setpoint for the designated setpoint node. A dehumidification component
placed upstream of this node can then use the humidity ratio setpoint to control its moisture
removal rate (e.g., desiccant dehumidifiers).
In the case of a chilled water coil which is used for both temperature and high humidity
control, this setpoint manager works in conjunction with a Controller:WaterCoil object to
determine the minimum supply air temperature required to meet both the temperature
(sensible) and humidity (latent) load in the control zone. See object Controller:WaterCoil in
the EnergyPlus Engineering Reference for a detailed discussion of how this is achieved.
The use of this object requires that a ZoneControl:Humidistat object be specified with a
relative humidity setpoint schedule for the controlling zone. The humidistats controlling zone
must correspond with the control zone air node name specified in this setpoint manager..
Field: Name
A unique, user-assigned name for an instance of a single zone maximum humidity setpoint
manager. Anywhere in the input that this setpoint manager is used, it is referred to by this
name.
Field: Control Variable
Deprecated Field. This field is not used and will be deleted in a future release.
Field: Schedule Name
Deprecated Field. This field is not used and will be deleted in a future release.
Field: Setpoint Node or NodeList Name
The name of the HVAC system node where the calculated humidity ratio setpoint is set. If the
setpoint is being placed on more than one node, this input should be the name of a NodeList.
Field: Control Zone Air Node Name
The name of the zone air node for the humidity control zone (as specified in the object
ZoneHVAC:EquipmentConnections).
An example of this object in an input data file (IDF), along with a temperature set point
manager, humidistat, and a simple controller, is shown below:

9/29/14

1604

Input-Output Reference

Group Setpoint Managers

SetpointManager:SingleZone:Humidity:Maximum,
Zone Max Set Point Manager,
!- Name
,
!- Control Variable
,
!- Schedule Name
VAV Sys 1 Outlet Node,
!- Setpoint Node or NodeList Name
Zone 2 Node;
!- Control Zone Air Node Name
SetpointManager:Scheduled,
Scheduled Set Point Manager 1,
Temperature,
Seasonal Reset Supply Air Temp Sch,
VAV Sys 1 Outlet Node;
ZoneControl:Humidistat,
Zone 2 Humidistat,
ZONE 2,
Min rel Hum Set Sch2;

!!!!-

Name
Control Variable
Schedule Name
Setpoint Node or NodeList Name

!- Name
!- Zone Name
!- Humidifying Relative Humidity Setpoint Schedule Name

Controller:WaterCoil,
Central Cooling Coil Contoller 1,
TEMPandHUMRAT,
Reverse,
FLOW,
VAV Sys 1 Outlet Node,
Main Cooling Coil 1 Water Inlet Node,
0.002,
0.025,
0.0;

!!!!!!!!!-

Name
Control Variable
Action
Actuator Variable
Sensor Node Name
Actuator Node Name
Controller Convergence Tolerance {deltaC}
Maximum Actuated Flow {m3/s}
Minimum Actuated Flow {m3/s}

SetpointManager:MixedAir
The Mixed Air Setpoint Manager is meant to be used in conjunction with a
Controller:OutdoorAir object. This setpoint manager is used to establish a temperature
setpoint at the mixed air node. The Controller:OutdoorAir then operates the outdoor air
damper to attempt to meet this setpoint.
In EnergyPlus the relief and outdoor air dampers, the economizer, and any outdoor air
conditioning equipment form a separate subsystem of an air loop system (ref. AirLoopHVAC).
The outdoor air controller operates within the subsystem. Consequently the mixed air
temperature setpoint must take into account any downstream system fan heat if it is to meet
a desired system supply air leaving temperature. The Mixed Air Setpoint Manager
accomplishes this by referencing a supply air setpoint set by another setpoint manager (most
likely at the AirLoopHVAC outlet node). The supply fan inlet and outlet nodes are also inputs
to the Mixed Air Setpoint Manager. From this information the Mixed Air Setpoint Manager
calculates the supply fan air temperature rise, subtracts it from the reference setpoint
temperature, and sets the result as the mixed air node setpoint temperature.
Of course any type of setpoint manager can be used to establish a temperature setpoint at
the mixed air node. But the Mixed Air Setpoint Manager is likely to be the most useful.
Field: Name
A unique, user-assigned name for an instance of a mixed air setpoint manager. Anywhere in
the input that this setpoint manager is used, it is referred to by this name.
Field: Control Variable
The type of variable that will be controlled. There is only one choice for this type of setpoint
manager: Temperature.
Field: Reference Setpoint Node Name
The name of an HVAC system node where the system supply air temperature is set.
Normally this would be the AirLoopHVAC outlet node. The temperature setpoint at this
reference node is set by a different setpoint manager.

9/29/14

1605

Input-Output Reference

Group Setpoint Managers

Field: Fan Inlet Node Name

The name of the supply fan inlet node.
Field: Fan Outlet Node Name
The name of the supply fan outlet node.
Field: Setpoint Node or NodeList Name
The name of a NodeList object containing the names of the HVAC system nodes or the
HVAC System Node Name where temperature setpoints will be established by this setpoint
manager.
Below is an example input for a Mixed Air Setpoint Manager.
SetpointManager:SingleZone:Reheat, ! establishes the setpoint at the system outlet node
Supply Air Temp Manager, !- Name
Temperature, !- Control Variable
13., !- Minimum Supply Air Temperature
45., !- Maximum Supply Air Temperature
NORTH ZONE, !- Control Zone Name
Zone 3 Node, !- Zone Node Name
Zone 3 Inlet Node, !- Zone Inlet Node Name
Supply Air Temp Nodes; !- Setpoint Node or NodeList Name
SetpointManager:MixedAir, ! uses the system outlet setpoint to establish the mixed air setpoint
Mixed Air Temp Manager 1, !- Name
Temperature, !- Control Variable
Air Loop Outlet Node,
!- Reference Setpoint Node Name
Heating Coil Air Outlet Node, !- Fan Inlet Node Name
Air Loop Outlet Node,
!- Fan Outlet Node Name
Mixed Air Nodes;
!- Setpoint Node or NodeList Name
NodeList, Supply Air Temp Nodes,
Air Loop Outlet Node; ! Setpoint Nodes
NodeList, Mixed Air Nodes,
Mixed Air Node; ! Setpoint Nodes

SetpointManager:OutdoorAirPretreat
The OutdoorAir Pretreat Setpoint Manager is meant to be used in conjunction with an
OutdoorAir:Mixer object. The Outdoor air Pretreat Setpoint Manager is used to establish a
temperature or humidity ratio setpoint in the outdoor air stream flowing into the "Outdoor Air
Stream Node" of an OutdoorAir:Mixer object. This setpoint manager determines the required
setpoint in the outdoor air stream to produce the reference setpoint in the mixed air stream
after mixing with return air. For example, if the temperature setpoint at the mixed air node is
15C, the return air temperature is 20C, and the outdoor air flow fraction is 0.5, the Outdoor
Air Pretreat setpoint would be set to 10C.
Of course any type of setpoint manager can be used to establish setpoints in the outdoor air
stream, but this setpoint manager is likely to be the most useful for systems which
precondition outdoor air with equipment such as a DX cooling coil or desiccant dehumidifier.
Field: Name
A unique, user-assigned name for an instance of an outdoor air pretreat setpoint manager.
Anywhere in the input that this setpoint manager is used, it is referred to by this name.
Field: Control Variable
The type of variable that will be controlled. The choices are:
Temperature references and sets the "System Node Setpoint Temperature" property.
This single temperature setpoint is set and used by all temperature setpoint managers
and equipment controls except dual-setpoint equipment.

9/29/14

1606

Input-Output Reference

Group Setpoint Managers

MaximumHumidityRatio references and sets the "System Node Humidity Ratio Max"
property.
This
type
of
reference
setpoint
may
be
set
using
SetpointManager:SingleZone:Humidity:Maximum,
SetpointManager:MultiZone:MaximumHumidity:Average,
or
SetpointManager:MultiZone:Humidity:Maximum and is used by equipment such as
Controller:WaterCoil (with control variable TemperatureAndHumidityRatio) and
Dehumidifier:Desiccant:NoFans.
MinimumHumidityRatio references and sets the "System Node Humidity Ratio Min"
property.
This
type
of
reference
setpoint
may
be
set
using
SetpointManager:SingleZone:Humidity:Minimum,
SetpointManager:Multizone:MinimumHumidity:Average
or
SetpointManager:MultiZone:Humidity:Minimum and is used by equipment such as
Humidifier:Steam:Electric.
HumidityRatio references and sets the "System Node Setpoint Humidity Ratio"
property. This type of reference setpoint may be set using (no applicable setpoint
managers at this time) and is used by equipment such as Controller:WaterCoil (with
control variable HumidityRatio).
The system node properties listed above are all available as an Output:Variable to facilitate
tracking these setpoints both at the reference node and the setpoint nodes.
Field: Minimum Setpoint Temperature
The minimum temperature (in oC) that is allowed by this setpoint manager. Applicable only if
Control variable is Temperature.
Field: Maximum Setpoint Temperature
The maximum temperature (in oC) that is allowed by this setpoint manager. Applicable only if
Control variable is Temperature.
Field: Minimum Setpoint Humidity Ratio
The minimum humidity ratio (kgWater/kgDryAir) that is allowed by this setpoint manager.
Applicable only if Control variable is MaximumHumidityRatio, MinimumHumidityRatio, or
HumidityRatio. Note that zero is not allowed as the computed setpoint humidity ratio,
because zero is used as a special value to indicate that no humidification or dehumidification
is needed. If the reference humidity ratio setpoint value is zero, the zero value will be passed
directly to the Set Point Node(s).
Field: Maximum Setpoint Humidity Ratio
The maximum humidity ratio (kgWater/kgDryAir) that is allowed by this set point manager.
Applicable only if Control variable is MaximumHumidityRatio, MinimumHumidityRatio, or
HumidityRatio.
Field: Reference Setpoint Node Name
The name of an HVAC system node where the desired mixed air condition has been set.
Normally this would be the mixed air node leaving the OutdoorAir:Mixer. The temperature or
humidity setpoint at this reference node must be set by a different setpoint manager of the
appropriate type (see Control Variable above).
Field: Mixed Air Stream Node Name
The name of the mixed air node. This node is used to obtain the flow rate of the combined air
stream. This node is usually the same node at the Reference Setpoint Node Name, but does
not have to be.

9/29/14

1607

Input-Output Reference

Group Setpoint Managers

Field: Outdoor Air Stream Node Name

The name of a node in the outdoor air stream. This node is used to obtain the flow rate of the
outdoor air stream.
Field: Return Air Stream Node Name
The name of a node in the return air stream. This node is used to obtain the flow rate of the
return air stream.
Field: Setpoint Node or NodeList Name
The name of a NodeList object containing the names of the HVAC system nodes or the
HVAC System Node Name for which temperature or humidity ratio setpoints will be
established by this setpoint manager.
Below is an example input for an Outdoor Air Pretreat Setpoint Manager.
SetpointManager:OutdoorAirPretreat,
DXSystem 1 Desiccant Set Point Manager, !- Name
MaximumHumidityRatio,
!- Control Variable
-99,
!- Minimum Setpoint Temperature {C}
99,
!- Maximum Setpoint Temperature {C}
0.00001,
!- Minimum Setpoint Humidity Ratio (kgWater/kgDryAir)
1.0,
!- Maximum Setpoint Humidity Ratio (kgWater/kgDryAir)
DXSystem 1 Fan Air Inlet Node, !- Reference Setpoint Node Name
DXSystem 1 Mixed Air Node,
!- Mixed Air Stream Node Name
Heat Recovery Outlet Node,
!- Outdoor Air Stream Node Name
DXSystem 1 Air Loop Inlet Node, !- Return Air Stream Node Name
Desiccant Process Outlet Node; !- Setpoint Node or NodeList Name

SetpointManager:Warmest
The Warmest Setpoint Manager resets the cooling supply air temperature of a central forced
air HVAC system according to the cooling demand of the warmest zone. For each zone in the
system at each system timestep, the manager calculates a supply air temperature that will
meet the zone cooling load at the maximum zone supply air flow rate. The lowest of the
possible supply air temperatures becomes the new supply air temperature setpoint, subject to
minimum and maximum supply air temperature constraints. The resulting temperature
setpoint is the highest supply air temperature that will meet the cooling requirements of all the
zones. When compared to a fixed cooling supply air temperature setpoint, this strategy
minimizes zone reheat coil energy (or overcooling) and central chiller energy consumption (if
the chilled water temperature is also reset) at the cost of possible increased fan energy.
Field: Name
A unique, user-assigned name for an instance of a warmest setpoint manager. Anywhere in
the input that this setpoint manager is used, it is referred to by this name.
Field: Control Variable
The type of variable that will be controlled. Currently there is only one choice: Temperature.
Field: HVAC Air Loop Name
The name of the AirLoopHVAC object (the central air system) which will use this setpoint
manager to set its cooling supply air temperature.
Field: Minimum Setpoint Temperature
The minimum allowed setpoint temperature in degrees C. If the calculated setpoint
temperature is less than this minimum, the setpoint is set to the minimum.

9/29/14

1608

Input-Output Reference

Group Setpoint Managers

Field: Maximum Setpoint Temperature

The maximum allowed setpoint temperature in degrees C. If the calculated setpoint is greater
than this value the setpoint is set to the maximum. This value is also used as the setpoint
temperature when none of the zones have a cooling load.
Field: Strategy
Currently, the only choice for this field is MaximumTemperature.
Field: Setpoint Node or NodeList Name
The name of a NodeList object containing the names of the HVAC system nodes or the
HVAC System Node Name for which temperature setpoints will be established by this
setpoint manager.
Below is an example input for a Warmest Setpoint Manager.
SetpointManager:Warmest,
Supply Air Temperature Manager 1, !- Name
Temperature, !- Control Variable
VAV Sys 1, !- HVAC Air Loop Name
11.2, !- Minimum Setpoint Temperature
16., !- Maximum Setpoint Temperature
MaximumTemperature, !- Strategy
Supply Air Temp Nodes 1; !- Setpoint Node or NodeList Name
SetpointManager:MixedAir,
Mixed Air Temp Manager 1, !- Name
Temperature, !- Control Variable
VAV Sys 1 Outlet Node, !- Reference Setpoint Node Name
Main Heating Coil 1 Outlet Node, !- Fan Inlet Node Name
VAV Sys 1 Outlet Node, !- Fan Outlet Node Name
Mixed Air Node 1;
!- Setpoint Node or NodeList Name
NodeList, Supply Air Temp Nodes 1,
VAV Sys 1 Outlet Node; ! Setpoint Node

SetpointManager:Coldest
The Coldest Setpoint Manager is used in dual duct systems to reset the setpoint temperature
of the air in the heating supply duct. Usually it is used in conjunction with a
SetpointManager:Warmest resetting the temperature of the air in the cooling supply duct. For
each zone in the system at each system timestep, the manager calculates a supply air
temperature that will meet the zone heating load at the maximum zone supply air flow rate.
The highest of the possible supply air temperatures becomes the new supply air temperature
setpoint, subject to minimum and maximum supply air temperature constraints. The resulting
temperature setpoint is the lowest supply air temperature that will meet the heating
requirements of all the zones. When compared to a fixed heating supply air temperature
setpoint, this strategy minimizes central boiler energy consumption (if the hot water
temperature is also reset or there are variable speed pumps) at the cost of possible
increased fan energy (if there is variable volume control in the air system).
Field: Name
A unique, user-assigned name for an instance of a coldest setpoint manager. Anywhere in
the input that this setpoint manager is used, it is referred to by this name.
Field: Control Variable
The type of variable that will be controlled. Currently there is only one choice: Temperature.
Field: HVAC Air Loop Name
The name of the AirLoopHVAC object (the central air system) which will use this setpoint
manager to set its heating supply air temperature.

9/29/14

1609

Input-Output Reference

Group Setpoint Managers

Field: Minimum Setpoint Temperature

The minimum allowed setpoint temperature in degrees C. If the calculated setpoint
temperature is less than this minimum, the setpoint is set to the minimum. This value is also
used as the setpoint temperature when none of the zones have a heating load.
Field: Maximum Setpoint Temperature
The maximum allowed setpoint temperature in degrees C. If the calculated setpoint is greater
than this value the setpoint is set to the maximum.
Field: Strategy
Currently, the only choice for this field is MinimumTemperature.
Field: Setpoint Node or NodeList Name
The name of a NodeList object containing the names of the HVAC system nodes or the
HVAC System Node Name for which temperature setpoints will be established by this
setpoint manager.
Below is an example input for a Coldest Setpoint Manager.

9/29/14

1610

Input-Output Reference

Group Setpoint Managers

Controller:Simple,
Central Cooling Coil Controller 1, !- Name
Temperature, !- Control Variable
Reverse, !- Action
Flow,
!- Actuator Variable
VAV Sys 1 Cold Outlet Node,
!- Sensor Node Name
Main Cooling Coil 1 Water Inlet Node, !- Actuator Node Name
0.001,
!- Controller Convergence Tolerance {deltaC}
autosize, !- Maximum Actuated Flow {m3/s}
0.0;
!- Minimum Actuated Flow {m3/s}
Controller:WaterCoil,
Central Heating Coil Controller 1, !- Name
Temperature, !- Control Variable
Normal, !- Action
Flow,
!- Actuator Variable
VAV Sys 1 Hot Outlet Node,
!- Sensor Node Name
Main Heating Coil 1 Water Inlet Node, !- Actuator Node Name
0.001,
!- Controller Convergence Tolerance {deltaC}
autosize, !- Maximum Actuated Flow {m3/s}
0.0;
!- Minimum Actuated Flow {m3/s}
SetpointManager:Warmest,
Supply Air Temperature Manager 1, !- Name
Temperature,
!- Control Variable
VAV Sys 1, !- HVAC Air Loop Name
11.2,
!- Minimum Setpoint Temperature {C}
16.,
!- Maximum Setpoint Temperature {C}
MaximumTemperature,
!- Strategy
Supply Air Temp Nodes 1; !- Setpoint Node or NodeList Name
NodeList,
Supply Air Temp Nodes 1,
VAV Sys 1 Cold Outlet Node;

!- Name
!- Node 1 Name

SetpointManager:Coldest,
Supply Air Temperature Manager 2, !- Name
Temperature,
!- Control Variable
VAV Sys 1, !- HVAC Air Loop Name
25.,
!- Minimum Setpoint Temperature {C}
50.,
!- Maximum Setpoint Temperature {C}
MinimumTemperature,
!- Strategy
Supply Air Temp Nodes 2; !- Setpoint Node or NodeList Name
NodeList,
Supply Air Temp Nodes 2,
VAV Sys 1 Hot Outlet Node;

!- Name
!- Node 1 Name

SetpointManager:ReturnAirBypassFlow
This manager is user in conjunction with a return air bypass configuration. This type of air
system is basically a standard single duct system with the addition of a bypass duct that
bypasses return air around the main system components in particular, the central cooling
coil. This allows the central cooling coil to sufficiently dehumidify the mixed air; the bypassed
air is then added to the supply air stream to bring the supply air temperature up to the desired
temperature set point. This scheme is very useful in situations where an higher than normal
supply air temperature is used for instance, in underfloor air distribution systems.
This manager relies on the program to figure out the system configuration and to extract the
needed data from the system nodes. All the user needs to input is the name of the air system
and a schedule giving the desired supply air temperature setpoint. No node names are
required. The manager will establish a bypass air flow rate that upon mixing with the nonbypassed air will yield the temperature given in the schedule.

9/29/14

1611

Input-Output Reference

Group Setpoint Managers

Field: Name
A unique, user-assigned name for an instance of an Return Air Bypass Flow setpoint
manager. Anywhere in the input that this setpoint manager is used, it is referred to by this
name.
Field: Control Variable
The type of variable that will be controlled. Currently there is only one choice: Flow.
Field: HVAC Air Loop Name
The name of the AirLoopHVAC object (the central air system) which will use this setpoint
manager to set its return air bypass flow rate.
Field: Temperature Setpoint Schedule Name
The name of a schedule whose values are temperatures in oC. The schedule value for the
time period is the setpoint for this type of setpoint manager. The setpoint is assumed to be at
the air handler outlet.
The following shows an example input for SetpointManager:ReturnAirBypassFlow.
SetpointManager:ReturnAirBypassFlow,
RETURN AIR BYPASS Manager 1, !- Name
Flow, !- Control Variable
VAV Sys 1, !- HVAC Air Loop Name
Seasonal Reset Supply Air Temp Sch; !- Temperature Setpoint Schedule Name

SetpointManager:WarmestTemperatureFlow
The Warmest Temperature Flow Setpoint Manager resets the cooling supply air temperature
of a central forced air HVAC system according to the cooling demand of the warmest zone.
The user can select one of two strategies: TemperatureFirst or FlowFirst.
For TemperatureFirst the manager tries to find the highest setpoint temperature that will
satisfy all the zone cooling loads at minimum supply air flow rate. If this setpoint temperature
is less than the minimum, the setpoint temperature is set to the minimum, and the supply air
flow rate is increased to meet the loads.
For FlowFirst the manager tries to find the lowest supply air flow rate that will satisfy all the
zone cooling loads at the maximum setpoint temperature. If this flow is greater than the
maximum, the flow is set to the maximum and the setpoint temperature is reduced to satisfy
the cooling loads.
When compared to a fixed cooling supply air temperature setpoint, the TemperatureFirst
strategy minimizes fan energy at the cost of possible increased zone reheat coil energy (or
overcooling) and central chiller energy consumption, whereas the FlowFirst strategy
minimizes zone reheat coil energy (or overcooling) and central chiller energy consumption at
the cost of possible increased fan energy.
Field: Name
A unique, user-assigned name for an instance of this setpoint manager. Anywhere in the
input that this setpoint manager is used, it is referred to by this name.
Field: Control Variable
The type of variable that will be controlled. For this setpoint manager, this input should be
Temperature.
Field: HVAC Air Loop Name
he name of the AirLoopHVAC object (the central air system) which will use this setpoint
manager to set its cooling supply air temperature.

9/29/14

1612

Input-Output Reference

Group Setpoint Managers

Field: Minimum Setpoint Temperature

The minimum allowed setpoint temperature in degrees C. If the calculated setpoint
temperature is less than this minimum, the setpoint is set to the minimum.
Field: Maximum Setpoint Temperature
The maximum allowed setpoint temperature in degrees C. If the calculated setpoint is greater
than this value the setpoint is set to the maximum. This value is also used as the setpoint
temperature when none of the zones have a cooling load.
Field: Strategy
The choices for this field are TemperatureFirst and FlowFirst. See discussion above for a
description of what each strategy does.
Field: Setpoint Node or NodeList Name
The name of a NodeList object containing the names of the HVAC system nodes or the
HVAC System Node Name for which temperature setpoints will be established by this
setpoint manager.
Field: Minimum Turndown Ratio
The minimum value of the ratio of the actual air flow rate to the maximum air flow rate, either
for the supply fan if there are no VAV terminal boxes, or for the VAV boxes if present. If there
are VAV boxes, it is assumed that the same value of minimum turndown applies to all boxes.
Below is an example input for a SetpointManager:WarmestTemperatureFlow object.
SetpointManager:WarmestTemperatureFlow,
Supply Air Temperature Manager 1, !- Name
Temperature, !- Control Variable
VAV Sys 1, !- HVAC Air Loop Name
11.2, !- Minimum Setpoint Temperature
16.,
!- Maximum Setpoint Temperature
TemperatureFirst, !- Strategy
Supply Air Temp Nodes 1, !- Setpoint Node or NodeList Name
0.3; !- Minimum Turndown Ratio
SetpointManager:MixedAir,
Mixed Air Temp Manager 1, !- Name
Temperature, !- Control Variable
VAV Sys 1 Outlet Node, !- Reference Setpoint Node Name
Main Heating Coil 1 Outlet Node, !- Fan Inlet Node Name
VAV Sys 1 Outlet Node, !- Fan Outlet Node Name
Mixed Air Node 1; !- Setpoint Node or NodeList Name
NodeList, Supply Air Temp Nodes 1,
VAV Sys 1 Outlet Node; ! Set Point Node

SetpointManager:WarmestTemperatureFlow Outputs
Setpoint Manager Warmest Temperature Critical Zone Number []
This is the number of the zone that was the critical zone for the setpoint manager.
Setpoint Manager Warmest Temperature Turndown Flow Fraction []
This is the fraction that flow was reduced by the setpoint manager. This is the actual air flow
rate divided by the maximum air flow rate.
SetpointManager:MultiZone:Cooling:Average
This setpoint manager is used to establish a supply air temperature setpoint for a central
forced air HVAC system (air loop) based on the predicted sensible cooling loads and actual
supply air mass flow rates for all zones served by the system. For all controlled zones in the
air loop (i.e., zones with a thermostat object), the setpoint manager calculates an average
9/29/14

1613

Input-Output Reference

Group Setpoint Managers

supply air temperature that will meet the zone cooling loads based on the actual zone supply
air mass flow rates (lagged by one time step). The calculated setpoint temperature is subject
to the minimum and maximum setpoint temperature constraints specified by the user. When
compared to a fixed cooling supply air temperature setpoint, this strategy may reduce zone
reheat coil energy (or overcooling) and central chiller energy consumption (if the chilled water
temperature is also reset) at the cost of possible increased fan energy.
Field: Name
A unique, user-assigned name for an instance of this multizone average cooling setpoint
manager. Anywhere in the input that this setpoint manager is used, it is referred to by this
name.
Field: HVAC Air Loop Name
The name of the AirLoopHVAC object (the central air system) which will use this setpoint
manager to set its cooling supply air temperature.
Field: Minimum Setpoint Temperature
The minimum allowed setpoint temperature in degrees C. If the calculated setpoint
temperature is less than this minimum, the setpoint is set to the minimum. The default value
is 12C.
Field: Maximum Setpoint Temperature
The maximum allowed setpoint temperature in degrees C. If the calculated setpoint
temperature is greater than this value, the setpoint is set to this maximum value. The default
value is 18C.
Field: Setpoint Node or NodeList Name
The name of a NodeList object containing the names of the HVAC system nodes, or the
HVAC System Node Name, for which temperature setpoints will be established by this
setpoint manager.
Below is an example of this object in an input file.
SetpointManager:MultiZone:Cooling:Average,
Cooling Coil Air Sys Branch Set Point, !- Name
Main Dual Duct Air Loop, !- HVAC Air Loop Name
12.0,
!- Minimum Setpoint Temperature {C}
22.0,
!- Maximum Setpoint Temperature {C}
Cooling Coil Supply Air Temp Nodes; !- Setpoint Node or NodeList Name

SetpointManager:MultiZone:Heating:Average
This setpoint manager is used to establish a supply air temperature setpoint for a central
forced air HVAC system (air loop) based on the predicted sensible heating loads and actual
supply air mass flow rates for all zones served by the system. For all controlled zones in the
air loop (i.e., zones with a thermostat object), the setpoint manager calculates an average
supply air temperature that will meet the zone heating loads based on the actual zone supply
air mass flow rates (lagged by one time step). The calculated setpoint temperature is subject
to the minimum and maximum setpoint temperature constraints specified by the user. When
compared to a fixed heating supply air temperature setpoint, this strategy may reduce central
boiler energy consumption (if the hot water temperature is also reset or there are variable
speed pumps) at the cost of possible increased fan energy (if there is variable volume control
for the air system).
Field: Name
A unique, user-assigned name for an instance of a multizone average heating setpoint
manager. Anywhere in the input that this setpoint manager is used, it is referred to by this
name.
9/29/14

1614

Input-Output Reference

Group Setpoint Managers

Field: HVAC Air Loop Name

The name of the AirLoopHVAC object (the central air system) which will use this setpoint
manager to set its heating supply air temperature.
Field: Minimum Setpoint Temperature
The minimum allowed setpoint temperature in degrees C. If the calculated setpoint
temperature is less than this minimum, the setpoint is set to the minimum. The default value
is 20C.
Field: Maximum Setpoint Temperature
The maximum allowed setpoint temperature in degrees C. If the calculated setpoint
temperature is greater than this value, the setpoint is set to this maximum value. The default
value is 50C.
Field: Setpoint Node or NodeList Name
The name of a NodeList object containing the names of the HVAC system nodes, or the
HVAC System Node Name, for which temperature setpoints will be established by this
setpoint manager.
Below is an example of this object in an input file.
SetpointManager:MultiZone:Heating:Average,
Heating Coil Air Sys Branch Set Point, !- Name
Main Dual Duct Air Loop, !- HVAC Air Loop Name
24.0,
!- Minimum Setpoint Temperature {C}
41.0,
!- Maximum Setpoint Temperature {C}
Heating Coil Supply Air Temp Nodes; !- Setpoint Node or NodeList Name

SetpointManager:MultiZone:MinimumHumidity:Average
This setpoint manager allows for controlling the minimum humidity level is multiple zones
served by a central forced air HVAC system (air loop). This setpoint manager, used in
conjunction with one or more ZoneControl:Humidistat objects, detects the air humidity level in
multiple controlled zones served by the HVAC air loop and uses air/moisture mass balances
to calculate an average supply air humidity ratio needed to maintain the zone relative
humidity levels near their respective humidifying setpoints. The calculated humidity ratio is
then used as the minimum humidity ratio setpoint for the designated setpoint node(s). A
humidification component (e.g., Humidifier:Steam:Electric) placed upstream of the setpoint
node can then use the minimum humidity ratio setpoint to control humidification rate. The use
of this object requires that a ZoneControl:Humidistat object be specified with a humidifying
relative humidity schedule for one or more controlled zones served by the HVAC air loop.
Field: Name
A unique, user-assigned name for an instance of an average minimum humidity (humidifying)
multizone setpoint manager. Anywhere in the input that this setpoint manager is used, it is
referred to by this name.
Field: HVAC Air Loop Name
The name of the AirLoopHVAC object (the central air system) which will use this setpoint
manager to set its humidification setpoint (minimum air humidity ratio).
Field: Minimum Setpoint Humidity Ratio
The minimum humidity ratio (kgWater/kgDryAir) that is allowed by this setpoint manager. If
the calculated setpoint humidity ratio is less than this value, then the setpoint is set to this
minimum value. The default value is 0.005 (kgWater/kgDryAir).

9/29/14

1615

Input-Output Reference

Group Setpoint Managers

Field: Maximum Setpoint Humidity Ratio

The maximum humidity ratio (kgWater/kgDryAir) that is allowed by this setpoint manager. If
the calculated setpoint humidity ratio is greater than this value, then the setpoint is set to this
maximum value. The default value is 0.012 (kgWater/kgDryAir).
Field: Setpoint Node or NodeList Name
The name of a NodeList object containing the names of the HVAC system nodes, or the
HVAC System Node Name, for which humidity ratio setpoints will be established by this
setpoint manager.
An example of this object in an input data file (IDF), along with a humidistat object, is shown
below.
SetpointManager:MultiZone:MinimumHumidity:Average,
VAV_1 Humidifier HUMRAT setpoint, !- Name
VAV_1,
!- HVAC Air Loop Name
0.003,
!- Minimum Setpoint Humidity Ratio (kgWater/kgDryAir)
0.012,
!- Maximum Setpoint Humidity Ratio (kgWater/kgDryAir)
VAV_1 Humidifier-Outlet Nodes List;
!- Setpoint Node or NodeList Name
ZoneControl:Humidistat,
ICU_NURSESTN_LOBBY_FLR_2 Humidistat, !- Name
ICU_NURSESTN_LOBBY_FLR_2, !- Zone Name
MinRelHumSetSch, !- Humidifying Relative Humidity Setpoint Schedule Name
MaxRelHumSetSch; !- Dehumidifying Relative Humidity Setpoint Schedule Name

SetpointManager:MultiZone:MaximumHumidity:Average
This setpoint manager allows for controlling the maximum humidity level is multiple zones
served by a central forced air HVAC system (air loop). This setpoint manager, used in
conjunction with one or more ZoneControl:Humidistat objects, detects the air humidity level in
multiple controlled zones served by the HVAC air loop and uses air/moisture mass balances
to calculate an average supply air humidity ratio needed to maintain the zone relative
humidity levels near their respective dehumidifying setpoints. The calculated humidity ratio is
then used as the maximum humidity ratio setpoint for the designated setpoint node(s). A
dehumidification component (e.g., desiccant dehumidifiers) placed upstream of the setpoint
node can then use the maximum humidity ratio setpoint to control its moisture removal rate.
The use of this object requires that a ZoneControl:Humidistat object be specified with a
dehumidifying relative humidity schedule for one or more controlled zones served by the
HVAC air loop.
In the case of a chilled water coil which is used for both temperature and high humidity
control, this setpoint manager works in conjunction with a Controller:WaterCoil object to
determine the supply air temperature required to meet both the temperature (sensible) and
humidity (latent) load in the control zone. See object Controller:WaterCoil in the EnergyPlus
Engineering Reference for a detailed discussion of how this is achieved.
Field: Name
A unique, user-assigned name for an instance of an average maximum humidity ratio
(dehumidifying) multizone setpoint manager. Anywhere in the input that this setpoint manager
is used, it is referred to by this name.
Field: HVAC Air Loop Name
The name of the AirLoopHVAC object (the central air system) which will use this setpoint
manager to set its dehumidification setpoint (maximum air humidity ratio).

9/29/14

1616

Input-Output Reference

Group Setpoint Managers

Field: Minimum Setpoint Humidity Ratio

The minimum humidity ratio (kgWater/kgDryAir) that is allowed by this setpoint manager. If
the calculated setpoint humidity ratio is less than this value, then the setpoint is set to this
minimum value. The default value is 0.008 (kgWater/kgDryAir).
Field: Maximum Setpoint Humidity Ratio
The maximum humidity ratio (kgWater/kgDryAir) that is allowed by this set point manager. If
the calculated setpoint humidity ratio is greater than this value, then the setpoint is set to this
maximum value. The default value is 0.015 (kgWater/kgDryAir).
Field: Setpoint Node or NodeList Name
The name of a NodeList object containing the names of the HVAC system nodes, or the
HVAC System Node Name, for which humidity ratio setpoints will be established by this
setpoint manager.
An example of this object in an input data file (IDF), along with a humidistat object, is shown
below:
SetpointManager:MultiZone:MaximumHumidity:Average,
VAV_1_CoolC HUMRAT setpoint,
!- Name
VAV_1,
!- HVAC Air Loop Name
0.005,
!- Minimum Setpoint Humidity Ratio (kgWater/kgDryAir)
0.015,
!- Maximum Setpoint Humidity Ratio (kgWater/kgDryAir)
VAV_1 DeHumidifier-Outlet Nodes List;
!- Setpoint Node or NodeList Name
ZoneControl:Humidistat,
ICU_NURSESTN_LOBBY_FLR_2 Humidistat, !- Name
ICU_NURSESTN_LOBBY_FLR_2, !- Zone Name
MinRelHumSetSch, !- Humidifying Relative Humidity Setpoint Schedule Name
MaxRelHumSetSch; !- Dehumidifying Relative Humidity Setpoint Schedule Name

SetpointManager:MultiZone:Humidity:Minimum
This setpoint manager allows for controlling the minimum humidity level in multiple zones
served by a central forced air HVAC system (air loop). This setpoint manager, used in
conjunction with one or more ZoneControl:Humidistat objects, detects the air humidity level in
multiple controlled zones served by the HVAC air loop and uses air/moisture mass balances
to calculate a supply air minimum humidity ratio based on a zone with the critical
humidification requirement (i.e., a zone with the highest humidity ratio setpoint) to maintain
the zone relative humidity levels near their respective humidifying setpoints. The calculated
humidity ratio is then used as the minimum humidity ratio setpoint for the designated setpoint
node(s). A humidification component (e.g., Humidifier:Steam:Electric) placed upstream of the
setpoint node can then use the minimum humidity ratio setpoint to control humidification rate.
The use of this object requires that a ZoneControl:Humidistat object be specified with a
humidifying relative humidity schedule for one or more controlled zones served by the HVAC
air loop. If ZoneControl:Humidistat object is defined for only one of the zones served by the
air
loop
then
the
SetpointManager:MultiZone:Humidity:Minimum
perform
as
SepointManager:SingleZone:Humidity:Minimum.
Field: Name
A unique, user-assigned name for an instance of a multizone minimum humidity (humidifying)
setpoint manager. Anywhere in the input that this setpoint manager is used, it is referred to
by this name.
Field: HVAC Air Loop Name
The name of the AirLoopHVAC object (the central air system) which will use this setpoint
manager to set its humidification setpoint (minimum air humidity ratio).

9/29/14

1617

Input-Output Reference

Group Setpoint Managers

Field: Minimum Setpoint Humidity Ratio

The minimum humidity ratio (kgWater/kgDryAir) that is allowed by this setpoint manager. If
the calculated setpoint humidity ratio is less than this value, then the setpoint is set to this
minimum value. The default value is 0.005 (kgWater/kgDryAir).
Field: Maximum Setpoint Humidity Ratio
The maximum humidity ratio (kgWater/kgDryAir) that is allowed by this setpoint manager. If
the calculated setpoint humidity ratio is greater than this value, then the setpoint is set to this
maximum value. The default value is 0.012 (kgWater/kgDryAir).
Field: Setpoint Node or NodeList Name
The name of a NodeList object containing the names of the HVAC system nodes, or the
HVAC System Node Name, for which humidity ratio setpoints will be established by this
setpoint manager.
An example of this object in an input data file (IDF), along with a humidistat object, is shown
below.
SetpointManager:MultiZone:Humidity:Minimum,
Main Humidifier setpoint Mgr,
!- Name
VAV Sys 1,
!- HVAC Air Loop Name
0.003,
!- Minimum Setpoint Humidity Ratio (kgWater/kgDryAir)
0.015,
!- Maximum Setpoint Humidity Ratio (kgWater/kgDryAir)
Main Humidifier Outlet Node;
!- Setpoint Node or NodeList Name
ZoneControl:Humidistat,
Space5-1 Humidistat,
SPACE5-1,
HumidifyingHumSetSch,
DehumidifyingHumSetSch;

!!!!-

Name
Zone Name
Humidifying Relative Humidity Setpoint Schedule Name
Dehumidifying Relative Humidity Setpoint Schedule Name

SetpointManager:MultiZone:Humidity:Maximum
This setpoint manager allows for controlling the maximum humidity level in multiple zones
served by a central forced air HVAC system (air loop). This setpoint manager, used in
conjunction with one or more ZoneControl:Humidistat objects, detects the air humidity level in
multiple controlled zones served by the HVAC air loop and uses air/moisture mass balances
to calculate the maximum supply air humidity ratio based on a zone with the critical
dehumidification requirement (i.e., a zone with the lowest humidity ratio setpoint) to maintain
the zone relative humidity levels near their respective dehumidifying setpoints. The calculated
humidity ratio is then used as the maximum humidity ratio setpoint for the designated setpoint
node(s). A dehumidification component (e.g., desiccant dehumidifiers) placed upstream of
the setpoint node can then use the maximum humidity ratio setpoint to control its moisture
removal rate. The use of this object requires that a ZoneControl:Humidistat object be
specified with a dehumidifying relative humidity schedule for one or more controlled zones
served by the HVAC air loop. If ZoneControl:Humidistat object is defined for only one of the
zones served by the air loop then the SetpointManager:MultiZone:Humidity:Maximum
perform as SetpointManager:SingleZone:Humidity:Maximum.
In the case of a chilled water coil which is used for both temperature and high humidity
control, this setpoint manager works in conjunction with a Controller:WaterCoil object to
determine the supply air temperature required to meet both the temperature (sensible) and
dehumidification (latent) load in the control zone. See object Controller:WaterCoil in the
EnergyPlus Engineering Reference for a detailed discussion of how this is achieved.
Field: Name
A unique, user-assigned name for an instance of a multizone maximum humidity ratio
(dehumidifying) setpoint manager. Anywhere in the input that this setpoint manager is used, it
is referred to by this name.

9/29/14

1618

Input-Output Reference

Group Setpoint Managers

Field: HVAC Air Loop Name

The name of the AirLoopHVAC object (the central air system) which will use this setpoint
manager to set its dehumidification setpoint (maximum air humidity ratio).
Field: Minimum Setpoint Humidity Ratio
The minimum humidity ratio (kgWater/kgDryAir) that is allowed by this setpoint manager. If
the calculated setpoint humidity ratio is less than this value, then the setpoint is set to this
minimum value. The default value is 0.008 (kgWater/kgDryAir).
Field: Maximum Setpoint Humidity Ratio
The maximum humidity ratio (kgWater/kgDryAir) that is allowed by this set point manager. If
the calculated setpoint humidity ratio is greater than this value, then the setpoint is set to this
maximum value. The default value is 0.015 (kgWater/kgDryAir).
Field: Setpoint Node or NodeList Name
The name of a NodeList object containing the names of the HVAC system nodes, or the
HVAC System Node Name, for which humidity ratio setpoints will be established by this
setpoint manager.
An example of this object in an input data file (IDF), along with a humidistat object, is shown
below.
SetpointManager:MultiZone:Humidity:Maximum,
Maximum Mzone HUMRAT setpoint, !- Name
VAV Sys 1,
!- HVAC Air Loop Name
0.003,
!- Minimum Setpoint Humidity Ratio (kgWater/kgDryAir)
0.015,
!- Maximum Setpoint Humidity Ratio (kgWater/kgDryAir)
DeHumidifier-Outlet Nodes;
!- Setpoint Node or NodeList Name
ZoneControl:Humidistat,
Space5-1 Humidistat,
SPACE5-1,
HumidifyingHumSetSch,

!- Name
!- Zone Name
!- Humidifying Relative Humidity Setpoint Schedule Name

SetpointManager:FollowOutdoorAirTemperature
This setpoint manager is used to place a temperature setpoint on a system node that is
derived from the current outdoor air environmental conditions. The outdoor air conditions are
obtained from the weather information during the simulation.
Field: Name
A unique user-defined name for an instance of this setpoint manager.
Field: Control Variable
The type of variable that will be controlled. There are three choices available: Temperature,
MaximumTemperature, or MinimumTemperature.
Field: Reference Temperature Type
The field specifies the type of temperature value to obtain from the system node referenced
in the previous field. The two available options are OutdoorDryBulb and OutdoorWetBulb.
Field: Offset Temperature Difference
This field provides a temperature offset that will be applied to the value of the reference
temperature (outdoor air wetbulb/drybulb). If this value is zero, and the limits are met, then
the resulting setpoint will be exactly the same as the outdoor air wetbulb/drybulb temperature.
The sign convention is that a positive value here will increase the resulting setpoint to higher
than the outdoor air wetbulb/drybulb.

9/29/14

1619

Input-Output Reference

Group Setpoint Managers

Field: Maximum Setpoint Temperature

This field provides an upper limit to the resulting setpoint value.
Field: Minimum Setpoint Temperature
This field provides a lower limit to the resulting setpoint value.
Field: Setpoint Node or NodeList Name
The name of a NodeList object containing the names of the HVAC system nodes or the
HVAC System Node Name for which setpoints will be established by this setpoint manager.
An IDF example of use:
SetpointManager:FollowOutdoorAirTemperature,
MyCondenserControl,
!- Name
Temperature,
!- Control Variable
OutdoorAirDryBulb,
!- Reference Temperature Type
0.5,
!- Offset Temperature Difference {deltaC}
200,
!- Maximum Setpoint Temperature {C}
21.1,
!- Minimum Setpoint Temperature {C}
CondSupplyOutletNode;
!- Setpoint Node or NodeList Name

SetpointManager:FollowSystemNodeTemperature
This setpoint manager is used to place a temperature setpoint on a system node that is
derived from the current temperatures at a separate system node. The current value of the
temperature at a reference node is obtained and used to generate setpoint on a second
system node. If the reference node is also designated to be an outdoor air (intake) node,
then this setpoint manager can be used to follow outdoor air conditions that are adjusted for
altitude.
Field: Name
A unique user-defined name for an instance of this setpoint manager.
Field: Control Variable
The type of variable that will be controlled. There are three choices available: Temperature,
MaximumTemperature, or MinimumTemperature.
Field: Reference Node Name
The name of a system node where this setpoint manager will obtain a reference temperature
to follow. Note that the temperature to obtained is the current temperature on the node and
not the current value of a temperature setpoint.
Field: Reference Temperature Type
The field specifies the type of temperature value to obtain from the system node referenced
in the previous field. The two available options are NodeDryBulb and NodeWetBulb.
Field: Offset Temperature Difference
This field provides a temperature offset that will be applied to the value obtained from the
reference system node. If this value is zero, and the limits are met, then the resulting
setpoint will be exactly the same as the reference system node temperature. The sign
convention is that a positive value here will increase the resulting setpoint to higher than the
temperature at the reference node.
Field: Maximum Limit Setpoint Temperature
This field provides an upper limit to the resulting setpoint value.
Field: Minimum Limit Setpoint Temperature
This field provides a lower limit to the resulting setpoint value.
9/29/14

1620

Input-Output Reference

Group Setpoint Managers

Field: Setpoint System Node or NodeList Name

The name of a NodeList object containing the names of the HVAC system nodes or the
HVAC System Node Name for which setpoints will be established by this setpoint manager.
An IDF example of use:
SetpointManager:FollowSystemNodeTemperature,
MyCondenserControl,
!- Name
Temperature,
!- Control Variable
MyOAinletNode,
!- Reference Node Name
NodeDryBulb,
!- Reference Temperature Type
0.5,
!- Offset Temperature Difference {deltaC}
200,
!- Maximum Setpoint Temperature {C}
24.0,
!- Minimum Setpoint Temperature {C}
CondSupplyOutletNode;
!- Setpoint Node or NodeList Name

SetpointManager:FollowGroundTemperature
This setpoint manager is used to place a temperature setpoint on a system node that is
derived from a current ground temperature. The ground temperatures are specified in
different Site:GroundTemperature:* objects and used during the simulation. This setpoint
manager is primarily intended for condenser or plant loops using some type of ground heat
exchanger.
Field: Name
A unique user-defined name for an instance of this setpoint manager.
Field: Control Variable
The type of variable that will be controlled. There are three choices available: Temperature,
MaximumTemperature, or MinimumTemperature.
Field: Reference Ground Temperature Object Type
This field is used to specify the type of ground temperature to be used by the setpoint
manager.
There
are
four
options,
Site:GroundTemperature:BuildingSurface,
Site:GroundTemperature:Shallow,
Site:GroundTemperature:Deep,
or
Site:GroundTemperature:FCfactorMethod. Generally the deep ground temperatures are the
most useful for a plant loop serving a vertical borehole ground heat exchanger.
Field: Offset Temperature Difference
This field provides a temperature offset that will be applied to the value of the ground
temperature. If this value is zero, and the limits are met, then the resulting setpoint will be
exactly the same as the ground temperature. The sign convention is that a positive value
here will increase the resulting setpoint to higher than the ground temperature.
Field: Maximum Setpoint Temperature
This field provides an upper limit to the resulting setpoint value.
Field: Minimum Setpoint Temperature
This field provides a lower limit to the resulting setpoint value.
Field: Setpoint System Node or NodeList Name
The name of a NodeList object containing the names of the HVAC system nodes or the
HVAC System Node Name for which setpoints will be established by this setpoint manager.
An IDF example of use:

9/29/14

1621

Input-Output Reference

Group Setpoint Managers

SetpointManager:FollowGroundTemperature,
MyCondenserControl,
!- Name
Temperature,
!- Control Variable
Site:GroundTemperature:Deep, !- Reference Ground Temperature Object Type
1.5,
!- Offset Temperature Difference {deltaC}
50.0,
!- Maximum Setpoint Temperature {C}
10.0,
!- Minimum Setpoint Temperature {C}
CondSupplyOutletNode;
!- Setpoint Node or NodeList Name

SetpointManager:CondenserEnteringReset
The object resets the condenser entering water temperature setpoint to the optimal setpoint
temperature that will result in minimum net energy consumption for the chiller and cooling
tower plant. This chiller-tower optimization scheme uses one curve to determine the optimum
condenser entering water temperature for a given time step and two other curves to place
boundary conditions on the optimized setpoint value. Note that this object will work with only
one cooling tower object in a plant loop.
Field: Name
A unique, user assigned name for an instance of the optimized condenser entering water
setpoint manager. Anywhere in the input that this setpoint manager is used, it is referred to
by this name.
Field: Control variable
The type of variable that will be controlled. The only valid choice for this setpoint manager is
Temperature.
Field: Default Condenser Entering Water Temperature Schedule Name
This schedule should define the default condenser entering water temperature setpoint. This
scheduled setpoint value is only used in a given time step if the optimized setpoint value
(see the Optimized Condenser Entering Water Temperature Curve Name field) does not fall
within its prescribed boundary conditions.
Field: Minimum Design Wetbulb Temperature Curve Name
The curve name associated with the coefficients in the equation used to determine the
minimum design tower wetbulb referenced by the minimum outside air wetbulb temperature
curve below. The value from this curve is compared to the tower design wet bulb each
timestep to establish one of the governing boundaries over the optimized condenser entering
water temperature setpoint calculation. This curve must be quad-linear (Curve:QuadLinear)
and is defined as:

C1 C2 OaWb C3 WPLR C4TwrWb C5 NF

where,
OaWb = Outside air wet bulb for current timestep, C
WPLR = Weighted Part Load Ratio, dimensionless
TwrWb = Design tower wet bulb boundary condition, C
NF = Normalized condenser water flow per unit of tower capacity, m3/s-W
Field: Minimum Outside Air Wetbulb Temperature Curve Name
The curve name associated with the coefficients in the equation used to determine the
minimum actual wetbulb referenced by the optimized condenser entering water temperature
curve. The value from this curve is compared the actual outside wet bulb each timestep to
establish one of the governing boundaries over the optimized condenser entering water
temperature setpoint calculation. This curve must be quad-linear (Curve:QuadLinear) and is
defined as:
9/29/14

1622

Input-Output Reference

Group Setpoint Managers

C1 C2 MinWb C3 WPLR C4 TwrWb C5 NF

Where
MinWb = Minimum design wetbulb for current timestep, C
WPLR = Weighted Part Load Ratio, dimensionless
TwrWb = Design tower wet bulb boundary condition, C
NF = Normalized condenser water flow per unit of tower capacity, m3/s-W
Field: Optimized Condenser Entering Temperature Curve Name
The curve name associated with the coefficients in the optimized condenser entering water
temperature equation. The value from this curve is used to calculate the optimized condenser
entering water temperature for each timestep. If this optimized setpoint does not fall within
the bounds established by the two boundary conditions, then the value from the Default
Condenser Entering Water Temperature Schedule is used for the Condenser Entering Water
Setpoint for that timestep. This curve must be quad-linear (Curve:QuadLinear) and is defined
as:

C1 C2OaWb C3WPLR C4TwrWb C5 NF

where,
OaWb = Outside air wet bulb for current timestep, C
WPLR = Weighted Part Load Ratio, dimensionless
TwrWb = Design tower wet bulb boundary condition, C
NF = Normalized condenser water flow per unit of tower capacity, m3/s-W
Field: Minimum Lift
This field establishes the minimum Lift allowed. Lift is generally thought of as the difference
between condenser refrigerant pressure and the evaporator refrigerant pressure. Using
defined pressure and temperature relationships, lift also can be related to the difference
between the leaving chilled water and the leaving condenser water temperature. Further,
when the leaving condenser water temperature and condenser water flow are constant, the
entering condenser temperature can be used as a proxy for lift. Because most condenser
water systems are designed for constant flow, entering condenser temperature is the most
common metric for lift, and that is what meant here. If the calculated Condenser Entering
Water Setpoint falls below (TEvapLvgWater+ MinimumLift), then the Condenser Entering
Water Setpoint is reset to equal TEvapLvgWater+ MinimumLift. The units for this field are deg
C TD. Default is 11.1 C (20 F).
Field: Maximum Condenser Entering Temperature
This field establishes the maximum condenser entering water setpoint temperature allowed.
If the scheduled or calculated setpoint is above TCondEntMax, then TCondEntSetpoint is
reset to equal TCondEntMax. The units for this field are deg C.
Field: Cooling Tower Design Inlet Air Wet-Bulb Temperature
This field defines the reference wet bulb temperature used to size the cooling tower.
Typically, the design condenser entering water temperature equals TwrRefOaWb +
TowerApproachTD. The units for this field are deg C.
Field: Setpoint Node or Node List Name
This field defines the condenser node being controlled.
Below is an example input for a CondenserEnteringReset Setpoint Manager.

9/29/14

1623

Input-Output Reference

Group Setpoint Managers

SetpointManager:CondenserEnteringReset,
Condenser Optimized Setpoint Manager, !- Name
Temperature,
!- Control Variable
DefaultCondEntSch,
!- Default Condenser Entering Water Temperature Schedule Name
MinDsnWBCurveName,
!- Minimum Design Wetbulb Temperature Curve Name
MinActWBCurveName,
!- Minimum Outside Air Wetbulb Temperature Curve Name
OptCondEntCurveName, !- Optimized Cond Entering Water Temperature Curve Name
12,
!- Minimum Lift, C
32,
!- Maximum Condenser Entering Water Temp, C
25.56,
!- Cooling Tower Design Inlet Air Wetbulb Temperature, C
Cond Water Setpoint Node; !- Setpoint Node or Node List Name

SetpointManager:CondenserEnteringReset:Ideal
The object determines a near-optimal condenser water entering setpoint at each time step
that will result in minimum net energy consumption for the chiller and cooling tower plant. The
ideal chiller-tower optimization scheme uses a search algorithm to find the ideal optimal
setpoint at a given timestep. Note that this object will work with only one chiller object and
only one cooling tower object in a plant loop.
Field: Name
A unique, user assigned name for an instance of the optimized condenser entering water
setpoint manager. Anywhere in the input that this setpoint manager is used, it is referred to
by this name.
Field: Control variable
The type of variable that will be controlled. There is only one choice for this type of setpoint
manager: Temperature.
Field: Minimum Lift
This field establishes the minimum lift allowed. Lift is generally thought of as the difference
between condenser refrigerant pressure and the evaporator refrigerant pressure. Using
defined pressure and temperature relationships, lift also can be related to the difference
between the leaving chilled water and the leaving condenser water temperature. Further,
when the leaving condenser water temperature and condenser water flow are constant, the
entering condenser temperature can be used as a proxy for lift. Because most condenser
water systems are designed for constant flow, entering condenser temperature is the most
common metric for lift, and that is what meant here. If the optimized condenser entering
water setpoint falls below leaving evaporator water temperature plus minimum lift, then the
condenser entering water setpoint is reset to equal this field value plus leaving evaporator
water temperature. This determines the minimum boundary of condenser entering water
setpoint. The unit for this field is deg C TD. Default is 11.1 deg C (20 deg F).
Field: Maximum Condenser Entering Water Temperature
This field establishes the maximum condenser entering water setpoint temperature allowed.
If the optimized condenser entering water setpoint is above this field value, then the
condenser entering water setpoint is reset to equal this filed value. The units for this field are
deg C. Default is 34 deg C
Field: Setpoint Node or Node List Name
This field defines the condenser node being controlled.
Below is an example input for a IdealCondenserEnteringReset Setpoint Manager.

9/29/14

1624

Input-Output Reference

Group Setpoint Managers

SetpointManager:CondenserEnteringReset:Ideal,
Condenser Optimized Setpoint Manager, !- Name
Temperature,
!- Control Variable
12,
!- Minimum Lift, C
32,
!- Maximum Condenser Entering Water Temp, C
Cond Water Setpoint Node; !- Setpoint Node or Node List Name

SetpointManager:SingleZone:OneStageCooling
The singe-zone, one-stage cooling setpoint manager allows a component to be controlled
based on thermostatic control using the object ZoneControl:Thermostat:StagedDualSetpoint.
This setpoint manager differs from other parts of EnergyPlus that control based on predicted
loads to setpoint. This setpoint manager allows modeling on/off cycling of DX coils using
CoilSystem:Cooling:DX in continuous fan air handlers. This setpoint manger detects if the
zone is calling for a cooling stage and applies one setpoint value if cooling is called for and
another setpoint value if cooling is not called for.
This method of control is much more like real world thermostatic control but it requires short
zone timesteps. Models using this type of control should use 60 timesteps per hour and will
run much slower because of that.
Field: Name
This alpha field is a unique, user-assigned name for an instance of a single zone one stage
cooling setpoint manager.
Field: Cooling Stage On Supply Air Setpoint Temperature
This numeric field is the setpoint temperature to apply when the manager intends to turn on
cooling, in degrees Celsius. The default is -99.0C.
Field: Cooling Stage Off Supply Air Setpoint Temperature
This numeric field is the setpoint temperature to apply when the manager intends to turn off
cooling, in degrees Celsius. The value in this field must be higher than the value in the
previous field. The default is 99.0C.
Field: Control Zone Name
This alpha field is the name of the control zone for this setpoint manager. This zone needs to
be controlled using ZoneControl:Thermostat:StagedDualSetpoint.
Field: Setpoint Node or NodeList Name
This alpha field is the name of a NodeList objet containing the names of the HVAC system
nodes, or the name of a system node, for which temperature setpoints will be established by
this setpoint manager.
An example input follows.
SetpointManager:SingleZone:OneStageCooling,
ZSF2 cooling on_off , !- Name
-99.0 , !- Cooling Stage On Supply Air Setpoint Temperature
99.0 , !- Cooling Stage Off Supply Air Setpoint Temperature
ZSF2 , !- Control Zone Name
DX Cooling Coil 3 Outlet Node ; !- Setpoint Node or NodeList Name

SetpointManager:SingleZoneOneStageHeating
The singe-zone, one-stage heating setpoint manager allows a component to be controlled
based on thermostatic control using the object ZoneControl:Thermostat:StagedDualSetpoint.
This setpoint manager differs from other parts of EnergyPlus that control based on predicted
loads to setpoint. This setpoint manager allows modeling on/off cycling of heating coils in
continuous fan air handlers. This setpoint manger detects if the zone is calling for a heating
9/29/14

1625

Input-Output Reference

Group Controllers

stage and applies one setpoint value if heating is called for and another setpoint value if
heating is not called for.
This method of control is much more like real world thermostatic control but it requires short
zone timesteps. Models using this type of control should use 60 timesteps per hour and will
run much slower because of that.
Field: Name
This alpha field is a unique, user-assigned name for an instance of a single zone one stage
heating setpoint manager.
Field: Heating Stage On Supply Air Setpoint Temperature
This numeric field is the setpoint temperature to apply when the manager intends to turn on
heating, in degrees Celsius. The default is 99.0C.
Field: Heating Stage Off Supply Air Setpoint Temperature
This numeric field is the setpoint temperature to apply when the manager intends to turn off
heating, in degrees Celsius. The value in this field must be lower than the value in the
previous field. The default is -99.0C.
Field: Control Zone Name
This alpha field is the name of the control zone for this setpoint manager. This zone needs to
be controlled using ZoneControl:Thermostat:StagedDualSetpoint.
Field: Setpoint Node or NodeList Name
This alpha field is the name of a NodeList objet containing the names of the HVAC system
nodes, or the name of a system node, for which temperature setpoints will be established by
this setpoint manager.
An example input follows.
SetpointManager:SingleZone:OneStageHeating,
ZNF1 heating on_off , !- Name
99.0 , !- Heating Stage On Supply Air Setpoint Temperature
-99.0 , !- Heating Stage Off Supply Air Setpoint Temperature
ZNF1 , !- Control Zone Name
Main Heating Coil 2 Air Outlet Node ; !- Setpoint Node or NodeList Name

Group Controllers
Controls (Air Loop and Zone Equipment)
A controller mimics the function of an actual physical controller in a somewhat rudimentary
way. It can sense one node variable, compare it with its setpoint, and determine the desired
value for another node variable. It should be noted that a controller cannot span a loop
manager boundary (but a Setpoint Manager can). Thus, in an air loop (AirLoopHVAC), the
sensed node and the controlled device must be in the air loop simulation. This means that a
single zone system cannot be modeled with a simple controller sensing zone temperature
and controlling coil water flow. Instead this must be modeled as a Setpoint Manager sensing
a zone temperature and resetting the supply air temperature setpoint each timestep. This is
artificial but should simplify the control modeling task. It should also be noted that there are
various types of controllers and that each controller might hook into loops in a slightly
different way. As a result, each controller type is described separately below.
Controller:WaterCoil
This controller is really a solution inverter. For a water coil the simulation cannot be inverted
where the mass flow rate of the water through the coil can be solved directly given an air
temperature. Thus, this controller will numerically step through all of the water flow
9/29/14

1626

Input-Output Reference

Group Controllers

possibilities by an interval-halving technique until the mass flow rate is determined to meet
the specified outlet air temperature within a specified user tolerance.
As the reader probably noted when reading the descriptions of the coil syntax shown earlier
in this section, there were no controls attached directly to a particular component. This is
because the input can be simplified somewhat by entering node names to be controlled. This
avoids having to search through multiple lists of component types for the sake of simply
controlling components. The Controller:WaterCoil shown below is a way of controlling
variables at one node based on conditions at another node. After the identifying name for the
controller, the user must define which control variable the controller is managing. These
options include Temperature, Humidity Ratio, TemperatureAndHumidityRatio), or Flow.
The next parameter in the input syntax is the Action of the control, which determines how the
controlled variable (e.g., mass flow rate through a water coil) is changed based on the control
signal. The following input parameter is the actuator variable, which is currently limited to
mass flow through a water coil.
The next two parameters in the input syntax are node names corresponding to the node that
is being sensed and the actuated node which controls the water mass flow through the coil.
For example, in the case of a cooling coil the control variable might be the outlet air
temperature of the coil while the actuated variable might be the water flow rate through the
coil. These two parameters are followed by the controller convergence tolerance. Finally, the
last two input parameters represent the maximum and minimum values allowed for the
actuated variable at the actuated node.
Field: Name
This is the unique name of the controller.
Field: Control Variable
This was setup to be generic but to date has only been used for temperature control, or
temperature and humidity ratio control, of a water coil in the air loop simulation. The keyword
Temperature is used for air temperature control and is normally specified for the coils outlet
air node. The keyword TemperatureAndHumidityRatio is used for controlling both air
temperature and high humidity levels, and is normally specified for a cooling coils outlet air
node. The keyword HumidityRatio is used for humidity control and would normally be
specified for a dehumidifier outlet node. These two keywords require a
ZoneControl:Humidistat object and a maximum humidity setpoint manager object
(SetPointManager:SingleZone:Humidity:Maximum,
SetPointManager:MultiZone:MaximumHumidity:Average
or
SetPointManager:MultiZone:Humidity:Maximum). If the coil is located in the outdoor air
stream, it may also be necessary to use SetpointManager:OutdoorAirPretreat.
Field: Action
The next input refers to the action of the control. This can be best described by an example.
In a coil where water mass flow rate is to be controlled, a coil will increase the mass flow rate
through the coil when more heating or cooling is requested. In a heating coil, this increases
the value of heat transfer from the water to the air stream. As a result, this is considered a
Normal action controller. In a cooling coil, an increase in water mass flow rate through the
coil decreases the value of heat transfer from the water to the air stream (absolute value
increases, but since cooling is traditionally described as a negative number, an increase in
absolute value results in a decrease in the actual heat transfer value). Thus, the cooling coil
controller has Reverse action since an increase in flow rate results in a decrease in heat
transfer.
Field: Actuator Variable
This was again meant to be more generic but currently has only been used to control the
water mass flow rate of a heating or cooling coil. This actuator variable must be set to the
keyword Flow to control the water mass flow rate.
9/29/14

1627

Input-Output Reference

Group Controllers

Field: Sensor Node Name

Name of the node where the temperature, humidity ratio or flow is sensed.
Field: Actuator Node Name
Name of the actuated node that controls the water mass flow rate through the coil.
Field: Controller Convergence Tolerance
The coil is controlled by knowing the outlet temperature and/or humidity ratio specified by the
setpoint managers, and setting the outlet conditions from the coil to meet these setpoints.
The hot and chilled water coils use complex models that cannot be inverted directly.
Therefore, to determine the correct mass flow rate for the hot or cold water the models are
inverted numerically using an iterative procedure. The iterative solution uses an intervalhalving routine and needs a termination criteria that is set with the Controller Convergence
Tolerance parameter. The convergence tolerance is the maximum difference between the
actual temperature at the setpoint node and the setpoint temperature. This control offset is
set to a small temperature difference, such as 0.01 to denote 1/100 degree C. The default is
0.1 degree C.
Field: Maximum Actuated Flow
This is the maximum water flow (m 3/sec) through the coil. Set to the maximum design water
flow for the coil.
Field: Minimum Actuated Flow
Set to the minimum design water flow (m3/sec) for the water coil, normally a shut off valve
that is set to zero.
An example of this object in an IDF, along with appropriate setpoint managers, is shown
below:
Controller:WaterCoil,
Central Cooling Coil Contoller 1,
TemperatureAndHumidityRatio,
Reverse,
Flow,
VAV Sys 1 Outlet Node,
Main Cooling Coil 1 Water Inlet Node,
0.002,
0.025,
0.0;

!!!!!!!!!-

Name
Control Variable
Action
Actuator Variable
Sensor Node Name
Actuator Node Name
Controller Convergence Tolerance {deltaC}
Maximum Actuated Flow {m3/s}
Minimum Actuated Flow {m3/s}

SetpointManager:SingleZone:Humidity:Maximum,
Zone Max Set Point Manager,
!- Name
,
!- Control Variable
,
!- Schedule name
VAV Sys 1 Outlet Node,
!- Setpoint Node or NodeList Name
Zone 2 Node;
!- Control Zone Air Node Name
SetpointManager:Scheduled,
Scheduled Set Point Manager 1,
Temperature,
Seasonal Reset Supply Air Temp Sch,
VAV Sys 1 Outlet Node;

!!!!-

Name
Control Variable
Schedule Name
Setpoint Node or NodeList Name

Controller:OutdoorAir
A mixed air box has its own controller type called Controller:OutdoorAir. The purpose of the
outdoor air controller is to provide outdoor air for ventilation and also provide free cooling
(through additional outdoor air and/or bypassing an air-to-air heat exchanger) whenever
9/29/14

1628

Input-Output Reference

Group Controllers

possible. The outdoor air controller includes a number of user-selectable limit controls. If any
of the selected limits are exceeded, the outdoor airflow rate is set to the minimum.
If all the limits are satisfied, the outdoor air controller does the following for continuous air
flow systems: if the outdoor air temperature is greater than or equal to the mixed air
temperature setpoint, the outdoor air flow rate is set to the maximum; if the outdoor air
temperature is less than the mixed air temperature setpoint, the outdoor air controller will
modulate the outdoor air flow so that the mixed air temperature will match the mixed air
setpoint temperature.
A time-of-day schedule may also be used to simulate an increase in outdoor air flow rate for
push-button type economizer applications. When the schedule permits (i.e., schedule
values are greater than 0), the outdoor air flow rate is increased to the user-specified
maximum outdoor air flow rate.
The outdoor air controller can also account for changes in the outdoor air flow rate during
times when indoor humidity levels are high. A zone humidistat must be used with this control
option. During high indoor humidity, the outdoor air flow rate is modified in response to a high
indoor humidity condition. If high humidity control is based on the outdoor air humidity ratio
and the outdoor humidity ratio is greater than the indoor humidity ratio, high humidity control
is terminated. When the economizer is used in conjunction with the high humidity control
option, high humidity control has priority and controls the change in air flow rates. The Night
Ventilation Availability Manager has priority over high humidity control and will use the
controllers maximum outdoor air flow rate when this Availability Manager cycles the fan on
(Ref. System Availability Managers AvailabilityManager:NightVentilation)
The mixed air box connections are defined separately in the OutdoorAir:Mixer object.
Although the mixer will commonly be connected directly to the outdoor air, other components
may be placed on the outdoor air path upstream of the mixer. When this is the case, any
modulation will be determined by the conditions at the inlet node of the mixer rather than the
outdoor air. This means that the controller will account for any heat recovery or other
preheating/precooling components that may modify the condition of outdoor air before it
reaches the mixer.
If all the limits are satisfied, the outdoor air controller does the following for cycling fan
systems: the outdoor air flow rate is set to the maximum when the fan cycles on. If the limits
are not satisfied, the outdoor air flow rate is at the minimum when the fan cycles on.
Field: Name
The unique user-assigned name for an instance of an outdoor air controller. Any other object
referencing this outdoor air controller will use this name.
Field: Relief Air Outlet Node Name
The name of the relief air node of the outdoor air mixer associated with this outdoor air
controller.
Field: Return Air Node Name
The name of the return air node of the outdoor air mixer associated with this outdoor air
controller.
Field: Mixed Air Node Name
Name of the node where the mixed air setpoint is set. The outdoor air controller senses the
temperature at this node and attempts to control that temperature to the node setpoint.
Field: Actuator Node Name
The name of the node that is associated with the outdoor air damper. This should be the
outermost air node on the outdoor air path connected to the outdoor air stream for the mixer
associated with this outdoor air controller.

9/29/14

1629

Input-Output Reference

Group Controllers

Field: Minimum Outdoor Air Flow Rate

Input for this field is the minimum outdoor air flow rate for the system in cubic meters per
second.
Field: Maximum Outdoor Air Flow Rate
Input for this field is the maximum outdoor air flow rate for the system in cubic meters per
second.
Field: Economizer Control Type
The options for this field are
FixedDryBulb
DifferentialDryBulb
FixedEnthalpy
DifferentialEnthalpy
ElectronicEnthalpy
FixedDewPointAndDryBulb
DifferentialDryBulbAndEnthalpy
NoEconomizer
Choosing NoEconomizer means the economizer will not operate and the outdoor airflow rate
will be at the minimum for the entire simulation.
Choosing FixedDryBulb means the economizer will set the outdoor airflow rate at minimum
if the outdoor air temperature is higher than a specified dry-bulb temperature limit.
Choosing DifferentialDryBulb will trigger the outdoor airflow to minimum when the dry-bulb
temperature of outdoor air is higher than the dry-bulb temperature of the return air.
FixedEnthalpy checks the upper limit of the enthalpy given as a field input against the
enthalpy content of outdoor air and will set the outdoor airflow rate to minimum if the latter is
greater than the former.
DifferentialEnthalpy does the same thing but compares the return air enthalpy with the
enthalpy of outdoor air. When the enthalpy of outdoor air is greater than the enthalpy of the
return air, the outdoor air flow rate is set to minimum.
Choosing ElectronicEnthalpy enables the simulation to calculate the humidity ratio limit of
outdoor air based on the dry-bulb temperature of outdoor air and a quadratic/cubic curve, and
compare it to the actual outdoor air humidity ratio. If the actual outdoor humidity ratio is
greater than the calculated humidity ratio limit, then the outdoor airflow rate is set to
minimum.
Choosing FixedDewPointAndDryBulb compares both the outdoor dewpoint temperature
and the outdoor dry-bulb temperature to their specified high limit values. If either outdoor
temperature exceeds the high limit value, the outdoor airflow rate is set to minimum.
Another option DifferentialDryBulbAndEnthalpy enables the control strategy to be based
on both the DifferentialDryBulb and DifferentialEnthalpy economizer control strategies.
In addition to all economizer control types listed above, each control type checks for userentered values for the upper limit of dry-bulb temperature, enthalpy limit, humidity ratio limit
and dewpoint limit. The outdoor air flow rate is set to minimum if any of these entered limits
are exceeded.
The default for this field is NoEconomizer.
Field: Economizer Control Action Type
There are two choices for this Field: MinimumFlowWithBypass and ModulateFlow, with the
default being ModulateFlow if this input field is left blank.

9/29/14

1630

Input-Output Reference

Group Controllers

ModulateFlow means the outdoor air flow rate will be increased to meet the mixed air
setpoint temperature, subject to the limits imposed via other inputs for this object (e.g.,
Economizer Maximum Limit Dry-Bulb Temperature, Maximum Outdoor Air Flow Rate, etc.).
MinimumFlowWithBypass is used exclusively in conjunction with air-to-air heat
exchanger:objects (Ref. HeatExchanger:*) for providing free cooling operation in the absence
of a conventional air-side economizer (i.e., when outdoor air flow rate is not increased during
economizer mode). The MinimumFlowWithBypass choice forces the outdoor air flow rate to
always remain at the minimum. However, when high humidity control is used, the outdoor air
flow rate is set to the product of the maximum outdoor air flow rate multiplied by the high
humidity outdoor air flow ratio. The heat exchanger uses the limit checking in the outdoor air
controller to decide whether or not to bypass the outdoor air around the heat exchanger or
turn off the wheel motor in the case of a rotary heat exchanger. Heat exchange is also
suspended when high humidity control is active.
The ModulateFlow option can also be used with the HeatExchanger:AirToAir:FlatPlate or
HeatExchanger:AirToAir:SensibleAndLatent objects.
Field: Economizer Maximum Limit Dry-Bulb Temperature
Input for this field is the outdoor air temperature high limit (C) for economizer operation. If the
outdoor air temperature is above this limit, the outdoor airflow rate will be set to the minimum.
This
field
is
required
if
Economizer
Control
Type
FixedDryBulb
or
FixedDewPointAndDryBulb has been specified.
No input (blank) in this field means that there is no outdoor air temperature high limit control.
This limit applies to the conditions at the Actuator Node regardless of whether or not there
are any other components in the outdoor air path upstream of the mixer.
Field: Economizer Maximum Limit Enthalpy
Input for this field is the outdoor air enthalpy limit (in J/kg) for economizer operation. If the
outdoor air enthalpy is above this value, the outdoor airflow rate will be set to the minimum.
This field is required if Economizer Control Type FixedEnthalpy has been specified.
No input (blank) in this field means that there is no outdoor air enthalpy limit control. This limit
applies to the conditions at the Actuator Node regardless of whether or not there are any
other components in the outdoor air path upstream of the mixer.
Field: Economizer Maximum Limit Dewpoint Temperature
Input for this field is the outdoor air dewpoint limit (C) for economizer operation. If the
outdoor air dewpoint temperature is above this value, the outdoor airflow rate will be set to
the
minimum. This field
is
required
if
the
Economizer
Control Type
FixedDewPointAndDryBulb has been specified.
No input (blank) in this field means that there is no outdoor air dewpoint limit control. This
limit applies to the conditions at the Actuator Node regardless of whether or not there are any
other components in the outdoor air path upstream of the mixer.
Field: Electronic Enthalpy Limit Curve Name
Input for this field is the name of a quadratic or cubic curve which provides the maximum
outdoor air humidity ratio (function of outdoor air dry-bulb temperature) for economizer
operation. If the outdoor air humidity ratio is greater than the curves maximum humidity ratio
(evaluated at the outdoor air dry-bulb temperature), the outdoor air flow rate will be set to the
minimum. This limit applies to the conditions at the Actuator Node regardless of whether or
not there are any other components in the outdoor air path upstream of the mixer. No input
(blank) in this field means that there is no electronic enthalpy limit control.
Field: Economizer Minimum Limit Dry-Bulb Temperature
Input for this field is the outdoor air temperature low limit (C) for economizer operation. If the
outdoor air temperature is below this limit, the outdoor airflow rate will be set to the minimum.
9/29/14

1631

Input-Output Reference

Group Controllers

No input (blank) in this field means that there is no outdoor air temperature low limit control.
This limit applies to the conditions at the Actuator Node regardless of whether or not there
are any other components in the outdoor air path upstream of the mixer.
Field: Lockout Type
Choices for this field are NoLockout, LockoutWithHeating, and LockoutWithCompressor. This
field is used for packaged systems with DX coils. LockoutWithHeating means that if the
packaged unit is in heating mode, the economizer is locked out i.e., the economizer
dampers are closed and there is minimum outdoor air flow. LockoutWithCompressor means
that in addition to locking out the economizer when the unit is in heating mode the
economizer is locked out when the DX unit compressor is operating to provide cooling. In
other words, the economizer must meet the entire cooling load it isnt allowed to operate in
conjunction with the DX cooling coil. This option (LockoutWithCompressor) is sometimes
called a nonintegrated economizer.
The default is NoLockout.
Field: Minimum Limit Type
Choices for this field are FixedMinimum or ProportionalMinimum. FixedMinimum means that
the minimum outdoor airflow rate is fixed no matter what the actual system flow rate is.
ProportionalMinimum means the minimum outdoor airflow rate varies in proportion to the total
system air flow rate. The default is ProportionalMinimum.
Field: Minimum Outdoor Air Schedule Name
The name of a schedule which uses decimal values (0.0 1.0). These values are multiplied
by the minimum outdoor air flow rate. This schedule is useful for reducing the outdoor air flow
rate to zero during unoccupied or start up hours. If this field is not entered, the minimum
outdoor air flow rate either remains constant during the simulation period (Minimum Outdoor
Air Control Type = FixedMinimum) or varies in proportion to the supply air flow rate (Minimum
Outdoor Air Control Type = ProportionalMinimum).
Field: Minimum Fraction of Outdoor Air Schedule Name
The name of a schedule which uses decimal values (0.0 1.0) These values are multiplied
by the total (design) air flow rate. This is an alternate method for specifying the minimum
outdoor air amount. (The other method is the Minimum Outdoor Air Schedule described
above.) Note: This field overrides Minimum Outdoor Air Schedule and Minimum Outdoor
Air Flowrate.
Field: Maximum Fraction of Outdoor Air Schedule Name
This is an optional field with the schedule values in decimal fractions (0.0-1.0). This field
enables the user to limit the maximum of amount of outdoor air permissible and thus also
limits the permissible maximum outdoor air into the system.
If both the above schedules are given values of 1.0, the system works at 100% outdoor air,
so in a system if 100% outdoor air is required regardless of any other condition, these fields
are helpful.
Field: Mechanical Ventilation Controller Name
This optional field is the name of the mechanical ventilation controller object to be used in
conjunction with this outdoor air controller. The Controller:MechanicalVentilation object allows
the user to define the minimum outdoor air flow rate based on air flow per unit floor area and
air flow per person (occupant) for the zones being served by the air loop that utilizes this
controller.
This feature allows the user to perform a first-order evaluation of carbon dioxide(CO2)-based
demand controlled ventilation (outdoor ventilation varied according to occupancy levels).

9/29/14

1632

Input-Output Reference

Group Controllers

If a valid name for a Controller:MechanicalVentilation object is entered in this field, the

minimum outdoor air flow rate delivered will be the greater of:
the minimum outdoor air flow rate calculated by the fields Minimum Outdoor Air Flow
Rate, Minimum Limit Type, and Minimum Outdoor Air Schedule Name as defined for this
outdoor air controller, or
the outdoor air flow rate calculated using the Controller:MechanicalVentilation object
named in this input field.
Leaving this input field blank will bypass the Controller:MechanicalVentilation object
calculations and the minimum outdoor air flow rate will be based on the other inputs
associated with this outdoor air controller object. Actual outdoor air flow rates may be higher
than the minimum if free cooling is available and the object inputs are properly selected.
Regardless, the maximum outdoor air flow rate is limited by the field Maximum Outdoor Air
Flow Rate.
Field: Time of Day Economizer Control Schedule Name
This alpha field is the name of a schedule which controls the outdoor air flow rate based on a
time-of-day economizer. Schedule values equal to 0 disable this feature. Schedule values
greater than 0 cause the outdoor air flow rate to increase to the maximum. When an
economizer is used in conjunction with the high humidity control option, high humidity control
has priority.
Field: High Humidity Control
This choice field establishes whether or not the outdoor air flow rate is modified in response
to high indoor relative humidity. Valid choices are Yes and No. If Yes is selected, the outdoor
air flow rate may be modified when the indoor relative humidity is above the humidstat
setpoint. If No is selected, this option is disabled and the following three fields are not used.
Field: Humidistat Control Zone Name
This input defines the zone name where the humidistat is located. This is the same name
used in the ZoneControl:Humidistat object. This field is required when the input field High
Humidity Control is specified as Yes.
Field: High Humidity Outdoor Air Flow Ratio
This input is the ratio of the modified outdoor air flow rate to the maximum outdoor air flow
rate. When the high humidity control algorithm determines that the outdoor air flow rate will
be changed (i.e., increased or decreased), the operating outdoor air flow rate is equal to the
maximum outdoor air flow rate multiplied by this ratio. The minimum value for this field is 0. If
this field is blank, the default value is 1. This field is used only when the input field High
Humidity Control is specified as Yes. When an economizer is used in conjunction with the
high humidity control option, high humidity control has priority.
Field: Control High Indoor Humidity Based on Outdoor Humidity Ratio
This choice field determines if high humidity control is activated based on high indoor relative
humidity alone or is activated only when the indoor relative humidity is above the humidstat
setpoint and the indoor humidity ratio is greater than the outdoor humidity ratio. Valid choices
are Yes and No. If No is selected, high humidity control is active any time the zone humidistat
senses a moisture load. If Yes is selected, the model also verifies that the outdoor humidity
ratio is less than the humidistats zone air humidity ratio. This field is used only when the
input field High Humidity Control is specified as Yes. The default value is Yes.
Field: Heat Recovery Bypass Control Type
This choice field determines if specialized control is used to optimize the use of heat
recovery.
Valid
choices
are
BypassWhenWithinEconomizerLimits
and
BypassWhenOAFlowGreaterThanMinimum. If BypassWhenWithinEconomizerLimits is
selected, heat recovery is disabled any time the controller determines that the economizer is
9/29/14

1633

Input-Output Reference

Group Controllers

active (i.e., all controls are within limits). If BypassWhenOAFlowGreaterThanMinimum is

selected, the model first verifies that the economizer is active and then checks to see if the
outdoor air flow rate is greater than the minimum, if so heat recovery is set to bypass whether
or not a heat exchanger is used in the outdoor air system. When this option is used with Time
of Day Economizer Control or High Humidity Control, this option has priority. The model then
compares the mixed air temperature at minimum outdoor air flow with the heat exchanger off
to the mixed air temperature set point. If the mixed air temperature at minimum outdoor air
flow with the heat exchanger off is less than the mixed air temperature set point, the outdoor
air flow rate is set to the minimum. The model then checks to see if an air loop heating coil is
operating. If any airloop heating coil turns on, the heat exchanger is also turned on and the
outdoor air flow is set to the minimum. This action is meant to minimize heating energy (this
action may also disable the heating coil on subsequent iterations, see output variable Air
System Outdoor Air Heat Recovery Bypass Heating Coil Activity Status). This means that
heat recovery is active any time the outdoor air flow rate is equal to the minimum even when
the economizer requests free cooling. For this case, the use of supply air temperature control
for the heat exchanger is recommended (Ref HeatExchanger). The default value is
BypassWhenWithinEconomizerLimits.
An Example IDF specification:
Controller:OutdoorAir,
OA Controller 1,
!- Name
Relief Air Outlet Node, !- Relief Air Outlet Node Name
Outdoor Air Mixer Inlet Node, !- Return Air Node Name
Mixed Air Node,
!- Mixed Air Node Name
Outdoor Air Inlet Node, !- Actuator Node Name
0.25,
!- Minimum Outdoor Air Flow Rate {m3/s}
1.6,
!- Maximum Outdoor Air Flow Rate {m3/s}
ElectronicEnthalpy,
!- Economizer Control Type
ModulateFlow,
!- Economizer Control Action Type
23.,
!- Economizer Maximum Limit Dry-Bulb Temperature {C}
,
!- Economizer Maximum Limit Enthalpy {J/kg}
13.5,
!- Economizer Maximum Limit Dewpoint Temperature {C}
ElectronicEnthalpyCurveA,!- Electronic Enthalpy Limit Curve Name
14.,
!- Economizer Minimum Limit Dry-Bulb Temperature {C}
NoLockout,
!- Lockout Type
FixedMinimum,
!- Minimum Limit Type
OAFractionSched,
!- Minimum Outdoor Air Schedule Name
,
!- Minimum Fraction of Outdoor Air Schedule Name
,
!- Maximum Fraction of Outdoor Air Schedule Name
,
!- Mechanical Ventilation Controller Name
TimeOfDayEconomizerSch, !- Time of Day Economizer Control Schedule Name
Yes,
!- High Humidity Control
EAST ZONE,
!- Humidistat Control Zone Name
0.9,
!- High Humidity Outdoor Air Flow Ratio
Yes;
!- Control High Indoor Humidity Based on Outdoor Humidity Ratio
Curve:Cubic,
ElectronicEnthalpyCurveA,!0.01342704,
!-0.00047892,
!0.000053352,
!-0.0000018103,
!16.6,
!29.13;
!-

Name
Coefficient1 Constant
Coefficient2 x
Coefficient3 x**2
Coefficient4 x**3
Minimum Value of x
Maximum Value of x

Controller:OutdoorAir Outputs
Note that the key value for these outputs is the AirLoopHVAC name, not the name of the
Controller:OutdoorAir.
HVAC,Average,Air System Outdoor Air Economizer Status []
HVAC,Average,Air System Outdoor Air Heat Recovery Bypass Status []
9/29/14

1634

Input-Output Reference

Group Controllers

HVAC,Average,Air System Outdoor Air Heat Recovery Bypass Heating Coil

Activity Status []
HVAC,Average,Air System Outdoor Air Heat Recovery Bypass Minimum Outdoor Air
Mixed Air Temperature [C]
HVAC,Average,Air System Outdoor Air High Humidity Control Status []
HVAC,Average,Air System Outdoor Air Flow Fraction []
HVAC,Average,Air System Outdoor Air Minimum Flow Fraction []
HVAC,Average,Air System Outdoor Air Mass Flow Rate [kg/s]
HVAC,Average,Air System Mixed Air Mass Flow Rate [kg/s]

Air System Outdoor Air Economizer Status []

Reports the average operating status of an air economizer over the reporting interval. The
economizer status is set to 1 when the conditions are favorable for the economizer to operate
(i.e., none of the control limits have been exceeded). While conditions may be favorable for
economizer operation, it does not guarantee that the air-side economizer has increased
outdoor air flow above the minimum level since the actual outdoor air flow rate is also
governed by other controls (e.g., mixed air set point tempeature, time of day economizer
control, maximum humidity setpoint, etc.). This variable is set to 0 if conditions disable
economizer operation or NoEconomizer (Economizer Control Type) is specified.
Air System Outdoor Air Heat Recovery Bypass Status []
This indicates if the controls have determined if the bypass mode for heat recovery is in effect
or not.
Air System Outdoor Air Heat Recovery Bypass Heating Coil Activity Status []
Reports the operating status of any heating coil in the air loop. If the heating coil is active, the
heat exchanger will be activated (no air bypassed) and the heating energy will be reduced or
eliminated. While conditions may be favorable for economizer operation, it does not
guarantee that the air-side economizer has increased outdoor air flow above the minimum
level since the actual outdoor air flow rate is also governed by other controls (e.g., mixed air
set point temperature, time of day economizer control, maximum humidity setpoint, etc.). This
variable is set to 0 if conditions disable economizer operation. This output variable is only
available
when
using
Heat
Recovery
Bypass
Control
Type
=
BypassWhenOAFlowGreaterThanMinimum.
Air System Outdoor Air Heat Recovery Bypass Minimum Outdoor Air Mixed Air
Temperature [C]
Reports the outdoor air mixers mixed air node temperature at minimum outdoor air flow rate
when the heat exchanger is disabled (off). This temperature is calculated as the return air
temperature multiplied by the return air mass flow rate plus the mixers inlet node
temperature multipled by the minimum outdoor air flow rate. This quantity is then divided by
the mixed air mass flow rate. If this temperature is less than the outdoor air mixers mixed air
node set point temperature, and the Heat Recovery Bypass Control Type =
BypassWhenOAFlowGreaterThanMinimum, the outdoor air flow rate is set to the minimum.
This output variable is only available when using Heat Recvoery Bypass Control Type =
BypassWhenOAFlowGreaterThanMinimum.
Air System Outdoor Air High Humidity Control Status []
Reports the average operating status of the controllers high humidity control over the
reporting interval. The high humidity control status is set to 1 when the controller determines
that a zone high humidity condition exists according to the settings specified in the controller.
This variable is set to 0 if conditions disable high humidity control operation or High Humidity
Control is specified as No.

9/29/14

1635

Input-Output Reference

Group Controllers

Air System Outdoor Air Flow Fraction []

Reports the average actual outdoor air fraction for the outdoor air controller over the reporting
interval.
Air System Outdoor Air Minimum Flow Fraction []
Reports the average minimum limit of the outdoor air fraction for the outdoor air controller
over the reporting interval.
Air System Outdoor Air Mass Flow Rate [kg/s]
Reports the average outdoor air mass flow rate introduced by the outdoor air controller over
the reporting interval.
Air System Mixed Air Mass Flow Rate [kg/s]
Reports the average mixed air mass flow rate of the HVAC air loop associated with this
outdoor air controller over the reporting interval.
Controller:MechanicalVentilation
This object is used in conjunction with an outdoor air controller (Ref. Controller:OutdoorAir,
Field: Mechanical Ventilation Controller Name) to establish the minimum outdoor air flow rate
provided by a mixed air box.
Ventilation standards provide guidance on appropriate levels of outdoor ventilation air
required for acceptable indoor air quality. The Ventilation Rate Procedure (VRP) of ASHRAE
Standard 62.1-2007/2010 (www.ashrae.org) requires outdoor ventilation rates to be
determined based on the floor area of each occupied zone plus the number of people in each
zone and considers the zone air distribution effectiveness and system ventilation efficiency.
The outdoor air ventilation rate can be reset dynamically as operating conditions change
(e.g., variations in occupancy). The Controller:MechanicalVentilation object implements the
VRP for calculating these outdoor air ventilation requirements and resetting them based on
varying occupancy levels and zone diversification. This is particularly useful for large air
distribution systems that serve a number of different zone types with varying occupancy
levels. This object can also be used to model the Indoor Air Quality Procedure (IAQP) as
defined in Standard 62.1
The first five inputs for this object are the name, the availability schedule, the zone outdoor
air method, the system outdoor air method, and the zone maximum outdoor air fraction.
The next three input fields define the zone name (or zone list name), the design
specification outdoor air object name, and the design specification zone air distribution
object name to be applied to this zone (or zone list). The last three fields are extensible
Field: Name
The unique user assigned name for an instance of mechanical ventilation. Any other object
referencing this mechanical ventilation object will use this name.
Field: Availability Schedule Name
The name of a schedule whose values are greater than 0 when mechanical ventilation, as
calculated by this object, is desired. If the schedules value is 0.0, then mechanical ventilation
is not available and flow will not be requested. If the schedules value is > 0.0 (usually 1 is
used), mechanical ventilation is available. If this field is blank, the schedule has values of 1
for all time periods. This schedule is useful for purging the building of contaminants prior to
occupancy (i.e., ventilation rate per unit floor area will be provided even if the occupancy is
zero).

9/29/14

1636

Input-Output Reference

Group Controllers

Field: Demand Controlled Ventilation

This field indicates whether the air loop is capable of doing demand controlled ventilation
(DCV) to vary the amount of outdoor air based on actual number of occupants in spaces.
Two choices: Yes and No. Default is No.
Field: System Outdoor Air Method
The method used to calculate the system minimum outdoor air flow. Several choices are
allowed:
ZoneSum,
VentilationRateProcedure,
IndoorAirQualityProcedure,
ProportionalControl, and IndoorAirQualityProcedureGenericContaminant. ZoneSum
sums the outdoor air flows across all zones served by the system. VentilationRateProcedure
(VRP) uses the multi-zone equations defined in 62.1-2007 to calculate the system outdoor air
flow. VRP considers zone air distribution effectiveness and zone diversification of outdoor air
fractions. IndoorAirQualityProcedure (IAQP) is the other procedure defined in ASHRAE
Standard 62.1-2007 for calculate the amount of outdoor air necessary to maintain the levels
of indoor air carbon dioxide at or below the setpoint defined in the
ZoneControl:ContaminantController object. Appendix A of the ASHRAE 62.1-2010 users
manual discusses another method for implementing CO 2-based DCV in a single zone
system. This method (Proportional Control) calculates the required outdoor air flow rate which
varies in proportion to the percentage of the CO 2 signal range. The
IndoorAirQualityProcedure-GenericContaminant method calculates the amount of outdoor air
necessary to maintain the levels of indoor air generic contaminant at or below the setpoint
defined in the ZoneControl:ContaminantController object.
Note:
When
System
Outdoor
Air
Method
=
IndoorAirQualityProcedure
or
IndoorAirQualityProcedureGenericContaminant is specified, only the Zone <x> Name fields are used. The
other field inputs described below are not used.

Field: Zone Maximum Outdoor Air Fraction

This positive numeric input is the zone maximum outdoor air fraction. For VAV systems,
when a zone requires outdoor air higher than the user specified Zone Maximum Outdoor Air
Fraction, the zone supply air flow will be increased (if damper not fully open yet) to cap the
outdoor air fraction at the maximum value. This allows the system level outdoor air flow to be
reduced while the total supply air flow increases to meet zone outdoor air requirement. Valid
values are from 0 to 1.0. Default is 1.0 which indicates zones can have 100% outdoor air
maintaining backward compatibility. This inputs work for single and dual duct VAV systems.
Field Set (Zone Name, Design Specification Outdoor Air Object Name, and Design
Specification Zone Air Distribution Object Name)
The following three fields are needed to define the parameters for the ventilation. This object
is extensible by duplicating these three fields.
Field: Zone <x> Name
The zone name or zone list to
DesignSpecification:OutdoorAir object.

apply

the

ventilation

rates

specified

in

the

Field: Design Specification Outdoor Air Object Name <x>

The name of the DesignSpecification:OutdoorAir object, defining the amount of outdoor air,
that applies to the zone or zone list. If this field is blank, the corresponding
DesignSpecification:OutdoorAir
object
for
the
zone
will
come
from
the
DesignSpecification:OutdoorAir object referenced by the Sizing:Zone object for the same
zone. If no such zone match is found, default values from the IDD will be used for the
DesignSpecification:OutdoorAir object.

9/29/14

1637

Input-Output Reference

Group Controllers

Field: Design Specification Zone Air Distribution Object Name <x>

The name of the DesignSpecification:ZoneAirDistribution object, defining the air distribution
effectiveness and secondary recirculation air fraction, that applies to the zone or zone list. If
this field is blank, the corresponding DesignSpecification:ZoneAirDistribution object for the
zone will come from the DesignSpecification:ZoneAirDistribution object referenced by the
Sizing:Zone object for the same zone. If no such zone match is found, default values from the
IDD will be used for the DesignSpecification:ZoneAirDistribution object.
As described previously, the Controller:MechanicalVentilation object works in conjunction
with Controller:OutdoorAir. As such, the minimum quantity of outdoor air delivered via the
mixed air box will be the greater of:
the minimum outdoor air flow rate calculated by the fields Minimum Outdoor Air Flow
Rate, Minimum Limit and Minimum Outdoor Air Schedule Name in the associated
Controller:OutdoorAir object, or
the outdoor air flow rate calculated by the VRP (details in the Engineering Reference)
with inputs specified in this object and the referenced DesignSpecification:OutdoorAir and
DesignSpecification:ZoneAirDistribution objects.
The actual outdoor air flow rate may be higher than the minimum if free cooling is available.
Regardless, the outdoor air flow rate will not exceed the Maximum Outdoor Air Flow Rate
specified in the associated Controller:OutdoorAir object.
An example input for this object is shown below:
Controller:MechanicalVentilation,
VentObject,
!- Name
VentSchedule,
!- Availability Schedule Name
VentilationRateProcedure, !- System Outdoor Air Method
1.0,
!- Zone Maximum Outdoor Air Fraction
Resistive Zone,
!- Zone 1 Name
DSOA1,
!- Design Specification Outdoor Air Object Name 1
DSZADO1,
!- Design Specification Zone Air Distribution Object Name 1
DCV Zone List,
!- Zone 2 Name
DSO_ZList,
!- Design Specification Outdoor Air Object Name 2
;
!- Design Specification Zone Air Distribution Object Name 2
ZoneList,
DCV Zone List,
!- Zone List Name
East Zone,
!- Zone Name 1
North Zone;
!- Zone Name 2
DesignSpecification:OutdoorAir,
DSOA1,
!- Name
SUM,
!- Outdoor Air Method
0.00236,
!- Outdoor Air Flow per Person
0.000305,
!- Outdoor Air Flow per Zone Floor Area
0.0,
!- Outdoor Air Flow per Zone
0.0,
!- Outdoor Air Flow Air Changes per Hour
;
!- Outdoor Air Flow Rate Fraction Schedule Name
DesignSpecification:ZoneAirDistribution,
DSZADO1,
!- Name
1.2,
!- Zone Air Distribution Effectiveness in Cooling Mode
1.0,
!- Zone Air Distribution Effectiveness in Heating Mode
,
!- Zone Air Distribution Effectiveness Schedule Name
0.3;
!- Zone Secondary Recirculation Fraction

ZoneHVAC:EnergyRecoveryVentilator:Controller
This controller object is used exclusively by the stand alone energy recovery ventilator
(ZoneHVAC:EnergyRecoveryVentilator, see Figure 143). The purpose of this controller is to
simulate economizer operation for the stand alone ERV and provide free cooling whenever
possible or modify the outdoor air flow rate during high indoor humidity conditions. During
economizer operation, if all of the limits are satisfied, the controller activates economizer
mode (fully bypassing the fixed-plate air-to-air heat exchanger or stopping the rotation of a
rotary heat exchanger). If any of the selected limits are exceeded, economizer operation is
9/29/14

1638

Input-Output Reference

Group Controllers

terminated. A time-of-day schedule may also be used to simulate a push-button type

economizer controller.
In addition, the outdoor air flow rate may be modified and heat exchange suspended in
response to high indoor relative humidities. When the indoor relative humidity exceeds the
zone humidistats relative humidity set point, high humidity control is activated. When
activated, if high humidity control is based on the outdoor air humidity ratio and the outdoor
humidity ratio is greater than the indoor humidity ratio, high humidity control is terminated.

Figure 143. Schematic of the ZoneHVAC:EnergyRecoveryVentilator compound object

Field: Name
A unique user-assigned name for the stand alone ERV controller. Any reference to this
controller by another object will use this name.
Field: Temperature High Limit
The input for this field is the outdoor air temperature high limit (C) for economizer operation.
If the outdoor air temperature is above this limit, economizer (free cooling) operation is
terminated. No input (blank) in this field means that there is no outdoor air temperature high
limit control.
Field: Temperature Low Limit
The input for this field is the outdoor air temperature low limit (C) for economizer operation. If
the outdoor air temperature is below this limit, economizer (free cooling) operation is
terminated. No input (blank) in this field means that there is no outdoor air temperature low
limit control.
Field: Enthalpy High Limit
The input for this field is the outdoor air enthalpy limit (in J/kg) for economizer operation. If the
outdoor air enthalpy is above this value, economizer (free cooling) operation is terminated.
No input (blank) in this field means that there is no outdoor air economizer limit control.

9/29/14

1639

Input-Output Reference

Group Controllers

Field: Dewpoint Temperature Limit

Input for this field is the outdoor air dewpoint limit (C) for economizer operation. If the
outdoor air dewpoint temperature is above this value, the outdoor airflow rate will be set to
the minimum. No input (blank) in this field means that there is no outdoor air dewpoint limit
control. This limit applies to the conditions at the Actuated Node regardless of whether or not
there are any other components on the outdoor air path upstream of the mixer.
Field: Electronic Enthalpy Limit Curve Name
Input for this field is the name of a quadratic or cubic curve which provides the maximum
outdoor air humidity ratio (function of outdoor air dry-bulb temperature) for economizer
operation. If the outdoor air humidity ratio is greater than the curves maximum humidity ratio
(evaluated at the outdoor air dry-bulb temperature), the outdoor air flow rate will be set to the
minimum. This limit applies to the conditions at the Actuated Node regardless of whether or
not there are any other components on the outdoor air path upstream of the mixer. No input
(blank) in this field means that there is no electronic enthalpy limit control.
Field: Exhaust Air Temperature Limit
This input establishes whether or not there is a limit control on the exhaust air temperature.
The choices are ExhaustAirTemperatureLimit or NoExhaustAirTemperatureLimit. If
ExhaustAirTemperatureLimit is chosen, the controller deactivates economizer mode
whenever the outdoor air temperature is greater than the exhaust air temperature. If
NoExhaustAirTemperatureLimit is chosen, no limit check on the exhaust air temperature is
performed.
Field: Exhaust Air Enthalpy Limit
This input establishes whether or not there is a limit control on the exhaust air enthalpy. The
choices
are
ExhaustAirEnthalpyLimit
or
NoExhaustAirEnthalpyLimit.
If
ExhaustAirEnthalpyLimit is chosen, the controller deactivates economizer mode whenever
the outdoor air enthalpy is greater than the exhaust air enthalpy. If
NoExhaustAirEnthalpyLimit is chosen, no limit check on the exhaust air enthalpy is
performed.
Field: Time of Day Economizer Flow Control Schedule Name
This alpha field is the name of a schedule which controls the change in air flow rate based on
time-of-day. Schedule values equal to 0 disable this feature. Schedule values greater than 0
activate the economizer. Note that heat exchange between the air streams is suspended
when the economizer is active. This schedule can be used with or without the high humidity
control option. When an economizer is used in conjunction with the high humidity control
option, high humidity control has priority.
Field: High Humidity Control Flag
This optional choice field establishes whether or not the supply and exhaust air flow rates are
modified in response to high indoor relative humidity. Valid choices are Yes and No. If Yes is
selected, the supply and exhaust air flow rates may be modified when the indoor relative
humidity is above the humidstat set point. If No is selected, this option is disabled and the
following three fields are not used. Note that heat exchange between the air streams is
suspended during times when high humidity control is active. The default value is No.
Field: Humidistat Control Zone Name
This optional input defines the zone name where the humidistat is located. This is the same
zone name used in the Zone Control:Humidistat object. This field is required when the High
Humidity Control Flag is specified as Yes.

9/29/14

1640

Input-Output Reference

Group Evaporative Coolers

Field: High Humidity Outdoor Air Flow Ratio

This optional input is the ratio of the modified supply (outdoor) air flow rate to the supply air
flow rate specified in the Energy Recovery Ventilator:Stand Alone ERV object. When the high
humidity control algorithm determines that the supply air flow rate will be changed (i.e.
increased or decreased), the operating supply air flow rate is equal to the supply air flow rate
specified in the Energy Recovery Ventilator:Stand Alone ERV object multiplied by this ratio.
The minimum value for this field is 0. This field is used to modify both the supply and exhasut
air flow rates when high humidity control is active. The supply and exhasut air fan volumetric
flow rates must be able to account for the increase in air flow when this input is greater than
1. The default value is 1.
Field: Control High Indoor Humidity based on Outdoor Humidity Ratio
This optional choice field determines if high humidity control is activated based on high indoor
relative humidity alone or is activated only when the indoor relative humidity is above the
humidstat set point and the outdoor humidity ratio is less than the indoor humidity ratio. Valid
choices are Yes and No. If No is selected, high humidity control is active any time the zone
humidistat senses a moisture load. If yes is selected, the model also verifies that the outdoor
humidity ratio is less than the humidistats zone air humidity ratio. This field is used only when
the High Humidity Control Flag is specified as Yes. The default value is Yes.
Following is an example input for this stand alone ERV controller object:
ZoneHVAC:EnergyRecoveryVentilator:Controller,
ERV OA Controller 1,
!- ERV controller name
19.,
!- Temperature high limit {C}
14.,
!- Temperature low limit {C}
,
!- Enthalpy high limit {J/kg}
15.55,
!- dew point temperature limit (C)
ElectronicEnthalpyCurveA,
!- electronic enthalpy limit curve name
NoExhaustAirTemperatureLimit,
!- Exhaust air temperature limit
NoExhaustAirEnthalpyLimit,
!- Exhaust air enthalpy limit
OutsideAirFlowSchedule,
!- Time of Day Economizer Flow Control Schedule Name
Yes,
!- High Humidity Control Flag
East Zone,
!- Humidistat Control Zone Name
1.2,
!- High Humidity Outdoor air Flow Ratio
Yes;
!- Control High Indoor Humidity based on Outdoor Humidity Ratio
Curve:Cubic,
ElectronicEnthalpyCurveA,
0.01342704,
-0.00047892,
0.000053352,
-0.0000018103,
16.6,
29.13;

!!!!!!!-

Name
Coefficient1 Constant
Coefficient2 x
Coefficient3 x**2
Coefficient4 x**3
Minimum Value of x
Maximum Value of x

Group Evaporative Coolers

This group of objects describes the properties and configuration for the evaporative coolers
models for the HVAC section.
EvaporativeCooler:Direct:CelDekPad
The direct stage, shown in the figure below, consists of a rigid media evaporative pad, with
water recirculated from a reservoir. The water is pumped from the reservoir to a water
distribution header, for water feed by gravity from above the media. The evaporative pad
provides the area for the adiabatic saturation of the air. While the process provides a lower
dry-bulb temperature, the moisture content of the leaving air is higher than the entering
condition. The direct stage is used for comfort cooling in a building where adding humidity to
the air can be tolerated.

9/29/14

1641

Input-Output Reference

Group Evaporative Coolers

E vapo ra ti ve
Medi a

S upp ly A ir
Fl ow

S ump

Figure 144. Direct Stage Evaporative Cooler

The thermodynamic process is a simultaneous heat and mass transfer, or adiabatic cooling,
and follows a constant enthalpy line on the psychrometric chart, it is shown in the figure
below as a process from A to B. Since the deviation of the constant wet-bulb line and the
constant enthalpy line is small, it is assumed that the wet-bulb temperature is constant across
the direct evaporative stage.
80

16 0
14 0
12 0

B
10 0

We t-Bulb Temp [F]

60

80
60

50
40

40

30

20

Humidity Ratio [Grains/Lb

70

Dry Air]

18 0

0
30

40

50

60
70
80
Dry-Bulb Temp [F]

90

10 0

11 0

Figure 145. Psychrometric Chart -- Constant Enthalpy

If the direct evaporative process were 100% efficient, the leaving dry-bulb temperature would
equal the entering wet-bulb temperature. The efficiency of the direct evaporative process is
less than 100% and by defining saturation efficiency ( se) for the direct stage or evaporative
pad, the leaving dry-bulb temperature can be expressed by the following equation.

Tdb supout

Tdb supin

se

Tdb supin Twb supin

Field: Name
A unique identifying name for each evaporative cooler.
Field: Availability Schedule Name
The name of a schedule which defines when the evaporative cooler is available. A schedule
value of 0 indicates that the evaporative cooler is off for that time period. A schedule value
9/29/14

1642

Input-Output Reference

Group Evaporative Coolers

greater than 0 indicates that the evaporative cooler can operate during the time period. If this
field is blank, the schedule has values of 1 for all time periods.
Field: Direct Pad Area
The face area of the evaporative pad in m 2. With the area and mass flow rate, the air velocity
is calculated and is used to determine the saturation efficiency. This field is autosizable.
Field: Direct Pad Depth
The depth of the evaporative pad in meters.
saturation efficiency. This field is autosizable.

The pad depth is used to determine the

Field: Recirculating Water Pump Power Consumption

This field is used to specify the power consumed by the evaporative cooler recirculating
pump in Watts.
Field: Air Inlet Node Name
The name of the evaporative cooler air inlet node from the Air Loop Simulation.
Field: Air Outlet Node Name
The name of the evaporative cooler air outlet node from the Air Loop Simulation.
Field: Control Type
This input field is currently unused and can be left blank.
Field: Water Supply Storage Tank Name
This field is optional. It is used to describe where the cooler obtains water used for
evaporative cooling. If blank or omitted, then the cooler will obtain water directly from the
mains. If the name of a WaterUse:Storage object is used here, then the cooler will obtain its
water from that tank. If a tank is specified, the cooler will attempt to obtain all the water it uses
from the tank. However if the tank cannot provide all the water the cooler needs, then the
cooler will still operate and obtain the rest of the water it needs from the mains.
An IDF example showing how this object is:
EvaporativeCooler:Direct:CelDekPad,
Evaporative Cooler,
!- Name
System Availability Schedule, !- Availability Schedule Name
0.6,
!- Direct Pad Area {m2}
0.2,
!- Direct Pad Depth {m}
225,
!- Recirculating Water Pump Power Consumption {W}
Evap Cooler Inlet Node, !- Air Inlet Node Name
Supply Outlet Node;
!- Air Outlet Node Name

EvaporativeCooler:Direct:CelDekPad Outputs
The output variables that are available for this direct evaporative cooler are shown below:
HVAC,Average, Evaporative Cooler Wet Bulb Effectiveness
HVAC,Average, Evaporative Cooler Electric Power[W]
HVAC,Sum, Evaporative Cooler Electric Energy [J]
HVAC,Sum, Evaporative Cooler Water Volume[m3]
HVAC,Sum,Evaporative Cooler Mains Water Volume [m3]
HVAC,Sum,Evaporative Cooler Storage Tank Water Volume [m3]
HVAC,Sum,Evaporative Cooler Starved Water Volume [m3]
HVAC,Sum,Evaporative Cooler Starved Mains Water Volume [m3]

Evaporative Cooler Wet Bulb Effectiveness

The effectivenss, or saturation efficiency, is the temperature change of the supply air divided
by the difference between the inlet air dry-bulb and wet-bulb temperatures. In other words, it
is a measure of the approach to the inlet air wet-bulb temperature.

9/29/14

1643

Input-Output Reference

Group Evaporative Coolers

Evaporative Cooler Electric Power[W]

Evaporative Cooler Electric Energy [J]
These output variables report the electric power and electric energy required to operate the
water pump.
Evaporative Cooler Water Volume [m3]
The water consumption is the water evaporated from the pad. This water consumption is
only from the direct thermodynamics of water evaporation and does not include other sources
of consumption such as drift or concentration blow down. This output variable appears when
mains water is supplied to the cooler.
Evaporative Cooler Mains Water Volume [m3]
This is the source of the water consumed. This output variable appears when mains water is
supplied to the cooler.
Evaporative Cooler Storage Tank Water Volume [m3]
The water consumption is the water evaporated from the pad. This water consumption is
only from the direct thermodynamics of water evaporation and does not include other sources
of consumption such as drift or concentration blow down. This output variable appears when
storage tank water is supplied to the cooler.
Evaporative Cooler Starved Water Volume [m3]
This is the water consumed by the evaporative cooler that could not accually be met by the
storage tank. This output variable appears when storage tank water is supplied to the cooler.
Evaporative Cooler Starved Mains Water Volume [m3]
This is the source (mains) of water consumed by the evaporative cooler that could not
accually be met by the storage tank. This output variable appears when storage tank water is
supplied to the cooler.
EvaporativeCooler:Direct:ResearchSpecial
This cooler is similar in principal to the EvaporativeCooler:Direct:CelDekPad. The model
differs in that it gives the user a simple way of specify the cooler effectiveness. Using the
ResearchSpecial input object also allows the cooler to control the amount of cooling based
on node setpoints (controlled by SetpointManagers). This avoid problems from over cooling
when conditions are such that loads are low and cooling power is high. Water pump power is
assumed to vary linearly when the cooler is operating at less than full capacity.
Field: Name
A unique identifying name for each cooler.
Field: Availability Schedule Name
The name of a schedule that defines when the evaporative cooler is available. A schedule
value of 0 indicates that the evaporative cooler is off for that time period. A schedule value
greater than 0 indicates that the evaporative cooler can operate during the time period. If this
field is blank, the schedule has values of 1 for all time periods.
Field: Cooler Effectiveness
This field specifies the effectiveness that is applied to the wetbulb depression to determine
the conditions leaving the cooler. This model assumes that the effectiveness is constant.
Field: Recirculationg Water Pump Power Consumption
This field is used to specify the power consumed by the water pump that circulates water in
Watts.
9/29/14

1644

Input-Output Reference

Group Evaporative Coolers

Field: Air Inlet Node Name

The name of the air inlet node for the primary air flow path through the cooler.
Field: Air Outlet Node Name
The name of the air outlet node for the primary air flow path through the cooler.
Field: Sensor Node Name
This field specifies the name of a node that will provide system air temperature setpoint
information. A separate SetpointManager object should be setup to update this node.
Field: Water Supply Storage Tank Name
This field is optional. It is used to describe where the cooler obtains water used for
evaporative cooling. If blank or omitted, then the cooler will obtain water directly from the
mains. If the name of a WaterUse:Storage object is used here, then the cooler will obtain its
water from that tank. If a tank is specified, the cooler will attempt to obtain all the water it uses
from the tank. However, if the tank cannot provide all the water the cooler needs, then the
cooler will still operate and obtain the rest of the water it needs from the mains.
Field: Drift Loss Fraction
This field is optional and can be used to model additional water consumed by the cooler from
drift. Drift is water that leaves the cooling media as droplets and does not evaporate into the
process air stream. For example, water may get blown off the evaporative media by winds
and escape the air system. The value entered here is a simple fraction of the water
consumed by the cooler for normal process evaporation. The amount of drift is this fraction
times the water evaporated for the normal cooling process. This field can be left blank and
then there will be no added water consumption from drift.
Field: Blowdown Concentration Ratio
This field is optional and can be used to model additional water consumed by the cooler from
blowdown. Blowdown is water that is intentionally drained from the coolers sump to offset
the build up of solids in the water that would otherwise occur because of evaporation. The
value entered here is dimensionless. It can be characterized as the ratio of solids in the
blowdown water to solids in the make up water. Typical values are 3 to 5. The default is 3.0.
An example IDF entry is
EvaporativeCooler:Direct:ResearchSpecial,
Direct Evap Cooler, !- Name
ALWAYS_ON, !- Availability Schedule Name
0.7 , !- Cooler Effectiveness
30.0 , !- Recirculating Water Pump Power Consumption
OAIndRDD Evap Cooler- OADirect Evap CoolerNode , !- Air Inlet Node Name
OADirect Evap Cooler- OAMixing BoxNode, !- Air Outlet Node Name
OADirect Evap Cooler- OAMixing BoxNode, !- Sensor Node Name
, !- Water Supply Storage Tank Name
0.0, !- Drift Loss Fraction
3; !- Blowdown Concentration Ratio

EvaporativeCooler:Direct:ResearchSpecial Outputs
The output variables that are available for this direct evaporative cooler are shown below:

9/29/14

1645

Input-Output Reference

Group Evaporative Coolers

HVAC,Average, Evaporative Cooler Electric Power[W]

HVAC,Sum, Evaporative Cooler Electric Energy [J]
HVAC,Sum, Evaporative Cooler Water Volume[m3]
HVAC,Sum,Evaporative Cooler Mains Water Volume [m3]
HVAC,Sum,Evaporative Cooler Storage Tank Water Volume [m3]
HVAC,Sum,Evaporative Cooler Starved Water Volume [m3]
HVAC,Sum,Evaporative Cooler Starved Mains Water Volume [m3]

Evaporative Cooler Electric Power[W]

Evaporative Cooler Electric Energy [J]
These output variables report the electric power and electric energy required to operate the
water pump.
Evaporative Cooler Water Volume [m3]
The water consumption is the water evaporated from the pad. This water consumption is
only from the direct thermodynamics of water evaporation and does not include other sources
of consumption such as drift or concentration blow down. This output variable appears when
mains water is supplied to the cooler.
Evaporative Cooler Mains Water Volume [m3]
This is the source of the water consumed. This output variable appears when mains water is
supplied to the cooler.
Evaporative Cooler Storage Tank Water Volume [m3]
The water consumption is the water evaporated from the pad. This water consumption is
only from the direct thermodynamics of water evaporation and does not include other sources
of consumption such as drift or concentration blow down. This output variable appears when
storage tank water is supplied to the cooler.
Evaporative Cooler Starved Water Volume [m3]
This is the water consumed by the evaporative cooler that could not accually be met by the
storage tank. This output variable appears when storage tank water is supplied to the cooler.
Evaporative Cooler Starved Mains Water Volume [m3]
This is the source (mains) of water consumed by the evaporative cooler that could not
accually be met by the storage tank. This output variable appears when storage tank water is
supplied to the cooler.
EvaporativeCooler:Indirect:CelDekPad
The dry coil indirect evaporative cooler, shown in the figure below, has a rigid media pad,
similar to the direct evaporative stage, where the adiabatic cooling takes place. The
secondary air leaves the rigid media pad and enters an air to air heat exchanger where it
cools the supply air flowing through the heat exchanger tubes. The moist secondary air is
then exhausted to the environment. The secondary air stream has its own fan and consists of
a rigid media evaporative pad, with water recirculated from a reservoir. The water is pumped
from the reservoir to a water distribution header, for water feed by gravity from above the
media. The evaporative pad provides the area for the adiabatic saturation of the air.

9/29/14

1646

Input-Output Reference

Group Evaporative Coolers

D

S eco nda ry Fa n

S upp ly A ir
Fl ow

Air-To-Air Heat Exchang er

A mbi ent Co ndi tio ns

T db, Twb

E vapo ra ti ve Medi a

S eco nda ry A ir
Fl ow

S ump

Figure 146. Evaporative Cooler -- Indirect Dry Coil

The process that the secondary air goes through, A to C to D, is shown by the dashed lines in
the following figure. Process A to C is adiabatic cooling in the rigid media pad. Then the air
enters the shell side of the heat exchanger and is sensibly heated from C to D by the warm
supply air passing through the tube side. The secondary air inlet is modeled as a separate
stream of outdoor air and the user has the option of defining the name of an outdoor air node.
80

16 0
14 0
12 0

D
10 0

We t-Bulb Temp [F]

60

80
60

50
40

40

30

20

Humidity Ratio [Grains/Lb

70

Dry Air]

18 0

0
30

40

50

60
70
80
Dry-Bulb Temp [F]

90

10 0

11 0

Figure 147. Secondary Air Process -- Indirect Dry Coil Evap Cooler
The advantage of the dry coil heat exchanger is that the heat exchanger does not have the
evaporation taking place on the outside of the tubes, thus no mineral deposits are left on the
heat exchange surface to reduce the efficiency of the heat exchanger. The rigid media pads
are designed to flush the mineral deposits to the sump, so the saturation efficiency of the pad
stays relatively constant.
Field: Name
A unique identifying name for each evaporative cooler.
Field: Availability Schedule Name
The name of a schedule which defines when the evaporative cooler is available. A schedule
value of 0 indicates that the evaporative cooler is off for that time period. A schedule value
greater than 0 indicates that the evaporative cooler can operate during the time period. If this
field is blank, the schedule has values of 1 for all time periods.

9/29/14

1647

Input-Output Reference

Group Evaporative Coolers

Field: Direct Pad Area

The face area of the evaporative pad in m 2. With the area and mass flow rate, the air velocity
is calculated and is used to determine the saturation efficiency on the secondary side of the
evaporative cooler. This field is autosizable.
Field: Direct Pad Depth
The depth of the evaporative pad in meters. The pad depth is used to determine the
saturation efficiency on the secondary side of the evaporative cooler. This field is autosizable.
Field: Recirculating Water Pump Power Consumption
This field is used to specify the power consumed by the evaporative cooler recirculating
pump in Watts.
Field: Secondary Fan Flow Rate
This field is used to specify the secondary fan flow rate and is specified in m 3/sec.
Field: Secondary Fan Total Efficiency
This value is the overall efficiency of the fan, i.e., the ratio of the power delivered to the fluid
to the electrical input power. It is the product of the motor efficiency and the impeller
efficiency. The motor efficiency is the power delivered to the shaft divided by the electrical
power input to the motor. The impeller efficiency is power delivered to the fluid (air) divided by
the shaft power. The power delivered to the fluid is the mass flow rate of the air multiplied by
the pressure rise divided by the air density. This input value must be between 0 and 1.
Field: Secondary Fan Delta Pressure
This field is used to specify the delta pressure across the secondary stage of the evaporative
cooler in Pascals.
Field: Indirect Heat Exchanger Effectiveness
This field is used to specify the effectiveness of the indirect heat exchanger between the
primary and secondary air flow.
Field: Primary Air Inlet Node Name
The name of the evaporative coolers primary air inlet node from the Air Loop Simulation.
This is the air flow being cooled indirectly.
Field: Primary Air Outlet Node Name
The name of the evaporative coolers primary air outlet node from the Air Loop Simulation.
Field: Control Type
This input field is currently unused and can be left blank.
Field: Water Supply Storage Tank Name
This field is optional. It is used to describe where the cooler obtains water used for
evaporative cooling. If blank or omitted, then the cooler will obtain water directly from the
mains. If the name of a WaterUse:Storage object is used here, then the cooler will obtain its
water from that tank. If a tank is specified, the cooler will attempt to obtain all the water it uses
from the tank. However if the tank cannot provide all the water the cooler needs, then the
cooler will still operate and obtain the rest of the water it needs from the mains.
Field: Secondary Air Inlet Node Name
This field is optional. It is used to explicitly define an outdoor air node for the inlet for
secondary air stream. Defining an outdoor air node here allows using the height-dependent
model for outdoor air conditions.
9/29/14

1648

Input-Output Reference

Group Evaporative Coolers

And an IDF example showing how this object is specified:

EvaporativeCooler:Indirect:CelDekPad,
IndirectEvapCooler1,
!- Name
FanAndCoilAvailSched,
!- Availability Schedule Name
0.6,
!- Direct Pad Area {m2}
0.2,
!- Direct Pad Depth {m}
225.,
!- Recirculating Water Pump Power Consumption {W}
1.0,
!- Secondary Fan Flow Rate {m3/s}
0.7,
!- Secondary Fan Total Efficiency
200.0,
!- Secondary Fan Delta Pressure {Pa}
0.67,
!- Indirect Heat Exchanger Effectiveness
EvapCoolerIndirectInletAirNode, !- Primary Air Inlet Node Name
EvapCoolerDirectInletAirNode, !- Primary Air Outlet Node Name
,
!- Control Type
,
!- Water Supply Storage Tank Name
Secondary side OA inlet node; !- Secondary Air Inlet Node Name

EvaporativeCooler:Indirect:CelDekPad Outputs
The output variables that are available for the indirect dry evaporative cooler are shown
below:
HVAC,Average, Evaporative Cooler Wetbulb Effectiveness
HVAC,Average, Evaporative Cooler Total Stage Effectiveness
HVAC,Average, Evaporative Cooler Electric Power[W]
HVAC,Sum, Evaporative Cooler Electric Energy [J]
HVAC,Sum, Evaporative Cooler Water Volume[m3]
HVAC,Sum,Evaporative Cooler Mains Water Volume [m3]
HVAC,Sum,Evaporative Cooler Storage Tank Water Volume [m3]
HVAC,Sum,Evaporative Cooler Starved Water Volume [m3]
HVAC,Sum,Evaporative Cooler Starved Mains Water Volume [m3]

Evaporative Cooler Wetbulb Effectiveness

The dry evaporation saturation efficiency is the saturation efficiency of the secondary or wet
side air stream defined as the temperature change of the supply air divided by the difference
between the outdoor dry-bulb and wet-bulb temperatures. In other words, it is a measure of
the approach to the outdoor wet-bulb temperature.
Evaporative Cooler Total Stage Effectiveness
The total stage efficiency includes the sensible heat exchanger effectiveness of the heat
exchanger in the supply air stream. It is the saturation efficiency multiplied by the heat
exchanger effectiveness.
Evaporative Cooler Electric Power[W]
Evaporative Cooler Electric Energy [J]
These output variables report the electric power and energy consumed by the secondary air
fan and the sump pump.
Evaporative Cooler Water Volume[m3]
The water consumption is the water evaporated from the pad. This water consumption is
only from the direct thermodynamics of water evaporation and does not include other sources
of consumption such as drift or concentration blow down. This output variable appears when
mains water is supplied to the cooler.
Evaporative Cooler Mains Water Volume [m3]
This is the source of the water consumed. This output variable appears when mains water is
supplied to the cooler.
Evaporative Cooler Storage Tank Water Volume [m3]
The water consumption is the water evaporated from the pad. This water consumption is
only from the direct thermodynamics of water evaporation and does not include other sources
9/29/14

1649

Input-Output Reference

Group Evaporative Coolers

of consumption such as drift or concentration blow down. This output variable appears when
storage tank water is supplied to the cooler.
Evaporative Cooler Starved Water Volume [m3]
This is the water consumed by the evaporative cooler that could not accually be met by the
storage tank. This output variable appears when storage tank water is supplied to the cooler.
Evaporative Cooler Starved Mains Water Volume [m3]
This is the source (mains) of water consumed by the evaporative cooler that could not
accually be met by the storage tank. This output variable appears when storage tank water is
supplied to the cooler.
EvaporativeCooler:Indirect:WetCoil
The wetted coil evaporative cooler shown in the figure below, has water sprayed directly on
the tubes of the heat exchanger where latent cooling takes place. The vaporization of the
water on the outside of the heat exchanger tubes allows the simultaneous heat and mass
transfer which removes heat from the supply air on the tube side. Then the moist secondary
air is exhausted. The secondary air stream has its own fan.
C
S eco nda ry Fa n

T s up in

T s ec out

Wetted Coil Heat Exc hange r

T s up out

A mbi ent Co ndi tio ns

T db, Twb

T s ec in

A
S ump

Figure 148. Evaporative Cooler Indirect Wet Coil

The process that the secondary air goes through, A to C on the following figure, is a path of
simultaneous heat and mass transfer, but it does not follow a line of constant enthalpy as in
the direct stage. The process is not adiabatic due to the heat gain from the supply air flowing
through the tubes of the heat exchanger.

9/29/14

1650

Input-Output Reference

Group Evaporative Coolers

80

16 0
14 0
12 0
C
10 0

We t-Bulb Temp [F]

60

80
60

50
40

40

30

20

Humidity Ratio [Grains/Lb

70

Dry Air]

18 0

0
30

40

50

60
70
80
Dry-Bulb Temp [F]

90

10 0

11 0

Figure 149. Secondary Air Process Indirect Wet Coil Evap Cooler
The wet coil heat exchanger can have a higher stage efficiency than the dry coil due to a
higher heat transfer rate on the outside of the heat exchanger tubes. Over the operating
lifetime of the heat exchanger, the vaporization taking place on the heat exchange surface
can leave mineral deposits which will decrease the effectiveness of the heat exchanger.
Field: Name
A unique identifying name for each evaporative cooler.
Field: Availability Schedule Name
The name of a schedule which defines when the evaporative cooler is available. A schedule
value of 0 indicates that the evaporative cooler is off for that time period. A schedule value
greater than 0 indicates that the evaporative cooler can operate during the time period. If this
field is blank, the schedule has values of 1 for all time periods.
Field: Coil Maximum Efficiency
The maximum efficiency of the stage is a combination of the efficiency due to the
simultaneous heat and mass transfer on the outside of the tube and the efficiency of the heat
exchanger. This value can be higher than the dry coil overall efficiency since the convective
coefficients on the outside of the tube are larger.
Field: Coil Flow Ratio
The Coil Flow Ratio is determined from performance data. The Coil Flow Ratio tells how
quickly the efficiency of the stage would decrease with a mismatch of the supply and
secondary flows.
Field: Recirculating Water Pump Power Consumption
This field is used to specify the power consumed by the evaporative cooler recirculating
pump in Watts.
Field: Secondary Fan Flow Rate
This field is used to specify the secondary fan flow rate and is specified in m3/sec.
Field: Secondary Fan Total Efficiency
This value is the overall efficiency of the fan, i.e., the ratio of the power delivered to the fluid
to the electrical input power. It is the product of the motor efficiency and the impeller
efficiency. The motor efficiency is the power delivered to the shaft divided by the electrical
power input to the motor. The impeller efficiency is power delivered to the fluid (air) divided by
9/29/14

1651

Input-Output Reference

Group Evaporative Coolers

the shaft power. The power delivered to the fluid is the mass flow rate of the air multiplied by
the pressure rise divided by the air density. This input value must be between 0 and 1..
Field: Secondary Fan Delta Pressure
This field is used to specify the delta pressure across the secondary stage of the evaporative
cooler in Pascals.
Field: Primary Air Inlet Node Name
The name of the evaporative cooler air inlet from the Air Loop Simulation.
Field: Primary Air Outlet Node Name
The name of the evaporative cooler air outlet from the Air Loop Simulation.
Field: Control Type
This input field is currently unused and can be left blank.
Field: Water Supply Storage Tank Name
This field is optional. It is used to describe where the cooler obtains water used for
evaporative cooling. If blank or omitted, then the cooler will obtain water directly from the
mains. If the name of a WaterUse:Storage object is used here, then the cooler will obtain its
water from that tank. If a tank is specified, the cooler will attempt to obtain all the water it uses
from the tank. However if the tank cannot provide all the water the cooler needs, then the
cooler will still operate and obtain the rest of the water it needs from the mains.
Field: Secondary Air Inlet Node Name
This field is optional. It is used to explicitly define an outdoor air node for the inlet for
secondary air stream. Defining an outdoor air node here allows using the height-dependent
model for outdoor air conditions.
Field: Drift Loss Fraction
This field is optional and can be used to model additional water consumed by the cooler from
drift. Drift is water that leaves the cooling media as droplets and does not evaporate into the
process air stream. For example, water may get blown off the evaporative media by winds
and escape the air system. The value entered here is a simple fraction of the water
consumed by the cooler for normal process evaporation. The amount of drift is this fraction
times the water evaporated for the normal cooling process. This field can be left blank and
then there will be no added water consumption from drift.
Field: Blowdown Concentration Ratio
This field is optional and can be used to model additional water consumed by the cooler from
blowdown. Blowdown is water that is intentionally drained from the coolers sump to offset
the build up of solids in the water that would otherwise occur because of evaporation. The
value entered here is dimensionless. It can be characterized as the ratio of solids in the
blowdown water to solids in the make up water. Typical values are 3 to 5. The default is 3.0.
And an IDF example showing how this object is specified:

9/29/14

1652

Input-Output Reference

Group Evaporative Coolers

EvaporativeCooler:Indirect:WetCoil,
IndirectEvapCooler1,
!- Name
FanAndCoilAvailSched,
!- Availability Schedule Name
0.8,
!- Coil Maximum Efficiency
0.16,
!- Coil Flow Ratio
225.,
!- Recirculating Water Pump Power Consumption {W}
1.0,
!- Secondary Fan Flow Rate {m3/s}
0.7,
!- Secondary Fan Total Efficiency
200.0,
!- Secondary Fan Delta Pressure {Pa}
EvapCoolerIndirectInletAirNode, !- Primary Air Inlet Node Name
EvapCoolerDirectInletAirNode, !- Primary Air Outlet Node Name
,
!- Control Type
,
!- Water Supply Storage Tank Name
Secondary side OA inlet node; !- Secondary Air Inlet Node Name

EvaporativeCooler:Indirect:WetCoil Outputs
The output variables that are available for the wet indirect evaporative cooler are shown
below:
HVAC,Average, Evaporative Cooler Total Stage Effectiveness
HVAC,Average, Evaporative Cooler Electric Power[W]
HVAC,Sum, Evaporative Cooler Electric Energy [J]
HVAC,Sum, Evaporative Cooler Water Volume[m3]
HVAC,Sum,Evaporative Cooler Mains Water Volume [m3]
HVAC,Sum,Evaporative Cooler Storage Tank Water Volume [m3]
HVAC,Sum,Evaporative Cooler Starved Water Volume [m3]
HVAC,Sum,Evaporative Cooler Starved Mains Water Volume [m3]

Evaporative Cooler Total Stage Effectiveness []

The Total Stage Efficiency is defined as the temperature change of the supply air divided by
the difference between the outdoor dry-bulb and wet-bulb temperatures, including the effect
of the reduction in flow because of the secondary air stream. In other words, it is a measure
of the approach to the outdoor wet-bulb temperature.
Evaporative Cooler Electric Power [W]
Evaporative Cooler Electric Energy [J]
These output variables report the electric power and energy that are consumed by the
secondary air fan and the sump pump.
Evaporative Cooler Water Volume [m3]
The water consumption is the water evaporated from the pad. This water consumption is
only from the direct thermodynamics of water evaporation and does not include other sources
of consumption such as drift or concentration blow down. This output variable appears when
mains water is supplied to the cooler.
Evaporative Cooler Mains Water Volume [m3]
This is the source of the water consumed. This output variable appears when mains water is
supplied to the cooler.
Evaporative Cooler Storage Tank Water Volume [m3]
The water consumption is the water evaporated from the pad. This water consumption is
only from the direct thermodynamics of water evaporation and does not include other sources
of consumption such as drift or concentration blow down. This output variable appears when
storage tank water is supplied to the cooler.
Evaporative Cooler Starved Water Volume [m3]
This is the water consumed by the evaporative cooler that could not accually be met by the
storage tank. This output variable appears when storage tank water is supplied to the cooler.
9/29/14

1653

Input-Output Reference

Group Evaporative Coolers

Evaporative Cooler Starved Mains Water Volume [m3]

This is the source (mains) of water consumed by the evaporative cooler that could not
accually be met by the storage tank. This output variable appears when storage tank water is
supplied to the cooler.
EvaporativeCooler:Indirect:ResearchSpecial
This cooler is similar in principal to the EvaporativeCooler:Indirect:CelDekPad and
EvaporativeCooler:Indirect:WetCoil (see Figure 147, Figure 148, and Figure 149). The model
differs in that it gives the user more flexibility to specify the source of secondary air. The
cooler effectiveness with respect to wetbulb depression is allowed to go beyond 1.0. Using
the ResearchSpecial input object also allows the cooler to control the amount of cooling
based on node setpoints (controlled by SetpointManagers). This avoid problems from over
cooling when conditions are such that loads are low and cooling power is high. Fan power is
assumed to vary linearly when the cooler is operating at less than full capacity.
Field: Name
A unique identifying name for each cooler.
Field: Availability Schedule Name
The name of a schedule that defines when the evaporative cooler is available. A schedule
value of 0 indicates that the evaporative cooler is off for that time period. A schedule value
greater than 0 indicates that the evaporative cooler can operate during the time period. If this
field is blank, the schedule has values of 1 for all time periods.
Field: Cooler Maximum Effectiveness
This field specifies the maximum effectiveness that is applied to the wetbulb depression to
determine the conditions leaving the cooler. This effectiveness is a complicated function of
the efficiency with which heat and mass are transferred on the secondary side and the
efficiency of heat exchange between the secondary and primary flows. The model assumes
that the effectiveness is constant.
Field: Cooler Flow Ratio
Not used in this model.
Field: Recirculating Water Pump Power Consumption
This field is used to specify the power consumed by the water pump that circulates water in
Watts. The pump power and energy consumption is reduced by cycling when the amount of
cooling needs to be restricted for control purposes.
Field: Secondary Fan Flow Rate
This field is used to specify the secondary fan flow rate and is specified in m 3/s. This flow rate
would typically be similar in magnitude to the flow through the primary side. This field can be
autosized. When it is autosized, the program detects if the component is in the main air loop
or on an outdoor air path. If it is on the main air loop, then the flow rate is set to the
AirLoopHVAC systems design supply air flow rate (which is the maximum required for
heating and cooling). If it is on the outdoor air path, then the flow rate is set to the larger of
either the design minimum outdoor air flow rate or one-half of the main air loop design flow
rate. The flow rate is used to determine parasitic fan energy and does not impact the
modeling of cooler effectiveness. The flow rate (and fan power) is effectively reduced by
cycling when the amount of cooling needs to be restricted for control purposes.
Field: Secondary Fan Total Efficiency
This value is the overall efficiency of the fan, i.e., the ratio of the power delivered to the fluid
to the electrical input power. It is the product of the motor efficiency and the impeller
9/29/14

1654

Input-Output Reference

Group Evaporative Coolers

efficiency. The motor efficiency is the power delivered to the shaft divided by the electrical
power input to the motor. The impeller efficiency is power delivered to the fluid (air) divided by
the shaft power. The power delivered to the fluid is the mass flow rate of the air multiplied by
the pressure rise divided by the air density. This input value must be between 0 and 1.
Field: Secondary Fan Delta Pressure
This field is used to specify the pressure difference in Pascals experienced by the secondary
fan as it moves air through the wet side of the cooler.
Field: Primary Air Inlet Node Name
The name of the air inlet node for the primary air flow path through the cooler.
Field: Primary Air Outlet Node Name
The name of the air outlet node for the primary air flow path through the cooler.
Field: Control Type
This input field is not used by this model. But using this model does implement controlling of
the primary outlet temperature.
Field: Dewpoint Effectiveness Factor
This field specifies an effectiveness that is applied to the dewpoint depression to determine a
bound for the conditions leaving the cooler. The model uses the warmer of the two
temperatures determined from wetbulb depression and dewpoint depression.
Field: Secondary Air Inlet Node Name
This field specifies the name of the node providing air to the secondary/wet side of the cooler.
Typically this node could appear in an outdoor air node list or be part of an air system loop.
Field: Sensor Node Name
This field specifies the name of a node that will provide system air temperature setpoint
information. A separate SetpointManager object should be setup to update this node.
Field: Relief Air Inlet Node Name
This field is optional, but can be used to feed two sources of secondary air into the wet side
of the cooler. Typical use is to run the air system relief air into the system. The model first
uses all of the air flow available from this node and then adds the air flow from the secondary
air inlet node to make up the total defined by Secondary Fan Flow Rate.
Field: Water Supply Storage Tank Name
This field is optional. It is used to describe where the cooler obtains water used for
evaporative cooling. If blank or omitted, then the cooler will obtain water directly from the
mains. If the name of a WaterUse:Storage object is used here, then the cooler will obtain its
water from that tank. If a tank is specified, the cooler will attempt to obtain all the water it uses
from the tank. However, if the tank cannot provide all the water the cooler needs, then the
cooler will still operate and obtain the rest of the water it needs from the mains.
Field: Drift Loss Fraction
This field is optional and can be used to model additional water consumed by the cooler from
drift. Drift is water that leaves the cooling media as droplets and does not evaporate into the
process air stream. For example, water may get blown off the evaporative media by winds
and escape the air system. The value entered here is a simple fraction of the water
consumed by the cooler for normal process evaporation. The amount of drift is this fraction
times the water evaporated for the normal cooling process. This field can be left blank and
then there will be no added water consumption from drift.

9/29/14

1655

Input-Output Reference

Group Evaporative Coolers

Field: Blowdown Concentration Ratio

This field is optional and can be used to model additional water consumed by the cooler from
blowdown. Blowdown is water that is intentionally drained from the coolers sump to offset
the build up of solids in the water that would otherwise occur because of evaporation. The
value entered here is dimensionless. It can be characterized as the ratio of solids in the
blowdown water to solids in the make up water. Typical values are 3 to 5. The default is 3.0.
An IDF example is shown below:
EvaporativeCooler:Indirect:ResearchSpecial,
Indirect Evap ZN1,
!- Name
On_Except_Winter_Night, !- Availability Schedule Name
1.2,
!- Cooler Maximum Effectiveness
,
!- Cooler Flow Ratio
30,
!- Recirculating Water Pump Power Consumption {W}
autosize,
!- Secondary Fan Flow Rate {m3/s}
0.7,
!- Secondary Fan Total Efficiency
300,
!- Secondary Fan Delta Pressure {Pa}
Mixed Air Node ZN1,
!- Primary Air Inlet Node Name
Evap Cooler Outlet Node ZN1, !- Primary Air Outlet Node Name
,
!- Control Type
0.9,
!- Dewpoint Effectiveness Factor
Purge Air Inlet ZN1,
!- Secondary Air Inlet Node Name
Air Loop Outlet Node ZN1,!- Sensor Node Name
Relief Air Outlet Node ZN1; !- Relief Air Inlet Node Name

EvaporativeCooler:Indirect:ResearchSpecial Outputs
The output variables that are available for the EvaporativeCooler:Indirect:ResearchSpecial
object are shown below:
HVAC,Average,Evaporative Cooler Total Stage Effectiveness
HVAC,Average,Evaporative Cooler Part Load Ratio
HVAC,Average,Evaporative Cooler Dewpoint Bound Status
HVAC,Sum,Evaporative Cooler Electric Energy [J]
HVAC,Average,Evaporative Cooler Electric Power [W]
HVAC,Sum,Evaporative Cooler Storage Tank Water Volume [m3]
HVAC,Sum,Evaporative Cooler Starved Water Volume [m3]
HVAC,Sum,Evaporative Cooler Starved Mains Water Volume [m3]

Evaporative Cooler Total Stage Effectiveness []

The Total Stage Efficiency is defined as the temperature change of the supply air divided by
the difference between the outdoor dry-bulb and wet-bulb temperatures, including the effect
of the reduction in flow because of the secondary air stream. In other words, it is a measure
of the approach to the outdoor wet-bulb temperature.
Evaporative Cooler Part Load Ratio []
This output variable provides the part load fraction of the indirect cooler.
The
ResearchSpecial cooler model is able to modulate to meet a temperature set point to avoid
over cooling. This output variable is the fraction formed by the ratio of the capacity needed
over the maximum cooling capacity available. A value of 1.0 corresponds to full capacity
cooling.
Evaporative Cooler Dewpoint Bound Status []
This output variable is a flag that indicates if the modeling was based on dewpoint
effectivenss rather than wetbulb effectiveness The ResearchSpecial model is usually based
on wet-bulb approach, but since values in excess of 1.0 are allowed, there is a secondary
constraint imposed by dewpoint. If the dewpoint effectiveness was applied, then this flag
variable will have the value 1.0, otherwise it is 0.0.

9/29/14

1656

Input-Output Reference

Group Heat Recovery

Evaporative Cooler Electric Power [W]

Evaporative Cooler Electric Energy [J]
These output variables report the electric power and energy that are consumed by the
secondary air fan and the sump pump.
Evaporative Cooler Water Volume [m3]
The water consumption is the water evaporated from the pad. This water consumption is
only from the direct thermodynamics of water evaporation and does not include other sources
of consumption such as drift or concentration blow down. This output variable appears when
mains water is supplied to the cooler.
Evaporative Cooler Mains Water Volume [m3]
This is the source of the water consumed. This output variable appears when mains water is
supplied to the cooler.
Evaporative Cooler Storage Tank Water Volume [m3]
The water consumption is the water evaporated from the pad. This water consumption is
only from the direct thermodynamics of water evaporation and does not include other sources
of consumption such as drift or concentration blow down. This output variable appears when
storage tank water is supplied to the cooler.
Evaporative Cooler Starved Water Volume [m3]
This is the water consumed by the evaporative cooler that could not accually be met by the
storage tank. This output variable appears when storage tank water is supplied to the cooler.
Evaporative Cooler Starved Mains Water Volume [m3]
This is the source (mains) of water consumed by the evaporative cooler that could not
accually be met by the storage tank. This output variable appears when storage tank water is
supplied to the cooler.

Group Heat Recovery

HeatExchanger:AirToAir:FlatPlate
The air-to-air flat plate heat exchanger is an HVAC component typically used for exhaust or
relief air heat recovery. The user can choose the flow arrangement type: counter flow, parallel
flow, or cross flow with both streams unmixed. The input requires no geometric data.
Performance is defined by specifying primary outlet air temperature at nominal (user
specified) inlet conditions. In addition, the ratio (h .A)p / (h.A)s at nominal flow needs to be
input, where h is the convective heat transfer coefficient, A is the surface area, p stands for
primary side, s for secondary side.
If the heat exchanger is operated in conjunction with an outdoor air economizer (economizer
lockout set to Yes), the nominal supply air flow rate should be set equal to the minimum
outdoor air flow rate specified in the Controller:OutdoorAir. The heat exchanger detects that
the economizer is operating by the fact that its inlet air flow rate is greater than its nominal
supply air flow rate.
Field: Name
A unique user-assigned name for a particular air-to-air flat plate heat exchanger unit. Any
reference to this unit by another object will use this name.
Field: Availability Schedule Name
The name of the schedule (ref: Schedule) that denotes whether the unit can run during a
given time period. A schedule value of 0 indicates that the unit is off for that time period. A
9/29/14

1657

Input-Output Reference

Group Heat Recovery

schedule value greater than 0 indicates that the unit can operate during the time period. If this
field is blank, the schedule has values of 1 for all time periods.
Field: Flow Arrangement Type
The user specified flow arrangement of the heat exchanger. The possible inputs are
CounterFlow, ParallelFlow, or CrossFlowBothUnmixed.
Field: Economizer Lockout
This input denotes whether the heat exchanger unit is locked out (bypassed) when the airside economizer is operating. Both the economizer and high humidity control (Ref.
Controller:OutdoorAir) activate the heat exchanger lockout as specified by this input. The
input choices are Yes (meaning locked out) or No. The default input for this field is Yes.
Field: Ratio of Supply to Secondary hA Values
The ratio (h.A)p / (h.A)s at nominal flow. h is the surface convective heat transfer coefficient, A
is the heat transfer area, and p and s stand for primary side and secondary side respectively.
A typical value for this ratio is 1.0.
Field: Nominal Supply Air Flow Rate
The nominal primary side air flow rate in cubic meters per second. If the unit is operated in
conjunction with an outdoor air economizer this should be equal to the minimum outdoor air
flow rate. This field is autosizable.
Field: Nominal Supply Air Inlet Temperature
The nominal primary side air inlet temperature in Celsius.
Field: Nominal Supply Air Outlet Temperature
The nominal primary side air outlet temperature in Celsius.
Field: Nominal Secondary Air Flow Rate
The nominal secondary side air flow rate in cubic meters per second. This field is autosizable.
It is equal to the primary side air flow rate defined above, if autosized.
Field: Nominal Secondary Air Inlet Temperature
The nominal secondary side air inlet temperature in Celsius.
Field: Nominal Electric Power
The electric consumption rate of the unit in watts. Electric power is considered constant
whenever the unit operates. This input can be used to model electric power consumption by
controls (transformers, relays, etc.) and/or a motor for a rotary heat exchanger. None of this
electric power contributes thermal load to the supply or exhaust air streams. The default
value for this field is 0.
Field: Supply Air Inlet Node Name
The name of the HVAC system node from which the unit draws its primary inlet air.
Field: Supply Air Outlet Node Name
The name of the HVAC system node to which the unit sends its primary outlet air.
Field: Secondary Air Inlet Node Name
The name of the HVAC system node from which the unit draws its secondary inlet air.
Field: Secondary Air Outlet Node Name
The name of the HVAC system node to which the unit sends its secondary outlet air.

9/29/14

1658

Input-Output Reference

Group Heat Recovery

An IDF example:
HeatExchanger:AirToAir:FlatPlate,
OA Heat Recovery 1,
!- Name
FanAndCoilAvailSched,
!- Availability Schedule Name
CounterFlow,
!- Flow Arrangement Type
Yes,
!- Economizer Lockout
1.0,
!- Ratio of Supply to Secondary hA Values
0.4333,
!- Nominal Supply Air Flow Rate {m3/s}
5.0,
!- Nominal Supply Air Inlet Temperature {C}
15.0,
!- Nominal Supply Air Outlet Temperature {C}
0.4333,
!- Nominal Secondary Air Flow Rate {m3/s}
20.0,
!- Nominal Secondary Air Inlet Temperature {C}
0.0,
!- Nominal Electric Power {W}
Desiccant Process Outlet Node, !- Supply Air Inlet Node Name
Heat Recovery Outlet Node, !- Supply Air Outlet Node Name
Relief Air Outlet Node, !- Secondary Air Inlet Node Name
Heat Recovery Secondary Outlet Node; !- Secondary Air Outlet Node Name

HeatExchanger:AirToAir:FlatPlate Outputs
HVAC,Average,Heat Exchanger Sensible Heating Rate [W]
HVAC,Sum,Heat Exchanger Sensible Heating Energy [J]
HVAC,Average,Heat Exchanger Latent Gain Rate [W]
HVAC,Sum,Heat Exchanger Latent Gain Energy [J]
HVAC,Average,Heat Exchanger Total Heating Rate [W]
HVAC,Sum,Heat Exchanger Total Heating Energy [J]
HVAC,Average,Heat Exchanger Sensible Cooling Rate [W]
HVAC,Sum,Heat Exchanger Sensible Cooling Energy [J]
HVAC,Average,Heat Exchanger Latent Cooling Rate [W]
HVAC,Sum,Heat Exchanger Latent Cooling Energy [J]
HVAC,Average,Heat Exchanger Total Cooling Rate [W]
HVAC,Sum,Heat Exchanger Total Cooling Energy [J]
HVAC,Average,Heat Exchanger Electric Power[W]
HVAC,Sum,Heat Exchanger Electric Energy [J]

Heat Exchanger Sensible Heating Rate [W]

This output is the sensible heating rate of the supply air by the heat exchanger in Watts. This
rate is determined using the supply air mass flow rate through the heat exchanger unit, the
supply air inlet and outlet conditions, and the specific heat of the inlet supply air. A positive
value is reported if the supply air is heated by the heat exchanger, else the rate is set to zero.
Heat Exchanger Sensible Heating Energy [J]
This output is the sensible heating energy added to the supply air by the heat exchanger in
Joules over the timestep being reported.
Heat Exchanger Latent Gain Rate [W]
This output is the latent heating rate (humidification) of the supply air by the heat exchanger
in Watts. This rate is determined by taking the difference between the Heat Exchanger Total
Heating Rate and the Heat Exchanger Sensible Heating Rate. A positive value is reported if
the supply air is humidified by the heat exchanger, else the rate is set to zero.
Heat Exchanger Latent Heating Energy [J]
This output is the latent heating energy added to the supply air by the heat exchanger in
Joules over the timestep being reported.
Heat Exchanger Total Heating Rate [W]
This output is the total heating rate of the supply air by the heat exchanger in Watts. This rate
is determined using the supply air mass flow rate through the heat exchanger unit, and the
enthalpy of the supply air entering and leaving the unit. A positive value is reported if the
enthalpy of the supply air is increased by the heat exchanger, else the rate is set to zero.
9/29/14

1659

Input-Output Reference

Group Heat Recovery

Heat Exchanger Total Heating Energy [J]

This output is the total heating energy added to the supply air by the heat exchanger in
Joules over the timestep being reported. This output is also added to a meter with
ResouceType = EnergyTransfer, EndUseKey = HeatRecoveryforHeating, GroupKey =
System (ref. Output:Meter objects).
Heat Exchanger Sensible Cooling Rate [W]
This output is the sensible cooling rate of the supply air by the heat exchanger in Watts. This
rate is determined using the supply air mass flow rate through the heat exchanger unit, the
supply air inlet and outlet conditions, and the specific heat of the inlet supply air. A positive
value is reported if the supply air is cooled by the heat exchanger, else the rate is set to zero.
Heat Exchanger Sensible Cooling Energy [J]
This output is the sensible cooling energy added to the supply air by the heat exchanger in
Joules over the timestep being reported.
Heat Exchanger Latent Cooling Rate [W]
This output is the latent cooling rate (dehumidification) of the supply air by the heat
exchanger in Watts. This rate is determined by taking the difference between the Heat
Exchanger Total Cooling Rate and the Heat Exchanger Sensible Cooling Rate. A positive
value is reported if the supply air is dehumidified by the heat exchanger, else the rate is set to
zero.
Heat Exchanger Latent Cooling Energy [J]
This output is the latent cooling energy added to the supply air by the heat exchanger in
Joules over the timestep being reported.
Heat Exchanger Total Cooling Rate [W]
This output is the total cooling rate of the supply air by the heat exchanger in Watts. This rate
is determined using the supply air mass flow rate through the heat exchanger unit, and the
enthalpy of the supply air entering and leaving the unit. A positive value is reported if the
enthalpy of the supply air is decreased by the heat exchanger, else the rate is set to zero.
Heat Exchanger Total Cooling Energy [J]
This output is the total cooling energy added to the supply air by the heat exchanger in Joules
over the timestep being reported. This output is also added to a meter with ResouceType =
EnergyTransfer, EndUseKey = HeatRecoveryforCooling, GroupKey = System (ref.
Output:Meter objects).
Heat Exchanger Electric Power [W]
This output is the electric consumption rate of the unit in Watts. This rate is applicable
whenever the unit operates (i.e., whenever the unit is scheduled to be available and supply
and exhaust air flows exist).
Heat Exchanger Electric Energy [J]
This output is the electric consumption of the unit in Joules for the timestep being reported.
This ouput is also added to a meter with ResourceType = Electricity, EndUseKey =
HeatRecovery, GroupKey = System (ref. Output:Meter objects).

9/29/14

1660

Input-Output Reference

Group Heat Recovery

HeatExchanger:AirToAir:SensibleAndLatent
The sensible and latent air-to-air heat exchanger is an HVAC component typically used for
exhaust or relief air heat recovery (Figure 150). Heat exchanger performance can be
specified to transfer sensible energy, latent energy or both between the supply and exhaust
air streams. The input requires no geometric data. Performance is defined by specifying
sensible and/or latent effectiveness at 75% and 100% of the nominal (rated) supply air flow
rate at two operating conditions as shown in Table 30.
Bypass Damper

Supply (Primary)
Air Inlet Node

Heat Exchanger

Supply (Primary)
Air Outlet Node

Exhaust
(Secondary) Air
Inlet Node

Exhaust
(Secondary) Air
Outlet Node

Bypass Damper

Figure 150. Schematic of the Sensible and Latent Air-to-Air Heat Exchanger

Table 30. Operating Conditions for Defining Heat Exchanger Performance

Parameter

Conditions
Heating

Cooling

Entering supply air temperature:

Dry-bulb
Wet-bulb

1.7C (35F)
0.6C (33F)

35C (95F)
26C (78F)

Entering exhaust air temperature:

Dry-bulb
Wet-bulb

21C (70F)
14C (58F)

24C (75F)
17C (63F)

Note: Conditions consistent with the Air-Conditioning and Refrigeration

Institutes (ARI) Standard 1060-2001.

This object models the basic operation of an air-to-air heat exchanger. Heat exchange
between the supply and exhaust air streams occurs whenever the unit is scheduled to be
available (Availability schedule) and supply/exhaust air flow is present. This heat exchanger
object can be used in conjunction with a conventional air-side economizer (i.e., specify
ModulateFlow in the Controller:OutdoorAir object), whereby heat exchange is suspended
whenever the air-side economizer (or high humidity control) is active (i.e., air flow is fully
bypassed around a fixed-plate heat exchanger or the rotation of a rotary heat exchanger is
stopped). This object is also able to suspend heat exchange for the purpose of providing free
cooling operation in the absence of a conventional air-side economizer (i.e., specify
MinimumFlowWithBypass in the Controller:OutdoorAir object).

9/29/14

1661

Input-Output Reference

Group Heat Recovery

During winter weather, humid exhaust air entering the heat exchanger can form frost on the
cold heat exchanger surfaces, which can reduce air flow and the amount of energy recovery.
Several methods are used to control or eliminate frost formation, and the following types can
be modeled for this heat exchanger object: supply air preheat, minimum exhaust air
temperature, exhaust air recirculation and exhaust only. For preheat frost control, a separate
heating coil object must be placed in the supply inlet air stream to keep the air temperature
above the frost threshold temperature. The other frost control types are modeled within this
object itself (i.e., do not require a separate object to be defined) based on alpha and numeric
inputs to this heat exchanger object.
Air-to-air heat exchangers are sometimes controlled to maintain a fixed supply air outlet
temperature to avoid overheating when the heat exchanger is heating the supply (primary)
air. To model this control in EnergyPlus, a set point manager object is used to establish a
temperature set point at the supply air outlet node of the heat exchanger. Wheel speed
modulation or plate supply air bypass is used to control the supply air exiting conditions to
this set point. The set point for supply air temperature control should be set at the minimum
economizer temperature set point if an air-side economizer is also being used by the air
system. If frost control and supply air outlet temperature control are used, frost control takes
precedence over supply air temperature control (e.g., frost control defrost time fraction is
determined as if wheel speed modulation or plate supply air bypass is not used).
To model a sensible and latent air-to-air heat exchanger located in an air loop, the input data
file should include the following objects:
AirLoopHVAC:OutdoorAirSystem
Controller:OutdoorAir
OutdoorAir:Mixer
HeatExchanger:AirToAir:SensibleAndLatent
Coil:Heating:Water, Coil:Heating:Electric or Coil:Heating:Gas (if preheat frost control is to
be modeled)
SetpointManager:Scheduled (if supply air outlet temperature control is used)
The sensible and latent air-to-air heat exchanger can also be used in a number of other
applications, including conditioning outdoor ventilation air and supplying it directly to a zone
without an air loop. See object ZoneHVAC:EnergyRecoveryVentilator for further details on
this specific application.
A description of each input field for this object is provided below.
Field: Name
A unique user-assigned name for a particular sensible/latent air-to-air heat exchanger. Any
reference to this heat exchanger by another object will use this name.
Field: Availability Schedule Name
The name of the schedule (ref: Schedule) that denotes whether the unit can operate during a
given time period. A schedule value of less than or equal to 0 indicates that the unit is off for
that time period. A schedule value greater than 0 indicates that the unit can operate during
the time period. If this field is blank, the schedule has values of 1 for all time periods.
Field: Nominal Supply Air Flow Rate
The nominal primary side (supply) air flow rate in cubic meters per second. The actual supply
and exhaust air flow rates must be between 50% and 130% of this value or a warning will be
issued.
Field: Sensible Effectiveness at 100% Heating Air Flow
The sensible heat exchange effectiveness at the heating condition defined in Table 30 above
with both the supply and exhaust air volume flow rates equal to 100% of the nominal supply
air flow rate specified in the previous input field. The default value for this field is 0.
9/29/14

1662

Input-Output Reference

Group Heat Recovery

Field: Latent Effectiveness at 100% Heating Air Flow

The latent heat exchange effectiveness at the heating condition defined in Table 30 with both
the supply and exhaust air volume flow rates equal to 100% of the nominal supply air flow
rate. Specify this value as 0.0 if the heat exchanger does not transfer latent energy. The
default value for this field is 0.
Field: Sensible Effectiveness at 75% Heating Air Flow
The sensible heat exchange effectiveness at the heating condition defined in Table 30 with
both the supply and exhaust air volume flow rates equal to 75% of the nominal supply air flow
rate. The default value for this field is 0.
Field: Latent Effectiveness at 75% Heating Air Flow
The latent heat exchange effectiveness at the heating condition defined in Table 30 with both
the supply and exhaust air volume flow rates equal to 75% of the nominal supply air flow rate.
Specify this value as 0.0 if the heat exchanger does not transfer latent energy. The default
value for this field is 0.
Field: Sensible Effectiveness at 100% Cooling Air Flow
The sensible heat exchange effectiveness at the cooling condition defined in Table 30 with
both the supply and exhaust air volume flow rates equal to 100% of the nominal supply air
flow rate. The default value for this field is 0.
Field: Latent Effectiveness at 100% Cooling Air Flow
The latent heat exchange effectiveness at the cooling condition defined in Table 30 with both
the supply and exhaust air volume flow rates equal to 100% of the nominal supply air flow
rate. Specify this value as 0.0 if the heat exchanger does not transfer latent energy. The
default value for this field is 0.
Field: Sensible Effectiveness at 75% Cooling Air Flow
The sensible heat exchange effectiveness at the cooling condition defined in Table 30 with
both the supply and exhaust air volume flow rates equal to 75% of the nominal supply air flow
rate. The default value for this field is 0.
Field: Latent Effectiveness at 75% Cooling Air Flow
The latent heat exchange effectiveness at the cooling condition defined in Table 30 with both
the supply and exhaust air volume flow rates equal to 75% of the nominal supply air flow rate.
Specify this value as 0.0 if the heat exchanger does not transfer latent energy. The default
value for this field is 0.
Field: Supply Air Inlet Node Name
The name of the HVAC system node from which the unit draws its supply (primary) inlet air.
Field: Supply Air Outlet Node Name
The name of the HVAC system node to which the unit sends its supply (primary) outlet air.
Field: Exhaust Air Inlet Node Name
The name of the HVAC system node from which the unit draws its exhaust (secondary) inlet
air.
Field: Exhaust Air Outlet Node Name
The name of the HVAC system node to which the unit sends its exhaust (secondary) outlet
air.

9/29/14

1663

Input-Output Reference

Group Heat Recovery

Field: Nominal Electric Power

The electric consumption rate of the unit in watts. Electric power is considered constant
whenever the unit operates. This numeric input can be used to model electric power
consumption by controls (transformers, relays, etc.) and/or a motor for a rotary heat
exchanger. None of this electric power contributes thermal load to the supply or exhaust air
streams. The default value for this field is 0.
Field: Supply Air Outlet Temperature Control
This alpha field determines if the heat exchangers supply air outlet is controlled to a
temperature set point when the heat exchanger is heating the supply (primary) air. The
choices for this input field are Yes or No, with the default being No. When supply air
outlet temperature control is used, the wheel rotational speed modulates or supply air is
bypassed around the plate heat exchanger to maintain the desired setpoint temperature. A
setpoint manager object is required to establish the desired set point at the supply air outlet
node (reference: SetpointManager:Scheduled). When an air-side economizer is also being
modeled for this air system, the set point for the supply air outlet temperature control should
be equal to the economizer outdoor air temperature lower limit (reference:
Controller:OutdoorAir, field Economizer Minimum Limit Dry-Bulb Temperature).
Field: Heat Exchanger Type
This alpha field denotes the type of heat exchanger being modeled: Plate (e.g., fixed plate) or
Rotary (e.g., rotating cylinder or wheel). The default choice for this field is Plate. The heat
exchanger type affects the modeling of frost control options and supply air outlet temperature
control. For rotary heat exchangers, rotational speed is varied to control frost formation or the
supply air outlet temperature. For plate exchangers, air bypass around the heat exchanger is
used to obtain the desired effect.
Field: Frost Control Type
This alpha field has four choices: None, ExhaustAirRecirculation, ExhaustOnly and
MinimumExhaustTemperature. If this field is left blank, the default frost control type is None.
For modeling preheat frost control, specify None for this input field and insert a separate
heating coil object in the supply inlet air stream to keep the air temperature above the desired
frost threshold temperature.
ExhaustAirRecirculation: dampers are used to direct exhaust air back into the zone through
the supply side of the heat exchanger when the supply (outdoor) air inlet temperature falls
below a threshold temperature (defined in the next input field). The fraction of time that
exhaust air is circulated through the supply side of the heat exchanger is dependent on the
supply (outdoor) air inlet temperature with respect to the threshold temperature, the initial
defrost time fraction, and the rate of change of defrost time fraction (see Field: Rate of
Defrost Time Fraction Increase). When exhaust air is being recirculated, no supply (outdoor
ventilation) air is being provided through the heat exchanger unit (which may or may not be
acceptable regarding ventilation for occupants).
ExhaustOnly (supply air bypass): this control cycles off the supply air flow through the heat
exchanger for a certain period of time while the exhaust air continues to flow through the
exhaust side of the heat exchanger. The fraction of time that the supply flow through the heat
exchanger is cycled off is dependent on the supply (outdoor) air inlet temperature with
respect to the threshold temperature, the initial defrost time fraction, and the rate of change of
defrost time fraction (see Field: Rate of Defrost Time Fraction Increase). When implemented
in real applications, provisions are usually made to avoid building depressurization when this
frost control is operating (automatic or pressure-operated dampers, or a bypass air damper
around the supply side of the heat exchanger). For this frost control type, it is assumed that
the supply air is bypassed around the heat exchanger during frost control operation (i.e., the
total supply flow is not reduced during defrost, but merely bypassed around the heat
exchanger).

9/29/14

1664

Input-Output Reference

Group Heat Recovery

MinimumExhaustTemperature: the temperature of the exhaust air leaving the heat exchanger
is monitored and the heat exchanger effectiveness is decreased (by slowing heat exchanger
rotation or bypassing supply air around the plate exchanger) to keep the exhaust air from
falling below the threshold temperature.
Field: Threshold Temperature
This numeric field defines the dry-bulb temperature of air which is used to initiate frost
control. The default value is 1.7C. For ExhaustAirRecirculation and ExhaustOnly frost
control, the threshold temperature defines the supply (outdoor) air inlet temperature below
which frost control is active. For MinimumExhaustTemperature frost control, heat exchanger
effectiveness is controlled to keep the exhaust air outlet temperature from falling below this
threshold temperature value.
The appropriate threshold temperature varies with exhaust (inlet) air temperature and
humidity, frost control type, heat exchanger type, and whether the heat exchanger transfers
sensible energy alone or both sensible and latent energy (enthalpy). Typical threshold
temperatures are provided in Table 31 below. However, it is recommended that the user
consult manufacturers information for the specific air-to-air heat exchanger being modeled.
Table 31. Typical threshold temperatures
Frost control type

Heat exchanger
type
Plate

Exhaust air
recirculation
Rotary
Plate
Exhaust only
Rotary
Plate
Minimum exhaust
temperature
Rotary
Plate
Preheat**
Rotary

Energy exchange

Threshold
temperature

Sensible-only

-1.1C (30F)

Sensible + latent

-12.2C (10F)

Sensible-only

-12.2C (10F)

Sensible + latent

-23.3C (-10F)

Sensible-only

-1.1C (30F)

Sensible + latent

-12.2C (10F)

Sensible-only

-12.2C (10F)

Sensible + latent

-23.3C (-10F)

Sensible-only

1.7C (35F)

Sensible + latent

1.7C (35F)

Sensible-only

1.7C (35F)

Sensible + latent

1.7C (35F)

Sensible-only

-1.1C (30F)

Sensible + latent

-12.2C (10F)

Sensible-only

-12.2C (10F)

Sensible + latent

-23.3C (-10F)

Source: Indoor Humidity Assessment Tool, U.S. Environmental Protection Agency,

http://www.epa.gov/iaq/schooldesign/saves.html
** To model preheat frost control, specify frost control type as None and place a
heating coil in the supply inlet air stream controlled to the keep the air temperature
above the frost threshold temperature.

9/29/14

1665

Input-Output Reference

Group Heat Recovery

Field: Initial Defrost Time Fraction

This numeric field defines the fraction of the simulation timestep when frost control will be
invoked when the threshold temperature is reached. This field is only used for the
ExhaustAirRecirculation and ExhaustOnly frost control types. The value for this field must be
0 and 1. The default time fraction is 0.083 (e.g., 5 min / 60 min) which is typical for
ExhaustAirRecirculation frost control. Higher initial defrost time fractions (e.g., 0.167 = 10 min
/ 60 min) are typically required for ExhaustOnly frost control. For best results, the user should
obtain this information from the manufacturer.
Field: Rate of Defrost Time Fraction Increase
This numeric field defines the rate of increase in the defrost time fraction as the supply
(outdoor) air inlet temperature falls below the threshold temperature. This field is only used
for the ExhaustAirRecirculation and ExhaustOnly frost control types. The value for this field
must be 0. The default value is 0.012 (e.g., 0.72 min / 60 min per degree C temperature
difference) which is typical for ExhaustAirRecirculation frost control. Higher values (e.g.,
0.024 = 1.44 min / 60 min per degree C temperature difference) are typically required for
ExhaustOnly frost control. For best results, the user should obtain this information from the
manufacturer.
This value is used to determine the total defrost time fraction as follows:
Total defrost time fraction = Initial Defrost Time Fraction +
Rate of Defrost Time Fraction Increase * (T threshold Tsupply air inlet)
The model does not allow the total defrost time fraction to exceed 1.0 or be less than 0.
Field: Economizer Lockout
This input denotes whether the heat exchanger unit is locked out (bypassed for plate type
heat exchangers or the rotation is suspended for rotary type heat exchangers) when the airside economizer is operating. Both the economizer and high humidity control (Ref.
Controller:OutdoorAir) activate the heat exchanger lockout as specified by this input. The
input choices are Yes (meaning locked out) or No. The default input for this field is Yes.
Following is an example input for this heat exchanger object:
HeatExchanger:AirToAir:SensibleAndLatent,
OA Heat Recovery 1,
!- Name
FanAndCoilAvailSched,
!- Availability Schedule Name
0.4333,
!- Nominal Supply Air Flow Rate {m3/s}
.76,
!- Sensible Effectiveness at 100% Heating Air Flow {dimensionless}
.68,
!- Latent Effectiveness at 100% Heating Air Flow {dimensionless}
.81,
!- Sensible Effectiveness at 75% Heating Air Flow {dimensionless}
.73,
!- Latent Effectiveness at 75% Heating Air Flow {dimensionless}
.76,
!- Sensible Effectiveness at 100% Cooling Air Flow {dimensionless}
.68,
!- Latent Effectiveness at 100% Cooling Air Flow {dimensionless}
.81,
!- Sensible Effectiveness at 75% Cooling Air Flow {dimensionless}
.73,
!- Latent Effectiveness at 75% Cooling Air Flow {dimensionless}
Outside Air Inlet Node Preheated, !- Supply Air Inlet Node Name
Heat Recovery Outlet Node, !- Supply Air Outlet Node Name
Relief Air Outlet Node, !- Exhaust Air Inlet Node Name
Heat Recovery Secondary Outlet Node, !- Exhaust Air Outlet Node Name
200.0,
!- Nominal Electric Power {W}
No,
!- Supply Air Outlet Temperature Control
Plate,
!- Heat Exchanger Type
None;
!- Frost Control Type

9/29/14

1666

Input-Output Reference

Group Heat Recovery

HeatExchanger:AirToAir:SensibleAndLatent Outputs
HVAC,Average,Heat Exchanger Sensible Heating Rate [W]
HVAC,Sum,Heat Exchanger Sensible Heating Energy [J]
HVAC,Average,Heat Exchanger Latent Gain Rate [W]
HVAC,Sum,Heat Exchanger Latent Gain Energy [J]
HVAC,Average,Heat Exchanger Total Heating Rate [W]
HVAC,Sum,Heat Exchanger Total Heating Energy [J]
HVAC,Average,Heat Exchanger Sensible Cooling Rate [W]
HVAC,Sum,Heat Exchanger Sensible Cooling Energy [J]
HVAC,Average,Heat Exchanger Latent Cooling Rate [W]
HVAC,Sum,Heat Exchanger Latent Cooling Energy [J]
HVAC,Average,Heat Exchanger Total Cooling Rate [W]
HVAC,Sum,Heat Exchanger Total Cooling Energy [J]
HVAC,Average,Heat Exchanger Electric Power[W]
HVAC,Sum,Heat Exchanger Electric Energy [J]
HVAC,Average,Heat Exchanger Sensible Effectiveness[]
HVAC,Average,Heat Exchanger Latent Effectiveness[]
HVAC,Average,Heat Exchanger Supply Air Bypass Mass Flow Rate [kg/s]
HVAC,Average,Heat Exchanger Exhaust Air Bypass Mass Flow Rate [kg/s]
HVAC,Average,Heat Exchanger Defrost Time Fraction[]

Heat Exchanger Sensible Heating Rate [W]

This output is the sensible heating rate of the supply air by the heat exchanger in Watts. This
rate is determined using the supply air mass flow rate through the heat exchanger unit, the
supply air inlet and outlet conditions, and the specific heat of the inlet supply air. A positive
value is reported if the supply air is heated by the heat exchanger, else the rate is set to zero.
Heat Exchanger Sensible Heating Energy [J]
This output is the sensible heating energy added to the supply air by the heat exchanger in
Joules over the timestep being reported.
Heat Exchanger Latent Gain Rate [W]
This output is the latent heating rate (humidification) of the supply air by the heat exchanger
in Watts. This rate is determined by taking the difference between the Heat Exchanger Total
Heating Rate and the Heat Exchanger Sensible Heating Rate. A positive value is reported if
the supply air is humidified by the heat exchanger, else the rate is set to zero.
Heat Exchanger Latent Gain Energy [J]
This output is the latent heating energy added to the supply air by the heat exchanger in
Joules over the timestep being reported.
Heat Exchanger Total Heating Rate [W]
This output is the total heating rate of the supply air by the heat exchanger in Watts. This rate
is determined using the supply air mass flow rate through the heat exchanger unit, and the
enthalpy of the supply air entering and leaving the unit. A positive value is reported if the
enthalpy of the supply air is increased by the heat exchanger, else the rate is set to zero.
Heat Exchanger Total Heating Energy [J]
This output is the total heating energy added to the supply air by the heat exchanger in
Joules over the timestep being reported. This output is also added to a meter with
ResouceType = EnergyTransfer, EndUseKey = HeatRecoveryforHeating, GroupKey =
System (ref. Output:Meter objects).

9/29/14

1667

Input-Output Reference

Group Heat Recovery

Heat Exchanger Sensible Cooling Rate [W]

This output is the sensible cooling rate of the supply air by the heat exchanger in Watts. This
rate is determined using the supply air mass flow rate through the heat exchanger unit, the
supply air inlet and outlet conditions, and the specific heat of the inlet supply air. A positive
value is reported if the supply air is cooled by the heat exchanger, else the rate is set to zero.
Heat Exchanger Sensible Cooling Energy [J]
This output is the sensible cooling energy added to the supply air by the heat exchanger in
Joules over the timestep being reported.
Heat Exchanger Latent Cooling Rate [W]
This output is the latent cooling rate (dehumidification) of the supply air by the heat
exchanger in Watts. This rate is determined by taking the difference between the Heat
Exchanger Total Cooling Rate and the Heat Exchanger Sensible Cooling Rate. A positive
value is reported if the supply air is dehumidified by the heat exchanger, else the rate is set to
zero.
Heat Exchanger Latent Cooling Energy [J]
This output is the latent cooling energy added to the supply air by the heat exchanger in
Joules over the timestep being reported.
Heat Exchanger Total Cooling Rate [W]
This output is the total cooling rate of the supply air by the heat exchanger in Watts. This rate
is determined using the supply air mass flow rate through the heat exchanger unit, and the
enthalpy of the supply air entering and leaving the unit. A positive value is reported if the
enthalpy of the supply air is decreased by the heat exchanger, else the rate is set to zero.
Heat Exchanger Total Cooling Energy [J]
This output is the total cooling energy added to the supply air by the heat exchanger in Joules
over the timestep being reported. This output is also added to a meter with ResouceType =
EnergyTransfer, EndUseKey = HeatRecoveryforCooling, GroupKey = System (ref.
Output:Meter objects).
Heat Exchanger Electric Power [W]
This output is the electric consumption rate of the unit in Watts. This rate is applicable
whenever the unit operates (i.e., whenever the unit is scheduled to be available and supply
and exhaust air flows exist).
Heat Exchanger Electric Energy [J]
This output is the electric consumption of the unit in Joules for the timestep being reported.
This ouput is also added to a meter with ResourceType = Electricity, EndUseKey =
HeatRecovery, GroupKey = System (ref. Output:Meter objects).
Heat Exchanger Sensible Effectiveness []
This output is the average sensible effectiveness of the heat exchanger (excluding bypass
air, if any) over the timestep being reported.
Heat Exchanger Latent Effectiveness []
This output is the average latent effectiveness of the heat exchanger (excluding bypass air, if
any) over the timestep being reported.
Heat Exchanger Supply Air Bypass Mass Flow Rate [kg/s]
This output is the average mass flow rate in kg/second of the supply (primary) air stream that
is bypassing the heat exchanger over the timestep being reported. This flow rate is equal to
9/29/14

1668

Input-Output Reference

Group Heat Recovery

the total supply mass flow rate through the heat exchanger unit minus the amount passing
through the supply side of the heat exchanger core.
Heat Exchanger Exhaust Air Bypass Mass Flow Rate [kg/s]
This output is the average mass flow rate in kg/second of the exhaust (secondary) air stream
that is bypassing the heat exchanger over the timestep being reported. This flow rate is equal
to the total exhaust mass flow rate through the heat exchanger unit minus the amount
passing through the exhaust side of the heat exchanger core.
Heat Exchanger Defrost Time Fraction []
This output is the average fraction of the reporting timestep when frost control is being
implemented.
HeatExchanger:Desiccant:BalancedFlow
This desiccant heat exchanger object is an HVAC component used to model both
temperature (sensible) and moisture (latent) heat exchange between two air streams (Figure
151). The model assumes balanced air flow through the regeneration and process sides of
the heat exchanger (i.e., regeneration and process air volume flow rates and face velocities
are the same). Heat exchanger performance is specified through a performance data type
object (e.g., HeatExchanger:Desiccant:BalancedFlow:PerformanceDataType1).

Figure 151. Schematic of the Balanced Flow Desiccant Heat Exchanger

Currently, this desiccant heat exchanger model can be referenced by two compound objects:
CoilSystem:Cooling:DX:HeatExchangerAssisted and Dehumidifier:Desiccant:System, both of
which are used to provide enhanced dehumidification over conventional systems. If this heat
exchanger is referenced by a compound object, the compound object will control heat
exchanger operation (i.e., tell the heat exchanger if heat exchange is needed or not for each
simulation timestep).
This desiccant heat exchanger object may also be specified directly in an AirLoopHVAC (air
loop
BranchList)
or
in
an
AirLoopHVAC:OutdoorAirSystem
(AirLoopHVAC:OutdoorAirSystem:EquipmentList) without being referenced by a compound
object. If specified directly in an AirLoopHVAC or AirLoopHVAC:OutdoorAirSystem, then the
heat exchanger can be controlled to provide heat exchange based on a maximum and/or
minimum humidity set point placed on the process air outlet node (ref. Setpoint Managers). If
no humidity set points are provided on this node, then heat exchange will be provided
9/29/14

1669

Input-Output Reference

Group Heat Recovery

whenever the heat exchanger is available to operate (via its availability schedule) and there is
a temperature and/or humidity ratio difference between the two air streams.
Inputs to this model include an availability schedule name, inlet and outlet air node names,
and the type and name of the heat exchanger performance data object. A description of each
input field for this object is provided below.
Field: Name
A unique, user-assigned name for a particular balanced flow desiccant heat exchanger. Any
reference to this heat exchanger by another object will use this name.
Field: Availability Schedule Name
The name of the schedule (ref: Schedule) that denotes whether the heat exchanger can
operate during a given time period. A schedule value of less than or equal to 0 indicates that
the unit is off for that time period. A schedule value greater than 0 indicates that the unit can
operate during the time period. If this field is blank, the schedule has values of 1 for all time
periods.
Field: Regeneration Air Inlet Node Name
The name of the HVAC system node from which the unit draws its regeneration inlet air.
Field: Regeneration Air Outlet Node Name
The name of the HVAC system node to which the unit sends its regeneration outlet air.
Field: Process Air Inlet Node Name
The name of the HVAC system node from which the unit draws its process inlet air.
Field: Process Air Outlet Node Name
The name of the HVAC system node to which the unit sends its process outlet air.
Field: Heat Exchanger Performance Object Type
This alpha field contains the type of model used to simulate the desiccant heat exchangers
thermal performance and electrical energy use. Currently, the only valid choice is
HeatExchanger:Desiccant:BalancedFlow:PerformanceDataType1.
Field: Heat Exchanger Performance Name
This alpha field contains the identifying name of the specific heat exchanger performance
type object (e.g., HeatExchanger:Desiccant:BalancedFlow:PerformanceDataType1) that
defines the performance for this heat exchanger. A single heat exchanger performance type
object may be used to define performance for many HeatExchanger:Desiccant:BalancedFlow
objects (i.e., the same name may be used in this input field for more than one balanced flow
desiccant heat exchanger).
Field: Economizer Lockout
This input denotes whether the heat exchanger unit is locked out (heat exchanger rotation is
suspended) when the air-side economizer is operating. Both the economizer and high
humidity control (Ref. Controller:OutdoorAir) activate the heat exchanger lockout as specified
by this input. The input choices are Yes (meaning locked out) or No. Economizer lockout is
typically not used for this type of heat exchanger. For this reason, the default input for this
field is No.
Following is an example input for this heat exchanger object:

9/29/14

1670

Input-Output Reference

Group Heat Recovery

HeatExchanger:Desiccant:BalancedFlow,
Desiccant Heat Exchanger 1,
!- Name
OfficeHeatCoolAvail,
!- Availability Schedule Name
DXSystem 1 Mixed Air Node,
!- Regeneration Air Inlet Node Name
DX Cooling Coil Air Inlet Node,
!- Regeneration Air Outlet Node Name
DX Cooling Coil Air Outlet Node,
!- Process Air Inlet Node Name
DXSystem 1 Fan Air Inlet Node,
!- Process Air Outlet Node Name
HeatExchanger:Desiccant:BalancedFlow:PerformanceDataType1, !- Heat Exchanger Performance Object Type
HXDesPerf1;
!- Heat Exchanger Performance Name

HeatExchanger:Desiccant:BalancedFlow Outputs
HVAC,Average,Heat Exchanger Sensible Heating Rate [W]
HVAC,Sum,Heat Exchanger Sensible Heating Energy [J]
HVAC,Average,Heat Exchanger Latent Gain Rate [W]
HVAC,Sum,Heat Exchanger Latent Gain Energy [J]
HVAC,Average,Heat Exchanger Total Heating Rate [W]
HVAC,Sum,Heat Exchanger Total Heating Energy [J]
HVAC,Average,Heat Exchanger Sensible Cooling Rate [W]
HVAC,Sum,Heat Exchanger Sensible Cooling Energy [J]
HVAC,Average,Heat Exchanger Latent Cooling Rate [W]
HVAC,Sum,Heat Exchanger Latent Cooling Energy [J]
HVAC,Average,Heat Exchanger Total Cooling Rate [W]
HVAC,Sum,Heat Exchanger Total Cooling Energy [J]
HVAC,Average,Heat Exchanger Electric Power[W]
HVAC,Sum,Heat Exchanger Electric Energy [J]

Heat Exchanger Sensible Heating Rate [W]

This output is the sensible heating rate of the process air by the heat exchanger in Watts.
This rate is determined using the process air mass flow rate through the heat exchanger unit,
the process air inlet and outlet temperatures, and the specific heat of the inlet process air. A
positive value is reported if the process air is heated by the heat exchanger, else the rate is
set to zero.
Heat Exchanger Sensible Heating Energy [J]
This output is the sensible heating energy added to the process air by the heat exchanger in
Joules over the timestep being reported.
Heat Exchanger Latent Gain Rate [W]
This output is the latent heating rate (humidification) of the process air by the heat exchanger
in Watts. This rate is determined by taking the difference between the heat exchangers total
heat recovery rate and the sensible heat recovery rate. A positive value is reported if the
process air is humidified by the heat exchanger, else the rate is set to zero.
Heat Exchanger Latent Gain Energy [J]
This output is the latent heating energy added to the process air by the heat exchanger in
Joules over the timestep being reported.
Heat Exchanger Total Heating Rate [W]
This output is the total heating rate of the process air by the heat exchanger in Watts. This
rate is determined using the process air mass flow rate through the heat exchanger unit and
the enthalpy of the air entering and leaving the process side of the unit. A positive value is
reported if the enthalpy of the process air is increased by the heat exchanger, else the rate is
set to zero.
Heat Exchanger Total Heating Energy [J]
This output is the total heating energy added to the process air by the heat exchanger in
Joules over the timestep being reported. This output is also added to a meter with
9/29/14

1671

Input-Output Reference

Group Heat Recovery

ResouceType = EnergyTransfer, EndUseKey = HeatRecoveryforHeating, GroupKey =

System (ref. Output:Meter objects).
Heat Exchanger Sensible Cooling Rate [W]
This output is the sensible cooling rate of the process air by the heat exchanger in Watts.
This rate is determined using the process air mass flow rate through the heat exchanger unit,
the process air inlet and outlet temperatures, and the specific heat of the inlet process air. A
positive value is reported if the process air is cooled by the heat exchanger, else the rate is
set to zero.
Heat Exchanger Sensible Cooling Energy [J]
This output is the sensible cooling energy added to the process air by the heat exchanger in
Joules over the timestep being reported.
Heat Exchanger Latent Cooling Rate [W]
This output is the latent cooling rate (dehumidification) of the process air by the heat
exchanger in Watts. This rate is determined by taking the difference between the heat
exchangers total heat recovery rate and the sensible heat recovery rate. A positive value is
reported if the process air is dehumidified by the heat exchanger, else the rate is set to zero.
Heat Exchanger Latent Cooling Energy [J]
This output is the latent cooling energy added to the process air by the heat exchanger in
Joules over the timestep being reported.
Heat Exchanger Total Cooling Rate [W]
This output is the total cooling rate of the process air by the heat exchanger in Watts. This
rate is determined using the process air mass flow rate through the heat exchanger unit and
the enthalpy of the air entering and leaving the process side of the unit. A positive value is
reported if the enthalpy of the process air is decreased by the heat exchanger, else the rate is
set to zero.
Heat Exchanger Total Cooling Energy [J]
This output is the total cooling energy added to the process air by the heat exchanger in
Joules over the timestep being reported. This output is also added to a meter with
ResouceType = EnergyTransfer, EndUseKey = HeatRecoveryforCooling, GroupKey =
System (ref. Output:Meter objects).
Heat Exchanger Electric Power [W]
This output is the average electric consumption rate of the unit in Watts. This average rate
includes portions of the simulation timestep when the heat exchanger may be cycled off (i.e.,
average of on and off periods, as appropriate).
Heat Exchanger Electric Energy [J]
This output is the electric consumption of the unit in Joules for the timestep being reported.
This ouput is also added to a meter with ResourceType = Electricity, EndUseKey =
HeatRecovery, GroupKey = System (ref. Output:Meter objects).
HeatExchanger:Desiccant:BalancedFlow:PerformanceDataType1
This object specifies a performance model and model coefficients for a balanced flow
desiccant heat exchanger. A HeatExchanger:Desiccant:BalancedFlow object will reference a
HeatExchanger:Desiccant:BalancedFlow:PerformanceDataType1 object. This performance
data object is used to specify the thermal performance and electric consumption of the heat
exchanger. Some representative inputs for this object are provided in the EnergyPlus
Reference DataSets (PerfCurves.idf and AllDataSets.idf).

9/29/14

1672

Input-Output Reference

Group Heat Recovery

This model predicts the regeneration air stream outlet temperature and humidity ratio values
based on the entering regeneration and process air stream temperature, humidity ratio and
face velocity. The process air stream outlet humidity ratio and temperatures are calculated
based on a simple heat and moisture balance. The model requires that the user enter the
nominal volumetric flow rate and a nominal face velocity, electric power consumption,
empirical model coefficients for the regeneration outlet air temperature and humidity ratio
equations, and the applicable minimum and maximum values for both the independent and
dependent variables for the empirical model coefficients provided. This model is based on the
following equations:
The dry-bulb temperature of the regeneration outlet air is defined using the following
equation:

RTO

B1 B2 * RWI

B3* RTI

B4 *

RWI
RTI

B5* PWI

B6* PTI

B7 *

PWI
PTI

B8* RFV

where,

RTO
RWI
RTI
PWI
PTI
RFV

= Regeneration outlet air dry-bulb temperature (C)

= Regeneration inlet air humidity ratio (kgWater/kgDryAir)
= Regeneration inlet air dry-bulb temperature (C)
= Process inlet air humidity ratio (kgWater/kgDryAir)
= Process inlet air dry-bulb temperature (C)
= Regeneration (and process) face velocity (m/s)

The humidity ratio of the regeneration outlet air is defined using the same empirical
equation form; however, different coefficients are used as follows:

RWO

C1 C 2 * RWI

C 3* RTI

C4 *

RWI
RTI

C 5* PWI

C 6* PTI

C7 *

PWI
PTI

C8* RFV

where,

RWO = Regeneration outlet air humidity ratio (kgWater/kgDryAir)

The process outlet air conditions are then calculated based on the regeneration outlet air
conditions (temperature or humidity ratio) calculated above, the actual regeneration inlet
air conditions entering the heat exchanger, and assuming the same amount of sensible
and total energy transfer across both the process and regeneration sides of the heat
exchanger. The difference between the actual inlet air conditions and RTI/RWI/PTI/PWI
is made here because user-defined limits for RTI/RWI/PTI/PWI may result in a difference
between the actual conditions and those used in the equations shown above (see the
EnergyPlus Engineering Reference for further discussion).
A description of each input field for this object is provided below.
Field: Name
This alpha field contains the identifying name for this set of desiccant heat exchanger
performance data. Any reference to this performance data set by another object (e.g.,
HeatExchanger:Desiccant:BalancedFlow) will use this name.
Field: Nominal Air Flow Rate
The nominal air volume flow rate in cubic meters per second. This model assumes balanced
air flow (i.e., the same air volume flow rate across the process and regeneration sides of the
heat exchanger). The minimum value should be greater than 0. This field is autosizable.

9/29/14

1673

Input-Output Reference

Group Heat Recovery

Field: Nominal Air Face Velocity

This numeric field contains the nominal air velocity across the heat exchanger face area in
meters per second. It is assumed that this air velocity is the same for both sides of the heat
exchanger. This value, along with the Nominal Air Flow Rate sets the heat exchanger face
area. With this fixed face area, the air face velocity is calculated every simulation timestep
based on the actual air volume flow rate for the timestep. The minimum value should be
greater than 0 and less than or equal to 6. The default value is 3.0.
Field: Nominal Electric Power
This numeric field contains the nominal electric consumption rate of the heat exchanger in
watts. This electric power is considered constant and is consumed only when the heat
exchanger operates (e.g., for all or a portion of the simulation timestep, as appropriate). This
numeric input can be used to model electric power consumption by controls (transformers,
relays, etc.) and/or a motor for a rotary heat exchanger. None of this electric power
contributes thermal load to the process or regeneration air streams. The minimum value
should be greater than or equal to 0. The default value for this field is also 0.
The coefficients for the regeneration air outlet temperature equation described above are
defined in the following eight fields:
Field: Temperature Equation Coefficient 1
The constant coefficient (B1) in the temperature equation shown above (RTO).
Field: Temperature Equation Coefficient 2
The coefficient (B2) in the temperature equation shown above (RTO).
Field: Temperature Equation Coefficient 3
The coefficient (B3) in the temperature equation shown above (RTO).
Field: Temperature Equation Coefficient 4
The coefficient (B4) in the temperature equation shown above (RTO).
Field: Temperature Equation Coefficient 5
The coefficient (B5) in the temperature equation shown above (RTO).
Field: Temperature Equation Coefficient 6
The coefficient (B6) in the temperature equation shown above (RTO).
Field: Temperature Equation Coefficient 7
The coefficient (B7) in the temperature equation shown above (RTO).
Field: Temperature Equation Coefficient 8
The coefficient (B8) in the temperature equation shown above (RTO).
The following 16 fields are used to establish the valid range for the dependent and
independent variables associated with the coefficients defined above (B 1 through B8) for the
regeneration outlet air temperature equation.
Field: Minimum Regeneration Inlet Air Humidity Ratio for Temperature Equation
The minimum allowable value of RWI in the temperature equation shown above
(kgWater/kgDryAir). Values of RWI less than the minimum will be replaced by this minimum
when calculating the regeneration outlet air temperature and a warning message will be
issued. The valid range for this input field is 0.0 to 1.0.

9/29/14

1674

Input-Output Reference

Group Heat Recovery

Field: Maximum Regeneration Inlet Air Humidity Ratio for Temperature Equation
The maximum allowable value of RWI in the temperature equation shown above
(kgWater/kgDryAir). Values of RWI greater than the maximum will be replaced by this
maximum when calculating the regeneration outlet air temperature and a warning message
will be issued. The valid range for this input field is 0.0 to 1.0.
Field: Minimum Regeneration Inlet Air Temperature for Temperature Equation
The minimum allowable value of RTI in the temperature equation shown above (C). Values of
RTI less than the minimum will be replaced by this minimum when calculating the
regeneration outlet air temperature and a warning message will be issued.
Field: Maximum Regeneration Inlet Air Temperature for Temperature Equation
The maximum allowable value of RTI in the temperature equation shown above (C). Values
of RTI greater than the maximum will be replaced by this maximum when calculating the
regeneration outlet air temperature and a warning message will be issued.
Field: Minimum Process Inlet Air Humidity Ratio for Temperature Equation
The minimum allowable value of PWI in the temperature equation shown above (kg/kg).
Values of PWI less than the minimum will be replaced by this minimum when calculating the
regeneration outlet air temperature and a warning message will be issued. The valid range
for this input field is 0.0 to 1.0.
Field: Maximum Process Inlet Air Humidity Ratio for Temperature Equation
The maximum allowable value of PWI in the temperature equation shown above (kg/kg).
Values of PWI greater than the maximum will be replaced by this maximum when calculating
the regeneration outlet air temperature and a warning message will be issued. The valid
range for this input field is 0.0 to 1.0.
Field: Minimum Process Inlet Air Temperature for Temperature Equation
The minimum allowable value of PTI in the temperature equation shown above (C). Values of
PTI less than the minimum will be replaced by this minimum when calculating the
regeneration outlet air temperature and a warning message will be issued.
Field: Maximum Process Inlet Air Temperature for Temperature Equation
The maximum allowable value of PTI in the temperature equation shown above (C). Values
of PTI greater than the maximum will be replaced by this maximum when calculating the
regeneration outlet air temperature and a warning message will be issued.
Field: Minimum Regeneration Air Velocity for Temperature Equation
The minimum allowable value of RFV in the temperature equation shown above (m/s).
Values of RFV less than the minimum will be replaced by this minimum when calculating the
regeneration outlet air temperature and a warning message will be issued. The minimum
value for this input field should be greater than 0.
Field: Maximum Regeneration Air Velocity for Temperature Equation
The maximum allowable value of RFV in the temperature equation shown above (m/s).
Values of RFV greater than the maximum will be replaced by this maximum value when
calculating the regeneration outlet air temperature and a warning message will be issued.
The minimum value for this input field should be greater than 0.
Field: Minimum Regeneration Outlet Air Temperature for Temperature Equation
The minimum value of RTO resulting from the temperature equation shown above (C). If RTO
is less than this value, RTO will be replaced by this minimum value and a warning message
will be issued.

9/29/14

1675

Input-Output Reference

Group Heat Recovery

Field: Maximum Regeneration Outlet Air Temperature for Temperature Equation

The maximum value of RTO resulting from the temperature equation shown above (C). If
RTO is greater than this value, RTO will be replaced by this maximum value and a warning
message will be issued.
Field: Minimum Regeneration Inlet Air Relative Humidity for Temperature Equation
The minimum relative humidity of the regeneration inlet air for the temperature equation
shown above (percent). If the relative humidity of the regeneration inlet air is below this value,
a warning message will be issued. The valid range for this input field is 0.0 to 100.0.
Field: Maximum Regeneration Inlet Air Relative Humidity for Temperature Equation
The maximum relative humidity of the regeneration inlet air for the temperature equation
shown above (percent). If the relative humidity of the regeneration inlet air is above this
value, a warning message will be issued. The valid range for this input field is 0.0 to 100.0.
Field: Minimum Process Inlet Air Relative Humidity for Temperature Equation
The minimum relative humidity of the process inlet air for the temperature equation shown
above (percent). If the relative humidity of the process inlet air is below this value, a warning
message will be issued. The valid range for this input field is 0.0 to 100.0.
Field: Maximum Process Inlet Air Relative Humidity for Temperature Equation
The maximum relative humidity of the process inlet air for the temperature equation shown
above (percent). If the relative humidity of the process inlet air is above this value, a warning
message will be issued. The valid range for this input field is 0.0 to 100.0.
The coefficients for the regeneration outlet air humidity ratio equation are defined in the
following eight fields:
Field: Humidity Ratio Equation Coefficient 1
The constant coefficient (C1) in the humidity ratio equation shown above (RWO).
Field: Humidity Ratio Equation Coefficient 2
The coefficient (C2) in the humidity ratio equation shown above (RWO).
Field: Humidity Ratio Equation Coefficient 3
The coefficient (C3) in the humidity ratio equation shown above (RWO).
Field: Humidity Ratio Equation Coefficient 4
The coefficient (C4) in the humidity ratio equation shown above (RWO).
Field: Humidity Ratio Equation Coefficient 5
The coefficient (C5) in the humidity ratio equation shown above (RWO).
Field: Humidity Ratio Equation Coefficient 6
The coefficient (C6) in the humidity ratio equation shown above (RWO).
Field: Humidity Ratio Equation Coefficient 7
The coefficient (C7) in the humidity ratio equation shown above (RWO).
Field: Humidity Ratio Equation Coefficient 8
The coefficient (C8) in the humidity ratio equation shown above (RWO).

9/29/14

1676

Input-Output Reference

Group Heat Recovery

The following 16 fields are used to establish the valid range for the dependent and
independent variables associated with the coefficients defined above (C 1 through C8) for the
regeneration outlet air humidity ratio equation.
Field: Minimum Regeneration Inlet Air Humidity Ratio for Humidity Ratio Equation
The minimum allowable value of RWI in the humidity ratio equation shown above
(kgWater/kgDryAir). Values of RWI less than the minimum will be replaced by this minimum
when calculating the regeneration outlet air humidity ratio and a warning message will be
issued. The valid range for this input field is 0.0 to 1.0.
Field: Maximum Regeneration Inlet Air Humidity Ratio for Humidity Ratio Equation
The maximum allowable value of RWI in the humidity ratio equation shown above
(kgWater/kgDryAir). Values of RWI greater than the maximum will be replaced by this
maximum when calculating the regeneration outlet air humidity ratio and a warning message
will be issued. The valid range for this input field is 0.0 to 1.0.
Field: Minimum Regeneration Inlet Air Temperature for Humidity Ratio Equation
The minimum allowable value of RTI in the humidity ratio equation shown above (C). Values
of RTI less than the minimum will be replaced by this minimum when calculating the
regeneration outlet air humidity ratio and a warning message will be issued.
Field: Maximum Regeneration Inlet Air Temperature for Humidity Ratio Equation
The maximum allowable value of RTI in the humidity ratio equation shown above (C). Values
of RTI greater than the maximum will be replaced by this maximum when calculating the
regeneration outlet air humidity ratio and a warning message will be issued.
Field: Minimum Process Inlet Air Humidity Ratio for Humidity Ratio Equation
The minimum allowable value of PWI in the humidity ratio equation shown above
(kgWater/kgDryAir). Values of PWI less than the minimum will be replaced by this minimum
when calculating the regeneration outlet air humidity ratio and a warning message will be
issued. The valid range for this input field is 0.0 to 1.0.
Field: Maximum Process Inlet Air Humidity Ratio for Humidity Ratio Equation
The maximum allowable value of PWI in the humidity ratio equation shown above
(kgWater/kgDryAir). Values of PWI greater than the maximum will be replaced by this
maximum when calculating the regeneration outlet air humidity ratio and a warning message
will be issued. The valid range for this input field is 0.0 to 1.0.
Field: Minimum Process Inlet Air Temperature for Humidity Ratio Equation
The minimum allowable value of PTI in the humidity ratio equation shown above (C). Values
of PTI less than the minimum will be replaced by this minimum when calculating the
regeneration outlet air humidity ratio and a warning message will be issued.
Field: Maximum Process Inlet Air Temperature for Humidity Ratio Equation
The maximum allowable value of PTI in the humidity ratio equation shown above (C). Values
of PTI greater than the maximum will be replaced by this maximum when calculating the
regeneration outlet air humidity ratio and a warning message will be issued.
Field: Minimum Regeneration Air Velocity for Humidity Ratio Equation
The minimum allowable value of RFV in the humidity ratio equation shown above (m/s).
Values of RFV less than the minimum will be replaced by this minimum when calculating the
regeneration outlet air humidity ratio and a warning message will be issued. The minimum
value for this input field should be greater than 0.

9/29/14

1677

Input-Output Reference

Group Heat Recovery

Field: Maximum Regeneration Air Velocity for Humidity Ratio Equation

The maximum allowable value of RFV in the humidity ratio equation shown above (m/s).
Values of RFV greater than the maximum will be replaced by this maximum when calculating
the regeneration outlet air humidity ratio and a warning message will be issued. The minimum
value for this input field should be greater than 0.
Field: Minimum Regeneration Outlet Air Humidity Ratio for Humidity Ratio Equation
The minimum value of RWO resulting from the humidity ratio equation shown above
(kgWater/kgDryAir). If RWO is less than this value, RWO will be replaced by this minimum
value and a warning message will be issued. The valid range for this input field is 0.0 to 1.0.
Field: Maximum Regeneration Outlet Air Humidity Ratio for Humidity Ratio Equation
The maximum value of RWO resulting from the humidity ratio equation shown above
(kgWater/kgDryAir). If RWO is greater than this value, RWO will be replaced by this
maximum value and a warning message will be issued. The valid range for this input field is
0.0 to 1.0.
Field: Minimum Regeneration Inlet Air Relative Humidity for Humidity Ratio Equation
The minimum relative humidity of the regeneration inlet air for the humidity ratio equation
shown above (percent). If the relative humidity of the regeneration inlet air is below this value,
a warning message will be issued. The valid range for this input field is 0.0 to 100.0.
Field: Maximum Regeneration Inlet Air Relative Humidity for Humidity Ratio Equation
The maximum relative humidity of the regeneration inlet air for the humidity ratio equation
shown above (percent). If the relative humidity of the regeneration inlet air is above this
value, a warning message will be issued. The valid range for this input field is 0.0 to 100.0.
Field: Minimum Process Inlet Air Relative Humidity for Humidity Ratio Equation
The minimum relative humidity of the process inlet air for the humidity ratio equation shown
above (percent). If the relative humidity of the process inlet air is below this value, a warning
message will be issued. The valid range for this input field is 0.0 to 100.0.
Field: Maximum Process Inlet Air Relative Humidity for Humidity Ratio Equation
The maximum relative humidity of the process inlet air for the humidity ratio equation shown
above (percent). If the relative humidity of the process inlet air is above this value, a warning
message will be issued. The valid range for this input field is 0.0 to 100.0.
Following is an example input for this heat exchanger performance data type object:
HeatExchanger:Desiccant:BalancedFlow:PerformanceDataType1,
HXDesPerf1,
!- Name
1.05,
!- Nominal Air Flow Rate {m3/s}
3.25,
!- Nominal Air Face Velocity {m/s}
50.0,
!- Nominal Electric Power {W}
-2.53636E+00,
!- Temperature Equation Coefficient 1
2.13247E+01,
!- Temperature Equation Coefficient 2
9.23308E-01,
!- Temperature Equation Coefficient 3
9.43276E+02,
!- Temperature Equation Coefficient 4
-5.92367E+01,
!- Temperature Equation Coefficient 5
-4.27465E-02,
!- Temperature Equation Coefficient 6
1.12204E+02,
!- Temperature Equation Coefficient 7
7.78252E-01,
!- Temperature Equation Coefficient 8

9/29/14

1678

Input-Output Reference

Group Demand Limiting Controls

0.007143,
!- Minimum Regeneration Inlet Air Humidity Ratio for Temperature Equation
0.024286,
!- Maximum Regeneration Inlet Air Humidity Ratio for Temperature Equation
46.111110,
!- Minimum Regeneration Inlet Air Temperature for Temperature Equation {C}
46.111112,
!- Maximum Regeneration Inlet Air Temperature for Temperature Equation {C}
0.005000,
!- Minimum Process Inlet Air Humidity Ratio for Temperature Equation
0.015714,
!- Maximum Process Inlet Air Humidity Ratio for Temperature Equation
4.583333,
!- Minimum Process Inlet Air Temperature for Temperature Equation {C}
21.83333,
!- Maximum Process Inlet Air Temperature for Temperature Equation {C}
2.286,
!- Minimum Regeneration Air Velocity for Temperature Equation {m/s}
4.826,
!- Maximum Regeneration Air Velocity for Temperature Equation {m/s}
35.0,
!- Minimum Regeneration Outlet Air Temperature for Temperature Equation {C}
50.0,
!- Maximum Regeneration Outlet Air Temperature for Temperature Equation {C}
5.0,
!- Minimum Regeneration Inlet Air Relative Humidity for Temperature Equation {percent}
45.0,
!- Maximum Regeneration Inlet Air Relative Humidity for Temperature Equation {percent}
80.0,
!- Minimum Process Inlet Air Relative Humidity for Temperature Equation {percent}
100.0,
!- Maximum Process Inlet Air Relative Humidity for Temperature Equation {percent}
-2.25547E+01,
!- Humidity Ratio Equation Coefficient 1
9.76839E-01,
!- Humidity Ratio Equation Coefficient 2
4.89176E-01,
!- Humidity Ratio Equation Coefficient 3
-6.30019E-02,
!- Humidity Ratio Equation Coefficient 4
1.20773E-02,
!- Humidity Ratio Equation Coefficient 5
5.17134E-05,
!- Humidity Ratio Equation Coefficient 6
4.94917E-02,
!- Humidity Ratio Equation Coefficient 7
-2.59417E-04,
!- Humidity Ratio Equation Coefficient 8
0.007143,
!- Minimum Regeneration Inlet Air Humidity Ratio for Humidity Ratio Equation
0.024286,
!- Maximum Regeneration Inlet Air Humidity Ratio for Humidity Ratio Equation
46.111110,
!- Minimum Regeneration Inlet Air Temperature for Humidity Ratio Equation {C}
46.111112,
!- Maximum Regeneration Inlet Air Temperature for Humidity Ratio Equation {C}
0.005000,
!- Minimum Process Inlet Air Humidity Ratio for Humidity Ratio Equation
0.015714,
!- Maximum Process Inlet Air Humidity Ratio for Humidity Ratio Equation
4.583333,
!- Minimum Process Inlet Air Temperature for Humidity Ratio Equation {C}
21.83333,
!- Maximum Process Inlet Air Temperature for Humidity Ratio Equation {C}
2.286,
!- Minimum Regeneration Air Velocity for Humidity Ratio Equation {m/s}
4.826,
!- Maximum Regeneration Air Velocity for Humidity Ratio Equation {m/s}
0.007914,
!- Minimum Regeneration Outlet Air Humidity Ratio for Humidity Ratio Equation
0.026279,
!- Maximum Regeneration Outlet Air Humidity Ratio for Humidity Ratio Equation
5.0,
!- Minimum Regeneration Inlet Air Relative Humidity for Humidity Ratio Equation {%}
45.0,
!- Maximum Regeneration Inlet Air Relative Humidity for Humidity Ratio Equation {percent}
80.0,
!- Minimum Process Inlet Air Relative Humidity for Humidity Ratio Equation {percent}
100.0;
!- Maximum Process Inlet Air Relative Humidity for Humidity Ratio Equation {percent}

HeatExchanger:Desiccant:BalancedFlow:PerformanceDataType1 Outputs
No variables are reported for this object. However, outputs are provided by the
HeatExchanger:Desiccant:BalancedFlow object that references this PerformanceDataType1
object.

Group Demand Limiting Controls

Demand limiting, or demand management, is a strategy for reducing a building's demand for
utilities, e.g., electricity. Utility companies typically charge a monthly fee for "demand
charges" that is based on the peak demand during a certain time period. Often the peak
demand charge is set by one exceptional day that is much higher than the peak demand for
an average day during the month. Therefore, to save utility costs, it is in the interest of
building owners to find ways to manage the demand on peak days. While demand
management is generally concerned with the demand for electricity, the future will likely see
demand management of other utilities, such as natural gas or water.
Demand limiting controls shut off or reduce the power to non-essential loads in order to
reduce the overall building demand. Some typical controls:
shut off or dim electric lights, equipment, or HVAC systems
reset the thermostatic set points on HVAC systems
reduce the load of a set of similar components by rotating one or more components
"off" for a short time interval
9/29/14

1679

Input-Output Reference

Group Demand Limiting Controls

turn on generators to meet some or all of the building's demand.

The demand limiting controls implemented in EnergyPlus are intended to allow some of the
more common demand limiting strategies. Currently, only Exterior:Lights, Lights,
ElectricEquipment, and ZoneControl:Thermostat objects can be demand limited. Additional
components will be demand limited in future releases.
DemandManagerAssignmentList
The DemandManagerAssignmentList object is a high level control that makes demand
limiting decisions based on a list of possible demand limiting strategies. Each demand limiting
strategy is described in a separate DemandManager object. (This is structured like the
relationship between the AvailabilityManagerAssignmentList and the AvailabilityManager
objects.)
Each DemandManagerAssignmentList monitors and demand limits one meter. Only
electricity meters are currently allowed. In many cases, the meter will be Electricity:Facility. A
schedule and safety factor are used to set the demand limit above which the
DemandManagers become activated. The billing month schedule and demand window are
also taken into account when calculating the demand limit.
DemandManagers in the list are activated based on the Demand Manager Priority. If the
Sequential option is used, each manager in the list is activated in sequence from first to last
until demand is reduced below the limit or until all managers are activated. If the All option is
used, all managers are activated simultaneously to achieve the maximum demand reduction.
A DemandManager is skipped if it cannot reduce the demand. Possible reasons that a
manager cannot reduce demand include:
not enough load to limit
not available because of its Availability Schedule
already activated; load limited during a previous timestep.
Field: Name
The name of the DemandManagerAssignmentList object.
Field: Meter Name
This field references the meter that is to be monitored and demand limited. Only electricity
meters are currently allowed.
Field: Demand Limit Schedule Name
The reference to the schedule object specifying the target demand limits [schedule values
should be in Watts].
Field: Demand Limit Safety Fraction
This field is a multiplier that is applied to the target demand limit (above). When the metered
demand exceeds (target demand limit * safety fraction), the DemandManagers begin to limit
the demand. This helps to ensure that the target limit is not exceeded.
Field: Billing Period Schedule Name
The reference to the schedule object that defines the monthly billing periods. The peak
demand during the peak period of the billing period typically determines the demand charge.
This should reference the same schedule that is used in the Month Schedule Name field of
the UtilityCost:Tariff object. If left blank, it defaults to the regular divisions between months.
Field: Peak Period Schedule Name
The reference to the schedule object that defines the peak/off-peak time-of-use periods. The
peak demand during the peak period of the billing period typically determines the demand
charge. This should reference the same schedule that is used in the Time of Use Period
9/29/14

1680

Input-Output Reference

Group Demand Limiting Controls

Schedule Name field of the UtilityCost:Tariff object. A value of 1 indicates the peak period;
any other value is off-peak. If left blank, it defaults to always on the peak period. The
DemandManagerAssignmentList only attempts to demand limit during peak periods.
Field: Demand Window Length
This field is similar to the field of the same name in the UtilityCost:Tariff object. However, the
user may not want to limit using the same demand window as the utility company. This field
allows the user to input the number of minutes over which to calculate the current demand.
The minutes are rounded to match the nearest multiple of time steps.
Field: Demand Manager Priority
This field indicates what logic should be used to activate the individual DemandManagers in
the list. Sequential treats the list of DemandManagers as a sequential priority list, i.e., the
first DemandManager in the list is activated first, then the second, etc., until the demand falls
below the limit. All activates all demand managers to achieve the maximum demand
reduction.
Field: Demand Manager Type 1
The key word defining the type of DemandManager.
Field: Demand Manager Name 1
The name of a DemandManager object defined elsewhere in the input file.
DemandManagers are listed by pairs of data items: Demand Manager Type and Demand
Manager Name. Ten managers are accomodated in the list by default. The IDD specification,
however, is extensible and additional pairs may be added by directly editing the IDD.
An example IDF showing how this object is used is provided below:
DemandManagerAssignmentList,
Demand Manager,
!- Name
Electricity:Facility,
!- Meter Name
Limit Schedule,
!- Demand Limit Schedule Name
1.0,
!- Demand Limit Safety Fraction
,
!- Billing Period Schedule Name
,
!- Peak Period Schedule Name
15,
!- Demand Window Length {minutes}
Sequential,
!- Demand Manager Priority
DemandManager:ExteriorLights, !- DemandManager 1 Object Type
Ext Lights Manager,
!- DemandManager 1 Name
DemandManager:ElectricEquipment, !- DemandManager 2 Object Type
Eq Mgr Stage 1,
!- DemandManager 2 Name
DemandManager:ElectricEquipment, !- DemandManager 3 Object Type
Eq Mgr Stage 2,
!- DemandManager 3 Name
DemandManager:ElectricEquipment, !- DemandManager 4 Object Type
Eq Mgr Stage 3,
!- DemandManager 4 Name
DemandManager:Lights,
!- DemandManager 5 Object Type
Lights Manager,
!- DemandManager 5 Name
DemandManager:Thermostats, !- DemandManager 6 Object Type
Thermostats Manager;
!- DemandManager 6 Name

DemandManagerAssignmentList Outputs
The following output variables are reported for the DemandManagerAssignmentList object:
Zone,Average,Demand Manager Meter Demand Power [W]
Zone,Average,Demand Manager Average Demand Power [W]
Zone,Average,Demand Manager Peak Demand Power [W]
Zone,Average,Demand Manager Scheduled Limit Power [W]
Zone,Average,Demand Manager Demand Limit Power [W]
Zone,Average,Demand Manager Avoided Demand [W]
Zone,Average,Demand Manager Over Limit Power [W]
Zone,Sum,Demand Manager Over Limit Time [hr]
9/29/14

1681

Input-Output Reference

Group Demand Limiting Controls

Zone,Sum,Demand Manager Exterior Energy Iteration Count []

Zone,Sum,Demand Manager Heat Balance Iteration Count []
Zone,Sum,Demand Manager HVAC Iteration Count []

Demand Manager Meter Demand Power [W]

The current demand for the designated meter.
Demand Manager Average Demand Power [W]
The current demand for the designated meter averaged over the Demand Window Length.
Demand Manager Peak Demand Power [W]
The peak demand in the billing month so far.
Demand Manager Scheduled Limit Power [W]
The scheduled target demand limit from the Demand Limit Schedule.
Demand Manager Demand Limit Power [W]
The actual demand limit after multiplication by the Demand Limit Safety Fraction.
Demand Manager Avoided Demand [W]
The demand that was avoided by the active DemandManagers.
Demand Manager Over Limit Power [W]
The difference between the demand limit and the average demand.
Demand Manager Over Limit Time [hr]
The number of hours that the demand limit was exceeded.
Demand Manager Exterior Energy Iteration Count []
The number times that the exterior energy use was resimulated for demand limiting.
Demand Manager Heat Balance Iteration Count []
The number times that the zone heat balance was resimulated for demand limiting.
Demand Manager HVAC Iteration Count []
The number times that the HVAC system was resimulated for demand limiting.
DemandManager:ExteriorLights
The DemandManager:ExteriorLights object is used for demand limiting Exterior:Lights
objects.
Field: Name
The name of the DemandManager:ExteriorLights object.
Field: Availability Schedule Name
The reference to the schedule object specifying the availability of this DemandManager. A
schedule value of 0 indicates that the unit is off for that time period. A schedule value greater
than 0 indicates that the unit can operate during the time period. If this field is blank, the
schedule has values of 1 for all time periods.

9/29/14

1682

Input-Output Reference

Group Demand Limiting Controls

Field: Limit Control

This field specifies the type of limiting control. The Fixed option reduces the power to the
controlled loads by a fixed amount determined by the Maximum Limit Fraction field. The Off
option disables the DemandManager in the simulation.
Field: Minimum Limit Duration
The minimum amount of time [minutes] that the DemandManager will continue to demand
limit after being activated. This prevents loads from turning on and off every time step.
Field: Maximum Limit Fraction
This field specifies a fraction of the Design Level power for the load that determines the
lowest allowable power level. With Limit Control set to Fixed, the power is reduced to
Maximum Limit Fraction * Design Level whenever the manager is activated. For example, if
the Maximum Limit Fraction is 0.8, then a 100 W design level load is reduced to 80 W when
limiting. A Maximum Limit Fraction of zero means that the load can be shut off entirely.
Field: Limit Step Change
NOT YET IMPLEMENTED.
Field: Selection Control
This field specifies which loads are selected to be limited. The All option simultaneously limits
all of the loads listed in this DemandManager. The RotateMany option limits all loads except
for one which rotates sequentially through the loads listed. The RotateOne limits only one
load which rotates sequentially through the loads listed. The time interval between rotations is
set by the Rotation Duration field.
Field: Rotation Duration
If the RotateOne or RotateMany option is used for Selection Control, this field sets the time
interval [minutes] between rotations.
Field: Exterior Lights 1-10 Name
The names of Exterior:Lights objects defined elsewhere in the input file. These are the loads
to be limited by this DemandManager.
Ten objects are accomodated in the list by default. The IDD specification, however, is
extensible and additional fields may be added by directly editing the IDD.
An example IDF showing how this object is used is provided below:
DemandManager:ExteriorLights,
Ext Lights Manager,
!,
!Fixed,
!60,
!0.0,
!,
!All,
!,
!Exterior Lights;
!-

Name
Availability Schedule Name
Limit Control
Minimum Limit Duration {minutes}
Maximum Limit Fraction
Limit Step Change
Selection Control
Rotation Duration {minutes}
Exterior Lights 1 Name

DemandManager:ExteriorLights Outputs
There are no output variables reported for the DemandManager:ExteriorLights object.
DemandManager:Lights
The DemandManager:Lights object is used for demand limiting Lights objects.
9/29/14

1683

Input-Output Reference

Group Demand Limiting Controls

Field: Name
The name of the DemandManager:Lights object.
Field: Availability Schedule Name
The reference to the schedule object specifying the availability of this DemandManager. A
schedule value of 0 indicates that the unit is off for that time period. A schedule value greater
than 0 indicates that the unit can operate during the time period. If this field is blank, the
schedule has values of 1 for all time periods.
Field: Limit Control
This field specifies the type of limiting control. The Fixed option reduces the power to the
controlled loads by a fixed amount determined by the Maximum Limit Fraction field. The Off
option disables the DemandManager in the simulation.
Field: Minimum Limit Duration
The minimum amount of time [minutes] that the DemandManager will continue to demand
limit after being activated. This prevents loads from turning on and off every time step.
Field: Maximum Limit Fraction
This field specifies a fraction of the Design Level power for the load that determines the
lowest allowable power level. With Limit Control set to Fixed, the power is reduced to
Maximum Limit Fraction * Design Level whenever the manager is activated. For example, if
the Maximum Limit Fraction is 0.8, then a 100 W design level load is reduced to 80 W when
limiting. A Maximum Limit Fraction of zero means that the load can be shut off entirely.
Field: Limit Step Change
NOT YET IMPLEMENTED.
Field: Selection Control
This field specifies which loads are selected to be limited. The All option simultaneously limits
all of the loads listed in this DemandManager. The RotateMany option limits all loads except
for one which rotates sequentially through the loads listed. The RotateOne limits only one
load which rotates sequentially through the loads listed. The time interval between rotations is
set by the Rotation Duration field.
Field: Rotation Duration
If the RotateOne or RotateMany option is used for Selection Control, this field sets the time
interval [minutes] between rotations.
Field: Lights 1-10 Name
The names of Lights objects defined elsewhere in the input file. These are the loads to be
limited by this DemandManager.
Ten objects are accomodated in the list by default. The IDD specification, however, is
extensible and additional fields may be added by directly editing the IDD.
If a global lights statement is used (Ref: Lights), then only that name need be entered and the
demand limiting will be applied to all the zones for that lighting. If only one of a set of zones
from a global lights statement is desired, then the name to be entered is: <Zone Name>
<Name of Lights Global Object>.
An example IDF showing how this object is used is provided below:

9/29/14

1684

Input-Output Reference
DemandManager:Lights,
Lights Manager,
,
Fixed,
60,
0.5,
,
All,
,
Space1-1 Lights 1,
Space2-1 Lights 1,
Space3-1 Lights 1,
Space4-1 Lights 1,
Space5-1 Lights 1;

Group Demand Limiting Controls

!!!!!!!!!!!!!-

Name
Availability Schedule Name
Limit Control
Minimum Limit Duration {minutes}
Maximum Limit Fraction
Limit Step Change
Selection Control
Rotation Duration {minutes}
Lights 1 Name
Lights 2 Name
Lights 3 Name
Lights 4 Name
Lights 5 Name

DemandManager:Lights Outputs
There are no output variables reported for the DemandManager:Lights object.
DemandManager:ElectricEquipment
The DemandManager:ElectricEquipment
ElectricEquipment objects.

object

is

used

for

demand

limiting

Field: Name
The name of the DemandManager:ElectricEquipment object.
Field: Availability Schedule Name
The reference to the schedule object specifying the availability of this DemandManager. A
schedule value of 0 indicates that the unit is off for that time period. A schedule value greater
than 0 indicates that the unit can operate during the time period. If this field is blank, the
schedule has values of 1 for all time periods.
Field: Limit Control
This field specifies the type of limiting control. The Fixed option reduces the power to the
controlled loads by a fixed amount determined by the Maximum Limit Fraction field. The Off
option disables the DemandManager in the simulation.
Field: Minimum Limit Duration
The minimum amount of time [minutes] that the DemandManager will continue to demand
limit after being activated. This prevents loads from turning on and off every time step.
Field: Maximum Limit Fraction
This field specifies a fraction of the Design Level power for the load that determines the
lowest allowable power level. With Limit Control set to Fixed, the power is reduced to
Maximum Limit Fraction * Design Level whenever the manager is activated. For example, if
the Maximum Limit Fraction is 0.8, then a 100 W design level load is reduced to 80 W when
limiting. A Maximum Limit Fraction of zero means that the load can be shut off entirely.
Field: Limit Step Change
NOT YET IMPLEMENTED.
Field: Selection Control
This field specifies which loads are selected to be limited. The All option simultaneously limits
all of the loads listed in this DemandManager. The RotateMany option limits all loads except
for one which rotates sequentially through the loads listed. The RotateOne limits only one

9/29/14

1685

Input-Output Reference

Group Demand Limiting Controls

load which rotates sequentially through the loads listed. The time interval between rotations is
set by the Rotation Duration field.
Field: Rotation Duration
If the RotateOne or RotateMany option is used for Selection Control, this field sets the time
interval [minutes] between rotations.
Field: Electric Equipment 1-10 Name
The names of ElectricEquipment objects defined elsewhere in the input file. These are the
loads to be limited by this DemandManager.
Ten objects are accomodated in the list by default. The IDD specification, however, is
extensible and additional fields may be added by directly editing the IDD.
If a global Electric Equipment statement is used (Ref: ElectricEquipment), then only that
name need be entered and the demand limiting will be applied to all the zones for that
equipment. If only one of a set of zones from a global electric equipment statement is
desired, then the name to be entered is: <Zone Name> <Name of ElectricEquipment Global
Object>.
An example IDF showing how this object is used is provided below:
DemandManager:ElectricEquipment,
Eq Mgr Stage 3,
!- Name
,
!- Availability Schedule Name
Fixed,
!- Limit Control
60,
!- Minimum Limit Duration {minutes}
0.0,
!- Maximum Limit Fraction
,
!- Limit Step Change
All,
!- Selection Control
,
!- Rotation Duration {minutes}
Space5-1 ElecEq 1;
!- Electric Equipment 1 Name

DemandManager:ElectricEquipment Outputs
There are no output variables reported for the DemandManager:ElectricEquipment object.
DemandManager:Thermostats
The
DemandManager:Thermostats
ZoneControl:Thermostat objects.

object

is

used

for

demand

limiting

Field: Name
The name of the DemandManager:Thermostats object.
Field: Availability Schedule Name
The reference to the schedule object specifying the availability of the DemandManager. A
schedule value of 0 indicates that the unit is off for that time period. A schedule value greater
than 0 indicates that the unit can operate during the time period. If this field is blank, the
schedule has values of 1 for all time periods.
Field: Reset Control
This field specifies the type of limiting control. The Fixed option resets the thermostats to a
fixed temperature determined by the Maximum Heating Setpoint Reset and Maximum
Cooling Setpoint Reset fields. The Off option disables the DemandManager in the simulation.

9/29/14

1686

Input-Output Reference

Group Demand Limiting Controls

Field: Minimum Reset Duration

The minimum amount of time [minutes] that the DemandManager will continue to demand
limit after being activated. This prevents thermostats from resetting on and off every time
step.
Field: Maximum Heating Setpoint Reset
This field specifies the thermostat heating setpoint temperature [C] that represents the largest
allowable temperature reset or setback. With Reset Control set to Fixed, the setpoint
temperature is reset to the Maximum Heating Setpoint Reset whenever the manager is
activated. For example, if the heating setpoint is normally 22 C and the Maximum Heating
Setpoint Reset is 20 C, then the setpoint is reset to 20 C when limiting.
Field: Maximum Cooling Setpoint Reset
This field specifies the thermostat cooling setpoint temperature [C] that represents the largest
allowable temperature reset or setback. With Reset Control set to Fixed, the setpoint
temperature is reset to the Maximum Cooling Setpoint Reset whenever the manager is
activated. For example, if the cooling setpoint is normally 22 C and the Maximum Cooling
Setpoint Reset is 24 C, then the setpoint is reset to 24 C when limiting.
Field: Reset Step Change
NOT YET IMPLEMENTED.
Field: Selection Control
This field specifies which loads are selected to be limited. The All option simultaneously limits
all of the loads listed in this DemandManager. The RotateMany option limits all loads except
for one which rotates sequentially through the loads listed. The RotateOne limits only one
load which rotates sequentially through the loads listed. The time interval between rotations is
set by the Rotation Duration field.
Field: Rotation Duration
If the RotateOne or RotateMany option is used for Selection Control, this field sets the time
interval [minutes] between rotations.
Field: Thermostat 1-10 Name
The names of ZoneControl:Thermostat objects defined elsewhere in the input file. These are
the loads to be limited by this DemandManager.
Ten objects are accomodated in the list by default. The IDD specification, however, is
extensible and additional fields may be added by directly editing the IDD.
If a global thermostat statement is used (Ref: ZoneControl:Thermostat), then only that name
need be entered and the demand limiting will be applied to all the zones for that thermostatic
control. If only one of a set of zones from a global thermostat statement is desired, then the
name to be entered is: <Zone Name> <Name of Thermostat Global Object>.
An example IDF showing how this object is used is provided below:

9/29/14

1687

Input-Output Reference
DemandManager:Thermostats,
Thermostats Manager,
,
Fixed,
60,
19,
26,
,
All,
,
SPACE1-1 Control,
SPACE2-1 Control,
SPACE3-1 Control,
SPACE4-1 Control,
SPACE5-1 Control;

Group -- Electric Load Center-Generator Specifications

!!!!!!!!!!!!!!-

Name
Availability Schedule Name
Reset Control
Minimum Reset Duration {minutes}
Maximum Heating Setpoint Reset {C}
Maximum Cooling Setpoint Reset {C}
Reset Step Change
Selection Control
Rotation Duration {minutes}
Thermostat 1 Name
Thermostat 2 Name
Thermostat 3 Name
Thermostat 4 Name
Thermostat 5 Name

DemandManager:Thermostats Outputs
There are no output variables reported for the DemandManager:Thermostats object.

Group -- Electric Load Center-Generator Specifications

ElectricLoadCenter:Transformer
This object is used to model the energy losses of transformers when they are used to transfer
electricity from the grid to a building (as distribution transformers) or transfer electricity from
onsite generators to the grid. Distribution transformers reduce the voltage on utility
distribution lines (34.5 kV or less) to a lower secondary voltage (600 V or less) suitable for
customer equipment. According to the medium used for cooling and insulation, distribution
transformers can be classified into liquid-immersed and dry type transformers. According to
the input voltages, distribution transformers can be classified into medium-voltage (between
600 V and 34.5kV) and low-voltage transformer (less than 600 V). The transformers used to
output the surplus electricity from onsite generators to the grid usually match the
cogeneration voltage to the grid. This object can be used for all types of distribution
transformers and the transformers used to output electricity from onsite generators to the
grid, but the model defaults applies to the low-voltage dry type transformers because they are
the most common type found in commercial and industrial facilities.
Energy losses in transformers consist of the no load (core) loss and the load (winding) loss.
The no load loss comes primarily from the switching of the magnetic fields in the core
material. It is roughly constant and exists continuously in the core material as long as the
transformer is energized. The load loss comes from the electrical resistance in the windings
when there is a load on the transformer. The load loss is proportional to the load squared with
a small temperature correction. The energy losses at a given load depend on the
transformers performance. This object provides the user two alternative ways to indicate the
transformers performance. First, the user can provide the no load loss and load loss at rated
conditions. Second, the user can provide the nameplate efficiency and the corresponding
reference conditions. The detailed algorithms to calculate the energy losses are described in
the Engineering Reference.
The user needs to specify which loads are connected to the transformer. This is achieved in
different manners depending on the transformer usage. For a distribution transformer, the
user needs to provide a number of electric meters wired to that transformer. The input object
can currently accommodate up to ten meters, but it is extensible by modifying the
Energy+.idd entry. For a transformer used to output electricity from onsite generators to the
grid, the user needs to indicate the transformer name in the served electric load center.

9/29/14

1688

Input-Output Reference

Group -- Electric Load Center-Generator Specifications

Field: Availability Schedule Name

This alpha field contains the schedule name (ref. Schedule objects) that contains information
on the availability of the transformer. A schedule value greater than 0 (usually 1 is used)
indicates that the transformer is available to convert AC power from one voltage to another. A
value less than or equal to 0 (usually 0 is used) denotes that the transformer is not available.
If this field is blank, the schedule has values of 1 for all time periods.
Field: Transformer Usage
This field indicates one of the two supported transformer application types: PowerInFromGrid
and PowerOutFromOnsiteGeneration. The first type of transformer is used to step down
voltage from the electricity grid to a building. The second type of transformer is used to match
voltage from building onsite generators to the electricity grid.
Field: Zone Name
This field contains the name of the thermal zone where the transformer is located. Entering a
valid name of zone here will direct EnergyPlus to include the transformers losses as heat
gains to the named thermal zone. If the transformer is not within a thermal zone, this field can
be left blank and the thermal energy associated with transformer losses is removed from the
building model.
Field: Radiative Fraction
This field contains the fraction of transformers losses that enter the zone as long-wave
thermal radiation. This numeric filed should have a value between 0.0 and 1.0. The balance
of the losses is convective. This field is not used if the previous field for zone name is left
blank.
Field: Rated Capacity
This field defines the rated capacity of the transformer in VA.
Field: Phase
This field indicates whether the transformer is a single phase or three phase type. The two
alternative values are 1 or 3. The default is 3. This field is currently not used in the model.
Field: Conductor Material
This field specifies the winding material used by the transformer. There are two options:
Copper and Aluminum. The choice will determine the thermal coefficient of resistance used to
calculate the temperature correction factor for the transformer load losses. The default is
Aluminum.
Field: Full Load Temperature Rise
This numeric field defines the temperature rise of the windings above the ambient
temperature, when the transformer is loaded at its nameplate rating. For liquid-immersed
distribution transformers, the full load temperature rise usually takes the value of 65 C. For
dry-type transformers, the temperature rise usually takes three optional values: 80, 115 and
150 C. This field accepts any value between the minimum (50 C) and the maximum (180
C). The default is 150 C.
Field: Fraction of Eddy Current Losses
This field defines the fraction of load losses resulting from the eddy currents. Transformers
load losses comprise two parts: the ohmic loss due to the current flowing in the resistance of
the windings and the eddy and stray losses due to the eddy currents. This field indicates the
fraction of the load losses due to the eddy currents. This numeric field should have a value
between 0.0 and 1.0. The default is 0.1.

9/29/14

1689

Input-Output Reference

Group -- Electric Load Center-Generator Specifications

Field: Performance Input Method

This alpha field contains the method by which the user will specify the transformer
performance: RatedLosses or NominalEfficiency. If this field is left blank in the input data
file, the default input method is assumed to be RatedLosses. If the method
NominalEfficiency is selected, the user must enter the fields for the nameplate efficiency
and the corresponding reference coditions as described below. If the method RatedLosses
is selected, then the fields for rated no load loss and load loss must be entered as described
below.
Field: Rated No Load Loss
This field defines the no load loss (W) at rated load and conditions. The no load loss is
roughly constant and exists whenever the transformer is energized. The no load loss is also
called the core loss. This field is used only if the field of Performance Input Method is
specified as RatedLosses.
Field: Rated Load Loss
This field defines the load loss (W) at rated load and conditions. The load loss varies with the
square of the load being served by the transformer. The load loss is also called the winding
loss because the load loss occurs in the primary and secondary windings around the core.
This field is used only if the field of Performance Input Method is specified as RatedLosses.
Field: Nameplate Efficiency
This field contains the value for transformer efficiency at a given per unit load and specified
reference temperature. This field is used only if the field of Performance Input Method is
specified as NominalEfficiency. The default is 0.98.
Field: Per Unit Load for Nameplate Efficiency
This field defines the percentage of the rated capacity at which the nameplate efficiency is
measured. According to the NEMA (National Electrical Manufactures Association) Standard
TP-1, the per unit load takes the value of 0.35 for dry-type distribution transformers and it
takes the value of 0.50 for liquid-filled distribution transformers. The default is 0.35.
Field: Reference Temperature for Nameplate Efficiency
This field defines the conductor temperature at which the nameplate efficiency is measured.
This field is used only if the field of Performance Input Method is specified as
NominalEfficiency. According to the NEMA Standard TP-1, the reference temperature takes
the value of 75 C for dry-type distribution transformers and it takes the value of 55 C for
liquid-filled distribution transformers. The default is 75 C.
Field: Per Unit Load for Maximum Efficiency
This field defines the percentage of the rated capacity at which the maximum efficiency is
obtained. This field is used only if the field of Performance Input Method is specified as
NominalEfficiency. A blank field indicates that it takes the same value as the per unit load
for nameplate efficiency.
Field: Consider Transformer Loss for Utility Cost
This field indicates whether the transformer losses are considered to calculate utility cost. In
some cases, the transformer losses are required but they are not part of the energy
consumption for utility cost calculation. For example, the transformer is owned by the utility
company but it locates in the building. In this case, it might be desired to model transformer
energy losses for HVAC operation but the energy losses will not be accounted for utility cost.
Field: Electric Meter 1-10 Name
A transformer may serve different loads such as plug loads, some lighting loads, and some
HVAC equipment loads. The user needs to specify which loads are connected to the
9/29/14

1690

Input-Output Reference

Group -- Electric Load Center-Generator Specifications

transformer. This is achieved by providing a list of electric meters wired to the transformer.
The input object can currently accommodate up to ten meters, but it is extensible by
modifying the Energy+.idd entry. Any valid electric meter name can be used here to wire to
the transformer loads. Many different meters are automatically generated by the program and
will depend on the objects used throughout the input file. The typical process of determining
the exact name to enter in this field involves doing an initial run of EnergyPlus and then
examining the *.mdd file which will list the meters and their resulting names. A custom meter
is also supported. The meter must have electricity as its resource type.
An example input of the ElectricLoadCenter:Transformer input is:
ElectricLoadCenter:Transformer,
Transformer 1,
!-Name
Always On,
!- Availability Schedule Name
PowerInFromGrid,
!- Transformer Usage
,
!- Zone Name
,
!- Radiative Fraction
15000,
!- Nameplate Rating {VA}
3,
!- Phase
Aluminum,
!- Conductor Material
150,
!- Full Load Temperature Rise {C}
0.1,
!- Fraction of Eddy Current Losses
NominalEfficiency,
!- Performance Input Method
,
!- Rated No Load Loss {W}
,
!- Rated Load Loss {W}
0.985,
!- Nameplate Efficiency
0.35,
!- Per Unit Load for Nameplate Efficiency
75,
!- Reference Temperature for Nameplate Efficiency {C}
,
!- Per Unit Load for Maximum Efficiency
Yes,
!- Consider Transformer Loss for Utility Cost
Electricity:Building;
!- Meter 1 Name

Schedule:Compact,
Always On,
Fraction,
Through: 12/31,
For: AllDays,
Until: 24:00,
1.0;

!!!!!!-

Name
ScheduleType
Field #1
Field #2
Field #3
Field #4

ElectricLoadCenter:Transformer Outputs
HVAC,Average,Transformer Efficiency[]
HVAC,Average,Transformer Output Electric Power[W]
HVAC,Sum,Transformer Output Elecric Energy [J]
HVAC,Average,Transformer Input Electric Power[W]
HVAC,Sum,Transformer Input Electric Energy [J]
HVAC,Average,Transformer No Load Loss Rate [W]
HVAC,Sum,Transformer No Load Loss Energy [J]
HVAC,Average,Transformer Load Loss Rate [W]
HVAC,Sum,Transformer Load Loss Energy [J]
HVAC,Average,Transformer Thermal Loss Rate [W]
HVAC,Sum,Transformer Thermal Loss Energy [J]
HVAC,Sum,Transformer Distribution Electric Loss Energy [J]
HVAC,Sum,Transformer Cogeneration Electric Loss Energy [J]

Transformer Efficiency
This output field is the efficiency at which the distribution transformer changes alternating
current from the higher primary voltage to a lower secondary voltage. The efficiency is
calculated for each HVAC system timestep being simulated, and the results are averaged for
the timestep being reported.
9/29/14

1691

Input-Output Reference

Group -- Electric Load Center-Generator Specifications

Transformer Output Electric Power [W]

Transformer Output Elecric Energy [J]
These outputs are the total electricity power or energy provided by the transformer. They are
equal to the metered loads which are wired to the transformer. These values are calculated
for each HVAC system timestep being simulated, and the results are averaged (for power) or
summed (for energy) for the timestep being reported.
Transformer Input Electric Power [W]
Transformer Input Electric Energy [J]
These outputs are the total electricity power or energy fed into the transformer. These values
are calculated for each HVAC system timestep being simulated, and the results are averaged
(for power) or summed (for energy) for the timestep being reported.
Transformer No Load Loss Rate [W]
Transformer No Load Loss Energy [J]
These outputs are the no load loss occurred in the transformer. These values are calculated
for each HVAC system timestep being simulated, and the results are averaged (for rate) or
summed (for energy) for the timestep being reported.
Transformer Load Loss Rate [W]
Transformer Load Loss Energy [J]
These outputs are the load loss occurred in the transformer. These values are calculated for
each HVAC system timestep being simulated, and the results are averaged (for rate) or
summed (for energy) for the timestep being reported.
Transformer Thermal Loss Rate [W]
Transformer Thermal Loss Energy [J]
These outputs are the total energy losses occurred in the transformer. They are equal to the
sum of the no load loss and the load loss. These values are calculated for each HVAC
system timestep being simulated, and the results are averaged (for rate) or summed (for
energy) for the timestep being reported.
Transformer Distribution Electric Loss Energy [J]
This output is the total energy losses occurred in the transformer when it is used for input
power from grid to building. It is set as zero if the transformer is used to transfer energy from
onsite power generators to the electricity grid. This output is also added to a meter with
ResourceType = Electricity, GroupKey = System.
Transformer Cogeneration Electric Loss Energy [J]
This output is the total energy losses occurred in the transformer when it is used for input
onsite cogeneration to the grid. It is set as zero if the transformer is used to transfer the
electricity grid to building. This output is also added to a meter with ResourceType =
ElectricityProduced, EndUseKey = Cogeneration, GroupKey = System.
ElectricLoadCenter:Distribution
ElectricLoadCenter:Distribution objects are used to include on-site electricity generators in a
simulation. The electric load center dispatches generators according to operation schemes
and tracks and reports the amount of electricity generated and purchased. When using onsite generators, the program provides a net report where the total electricity used is reduced
by the amount generated on site. Electrical demand tracking is done by the internal or custom
meters used by EnergyPlus for reporting. The thermal demand tracking uses internal load
calculations from the plant simulation. The dispatching of different generators is based on
9/29/14

1692

Input-Output Reference

Group -- Electric Load Center-Generator Specifications

expectations based on their nominal/rated electric power output. If the current conditions are
such that the generator model determines that generation was higher or lower, then the
results of the dispatch may differ from expectations.
Multiple different ElectricLoadCenter:Distribution objects can be included in an input file. A
great deal of flexibility is available by mixing different load centers and operating schemes. If
multiple load centers are used, the supervisory control will dispatch generators sequentially
across the load centers. Therefore, the order of these input objects in the IDF file becomes
important with the generators associated with first load center in the file being the first to be
managed. A certain amount of caution is needed to avoid conflicting operating schemes.
The electricity produced from photovoltaic arrays will be reported in the electricity produced
output variable and will reduce the demand that the generators will try to meet for that
timestep.
Field: Name
This alpha field contains the identifying name for the electric load center.
Field: Generator List Name
This alpha field contains the identifying name for the list of generators in the set.
Field: Generator Operation Scheme Type
This alpha field specifies the type of operating scheme for the generator set. The available
operating schemes are Baseload, DemandLimit, TrackElectrical, TrackSchedule,
TrackMeter, FollowThermal, and FollowThermalLimitElectrical. The Baseload scheme
operates the generators at their rated (requested) electric power output when the generator is
scheduled ON (ref. ElectricLoadCenter:Generators). The Baseload scheme requests all
generators scheduled ON (available) to operate, even if the amount of electric power
generated exceeds the total facility electric power demand. The DemandLimit scheme limits
the amount of purchased electrical from the utility to the amount specified in the input object.
The DemandLimit scheme tries to have the generators meet all of the demand above the
purchased electric limit set by the user in the next field. The TrackElectrical scheme tries to
have the generators meet all of the electrical demand for the building. The TrackSchedule
scheme tries to have the generators meet all of the electrical demand determined in a userdefined schedule. The TrackMeter scheme tries to have the generators meet all the electrical
demand from a meter, which could also be a user-defined custom meter.
The DemandLimit, TrackElectrical, TrackSchedule, and TrackMeter schemes will sequentially
load the available generators. All demand not met by available generator capacity will be met
by purchased electrical. Therefore, if DemandLimit, TrackElectrical, TrackSchedule, or
TrackMeter is utilized and the available generators are not enough to meet demand, then
purchased electrical will offset the difference. If a generator is needed in the simulation for a
small load and it is less than the minimum part load ratio the generator will operate at the
minimum part load ratio and the excess will either reduce demand or the excess energy will
be available for returning to the electric grid.
The FollowThermal and FollowThermalLimitElectrical schemes are for heat following
cogeneration and run the generators to meet the thermal demand. The FollowThermal
schemes allow excess electrical generation to be exported to the grid, while the
FollowThermalLimitElectrical scheme restricts generator output to a maximum of the
buildings current electrical demand (so that no electricity is exported). The thermal demand
is determined from the plant modeling and depends on the flow requested by other
components on the demand side of the plant loop, the loop temperatures, and the loop
temperature set point. The electric load center converts the thermal load to an electrical load
using a nominal ratio of the thermal to electrical power production for each generator. For
these schemes, the generator needs to be connected to the supply side of a plant loop and
components that request hot water need to be on the demand side of the plant loop. This is
different than the usual configuration for electrical following schemes where the generator is
put on the demand side and request flow for the purposes of cooling the generator.
9/29/14

1693

Input-Output Reference

Group -- Electric Load Center-Generator Specifications

Therefore a switch from one of the electrical-based operating schemes to one of the thermalbased operating schemes requires a substantial change in plant topology.
If the load center includes electrical storage, then the choice of operating schemes will also
affect how storage is managed.
Field: Demand Limit Scheme Purchased Electric Demand Limit
This numerical field is the user input for the demand limit above which the generators will try
and meet the entire electrical load on the building minus the photovoltaic array if available.
Field: Track Schedule Name Scheme Schedule Name
This alpha field is the user input for the name of a schedule defined elsewhere in the input file
that contains values for the demand loads placed on the generator(s). The schedule values
should be in Watts.
Field: Track Meter Scheme Meter Name
This alpha field is the user input for the name of a meter. Any valid meter name can be used
here to control the loads that the generator(s) will try to meet. Many different meters are
automatically generated by the program and will depend on the objects used throughout the
input file. The typical process of determining the exact name to enter in this field involves
doing an initial run of EnergyPlus and then examining the *.rdd file which will list the meters
and their resulting names. The *.mtd file will also be useful to understand what exactly is
included in a meter. The user can also use the Output:CustomMeter objects to redefine meter
names and to control what electrical loads are included on them in a flexible manner.
Field: Electrical Buss Type
This alpha field is used to describe how the electric load center is configured with respect to
any power conditioning and/or storage equipment. There are five configurations for load
centers available by using one of these keywords:
AlternatingCurrent
AlternatingCurrentWithStorage
DirectCurrentWithInverter
DirectCurrentWithInverterDCStorage
DirectCurrentWithInverterACStorage
AlternatingCurrent is the default. All the generators connected to a specific load center need
to be of the same type (all AC or all DC). If the generators are DC, then an inverter is needed
to convert the DC to AC. If there are DC generators and a DC electrical storage device on
the buss along with an inverter, then use DirectCurrentWithInverterDCStorage in this field.
See the Engineering Reference for more information including diagrams of the load center
configurations.
Field: Inverter Object Name
This field is used to identify the inverter connected to this load center (if any). This field is
only used if the Electrical Buss Type is set to DirectCurrentWithInverter and should contain
the user-defined name of an inverter object. There are three types of inverter models
availablesee
ElectricLoadCenter:Inverter:Simple,
ElectricLoadCenter:Inverter:LookUpTable, or ElectricLoadCenter:Inverter:FunctionOfPower.
Enter the name of one of these types of inverter objects defined elsewhere in the input file.
Field: Electrical Storage Object Name
This field is used to identify the electrical storage connected to this load center (if any). This
field is only used if the Electrical Buss Type is set to DirectCurrentWithInverterDCStorage or
DirectCurrentWithInverterACStorage.
Enter
the
name
of
an
ElectricLoadCenter:Storage:Simple object defined elsewhere in the input file.

9/29/14

1694

Input-Output Reference

Group -- Electric Load Center-Generator Specifications

Field: Transformer Object Name

This field is used to identify the transformer connected to this load center (if any). This field
can be used for any electrical buss types. Enter the name of an
ElectricLoadCenter:Transformer object defined elsewhere in the input file.
Examples of this object are:
ElectricLoadCenter:Distribution,
SOFC Electric Load Center, !- Name
Micro-Generators,
!- Generator List Name
Baseload,
!- Generator Operation Scheme Type
0.0,
!- Demand Limit Scheme Purchased Electric Demand Limit {W}
,
!- Track Schedule Name Scheme Schedule Name
,
!- Track Meter Scheme Meter Name
AlternatingCurrent,
!- Electrical Buss Type
,
!- Inverter Object Name
;
!- Electrical Storage Object Name
ElectricLoadCenter:Distribution,
Electric Load Center,
!- Name
Backup Generators,
!- Generator List Name
DemandLimit,
!- Generator Operation Scheme Type
10000.0,
!- Demand Limit Scheme Purchased Electric Demand Limit {W}
,
!- Track Schedule Name Scheme Schedule Name
,
!- Track Meter Scheme Meter Name
AlternatingCurrent,
!- Electrical Buss Type
,
!- Inverter Object Name
;
!- Electrical Storage Object Name

ElectricLoadCenter:Distribution Outputs
There are three levels of results reporting related to electric load centers and generators.
The top level of reporting provides results across the whole building and all the different
electric load centers and generators. The second level of reporting provides results for
individual load centers. The third level is for each type of generator (see individual generator
descriptions). This section discusses the first two levels.
The whole-building summary output variables are:
HVAC,Average,Facility Total Produced Electric Power [W]
HVAC,Sum,Facility Total Produced Electric Energy [J]
HVAC,Average,Facility Total Purchased Electric Power [W]
HVAC,Sum,Facility Total Purchased Electric Energy [J]
HVAC,Average,Facility Total Building Electric Demand Power [W]
HVAC,Average,Facility Total HVAC Electric Demand Power [W]
HVAC,Average,Facility Total Electric Demand Power [W]

These output variables all use a default keyword Whole Building.

These output variables can also be accessed without specifying generation equipment by
including the syntax shown below:
ElectricLoadCenter:Distribution,
Electric Load Center; !- Name

Even if no ElectricLoadCenter:Distribution object is included, these output variables are also

available for all simulations that have any electricity consuming equipment with the default
keyword name Electrical Service.
Facility Total Produced Electric Power [W]
Facility Total Produced Electric Energy [J]
These outputs are the total generator and photovoltaic electricity produced on-site for the
entire model, and they are in both Power and Energy units. When electrical storage is used
with on-site production, the electricity put into storage is decremented from production and
the electricity removed storage is added to production. This means that losses from a round
trip through electrical storage decrease on-site electricity production.

9/29/14

1695

Input-Output Reference

Group -- Electric Load Center-Generator Specifications

Facility Total Purchased Electric Power [W]

Facility Total Purchased Electric Energy [J]
These outputs are the total of electricity purchased for the entire model in both Power and
Energy units. This value is always positive and indicates the amount of energy is purchased
from the utility.
Facility Total Surplus Electric Energy [J]
This output is the excess electricity produced and sent out to the electrical grid. This value is
always positive and indicates the surplus electricity from generation that exceeds wholebuilding demand and fed into the grid.
Facility Total Building Electric Demand Power [W]
This output variable includes all of the electric demand from the building (non-HVAC) portion
of the simulation, which would contain lights, electrical equipment, exterior lights and
equipment, etc.
Facility Total HVAC Electric Demand Power [W]
This output variable includes all of the electric demand from the HVAC portion of the
simulation, which would contain fans, electric coils, pumps, chillers, cooling towers, etc.
Facility Total Electric Demand Power [W]
This is the total of the whole Building and HVAC electric demands.
Facility Net Purchased Electric Power [W]
Facility Net Purchased Electric Energy [J]
These outputs are the net electricity purchased in both Power and Energy units. This value
can be either positive or negative. Positive values are defined as electricity purchased from
the utility. Negative values are defined as surplus electricity fed back into the grid.
Each ElectricLoadCenter also collects results from the individual generators that are
connected to that load center. The output variables available at the ElectricLoadCenter level
are:
HVAC,Average,Electric Load Center Requested Electric Power [W]
HVAC,Average,Electric Load Center Produced Electric Power [W]
HVAC,Sum,Electric Load Center Produced Electric Energy [J]
HVAC,Average,Electric Load Center Produced Thermal Rate [W]
HVAC,Sum,Electric Load Center Produced Thermal Energy [J]

Electric Load Center Requested Electric Power [W]

This output variable is the average electric power supply (in watts) requested by the load
center from its generators for the time step being reported. For the baseload operating
scheme, this output variable should equal the sum of the power supply requests for the
available generators associated with this load center (ref. ElectricLoadCenter:Generators).
In other cases, this output could be different from the sum of the power supply requests for
the generators associated with this load center. For example, a generator might be requested
to provide a certain amount of power but can only provide a fraction of the requested amount.
In this case the load center will detect this shortfall and include it when calculating the power
request for the next available generator. Therefore, the sum of the power supply requests for
the
individual
generators
associated
with
this
load
center
(ref.
ElectricLoadCenter:Generators) could be greater than the Electric Load Center Requested
Electric Power output variable.

9/29/14

1696

Input-Output Reference

Group -- Electric Load Center-Generator Specifications

Electric Load Center Produced Electric Power [W]

Electric Load Center Produced Electric Energy [J]
These outputs are the sum of electrical energy and power produced by the generators
attached to a particular load center. The keywords for these reports are the unique names of
ElectricLoadCenter:Distribution objects.
Electric Load Center Produced Thermal Rate [W]
Electric Load Center Produced Thermal Energy [J]
These outputs are the sum of the thermal energy and power produced by the generators
attached to a particular load center. The keywords for these reports are the unique names of
ElectricLoadCenter:Distribution objects.
ElectricLoadCenter:Generators
The ElectricLoadCenter:Generators object is used to provide a list of the generators to
include in the simulation. The list includes the names and types of all the generators along
with separate availability schedules, the rated power output, and thermal-to-electrical power
ratio for each. Sets of five input fields are repeated for each generator. If more than 30
generators are needed, EnergyPlus will auto-extend to suit the needs but other interfaces
(such as the IDF Editor may not). The user can always modify the Energy+.idd file to
accommodate the extra fields necessary, but it is likely the next release of EnergyPlus will
overwrite any user modifications.
Field: Name
This alpha field contains the identifying name for the generators in the set.
FieldSet: Name, Object Type, Rated Power Output, Availability, Thermal Ratio up to 30
Each generator is specified by a set of 5 input fields that contain an identifying name, a
keyword that indicates the type of generator, the rated output of the generator, the availability
schedule of the generator, and the thermal to electrical power production ratio.
Field: Generator <x> Name
This alpha field contains the identifying name for the first generator in the list.
Field: Generator <x> Object Type
This alpha field contains the keyword for the type of generator. The available types include:
Generator:InternalCombustionEngine
Generator:CombustionTurbine
Generator:Photovoltaic
Generator:FuelCell
Generator:MicroCHP
Generator:MicroTurbine
Generator:WindTurbine
These keywords are the names of the input objects for the type of generator.
Field: Generator <x> Rated Electric Power Output
This numeric field contains the nominal electric power output to be requested from generator
1. It is normally equal to the rated power output of the generator in Watts. This value is used
only for supervisory control and generator dispatch; the actual power output for each time
step is determined by the generator models. This value affects how much a generator is
loaded (i.e., requested electric power output) and can also impact the operation of an electric
storage unit (e.g., LoadCenter:Storage:Simple) if one is connected to the associated load
9/29/14

1697

Input-Output Reference

Group -- Electric Load Center-Generator Specifications

distribution center (ref. ElectricLoadCenter:Distribution). Refer to Electrical Storage in the

EnergyPlus Engineering Reference for more details regarding this input field and its
relationship with electric storage.
Field: Generator <x> Availability Schedule Name
This alpha field is used as an identifying field for the generator availability schedule. If not
blank, this field must contain the name of a schedule defined elsewhere in the input file. A
schedule value of <=0.0 indicates the generator is not available, while a schedule value > 0.0
indicates that the generator is available to operate. If this field is blank, the schedule has
values of 1 for all time periods.
Field: Generator <x> Rated Thermal to Electrical Power Ratio
This numeric field contains the ratio of the rated thermal output to the rated electric output. It
is only needed and used if the operation scheme is set to FollowThermal or
FollowThermalLimitElectrical. This nominal ratio is only used for control and dispatch
decisions. This value should be generally consistent with the more detailed performance
input for the individual generator component models but it is not used in those component
models.
An example IDF showing how this object is used is provided below:
ElectricLoadCenter:Generators,
Backup Generators,
!- Name
Cat Diesel,
!- Generator 1 Name
Generator:InternalCombustionEngine, !- Generator 1 Object Type
50000,
!- Generator 1 Rated Electric Power Output
ON PEAK GENERATOR SCHEDULE, !- Generator 1 Availability Schedule Name
,
!- Generator 1 Rated Thermal to Electrical Power Ratio
Solar Turbine,
!- Generator 2 Name
Generator:CombustionTurbine, !- Generator 2 Object Type
30000,
!- Generator 2 Rated Electric Power Output
OFF PEAK GENERATOR SCHEDULE, !- Generator 2 Availability Schedule Name
,
!- Generator 2 Rated Thermal to Electrical Power Ratio
Capstone C65,
!- Generator 3 Name
Generator:Microturbine, !- Generator 3 Object Type
65000,
!- Generator 3 Rated Electric Power Output
MID PEAK GENERATOR SCHEDULE, !- Generator 3 Availability Schedule Name
;
!- Generator 3 Rated Thermal to Electrical Power Ratio

ElectricLoadCenter:Generators Outputs
A single output variable is available for each generator specified via this object as described
below:
HVAC,Average,Generator Requested Electric Power [W]

Generator Requested Electric Power [W]

This output variable represents the average electric power supply in Watts that is being
requested from a specific generator for the time step being reported. In some instances the
output value may be the Rated Electric Power Output specified for the generator in the
ElectricLoadCenter:Generators object. If the generator is not available for a simulation time
step (as indicated by its availability schedule), then the power supply request will be zero.
The power supply request may be less than the rated electric power output if the overall
electric power reduction target has already been met, partially or completely, by electric
power produced by other generators. If an EnergyPlus Energy Management System is used
to specify an electric power supply request for this generator, then that EMS request will be
reflected in this output variable.
ElectricLoadCenter:Inverter:Simple
This input object is used to model conversion from Direct Current (DC) to Alternating Current
(AC) in an electric load center that contains photovoltaic modules. Such a load center has an
9/29/14

1698

Input-Output Reference

Group -- Electric Load Center-Generator Specifications

array of photovoltaic modules that feed an inverter DC power and the inverter produces AC
power. This input object is for the simplest inverter model and uses a fixed efficiency. There
are two other types of inverters with more complex models described below.
Field: Name
This field contains a unique name for the inverter. The name entered must also be unique
across all other types of inverters that may also be in the input file.
Field: Availability Schedule Name
This field contains the name of a schedule that describes when the inverter is available. If
the inverter is scheduled to not be available, by scheduling a value of 0, then it cannot
produce AC power and will not consume ancillary power during standby. Any non-zero
schedule value means the inverter is available to produce AC power and consume ancillary
power during standby. If the Inverter is scheduled to be unavailable but it is being supplied
with DC power anyway, then the energy is dissipated as heat. If this field is blank, the
schedule has values of 1 for all time periods.
Field: Zone Name
This field contains the name of the thermal zone where the inverter is located. Entering a
valid name of zone here will direct EnergyPlus to include the inverters losses as heat gains
to the named thermal zone. If the inverter is not within a thermal zone, then this field can be
left blank (and the thermal energy associated with inverter losses is removed from the
building model).
Field: Radiative Fraction
This field contains the fraction of inverter thermal losses that enter the zone as long-wave
thermal radiation. This should be a factor between 0.0 and 1.0. The balance of the losses is
convective. This field is not used if the previous field for zone name is left blank.
Field: Inverter Efficiency
This field contains the value for inverter efficiency. In the simple model, efficiency is a
constant. This is the so-called 1-term model. Input data for different types of inverters is
available at http://www.gosolarcalifornia.org/equipment/inverter_tests/summaries where the
CEC Efficiency would be the value to enter here.
An example IDF showing how this object is used is provided below:
ElectricLoadCenter:Inverter:Simple,
Simple Ideal Inverter,
!- Name
Always On,
!- Availability Schedule Name
,
!- Zone Name
0.0,
!- Radiative Fraction
1.0;
!- Inverter Efficiency

ElectricLoadCenter:Inverter:FunctionOfPower
This input object is used to model conversion from Direct Current (DC) to Alternating Current
(AC) in an electric load center that contains photovoltaic modules. Such a load center has an
array of photovoltaic modules that feed an inverter DC power and the inverter produces AC
power. This input object is for an inverter model where efficiency is a function of normalized
power.
Field: Name
This field contains a unique name for the inverter. The name entered must also be unique
across all other types of inverters that may also be in the input file.

9/29/14

1699

Input-Output Reference

Group -- Electric Load Center-Generator Specifications

Field: Availability Schedule Name

This field contains the name of a schedule that describes when the inverter is available. If
the inverter is scheduled to not be available, by scheduling a value of 0, then it cannot
produce AC power, nor contribute heat gains to the zone, and will not consume ancillary
power during standby. Any non-zero schedule value means the inverter is available to
produce AC power, contribute heat gains to the zone and consume ancillary power during
standby. If this field is blank, the schedule has values of 1 for all time periods.
Field: Zone Name
This field contains the name of the thermal zone where the inverter is located. Entering a
valid name of zone here will direct EnergyPlus to include the inverters losses as heat gains
to the named thermal zone. If the inverter is not within a thermal zone, then this field can be
left blank (and the thermal energy associated with inverter losses is removed from the
building model).
Field: Radiative Fraction
This field contains the fraction of inverter thermal losses that enter the zone as long-wave
thermal radiation. This should be a factor between 0.0 and 1.0. The balance of the losses is
convective. This field is not used if the previous field for zone name is left blank.
Field: Efficiency Function of Power Curve Name
This field contains the name of curve representing the relationship between DC power input
into the inverter and the efficiency with which that power is converted to AC. The curve can
be either a Curve:Linear, Curve:Quadratic, or Curve:Cubic. The curves x value is DC
power input normalized by the following field. The result of the curve should be power
conversion efficiency expressed as a fraction between 0.0 and 1.0.
Field: Rated Maximum Continuous Input Power
This field contains the rated power input in watts. This is value used to normalize input power
for use with the curve named in the previous field. This is DC power from the PV arrays
going into the inverter.
Field: Minimum Efficiency
This field contains a minimum bound on the inverter efficiency. This value will be used as a
limit on the curves result.
Field: Maximum Efficiency
This field contains a maximum bound on the inverter efficiency. This value will be used as a
limit on the curves result.
Field: Minimum Power Output
This field contains a lower limit on the AC power produced by the inverter. If the resulting
power output would be below this level, then the inverter is assumed to not produce any
power and is in stand by mode. All DC power input is lost (unless it is going into storage).
Field: Maximum Power
This field contains an upper limit on the AC power produced by the inverter. If the resulting
power output would be above this level, then the power produced is capped at this level with
the rest of input power converted to losses (unless it is going into storage).
Field: Ancillary Power Consumed In Standby
This field contains the ancillary power in watts used by the inverter when not producing AC
power. This is AC electricity consumed in standby mode. Standby mode occurs when the
inverter is scheduled to be available but the incoming DC power is too low.

9/29/14

1700

Input-Output Reference

Group -- Electric Load Center-Generator Specifications

An example IDF showing how this object is used is provided below:

ElectricLoadCenter:Inverter:FunctionOfPower,
Curve Inverter,
!- Name
ALWAYS_ON,
!- Availability Schedule Name
,
!- Zone Name
0.3,
!- Radiative Fraction
Inverter Curve,
!- Efficiency Function of Power Curve Name
15000,
!- Rated Maximum Continuous Input Power {W}
0.0,
!- Minimum Efficiency
1.0,
!- Maximum Efficiency
200,
!- Minimum Power Output {W}
20000,
!- Maximum Power Output {W}
0.0;
!- Ancillary Power Consumed In Standby {W}

ElectricLoadCenter:Inverter:LookUpTable
This input object is used to model conversion from Direct Current (DC) to Alternating Current
(AC) in an electric load center that contains photovoltaic modules. Such a load center has an
array of photovoltaic modules that feed an inverter DC power and the inverter produces AC
power. This input object is for an inverter model where efficiency is interpolated using a look
up table.
This object was designed for use with data contained in the Inverter Performance Test
Summaries available at http://www.gosolarcalifornia.org/equipment/inverter_tests/summaries.
All of the data needed for this object can be found there by make and model of inverter. The
core of the data set is a 3x6 matrix of efficiency at different voltage and power levels. These
form the look up table used in the model. Note that EnergyPlus PV models currently model
only power and not the voltage and current situation. Therefore, only the nominal voltage
data are used. This is the middle row of data in the Go Solar summaries.
Field: Name
This field contains a unique name for the inverter. The name entered must also be unique
across all other types of inverters that may also be in the input file.
Field: Availability Schedule Name
This field contains the name of a schedule that describes when the inverter is available. If
the inverter is scheduled to not be available, by setting a value of 0, then it cannot produce
AC power, nor contribute heat gains to the zone, and will not consume ancillary power during
standby. Any non-zero schedule value means the inverter is available to produce AC power,
contribute heat gains to the zone and consume ancillary power during standby. If this field is
blank, the schedule has values of 1 for all time periods.
Field: Zone Name
This field contains the name of the thermal zone where the inverter is located. Entering a
valid name of zone here will direct EnergyPlus to include the inverters losses as heat gains
to the named thermal zone. If the inverter is not within a thermal zone, then this field can be
left blank (and the thermal energy associated with inverter losses is removed from the
building model).
Field: Radiative Fraction
This field contains the fraction of inverter thermal losses that enter the zone as long-wave
thermal radiation. This should be a factor between 0.0 and 1.0. The balance of the losses is
convective. This field is not used if the previous field for zone name is left blank.
Field: Rated Maximum Continuous Output Power
This field contains the rated maximum continuous output power in watts.

9/29/14

1701

Input-Output Reference

Group -- Electric Load Center-Generator Specifications

Field: Night Tare Loss Power

This field contains the night tare loss in watts.
consumed during standby.

This is modeled as ancillary power

Field: Nominal Voltage Input

This field contains the nominal DC input voltage in volts. This is Vnom in the Go Solar test
summaries.
Field: Efficiency at 10% Power and Nominal Voltage
This field contains the fractional efficiency at nominal voltage and 10% power.
Field: Efficiency at 20% Power and Nominal Voltage
This field contains the fractional efficiency at nominal voltage and 20% power.
Field: Efficiency at 30% Power and Nominal Voltage
This field contains the fractional efficiency at nominal voltage and 30% power.
Field: Efficiency at 50% Power and Nominal Voltage
This field contains the fractional efficiency at nominal voltage and 50% power.
Field: Efficiency at 75% Power and Nominal Voltage
This field contains the fractional efficiency at nominal voltage and 75% power.
Field: Efficiency at 100% Power and Nominal Voltage
This field contains the fractional efficiency at nominal voltage and 100% power.
An example IDF showing how this object is used is provided below:
ElectricLoadCenter:Inverter:LookUpTable,
PV Inverter,
!- Name
ALWAYS_ON,
!- Availability Schedule Name
,
!- Zone Name
0.25,
!- Radiative Fraction
14000,
!- Rated Maximum Continuous Output Power {W}
200.0,
!- Night Tare Loss Power {W}
368,
!- Nominal Voltage Input {V}
0.839,
!- Efficiency at 10% Power and Nominal Voltage
0.897,
!- Efficiency at 20% Power and Nominal Voltage
0.916,
!- Efficiency at 30% Power and Nominal Voltage
0.931,
!- Efficiency at 50% Power and Nominal Voltage
0.934,
!- Efficiency at 75% Power and Nominal Voltage
0.930;
!- Efficiency at 100% Power and Nominal Voltage

Electric Load Center Inverter Outputs

Each inverter can report the following seven output variables.
HVAC,Average,Inverter DC to AC Efficiency [ ]
HVAC,Average,Inverter DC Input Elecric Power [W]
HVAC,Sum,Inverter DC Input Electric Energy [J]
HVAC,Average,Inverter AC Output Electric Power [W]
HVAC,Sum,Inverter AC Output Electric Energy [J]
HVAC,Average,Inverter Thermal Loss Rate [W]
HVAC,Sum,Inverter Thermal Loss Energy [J]
HVAC,Sum,Inverter Ancillary AC Electric Energy [J]
HVAC,Average,Inverter Ancillary AC Electric Power [W]

Inverter DC to AC Efficiency [ ]
This is the efficiency with which DC power is converted to AC power by the inverter.

9/29/14

1702

Input-Output Reference

Group -- Electric Load Center-Generator Specifications

Inverter DC Input Elecric Power [W]

Inverter DC Input Electric Energy [J]
These outputs are total electricity power or energy fed into the inverter. This is Direct Current
from photovoltaics (or DC-based electrical storage) going into the inverter.
Inverter AC Output Electric Power [W]
Inverter AC Output Electric Energy [J]
These outputs are the total electricity power or energy produced by the inverter. This is
Alternating Current going out of the inverter.
Inverter Thermal Loss Rate [W]
Inverter Thermal Loss Energy [J]
These outputs are the thermal power or energy losses in the inverter that stem from
converting from DC to AC.
Inverter Ancillary AC Electric Power [W]
Inverter Ancillary AC Electric Energy [J]
These outputs are the Alternating Current electricity consumed by the inverter. These are
ancillary, or night tare loss, power uses by the inverter and modeled as if powered by the
buildings grid connection. These ancillary power draws generally occur when the inverter is
not generating power but waiting in a standby mode ready to begin generating power.
ElectricLoadCenter:Storage:Simple
This input object is used to model storage of electricity in an electric load center. This is a
simple model that does not attempt to represent any of the characteristics of a real storage
device such as a battery. The type of power, AC or DC, depends on the configuration
chosen as the Electrical Buss Type in the ElectricLoadCenter:Distribution object.
Field: Name
This field contains a unique name for the electric storage device.
Field: Availability Schedule Name
This field contains the name of a schedule that describes when the storage device is
available. If storage is not available, by scheduling a value of 0, then no electrical energy can
be stored or drawn from the device. Any non-zero schedule value means the devices is
available. If this field is blank, the schedule has values of 1 for all time periods.
Field: Zone Name
This field contains the name of the thermal zone where the storage device is located.
Entering a valid name of a zone here will direct EnergyPlus to include the storage losses as
heat gains to the name thermal zone. If the storage is not within a therma zone, then this
field can be left blank.
Field: Radiative Fraction for Zone Heat Gains
This field contains the fraction of storage losses that enter the zone as long-wave thermal
radiation. This should be a factor between 0.0 and 1.0. The balance of the losses are
convective. This field is not used if the previous field for zone name is left blank.
Field: Nominal Energetic Efficiency for Charging
This field contains the charging efficiency. This is the energetic efficiency of storing electrical
energy in the storage device. A value of 1.0 means the device does not lose any energy
when charging.
9/29/14

1703

Input-Output Reference

Group -- Electric Load Center-Generator Specifications

Field: Nominal Discharging Energetic Efficiency

This field contains the discharging efficiency. This is the energetic efficiency of drawing
electrical energy from the storage device. A value of 1.0 means the device does not lose any
energy when drawing power.
Field: Maximum Storage Capacity
This field describes the maximum amount of energy that can be stored in the device in
Joules. Once the storage device is full, no additional energy can be stored in it.
Field: Maximum Power for Discharging
This field describes the maximum rate at which electrical power can be discharged from the
storage device in watts.
Field: Maximum Power for Charging
This field describes the maximum rate at which electrical power can be stored in the device in
watts.
Field: Initial State of Charge
This field describes the value for the initial state of charge in Joules. This is used to model
the storage device as having some amount of stored energy at the beginning of the
simulation period.
An example IDF showing how this object is used is provided below:
ElectricLoadCenter:Storage:Simple,
Battery,
!- Name
ALWAYS_ON,
!- Availability Schedule Name
,
!- Zone Name
0.0,
!- Radiative Fraction for Zone Heat Gains
0.7,
!- Nominal Energetic Efficiency for Charging
0.7,
!- Nominal Discharging Energetic Efficiency
1.0E11,
!- Maximum Storage Capacity {J}
50000,
!- Maximum Power for Discharging {W}
25000,
!- Maximum Power for Charging {W}
1.0E10;
!- Initial State of Charge {J}

ElectricLoadCenter:Storage:Simple Outputs
Each electrical storage device can report the following seven output variables.
HVAC,Average,Electric Storage Charge State [J]
HVAC,Average,Electric Storage Charge Power [W]
HVAC,Sum,Electric Storage Charge Energy [J]
HVAC,Average,Electric Storage Discharge Power [W]
HVAC,Sum,Electric Storage Discharge Energy [J]
HVAC,Average,Electric Storage Thermal Loss Rate [W]
HVAC,Sum,Electric Storage Thermal Loss Energy [J]
HVAC,Sum,Electric Storage Production Decrement Energy [J]

Electric Storage Charge State [J]

This output is the state of charge of the storage device. State of charge is the amount of
electrical energy stored in the device at a point of time. The amount of energy stored in
tracked in Joules.
Electric Storage Charge Power [W]
Electric Storage Charge Energy [J]
These outputs are total electricity power or energy fed into the storage device. This is the
rate or amount of charging.

9/29/14

1704

Input-Output Reference

Group -- Electric Load Center-Generator Specifications

Electric Storage Production Decrement Energy [J]

This output is the total electricity energy decremented from electricity production because it
has fed into the storage device. This output has the opposite sign of Electric Storage
Charge Energy but is otherwise similar. This decrement output variable is also a meter
associated with the resource type ElectricityProduced that reduces the metered electricity
production to account for power that went into storage after production.
Electric Storage Discharge Power [W]
Electric Storage Discharge Energy [J]
These outputs are total electricity power or energy drawn from the storage device. This is the
rate or amount of discharging. The energy from storage output variable is also a meter
associated with the resource type ElectricityProduced that increases the metered electricity
production to account for power that has come back out of storage.
Electric Storage Thermal Loss Rate [W]
Electric Storage Thermal Loss Energy [J]
These outputs are the thermal power or energy losses from both charging and drawing
electrical power in or out of the storage device. These losses are the result of inefficiencies
in charging and drawing.
ElectricLoadCenter:Storage: Battery
This object uses the kinetic battery model (KiBaM) to simulate rechargeable battery banks in
an electrical load center. The battery bank is a collection of one or more individual battery
modules. Given the surplus or deficit power from the electrical system and the state of charge
from the previous time step, this object can model the voltage, current, and energy losses
with charging and discharging during each time step. The cumulative battery damage can be
also modeled and reported at the end of each simulation run.
This object allows the simulation of both lead-acid and Nickel Cadmium batteries. With input
parameters derived from specific battery tests, the object is expected to support other battery
types such as Lithium-ion batteries.
The kinetic battery model assumes that part of the batterys energy storage capacity is
immediately available in discharging or charging while the rest is chemically bound. As a
function of constant current, the battery capacity is related to three parameters: the maximum
capacity at infinitesimal current, the capacity ratio of available charges, and the conversion
ratio between available charges and bound charges. These parameters are usually obtained
via curve fitting based on battery data sheets or test data.
Each individual battery module is modeled as a voltage source in series with an electrical
resistance. KiBaM assumes that the internal resistance is constant and the open circuit
voltage varies with the electric current, the state of charge and the operation mode (charging
or discharging). For an individual battery module, the open circuit voltage at any time is
correlated to the voltage at fully charged/discharged state and three other regression
coefficients. These regression coefficients are usually obtained via curve fitting based on
battery test data.
The object offers user the option to perform battery life calculation. If battery life is modeled,
the user needs to provide a group of coefficients for the correlation between the number of
cycles for battery failure and the corresponding cycle range. More detailed information can be
found from the Engineering Reference.
Field: Name
This alpha field contains the identifying name for the battery bank.

9/29/14

1705

Input-Output Reference

Group -- Electric Load Center-Generator Specifications

Field: Availability Schedule Name

This alpha field contains the schedule name (ref. Schedule objects) that describes when the
battery is available. A schedule value greater than 0 (usually 1 is used) indicates that
electrical energy can be stored or drawn from the battery. A value less than or equal to 0
(usually 0 is used) denotes that the battery is not available. If this field is blank, the schedule
has values of 1 for all time periods.
Field: Zone Name
This field contains the name of the thermal zone where the battery is located. Entering a valid
name of zone here will direct EnergyPlus to include the energy storage losses as heat gains
to the named thermal zone. If the battery is not within a thermal zone, this field can be left
blank and the thermal energy associated with storage losses is removed from the building
model.
Field: Radiative Fraction
This field contains the fraction of storage losses that enter the zone as long-wave thermal
radiation. This numeric filed should have a value between 0.0 and 1.0. The balance of the
losses is convective. This field is not used if the previous field for zone name is left blank.
Field: Number of Battery Modules in Parallel
This field defines the number of modules connected in parallel in the battery bank.
Field: Number of Battery Modules in Series
This field defines the number of modules connected in series in the battery bank. The total
number of modules in a battery bank is equal to the number of modules in parallel times the
number of modules in series.
Field: Maximum Module Capacity
This field indicates the maximum capacity of one battery module. It is evaluated as the total
Amp-hours available when a full battery is discharged at infinitesimal current. This capacity is
for an individual battery module, not for the whole battery bank. The maximum capacity can
be found from manufactures data or derived from test data by curve fitting.
Field: Initial Fractional State of Charge
This field describes the initial state of charge in terms of the fraction of maximum capacity as
defined in the previous field.
Field: Fraction of Available Charge Capacity
The kinetic battery model assumes that battery is a two-tank electrical energy storage device:
an available tank and a bound tank. The available tank can be immediately charged or
discharged, while the bound tank can only be charged or discharged via the available tank.
This field specifies the fraction of total charge in the battery that is part of the available tank.
The ratio of available charge capacity to total capacity is a parameter usually derived from
test data by curve fitting.
Field: Change Rate from Bound Charge to Available Charge
This field specifies the rate at which the charge flows between the available tank and the
bound tank. It is a parameter used to calculate the conversion between available charge and
chemically bound charge when charging and discharging the battery. This parameter is
usually derived from test data by curve fitting.
Field: Fully Charged Module Open Circuit Voltage
This field indicates the open circuit voltage for a fully charged battery module. It can be found
from manufactures data or battery tests.

9/29/14

1706

Input-Output Reference

Group -- Electric Load Center-Generator Specifications

Field: Fully Discharged Module Open Circuit Voltage

This field indicates the open circuit voltage for a fully discharged battery module. It can be
found from manufactures data or battery tests.
Field: Voltage Change Curve Name for Charging
This field specifies the name of a rectangular hyperbola type 2 performance curve (ref:
Curve:RectangularHyperbola2 in Performance Curves) that determines the change of open
circuit voltage ( E ) as a function of the battery state of charge in charging. The change of
open circuit voltage is relative to a fully discharged battery.
The curve has the following form:

(C1 * X ) / (C2

X ) C3 * X

where X is the battery charge divided by the maximum capacity at a given current. More
details can be found from the Engineering Reference.
Field: Voltage Change Curve Name for Discharging
This field specifies the name of a rectangular hyperbola type 2 performance curve (ref:
Curve:RectangularHyperbola2 in Performance Curves) that determines the change of open
circuit voltage ( E ) as a function of the battery state of charge in discharging. The change of
open circuit voltage is relative to a fully charged battery.
The curve has the following form:

(C1 * X ) / (C2

X ) C3 * X

where X is the removed charge divided by the maximum capacity at a given current. More
details can be found from the Engineering Reference.
Field: Module Internal Electrical Resistance
This field specifies the battery internal resistance in ohms. In theory, the electrical resistance
within the battery varies with the state of charge and depends on whether it is in charging or
discharging. In the kinetic battery model, the internal resistance is assumed as constant and
the terminal voltage varies with current and state of charge. The internal resistance may be
obtained from the battery manufacture or battery test data. Note that the field is for an
individual module, not for the whole battery bank.
Field: Maximum Module Discharging Current
This field indicates the maximum current at which the battery can be discharged
continuously. The limit on discharge current is usually defined by the battery manufacture to
avoid battery damage. The limit is for an individual battery module.
Field: Module Cut-off Voltage
This field specifies the minimum allowable voltage, below which the battery is generally
regarded as empty. The cut-off voltage is usually defined by the battery manufacture and it is
for an individual battery module.
Field: Module Charge Rate Limit
This field specifies the limit on charging current relative to the remaining charge until the
battery is full. This limit reflects the common practice that the charge rate is reduced as the
battery gets more charged.

9/29/14

1707

Input-Output Reference

Group -- Electric Load Center-Generator Specifications

Field: Battery Life Calculation

This field indicates whether the battery life model is activated in the simulation. If the battery
life model is activated, the following five inputs on curve coefficients are required; otherwise,
they are not used.
Field: Number of Cycle Bins
This field specifies the number of equally ranged cycle bins in battery life simulation. If 10
bins are used, the cycle ranges will include 10%, 20%, , 100%.
Field: Battery Cycle Life Curve Name
This field specifies the name of a double exponential decay curve (ref:
Curve:DoubleExponentialDecay in Performance Curves) that correlates the cycles of battery
failure (CF) and fractional depth of discharge (R). The curve is:

CF

C1 C2eC3R C4eC5R

An example input of the ElectricLoadCenter:Storage: Battery input is:

ElectricLoadCenter:Storage:Battery,
Lead Acid Battery A, !-Name
Always On,
!- Availability Schedule Name
,
!- Zone Name
,
!- Radiative Fraction
1,
!- Number of Battery Modules in Parallel
1,
!- Number of Battery Modules in Series
86.1,
!- Maximum Module Capacity {Ah}
1.0,
!- Initial Fractional State of Charge
0.3747,
!- Fraction of Available Charge Capacity
0.5874,
!- Change Rate from Bound Charge to Available Charge {hr-1}
12.60,
!- Fully Charged Module Open Circuit Voltage {V}
12.37,
!- Fully Discharged Module Open Circuit Voltage {V}
BatteryChargeCurve,
!- Voltage Change Curve Name for Charging
BatteryDischargeCurve,!- Voltage Change Curve Name for Discharging
0.0538,
!- Module Internal Electrical Resistance {Ohm}
100,
!- Maximum Module Discharging Current {A}
10.2,
!- Module Cut-off Voltage {V}
1,
!- Module Charge Rate Limit {1/hr}
Yes,
!- Battery Life Calculation
10,
!- Number of Cycle Bins
BatteryCycleCurve;
!- Battery Cycle Life Curve Name

Curve:RectangularHyperbola2,
BatteryChargeCurve,
!- Name
-0.2765,
!- Coefficient1 C1
-93.27,
!- Coefficient2 C2
0.0068,
!- Coefficient3 C3
0,
!- Minimum Value of x
1.0,
!- Maximum Value of x
-100,
!- Minimum Curve Output
100;
!- Maximum Curve Output

9/29/14

1708

Input-Output Reference
Curve:RectangularHyperbola2,
BatteryDischargeCurve,
!0.0899,
!-98.24,
!-0.0082,
!0,
!1.0,
!-100,
!100;
!-

Group -- Electric Load Center-Generator Specifications

Name
Coefficient1 C1
Coefficient2 C2
Coefficient3 C3
Minimum Value of x
Maximum Value of x
Minimum Curve Output
Maximum Curve Output

Curve:DoubleExponentialDecay,
BatteryCycleCurve,
!- Name
1380,
!- Coefficient1 C1
6834,
!- Coefficient2 C2
-8.75,
!- Coefficient3 C3
6747,
!- Coefficient4 C4
-6.22,
!- Coefficient5 C5
0,
!- Minimum Value of x
1.0;
!- Maximum Value of x

ElectricLoadCenter: Storage:Battery Outputs

HVAC,Average, Electric Storage Operating Mode Index []
HVAC,Average,Electric Storage Charge State[Ah]
HVAC,Average, Electric Storage Charge Fraction []
HVAC,Average,Electric Storage Charge Power[W]
HVAC,Sum,Electric Storage Charge Energy [J]
HVAC,Average,Electric Storage Discharge Power[W]
HVAC,Sum,Electric Storage Discharge Energy [J]
HVAC,Average,Electric Storage Total Current[A]
HVAC,Average, Electric Storage Total Voltage [V]
HVAC,Average,Electric Storage Thermal Loss Rate [W]
HVAC,Average, Electric Storage Degradation Fraction []
HVAC,Sum,Electric Storage Production Decrement Energy [J]
HVAC,Sum,Electric Storage Thermal Loss Energy [J]

Electric Storage Operating Mode Index []

This output reports the battery mode of operation: 0 for idle; 1 for discharging; 2 for charging.
It is expected that more operation modes would be added when a smart and active power
dispatch controller is used in future.
Electric Storage Charge State [Ah]
The state of charge is expressed as the amount of charge stored in the battery at a point of
time. It has the same unit as the maximum capacity. This value is given for an individual
battery module
Electric Storage Charge Fraction []
This output is the ratio between the electrical storage state of charge and the maximum
capacity.
Electric Storage Charge Power [W]
Electric Storage Charge Energy [J]
These outputs are total electricity power or energy fed into the battery. This is the rate of
amount of charging.

9/29/14

1709

Input-Output Reference

Group -- Electric Load Center-Generator Specifications

Electric Storage Production Decrement Energy [J]

This output is the total electricity energy decremented from electricity production because it
has fed into the battery. This output has the opposite sign of Electric Storage Charge
Energy but is otherwise similar. This decrement output variable is also a meter associated
with the resource type ElectricityProduced that reduces the metered electricity production to
account for power that went into storage after production.
Electric Storage Discharge Power [W]
Electric Storage Discharge Energy [J]
These outputs are total electricity power or energy drawn from the battery. This is the rate or
amount of discharging. The energy from storage output variable is also a meter associated
with the resource type ElectricityProduced that increases the metered electricity production
to account for power that has come back out of storage.
Electric Storage Total Current [A]
This output is the current to or from the battery bank depending on whether the battery is in
the state of charging or discharging. The value is positive for discharging and negative for
charging.
Electric Storage Total Voltage [V]
This output is the total terminal voltage of the battery bank.
Electric Storage Thermal Loss Rate [W]
Electric Storage Thermal Loss Energy [J]
These outputs are the thermal power or energy losses from both charging and drawing
electrical power in or out of the storage device. These losses are due to the battery internal
resistance in charging and discharging.
Electric Storage Degradation Fraction []
This output reports the fractional battery life used up at a point of time. For example, a value
of 0.4 at the end of one year simulation means that the 40% of the battery life is used up, so
the battery needs to be replaced every two and a half years.
Generator:InternalCombustionEngine
The Internal Combustion (IC) Engine generator uses a modified Otto cycle. This generator
model uses the electrical load and rated engine generator size to compute part-load ratios
(PLR). Fuel energy input and recoverable jacket and lube oil heat are then computed. Finally,
the recoverable exhaust heat is calculated.
Manufacturer's curves or tables must be obtained for IC engine generators to derive the
equipment performance parameters that are specified in the quadratic curve fits. Note that
simple transformation of the form of the manufacturer's curves may be required. Electric
energy output/fuel energy input is related to the part-load ratio (i.e., electric/load generator
capacity) with a polynomial. Recoverable jacket heat/fuel energy equipment, recoverable lube
oil heat/fuel energy input equipment performance, total exhaust heat/fuel energy input
equipment, exhaust gas temperature/fuel energy input equipment performance parameters
are all specified with a quadratic curve fit.
When the heat recovery curve fits = 0.0, this means that no heat recovery is done on the IC
engine generator exhaust gas; and no heat recovery is specified.
Field: Name
This alpha field contains the identifying name for the IC engine generator.

9/29/14

1710

Input-Output Reference

Group -- Electric Load Center-Generator Specifications

Field: Rated Power Output

The design nominal capacity of the generator in Watts [W].
Field: Electric Circuit Node Name
This named node contains where the electric power is put in the program simulation for use
by the electric equipment in the Load Center.
Field: Minimum Part Load Ratio
This field contains the minimum allowed operating fraction of full load. The input value must
be >=0.0 and <=1.0.
Field: Maximum Part Load Ratio
This field contains the maximum allowed operating fraction of full load. The input value must
be >0.0 and <=1.0.
Field: Optimum Part Load Ratio
This alpha field contains the optimal operating fraction of full load. This is the part load ratio
that gives the optimal production of electric power with the least amount of fuel usage.
Field: Shaft Power Curve Name
This alpha field contains the name of the shaft power curve. The curve itself is specified
separately using a curve object (ref: Curve:QuadLinear). The Shaft Power Curve is a
quadratic equation that determines the electric output versus the fuel used. Used to calculate
the electric energy output divided by the fuel energy consumption as a function of part-load
ratio. The defining equation is:

ShaftPowerToFuelRatio C1 C2 RL C3 RL2
where RL is the Ratio of Load to Rated Power Output.
Field: Jacket Heat Recovery Curve Name
This alpha field contains the name of the Recovery Jacket Heat curve. The curve itself is
specified separately using a curve object (ref: Curve:QuadLinear). The Jacket Heat Recovery
Curve is a quadratic equation that determines the ratio of recovery jacket heat to fuel energy.
Used to calculate the recoverable jacket heat as a function of part-load ratio.
The defining equation is:

RecoveryJacketHeatToFuelRatio C1 C2 RL C3 RL2
where RL is the Ratio of Load to Rated Power Output.
Field: Lube Heat Recovery Curve Name
This alpha field contains the name of the Recovery Lube Heat curve. The curve itself is
specified separately using a curve object (ref Curve:QuadLinear). The Lube Heat Recovery
Curve is a quadratic equation that determines the ratio of recovery lube heat to fuel energy.
Used to calculate the recoverable lube oil heat as a function of part-load ratio. The defining
equation is:

RecoveryLubeHeatToFuelRatio C1 C2 RL C3 RL2
where RL is the Ratio of Load to Rated Power Output.

9/29/14

1711

Input-Output Reference

Group -- Electric Load Center-Generator Specifications

Field: Total Exhaust Energy Curve Name

This alpha field contains the name of the Total Exhaust Energy curve. The curve itself is
specified separately using a curve object (ref Curve:QuadLinear object). The Total Exhaust
Energy Curve is a quadratic equation that determines the ratio of total exhaust energy to fuel
energy. Used to calculate the total exhaust heat as a function of part-load ratio. The defining
equation is:

TotalExhaustToFuelRatio C1 C2 RL C3 RL2
where RL is the Ratio of Load to Rated Power Output.
Field: Exhaust Temperature Curve Name
This alpha field contains the name of the Exhaust Temperature curve. The curve itself is
specified separately using a curve object (ref Curve:QuadLinear object). The Exhaust
Temperature Curve is a quadratic equation that determines the absolute exhaust
temperature. Used to determine the exhaust gas temperature as a function of part-load ratio.
The defining equation is:

AbsoluteExhaustTemperature C1 C2 RL C3 RL2
where RL is the Ratio of Load to Rated Power Output.
U-Factor Times Area (UA) Curve
The UA curve applies to the exhaust gas heat exchanger. The curve is an equation that
determines the overall heat transfer coefficient for the exhaust gases with the stack. The heat
transfer coefficient ultimately helps determine the exhaust stack temperature. The defining
equation is:

UAToCapacityRatio C1GeneratorRatedPowerOutput C2
The following two fields contain the coefficients for the equation.
Field: Coefficient 1 of U-Factor Times Area Curve
This numeric field contains the first coefficient for the overall heat transfer coefficient curve.
Field: Coefficient 2 of U-Factor Times Area Curve
This numeric field contains the second (exponential) coefficient for the overall heat transfer
coefficient curve.
Field: Maximum Exhaust Flow per Unit of Power Output
Maximum exhaust flow per unit capacity for the generator. The parameter sets an upper limit
on exhaust gas flow and exhaust gas heat recovery for the generator. Units: kg/sec per kW
capacity
Field: Design Minimum Exhaust Temperature
This is the design engine stack saturated steam temperature in degrees C.
Field: Fuel Higher Heating Value
This numeric field contains the higher heating value of the fuel used in kJ/kg.
Field: Design Heat Recovery Water Flow Rate
Design water volumetric flow rate through heat recovery loop in m 3/sec.
9/29/14

1712

Input-Output Reference

Group -- Electric Load Center-Generator Specifications

Field: Heat Recovery Inlet Node Name

This alpha field contains the identifying name for the generators heat recovery side inlet
node.
Field: Heat Recovery Outlet Node Name
This alpha field contains the identifying name for the generators heat recovery side outlet
node.
Field: Fuel Type
This alpha field determines the type of fuel that the generator uses. The default is Diesel.
Valid values are: NaturalGas, PropaneGas, Diesel, Gasoline, FuelOil#1, FuelOil#2,
OtherFuel1, and OtherFuel2.
Field: Heat Recovery Maximum Temperature
This field sets the maximum temperature that this piece of equipment can produce for heat
recovery. The idea behind this field is that the current models do not take temperatures into
account for availability and they just pass Q's around the loop without a temperature limit.
This temperature limit puts an upper bound on the recovered heat and limits the max
temperatures leaving the component.
As temperatures in the loop approach the maximum temperature, the temperature difference
between the entering water and the surfaces in the piece of equipment becomes smaller. For
the given heat recovery flow rate and that temperature difference the amount of heat
recovered will be reduced, and eventually there will be no heat recovered when the entering
water temperature is equal to the maximum temperature specified by the user in this field.
The reduced amount of heat recovered will diminish if the temperature of the loop approach
is the maximum temperature, and this will show up in the reporting. This allows the user to
set the availability or the quality of the heat recovered for usage in other parts of the system
or to heat domestic hot water supply.
The temperature is specified in degrees C.
An IDF example showing how it is used is provided below:

9/29/14

1713

Input-Output Reference

Group -- Electric Load Center-Generator Specifications

Generator:InternalCombustionEngine,
Cat Diesel,
!- Name
50000,
!- Rated Power Output {W}
Generator Diesel Electric Node, !- Electric Circuit Node Name
0.15,
!- Minimum Part Load Ratio
1.0,
!- Maximum Part Load Ratio
0.65,
!- Optimum Part Load Ratio
BG Shaft Power Curve,
!- Shaft Power Curve Name
BG Recovery Jacket Heat Curve, !- Jacket Heat Recovery Curve Name
BG Recovery Lube Heat Curve, !- Lube Heat Recovery Curve Name
BG Total Exhaust Energy Curve, !- Total Exhaust Energy Curve Name
BG Exhaust Temperature Curve, !- Exhaust Temperature Curve Name
0.00952329,
!- Coefficient 1 of U-Factor Times Area Curve
0.9,
!- Coefficient 2 of U-Factor Times Area Curve
0.00000063,
!- Maximum Exhaust Flow per Unit of Power Output {(kg/s)/W}
150,
!- Design Minimum Exhaust Temperature {C}
45500,
!- Fuel Higher Heating Value {kJ/kg}
0.0,
!- Design Heat Recovery Water Flow Rate {m3/s}
,
!- Heat Recovery Inlet Node Name
,
!- Heat Recovery Outlet Node Name
Diesel;
!- Fuel Type
Curve:Quadratic,
BG Shaft Power Curve,
0.09755,
0.6318,
-0.4165,
0,
1;

!!!!!!-

Name
Coefficient1 Constant
Coefficient2 x
Coefficient3 x**2
Minimum Value of x
Maximum Value of x

Curve:Quadratic,
BG Recovery Jacket Heat Curve, !- Name
0.25,
!- Coefficient1 Constant
0,
!- Coefficient2 x
0,
!- Coefficient3 x**2
0,
!- Minimum Value of x
1;
!- Maximum Value of x
Curve:Quadratic,
BG Recovery Lube Heat Curve, !- Name
0.15,
!- Coefficient1 Constant
0,
!- Coefficient2 x
0,
!- Coefficient3 x**2
0,
!- Minimum Value of x
1;
!- Maximum Value of x
Curve:Quadratic,
BG Total Exhaust Energy Curve, !- Name
0.1,
!- Coefficient1 Constant
0,
!- Coefficient2 x
0,
!- Coefficient3 x**2
0,
!- Minimum Value of x
1;
!- Maximum Value of x
Curve:Quadratic,
BG Exhaust Temperature Curve, !- Name
425,
!- Coefficient1 Constant
0,
!- Coefficient2 x
0,
!- Coefficient3 x**2
0,
!- Minimum Value of x
1;
!- Maximum Value of x

Generator:InternalCombustionEngine Outputs
The output variables that are available for the IC engine generator are:
HVAC,Average,Generator Produced Electric Power [W]
HVAC,Sum,Generator Produced Electric Energy [J]

9/29/14

1714

Input-Output Reference

Group -- Electric Load Center-Generator Specifications

HVAC,Average,Generator Lube Heat Recovery Rate [W]

HVAC,Sum,Generator Lube Heat Recovery Energy [J]
HVAC,Average,Generator Jacket Heat Recovery Rate [W]
HVAC,Sum,Generator Jacket Heat Recovery Energy [J]
HVAC,Average,Generator Exhaust Heat Recovery Rate [W]
HVAC,Sum,Generator Exhaust Heat Recovery Energy [J]
HVAC,Average,Generator Total Heat Recovery Rate [W]
HVAC,Sum,Generator Total Heat Recovery [J]
HVAC,Average,Generator Exhaust Air Temperature [C]
HVAC,Average,Generator Heat Recovery Inlet Temperature [C]
HVAC,Average,Generator Heat Recovery Outlet Temperature [C]
HVAC,Average,Generator Heat Recovery Mass Flow Rate [kg/s]
HVAC,Average,Generator Fuel HHV Basis Rate [W]
HVAC,Sum,Generator Fuel HHV Basis Energy [J]
HVAC,Average,Generator <Fuel Type> Rate [W]
HVAC,Sum,Generator <Fuel Type> Energy [J]
HVAC,Average,Generator <Fuel Type> Mass Flow Rate [kg/s]

Generator Produced Electric Power [W]

Generator Produced Electric Energy [J]
These outputs are the electric power output from the electric generator. Energy is metered on
Cogeneration:ElectricityProduced, ElectricityProduced:Plant, and ElectricityProduced:Facility.
Generator Lube Heat Recovery Rate [W]
Generator Lube Heat Recovery Energy [J]
Generator Jacket Heat Recovery Rate [W]
Generator Jacket Heat Recovery Energy [J]
Generator Exhaust Heat Recovery Rate [W]
Generator Exhaust Heat Recovery Energy [J]
Generator Produced Thermal Rate [W]
Generator Produced Thermal Energy [J]
For electric generators with heat recovery these outputs are the components of recoverable
energy available. For the IC engine generator, the following heat recovery components are
reported: Lube (engine lubricant), Jacket (engine coolant), and Exhaust (engine exhaust).
These components are totaled together for Generator Produced Thermal Rate and Generator
Produced Thermal Energy reports. Generator Lube Heat Recovery Energy, Generator Jacket
Heat Recovery Energy, and Generator Exhaust Heat Recovery Energy are metered on
HeatRecovery:EnergyTransfer, EnergyTransfer:Plant, and EnergyTransfer:Facility.
Generator Exhaust Air Temperature [C]
This is the exhaust temperature leaving the engine.

9/29/14

1715

Input-Output Reference

Group -- Electric Load Center-Generator Specifications

Generator Heat Recovery Inlet Temperature [C]

Generator Heat Recovery Outlet Temperature [C]
Generator Heat Recovery Mass Flow Rate [kg/s]
These outputs are the heat recovery inlet and outlet temperatures and flow rate for
generators with heat recovery.
Generator Fuel HHV Basis Rate [W]
Generator Fuel HHV Basis Energy [J]
These outputs are the generators fuel energy and use rate. The energy content of the fuel is
based on the higher heating value (HHV).
Generator <Fuel Type> Rate [W]
Generator <Fuel Type> Energy [J]
Generator <Fuel Type> Mass Flow Rate [kg/s]
If the fuel type is Diesel, then Diesel is shown as the fuel type. They are the diesel fuel input
to the electric generator. Consumption is metered on Cogeneration:Diesel, Diesel:Plant, and
Diesel:Facility.
If the fuel type is Natural Gas, then Gas is shown as the fuel type. They are the natural gas
fuel input to the electric generator. Consumption is metered on Cogeneration:Gas, Gas:Plant,
and Gas:Facility.
If the fuel type is Propane, then Propane is shown as the fuel type. They are the propane fuel
input to the electric generator. Consumption is metered on Cogeneration:Propane,
Propane:Plant, and Propane:Facility.
If the fuel type is Gasoline, then Gasoline is shown as the fuel type. They are the gasoline
fuel input to the electric generator. Consumption is metered on Cogeneration:Gasoline,
Gasoline:Plant, and Gasoline:Facility.
If the fuel type is FuelOil#1, then FuelOil#1 is shown as the fuel type. They are the fuel oil
input to the electric generator. Consumption is metered on Cogeneration:FuelOil#1,
FuelOil#1:Plant, and FuelOil#1:Facility.
If the fuel type is FuelOil#2, then FuelOil#2 is shown as the fuel type. They are the fuel oil
input to the electric generator. Consumption is metered on Cogeneration:FuelOil#2,
FuelOil#2:Plant, and FuelOil#2:Facility.
If the fuel type is OtherFuel1, then OtherFuel1 is shown as the fuel type. They are the fuel oil
input to the electric generator. Consumption is metered on Cogeneration:OtherFuel1,
OtherFuel1:Plant, and OtherFuel1:Facility.
If the fuel type is OtherFuel2, then OtherFuel2 is shown as the fuel type. They are the fuel oil
input to the electric generator. Consumption is metered on Cogeneration:OtherFuel2,
OtherFuel2:Plant, and OtherFuel2:Facility.
Generator:CombustionTurbine
EnergyPlus has two different models for combustion turbine style generators. This one
stems for a model that was originally in the BLAST computer program. A newer model with a
different formulation is also availablesee the Generator:MicroTurbine input object. The
basic combustion-turbine cycle is the Brayton Cycle or open cycle, which consists of an
adiabatic compression, constant pressure heating, and adiabatic expansion. The Combustion
turbine model uses the electrical load and engine generator size to compute part-load ratios
(PLR). Fuel energy input and recoverable lube oil heat are then computed. Finally, the
recoverable exhaust heat is calculated.
Combustion turbine generators use performance parameters to compute fuel energy
consumption as a function of part-load and ambient (entering) air temperature. Recoverable
9/29/14

1716

Input-Output Reference

Group -- Electric Load Center-Generator Specifications

fuel energy equipment, recoverable lube oil heat/fuel energy input equipment performance,
total exhaust heat/fuel energy input equipment, exhaust gas temperature/fuel energy input
equipment performance parameters are all specified with a quadratic curve fit.
When the heat recovery curve fits = 0.0, this means that no heat recovery is done on the
diesel generator exhaust gas; and no heat recovery is specified.
Field: Name
Unique name to identify this combustion turbine generator.
Field: Rated Power Output
The design nominal capacity of the combustion turbine generator in Watts [W].
Field: Electric Circuit Node Name
This Named node contains where the electric power is put in the program simulation for use
by the electric equipment in the Load Center.
Field: Minimum Part Load Ratio
This field contains the minimum allowed operating fraction of full load. The input value must
be >=0.0 and <=1.0.
Field: Maximum Part Load Ratio
This field contains the maximum allowed operating fraction of full load. The input value must
be >0.0 and <=1.0.
Field: Optimum Part Load Ratio
This alpha field contains the optimal operating fraction of full load. This is the part load ratio
that gives the optimal production of electric power with the least amount of fuel usage.
Field: Part Load Based Fuel Input Curve Name
Needs a Curve:Quadratic object to be specified.
Fuel Input = a + b*PLR + c*PLR**2
PLR = Ratio of Generator Load to Rated Power Output. This curve is multiplied to the
Temperature Based Fuel Input Curve to determine Fuel Energy In.
Field: Temperature Based Fuel Input Curve Name
Needs a Curve:Quadratic object to be specified.
Fuel Input = a + b*AT + c*AT**2 where: AT = Ambient Delta T
Field: Exhaust Flow Curve Name
The Total Exhaust Energy Curve is a quadratic equation that needs to be specified by a
curve object. Used to calculate the total exhaust heat as a function of part-load ratio.
Field: Part Load Based Exhaust Temperature Curve Name
The Exhaust Temperature Curve is a quadratic equation that needs to be specified by a
curve object. Used to determine the exhaust gas temperature as a function of part-load ratio.
Field: Temperature Based Exhaust Temperature Curve Name
The Exhaust Temperature Curve is a quadratic equation that needs to be specified by a
curve object. Used to determine the exhaust gas temperature as a function of part-load ratio.
Field: Heat Recovery Lube Energy Curve Name
This alpha field contains the name of the Recovery Lube Heat curve. The curve itself is
specified separately using a curve object (see Curve:Quadlinear object). The Recovery
Lubricant Heat Curve is a quadratic equation that determines the ratio of recovery lube heat
9/29/14

1717

Input-Output Reference

Group -- Electric Load Center-Generator Specifications

to fuel energy. Used to calculate the recoverable lube oil heat as a function of part-load ratio.
The defining equation is:

RecoveryLubeHeatToFuelRatio C1 C2 RL C3 RL2
where RL is the Ratio of Load to Rated Power Output.
U-Factor Times Area (UA) Curve
The UA curve applies to the exhaust gas heat exchanger. The curve is an equation that
determines the overall heat transfer coefficient for the exhaust gases with the stack. The heat
transfer coefficient ultimately helps determine the exhaust stack temperature. The defining
equation is:

UAToCapacityRatio C1GeneratorRatedPowerOutput C2
The following two fields contain the coefficients for the equation.
Field: Coefficient 1 of U-Factor Times Area Curve
This numeric field contains the first coefficient for the overall heat transfer coefficient curve.
Field: Coefficient 2 of U-Factor Times Area Curve
This numeric field contains the second (exponential) coefficient for the overall heat transfer
coefficient curve.
Field: Maximum Exhaust Flow per Unit of Power Output
Maximum exhaust flow per unit capacity for diesel engines. The parameter sets an upper limit
on exhaust gas flow and exhaust gas heat recovery for diesel engines. Units: kg/sec per kW
capacity
Field: Design Minimum Exhaust Temperature
This is the design engine stack saturated steam temperature in degrees C.
Field: Design Air Inlet Temperature
Design air inlet temperature in degrees C.
Field: Fuel Higher Heating Value
This numeric field contains the higher heating value of the fuel used in kJ/kg.
Field: Design Heat Recovery Water Flow Rate
Design water volumetric flow rate through heat recovery loop in m 3/sec.
Field: Heat Recovery Inlet Node Name
This alpha field contains the identifying name for the combustion turbine generator heat
recovery side inlet node.
Field: Heat Recovery Outlet Node Name
This alpha field contains the identifying name for the combustion turbine generator heat
recovery side outlet node.
Field: Fuel Type
This alpha field determines the type of fuel that the generator uses. Valid choices are:
NaturalGas, PropaneGas, Diesel, Gasoline, FuelOil#1, FuelOil#2, OtherFuel1 and
OtherFuel2. The default is NaturalGas.
9/29/14

1718

Input-Output Reference

Group -- Electric Load Center-Generator Specifications

Field: Heat Recovery Maximum Temperature

This field sets the maximum temperature that this piece of equipment can produce for heat
recovery. The idea behind this field is that the current models do not take temperatures into
account for availability and they just pass Q's around the loop without a temperature limit.
This temperature limit puts an upper bound on the recovered heat and limits the max
temperatures leaving the component.
As temperatures in the loop approach the maximum temperature, the temperature difference
between the entering water and the surfaces in the piece of equipment becomes smaller. For
the given heat recovery flow rate and that temperature difference the amount of heat
recovered will be reduced, and eventually there will be no heat recovered when the entering
water temperature is equal to the maximum temperature specified by the user in this field.
The reduced amount of heat recovered will diminish if the temperature of the loop approach
is the maximum temperature, and this will show up in the reporting. This allows the user to
set the availability or the quality of the heat recovered for usage in other parts of the system
or to heat domestic hot water supply.
The temperature is specified in degrees C.
Field: Outdoor Air Inlet Node Name
This field is optional. It is used to explicitly define an outdoor air node for the inlet for
combustion air stream. Defining an outdoor air node here allows using the height-dependent
model for outdoor air conditions.
An IDF example showing how it is used is provided below:
Generator:CombustionTurbine,
Solar Turbine,
!- Name
30000,
!- Rated Power Output {W}
GT gen Electric Node,
!- Electric Circuit Node Name
0.15,
!- Minimum Part Load Ratio
1.0,
!- Maximum Part Load Ratio
0.65,
!- Optimum Part Load Ratio
BG PL Based Fuel Input Curve, !- Part Load Based Fuel Input Curve Name
BG Temp Based Fuel Input Curve, !- Temperature Based Fuel Input Curve Name
BG Exhaust Flow Curve,
!- Exhaust Flow Curve Name
BG PL Based Exhaust Temp Curve, !- Part Load Based Exhaust Temperature Curve Name
BG Temp Based Exhaust Temp Curve, !- Temperature Based Exhaust Temperature Curve Name
BG Tur Recovery Lube Heat Curve, !- Heat Recovery Lube Energy Curve Name
0.01907045,
!- Coefficient 1 of U-Factor Times Area Curve
0.9,
!- Coefficient 2 of U-Factor Times Area Curve
0.00000504,
!- Maximum Exhaust Flow per Unit of Power Output {(Kg/s)/W}
150,
!- Design Minimum Exhaust Temperature {C}
25,
!- Design Air Inlet Temperature {C}
43500,
!- Fuel Higher Heating Value {kJ/kg}
0.0,
!- Design Heat Recovery Water Flow Rate {m3/s}
,
!- Heat Recovery Inlet Node Name
,
!- Heat Recovery Outlet Node Name
NaturalGas,
!- Fuel Type
,
!- Heat Recovery Maximum Temperature {C}
CT OA inlet;
!- Outdoor Air Inlet Node Name

9/29/14

1719

Input-Output Reference

Group -- Electric Load Center-Generator Specifications

Curve:Quadratic,
BG PL Based Fuel Input Curve, !- Name
9.41,
!- Coefficient1 Constant
-9.48,
!- Coefficient2 x
4.32,
!- Coefficient3 x**2
0,
!- Minimum Value of x
1;
!- Maximum Value of x
Curve:Quadratic,
BG Temp Based Fuel Input Curve, !- Name
1.0044,
!- Coefficient1 Constant
-0.0008,
!- Coefficient2 x
0,
!- Coefficient3 x**2
-30,
!- Minimum Value of x
+30;
!- Maximum Value of x
Curve:Quadratic,
BG Exhaust Flow Curve,
0.05,
0.0,
0.0,
0,
1;

!!!!!!-

Name
Coefficient1 Constant
Coefficient2 x
Coefficient3 x**2
Minimum Value of x
Maximum Value of x

Curve:Quadratic,
BG PL Based Exhaust Temp Curve, !- Name
450,
!- Coefficient1 Constant
0,
!- Coefficient2 x
0,
!- Coefficient3 x**2
0,
!- Minimum Value of x
1;
!- Maximum Value of x

Curve:Quadratic,
BG Temp Based Exhaust Temp Curve, !- Name
1.005,
!- Coefficient1 Constant
0.0018,
!- Coefficient2 x
0,
!- Coefficient3 x**2
-30,
!- Minimum Value of x
+30;
!- Maximum Value of x
Curve:Quadratic,
BG Tur Recovery Lube Heat Curve, !- Name
0.223,
!- Coefficient1 Constant
-0.4,
!- Coefficient2 x
0.2286,
!- Coefficient3 x**2
0,
!- Minimum Value of x
1;
!- Maximum Value of x

Generator:CombustionTurbine Outputs
The output variables that are available for the combustion turbine generator are:
HVAC,Average,Generator Produced Electric Power [W]
HVAC,Sum,Generator Produced Electric Energy [J]
Zone,Meter,ElectricityProduced:Facility [J]
Zone,Meter,ElectricityProduced:Plant [J]
Zone,Meter,Cogeneration:ElectricityProduced [J]
HVAC,Average,Generator Lube Heat Recovery Rate [W]
HVAC,Sum,Generator Lube Heat Recovery Energy [J]
HVAC,Average,Generator Exhaust Heat Recovery Rate [W]
HVAC,Sum,Generator Exhaust Heat Recovery [J]
HVAC,Average,Generator Total Heat Recovery Rate [W]
HVAC,Sum,Generator Total Heat Recovery [J]
9/29/14

1720

Input-Output Reference

Group -- Electric Load Center-Generator Specifications

HVAC,Average,Generator Exhaust Air Temperature [C]

HVAC,Average,Generator Heat Recovery Inlet Temperature [C]
HVAC,Average,Generator Heat Recovery Outlet Temperature [C]
HVAC,Average,Generator Heat Recovery Mass Flow Rate [kg/s]
HVAC,Average,Generator <Fuel Type> Rate [W]
HVAC,Sum,Generator <Fuel Type> Energy [J]
HVAC,Average,Generator <Fuel Type> Mass Flow Rate [kg/s]

All of these outputs, except for the Combustion use outputs, are described above under
"Generator:InternalCombustionEngine Outputs."
Generator <Fuel Type> Rate [W]
Generator <Fuel Type> Energy [J]
Generator <Fuel Type> Mass Flow Rate [kg/s]
These outputs are the fuel input to the electric generator. Consumption is metered on
Cogeneration:<Fuel Type>, <Fuel Type>:Plant, and <Fuel Type>:Facility.
Generator:MicroTurbine
MicroTurbine generators are small combustion turbines that produce electricity on a relatively
small scale (e.g., 25kW to 500kW). This model uses nominal performance at reference
conditions along with several modifier curves to determine electrical power output and fuel
use at non-reference conditions. Standby and ancillary power can also be taken into account.
Furthermore, energy recovery from exhaust air can be used to heat water. Similar to
electrical power output, thermal power (heat recovery) output is calculated using nominal
performance at reference conditions with modifier curves to account for variations at nonreference conditions.
The
following
inputs
define
the
MicroTurbine
electric
generator.
The
ElectricLoadCenter:Generators and ElectricLoadCenter:Distribution objects are used to
define the availability and control of all electric generators included in the simulation (ref.
ElectricLoadCenter:Generators and ElectricLoadCenter:Distribution).
Field: Name
This alpha field specifies a unique user-defined name to identify this generator. This is a
required input.
Field: Reference Electrical Power Output
This numeric field specifies the full-load electrical power output of the microturbine generator
in Watts at reference conditions. The reference conditions are defined via additional input
fields for this object (see below). This is a required input, and the value entered in this field
must be greater than zero.
Field: Minimum Full Load Electrical Power Output
This numeric field specifies the minimum electrical power output in Watts at full-load
conditions. The electrical power output of the generator is determined by multiplying the
Reference Electrical Power Output by the Electrical Power Function of Temperature and
Elevation modifier curve. If the result is less than the numeric value specified in this input
field, then the generators electrical power output is reset to the minimum full-load value
specified in this input field. The value entered in this field must be greater than or equal to
zero. If this field is left blank, the default value of 0.0 will be used.

9/29/14

1721

Input-Output Reference

Group -- Electric Load Center-Generator Specifications

Field: Maximum Full Load Electrical Power Output

This numeric field specifies the maximum electrical power output in Watts at full-load
conditions. The electrical power output of the generator is determined by multiplying the
Reference Electrical Power Output by the Electrical Power Function of Temperature and
Elevation Modifier curve. If the result is greater than the numeric value specified in this input
field, then the generators electrical power output is reset to the maximum full-load value
specified in this input field. The value entered in this field must be greater than zero. If this
field is left blank, then the value entered for the Reference Electrical Power Output field
(above) will be used as the Maximum Full Load Electrical Power Output.
Field: Reference Electrical Efficiency Using Lower Heating Value
This numeric field contains the electrical efficiency of the generator at reference conditions,
based on the lower heating value of the fuel. The electrical efficiency is the electric power
output divided by the fuel energy consumption rate (LHV basis). The reference conditions are
defined via additional input fields for this object (see below). This is a required input, and the
value entered in this field must be greater than zero and less than or equal to 1.0.
Field: Reference Combustion Air Inlet Temperature
This numeric field specifies the reference temperature for the combustion inlet air in degrees
Celsius. If this field is left blank, the default value of 15C will be used.
Field: Reference Combustion Air Inlet Humidity Ratio
This numeric field specifies the reference humidity ratio for the combustion inlet air in
kgWater/kgDryAir. The value specified for this field must be greater than zero. If this field is
left blank, the default value of 0.00638 (kgWater/kgDryAir) will be used.
Field: Reference Elevation
This numeric field specifies the reference elevation in meters (relative to sea level). The value
specified for this field must be greater than or equal to -300.0 meters. If this field is left blank,
the default value of 0.0 meters will be used.
Field: Electrical Power Function of Temperature and Elevation Curve Name
This alpha field specifies the name of a bi-quadratic performance curve (ref: Performance
Curves) that parameterizes the variation of electrical power output as a function of the
combustion air inlet temperature and elevation. The output of this curve is multiplied by the
Reference Electrical Power Output to give the full-load power output at a specific combustion
air inlet temperature and elevation (i.e., at values different from the reference conditions).
This curve should be normalized to have a value of 1.0 at the reference conditions, and the
curve should be valid for the range of inlet air temperatures anticipated for the simulation
period and for the actual elevation of the generator.
Field: Electrical Efficiency Function of Temperature Curve Name
This alpha field specifies the name of a quadratic or cubic performance curve (ref:
Performance Curves) that parameterizes the variation of electrical efficiency as a function of
the combustion air inlet temperature. The output of this curve is multiplied by the Reference
Electrical Efficiency Using Lower Heating Value to give the full-load electrical efficiency at
specific combustion air inlet temperatures (i.e., at inlet air temperatures different from the
Reference Combustion Air Inlet Temperature). This curve should be normalized to have a
value of 1.0 at the Reference Combustion Air Inlet Temperature, and the curve should be
valid for the range of inlet air temperatures anticipated for the simulation period.
Field: Electrical Efficiency Function of Part Load Ratio Curve Name
This alpha field specifies the name of a quadratic or cubic performance curve (ref:
Performance Curves) that parameterizes the variation of electrical efficiency as a function of
the generators part-load ratio (part-load ratio is the actual electrical power output divided by
9/29/14

1722

Input-Output Reference

Group -- Electric Load Center-Generator Specifications

the full-load electrical power output at the current operating conditions). The output of this
curve is multiplied by the Reference Electrical Efficiency Using Lower Heating Value and the
output of the Electrical Efficiency Function of Temperature modifier curve to give the electrical
efficiency at specific part-load and combustion air inlet (temperature) conditions. This curve
should be normalized to have a value of 1.0 when the generators part-load ratio is 1.0, and
the curve should be valid for the range of part-load ratios anticipated for the simulation
period.
Field: Fuel Type
This choice field specifies the type of fuel used by the generator. Valid fueld types are
PropaneGas and NaturalGas. If the field is left blank, the fuel type will be assumed to be
NaturalGas.
Field: Fuel Higher Heating Value
This numeric field specifies the higher heating value of the fuel used in kJ/kg. The value
specified for this field must be greater than zero and greater than the specified Fuel Lower
Heating Value. If this field is left blank, the default value of 50,000 kJ/kg will be used.
Field: Fuel Lower Heating Value
This numeric field specifies the lower heating value of the fuel used in kJ/kg. The value
specified for this field must be greater than zero but less than the specified Fuel Higher
Heating Value. If this field is left blank, the default value of 45,450 kJ/kg will be used.
Field: Standby Power
This numeric field specifies the standby electric power consumed by the generator in Watts.
The standby power is the electrical power consumed by the generator (e.g., air fans and
controls) when the generator is available to operate but the generator electrical power output
is zero (power output is not being requested by the electric load center). The value specified
for this field must be greater than or equal to zero. If this field is left blank, the default value of
0.0 W will be used.
Field: Ancillary Power
This numeric field specifies the ancillary electric power consumed by the generator in Watts.
The ancillary power is the electrical power consumed by other associated equipment (e.g.,
external fuel pressurization pumps) when the generator is operating. Specify this input as 0.0
if the Reference Electrical Power Output and Reference Electrical Efficiency Using Lower
Heating Value input fields and associated modifier curves reflect the net electrical power
output from the generator (i.e., ancillary power already deducted from the generators gross
electrical power output). A value greater than zero indicates that this electrical power is
consumed whenever the generator is operating and will be deducted from the generators
overall electrical power output (Generator Produced Electric Power). The value specified for
this field must be greater than or equal to zero. If this field is left blank, the default value of
0.0 W will be used.
Field: Ancillary Power Function of Fuel Input Curve Name
This alpha field specifies the name of a quadratic performance curve (ref: Performance
Curves) that parameterizes the variation of ancillary power as a function of the generators
input fuel mass flow rate (kg/s). The output of this curve is multiplied by the ancillary power to
give the ancillary power at a specific fuel mass flow rate. If this field is left blank, the model
assumes that the modifier curve is 1.0 for the entire simulation (i.e., the ancillary power is
constant whenever the generator operates).
Field: Heat Recovery Water Inlet Node Name
This alpha field specifies the identifying name for the generators heat recovery water inlet
node.
9/29/14

1723

Input-Output Reference

Group -- Electric Load Center-Generator Specifications

Field: Heat Recovery Water Outlet Node Name

This alpha field specifies the identifying name for the generators heat recovery water outlet
node.
Field: Reference Thermal Efficiency Using Lower Heat Value
This numeric field specifies the thermal efficiency (heat recovery to water) at reference
conditions, based on the lower heating value of the fuel. The thermal efficiency is the thermal
power output (to water) divided by the fuel energy consumption rate (LHV basis). The
reference conditions are defined via additional input fields for this object. This value must be
from 0.0 to 1.0. If this field is left blank, the default value of 0.0 will be used.
Field: Reference Inlet Water Temperature
This numeric field specifies the reference temperature for the inlet water to the heat recovery
heat exchanger in degrees Celsius.
Field: Heat Recovery Water Flow Operating Mode
This field is used to choose between different modes of controlling the mass flow rate of
water being heated by energy recovered from exhaust air. There are two options available for
this field: PlantControl or InternalControl. The PlantControl option indicates that the heat
recovery water flow rate through the generator is determined externally (by the wider balance
of plant). In this case, the generator will request the Reference Heat Recovery Water Flow
Rate whenever it operates but the actual flow rate may be limited by other plant components
(e.g., pump). The InternalControl option indicates the flow of water is controlled inside the
generator based on current operating conditions. For InternalControl, the generator should
(probably) include a bypass branch when connecting to the plant loop.
Field: Reference Heat Recovery Water Flow Rate
This numeric field is the reference heat recovery (volumetric) water flow rate in cubic meters
per second. Entered values must be greater than zero.
Field: Heat Recovery Water Flow Rate Function of Temperature and Power Curve Name
This alpha field specifies the name of a bi-quadratic performance curve (ref: Performance
Curves) that parameterizes the variation of heat recovery water flow rate as a function of the
inlet water temperature and net electrical power output. This field is only used if the Heat
Recovery Water Flow Operating Mode is InternalControl. The output of this curve is
multiplied by the Reference Heat Recovery Water Flow Rate to give the water flow rate at the
specific inlet water temperature and net power operating conditions. This curve should be
normalized to have a value of 1.0 at the reference conditions, and the curve should be valid
for the range of inlet water temperatures and net electrical power output anticipated for the
simulation period. If this field is left blank, the model assumes that the modifier curve is 1.0
for the entire simulation.
Field: Thermal Efficiency Function of Temperature and Elevation Curve Name
This alpha field specifies the name of a bi-quadratic performance curve (ref: Performan