Add revision section and further documentation #1223

RWTH-EBC · Nov 14, 2022 · 382f0b0 · 382f0b0
1 parent 39df81d
commit 382f0b0
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 1 deletion.
diff --git a/AixLib/Fluid/Storage/Examples/StorageDetailedExample.mo b/AixLib/Fluid/Storage/Examples/StorageDetailedExample.mo
@@ -94,6 +94,10 @@ equation
   mass flow with a higher temperature than the initial temperature.
 </p>
 <ul>
+  <li>November 14, 2022, by Laura Maier:<br/>
+    <a href=\"https://github.com/RWTH-EBC/AixLib/issues/1223\">#1223</a>:
+    Parameter tuning and refactoring.
+  </li>
   <li>November 27, 2019, by Philipp Mehrfeld:<br/>
     <a href=\"https://github.com/RWTH-EBC/AixLib/issues/793\">#793</a>:
     Add one heating coil to example.

diff --git a/AixLib/Fluid/Storage/Examples/StorageSimpleExample.mo b/AixLib/Fluid/Storage/Examples/StorageSimpleExample.mo
@@ -269,5 +269,21 @@ equation
       Interval=900,
       Tolerance=1e-06,
       __Dymola_Algorithm="Dassl"),
-          __Dymola_Commands(file="modelica://AixLib/Resources/Scripts/Dymola/Fluid/Storage/Examples/StorageSimpleExample.mos" "Simulate and plot"));
+          __Dymola_Commands(file="modelica://AixLib/Resources/Scripts/Dymola/Fluid/Storage/Examples/StorageSimpleExample.mos" "Simulate and plot"),
+    Documentation(info="<html>
+    <p>
+    This is an example of the simple storage model with two hydronic circuits.<br/>
+    A heating rod indirectly supplies heat to the thermal energy storage.<br/>
+    A simplified consumer extracts heat from the consumer water circuit<br/>
+    based on a daily load profile.
+    </p>
+    </ul>
+    </html>",revisions="<html>
+  <ul>
+  <li>
+  <i>November 14 2022</i> by Laura Maier:<br/>
+  First implementation
+  </li>
+</ul>
+</html>"));
 end StorageSimpleExample;