Corrected documentation of derivative approximation (#2996)

This closes #2993
lbl-srg · May 7, 2022 · 0ee6e8a · 0ee6e8a
1 parent 2912509
commit 0ee6e8a
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 3 deletions.
diff --git a/Buildings/Controls/OBC/CDL/Continuous/PID.mo b/Buildings/Controls/OBC/CDL/Continuous/PID.mo
@@ -564,7 +564,7 @@ that can reset the output should be used.
 The derivative of the control error <i>d &frasl; dt e(t)</i> is approximated using
 </p>
 <p align=\"center\" style=\"font-style:italic;\">
-d&frasl;dt x(t) = (e(t)-x(t)) T<sub>d</sub> &frasl; N<sub>d</sub>,
+d&frasl;dt x(t) = (e(t)-x(t)) N<sub>d</sub> &frasl; T<sub>d</sub>,
 </p>
 <p>
 and
@@ -625,6 +625,12 @@ American Society of Heating Refrigerating and Air-Conditioning Engineers Inc. At
  revisions="<html>
 <ul>
 <li>
+May 6, 2022, by Michael Wetter:<br/>
+Corrected wrong documentation in how the derivative of the control error is approximated.<br/>
+This is for
+<a href=\"https://github.com/lbl-srg/modelica-buildings/issues/2994\">issue 2994</a>.
+</li>
+<li>
 November 12, 2020, by Michael Wetter:<br/>
 Reformulated to remove dependency to <code>Modelica.SIunits</code>.<br/>
 This is for

diff --git a/Buildings/Controls/OBC/CDL/Continuous/PIDWithReset.mo b/Buildings/Controls/OBC/CDL/Continuous/PIDWithReset.mo
@@ -556,7 +556,7 @@ Whenever the value of boolean input signal <code>trigger</code> changes from
 The derivative of the control error <i>d &frasl; dt e(t)</i> is approximated using
 </p>
 <p align=\"center\" style=\"font-style:italic;\">
-d&frasl;dt x(t) = (e(t)-x(t)) T<sub>d</sub> &frasl; N<sub>d</sub>,
+d&frasl;dt x(t) = (e(t)-x(t)) N<sub>d</sub> &frasl; T<sub>d</sub>,
 </p>
 <p>
 and
@@ -617,6 +617,12 @@ American Society of Heating Refrigerating and Air-Conditioning Engineers Inc. At
  revisions="<html>
 <ul>
 <li>
+May 6, 2022, by Michael Wetter:<br/>
+Corrected wrong documentation in how the derivative of the control error is approximated.<br/>
+This is for
+<a href=\"https://github.com/lbl-srg/modelica-buildings/issues/2994\">issue 2994</a>.
+</li>
+<li>
 April 30, 2021, by Michael Wetter:<br/>
 Corrected error in non-released development version
 when reset trigger is <code>true</code>.<br/>

diff --git a/Buildings/package.mo b/Buildings/package.mo
@@ -331,13 +331,26 @@ units are wrong or errors in documentation):
 </p>
 <table class=\"releaseTable\" summary=\"summary\" border=\"1\" cellspacing=\"0\" cellpadding=\"2\" style=\"border-collapse:collapse;\">
 <tr><td colspan=\"2\"><b>Buildings.Applications</b>
+ </td>
+ </tr>
  <tr><td valign=\"top\">Buildings.Applications.DataCenters.ChillerCooled.Equipment.Validation.IntegratedPrimaryLoadSide
  </td>
  <td valign=\"top\">Removed duplicate instances of blocks that generate control signals.<br/>
  This is for
  <a href=\"https://github.com/lbl-srg/modelica-buildings/issues/2963\">Buildings, issue 2963</a>.
  </td>
- </tr>
+</tr>
+<tr><td colspan=\"2\"><b>Buildings.Controls.OBC.CDL</b>
+ </td>
+ </tr>
+ <tr><td valign=\"top\">Buildings.Controls.OBC.CDL.PID<br/>
+ Buildings.Controls.OBC.CDL.PIDWithReset
+ </td>
+ <td valign=\"top\">Corrected wrong documentation in how the derivative of the control error is approximated.<br/>
+ This is for
+ <a href=\"https://github.com/lbl-srg/modelica-buildings/issues/2994\">Buildings, issue 2994</a>.
+ </td>
+</tr>
 <tr><td colspan=\"2\"><b>Buildings.Experimental</b>
  </td>
 </tr>