Merge branch 'develop' of https://github.com/NREL/EnergyPlus into NFP…

…-Refrigerant-Migration-Decarbonization

doc/engineering-reference/src/advanced-surface-concepts/green-roof-model-ecoroof.tex

@@ -59,7 +59,7 @@ \subsubsection{Energy budget in the foliage layer}\label{energy-budget-in-the-fo
 Where $\sigma$\(_{f}\) is calculated as a function of Leaf-Area-Index (LAI):
 
 \begin{equation}
-\sigma_f = 0.9 - 0.7 \exp{-0.75 LAI }
+\sigma_f = 0.9 - 0.7 \exp^{-0.75 LAI}
 \end{equation}
 
 In addition to convective and sensible heat transfer this equation accounts for both the short and longwave radiation absorbed by the vegetation, including the effects of multiple reflections. The sensible and latent heat flux terms (H\(_{f}\) and L\(_{f-}\)) are somewhat complicated and therefore discussed in some detail below.

doc/input-output-reference/src/hvac-template-objects/group-hvac-templates.tex

@@ -326,7 +326,7 @@ \subsection{HVACTemplate:Zone:IdealLoadsAirSystem}\label{hvactemplatezoneideallo
 
 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 \hyperref[districtheating]{DistrictHeating} and \hyperref[districtcooling]{DistrictCooling}.
+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 \hyperref[districtheating]{DistrictHeatingWater} and \hyperref[districtcooling]{DistrictCooling}.
 
 \subsubsection{Inputs}\label{inputs-1-022}
 
@@ -910,7 +910,7 @@ \subsubsection{Inputs}\label{inputs-4-016}
 
 \paragraph{Field: Cooling Coil Type}\label{field-cooling-coil-type-1}
 
-Enter the type of cooling coil. There is currently only one choices for this field, SingleSpeedDX.
+Enter the type of cooling coil. There is currently only one choice for this field, SingleSpeedDX.
 
 \paragraph{Field: Cooling Coil Availability Schedule Name}\label{field-cooling-coil-availability-schedule-name-1}
 
@@ -1156,7 +1156,7 @@ \subsubsection{Inputs}\label{inputs-5-014}
 
 \paragraph{Field: Cooling Coil Type}\label{field-cooling-coil-type-2}
 
-Enter the type of cooling coil. There is currently only one choices for this field, SingleSspeedDX.
+Enter the type of cooling coil. There is currently only one choice for this field, SingleSpeedDX.
 
 \paragraph{Field: Cooling Coil Availability Schedule Name}\label{field-cooling-coil-availability-schedule-name-2}
 
@@ -1176,7 +1176,7 @@ \subsubsection{Inputs}\label{inputs-5-014}
 
 \paragraph{Field: Heat Pump Heating Coil Type}\label{field-heat-pump-heating-coil-type}
 
-Enter the type of heat pump heating coil. There is currently only one choices for this field, SingleSpeedDXHeatPump.
+Enter the type of heat pump heating coil. There is currently only one choice for this field, SingleSpeedDXHeatPump.
 
 \paragraph{Field: Heat Pump Heating Coil Availability Schedule Name}\label{field-heat-pump-heating-coil-availability-schedule-name}
 
@@ -1445,7 +1445,8 @@ \subsubsection{Inputs}\label{inputs-6-011}
 
 \paragraph{Field: Cooling Coil Type}\label{field-cooling-coil-type-3}
 
-Enter the type of cooling coil. There is currently only one choices for this field, \hyperref[coilcoolingwatertoairheatpumpequationfit]{Coil:Cooling:WaterToAirHeatPump:EquationFit}.
+Enter the type of cooling coil. At the present time, there is currently only one choice for this field:
+ \hyperref[coilcoolingwatertoairheatpumpequationfit]{Coil:Cooling:WaterToAirHeatPump:EquationFit}
 
 \paragraph{Field: Cooling Coil Gross Rated Total Capacity}\label{field-cooling-coil-gross-rated-total-capacity-2}
 
@@ -1461,7 +1462,8 @@ \subsubsection{Inputs}\label{inputs-6-011}
 
 \paragraph{Field: Heat Pump Heating Coil Type}\label{field-heat-pump-heating-coil-type-1}
 
-Enter the type of heat pump heating coil. There is currently only one choices for this field, \hyperref[coilheatingwatertoairheatpumpequationfit]{Coil:Heating:WaterToAirHeatPump:EquationFit}.
+Enter the type of heat pump heating coil. There is currently only one choice for this field:
+ \hyperref[coilheatingwatertoairheatpumpequationfit]{Coil:Heating:WaterToAirHeatPump:EquationFit}.
 
 \paragraph{Field: Heat Pump Heating Coil Gross Rated Capacity}\label{field-heat-pump-heating-coil-gross-rated-capacity-1}
 
@@ -3654,9 +3656,7 @@ \subsubsection{Inputs}\label{inputs-16-004}
 
 \paragraph{Field: Cooling Coil Type}\label{field-cooling-coil-type-6}
 
-Enter the type of cooling coil. There is currently only one choices for this field,
-
-SingleSpeedDX. Future versions may have additional cooling coil types.
+Enter the type of cooling coil. There is currently only one choice for this field, SingleSpeedDX. Future versions may have additional cooling coil types.
 
 \paragraph{Field: Cooling Coil Availability Schedule Name}\label{field-cooling-coil-availability-schedule-name-5}
 

doc/input-output-reference/src/overview/group-advanced-surface-concepts.tex

@@ -2719,7 +2719,7 @@ \subsubsection{Outputs}\label{outputs-gndSrfs}
 
 This is an average surface reflectance of multiple ground surfaces viewed by an exterior surface for each time step. If there is only one ground surface specified in a given \textit{SurfaceProperty:GroundSurfaces} object, then the average surface reflectance will be the same as the specified ground surface reflectance. This output variable is not generated when all ground surface reflectance schedule name fields are blank.
 
-\subsection{References}\label{references-gnd-srfs}
+\subsubsection{References}\label{references-gnd-srfs}
 
 Bill Marion. 2018. Ground Albedo Measurements and Modeling. Bifacial PV Workshop Lakewood, Colorado. September 11, 2018.
 NREL/PR-5K00-72589. https://www.nrel.gov/docs/fy20osti/72589.pdf

doc/input-output-reference/src/overview/group-design-objects.tex

@@ -752,7 +752,7 @@ \subsubsection{Component Sizing Output}\label{component-sizing-output}
 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
-\begin{longtable}[c]{p{3.02in}p{2.97in}}
+\begin{longtable}[c]{p{3.3in}p{3.3in}}
 \caption{Complete list of Objects with autosized Fields \label{table:complete-list-of-objects-with-autosized}} \tabularnewline
 \toprule
 Object Name & Object Name \tabularnewline
@@ -767,17 +767,22 @@ \subsubsection{Component Sizing Output}\label{component-sizing-output}
 
 AirConditioner:VariableRefrigerantFlow & AirLoopHVAC \tabularnewline
 AirLoopHVAC:Unitary:Furnace:HeatCool & AirLoopHVAC:Unitary:Furnace:HeatOnly \tabularnewline
-AirLoopHVAC:UnitaryHeatCool & AirLoopHVAC:UnitaryHeatCool:VAVChangeoverBypass \tabularnewline
+AirLoopHVAC:UnitaryHeatCool & \tabularnewline
+AirLoopHVAC:UnitaryHeatCool:VAVChangeoverBypass & \tabularnewline
 AirLoopHVAC:UnitaryHeatOnly & AirLoopHVAC:UnitaryHeatPump:AirToAir \tabularnewline
-AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed & AirLoopHVAC:UnitaryHeatPump:WaterToAir \tabularnewline
+AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed & \tabularnewline
+AirLoopHVAC:UnitaryHeatPump:WaterToAir & \tabularnewline
 AirLoopHVAC:UnitarySystem & AirTerminal:DualDuct:ConstantVolume \tabularnewline
 AirTerminal:DualDuct:VAV & AirTerminal:DualDuct:VAV:OutdoorAir \tabularnewline
-AirTerminal:SingleDuct:ConstantVolume:CooledBeam & AirTerminal:SingleDuct:ConstantVolume:FourPipeInduction \tabularnewline
+AirTerminal:SingleDuct:ConstantVolume:CooledBeam & \tabularnewline
+AirTerminal:SingleDuct:ConstantVolume:FourPipeInduction & \tabularnewline
 AirTerminal:SingleDuct:ConstantVolume:Reheat & AirTerminal:SingleDuct:ParallelPIU:Reheat \tabularnewline
 AirTerminal:SingleDuct:SeriesPIU:Reheat & AirTerminal:SingleDuct:ConstantVolume:NoReheat \tabularnewline
-AirTerminal:SingleDuct:VAV:HeatAndCool:NoReheat & AirTerminal:SingleDuct:VAV:HeatAndCool:Reheat \tabularnewline
+AirTerminal:SingleDuct:VAV:HeatAndCool:NoReheat & \tabularnewline
+ & AirTerminal:SingleDuct:VAV:HeatAndCool:Reheat \tabularnewline
 AirTerminal:SingleDuct:VAV:NoReheat & AirTerminal:SingleDuct:VAV:Reheat \tabularnewline
-AirTerminal:SingleDuct:VAV:Reheat:VariableSpeedFan & Boiler:HotWater \tabularnewline
+AirTerminal:SingleDuct:VAV:Reheat:VariableSpeedFan & \tabularnewline
+ & Boiler:HotWater \tabularnewline
 Boiler:Steam & Branch \tabularnewline
 Chiller:Absorption & Chiller:Absorption:Indirect \tabularnewline
 Chiller:CombustionTurbine & Chiller:ConstantCOP \tabularnewline
@@ -789,13 +794,15 @@ \subsubsection{Component Sizing Output}\label{component-sizing-output}
 Coil:Cooling:DX:TwoSpeed & Coil:Cooling:DX:VariableRefrigerantFlow \tabularnewline
 Coil:Cooling:DX:VariableSpeed & Coil:Cooling:Water \tabularnewline
 Coil:Cooling:Water:DetailedGeometry & Coil:Cooling:WaterToAirHeatPump:EquationFit \tabularnewline
-Coil:Cooling:WaterToAirHeatPump:VariableSpeedEquationFit & Coil:Heating:DX:MultiSpeed \tabularnewline
+Coil:Cooling:WaterToAirHeatPump:VariableSpeedEquationFit & \tabularnewline
+ & Coil:Heating:DX:MultiSpeed \tabularnewline
 Coil:Heating:DX:SingleSpeed & Coil:Heating:DX:VariableRefrigerantFlow \tabularnewline
 Coil:Heating:DX:VariableSpeed & Coil:Heating:Electric \tabularnewline
 Coil:Heating:Electric:MultiStage & Coil:Heating:Fuel \tabularnewline
 Coil:Heating:Gas:MultiStage & Coil:Heating:Steam \tabularnewline
 Coil:Heating:Water & Coil:Heating:WaterToAirHeatPump:EquationFit \tabularnewline
-Coil:Heating:WaterToAirHeatPump:VariableSpeedEquationFit & CoilPerformance:DX:Cooling \tabularnewline
+Coil:Heating:WaterToAirHeatPump:VariableSpeedEquationFit & \tabularnewline
+ & CoilPerformance:DX:Cooling \tabularnewline
 CondenserLoop & Controller:OutdoorAir \tabularnewline
 Controller:WaterCoil & CoolingTower:SingleSpeed \tabularnewline
 CoolingTower:TwoSpeed & CoolingTower:VariableSpeed \tabularnewline
@@ -811,7 +818,8 @@ \subsubsection{Component Sizing Output}\label{component-sizing-output}
 HVACTemplate:Plant:Tower & HVACTemplate:System:ConstantVolume \tabularnewline
 HVACTemplate:System:DedicatedOutdoorAir & HVACTemplate:System:DualDuct \tabularnewline
 HVACTemplate:System:PackagedVAV & HVACTemplate:System:Unitary \tabularnewline
-HVACTemplate:System:UnitaryHeatPump:AirToAir & HVACTemplate:System:UnitarySystem \tabularnewline
+HVACTemplate:System:UnitaryHeatPump:AirToAir & \tabularnewline
+ & HVACTemplate:System:UnitarySystem \tabularnewline
 HVACTemplate:System:VAV & HVACTemplate:System:VRF \tabularnewline
 HVACTemplate:Zone:BaseboardHeat & HVACTemplate:Zone:ConstantVolume \tabularnewline
 HVACTemplate:Zone:DualDuct & HVACTemplate:Zone:FanCoil \tabularnewline

doc/input-output-reference/src/overview/group-electric-load-center-generator.tex

@@ -4451,7 +4451,7 @@ \subsubsection{Inputs}\label{inputs-20-000}
 
 \paragraph{Field: Surface Name}\label{field-surface-name-001}
 
-This field is the name of a surface that defines the location and geometry of the array.
+This field is the name of a surface that defines the location and geometry of the array. Array tilt, azimuth, and gross area are taken from the referenced building surface or shading surface. This will define the orientation of the solar panel for the detailed models and also the area of the solar panel for the simple model.
 
 \paragraph{Field: Photovoltaic Performance Object Type}\label{field-photovoltaic-performance-object-type}
 

doc/input-output-reference/src/overview/group-heat-recovery.tex

@@ -264,12 +264,6 @@ \subsubsection{Inputs}\label{inputs-1-019}
 
 The latent heat exchange effectiveness at the \emph{heating} condition defined in Table~\ref{table:operating-conditions-for-defining-heat} 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.
 
-\paragraph{Field: Sensible Effectiveness at 75\% Heating Air Flow}\label{field-sensible-effectiveness-at-75-heating-air-flow}
-
-The sensible heat exchange effectiveness at the \emph{heating} condition defined in Table~\ref{table:operating-conditions-for-defining-heat} 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.
-
-\paragraph{Field: Latent Effectiveness at 75\% Heating Air Flow}\label{field-latent-effectiveness-at-75-heating-air-flow}
-
 The latent heat exchange effectiveness at the \emph{heating} condition defined in Table~\ref{table:operating-conditions-for-defining-heat} 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.
 
 \paragraph{Field: Sensible Effectiveness at 100\% Cooling Air Flow}\label{field-sensible-effectiveness-at-100-cooling-air-flow}
@@ -280,14 +274,6 @@ \subsubsection{Inputs}\label{inputs-1-019}
 
 The latent heat exchange effectiveness at the \emph{cooling} condition defined in Table~\ref{table:operating-conditions-for-defining-heat} 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.
 
-\paragraph{Field: Sensible Effectiveness at 75\% Cooling Air Flow}\label{field-sensible-effectiveness-at-75-cooling-air-flow}
-
-The sensible heat exchange effectiveness at the \emph{cooling} condition defined in Table~\ref{table:operating-conditions-for-defining-heat} 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.
-
-\paragraph{Field: Latent Effectiveness at 75\% Cooling Air Flow}\label{field-latent-effectiveness-at-75-cooling-air-flow}
-
-The latent heat exchange effectiveness at the \emph{cooling} condition defined in Table~\ref{table:operating-conditions-for-defining-heat} 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.
-
 \paragraph{Field: Supply Air Inlet Node Name}\label{field-supply-air-inlet-node-name-1-000}
 
 The name of the HVAC system node from which the unit draws its supply (primary) inlet air.
@@ -392,6 +378,22 @@ \subsubsection{Inputs}\label{inputs-1-019}
 
 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 air-side economizer is operating. Both the economizer and high humidity control (Ref. \hyperref[controlleroutdoorair]{Controller:OutdoorAir}) activate the heat exchanger lockout as specified by this input. The input choices are \emph{Yes} (meaning locked out) or \emph{No}. The default input for this field is Yes.
 
+\paragraph{Field: Sensible Effectiveness of Heating Air Flow Curve Name}\label{field-sensible-effectiveness-of-heating-air-flow-curve-name-1}
+
+This optional input allows the user to specify a curve that determines the value of the sensible effectiveness for heating.  The result of the curve is multipled by the sensible effectiveness at 100\% heating (see field: \hyperref[field-sensible-effectiveness-at-100-heating-air-flow]{Sensible Effectiveness at 100\% Heating Air Flow} above).
+
+\paragraph{Field: Latent Effectiveness of Heating Air Flow Curve Name}\label{field-latent-effectiveness-of-heating-air-flow-curve-name-1}
+
+This optional input allows the user to specify a curve that determines the value of the latent effectiveness for heating.  The result of the curve is multipled by the latent effectiveness at 100\% heating (see field: \hyperref[field-latent-effectiveness-at-100-heating-air-flow]{Latent Effectiveness at 100\% Heating Air Flow} above).
+
+\paragraph{Field: Sensible Effectiveness of Cooling Air Flow Curve Name}\label{field-sensible-effectiveness-of-cooling-air-flow-curve-name-1}
+
+This optional input allows the user to specify a curve that determines the value of the sensible effectiveness for cooling.  The result of the curve is multipled by the sensible effectiveness at 100\% cooling (see field: \hyperref[field-sensible-effectiveness-at-100-cooling-air-flow]{Sensible Effectiveness at 100\% Cooling Air Flow} above).
+
+\paragraph{Field: Latent Effectiveness of Cooling Air Flow Curve Name}\label{field-latent-effectiveness-of-cooling-air-flow-curve-name-1}
+
+This optional input allows the user to specify a curve that determines the value of the latent effectiveness for cooling.  The result of the curve is multipled by the latent effectiveness at 100\% cooling (see field: \hyperref[field-latent-effectiveness-at-100-cooling-air-flow]{Latent Effectiveness at 100\% Cooling Air Flow} above).
+
 Following is an example input for this heat exchanger object:
 
 \begin{lstlisting}

doc/input-output-reference/src/overview/group-humidifiers-and-dehumidifiers.tex

@@ -209,17 +209,19 @@ \subsubsection{Inputs}\label{inputs-1-021}
 \item
   HVAC,Sum,Humidifier Water Volume{[}m3{]}
 \item
-  HVAC,Average,Humidifier Gas Use Rate{[}W{]}
+  HVAC,Average,Humidifier NaturalGas Use Rate{[}W{]}
 \item
-  HVAC,Sum,Humidifier Gas Use Energy {[}J{]}
+  HVAC,Sum,Humidifier NaturalGas Use Energy {[}J{]}
+ \item
+  HVAC,Average,Humidifier NaturalGas Use Thermal Efficiency {[}{]}
 \item
   HVAC,Average,Humidifier Auxiliary Electricity Rate {[}W{]}
 \item
   HVAC,Sum,Humidifier Auxiliary Electricity Energy {[}J{]}
 \item
   HVAC,Meter,Humidifier:Water {[}m3{]}
 \item
-  HVAC,Meter,Humidifier:Gas {[}J{]}
+  HVAC,Meter,Humidifier:NaturalGas {[}J{]}
 \item
   HVAC,Meter,Humidifier:Electricity {[}J{]}
 \item
@@ -244,13 +246,17 @@ \subsubsection{Inputs}\label{inputs-1-021}
 
 This output is the cubic meters of water consumed by the steam humidifier over the timestep being reported.
 
-\paragraph{Humidifier Gas Use Rate {[}W{]}}\label{humidifier-gas-use-rate-w}
+\paragraph{Humidifier NaturalGas Use Rate {[}W{]}}\label{humidifier-naturalgas-use-rate-w}
 
-This output is the gas use rate of the gas fired steam humidifier in Watts.
+This output is the natural gas use rate of the natural gas fired steam humidifier in Watts.
 
-\paragraph{Humidifier Gas Use Energy {[}J{]}}\label{humidifier-gas-use-energy-j}
+\paragraph{Humidifier NaturalGas Use Energy {[}J{]}}\label{humidifier-naturalgas-use-energy-j}
 
-This output is the gas consumption of the gas fired steam humidifier in Joules.
+This output is the natural gas consumption of the natural gas fired steam humidifier in Joules.
+
+\paragraph{Humidifier NaturalGas Use Thermal Efficiency {[}{]}}\label{humidifier-naturalgas-use-thermal-efficiency-j}
+
+This output is the thermal efficiency of the natural gas consumed by the natural gas fired steam humidifier.
 
 \paragraph{Humidifier Auxiliary Electricity Rate {[}W{]}}\label{humidifier-auxiliary-electric-power-w}
 
@@ -264,9 +270,9 @@ \subsubsection{Inputs}\label{inputs-1-021}
 
 This meter output contains the sum of the water consumed (in cubic meters of water during the report timestep) by all the steam humidifiers at the HVAC level in the simulation.
 
-\paragraph{Humidifier:Gas {[}J{]}}\label{humidifiergas-j}
+\paragraph{Humidifier:NaturalGas {[}J{]}}\label{humidifiernaturalgas-j}
 
-This meter output contains the sum of the gas consumed (in Joules during the report timestep) by all the steam humidifiers at the HVAC level in the simulation.
+This meter output contains the sum of the natural gas consumed (in Joules during the report timestep) by all the steam humidifiers at the HVAC level in the simulation.
 
 \paragraph{Humidifier Storage Tank Water Volume Flow Rate {[}m3/s{]}}\label{humidifier-storage-tank-water-volume-flow-rate-m3s-1}