Closed mjwitte closed 5 years ago
Addressed in Pull Request 160251551_Issue#5997
Addressed in Pull Request 160251551_Issue#5997
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
Addressed in Pull Request 160251551_Issue#5997
Addressed in Pull Request 160251551_Issue#5997
[x] 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.
Addressed in Pull Request 160251551_Issue#5997
Addressed in Pull Request 160251551_Issue#5997
[ ] I/O Ref section for HybridModel:Zone is not in the pdf. The source files were added in #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.
Addressed in Pull Request 160251551_Issue#5997
Addressed in Pull Request 160251551_Issue#5997
The underscore appears everywhere in the documentation where "\begin{lstlisting} ... \end{lstlisting}" is used as designed. It is OK as is.
[x] 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.
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
[x] IDF example in Input-Output Reference section for the Exterior:WaterEquipment object isn't displaying as code blocks like other IDF examples.
[x] 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
Addressed in Pull Request 160251551_Issue#5997
The heating or cooling output of the
unit ventilatorfan 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)
https://github.com/NREL/EnergyPlus/issues/5997#ref-commit-7724958
Included Matthew's fix here 160251551_Issue#5997.
This is not an exhaustive list. Addressed in Pull Request 160251551_Issue#5997
Posted new issue here.
@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?
@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.
Addressed in Pull Request 160251551_Issue#5997
"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
Addressed in Pull Request 160251551_Issue#5997
Addressed in Pull Request 160251551_Issue#5997
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.
https://github.com/NREL/EnergyPlus/issues/5997#ref-commit-7724958 Included Matthew's fix here 160251551_Issue#5997.
[x] 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.
[x] The link to the iso.org page in the CurrencyType documentation is broken and should be replaced.
Addressed in Pull Request 160251551_Issue#5997
Addressed in Pull Request 160251551_Issue#5997
Pump:VariableSpeed IO documentation
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.
This numeric field contains the pump ~'s~ motor's efficiency in decimal form (0 = 0\%, 1 = 100\%).
Pump:ConstantSpeed IO documentation
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.
This numeric field contains the pump ~'s~ motor's efficiency in decimal form (0 = 0\%, 1 = 100\%).
https://github.com/NREL/EnergyPlus/issues/5997#ref-commit-7724958 Included Matthew's fix here 160251551_Issue#5997.
@JasonGlazer I think the "Zone Component Load Summary" issue listed above warrants a separate issue by itself. What do you think?
@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.
@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.
@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.
@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.
@mjwitte Ok. Thanks. I will mark it as designed.
Closed by #6946
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