Update docs

doc/engineering-reference/src/building-system-simulation-system-manager/plant-load-profile.tex

@@ -6,7 +6,9 @@ \section{Plant Load Profile}\label{plant-load-profile}
 
 \subsection{Calculation Model}\label{calculation-model}
 
-The LoadProfile:Plant object calculates the outlet water temperature based on the inlet water temperature from the plant loop and user inputs for the scheduled plant load and the requested flow rate.~ The calculation can be expressed with the equation:
+\subsubsection{Plant Load Profile in the Water Loop}\label{plant-load-profile-in-the-water-loop}
+
+The LoadProfile:Plant object in the water loop calculates the outlet water temperature based on the inlet water temperature from the plant loop and user inputs for the scheduled plant load and the requested flow rate.~ The calculation can be expressed with the equation:
 
 \begin{equation}
 {T_{out}} = {T_{in}} - \frac{{{Q_{load}}}}{{\dot m{c_p}}}
@@ -41,3 +43,24 @@ \subsection{Calculation Model}\label{calculation-model}
 \({Q_{load}}\) ~ = the scheduled plant load
 
 \(\Delta t\) ~ = the time step interval
+
+
+\subsubsection{Plant Load Profile in the Steam Loop}\label{plant-load-profile-in-the-steam-loop}
+
+The LoadProfile:Plant object in the steam loop calculates the outlet steam flow rate based on the inlet condensate temperature from the plant loop and user inputs for the scheduled plant load.~ This model accounts for the latent heat transfer and sensible cooling of water.~ Steam enters the load profile component at quality equal to 1.0, at saturation temperature and leaves the load profile component with desired degree of sub cooling.~ The user inputs the desired degree of subcooling, which determines the condensate outlet condition from the load profile component.~ The calculation can be expressed with the equation:
+
+\begin{equation}
+{\dot m_{out}}\,\,\,\, = \,\,\,\,\,\frac{{{Q_{load}}}}{{{h_{fg}} + {c_{p,condensate}} \times \Delta {T_{sc}}}}
+\end{equation}
+
+where
+
+\({\dot m_{out}}\) ~ = the outlet steam mass flow rate
+
+\({Q_{load}}\) ~ = the scheduled plant load
+
+\({h_{fg}}\) ~ = the steam latent heat of vaporization
+
+\({ \Delta {T_{sc}}}\) ~ = the temperature difference between saturation temperature and condensate temperature
+
+\({c_{p,condensate}}\) ~ = the condensate heat capacity

doc/engineering-reference/src/simulation-models-encyclopedic-reference-003/district-heating.tex

@@ -1,3 +1,3 @@
 \section{District Heating }\label{district-heating}
 
-When the user is not interested in a plant simulation or there is some centralized source of hot water, the following model can be used in the input.~ This allows the user to achieve a simulation without specifying operating parameters or curve fits for boiler models.~ This model only needs the connections to the loop and the nominal capacity to simulate.~ See the InputOutput Reference for additional information (Object: DistrictHeating).~ This model calculates the output capacity necessary from the inlet temperature to the setpoint temperature for that loop with the given mass flow rate in Watts.
+When the user is not interested in a plant simulation or there is some centralized source of hot water, the following model can be used in the input.~ This allows the user to achieve a simulation without specifying operating parameters or curve fits for boiler models.~ This model only needs the connections to the loop and the nominal capacity to simulate.~ See the InputOutput Reference for additional information (Object: DistrictHeating:Water and DistrictHeating:Steam).~ DistrictHeating:Water calculates the output capacity necessary from the inlet temperature to the setpoint temperature for that loop with the given mass flow rate in Watts.~ DistrictHeating:Steam the output capacity necessary from the inlet condensate to the saturated steam. 

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

@@ -38,17 +38,30 @@ \subsubsection{Inputs}\label{inputs-028}
 
 Reference to the schedule object specifying the flow rate fraction relative to the value in the field Peak Flow Rate (above).
 
+\paragraph{Field: Plant Loop Fluid Type}\label{field-plant-loop-fluid-type}
+
+The fluid type of the plant loop; water or steam.
+
+\paragraph{Field: Degree of SubCooling}\label{field-degree-of-subcooling-load-profile}
+
+This field is used only when Plant Loop Fluid Type=Steam. The minimum value is 1$^\circ$ Celsius and default is 5$^\circ$ Celsius.
+
+\paragraph{Field: Degree of Loop SubCooling}\label{field-degree-of-loop-subcooling-load-profile}
+
+This field is used only when Plant Loop Fluid Type=Steam. The minimum value is 2$^\circ$ Celsius and default is 5$^\circ$ Celsius.
+
 An example of this object follows.
 
 \begin{lstlisting}
 
 LoadProfile:Plant,
-  Load Profile 1,                                         !- Name
-  Demand Load Profile 1 Inlet Node,     !- Inlet Node Name
-  Demand Load Profile 1 Outlet Node,   !- Outlet Node Name
-  Load Profile 1 Load Schedule,             !- Load Schedule Name {W}
-  0.003,                                                           !- Peak Flow Rate {m3/s}
-  Load Profile 1 Flow Frac Schedule;   !- Flow Rate Fraction Schedule Name
+  Load Profile 1,                               !- Name
+  Demand Load Profile 1 Inlet Node,    !- Inlet Node Name
+  Demand Load Profile 1 Outlet Node,  !- Outlet Node Name
+  Load Profile 1 Load Schedule,           !- Load Schedule Name {W}
+  0.003,                                         !- Peak Flow Rate {m3/s}
+  Load Profile 1 Flow Frac Schedule,     !- Flow Rate Fraction Schedule Name
+  Water;                                        !-Plant Loop Fluid Type
 \end{lstlisting}
 
 \subsubsection{Outputs}\label{outputs-020}
@@ -66,6 +79,8 @@ \subsubsection{Outputs}\label{outputs-020}
   HVAC,Sum,Plant Load Profile Heating Energy {[}J{]}
 \item
   HVAC,Sum,Plant Load Profile Cooling Energy {[}J{]}
+\item
+  HVAC,Average,Plant Load Profile Steam Outlet Temperature {[}J{]}
 \end{itemize}
 
 \paragraph{Plant Load Profile Mass Flow Rate {[}kg/s{]}}\label{plant-load-profile-mass-flow-rate-kgs}
@@ -82,6 +97,8 @@ \subsubsection{Outputs}\label{outputs-020}
 
 These report the overall cooling or heating energy that the load profile object places on the plant loop, in Joules.
 
+\paragraph{Plant Load Profile Steam Outlet Temperature {[}C{]}}\label{plant-load-profile-steam-outlet-temperature-c}
+
 The inlet and outlet node temperatures and mass flow rates can be monitored using the system node output variables:
 
 \begin{itemize}

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

@@ -6129,44 +6129,40 @@ \subsubsection{Outputs}\label{outputs-14-003}
 
 \begin{itemize}
     \item
-    HVAC,Average, District Cooling Chilled Water Rate {[}W{]}
+    HVAC,Average, District Cooling Water Rate {[}W{]}
     \item
-    HVAC,Sum, District Cooling Chilled Water Energy {[}J{]}
+    HVAC,Sum, District Cooling Water Energy {[}J{]}
     \item
     Zone,Meter, DistrictCooling:Plant {[}J{]}
     \item
     Zone,Meter,Cooling: DistrictCooling {[}J{]}
     \item
-    HVAC,Average,District Cooling Rate {[}W{]}
+    HVAC,Average,District Cooling Water Inlet Temperature {[}C{]}
     \item
-    HVAC,Average,District Cooling Inlet Temperature {[}C{]}
+    HVAC,Average,District Cooling Water Outlet Temperature {[}C{]}
     \item
-    HVAC,Average,District Cooling Outlet Temperature {[}C{]}
-    \item
-    HVAC,Average,District Cooling Mass Flow Rate {[}kg/s{]}
+    HVAC,Average,District Cooling Water Mass Flow Rate {[}kg/s{]}
 \end{itemize}
 
-\paragraph{District Cooling Chilled Water Rate {[}W{]}}\label{district-cooling-chilled-water-rate-w}
-
-\paragraph{District Cooling Chilled Water Energy {[}J{]}}\label{district-cooling-chilled-water-energy-j}
+\paragraph{District Cooling Water Rate {[}W{]}}\label{district-cooling-chilled-water-rate-w}
 
-These outputs are the energy taken from purchased chilled water. Consumption is metered on Cooling:DistrictCooling, DistrictCooling:Plant, and DistrictCooling:Facility.
+This is the useful rate of cooling energy from purchased chilled water. 
 
-\paragraph{District Cooling Rate {[}W{]}}\label{district-cooling-rate-w}
+\paragraph{District Cooling Water Energy {[}J{]}}\label{district-cooling-chilled-water-energy-j}
 
-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.
+These outputs are the energy taken from purchased chilled water. Consumption is metered on Cooling:DistrictCooling, DistrictCooling:Plant, and DistrictCooling:Facility.
 
-\paragraph{District Cooling Inlet Temperature {[}C{]}}\label{district-cooling-inlet-temperature-c}
+\paragraph{District Cooling Water Inlet Temperature {[}C{]}}\label{district-cooling-inlet-temperature-c}
 
-\paragraph{District Cooling Outlet Temperature {[}C{]}}\label{district-cooling-outlet-temperature-c}
+\paragraph{District Cooling WaterOutlet Temperature {[}C{]}}\label{district-cooling-outlet-temperature-c}
 
-\paragraph{District Cooling Mass Flow Rate {[}kg/s{]}}\label{district-cooling-mass-flow-rate-kgs}
+\paragraph{District Cooling Water Mass Flow Rate {[}kg/s{]}}\label{district-cooling-mass-flow-rate-kgs}
 
 These outputs are the supply-side plant loop chilled water inlet and outlet temperatures and mass flow rate.
 
-\subsection{DistrictHeating}\label{districtheating}
+\subsection{DistrictHeating:Water}\label{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.
+When the user is not interested in a plant simulation or there is some centralized source of hot water (district heating water), the following object can be used in the input.
 
 \subsubsection{Inputs}\label{inputs-17-006}
 
@@ -6203,41 +6199,96 @@ \subsubsection{Outputs}\label{outputs-15-002}
 
 \begin{itemize}
     \item
-    HVAC,Average,District Heating Hot Water Rate {[}W{]}
-    \item
-    HVAC,Sum,District Heating Hot Water Energy {[}J{]}
+    HVAC,Average,District Heating Water Rate {[}W{]}
     \item
-    Zone,Meter,DistrictHeating:Plant {[}J{]}
+    HVAC,Sum,District Heating Water Energy {[}J{]}
     \item
-    Zone,Meter,Heating:DistrictHeating {[}J{]}
+    Zone,Meter,DistrictHeatingWater:Plant {[}J{]}
     \item
-    HVAC,Average,District Heating Rate {[}W{]}
+    Zone,Meter,Heating:DistrictHeatingWater {[}J{]}
     \item
-    HVAC,Average,District Heating Inlet Temperature {[}C{]}
+    HVAC,Average,District Heating Water Inlet Temperature {[}C{]}
     \item
-    HVAC,Average,District Heating Outlet Temperature {[}C{]}
+    HVAC,Average,District Heating Water Outlet Temperature {[}C{]}
     \item
-    HVAC,Average,District Heating Mass Flow Rate {[}kg/s{]}
+    HVAC,Average,District Heating Water Mass Flow Rate {[}kg/s{]}
 \end{itemize}
 
-\paragraph{District Heating Hot Water Rate {[}W{]}}\label{district-heating-hot-water-rate-w}
-
-\paragraph{District Heating Hot Water Energy {[}J{]}}\label{district-heating-hot-water-energy-j}
+\paragraph{District Heating Water Rate {[}W{]}}\label{district-heating-hot-water-rate-w}
 
-These outputs are the energy taken from purchased hot water. Consumption is metered on Heating:DistrictHeating, DistrictHeating:Plant, and DistrictHeating:Facility.
+This is the useful rate of heating energy from purchased hot water.
 
-\paragraph{District Heating Rate {[}W{]}}\label{district-heating-rate-w}
+\paragraph{District Heating Water Energy {[}J{]}}\label{district-heating-hot-water-energy-j}
 
-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.
+These outputs are the energy taken from purchased hot water. Consumption is metered on Heating:DistrictHeatingWater, DistrictHeatingWater:Plant, and DistrictHeatingWater:Facility.
 
-\paragraph{District Heating Inlet Temperature {[}C{]}}\label{district-heating-inlet-temperature-c}
+\paragraph{District Heating Water Inlet Temperature {[}C{]}}\label{district-heating-inlet-temperature-c}
 
-\paragraph{District Heating Outlet Temperature {[}C{]}}\label{district-heating-outlet-temperature-c}
+\paragraph{District Heating Water Outlet Temperature {[}C{]}}\label{district-heating-outlet-temperature-c}
 
-\paragraph{District Heating Mass Flow Rate {[}kg/s{]}}\label{district-heating-mass-flow-rate-kgs}
+\paragraph{District Heating Water Mass Flow Rate {[}kg/s{]}}\label{district-heating-mass-flow-rate-kgs}
 
 These outputs are the supply-side plant loop hot water inlet and outlet temperatures and mass flow rate.
 
+\subsection{DistrictHeating:Steam}\label{districtheatingsteam}
+
+When the user is not interested in a plant simulation or there is some centralized source of steam (district heating steam), the following object can be used in the input.
+
+\subsubsection{Inputs}\label{inputs-17-006}
+
+\paragraph{Field: Name}\label{field-name-16-006}
+
+This alpha field contains the identifying name for the district heating steam (i.e., purchased steam).
+
+\paragraph{Field:Steam Inlet Node Name}\label{field-steam-inlet-node-name-2}
+
+This alpha field contains the identifying name for the district heating inlet node.
+
+\paragraph{Field: Steam Outlet Node Name}\label{field-steam-outlet-node-name-2}
+
+This alpha field contains the identifying name for the district heating outlet node.
+
+\paragraph{Field: Nominal Capacity}\label{field-nominal-capacity-12}
+
+This numeric field contains the nominal demand (W) that the district heating will meet. This field is autosizable.
+
+\paragraph{Field: Capacity Fraction Schedule Name}\label{field-capacity-fraction-schedule-name-2}
+
+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.
+
+\subsubsection{Outputs}\label{outputs-15-003}
+
+\begin{itemize}
+    \item
+    HVAC,Average,District Heating Steam Rate {[}W{]}
+    \item
+    HVAC,Sum,District Heating Steam Energy {[}J{]}
+    \item
+    Zone,Meter,DistrictHeatingSteam:Plant {[}J{]}
+    \item
+    Zone,Meter,Heating:DistrictHeatingSteam {[}J{]}
+    \item
+    HVAC,Average,District Heating Steam Inlet Temperature {[}C{]}
+    \item
+    HVAC,Average,District Heating Steam Outlet Temperature {[}C{]}
+    \item
+    HVAC,Average,District Heating Steam Mass Flow Rate {[}kg/s{]}
+\end{itemize}
+
+\paragraph{District Heating Steam Energy {[}J{]}}\label{district-heating-Steam-energy-j}
+
+These outputs are the energy taken from purchased steam. Consumption is metered on Heating:DistrictHeatingSteam, DistrictHeatingSteam:Plant, and DistrictHeatingSteam:Facility.
+
+\paragraph{District Heating Steam Rate {[}W{]}}\label{district-heating-steam-rate-w}
+
+This is the useful rate of heating energy from purchased steam.
+
+\paragraph{District Heating Steam Inlet Temperature {[}C{]}}\label{district-heating-steam-inlet-temperature-c}
+
+\paragraph{District Heating Steam Outlet Temperature {[}C{]}}\label{district-heating-steam-outlet-temperature-c}
+
+\paragraph{District Heating Steam Mass Flow Rate {[}kg/s{]}}\label{district-heating-steam-mass-flow-rate-kgs}
+
 \subsection{PlantComponent:TemperatureSource}\label{plantcomponenttemperaturesource}
 
 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 run-time.