Skip to content

Commit 2e9fe79

Browse files
lucasverleyenlucasverleyen
authored
Merge pull request #1445 from lucasverleyen/issue1444_updateUsersGuide
Update user's guide
2 parents 0487686 + adf77cf commit 2e9fe79

36 files changed

+1136
-569
lines changed

‎IDEAS/BoundaryConditions/SolarIrradiation/ShadedRadSol.mo‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,10 +106,13 @@ Adjusted implementation for grouping of solar calculations.
106106
</ul>
107107
</html>", info="<html>
108108
<p>
109-
Model of equivalent radiative temperature is according to page 73 in
109+
Model of equivalent radiative temperature is according to page 73 in [Walton 1983].
110110
</p>
111+
<h4>References</h4>
111112
<p>
112-
Walton, G. N. 1983. Thermal Analysis Research Program Reference Manual. NBSSIR 83-2655. National Bureau of Standards
113+
[Walton 1983]: G.N. Walton,
114+
\"<a href=\"https://nvlpubs.nist.gov/nistpubs/Legacy/IR/nbsir83-2655.pdf\">Thermal Analysis Research Program Reference Manual (NBSSIR 83-2655)</a>\",
115+
U.S. Department of Commerce, National Bureau of Standards, U.S. Department of Energy, 1983.
113116
</p>
114117
</html>"));
115118
end ShadedRadSol;

‎IDEAS/Buildings/Components/BaseClasses/ConvectiveHeatTransfer/InteriorConvection.mo‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -116,10 +116,16 @@ a thermal circuit formulation for the direct radiant exchange between surfaces c
116116
[Buchberg 1955, Oppenheim 1956].</p>
117117
<h4>References</h4>
118118
<p>
119-
[Awbi 1999]: H.B. Awbi, A. Hatton, \"Natural convection from heated room surfaces\", <i>Energy and Buildings</i>, vol. 30, no. 3, pp. 233&ndash;244, 1999.<br>
119+
[Awbi 1999]: H.B. Awbi, and A. Hatton,
120+
\"<a href=\"https://doi.org/10.1016/S0378-7788(99)00004-3\">Natural convection from heated room surfaces</a>\",
121+
<i>Energy and Buildings</i>, vol. 30, no. 3, pp. 233&ndash;244, 1999.<br>
120122
[Buchberg 1955]: H. Buchberg, \"Electric analogue prediction of thermal behavior of an inhabitable enclosure\", <i>ASHRAE Transactions</i>, vol. 61, pp. 339&ndash;386, 1955.<br>
121-
[Khalifa 2001]: A.J.N. Khalifa, \"Natural convective heat transfer coefficient - a review: II. Surfaces in two-and three-dimensional enclosures\", <i>Energy Conversion and Management</i>, vol. 42, no. 4, pp. 505&ndash;517, 2001.<br>
122-
[Oppenheim 1956]: A.K. Oppenheim, \"Radiation analysis by the network method\", <i>Transaction of American Society of Mechanical Engineers</i>, vol. 78, pp. 725&ndash;735, 1956.
123+
[Khalifa 2001]: A.J.N. Khalifa,
124+
\"<a href=\"https://doi.org/10.1016/S0196-8904(00)00043-1\">Natural convective heat transfer coefficient &ndash; a review: II. Surfaces in two- and three-dimensional enclosures</a>\",
125+
<i>Energy Conversion and Management</i>, vol. 42, no. 4, pp. 505&ndash;517, 2001.<br>
126+
[Oppenheim 1956]: A.K. Oppenheim,
127+
\"<a href=\"https://asmedigitalcollection.asme.org/fluidsengineering/article/78/4/735/1137224/Discussion-Radiation-Analysis-by-the-Network\">Radiation analysis by the network method</a>\",
128+
<i>Transaction of American Society of Mechanical Engineers</i>, vol. 78, pp. 725&ndash;735, 1956.
123129
</p>
124130
</html>", revisions="<html>
125131
<ul>

‎IDEAS/Buildings/Components/BaseClasses/RadiativeHeatTransfer/ExteriorHeatRadiation.mo‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,12 @@ equation
7373
</ul>
7474
<h4>References</h4>
7575
<p>
76-
[Hamilton 1952]: D.C. Hamilton, W.R. Morgan, \"Radiant-interchange configuration factors\", <i>Technical Report &ndash; National Advisory Committee for Aeronautics</i>, 1952.<br>
77-
[Mohr 2008]: P.J. Mohr, B.N. Taylor, D.B. Newell, \"CODATA Recommended values of the fundamental physical constants: 2006\", <i>Review of Modern Physics</i>, vol. 80, pp. 633&ndash;730, 2008.
76+
[Hamilton 1952]: D.C. Hamilton, and W.R. Morgan,
77+
\"<a href=\"https://ntrs.nasa.gov/citations/19930083529\">Radiant-interchange configuration factors</a>\",
78+
<i>Technical Report &ndash; National Advisory Committee for Aeronautics</i>, Washington, 1952.<br>
79+
[Mohr 2008]: P.J. Mohr, B.N. Taylor, and D.B. Newell,
80+
\"<a href=\"https://doi.org/10.1103/RevModPhys.80.633\">CODATA recommended values of the fundamental physical constants: 2006</a>\",
81+
<i>Review of Modern Physics</i>, vol. 80, pp. 633&ndash;730, 2008.
7882
</p>
7983
</html>", revisions="<html>
8084
<ul>

‎IDEAS/Buildings/Components/BaseClasses/RadiativeHeatTransfer/ExteriorSolarAbsorption.mo‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,15 @@ equation
4444
Line(points={{-40,-10},{-30,-4}},color={191,0,0}),
4545
Line(points={{-40,-10},{-30,-16}}, color={191,0,0})}), Documentation(
4646
info="<html>
47-
<p>Transmitted shortwave solar radiation is distributed over all surfaces in the zone in a prescribed scale. This scale is an input value which may be dependent on the shape of the zone and the location of the windows, but literature <a href=\"IDEAS.Buildings.UsersGuide.References\">[Liesen 1997]</a> shows that the overall model is not significantly sensitive to this assumption.</p>
47+
<p>
48+
Transmitted shortwave solar radiation is distributed over all surfaces in the zone in a prescribed scale. This scale is an input value which may be dependent on the shape of the zone and the location of the windows, but literature [Liesen 1997] shows that the overall model is not significantly sensitive to this assumption.
49+
</p>
50+
<h4>References</h4>
51+
<p>
52+
[Liesen 1997]: R.J. Liesen, and C.O. Pedersen,
53+
\"<a href=\"https://iifiir.org/en/fridoc/an-evaluation-of-inside-surface-heat-balance-models-for-cooling-load-16626\">An evaluation of inside surface heat balance models for cooling load calculations</a>,\"
54+
<i>ASHRAE Transactions</i>, vol. 103, no. 2, pp. 485-502, 1997.
55+
</p>
4856
</html>", revisions="<html>
4957
<ul>
5058
<li>

‎IDEAS/Buildings/Components/BaseClasses/RadiativeHeatTransfer/SwWindowResponse.mo‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -137,8 +137,14 @@ equation
137137
Line(points = {{20, -70}, {20, -35}}, color = {0, 0, 127}));
138138
annotation(
139139
Diagram(coordinateSystem(preserveAspectRatio = false, extent = {{-100, -100}, {100, 100}})),
140-
Icon(graphics = {Rectangle(fillColor = {192, 192, 192}, pattern = LinePattern.None, fillPattern = FillPattern.Backward, extent = {{-80, 90}, {80, 70}}), Line(points = {{-80, 70}, {80, 70}}, pattern = LinePattern.None, thickness = 0.5), Line(points = {{44, 40}, {44, -50}}, color = {127, 0, 0}), Line(points = {{44, 40}, {38, 30}}, color = {127, 0, 0}), Line(points = {{44, 40}, {50, 30}}, color = {127, 0, 0}), Line(points = {{14, 40}, {14, -50}}, color = {127, 0, 0}), Line(points = {{14, 40}, {8, 30}}, color = {127, 0, 0}), Line(points = {{14, 40}, {20, 30}}, color = {127, 0, 0}), Line(points = {{-16, 40}, {-16, -50}}, color = {127, 0, 0}), Line(points = {{-16, 40}, {-22, 30}}, color = {127, 0, 0}), Line(points = {{-16, 40}, {-10, 30}}, color = {127, 0, 0}), Line(points = {{-46, 40}, {-46, -50}}, color = {127, 0, 0}), Line(points = {{-46, 40}, {-52, 30}}, color = {127, 0, 0}), Line(points = {{-46, 40}, {-40, 30}}, color = {127, 0, 0})}, coordinateSystem(extent = {{-100, -100}, {100, 100}})),
141-
Documentation(info = "<html>
142-
<p>The properties for absorption by and transmission through the glazingare taken into account depending on the angle of incidence of solar irradiation and are based on the output of the <a href=\"IDEAS.Buildings.UsersGuide.References\">[WINDOW 6.3]</a> software, i.e. the shortwave properties itselves based on the layers in the window are not calculated in the model but are input parameters. </p>
140+
Icon(graphics={ Rectangle(fillColor = {192, 192, 192}, pattern = LinePattern.None, fillPattern = FillPattern.Backward, extent = {{-80, 90}, {80, 70}}), Line(points = {{-80, 70}, {80, 70}}, pattern = LinePattern.None, thickness = 0.5), Line(points = {{44, 40}, {44, -50}}, color = {127, 0, 0}), Line(points = {{44, 40}, {38, 30}}, color = {127, 0, 0}), Line(points = {{44, 40}, {50, 30}}, color = {127, 0, 0}), Line(points = {{14, 40}, {14, -50}}, color = {127, 0, 0}), Line(points = {{14, 40}, {8, 30}}, color = {127, 0, 0}), Line(points = {{14, 40}, {20, 30}}, color = {127, 0, 0}), Line(points = {{-16, 40}, {-16, -50}}, color = {127, 0, 0}), Line(points = {{-16, 40}, {-22, 30}}, color = {127, 0, 0}), Line(points = {{-16, 40}, {-10, 30}}, color = {127, 0, 0}), Line(points = {{-46, 40}, {-46, -50}}, color = {127, 0, 0}), Line(points = {{-46, 40}, {-52, 30}}, color = {127, 0, 0}), Line(points = {{-46, 40}, {-40, 30}}, color = {127, 0, 0})}, coordinateSystem(extent = {{-100, -100}, {100, 100}})),
141+
Documentation(info="<html>
142+
<p>
143+
The properties for absorption by and transmission through the glazing are taken into account depending on the angle of incidence of solar irradiation and are based on the output of the [WINDOW 6.3] software, i.e. the shortwave properties itselves based on the layers in the window are not calculated in the model but are input parameters.
144+
</p>
145+
<h4>References</h4>
146+
<p>
147+
[WINDOW]: Lawrence Berkeley Laboratory, \"<a href=\"https://windows.lbl.gov/window-software-downloads\">WINDOW (v6.3)</a>\", 1993.
148+
</p>
143149
</html>"));
144150
end SwWindowResponse;

‎IDEAS/Buildings/Components/BaseClasses/RadiativeHeatTransfer/ZoneLwDistribution.mo‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -192,8 +192,10 @@ It may be used when the initial equation that computes the view factors does not
192192
</p>
193193
<h4>References</h4>
194194
<p>
195-
Liesen, R. J., &amp; Pedersen, C. O. (1997). An Evaluation of Inside Surface Heat Balance Models for Cooling Load Calculations. ASHRAE Transactions, 3(103), 485-502.<br/>
196-
Carroll, J.A. 1980. An \"MRT method\" of computing radiant energy exchange in rooms. Proceedings of the 2nd Systems Simulation and Economics Analysis Conference, January 23-25
195+
[Liesen 1997]: R.J. Liesen, and C.O. Pedersen,
196+
\"<a href=\"https://iifiir.org/en/fridoc/an-evaluation-of-inside-surface-heat-balance-models-for-cooling-load-16626\">An evaluation of inside surface heat balance models for cooling load calculations</a>,\"
197+
<i>ASHRAE Transactions</i>, vol. 103, no. 2, pp. 485-502, 1997.<br>
198+
[Carroll 1980]: Carroll, J.A. 1980. An \"MRT method\" of computing radiant energy exchange in rooms. Proceedings of the 2nd Systems Simulation and Economics Analysis Conference, January 23-25
197199
</p>
198200
</html>", revisions="<html>
199201
<ul>

‎IDEAS/Buildings/Components/SlabOnGround.mo‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,10 @@ environment on the ground temperature.
190190
The model assumes that the floor plate is connected to a (heated)
191191
zone that is surrounded by air at the ambient temperature.
192192
</p>
193+
<h4>References</h4>
194+
<p>
195+
ISO 13370: Thermal performance of buildings - Heat transfer via the ground - Calculation methods.
196+
</p>
193197
</html>", revisions="<html>
194198
<ul>
195199
<li>

‎IDEAS/Buildings/Data/Glazing/EpcDouble.mo‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,4 +91,8 @@ with changed implementation of MultiLayerLucent.
9191
<p> ---- ---- ---- ----</p>
9292
<p>Lay1 2.5 2.7 34.0 34.0 </p>
9393
<p>Lay2 12.7 12.9 32.7 32.6 </p>
94+
<h4>References</h4>
95+
<p>
96+
[WINDOW]: Lawrence Berkeley Laboratory, \"<a href=\"https://windows.lbl.gov/window-software-downloads\">WINDOW (v7.3.4.0)</a>\", 1993.
97+
</p>
9498
</html>"));

‎IDEAS/Buildings/Data/Glazing/EpcSingle.mo‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,4 +84,8 @@ with changed implementation of MultiLayerLucent.
8484
<p> Out In Out In</p>
8585
<p> ---- ---- ---- ----</p>
8686
<p>Lay1 5.0 5.5 31.0 30.9 </p>
87+
<h4>References</h4>
88+
<p>
89+
[WINDOW]: Lawrence Berkeley Laboratory, \"<a href=\"https://windows.lbl.gov/window-software-downloads\">WINDOW (v7.3.4.0)</a>\", 1993.
90+
</p>
8791
</html>"));

‎IDEAS/Buildings/Data/Glazing/Ins3Ar2020.mo‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,4 +124,8 @@ Lay1 31.8 31.7 37.9 38.4 <br/>
124124
Lay2 28.3 28.3 58.5 58.5 <br/>
125125
Lay3 24.7 24.7 33.3 33.0
126126
</p>
127+
<h4>References</h4>
128+
<p>
129+
[WINDOW]: Lawrence Berkeley Laboratory, \"<a href=\"https://windows.lbl.gov/window-software-downloads\">WINDOW (v7.7.10.0)</a>\", 1993.
130+
</p>
127131
</html>"));

0 commit comments

Comments
 (0)