Update docs for v0.923.1.

cse-user-manual/afmeter.html

@@ -24,6 +24,6 @@ <h1 class="subtitle">California Simulation Engine</h1>
 <div id="main-content">
 <h1 id="afmeter">4.12 AFMETER</h1><p>An AFMETER object is a user-defined “device” that records zone air flows as simulated by CSE. The user defines AFMETERs and assigns them to zones (see <a href="zone.html#zone">ZONE</a> znAFMtr).</p><p>Air flow is recorded in standard air cfm (density 0.075 lb/ft3) at subhour, hour, day, month, and year intervals. At intervals of an hour and longer, values are averaged. Flows are categorized according to <a href="izxfer.html#izxfer">IZXFER</a> izAFCat.</p><p>If any AFMETERs are defined, an additional AFMETER “sum_of_AFMETERs” is automatically created where the sums of all user-define AFMETERs are accumulated.</p><p>Note that <em>only</em> AirNet flows are recorded.</p><p>AFMETER results can be REPORTed using rpType=AFMTR (or EXPORTed using exType=AFMTR). See <a href="output-reports.html#air-flow-meter-report">Air Flow Meter Report</a>.</p><p><strong>afMtrName</strong></p><p>Name of meter: required for assigning air flows to the AFMETER.</p><table style="width:90%"><colgroup><col style="width:16%"><col style="width:18%"><col style="width:16%"><col style="width:18%"><col style="width:20%"></colgroup><thead><tr class="header"><th style="text-align:left"><strong>Units</strong></th><th style="text-align:left"><strong>Legal</strong> <strong>Range</strong></th><th><strong>Default</strong></th><th><strong>Required</strong></th><th><strong>Variability</strong></th></tr></thead><tbody><tr class="odd"><td style="text-align:left"></td><td style="text-align:left"><em>63 characters</em></td><td><em>none</em></td><td>Yes</td><td>constant</td></tr></tbody></table><p><strong>endAFMeter</strong></p><p>Indicates the end of the meter definition. Alternatively, the end of the meter definition can be indicated by the declaration of another object or by END.</p><table style="width:96%"><colgroup><col style="width:16%"><col style="width:16%"><col style="width:18%"><col style="width:22%"><col style="width:22%"></colgroup><thead><tr class="header"><th style="text-align:left"><strong>Units</strong></th><th style="text-align:left"><strong>Legal</strong> <strong>Range</strong></th><th style="text-align:left"><strong>Default</strong></th><th style="text-align:left"><strong>Required</strong></th><th><strong>Variability</strong></th></tr></thead><tbody><tr class="odd"><td style="text-align:left"></td><td style="text-align:left"></td><td style="text-align:left"><em>none</em></td><td style="text-align:left">No</td><td>constant</td></tr></tbody></table><p><strong>Related Probes:</strong></p><ul><li>@<a href="probe_afmeter.html#p_afmeter">afmeter</a></li></ul>
 </div>
-<p class="footer">Copyright (c) 1997-2024 The CSE Authors. All rights reserved.<br>Generated: 2024-12-18T17:30:52+00:00</p>
+<p class="footer">Copyright (c) 1997-2025 The CSE Authors. All rights reserved.<br>Generated: 2025-01-13T19:27:36+00:00</p>
 </body>
 </html>

cse-user-manual/battery.html

@@ -27,6 +27,6 @@ <h1 id="battery">4.46 BATTERY</h1><p>BATTERY describes input data for a model of
     $hour&gt;=9 &amp;&amp; $hour&lt;=20,-min(@BATTERY[ 1].loadSeen, 0), // hrs 9 - 20: charge when surplus energy
     default -max( @BATTERY[ 1].loadSeen, 0))              // else: discharge when energy is required</code></pre><p>The sign conventions here are tricky. min(<span class="citation" data-cites="BATTERY">@BATTERY [ 1]</span>.loadSeen, 0) produces a value &lt;=0 that is the negative of the amount of surplus energy available. A positive btChgReq value requests charging, hence “-” (minus sign) in front of the min(). Conversely, max( <span class="citation" data-cites="BATTERY">@BATTERY [ 1]</span>.loadSeen, 0) results in a value &gt;= 0 indicating the net energy needed by the building. To request discharge, btChgReq must be negative, so “-” is also needed in the discharge expression. (The <span class="citation" data-cites="BATTERY">@BATTERY [1]</span> references mean “this battery”, assuming there is only one battery being modelled. In multi-battery situations, the current BATTERY’s index or name must be included within the “[ ]”.)</p><table style="width:96%"><colgroup><col style="width:16%"><col style="width:16%"><col style="width:18%"><col style="width:22%"><col style="width:22%"></colgroup><thead><tr class="header"><th style="text-align:left"><strong>Units</strong></th><th style="text-align:left"><strong>Legal</strong> <strong>Range</strong></th><th style="text-align:left"><strong>Default</strong></th><th style="text-align:left"><strong>Required</strong></th><th><strong>Variability</strong></th></tr></thead><tbody><tr class="odd"><td style="text-align:left">kW</td><td style="text-align:left"></td><td style="text-align:left">btMeter net load</td><td style="text-align:left">No</td><td>hourly</td></tr></tbody></table><p><strong>btUseUsrChg=<em>choice</em></strong></p><p>Former yes/no choice that currently has no effect. Deprecated, will be removed in a future version.</p><p><strong>endBATTERY</strong></p><p>Optionally indicates the end of the BATTERY definition. Alternatively, the end of the definition can be indicated by END or by beginning another object.</p><table style="width:96%"><colgroup><col style="width:16%"><col style="width:16%"><col style="width:18%"><col style="width:22%"><col style="width:22%"></colgroup><thead><tr class="header"><th style="text-align:left"><strong>Units</strong></th><th style="text-align:left"><strong>Legal</strong> <strong>Range</strong></th><th style="text-align:left"><strong>Default</strong></th><th style="text-align:left"><strong>Required</strong></th><th><strong>Variability</strong></th></tr></thead><tbody><tr class="odd"><td style="text-align:left"></td><td style="text-align:left"></td><td style="text-align:left"><em>none</em></td><td style="text-align:left">No</td><td>constant</td></tr></tbody></table><p><strong>Related Probes:</strong></p><ul><li>@<a href="probe_battery.html#p_battery">battery</a></li></ul>
 </div>
-<p class="footer">Copyright (c) 1997-2024 The CSE Authors. All rights reserved.<br>Generated: 2024-12-18T17:30:52+00:00</p>
+<p class="footer">Copyright (c) 1997-2025 The CSE Authors. All rights reserved.<br>Generated: 2025-01-13T19:27:36+00:00</p>
 </body>
 </html>

cse-user-manual/construction.html

@@ -25,6 +25,6 @@ <h1 class="subtitle">California Simulation Engine</h1>
 <div id="main-content">
 <h1 id="construction">4.5 CONSTRUCTION</h1><p>CONSTRUCTION constructs an object of class CONSTRUCTION that represents a light weight or massive ceiling, wall, floor, or mass assembly (mass assemblies cannot, obviously, be lightweight). Once defined, CONSTRUCTIONs can be referenced from <a href="surface.html#surface">SURFACEs</a> (below). A defined CONSTRUCTION need not be referenced. Each CONSTRUCTION is optionally followed by <a href="layer.html#layer">LAYERs,</a> which define the constituent <a href="layer.html#layer">LAYERs</a> of the construction.</p><p><strong>conName</strong></p><p>Name of construction. Required for reference from <a href="surface.html#surface">SURFACE</a> and <a href="door.html#door">DOOR</a> objects, below.</p><table style="width:90%"><colgroup><col style="width:16%"><col style="width:18%"><col style="width:16%"><col style="width:18%"><col style="width:20%"></colgroup><thead><tr class="header"><th style="text-align:left"><strong>Units</strong></th><th style="text-align:left"><strong>Legal</strong> <strong>Range</strong></th><th><strong>Default</strong></th><th><strong>Required</strong></th><th><strong>Variability</strong></th></tr></thead><tbody><tr class="odd"><td style="text-align:left"></td><td style="text-align:left"><em>63 characters</em></td><td><em>none</em></td><td>Yes</td><td>constant</td></tr></tbody></table><p><strong>conU=<em>float</em></strong></p><p>U-value for the construction (NOT including surface (air film) conductances; see <a href="surface.html#surface">SURFACE</a> statements). If omitted, one or more <a href="layer.html#layer">LAYERs</a> must immediately follow to specify the <a href="layer.html#layer">LAYERs</a> that make up the construction. If specified, no <a href="layer.html#layer">LAYERs</a> can follow.</p><table style="width:94%"><colgroup><col style="width:22%"><col style="width:16%"><col style="width:16%"><col style="width:18%"><col style="width:20%"></colgroup><thead><tr class="header"><th style="text-align:left"><strong>Units</strong></th><th style="text-align:left"><strong>Legal</strong> <strong>Range</strong></th><th><strong>Default</strong></th><th><strong>Required</strong></th><th><strong>Variability</strong></th></tr></thead><tbody><tr class="odd"><td style="text-align:left">Btuh/ft<sup>2</sup>-<sup>o</sup>F</td><td style="text-align:left">x <span class="math inline">\(&gt;\)</span> 0</td><td>calculated from LAYERs</td><td>if omitted, LAYERs must follow</td><td>constant</td></tr></tbody></table><p><strong>endConstruction</strong></p><p>Optional to indicates the end of the CONSTRUCTION. Alternatively, the end of the CONSTRUCTION definition can be indicated by “END” or by beginning another object If END or endConstruction is used, it should follow the construction’s <a href="layer.html#layer">LAYER</a> subobjects, if any.</p><table style="width:96%"><colgroup><col style="width:16%"><col style="width:16%"><col style="width:18%"><col style="width:22%"><col style="width:22%"></colgroup><thead><tr class="header"><th style="text-align:left"><strong>Units</strong></th><th style="text-align:left"><strong>Legal</strong> <strong>Range</strong></th><th style="text-align:left"><strong>Default</strong></th><th style="text-align:left"><strong>Required</strong></th><th><strong>Variability</strong></th></tr></thead><tbody><tr class="odd"><td style="text-align:left"></td><td style="text-align:left"></td><td style="text-align:left"><em>N/A</em></td><td style="text-align:left">No</td><td>constant</td></tr></tbody></table><p><strong>Related Probes:</strong></p><ul><li>@<a href="probe_construction.html#p_construction">construction</a></li></ul>
 </div>
-<p class="footer">Copyright (c) 1997-2024 The CSE Authors. All rights reserved.<br>Generated: 2024-12-18T17:30:52+00:00</p>
+<p class="footer">Copyright (c) 1997-2025 The CSE Authors. All rights reserved.<br>Generated: 2025-01-13T19:27:36+00:00</p>
 </body>
 </html>