Documentation Issues - 2017

[mjwitte]

• E+ I/O document V8.6 pages 769-770 describes "1.21.8.1.10 Field: Electric Input to Cooling Output Ratio Function of Temperature Curve Name" where at the early part of the paragraph it says "For the type of LeavingCondenserWaterTemperature, the curve object type should be Curve:Bicubic or Table:TwoIndependentVariables 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. " (yes, I am using leaving condenser water temperature). But near the end of the paragraph it says "The biquadratic curve should be valid for the range of water temperatures anticipated for the simulation (otherwise the program issues warning messages)." (from helpdesk ticket 11860).

The last sentence should read
"The bicubic curve should be valid for the range of water temperatures and part-load ratios anticipated for the simulation (otherwise the program issues warning messages)."

Addressed in Pull Request 160251551_Issue#5997

[mjwitte]

• I/O Reference, v8.6 p 1110, Table 1.40 "Value of opening factor multiplier for different venting conditions.", table alignment is messed up. Table should be like this (from v8.2 docs):
  

Addressed in Pull Request 160251551_Issue#5997

[mjwitte]

• Reference discussion on unmethours, the section about energyplus.log should be removed. At least on Windows, that file has not been saved for quite some time now. Check the full set of docs for other references to a .log output.

Addressed in Pull Request 160251551_Issue#5997

[mjwitte]

• par. 5.3.2 in the Engineering Reference, after equation 5.23 where it says
  "Rhorizon and Rdome are calculated once for each surface since they are independent of sun position."

This is out of date, and should read:
If the Sky Diffuse Modeling Algorithm (ShadowCalculation object) is set to SimpleSkyDiffuseModeling, then Rhorizon and Rdome are calculated once for each surface since they are independent of sun position. If the Sky Diffuse Modeling Algorithm is set to DetailedSkyDiffuseModeling, then Rhorizon and Rdome are calculated every timestep for each surface."

Addressed in Pull Request 160251551_Issue#5997

[mjwitte]

• Engineering Ref (v8.7.0) pdf p. 1086, text is running off the bottom of the page. Not sure how much is missing before the next page starts.

• This issue does not exist in V8.9 pdf (see pages 1047-1048) no need to address.

[JasonGlazer]

• Output:IlluminanceMap should indicate that it is only valid when used with SplitFlux daylighting method.

Addressed in Pull Request 160251551_Issue#5997

[mjwitte]

• p. 97 of the Engineering Reference the equation numbers are missing in the description of the DOE-2 convection algorithm
  "hn is calculated using Equation or Equation ." (helpdesk ticket 12090)
  Based on the v8.2 engineering rerefence, the equation numbers here should be references to the current equations 3.74 and 3.75.

Addressed in Pull Request 160251551_Issue#5997

[aaron-boranian]

• In both the Input-Output Reference and Engineering Reference documentation for the AirConditioner:VariableRefrigerantFlow object, discussion of the condenser entering node conditions only refers to outdoor air dry-bulb temperature. This may confuse users who want to model water- or evaporatively-cooled VRF systems.

• Input-Output Reference for Cooling Capacity Ratio Modifier Function of Low Temperature Curve Name input field of AirConditioner:VariableRefrigerantFlow object.

• Engineering Reference for Cooling Capacity Ratio Modifier Function of Low Temperature Curve Name input field of AirConditioner:VariableRefrigerantFlow object.

• Related UnmetHours question

Addressed in Pull Request 160251551_Issue#5997

[mjwitte]

• In the I/O Ref, ZoneHVAC:IdealLoadsAirSystem outputs, the Ideal Loads Output Variable Overview should include the caveats that the outdoor air load is only calculated when there is active heating or cooling (or humidification/dehumidification). This is stated later on in the individual output descriptions, but it should be stated here as well, probably several places here, including before the equation. (helpdesk ticket 12105)

Addressed in Pull Request 160251551_Issue#5997

[mjwitte]

• I/O Ref section for HybridModel:Zone is not in the pdf. The source files were added in Hybrid Zone Model #5882 but there's no line in overview.tex to input the new file into the document?

• This object/model was first introduced in V8.7

Posted new issue #6947 for this.

[mjwitte]

• Typo in Engineering Reference section for Ground Heat Transfer Calculations using Site:GroundDomain:Slab, subsection heading "Boudary Conditions".

Addressed in Pull Request 160251551_Issue#5997

[aaron-boranian]

• Typo in EMS Application Guide for Hydronic Low Temp Radiant Design Water Mass Flow Rate for Cooling internal variable: 'The internal variable called “Hydronic Low Temp Radiant Design Water Mass Flow Rate for Heating” provides ... '

Addressed in Pull Request 160251551_Issue#5997

[mjwitte]

• In the Auxiliary Programs document, the example def files for the Weather Converter show backslashes and underscores in many places. These should not be in the final pdf.

The underscore appears everywhere in the documentation where "\begin{lstlisting} ... \end{lstlisting}" is used as designed. It is OK as is.

[aaron-boranian]

• In both the Input-Output Reference and Engineering Reference documentation for the SetpointManager:OutdoorAirReset object, discussion of the supply temperature being controlled is only for air systems. However, there are example files that use this object to reset plant systems as well (5ZoneBoilerOutsideAirReset.idf, 5ZoneWaterSystems.idf). This option to reset plant systems using the outdoor air reset SPM object should be part of the documentation.

• Input-Output Reference for SetpointManager:OutdoorAirReset object.

• Engineering Reference for SetpointManager:OutdoorAirReset object.

• I/O Ref document is already updated (addressed missing OutdoorAir Restet SPM use in plant loops in Eng. Ref. document)

Addressed in Pull Request 160251551_Issue#5997

[aaron-boranian]

• IDF example in Input-Output Reference section for the Exterior:WaterEquipment object isn't displaying as code blocks like other IDF examples.

• Description of last output variable "Exterior Equipment Mains Water Volume" in Input-Output Reference section for the Exterior:WaterEquipment object isn't displaying correctly (looks like there is no space between variable unit and description).

Addressed in Pull Request 160251551_Issue#5997

[aaron-boranian]

• Typo in Table 2.3: Operators for Erl: "*" multiplication symbol doesn't appear in Operator Symbol column at left of table (see below). Maybe it's being interpreted as a bad symbol (missing a \ to escape)?

• Typo in code block for compound expressions following Table 2.3: using "*" for multiplication symbol (see below). Should remove \ since don't need to escape characters in code block.

Addressed in Pull Request 160251551_Issue#5997

[MatthewSteen]

• Typo in IO Ref for ZoneHVACFourPipeFanCoil 2nd paragraph, 1st sentence looks like it should read...

The heating or cooling output of the unit ventilator fan coil unit 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. (source code)

---

#5997 (reference)

Included Matthew's fix here 160251551_Issue#5997.

[aaron-boranian]

• There are multiple differences between what the EMS Application Guide claims that actuators contain as control types and what the EDD file shows as available actuator info. EMS Application Guide should be consistent with EDD file.
  • Update "Mass Flow Rate Minimum Setpoint" to "Mass Flow Rate Minimum Available Setpoint"
  • Update "Mass Flow Rate Maximum Setpoint" to "Mass Flow Rate Maximum Available Setpoint"
  • Add "Pump Pressure Rise" (missing from documentation)

This is not an exhaustive list.
Addressed in Pull Request 160251551_Issue#5997

[aaron-boranian]

• The "Zone Component Load Summary" output table report contains information for individual heat transfer components contributing to design day sizing calculations for heating and cooling. However, there aren't definitions or equations in the Input/Output Reference or Engineering Reference to help users know what the components represent or how the components are calculated. This should be included since users can get confused about what different heat gain components represent (infiltration vs zone ventilation, e.g.). Users should also be able to see how it's calculated for their own output processing purposes.

Posted new issue here.

[JasonGlazer]

@aaron-boranian the Engineering Reference includes a section on the Zone Component Loads Summary report already here. What further clarification is needed in that section?

[aaron-boranian]

@JasonGlazer that section essentially just lists all the load components, but doesn't define them. For example, new users or energy modelers may not be familiar with the difference between infiltration, ventilation, and zone mixing load components. It would be nice to include equations that explicitly show how each load component is calculated.

[JasonGlazer]

• Remove references to FORTRAN in the Engineering Reference

[JasonGlazer]

• In the IORef, for Refrigeration:Compressor, the following fields are not documented
• Mode of Operation
• Transcritical Compressor Power Curve Name
• Transcritical Compressor Capacity Curve Name

Addressed in Pull Request 160251551_Issue#5997

[mjwitte]

• From helpdesk ticket 12319, I/O Ref, WaterUse:Equipment, incorrectly references inlet/outlet nodes. This should say if the WaterUse:Equipment is included in a WaterUse:Connections object, blah blah blah.

"1.53.1.2.17 Water Use Equipment Heating Energy [J]
The heating energy accumulated by the heating rate above, in units of Joules (J). This output
is also added to a meter with End Use Key = WaterSystems, Group Key = Plant. If both of the
node names specified in the WaterUse:Equipment object are blank, then this output is reported
with Resource Type = DistrictHeating. If either of the node names are entered, then this output
is reported with Resource Type = EnergyTransfer. The sub-categories may be entered as any
type (e.g., Laundry, Dish Washing, etc. defined in WaterUse:Equipment object input for End-Use
Subcategory) with General being the default sub-category (ref. Output Meter)"

Addressed in Pull Request 160251551_Issue#5997

[JasonGlazer]

• In the AuxiliaryPrograms.pdf documentation, the section on HVAC Diagram is 7.8, which is a continuation of the section on Input Macros (EP-Macro). It should really be its own chapter just like all the other utility programs. It should probably be Chapter 8 and the rest of the chapters renumbered.

Addressed in Pull Request 160251551_Issue#5997

[mjwitte]

• Documentation should be clarified regarding the ecoroof model. Both the I/O Ref and Engineering Ref mention using the eco model with conduction finite difference is "under development". But that isn't true. Running econroof with CondFD produces this warning:
  ** Warning ** CalcEcoRoof: EcoRoof simulation but HeatBalanceAlgorithm is not ConductionTransferFunction(CTF). Has not been tested under other solution approaches.
  Maybe that should be changed to a severe/fatal?
  Helpdesk ticket 12333.

Addressed in Pull Request 160251551_Issue#5997

[MatthewSteen]

• Typo in the Life-Cycle Cost Computations section of the ER.

Step 4. Put the nonrecurring, nonrecurring, and utility costs into a monthly array for the entire length of the study period.

should be:

Step 4. Put the nonrecurring, recurring, and utility costs into a monthly array for the entire length of the study period.

---

#5997 (reference)
Included Matthew's fix here 160251551_Issue#5997.

[JasonGlazer]

• The CurrencyType object is not shown in the table of contents and is just shown as a subsection to the LifeCycleCost:UseAdjustment object. It should be promoted to show in the table of contents to make it easier for people to find.

• The link to the iso.org page in the CurrencyType documentation is broken and should be replaced.

Addressed in Pull Request 160251551_Issue#5997

[JasonGlazer]

• the "Web Resources" section of the Weather Converter Program in Auxiliary Programs should have updated links.

Addressed in Pull Request 160251551_Issue#5997

[MatthewSteen]

Pump:VariableSpeed IO documentation

• Field: Design Pump Head

This numeric field contains the pump's rated design head pressure in Pascals. The default is 179352 Pa, or 60 ftH20, and is for a fairly large building.

• Field: Motor Efficiency

This numeric field contains the pump 's motor's efficiency in decimal form (0 = 0%, 1 = 100%).

Pump:ConstantSpeed IO documentation

• Field: Design Power Consumption

This numeric field contains the pump’s rated design 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. This field can be autosized. When set to autosize the type of scaling factor is chosen in the input field Design Power Sizing Method.

• Field: Motor Efficiency

This numeric field contains the pump 's motor's efficiency in decimal form (0 = 0%, 1 = 100%).

---

#5997 (reference)
Included Matthew's fix here 160251551_Issue#5997.

[Nigusse]

@mjwitte @Myoldmopar All but two issues listed in this documentation are addressed. Two of the issues should be addressed separately (each) and posted two new issues here and here.

[Nigusse]

@JasonGlazer I think the "Zone Component Load Summary" issue listed above warrants a separate issue by itself. What do you think?

[JasonGlazer]

@Nigusse Sure, although I still believe that the section in the engineering reference that describes the Zone Component Loads Summary is sufficient for understanding how it works.

[Nigusse]

@JasonGlazer @mjwitte @Myoldmopar I will post a separate issue for "Zone Component Load Summary" calculation definitions or equations request as a place holder for next release consideration.

[Nigusse]

@mjwitte @Myoldmopar The only issue remaining now is
"- [ ] In the Auxiliary Programs document, the example def files for the Weather Converter show backslashes and underscores in many places. These should not be in the final pdf."

The underscore appears everywhere in the documentation where "\begin{lstlisting} ... \end{lstlisting}" listing template is used. I think this is a a standard template in LaTex mainly used to add code snippet to a documentation as described here. I don't know enough if we can customize it to remove the underscore.

[mjwitte]

@Nigusse I'm confused. I don't see any problems in the current Auxiliary Programs doc def file listings. Even going back several releases. I don't know what prompted me to post this comment.

[Nigusse]

@mjwitte Ok. Thanks. I will mark it as designed.

[Myoldmopar]

Closed by #6946