Address eir_wwhp review comments post-merge

Author: Myoldmopar

doc/engineering-reference/src/simulation-models-encyclopedic-reference-002/air-system-compound-component-groups.tex

@@ -2558,14 +2558,15 @@ \subsection{EIR Formulated Water To Water Heat Pump Model}\label{eir-water-to-wa
 
 This section describes the EIR formulated model for water-to-water heat pumps. (Object names: HeatPump:WaterToWater:EIR:Cooling \& HeatPump:WaterToWater:EIR:Heating). In general, these heat pump objects are treated the same as the other heat pump models by the plant loop.  Even though a heat pump is generally a single load coil and a single source coil with a reversing valve, in EnergyPlus, the paradigm is to split the operation into two separate coils, a heating and a cooling.  It is certainly possible to connect the load side of both of these to a single plant loop if the controls are established properly.  The source side of the coils are often placed on a single loop with some form of condensing supply, either a ground loop heat exchanger or a cooling tower (or a combination of the two).
 
-Note that this component is currently a constant flow device (it will always request its full design flow from the plant), with a future addition to make it respond to outlet setpoint in order to vary the flow request.
+Note that this component is currently a constant flow device (it will always request its full design flow from the plant), with a future addition planned to make it respond to outlet setpoint in order to vary the flow request.
 
-The bookkeeping part of the heat pump code with regards to flow requests and nodal conditions is identical to other components, so this section will only briefly discuss the mathematical formulation of the model.
+The bookkeeping part of the heat pump code with regards to flow requests and nodal conditions is identical to other water-to-water heat pump components, so this section will only briefly discuss the mathematical formulation of the model.
 
 Once load and source flow rates have been established for the component using the SetComponentFlowRate interface to the plant, and inlet temperatures for each side have been read, a function calculates the response of the unit to these conditions.  The process to evaluate the outlet state is as follows:
 
 \begin{enumerate}
 	\item Retrieve load side outlet temperature setpoint
+    \item Take the reference power usage as $P_{reference}$
 	\item Evaluate the capacity modifier function using the source inlet temperature and the load side setpoint temperature as the projected outlet temperature ($f_{cap} = f(T_{out,load,set}, T_{in,src}) $)
 	\item Calculate available load side capacity using the reference value and the modifier ($\dot{q}_{load,avail} = \dot{q}_{reference} \cdot f_{cap}$)
 	\item Calculate the part load ratio using the current plant-dispatched load (constrained between zero and one) ($PLR = \frac{\dot{q}_{plant}}{\dot{q}_{avail}}$)

doc/input-output-reference/src/overview/group-plant-equipment.tex

@@ -4442,8 +4442,14 @@ \subsection{Water to Water Heat Pumps}\label{water-to-water-heat-pumps}
 
 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 \href{http://www.hvac.okstate.edu}{http://www.hvac.okstate.edu/})
 
+\textbf{HeatPump:WaterToWater:EIR:Cooling}
+
+\textbf{HeatPump:WaterToWater:EIR:Heating}
+
 Beginning with version 9.1, an EIR-formulated water-to-water heat pump model was added.  This formulation allows the user to enter curves for specifying the capacity and energy usage in a more generic way, allowing the curves to be applicable to a wide variety of components.  With the original equation fit model, the curve form was locked in to a specific set of linear coefficients.  With the new form, the curve can be a quadratic function of temperatures, or an even more generic lookup table.
 
+\textbf{Configuration}
+
 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.
 
 \begin{figure}[hbtp] % fig 75
@@ -5075,35 +5081,35 @@ \subsubsection{Inputs}\label{wwhpeir_inputs}
 
 \paragraph{Field: Load Side Reference Flow Rate}\label{wwhp_eir_inputs_load_side_flow}
 
-This autosizable field defines the reference load side flow rate for the coil.  This field is used as the nominal flow request for this heat pump unit during the simulation.  The units for this field are [m3/s].
+This autosizable field defines the reference load side flow rate for the heat pump.  This field is used as the nominal flow request for this heat pump unit during the simulation.  The units for this field are [m3/s].
 
 \paragraph{Field: Source Side Reference Flow Rate}\label{wwhp_eir_inputs_source_side_flow}
 
-This autosizable field defines the reference demand side flow rate for the coil.  This field is used as the nominal flow request for this heat pump unit during the simulation.  The units for this field are [m3/s].
+This autosizable field defines the reference source side side flow rate for the heat pump.  This field is used as the nominal flow request for this heat pump unit during the simulation.  The units for this field are [m3/s].
 
 \paragraph{Field: Reference Capacity}\label{wwhp_eir_inputs_reference_capacity}
 
-This autosizable field defines the reference load side heat capacity for the coil.  Cooling capacity for a cooling coil and heating capacity for a heating coil.  The units for this field are [W].
+This autosizable field defines the reference load side heat capacity for the heat pump.  Cooling capacity for a cooling companion heat pump and heating capacity for a heating companion heat pump.  The units for this field are [W].
 
 \paragraph{Field: Reference Coefficient of Performance}\label{wwhp_eir_inputs_reference_cop}
 
-This field contains the reference COP for this unit, which is used when calculating the power required for the coil under simulation conditions.  The COP is defined as the load side energy transfer divided by the power input, with dimensionless units of [W/W].
+This field contains the reference COP for this unit, which is used when calculating the power required for the heat pump under simulation conditions.  The COP is defined as the load side energy transfer divided by the power input, with dimensionless units of [W/W].
 
 \paragraph{Field: Sizing Factor}\label{wwhp_eir_inputs_sizing_factor}
 
 This field allows the user to scale the sizing of this unit compared to the plant-determined autosized flow and heat capacity.
 
 \paragraph{Field: Capacity Modifier Function of Temperature Curve Name}\label{wwhp_eir_inputs_capft}
 
-This field is the name of a bivariate curve that defines an available capacity modifier of the unit as a function of the load side outlet temperature and the source side inlet temperature.
+This field is the name of a bivariate curve or table that defines an available capacity modifier of the unit as a function of the load side outlet temperature and the source side inlet temperature.  The temperatures are in degrees Celsius when used in the function and the output of the function is multiplied by the reference capacity to get a current available capacity.
 
 \paragraph{Field: Electric Input to Output Ratio Modifier Function of Temperature Curve Name}\label{wwhp_eir_inputs_eirft}
 
-This field is the name of a bivariate curve that defines an EIR (1/COP) modifier as a function of the load side outlet temperature and the source side inlet temperature.
+This field is the name of a bivariate curve or table that defines an EIR (1/COP) modifier as a function of the load side outlet temperature and the source side inlet temperature.  The temperatures are in degrees Celsius when used in the function. The output of this function and the output of the EIR Modifier Function of PLR are multiplied by the reference EIR to get a current EIR .
 
 \paragraph{Field: Electric Input to Output Ratio Modifier Function of Part Load Ratio Curve Name}\label{wwhp_eir_inputs_eirfplr}
 
-This field is the name of a univariate curve that defines an EIR modifier as a function of the current part load ratio.
+This field is the name of a univariate curve or table that defines an EIR modifier as a function of the current part load ratio.  The output of this function and the output of the EIR Modifier Function of Temperature are multiplied by the reference EIR to get a current EIR .
 
 An idf example:
 

idd/Energy+.idd.in

@@ -69946,7 +69946,7 @@ HeatPump:WaterToWater:EIR:Cooling,
         \min-fields 15
    A1,  \field Name
         \type alpha
-        \reference WWHPHeatingNames
+        \reference WWHPCoolingNames
         \required-field
         \reference-class-name validPlantEquipmentTypes
         \reference validPlantEquipmentNames
@@ -69965,10 +69965,10 @@ HeatPump:WaterToWater:EIR:Cooling,
         \required-field
         \type node
    A6,  \field Companion Heat Pump Name
-		\note This field allows the user to specify a companion heating
-		\note object for this cooling object.  The companion is used in
-		\note sizing the heat pump as well as to allow checks for unexpected
-		\note simultaneous operation of the two objects.
+        \note This field allows the user to specify a companion heating
+        \note object for this cooling object.  The companion is used in
+        \note sizing the heat pump as well as to allow checks for unexpected
+        \note simultaneous operation of the two objects.
    N1,  \field Load Side Reference Flow Rate
         \note This component is currently a constant-flow device, meaning it will always
         \note try to request the full design flow from the central plant manager.
@@ -69978,19 +69978,22 @@ HeatPump:WaterToWater:EIR:Cooling,
         \units m3/s
         \ip-units gal/min
         \autosizable
+        \default autosize
    N2,  \field Source Side Reference Flow Rate
         \required-field
         \type real
         \minimum> 0.0
         \units m3/s
         \ip-units gal/min
         \autosizable
+        \default autosize
    N3,  \field Reference Capacity
         \required-field
         \type real
         \minimum> 0.0
         \units W
         \autosizable
+        \default autosize
    N4,  \field Reference Coefficient of Performance
         \required-field
         \type real
@@ -70004,31 +70007,28 @@ HeatPump:WaterToWater:EIR:Cooling,
         \minimum> 0.0
         \default 1.0
    A7,  \field Capacity Modifier Function of Temperature Curve Name
-        \note Cooling capacity as a function of CW supply temp and entering condenser temp
+        \note Cooling capacity modifier as a function of CW supply temp and entering condenser temp
         \required-field
         \type object-list
-        \object-list BiquadraticCurves
-        \object-list BiVariateTables
+        \object-list BivariateFunctions
         \note curve = a + b*CWS + c*CWS**2 + d*ECT + e*ECT**2 + f*CWS*ECT
         \note CWS = supply (leaving) chilled water temperature(C)
         \note ECT = entering condenser fluid temperature(C)
    A8,  \field Electric Input to Output Ratio Modifier Function of Temperature Curve Name
-        \note Electric Input Ratio (EIR) as a function of temperature
+        \note Electric Input Ratio (EIR) modifier as a function of temperature
         \note EIR = 1/COP
         \required-field
         \type object-list
-        \object-list BiquadraticCurves
-        \object-list BiVariateTables
+        \object-list BivariateFunctions
         \note curve = a + b*CWS + c*CWS**2 + d*ECT + e*ECT**2 + f*CWS*ECT
         \note CWS = supply (leaving) chilled water temperature(C)
         \note ECT = entering condenser fluid temperature(C)
    A9;  \field Electric Input to Output Ratio Modifier Function of Part Load Ratio Curve Name
-        \note Electric Input Ratio (EIR) as a function of Part Load Ratio (PLR)
+        \note Electric Input Ratio (EIR) modifier as a function of Part Load Ratio (PLR)
         \note EIR = 1/COP
         \required-field
         \type object-list
-        \object-list UniVariateCurves
-        \object-list UniVariateTables
+        \object-list UniVariateFunctions
         \note quadratic curve = a + b*PLR + c*PLR**2 is typical, other univariate curves may be used
         \note PLR = part load ratio (cooling load/steady state capacity)
 
@@ -70056,10 +70056,10 @@ HeatPump:WaterToWater:EIR:Heating,
         \required-field
         \type node
    A6,  \field Companion Heat Pump Name
-		\note This field allows the user to specify a companion cooling
-		\note object for this heating object.  The companion is used in
-		\note sizing the heat pump as well as to allow checks for unexpected
-		\note simultaneous operation of the two objects.
+        \note This field allows the user to specify a companion cooling
+        \note object for this heating object.  The companion is used in
+        \note sizing the heat pump as well as to allow checks for unexpected
+        \note simultaneous operation of the two objects.
         \type object-list
         \object-list WWHPCoolingNames
    N1,  \field Load Side Reference Flow Rate
@@ -70071,19 +70071,22 @@ HeatPump:WaterToWater:EIR:Heating,
         \units m3/s
         \ip-units gal/min
         \autosizable
+        \default autosize
    N2,  \field Source Side Reference Flow Rate
         \required-field
         \type real
         \minimum> 0.0
         \units m3/s
         \ip-units gal/min
         \autosizable
+        \default autosize
    N3,  \field Reference Capacity
         \required-field
         \type real
         \minimum> 0.0
         \units W
         \autosizable
+        \default autosize
    N4,  \field Reference Coefficient of Performance
         \required-field
         \type real
@@ -70097,31 +70100,28 @@ HeatPump:WaterToWater:EIR:Heating,
         \minimum> 0.0
         \default 1.0
    A7,  \field Capacity Modifier Function of Temperature Curve Name
-        \note Heating capacity as a function of CW supply temp and entering condenser temp
+        \note Heating capacity modifier as a function of CW supply temp and entering condenser temp
         \required-field
         \type object-list
-        \object-list BiquadraticCurves
-        \object-list BiVariateTables
+        \object-list BivariateFunctions
         \note curve = a + b*CWS + c*CWS**2 + d*ECT + e*ECT**2 + f*CWS*ECT
         \note CWS = supply (leaving) hot water temperature(C)
         \note ECT = entering condenser fluid temperature(C)
    A8,  \field Electric Input to Output Ratio Modifier Function of Temperature Curve Name
-        \note Electric Input Ratio (EIR) as a function of temperature
+        \note Electric Input Ratio (EIR) modifier as a function of temperature
         \note EIR = 1/COP
         \required-field
         \type object-list
-        \object-list BiquadraticCurves
         \object-list BiVariateTables
         \note curve = a + b*CWS + c*CWS**2 + d*ECT + e*ECT**2 + f*CWS*ECT
         \note CWS = supply (leaving) hot water temperature(C)
         \note ECT = entering condenser fluid temperature(C)
    A9;  \field Electric Input to Output Ratio Modifier Function of Part Load Ratio Curve Name
-        \note Electric Input Ratio (EIR) as a function of Part Load Ratio (PLR)
+        \note Electric Input Ratio (EIR) modifier as a function of Part Load Ratio (PLR)
         \note EIR = 1/COP
         \required-field
         \type object-list
-        \object-list UniVariateCurves
-        \object-list UniVariateTables
+        \object-list UnivariateFunctions
         \note quadratic curve = a + b*PLR + c*PLR**2 is typical, other univariate curves may be used
         \note PLR = part load ratio (hot load/steady state capacity)
 

src/EnergyPlus/HeatPumpWaterToWaterSimple.cc

@@ -764,7 +764,7 @@ namespace HeatPumpWaterToWaterSimple {
 
             if (this->WWHPPlantTypeOfNum == TypeOf_HPWaterEFHeating) {
                 rho = GetDensityGlycol(
-                    PlantLoop(this->LoadLoopNum).FluidName, DataGlobals::CWInitConvTemp, PlantLoop(this->LoadLoopNum).FluidIndex, RoutineName);
+                    PlantLoop(this->LoadLoopNum).FluidName, DataGlobals::HWInitConvTemp, PlantLoop(this->LoadLoopNum).FluidIndex, RoutineName);
                 this->LoadSideDesignMassFlow = this->RatedLoadVolFlowHeat * rho;
                 rho = GetDensityGlycol(
                     PlantLoop(this->SourceLoopNum).FluidName, DataGlobals::CWInitConvTemp, PlantLoop(this->SourceLoopNum).FluidIndex, RoutineName);
@@ -774,7 +774,7 @@ namespace HeatPumpWaterToWaterSimple {
                     PlantLoop(this->LoadLoopNum).FluidName, DataGlobals::CWInitConvTemp, PlantLoop(this->LoadLoopNum).FluidIndex, RoutineName);
                 this->LoadSideDesignMassFlow = this->RatedLoadVolFlowCool * rho;
                 rho = GetDensityGlycol(
-                    PlantLoop(this->SourceLoopNum).FluidName, DataGlobals::CWInitConvTemp, PlantLoop(this->SourceLoopNum).FluidIndex, RoutineName);
+                    PlantLoop(this->SourceLoopNum).FluidName, DataGlobals::HWInitConvTemp, PlantLoop(this->SourceLoopNum).FluidIndex, RoutineName);
                 this->SourceSideDesignMassFlow = this->RatedSourceVolFlowCool * rho;
             }