Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Major Cleanup of Baseboard Section of Engineering Reference #6318

Merged
merged 2 commits into from
Sep 19, 2017

Conversation

RKStrand
Copy link
Contributor

Pull request overview

Significant cleanup, corrections, reorganization, etc. of the baseboard documentation in the Engineering Reference. Lots of changes, many rewrites. Things are now standardized among the baseboard models, language clarified, equations checked and corrected. This section is much better than it was. This work was what GitHub Issue #3625 became.

Work Checklist

Add to this list or remove from it as applicable. This is a simple templated set of guidelines.

Review Checklist

This will not be exhaustively relevant to every PR.

  • Code style (parentheses padding, variable names)
  • Functional code review (it has to work!)
  • If defect, results of running current develop vs this branch should exhibit the fix
  • CI status: all green or justified
  • Performance: CI Linux results include performance check -- verify this
  • Unit Test(s)
  • C++ checks:
    • Argument types
    • If any virtual classes, ensure virtual destructor included, other things
  • IDD changes:
    • Verify naming conventions and styles, memos and notes and defaults
    • Open windows IDF Editor with modified IDD to check for errors
    • If transition, add rules to spreadsheet
    • If transition, add transition source
    • If transition, update idfs
  • If new idf included, locally check the err file and other outputs
  • Documentation changes in place
  • Changed docs build successfully
  • ExpandObjects changes?
  • If output changes, including tabular output structure, add to output rules file for interfaces

Significant cleanup, corrections, reorganization, etc. of the baseboard
documentation in the Engineering Reference.  Lots of changes, many
rewrites.  Things are now standardized among the baseboard models,
language clarified, equations checked and corrected.  This section is
much better than it was (hopefully).
@RKStrand RKStrand self-assigned this Sep 18, 2017
@RKStrand RKStrand requested a review from mjwitte September 18, 2017 03:46
@RKStrand
Copy link
Contributor Author

@mjwitte Not sure if me selecting you as a potential reviewer actually sends you an email or not, but I know that this will. I picked you because you have been involved in the discussion about this. I took the liberty of not just cleaning up the organization but going beyond that and giving the entire section a full review including many rewrites, edits, etc. If you have any questions, please let me know. If you need someone else to do this review, please let me know and I'll contact someone else or flip it to another name. Thanks!

Copy link
Member

@Myoldmopar Myoldmopar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I got a little nitpicky, but only on a couple of lines. It's only because this is now so much better than it was! If you can address those two little changes I'll verify they build OK and merge it in. Thanks @RKStrand !

@@ -130,19 +128,23 @@ \subsubsection{Simulation and Control}\label{simulation-and-control-2-000}
{T_{w,out}} = 2{T_{w,avg}} - {T_{w,in}}
\end{equation}

where \({c_{p,w}}\) ~is the specific heat capacity of the water.
where \({c_{p,w}}\) is the specific heat capacity the water (calculated based on the average water temperature).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

of the water

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Myoldmopar Another good catch--this is now also fixed. The changes you requested should now be up in GitHub.

@@ -1,24 +1,28 @@
\section{Baseboard Heaters }\label{baseboard-heaters}

\subsection{Hot Water Baseboard Heater with Only Convection}\label{hot-water-baseboard-heater-with-only-convection}
There are five different baseboard models in EnergyPlus. Two of these models are convection only while three of these models have both radiative and convective heat transfer to the zone. The hot water and electric baseboard models with only convection provide a simple convective heat gain to the space via the baseboard unit. The models for these convection only units are fairly simple and simply provide convective heating to the space in an attempt to meet whatever heating load is present. The convection only models do not require iteration or resimulation of the surface heat balances because it is assumed that there is no radiation given off by the unit.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fairly simple and simply provide

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Myoldmopar Good catch--this should now be fixed.

$\dot{m}_{a,std} = 0.0062 + .0000275 \dot{Q}_{design}$
\begin{equation}
\dot{m}_{a,std} = 0.0062 + .0000275 \dot{Q}_{design}
\end{equation}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Changes made to the documents as a result of the review comments.
Comments were addressed exactly as requested.
@Myoldmopar Myoldmopar added this to the EnergyPlus 8.8.0 milestone Sep 18, 2017
@Myoldmopar Myoldmopar merged commit d452514 into develop Sep 19, 2017
@Myoldmopar Myoldmopar deleted the 113837243-Baseboard-Eng-Ref-Enhancements branch September 19, 2017 12:37
@Myoldmopar Myoldmopar added the Defect Includes code to repair a defect in EnergyPlus label Sep 19, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Defect Includes code to repair a defect in EnergyPlus
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants