CSE User's Manual

California Simulation Engine

1 Introduction

1.1 Greetings

The purpose of this manual is to document the California Simulation Engine computer program, CSE. CSE is an hourly building and HVAC simulation program which calculates annual energy requirements for building space conditioning and lighting. CSE is specifically tailored for use as internal calculation machinery for compliance with the California building standards.

CSE is a batch driven program which reads its input from a text file. It is not intended for direct use by people seeking to demonstrate compliance. Instead, it will be used within a shell program or by technically oriented users. As a result, this manual is aimed at several audiences:

  1. People testing CSE during its development.

  2. Developers of the CSE shell program.

  3. Researchers and standards developers who will use the program to explore possible conservation opportunities.

Each of these groups is highly sophisticated. Therefore this manual generally uses an exhaustive, one-pass approach: while a given topic is being treated, everything about that topic is presented with the emphasis on completeness and accuracy over ease of learning.

Please note that CSE is under development and will be for many more months. Things will change and from time to time this manual may be inconsistent with the program.

1.2 Manual Organization

This Introduction covers general matters, including program installation.

Operation documents the operational aspects of CSE, such as command line switches, file naming conventions, and how CSE finds files it needs.

Input Structure documents the CSE input language in general.

Input Data describes all of the specific input language statements.

Output Reports will describe the output reports.

Lastly, Probe Definitions lists all available probes.

1.3 Installation

1.3.1 Hardware and Software Requirements

CSE is a 32-bit Microsoft Windows console application. That is, it runs at the command prompt on Windows Vista, Windows 7, Windows 8, and Windows 10. Memory and disk space requirements depend on the size of projects being modeled, but are generally modest.

To prepare input files, a text editor is required. Notepad will suffice, although a text editor intended for programming is generally more capable. Alternatively, some word processors can be used in “ASCII” or “text” or “non-document” mode.

1.3.2 Installation Procedure

Create a directory on your hard disk with the name \CSE or some other name of your choice. Copy the files into that directory. Add the name of the directory to the PATH environment setting unless you intend to use CSE only from the CSE directory.

2 Operation

2.1 Command Line

CSE is invoked from the command prompt or from a batch file using the following command:

    CSE *inputfile* {*switches*}

where:

inputfile
specifies the name of the text input file for the run(s). If the filename has an extension other than “.cse” (the default), it must be included. The name of the file with weather data for the simulation(s) is given in this file (wfName= statement, see Weather Data Items).
{switches}
indicates zero or more of the following:

2.2 Locating Files

As with any program, in order to invoke CSE, the directory containing CSE.EXE must be the current directory, or that directory must be on the operating system path, or you must type the directory path before CSE.

A CSE simulation requires a weather file. The name of the weather file is given in the CSE input file (wfName= statement, see Weather Data Items). The weather file must be in one of the same three places: current directory, directory containing CSE.EXE, or a directory on the operating system path; or, the directory path to the file must be given in the wfName= statement in the usual pathName syntax. ?? Appears that file must be in current directory due to file locating bugs 2011-07

The CSE input file, named on the CSE command line, must be in the current directory or the directory path to it must be included in the command line.

Included input files, named in #include preprocessor directives (see “The Preprocessor”) in the input file, must be in the current directory or the path to them must be given in the #include directive. In particular, CSE will NOT automatically look for included files in the directory containing the input file. The default extension for included files is “.CSE”.

Output files created by default by CSE (error message file, primary report and export files) will be in the same directory as the input file; output files created by explicit command in the input file (additional report and/or export files) will be in the current directory unless another path is explicitly specified in the command creating the file.

2.3 Output File Names

If any error or warning messages are generated, CSE puts them in a file with the same name and path as the input file and extension .ERR, as well as on the screen and, usually, in the primary (default) report file. The exception is errors in the command line: these appear only on the screen. If there are no error or warning messages, any prior file with this name is deleted.

By default, CSE generates an output report file with the same name and path as the input file, and extension “.REP”. This file may be examined with a text editor and/or copied to an ASCII printer. If any exports are specified, they go by default into a file with the same name and path as the input file and extension “.EXP”.

In response to specifications in the input file, CSE can also generate additional report and export files with user-specified names. The default extensions for these are .REP and .CSV respectively and the default directory is the current directory; other paths and extensions may be specified. For more information on report and export files, see REPORTFILE and EXPORTFILE in “Input Data”.

2.4 Errorlevel

CSE sets the command processor ERRORLEVEL to 2 if any error occurs in the session. This should be tested in batch files that invoke CSE, to prevent use of the output reports if the run was not satisfactory. The ERRORLEVEL is NOT set if only warning messages that do not suppress or abort the run occur, but such messages DO create the .ERR file.

3 Input Structure

DRAFT: In the following, any text annotated with ?? indicates areas of uncertainty or probable change. As the program and input language develop, these matters will be resolved.

3.1 Introduction

The CSE Input Language is the fundamental interface to the CSE program. The language has been designed with three objectives in mind:

  1. Providing direct access to all program features (including ones included for self-testing), to assist in program development.

  2. Providing a set of parametric and expression evaluation capabilities useful for standards development and program testing.

  3. Providing a means for other programs, such as an interactive user interface, to transmit input data and control data to the program.

Thus, the language is not intended to be used by the average compliance or simulation user. Instead, it will be used during program development for testing purposes and subsequently for highly technical parametric studies, such as those conducted for research and standards development. In all of these situations, power, reproducibility, and thorough input documentation take precedence over user-friendliness.

CSE reads its input from a file. The file may be prepared by the user with a text editor, or generated by some other program.

3.2 Form of the CSE Data

The data used by CSE consists of objects. Each object is of a class, which determines what the object represents. For example, objects of class ZONE represent thermally distinct regions of the building; each thermally distinct region has its own ZONE object. An object’s class determines what data items or members it contains. For instance, a ZONE object contains the zone’s area and volume. In addition, each object can have a name.

The objects are organized in a hierarchy, or tree-like structure. For example, under each ZONE object, there can be SURFACE objects to represent the walls, floors, and ceilings of the ZONE. Under SURFACEs there can be WINDOW objects to represent glazings in the particular wall or roof. SURFACE is said to be a subclass of the class ZONE and WINDOW a subclass of SURFACE; each individual SURFACE is said to be a subobject of its particular ZONE object. Conversely, each individual SURFACE is said to be owned by its zone, and the SURFACE class is said to be owned by the ZONE class.

The hierarchy is rooted in the one top-level object (or just Top). The top level object contains information global to the entire simulation, such as the start and end dates, as well as all of the objects that describe the building to be simulated and the reports to be printed.

Objects and their required data must be specified by the user, except that Top is predefined. This is done with input language statements. Each statement begins an object (specifying its class and object name) or gives a value for a data member of the object being created. Each object is specified with a group of statements that are usually given together, and the objects must be organized according to the hierarchy. For example, SURFACEs must be specified within ZONEs and WINDOWs within SURFACEs. Each SURFACE belongs to (is a subobject of) the ZONE within which it is specified, and each WINDOW is a subobject of its SURFACE.

The entire hierarchy of CSE classes can be represented as follows, using indentation to indicate subclasses:

TODO: review hierarchy

TOP (Top-level class; object of this class supplied automatically by CSE)
    HOLIDAY
    MATERIAL
    CONSTRUCTION
        LAYER
    METER
    DHWMETER
    IZXFER
    DHWDAYUSE
        DHWUSE
    DHWSYS
        DHWHEATER
        DHWTANK
        DHWPUMP
        DHWLOOP
        DHWLOOPPUMP
        DHWLOOPSEG
            DHWLOOPBRANCH
    DHWSOLARSYS
        DHWSOLARCOLLECTOR
    ZONE
        GAIN
        SURFACE
            WINDOW
                SHADE
                SGDIST
            DOOR
    REPORTFILE
    REPORT
    REPORTCOL
    EXPORTFILE
    EXPORT
    EXPORTCOL

3.3 Overview of CSE Input Language

The CSE Input Language consists of commands, each beginning with a particular word and, preferably, ending with a semicolon. Each command is either an action-command, which specifies some action such as starting a simulation run, or a statement, which creates or modifies an object or specifies a value for a member of an object.

3.3.1 Statements – Overview

A statement that creates an object consists basically of the class name followed by your name for the object to be created. (The name can be omitted for most classes; optional modifying clauses will be described later.) For example,

    ZONE "north";

begins an object of class ZONE; the particular zone will be named “north”. This zone name will appear in reports and error messages, and will be used in other statements that operate on the zone. As well as creating the ZONE, this statement sets CSE to expect statements specifying ZONE data members or ZONE subobjects to follow.

A statement specifying a data member consists of the data member’s name, an = sign, an expression specifying the value, and a terminating semicolon. An expression is a valid combination of operands and operators as detailed later; commonly it is just a number, name, or text enclosed in quotes. For example,

    znVol = 100000;

specifies that the zone has a volume of 100000 cubic feet. (If the statement occurs outside of the description of a ZONE, an error message occurs.) All of the member names for each class are described in the input data section; most of them begin with an abbreviation of the class name for clarity.

The description of a zone or any object except Top can be terminated with the word “END”; but this is not essential; CSE will assume the ZONE ends when you start another ZONE or any object not a subobject of ZONE, or when you specify a member of a higher level class (Top for ZONE), or give an action-command such as RUN.

Statements are free-form; several can be put on a line, or a single statement can occupy several lines. Indentation according to class hierarchy will help make your input file readable. Spaces may be used freely except in the middle of a word or number. Tab characters may be used. Each statement should end with a semicolon. If the semicolon is omitted and the statement and the following statement are both correctly formed, CSE will figure out your intent anyway. But when there is an error, CSE gives clearer error messages when the statements are delimited with semicolons.

Capitalization generally does not matter in input language statements; we like to capitalize class names to make them stand out. Words that differ only in capitalization are NOT distinct to CSE.

Comments (remarks) may be interspersed with commands. Comments are used to make the input file clearer to humans; they are ignored by CSE. A comment introduced with “//” ends at the end of the line; a comment introduced with “/*” continues past the next “*/”, whether on the same line, next line, or many lines down. Additional input language may follow the */ on the same line.

3.3.2 Nested Objects

The following is a brief CSE input file, annotated with comments intended to exemplify how the input language processor follows the object hierarchy when decoding input describing objects and their subobjects.

    // short example file
                            // initially, the current object is Top.
    wfName = "CZ12RV2.CEC"; // give weather file name, a Top member
    begDay = Jan 1;         // start and ...
    endDay = Dec 31;        // ...end run dates: Top members.

    MATERIAL carpet;        // create object of class MATERIAL
    matThk = .296;          // specify 'matThk' member of MATERIAL 'carpet'
    matCond = 1./24;        // give value of 'matCond' for 'carpet'

    CONSTRUCTION slab140C;  /* create object of class CONSTRUCTION, named
                               slab140C. Terminates MATERIAL, because
                               CONSTRUCTION is not a subclass of material
                               in the hierarchy shown in another section** */
      LAYER                 /* start an unnamed object of class LAYER.
                               Since LAYER is a subclass of CONSTRUCTION,
                               this will be a subobject of slab140C. */
        lrMat = carpet;     /* member of the LAYER. Note use of name of
                               MATERIAL object. */
      // (additional layers would be here)

    METER Elec;             /* create METER named Elec;
                               since METER is a subobject of Top,
                               this ends slab140C and its LAYER. */

    ZONE North;             // start a ZONE named North.  Ends METER.
      znArea = 1000;        // specify data members of ZONE North.
      znVol = 10;           // (you don't have to capitalize these as shown.)
      GAIN NorthLights      /* create GAIN object named NorthLights.
                               Creates a subobject of ZONE North. */
        gnPower = 0.01;     // member of NorthLights -- numeric value
        gnMeter = Elec;     // member of NorthLights -- object name value

      znCAir = 3.5;         /* processor knows that znCAir is a member of ZONE;
                               thus this statement terminates the GAIN
                               subobject & continues ZONE 'North'. */

      /*lrMat = ...            would be an error here, because the current
                               object is not a LAYER nor a subobject of LAYER */

    RUN;                    /* initiate simulation run with data given.
                               Terminates ZONE North, since action-commands
                               terminate all objects being constructed. */

** See Form of the CSE Data

3.3.3 Expressions – Overview

Expressions are the parts of statements that specify values – numeric values, string values, object name values, and choice values. Expressions are composed of operators and operands, in a manner similar to many programming languages. The available operators and operands will be described in the section on operators.

Unlike most programming languages, CSE expressions have Variation. Variation is how often a value changes during the simulation run – hourly, daily, monthly, yearly (i.e. does not change during run), etc. For instance, the operand $hour represents the hour of the day and has “hourly” variation. An expression has the variation of its fastest-varying component.

Each data member of each object (and every context in which an expression may be used) has its allowed variability, which is the fastest variation it will accept. Many members allow no variability. For example, begDay, the date on which the run starts, cannot meaningfully change during the run. On the other hand, a thermostat setting can change hourly. Thermostat settings and other scheduled values are specified in CSE with expressions that often make use of variability; there is no explicit SCHEDULE class.

For example, a heating setpoint that was 68 during business hours and 55 at night might be expressed as

    select( $hour > 8 && $hour < 18, 68, default 55)

An example of a complete statement containing the above expression is:

    tuTH = select( $hour > 8 && $hour < 18, 68, default 55);

The preceding is valid a statement if used in a TERMINAL description. The following:

    begDay = select( $hour > 8 && $hour < 18, 68, default 55);

would always get an error message, because begDay (the starting day of the run) will not accept hourly variation, and the expression varies hourly, since it contains $hour. The expression’s variation is considered “hourly” even though it changes only twice a day, since CSE has no variation category between hourly and daily.

CSE’s expression capability may be used freely to make input clearer. For example,

    znVol = 15 * 25 * 8;

meaning that the zone volume is 15 times 25 times 8 is the same to CSE as

    znVol = 3000;

but might be useful to you to tersely indicate that the volume resulted from a width of 15, a length of 25, and a height of 8. Further, if you wished to change the ceiling height to 9 feet, the edit would be very simple and CSE would perform the volume calculation for you.

CSE computes expressions only as often as necessary, for maximum simulation speed. For example,

    tuTH = 68;

causes 68 to be stored in the heating setpoint once at the start of the run only, even though tuTH will accept expressions with variability up to hourly. Furthermore, constant inner portions of variable expressions are pre-evaluated before the run begins.

CSE statements and expressions do not (yet) have user-settable variables in the usual programming language sense. They do, however, have user-defined functions to facilitate using the same computation several places, and preprocessor macros, to facilitate using the same text several places, specifying parametric values in a separate file, etc.

3.3.4 The Preprocessor – Overview

The preprocessor scans and processes input file text before the language processor sees the text. The preprocessor can include (embed) additional files in the input, include sections of input conditionally, and define and expand macros.

Macros are a mechanism to substitute a specified text for each occurrence of a word (the macro name). For example,

    #define ZNWID 20
    #define ZNLEN 30
    . . .

    znArea = ZNWID * ZNLEN;
    znVol  = ZNWID * ZNLEN * 8;

The first line above says that all following occurrences of “ZNWID” are to be replaced with “20” (or whatever follows ZNWID on the same line). The effect of the above is that the zone width and length are specified only one place; if the single numbers are editing, both the zone area and zone volume change to match.

Macros can be especially powerful when combined with the file inclusion feature; the generic building description could be in one file, and the specific values for multiple runs supplied by another file. By also using conditional compilation, the values-specifying file can select from a range of features available in the building description file.

The preprocessor is similar to that of the C programming language, and thus will be familiar to C programmers.

The next section describes the preprocessor in detail. The preprocessor description is followed by sections detailing statements, then expressions.

3.4 The Preprocessor

Note: The organization and wording of this section is based on section A12 of Kernigan and Richie [1988]. The reader is referred to that source for a somewhat more rigorous presentation but with the caution that the CSE input language preprocessor does not completely comply to ANSI C specifications.

The preprocessor performs macro definition and expansion, file inclusion, and conditional inclusion/exclusion of text. Lines whose first non-whitespace character is # communicate with the preprocessor and are designated preprocessor directives. Line boundaries are significant to the preprocessor (in contrast to the rest of the input language in which a newline is simply whitespace), although adjacent lines can be spliced with \, as discussed below. The syntax of preprocessor directives is separate from that of the rest of the language. Preprocessor directives can appear anywhere in an input file and their effects last until the end of the input file. The directives that are supported by the input language preprocessor are the following:

    #if
    #else
    #elif
    #endif
    #ifndef

    #define
    #redefine
    #undef

    #include

3.4.1 Line splicing

If the last character on a line is the backslash \, then the next line is spliced to that line by elimination of the backslash and the following newline. Line splicing occurs before the line is divided into tokens.

Line splicing finds its main use in defining long macros:

    // hourly light gain values:
    #define LIGHT_GAIN       .024, .022, .021, .021, .021, .026, \
                             .038, .059, .056, .060, .059, .046, \
                             .045, .5  , .5  , .05 , .057, .064, \
                             .064, .052, .050, .055, .044, .027

3.4.2 Macro definition and expansion

A directive of the form

    #define _identifier_ _token-sequence_

is a macro definition and causes the preprocessor to replace subsequent instances of the identifier with the given token sequence. Note that the token string can be empty (e.g. #define FLAG).

A line of the form

    #define _identifier_( _identifier-list_) _token-sequence_

where there is no space between the identifier and the (, is a macro with parameters given by the identifier list. The expansion of macros with parameters is discussed below.

Macros may also be defined on the CSE command line, making it possible to vary a run without changing the input files at all. As described in the command line section, macros are defined on the CSE command line using the -D switch in the forms

    -D_identifier_

    -D_identifier_=_token-sequence_

The first form simply defines the name with no token-sequence; this is convenient for testing with #ifdef, #ifndef, or defined(), as described in the section on conditional inclusion of tex. The second form allows an argument list and token sequence. The entire command line argument must be enclosed in quotes if it contains any spaces.

A macro definition is forgotten when an #undef directive is encountered:

    #undef _identifier_

It is not an error to #undef an undefined identifier.

A macro may be re-#defined without a prior #undef unless the second definition is identical to the first. A combined #undef/#define directive is available to handle this common case:

    #redefine _identifier_ _token-sequence_

    #redefine _identifier_( _identifier-list_) _token-sequence_

When a macro is #redefined, it need not agree in form with the prior definition (that is, one can have parameters even if the other does not). It is not an error to #redefine an undefined identifier.

Macros defined in the second form (with parameters) are expanded whenever the preprocessor encounters the macro identifier followed by optional whitespace and a comma-separated parameter list enclosed in parentheses. First the comma separated token sequences are collected; any commas within quotes or nested parentheses do not separate parameters. Then each unquoted instance of the each parameter identifier in the macro definition is replaced by the collected tokens. The resulting string is then repeatedly re-scanned for more defined identifiers. The macro definition and reference must have the same number of arguments.

It is often important to include parentheses within macro definitions to make sure they evaluate properly in all situations. Suppose we define a handy area macro as follows:

    #define AREA(w, h) w*h        // WRONG

Consider what happens when this macro is expanded with arguments 2+3 and 4+1. The preprocessor substitutes the arguments for the parameters, then the input language processor processes the statement containing the macro expansion without regard to the beginning and end of the arguments. The expected result is 25, but as defined, the macro will produce a result of 15. Parentheses fix it:

    #define AREA(w, h) ((w)*(h))  // RIGHT

The outer enclosing set of parentheses are not strictly needed in our example, but are good practice to avoid evaluation errors when the macro expands within a larger expression.

Note 1: The CSE preprocessor does not support the ANSI C stringizing (#) or concatenation (##) operators.

Note 2: Identifiers are case insensitive (unlike ANSI C). For example, the text “myHeight” will be replaced by the #defined value of MYHEIGHT (if there is one).

The preprocessor examples at the end of this section illustrate macro definition and expansion.

3.4.3 File inclusion

Directives of the form

#include "filename" and

#include <filename>

cause the replacement of the directive line with the entire contents of the referenced file. If the filename does not include an extension, a default extension of .INP is assumed. The filename may include path information; if it does not, the file must be in the current directory.

#includes may be nested to a depth of 5.

For an example of the use #includes, please see the preprocessor examples at the end of this section.

3.4.4 Conditional inclusion of text

Conditional text inclusion provides a facility for selectively including or excluding groups of input file lines. The lines so included or excluded may be either CSE input language text or other preprocessor directives. The latter capability is very powerful.

Several conditional inclusion directive involve integer constant expressions. Constant integer expressions are formed according the rules discussed in the section on expressions with the following changes:

  1. Only constant integer operands are allowed.

  2. All values (including intermediate values computed during expression evaluation) must remain in the 16 bit range (-32768 - 32767). The expression processor treats all integers as signed values and requires signed decimal constants – however, it requires unsigned octal and hexadecimal constants. Thus decimal constants must be in the range -32768 - 32767, octal must be in the range 0 - 0o177777, and hexadecimal in the range 0 - 0xffff. Since all arithmetic comparisons are done assuming signed values, 0xffff < 1 is true (unhappily). Care is required when using the arithmetic comparison operators (<, <=, >=, >).

  3. The logical relational operators && and || are not available. Nearly equivalent function can be obtained with & and |.

  4. A special operand defined( ) is provided; it is described below.

Macro expansion is performed on constant expression text, so symbolic expressions can be used (see examples below).

The basic conditional format uses the directive

    #if _constant-expression_

If the constant expression has the value 0, all lines following the #if are dropped from the input stream (the preprocessor discards them) until a matching #else, #elif, or #endif directive is encountered.

The defined( identifier ) operand returns 1 if the identifier is the name of a defined macro, otherwise 0. Thus

    #if defined( _identifier_ )

can be used to control text inclusion based on macro flags. Two #if variants that test whether a macro is defined are also available. #ifdef identifier is equivalent to #if defined(identifier) and #ifndef identifier is equivalent to #if !defined(identifier).

Defined(), #ifdef, and #ifndef consider a macro name “defined” even if the body of its definition contains no characters; thus a macro to be tested with one of these can be defined with just

    #define _identifier_

or with just “-Didentifier” on the CSE command line.

Conditional blocks are most simply terminated with #endif, but #else and #elif constant-expression are also available for selecting one of two or more alternative text blocks.

The simplest use of #if is to “turn off” sections of an input file without editing them out:

    #if 0
    This text is deleted from the input stream.
    #endif

Or, portions of the input file can be conditionally selected:

    #define FLRAREA 1000   // other values used in other runs
    #if FLRAREA <= 800
        CSE input language for small zones
    #elif FLRAREA <= 1500
        CSE input language for medium zones
    #else
        CSE input language for large zones
    #endif

Note that if a set of #if#elif#elif conditionals does not contain an #else, it is possible for all lines to be excluded.

Finally, it is once again important to note that conditional directives nest, as shown in the following example (indentation is included for clarity only):

    #if 0
        This text is NOT included.
        #if 1
            This text is NOT included.
        #endif
    #else
        This text IS included.
    #endif

3.4.5 Input echo control

By default, CSE echos all input text to the input echo report (see REPORT rpType=INP). #echooff and #echoon allow disabling and re-enabling text echoing. This capability is useful reducing report file size by suppressing echo of, for example, large standard include files.

    ... some input ...   // text sent to the input echo report
    #echooff
       // This text will NOT be sent to the input echo report.
       // However, it IS read and used by CSE.
       // Error messages will be echoed even if #echooff
       ... more input ...
    #echoon         // restore echo

Nesting is supported – each #echoon “undoes” the prior #echooff, but echoing does not resume until the topmost (earliest) #echooff is cancelled. * #echoon has no effect when echoing is already active. * Unmatched #echooffs are ignored – echoing remains disabled through the end of the input stream.

3.4.6 Preprocessor examples

This section shows a few combined examples that demonstrate the preprocessor’s capabilities.

The simplest use of macros is for run parameterization. For example, a base file is constructed that derives values from a macro named FLRAREA. Then multiple runs can be performed using #include:

    // Base file
    ... various input language statements ...

    ZONE main
        znArea = FLRAREA
        znVol  = 8*FLRAREA
        znCAir = 2*FLRAREA ...
        ... various other input language statements ...

    RUN

    CLEAR

The actual input file would look like this:

    // Run with zone area = 500, 1000, and 2000 ft2
    #define FLRAREA 500
    #include "base."
    #redefine FLRAREA 1000
    #include "base."
    #redefine FLRAREA 2000
    #include "base."

Macros are also useful for encapsulating standard calculations. For example, most U-values must be entered without surface conductances, yet many tabulated U-values include the effects of the standard ASHRAE winter surface conductance of 6.00 Btuh/ft2-oF. A simple macro is very helpful:

    #define UWinter(u)  ( 1/(1/(u)-1/6.00) )

This macro can be used whenever a U-value is required (e.g. SURFACE … sfU=UWinter(.11) … ).

3.5 CSE Input Language Statements

This section describes the general form of CSE input language statements that define objects, assign values to the data members of objects, and initiate actions. The concepts of objects and the class hierarchy were introduced in the section on form of CSE data. Information on statements for specific CSE input language classes and their members is the subject of the input data section.

3.5.1 Object Statements

As we described in a previous section, the description of an object is introduced by a statement containing at least the class name, and usually your chosen name for the particular object. In addition, this section will describe several optional qualifiers and modifying clauses that permit defining similar objects without repeating all of the member details, and reopening a previously given object description to change or add to it.

Examples of the basic object-beginning statement:

    ZONE "North";

    METER "Electric - Cooling";

    LAYER;

As described in the section on nested objects, such a statement is followed by statements giving the object’s member values or describing subobjects of the object. The object description ends when you begin another object that is not of a subclass of the object, or when a member of an embedding (higher level) object previously begun is given, or when END is given.

3.5.1.1 Object Names

An object name consists of up to 63 characters. If you always enclose the name in quotation marks, punctuation and spaces may be used freely; if the name starts with a letter or dollar sign and consists only of letters, digits, underscore, and dollar sign, and is different from all of the words already defined in CSE input language (as listed below in this section), you may omit the quotes. Capitalization, and Leading and trailing spaces and tabs, are always disregarded by input language processor. Names of 0 length, and names containing control characters (ASCII codes 0-31) are not allowed.

Examples of valid names that do not require quotes:

    North
    gas_meter
    slab140E

The following object names are acceptable if always enclosed in quotes:

    "Front Door"
    "M L King Day"
    "123"
    "3.5-inch wall"

We suggest always quoting object names so you won’t have to worry about disallowed words and characters.

Duplicate names result in error messages. Object names must be distinct between objects of the same class which are subobjects of the same object. For example, all ZONE names must be distinct, since all ZONEs are subobjects of Top. It is permissible to have SURFACEs with the same name in different ZONEs – but it is a good idea to keep all of your object names distinct to minimize the chance of an accidental mismatch or a confusing message regarding some other error.

For some classes, such as ZONE, a name is required for each object. This is because several other statements refer to specific ZONEs, and because a name is needed to identify ZONEs in reports. For other classes, the name is optional. The specific statement descriptions in the Input Data Section 5 say which names are required. We suggest always using object names even where not required; one reason is because they allow CSE to issue clearer error messages.

The following reserved words will not work as object names unless enclosed in quotes:

(this list needs to be assembled and typed in)

3.5.1.2 ALTER

ALTER is used to reopen a previously defined object when it is not possible or desired to give the entire description contiguously.

ALTER could be used if you wish to order the input in a special way. For example, SURFACE objects are subobjects of ZONE and are normally described with the ZONE they are part of. However, if you wanted to put all roofs together, you could use input of the general form:

    ZONE "1";  . . .  (zone 1 description)
    ZONE "2";  . . .
    . . .
    ALTER ZONE "1";               // revert to specifying zone 1
        SURFACE "Roof1";  . . .   (describe roof of zone 1)
    ALTER ZONE "2";
        SURFACE "Roof2";  . . .

ALTER can be used to facilitate making similar runs. For example, to evaluate the effect of a change in the size of a window, you might use:

    ZONE "South";
        SURFACE "SouthWall";
        ...
            WINDOW "BigWindow";
                wnHeight = 6;  wnWidth = 20;
    . . .
    RUN;          // perform simulation and generate reports
    // data from simulation is still present unless CLEAR given
    ALTER ZONE "South";
        ALTER SURFACE "SouthWall";
            ALTER WINDOW "BigWindow";
                wnHeight = 4;  wnWidth = 12;  // make window smaller
    RUN;          // perform simulation and print reports again

ALTER also lets you access the predefined “Primary” REPORTFILE and EXPORTFILE objects which will be described in the Input Data Section:

    ALTER REPORTFILE "Primary";    /* open description of object automatically
                                      supplied by CSE -- no other way to access */
        rfPageFmt = NO;            /* Turn off page headers and footers --
                                      not desired when reports are to be
                                      reviewed on screen. */

3.5.1.3 DELETE

DELETE followed by a class name and an object name removes the specified object, and any subobjects it has. You might do this after RUN when changing the data for a similar run (but to remove all data, CLEAR is handier), or you might use DELETE after COPYing (below) an object if the intent is to copy all but certain subobjects.

3.5.1.4 LIKE clause

LIKE lets you specify that an object being defined starts with the same member values as another object already defined. You then need give only those members that are different. For Example:

    MATERIAL "SheetRock";         // half inch gypsum board
        matCond = .0925;          // conductivity per foot
        matSpHt = .26;            // specific heat
        matDens = 50;             // density
        matThk = 0'0.5;           // thickness 1/2 inch
    MATERIAL "5/8 SheetRock" LIKE "SheetRock"; // 5/8" gypsum board
        matThk = 0'0.625;         // thickness 5/8 inch
        // other members same as "SheetRock", need not be repeated

The object named after LIKE must be already defined and must be of the same class as the new object.

LIKE copies only the member values; it does not copy any subobjects of the prototype object. For example, LIKEing a ZONE to a previously defined ZONE does not cause the new zone to contain the surfaces of the prototype ZONE. If you want to duplicate the surfaces, use COPY instead of LIKE.

3.5.1.5 COPY clause

COPY lets you specify that the object being defined is the same as a previously defined object including all of the subobjects of that object. For example,

    . . .
    ZONE "West" COPY "North";
        DELETE WALL "East";
        ALTER WALL "South";
            sfExCnd = ambient;

Specifies a ZONE named “West” which is the same as ZONE North except that it does not contain a copy of West’s East wall, and the South wall has ambient exposure.

3.5.1.6 USETYPE clause

USETYPE followed by the type name is used in creating an object of a type previously defined with DEFTYPE (next section). Example:

    SURFACE "EastWall" USETYPE "IntWall";     // use interior wall TYPE (below)
        sfAzm = 90;                           // this wall faces to the East
        sfArea = 8 * 30;                      // area of each wall is different
        sfAdjZn = "East";                     // zone on other side of wall

Any differences from the type, and any required information not given in the type, must then be specified. Any member specified in the type may be respecified in the object unless FROZEN (see this section) in the type (normally, a duplicate specification for a member results in an error message).

3.5.1.7 DEFTYPE

DEFTYPE is used to begin defining a TYPE for a class. When a TYPE is created, no object is created; rather, a partial or complete object description is stored for later use with DEFTYPE. TYPES facilitate creating multiple similar objects, as well as storing commonly used descriptions in a file to be #included in several different files, or to be altered for multiple runs in comparative studies without changing the including files. Example (boldface for emphasis only):

    DEFTYPE SURFACE "BaseWall"                // common characteristics of all walls
        sfType = WALL;                        // walls are walls, so say it once
        sfTilt = 90;                          // all our walls are vertical;
                                              //  but sfAzm varies, so it is not in TYPE.
        sfU = .83;                            // surf conductance; override if different
        sfModel = QUICK;

    DEFTYPE SURFACE "ExtWall" USETYPE "BaseWall";
        sfExCnd = AMBIENT;                    // other side of wall is outdoors
        sfExAbs = 0.5;                        // member only needed for exterior walls

    DEFTYPE SURFACE "IntWall" USETYPE "BaseWall";   // interior wall
        sfExCnd = ADJZN;                      // user must give sfAdjZn.

In a TYPE as much or as little of the description as desired may be given. Omitting normally-required members does not result in an error message in the type definition, though of course an error will occur at use if the member is not given there.

At use, member values specified in the TYPE can normally be re specified freely; to prevent this, “freeze” the desired member(s) in the type definition with

    FREEZE *memberName*;

Alternately, if you wish to be sure the user of the TYPE enters a particular member even if it is normally optional, use

    REQUIRE *memberName*

Sometimes in the TYPE definition, member(s) that you do not want defined are defined – for example, if the TYPE definition were itself initiated with a statement containing LIKE, COPY, or USETYPE. In such cases the member specification can be removed with

    UNSET *memberName*;

3.5.1.8 END and ENDxxxx

END, optionally followed by an object name, can be used to unequivocally terminate an object. Further, as of July 1992 there is still available a specific word to terminate each type of object, such as ENDZONE to terminate a ZONE object. If the object name is given after END or ENDxxxx, an additional check is performed: if the name is not that of an object which has been begun and not terminated, an error message occurs. Generally, we have found it is not important to use END or ENDxxxx, especially since the member names in different classes are distinct.

3.5.2 Member Statements

As introduced in the section on statements, statements which assign values to members are of the general form:

    *memberName* = *expression*;

The specific member names for each class of objects are given in Section 5; many have already been shown in examples.

Depending on the member, the appropriate type for the expression giving the member value may be numeric (integer or floating point), string, object name, or multiple-choice. Expressions of all types will be described in detail in the section on expressions.

Each member also has its variability (also given in the input data section), or maximum acceptable variation. This is how often the expression for the value can change during the simulation – hourly, daily, monthly, no change (constant), etc. The “variations” were introduced in the expressions overview section and will be further detailed in a section on variation frequencies.

Four special statements, AUTOSIZE, UNSET, REQUIRE, and FREEZE, add flexibility in working with members.

3.5.2.1 AUTOSIZE

AUTOSIZE followed by a member name, sets the member to be sized by CSE. The option to AUTOSIZE a member will be shown under its legal range where it is described in the input data section. AUTOSIZE is only applicable to members describing HVAC system airflows and heating/cooling capacities. If AUTOSIZE is used for any member in the input, input describing design day conditions must also be specified (see TOP Autosizing).

3.5.2.2 UNSET

UNSET followed by a member name is used when it is desired to delete a member value previously given. UNSETing a member resets the object to the same internal state it was in before the member was originally given. This makes it legal to specify a new value for the member (normally, a duplicate specification results in an error message); if the member is required (as specified in the input data section), then an error message will occur if RUN is given without re specifying the member.

Situations where you really might want to specify a member, then later remove it, include:

Note that UNSET is only for deleting members (names that would be followed with an = and a a value when being defined). To delete an entire object, use DELETE (see this section).

3.5.2.3 REQUIRE

REQUIRE followed by a member name makes entry of that member mandatory if it was otherwise optional; it is useful in defining a TYPE (see this section) when you desire to make sure the user enters a particular member, for example to be sure the TYPE is applied in the intended manner. REQUIRE by itself does not delete any previously entered value, so if the member already has a value, you will need to UNSET it. ?? verify

3.5.2.4 FREEZE

FREEZE followed by a member name makes it illegal to UNSET or redefine that member of the object. Note that FREEZE is unnecessary most of the time since CSE issues an error message for duplicate definitions without an intervening UNSET, unless the original definition came from a TYPE (see this section). Situations where you might want to FREEZE one or more members include:

3.5.3 Action Commands

CSE has two action commands, RUN and CLEAR.

3.5.3.1 RUN

RUN tells CSE to do an hourly simulation with the data now in memory, that is, the data given in the preceding part of the input file.

Note that CSE does NOT automatically run the simulator; an input file containing no RUN results in no simulation (you might nevertheless wish to submit an incomplete file to CSE to check for errors in the data already entered). The explicit RUN command also makes it possible to do multiple simulation runs in one session using a single input file.

When RUN is encountered in the input file, CSE checks the data. Many error messages involving inconsistencies between member values or missing required members occur at this time. If the data is good, CSE starts the simulation. When the simulation is complete and the reports have been output, CSE continues reading the input file. Statements after the first run can add to or change the data in preparation for another RUN. Note that the data for the first run is NOT automatically removed; if you wish to start over with complete specifications, use CLEAR after RUN.

3.5.3.2 CLEAR

CLEAR removes all input data (objects and all their members) from CSE memory. CLEAR is normally used after RUN, when you wish to perform another simulation run and wish to start clean. If CLEAR is not used, the objects from the prior run’s input remain in memory and may be changed or added to produce the input data for the next simulation run.

3.6 Expressions

Probably the CSE input language’s most powerful characteristic is its ability to accept expressions anywhere a single number, string, object name, or other value would be accepted. Preceding examples have shown the inputting zone areas and volumes as numbers (some defined via preprocessor macros) with *’s between them to signify multiplication, to facilitate changes and avoid errors that might occur in manual arithmetic. Such expressions, where all operands are constants, are acceptable anywhere a constant of the same type would be allowed.

But for many object members, CSE accepts live expressions that vary according to time of day, weather, zone temperatures, etc. (etc., etc., etc.!). Live expressions permit simulation of many relationships without special-purpose features in the language. Live expressions support controlling setpoints, scheduling HVAC system operation, resetting air handler supply temperature according to outdoor temperature, and other necessary and foreseen functions without dedicated language features; they will also support many unforeseen user-generated functionalities that would otherwise be unavailable.

Additional expression flexibility is provided by the ability to access all of the input data and much of the internal data as operands in expressions (probes, see this section).

As in a programming language, CSE expressions are constructed from operators and operands; unlike most programming languages, CSE determines how often an expression’s operands change and automatically compute and store the value as often as necessary.

Expressions in which all operands are known when the statement is being decoded (for example, if all values are constants) are always allowed, because the input language processor immediately evaluates them and presents the value to the rest of the program in the same manner as if a single number had been entered. Most members also accept expressions that can be evaluated as soon as the run’s input is complete, for example expressions involving a reference to another member that has not been given yet. Expressions that vary during the run, say at hourly or daily intervals, are accepted by many members. The variability or maximum acceptable variation for each member is given in the descriptions in the input data section, and the variation of each non-constant expression component is given in its description in this section.

Interaction of expressions and the preprocessor: Generally, they don’t interact. The preprocessor is a text processor which completes its work by including specified files, deleting sections under false #if’s, remembering define definitions, replacing macro calls with the text of the definition, removing preprocessor directives from the text after interpreting them, etc., then the resulting character stream is analyzed by the input language statement compiler. However, the if statement takes an integer numeric expression argument. This expression is similar to those described here except that it can only use constant operands, since the preprocessor must evaluate it before deciding what text to feed to the input statement statement compiler.

3.6.1 Expression Types

The type of value to which an expression must evaluate is specified in each member description (see the input data section) or other context in which an expression can be used. Each expression may be a single constant or may be made up of operators and operands described in the rest of this section, so long as the result is the required type or can be converted to that type by CSE, and its variation is not too great for the context. The possible types are:

floatA real number (3.0, 5.34, -2., etc.). Approximately 7 digits are carried internally. If an int is given where a real is required, it is automatically converted.
intAn integer or whole number (-1, 0, 1, 2 etc.). If a real is given, an error may result, but we should change it to convert it (discarding any fractional part).
BooleanSame as int; indicates that a 0 value will be interpreted as “false” and any non-0 value will be interpreted as “true”.
stringA string of characters; for example, some text enclosed in quotes.
object nameName of an object of a specified class. Differs from string in that the name need not be enclosed in quotes if it consists only of letters, digits, _, and $, begins with a non-digit, and is different from all reserved words now in or later added to the language (see Object Names).
The object may be defined after it is referred to. An expression using conditional operators, functions, etc. may be used provided its value is known when the RUN action command is reached.; no members requiring object names accept values that vary during the simulation.
choiceOne of several choices; a list of the acceptable values is given wherever a choice is required. The choices are usually listed in CAPITALS but may be entered in upper or lower case as desired. As with object names, quotes are allowed but not required.
Expressions may be used for choices, subject to the variability of the context.
dateMay be entered as a 3-letter month abbreviation followed by an int for the day of the month, or an int for the Julian day of the year (February is assumed to have 28 days). Expressions may be used subject to variability limitations. Examples:
Jan 23 // January 23
23 // January 23
32 // February 1

These words are used in following descriptions of contexts that can accept more than one basic type:

numericfloat or int. When floats and ints are intermixed with the same operator or function, the result is float.
anyTypeAny type; the result is the same type as the argument. If floats and ints are intermixed, the result is float. If strings and valid choice names are intermixed, the result is choice. Other mixtures of types are generally illegal, except in expressions for a few members that will accept either one of several choices or a numeric value.

The next section describes the syntax of constants of the various data types; then, we will describe the available operators, then other operand types such as system variables and built-in functions.

3.6.2 Constants

This section reviews how to enter ordinary non-varying numbers and other values.

intoptional - sign followed by digits. Don’t use a decimal point if your intent is to give an int quantity – the decimal point indicates a float to CSE. Hexadecimal and Octal values may be given by prefixing the value with 0x and 0O respectively (yes, that really is a zero followed by an ‘O’).
floatoptional - sign, digits and decimal point. Very large or small values can be entered by following the number with an “e” and a power of ten. Examples;
    1.0 1. .1 -5534.6 123.e25 4.56e-23
The decimal point indicates a float as opposed to an int. Generally it doesn’t matter as CSE converts ints to floats as required, but be careful when dividing: CSE interprets “2/3” as integer two divided by integer 3, which will produce an integer 0 before CSE notices any need to convert to float. If you mean .6666667, say 2./3, 2/3., or .6666667.
feet and inchesFeet and inches may be entered where a float number of feet is required by typing the feet (or a 0 if none), a single quote ’, then the inches. (Actually this is an operator meaning “divide the following value by 12 and add it to the preceding value”, so expressions can work with it.) Examples:
    3'6 0'.5 (10+20)'(2+3)
string“Text” – desired characters enclosed in double quotes. Maximum length 80 characters (make 132??). To put a " within the “’s, precede it with a backslash. Certain control codes can be represented with letters preceded with a backslash as follows:
    \\e escape
    \\t tab
    \\f form feed
    \\r carriage return
    \\n newline or line feed
object nameSame as string, or without quotes if name consists only of letters, digits, _, and $, begins with a non-digit, and is different from all reserved words now in or later added to the language (see Object Names). Control character codes (ASCII 0-31) are not allowed.
choiceSame as string; quotes optional on choice words valid for the member. Capitalization does not matter.
dateJulian day of year (as int constant), or month abbreviation
    Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov De c
followed by the int day of month. (Actually, the month names are operators implemented to add the starting day of the month to the following int quantity).

3.6.3 Operators

For floats and ints, the CSE input language recognizes a set of operators based closely on those found in the C programming language. The following table describes the available numeric operators. The operators are shown in the order of execution (precedence) when no ()’s are used to control the order of evaluation; thin lines separate operators of equal precedence.

OperatorNameNotes and Examples
Feet-Inches Separatora ’ b yields a + b/12; thus 4’6 = 4.5.
+Unary plusThe familiar “positive”, as in +3. Does nothing; rarely used.
-Unary minusThe familiar “minus”, as in -3. -(-3) = +3 etc.
!Logical NOTChanges 0 to 1 and any non-0 value to 0. !0 = 1, !17 = 0.
~One’s complementComplements each bit in an int value.
*MultiplicationMultiplication, e.g. 3*4 = 12; 3.24*18.54 = 60.07
/DivisionDivision, e.g. 4/2 = 2, 3.24/1.42 = 2.28. Integer division truncates toward 0 (e.g. 3/2 = 1, 3/-2 = -1, -3/2 = -1, 2/3 = 0) CAUTION!
%ModulusYields the remainder after division, e.g. 7%2 = 1. The result has the same sign as the left operand (e.g.(-7)%2 = -1). % is defined for both integer and floating point operands (unlike ANSI C).
+AdditionYields the sum of the operands, e.g. 5+3 = 8
-SubtractionYields the difference of the operands, e.g. 5-3 = 2
>>Right shifta >> b yields a shifted right b bit positions, e.g. 8>>2 = 2
<<Left shifta << b yields a shifted left b bit positions, e.g. 8<<2 = 32
<Less thana < b yields 1 if a is less than b, otherwise 0
<=Less than or equala <= b yields 1 if a is less than or equal to b, otherwise 0
>=Greater than or equala >= b yields 1 if a is greater than or equal to b, otherwise 0
>Greater thana > b yields 1 if a is greater than b, otherwise 0
==Equala == b yields 1 if a is exactly (bit wise) equal to b, otherwise 0
!=Not equala != b yields 1 if a is not equal to b, otherwise 0
&Bitwise anda & b yields the bitwise AND of the operands, e.g. 6 & 2 = 2.
^Bitwise exclusive ora ^ b yields the bitwise XOR of the operands, e.g. 6 ^ 2 = 4.
|Bitwise inclusive ora | b yields the bitwise IOR of the operands, e.g. 6 | 2 = 6.
&&Logical ANDa && b yields 1 if both a and b are non-zero, otherwise 0. && guarantees left to right evaluation: if the first operand evaluates to 0, the second operand is not evaluated and the result is 0.
||Logical ORa || b yields 1 if either a or b is true (non-0), otherwise 0. || guarantees left to right evaluation: if the first operand evaluates to non-zero, the second operand in not evaluated and the result is 1.
? :Conditionala ? b : c yields b if a is true (non-0), otherwise c.

Dates are stored as ints (the value being the Julian day of the year), so all numeric operators could be used. The month abbreviations are implemented as operators that add the first day of the month to the following int value; CSE does not disallow their use in other numeric contexts.

For strings, object names, and choices, the CSE input language currently has no operators except the ?: conditional operator. A concatenation operator is being considered. Note, though, that the choose, choose1, select, and hourval functions described below work with strings, object names, and choice values as well as numbers.

3.6.4 System Variables

System Variables are built-in operands with useful values. To avoid confusion with other words, they begin with a $. Descriptions of the CSE system variables follow. Capitalization shown need not be matched. Most system variables change during a simulation run, resulting in the variations shown; they cannot be used where the context will not accept variation at least this fast. (The Input Data Section gives the variability, or maximum acceptable variation, for each object member.)

$dayOfYearDay of year of simulation, 1 - 365; 1 corresponds to Jan-1. (Note that this is not the day of the simulation unless begDay is Jan-1.) Variation: daily.
$monthMonth of year, 1 - 12. Variation: monthly.
$dayOfMonthDay of month, 1 - 31. Variation: daily.
$hourHour of day, 1 - 24, in local time; 1 corresponds to midnight - 1 AM. Variation: hourly.
$hourSTHour of day, 1 - 24, in standard time; 1 corresponds to midnight - 1 AM. Variation: hourly.
$subhourSubhour of hour, 1 - N (number of subhours). Variation: subhourly.
$dayOfWeekDay of week, 1 - 7; 1 corresponds to Sunday, 2 to Monday, etc. Variation: daily.
$DOWHDay of week 1-7 except 8 on every observed holiday. Variation: daily.
$isHoliday1 on days that a holiday is observed (regardless of the true date of the holiday); 0 on other days. Variation: daily.
$isHoliTrue1 on days that are the true date of a holiday, otherwise 0. Variation: daily.
$isWeHol1 on weekend days or days that are observed as holidays. Variation: daily.
$isWeekend1 on Saturday and Sunday, 0 on any day from Monday to Friday. Variation: daily.
$isWeekday1 on Monday through Friday, 0 on Saturday and Sunday. Variation: daily.
$isBegWeek1 for any day immediately following a weekend day or observed holiday that is neither a weekend day or an observed holiday. Variation: daily.
$isWorkDay1 on non-holiday Monday through Friday, 0 on holidays, Saturday and Sunday. Variation: daily.
$isNonWorkDay1 on Saturday, Sunday and observed holidays, 0 on non-holiday Monday through Friday. Variation: daily.
$isBegWorkWeek1 on the first workday after a non-workday, 0 all other days. Variation: daily.
$isDT1 if Daylight Saving time is in effect, 0 otherwise. Variation: hourly.
$autoSizing1 during autosizing calculations, 0 during main simulation. Variation: for each phase.
$dsDayDesign day type, 0 during main simulation, 1 during heating autosize, 2 during cool autosize. Variation: daily.

Weather variables: the following allow access to the current hour’s weather conditions in you CSE expressions. Units of measure are shown in parentheses. All have Variation: hourly.

$radBeamSolar beam irradiance (on a sun-tracking surface) this hour (Btu/ft2)
$radDiffSolar diffuse irradiance (on horizontal surface) this hour (Btu/ft2)
$tDbOOutdoor drybulb temperature this hour (degrees F)
$tWbOOutdoor wetbulb temperature this hour (degrees F)
$wOOutdoor humidity ratio this hour (lb H2O/lb dry air)
$windDirDegWind direction (compass degrees)
$windSpeedWind speed (mph)

3.6.5 Built-in Functions

Built-in functions perform a number of useful scheduling and conditional operations in expressions. Built-in functions have the combined variation of their arguments; for hourval, the minimum result variation is hourly. For definitions of numeric and anyType, see Expression Types.

3.6.5.1 brkt

Functionlimits a value to be in a given range
Syntaxnumeric brkt( numeric min, numeric val, numeric max)
RemarkIf val is less than min, returns min; if val is greater than max, returns max; if val is in between, returns val.
ExampleIn an AIRHANDLER object, the following statement would specify a supply temperature equal to 130 minus the outdoor air temperature, but not less than 55 nor greater than 80:
    ahTsSp = brkt( 55, 130 - $tDbO, 80);
This would produce a 55-degree setpoint in hot weather, an 80-degree setpoint in cold weather, and a transition from 55 to 70 as the outdoor temperature moved from 75 to 50.

3.6.5.2 fix

Functionconverts float to int
Syntaxint fix( float val )
Remarkval is converted to int by truncation – fix( 1.3) and fix( 1.99) both return 1. fix( -4.4) returns -4.

3.6.5.3 toFloat

Functionconverts int to float
Syntaxfloat toFloat( int val )

3.6.5.4 min

Functionreturns the lowest quantity from a list of values.
Syntaxnumeric min( numeric value1, numeric value2, … numeric valuen )
Remarkthere can be any number of arguments separated by commas; if floats and ints are intermixed, the result is float.

3.6.5.5 max

Functionreturns the highest quantity from a list of values.
Syntaxnumeric max ( numeric value1, numeric value2,numeric valuen )

3.6.5.6 choose

Functionreturns the nth value from a list. If arg0 is 0, value0 is returned; for 1, value1 is returned, etc.
SyntaxanyType choose ( int arg0, anyType value0, anyType value1, … anyType valuen ) or anyType choose ( int arg0, anyType value0, … anyType valuen, default valueDef)
RemarksAny number of value arguments may be given. If default and another value is given, this value will be used if arg0 is less than 0 or too large; otherwise, an error will occur.

3.6.5.7 choose1

Functionsame as choose except arg0 is 1-based. Choose1 returns the second argument value1 for arg0 = 1, the third argument value2 when arg0 = 2, etc.
SyntaxanyType choose1 ( int arg0, anyType value1, anyType value2, … anyType valuen ) or anyType choose1 ( int arg0, anyType value1,anyType valuen, default valueDef)
Remarkschoose1 is a function that is well suited for use with daily system variables. For example, if a user wanted to denote different values for different days of the week, the following use of choose1 could be implemented:
    tuTC = choose1(\$dayOfWeek, MonTemp, TueTemp, ...)
Note that for hourly data, the hourval function would be a better choice, because it doesn’t require the explicit declaration of the $hour system variable.

3.6.5.8 select

Functioncontains Boolean-value pairs; returns the value associated with the first Boolean that evaluates to true (non-0).
SyntaxanyType ( Boolean arg1, anyType value1, Boolean arg2, anyType value2, … default anyType) (the default part is optional)
Remarkselect is a function that simulates if-then logic during simulation (for people familiar with C, it works much like a series of imbedded conditionals: (a?b:(a?b:c)) ).
ExamplesSelect can be used to simulate a dynamic (run-time) if-else statement:
gnPower = select( $isHoliday, HD_GAIN, // if ($isHolid a y)
default WD_GAIN) // else
This technique can be combined with other functions to schedule items on a hourly and daily basis. For example, an internal gain that has different schedules for holidays, weekdays, and weekends could be defined as follows:
// 24-hour lighting power schedules for weekend, weekda y , holiday:
#define WE_LIGHT hourval( .024, .022, .021, .021, .021 , . 026, \
             .038, .059, .056, .060, .059, .046, \
             .045, .005, .005, .005, .057, .064, \
             .064, .052, .050, .055, .044, .027 )
#define WD_LIGHT hourval( .024, .022, .021, .021, .021 , . 026, \
             .038, .059, .056, .060, .059, .046, \
             .045, .005, .005, .005, .057, .064, \
             .064, .052, .050, .055, .044, .027 )
#define HD_LIGHT hourval( .024, .022, .021, .021, .021 , . 026, \
             .038, .059, .056, .060, .059, .046, \
             .045, .005, .500, .005, .057, .064, \
             .064, .052, .050, .055, .044, .027 )
// set power member of zone's GAIN object for lighting
gnPower = BTU_Elec( ZAREA*0.1 ) * // .1 kW/ft2 ti mes...
    select( $isHoliday, HD_LIGHT, // Holidays
       $isWeekend, WE_LIGHT, // Saturday & Sunday
       default WD_LIGHT ); // Week Days
In the above, three subexpressions using hourval (next) are first defined as macros, for ease of reading and later change. Then, gnPower (the power member of a GAIN object) is set, using select to choose the appropriate one of the three hourval calls for the type of day. The expression for gnPower is a live expression with hourly variation, that is, CSE will evaluate it an set gnPower to the latest value each hour of the simulation. The variation comes from hourval, which varies hourly (also, $isHoliday and $isWeekend vary daily, but the faster variation determines the variation of the result).

3.6.5.9 hourval

Functionfrom a list of 24 values, returns the value corresponding to the hour of day.
SyntaxanyType hourval ( anyType value1, anyType value2,anyType value24 )
anyType hourval ( anyType value1, anyType value2, … default anyType)
Remarkhourval is evaluated at runtime and uses the hour of the day being simulated to choose the corresponding value from the 24 suppplied values.
If less than 24 value arguments are given, default and another value (or expression) should be supplied to be used for hours not explicitly specified.
Examplesee select, just above.

3.6.5.10 abs

Functionconverts numeric to its absolute value
Syntaxnumeric abs( numeric val)

3.6.5.11 sqrt

FunctionCalculates and returns the positive square root of val ( val must be \(\geq\) 0).
Syntaxfloat sqrt ( float val)

3.6.5.12 exp

FunctionCalculates and returns the exponential of val (= eval)
Syntaxfloat exp( float val)

3.6.5.13 logE

FunctionCalculates and returns the base e logarithm of val ( val must be \(\geq\) 0).
Syntaxfloat logE( float val)

3.6.5.14 log10

FunctionCalculates and returns the base 10 logarithm of val ( val must be \(\geq\) 0).
Syntaxfloat log10( float val)

3.6.5.15 sin

FunctionCalculates and returns the sine of val (val in radians)
Syntaxfloat sin( float val)

3.6.5.16 sind

FunctionCalculates and returns the sine of val (val in degrees)
Syntaxfloat sind( float val)

3.6.5.17 asin

FunctionCalculates and returns (in radians) the arcsine of val
Syntaxfloat asin( float val)

3.6.5.18 asind

FunctionCalculates and returns (in degrees) the arcsine of val
Syntaxfloat asind( float val)

3.6.5.19 cos

FunctionCalculates and returns the cosine of val (val in radians)
Syntaxfloat cos( float val)

3.6.5.20 cosd

FunctionCalculates and returns the cosine of val (val in degrees)
Syntaxfloat cosd( float val)

3.6.5.21 acos

FunctionCalculates and returns (in radians) the arccosine of val
Syntaxfloat acos( float val)

3.6.5.22 acosd

FunctionCalculates and returns (in degrees) the arccosine of val
Syntaxfloat acosd( float val)

3.6.5.23 tan

FunctionCalculates and returns the tangent of val (val in radians)
Syntaxfloat tan( float val)

3.6.5.24 tand

FunctionCalculates and returns the tangent of val (val in degrees)
Syntaxfloat tand( float val)

3.6.5.25 atan

FunctionCalculates and returns (in radians) the arctangent of val
Syntaxfloat atan( float val)

3.6.5.26 atand

FunctionCalculates and returns (in degrees) the arctangent of val
Syntaxfloat atand( float val)

3.6.5.27 atan2

FunctionCalculates and returns (in radians) the arctangent of y/x (handling x = 0)
Syntaxfloat atan2( float y, float x)

3.6.5.28 atan2d

FunctionCalculates and returns (in degrees) the arctangent of y/x (handling x = 0)
Syntaxfloat atan2d( float y, float x)

3.6.5.29 pow

FunctionCalculates and returns val raised to the xth power (= valx). val and x cannot both be 0. If val < 0, x must be integral.
Syntaxfloat pow( float val, numeric x)

3.6.5.30 enthalpy

FunctionReturns enthalpy of moist air (Btu/lb) for dry bulb temperature (F) and humidity ratio (lb/lb)
Syntaxfloat enthalpy( float tDb, float w)

3.6.5.31 wFromDbWb

FunctionReturns humidity ratio (lb/lb) of moist air from dry bulb and wet bulb temperatures (F)
Syntaxfloat wFromDbWb( float tDb, float tWb)

3.6.5.32 wFromDbRh

FunctionReturns humidity ratio (lb/lb) of moist air from dry bulb temperature (F) and relative humidity (0 – 1)
Syntaxfloat wFromDbRh( float tDb, float rh)

3.6.5.33 rhFromDbW

FunctionReturns relative humidity (0 – 1) of moist air from dry bulb temperature (F) and humidity ratio (lb/lb).
Syntaxfloat rhFromDbW( float tDb, float w)
RemarkThe return value is constrained to 0 <= rh <= 1 (that is, physically impossible combinations of tDb and w are silently tolerated).

3.6.5.34 import

FunctionReturns float read from an import file.
Syntaxfloat import( string importFile, string colName)
float import( string importFile, int colN)
RemarkColumns can be referenced by name or 1-based index.
See IMPORTFILE for details on use of import()

3.6.5.35 importStr

**Functio n Returns string read from an import file.
Syntaxstring importStr( string importFile, string colName)
string importStr( string importFile, int colN)
RemarkSee IMPORTFILE for details on use of importStr()

3.6.5.36 contin

FunctionReturns continuous control value, e.g. for lighting control
Syntaxfloat contin( float mpf, float mlf, float sp, float val)
Remarkcontin is evaluated at runtime and returns a value in the range 0 – 1 ???
Example

3.6.5.37 stepped

FunctionReturns stepped reverse-acting control value, e.g. for lighting control
Syntaxfloat stepped( int nsteps, float sp, float val)
Remarkstepped is evaluated at runtime and returns a value in the range 0 – 1. If val <= 0, 1 is returned; if val >= sp, 0 is returned; otherwise, a stepped intermediate value is returned (see example)

example:

stepped( 3, 12, val) returns

valresult
val \(<\) 41
4 \(\leq\) val \(<\) 8.667
8 \(\leq\) val \(<\) 12.333
val \(\geq\) 120

3.6.6 User-defined Functions

User defined functions have the format:

    type FUNCTION name ( arg decls ) = expr ;

Type indicates the type of value the function returns, and can be:

    INTEGER
    FLOAT
    STRING
    DOY       (day of year date using month name and day; actually same as integer).

Arg decls indicates zero or more comma-separated argument declarations, each consisting of a type (as above) and the name used for the argument in expr.

Expr is an expression of (or convertible to) type.

The tradeoffs between using a user-defined function and a preprocessor macro (#define) include:

  1. Function may be slightly slower, because its code is always kept separate and called, while the macro expansion is inserted directly in the input text, resulting in inline code.

  2. Function may use less memory, because only one copy of it is stored no matter how many times it is called.

  3. Type checking: the declared types of the function and its arguments allow CSE to perform additional checks.

Note that while macros require line-splicing (“\”)to extend over one line, functions do not require it:

    // Function returning number of days in ith month of year:
    DOY FUNCTION MonthLU (integer i) = choose1 ( i , Jan 31, Feb 28, Mar 31,
                                                     Apr 30, May 31, Jun 30,
                                                     Jul 31, Aug 31, Sep 30,
                                                     Oct 31, Nov 30, Dec 31 ) ;
    // Equivalent preprocessor macro:
    #define MonthLU (i) = choose1 ( i , Jan 31, Feb 28, Mar 31,  \
                                        Apr 30, May 31, Jun 30,  \
                                        Jul 31, Aug 31, Sep 30,  \
                                        Oct 31, Nov 30, Dec 31 ) ;

3.6.7 Probes

Probes provide a universal means of referencing data within the simulator. Probes permit using the inputtable members of each object, as described in the Input Data Section, as operands in expressions. In addition, most internal members can be probed; we will describe how to find their names shortly.

Three general ways of using probes are:

  1. During input, to implement things like “make this window’s width equal to 10% of the zone floor area” by using the zone’s floor area in an expression:
    wnWidth = @zone[1].znArea * 0.1;

Here “@zone[1].znArea” is the probe.

  1. During simulation. Probing during simulation, to make inputs be functions of conditions in the building or HVAC systems, is limited because most of the members of interest are updated after CSE has evaluated the user’s expressions for the subhour or other time interval – this is logically necessary since the expressions are inputs. (An exception is the weather data, but this is also available through system variables such as $tDbO.)

However, a number of prior subhour values are available for probing, making it possible to implement relationships like “the local heat output of this terminal is 1000 Btuh if the zone temperature last subhour was below 65, else 500”:

    tuMnLh = @znres["North"].S.prior.tAir < 65 ? 1000 : 500;
  1. For output reports, allowing arbitrary data to be reported at subhourly, hourly, daily, monthly, or annual intervals. The REPORT class description describes the user-defined report type (UDT), for which you write the expression for the value to be reported. With probes, you can thus report almost any datum within CSE – not just those values chosen for reporting when the program was designed. Even values calculated during the current subhour simulation can be probed and reported, because expressions for reports are evaluated after the subhour’s calculations are performed.

Examples:

    colVal = @airHandler["Hot"].ts;     // report air handler supply temp
    colVal = @terminal[NorthHot].cz;    // terminal air flow to zone (Btuh/F)

The general form of a probe is

    @ className [ objName ] . member

The initial @ is always necessary. And don’t miss the period after the ].

className is the CLASS being probed

objNameis the name of the specific object of the class; alternately, a numeric subscript is allowed. Generally, the numbers correspond to the objects in the order created. [ objName ] can be omitted for the TOP class, which has only one member, Top.
memberis the name of the particular member being probed. This must be exactly correct. For some inputtable members, the probe name is not the same as the input name given in the Input Data Section, and there are many probe-able members not described in the Input Data section.

How do you find out what the probe-able member names are? CSE will display the a list of the latest class and member names if invoked with the -p switch. Use the command line

    CSE -p >probes.txt

to put the displayed information into the file PROBES.TXT, then print the file or examine it with a text editor.

A portion of the -p output looks like:

    @exportCol[1..].        I   R                   owner: export
                     name   I   R   string            constant
                  colHead   I   R   string            input time
                   colGap   I   R   integer number    input time
                   colWid   I   R   integer number    input time
                   colDec   I   R   integer number    input time
                  colJust   I   R   integer number    constant
                   colVal   I   R   un-probe-able     end of each subhour
                   nxColi   I   R   integer number    constant

    @holiday[1..].          I
                     name   I       string            constant
               hdDateTrue   I       integer number    constant
                hdDateObs   I       integer number    constant
               hdOnMonday   I       integer number    constant

In the above “exportCol” and “holiday” are class names, and “name”, “colHead”, “colGap”, . . . are member names for class exportCol. Some members have multiple names separated by .’s, or they may contain an additional subscript. To probe one of these, type all of the names and punctuation exactly as shown (except capitalization may differ); if an additional subscript is shown, give a number in the specified range. An “I” designates an “input” parameter, an R means “runtime” parameter. The “owner” is the class of which this class is a subclass.

The data type and variation of each member is also shown. Note that variation, or how often the member changes, is shown here. (Variability, or how often an expression assigned to the member may change, is given for the input table members in the Input Data Section). Members for which an “end of” variation is shown can be probed only for use in reports. A name described as “un-probe-able” is a structure or something not convertible to an integer, float, or string.

surface[].sgdist[].f[]: f[0] is winter solar coupling fraction; f[1] is summer.

3.6.8 Variation Frequencies Revisited

At risk of beating the topic to death, we’re going to review once more the frequencies with which a CSE value can change (variations), with some comments on the corresponding variabilities.

subhourlychanges in each “subhour” used in simulation. Subhours are commonly 15-minute intervals for models using znModel=CNE or 2-minute intervals for CSE znModels.
hourlychanges every simulated hour. The simulated weather and many other aspects of the simulation change hourly; it is customary to schedule setpoint changes, HVAC system operation, etc. in whole hours.
dailychanges at each simulated midnite.
monthlychanges between simulated months.
monthly-hourly, or “hourly on first day of each month”changes once an hour on the first day of each month; the 24 hourly values from the first day of the month are used for the rest of the month. This variation and variability is used for data dependent on the sun’s position, to save calculation time over computing it every hour of every day.
run start timevalue is derived from other inputs before simulation begins, then does not change.
Members that cannot change during the simulation but which are not needed to derive other values before the simulation begins have “run start time” variability.
input timevalue is known before CSE starts to check data and derive “run start time” values.
Expressions with “input time” variation may be used in many members that cannot accept any variation during the run. Many members documented in the Input Data Section as having “constant” variability may actually accept expressions with “input time” variation; to find out, try it: set the member to an expression containing a proposed probe and see if an error message results.
“Input time” differs from “constant” in that it includes object names (forward references are allowed, and resolved just before other data checks) and probes that are forward references to constant values.
constantdoes not vary. But a “constant” member of a class denoted as R (with no I) in the probes report produced by CSE -p is actually not available until run start time.

Also there are end-of varieties of all of the above; these are values computed during simulation: end of each hour, end of run, etc. Such values may be reported (using a probe in a UDT report), but will produce an error message if probed in an expression for an input member value.

4 Input Data

This section describes the input for each CSE class (object type). For each object you wish to define, the usual input consists of the class name, your name for the particular object (usually), and zero or more member value statements of the form name=expression. The name of each subsection of this section is a class name (HOLIDAY, MATERIAL, CONSTRUCTION, etc.). The object name, if given, follows the class name; it is the first thing in each description (hdName, matName, conName, etc.). Exception: no statement is used to create or begin the predefined top-level object “Top” (of class TOP); its members are given without introduction.

After the object name, each member’s description is introduced with a line of the form name=type. Type indicates the appropriate expression type for the value:

These types discussed in the section on expression types.

Each member’s description continues with a table of the form:

UnitsLegal RangeDefaultRequiredVariability
ft2x > 0wnHeight * wnWidthNoconstant

where the column headers have the following meaning:

Unitsunits of measure (lb., ft, Btu, etc.) where applicable
Legallimits of valid range for numeric inputs; valid choices
Rangefor choice members, etc.
Defaultvalue assumed if member not given; applicable only if not required
RequiredYES if you must give this member
Variabilityhow often the given expression can change: hourly, daily, etc. See sections on expressions, statements, and variation frequencies

4.1 TOP Members

The top-level data items (TOP members) control the simulation process or contain data that applies to the modeled building as a whole. No statement is used to begin or create the TOP object; these statements can be given anywhere in the input (they do, however, terminate any other objects being specified – ZONEs, REPORTs, etc.).

4.1.1 TOP General Data Items

doMainSim=choice

Specifies whether the simulation is performed when a Run command is encountered. See also doAutoSize.

UnitsLegal RangeDefaultRequiredVariability
NO, YESYESNoconstant

begDay=date

Date specifying the beginning day of the simulation performed when a Run command is encountered. See further discussion under endDay (next).

UnitsLegal RangeDefaultRequiredVariability
dateJan 1Noconstant

endDay=date

Date specifying the ending day of the simulation performed when a Run command is encountered.

The program simulates 365 days at most. If begDay and endDay are the same, 1 day is simulated. If begDay precedes endDay in calendar sequence, the simulation is performed normally and covers begDay through endDay inclusive. If begDay follows endDay in calendar sequence, the simulation is performed across the year end, with Jan 1 immediately following Dec 31.

UnitsLegal RangeDefaultRequiredVariability
dateDec 31Noconstant

jan1DoW=choice

Day of week on which January 1 falls.

UnitsLegal RangeDefaultRequiredVariability
SUN, MON,
TUE, WED,
THU, FRI,
SAT
THUNoconstant

workDayMask=int TODO

UnitsLegal RangeDefaultRequiredVariability
constant

wuDays=int

Number of “warm-up” days used to initialize the simulator. Simulator initialization is required because thermal mass temperatures are set to arbitrary values at the beginning of the simulation. Actual mass temperatures must be established through simulation of a few days before thermal loads are accumulated. Heavier buildings require more warm-up; the default values are adequate for conventional construction.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 07Noconstant

nSubSteps=int

Number of subhour steps used per hour in the simulation. 4 is the time-honored value for models using CNE zones. A value of 30 is typically for CSE zone models.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 04Noconstant

nSubhrTicks=int

Number of subhour ticks used per nSubSteps for DHWSYS simulation.

Note: This input is currently used only for experimental purposes.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 060/nSubStepsNoconstant

tol=float

Endtest convergence tolerance for internal iteration in CNE models (no effect for CSE models) Small values for the tolerance cause more accurate simulations but slower performance. The user may wish to use a high number during the initial design process (to quicken the runs) and then lower the tolerance for the final design (for better accuracy). Values other than .001 have not been explored.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 00.001Noconstant

humTolF=float

Specifies the convergence tolerance for humidity calculations in CNE models (no effect in for CSE models), relative to the tolerance for temperature calculations. A value of .0001 says that a humidity difference of .0001 is about as significant as a temperature difference of one degree. Note that this is multiplied internally by “tol”; to make an overall change in tolerances, change “tol” only.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 00.0001Noconstant

ebTolMon=float

Monthly energy balance error tolerance for internal consistency checks. Smaller values are used for testing the internal consistency of the simulator; values somewhat larger than the default may be used to avoid error messages when it is desired to continue working despite a moderate degree of internal inconsistency.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 00.0001Noconstant

ebTolDay=float

Daily energy balance error tolerance.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 00.0001Noconstant

ebTolHour=float

Hourly energy balance error tolerance.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 00.0001Noconstant

ebTolSubhr=float

Sub-hourly energy balance error tolerance.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 00.0001Noconstant

unMetTzTol=float

Zone temperature unmet load tolerance. At the end of each subhour, if a conditioned zone temperature is more than unMetTzTol below the current heating setpoint or more than unMetTzTol above the current cooling setpoint, “unmet load” time is accumulated.

UnitsLegal RangeDefaultRequiredVariability
oFx \(\geq\) 01 oFNoconstant

unMetTzTolWarnHrs=float

Unmet load warning threshold. A warning message is issued for each zone having more than unMetTzTolWarnHrs unmet heating or cooling loads.

UnitsLegal RangeDefaultRequiredVariability
hrx \(\geq\) 0150Noconstant

grndMinDim=float

The minimum cell dimension used in the two-dimensional finite difference calculations for FOUNDATIONs.

UnitsLegal RangeDefaultRequiredVariability
ftx \(>\) 00.066Noconstant

grndMaxGrthCoeff=float

The maximum ratio of growth between neighboring cells in the direction away from the near-field area of interest. Used in the two-dimensional finite difference calculations for FOUNDATIONs.

UnitsLegal RangeDefaultRequiredVariability
x \(\geq\) 1.01.5Noconstant

grndTimeStep=choice

Allows the user to choose whether to calculate foundation conduction on hourly or subhourly intervals. Hourly intervals require less overall computation time, but with less accuracy.

UnitsLegal RangeDefaultRequiredVariability
HOURLY, SUBHOURLYHOURLYNoconstant

humMeth=choice

Developmental zone humidity computation method choice for CNE models (no effect for CSE models).

ROBRob’s backward difference method. Works well within limitations of backward difference approach.
PHILPhil’s central difference method. Should be better if perfectedcoma but initialization at air handler startup is unresolved*coma and ringing has been observed.
UnitsLegal RangeDefaultRequiredVariability
ROB, PHILROBNoconstant

dflExH=float

Default exterior surface (air film) conductance used for opaque and glazed surfaces exposed to ambient conditions in the absence of explicit specification.

UnitsLegal RangeDefaultRequiredVariability
Btuh/ft2-oFx \(>\) 02.64Noconstant

bldgAzm=float

Reference compass azimuth (0 = north, 90 = east, etc.). All zone orientations (and therefore surface orientations) are relative to this value, so the entire building can be rotated by changing bldgAzm only. If a value outside the range 0o \(\leq\) x \(<\) 360o is given, it is normalized to that range.

UnitsLegal RangeDefaultRequiredVariability
o (degrees)unrestricted0Noconstant

elevation=float

Elevation of the building site. Used internally for the computation of barometric pressure and air density of the location.

UnitsLegal RangeDefaultRequiredVariability
ftx \(\ge\) 00 (sea level)Noconstant

runTitle=string

Run title for the simulation. Appears in report footers, export headers, and in the title lines to the INP, LOG, and ERR built-in reports (these appear by default in the primary report file; the ERR report also appears in the error message file, if one is created).

UnitsLegal RangeDefaultRequiredVariability
63 charactersblank (no titleNoconstant

runSerial=int

Run serial number for the simulation. Increments on each run in a session; appears in report footers.

UnitsLegal RangeDefaultRequiredVariability
0 \(leq\) x \(leq\) 9990Noconstant

4.1.2 TOP Daylight Saving Time Items

Daylight savings starts by default at 2:00 a.m. of the second Sunday in March. Internally, hour 3 (2:00-3:00 a.m.) is skipped and reports for this day show only 23 hours. Daylight savings ends by default at 2:00 a.m. of the first Sunday of November; for this day 25 hours are shown on reports. CSE fetches weather data using standard time but uses daylight savings time to calculate variable expressions (and thus all schedules).

DT=choice

Whether Daylight Savings Time is to be used for the current run.

UnitsLegal RangeDefaultRequiredVariability
YES, NOYESNoconstant

DTbegDay=date

Start day for daylight saving time (assuming DT=Yes)

UnitsLegal RangeDefaultRequiredVariability
datesecond Sunday in MarchNoconstant

DTendDay=date

End day for daylight saving time (assuming DT=Yes)

UnitsLegal RangeDefaultRequiredVariability
datefirst Sunday in NovemberNoconstant

4.1.3 TOP Model Control Items

ventAvail=choice

Indicates availability of outdoor ventilation strategies. CSE cannot model simultaneously-operating alternative ventilation strategies. For example, an RSYS central fan integrated (CFI) OAV system is never modeled while whole house fan ventilation is available. ventAvail controls which ventilation mode, if any, is available for the current hour. Note that mode availability means that the strategy could operate but may not operate due to other control assumptions.

ChoiceVentilation Strategy Available
NONENone
WHOLEBUILDINGIZXFER (window and whole-house fan)
RSYSOAVRSYS central fan integrated (CFI) outside air ventilation (OAV)

As noted, ventAvail is evaluated hourly, permitting flexible control strategy modeling. The following example specifies that RSYSOAV (CFI) ventilation is available when the seven day moving average temperature is above 68 oF, otherwise whole building ventilation is available between 7 and 11 PM, otherwise no ventilation.

ventAvail = (@weather.taDbAvg07 > 68)    ? RSYSOAV
          : ($hour >= 19 && $hour <= 23) ? WHOLEBUILDING
          :                                NONE
UnitsLegal RangeDefaultRequiredVariability
Choices aboveWHOLEBUILDINGNohourly

exShadeModel=choice

Specifies advanced exterior shading model used to evaluate shading of PVARRAYs by SHADEXs or other PVARRAYs. Advanced shading is not implemented for building surfaces and this setting has no effect on walls or windows.

ChoiceEffect
PENUMBRACalculate shading using the Penumbra model
NONEDisable advanced shading calculations
UnitsLegal RangeDefaultRequiredVariability
Choices abovePENUMBRANoconstant

slrInterpMeth=choice

Solar interpolation method.

Choice
CSE
TRNSYS
UnitsLegal RangeDefaultRequiredVariability
See table aboveCSENoconstant

ANTolAbs=float

AirNet absolute convergence tolerance. Ideally, calculated zone air pressures should be such that the net air flow into each zone is 0 – that is, there should be a perfect mass balance. The iterative AirNet solution techniques are deemed converged when netAirMassFlow < max( ANTolAbs, ANTolRel*totAirMassFlow).

UnitsLegal RangeDefaultRequiredVariability
lbm/secx \(>\) 00.00125 (about 1 cfm)Noconstant

ANTolRel=float

AirNet relative convergence tolerance. See AnTolAbs just above.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 00.0001Noconstant

ANPressWarn=float

AirNet pressure warning threshold. A warning message is issued when the absolute value of the AirNet-calculated zone pressure exceeds ANPressWarn. Note the default for ANPressWarn conservatively large. 10 lb/ft2 is about 500 pascals – a pressure that is probably impossible in a building. The intent of this value is to alert the user to incorrect modeling inputs while avoiding excessive messages.

UnitsLegal RangeDefaultRequiredVariability
lb/ft2x \(\gt\) 010Noconstant

ANPressErr=float

AirNet pressure error threshold. The simulation terminates with a message if the absolute value of any AirNet-calculated zone pressure exceeds ANPressErr. Note the default value for ANPressErr is physically unrealistic. 30 lb/ft2 is about 1500 pascals – a pressure that would never be possible in a building. The intent of this value is to prevent simulation crashes due to numerical errors in AirNet calculations.

UnitsLegal RangeDefaultRequiredVariability
lb/ft2x \(\gt\) 030Noconstant

The ASHWAT complex fenestration model used when WINDOW wnModel=ASHWAT yields several heat transfer results that are accurate over local ranges of conditions. Several values control when these value are recalculated. If any of the specified values changes more than the associated threshold, a full ASHWAT calculation is triggered. Otherwise, prior results are used. ASHWAT calculations are computationally expensive and conditions often change only incrementally between time steps.

AWTrigT=float

ASHWAT temperature change threshold – full calculation is triggered by a change of either indoor or outdoor environmental (combined air and radiant) temperature that exceeds AWTrigT.

UnitsLegal RangeDefaultRequiredVariability
oFx \(>\) 01Noconstant

AWTrigSlr=float

ASHWAT solar change threshold – full calculation is triggered by a fractional change of incident solar radiation that exceeds AWTrigSlr.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 00.05Noconstant

AWTrigH=float

ASHWAT convection coefficient change threshold – full calculation is triggered by a fractional change of inside surface convection coefficient that exceeds AWTrigH.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 00.1Noconstant

4.1.4 TOP Weather Data Items

The following system variables (4.6.4) are determined from the weather file for each simulated hour:

$radBeambeam irradiance on tracking surface (integral for hour, Btu/ft2).
$radDiffdiffuse irradiance on a horizontal surface (integral for hour, Btu/ft2).
$tDbOdry bulb temp (oF).
$tWbOwet bulb temp (oF).
$wOhumidity ratio
$windDirDegwind direction (degrees, NOT RADIANS; 0=N, 90=E).
$windSpeedwind speed (mph).

The following are the terms determined from the weather file for internal use, and can be referenced with the probes shown.

    @Top.depressWbWet bulb depression (F).

    @Top.windSpeedSquaredWind speed squared (mph2).

wfName=string

Weather file path name for simulation. The file should be in the current directory, in the directory CSE.EXE was read from, or in a directory on the operating system PATH. Weather file formats supported are CSW, EPW, and ET1. Only full-year weather files are supported.

Note: Backslash (\) characters in path names must be doubled to work properly (e.g. “\\wthr\\mywthr.epw”). Forward slash (/) may be used in place of backslash without doubling.

UnitsLegal RangeDefaultRequiredVariability
file name,path optionalnoneYesconstant

skyModel=choice

Selects sky model used to determine relative amounts of direct and diffuse irradiance.

ISOTROPICtraditional isotropic sky model
ANISOTROPICHay anisotropic model
UnitsLegal RangeDefaultRequiredVariability
choices aboveANISOTROPICNoconstant

skyModelLW=choice

Selects the model used to derive sky temperature used in long-wave (thermal) radiant heat exchange calculations for SURFACEs exposed to ambient conditions. See the RACM alorithms documentation for technical details.

ChoiceDescription
DEFAULTDefault: tSky from weather file if available else Berdahl-Martin
BERDAHLMARTINBerdahl-Martin (tSky depends on dew point, cloud cover, and hour)
DRYBULBtSky = dry-bulb temperature (for testing)
BLASTBlast model (tSky depends on dry-bulb)
UnitsLegal RangeDefaultRequiredVariability
choices aboveDEFAULTNoconstant

The reference temperature and humidity are used to calculate a humidity ratio assumed in air specific heat calculations. The small effect of changing humidity on the specific heat of air is generally ignored in the interests of speed, but the user can control the humidity whose specific heat is used through the refTemp and refRH inputs.

refTemp=float

Reference temperature (see above paragraph).

UnitsLegal RangeDefaultRequiredVariability
oFx \(\ge\) 060oNoconstant

refRH=float

Reference relative humidity (see above).

UnitsLegal RangeDefaultRequiredVariability
0 \(\leq\) x \(\leq\) 10.6Noconstant

grndRefl=float

Global ground reflectivity, used except where other value specified with sfGrndRefl or wnGrndRefl. This reflectivity is used in computing the reflected beam and diffuse radiation reaching the surface in question. It is also used to calculate the solar boundary conditions for the exterior grade surface in two-dimensional finite difference calculations for FOUNDATIONs.

UnitsLegal RangeDefaultRequiredVariability
0 \(\leq\) x \(\leq\) 10.2NoMonthly-Hourly

The following values modify weather file data, permitting varying the simulation without making up special weather files. For example, to simulate without the effects of wind, use windF = 0; to halve the effects of diffuse solar radiation, use radDiffF = 0.5. Note that the default values for windSpeedMin and windF result in modification of weather file wind values unless other values are specified.

grndEmit=float

Long-wave emittance of the exterior grade surface used in two-dimensional finite difference calculations for FOUNDATIONs.

UnitsLegal RangeDefaultRequiredVariability
0.0 \(le\) x \(le\) 1.00.8Noconstant

grndRf

Ground surface roughness. Used for convection and wind speed corrections in two-dimensional finite difference calculations for FOUNDATIONs.

UnitsLegal RangeDefaultRequiredVariability
ftx \(\geq\) 0.00.1Noconstant

windSpeedMin=float

Minimum value for wind speed

UnitsLegal RangeDefaultRequiredVariability
mphx \(\ge\) 00.5Noconstant

windF=float

Wind Factor: multiplier for wind speeds read from weather file. windF is applied after windSpeedMin. Note that windF does not effect infiltration rates calculated by the Sherman-Grimsrud model (see e.g. ZONE.infELA). However, windF does modify AirNet flows (see IZXFER).

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 00.25Noconstant

terrainClass=int

Specifies characteristics of ground terrain in the project region.

1ocean or other body of water with at least 5 km unrestricted expanse
2flat terrain with some isolated obstacles (buildings or trees well separated)
3rural areas with low buildings, trees, etc.
4urban, industrial, or forest areas
5center of large city
UnitsLegal RangeDefaultRequiredVariability
1 \(\leq\) x \(\leq\) 54Noconstant

radBeamF=float

Multiplier for direct normal (beam) irradiance

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 01Noconstant

radDiffF=float

Multiplier for diffuse horizonal irradiance.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 01Noconstant

hConvMod=choice

Enable/disable convection convective coefficient pressure modification factor.

\[0.24 + 0.76 \cdot P_{Location}/P_{SeaLevel}\]

UnitsLegal RangeDefaultRequiredVariability
YES, NOYESNoconstant

soilDiff=float

Note: soilDiff is used as part of the simple ground model, which is no longer supported. Use soilCond, soilSpHt, and SoilDens instead.

Soil diffusivity, used in derivation of ground temperature. CSE calculates a ground temperature at 10 ft depth for each day of the year using dry-bulb temperatures from the weather file and soilDiff. Ground temperature is used in heat transfer calculations for SURFACEs with sfExCnd=GROUND. Note: derivation of mains water temperature for DHW calculations involves a ground temperature based on soil diffusivity = 0.025 and does not use this soilDiff.

UnitsLegal RangeDefaultRequiredVariability
ft2/hrx \(>\) 00.025Noconstant

soilCond=float

Soil conductivity. Used in two-dimensional finite difference calculations for FOUNDATIONs.

UnitsLegal RangeDefaultRequired**Variability
Btuh-ft/ft2-oFx \(>\) 01.0Noconstant

soilSpHt=float

Soil specific heat. Used in two-dimensional finite difference calculations for FOUNDATIONs.

UnitsLegal RangeDefaultRequiredVariability
Btu/lb-oFx \(>\) 00.1Noconstant

soilDens=float

Soil density. Used in two-dimensional finite difference calculations for FOUNDATIONs.

UnitsLegal RangeDefaultRequiredVariability
lb/ft3x \(>\) 0115Noconstant

farFieldWidth=float

Far-field width. Distance from foundation to the lateral, zero-flux boundary condition. Used in two-dimensional finite difference calculations for FOUNDATIONs.

UnitsLegal RangeDefaultRequiredVariability
ftx \(>\) 0130Noconstant

deepGrndCnd=choice

Deep-ground boundary condition type. Choices are WATERTABLE (i.e., a defined temperature) or ZEROFLUX.

UnitsLegal RangeDefaultRequiredVariability
WATERTABLE, ZEROFLUXZEROFLUXNoconstant

deepGrndDepth=float

Deep-ground depth. Distance from exterior grade to the deep-ground boundary. Used in two-dimensional finite difference calculations for FOUNDATIONs.

UnitsLegal RangeDefaultRequiredVariability
ftx \(>\) 0130Noconstant

deepGrndT=float

Deep-ground temperature. Used when deepGrndCnd=WATERTABLE.

UnitsLegal RangeDefaultRequiredVariability
Fx \(>\) 0Annual average drybulb temperatureNohourly

4.1.5 TOP TDV (Time Dependent Value) Items

CSE supports an optional comma-separated (CSV) text file that provides hourly TDV values for electricity and fuel. TDV values are read along with the weather file and the values merged with weather data. Several daily statistics are calculated for use via probes. The file has no other effect on the simulation. Only full-year TDV files are supported.

The format of a TDV file is the same as an IMPORTFILE with the proviso that the 4 line header is not optional and certain header items must have specified values. In the following table, non-italic items must be provided as shown (with optional quotes).

Line Contents Notes
1TDV Data (TDV/Btu), runNumber, runNumber is not checked
2timestamp optionally in quotes accessible via @TOP.TDVFileTimeStamp
3title, hour title (in quotes if it contains commas) accessible via @TOP.TDVFileTitle
4tdvElec, tdvFuel comma separated column names (optionally in quotes) not checked
5 ..valElec,valFuel comma separated numerical values (8760 or 8784 rows) tdvElec is always in column 1, tdvFuel always in column 2 column names in row 4 do not determine order

Example TDV file –

    "TDV Data (TDV/Btu)","001"
    "Wed 14-Dec-16  12:30:29 pm"
    "BEMCmpMgr 2019.0.0 RV (758), CZ12, Fuel NatGas", Hour
    "tdvElec","tdvFuel"
    7.5638,2.2311
    7.4907,2.2311
    7.4478,2.2311
    7.4362,2.2311
    7.5255,2.2311
    7.5793,2.2311
    7.6151,2.2311
    7.6153,2.2311
    7.5516,2.2311
    (... continues for 8760 or 8784 data lines ...)

Note: additional columns can be included and are ignored.

The table below shows probes available for accessing TDV data in expressions. Except as noted, daily values are updated based on standard time, so they may be inaccurate by small amounts when daylight savings time is in effect.

ProbeVariabilityDescription
@Weather.tdvElecHourcurrent hour electricity TDV
@Weather.tdvFuelHourcurrent hour fuel TDV
@Weather.tdvElecPkDaycurrent day peak electricity TDV (includes future hours). Updated at hour 23 during daylight savings.
@Weather.tdvElecAvgDaycurrent day average electricity TDV (includes future hours)
@Weather.tdvElecPvPkDayprevious day peak electricity TDV
@Weather.tdvElecAvg01Dayprevious day average electricity TDV
@weather.tdvElecHrRankDayhour ranking of TDVElec values. tdvElecHrRank[ 1] is the hour having the highest TDVElec, tdvElecHrRank[ 2] is the next highest, etc. The hour values are adjusted when dayight savings time is in effect, so they remain consistent with system variable $hour.
@weatherFile.tdvFileTimeStampConstantTDV file timestamp (line 2 of header)
@weatherFile.tdvFileTitleConstantTDV file title (line 3 of header)
@Top.tdvFNameConstantTDV file full path

TDVfName=string

Note: Backslash (\) characters in path names must be doubled to work properly (e.g. “\\data\\mytdv.tdv”). Forward slash (/) may be used in place of backslash without doubling.

UnitsLegal RangeDefaultRequiredVariability
file name, path optional(no TDV file)Noconstant

4.1.6 TOP Report Data Items

These items are used in page-formatted report output files. See REPORTFILE, Section 5.245.21, and REPORT, Section 5.25.

repHdrL=string

Report left header. Appears at the upper left of each report page unless page formatting (rfPageFmt) is OFF. If combined length of repHdrL and repHdrR is too large for the page width, one or both will be truncated.

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

repHdrR=string

Report right header. Appears at the upper right of each report page unless page formatting (rfPageFmt) is OFF. If combined length of repHdrL and repHdrR is too large for the page width, one or both will be truncated.

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

repLPP=int

Total lines per page to be assumed for reports. Number of lines used for text (including headers and footers) is repLPP - repTopM - repBotM.

UnitsLegal RangeDefaultRequiredVariability
linesx \(\ge\) 5066Noconstant

repTopM=int

Number of lines to be skipped at the top of each report page (prior to header).

UnitsLegal RangeDefaultRequiredVariability
lines0 \(\geq\) x \(\geq\) 123Noconstant

repBotM=int

Number of lines reserved at the bottom of each report page. repBotM determines the position of the footer on the page (blank lines after the footer are not actually written).

UnitsLegal RangeDefaultRequiredVariability
lines0 \(\geq\) x \(\geq\) 123Noconstant

repCPL=int

Characters per line for report headers and footers, user defined reports, and error messages. CSE writes simple ASCII files and assumes a fixed (not proportional) spaced printer font. Many of the built-in reports now (July 1992) assume a line width of 132 columns.

UnitsLegal RangeDefaultRequiredVariability
characters78 \(\leq\) x \(\leq\) 13278Noconstant

repTestPfx=string

Report test prefix. Appears at beginning of report lines that are expected to differ from prior runs. This is useful for “hiding” lines from text comparison utilities in automated testing schemes. Note: the value specified with command line -x takes precedence over this input.

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

4.1.7 TOP Autosizing

doAutoSize=choice

Controls invocation of autosizing phase prior to simulation.

UnitsLegal RangeDefaultRequiredVariability
YES, NONO, unless AUTOSIZE commands in inputNoconstant

auszTol=float

Autosize tolerance. Sized capacity results are deemed final when successive design day calculations produce results within auszTol of the prior iteration.

UnitsLegal RangeDefaultRequiredVariability
.005Noconstant

heatDsTDbO=float

Heating outdoor dry bulb design temperature used for autosizing heating equipment.

UnitsLegal RangeDefaultRequiredVariability
oFnoneNohourly

heatDsTWbO=float

Heating outdoor design dry bulb temperature used for autosizing heating equipment.

UnitsLegal RangeDefaultRequiredVariability
oFx \(\ge\) 0derived assuming RH=.7Nohourly

CSE provides 3 mutually-exclusive methods for specifying cooling design conditions. Each resulting design day is simulated repeatedly until results (e.g. equipment capacities) converge to stable values. Multiple days are typically used to ensure the a range of temperatures and sun positions are considered.

coolDsCond=list of up to 12 DESCONDs

Specifies cooling design conditions for cooling autosizing. A comma-separated list of up to 12 DESCOND names can be provided. Each day will be simulated repeatedly using weather conditions generated from DESCOND values.

UnitsLegal RangeDefaultRequiredVariability
name of DESCONDnoneNoconstant

coolDsDay=list of up to 12 days

Specifies cooling design days for cooling autosizing. Each day will be simulated repeatedly using weather file conditions for that day.

UnitsLegal RangeDefaultRequiredVariability
datesnoneNoconstant

coolDsMo=list of up to 12 months

Deprecated method for specifying design days for cooling autosizing. Design conditions are taken from ET1 weather file header, however, the limited availale ET1 files do not contain design condition information.

UnitsLegal RangeDefaultRequiredVariability
monthsnoneNoconstant

4.1.8 TOP Debug Reporting

verbose=int

Controls verbosity of screen remarks. Most possible remarks are generated during autosizing of CNE models. Little or no effect in CSE models. TODO: document options

UnitsLegal RangeDefaultRequiredVariability
0 - 51Noconstant

The following dbgPrintMask values provide bitwise control of addition of semi-formated internal results to the run report file. The values and format of debugging reports are modified as required for testing purposes.

dbgPrintMaskC=int

Constant portion of debug reporting control.

UnitsLegal RangeDefaultRequiredVariability
0Noconstant

dbgPrintMask=int

Hourly portion of debug reporting control (generally an expression that evaluates to non-0 only on days or hours of interest).

UnitsLegal RangeDefaultRequiredVariability
0Nohourly

dbgFlag=int

Allows passing an input value to ad-hoc debugging code. No permanent use; no impact on results.

UnitsLegal RangeDefaultRequiredVariability
0Nosubhourly

doCoverage=choice

Enables expression code coverage reporting. Development aid.

UnitsLegal RangeDefaultRequiredVariability
NO, YESNONoconstant

Related Probes:

4.2 HOLIDAY

HOLIDAY objects define holidays. Holidays have no inherent effect, but input expressions can test for holidays via the $DOWH, $isHoliday, $isHoliTrue, $isWeHol, and $isBegWeek system variables (4.6.4).

Examples and the list of default holidays are given after the member descriptions.

hdName

Name of holiday: must follow the word HOLIDAY.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneYesconstant

A holiday may be specified by date or via a rule such as “Fourth Thursday in November”. To specify by date, give hdDateTrue, and also hdDateObs or hdOnMonday if desired. To specify by rule, give all three of hdCase, hdMon, and hdDow.

hdDateTrue=date

The true date of a holiday, even if not celebrated on that day.

UnitsLegal RangeDefaultRequiredVariability
dateblankNoconstant

hdDateObs=date

The date that a holiday will be observed. Allowed only if hdDateTrue given and hdOnMonday not given.

UnitsLegal RangeDefaultRequiredVariability
datehdDateTrueNoconstant

hdOnMonday=choice

If YES, holiday is observed on the following Monday if the true date falls on a weekend. Allowed only if hdDateTrue given and hdDateObs not given.

Note: there is no provision to celebrate a holiday that falls on a Saturday on Friday (as July 4 was celebrated in 1992).

UnitsLegal RangeDefaultRequiredVariability
YES/NOYESNoconstant

hdCase=choice

Week of the month that the holiday is observed. hdCase, hdMon, and hdDow may be given only if hdDateTrue, hdDateObs, and hdOnMonday are not given.

UnitsLegal RangeDefaultRequiredVariability
FIRST SECOND THIRD FOURTH LASTFIRSTNoconstant

hdMon=choice

Month that the holiday is observed.

UnitsLegal RangeDefaultRequiredVariability
JAN, FEB, MAR, APR, MAY, JUN, JUL, AUG, SEP, OCT, NOV, DECnonerequired if hdCase givenconstant

hdDow=choice

Day of the week that the holiday is observed.

UnitsLegal RangeDefaultRequiredVariability
SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAYMONDAYrequired if hdCase givenconstant

endHoliday

Indicates the end of the holiday definition. Alternatively, the end of the holiday definition can be indicated by “END” or simply by beginning another object.

UnitsLegal RangeDefaultRequiredVariability
noneconstant

Examples of valid HOLIDAY object specifications:

    HOLIDAY MAYDAY;
        hdDateTrue = May 1;
    HOLIDAY MAYDAY;
        hdDateTrue = May 1;
        hdDateObs  = May 3;
    HOLIDAY MAYDAY;
        hdDateTrue = May 1;
        hdOnMonday = No;
    HOLIDAY HYPOTHET;
        hdCase = third;
        hdDow  = Wed;
        hdMon  = MAR

As with reports, Holidays are automatically generated for a standard set of Holidays. The following are the default holidays automatically defined by CSE:

New Year’s Day*January 1
M L King Day*January 15
President’s Day3rd Monday in February
Memorial Daylast Monday in May
Fourth of July*July 4
Labor Day1st Monday in September
Columbus Day2nd Monday in October
Veterans Day*November 11
Thanksgiving4th Thursday in November
Christmas*December 25

* observed on the following Monday if falls on a weekend, except as otherwise noted:

If a particular default holiday is not desired, it can be removed with a DELETE statement:

    DELETE HOLIDAY Thanksgiving

    DELETE HOLIDAY "Columbus Day"  // Quotes necessary (due to space)

    DELETE HOLIDAY "VETERANS DAY"  // No case-sensitivity

Note that the name must be spelled exactly as listed above.

Related Probes:

4.3 DESCOND

Specifies conditions for a cooling design day. When referenced in TOP coolDsCond (see TOP Autosizing), DESCOND members are used to generate a 24 hour design day used during cooling autosizing. Note that coolDsCond can reference more than one DESCOND, allowing multiple design conditions to be used for autosizing. For example, both summer and fall days could be specified to ensure a range of sun angles are considered. Any DESCONDs that are not referenced in coolDsCond have no effect.

desCondName

Object name, given after “DESCOND”. Required for referencing from Top coolDsCond.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneYesconstant

dcDay=date

Calendar date for this design cooling condition.

UnitsLegal RangeDefaultRequiredVariability
1-365200Noconstant

dcDB=float

Design dry-bulb temperature (maxiumum temperature on design day).

UnitsLegal RangeDefaultRequiredVariability
oFno-limitations?0.0Noconstant

dcMCDBR=float

Coincident daily dry-bulb range.

UnitsLegal RangeDefaultRequiredVariability
oFno-limitations?noneNoconstant

dcMCWB=float

Coincident wet-bulb design temperature.

UnitsLegal RangeDefaultRequiredVariability
oFno-limitations?noneNoconstant

dcMCWBR=float

Coincident daily wet-bulb range.

UnitsLegal RangeDefaultRequiredVariability
oFno-limitations?noneNoconstant

dcWindSpeed=float

Wind speed for design conditions.

UnitsLegal RangeDefaultRequiredVariability
mphx \(\geq\) 00.0Noconstant

DESCOND provides two mutually-exclusive methods for specifying design day direct beam and diffuse horizontal irradiance values. Both use the ASHRAE clear sky model. Consult the ASHRAE Handbook of Fundamentals Climatic Data chapter for model documentation.

At most one of these methods can be used within a given DESCOND. If all solar-related values are omitted, the generated design day has 0 irradiance for all hours.

dcTauB=float
dcTauD=float

ASHRAE clear sky model beam and diffuse pseudo optical depths. These values are available by month for many locations in ASHRAE design weather data. Cannot be given if dcEbnSlrNoon and dcEdhSlrNoon are specified.

UnitsLegal RangeDefaultRequiredVariability
0 irradianceNoconstant

dcEbnSlrNoon=float
dcEdhSlrNoon=float

Solar noon direct beam and diffuse horizontal irradiance. Cannot be given if dcTauB and dcTauD are specified.

UnitsLegal RangeDefaultRequiredVariability
Btuh/ft2x \(\geq\) 00 irradianceNoconstant

endDesCond

Optionally indicates the end of the descond definition.

UnitsLegal RangeDefaultRequiredVariability
noneNo

4.4 MATERIAL

MATERIAL constructs an object of class MATERIAL that represents a building material or component for later reference a from LAYER (see below). A MATERIAL so defined need not be referenced. MATERIAL properties are defined in a consistent set of units (all lengths in feet), which in some cases differs from units used in tabulated data. Note that the convective and air film resistances for the inside wall surface is defined within the SURFACE statements related to conductances.

matName

Name of material being defined; follows the word “MATERIAL”.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneYesconstant

matThk=float

Thickness of material. If specified, matThk indicates the discreet thickness of a component as used in construction assemblies. If omitted, matThk indicates that the material can be used in any thickness; the thickness is then specified in each LAYER using the material (see below).

UnitsLegal RangeDefaultRequiredVariability
ftx \(>\) 0noneNoconstant

matCond=float

Conductivity of material. Note that conductivity is always stated for a 1 foot thickness, even when matThk is specified; if the conductance is known for a specific thickness, an expression can be used to derive matCond.

UnitsLegal RangeDefaultRequired**Variability
Btuh-ft/ft2-oFx \(>\) 0noneYesconstant

matCondT=float

Temperature at which matCond is rated. See matCondCT (next).

UnitsLegal RangeDefaultRequiredVariability
oFx \(>\) 070 oFNoconstant

matCondCT=float

Coefficient for temperature adjustment of matCond in the forward difference surface conduction model. Each hour (not subhour), the conductivity of layers using this material are adjusted as followslrCond = matCond * (1 + matCondCT*(Tlayer – matCondT))

UnitsLegal RangeDefaultRequiredVariability
oF-10Noconstant

Note: A typical value of matCondCT for fiberglass batt insulation is 0.00418 F-1

matSpHt=float

Specific heat of material.

UnitsLegal RangeDefaultRequiredVariability
Btu/lb-oFx \(\ge\) 00 (thermally massless)Noconstant

matDens=float

Density of material.

UnitsLegal RangeDefaultRequiredVariability
lb/ft3x \(\ge\) 00 (massless)Noconstant

matRNom=float

Nominal R-value per foot of material. Appropriate for insulation materials only and used for documentation only. If specified, the current material is taken to have a nominal R-value that contributes to the reported nominal R-value for a construction. As with matCond, matRNom is always stated for a 1 foot thickness, even when matThk is specified; if the nominal R-value is known for a specific thickness, an expression can be used to derive matRNom.

UnitsLegal RangeDefaultRequiredVariability
ft2-oF/Btuhx \(>\) 0noneNoconstant

endMaterial

Optional to indicate the end of the material. Alternatively, the end of the material definition can be indicated by “END” or simply by beginning another object.

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

Related Probes:

4.5 CONSTRUCTION

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 SURFACEs (below). A defined CONSTRUCTION need not be referenced. Each CONSTRUCTION is optionally followed by LAYERs, which define the constituent LAYERs of the construction.

conName

Name of construction. Required for reference from SURFACE and DOOR objects, below.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneYesconstant

conU=float

U-value for the construction (NOT including surface (air film) conductances; see SURFACE statements). If omitted, one or more LAYERs must immediately follow to specify the LAYERs that make up the construction. If specified, no LAYERs can follow.

UnitsLegal RangeDefaultRequiredVariability
Btuh/ft2-oFx \(>\) 0calculated from LAYERsif omitted, LAYERs must followconstant

endConstruction

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 LAYER subobjects, if any.

UnitsLegal RangeDefaultRequiredVariability
N/ANoconstant

Related Probes:

4.6 FOUNDATION

Foundation describes the two-dimensional relationship between ground-contact SURFACEs (i.e., sfExCnd = GROUND) and the surrounding ground. A FOUNDATION is referenced by Floor SURFACEs (see sfFnd). FOUNDATIONs are used to describe the two-dimensional features of foundation designs that cannot be captured by the typical one-dimensional constructions. Dimensions from the one-dimensional CONSTRUCTIONs associated with ground-contact floors and walls will automatically be interpreted into the two-dimensional context.

Two-dimensional context
Two-dimensional context

Any wall SURFACEs in contact with the ground must refer to a Floor SURFACE object (see sfFndFloor) to indicate which floor shares the same ground domain as a boundary condition (and establish the two-dimensional context for the basis of the ground calculations).

FOUNDATION objects are used to instantiate instances of heat transfer within Kiva.

MATERIALs used in a FOUNDATION cannot have variable properties at this time.

Most of the relevant dimensions and properties in the two-dimensional context are defined in the FOUNDATION object (and FNDBLOCK subobjects) with a few exceptions specified by specific SURFACEs:

Some properties applying to all FOUNDATIONs are defined at the TOP level:

The following data members describe the dimensions and properties of the foundation wall. For below-grade walls, the CONSTRUCTION (and corresponding width) of the foundation wall is defined by the Wall SURFACEs referencing the FOUNDATION object. For on-grade floors, the CONSTRUCTION of the foundation wall must be defined using fdFtCon. The actual height of the foundation wall (from the top of the wall to the top of the slab) is defined by the corresponding SURFACE objects.

Foundation wall dimensions
Foundation wall dimensions

Other components of the foundation design (e.g., interior/exterior insulation) as well as other variations in thermal properties within the ground are defined using FNDBLOCK (foundation block) objects. Any number of FNDBLOCKs can appear after the definition of a FOUNDATION to be properly associated.

fdName

Name of foundation; give after the word FOUNDATION. Required for reference from SURFACE objects.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneYesconstant

fdWlHtAbvGrd=float

Wall height above grade.

UnitsLegal RangeDefaultRequiredVariability
ftx \(\geq\) 00.0Noconstant

fdWlDpBlwSlb=float

Wall depth below slab.

UnitsLegal RangeDefaultRequiredVariability
ftx \(\geq\) 00.0Noconstant

fdFtCon=conName

Name of CONSTRUCTION of the footing wall. Only required IF it is a slab foundation (i.e., no wall surfaces reference this FOUNDATION object).

UnitsLegal RangeDefaultRequiredVariability
Name of a Constructionnoneif a slab foundationconstant

endFoundation

Indicates the end of the foundation definition. Alternatively, the end of the foundation definition can be indicated by the declaration of another object or by END.

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

4.7 FNDBLOCK

Foundation blocks are materials within the two-dimensional domain beyond those defined by the slab and wall SURFACEs. Each block is represented as a rectangle in the domain by specifying the X (lateral) and Z (vertical) coordinates of two opposite corners. The coordinate system for each point is relative to the X and Z references defined by the user. As a convention The positive X direction is away from the building, and the positive Z direction is down.

Options for X and Z references are illustrated in the figure below.

Foundation block references
Foundation block references

The default reference is WALLINT, WALLTOP.

An example of defining a block for interior wall insulation is shown below. Here the two points defining the block (P1 and P2) are both shown relative to their reference points (Ref1 and Ref2, respectively).

Foundation block example
Foundation block example

Note: X and Z point values of zero imply that a point is the same as the reference point. The default for X and Z point values is zero since points will often align with one or both of the reference values.

It does not matter which of the four corners of a block are used to define the two points as long as they are opposite corners.

fbMat=matName

Name of MATERIAL of the foundation block.

UnitsLegal RangeDefaultRequiredVariability
Name of a MaterialnoneYesconstant

fbX1Ref=choice

Relative X origin for fbX1 point. Options are:

UnitsLegal RangeDefaultRequiredVariability
choices aboveWALLINTNoconstant

fbZ1Ref=choice

Relative Z origin for fbZ1 point. Options are:

UnitsLegal RangeDefaultRequiredVariability
choices aboveWALLTOPNoconstant

fbX1=float

The X position of the first corner of the block relative to fbX1Ref.

UnitsLegal RangeDefaultRequiredVariability
ft0.0Noconstant

fbZ1=float

The Z position of the first corner of the block relative to fbZ1Ref.

UnitsLegal RangeDefaultRequiredVariability
ft0.0Noconstant

fbX2Ref=choice

Relative X origin for fbX2 point. Options are:

UnitsLegal RangeDefaultRequiredVariability
choices aboveWALLINTNoconstant

fbZ2Ref=choice

Relative Z origin for fbZ2 point. Options are:

UnitsLegal RangeDefaultRequiredVariability
choices aboveWALLTOPNoconstant

fbX2=float

The X position of the second corner of the block relative to fbX2Ref.

UnitsLegal RangeDefaultRequiredVariability
ft0.0Noconstant

fbZ2=float

The Z position of the second corner of the block relative to fbZ2Ref.

UnitsLegal RangeDefaultRequiredVariability
ft0.0Noconstant

endFndBlock

Indicates the end of the foundation block definition. Alternatively, the end of the foundation block definition can be indicated by the declaration of another object or by END.

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

4.8 LAYER

LAYER constructs a subobject of class LAYER belonging to the current CONSTRUCTION. LAYER is not recognized except immediately following CONSTRUCTION or another LAYER. The members represent one layer (that optionally includes framing) within the CONSTRUCTION.

The layers should be specified in inside to outside order. A framed layer (lrFrmMat and lrFrmFrac given) is modeled by creating a homogenized material with weighted combined conductivity and volumetric heat capacity. Caution: it is generally preferable to model framed constructions using two separate surfaces (one with framing, one without). At most one framed layer (lrFrmMat and lrFrmFrac given) is allowed per construction.

The layer thickness may be given by lrThk, or matThk of the material, or matThk of the framing material if any. The thickness must be specified at least one of these three places; if specified in more than one place and not consistent, an error message occurs.

lrName

Name of layer (follows “LAYER”). Required only if the LAYER is later referenced in another object, for example with LIKE or ALTER; however, we suggest naming all objects for clearer error messages and future flexibility.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneNoconstant

lrMat=matName

Name of primary MATERIAL in layer.

UnitsLegal RangeDefaultRequiredVariability
name of a MATERIALnoneYesconstant

lrThk=float

Thickness of layer.

UnitsLegal RangeDefaultRequiredVariability
ftx \(>\) 0Required if matThk not specified in referenced lrMatNoconstant

lrFrmMat=matName

Name of framing MATERIAL in layer, if any. At most one layer with lrFrmMat is allowed per CONSTRUCTION. See caution above regarding framed-layer model.

UnitsLegal RangeDefaultRequiredVariability
name of a MATERIALno framed layerNoconstant

lrFrmFrac=float

Fraction of layer that is framing. Must be specified if frmMat is specified. See caution above regarding framed-layer model.

UnitsLegal RangeDefaultRequiredVariability
0 \(\leq\) x \(\leq\) 1no framed layerRequired if lrFrmMat specified, else disallowedconstant

endLayer

Optional end-of-LAYER indicator; LAYER definition may also be indicated by “END” or just starting the definition of another LAYER or other object.

Related Probes:

4.9 GLAZETYPE

GLAZETYPE constructs an object of class GLAZETYPE that represents a glazing type for use in WINDOWs.

gtName

Name of glazetype. Required for reference fromWINDOW objects, below.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneYesconstant

gtModel=choice

Selects model to be used for WINDOWs based on this GLAZETYPE.

UnitsLegal RangeDefaultRequiredVariability
SHGC, ASHWATSHGCNoconstant

gtU=float

Glazing conductance (U-factor without surface films, therefore not actually a U-factor but a C-factor). Used as wnU default; an error message will be issued if the U value is not given in the window (wnU) nor in the glazeType (gtU). Preferred Approach: To use accurately with standard winter rated U-factor from ASHRAE or NFRC enter as:

    gtU = (1/((1/U-factor)-0.85)

Where 0.85 is the sum of the interior (0.68) and exterior (0.17) design air film resistances assumed for rating window U-factors. Enter wnInH (usually 1.5=1/0.68) instead of letting it default. Enter the wnExH or let it default. It is important to use this approach if the input includes gnFrad for any gain term. Using approach 2 below will result in an inappropriate internal gain split at the window.

Approach 2. Enter gtU=U-factor and let the wnInH and wnExH default. This approach systematically underestimates the window U-factor because it adds the wnExfilm resistance to 1/U-factor thereby double counting the exterior film resistance. This approach will also yield incorrect results for gnFrad internal gain since the high wnInH will put almost all the gain back in the space.

UnitsLegal RangeDefaultRequiredVariability
Btuh/ft2-oFx \(>\) 0noneNoconstant

gtUNFRC=float

Fenestration system (including frame) U-factor evaluated at NFRC heating conditions. For ASHWAT windows, a value for the NFRC U-factor is required, set via gtUNFRC or wnUNFRC.

UnitsLegal RangeDefaultRequiredVariability
Btuh/ft2-oFx \(>\) 0noneNoconstant

gtSHGC=float

Glazing Solar Heat Gain Coefficient: fraction of normal beam insolation which gets through glass to space inside. We recommend using this to represent the glass normal transmissivity characteristic only, before shading and framing effects

UnitsLegal RangeDefaultRequiredVariability
fraction0 \(\leq\) x \(\leq\) 1noneYesconstant

gtSMSO=float

SHGC multiplier with shades open. May be overriden in the specific window input.

UnitsLegal RangeDefaultRequiredVariability
fraction0 \(\leq\) x \(\leq\) 11.0NoMonthly - Hourly

gtSMSC=float

SHGC multiplier with shades closed. May be overriden in the specific window input.

UnitsLegal RangeDefaultRequiredVariability
fraction0 \(\leq\) x \(\leq\) 1gtSMSO (no shades)NoMonthly - Hourly

gtFMult=float

Framing multiplier used if none given in window, for example .9 if frame and mullions reduce the solar gain by 10%. Default of 1.0 implies frame/mullion effects allowed for in gtSHGC’s or always specified in Windows.

UnitsLegal RangeDefaultRequiredVariability
fraction0 \(\leq\) x \(\leq\) 1gtSHGCONoMonthly - Hourly

gtPySHGC =float

Four float values separated by commas. Coefficients for incidence angle SHGC multiplier polynomial applied to gtSHGC to determine beam transmissivity at angles of incidence other than 90 degrees. The values are coefficients for first through fourth powers of the cosine of the incidence angle; there is no constant part. An error message will be issued if the coefficients do not add to one. They are used in the following computation:

    angle = incidence angle of beam radiation, measured from normal to glass.

    cosI = cos( angle)

    angMult = a*cosI + b*cosI^2 + c*cosI^3 + d*cosI^4

    beamXmisvty = gtSHGCO * angMult (shades open)

UnitsLegal RangeDefaultRequiredVariability
floatanynoneYesconstant

gtDMSHGC=float

SHGC diffuse multiplier, applied to gtSHGC to determine transmissivity for diffuse radiation.

UnitsLegal RangeDefaultRequiredVariability
fraction0 \(\leq\) x \(\leq\) 1noneYesconstant

gtDMRBSol=float

SHGC diffuse multiplier, applied to qtSHGC to determine transmissivity for diffuse radiation reflected back out the window. Misnamed as a reflectance. Assume equal to DMSHGC if no other data available.

UnitsLegal RangeDefaultRequiredVariability
fraction0 \(\leq\) x \(\leq\) 1noneYesconstant

gtNGlz=int

Number of glazings in the Glazetype (bare glass only, not including any interior or exterior shades).

UnitsLegal RangeDefaultRequiredVariability
0 \(<\) x \(\leq\) 42Noconstant

gtExShd=choice

Exterior shading type (ASHWAT only).

UnitsLegal RangeDefaultRequiredVariability
NONE INSCRNNONENoconstant

gtInShd=choice

Interior shade type (ASHWAT only).

UnitsLegal RangeDefaultRequiredVariability
NONE DRAPEMEDNONENoconstant

gtDirtLoss=float

Glazing dirt loss factor.

UnitsLegal RangeDefaultRequiredVariability
fraction0 \(\leq\) x \(\leq\) 10Noconstant

endGlazeType

Optional to indicates the end of the Glazetype. Alternatively, the end of the GLAZETYPE definition can be indicated by “END” or by beginning another object

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

Related Probes:

4.10 METER

A METER object is a user-defined “device” that records energy consumption of equipment as simulated by CSE. The user defines METERs with the desired names, then assigns energy uses of specific equipment to the desired meters using commands described under each equipment type’s class description (AIRHANDLER, TERMINAL, etc.). Additional energy use from equipment not simulated by CSE (except optionally for its effect on heating and cooling loads) can also be charged to METERs (see GAIN). The data accumulated by meters can be reported at hourly, daily, monthly, and annual (run) intervals by using REPORTs and EXPORTs of type MTR.

Meters account for energy use in the following pre-defined categories, called end uses. The abbreviations in parentheses are used in MTR report headings (and for gnMeter input, below). You also get a column for the net total on the meter (abbreviated “Tot”).

ClgCooling
HtgHeating (includes heat pump compressor)
HPBUHeat pump resistance heating (backup and defrost)
DHWDomestic (service) hot water
DHWBUDomestic (service) hot water heating backup (HPWH resistance)
DHWMFLDomestic (service) hot water heating multi-family loop pumping and loss makeup
FANCFans, AC and cooling ventilation
FANHFans, heating
FANVFans, IAQ venting
FANFans, other purposes
AUXHVAC auxiliaries such as pumps
PROCProcess
LITLighting
RCPReceptacles
EXTExterior lighting
REFRRefrigeration
DISHDishwashing
DRYClothes drying
WASHClothes washing
COOKCooking
USER1User-defined category 1
USER2User-defined category 2
BTBattery charge power
PVPhotovoltaic power generation

The user has complete freedom over how many meters are defined and how equipment is assigned to them. At one extreme, a single meter “Electricity” could be defined and have all of electrical uses assigned to it. On the other hand, definition of separate meters “Elect_Fan1”, “Elect_Fan2”, and so forth allows accounting of the electricity use for individual pieces of equipment. Various groupings are possible: for example, in a building with several air handlers, one could separate the energy consumption of the fans from the coils, or one could separate the energy use by air handler, or both ways, depending on the information desired from the run.

The members that assign energy use to meters include:

The end use can be specified by the user only for GAINs and PVARRAYs; in other cases it is hard-wired to Clg, Htg, FanC, FanH, FanV, Fan, or Aux as appropriate.

mtrName

Name of meter: required for assigning energy uses to the meter elsewhere.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneYesconstant

mtrDemandRate=float

DmdCost per Btu of demand, for a month.

UnitsLegal RangeDefaultRequiredVariability
N/ANoconstant

mtrRate=float

Cost of energy use per Btu.

UnitsLegal RangeDefaultRequiredVariability
N/ANoconstant

mtrSubmeters=list of up to 50 METERs

A comma-separate list of METERs that are accumulated into this METER with optional multipliers (see mtrSubmeterMults). Submeters facilitate flexible categorization of energy results. In addition, use of mtrSubmeterMults allows energy results from a representative model to be scaled and included in overall results. For example, a typical zone could be used to represent 5 similar spaces. The energy uses of the typical zone could be assigned to a dedicated METER that is accumulated to a main METER with a multiplier of 5. Rules –

UnitsLegal RangeDefaultRequiredVariability
names of METERsNoconstant

mtrSubmeterMults=list of up to 50 floats

Submeter multipliers. Use cases for multipliers include –

A note re default values: if mtrSubmeterMults is omitted, all multipliers are defaulted to 1. However, when mtrSubmeterMults is included, a multiplier value should be provided for each METER listed in mtrSubmeters since unspecified values are set to 0.

UnitsLegal RangeDefaultRequiredVariability
1Nohourly

endMeter

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.

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

Related Probes:

4.11 DHWMETER

A DHWMETER object is a user-defined “device” that records water consumption as simulated by CSE. The data accumulated by DHWMETERs can be reported at hourly, daily, monthly, and annual (run) intervals by using REPORTs and EXPORTs of type DHWMTR. Water use is reported in gallons.

DHWMETERs account for water use in the following pre-defined end uses. The abbreviations in parentheses are used in DHWMTR report headings.

DHWSYS items wsWHhwMtr and wsFXhwMtr specify the DHWMETER(s) to which water consumption is accumulated.

dhwMtrName

Name of meter: required for assigning water uses to the DHWMETER.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneYesconstant

endDhwMeter

Related Probes:

4.12 AFMETER

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 ZONE znAFMtr).

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 IZXFER izAFCat.

If any AFMETERs are defined, an additional AFMETER “sum_of_AFMETERs” is automatically created where the sums of all user-define AFMETERs are accumulated.

Note that only AirNet flows are recorded.

AFMETER results can be REPORTed using rpType=AFMTR (or EXPORTed using exType=AFMTR). See Air Flow Meter Report.

afMtrName

Name of meter: required for assigning air flows to the AFMETER.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneYesconstant

endAFMeter

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.

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

Related Probes:

4.13 LOADMETER

A LOADMETER object is a user-defined “device” that records heating and cooling loads as computed by CSE. The user defines LOADMETERs and assigns them to ZONEs and/or RSYSs (see ZONE znLoadMtr and RSYS rsLoadMtr).

Loads are accumulated for subhour, hour, day, month, and annual intervals. All values are in Btu. Values >0 indicated heat into the process or zone – thus heating loads are >0 and cooling loads are <0.

LOADMETER results must be reported using user-defined REPORTs or EXPORTs. For example –

REPORT rpType=UDT rpFreq=Month rpDayBeg=Jan 1 rpDayEnd=Dec 31
    REPORTCOL colHead="mon" colVal=$Month colWid=3
    REPORTCOL colHead="Heating" colVal=@LoadMeter[ 1].M.qHtg colDec=0 colWid=10
    REPORTCOL colHead="Cooling" colVal=@LoadMeter[ 1].M.qClg colDec=0 colWid=10

ldMtrName

Name of LOADMETER: required for assigning to ZONEs and RSYSs.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneYesconstant

lmtSubmeters=list of up to 50 LOADMETERs

A comma-separate list of LOADMETERs that are accumulated into this LOADMETER with optional multipliers (see lmtSubmeterMults). Submeters facilitate flexible categorization of loads results. In addition, use of lmtSubmeterMults allows load results from a representative model to be scaled and included in overall results. For example, a typical zone could be used to represent 5 similar spaces. The loads calculated for the typical zone could be assigned to a dedicated LOADMETER and that LOADMETER accumulated to a main LOADMETER with a multiplier of 5. Rules –

UnitsLegal RangeDefaultRequiredVariability
names of LOADMETERsNoconstant

lmtSubmeterMults=list of up to 50 floats

Submeter multipliers.

A note re default values: if lmtSubmeterMults is omitted, all multipliers are defaulted to 1. However, when lmtSubmeterMults is included, a multiplier value should be provided for each LOADMETER listed in lmtSubmeters since unspecified values are set to 0.

UnitsLegal RangeDefaultRequiredVariability
1Nosubhourly

endLOADMETER

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.

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

Related Probes:

4.14 ZONE

ZONE constructs an object of class ZONE, which describes an area of the building to be modeled as having a uniform condition. ZONEs are large, complex objects and can have many subobjects that describe associated surfaces, shading devices, HVAC equipment, etc.

4.14.1 ZONE General Members

znName

Name of zone. Enter after the word ZONE; no “=” is used.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneYesconstant

znModel=choice

Selects model for zone.

CNEOlder central difference model based on original CALPAS methods. Not fully supported and not suitable for current compliance applications.
CZMConditioned zone model. Forward-difference, short time step methods are used.
UZMUnconditioned zone model. Identical to CZM except heating and cooling are not supported. Typically used for attics, garages, and other ancillary spaces.
UnitsLegal RangeDefaultRequiredVariability
choices aboveCNENoconstant

znArea=float

Nominal zone floor area.

UnitsLegal RangeDefaultRequiredVariability
ft2x \(>\) 0noneYesconstant

znVol=float

Nominal zone volume.

UnitsLegal RangeDefaultRequiredVariability
ft3x \(>\) 0noneYesconstant

znAzm=float

Zone azimuth with respect to bldgAzm. All surface azimuths are relative to znAzm, so that the zone can be rotated by changing this member only. Values outside the range 0o to 360o are normalized to that range.

UnitsLegal RangeDefaultRequiredVariability
degreesunrestricted0Noconstant

znFloorZ=float

Nominal zone floor height relative to arbitrary 0 level. Used re determination of vent heights

UnitsLegal RangeDefaultRequiredVariability
ftunrestricted0Noconstant

znCeilingHt=float

Nominal zone ceiling height relative to zone floor (typically 8 – 10 ft).

UnitsLegal RangeDefaultRequiredVariability
ftx \(>\) 0znVol / znAreaNoconstant

znEaveZ=float

Nominal eave height above ground level. Used re calculation of local surface wind speed. This in turn influences outside convection coefficients in some surface models and wind-driven air leakage.

UnitsLegal RangeDefaultRequiredVariability
ftx \(>\) 0znFloorZ + infStories8*Noconstant

znCAir=float

Zone “air” heat capacity: represents heat capacity of air, furniture, “light” walls, and everything in zone except surfaces having heat capacity (that is, non-QUICK surfaces).

UnitsLegal RangeDefaultRequiredVariability
Btu/oFx \(\geq\) 03.5 znArea*Noconstant

znHcAirX=float

Zone air exchange rate used in determination of interior surface convective coefficients. This item is generally used only for model testing.

UnitsLegal RangeDefaultRequiredVariability
ACHx \(>\) 0as modeledNosubhourly

znHcFrcF=float

Zone surface forced convection factor. Interior surface convective transfer is modeled as a combination of forced and natural convection. hcFrc = znHcFrcF * znHcAirX^.8. See CSE Engineering Documentation.

UnitsLegal RangeDefaultRequiredVariability
Btuh/ft2-oF.2.2Nohourly

znHIRatio=float

Zone hygric inertia ratio. In zone moisture balance calculations, the effective dry-air mass = znHIRatio * (zone dry air mass). This enhancement can be used to represente the moisture storage capacity of zone surfaces and contents.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 01Noconstant

znSC=float

Zone shade closure. Determines insolation through windows (see WINDOW members wnSCSO and wnSCSC) and solar gain distribution: see SGDIST members sgFSO and sgFSC. 0 represents shades open; 1 represents shades closed; intermediate values are allowed. An hourly variable CSE expression may be used to schedule shade closure as a function of weather, time of year, previous interval HVAC use or zone temperature, etc.

UnitsLegal RangeDefaultRequiredVariability
0 \(\leq\) x \(\leq\) 11 when cooling was used in previous hour, else 0Nohourly

znTH=float

Heating set point for znModel=CZM.

UnitsLegal RangeDefaultRequiredVariability
oFx \(\geq\) 0noneNosubhourly

znTD=float

Desired set point (temperature maintained with ventilation if possible) for znModel=CZM

UnitsLegal RangeDefaultRequiredVariability
oFx \(\geq\) 0noneNosubhourly

znTC=float

Cooling set point for znModel=CZM.

UnitsLegal RangeDefaultRequiredVariability
oFx \(\geq\) 0noneNosubhourly

CZM zone heating and cooling is provided either via an RSYS HVAC system or by “magic” heat transfers specified by znQxxx items.

znRSys=rsysName

Name of RSYS providing heating, cooling, and optional central fan integrated ventilation to this zone.

UnitsLegal RangeDefaultRequiredVariability
RSYS name(no RSYS)Noconstant

znQMxH=float

Heating capacity at current conditions

UnitsLegal RangeDefaultRequiredVariability
Btuhx \(\geq\) 0noneNohourly

znQMxHRated=float

Rated heating capacity

UnitsLegal RangeDefaultRequiredVariability
Btuhx \(\geq\) 0noneNoconstant

znQMxC=float

Cooling capacity at current conditions

UnitsLegal RangeDefaultRequiredVariability
Btuhx \(\leq\) 0noneNohourly

znQMxCRated=float

Rated cooling capacity

UnitsLegal RangeDefaultRequiredVariability
Btuhx \(\leq\) 0noneNoconstant

4.14.2 ZONE Infiltration

The following control a simplified air change plus leakage area model. The Sherman-Grimsrud model is used to derive air flow rate from leakage area and this rate is added to the air changes specified with infAC. Note that TOP.windF does not modify calculated infiltration rates, since the Sherman-Grimsrud model uses its own modifiers. See also AirNet models available via IZXFER.

infAC=float

Zone infiltration air changes per hour.

UnitsLegal RangeDefaultRequiredVariability
1/hrx \(\geq\) 00.5Nohourly

infELA=float

Zone effective leakage area (ELA).

UnitsLegal RangeDefaultRequiredVariability
in2x \(\geq\) 00.0Nohourly

infShld=int

Zone local shielding class, used in derivation of local wind speed for ELA infiltration model, wind-driven AirNet leakage, and exterior surface coefficients. infShld values are –

1no obstructions or local shielding
2light local shielding with few obstructions
3moderate local shielding, some obstructions within two house heights
4heavy shielding, obstructions around most of the perimeter
5very heavy shielding, large obstructions surrounding the perimeter within two house heights
UnitsLegal RangeDefaultRequiredVariability
1 \(\leq\) x \(\leq\) 53Noconstant

infStories=int

Number of stories in zone, used in ELA model.

UnitsLegal RangeDefaultRequiredVariability
1 \(\leq\) x \(\leq\) 31Noconstant

znWindFLkg=float

Wind speed modifier factor. The weather file wind speed is multiplied by this factor to yield a local wind speed for use in infiltration and convection models.

UnitsLegal RangeDefaultRequiredVariability
x \(\geq\) 0derived from znEaveZ and infShldNoconstant

znAFMtr=afMtrName

Name of an AFMETER object, if any, to which zone AirNet air flows are recorded. ZnAFMtr defines a pressure boundary for accounting purposes. Multiple zones having the same AFMETER are treated as a single volume – interzone flows within that volume are not recorded. For example, to obtain “building total” flow data, a common AFMETER could be assigned to several conditioned zones but not to adjacent unconditioned zones such as attic spaces.

UnitsLegal RangeDefaultRequiredVariability
name of an AFMETERnot recordedNoconstant

znLoadMtr=ldMtrName

Name of a LOADMETER object, if any, to which zone heating and cooling loads are recorded.

UnitsLegal RangeDefaultRequiredVariability
name of a LOADMETERnot recordedNoconstant

4.14.3 ZONE Exhaust Fan

Presence of an exhaust fan in a zone is indicated by specifying a non-zero design flow value (xfanVfDs).

Zone exhaust fan model implementation is incomplete as of July, 2011. The current code calculates energy use but does not account for the effects of air transfer on room heat balance. IZXFER provides a more complete implementation.

xfanFOn=float

Exhaust fan on fraction. On/off control assumed, so electricity requirement is proportional to run time.

UnitsLegal RangeDefaultRequiredVariability
fraction0 \(\leq\) x \(\leq\) 11Nohourly

Example: The following would run an exhaust fan 70% of the time between 8 AM and 5 PM:

    xfanFOn = select( (\$hour >= 7 && \$hour < 5), .7,
                                          default, 0 );

xfanVfDs=float

Exhaust fan design flow; 0 or not given indicates no fan.

UnitsLegal RangeDefaultRequiredVariability
cfmx \(\geq\) 00, no fanIf fan presentconstant

xfanPress=float

Exhaust fan external static pressure.

UnitsLegal RangeDefaultRequiredVariability
inches0.05 \(\leq\) x \(\leq\) 1.00.3Noconstant

Only one of xfanElecPwr, xfanEff, and xfanShaftBhp may be given: together with xfanVfDs and xfanPress, any one is sufficient for CSE to detemine the others and to compute the fan heat contribution to the air stream.

xfanElecPwr=float

Fan input power per unit air flow (at design flow and pressure).

UnitsLegal RangeDefaultRequiredVariability
W/cfmx \(>\) 0derived from xfanEffIf xfanEff and xfanShaftBhp not presentconstant

xfanEff=float

Exhaust fan/motor/drive combined efficiency.

UnitsLegal RangeDefaultRequiredVariability
fraction0 \(\leq\) x \(\leq\) 10.08Noconstant

xfanShaftBhp=float

Fan shaft power at design flow and pressure.

UnitsLegal RangeDefaultRequiredVariability
BHPx \(>\) 0derived from xfanElecPwr and xfanVfDsIf xfanElecPwr not presentconstant

xfanMtr=mtrName

Name of METER object, if any, by which fan’s energy use is recorded (under end use category “fan”).

UnitsLegal RangeDefaultRequiredVariability
name of a METERnot recordedNoconstant

endZone

Indicates the end of the zone definition. Alternatively, the end of the zone definition can be indicated by the declaration of another object or by “END”. If END or endZone is used, it should follow the definitions of the ZONE’s subobjects such as GAINs, SURFACEs, TERMINALs, etc.

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

Related Probes:

4.15 GAIN

A GAIN object adds sensible and/or latent heat to the ZONE, and/or adds arbitrary energy use to a METER. GAINs may be subobjects of ZONEs and are normally given within the input for their ZONE. As many GAINs as desired (or none) may be given for each ZONE. Alternatively, GAINs may be subobjects of TOP and specify gnZone to specify their associate zone.

Each gain has an amount of power (gnPower), which may optionally be accumulated to a METER (gnMeter). The power may be distributed to the zone, plenum, or return as sensible heat with an optional fraction radiant, or to the zone as latent heat (moisture addition), or not.

4.15.1 Gain zones

The gain to the zone may be further divided into convective sensible, radiant sensible and latent heat via the gnFrRad and gnFrLat members; the plenum and return gains are assumed all convective sensible.

In the CNE zone mode, the radiant internal gain is distributed to the surfaces in the zone, rather than going directly to the zone “air” heat capacity (znCAir). A simple model is used – all surfaces are assumed to be opaque and to have the same (infrared) absorptivity – even windows. Along with the assumption that the zone is spherical (implicit in the current treatment of solar gains), this allows distribution of gains to surfaces in proportion to their area, without any absorptivity or transmissivity calculations. The gain for windows and quick-model surfaces is assigned to the znCAir, except for the portion which conducts through the surface to the other side rather than through the surface film to the adjacent zone air; the gain to massive (delayed-model) surfaces is assigned to the side of surface in the zone with the gain.

Radiant internal gains are included in the IgnS (Sensible Internal Gain) column in the zone energy balance reports. (They could easily be shown in a separate IgnR column if desired.) Any energy transfer shows two places in the ZEB report, with opposite signs, so that the result is zero – otherwise it wouldn’t be an energy balance. The rest of the reporting story for radiant internal gains turns out to be complex. The specified value of the radiant gain (gnPower * gnFrZn * gnFrRad) shows in the IgnS column. To the extent that the gain heats the zone, it also shows negatively in the Masses column, because the zone CAir is lumped with the other masses. To the extent that the gain heats massive surfaces, it also shows negatively in the masses column. To the extent that the gain conducts through windows and quick-model surfaces, it shows negatively in the Conduction column. If the gain conducts through a quick-model surface to another zone, it shows negatively in the Izone (Interzone) column, positively in the Izone column of the receiving zone, and negatively in the receiving zone’s Masses or Cond column.

gnName

Name of gain; follows the word GAIN if given.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneNoconstant

gnZone=znName

Name of ZONE to which heat gains are added. Omitted when GAIN is given as a ZONE subobject. If a TOP subobject (i.e., not a ZONE subobject) and znZone is omitted, heat gains are discarded but energy use is still recorded to gnMeter. This feature can be used to represent energy uses that our outside of conditioned zones (e.g. exterior lighting).

UnitsLegal RangeDefaultRequiredVariability
name of ZONEparent zone if anyNoconstant

gnPower=float

Rate of heat addition/energy use. Negative gnPower values may be used to represent heat removal/energy generation. Expressions containing functions are commonly used with this member to schedule the gain power on a daily and/or hourly basis. Refer to the functions section in Section 4 for details and examples.

All gains, including electrical, are specified in Btuh units unless associated with DHW use (see gnCtrlDHWSYS), in which case gnPower is specified in Btuh/gal. Note that meter reporting of internal gain is in MBtu (millions of Btu) by default.

UnitsLegal RangeDefaultRequiredVariability
Btuhno restrictionsnoneYeshourly

gnMeter=choice

Name of meter by which this GAIN’s gnPower is recorded. If omitted, gain is assigned to no meter and energy use is not accounted in CSE simulation reports; thus, gnMeter should only be omitted for “free” energy sources.

UnitsLegal RangeDefaultRequiredVariability
name of METERnoneNoconstant

gnEndUse=choice

Meter end use to which the GAIN’s energy use should be accumulated.

ClgCooling
HtgHeating (includes heat pump compressor)
HPBUHeat pump resistance heating (backup and defrost)
DHWDomestic (service) hot water
DHWBUDomestic (service) hot water heating backup (HPWH resistance)
DHWMFLDomestic (service) hot water heating multi-family loop pumping and loss makeup
FANCFans, AC and cooling ventilation
FANHFans, heating
FANVFans, IAQ venting
FANFans, other purposes
AUXHVAC auxiliaries such as pumps
PROCProcess
LITLighting
RCPReceptacles
EXTExterior lighting
REFRRefrigeration
DISHDishwashing
DRYClothes drying
WASHClothes washing
COOKCooking
USER1User-defined category 1
USER2User-defined category 2
BTBattery charge power
PVPhotovoltaic power generation
UnitsLegal RangeDefaultRequiredVariability
Codes listed abovenoneRequired if gnMeter is givenconstant

The gnFrZn, gnFrPl, and gnFrRtn members allow you to allocate the gain among the zone, the zone’s plenum, and the zone’s return air flow. Values that total to more than 1.0 constitute an error. If they total less than 1, the unallocated portion of the gain is recorded by the meter (if specified) but not transferred into the building. By default, all of the gain not directed to the return or plenum goes to the zone.

gnFrZn=float

Fraction of gain going to zone. gnFrLat (below) gives portion of this gain that is latent, if any; the remainder is sensible.

UnitsLegal RangeDefaultRequiredVariability
0 \(\leq\) x \(\leq\) 11.Nohourly

gnFrPl=float

Fraction of gain going to plenum.

UnitsLegal RangeDefaultRequiredVariability
gnFrZn + gnFrPl + gnFrRtn \(\leq\) 10.Nohourly

gnFrRtn=float

Fraction of gain going to return.

UnitsLegal RangeDefaultRequiredVariability
gnFrZn + gnFrPl + gnFrRtn \(\leq\) 10.Nohourly

gnFrRad=float

Fraction of total gain going to zone (gnFrZn) that is radiant rather than convective or latent.

UnitsLegal RangeDefaultRequiredVariability
0 \(\leq\) x \(\leq\) 10.0Nohourly

gnFrLat=float

Fraction of total gain going to zone (gnFrZn) that is latent heat (moisture addition).

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 10.0Nohourly

gnDlFrPow=float

Hourly power reduction factor, typically used to modify lighting power to account for daylighting.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 11.0Nohourly

gnCtrlDHWSYS=dhwsysName

Name of a DHWSYS whose water use modulates gnPower. For example, electricity use of water-using appliances (e.g. dishwasher or clothes washer) can be modeled based on water use, ensuring that the uses are synchronized. When this feature is used, gnPower should be specified in Btuh/gal.

UnitsLegal RangeDefaultRequiredVariability
name of a DHWSYSno DHWSYS/GAIN linkageNoconstant

gnCtrlDHWMETER=dhwMtrName

Allows gains to track water usage such as dishwashers, clothes washers, etc.

UnitsLegal RangeDefaultRequiredVariability
name of DHWMETER0Noconstant

gnCtrlDHWEndUse=dhwEndUseName

Name of the DHWSYS end use consumption that modulates gnPower. See DHWMETER for DHW end use definitions.

UnitsLegal RangeDefaultRequiredVariability
DHW end useTotalNoconstant

endGain

Optional to indicate the end of the GAIN definition. Alternatively, the end of the gain definition can be indicated by END or by the declaration of another object.

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

Related Probes:

4.16 SURFACE

Surface constructs a ZONE subobject of class SURFACE that represents a surrounding or interior surface of the zone. Internally, SURFACE generates a QUICK surface (U-value only), a DELAYED (massive) surface (using the finite-difference mass model), interzone QUICK surface, or interzone DELAYED surface, as appropriate for the specified construction and exterior conditions.

sfName

Name of surface; give after the word SURFACE.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneNoconstant

sfType=choice

Type of surface:

FLOORSurface defines part or all of the ‘bottom’ of the zone; it is horizontal with inside facing up. The outside of the surface is not adjacent to the current zone.
WALLSurface defines a ‘side’ of the zone; its outside is not adjacent to the current zone.
CEILINGSurface defines part or all of the ‘top’ of the zone with the inside facing down. The outside of the surface is not adjacent to the current zone.

sfType is used extensively for default determination and input checking, but does not have any further internal effect. The Floor, Wall, and Ceiling choices identify surfaces that form boundaries between the zone and some other condition.

UnitsLegal RangeDefaultRequiredVariability
FLOOR WALL CEILINGnoneYesconstant

sfArea=float

Gross area of surface. (CSE computes the net area for simulation by subtracting the areas of any windows and doors in the surface.).

UnitsLegal RangeDefaultRequiredVariability
ft2x \(>\) 0noneYesconstant

sfTilt=float

Surface tilt from horizontal. Values outside the range 0 to 360 are first normalized to that range. The default and allowed range depend on sfType, as follows:

sfType = FLOORsfTilt=180, default = 180 (fixed value)
sfType = WALL60 \(<\) sfTilt \(<\) 180, default = 90
sfType = CEILING0 \(\leq\) sfTilt \(\leq\) 60, default = 0
UnitsLegal RangeDefaultRequiredVariability
degreesDependent upon sfType See aboveDependent upon sfType See aboveNoconstant

sfAzm=float

Azimuth of surface with respect to znAzm. The azimuth used in simulating a surface is bldgAzm + znAzm + sfAzm; the surface is rotated if any of those are changed. Values outside the range 0 to 360 are normalized to that range. Required for non-horizontal surfaces.

UnitsLegal RangeDefaultRequiredVariability
degreesunrestrictednoneRequired if sfTilt \(\neq\) 0 and sfTilt \(\neq\) 180constant

sfModel=choice

Provides user control over how CSE models conduction for this surface.

QUICKSurface is modeled using a simple conductance. Heat capacity effects are ignored. Either sfCon or sfU (next) can be specified.
DELAYED, DELAYED_HOUR, DELAYED_SUBHOURSurface is modeled using a multi-layer finite difference technique that represents heat capacity effects. If the time constant of the surface is too short to accurately simulate, a warning message is issued and the Quick model is used. The program cannot use the finite difference model if sfU rather than sfCon is specified.
AUTOProgram selects Quick or the appropriate Delayed automatically according to the time constant of the surface (if sfU is specified, Quick is selected).
FD (or FORWARD_DIFFERENCE)Selects the forward difference model (used with short time steps and the CZM/UZM zone model).
KIVAUses a two-dimensional finite difference model to simulate heat flow through foundation surfaces.
UnitsLegal RangeDefaultRequiredVariability
QUICK, DELAYED, DELAYED_HOUR, DELAYED_SUBOUR , AUTO, 2D_FNDAUTONoconstant

Either sfU or sfCon must be specified, but not both.

sfU=float

Surface U-value (NOT including surface (air film) conductances). For surfaces for which no heat capacity is to be modeled, allows direct entry of U-value without defining a CONSTRUCTION.

UnitsLegal RangeDefaultRequiredVariability
Btuh/ft2-oFx \(>\) 0Determined from sfConif sfCon not givenconstant

sfCon=conName

Name of CONSTRUCTION of the surface.

UnitsLegal RangeDefaultRequiredVariability
Name of a CONSTRUCTIONnoneunless sfU givenconstant

sfLThkF=float

Sublayer thickness adjustment factor for FORWARD_DIFFERENCE conduction model used with sfCon surfaces. Material layers in the construction are divided into sublayers as needed for numerical stability. sfLThkF allows adjustment of the thickness criterion used for subdivision. A value of 0 prevents subdivision; the default value (0.5) uses layers with conservative thickness equal to half of an estimated safe value. Fewer (thicker) sublayers improves runtime at the expense of accurate representation of rapid changes.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 00.5Noconstant

sfExCnd=choice

Specifies the thermal conditions assumed at surface exterior, and at exterior of any subobjects (windows or doors) belonging to current surface. The conditions accounted for are dry bulb temperature and incident solar radiation.

AMBIENTExterior surface is exposed to the ‘weather’ as read from the weather file. Solar gain is calculated using solar geometry, sfAzm, sfTilt, and sfExAbs.
SPECIFIEDTExterior surface is exposed to solar radiation as in AMBIENT, but the dry bulb temperature is calculated with a user specified function (sfExT). sfExAbs can be set to 0 to eliminate solar effects.
ADJZNExterior surface is exposed to another zone, whose name is specified by sfAdjZn. Solar gain is 0 unless gain is targeted to the surface with SGDIST below.
GROUNDThe surface is in contact with the ground. Details of the two-dimensional foundation design are defined by sfFnd. Only floor and wall surfaces may use this option.
ADIABATICExterior surface heat flow is 0. Thermal storage effects of delayed surfaces are modeled.

sfExAbs=float

Surface exterior absorptivity.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 10.5Required if sfExCnd = AMBIENT or sfExCnd = SPECIFIEDTmonthly-hourly

sfInAbs=float

Surface interior solar absorptivity.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(le\) 1sfType = CEILING, 0.2; sfType = WALL, 0.6; sfType = FLOOR, 0.8Nomonthly-hourly

sfExEpsLW=float

Surface exterior long wave (thermal) emittance.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 10.9Noconstant

sfInEpsLW=float

Surface interior long wave (thermal) emittance.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 10.9Noconstant

sfExT=float

Exterior air temperature.

UnitsLegal RangeDefaultRequiredVariability
oFunrestrictednoneRequired if sfExCnd = SPECIFIEDThourly

sfAdjZn=znName

Name of adjacent zone; used only when sfExCnd is ADJZN. Can be the same as the current zone.

UnitsLegal RangeDefaultRequiredVariability
name of a ZONEnoneRequired when
sfExCnd = ADJZN
constant

sfGrndRefl=float

Ground reflectivity for this surface.

UnitsLegal RangeDefaultRequiredVariability
fraction0 \(\leq\) x \(\leq\) 1grndReflNoMonthly - Hourly

sfInH=float

Inside surface (air film) conductance. Ignored for sfModel = Forward_Difference. Default depends on the surface type.

sfType = FLOOR or CEILING1.32
other1.5
UnitsLegal RangeDefaultRequiredVariability
Btuh/ft2-oFx \(>\) 0See aboveNoconstant

sfExH=float

Outside combined surface (air film) conductance. Ignored for sfModel = Forward_Difference. The default value is dependent upon the exterior conditions:

sfExCnd = AMBIENTdflExH (Top-level member, described above)
sfExCnd = SPECIFIEDTdflExH (described above)
sfExCnd = ADJZN1.5
sfExCnd = ADIABATICnot applicable
UnitsLegal RangeDefaultRequiredVariability
Btuh/ft2-oFx \(>\) 0see aboveNoconstant

When sfModel = Forward_Difference, several models are available for calculating inside and outside surface convective coefficients. Inside surface faces can be exposed only to zone conditions. Outside faces may be exposed either to ambient conditions or zone conditions, based on sfExCnd. Only UNIFIED and INPUT are typically used. The other models were used during CSE development for comparison. For details, see CSE Engineering Documentation.

ModelExposed to ambientExposed to zone
UNIFIEDdefault CSE modeldefault CSE model
INPUThc = sfExHcMulthc = sfxxHcMult
AKBARIAkbari modeln/a
WALTONWalton modeln/a
WINKELMANNWinkelmann modeln/a
DOE2DOE2 modeln/a
MILLSn/aMills model
ASHRAEn/aASHRAE handbook values
TARPn/aTARP model

sfExHcModel=choice

Selects the model used for exterior surface convection when sfModel = Forward_Difference.

UnitsLegal RangeDefaultRequiredVariability
choices aboveUNIFIEDNoconstant

sfExHcLChar=float

Characteristic length of surface, used in derivation of forced exterior convection coefficients in some models when outside surface is exposed to ambient. See sfExHcModel.

UnitsLegal RangeDefaultRequiredVariability
ftx \(>\) 010Noconstant

sfExHcMult=float

Exterior convection coefficient adjustment factor. When sfExHcModel=INPUT, hc=sfExHcMult. For other sfExHcModel choices, the model-derived hc is multiplied by sfExHcMult.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 01Nosubhourly

sfExRf=float

Exterior surface roughness factor. Used only when surface is exposed to ambient (i.e. with wind exposure). Typical values:

Roughness IndexsfExRfExample
1 (very rough)2.17Stucco
2 (rough)1.67Brick
3 (medium rough)1.52Concrete
4 (Medium smooth)1.13Clear pine
5 (Smooth)1.11Smooth plaster
6 (Very Smooth)1Glass
UnitsLegal RangeDefaultRequiredVariability
sfExHcModel = WINKELMANN: 1.66 else 2.17Noconstant

sfInHcModel=choice

Selects the model used for the inside (zone) surface convection when sfModel = Forward_Difference.

UnitsLegal RangeDefaultRequiredVariability
choices above (see sfExHcModel)UNIFIEDNoconstant

sfInHcMult=float

Interior convection coefficient adjustment factor. When sfInHcModel=INPUT, hc=sfInHcMult. For other sfInHcModel choices, the model-derived hc is multiplied by sfInHcMult.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 01Nosubhourly

The items below give values associated with CSE’s model for below grade surfaces (sfExCnd=GROUND). See CSE Engineering Documentation for technical details.

sfFnd=fdName

Name of FOUNDATION applied to ground-contact Floor SURFACEs; used only for Floor SURFACEs when sfExCnd is GROUND.

UnitsLegal RangeDefaultRequired**Variability
Name of a Foundationnonewhen
sfExCnd = GROUND and
sfType = Floor
constant

sfFndFloor=sfName

Name of adjacent ground-contact Floor SURFACE; used only for Wall SURFACEs when sfExCnd is GROUND.

UnitsLegal RangeDefaultRequiredVariability
Name of a Surfacenonewhen
sfExCnd = GROUND and
sfType = Wall
constant

sfHeight=float

Needed for foundation wall height, otherwise ignored. Maybe combine with sfDepthBG?

UnitsLegal RangeDefaultRequiredVariability
ftx \(>\) 0nonewhen sfType is WALL and sfExtCnd is GROUNDconstant

sfExpPerim=float

Exposed perimeter of foundation floors.

UnitsLegal RangeDefaultRequiredVariability
ftx \(\geq\) 0nonewhen sfType is FLOOR, sfFnd is set, and sfExtCnd is GROUNDconstant

sfDepthBG=float

Note: sfDepthBG is used as part of the simple ground model, which is no longer supported. Use sfHeight with sfFnd instead.

Depth below grade of surface. For walls, sfDepthBG is measured to the lower edge. For floors, sfDepthBG is measured to the bottom face.

UnitsLegal RangeDefaultRequiredVariability
ftx \(\ge\) 0noneNoconstant

Note: The following data members are part of the simple ground model, which is no longer supported. Use sfFnd instead.

sfExCTGrnd=float

sfExCTaDbAvg07=float

sfExCTaDbAvg14=float

sfExCTaDbAvg31=float

sfExCTaDbAvgYr=float

Conductances from outside face of surface to the weather file ground temperature and the moving average outdoor dry-bulb temperatures for 7, 14, 31, and 365 days.

UnitsLegal RangeDefaultRequiredVariability
Btuh/ft2-oFx \(\ge\) 0see aboveNoconstant

sfExRConGrnd=float

Resistance overall construction resistance. TODO: full documentation.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 0noneNoconstant

endSURFACE

Optional to indicates the end of the surface definition. Alternatively, the end of the surface definition can be indicated by END, or by beginning another SURFACE or other object definition. If used, should follow the definitions of the SURFACE’s subobjects – DOORs, WINDOWs, SHADEs, SGDISTs, etc.

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

Related Probes:

4.17 WINDOW

WINDOW defines a subobject belonging to the current SURFACE that represents one or more identical windows. The azimuth, tilt, and exterior conditions of the window are the same as those of the surface to which it belongs. The total window area (wnHt \(\cdot\) wnWid \(\cdot\) wnMult) is deducted from the gross surface area. A surface may have any number of windows.

Windows may optionally have operable interior shading that reduces the overall shading coefficient when closed.

wnName

Name of window: follows the word “WINDOW” if given.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneNoconstant

wnHeight=float

Overall height of window (including frame).

UnitsLegal RangeDefaultRequiredVariability
ftx \(>\) 0noneYesconstant

wnWidth=float

Overall width of window (including frame).

UnitsLegal RangeDefaultRequiredVariability
ftx \(>\) 0noneYesconstant

wnArea=float

Overall area of window (including frame).

UnitsLegal RangeDefaultRequiredVariability
ft2x \(>\) 0wnHeight wnWidth*Noconstant

wnMult=float

Area multiplier; can be used to represent multiple identical windows.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 01Noconstant

wnModel=choice

Selects window model

UnitsLegal RangeDefaultRequiredVariability
SHGC, ASHWATSHGCNoconstant

wnGt=choice

GLAZETYPE for window. Provides many defaults for window properties as cited below.

wnU=float

Window conductance (U-factor without surface films, therefore not actually a U-factor but a C-factor).

Preferred Approach: To use accurately with standard winter rated U-factor from ASHRAE or NFRC enter as:

    wnU = (1/((1/U-factor)-0.85)

Where 0.85 is the sum of the interior (0.68) and exterior (0.17) design air film resistances assumed for rating window U-factors. Enter wnInH (usually 1.5=1/0.68) instead of letting it default. Enter the wnExH or let it default. It is important to use this approach if the input includes gnFrad for any gain term. Using approach 2 below will result in an inappropriate internal gain split at the window.

Approach 2. Enter wnU=U-factor and let the wnInH and wnExH default. Tnormally this approach systematically underestimates the window U-factor because it adds the wnExfilm resistance to 1/U-factor thereby double counting the exterior film resistance. This approach will also yield incorrect results for gnFrad internal gain since the high wnInH will put almost all the gain back in the space.

UnitsLegal RangeDefaultRequiredVariability
Btuh/ft2-oFx \(>\) 0noneYesconstant

wnUNFRC=float

Fenestration system (including frame) U-factor evaluated at NFRC heating conditions.

UnitsLegal RangeDefaultRequiredVariability
Btuh/ft2-oFx \(>\) 0gtUNFRCRequired when wnModel = ASHWATconstant

wnExEpsLW=float

Window exterior long wave (thermal) emittance.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 10.84Noconstant

wnInEpsLW=float

Window interior long wave (thermal) emittance.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 10.84Noconstant

wnInH=float

Window interior surface (air film) conductance.

Preferred Approach: Enter the appropriate value for each window, normally:

    wnInH = 1.5

    where 1.5 = 1/0.68 the standard ASHRAE value.

The large default value of 10,000 represents a near-0 resistance, for the convenience of those who wish to include the interior surface film in wnU according to approach 2 above.

UnitsLegal RangeDefaultRequiredVariability
Btuh/ft2-oFx \(>\) 010000Noconstant

wnExH=float

Window exterior surface (air film) conductance.

UnitsLegal RangeDefaultRequiredVariability
Btuh/ft2-oFx \(>\) 0same as owning surfaceNoconstant

Several models are available for calculating inside and outside surface convective coefficients. Inside surface faces can be exposed only to zone conditions. Outside faces may be exposed either to ambient conditions or zone conditions, based on wnExCnd. Only UNIFIED and INPUT are typically used. The other models were used during CSE development for comparison. For details, see CSE Engineering Documentation.

ModelExposed to ambientExposed to zone
UNIFIEDdefault CSE modeldefault CSE model
INPUThc = wnExHcMulthc = wnxxHcMult
AKBARIAkbari modeln/a
WALTONWalton modeln/a
WINKELMANNWinkelmann modeln/a
MILLSn/aMills model
ASHRAEn/aASHRAE handbook values

wnExHcModel=choice

Selects the model used for exterior surface convection when wnModel = Forward_Difference.

UnitsLegal RangeDefaultRequiredVariability
choices aboveUNIFIEDNoconstant

wnExHcLChar=float

Characteristic length of surface, used in derivation of forced exterior convection coefficients in some models when outside face is exposed to ambient (i.e. to wind).

UnitsLegal RangeDefaultRequiredVariability
ftx \(>\) 010Noconstant

wnExHcMult=float

Exterior convection coefficient adjustment factor. When wnExHcModel=INPUT, hc=wnExHcMult. For other wnExHcModel choices, the model-derived hc is multiplied by wnExHcMult.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 01Nosubhourly

wnInHcModel=choice

Selects the model used for the inside (zone) surface convection when wnModel = Forward_Difference.

UnitsLegal RangeDefaultRequiredVariability
choices above (see wnExHcModel)UNIFIEDNoconstant

wnInHcMult=float

Interior convection coefficient adjustment factor. When wnInHcModel=INPUT, hc=wnInHcMult. For other wnInHcModel choices, the model-derived hc is multiplied by wnInHcMult.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 01Nosubhourly

wnSHGC=float

Rated Solar Heat Gain Coefficient (SHGC) for the window assembly.

UnitsLegal RangeDefaultRequiredVariability
fraction0 < x < 1gtSHGCNoconstant

wnFMult=float

Frame area multiplier = areaGlaze / areaAssembly

UnitsLegal RangeDefaultRequiredVariability
fraction0 < x < 1gtFMult or 1Noconstant

wnSMSO=float

SHGC multiplier with shades open. Overrides gtSMSO.

UnitsLegal RangeDefaultRequiredVariability
fraction0 \(\leq\) x \(\leq\) 1gtSMSO or 1NoMonthly - Hourly

wnSMSC=float

SHGC multiplier with shades closed. Overrides gtSMSC

UnitsLegal RangeDefaultRequiredVariability
fraction0 \(leq\) x \(leq\) 1wnSMSO or gtSMSCNoMonthly - Hourly

wnNGlz=int

Number of glazings in the window (bare glass only, not including any interior or exterior shades).

UnitsLegal RangeDefaultRequiredVariability
0 \(<\) x \(leq\) 4gtNGLZRequired when wnModel = ASHWATconstant

wnExShd=choice

Exterior shading type (ASHWAT only).

UnitsLegal RangeDefaultRequiredVariability
NONE, INSCRNgtExShdNoconstant

wnInShd=choice

Interior shade type (ASHWAT only).

UnitsLegal RangeDefaultRequiredVariability
NONE, DRAPEMEDgtInShdNoconstant

wnDirtLoss=float

Glazing dirt loss factor.

UnitsLegal RangeDefaultRequiredVariability
fraction0 \(\leq\) x \(\leq\) 1noneNoconstant

wnGrndRefl=float

Ground reflectivity for this window.

UnitsLegal RangeDefaultRequiredVariability
fraction0 \(\leq\) x \(\leq\) 1sfGrndReflNoMonthly - Hourly

wnVfSkyDf=float

View factor from this window to sky for diffuse radiation. For the shading effects of an overhang, a wnVfSkyDf value smaller than the default would be used

UnitsLegal RangeDefaultRequiredVariability
fraction0 \(\leq\) x \(\leq\) 10.5 - 0.5 cos(tilt) = .5 for vertical surfaceNoMonthly - Hourly

wnVfGrndDf=float

View factor from this window to ground for diffuse radiation. For the shading effects of a fin(s), both wnVfSkyDf and wnVfGrndDf would be used.

UnitsLegal RangeDefaultRequiredVariability
fraction0 \(\leq\) x \(\leq\) 10.5 + 0.5 .5 for vertical surfaceNoMonthly - Hourly

endWINDOW

Optionally indicates the end of the window definition. Alternatively, the end of the window definition can be indicated by END or the declaration of another object. END or endWindow, if used, should follow any subobjects of the window (SHADEs and/or SGDISTs).

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

Related Probes:

4.18 SHADE

SHADE constructs a subobject associated with the current WINDOW that represents fixed shading devices (overhangs and/or fins). A window may have at most one SHADE and only windows in vertical surfaces may have SHADEs. A SHADE can describe an overhang, a left fin, and/or a right fin; absence of any of these is specified by omitting or giving 0 for its depth. SHADE geometry can vary on a monthly basis, allowing modeling of awnings or other seasonal shading strategies.

shName

Name of shade; follows the word “SHADE” if given.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneNoconstant

ohDepth=float

Depth of overhang (from plane of window to outside edge of overhang). A zero value indicates no overhang.

UnitsLegal RangeDefaultRequiredVariability
ftx \(\ge\) 00Nomonthly-hourly

ohDistUp=float

Distance from top of window to bottom of overhang.

UnitsLegal RangeDefaultRequiredVariability
ftx \(\ge\) 00Nomonthly-hourly

ohExL=float

Distance from left edge of window (as viewed from the outside) to the left end of the overhang.

UnitsLegal RangeDefaultRequiredVariability
ftx \(\ge\) 00Nomonthly-hourly

ohExR=float

Distance from right edge of window (as viewed from the outside) to the right end of the overhang.

UnitsLegal RangeDefaultRequiredVariability
ftx \(\ge\) 00Nomonthly-hourly

ohFlap=float

Height of flap hanging down from outer edge of overhang.

UnitsLegal RangeDefaultRequiredVariability
ftx \(\ge\) 00Nomonthly-hourly

lfDepth=float

Depth of left fin from plane of window. A zero value indicates no fin.

UnitsLegal RangeDefaultRequiredVariability
ftx \(\ge\) 00Nomonthly-hourly

lfTopUp=float

Vertical distance from top of window to top of left fin.

UnitsLegal RangeDefaultRequiredVariability
ftx \(\ge\) 00Nomonthly-hourly

lfDistL=float

Distance from left edge of window to left fin.

UnitsLegal RangeDefaultRequiredVariability
ftx \(\ge\) 00Nomonthly-hourly

lfBotUp=float

Vertical distance from bottom of window to bottom of left fin.

UnitsLegal RangeDefaultRequiredVariability
ftx \(\ge\) 00Nomonthly-hourly

rfDepth=float

Depth of right fin from plane of window. A 0 value indicates no fin.

UnitsLegal RangeDefaultRequiredVariability
ftx \(\ge\) 00Nomonthly-hourly

rfTopUp=float

Vertical distance from top of window to top of right fin.

UnitsLegal RangeDefaultRequiredVariability
ftx \(\ge\) 00Nomonthly-hourly

rfDistR=float

Distance from right edge of window to right fin.

UnitsLegal RangeDefaultRequiredVariability
ftx \(\ge\) 00Nomonthly-hourly

rfBotUp=float

Vertical distance from bottom of window to bottom of right fin.

UnitsLegal RangeDefaultRequiredVariability
ftx \(\ge\) 00Nomonthly-hourly

endShade

Optional to indicate the end of the SHADE definition. Alternatively, the end of the shade definition can be indicated by END or the declaration of another object.

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

Related Probes:

4.19 SGDIST

SGDIST creates a subobject of the current window that distributes a specified fraction of that window’s solar gain to a specified delayed model (massive) surface. Any remaining solar gain (all of the window’s solar gain if no SGDISTs are given) is added to the air of the zone containing the window. A window may have up to three SGDISTs; an error occurs if more than 100% of the window’s gain is distributed.

Via members sgFSO and sgFSC, the fraction of the insolation distributed to the surface can be made dependent on whether the zone’s shades are open or closed (see ZONE member znSC).

sgName

Name of solar gain distribution (follows “SGDIST” if given).

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneNoconstant

sgSurf=sfName

Name of surface to which gain is targeted.

If there is more than surface with the specified name: if one of the surfaces is in the current zone, it is used; otherwise, an error message is issued.

The specified surface must be modeled with the Delayed model. If gain is targeted to a Quick model surface, a warning message is issued and the gain is redirected to the air of the associated zone.

UnitsLegal RangeDefaultRequiredVariability
name of a SURFACEnoneYesconstant

sgSide=choice

Designates the side of the surface to which the gain is to be targeted:

INTERIORApply gain to interior of surface
EXTERIORApply gain to exterior of surface
UnitsLegal RangeDefaultRequiredVariability
INTERIOR, EXTERIORSide of surface in zone containing window; or INTERIOR if both sides are in zone containing window.Yesconstant

sgFSO=float

Fraction of solar gain directed to specified surface when the owning window’s interior shading is in the open position (when the window’s zone’s shade closure (znSC) is 0).

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 1,and sum of window’s sgFSO’s \(\le\) 1noneYesmonthly-hourly

sgFSC=float

Fraction of solar gain directed to specified surface when the owning window’s interior shading is in the closed position. If the zone’s shades are partly closed (znSC between 0 and 1), a proportional fraction between sgFSO and sgFSC is used.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 1, and sum of window’s sgFSC’s \(\le\) 1sgFSONomonthly-hourly

endSGDist

Optionally indicates the end of the solar gain distribution definition. Alternatively, the end of the solar gain distribution definition can be indicated by END or by just beginning another object.

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

Related Probes:

4.20 DOOR

DOOR constructs a subobject belonging to the current SURFACE. The azimuth, tilt, ground reflectivity and exterior conditions associated with the door are the same as those of the owning surface, although the exterior surface conductance and the exterior absorptivity can be altered.

drName

Name of door.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneNoconstant

drArea=float

Overall area of door.

UnitsLegal RangeDefaultRequiredVariability
ft2x \(>\) 0noneYesconstant

drModel=choice

Provides user control over how CSE models conduction for this door:

QUICKSurface is modeled using a simple conductance. Heat capacity effects are ignored. Either drCon or drU (next) can be specified.
DELAYED, DELAYED_HOUR, DELAYED_SUBOURSurface is modeled using a multi-layer finite difference technique which represents heat capacity effects. If the time constant of the door is too short to accurately simulate, a warning message is issued and the Quick model is used. drCon (next) must be specified – the program cannot use the finite difference model if drU rather than drCon is specified.
AUTOProgram selects Quick or appropriate Delayed automatically according to the time constant of the surface (if drU is specified, Quick is selected).
FD or FORWARD_DIFFERENCESelects the forward difference model (used with short time steps and the CZM/UZM zone models)
UnitsLegal RangeDefaultRequiredVariability
choices aboveAUTONoconstant

Either drU or drCon must be specified, but not both.

drU=float

Door U-value, NOT including surface (air film) conductances. Allows direct entry of U-value, without defining a CONSTRUCTION, when no heat capacity effects are to be modeled.

UnitsLegal RangeDefaultRequiredVariability
Btuh/ft2-oFx \(>\) 0Determined from drConif drCon not givenconstant

drCon=conName

Name of construction for door.

UnitsLegal RangeDefaultRequiredVariability
name of a CONSTRUCTIONnoneunless drU givenconstant

drLThkF=float

Sublayer thickness adjustment factor for FORWARD_DIFFERENCE conduction model used with drCon surfaces. Material layers in the construction are divided into sublayers as needed for numerical stability. drLThkF allows adjustment of the thickness criterion used for subdivision. A value of 0 prevents subdivision; the default value (0.5) uses layers with conservative thickness equal to half of an estimated safe value. Fewer (thicker) sublayers improves runtime at the expense of accurate representation of rapid changes.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 00.5Noconstant

drExAbs=float

Door exterior solar absorptivity. Applicable only if sfExCnd of owning surface is AMBIENT or SPECIFIEDT.

UnitsLegal RangeDefaultRequiredVariability
Btuh/ft2-oFx \(>\) 0same as owning surfaceNomonthly-hourly

drInAbs=float

Door interior solar absorptivity.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 10.5Nomonthly-hourly

drExEpsLW=float

Door exterior long wave (thermal) emittance.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 10.9Noconstant

drInEpsLW=float

Door interior long wave (thermal) emittance.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 10.9Noconstant

drInH=float

Door interior surface (air film) conductance. Ignored if drModel = Forward_Difference

UnitsLegal RangeDefaultRequiredVariability
Btuh/ft2-oFx \(>\) 0same as owning surfaceNoconstant

drExH=float

Door exterior surface (air film) conductance. Ignored if drModel = Forward_Difference

UnitsLegal RangeDefaultRequiredVariability
Btuh/ft2-oFx \(>\) 0same as owning surfaceNoconstant

When drModel = Forward_Difference, several models are available for calculating inside and outside surface convective coefficients. Inside surface faces can be exposed only to zone conditions. Outside faces may be exposed either to ambient conditions or zone conditions, based on drExCnd. Only UNIFIED and INPUT are typically used. The other models were used during CSE development for comparison. For details, see CSE Engineering Documentation.

ModelExposed to ambientExposed to zone
UNIFIEDdefault CSE modeldefault CSE model
INPUThc = drExHcMulthc = drxxHcMult
AKBARIAkbari modeln/a
WALTONWalton modeln/a
WINKELMANNWinkelmann modeln/a
MILLSn/aMills model
ASHRAEn/aASHRAE handbook values

drExHcModel=choice

Selects the model used for exterior surface convection when drModel = Forward_Difference.

UnitsLegal RangeDefaultRequiredVariability
choices aboveUNIFIEDNoconstant

drExHcLChar=float

Characteristic length of surface, used in derivation of forced exterior convection coefficients in some models when outside face is exposed to ambient (i.e. to wind).

UnitsLegal RangeDefaultRequiredVariability
ftx \(>\) 010Noconstant

drExHcMult=float

Exterior convection coefficient adjustment factor. When drExHcModel=INPUT, hc=drExHcMult. For other drExHcModel choices, the model-derived hc is multiplied by drExHcMult.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 01Nosubhourly

drExRf=float

Exterior roughness factor. Typical roughness values:

Roughness IndexdrExRfExample
1 (very rough)2.17Stucco
2 (rough)1.67Brick
3 (medium rough)1.52Concrete
4 (Medium smooth)1.13Clear pine
5 (Smooth)1.11Smooth plaster
6 (Very Smooth)1Glass
UnitsLegal RangeDefaultRequiredVariability
drExHcModel = WINKELMANN: 1.66 else 2.17Noconstant

drInHcModel=choice

Selects the model used for the inside (zone) surface convection when drModel = Forward_Difference.

UnitsLegal RangeDefaultRequiredVariability
choices above (see drExHcModel)UNIFIEDNoconstant

drInHcMult=float

Interior convection coefficient adjustment factor. When drInHcModel=INPUT, hc=drInHcMult. For other drInHcModel choices, the model-derived hc is multiplied by drInHcMult.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 01Nosubhourly

endDoor

Indicates the end of the door definition. Alternatively, the end of the door definition can be indicated by the declaration of another object or by END.

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

Related Probes:

4.21 PERIMETER

PERIMETER defines a subobject belonging to the current zone that represents a length of exposed edge of a (slab on grade) floor.

prName

Optional name of perimeter.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneNoconstant

prLen=float

Length of exposed perimeter.

UnitsLegal RangeDefaultRequiredVariability
ftx \(>\) 0noneYesconstant

prF2=float

Perimeter conduction per unit length.

UnitsLegal RangeDefaultRequiredVariability
Btuh/ft-oFx \(>\) 0noneYesconstant

endPerimeter

Optionally indicates the end of the perimeter definition.

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

Related Probes:

4.22 TERMINAL

TERMINAL constructs an object to represent equipment that transfers energy to or from the current zone from a local heating device (coil, etc.) and/or one AIRHANDLER. A terminal serves a zone (and, internally, is owned by a zone). Up to three terminals can be defined for each zone.

A terminal can have local heating capability, using a simulated reheat coil, baseboard heater, etc. and/or air heating/cooling capability, using a simulated variable air volume (VAV) box connected to an AIRHANDLER (Section 0). Since a TERMINAL can only connect to a single air handler, use two terminals per zone to model systems where separate air handlers supply hot and cool air (dual duct). If a local heat capability utilizes the air flow (e.g. a reheat coil), model it in the terminal connected to the air handler; if a local heat capability is independent of air flow (e.g. electric baseboard heaters), it doesn’t matter whether you model it with a separate terminal.

Each capability can be set output, in which the output is constant or determined by external conditions such as in an outdoor reset baseboard situation or set temperature, in which the output is modulated to maintain the zone temperature at a set point. Set temperature operation is established by giving the setpoint for the capability (tuTLh, tuTH, tuTC); set output operation is established by specifying the local heat output (tuQMnLh) or air flow (tuVfMn) without specifying a setpoint.

Hourly variable expressions may be used as desired to schedule setpoints and flow limits. Figure 1 shows [need sentence describing the figure.]

Insert Figure Title
Insert Figure Title

tuName

Optional name of terminal; follows the word “TERMINAL” if given.

UnitsLegal RangeDefaultRequiredVariability
63 charactersNoconstant

4.22.1 TERMINAL Local Heating

These commands establish the TERMINAL’s local heating capability and determine whether it operates in set output or set temperature fashion. Additional details of the local heating mechanism are given with commands described below under terminal heating coil.

Either tuTLh or tuQMnLh must be given to establish the TERMINAL’s local heat capability:

tuTLh=float

Local heating thermostat setpoint. Hourly expression may be used to schedule as desired. Giving this implies set temperature local heat from this terminal; omitting implies no local heat or, if tuQMnLh is given, set output local heat.

UnitsLegal RangeDefaultRequiredVariability
oFx \(>\) 0no thermostat controlNohourly

tuQMnLh=float

Minimum local heat output or set local heat output. If tuTLh is given, this is the minimum output, used when the thermostat is not calling for (local) heat. If tuTLh is not given, giving tuQMnLh implies set output local heat and specifies the set output level. An hourly expression may be used to schedule as desired.

UnitsLegal RangeDefaultRequiredVariability
Btuhx \(\ge\) 00 if tuTLh given else no local heatFor set output local heathourly

The next three items are allowed only for thermostat controlled local heating (tuTLh given):

tuQMxLh=float

Maximum desired power, used when thermostat is calling for heat continuously, subject to coil capacity, and to HEATPLANT limitations where pertinent (see tuhcCaptRat description). If tuQMxLh is less than minimum power (tuQMnLh), the latter is used, effectively disabling setpoint control.

UnitsLegal RangeDefaultRequiredVariability
Btuhx \(\ge\) 0Yes, if tuTLh givenhourly

tuPriLh=int

Setpoint priority: when there is more than one capability with the same setpoint, that with the highest priority (lowest value) is used first. The defaults for tuPriLh (100) and tuPriH (1) cause maximum air heat to be used before local heat, if both are present and the setpoints are the same. Two or more equal setpoints with equal priorities in the ZONE cause an error, even if in different TERMINALs.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 0100Noconstant

tuLhNeedsFlow=choice

YESlocal heat being modeled requires terminal air flow (e.g. reheat coil). Local heat is then disabled when there is zero air flow through the terminal (when simulated VAV damper set to 0 flow, or when air handler fan and terminal fan both off)
NOno local heat or does not require air flow (e.g. baseboard heaters).
UnitsLegal RangeDefaultRequiredVariability
YES, NONONoconstant

4.22.2 TERMINAL Air Heating and Cooling

These commands establish whether the TERMINAL has air capability (heat, cool, or both), and whether the capability operates in set temperature mode (tuTH and/or tuTLh given) or set output mode (tuVfMn given without tuTH and tuTLh). They further establish the setpoints, flow limits, leakages, and losses.

Caution should be exercised in using air heat and air cooling in the same terminal. The supply air for both comes from the same air handler; it is up to you to make sure the terminal only calls for heat when the air handler is blowing hot air and only calls for cooling when the air handler is blowing cold air. This is done by carefully coordinating the variable expressions for terminal air heating and cooling setpoints (tuTH and tuTC here) and the air handler supply temperature setpoint (AIRHANDLER ahTsSp, Section 0).

Note: To autosize air flows for a constant volume terminal, use the following

AUTOSIZE tuVfMxC
AUTOSIZE tuVfMxH
AUTOSIZE tuVfMn
tuVfMxHC = SAME

tuAh=ahName

Name of air handler supplying this terminal.

UnitsLegal RangeDefaultRequiredVariability
name of an AIRHANDLERIf omitted, terminal has no air heating nor cooling capability.Noconstant

If both of the following (tuTH and tuTC) are specified, be careful not to accidentally permit the heating setpoint to be active when the air handler is blowing cold air, or vice versa. CSE’s simulated thermostats and VAV boxes are at least as dumb as their real counterparts; if the thermostat calls for heat, the VAV damper will open even if the supply air is colder than the zone. To schedule deactivation of the air heating or cooling capability, schedule an extreme setpoint, such as 1 for heating or 199 for cooling.

Giving neither tuTH nor tuTC implies that the terminal has no set temperature air capability; it will then have set output air capability if tuVfMn is given.

tuTH=float

Air heating thermostat set point; implies set temperature air capability. May be scheduled as desired with an hourly expression; to disable set temperature operation at certain times (as when air handler is scheduled to supply cold air), schedule a low temperature such as 1.

UnitsLegal RangeDefaultRequired**Variability
oFx \(\ge\) 0No thermostat-controlled air heatingNohourly

tuTC=float

Air cooling thermostat set point; implies set temperatureair capability. May be scheduled as desired; to disable at certain times, schedule an extreme temperature such as 199.

UnitsLegal RangeDefaultRequired**Variability
oFx \(\ge\) 0No thermostat-controlled air coolingNohourly

tuVfDs=float

Design air flow rate. (“Vf” in member names stands for “Volumetric Flow”, to emphasize that flow is specified by volume at actual air temperature (cfm), not by mass (lb/hr), nor heat capacity (Btuh/F), etc.)

The design air flow rate is used to apportion the available cfm among the terminals when the total flow demand of the terminals exceeds the air handler’s supply fan capacity; it is unimportant (but may nevertheless be required) if the total of the tuVfMx’s of the terminals on the air handler is not greater than the air handler’s fan capacity including overrun.

CSE will default tuVfDs to the largest of tuVfMn, tuVfMxH, and tuVfMxC unless a variable expression is given for any of them. Thus, you must given tuVfDs only when a variable minimum or maximum flow is used, or when you wish to override the default cfm apportionment under fan overload conditions.

UnitsLegal RangeDefaultRequiredVariability
cfmx \(\ge\) 0largest of tuVfMn, tuVfMxH, and tuVfMxC if all are constantYes, if tuVfmn, tuVfmxH, or tuVfMxC is variablehourly

tuFxVfHC=float

Sizing factor for autosized terminal air flows. Default value (1.1) specifies 10% oversizing.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 01.1Noconstant

tuVfMxHC=choice

Determines autosizing strategy for heating and cooling air flows.

SAMEtuVfMxH and tuVfMxC are set to the larger of the autosized values
DIFFERENTtuVfMxH and tuVfMxC are autosized independently
UnitsLegal RangeDefaultRequiredVariability
choices aboveDifferentNoconstant

tuVfMn=float

Minimum terminal air flow rate or set output air flow rate. An hourly expression may be used to schedule the minimum or set output flow as desired.

If neither tuTH nor tuTC is given, giving tuVfMn implies set output air capability for the terminal; the tvVfMn value is the set output cfm.

If either setpoint (tuTH or tuTC) is given, tuVfMn is the cfm used when the thermostat is not calling for heat nor cold; it might be non-0, for example, to meet ventilation requirements. If tuVfMn is larger than tuVfMxH (when heating) or tuVfMxC (when cooling), it overrules them; thus a minimum (e.g. ventilation) requirement need not be considered in formulating expressions for the maximum flows.

UnitsLegal RangeDefaultRequiredVariability
cfmAUTOSIZE or x \(\ge\) 0if tuTH or tuTC given, else no air heat/coolFor set output air operationhourly

tuVfMxH=float

Maximum heating air flow rate, subject to air handler limitations. This terminal flow is used when the thermostat is calling for heat continuously. Hourly schedulable. If not greater than tuVfMn, the latter flow is used, thus disabling thermostat control.

UnitsLegal RangeDefaultRequiredVariability
cfmAUTOSIZE or x \(\ge\) 0noneIf tuTH givenhourly

tuVfMxC=float

Maximum cooling air flow rate, before air handler limitations, used when the thermostat is calling for cooling continuously. tuVfMn overrides if larger.

UnitsLegal RangeDefaultRequiredVariability
cfmAUTOSIZE or x \(\ge\) 0noneIf tuTC givenhourly

tuPriC=int

Cool setpoint priority. The lowest numbered priority is used first when there are equal setpoints in a zone; equal heat or cool setpoints with equal priority in same ZONE (even if on different TERMINALs) constitute an error.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 01Noconstant

tuPriH=int

Heat setpoint priority. Lowest numbered priority is used first when there are equal setpoints in a zone. Default for tuPriLh is larger, so that by default local heat is not used unless maximum air heat is insufficient, when both local heat and air heat are present in zone and have same setpoint.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 01Noconstant

tuSRLeak=float

Leakage of supply air to return, increasing supply volume and return temperature. Note that this is a fraction of current cfm, whereas air handler leak (before VAV dampers) is a fraction of maximum cfm. TfanOffLeak is added to this if terminal has a fan that is not running (future, 7-92).

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 10.05Noconstant

tuSRLoss=float

Supply air to return plenum heat loss as a fraction of supply air to return air temperature difference. Not allowed if return is ducted (no plenum).

NOT IMPLEMENTED as of July 1992 – Plenums are unimplemented.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 10.1Noconstant

4.22.3 TERMINAL Heating Coil

These members are disallowed if terminal has no local heating capability, that is, if neither tuTLh nor tuQMnLh is given.

tuhcType=choice

Local heating coil type:

ELECTRICElectric coil or heater, including separate heaters such as electric baseboards. 100% efficient; rated capacity always available.
HWHot water coil, using hot water from amHEATPLANT. Available capacity may be limited by HEATPLANT total capacity as well as by coil rated capacity.
UnitsLegal RangeDefaultRequiredVariability
ELECTRIC (future: HW)ELECTRIC, or NONE if no local heatNoconstant

tuhcCaptRat=float

Rated capacity of the heating coil. The coil will never supply more heat than its capacity, even if tuQMxLh and/or tuQMnLh is greater. For an ELECTRIC coil, the capacity is always the rated capacity. For an HW coil, the capacity is the rated capacity when the HEATPLANT can supply it; when the total heat demanded from the HEATPLANT by all the HW coils in TERMINALs and AIRHANDLERs exceeds the HEATPLANT’s capacity, CSE reduces the capacities of all HW coils proportionately until the plant is not overloaded.

UnitsLegal RangeDefaultRequiredVariability
Btu/hrAUTOSIZE or x \(\gt\) 0noneYesconstant

tuhcFxCap=float

Capacity factor for autosized terminal heating coil. Default value (1.1) specifies 10% oversizing.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 01.1Noconstant

tuhcMtr=mtrName

Name of meter, if any, which accumulates input energy for this coil. End use category used is “Htg”. Not allowed when tuhcType is HW, as the energy for an HW coil comes through a HEATPLANT; the input energy is accumulated to a meter by the HEATPLANT.

UnitsLegal RangeDefaultRequiredVariability
name of a METERnot recordedNoconstant

tuhcHeatplant=heatplantName

Name of HEATPLANT for HW coil; disallowed for other coil types.

UnitsLegal RangeDefaultRequiredVariability
name of a HEATPLANTnoneIf tuhcType is HWconstant

4.22.4 TERMINAL Fan

Presence of a terminal fan is indicated by specifying a tfanType value other than NONE.

Terminal fans are NOT IMPLEMENTED as of July 1992.

tfanType=choice

Choice of:

NONENo fan in this TERMINAL (default); input for other terminal fan members disallowed.
SERIESFan runs whenever scheduled ON (see tfanSched, next); if VAV cfm < terminal fan cfm (tfanVfDs), the additional flow comes from the return air.
PARALLELFan runs when scheduled ON (see tfanSched) and terminal’s simulated VAV cfm is less than tfanVfDs plus tuVfMn ?? plus tuVfMn??. Terminal fan cfm is added to VAV cfm from AIRHANDLER to get cfm to ZONE.
UnitsLegal RangeDefaultRequiredVariability
NONE, SERIES, PARALLELnoneYes, if fan presentconstant

tfanSched=choice

Terminal fan schedule. May be scheduled with an hourly variable expression.

OFFfan does not run
ONfan may run
HEATINGfan may run when local heat is in use
VAVfan may run when AIRHANDLER supply fan is on or when doing setback headting and ssCtrl is ZONE_HEAT or BOTH (future).

A series fan (see tfanType) runs whenever on; a parallel fan runs only enough to keep terminal cfm at terminal minimum plus fan cfm; thus it may not run at all when the VAV flow from the AIRHANDLER is sufficient.

UnitsLegal RangeDefaultRequiredVariability
OFF, ON, HEATING, VAVnoneYes (if fan present)hourly

tfanOffLeak=float

Backdraft leakage when terminal fan off., as a fraction of tfanVfDs.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 10.1 if fan presentNoconstant

tfanVfDs=float

Terminal fan design flow rate. To specify .x times zone or terminal cfm, use a CSE expression.

UnitsLegal RangeDefaultRequiredVariability
cfmx \(\le\) 0noneYes (if fan present)constant

tfanPress=float

Terminal fan external static pressure.

UnitsLegal RangeDefaultRequiredVariability
inches H2Ox \(\ge\) 00.3Noconstant

tfanEff=float

Terminal fan/motor/drive combined efficiency.

UnitsLegal RangeDefaultRequiredVariability
0 \(le\) x \(le\) 10.08Noconstant

tfanCurvePy=k0, k1, k2, k3, x0

k0 through k3 are the coefficients of a cubic polynomial for the curve relating fan relative energy consumption to relative air flow above the minimum flow x0. Up to five floats may be given, separated by commas. 0 is used for any omitted trailing values. The values are used as follows:

\[z = k_0 + k_1 \cdot (x - x_0)| + k_2 \cdot (x - x_0)|^2 + k_3 \cdot (x - x_0)|^3\]

where:

If \(z\) is not 1.0 for \(x\) = 1.0, a warning message is displayed and the coefficients are normalized by dividing by the polynomial’s value for \(x\) = 1.0.

UnitsLegal RangeDefaultRequiredVariability
0, 1, 0, 0, 0 (linear)Noconstant

tfanMtr=mtrName

Name of meter, if any, which is to record energy used by this terminal fan. The “fans” category is used.

UnitsLegal RangeDefaultRequiredVariability
name of a METERnot recordedNoconstant

endTerminal

Optional to indicates the end of terminal definition. Alternatively, the end of the door definition can be indicated by END or by beginning another object.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 0noneNoconstant

Related Probes:

4.23 IZXFER

IZXFER constructs an object that represents an interzone or zone/ambient heat transfer due to conduction and/or air transfer. The air transfer modeled by IZXFER transfers heat only; humidity transfer is not modeled as of July 2011. Note that SURFACE is the preferred way represent conduction between ZONEs.

The AIRNET types are used in a multi-cell pressure balancing model that finds zone pressures that produce net 0 mass flow into each zone. The model operates in concert with the znType=CZM or znType=UZM to represent ventilation strategies. During each time step, the pressure balance is found for two modes that can be thought of as “VentOff” (or infiltration-only) and “VentOn” (or infiltration+ventilation). The zone model then determines the ventilation fraction required to hold the desired zone temperature (if possible). AIRNET modeling methods are documented in the CSE Engineering Documentation.

Note that fan-driven types assume pressure-independent flow. That is, the specified flow is included in the zone pressure balance but the modeled fan flow does not change with zone pressure. The assumption is that in realistic configurations, zone pressure will generally be close to ambient pressure. Unbalanced fan ventilation in a zone without relief area will result in runtime termination due to excessively high or low pressure.

izName

Optional name of interzone transfer; give after the word “IZXFER” if desired.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneNoconstant

izNVType=choice

Choice specifying the type of ventilation or leakage model to be used.

NONENo interzone ventilation
ONEWAYUncontrolled flow from izZn1 to izZn2 when izZn1 air temperature exceeds izZn2 air temperature (using ASHRAE high/low vent model).
TWOWAYUncontrolled flow in either direction (using ASHRAE high/low vent model).
AIRNETIZSingle opening to another zone (using pressure balance AirNet model). Flow is driven by buoyancy.
AIRNETEXTSingle opening to ambient (using pressure balance AirNet model). Flow is driven by buoyancy and wind pressure.
AIRNETHORIZHorizontal (large) opening between two zones, used to represent e.g. stairwells. Flow is driven by buoyancy; simultaneous up and down flow is modeled.
AIRNETEXTFANFan from exterior to zone (flow either direction).
AIRNETIZFANFan between two zones (flow either direction).
AIRNETEXTFLOWSpecified flow from exterior to zone (either direction). Behaves identically to AIRNETEXTFAN except no electricity is consumed and no fan heat is added to the air stream.
AIRNETIZFLOWSpecified flow between two zones (either direction). Behaves identically to AIRNETIZFAN except no electricity is consumed and no fan heat is added to the air stream.
AIRNETHERVHeat or energy recovery ventilator. Supply and exhaust air are exchanged with the exterior with heat and/or moisture exchange between the air streams. Flow may or may not be balanced.
AIRNETDOASAir supplied from and/or exhausted to a centralized DOAS fans.

Note that optional inputs izTEx, izWEx, and izWindSpeed can override the outside conditions assumed for ivNVTypes that are connected to ambient (AIRNETEXT, AIRNETEXTFAN, AIRNETEXTFLOW, and AIRNETHERV).

UnitsLegal RangeDefaultRequiredVariability
choices abovenoneNoconstant

izAFCat=choice

Choice indicating air flow category used only for recording air flow results to an AFMETER. izAFCat has no effect for non-AIRNET IZXFERs. izAFCat is not used unless the associated ZONE(s) specify znAFMtr.

Choices are:

InfilExInfiltration from ambient
VentExNatural ventilation from ambient
FanExForced ventilation from ambient
InfilIzInterzone infiltration
VentIzInterzone natural ventilation
FanIzInterzone forced ventilation
DuctLkDuct leakage
HVACHVAC air

Default values for izAFCat are generally adequate except that natural ventilation IZXFERs are by default categorized as infiltration. It is thus recommended that izAfCat be omitted except that ventilation IZXFERs (e.g. representing openable windows) should include izAfCat=VentEx (or VentIz).

UnitsLegal RangeDefaultRequiredVariability
choices abovederived from IZXFER characteristicsNoconstant

izZn1=znName

Name of primary zone. Flow rates \(>\) 0 are into the primary zone.

UnitsLegal RangeDefaultRequiredVariability
name of a ZONEnoneYesconstant

izZn2=znName

Name of secondary zone.

UnitsLegal RangeDefaultRequiredVariability
name of a ZONEnonerequired unless constant izNVType = AIRNETEXT, AIRNETEXTFAN, AIRNETEXTFLOW, or AIRNETHERVconstant

izDOAS=oaName

Name of DOAS where air is supplied from (izVfMin > 0), or exhausting to (izVfMin < 0).

UnitsLegal RangeDefaultRequiredVariability
name of a DOASwhen izNVType = AIRNETDOASconstant

izLinkedFlowMult=float

Specifies a multiplier applied to air flow to/from any associated DOAS. This supports use of a single modeled zone to represent multiple actual zones while preserving the total DOAS air flow and energy consumption.

For example, consider a DOAS-linked IZXFER with izVfMin = 100 and izLinkedFlowMult = 5. The zone specified by izZn1 receives 100 cfm while the DOAS specified by izDOAS is modeled as if the supply flow is 500 cfm. Thus the DOAS behavior (fan energy use etc.) approximates that of a DOAS serving 5 zones, but only one zone is simulated.

Note izLinkedFlowMult has no effect on the air flow to or from the zone specified by izZn1.

UnitsLegal RangeDefaultRequiredVariability
x \(\gt\) 01Noconstant

Give izHConst for a conductive transfer between zones. Give izNVType other than NONE and the following variables for a convective (air) transfer between the zones or between a zone and outdoors. Both may be given if desired. Not known to work properly as of July 2011

izHConst=float

Conductance between zones.

UnitsLegal RangeDefaultRequiredVariability
Btu/oFx \(\ge\) 00Nohourly

izALo=float

Area of low or only vent (typically VentOff)

UnitsLegal RangeDefaultRequiredVariability
ft2x \(\ge\) 00Nohourly

izAHi=float

Additional vent area (high vent or VentOn). If used in AIRNET, izAHi > izALo typically but this is not required.

UnitsLegal RangeDefaultRequiredVariability
ft2x \(\ge\) 0izALoNohourly

izTEx=float

Alternative exterior air dry bulb temperature for this vent. Allowed only with izNVTypes that use outdoor air (AIRNETEXT, AIRNETEXTFAN, AIRNETEXTFLOW, and AIRNETHERV). If given, izTEx overrides the outdoor dry-bulb temperature read from the weather file or derived from design conditions.

Caution: izTEx is not checked for reasonableness.

One use of izTEx is in representation of leaks in surfaces adjacent to zones not being simulated. “Pseudo-interior” surface leakage can be created as follows (where “Z1” is the name of the leak’s zone and izALo and izHD are set to appropriate values) –

 IZXFER RLF izNVTYPE=AirNetExt izZN1="Z1" izALo=.1 izHD=10  izTEx=@zone["Z1"].tzls izWEx=@zone["Z1"].wzls

This will allow Z1’s pressure to be realistic without inducing thermal loads that would occur if the leak source had outdoor conditions.

UnitsLegal RangeDefaultRequiredVariability
oFOutdoor dry-bulbNosubhourly

izWEx=float

Alternative exterior air humidity ratio seen by this vent. Allowed only with izNVTypes that use outdoor air (AIRNETEXT, AIRNETEXTFAN, AIRNETEXTFLOW, and AIRNETHERV). If given, izWEx overrides the outdoor humidity ratio derived from weather file data or design conditions.

Caution: izWEx is not checked against saturation – there is no verification that the value provided is physically possible.

See izTEx example just above.

UnitsLegal RangeDefaultRequiredVariability
\(\gt\) 0Outdoor humidity ratioNosubhourly

izWindSpeed=float

Alternative windspeed seen by this vent. Allowed only with izNVTypes that use outdoor air (AIRNETEXT, AIRNETEXTFAN, AIRNETEXTFLOW, and AIRNETHERV). If given, izWindSpeed overrides the windspeed read from the weather file or derived from design conditions.

No adjustments such as TOP windF or ZONE znWindFLkg are applied to izWindSpeed when it is used in derivation of wind-driven air flow.

Note that izCpr must be non-0 for izWindSpeed to have any effect.

UnitsLegal RangeDefaultRequiredVariability
mph\(\ge\) 0Zone adjusted windspeedNosubhourly

izL1=float

Length or width of AIRNETHORIZ opening.

UnitsLegal RangeDefaultRequiredVariability
ftx \(>\) 0noneif izNVType = AIRNETHORIZconstant

izL2=float

Width or length of AIRNETHORIZ opening.

UnitsLegal RangeDefaultRequiredVariability
ftx \(>\) 0noneif izNVType = AIRNETHORIZconstant

izStairAngle=float

Stairway angle for AIRNETHORIZ opening. Use 90 for an open hole. Note that 0 prevents flow.

UnitsLegal RangeDefaultRequiredVariability
o degreesx \(>\) 034Noconstant

izHD=float

Vent center-to-center height difference (for TWOWAY) or vent height above nominal 0 level (for AirNet types)

UnitsLegal RangeDefaultRequiredVariability
ft0Noconstant

izNVEff=float

Vent discharge coefficient.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 10.8Noconstant

izfanVfDs=float

Fan design or rated flow at rated pressure. For AIRNETHERV, this is the net air flow into the zone, gross flow at the fan is derived using izEATR (see below).

UnitsLegal RangeDefaultRequiredVariability
cfmx \(\ge\) 00 (no fan)If fan presentconstant

izCpr=float

Wind pressure coefficient (for AIRNETEXT).

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 00Noconstant

izExp=float

Opening exponent (for AIRNETEXT).

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 00.5Noconstant

izVfMin=float

Minimum volume flow rate (VentOff mode).

UnitsLegal RangeDefaultRequiredVariability
cfmx \(\ge\) 0izfanVfDsNosubhourly

izVfMax=float

Maximum volume flow rate (VentOn mode)

UnitsLegal RangeDefaultRequiredVariability
cfmx \(\ge\) 0izVfMinNosubhourly

izASEF=float

Apparent sensible effectiveness for AIRNETHERV ventilator. ASEF is a commonly-reported HERV rating and is calculated as (supplyT - sourceT) / (returnT - sourceT). This formulation includes fan heat (in supplyT), hence the term “apparent”. Ignored if izSRE is given. CSE does not HRV exhaust-side condensation, so this model is approximate.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 10Nosubhourly

izSRE=float

Sensible recovery efficiency (SRE) for AIRNETHERV ventilator. Used as the sensible effectiveness in calculation of the supply air temperature. Note that values of SRE greater than approximately 0.6 imply exhaust-side condensation under HVI rating conditions. CSE does not adjust for these effects. High values of izSRE will produce unrealistic results under mild outdoor conditions and/or dry indoor conditions.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 10Nosubhourly

izASRE=float

Adjusted sensible recovery efficiency (ASRE) for AIRNETHERV ventilator. The difference izASRE - izSRE is used to calculate fan heat added to the supply air stream. See izSRE notes. No effect when izSRE is 0.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) izSRE0Nosubhourly

izEATR=float

Exhaust air transfer ratio for AIRNETHERV ventilator. NetFlow = (1 - EATR)*(grossFlow).

UnitsLegal RangeDefaultRequiredVariability
cfm0 \(\le\) x \(\le\) 10Nosubhourly

izLEF=float

Latent heat recovery effectiveness for AIRNETHERV ventilator. The default value (0) results in sensible-only heat recovery.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 10Nosubhourly

izRVFanHeatF=float

Fraction of fan heat added to supply air stream for AIRNETHERV ventilator. Used only when when izSRE is 0 (that is, when izASEF specifies the sensible effectiveness).

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 10Nosubhourly

izVfExhRat=float

Exhaust volume flow ratio for AIRNETHERV ventilator = (exhaust flow) / (supply flow). Any value other than 1 indicates unbalanced flow that effects the zone pressure.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 01 (balanced)Noconstant

izfanPress=float

Design or rated fan pressure.

UnitsLegal RangeDefaultRequiredVariability
inches H2Ox \(>\) 00.3Noconstant

Only one of izfanElecPwr, izfanEff, and izfanShaftBhp may be given: together with izfanVfDs and izfanPress, any one is sufficient for CSE to determine the others and to compute the fan heat contribution to the air stream.

izfanElecPwr=float

Fan input power per unit air flow (at design flow and pressure).

UnitsLegal RangeDefaultRequiredVariability
W/cfmx \(>\) 0derived from izfanEff and izfanShaftBhpIf izfanEff and izfanShaftBhp not presentconstant

izfanEff=float

Fan efficiency at design flow and pressure, as a fraction.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 1derived from izfanShaftBhp if given, else 0.08Noconstant

izfanShaftBhp=float

Fan shaft brake horsepower at design flow and pressure.

UnitsLegal RangeDefaultRequiredVariability
bhpx \(>\) 0derived from izfanEff.Noconstant

izfanCurvePy=\(k_0\), \(k_1\), \(k_2\), \(k_3\), \(x_0\)

\(k_0\) through \(k_3\) are the coefficients of a cubic polynomial for the curve relating fan relative energy consumption to relative air flow above the minimum flow \(x_0\). Up to five floats may be given, separated by commas. 0 is used for any omitted trailing values. The values are used as follows:

\[z = k_0 + k_1 \cdot (x - x_0)| + k_2 \cdot (x - x_0)|^2 + k_3 \cdot (x - x_0)|^3\]

where:

If \(z\) is not 1.0 for \(x\) = 1.0, a warning message is displayed and the coefficients are normalized by dividing by the polynomial’s value for \(x\) = 1.0.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 00, 1, 0, 0, 0 (linear)Noconstant

izFanMtr=mtrName

Name of meter, if any, to record energy used by supply fan. End use category used is specified by izFanEndUse (next).

UnitsLegal RangeDefaultRequiredVariability
name of a METERnot recordedNoconstant

izFanEndUse=choice

End use to which fan energy is recorded (in METER specified by izFanMtr). See METER for available end use choices.

UnitsLegal RangeDefaultRequiredVariability
end use choiceFanNoconstant

endIZXFER

Optionally indicates the end of the interzone transfer definition.

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

Related Probes:

4.24 DOAS

DOAS (Dedicated Outdoor Air System) provides centralized supply and/or exhuast ventilation air to IZXFER objects with the izNVType = AIRNETDOAS. The supply air may be preconditioned using heat recovery and/or tempering coils.

oaName

Name of DOAS.

4.24.1 DOAS Supply Fan Data Members

oaSupFanVfDs=float

Supply fan design or rated flow at rated pressure.

UnitsLegal RangeDefaultRequiredVariability
cfmx \(\ge\) 0Sum of referencing IZXFER supply flowsNoconstant

oaSupFanPress=float

Design or rated fan pressure.

UnitsLegal RangeDefaultRequiredVariability
inches H2Ox \(>\) 00.3Noconstant

Only one of oaSupFanElecPwr, oaSupFanEff, and oaSupFanShaftBhp may be given.

oaSupFanElecPwr=float

Fan input power per unit air flow (at design flow and pressure).

UnitsLegal RangeDefaultRequiredVariability
W/cfmx \(>\) 0derived from oaSupFanEff and oaSupFanShaftBhpIf oaSupFanEff and oaSupFanShaftBhp not presentconstant

oaSupFanEff=float

Fan efficiency at design flow and pressure, as a fraction.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 1derived from oaSupFanShaftBhp if given, else 0.08Noconstant

oaSupFanShaftBhp=float

Fan shaft brake horsepower at design flow and pressure.

UnitsLegal RangeDefaultRequiredVariability
bhpx \(>\) 0derived from oaSupFanEff.Noconstant

oaSupFanCurvePy=\(k_0\), \(k_1\), \(k_2\), \(k_3\), \(x_0\)

\(k_0\) through \(k_3\) are the coefficients of a cubic polynomial for the curve relating fan relative energy consumption to relative air flow above the minimum flow \(x_0\). Up to five floats may be given, separated by commas. 0 is used for any omitted trailing values. The values are used as follows:

\[z = k_0 + k_1 \cdot (x - x_0)| + k_2 \cdot (x - x_0)|^2 + k_3 \cdot (x - x_0)|^3\]

where:

If \(z\) is not 1.0 for \(x\) = 1.0, a warning message is displayed and the coefficients are normalized by dividing by the polynomial’s value for \(x\) = 1.0.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 00, 1, 0, 0, 0 (linear)Noconstant

oaSupFanMtr=mtrName

Name of meter, if any, to record energy used by supply fan. End use category used is specified by oaSupFanEndUse (next).

UnitsLegal RangeDefaultRequiredVariability
name of a METERnot recordedNoconstant

oaSupFanEndUse=choice

End use to which fan energy is recorded (in METER specified by oaSupFanMtr). See METER for available end use choices.

UnitsLegal RangeDefaultRequiredVariability
end use choiceFanNoconstant

oaTEx=float

Alternative supply fan source air dry bulb temperature. If given, oaTEx overrides the outdoor dry-bulb temperature read from the weather file or derived from design conditions.

Caution: oaTEx is not checked for reasonableness.

UnitsLegal RangeDefaultRequiredVariability
oFOutdoor dry-bulbNosubhourly

oaWEx=float

Alternative supply fan source air air humidity ratio. If given, oaWEx overrides the outdoor humidity ratio derived from weather file data or design conditions.

Caution: oaWEx is not checked against saturation – there is no verification that the value provided is physically possible.

UnitsLegal RangeDefaultRequiredVariability
\(\gt\) 0Outdoor humidity ratioNosubhourly

4.24.2 DOAS Exhaust Fan Data Members

oaExhFanVfDs=float

Exhaust fan design or rated flow at rated pressure.

UnitsLegal RangeDefaultRequiredVariability
cfmx \(\ge\) 0Sum of referencing IZXFER exhaust flowsNoconstant

oaExhFanPress=float

Design or rated fan pressure.

UnitsLegal RangeDefaultRequiredVariability
inches H2Ox \(>\) 00.3Noconstant

Only one of oaExhFanElecPwr, oaExhFanEff, and oaExhFanShaftBhp may be given.

oaExhFanElecPwr=float

Fan input power per unit air flow (at design flow and pressure).

UnitsLegal RangeDefaultRequiredVariability
W/cfmx \(>\) 0derived from oaExhFanEff and oaExhFanShaftBhpIf oaExhFanEff and oaExhFanShaftBhp not presentconstant

oaExhFanEff=float

Fan efficiency at design flow and pressure, as a fraction.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 1derived from oaExhFanShaftBhp if given, else 0.08Noconstant

oaExhFanShaftBhp=float

Fan shaft brake horsepower at design flow and pressure.

UnitsLegal RangeDefaultRequiredVariability
bhpx \(>\) 0derived from oaExhFanEff.Noconstant

oaExhFanCurvePy=\(k_0\), \(k_1\), \(k_2\), \(k_3\), \(x_0\)

\(k_0\) through \(k_3\) are the coefficients of a cubic polynomial for the curve relating fan relative energy consumption to relative air flow above the minimum flow \(x_0\). Up to five floats may be given, separated by commas. 0 is used for any omitted trailing values. The values are used as follows:

\[z = k_0 + k_1 \cdot (x - x_0)| + k_2 \cdot (x - x_0)|^2 + k_3 \cdot (x - x_0)|^3\]

where:

If \(z\) is not 1.0 for \(x\) = 1.0, a warning message is displayed and the coefficients are normalized by dividing by the polynomial’s value for \(x\) = 1.0.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 00, 1, 0, 0, 0 (linear)Noconstant

oaExhFanMtr=mtrName

Name of meter, if any, to record energy used by exhaust fan. End use category used is specified by oaExhFanEndUse (next).

UnitsLegal RangeDefaultRequiredVariability
name of a METERnot recordedNoconstant

oaExhFanEndUse=choice

End use to which fan energy is recorded (in METER specified by oaExhFanMtr). See METER for available end use choices.

UnitsLegal RangeDefaultRequiredVariability
end use choiceFanNoconstant

4.24.3 DOAS Tempering Coils Data Members

oaSupTH=float

Heating setpoint for tempering and/or heat exchanger bypass.

UnitsLegal RangeDefaultRequiredVariability
oF68Nosubhourly

oaEIRH=float

Energy Input Ratio of the heating coil. This is the inverse of the coil efficiency or COP. A value of zero indicates that the coil does not use energy (e.g., hot water coils). Specifying input triggers the modeling of a heating coil.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 00when modeling heating coilsubhourly

oaCoilHMtr=mtrName

Name of meter, if any, to record energy used by the heating coil.

UnitsLegal RangeDefaultRequiredVariability
name of a METERnot recordedNoconstant

oaSupTC=float

Cooling setpoint for tempering and/or heat exchanger bypass.

UnitsLegal RangeDefaultRequiredVariability
oF68Nosubhourly

oaEIRC=float

Energy Input Ratio of the cooling coil. This is the inverse of the coil efficiency or COP. A value of zero indicates that the coil does not use energy (e.g., chilled water coils). Specifying input triggers the modeling of a cooling coil.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 00when modeling cooling coilsubhourly

oaSHRtarget=float

Sensible Heat Ratio of the cooling coil. If the required sensible capacity of the coil and the entered SHR do not produce a valid psychrometric state, the SHR is adjusted and reported through the SHR probe.

UnitsLegal RangeDefaultRequiredVariability
x \(\gt\) 01.0Nosubhourly

oaCoilCMtr=mtrName

Name of meter, if any, to record energy used by the cooling coil.

UnitsLegal RangeDefaultRequiredVariability
name of a METERnot recordedNoconstant

oaLoadMtr=ldMtrName

Name of load meter, if any, to record load met by the heating coil or cooling coil.

UnitsLegal RangeDefaultRequiredVariability
name of a LOADMETERnot recordedNoconstant

4.24.4 DOAS Heat Recovery Data Members

oaHXVfDs=float

Heat exchanger design or rated flow.

UnitsLegal RangeDefaultRequiredVariability
cfmx \(\gt\) 0Average of supply and exhaust fan design flowsNoconstant

oaHXf2=float

Heat exchanger flow fraction (of design flow) used for second set of effectivenesses.

UnitsLegal RangeDefaultRequiredVariability
0 \(\lt\) x \(\lt\) 1.00.75Noconstant

oaHXSenEffHDs=float

Heat exchanger sensible effectiveness in heating mode at the design flow rate. Specifying input triggers modeling of heat recovery.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 1.0when modeling heat recoveryconstant

oaHXSenEffHf2=float

Heat exchanger sensible effectiveness in heating mode at the second flow rate (oaHXf2).

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 1.00Noconstant

oaHXLatEffHDs=float

Heat exchanger latent effectiveness in heating mode at the design flow rate.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 1.00Noconstant

oaHXLatEffHf2=float

Heat exchanger latent effectiveness in heating mode at the second flow rate (oaHXf2).

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 1.00Noconstant

oaHXSenEffCDs=float

Heat exchanger sensible effectiveness in cooling mode at the design flow rate.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 1.00Noconstant

oaHXSenEffCf2=float

Heat exchanger sensible effectiveness in cooling mode at the second flow rate (oaHXf2).

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 1.00Noconstant

oaHXLatEffCDs=float

Heat exchanger latent effectiveness in cooling mode at the design flow rate.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 1.00Noconstant

oaHXLatEffCf2=float

Heat exchanger latent effectiveness in cooling mode at the second flow rate (oaHXf2).

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 1.00Noconstant

oaHXBypass=choice

Yes/No choice for enabling heat exchanger bypass. If selected, the outdoor air will bypass the heat exchanger when otherwise the heat exchanger would require more heating or cooling energy to meet the respective setpoints.

UnitsLegal RangeDefaultRequiredVariability
NO, YESNONoconstant

oaHXAuxPwr=float

Auxiliary power required to operate the heat recovery device (e.g., wheel motor, contorls).

UnitsLegal RangeDefaultRequiredVariability
Wx \(\ge\) 00Nosubhourly

oaHXAuxMtr=mtrName

Name of meter, if any, to record energy used by auxiliary components of the heat recovery system.

UnitsLegal RangeDefaultRequiredVariability
name of a METERnot recordedNoconstant

endDOAS

Indicates the end of the DOAS definition. Alternatively, the end of the DOAS definition can be indicated by the declaration of another object or by “END”.

UnitsLegal RangeDefaultRequiredVariability
N/ANoconstant

Related Probes:

4.25 RSYS

RSYS constructs an object representing an air-based residential HVAC system.

rsName

Optional name of HVAC system; give after the word “RSYS” if desired.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneNoconstant

rsType=choice

Type of system.

rsTypeDescription
ACFURNACECompressor-based cooling and fuel-fired heating. Primary heating input energy is accumulated to end use HTG of meter rsFuelMtr.
ACRESISTANCECompressor-based cooling and electric (‘strip’) heating. Primary heating input energy is accumulated to end use HTG of meter rsElecMtr.
ASHPAir-source heat pump (compressor-based heating and cooling). Primary (compressor) heating input energy is accumulated to end use HTG of meter rsElecMtr. Auxiliary and defrost heating input energy is accumulated to end use HPBU of meter rsElecMtr or meter rsFuelMtr (depending on rsTypeAuxH).
ASHPKGROOMPackaged room air-source heat pump.
ASHPHYDRONICAir-to-water heat pump with hydronic distribution. Compressor performance is approximated using the air-to-air model with adjusted efficiencies.
VCHP2Air-to-air heat pump with variable speed compressor.
WSHPWater-to-air heat pump.
ACCompressor-based cooling; no heating. Required ratings are SEER and capacity and EER at 95 oF outdoor dry bulb.
ACPKGROOMPackaged compressor-based cooling; no heating. Required ratings are capacity and EER at 95 oF outdoor dry bulb.
FURNACEFuel-fired heating. Primary heating input energy is accumulated to end use HTG of meter rsFuelMtr.
RESISTANCEElectric heating. Primary heating input energy is accumulated to end use HTG of meter rsElecMtr.
ACPKGROOMFURNACEPackaged room cooling and (separate) furnace heating.
ACPKGROOMRESISTANCEPackaged room cooling and electric resistance heating.
COMBINEDHEATDHWCombined heating / DHW. Use rsCHDHWSYS to specify the DHWSYS that provides hot water to the coil in this RSYS. No cooling.
ACCOMBINEDHEATDHWCompressor-based cooling plus COMBINEDHEATDHW heating.
FANCOILCoil-based heating and cooling. No primary (fuel-using) equipment is modeled. rsLoadMtr, rsHtgLoadMtr, and rsClgLoadMtr are typically used to record loads for linking to an external model.
UnitsLegal RangeDefaultRequiredVariability
one of above choicesACFURNACENoconstant

rsDesc=string

Text description of system, included as documentation in debugging reports such as those triggered by rsPerfMap=YES

UnitsLegal RangeDefaultRequiredVariability
stringnoneNoconstant

rsModeCtrl=choice

Specifies systems heating/cooling availability during simulation.

OFFSystem is off (neither heating nor cooling is available)
HEATSystem can heat (assuming rsType can heat)
COOLSystem can cool (assuming rsType can cool)
AUTOSystem can either heat or cool (assuming rsType compatibility). First request by any zone served by this RSYS determines mode for the current time step.
UnitsLegal RangeDefaultRequiredVariability
OFF, HEAT, COOL, AUTOAUTONohourly

rsPerfMap=choice

Generate performance map(s) for this RSYS. Comma-separated text is written to file PM_[rsName].csv. This is a debugging capability that is not necessarily maintained.

UnitsLegal RangeDefaultRequiredVariability
YES, NONONoconstant

rsFanTy=choice

Specifies fan (blower) position relative to cooling coil.

UnitsLegal RangeDefaultRequiredVariability
BLOWTHRU, DRAWTHRUBLOWTHRUNoconstant

rsFanMotTy=choice

Specifies type of motor driving the fan (blower). This is used in the derivation of the coil-only cooling capacity for the RSYS.

PSCPermanent split capacitor
BPMBrushless permanent magnet (aka ECM)
UnitsLegal RangeDefaultRequiredVariability
PSC, BPMPSCNoconstant

rsAdjForFanHt=choice

Fan heat adjustment with two options Yes or no. Yes: fanHtRtd derived from rsFanTy and removed from capacity and input values. No: no rated fan heat adjustments.

rsElecMtr=mtrName

Name of METER object, if any, by which system’s electrical energy use is recorded (under appropriate end uses).

UnitsLegal RangeDefaultRequiredVariability
name of a METERnoneNoconstant

rsFuelMtr =mtrName

Name of METER object, if any, by which system’s fuel energy use is recorded (under appropriate end uses).

UnitsLegal RangeDefaultRequiredVariability
name of a METERnoneNoconstant

rsLoadMtr =ldMtrName
rsHtgLoadMtr =ldMtrName
rsClgLoadMtr =ldMtrName

Names of LOADMETER objects, if any, to which the system’s heating and/or cooling loads are recorded. Loads are the gross heating and cooling energy added to (or removed from) the air stream. Fan heat, auxiliary heat, and duct losses are not included in loads values.

rsLoadMtr accumulates both heating (> 0) and cooling (< 0) loads. rsHtgLoadMtr accumulates only heating loads. rsClgLoadMtr accumulates only cooling loads. This arrangement accomodates mixed heating and cooling source configurations. For example, loads can be tracked appropriately in a building that has multiple cooling sources and a single heating source.

rsLoadMtr should not specify the same LOADMETER as rsHtgLoadMtr or rsClgLoadMtr since this would result in double counting.

UnitsLegal RangeDefaultRequiredVariability
name of a LOADMETERnoneNoconstant

rsSrcSideLoadMtr=ldMtrName
rsHtgSrcSideLoadMtr =ldMtrName
rsClgSrcSideLoadMtr =ldMtrName

Name of LOADMETER objects, if any, to which the system’s source-side heat transfers are recorded. For DX systems, this is the outdoor coil heat transfer. For other types, source-side values are the same as the indoor coil loads reported via rsLoadMtr.

rsSrcSideLoadMtr accumulates both heating (> 0) and cooling (< 0) transfers. rsHtgSrcSideLoadMtr accumulates only heating transfers. rsClgSrcSideLoadMtr accumulates only cooling transfers. This arrangement accomodates mixed heating and cooling source configurations.

rsSrcSideLoadMtr should not specify the same LOADMETER as rsHtgSrcSideLoadMtr or rsClgSrcSideLoadMtr since this would result in double counting.

UnitsLegal RangeDefaultRequiredVariability
Name of a LOADMETERNoconstant

rsCHDHWSYS=dhwsysName

DHWSYS hot water source for this RSYS, required when rsType is COMBINEDHEATDHW or ACCOMBINEDHEATDHW. The specified DHWSYS must include a DHWHEATER of whType=ASHPX or RESISTANCEX.

UnitsLegal RangeDefaultRequiredVariability
Name of DHWSYSnoneif combined heat/DHWconstant

rsAFUE=float

Heating Annual Fuel Utilization Efficiency (AFUE).

UnitsLegal RangeDefaultRequiredVariability
0 \(<\) x \(\le\) 10.9 if furnace, 1.0 if resistanceNoconstant

rsCapH=float

Heating capacity, used when rsType is ACFURNACE, ACRESISTANCE, FURNACE, WSHP or RESISTANCE.

If rsType=WSHP, rsCapH is at source fluid temperature = 68 oF.

UnitsLegal RangeDefaultRequiredVariability
Btu/hrAUTOSIZE or x \(\ge\) 00Noconstant

rsTdDesH=float

Nominal heating temperature rise (across system, not at zone) used during autosizing (when capacity is not yet known) and to derive heating air flow rate from heating capacity.

UnitsLegal RangeDefaultRequiredVariability
oFx \(>\) 030 oF if heat pump else 50 oFNoconstant

rsFxCapH=float

Heating autosizing capacity factor. If AUTOSIZEd, rsCapH or rsCap47 is set to rsFxCapH \(\times\) (peak design-day load). Peak design-day load is the heating capacity that holds zone temperature at the thermostat set point during the last substep of all hours of all design days.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 01.4Noconstant

rsFanPwrH=float

Heating operating fan power. For most rsTypes, heating air flow is calculated from heating capacity and rsTdDesH. The default value of rsFanPwrH is .365 W/cfm except 0.273 W/cfm is used when rsType=COMBINEDHEATDHW and rsType=ACCOMBINEDHEATDHW.

UnitsLegal RangeDefaultRequiredVariability
W/cfmx \(\ge\) 0see aboveNoconstant

rsHSPF=float

For rsType=ASHP, Heating Seasonal Performance Factor (HSPF).

UnitsLegal RangeDefaultRequiredVariability
Btu/Whx \(>\) 0noneYes if rsType=ASHPconstant

rsCAP115=float

For rsType=ASHP, rated heating capacity at outdoor dry-bulb temperature = 115 oF.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 0Calculated from rsCAP95Noconstant

rsCAP82=float

For rsType=ASHP, rated heating capacity at outdoor dry-bulb temperature = 82 oF.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 0Calculated from rsCAP95Noconstant

rsCap47=float

For rsType=ASHP, rated heating capacity at outdoor dry-bulb temperature = 47 oF.

If rsType=ASHP and both rsCapC and rsCap47 are autosized, both are set to the larger consistent value using rsCapRat9547 (after application of rsFxCapH and rsFxCapC).

UnitsLegal RangeDefaultRequiredVariability
Btu/WhAUTOSIZE or x \(>\) 0Calculated from rsCapCNoconstant

rsCap35=float

For rsType=ASHP, rated heating capacity at outdoor dry-bulb temperature = 35 oF. rsCap35 typically reflects reduced capacity due to reverse (cooling) heat pump operation for defrost.

UnitsLegal RangeDefaultRequiredVariability
Btu/Whx \(>\) 0Calculated from rsCap47 and rsCap17Noconstant

rsCap17=float

For rsType=ASHP, rated heating capacity at outdoor dry-bulb temperature = 17 oF.

UnitsLegal RangeDefaultRequiredVariability
Btu/Whx \(>\) 0Calculated from rsCap47Noconstant

rsCAP05=float

For rsType=ASHP, rated heating capacity at outdoor dry-bulb temperature = 5 oF.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 0Calculated from rsCAP47Noconstant

rsCOP115=float

For rsType=ASHP, rated heating coefficient of performance at outdoor dry-bulb temperature = 115 oF.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 0Calculated from rsCap115Noconstant

rsCOP95=float

For rsType=ASHP, rated heating coefficient of performance at outdoor dry-bulb temperature = 95 oF.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 0Calculated from rsCap95Noconstant

rsCOP82=float

For rsType=ASHP, rated heating coefficient of performance at outdoor dry-bulb temperature = 82 oF.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 0Calculated from rsCap82Noconstant

rsCOP47=float

For rsType=ASHP, rated heating coefficient of performance at outdoor dry-bulb temperature = 47 oF. For rsType=WSHP, rated heating coefficient of performance at source fluid temperature = 68 oF.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 0Estimated from rsHSPF, rsCap47, and rsCap17Noconstant

rsCOP35=float

For rsType=ASHP, rated heating coefficient of performance at outdoor dry-bulb temperature = 35 oF.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 0Calculated from rsCap35, rsCap47, rsCap17, rsCOP47, and rsCOP17Noconstant

rsCOP17=float

For rsType=ASHP, rated heating coefficient of performance at outdoor dry-bulb temperature = 17 oF.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 0Calculated from rsHSPF, rsCap47, and rsCap17Noconstant

rsCOP05=float

For rsType=ASHP, rated heating coefficient of performance at outdoor dry-bulb temperature = 5 oF.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 0Calculated from rsCap05Noconstant

rsCapRat1747=float

Ratio of rsCAP17 over rsCAP47.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 0Based on HSPF or other correlationsNoStart of a run

rsCapRat9547=float

Ratio of rsCAP95 to rsCAP47. This ratio is used for inter-defaulting rsCap47 and rsCapC such that they have consistent values as is required given that a heat pump is a single device. If not given, rsCapRat9547 is determined during calculations using the relationship cap95 = 0.98 * cap47 + 180 (derived via correlation of capacities of a set of real units).

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 0See aboveNoconstant

rsCapRat0547=float

Ratio of rsCAP05 over rsCAP47.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 00Norun start time

rsCapRat11595=float

Ratio of rsCAP115 over rsCAP95.

UnitsLegal RangeDefaultRequiredVariability
0 \(<\) x \(\geq\) 10.9155Norun start time

rsCapRat8295=float

Ratio of rsCAP82 over rsCAP95.

UnitsLegal RangeDefaultRequiredVariability
1 \(\leq\) x \(<\) 21.06Norun start time

rsCapRatCH=float

For WSHP only: ratio of rsCapC to rsCapH. Used to derive capacity during autosizing or when only one capacity is specified.

UnitsLegal RangeDefaultRequiredVariability
.3 \(\leq\) x \(<\) 20.8NoStart of a run

rsCOPMin115=float

Coefficient of performance at outdoor dry-bulb temperature of 115 oF, minimum speed.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 0Calculated from rsCAP115, rsCOP115NoBefore set up or at the end of interval

rsCOPMin95=float

Coefficient of performance at outdoor dry-bulb temperature of 95 oF, minimum speed.

UnitsLegal RangeDefaultRequiredVariability
Calculated from rsCAP95, rsCOP950.0NoBefore set up or at the end of interval

rsCOPMin82=float

Coefficient of performance at outdoor dry-bulb temperature of 82 oF, minimum speed.

UnitsLegal RangeDefaultRequiredVariability
Calculated from rsCAP82, rsCOP820.0NoBefore set up or at the end of interval

rsCOPMin47=float

Coefficient of performance at outdoor dry-bulb temperature of 47 oF, minimum speed.

UnitsLegal RangeDefaultRequiredVariability
Calculated from rsCAP47, rsCOP47rsCOP47NoBefore set up or at the end of interval

rsCOPMin35=float

Coefficient of performance at outdoor dry-bulb temperature of 35 oF, minimum speed.

UnitsLegal RangeDefaultRequiredVariability
Calculated from rsCAP35, rsCOP35Derived from rsCAP47 and rsCAP17NoBefore set up or at the end of interval

rsCOPMin17=float

Coefficient of performance at outdoor dry-bulb temperature of 17 oF, minimum speed.

UnitsLegal RangeDefaultRequiredVariability
Calculated from rsCAP17, rsCOP17rsCOP17NoBefore set up or at the end of interval

rsCOPMin05=float

Coefficient of performance at outdoor dry-bulb temperature of 5 oF, minimum speed.

UnitsLegal RangeDefaultRequiredVariability
Calculated from rsCAP05, rsCOP05rsCOP05NoBefore set up or at the end of interval

rsloadFMin115=float

Ratio of total cooling capacity at minimum (non-cycling) speed to full-speed total cooling capacity at 115 oF outdoor dry bulb temperature.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 01.0NoBefore set up or at the end of interval

rsloadFMin95=float

Ratio of total cooling capacity at minimum (non-cycling) speed to full-speed total cooling capacity at 95 oF outdoor dry bulb temperature.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 01.0NoBefore set up or at the end of interval

rsloadFMin82=float

Ratio of total cooling capacity at minimum (non-cycling) speed to full-speed total cooling capacity at 82 oF outdoor dry bulb temperature.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 01.0NoBefore set up or at the end of interval

rsloadFMin47=float

Ratio of heating capacity at minimum (non-cycling) speed to full-speed total cooling capacity at 47 oF outdoor dry bulb temperature.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 01.0NoBefore set up or at the end of interval

rsloadFMin17=float

Ratio of heating capacity at minimum (non-cycling) speed to full-speed total cooling capacity at 17 oF outdoor dry bulb temperature.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 01.0NoBefore set up or at the end of interval

rsloadFMin05=float

Ratio of heating capacity at minimum (non-cycling) speed to full-speed total cooling capacity at 5 oF outdoor dry bulb temperature.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 01.0NoBefore set up or at the end of interval

rsTypeAuxH=choice

For rsType=ASHP, type of auxiliary heat. Auxiliary heating is used when heatpump capacity is insufficient to maintain zone temperature and during reverse-cycle defrost operation (if rsDefrostModel=REVCYCLEAUX). If rsTypeAuxH=Furnace, energy use for auxiliary heat is accumulated to end use HPBU of meter rsFuelMtr (if specified). If rsTypeAuxH=Resistance, energy use for auxiliary heat is accumulated to end use HPBU of meter rsElecMtr (if specified).

ChoiceDescription
NONENo auxiliary heat
RESISTANCEElectric resistance (aka strip heat)
FURNACEFuel-fired
UnitsLegal RangeDefaultRequiredVariability
See table aboveRESISTANCENoconstant

rsCtrlAuxH=choice

For rsType=ASHP, type of auxiliary heating control.

ChoiceDescription
LOCKOUTCompressor locked out if any auxiliary heating control
CYCLECompressor runs continuously and auxiliary cycles
ALTERNATEAlternates between compressor and auxiliary
UnitsLegal RangeDefaultRequiredVariability
See table aboveALTERNATE if rsTypeAuxH=FURNACE else CYCLENoStart of a run

rsCapAuxH=float

For rsType=ASHP, auxiliary heating capacity. If AUTOSIZEd, rsCapAuxH is set to the peak heating load evaluated at the heating design temperature (Top.heatDsTDbO).

UnitsLegal RangeDefaultRequiredVariability
Btu/hrAUTOSIZE or x \(\ge\) 00Noconstant

rsAFUEAuxH=float

For rsType=ASHP, auxiliary heat annualized fuel utilization efficiency.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 00.9 if rsTypeAuxH=FURNACE else 1Noconstant

rsDefrostModel=choice

Selects modeling options for ASHP outdoor coil defrosting when 17 oF < TDbO < 45 oF. In this temperature range, heating capacity and/or efficiency are typically reduced due to frost accumulation on the outdoor coil.

REVCYCLEReverse compressor (cooling) operation. Net capacity and efficiency is derived from rsCap17/rsCOP17 and rsCap35/rsCOP35 using linear interpolation. Auxiliary heat is not modeled.
REVCYCLEAUXReverse compressor (cooling) operation with provision of sufficient auxiliary heat to make up the loss of heating capacity. Auxiliary heating is typically used to prevent cold air delivery to zones during the defrost cycle.
UnitsLegal RangeDefaultRequiredVariability
one of above choicesREVCYCLEAUXNoconstant

rsSHRtarget=float

Nominal target for sensible heat ratio (for fancoil).

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 00.7Nosubhour

rsFxCapAuxH=float

Auxiliary heating autosizing capacity factor. If AUTOSIZEd, rsCapAuxH is set to rsFxCapAuxH \(\times\) (peak design-day load). Peak design-day load is the heating capacity that holds zone temperature at the thermostat set point during the last substep of all hours of all design days.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 01Noconstant

rsSEER=float

Cooling rated Seasonal Energy Efficiency Ratio (SEER).

UnitsLegal RangeDefaultRequiredVariability
Btu/Whx \(>\) 0noneYesconstant

rsEER=float

Cooling Energy Efficiency Ratio (EER) at standard AHRI rating conditions (outdoor drybulb of 95 oF and entering air at 80 oF drybulb and 67 oF wetbulb). For rsType=WSHP, rated EER at fluid source temperature = 86 oF.

UnitsLegal RangeDefaultRequiredVariability
Btu/Whx \(>\) 0Estimated from SEER unless WSHPYes for WSHP else Noconstant

rsCapC=float

Net cooling capacity at standard rating conditions (outdoor drybulb temperature = 95 oF for air source or fluid source temperature = 86 oF for water source).

If rsType=ASHP and both rsCapC and rsCap47 are autosized, both are set to the larger consistent value using rsCapRat9547 (after application of rsFxCapH and rsFxCapC).

If rsType=WSHP and both rsCapC and rsCapH are autosized, both are set to the larger consistent value using rsCapRatCH (after application of rsFxCapH and rsFxCapC).

UnitsLegal RangeDefaultRequiredVariability
Btu/hrAUTOSIZE or x \(\le\) 0 (x \(>\) 0 coverted to \(<\) 0)noneYes if rsType includes coolingconstant

rsTdDesC=float

Nominal cooling temperature fall (across system, not zone) used during autosizing (when capacity is not yet known).

UnitsLegal RangeDefaultRequiredVariability
oFx \(<\) 0-25Noconstant

rsFxCapC=float

Cooling autosizing capacity factor. rsCapC is set to rsFxCapC \(\times\) (peak design-day load). Peak design-day load is the cooling capacity that holds zone temperature at the thermostat set point during the last substep of all hours of all design days.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 01.4Noconstant

rsFChg=float

Cooling compressor capacity factor. The gross cooling capacity is adjusted by the factor rsFChg as specified by California Title 24 procedures.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 01 (no effect)Noconstant

rsVFPerTon=float

Standard air volumetric flow rate per nominal ton of cooling capacity.

UnitsLegal RangeDefaultRequiredVariability
cfm/ton150 \(\le\) x \(\le\) 500350Noconstant

rsFanPwrC=float

Cooling fan power.

UnitsLegal RangeDefaultRequiredVariability
W/cfmx \(\ge\) 00.365Noconstant

rsASHPLockOutT=float

Source air dry-bulb temperature below which the air source heat pump compressor does not operate.

UnitsLegal RangeDefaultRequiredVariability
oF(no lockout)Nohourly

rsCdH=float

Heating cyclic degradation coefficient, valid only for compressor-based heating (heat pumps).

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 0.5ASHPHYDRONIC: 0.25 ASHP: derived from rsHSPFNohourly

rsCdC=float

Cooling cyclic degradation coefficient, valid for configurations having compressor-based cooling.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 0.50Nohourly

rsFEffH=float

Heating efficiency factor. At each time step, the heating efficiency is multiplied by rsFEffH.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 01Nosubhourly

rsFEffAuxHBackup=float

Backup auxiliary heating efficiency factor. At each time step, the backup heating efficiency is multiplied by rsFEffAuxHBackup. Backup auxiliary heating is typically provided by electric resistance “strip heat” but may be provided by a furnace (see rsTypeAuxH). If rsTypeAuxH is not “none”, backup heat operates when air source heat pump compressor capacity is insufficient to meet heating load. See also rsFEffAuxHDefrost.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 01Nosubhourly

rsFEffAuxHDefrost=float

Defrost auxiliary heating efficiency factor. At each time step, the defrost auxiliary heating efficiency is multiplied by rsFEffAuxHDefrost. Defrost auxiliary heating is typically provided by electric resistance “strip heat” but may be provided by a furnace (see rsTypeAuxH). If rsDefrostModel=REVCYCLEAUX, defrost auxiliary heat operates during air source heat pump defrost mode. Since defrost and backup heating are generally provided by the same equipment, rsFEffAuxHDefrost and rsFEffAuxHBackup are usually set to the same value, but separate inputs are available for special cases.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 01Nosubhourly

rsFEffC=float

Cooling efficiency factor. At each time step, the cooling efficiency is multiplied by rsEffC.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 01Nosubhourly

rsCapNomH=float

Heating nominal capacity. Provides type-independent probe source for RSYS heating capacity. Daily variability is specified to support value changes during AUTOSIZEing. Values set via input are typically constant.

UnitsLegal RangeDefaultRequiredVariability
Btu/hrx \(\ge\) 0no heating: 0 heat pump: rsCap47 (input or AUTOSIZEd) other: rsCapH (input or AUTOSIZEd)Nodaily

rsCapNomC=float

Cooling nominal capacity. Provides type-independent probe source for RSYS cooling capacity. Daily variability is specified to support value changes during AUTOSIZEing. Values set via input are typically constant.

UnitsLegal RangeDefaultRequiredVariability
Btu/hrx \(\ge\) 0no cooling: 0 other: rsCap95 (input or AUTOSIZEd)Nodaily

rsDSEH=float

Heating distribution system efficiency. If given, (1-rsDSEH) of RSYS heating output is discarded. Cannot be combined with more detailed DUCTSEG model.

UnitsLegal RangeDefaultRequiredVariability
0 < x < 1(use DUCTSEG model)Nohourly

rsDSEC=float

Cooling distribution system efficiency. If given, (1-rsDSEC) of RSYS cooling output is discarded. Cannot be combined with more detailed DUCTSEG model.

UnitsLegal RangeDefaultRequiredVariability
0 < x < 1(use DUCTSEG model)Nohourly

rsOAVType=choice

Type of central fan integrated (CFI) outside air ventilation (OAV) included in this RSYS. OAV systems use the central system fan to circulate outdoor air (e.g. for night ventilation).

OAV cannot operate simultaneously with whole building ventilation (operable windows, whole house fans, etc.). Availability of ventilation modes is controlled on an hourly basis via Top ventAvail.

NONENo CFI ventilation capabilities
FIXEDFixed-flow CFI (aka SmartVent). The specified rsOAVVfDs is used whenever the RSYS operates in OAV mode.
VARIABLEVariable-flow CFI (aka NightBreeze). Flow rate is determined at midnight based on prior day’s average dry-bulb temperature according to a control algorithm defined by the NightBreeze vendor.
UnitsLegal RangeDefaultRequiredVariability
NONE, FIXED, VARIABLEnoneNoconstant

rsOAVVfDs=float

Design air volume flow rate when RSYS is operating in OAV mode.

UnitsLegal RangeDefaultRequiredVariability
cfmx \(\ge\) 0noneif rsOAVType $ e$ NONEconstant

rsOAVVfMinF=float

Minimum air volume flow rate fraction when RSYS is operating in OAV mode. When rsOAVType=VARIABLE, air flow rate is constrained to rsOAVVfMinF * rsOAVVfDs or greater.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 10.2Noconstant

rsOAVFanPwr=float

RSYS OAV-mode fan power.

UnitsLegal RangeDefaultRequiredVariability
W/cfm0 < x \(\le\) 5per rsOAVTYPE FIXED: rsFanPwrC VARIABLE: NightBreeze vendor curve based on rsOAVvfDsNoconstant

rsOAVTDbInlet=float

OAV inlet (source) air temperature. Supply air temperature at the zone is generally higher due to fan heat. Duct losses, if any, also alter the supply air temperature.

UnitsLegal RangeDefaultRequiredVariability
oFx \(\ge\) 0Dry-bulb temperature from weather fileNohourly

rsOAVTdiff=float

OAV temperature differential. When operating in OAV mode, the zone set point temperature is max( znTD, inletT+rsOAVTdiff). Small values can result in inadvertent zone heating, due to fan heat.

UnitsLegal RangeDefaultRequiredVariability
oFx \(>\) 05 oFNohourly

rsOAVReliefZn=znName

Name of zone to which relief air is directed during RSYS OAV operation, typically an attic zone. Relief air flow is included in the target zone’s pressure and thermal balance.

UnitsLegal RangeDefaultRequiredVariability
name of ZONEnoneif rsOAVType $ e$ NONEconstant

rsParElec=float

Parasitic electrical power. rsParElec is unconditionally accumulated to rsElecMtr (if specified) and has no other effect.

UnitsLegal RangeDefaultRequiredVariability
W0Nohourly

rsParFuel=float

Parasitic fuel use. rsParFuel is unconditionally accumulated to rsFuelMtr (if specified) and has no other effect.

UnitsLegal RangeDefaultRequiredVariability
Btuh0Nohourly

rsRhIn=float

Entering air relative humidity (for model testing).

UnitsLegal RangeDefaultRequiredVariability
W/cfm0 \(\le\) x \(\le\) 1Derived from entering air stateNoconstant

rsTdbOut=float

Air dry-bulb temperature at the outdoor portion of this system.

UnitsLegal RangeDefaultRequiredVariability
oFx \(\ge\) 0From weather fileNohourly

endRSYS

Optionally indicates the end of the RSYS definition.

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

Related Probes:

4.26 DUCTSEG

DUCTSEG defines a duct segment. Each RSYS has at most one return duct segment and at most one supply duct segment. That is, DUCTSEG input may be completely omitted to eliminate duct losses.

dsName

Optional name of duct segment; give after the word “DUCTSEG” if desired.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneNoconstant

dsTy=choice

Duct segment type.

UnitsLegal RangeDefaultRequiredVariability
SUPPLY, RETURNYesconstant

The surface area of a DUCTSEG depends on its shape. 0 surface area is legal (leakage only). DUCTSEG shape is modeled either as flat or round –

dsBranchLen=float

Average branch length.

UnitsLegal RangeDefaultRequiredVariability
ftx \(>\) 0-1.0Noconstant

dsBranchCount=integer

Number of branches.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 0-1Noconstant

dsBranchCFA=float

Floor area served per branch

UnitsLegal RangeDefaultRequiredVariability
ft2x \(>\) 0-1.0Noconstant

dsAirVelDs=float

Specified air velocity design.

UnitsLegal RangeDefaultRequiredVariability
fpmx \(>\) 0-1.0Noconstant

dsExArea=float

Duct segment surface area at outside face of insulation for flat duct shape, see above.

UnitsLegal RangeDefaultRequiredVariability
ft2x \(\ge\) 0noneNoconstant

dsInArea=float

Duct segment inside surface area (at duct wall, duct wall thickness assumed negligible) for round shaped duct.

UnitsLegal RangeDefaultRequiredVariability
ft2x \(\ge\) 0Derived from dsDiameter and dsLength(see above reduct shape)constant

dsDiameter=float

Duct segment round duct diameter (duct wall thickness assumed negligible)

UnitsLegal RangeDefaultRequiredVariability
ftx \(\ge\) 0Derived from dsInArea and dsLength(see above reduct shape)constant

dsLength=float

Duct segment length.

UnitsLegal RangeDefaultRequiredVariability
ftx \(\ge\) 0Derived from dsInArea and dsDiameter(see above reduct shape)constant

dsExCnd=choice

Conditions surrounding duct segment.

UnitsLegal RangeDefaultRequiredVariability
ADIABATIC, AMBIENT, SPECIFIEDT, ADJZNADJZNNoconstant

dsAdjZn=znName

Name of zone surrounding duct segment; used only when dsExCon is ADJZN. Can be the same as a zone served by the RSYS owning the duct segment.

UnitsLegal RangeDefaultRequiredVariability
name of a ZONEnoneRequired when dsExCon = ADJZNconstant

dsEpsLW=float

Exposed (i.e. insulation) outside surface exterior long wave (thermal) emittance.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 10.9Noconstant

dsExT=float

Air dry-bulb temperature surrounding duct segment.

UnitsLegal RangeDefaultRequiredVariability
oFunrestrictednoneRequired if sfExCnd = SPECIFIEDThourly

dsInsulR=float

Insulation thermal resistance not including surface conductances. dsInsulR and dsInsulMat are used to calculate insulation thickness (see below). Duct insulation is modeled as a pure conductance (no mass).

UnitsLegal RangeDefaultRequiredVariability
ft2-oF-hr / Btux \(\ge\) 00Noconstant

dsInsulMat=matName

Name of insulation MATERIAL. The conductivity of this material at 70 oF is combined with dsInsulR to derive the duct insulation thickness. If omitted, a typical fiberglass material is assumed having conductivity of 0.025 Btu/hr-ft2-F at 70 oF and a conductivity coefficient of .00418 1/F (see MATERIAL). In addition, insulation conductivity is adjusted during the simulation in response its average temperature. As noted with dsInsulR, duct insulation is modeled as pure conductance – MATERIAL matDens and matSpHt are ignored.

UnitsLegal RangeDefaultRequiredVariability
name of a MATERIALfiberglassNoconstant

dsLeakF=float

Duct leakage. Return duct leakage is modeled as if it all occurs at the segment inlet. Supply duct leakage is modeled as if it all occurs at the outlet.

UnitsLegal RangeDefaultRequiredVariability
0 \(<\) x \(\le\) 1noneNoconstant

dsExH=float

Outside (exposed) surface convection coefficient.

UnitsLegal RangeDefaultRequiredVariability
Btuh/ft2-oFx \(\ge\) 0.54Nosubhourly

endDuctSeg

Optionally indicates the end of the DUCTSEG definition.

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

Related Probes:

4.27 DHWDAYUSE

Defines an object that represents domestic hot water use for a single day. A DHWDAYUSE contains a collection of DHWUSE objects that specify the time, volume, and duration of individual draws. DHWDAYUSEs are referenced by DHWSYS wsDayUse. Unreferenced DHWDAYUSEs are allowed.

DHWDAYUSEs and their child DHWUSEs are used to construct minute-by-minute hot water use schedules in addition to aggregated hourly schedules. The minute-by-minute schedules are used for modeling resistance and heat pump storage water heaters, see DHWHEATER whType=SmallStorage whHeatSrc=ResistanceX or whHeatSrc=ASHPX.

The following illustrates some features of DHWDAYUSE / DHWUSE

DHWDAYUSE "Sample"
   // 6 AM: 7 min shower, 2 gpm @ 105 F
   DHWUSE whStart=6.0 wuDuration=7 wuFlow=2 wuTemp=105 wuEndUse=Shower wuEventID=1

   // 7 AM: 1 min faucet draw, 100% hot
   DHWUSE whStart=7.0 wuDuration=1 wuFlow=1 wuHotF=1 whEndUse=Faucet wuEventID=2

   // 12:30 PM: dishwasher start, several draws over 70 mins; note common wuEventID
   DHWUSE whStart=12.5 wuDuration=2 wuFlow=2 wuHotF=1 whEndUse=DWashr wuEventID=3
   DHWUSE whStart=12.8 wuDuration=1.5 wuFlow=2 wuHotF=1 whEndUse=DWashr wuEventID=3
   DHWUSE whStart=13.6 wuDuration=3 wuFlow=2 wuHotF=1 whEndUse=DWashr wuEventID=3

   // 7 PM every 2nd day: clothes washer runs
   //   even days: 0 gpm (no draw)
   //   odd days: 3 gpm, 22% hot
   DHWUSE whStart=19 wuDuration=30 wuFlow = ($dayOfYear%2)*3 whEndUse=CWashr whHotF=.22 wuEventID=4

   // 11:54 PM: 20 min bath, 1.5 gpm, 80% hot water
   // Duration spans midnight: draw is wrapped to beginning of *current* day
   //   In this case a 12 M - 12:14 AM draw is modeled -- before (!) the bath start.
   DHWUSE whStart 23.9 wuDuration=20 wuFlow=1.5  wuHotF=.8 whEndUse=Bath wuEventID=99
endDHWDAYUSE

DHWSYS "DHWSYS1"
  ...
  wsDayUse = "Sample"
  ...

During the simulation, DHWUSEs are evaluated each hour. Many DHWUSE values have hourly variability and this allows complicated schemes to be constructed very flexibly. For example:

DHWDAYUSE "HourlyFaucet"
   // Every hour on the half hour: 5 minute, 2 gpm draw
   //   Same as 24 DHWUSEs, one for each hour
   DHWUSE wuStart=$hour+.5 wuDuration=5 wuFlow=2 wuEndUse=Faucet
endDAYUSE

Some DHWUSE configurations involve mixing to specified wuTemp. Hot and cold water arriving at the point of use is assumed to be at DHWSYS wsUseTemp and wsMainsTemp respectively. It is possible to set up situations where wuTemp cannot be achieved (wuTemp > wsUseTemp, for example). Runtime error messages are produced when impossible conditions are detected.

When more than one DHWSYS references the same DHWDAYUSE, DHWUSEs are allocated to DHWSYSs in wuEventID rotation. This procedure divides the water heating load approximately equally while retaining the peak demand of individual events. When detailed information is available about which loads are served by specific systems, separate DHWDAYUSEs should be given.

dhwDayUseName

Object name, given after “DHWDAYUSE”. Required for referencing from DHWSYS.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneYesconstant

wduMult=float

Scale factor applied to all draws in this DHWDAYUSE.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 01Noconstant

endDHWDAYUSE

Indicates the end of the DHWDAYUSE definition. endDHWDAYUSE should follow all child DHWUSEs. Alternatively, the end of the meter definition can be indicated by the declaration of another object or by END.

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

Related Probes:

4.28 DHWUSE

Defines a single hot water draw as part of a DHWDAYUSE. See discussion and examples under DHWDAYUSE. As noted there, most DHWUSE values have hourly variability, allowing flexible representation.

wuName

Optional name; give after the word “DHWUSE” if desired.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneNoconstant

wuStart=float

The starting time of the hot water draw.

UnitsLegal RangeDefaultRequiredVariability
hr0 \(\le\) x \(\le\) 24noneYesconstant

wuDuration=float

Draw duration. wuDuration = 0 is equivalent to omitting the DHWUSE. Durations that extend beyond midnight are included in the current day.

UnitsLegal RangeDefaultRequiredVariability
min0 \(\le\) x \(\le\) 14400Nohourly

wuFlow=float

Draw flow rate at the point of use (in other words, the mixed-water flow rate). wuFlow = 0 is equivalent to omitting the DHWUSE. There is no enforced upper limit on wuFlow, however, unrealistically large values can cause runtime errors.

UnitsLegal RangeDefaultRequiredVariability
gpmx \(\le\) 00Nohourly

wuHotF=float

Fraction of draw that is hot water. Cannot be specified with wuTemp or wuHeatRecEF.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 11Nohourly

wuTemp=float

Mixed-water use temperature at the fixture. Cannot be specified when wuHotF is given.

UnitsLegal RangeDefaultRequiredVariability
oFx \(\le\) 00when wuHeatRecEF is given or parent DHWSYS includes DHWHEATREC(s)hourly

wuHeatRecEF=float

Heat recovery effectiveness, allows simple modeling of heat recovery devices such as drain water heat exchangers.

If non-0 (evaluated hourly), hot water use is reduced based on wuTemp, DHWSYS wsTUse, and DHWSYS wsTInlet. DHWHEATREC(s), if any, are ignored for this use. wuTemp must be specified.

If 0, detailed heat recovery modeling may apply, see DHWHEATREC.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 0.90Nohourly

wuHWEndUse=choice

Hot-water end use: one of Shower, Bath, CWashr, DWashr, or Faucet. wuHWEndUse has the following functions –

UnitsLegal RangeDefaultRequiredVariability
One of above choices(use allocated to Unknown)Noconstant

wuEventID=integer

User-defined identifier that associates multiple DHWUSEs with a single event or activity. For example, a dishwasher uses water at several discrete times during a 90 minute cycle and all DHWUSEs would be assigned the same wuEventID. All DHWUSEs having the same wuEventID should have the same wuHWEndUse.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 00Noconstant

endDHWUSE

Optionally indicates the end of the DHWUSE definition.

UnitsLegal RangeDefaultRequiredVariability
noneNo

Related Probes:

4.29 DHWSYS

DHWSYS constructs an object representing a domestic hot water system consisting of one or more hot water heaters, storage tanks, loops, and pumps (DHWHEATER, DHWTANK, DHWLOOP, and DHWPUMP, see below) and a distribution system characterized by loss parameters. This model is based on Appendix B of the 2019 Residential ACM Reference Manual and the Ecotope HPWHSim air source heat pump water heater model (called HPWH herein).

The parent-child structure of DHWSYS components is determined by input order. For example, DHWHEATERs belong to the DHWSYS that precedes them in the input file. The following hierarchy shows the relationship among components. Note that any of the commands can be repeated any number of times.

Minimal modeling is included for physically realistic controls. For example, if several DHWHEATERs are included in a DHWSYS, an equal fraction of the required hot water is assumed to be produced by each heater, even if they are different types or sizes. Thus a DHWSYS is in some ways a collection of components as opposed to an explicitly connected system. This approach avoids requiring detailed input that would impose impractical user burden, especially in compliance applications.

dhwsysName

Optional name of system; give after the word “DHWSYS” if desired.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneNoconstant

wsCalcMode=choice

Enables preliminary simulation that derives values needed for simulation.

PRERUNCalculate hot water heating load; at end of run, derive whLDEF for all child DHWHEATERs for which that value is required and defaulted (this emulates methods used in the T24DHW.DLL implementation of CEC DHW procedures). Also derived are average number of draws per day by end use (used in the wsDayWaste scheme).
SIMULATEPerform full modeling calculations

To use PRERUN efficiently, the recommended input file structure is:

This order avoids duplicate time-consuming simulation of the full building model.

UnitsLegal RangeDefaultRequiredVariability
Codes listed aboveSIMULATENo

wsCentralDHWSYS=dhwsysName

Name of the central DHWSYS that serves this DHWSYS, allowing representation of multiple units having distinct distribution configurations and/or water use patterns but served by a central DHWSYS. The child DHWSYS(s) may not include DHWHEATERs – they are “loads only” systems. wsCentralDHWSYS and wsLoadShareDHWSYS cannot both be given.

UnitsLegal RangeDefaultRequiredVariability
name of a DHWSYSDHWSYS is standaloneNoconstant

wsLoadShareDHWSYS=dhwsysName

Name of a DHWSYS that serves the same loads as this DHWSYS, allowing representation of multiple water heating systems within a unit. If given, wsUse and wsDayUse are not allowed, hot water requirements are derived from the referenced DHWSYS. wsCentralDHWSYS and wsLoadShareDHWSYS cannot both be given.

For example, two DHWSYSs should be defined to model two water heating systems serving a load represented by wsDayUse DayUseTyp. Each DHWSYS should include DHWHEATER(s) and other components as needed. DHWSYS Sys1 should specify wsDayUse=DayUseTyp and DHWSYS Sys2 should have wsLoadShareDHWSYS=Sys1 in place of wsDayUse.

Loads are shared by assigning DHWUSE events sequentially by end use to all DHWSYS with compatible fixtures (determined by wsFaucetCount, wsShowerCount etc., see below) in the group. This algorithm approximately divides load for each end use by the number of compatible fixtures in the group. In addition, assigning 0 to a fixture type prevents assignment of an end use load to a DHWSYS – for example, wsDWashrCount=0 could be provided for a DHWSYS that does not serve a kitchen.

UnitsLegal RangeDefaultRequiredVariability
name of a DHWSYSNo shared loadsNoconstant

wsMult=float

Number of identical systems of this type (including all child objects). Any value \(> 1\) is equivalent to repeated entry of the same DHWSYS. A value of 0 is equivalent to omitting the DHWSYS. Non-integral values scale all results; this may be useful in parameterized models, for example.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 01Noconstant

wsFaucetCount=integer
wsShowerCount=integer
wsBathCount=integer
wsCWashrCount=integer
wsDWashrCount=integer

Specifies the count of fixtures served by this DHWSYS that can accommodate draws of each end use (see DHWUSE). These counts are used for distributing draws in shared load configurations (multiple DHWSYSs serving the same loads, see wsLoadShareDHWSYS above).

In addition, wsShowerCount participates in assignment of Shower draws to DHWHEATRECs (if any).

Unless this DHWSYS is part of a shared-load group or includes DHWHEATREC(s), these counts have no effect and need not be specified.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 01Noconstant

wsTInlet=float

Specifies cold (mains) water temperature supplying this DHWSYS. DHWHEATER supply water temperature wsTInlet adjusted (increased) by any DHWHEATREC recovered heat and application of wsSSF (approximating solar preheating).

UnitsLegal RangeDefaultRequiredVariability
oF\(>\) 32 oFMains temp from weather fileNohourly

wsTInletTest=float

Overides at the substep interval the cold (mains) water temperature supplying this DHWSYS.

CAUTION: wsTInletTest is intended for testing and model validation studies and should not be generally used. It is not fully supported for all DHWSYS configurations. wsTInletTest is allowed only for configurations using HPWH-based DHWHEATERs (whHeatSrc=ASHPX or whHeatSrc=RESISTANCEX).

UnitsLegal RangeDefaultRequiredVariability
oF\(>\) 32 oFNosubhourly

wsTInletDes=float

Cold water inlet design temperature for sizing.

UnitsLegal RangeDefaultRequiredVariability
oFx \(>\) 32 oFAnnual minimums mains temperatureNoconstant

wsUse=float

Hourly hot water use (at the point of use). See further info under wsDayUse.

UnitsLegal RangeDefaultRequiredVariability
galx \(\ge\) 00Nohourly

wsUseTest=float

Additional substep hot water use added to draw(s) specfied by wsHWUse and wsDayUse.

CAUTION: wsUseTest is intended for testing and model validation studies and should not be generally used. It is not fully supported for all DHWSYS configurations. wsUseTest is allowed only for configurations using HPWH-based DHWHEATERs (whHeatSrc=ASHPX or whHeatSrc=RESISTANCEX).

UnitsLegal RangeDefaultRequiredVariability
galx \(\ge\) 0Nosubhourly

wsDayUse=dhwdayuseName

Name of DHWDAYUSE object that specifies a detailed schedule of mixed water use at points of hot water use (that is, “at the tap”). The mixed water amounts are used to derive hot water requirements based on specified mixing fractions or mixed water temperature (see DHWDAYUSE and DHWUSE).

The total water use modeled by CSE is the sum of amounts given by wsUse and the DWHDAYUSE schedule. DHWDAYUSE draws are resolved to minute-by-minute bins compatible with the HPWH model and wsUse/60 is added to each minute bin. Conversely, the hour total of the DHWDAYUSE amounts is included in the draw applied to non-HPWH DHWHEATERs.

wsDayUse variability is daily, so it is possible to select different schedules as a function of day type (or any other condition), as follows –

     DHWSYS "DHW1"
       ...
       wsDayUse = choose( $isWeHol, "DUSEWeekday", "DUSEWeHol")
       ...

Note that while DHWDAYUSE selection is updated daily, the DHWUSE values within the DHWDAYUSE can be altered hourly, providing additional scheduling flexibility.

UnitsLegal RangeDefaultRequiredVariability
name of a DHWDAYUSE(no scheduled draws)Nodaily

wsFaucetDrawDurF=float

Water heater draw duration factor for faucets. Defined as the ratio of the actual draw duration (including time waiting for hot water to arrive at the fixture) to the nominal draw duration (as though hot water was instantly available).

UnitsLegal RangeDefaultRequiredVariability
x \(\geq\) 00.0NoHourly

wsShowerDrawDurF=float

Water heater draw duration factor for showers. Defined as the ratio of the actual draw duration (including time waiting for hot water to arrive at the fixture) to the nominal draw duration (as though hot water was instantly available).

UnitsLegal RangeDefaultRequiredVariability
x \(\geq\) 00.0NoHourly

wsBathDrawDurF=float

Water heater draw duration factor for baths. Defined as the ratio of the actual draw duration (including time waiting for hot water to arrive at the fixture) to the nominal draw duration (as though hot water was instantly available).

UnitsLegal RangeDefaultRequiredVariability
x \(\geq\) 00.0NoHourly

wsCWashrDrawDurF=float

Water heater draw duration factor for clothes washers. Defined as the ratio of the actual draw duration (including time waiting for hot water to arrive at the fixture) to the nominal draw duration (as though hot water was instantly available).

UnitsLegal RangeDefaultRequiredVariability
x \(\geq\) 01.0NoHourly

wsDWashrDurF=float

Water heater draw duration factor for dishwashers. Defined as the ratio of the actual draw duration (including time waiting for hot water to arrive at the fixture) to the nominal draw duration (as though hot water was instantly available).

UnitsLegal RangeDefaultRequiredVariability
x \(\geq\) 01.0NoHourly

wsUnkDrawDurF=float

Water heater draw duration factor for unknown end use. Defined as the ratio of the actual draw duration (including time waiting for hot water to arrive at the fixture) to the nominal draw duration (as though hot water was instantly available).

UnitsLegal RangeDefaultRequiredVariability
x \(\geq\) 00.0NoHourly

wsFaucetDrawWaste=float

Draw water waste for faucets. Specifies additional draw volume per DHWUSE event (at fixture, by end use). This can be used to account for water discarded during warmup or otherwise adjust the draw volume. Because the values are at the fixture, the impact on hot water demand additionally depends on DHWUSE parameters. The value is applied by lengthening (or shortening) the draw duration.

UnitsLegal RangeDefaultRequiredVariability
gal/drawx \(\geq\) 00.0NoHourly

wsShowerDrawWaste=float

Draw water waste for showers. Specifies additional draw volume per DHWUSE event (at fixture, by end use). This can be used to account for water discarded during warmup or otherwise adjust the draw volume. Because the values are at the fixture, the impact on hot water demand additionally depends on DHWUSE parameters. The value is applied by lengthening (or shortening) the draw duration.

UnitsLegal RangeDefaultRequiredVariability
gal/drawx \(\geq\) 00.0NoHourly

wsBathDrawWaste=float

Draw water waste for baths. Specifies additional draw volume per DHWUSE event (at fixture, by end use). This can be used to account for water discarded during warmup or otherwise adjust the draw volume. Because the values are at the fixture, the impact on hot water demand additionally depends on DHWUSE parameters. The value is applied by lengthening (or shortening) the draw duration.

UnitsLegal RangeDefaultRequiredVariability
gal/drawx \(\geq\) 00.0NoHourly

wsCWashrDrawWaste=float

Draw water waste for clothes washers. Specifies additional draw volume per DHWUSE event (at fixture, by end use). This can be used to account for water discarded during warmup or otherwise adjust the draw volume. Because the values are at the fixture, the impact on hot water demand additionally depends on DHWUSE parameters. The value is applied by lengthening (or shortening) the draw duration.

UnitsLegal RangeDefaultRequiredVariability
gal/drawx \(\geq\) 00.0NoHourly

wsDWashrDrawWaste=float

Draw water waste for dishwashers. Specifies additional draw volume per DHWUSE event (at fixture, by end use). This can be used to account for water discarded during warmup or otherwise adjust the draw volume. Because the values are at the fixture, the impact on hot water demand additionally depends on DHWUSE parameters. The value is applied by lengthening (or shortening) the draw duration.

UnitsLegal RangeDefaultRequiredVariability
gal/drawx \(\geq\) 00.0NoHourly

wsUnkDrawWaste=float

Draw water waste for unknown end use. Specifies additional draw volume per DHWUSE event (at fixture, by end use). This can be used to account for water discarded during warmup or otherwise adjust the draw volume. Because the values are at the fixture, the impact on hot water demand additionally depends on DHWUSE parameters. The value is applied by lengthening (or shortening) the draw duration.

UnitsLegal RangeDefaultRequiredVariability
gal/drawx \(\geq\) 00.0NoHourly

wsTRLTest=float

Circulation loop return temperature for testing and validation.

UnitsLegal RangeDefaultRequiredVariability
Fx \(\geq\) 00.0NoSubhourly

wsVolRLTest=float

Circulation loop volume flow rate for testing and validation.

UnitsLegal RangeDefaultRequiredVariability
gpmx \(\geq\) 00.0NoSubhourly

wsBranchModel=choice

Branch model selection.

wsBranchModelDescription
T24DHWModel in appendix B of the Alternative Compliance Manual
DRAWWASTEDraw duration increase per draw waste
DAYWASTEdraw duration increase per day waste

wsDayWasteVol=float

Average amount of waste per day.

UnitsLegal RangeDefaultRequired**Variability
gal/dayx \(\ge\) 0wsDayWasteBranchVolF * (Total DHWLOOPBRANCH vol)Noconstant

wsDayWasteBranchVolF=float

Day waste scaling factor.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 01Noconstant

wsFaucetDayWasteF=float

Relative faucet water draw for day of waste scheme.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 00.0Nosubhourly

wsShowerDayWasteF=float

Relative shower water draw for day of waste scheme.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 00.0Nosubhourly

wsBathDayWasteF=float

Relative bath water draw for day of waste scheme.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 00.0Nosubhourly

wsCWashrDayWasteF=float

Relative clothes washer water draw for day of waste scheme.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 00.0Nosubhourly

wsDWashrDayWasteF=float

Relative dish washer water draw for day of waste scheme.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 00.0Nosubhourly

wsUnkDayWasteF=float

Unknown relative water draw for day of waste scheme.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 00.0Nosubhourly

wsTUse=float

Hot water delivery temperature (at output of water heater(s) and at point of use). Delivered water is mixed down to wsTUSe (with cold water) or heated to wsTUse (with extra electric resistance backup, see DHWHEATER whXBUEndUse). Note that draws defined via DHWDAYUSE / DHWUSE can specify mixing to a lower temperature.

UnitsLegal RangeDefaultRequiredVariability
oF\(>\) 32 oF120Nohourly

wsTUseTest=float

Overides at the substep interval the hot water delivery temperature.

CAUTION: wsTUseTest is intended for testing and model validation studies and should not be generally used. It is not fully supported for all DHWSYS configurations. wsTUseTest is allowed only for configurations using HPWH-based DHWHEATERs (whHeatSrc=ASHPX or whHeatSrc=RESISTANCEX).

UnitsLegal RangeDefaultRequiredVariability
oF\(>\) 32 oFNosubhourly

wsTSetPoint=float

Specifies the hot water setpoint temperature for all child DHWHEATERs. Used only for HPWH-based DHWHEATERs (HPWH models tank temperatures and heating controls), otherwise has no effect. wsTSetpoint can be modified hourly to achieve load-shifting effects.

UnitsLegal RangeDefaultRequiredVariability
oF\(>\) 32 oFwsTUseNohourly

wsTSetPointLH=float

Specifies the hot water set point temperature for all child DHWLOOPHEATERs. Used only for HPWH-based DHWHLOOPEATERs (HPWH explicitly models tank temperatures and heating controls), otherwise has no effect.

UnitsLegal RangeDefaultRequiredVariability
oF\(>\) 32 oFwsTSetPointNohourly

wsTSetpointDes=float

Specifies the design (sizing) set point temperature.

UnitsLegal RangeDefaultRequiredVariability
oFx \(>\) 32 oFwsTUseNoconstant

wsVolRunningDes=float

Running volume for design. Active volume (above aquastat) equals to a full tank volume, defaults from EcoSizer at end of prerun if not input. No direct use, must be passed to DHWHEATER via ALTER.

UnitsLegal RangeDefaultRequiredVariability
galx \(>\) 00.0Noconstant

wsASHPTSrcDes=float

Design (sizing) source air temperature for HPWH DHWHEATERs.

UnitsLegal RangeDefaultRequiredVariability
oFx \(>\) 32 oFHeating design temperatureNoAt the start and at the end of interval

wsFxDes=float

Excess size factor for domestic hot water design. wsFxDes is applied when wsHeatingCapDes and/or wsVolRunningDes are defaulted from EcoSizer at the end of the prerun. There is no effect if those values are input.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 01.0Noconstant

wsDRMethod=choice

Selects alternative control schemes for HPWH-based DHWHEATERs. These allow shifting primary heater (compressor or resistance element) operation to times of day that have load-management advantages.

wsDRMethodDescription
NONENone (default setpoint-based control)
SCHEDULEDemand response schedule (see wsDRSignal)
STATEOFCHARGEState-of-charge (see wsTargetSOC)
UnitsLegal RangeDefaultRequiredVariability
See table aboveNONENoconstant

wsDRSignal=choice

When (and only when) wsDRMethod=SCHEDULE, wsDRSignal allows hourly specification of modified control schemes. Available signals are:

wsDRSignalDescription
ONNormal operation following the water heater’s internal control logic.
TOOTops off the tank once by engaging the all the available heating sources (compressor and resistive elements) in the water heater to heat the tank to setpoint (regardless of the current condition).
TOOLORTops off the tank once and locks out the resistance elements (only the compressor is used to heat the tank to setpoint).
TOOLOCTops off the tank once and locks out the compressor (only the resistance elements are used to heat the tank to setpoint).
TOTTops off the tank on a timer using all the available heating sources (compressor and resistive elements) in the water heater. The tank starts a timer and heating to setpoint when the call is received and repeats the heating call when the timer reaches zero.
TOTLORTops of the tank on a timer and locks out the resistance elements (only the compressor is used to heat the tank to setpoint).
TOTLOCTops of the tank on a timer and locks out the compressor (only the resistance elements are used to heat the tank to setpoint).
LOCLocks out the compressor from the water heater’s normal internal control logic.
LORLocks out the resistive elements from the water heater’s normal internal control logic.
LOCLORLocks out the compressor and resistive elements from the water heater’s normal internal control logic.

Scheduling functions can be used to construct control strategies of interest, for example:

wsDRSignal = $isWeHol
  ? hourval( on,  on,  on,  on,  on,  on,  on,  on,  on,  on,  on,  on,
            on,  on,  on,  on,  on,  on, TOO, LOC, LOR,  on,  on,  on)
  : hourval( on,  on,  on,  on,  on,     on,     on,  on,  on,  on,  on,  on,
            on,  on,  on,  on,  TOOLOR, TOOLOR, LOC, LOR, LOR, LOR,  on,  on)

Note also that wsTSetpoint can be also be modified hourly to achieve load-shifting effects.

UnitsLegal RangeDefaultRequiredVariability
See Table aboveONNohourly

wsTargetSOC=float

When (and only when) wsDRMethod=STATEOFCHARGE, wsTargetSOC specifies the target fraction of maximum tank heat content. The tank is deemed fully charged when its entire contents is at wsTSetpoint and 0 charged at 110 oF. Schedules are used to indicate anticipated heat requirements. The STATEOFCHARGE method can be used in combined heat / DHW systems (see RSYS rsType=COMBINEDHEATDHW) when there is excess capacity during summer months, as shown in the following:

wsTargetSOC = select(
  $month > 11 || $month < 3,
      hourval(.70,.70,.70,.70,.70,.70,.70,.30,.95,.95,.95,.95,
              .95,.95,.95,.95,.95,.70,.70,.70,.70,.70,.70,.70),
  $month==3 || $month== 4,
      hourval(.50,.50,.50,.50,.50,.50,.50,.30,.95,.95,.95,.95,
              .95,.95,.95,.95,.95,.50,.50,.50,.50,.50,.50,.50),
  default
      hourval(.15,.15,.15,.15,.15,.15,.15,.15,.15,.15,.15,.15,
              .15,.60,.60,.60,.15,.15,.15,.15,.15,.15,.15,.15))
UnitsLegal RangeDefaultRequiredVariability
0 \(\lt\) x \(\le\) 10.9Nohourly

wsSDLM=float

Specifies the standard distribution loss multiplier. See App B Eqn 4. To duplicate CEC 2019 methods, this value should be set according to the value derived with App B Eqn 5.

UnitsLegal RangeDefaultRequiredVariability
\(>\) 01Noconstant

wsDSM=float

Distribution system multiplier. See RACM App B Eqn 4. To duplicate CEC 2016 methods, wsDSM should be set to the appropriate value from App B Table B-2. Note the NCF (non-compliance factor) included in App B Eqn 4 is not a CSE input and thus must be applied externally to wsDSM.

UnitsLegal RangeDefaultRequiredVariability
\(>\) 01Noconstant

wsWF=float

Waste factor. See RACM App B Eqn 1. wsWF is applied to hot water draws. The default value (1) reflects the inclusion of waste in draw amounts. App B specifies wsWF=0.9 when the system has a within-unit pumped loop that reduces waste due to immediate availability of hot water at fixtures.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 01Nohourly

wsSSF=float

NOTE: Deprecated. Use wsSolarSys instead.

Specifies the solar savings fraction, allowing recognition of externally-calculated solar water heating energy contributions. The contributions are modeled by deriving an increased water heater feed temperature –

\[tWHFeed = tInletAdj + wsSSF*(wsTUse-tInletAdj)\]

where tInletAdj is the source cold water temperature including any DHWHEATREC tempering (that is, wsTInlet + heat recovery temperature increase, if any). This model approximates the diminishing returns associated with combined preheat strategies such as drain water heat recovery and solar.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 0.99Nohourly

wsSolarSys=dhwSolarSys

Name of DHWSOLARSYS object, if any, that supplies pre-heated water to this DHWSYS.

UnitsLegal RangeDefaultRequiredVariability
name of a DHWSOLARSYSnot recordedNoconstant

wsParElec=float

Specifies electrical parasitic power to represent recirculation pumps or other system-level electrical devices. Calculated energy use is accumulated to the METER specified by wsElecMtr (end use DHW). No other effect, such as heat gain to surroundings, is modeled.

UnitsLegal RangeDefaultRequiredVariability
Wx \(\ge\) 00Nohourly

wsDrawMaxDur=integer

Maximum draw duration for the sizing window.

UnitsLegal RangeDefaultRequiredVariability
Hrx \(\geq\) 04Noconstant

wsLoadMaxDur=integer

Maximum load duration for the sizing window.

UnitsLegal RangeDefaultRequiredVariability
Hrx \(\geq\) 012Noconstant

wsElecMtr=mtrName

Name of METER object, if any, to which DHWSYS electrical energy use is recorded (under end use DHW). In addition, wsElecMtr provides the default whElectMtr selection for all DHWHEATERs and DHWPUMPs in this DHWSYS.

UnitsLegal RangeDefaultRequiredVariability
name of a METERnot recordedNoconstant

wsFuelMtr =mtrName

Name of METER object, if any, to which DHWSYS fuel energy use is recorded (under end use DHW). DHWSYS fuel use is usually (always?) 0, so the primary use of this input is to specify the default whFuelMtr choice for DHWHEATERs in this DHWSYS.

UnitsLegal RangeDefaultRequiredVariability
name of a METERnot recordedNoconstant

wsWHhwMtr=dhwmtrName

Name of DHWMETER object, if any, to which hot water quantities (at water heater) are recorded by hot water end use.

UnitsLegal RangeDefaultRequiredVariability
name of a METERnot recordedNoconstant

wsFXhwMtr =dhwmtrName

Name of DHWMETER object, if any, to which mixed hot water use (at fixture) quantities are recorded by hot water end use. DHWDAYUSE and wsUse input can be verified using DHWMETER results.

UnitsLegal RangeDefaultRequiredVariability
name of a METERNoconstant

wsWriteDrawCSV=choice

If Yes, a comma-separated file is generated containing 1-minute interval hot water draw values for testing or linkage purposes.

UnitsLegal RangeDefaultRequiredVariability
Yes or NoNoNoconstant

endDHWSys

Optionally indicates the end of the DHWSYS definition.

UnitsLegal RangeDefaultRequiredVariability
noneNo

Related Probes:

4.30 DHWHEATER

DHWHEATER constructs an object representing a domestic hot water heater (or several if identical).

whName

Optional name of water heater; give after the word “DHWHEATER” if desired.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneNoconstant

whMult=integer

Number of identical water heaters of this type. Any value \(>1\) is equivalent to repeated entry of the same DHWHEATER.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 01Noconstant

whType=choice

Type of water heater. This categorization is based on CEC and federal rating standards that change from time to time.

SMALLSTORAGEA storage water heater having an energy factor (EF) rating. Generally, a gas-fired storage water heater with input of 75,000 Btuh or less, an oil-fired storage water heater with input of 105,000 Btuh or less, an electric storage water heater with input of 12 kW or less, or a heat pump water heater rated at 24 amps or less.
LARGESTORAGEAny storage water heater that is not SMALLSTORAGE.
SMALLINSTANTANEOUSA water heater that has an input rating of at least 4,000 Btuh per gallon of stored water. Small instantaneous water heaters include: gas instantaneous water heaters with an input of 200,000 Btu per hour or less, oil instantaneous water heaters with an input of 210,000 Btu per hour or less, and electric instantaneous water heaters with an input of 12 kW or less.
LARGEINSTANTANEOUSAn instantaneous water heater that does not conform to the definition of SMALLINSTANTANEOUS, an indirect fuel-fired water heater, or a hot water supply boiler.
INSTANTANEOUSUEFAn instantaneous water heater having a UEF rating (as opposed to EF).
UnitsLegal RangeDefaultRequiredVariability
Codes listed aboveSMALLSTORAGENoconstant

whHeatSrc=choice

Heat source for water heater. CSE implements uses efficiency-based models for all whTypes (as documented in RACM, App. B). In addition, the detailed Ecotope HPWH model is available for electric (air source heat pump and resistance) SMALLSTORAGE water heaters.

RESISTANCEElectric resistance heating element Deprecated for whType=SMALLSTORAGE (use RESISTANCEX)
RESISTANCEXElectric resistance heating element, detailed HPWH model
ASHPAir source heat pump, EF model Deprecated for whType=SMALLSTORAGE (use ASHPX)
ASHPXAir source heat pump, detailed HPWH model
FUELFuel-fired burner
UnitsLegal RangeDefaultRequiredVariability
Codes listed aboveFUELNoconstant

whResType=choice

Resistance heater type, valid only if whHeatSrc is equal to RESISTANCEX, else ignored. These choices are supported by the detailed HPWH model. Except for Generic, all heater characteristics are set by HPWH based on whResType.

UnitsLegal RangeDefaultRequiredVariability
Typical SwingTankTypicalNoconstant

whHeatingCap=float

Nominal heating capacity, available only for a limited HPWH types.

UnitsLegal RangeDefaultRequiredVariability
Btuhx \(>\) 00Noconstant

whVol=float

Storage tank volume. Must be omitted or 0 for instantaneous whTypes. Used by HPWH model (whHeatSrc=RESISTANCEX or whHeatSrc=ASHPX). Required when whHeatSrc=RESISTANCEX or whHeatSrc=ASHPX with whASHPType=GENERIC. For all other configurations, whVol is documentation-only.

UnitsLegal RangeDefaultRequiredVariability
gal\(\ge\) 0.1 (caution: small values may cause runtime errors)per whASHPType if HPWH else 50For some HPWH configurations, see aboveconstant

whVolRunning=float

Running storage volume is the volume above aquastat. Requires the total volume based on aquastat position. Ecotope’s HPWH tank and heater.

UnitsLegal RangeDefaultRequiredVariability
galx \(>\) 00Noconstant

whEF=float

Rated energy factor that specifies DHWHEATER efficiency under test conditions. Used by CSE to derive annual water heating efficiency and/or other characteristics as described below. Calculation methods are documented in RACM, Appendix B.

ConfigurationwhEF defaultUse
whType=SMALLSTORAGE, whHeatSrc=RESISTANCE or FUEL0.82Derivation of whLDEF
whType=SMALLSTORAGE, whHeatSrc=ASHP0.82Derivation of whLDEFnote inappropriate default (deprecated, use ASHPX)
whType=SMALLSTORAGE, whHeatSrc=ASHPX, whASHPType=GENERIC(req’d)Tank losses Overall efficiency
whType=SMALLSTORAGE, whHeatSrc=RESISTANCEX(req’d)Tank losses Note: maximum whEF=0.98.
whType=SMALLINSTANTANEOUS, whHeatSrc=RESISTANCE or FUEL0.82Annual efficiency = whEF*0.92
Any other(unused)
UnitsLegal RangeDefaultRequiredVariability
\(>\) 0 Caution: maximum not checked. Unrealistic values will cause runtime errors and/or invalid resultsSee aboveSee aboveconstant

whLDEF=float

Load-dependent energy factor for DHWHEATERs with whType=SMALLSTORAGE and whHeatSrc=FUEL or whHeatSrc=RESISTANCE. If not given, whLDEF is derived using a preliminary simulation activated via DHWSYS wsCalcMode=PRERUN. See RACM Appendix B.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 0Calculated via DHWSYS PreRun mechanismWhen whType = SMALLSTORAGE and PreRun not usedconstant

whUEF=float

Water heater Uniform Energy Factor efficiency rating, used when whType=INSTANTANEOUSUEF.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 0nonewhen whType= INSTANTANEOUSUEFconstant

whAnnualElec=float

Annual electricity use assumed in UEF rating derivation. Used when whType=INSTANTANEOUSUEF.

UnitsLegal RangeDefaultRequiredVariability
kWhx \(\ge\) 0nonewhen whType= INSTANTANEOUSUEFconstant

whAnnualFuel=float

Annual fuel use assumd in UEF rating derivation, used when whType=INSTANTANEOUSUEF.

UnitsLegal RangeDefaultRequiredVariability
thermsx \(\ge\) 0nonewhen whType= INSTANTANEOUSUEFconstant

whRatedFlow=float

Maximum flow rate assumed in UEF rating derivation. Used when whType=INSTANTANEOUSUEF.

UnitsLegal RangeDefaultRequiredVariability
gpmx \(>\) 0nonewhen whType= INSTANTANEOUSUEFconstant

whStbyElec=float

Instantaneous water heater standby power (electricity consumed when heater is not operating). Used when whType=INSTANTANEOUSUEF.

UnitsLegal RangeDefaultRequiredVariability
Wx \(\ge\) 04Noconstant

whLoadCFwdF=float

Instanteous water heater load carry forward factor – approximate number of hours the heater is allowed to meet water heating demand that is unmet on a 1 minute basis, used when whType=INSTANTANEOUSUEF.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 01Noconstant

whZone=znName

Name of zone where water heater is located, used only in detailed HPWH models (whHeatSrc=ASHPX or whHeatSrc=RESISTANCEX), otherwise no effect. Zone conditions are used for tank heat loss calculations. Heat losses from the DHWHEATER are included in the zone heat balance. whZone also provides the default for whASHPSrcZn (see below).

whZone and whTEx cannot both be specified.

UnitsLegal RangeDefaultRequiredVariability
name of a ZONENot in a zone (heat losses discarded)Noconstant

whTEx=float

Water heater surround temperature, used only in detailed HPWH models (whHeatSrc=ASHPX or whHeatSrc=RESISTANCEX), otherwise no effect. When whTEx is specified, tank heat losses are calculated using whTEx and modify tank water temperatures, but the lost heat has no external effect.

whZone and whTEx cannot both be specified.

UnitsLegal RangeDefaultRequiredVariability
oFx \(\ge\) 0whZone air temperature if specified, else 70 oFNohourly

whASHPType=choice

Air source heat pump type, valid only if whHeatSrc=ASHPX. These choices are supported by the detailed HPWH model. Except for Generic, all heater characteristics are set by HPWH based on whASHPType.

ChoiceSpecified type
GenericGeneral generic (parameterized by wh_EF and wh_vol)
AOSmithPHPT6060 gallon Voltex
AOSmithPHPT8080 gallon Voltex
AOSmithHPTU5050 gallon AOSmith HPTU
AOSmithHPTU6666 gallon AOSmith HPTU
AOSmithHPTU8080 gallon AOSmith HPTU
AOSmithHPTU80DR80 gallon AOSmith HPTU (demand reduction variant)
AOSmithCAHP120120 gallon AOSmith
Sanden40Sanden 40 gallon CO2 external heat pump
Sanden80Sanden 80 gallon CO2 external heat pump
Sanden120Sanden 120 gallon CO2 external heat pump
SandenGS3Sanden GS3 compressor CO2 external
GE20122012 era GeoSpring
GE20142014 80 gal GE model run in the efficiency mode
GE2014_80DR2014 80 gal GE model run in the efficiency mode (demand reduction variant)
GE2014StdMode2014 50 gal GE run in standard mode
GE2014StdMode802014 80 gal GE run in standard mode
RheemHB50newish Rheem (2014 model?)
RheemHBDR225050 gallon, 2250 W resistance Rheem HB Duct Ready
RheemHBDR455050 gallon, 4500 W resistance Rheem HB Duct Ready
RheemHBDR226565 gallon, 2250 W resistance Rheem HB Duct Ready
RheemHBDR456565 gallon, 4500 W resistance Rheem HB Duct Ready
RheemHBDR228080 gallon, 2250 W resistance Rheem HB Duct Ready
RheemHBDR458080 gallon, 4500 W resistance Rheem HB Duct Ready
Rheem2020Prem4040 gallon, Rheem 2020 Premium
Rheem2020Prem5050 gallon, Rheem 2020 Premium
Rheem2020Prem6565 gallon, Rheem 2020 Premium
Rheem2020Prem8080 gallon, Rheem 2020 Premium
Rheem2020Build4040 gallon, Rheem 2020 Builder
Rheem2020Build5050 gallon, Rheem 2020 Builder
Rheem2020Build6565 gallon, Rheem 2020 Builder
Rheem2020Build8080 gallon, Rheem 2020 Builder
RheemPlugInShared4040 gal Rheem plug-in 120V shared circuit (no resistance elements)
RheemPlugInShared5050 gal Rheem plug-in 120V shared circuit (no resistance elements)
RheemPlugInShared6565 gal Rheem plug-in 120V shared circuit (no resistance elements)
RheemPlugInShared8080 gal Rheem plug-in 120V shared circuit (no resistance elements)
RheemPlugInDedicated4040 gal Rheem plug-in 120V dedicated circuit (no resistance elements)
RheemPlugInDedicated5050 gal Rheem plug-in 120V dedicated circuit (no resistance elements)
Stiebel220EStiebel Eltron (2014 model?)
AOSmithSHPT50AOSmith add’l models (added 3-24-2017)
AOSmithSHPT66AOSmith add’l models (added 3-24-2017)
AOSmithSHPT80AOSmith add’l models (added 3-24-2017)
GenericTier1Generic Tier 1
GenericTier2Generic Tier 2
GenericTier3Generic Tier 3
GenericGeneral generic (parameterized by EF and vol)
UEF2GenericExperimental UEF=2
WorstCaseMediumUEF2Generic alias (supports pre-existing test cases)
BasicIntegratedTypical integrated HPWH
ResTankResistance heater (no compressor). Superceded by whHeatSrc=RESITANCEX
ResTankNoUAResistance heater (no compressor) with no tank losses. Superseded by whHeatSrc=RESISTANCEX.
AOSmithHPTU80DR80 gallon AOSmith HPTU with fixed backup setpoint (experimental for demand response testing)
AOSmithSHPT5050 gal AOSmith SHPT
AOSmithSHPT6666 gal AOSmith SHPT
AOSmithSHPT8080 gal AOSmith SHPT
ColmacCxV5_SPColmac CxA-xx modular external HPWHs (single pass mode)
ColmacCxA10_SPColmac CxA-xx modular external HPWHs (single pass mode)
ColmacCxA15_SPColmac CxA-xx modular external HPWHs (single pass mode)
ColmacCxA20_SPColmac CxA-xx modular external HPWHs (single pass mode)
ColmacCxA25_SPColmac CxA-xx modular external HPWHs (single pass mode)
ColmacCxA30_SPColmac CxA-xx modular external HPWHs (single pass mode)
ColmacCxV5_MPColmac CxA-xx modular external HPWHs (multi-pass mode)
ColmacCxA10_MPColmac CxA-xx modular external HPWHs (multi-pass mode)
ColmacCxA15_MPColmac CxA-xx modular external HPWHs (multi-pass mode)
ColmacCxA20_MPColmac CxA-xx modular external HPWHs (multi-pass mode)
ColmacCxA25_MPColmac CxA-xx modular external HPWHs (multi-pass mode)
ColmacCxA30_MPColmac CxA-xx modular external HPWHs (multi-pass mode)
NyleC25A_SPNyle Cxx external HPWHs (SP = single pass mode)
NyleC60A_SPNyle Cxx external HPWHs (SP = single pass mode)
NyleC90A_SPNyle Cxx external HPWHs (SP = single pass mode)
NyleC125A_SPNyle Cxx external HPWHs (SP = single pass mode)
NyleC185A_SPNyle Cxx external HPWHs (SP = single pass mode)
NyleC250A_SPNyle Cxx external HPWHs (SP = single pass mode)
NyleC60A_CWP_SPNyle Cxx external SP HPWHs with cold weather package
NyleC90A_CWP_SPNyle Cxx external SP HPWHs with cold weather package
NyleC125A_CWP_SPNyle Cxx external SP HPWHs with cold weather package
NyleC185A_CWP_SPNyle Cxx external SP HPWHs with cold weather package
NyleC250A_CWP_SPNyle Cxx external SP HPWHs with cold weather package
NyleC60A_MPNyle Cxx external HPWHs (MP = multi-pass mode)
NyleC90A_MPNyle Cxx external HPWHs (MP = multi-pass mode)
NyleC125A_MPNyle Cxx external HPWHs (MP = multi-pass mode)
NyleC185A_MPNyle Cxx external HPWHs (MP = multi-pass mode)
NyleC250A_MPNyle Cxx external HPWHs (MP = multi-pass mode)
NyleC60A_CWP_MPNyle Cxx external MP HPWHs w/ cold weather package
NyleC90A_CWP_MPNyle Cxx external MP HPWHs w/ cold weather package
NyleC125A_CWP_MPNyle Cxx external MP HPWHs w/ cold weather package
NyleC185A_CWP_MPNyle Cxx external MP HPWHs w/ cold weather package
NyleC250A_CWP_MPNyle Cxx external MP HPWHs w/ cold weather package
Rheem_HPHD60HNU_MPRheem HPHD60 MP external MP HPWHs
Rheem_HPHD60VNU_MPRheem HPHD60 MP external MP HPWHs
Rheem_HPHD135HNU_MPRheem HPHD135 MP external MP HPWHs
Rheem_HPHD135VNU_MPRheem HPHD135 MP external MP HPWHs
Scalable_SPsingle pass scalable type for autosized standard design
Scalable_MPmultipass scalable type for autosized standard design
AquaThermAireVallara AquaThermAire HPWH
UnitsLegal RangeDefaultRequiredVariability
Codes listed abovenoneWhen whHeatSrc=ASHPXconstant

whASHPSrcZn=znName

Name of zone that serves as heat pump heat source used when whHeatSrc=ASHPX. Heat removed from the zone is added to the heated water and is included in zone heat balance (that is, heat pump operation cools the zone).

whASHPSrcZn and whASHPSrcT cannot both be specified.

UnitsLegal RangeDefaultRequiredVariability
name of a ZONEwhZoneIf no zone is specified by input or default, heat extracted by ASHP has no effect.Noconstant

whASHPSrcT=float

Heat pump source air temperature used when whHeatSrc=ASHPX. Heat removed from this source is added to the heated water but has no other effect.

whASHPSrcZn and whASHPSrcT cannot both be specified.

The logic to determine the temperature of the heat pump source air is:

        if whASHPSrcT is specified
          use whASHPSrcT
        else if whASHPSRCZn is specified
          use whASHPSrcZn air temp
        else if whZone is specified
          use whZone air temp
        else
          use 70 F

To model a heat pump that uses outdoor air as its heat source, omit whASHPSrcZn and specify whASHPSrcT = $tDbO.

UnitsLegal RangeDefaultRequiredVariability
oFx \(\ge\) 070 oF (used only when whASHPSrcZn and whZone not specified)Nohourly

whASHPResUse=float

Specifies activation temperature difference for resistance heating, used only when whHeatSrc=ASHPX and whASHPType=GENERIC. Refer to HPWH engineering documentation for model details.

UnitsLegal RangeDefaultRequiredVariability
oCx \(\ge\) 07.22Noconstant

whResHtPwr=float

Specifies resistance upper element power, used only with whHeatSrc=RESISTANCEX.

UnitsLegal RangeDefaultRequiredVariability
Wx \(\ge\) 04500Noconstant

whResHtPwr2=float

Specifies resistance lower element power, used only with whHeatSrc=RESISTANCEX.

UnitsLegal RangeDefaultRequiredVariability
Wx \(\ge\) 0whResHtPwrNoconstant

whUA=float

HPWH-type total UA (not per tank)

UnitsLegal RangeDefaultRequiredVariability
Btuh/Fx \(\geq\) 0HPWH defaultNoconstant

whInsulR=float

Tank insulation resistance for heat pump water heater.

UnitsLegal RangeDefaultRequiredVariability
hr-F/Btuhx \(>\) 0-1Noconstant

whInHtSupply=float
whInHtLoopRet=float

Fractional tank height of inlets for supply water and DHWLOOP return, used only with HPWH types (whHeatSrc=RESISTANCEX or whHeatSrc=ASHPX). 0 indicates the bottom of the water heater tank and 1 specifies the top. Inlet height influences tank layer mixing and can impact heat pump COP and/or heating activation frequency.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 1HPWH default (0?)Noconstant

whtankCount=float

Number of storage tanks per DHWHEATER, re built-up whType=Builtup, does not reflect wh_mult (wh_mult=2, wh_tankCount=3 -> 6 tanks).

UnitsLegal RangeDefaultRequiredVariability
#x \(\geq\) 11Noconstant

whEff=float

Water heating efficiency, used in modeling whType=LARGESTORAGE and whType=LARGEINSTANTANEOUS.

UnitsLegal RangeDefaultRequiredVariability
0 \(<\) whEff \(\leq\) 1.82Noconstant

whSBL=float

Standby loss, used in modeling whType=LARGESTORAGE.

UnitsLegal RangeDefaultRequiredVariability
Btuhx \(\ge\) 00Noconstant

whPilotPwr=float

Pilot light consumption, included in fuel energy use of DHWHEATERs with whHeatSrc=FUEL.

UnitsLegal RangeDefaultRequiredVariability
Btuhx \(\ge\) 00Nohourly

whParElec=float

Parasitic electricity power, included in electrical energy use of all DHWHEATERs.

UnitsLegal RangeDefaultRequiredVariability
Wx \(\ge\) 00Nohourly

whFAdjElec=float
whFAdjFuel=float

Water heater energy use modifiers. Multiplies calculated use of electricity (whFAdjElec) and fuel (whFAdjFuel). All components of energy use – primary, backup, XBU (extra backup), and other auxiliary – are modified before they are accumulated to whElecMtr and whFuelMtr.

UnitsLegal RangeDefaultRequiredVariability
\(\ge\) 01Nosubhourly

whElecMtr=mtrName

Name of METER object, if any, by which DHWHEATER electrical energy use is recorded (under end use DHW).

UnitsLegal RangeDefaultRequiredVariability
name of a METERParent DHWSYS wsElecMtrNoconstant

whxBUEndUse=choice

Specifies the whElecMtr end use, if any, to which extra backup energy is accumulated. In some water heater types, extra backup energy is modeled to maintain output temperature at wsTUse. By default, extra backup energy is included in end use dhwBU. whxBUEndUse allows specification of an alternative end use to which extra backup energy is accumulated.

UnitsLegal RangeDefaultRequiredVariability
end use code(extra backup accums to dhwBU)Noconstant

whFuelMtr =mtrName

Name of METER object, if any, by which DHWHEATER fuel energy use is recorded (under end use DHW).

UnitsLegal RangeDefaultRequiredVariability
name of a METERParent DHWSYS wsFuelMtrNoconstant

whTankTInit =comma-separated list of 12 floats

A list of 12 initial values for HPWH tank model layer temperatures, in bottom-to-top order. If given, these values are used to initialize tank layer temperatures at the beginning of the warmup period. Initialization is not repeated at the beginning of the main simulation.

whTankTInit is allowed only for HPWH-based types (whHeatSrc=ASHPX or whHeatSrc=ResistanceX).

whTankTInit is intended for use in empirical validation studies where the initial tank state needs to match measured data. whTankTInit should not be generally used. In the absence of whTankTInit, layer temperatures are initialized to the water heater setpoint inherited from the parent DHWSYS.

UnitsLegal RangeDefaultRequiredVariability
oFx \(\gt\) 0Noconstant

endDHWHEATER

Optionally indicates the end of the DHWHEATER definition.

UnitsLegal RangeDefaultRequiredVariability
x \(\geq\) 0noneNo

Related Probes:

4.31 DHWLOOPHEATER

DHWHEATERLOOP constructs an object representing a hot water heater dedicated to heating DHWLOOP return water (or several if identical).

whName

Optional name of water heater; give after the word “DHWHEATER” if desired.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneNoconstant

whMult=integer

Number of identical water heaters of this type. Any value \(>1\) is equivalent to repeated entry of the same DHWHEATER.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 01Noconstant

whType=choice

Type of water heater. This categorization is based on CEC and federal rating standards that change from time to time.

SMALLSTORAGEA storage water heater having an energy factor (EF) rating. Generally, a gas-fired storage water heater with input of 75,000 Btuh or less, an oil-fired storage water heater with input of 105,000 Btuh or less, an electric storage water heater with input of 12 kW or less, or a heat pump water heater rated at 24 amps or less.
LARGESTORAGEAny storage water heater that is not SMALLSTORAGE.
SMALLINSTANTANEOUSA water heater that has an input rating of at least 4,000 Btuh per gallon of stored water. Small instantaneous water heaters include: gas instantaneous water heaters with an input of 200,000 Btu per hour or less, oil instantaneous water heaters with an input of 210,000 Btu per hour or less, and electric instantaneous water heaters with an input of 12 kW or less.
LARGEINSTANTANEOUSAn instantaneous water heater that does not conform to the definition of SMALLINSTANTANEOUS, an indirect fuel-fired water heater, or a hot water supply boiler.
INSTANTANEOUSUEFAn instantaneous water heater having a UEF rating (as opposed to EF).
UnitsLegal RangeDefaultRequiredVariability
Codes listed aboveSMALLSTORAGENoconstant

whHeatSrc=choice

Heat source for water heater. CSE implements uses efficiency-based models for all whTypes (as documented in RACM, App. B). In addition, the detailed Ecotope HPWH model is available for electric (air source heat pump and resistance) SMALLSTORAGE water heaters.

RESISTANCEElectric resistance heating element Deprecated for whType=SMALLSTORAGE (use RESISTANCEX)
RESISTANCEXElectric resistance heating element, detailed HPWH model
ASHPAir source heat pump, EF model Deprecated for whType=SMALLSTORAGE (use ASHPX)
ASHPXAir source heat pump, detailed HPWH model
FUELFuel-fired burner
UnitsLegal RangeDefaultRequiredVariability
Codes listed aboveFUELNoconstant

whResType=choice

Resistance heater type, valid only if whHeatSrc is equal to RESISTANCEX, else ignored. These choices are supported by the detailed HPWH model. Except for Generic, all heater characteristics are set by HPWH based on whResType.

UnitsLegal RangeDefaultRequiredVariability
Typical SwingTankTypicalNoconstant

whHeatingCap=float

Nominal heating capacity, available only for a limited HPWH types.

UnitsLegal RangeDefaultRequiredVariability
Btuhx \(>\) 00Noconstant

whVol=float

Storage tank volume. Must be omitted or 0 for instantaneous whTypes. Used by HPWH model (whHeatSrc=RESISTANCEX or whHeatSrc=ASHPX). Required when whHeatSrc=RESISTANCEX or whHeatSrc=ASHPX with whASHPType=GENERIC. For all other configurations, whVol is documentation-only.

UnitsLegal RangeDefaultRequiredVariability
gal\(\ge\) 0.1 (caution: small values may cause runtime errors)per whASHPType if HPWH else 50For some HPWH configurations, see aboveconstant

whVolRunning=float

Running storage volume is the volume above aquastat. Requires the total volume based on aquastat position. Ecotope’s HPWH tank and heater.

UnitsLegal RangeDefaultRequiredVariability
galx \(>\) 00Noconstant

whEF=float

Rated energy factor that specifies DHWHEATER efficiency under test conditions. Used by CSE to derive annual water heating efficiency and/or other characteristics as described below. Calculation methods are documented in RACM, Appendix B.

ConfigurationwhEF defaultUse
whType=SMALLSTORAGE, whHeatSrc=RESISTANCE or FUEL0.82Derivation of whLDEF
whType=SMALLSTORAGE, whHeatSrc=ASHP0.82Derivation of whLDEFnote inappropriate default (deprecated, use ASHPX)
whType=SMALLSTORAGE, whHeatSrc=ASHPX, whASHPType=GENERIC(req’d)Tank losses Overall efficiency
whType=SMALLSTORAGE, whHeatSrc=RESISTANCEX(req’d)Tank losses Note: maximum whEF=0.98.
whType=SMALLINSTANTANEOUS, whHeatSrc=RESISTANCE or FUEL0.82Annual efficiency = whEF*0.92
Any other(unused)
UnitsLegal RangeDefaultRequiredVariability
\(>\) 0 Caution: maximum not checked. Unrealistic values will cause runtime errors and/or invalid resultsSee aboveSee aboveconstant

whLDEF=float

Load-dependent energy factor for DHWHEATERs with whType=SMALLSTORAGE and whHeatSrc=FUEL or whHeatSrc=RESISTANCE. If not given, whLDEF is derived using a preliminary simulation activated via DHWSYS wsCalcMode=PRERUN. See RACM Appendix B.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 0Calculated via DHWSYS PreRun mechanismWhen whType = SMALLSTORAGE and PreRun not usedconstant

whUEF=float

Water heater Uniform Energy Factor efficiency rating, used when whType=INSTANTANEOUSUEF.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 0nonewhen whType= INSTANTANEOUSUEFconstant

whAnnualElec=float

Annual electricity use assumed in UEF rating derivation. Used when whType=INSTANTANEOUSUEF.

UnitsLegal RangeDefaultRequiredVariability
kWhx \(\ge\) 0nonewhen whType= INSTANTANEOUSUEFconstant

whAnnualFuel=float

Annual fuel use assumd in UEF rating derivation, used when whType=INSTANTANEOUSUEF.

UnitsLegal RangeDefaultRequiredVariability
thermsx \(\ge\) 0nonewhen whType= INSTANTANEOUSUEFconstant

whRatedFlow=float

Maximum flow rate assumed in UEF rating derivation. Used when whType=INSTANTANEOUSUEF.

UnitsLegal RangeDefaultRequiredVariability
gpmx \(>\) 0nonewhen whType= INSTANTANEOUSUEFconstant

whStbyElec=float

Instantaneous water heater standby power (electricity consumed when heater is not operating). Used when whType=INSTANTANEOUSUEF.

UnitsLegal RangeDefaultRequiredVariability
Wx \(\ge\) 04Noconstant

whLoadCFwdF=float

Instanteous water heater load carry forward factor – approximate number of hours the heater is allowed to meet water heating demand that is unmet on a 1 minute basis, used when whType=INSTANTANEOUSUEF.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 01Noconstant

whZone=znName

Name of zone where water heater is located, used only in detailed HPWH models (whHeatSrc=ASHPX or whHeatSrc=RESISTANCEX), otherwise no effect. Zone conditions are used for tank heat loss calculations. Heat losses from the DHWHEATER are included in the zone heat balance. whZone also provides the default for whASHPSrcZn (see below).

whZone and whTEx cannot both be specified.

UnitsLegal RangeDefaultRequiredVariability
name of a ZONENot in a zone (heat losses discarded)Noconstant

whTEx=float

Water heater surround temperature, used only in detailed HPWH models (whHeatSrc=ASHPX or whHeatSrc=RESISTANCEX), otherwise no effect. When whTEx is specified, tank heat losses are calculated using whTEx and modify tank water temperatures, but the lost heat has no external effect.

whZone and whTEx cannot both be specified.

UnitsLegal RangeDefaultRequiredVariability
oFx \(\ge\) 0whZone air temperature if specified, else 70 oFNohourly

whASHPType=choice

Air source heat pump type, valid only if whHeatSrc=ASHPX. These choices are supported by the detailed HPWH model. Except for Generic, all heater characteristics are set by HPWH based on whASHPType.

ChoiceSpecified type
GenericGeneral generic (parameterized by wh_EF and wh_vol)
AOSmithPHPT6060 gallon Voltex
AOSmithPHPT8080 gallon Voltex
AOSmithHPTU5050 gallon AOSmith HPTU
AOSmithHPTU6666 gallon AOSmith HPTU
AOSmithHPTU8080 gallon AOSmith HPTU
AOSmithHPTU80DR80 gallon AOSmith HPTU (demand reduction variant)
AOSmithCAHP120120 gallon AOSmith
Sanden40Sanden 40 gallon CO2 external heat pump
Sanden80Sanden 80 gallon CO2 external heat pump
Sanden120Sanden 120 gallon CO2 external heat pump
SandenGS3Sanden GS3 compressor CO2 external
GE20122012 era GeoSpring
GE20142014 80 gal GE model run in the efficiency mode
GE2014_80DR2014 80 gal GE model run in the efficiency mode (demand reduction variant)
GE2014StdMode2014 50 gal GE run in standard mode
GE2014StdMode802014 80 gal GE run in standard mode
RheemHB50newish Rheem (2014 model?)
RheemHBDR225050 gallon, 2250 W resistance Rheem HB Duct Ready
RheemHBDR455050 gallon, 4500 W resistance Rheem HB Duct Ready
RheemHBDR226565 gallon, 2250 W resistance Rheem HB Duct Ready
RheemHBDR456565 gallon, 4500 W resistance Rheem HB Duct Ready
RheemHBDR228080 gallon, 2250 W resistance Rheem HB Duct Ready
RheemHBDR458080 gallon, 4500 W resistance Rheem HB Duct Ready
Rheem2020Prem4040 gallon, Rheem 2020 Premium
Rheem2020Prem5050 gallon, Rheem 2020 Premium
Rheem2020Prem6565 gallon, Rheem 2020 Premium
Rheem2020Prem8080 gallon, Rheem 2020 Premium
Rheem2020Build4040 gallon, Rheem 2020 Builder
Rheem2020Build5050 gallon, Rheem 2020 Builder
Rheem2020Build6565 gallon, Rheem 2020 Builder
Rheem2020Build8080 gallon, Rheem 2020 Builder
RheemPlugInShared4040 gal Rheem plug-in 120V shared circuit (no resistance elements)
RheemPlugInShared5050 gal Rheem plug-in 120V shared circuit (no resistance elements)
RheemPlugInShared6565 gal Rheem plug-in 120V shared circuit (no resistance elements)
RheemPlugInShared8080 gal Rheem plug-in 120V shared circuit (no resistance elements)
RheemPlugInDedicated4040 gal Rheem plug-in 120V dedicated circuit (no resistance elements)
RheemPlugInDedicated5050 gal Rheem plug-in 120V dedicated circuit (no resistance elements)
Stiebel220EStiebel Eltron (2014 model?)
AOSmithSHPT50AOSmith add’l models (added 3-24-2017)
AOSmithSHPT66AOSmith add’l models (added 3-24-2017)
AOSmithSHPT80AOSmith add’l models (added 3-24-2017)
GenericTier1Generic Tier 1
GenericTier2Generic Tier 2
GenericTier3Generic Tier 3
GenericGeneral generic (parameterized by EF and vol)
UEF2GenericExperimental UEF=2
WorstCaseMediumUEF2Generic alias (supports pre-existing test cases)
BasicIntegratedTypical integrated HPWH
ResTankResistance heater (no compressor). Superceded by whHeatSrc=RESITANCEX
ResTankNoUAResistance heater (no compressor) with no tank losses. Superseded by whHeatSrc=RESISTANCEX.
AOSmithHPTU80DR80 gallon AOSmith HPTU with fixed backup setpoint (experimental for demand response testing)
AOSmithSHPT5050 gal AOSmith SHPT
AOSmithSHPT6666 gal AOSmith SHPT
AOSmithSHPT8080 gal AOSmith SHPT
ColmacCxV5_SPColmac CxA-xx modular external HPWHs (single pass mode)
ColmacCxA10_SPColmac CxA-xx modular external HPWHs (single pass mode)
ColmacCxA15_SPColmac CxA-xx modular external HPWHs (single pass mode)
ColmacCxA20_SPColmac CxA-xx modular external HPWHs (single pass mode)
ColmacCxA25_SPColmac CxA-xx modular external HPWHs (single pass mode)
ColmacCxA30_SPColmac CxA-xx modular external HPWHs (single pass mode)
ColmacCxV5_MPColmac CxA-xx modular external HPWHs (multi-pass mode)
ColmacCxA10_MPColmac CxA-xx modular external HPWHs (multi-pass mode)
ColmacCxA15_MPColmac CxA-xx modular external HPWHs (multi-pass mode)
ColmacCxA20_MPColmac CxA-xx modular external HPWHs (multi-pass mode)
ColmacCxA25_MPColmac CxA-xx modular external HPWHs (multi-pass mode)
ColmacCxA30_MPColmac CxA-xx modular external HPWHs (multi-pass mode)
NyleC25A_SPNyle Cxx external HPWHs (SP = single pass mode)
NyleC60A_SPNyle Cxx external HPWHs (SP = single pass mode)
NyleC90A_SPNyle Cxx external HPWHs (SP = single pass mode)
NyleC125A_SPNyle Cxx external HPWHs (SP = single pass mode)
NyleC185A_SPNyle Cxx external HPWHs (SP = single pass mode)
NyleC250A_SPNyle Cxx external HPWHs (SP = single pass mode)
NyleC60A_CWP_SPNyle Cxx external SP HPWHs with cold weather package
NyleC90A_CWP_SPNyle Cxx external SP HPWHs with cold weather package
NyleC125A_CWP_SPNyle Cxx external SP HPWHs with cold weather package
NyleC185A_CWP_SPNyle Cxx external SP HPWHs with cold weather package
NyleC250A_CWP_SPNyle Cxx external SP HPWHs with cold weather package
NyleC60A_MPNyle Cxx external HPWHs (MP = multi-pass mode)
NyleC90A_MPNyle Cxx external HPWHs (MP = multi-pass mode)
NyleC125A_MPNyle Cxx external HPWHs (MP = multi-pass mode)
NyleC185A_MPNyle Cxx external HPWHs (MP = multi-pass mode)
NyleC250A_MPNyle Cxx external HPWHs (MP = multi-pass mode)
NyleC60A_CWP_MPNyle Cxx external MP HPWHs w/ cold weather package
NyleC90A_CWP_MPNyle Cxx external MP HPWHs w/ cold weather package
NyleC125A_CWP_MPNyle Cxx external MP HPWHs w/ cold weather package
NyleC185A_CWP_MPNyle Cxx external MP HPWHs w/ cold weather package
NyleC250A_CWP_MPNyle Cxx external MP HPWHs w/ cold weather package
Rheem_HPHD60HNU_MPRheem HPHD60 MP external MP HPWHs
Rheem_HPHD60VNU_MPRheem HPHD60 MP external MP HPWHs
Rheem_HPHD135HNU_MPRheem HPHD135 MP external MP HPWHs
Rheem_HPHD135VNU_MPRheem HPHD135 MP external MP HPWHs
Scalable_SPsingle pass scalable type for autosized standard design
Scalable_MPmultipass scalable type for autosized standard design
AquaThermAireVallara AquaThermAire HPWH
UnitsLegal RangeDefaultRequiredVariability
Codes listed abovenoneWhen whHeatSrc=ASHPXconstant

whASHPSrcZn=znName

Name of zone that serves as heat pump heat source used when whHeatSrc=ASHPX. Heat removed from the zone is added to the heated water and is included in zone heat balance (that is, heat pump operation cools the zone).

whASHPSrcZn and whASHPSrcT cannot both be specified.

UnitsLegal RangeDefaultRequiredVariability
name of a ZONEwhZoneIf no zone is specified by input or default, heat extracted by ASHP has no effect.Noconstant

whASHPSrcT=float

Heat pump source air temperature used when whHeatSrc=ASHPX. Heat removed from this source is added to the heated water but has no other effect.

whASHPSrcZn and whASHPSrcT cannot both be specified.

The logic to determine the temperature of the heat pump source air is:

        if whASHPSrcT is specified
          use whASHPSrcT
        else if whASHPSRCZn is specified
          use whASHPSrcZn air temp
        else if whZone is specified
          use whZone air temp
        else
          use 70 F

To model a heat pump that uses outdoor air as its heat source, omit whASHPSrcZn and specify whASHPSrcT = $tDbO.

UnitsLegal RangeDefaultRequiredVariability
oFx \(\ge\) 070 oF (used only when whASHPSrcZn and whZone not specified)Nohourly

whASHPResUse=float

Specifies activation temperature difference for resistance heating, used only when whHeatSrc=ASHPX and whASHPType=GENERIC. Refer to HPWH engineering documentation for model details.

UnitsLegal RangeDefaultRequiredVariability
oCx \(\ge\) 07.22Noconstant

whResHtPwr=float

Specifies resistance upper element power, used only with whHeatSrc=RESISTANCEX.

UnitsLegal RangeDefaultRequiredVariability
Wx \(\ge\) 04500Noconstant

whResHtPwr2=float

Specifies resistance lower element power, used only with whHeatSrc=RESISTANCEX.

UnitsLegal RangeDefaultRequiredVariability
Wx \(\ge\) 0whResHtPwrNoconstant

whUA=float

HPWH-type total UA (not per tank)

UnitsLegal RangeDefaultRequiredVariability
Btuh/Fx \(\geq\) 0HPWH defaultNoconstant

whInsulR=float

Tank insulation resistance for heat pump water heater.

UnitsLegal RangeDefaultRequiredVariability
hr-F/Btuhx \(>\) 0-1Noconstant

whInHtSupply=float
whInHtLoopRet=float

Fractional tank height of inlets for supply water and DHWLOOP return, used only with HPWH types (whHeatSrc=RESISTANCEX or whHeatSrc=ASHPX). 0 indicates the bottom of the water heater tank and 1 specifies the top. Inlet height influences tank layer mixing and can impact heat pump COP and/or heating activation frequency.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 1HPWH default (0?)Noconstant

whtankCount=float

Number of storage tanks per DHWHEATER, re built-up whType=Builtup, does not reflect wh_mult (wh_mult=2, wh_tankCount=3 -> 6 tanks).

UnitsLegal RangeDefaultRequiredVariability
#x \(\geq\) 11Noconstant

whEff=float

Water heating efficiency, used in modeling whType=LARGESTORAGE and whType=LARGEINSTANTANEOUS.

UnitsLegal RangeDefaultRequiredVariability
0 \(<\) whEff \(\leq\) 1.82Noconstant

whSBL=float

Standby loss, used in modeling whType=LARGESTORAGE.

UnitsLegal RangeDefaultRequiredVariability
Btuhx \(\ge\) 00Noconstant

whPilotPwr=float

Pilot light consumption, included in fuel energy use of DHWHEATERs with whHeatSrc=FUEL.

UnitsLegal RangeDefaultRequiredVariability
Btuhx \(\ge\) 00Nohourly

whParElec=float

Parasitic electricity power, included in electrical energy use of all DHWHEATERs.

UnitsLegal RangeDefaultRequiredVariability
Wx \(\ge\) 00Nohourly

whFAdjElec=float
whFAdjFuel=float

Water heater energy use modifiers. Multiplies calculated use of electricity (whFAdjElec) and fuel (whFAdjFuel). All components of energy use – primary, backup, XBU (extra backup), and other auxiliary – are modified before they are accumulated to whElecMtr and whFuelMtr.

UnitsLegal RangeDefaultRequiredVariability
\(\ge\) 01Nosubhourly

whElecMtr=mtrName

Name of METER object, if any, by which DHWHEATER electrical energy use is recorded (under end use DHW).

UnitsLegal RangeDefaultRequiredVariability
name of a METERParent DHWSYS wsElecMtrNoconstant

whxBUEndUse=choice

Specifies the whElecMtr end use, if any, to which extra backup energy is accumulated. In some water heater types, extra backup energy is modeled to maintain output temperature at wsTUse. By default, extra backup energy is included in end use dhwBU. whxBUEndUse allows specification of an alternative end use to which extra backup energy is accumulated.

UnitsLegal RangeDefaultRequiredVariability
end use code(extra backup accums to dhwBU)Noconstant

whFuelMtr =mtrName

Name of METER object, if any, by which DHWHEATER fuel energy use is recorded (under end use DHW).

UnitsLegal RangeDefaultRequiredVariability
name of a METERParent DHWSYS wsFuelMtrNoconstant

whTankTInit =comma-separated list of 12 floats

A list of 12 initial values for HPWH tank model layer temperatures, in bottom-to-top order. If given, these values are used to initialize tank layer temperatures at the beginning of the warmup period. Initialization is not repeated at the beginning of the main simulation.

whTankTInit is allowed only for HPWH-based types (whHeatSrc=ASHPX or whHeatSrc=ResistanceX).

whTankTInit is intended for use in empirical validation studies where the initial tank state needs to match measured data. whTankTInit should not be generally used. In the absence of whTankTInit, layer temperatures are initialized to the water heater setpoint inherited from the parent DHWSYS.

UnitsLegal RangeDefaultRequiredVariability
oFx \(\gt\) 0Noconstant

endDHWHEATER

Optionally indicates the end of the DHWHEATER definition.

UnitsLegal RangeDefaultRequiredVariability
x \(\geq\) 0noneNo

Related Probes:

4.32 DHWHEATREC

DHWHEATREC constructs an object representing one or more heat recovery devices in a DHWSYS. Drain water heat recovered by the device increases parent DHWSYS wsInlet temperature and/or fixture cold water feed temperature. This reduces water heating energy consumption.

wrName

Optional name of device; give after the word “DHWHEATREC” if desired.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneNoconstant

wrMult=integer

Number of identical heat recovery devices of this type. Any value >1 is equivalent to repeated entry of the same DHWHEATREC.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 01Noconstant

wrHWEndUse=choice

Hot water end use to which this DHWHEATREC is applied: one of Shower, Bath, CWashr, DWashr, or Faucet. Selects DHWUSE draws for heat recovery calculations. Currently, only Shower is supported.

UnitsLegal RangeDefaultRequiredVariability
ShowerShowerNoconstant

wrCountFXDrain=integer

Number of fixtures (of type wrHWEndUse) whose drain lines pass through this heat recovery device. wrCountFXDrain=0 causes this DHWHEATREC to have no effect (that is, equivalent to omitting the DHWHEATREC command).

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 01Noconstant

wrCountFXCold=integer

Number of fixtures (of type wrHWEndUse) with cold water supply connected to the DHWHEATREC potable-side outlet and thus use tempered water to mix with hot water.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 01Noconstant

wrFeedsWH=choice

Specifies whether the potable-side outlet of the DHWHEATREC is connected to the DHWHEATER(s) inlet.

UnitsLegal RangeDefaultRequiredVariability
Yes, NoNoNoconstant

wrType=choice

Specifies the type of heat recovery device: Vertical, Horizontal, or SetEF. Horizontal and Vertical derive effectiveness from wrCSARatedEF, flow rates, and water temperatures. As of Feb. 2019, the same correlation is used for both Horizontal and Vertical, so these choices have no effect on results. Choice SetEF uses wrCSARatedEF without modification as the effectiveness (note hourly variability).

UnitsLegal RangeDefaultRequiredVariability
Vertical, Horizontal, SetEFVerticalNoconstant

wrCSARatedEF=float

Specifies the heat recovery effectiveness, generally determined using CSA B55.2 rating conditions. This value is modified during simulation based on water flow rates and temperatures. If wrType=SetEF, wsCSARatedEF is used without modification.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 1noneYeshourly

wrTDInDiff=float

Temperature drop between the fixture drain and DHWHEATREC drain-side inlet. The drain-side inlet temperature is thus DHWUSE wuTemp - wrTDInDiff.

UnitsLegal RangeDefaultRequiredVariability
oFx \(\ge\) 04.6 oFNohourly

wrTDInWarmup=float

Drain-side inlet water temperature during warmup. During the warmup portion of a draw (if any), the drain-side inlet temperature will initially be lower than that based on DHWUSE wuTemp. wrTDInWarmup allows input of user estimates for this temperature. Note wrTDInWarmup is not adjusted by wrTDInDiff.

UnitsLegal RangeDefaultRequiredVariability
oFx \(>\) 065 oFNohourly

endDHWHEATREC

Optionally indicates the end of the DHWHEATREC definition.

UnitsLegal RangeDefaultRequiredVariability
noneNo

Related Probes:

4.33 DHWTANK

DHWTANK constructs an object representing one or more unfired water storage tanks in a DHWSYS. DHWTANK heat losses contribute to the water heating load.

wtName

Optional name of tank; give after the word “DHWTANK” if desired.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneNoconstant

wtMult=integer

Number of identical tanks of this type. Any value \(>1\) is equivalent to repeated entry of the same DHWTANK.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 01Noconstant

Tank heat loss is calculated hourly (note that default heat loss is 0) –

\[\text{qLoss} = \text{wtMult} \cdot (\text{wtUA} \cdot (\text{wtTTank} - \text{wtTEx}) + \text{wtXLoss})\]

wtUA=float

Tank heat loss coefficient.

UnitsLegal RangeDefaultRequiredVariability
Btuh/oFx \(\ge\) 0Derived from wtVol and wtInsulRNoconstant

wtVol=float

Specifies tank volume.

UnitsLegal RangeDefaultRequiredVariability
galx \(\ge\) 00Noconstant

wtInsulR=float

Specifies total tank insulation resistance. The input value should represent the total resistance from the water to the surroundings, including both built-in insulation and additional exterior wrap insulation.

UnitsLegal RangeDefaultRequiredVariability
ft2-oF/Btuhx \(\ge\) 0.010Noconstant

wtZone=znName

Zone location of DHWTANK regarding tank loss. The value of zero only valid if wtTEx is being used. Half of the heat losses go to zone air and the other goes to half radiant.

UnitsLegal RangeDefaultRequiredVariability
Name of ZONE0Noconstant

wtTEx=float

Tank surround temperature.

UnitsLegal RangeDefaultRequiredVariability
oFx \(\ge\) 070Nohourly

wtTTank=float

Tank average water temperature.

UnitsLegal RangeDefaultRequiredVariability
oF\(>\) 32 oFParent DHWSYSTEM wsTUseNohourly

wtXLoss=float

Additional tank heat loss. To duplicate CEC 2016 procedures, this value should be used to specify the fitting loss of 61.4 Btuh.

UnitsLegal RangeDefaultRequiredVariability
Btuh(any)0Nohourly

endDHWTank

Optionally indicates the end of the DHWTANK definition.

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

Related Probes:

4.34 DHWPUMP

DHWPUMP constructs an object representing a domestic hot water circulation pump (or more than one if identical).

wpName

Optional name of pump; give after the word “DHWPUMP” if desired.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneNoconstant

wpMult=integer

Number of identical pumps of this type. Any value \(>1\) is equivalent to repeated entry of the same DHWPUMP.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 01Noconstant

wpPwr=float

Pump power.

UnitsLegal RangeDefaultRequiredVariability
Wx \(>\) 00Nohourly

wpElecMtr=mtrName

Name of METER object, if any, to which DHWPUMP electrical energy use is recorded (under end use DHW).

UnitsLegal RangeDefaultRequiredVariability
name of a METERParent DHWSYS wsElecMtrNoconstant

endDHWPump

Optionally indicates the end of the DHWPUMP definition.

UnitsLegal RangeDefaultRequiredVariability
noneNo

Related Probes:

4.35 DHWLOOP

DHWLOOP constructs one or more objects representing a domestic hot water circulation loop. The actual pipe runs in the DHWLOOP are specified by any number of DHWLOOPSEGs (see below). Circulation pumps are specified by DHWLOOPPUMPs (also below).

wlName

Optional name of loop; give after the word “DHWLOOP” if desired.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneNoconstant

wlMult=integer

Number of identical loops of this type. Any value \(>1\) is equivalent to repeated entry of the same DHWLOOP (and all child objects).

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 01Noconstant

wlFlow=float

Loop flow rate (when operating).

UnitsLegal RangeDefaultRequiredVariability
gpmx \(\ge\) 06Nohourly

wlTIn1=float

Inlet temperature of first DHWLOOPSEG.

UnitsLegal RangeDefaultRequiredVariability
oFx \(>\) 0DHWSYS wsTUseNohourly

wlRunF=float

Fraction of hour that loop circulation operates.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 01Nohourly

wlFUA=float

DHWLOOPSEG pipe heat loss adjustment factor. DHWLOOPSEG UA is derived (from wgSize, wgLength, wgInsulK, wgInsulThk, and wgExH) and multiplied by wlFUA. Note: does not apply to child DHWLOOPBRANCHs (see wbFUA).

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 01Noconstant

wlLossMakeupPwr=float

Specifies electrical power available to make up losses from DHWLOOPSEGs (loss from DHWLOOPBRANCHs is not included). Separate loss makeup is typically used in multi-unit HPWH systems to avoid inefficiencies associated with high condenser temperatures. Loss-makeup energy is calculated hourly and is the smaller of loop losses and wlLossMakeupPwr. The resulting electricity use (including the effect of wlLossMakeupEff) is accumulated to the METER specified by wlElecMtr (end use dhwMFL). No other effect, such as heat gain to surroundings, is modeled.

UnitsLegal RangeDefaultRequiredVariability
Wx \(\ge\) 00Nohourly

wlLossMakeupEff=float

Specifies the efficiency of loss makeup heating if any. No effect when wlLossMakeupPwr is 0.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 01Nohourly

wlElecMtr=mtrName

Name of METER object, if any, to which DHWLOOP electrical energy use is recorded (under end use dhwMFL).

UnitsLegal RangeDefaultRequiredVariability
name of a METERParent DHWSYS wsElecMtrNoconstant

endDHWLoop

Optionally indicates the end of the DHWLOOP definition.

UnitsLegal RangeDefaultRequiredVariability
noneNo

Related Probes:

4.36 DHWLOOPPUMP

DHWLOOPPUMP constructs an object representing a pump serving part a DHWLOOP. The model is identical to DHWPUMP except that that the electricity use calculation reflects wlRunF of the parent DHWLOOP.

wlpName

Optional name of pump; give after the word “DHWLOOPPUMP” if desired.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneNoconstant

wlpMult=integer

Number of identical pumps of this type. Any value \(>1\) is equivalent to repeated entry of the same DHWPUMP.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 01Noconstant

wlpPwr=float

Pump power.

UnitsLegal RangeDefaultRequiredVariability
Wx \(>\) 00Nohourly

wlpLiqHeatF=float

Fraction of pump power that heats circulating liquid. The remainder is discarded.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 11Nohourly

wlpElecMtr=mtrName

Name of METER object, if any, to which DHWLOOPPUMP electrical energy use is recorded (under end use dhwMFL).

UnitsLegal RangeDefaultRequiredVariability
name of a METERParent DHWLOOP wlElecMtrNoconstant

endDHWLOOPPUMP

Optionally indicates the end of the DHWPUMP definition.

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

Related Probes:

4.37 DHWLOOPSEG

DHWLOOPSEG constructs one or more objects representing a segment of the preceeding DHWLOOP. A DHWLOOP can have any number of DHWLOOPSEGs to represent the segments of the loop with possibly differing sizes, insulation, or surrounding conditions.

wgName

Optional name of segment; give after the word “DHWLOOPSEG” if desired.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneNoconstant

wgTy=choice

Specifies the type of segment. RETURN segments, if any, must follow SUPPLY segments.

SUPPLYIndicates a supply segment (flow is sum of circulation and draw flow, child DHWLOOPBRANCHs permitted).
RETURNIndicates a return segment (flow is only due to circulation, child DHWLOOPBRANCHs not allowed)
UnitsLegal RangeDefaultRequiredVariability
noneYesconstant

wgLength=float

Length of segment.

UnitsLegal RangeDefaultRequiredVariability
ftx \(\ge\) 00Noconstant

wgSize=float

Nominal size of pipe. CSE assumes the pipe outside diameter = size + 0.125 in.

UnitsLegal RangeDefaultRequiredVariability
inx \(>\) 01Yesconstant

wgInsulK=float

Pipe insulation conductivity

UnitsLegal RangeDefaultRequired**Variability
Btuh-ft/ft2-oFx \(>\) 00.02167Noconstant

wgInsulThk=float

Pipe insulation thickness

UnitsLegal RangeDefaultRequiredVariability
inx \(\ge\) 01Noconstant

wgExH=float

Combined radiant/convective exterior surface conductance between insulation (or pipe if no insulation) and surround.

UnitsLegal RangeDefaultRequiredVariability
Btuh/ft2-oFx \(>\) 01.5Nohourly

wgExT=float

Surrounding equivalent temperature.

UnitsLegal RangeDefaultRequiredVariability
oFx \(>\) 070Nohourly

wgFNoDraw=float

Fraction of hour when no draw occurs.

UnitsLegal RangeDefaultRequiredVariability
oFx \(>\) 070Nohourly

endDHWLoopSeg

Optionally indicates the end of the DHWLOOPSEG definition.

UnitsLegal RangeDefaultRequiredVariability
noneNo

Related Probes:

4.38 DHWLOOPBRANCH

DHWLOOPBRANCH constructs one or more objects representing a branch pipe from the preceding DHWLOOPSEG. A DHWLOOPSEG can have any number of DHWLOOPBRANCHs to represent pipe runs with differing sizes, insulation, or surrounding conditions.

wbName

Optional name of segment; give after the word “DHWLOOPBRANCH” if desired.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneNoconstant

wbMult=float

Specifies the number of identical DHWLOOPBRANCHs. Note may be non-integer.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 01Noconstant

wbLength=float

Length of branch.

UnitsLegal RangeDefaultRequiredVariability
ftx \(\ge\) 00Noconstant

wbSize=float

Nominal size of pipe. CSE assumes the pipe outside diameter = size + 0.125 in.

UnitsLegal RangeDefaultRequiredVariability
inx \(>\) 0noneYesconstant

wbInsulK=float

Pipe insulation conductivity

UnitsLegal RangeDefaultRequired**Variability
Btuh-ft/ft2-oFx \(>\) 00.02167Noconstant

wbInsulThk=float

Pipe insulation thickness

UnitsLegal RangeDefaultRequiredVariability
inx \(\ge\) 01Noconstant

wbExH=float

Combined radiant/convective exterior surface conductance between insulation (or pipe if no insulation) and surround.

UnitsLegal RangeDefaultRequiredVariability
Btuh/ft2-oFx \(>\) 01.5Nohourly

wbExCnd=choice

Specify exterior conditions.

ChoiceDescription
ADIABATICAdiabatic on other side
AMBIENTAmbient exterior
SPECTSpecify temperature
ADJZNAdjacent zone
GROUNDGround conditions
UnitsLegal RangeDefaultRequiredVariability
See table aboveSPECTNoconstant

wbAdjZn=float

Boundary conditions for adjacent zones.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 00.0Norunly

wbExTX=float

External boundary conditions.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 070.0Norunly

wbFUA=float

Adjustment factor applied to branch UA. UA is derived (from wbSize, wbLength, wbInsulK, wbInsulThk, and wbExH) and then multiplied by wbFUA. Used to represent e.g. imperfect insulation. Note that parent DHWLOOP wlFUA does not apply to DHWLOOPBRANCH (only DHWLOOPSEG)

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 01Noconstant

wbExT=float

Surrounding equivalent temperature.

UnitsLegal RangeDefaultRequiredVariability
oFx \(>\) 070Nohourly

wbFlow=float

Branch flow rate assumed during draw.

UnitsLegal RangeDefaultRequiredVariability
gpmx \(\ge\) 02Nohourly

wbFWaste=float

Number of times during the hour when the branch volume is discarded.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 00Nohourly

endDHWLOOPBRANCH

Optionally indicates the end of the DHWLOOPBRANCH definition.

UnitsLegal RangeDefaultRequiredVariability
nonenoneNo

Related Probes:

4.39 DHWSOLARSYS

Solar water heating system.

May have any number of solar collectors, but only one tank.

May have no tank for direct system? What if system has multiple primary tanks?

swElecMtr=mtrName

Name of METER object, if any, to which DHWSOLARSYS electrical energy use is recorded (under end use ???).

UnitsLegal RangeDefaultRequiredVariability
oFname of a METERnot recordedNoconstant

swSCFluidSpHt=float

Specific heat for the collector fluid.

UnitsLegal RangeDefaultRequiredVariability
Btu/lbm-oFx \(>\) 00.9Noconstant

swSCFluidDens=float

Density for the collector fluid.

UnitsLegal RangeDefaultRequiredVariability
lb/ft3x \(>\) 064.0Noconstant

swEndUse

End use of pump energy; defaults to “DHW”.

swParElec=float

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 00Nohourly

swTankHXEff=float

Tank heat exchanger effectiveness.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 0.990Nohourly

swTankTHxLimit=float

Temperature limit for the tank collector.

UnitsLegal RangeDefaultRequiredVariability
oFx \(\geq\) 0180.0Noconstant

swTankUA=float

Heat transfer coefficient for the tank multiplied by area.

UnitsLegal RangeDefaultRequiredVariability
Btuh/oFNoconstant

swTankVol=float

UnitsLegal RangeDefaultRequiredVariability
galNoconstant

swTankInsulR=float

Total tank insulation resistance, built-in plus exterior wrap.

UnitsLegal RangeDefaultRequiredVariability
ft2-oF/BtuhNoconstant

swTankZone=znName

Pointer to tank zone location, use sw_tankTEx if NULL

UnitsLegal RangeDefaultRequiredVariability
Name of ZONENoconstant

swTankTEx=float

Surrounding temperature.

UnitsLegal RangeDefaultRequiredVariability
oFNohourly

endDHWSOLARSYS

Optionally indicates the end of the DHWSOLARSYS definition.

UnitsLegal RangeDefaultRequiredVariability
noneNo

4.40 DHWSOLARCOLLECTOR

Solar Collector Array. May be multiple collectors on the same DHWSOLARSYS system. All inlets come from the DHWSOLARTANK.

Uses SRCC Ratings.

scArea=float

Collector area.

UnitsLegal RangeDefaultRequiredVariability
ft^2\(>\) 00Yesconstant

scMult

Number of identical collectors, default 1

UnitsLegal RangeDefaultRequiredVariability
\(>\) 01Noconstant

scTilt=float

Array tilt.

UnitsLegal RangeDefaultRequiredVariability
deg0Yesconstant

scAzm=float

Array azimuth.

UnitsLegal RangeDefaultRequiredVariability
deg0Yesconstant

scFRUL=float

Fit slope

UnitsLegal RangeDefaultRequiredVariability
Btuh/ft2-o^F-0.727Noconstant

scFRTA=float

Fit y-intercept

UnitsLegal RangeDefaultRequiredVariability
none\(>\) 00.758Noconstant

scTestMassFlow=flaot

Mass flow rate for collector loop SRCC rating.

UnitsLegal RangeDefaultRequiredVariability
lb/h-ft2x \(>\) 014.79Noconstant

scKta60=float

Incident angle modifier at 60 degree, from SRCC rating.

UnitsLegal RangeDefaultRequiredVariability
x \(\geq\) 00.72Noconstant

scOprMassFlow=float

Collector loop operating mass flow rate.

UnitsLegal RangeDefaultRequiredVariability
lb/h-ft2x \(>\) 00.0Noconstant

scPipingLength=float

Collector piping length.

UnitsLegal RangeDefaultRequiredVariability
ftx \(\geq\) 00.0NoHourly and at the end of interval

scPipingInsulK=float

Collector piping insulation conductivity.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 00.02167NoHourly and at the end of interval

scPipingInsulThk=float

Collector piping insulation thickness.

UnitsLegal RangeDefaultRequiredVariability
x \(\geq\) 01.0NoHourly and at the end of interval

scPipingExH=float

Collector piping heat transfer coefficient.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 01.5NoHourly and at the end of interval

scPipingExT=float

Collector piping surround temperature.

UnitsLegal RangeDefaultRequiredVariability
oFx \(\geq\) 3270.0Nohourly

scPumpPwr=float

UnitsLegal RangeDefaultRequiredVariability
Btu/hx \(\ge\) 0from scPumpflowNoconstant

scPumpLiqHeatF=float

Fraction of scPumpPwr added to liquid stream, the remainder is discarded.

UnitsLegal RangeDefaultRequiredVariability
x \(\geq\) 01.0NoEvery run

scPumpOnDeltaT=float

Temperature difference between the tank and collector outlet where pump turns on

UnitsLegal RangeDefaultRequiredVariability
oF10.0Noconstant

scPumpOffDeltaT=float

Temperature difference between the tank and collector outlet where pump turns off

UnitsLegal RangeDefaultRequiredVariability
oF5.0Noconstant

endDHWSOLARCOLLECTOR

Optionally indicates the end of the DHWSOLARCOLLECTOR definition.

UnitsLegal RangeDefaultRequiredVariability
noneNo

4.41 PVARRAY

PVARRAY describes a photovoltaic panel system. The algorithms are based on the PVWatts calculator.

pvName

Name of photovoltaic array. Give after the word PVARRAY.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneNoconstant

pvElecMtr=choice

Name of meter by which this PVARRAY’s AC power out is recorded. Generated power is expressed as a negative value.

UnitsLegal RangeDefaultRequiredVariability
name of a METERnoneNoconstant

pvEndUse=choice

Meter end use to which the PVARRAY’s generated energy should be accumulated.

ClgCooling
HtgHeating (includes heat pump compressor)
HPBUHeat pump resistance heating (backup and defrost)
DHWDomestic (service) hot water
DHWBUDomestic (service) hot water heating backup (HPWH resistance)
DHWMFLDomestic (service) hot water heating multi-family loop pumping and loss makeup
FANCFans, AC and cooling ventilation
FANHFans, heating
FANVFans, IAQ venting
FANFans, other purposes
AUXHVAC auxiliaries such as pumps
PROCProcess
LITLighting
RCPReceptacles
EXTExterior lighting
REFRRefrigeration
DISHDishwashing
DRYClothes drying
WASHClothes washing
COOKCooking
USER1User-defined category 1
USER2User-defined category 2
BTBattery charge power
PVPhotovoltaic power generation
UnitsLegal RangeDefaultRequiredVariability
Codes listed abovePVNoconstant

pvDCSysSize=float

The rated photovoltaic system DC capacity/size as indicated by the nameplate.

UnitsLegal RangeDefaultRequiredVariability
kWx \(\geq\) 0noneYesconstant

pvModuleType=choice

Type of module to model. The module type determines the refraction index and temperature coefficient used in the simulation. Alternatively, the “Custom” module type may be used in conjunction with user-defined input for pvCoverRefrInd and pvTempCoeff.

Module TypepvCoverRefrIndpvTempCoeff
Standard1.3-0.00206
Premium1.3-0.00194
ThinFilm1.3-0.00178
CustomUser-definedUser-defined
UnitsLegal RangeDefaultRequiredVariability
Standard Premium ThinFilm CustomStandardNoconstant

pvCoverRefrInd=float

The refraction index for the coating applied to the module cover. A value of 1.0 represents refraction through air. Coatings have higher refraction indexes that capture more solar at lower angles of incidence.

UnitsLegal RangeDefaultRequiredVariability
x \(\geq\) 01.3Noconstant

pvTempCoeff=float

The temperature coefficient how the efficiency of the module varies with the cell temperature. Values are typically negative.

UnitsLegal RangeDefaultRequiredVariability
1/oFno restrictions-0.00206Noconstant

pvArrayType=choice

The type of array describes mounting and tracking options. Roof mounted arrays have a higher installed nominal operating cell temperature (INOCT) of 120 oF compared to the default of 113 oF. Array self-shading is not currently calculated for adjacent rows of modules within an array.

UnitsLegal RangeDefaultRequired**Variability
FixedOpenRack, FixedRoofMount, OneAxisTracking, TwoAxisTrackingFixedOpenRackNoconstant

pvTilt=float

The tilt of the photovoltaic array from horizontal. Values outside the range 0 to 360 are first normalized to that range. For one-axis tracking, defines the tilt of the rotation axis. Not used for two-axis tracking arrays. Should be omitted if pvVertices is given.

UnitsLegal RangeDefaultRequiredVariability
degreesunrestrictedfrom pvVertices (if given) else 0Nohourly

The following figures illustrate the use of both pvTilt and pvAzm for various configurations:

Fixed, south facing, tilted at 40o
Fixed, south facing, tilted at 40o
One-axis tracker, south facing, tilted at 20o
One-axis tracker, south facing, tilted at 20o
One-axis tracker, horizontal aligned North/South (more common)
One-axis tracker, horizontal aligned North/South (more common)
One-axis tracker, horizontal aligned East/West (less common)
One-axis tracker, horizontal aligned East/West (less common)

pvAzm=float

Photovoltaic array azimuth (0 = north, 90 = east, etc.). If a value outside the range 0o \(\leq\) x \(<\) 360o is given, it is normalized to that range. For one-axis tracking, defines the azimuth of the rotation axis. Not used for two-axis tracking arrays. Should be omitted if pvVertices is given.

UnitsLegal RangeDefaultRequiredVariability
degreesunrestrictedfrom pvVertices (if given) else 0Nohourly

pvVertices=list of up to 36 floats

Vertices of an optional polygon representing the position and shape of the photovoltaic array. The polygon is used to calculate the shaded fraction using an advanced shading model. Only PVARRAYs and SHADEXs are considered in the advanced shading model – PVARRAYs can be shaded by SHADEXs or other PVARRAYs. If pvVertices is omitted, the PVARRAY is assumed to be unshaded at all times. Advanced shading must be enabled via TOP exShadeModel. Note that the polygon is used only for evaluating shading; array capacity is specified by pvDCSysSize (above).

The values that follow pvVertices are a series of X, Y, and Z values for the vertices of the polygon using a coordinate system defined from a viewpoint facing north. X and Y values convey east-west and north-south location respectively relative to an arbitrary origin (positive X value are to the east; positive Y values are to the north). Z values convey height relative to the building 0 level and positive values are upward.

The vertices are specified in counter-clockwise order when facing the receiving surface of the PVARRAY. The number of values provided must be a multiple of 3. The defined polygon must be planar and have no crossing edges. When pvMounting=Building, the effective position of the polygon is modified in response to building rotation specified by TOP bldgAzm.

For example, to specify a rectangular photovoltaic array that is 10 x 20 ft, tilted 45 degrees, and facing south –

 pvVertices = 0, 0, 15,   20, 0, 15,  20, 7.07, 22.07,  0, 7.07, 22.07
UnitsLegal RangeDefaultRequiredVariability
ftunrestrictedno polygon9, 12, 15, 18, 21, 24, 27, 30, 33, or 36 valuesconstant

pvSIF=float

Shading Impact Factor (SIF) of the array used to represent the disproportionate impact on array output of partially shaded modules at the sub-array level. This impact is applied to the effective beam irradiance on the array:

\[I_{poa,beam,eff} = \max\left(I_{poa,beam}\cdot\left(1-SIF\cdot f_{sh}\right),0\right)\]

where \(f_{sh}\) is the fraction of the array that is shaded.

Default value is 1.2, which is representative of PV systems with sub-array microinverters or DC power optimizers. For systems without sub-array power electronics, values are closer to 2.0.

UnitsLegal RangeDefaultRequiredVariability
x \(\geq\) 1.01.2Noconstant

pvMounting=choice

Specified mounting location of this PVARRAY. pvMounting=Site indicates the array position is not altered by building rotation via TOP bldgAzm, while PVARRAYs with pvMounting=Building are assumed to rotate with the building.

UnitsLegal RangeDefaultRequiredVariability
Building or SiteBuildingNoconstant

pvGrndRefl=float

Ground reflectance used for calculating reflected solar incidence on the array.

UnitsLegal RangeDefaultRequiredVariability
0 \(<\) x \(<\) 1.00.2Nohourly

pvDCtoACRatio=float

DC-to-AC ratio used to intentionally undersize the AC inverter. This is used to increase energy production in the beginning and end of the day despite the possibility of clipping peak sun hours.

UnitsLegal RangeDefaultRequiredVariability
x > 0.01.2Noconstant

pvInverterEff=float

AC inverter efficiency at rated DC power.

UnitsLegal RangeDefaultRequiredVariability
0 \(<\) x \(<\) 1.00.96Noconstant

pvSysLosses=float

Fraction of total DC energy lost. The total loss from a system is aggregated from several possible causes as illustrated below:

Loss TypeDefault Assumption
Soiling0.02
Shading0 (handled explicitly)
Snow0
Mismatch0 (shading mismatch handled explicitly [see pvSIF])
Wiring0.02
Connections0.005
Light-induced degradation0.015
Nameplate rating0.01
Age0.05 (estimated 0.5% degradation over 20 years)
Availability0.03
Total0.14

Italic lines indicate differences from PVWatts assumptions.

UnitsLegal RangeDefaultRequiredVariability
0 \(<\) x \(<\) 1.00.14Nohourly

endPVARRAY

Optionally indicates the end of the PVARRAY definition. Alternatively, the end of the definition can be indicated by END or by beginning another object.

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

Related Probes:

4.42 SHADEX

SHADEX describes an object that shades other building surfaces using an advanced shading model. Advanced shading calculations are provided only for PVARRAYs. Advanced shading must be enabled via Top exShadeModel.

sxName

Name of photovoltaic array. Give after the word SHADEX.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneNoconstant

sxMounting=choice

Specifies the mounting location of the shade. sxMounting=Site indicates the SHADEX position is fixed and is not modified if the building is rotated. The position of SHADEXs with sxMounting=Building are modified to include the effect of building rotation specified via Top bldgAz

UnitsLegal RangeDefaultRequiredVariability
Building or SiteSiteNoconstant

sxVertices=list of up to 36 floats

Vertices of a polygon representing the shape of the shading object.

The values that follow sxVertices are a series of X, Y, and Z values for the vertices of the polygon. The coordinate system is defined from a viewpoint facing north. X and Y values convey east-west and north-south location respectively relative to an arbitrary origin (positive X value are to the east; positive Y values are to the north). Z values convey height relative to the building 0 level and positive values are upward.

The vertices are specified in counter-clockwise order when facing the shading object from the south. The number of values provided must be a multiple of 3. The defined polygon must be planar and have no crossing edges. When sxType=Building, the effective position of the polygon reflects building rotation specified by TOP bldgAzm.

For example, to specify a rectangular shade “tree” that is 10 x 40 ft, facing south, and 100 ft to the south of the nominal building origin –

sxVertices = 5, -100, 0,   15, -100, 0,  15, -100, 40,  5, -100, 40
UnitsLegal RangeDefaultRequiredVariability
ftunrestrictednone9, 12, 15, 18, 21, 24, 27, 30, 33 or 36 valuesconstant

endSHADEX

Optionally indicates the end of the SHADEX definition. Alternatively, the end of the definition can be indicated by END or by beginning another object.

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

Related Probes:

4.43 BATTERY

BATTERY describes input data for a model of an energy-storage system which is not tied to any specific energy storage technology. The battery model integrates the energy added and removed (accounting for efficiency losses). Note: although we use the term battery, the underlying model is flexible enough to model any energy storage system.

The modeler can set limits and constraints on capacities and flows and the associated efficiencies for this model.

btName

Name of the battery system. Given after the word BATTERY.

UnitsLegal RangeDefaultRequiredVariability
63 characters*noneNoconstant

btMeter=choice

Name of a meter by which the BATTERY’s power input/output (i.e., charge/discharge) is recorded. Charges to the BATTERY system would be seen as a positive powerflow while discharges from the BATTERY system would be seen as a negative value.

Note btMeter determines the source for the probe value loadSeen. See discussion and example under btChgReq (below).

UnitsLegal RangeDefaultRequiredVariability
meter namenoneNoconstant

btEndUse=choice

Meter end use to which the BATTERY’s charged/discharged energy should be accumulated. Note that the battery end use is seen from the standpoint of a “load” on the electric grid. That is, when the battery is being charged, the end use will show up as positive. When the battery is being discharged (i.e., when it is offsetting other loads), it is seen as negative.

ClgCooling
HtgHeating (includes heat pump compressor)
HPBUHeat pump resistance heating (backup and defrost)
DHWDomestic (service) hot water
DHWBUDomestic (service) hot water heating backup (HPWH resistance)
DHWMFLDomestic (service) hot water heating multi-family loop pumping and loss makeup
FANCFans, AC and cooling ventilation
FANHFans, heating
FANVFans, IAQ venting
FANFans, other purposes
AUXHVAC auxiliaries such as pumps
PROCProcess
LITLighting
RCPReceptacles
EXTExterior lighting
REFRRefrigeration
DISHDishwashing
DRYClothes drying
WASHClothes washing
COOKCooking
USER1User-defined category 1
USER2User-defined category 2
BTBattery charge power
PVPhotovoltaic power generation
UnitsLegal RangeDefaultRequiredVariability
Codes listed aboveBTNoconstant

btChgEff=float

The charging efficiency of storing electricity into the BATTERY system. A value of 1.0 means that no energy is lost and 100% of charge energy enters and is stored in the battery.

UnitsLegal RangeDefaultRequiredVariability
0 < x \(\le\) 10.975Nohourly

btDschgEff=float

The discharge efficiency for when the BATTERY system is discharging power. A value of 1.0 means that no energy is lost and 100% of discharge energy leaves the system.

UnitsLegal RangeDefaultRequiredVariability
0 < x \(\le\) 10.975Nohourly

btMaxCap=float

This is the maximum amount of energy that can be stored in the BATTERY system in kilowatt-hours. Once the BATTERY has reached its maximum capacity, no additional energy will be stored.

UnitsLegal RangeDefaultRequiredVariability
kWhx \(\ge\) 016Noconstant

btInitSOE=float

The initial state of energy of the BATTERY system as a fraction of the total capacity. If btInitSOE is specified, the battery state-of-energy at the beginning of the actual simulation will be set to the amount specified, regardless of whether there was a warm-up period or not. If btInitSOE is NOT specififed, it will default to 1.0 (i.e., 100%) at the beginning of the warmup period (if any).

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 01.0Noconstant

btInitCycles=int

The number of cycles on the battery at the beginning of the run.

UnitsLegal RangeDefaultRequiredVariability
number of cyclesx \(\ge\) 00Norunly

btMaxChgPwr=float

The maximum rate at which the BATTERY can be charged in kilowatts (i.e., energy flowing into the BATTERY).

UnitsLegal RangeDefaultRequiredVariability
kWx \(\ge\) 04Nohourly

btMaxDschgPwr=float

The maximum rate at which the BATTERY can be discharged in kilowatts (i.e., energy flowing out of the BATTERY).

UnitsLegal RangeDefaultRequiredVariability
kWx \(\ge\) 04Nohourly

btControlAlg=choice

Selects charge/discharge control algorithm. btChgReq (next) specifies the desired battery charge or discharge rate. btControlAlg allows selection of alternative algorithms for deriving btChgReq.

DEFAULTbtChgReq is used as input or defaulted (see below)
TDVPEAKSAVEbtChgReq input (if any) is ignored. Instead, a California-specific algorithm is used that saves battery charge until peak TDV (Time Dependant Valuation) hours of the day, shifting energy generated on site (e.g. PV) to supply feed the grid during critical periods. The algorithm requires availability of hourly TDV data, see Top.tdvFName.

Note btControlAlg has hourly variability, allowing dynamic algorithm selection. In California compliance applications, TDVPEAKSAVE is typically used only on days with high TDV peaks.

UnitsLegal RangeDefaultRequiredVariability
DEFAULT or TDVPEAKSAVEDEFAULTNohourly

btChgReq=float

The power request to charge (or discharge if negative) the battery. If omitted, the default strategy is used (attempt to satisfy all loads and absorb all available excess power). btChgReq and the default strategy requested power are literally requests: that is, more power will not be delivered than is available; more power will not be absorbed than capacity exits to store; and the battery’s power limits will be respected.

btChgReq can be set by an expression to allow complex energy management/dispatch strategies. These approaches typically involve the BATTERY probe value loadSeen, which is the net electricity use (not including the battery) on the meter specified by btMeter (above). When loadSeen is positive, electricity input (e.g. from the grid) is required; when negative, excess electrical energy is available from photovoltaic generation. loadSeen can be used in btChgReq expressions such as –

btChgReq = select(
    $hour>=9 && $hour<=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

The sign conventions here are tricky. min(@BATTERY [ 1].loadSeen, 0) produces a value <=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( @BATTERY [ 1].loadSeen, 0) results in a value >= 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 @BATTERY [1] 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 “[ ]”.)

UnitsLegal RangeDefaultRequiredVariability
kWbtMeter net loadNohourly

btUseUsrChg=choice

Former yes/no choice that currently has no effect. Deprecated, will be removed in a future version.

endBATTERY

Optionally indicates the end of the BATTERY definition. Alternatively, the end of the definition can be indicated by END or by beginning another object.

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

Related Probes:

4.44 AIRHANDLER

AIRHANDLER defines a central air handling system, containing a fan or fans, optional heating and cooling coils, and optional outside air intake and exhaust. AIRHANDLERs are subobjects of TOP, and deliver air to one or more ZONEs through TERMINAL(s). AIRHANDLER objects can be used to model fan ventilation and forced air heating and cooling. Dual duct systems are modeled with two AIRHANDLERs (one for hot air and one for cool air) and two TERMINALs in each zone. Figure 2 shows…. [need a sentence that explains the figure.]

Insert Figure Title
Insert Figure Title

AIRHANDLER is designed primarily to model a central system that supplies hot or cold air at a centrally determined temperature (the “Supply Temperature Setpoint”) to Variable Air Volume (VAV) terminals in the zones. Some additional variations are also supported:

  1. The AIRHANDLER can model a constant volume, fan-always-on system, where the supply temperature varies to meet the load of a single zone (that is, the thermostat controls the heating and/or cooling coil, but not the fan). This is done by setting the terminal minimum flow, tuVfMn, equal to the maximum flow, tuVfMxH for heating and/or tuVfMxC for cooling, and using a supply temperature control method that adjusts the temperature to the load (ahTsSp = WZ, CZ, or ZN2, described below).

  2. The AIRHANDLER can model constant volume, fan cycling systems where the fan cycles with a single zone thermostat, running at full flow enough of the time to meet the load and shutting completely off the rest of the time, rather than running at variable flow to adjust to the demand from the zones.

    This variation is invoked by specifying ahFanCycles= YES (usually with ahTsSp=ZN, described below). The user should be aware that this is done by treating fractional flow as equivalent to fractional on-time in most of the program, adjusting for the higher flow and less than 100% duty cycle only in a few parts of the model known to be non-linear, such as computation of cooling coil performance, fan heat, and duct leakage. For example, the outside air inputs, designed for VAV modeling, won’t work in the expected manner unless you keep this modeling method in mind.

  3. The AIRHANDLER can supply hot air, cold air, or shut off according to the requirements of a single zone. This variation is invoked by giving ahTsSp = ZN or ZN2, both described further below.

ahName

Name of air handler: give after the word AIRHANDLER. Required for reference in TERMINALs.

UnitsLegal RangeDefaultRequiredVariability
63 charactersYesconstant

ahSched=choice

Air handler schedule; OFF or ON, hourly schedulable by using CSE expression.

OFFsupply fan off; air handler not operating. Old date? Note: (future) Taylor setback/setup control in effect, when implemented.
ONsupply fan runs, at varying volume according to TERMINAL demand (except if ahFanCycles = YES, fan cycles on and off at full volume).

The following might be used to run an air handler between 8 AM and 5 PM:

    ahSched = select(  (\$hour > 8 && \$hour <= 5),  ON,
                                          default, OFF );
UnitsLegal RangeDefaultRequiredVariability
ON/OFFONNohourly

ahFxVfFan=float

Fan flow rate multiplier for autosized fan(s). The default value (1.1) specifies 10% oversizing.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 01.1Noconstant

4.44.1 AIRHANDLER Supply Air Temperature Controller

ahTsSp=float or choice

Supply temperature setpoint numeric value OR* choice of control method (WZ, CZ, RA, ZN, or ZN2):

floatA numeric value specifies the supply temperature setpoint. An expression can be used to make dependent on time, weather, etc.
WZWarmest Zone: for cooling, sets the supply temperature setpoint each sub??hour so that the control zone (seeahWzCzns) requiring the coolest supply temperature can meet its load with its VAV damper 90% of the way from its minimum opening to its maximum, that is, at a flow of: tuVfMn + .9(tuVfMxC - * tuVfMn*).
CZCoolest Zone: analogous to WZ, but for heating
RASupply temperature setpoint value is controlled by return air temperature (this cannot be done with a CSE expression without lagging a subhour). See ahTsRaMn and ahTsRaMx.
ZNCauses air handler to switch between heating, OFF, and cooling as required by the load of a single zone. When the zone thermostat (modeled through the tuTC and tuTH inputs) calls for neither heating nor cooling, the air handler shuts down, including stopping its fan(s). Changes ahFanCycles default to YES, to simulate a constant volume, fan cycling system.
Supply temperature setpoint value when ahFanCycles = YES is taken from ahTsMn for cooling, from ahTsMx for heating (actual temperatures expected to be limited by coil capacity since fan is running at full flow). When ahFanCycles = NO, the setpoint is determined to allow meeting the load, as for WZ and CZ.
When the zone is calling for neither heat nor cold, the air handler shuts down, including stopping its fan(s), regardless of the ahFanCycles value.
ZN2Causes air handler to switch between heating, cooling, and FAN ONLY operation as required by the load of a single zone. To model a constant volume system where the fan runs continuously, use ZN2 and set the terminal minimum flow (tuVfMn) equal to the maximum (tuVfMxC and/or tuVfMxH).
When ahTsSp is ZN2, the supply temperature setpoint is determined to allow meeting the load, as for WZ and CZ, described above.

Only when ahTsSp is ZN or ZN2 does AIRHANDLER switches between heating and cooling supply temperatures according to demand. In other cases, there is but a single setpoint value or control method (RA, CZ, or WZ); if you want the control method or numeric value to change according to time of day or year, outside temperature, etc., your CSE input must contain an appropriate conditional expression for ahTsSp.

Unless ahTsSp is ZN or ZN2, the AIRHANDLER does not know whether it is heating or cooling, and will use either the heating coil or cooling coil, if available, as necessary, to keep the supply air at the single setpoint temperature. The coil schedule members, described below, allow you to disable present coils when you don’t want them to operate, as to prevent cooling supply air that is already warm enough when heating the zones. For example, in an AIRHANDLER with both heating and cooling coils, if you are using a conditional expression based on outdoor temperature to change ahTsSp between heating and cooling values, you may use expressions with similar conditions for ahhcSched and ahccSched to disable the cooling coil when heating and vice versa. (Expressions would also be used in the TERMINALS to activate their heating or cooling setpoints according to the same conditions.)

Giving ahTsSp is disallowed for an air handler with no economizer, no heat coil and no cooling coil. Such an AIRHANDLER object is valid as a ventilator; its supply temperature is not controlled. but rather determined by the outside temperature and/or the return air temperature.

UnitsLegal RangeDefaultRequiredVariability
oFnumber, RA*, WZ, CZ, ZN, ZN2,0Yes, if coil(s) or economizer presenthourly

* ahTsRaMn, ahTsRaMx, ahTsMn, and ahTsMx are required input for this choice.

** only a single ZONE may be used with these choices.

Using AIRHANDLER to Model Various Systems
To ModelUseComments
VAV heating OR cooling systemahTsSp = numeric expression, WZ, CZ, or RACSE models this most directly
VAV system that both heats and cools (single duct)Use a conditional expression to change ahTsSp between heating and cooling values on the basis of outdoor temperature, date, or some other condition.Also use expressions to disable the unwanted coil and change each zone’s setpoints according to same as ahTsSp. For example, when heating, use ahccSched = OFF and tuTC = 999; and when cooling, use ahhcSched = OFF and tuTH = -99.
Dual duct heating cooling systemUse two AIRHANDLERs
Single zone VAV system that heats or cools per zone thermostatahTsSp = ZN2Supply fan runs, at flow tuVfMn, even when neither heating nor cooling. Supply temp setpoint determined as for CZ or WZ.
Single zone constant volume system that heats or cools per zone thermostat, e.g. PSZ.ahTsSp = ZN2; tuVfMn = tuVfMxH = tuVfMxCSupply fan circulates air even if neither heating nor cooling. Supply temp setpoint determined as for CZ or WZ. All tuVf’s same forces constant volume.
Single zone constant volume, fan cycling system that heats or cools per zone thermostat, e.g. PTAC, RESYS, or furnace.ahTsSp= ZN; ahTsMx = heat supply temp setpoint; ahTsMn = cool supply temp setpoint; tuVfMn= 0; tuVfMxH = tuVfMxC normally; sfanVfDs >= max( tuVfMxH, tuVfMxC) to minimize confusion about flow modeled.AhFanCycles defaults to YES. Supply fan off when not heating or cooling. Flow when fan on is tuVfMxH or tuVfMxC as applicable (or sfanVfDs sfanVfMxF* if smaller).

ahFanCycles=choice

Determines whether the fan cycles with the zone thermostat.

YESSupply fan runs only for fraction of the subhour that the zone requests heating or cooling. When running, supply fan runs at full flow (i.e. constant volume), as determined by the more limiting of the air handler and terminal specifications. Use with a single zone only. Not allowed with ahTsSp = ZN2.
NONormal CSE behavior for simulating VAV systems with continuously running (or scheduled), variable flow supply fans. (For constant volume, fan always on modeling, use NO, and make tuVfMn equal to tuVfMxH/C.)
UnitsLegal RangeDefaultRequiredVariability
YES, NOYES when ahTsSp=ZN, NO otherwiseNohourly

ahTsMn=float

Minimum supply temperature. Also used as cooling supply temperature setpoint value under ahTsSp = ZN.

UnitsLegal RangeDefaultRequiredVariability
oFno limit; typically: 40 \(\le\) x \(\le\) 140o0oFOnly for ahTsSp=RAhourly
UnitsLegal RangeDefaultRequiredVariability
oFno limit; typically: 40 \(\le\) x \(\le\) 140o999o FOnly for asTsSp=RA; recommend giving for ahTsSp=ZNhourly

ahTsMx=float

Maximum supply temperature. Also used as heating supply temperature setpoint value under ahTsSp = ZN.

ahWzCzns=zone names or ALL or ALL_BUT zone names

ahCzCzns=zone names or ALL or ALL_BUT zone names

Specify zones monitored to determine supply temperature setpoint value (control zones), under ahTsSp=WZ and CZ respectively.

zone namesA list of zone names, with commas between them. Up to 15 names may be given.
ALL_BUTMay be followed by a a comma and list of up to 14 zone names; all zones on air handler other than these are the control zones.
ALLIndicates that all zones with terminals connected to the air handler are control zones.

A comma must be entered between zone names and after the word ALL_BUT.

UnitsLegal RangeDefaultRequiredVariability
name(s) of ZONEs ALL ALL_BUT zone Name(s)ALLNohourly

ahTsDsC=float

Cooling design supply temperature, for sizing coil vs fan.

UnitsLegal RangeDefaultRequiredVariability
oFx \(>\) 0ahTsMnNohourly

ahTsDsH=float

Heating design supply temperature, for sizing coil vs fan.

UnitsLegal RangeDefaultRequiredVariability
oFx \(>\) 0ahTsMxNohourly

ahCtu=terminal name

Terminal monitored to determine whether to heat or cool under ZN and ZN2 supply temperature setpoint control. Development aid feature; believe there is no need to give this since ahTsSp = ZN or ZN2 should only be used with one zone.

UnitsLegal RangeDefaultRequiredVariability
name of a TERMINALAIRHANDLER’s TERMINAL, if only oneIf ahTsSp = ZN with more than 1 TERMINALhourly

AhTsRaMn and ahTsRaMx are used when ahTsSp is RA.

ahTsRaMn=float

Return air temperature at which the supply temperature setpoint is at the maximum supply temperature, ahTsMx.

ahTsRaMx=float

Return air temperature at which the supply temperature setpoint is at the minimum supply temperature, ahTsMn.

When the return air temperature is between ahTsRaMnand ahTsRaMx, the supply temperature setpoint has a proportional value between ahTsMx and ahTsMn.

If return air moves outside the range ahTsRaMn to ahTsRaMx, the supply temperature setpoint does not change further.

UnitsLegal RangeDefaultRequiredVariability
oFno limit; typically: 40 \(\le\) x \(\le\) 140ononeOnly for ahTsSp=RAhourly

4.44.2 AIRHANDLER Supply fan

All AIRHANDLERs have supply fans.

sfanType=choice

Supply fan type/position. A BLOWTHRU fan is located in the air path before the coils; a DRAWTHRU fan is after the coils.

UnitsLegal RangeDefaultRequiredVariability
DRAWTHRU, BLOWTHRUDRAWTHRUNoconstant

sfanVfDs=float

Design or rated (volumetric) air flow at rated pressure. Many fans will actually blow a larger volume of air at reduced pressure: see sfanVfMxF (next).

UnitsLegal RangeDefaultRequiredVariability
cfmAUTOSIZE or x \(\ge\) 0noneYesconstant

sfanVfMxF=float

Overrun factor: maximum factor by which fan will exceed rated flow (at reduced pressure, not explicitly modeled). CSE delivers flows demanded by terminals until total flow at supply fan reaches sfanVfDs * sfanVsMxF, then reduces maximum flows to terminals, keeping them in proportion to terminal design flows, to keep total flow at that value.

We recommend giving 1.0 to eliminate overrun in constant volume modeling.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 1.01.3Noconstant

sfanPress=float

Design or rated pressure. The work done by the fan is computed as the product of this pressure and the current flow, except that the flow is limited to sfanVfDs. That is, in overrun (see sfanVfMxF) it is assumed that large VAV terminal damper openings allow the pressure to drop in proportion to the flow over rated. This work is added to the air as heat at the fan, and is termed “fan heat”. Setting sfanPress to zero will eliminate simulated fan heat for theoretical simulation of a coil only.

UnitsLegal RangeDefaultRequiredVariability
inches H2Ox \(\gt\) 03Noconstant

Prior text: At most, one of the next two items may be given: in combination with sfanVfDs and sfanPress, either is sufficient to compute the other. SfanCurvePy is then used to compute the mechanical power at the fan shaft at partial loads; sfanMotEff allows determining the electrical input from the shaft power.

New possible text (after addition of sfanElecPwr): Only one of sfanElecPwr, sfanEff, and sfanShaftBhp may be given: together with sfanVfDs and xfanPress, any one is sufficient for CSE to determine the others and to compute the fan heat contribution to the air stream.

sfanElecPwr=float

Fan input power per unit air flow (at design flow and pressure).

UnitsLegal RangeDefaultRequiredVariability
W/cfmx \(\gt\) 0derived from sfanEff and sfanShaftBhpIf sfanEff and sfanShaftBhp not presentconstant

sfanEff=float

Fan efficiency at design flow and pressure, as a fraction.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 1derived from sfanShaftBhp if given, else 0.65Noconstant

sfanShaftBhp=float

Fan shaft brake horsepower at design flow and pressure.

UnitsLegal RangeDefaultRequiredVariability
bhpx \(\gt\) 0derived from sfanEff.Noconstant

sfanCurvePy=\(k_0\), \(k_1\), \(k_2\), \(k_3\), \(x_0\)

\(k_0\) through \(k_3\) are the coefficients of a cubic polynomial for the curve relating fan relative energy consumption to relative air flow above the minimum flow \(x_0\). Up to five floats may be given, separated by commas. 0 is used for any omitted trailing values. The values are used as follows:

\[z = k_0 + k_1 \cdot (x - x_0)| + k_2 \cdot (x - x_0)|^2 + k_3 \cdot (x - x_0)|^3\]

where:

If \(z\) is not 1.0 for \(x\) = 1.0, a warning message is displayed and the coefficients are normalized by dividing by the polynomial’s value for \(x\) = 1.0.

UnitsLegal RangeDefaultRequiredVariability
0, 1, 0, 0, 0 (linear)Noconstant

sfanMotEff=float

Motor/drive efficiency.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 10.9Noconstant

sfanMotPos=choice

Motor/drive position: determines disposition of fan motor heat (input energy in excess of work done by fan; the work done by the fan is the “fan heat”, always added to air flow).

IN_FLOWadd fan motor heat to supply air at the fan position.
IN_RETURNadd fan motor heat to the return air flow.
EXTERNALdiscard fan motor heat

sfanMtr=mtrName

Name of meter, if any, to record energy used by supply fan. End use category used is “Fan”.

UnitsLegal RangeDefaultRequiredVariability
name of a METERnot recordedNoconstant

4.44.3 AIRHANDLER Return/Relief fan

A return/relief fan is optional. Its presence is established by setting rfanType to a value other than NONE. For additional information on the return/relief fan members, refer to the description of the corresponding supply fan member above.

rfanType=choice

relief fan type/position.

RETURNfan is at air handler; all return air passes through it.
RELIEFfan is in exhaust path. Air being exhausted to the outdoors passes through fan; return air being recirculated does not pass through it.
NONEno return/relief fan in this AIRHANDLER.
UnitsLegal RangeDefaultRequiredVariability
NONE, RETURN, RELIEFNONEYes, if fan presentconstant

rfanVfDs=float

design or rated (volumetric) air flow.

UnitsLegal RangeDefaultRequiredVariability
cfmAUTOSIZE or x \(\gt\) 0sfanVfDs - oaVfDsMnNoconstant

rfanVfMxF=float

factor by which fan will exceed design flow (at reduced pressure).

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 1.01.3Noconstant

rfanPress=float

design or rated pressure.

UnitsLegal RangeDefaultRequiredVariability
inches H2Ox \(\gt\) 00.75Noconstant

At most, one of the next three?? items may be defined: ?? rework re rfanElecPwr

rfanElecPwr=float

Fan input power per unit air flow (at design flow and pressure).

UnitsLegal RangeDefaultRequiredVariability
W/cfmx \(>\) 0derived from rfanEff and rfanShaftBhpIf rfanEff and rfanShaftBhp not presentconstant

rfanEff=float

Fan efficiency at design flow and pressure.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 1derived from rfanShaftBhp if given, else 0.65Noconstant

rfanShaftBhp=float

Fan shaft brake horsepower at design flow and pressure.

UnitsLegal RangeDefaultRequiredVariability
bhpx \(\gt\) 0derived from rfanEffNoconstant

rfanCurvePy=\(k_0\), \(k_1\), \(k_2\), \(k_3\), \(x_0\)

\(k_0\) through \(k_3\) are the coefficients of a cubic polynomial for the curve relating fan relative energy consumption to relative air flow above the minimum flow \(x_0\). Up to five floats may be given, separated by commas. 0 is used for any omitted trailing values. The values are used as follows:

\[z = k_0 + k_1 \cdot (x - x_0)| + k_2 \cdot (x - x_0)|^2 + k_3 \cdot (x - x_0)|^3\]

where:

If \(z\) is not 1.0 for \(x\) = 1.0, a warning message is displayed and the coefficients are normalized by dividing by the polynomial’s value for \(x\) = 1.0.

UnitsLegal RangeDefaultRequiredVariability
0, 1, 0, 0, 0 (linear)Noconstant

rfanMotEff=float

Motor/drive efficiency.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 10.9Noconstant

rfanMotPos=choice

Motor/drive position.

UnitsLegal RangeDefaultRequiredVariability
IN_FLOW, EXTERNALIN_FLOWNoconstant

rfanMtr=mtrName

Name of meter, if any, to record power consumption of this return fan. May be same or different from meter used for other fans and coils in this and other air handlers. “Fan” end use category is used.

UnitsLegal RangeDefaultRequiredVariability
name of a METERnot recordedNoconstant

4.44.4 AIRHANDLER Heating coil/Modeling Furnaces

Heating coils are optional devices that warm the air flowing through the AIRHANDLER, including electric resistance heaters, hot water coils supplied by a HEATPLANT, the heating function of an air source heat pump, and furnaces.

Furnaces are modeled as AIRHANDLERs with heat “coils” that model the heating portion of a gas or oil forced hot air furnace. Notes on modeling a furnace with a CSE AIRHANDLER:

The heating function of an air source heat pump is modeled with an AIRHANDLER with heat coil type AHP. There are several additional heat coil input variables (names beginning with ahp-) described later in the heat coil section. Also, a heat pump generally has a crankcase heater, which is specified with the crankcase heater inputs (cch-), described later in the AIRHANDLER Section 0. If the heat pump also performs cooling, its cooling function is modeled by specifying a suitable cooling coil in the same AIRHANDLER. Use ahccType = DX until a special cooling coil type for heat pumps is implemented. It is the user’s responsibility to specify consistent heating and cooling coil inputs when the intent is to model a heat pump that both heats and cools, as CSE treats the heat coil and the cool coil as separate devices.

The next four members apply to all heat coil types, except as noted.

To specify that an AIRHANDLER has a heating coil and thus heating capability, give an ahhcType other than NONE.

ahhcType=choice

Coil type choice:

ELECTRICelectric resistance heat: 100% efficient, can deliver its full rated capacity at any temperature and flow.
HWhot water coil, supplied by a HEATPLANT object.
GAS or OIL‘coil’ type that models heating portion of a forced hot air furnace. Furnace ‘coil’ model uses inputs for full-load efficiency and part-load power input; model must be completed with appropriate auxiliaries, ahTsSp, etc. See notes above.
GAS and OIL are the same here – the differences between gas- and oil-fired furnaces is in the auxiliaries (pilot vs. draft fan, etc.), which you specify separately.
AHPheating function of an air source heat pump.
NONEAIRHANDLER has no heat coil, thus no heating capability.
UnitsLegal RangeDefaultRequiredVariability
ELECTRIC, HW, GAS OIL, AHP, NONENONEYes, if coil is presentconstant

ahhcSched=choice

Heat coil schedule; choice of AVAIL or OFF, hourly variable. Use an appropriate ahhcSched expression if heat coil is to operate only at certain times of the day or year or only under certain weather conditions, etc.

AVAILheat coil available: will operate as necessary to heat supply air to supply temperature setpoint, up to the coil’s capacity.
OFFcoil will not operate, no matter how cold supply air is. A HW coil should be scheduled off whenever its HEATPLANT is scheduled off (hpSched) to insure against error messages.
UnitsLegal RangeDefaultRequiredVariability
AVAIL, OFFAVAILNohourly

ahhcCapTRat=float

Total heating (output) capacity. For an ELECTRIC, AHP, GAS, or OIL coil, this capacity is always available. For an HW heating coil, when the total heat being requested from the coil’s HEATPLANT would overload the HEATPLANT, the capacity of all HW coils connected to the plant (in TERMINALs as well as AIRHANDLERs) is reduced proportionately until the requested total heat is within the HEATPLANT’s capacity. For AHP, this value represents the AHRI rated capacity at 47 oF outdoor temperature.

UnitsLegal RangeDefaultRequiredVariability
BtuhAUTOSIZE or x \(\ge\) 0noneYes, if coil presenthourly

ahhcFxCap=float

Capacity sizing multiplier for autoSized heating coils. The default value (1.1) specifies 10% oversizing.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 01.1Noconstant

ahhcMtr=mtrName

Name of meter to accumulate energy use by this heat coil. The input energy used by the coil is accumulated in the end use category “Htg”; for a heat pump, the energy used by the supplemental resistance heaters (regular and defrost) is accumulated under the category “hp”. Not allowed when*ahhcType* is HW, as an HW coil’s energy comes from its HEATPLANT, and the HEATPLANT’s BOILERs accumulate input energy to meters.

UnitsLegal RangeDefaultRequiredVariability
name of a METERnot recordedNoconstant

The following input is used only when ahhcType is HW:

ahhcHeatplant=Heatplant name

Name of HEATPLANT supporting hot water coil.

UnitsLegal RangeDefaultRequiredVariability
name of a HEATPLANTnoneif ahhcType is HWconstant

The following inputs are used only for furnaces (ahhcType = GAS or OIL).

One of the next two items, but not both, must be given for furnaces:

ahhcEirR=float

Rated energy input ratio (input energy/output energy) at full power.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 1noneif ahhcEirR not given and ahhcType is GAS or OILhourly

ahhcEffR=float

Rated efficiency (output energy/input energy; 1/ahhcEirR) at full power

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 1noneif ahhcEirR not given and ahhcType is GAS or OILhourly

ahhcPyEi=\(k_0\), \(k_1\), \(k_2\), \(k_3\)

Coefficients of cubic polynomial function of (subhour average) part-load-ratio (plrAv) to adjust the full-load furnace energy input for part load operation. Enter, separated by commas, in order, the constant part, the coefficient of plrAv, the coefficient of plrAv squared, and the coefficient of plrAv cubed. CSE will normalize the coefficients if necessary to make the polynomial value be 1.0 when the part load ratio is 1.0.

The default, from DOE2, is equivalent to:

    ahhcPyEi = .01861, 1.094209, -.112819, 0.;

which corresponds to the quadratic polynomial:

\[\text{pyEi}(\text{plrAv}) = 0.01861 + 1.094209 \cdot \textbf{plrAv} - 0.112819 \cdot \textbf{plrAv}^2\]

Note that the value of this polynomial adjusts the energy input, not the energy input ratio, for part load operation.

UnitsLegal RangeDefaultRequiredVariability
0.01861, 1.094209, -0.112819, 0.0.Noconstant

ahhcStackEffect=float

Fraction of unused furnace capacity that must be used to make up for additional infiltration caused by stack effect of a hot flue when the (indoor) furnace is NOT running, only in subhours when furnace runs PART of the subhour, per DOE2 model.

This is an obscure feature that will probably never be used, included only due to indecisiveness on the part of most members of the committee designing this program. The first time reader should skip this section, or read it only as an example of deriving an expression to implement a desired relationship.

The stack effect is typically a function of the square root of the difference between the outdoor temperature and the assumed stack temperature.

For example, the following is a typical example for furnace stack effect:

    ahhcStackEffect =  @Top.tDbO >= 68.  ?  0.
                        :  (68. - @Top.tDbO)
                           * sqrt(200.-@Top.tDbO)
                           / (10*68*sqrt(200));

The code “@Top.tDbO >= 68 ? 0. : ...” insures that the value will be 0, not negative, when it is warmer than 68 out (if the furnace were to run when the value was negative, a run-time error would terminate the run).

The factor “(68. - @Top.tDbO)” reflects the fact that the energy requirement to heat the infiltrating air is proportional to how much colder it is than the indoor temperature. Note that its permitted to use a constant for the indoor temperature because if it is below setpoint, the furnace will be running all the time, and there will be no unused capacity and the value of ahhcStackEffect will be moot.

The factor “sqrt(200.-@Top.tDbO)” represents the volume of infiltrated air that is typically proportional to the square root of the driving temperature difference, where 200 is used for the estimated effective flue temperature.

The divisor “/ (10*68*sqrt(200))” is to make the value 0.1 when tDbO is 0, that is, to make the stack effect loss use 10% of unused load when it is 0 degrees out. The actual modeling engineer must know enough about his building to be able to estimate the additional infiltration load at some temperature.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 10Nohourly

The following heat coil input members, beginning with ahp-, are used when modeling the heating function of an air source heat pump with the air handler heat coil, that is, when ahhcType= AHP is given. Also, see the “AIRHANDLER Crankcase Heater" section with regard to specifying the heat pump’s crankcase heater.

ahpCap17=float

AHRI steady state (continuous operation) rated capacity at 70 degrees F indoor (return) air temp, and 17 degrees F outdoor temp, respectively. These values reflect no cycling, frost, or defrost degradation. To help you find input errors, the program issues an error message if ahpCap17 >= ahhcCapTRat.

UnitsLegal RangeDefaultRequiredVariability
Btuhx \(\gt\) 0noneYes, for AHP coilconstant

ahpCapRat1747=float

The ratio of AHRI steady state (continuous operation) rated capacities at 17 and 47 degrees F outdoor temp. This is used to determine ahpCap35 when ahhcCapTRat is AUTOSIZEd.

UnitsLegal RangeDefaultRequiredVariability
x \(\gt\) 00.6184Noconstant

ahpCapRat9547=float

Ratio of ahccCapTRat to ahhcCapTRat. This ratio is used for defaulting of AUTOSIZEd heat pump heating and cooling capacities such that they have consistent values as is required given that a heat pump is a single device. If not given, ahpCapRat9547 is determined during calculations using the relationship ahccCapTRat = 0.98 * ahhcCapTRat + 180 (derived via correlation of capacities of a set of real units).

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 0See aboveNoconstant

ahpCap35=float

AHRI steady state (continuous operation) rated capacity at 35 F outdoor temp, reflecting frost buildup and defrost degradation but no cycling. Unlikely to be available for input; if not given, will be defaulted to ahpFd35Df (next description) times a value determined by linear interpolation between the given ahpCap17 and ahhcCapTRat values. If ahpCap35 is given, CSE will issue an error message if it is greater than value determined by linear interpolation between ahpCap17 and ahhcCapTRat.

UnitsLegal RangeDefaultRequiredVariability
Btuhx \(\gt\) 0from ahpFd35DfNoconstant

ahpFd35Df=float

Default frost/defrost degradation factor at 35 F: reduction of output at unchanged input, due to defrosting and due to frost on outdoor coil. Used in determining default value for ahpCap35 (preceding description); not used if ahpCap35 is given.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 10.85Noconstant

ahpCapIa=float

Capacity correction factor for indoor (return) air temperature, expressed as a fraction reduction in capacity per degree above 70F.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 10.004Noconstant

ahpCapSupH=float

Output capacity of the supplemental reheat coil used when heat pump alone cannot meet the load or to offset the defrost cooling load. Energy consumed by this heater is accumulated in category “HPBU” of ahhcMeter (whereas energy consumption of the heat pump compressor is accumulated under category “Htg”).

UnitsLegal RangeDefaultRequiredVariability
Btu/hrx \(\ge\) 00Noconstant

ahpEffSupH=float

Efficiency of the supplemental reheat coil. Use values other than the default for gas supplemental heaters.

UnitsLegal RangeDefaultRequiredVariability
x \(\gt\) 01.0Nohourly

ahpSupHMtr=mtrName

Specifies a meter for recording supplemental heater energy use. End use category “HPBU” is used.

UnitsLegal RangeDefaultRequiredVariability
name of a METERnot recordedNoconstant

The next seven inputs specify frost buildup and defrosting and their effect on capacity.

ahpTFrMn=float

ahpTFrMx=float

ahpTFrPk=float

Lowest, highest, and peak temperatures for frost buildup and defrost effects. Capacity reduction due to frost and defrosting consists of a component due to frost buildup on the outdoor coil, plus a component due to lost heating during the time the heat pump is doing reverse cycle defrosting (heating the outdoor coil to melt off the frost, which cools the indoor coil). The effects of Frost Buildup and of time spent defrosting are computed for different temperature ranges as follows:

In other words, the curve of capacity loss due to frost buildup follows straight lines from its high point at ahpTFrPk to zero at ahpTFrMn and ahpTFrMx, and remains zero outside the range ahpTFrMn to ahpTFrMx. The height of the high point is determined to match the ahpCap35 input value or its default. The curve of time spent defrosting is described in other words in the description of ahpDfrFMn and ahpDfrFMx, next.

An error will occur unless ahpTFrMn < ahpTFrPk < ahpTFrMx and ahpTFrMn < 35 < ahpTFrMx.

UnitsLegal RangeDefaultRequiredVariability
oFx \(\gt\) 0ahpTFrMn: 17, ahpTFrMx: 47, ahpTFrPk: 42Noconstant

ahpDfrFMn=float

ahpDfrFMx=float

Minimum and maximum fraction of time spent in reverse cycle defrost cooling.

The fraction of the time spent defrosting depends on the outdoor temperature, as follows: at or below ahpTFrMn, and at (but not above) ahpTFrMx, ahpDfrFMn is used. ahpDfrFMx is used at ahpTFrMx. Linear interpolation is used between ahpTFrMn or ahpTFrMx and ahpTFrMx. No time is spent defrosting above ahpTFrMx.

In other words, the curve of time spent defrosting versus outdoor temperature has the value ahpDfrFMn up to ahpTFrMn, then rises in a straight line to ahpDfrFMx at ahpTFrMx, then falls in a straight line back to ahpDfrFMn at ahpTFrMx, then drops directly to zero for all higher temperatures.

During the fraction of the time spent defrosting, the heat pump’s input remains constant and the output is changed as follows:

The program will issue an error message if ahpDfrFMx \(\le\) ahpDfrFMn.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 1ahpDfrFMn: .0222, (2 minutes/90 minutes), ahpDfrFMx:.0889, (8 minutes / 90 minutes)Noconstant

ahpDfrCap=float

Cooling capacity (to air handler supply air) during defrosting. Program separately computes the lost heating capacity during defrosting, but effects of switchover transient should be included in ahpDfrCap.

UnitsLegal RangeDefaultRequiredVariability
Btuhx \(\neq\) 02 \(\cdot\) ahpCap17Noconstant

ahpTOff=float

ahpTOn=float

Heat pump low temperature cutout setpoints. Heat pump is disabled (only the supplemental resistance heater operates) when outdoor temperature falls below ahpTOff, and is re-enabled when temperature rises above ahpTOn. Different values may be given to simulate thermostat differential. ahpTOff must be \(\le\) ahpTOn; equal values are accepted.

UnitsLegal RangeDefaultRequiredVariability
oFahpTOff: 5, ahpTOn: 12Noconstant

The next four inputs specify the heating power input for an air source heat pump:

ahpCOP47=float

ahpCOP17=float

Steady state (full power, no cycling) coeffient of performance for compressor and crankcase heater at 70 degrees F indoor (return) air temp and 47 and 17 degrees F outdoor temp, respectively.

UnitsLegal RangeDefaultRequiredVariability
kWx \(\gt\) 0noneYes, for AHP coilconstant

ahpInIa=float

Indoor (return) air temp power input correction factor: fraction increase in steady-state input per degree above 70 F, or decrease below 70F.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 10.004Noconstant

ahpCd=float

AHRI cycling degradation coefficient: ratio of fraction drop in system coefficient of performance (COP) to fraction drop in capacity when cycling, from steady-state values, in AHRI 47 F cycling performance tests. A value of .25 means that if the heat pump is cycled to drop its output to 20% of full capacity (i.e. by the fraction .8), its COP will drop by .8 * .25 = .2. Here COP includes all energy inputs: compressor, crankcase heater, defrost operation, etc.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 10.25Noconstant

The following four air handler heat coil members allow specification of auxiliary input power consumption associated with the heat coil (or furnace) under the indicated conditions. The single description box applies to all four.

ahhcAux=float

Auxiliary energy used by the heating coil.

UnitsLegal RangeDefaultRequiredVariability
Btu/hrx \(\ge\) 00Nohourly

ahhcAuxMtr=mtrName

Specifies a meter for recording auxiliary energy use. End use category “Aux” is used.

UnitsLegal RangeDefaultRequiredVariability
name of a METERnot recordedNoconstant

4.44.5 AIRHANDLER Cooling coil

A cooling coil is an optional device that remove heat and humidity from the air passing through the AIRHANDLER. Available cooling coil types include chilled water (CHW), supported by a COOLPLANT that supplies cold water, and Direct Expansion (DX), supported by a dedicated compressor and condenser that are modeled integrally with the DX coil. No plant is used with DX coils.

The following five members are used for all cool coil types except as noted. Presence of a cool coil in the AIRHANDLER is indicated by giving an ahccType value other than NONE.

ahccType=choice

Cool coil type choice:

ELECTRICTesting artifice: removes heat at 100% efficiency up to rated capacity at any flow and temperature; removes no humidity. Use in research runs to isolate effects of coil models from other parts of the CSE program.
CHWCHilled Water coil, using a cold water from a COOLPLANT.
DXDirect Expansion coil, with dedicated compressor and condenser modeled integrally.
NONEAIRHANDLER has no cooling coil and no cooling capability.
UnitsLegal RangeDefaultRequiredVariability
ELECTRIC, DX, CHW, NONENONEYes, if coil presentconstant

ahccSched=choice

Cooling coil schedule choice, hourly variable. Use a suitable CSE expression for ahccSched if cooling coil is to operate only at certain times, only in hot weather, etc.

AVAILCooling coil will operate as necessary (within its capacity) to cool the supply air to the supply temperature setpoint.
OFFCooling coil will not operate no matter how hot the supply air is. To avoid error messages, a CHW coil should be scheduled OFF whenever its COOLPLANT is scheduled OFF.
UnitsLegal RangeDefaultRequiredVariability
AVAIL, OFFAVAILNoconstant

ahccCapTRat=float

Total rated capacity of coil: sum of its “sensible” (heat-removing) and “latent” (moisture removing) capacities. Not used with CHW coils, for which capacity is implicitly specified by water flow (ahccGpmDs) and transfer unit (ahccNtuoDs* and ahccNtuiDs) inputs, described below.

For coil specification conditions (a.k.a. rating conditions or design conditions), see ahccDsTDbEn, ahccDsTWbEn, ahccDsTDbCndand ahccVfRbelow (see index).

UnitsLegal RangeDefaultRequiredVariability
BtuhAUTOSIZE or x \(>\) 0noneYesconstant

ahccCapSRat=float

Sensible (heat-removing) rated capacity of cooling coil. Not used with CHW coils.

UnitsLegal RangeDefaultRequiredVariability
Btuhx \(>\) 0noneYesconstant

ahccSHRRat=float

Rated sensible heat ratio (ahccCapSRat/ahccCapTRat) for cooling coil. Default based on correlation to ahccVfRperTon. Not used with CHW coils.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 0based on ahccVfRperTonNoconstant

ahccFxCap=float

Capacity sizing multiplier for autoSized cooling coils. The default value (1.1) specifies 10% oversizing.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 01.1Noconstant

ahccMtr=mtrName

Name of meter, if any, to record energy use of air handler cool coil. End use category “Clg” is used. Not used with CHW coils, because the input energy use for a CHW coil is recorded by the COOLPLANT’s CHILLERs.

UnitsLegal RangeDefaultRequiredVariability
name of a METERnot recordedNoconstant

The following six members are used with DX cooling coils.

ahccMinTEvap=float

Minimum (effective surface) temperature of coil (evaporator). Represents refrigerant setpoint, or cutout to prevent freezing. Coil model will reduce output to keep simulated coil from getting colder than this, even though it lets supply air get warmer than setpoint. Should default be 35??

UnitsLegal RangeDefaultRequiredVariability
oFx \(>\) 040oFNoconstant

ahccK1=float

Exponent in power relationship expressing coil effectiveness as a function of relative air flow. Used as K1 in the relationship ntu = ntuR * relCfmk1, which says that the “number of transfer units” (on the coil outside or air side) varies with the relative air flow raised to the K1 power. Used with CHW as well as DX coils; for a CHW coil, ntuR in the formula is ahccNtuoDs.

UnitsLegal RangeDefaultRequiredVariability
x \(<\) 0-0.4Noconstant

ahccBypass=float

Fraction of air flow which does NOT flow through DX cooling coil, for better humidity control. Running less of the air through the coil lets the coil run colder, resulting in greater moisture removal right??.

UnitsLegal RangeDefaultRequiredVariability
0 \(\lt\) x \(\le\) 10Noconstant

The next three members are used in determining the energy input to a DX coil under various load conditions. The input is derived from the full load energy input ratio for four segments of the part load curve. In the following the part load ratio (plr) is the ratio of the actual sensible + latent load on the coil to the coil’s capacity. The coil’s capacity is ahccCaptRat, adjusted by the coil model for differences between entering air temperature, humidity, and flow rate and the coil rating conditions. The coil may run at less than capacity even at full fan flow, depending on the air temperature change needed, the moisture content of the entering air, and the relative values of between sfanVfDs and ahccVfR.

full loadplr (part load ratio) = 1.0
Full-load power input is power output times ahhcEirR.
compressor unloading region1.0 > plr \(\ge\) ahhcMinUnldPlr
Power input is the full-load input times the value of the pydxEirUl polynomial (below) for the current plr, i.e. pydxEirUl(plr).
false loading regionahccMinUnldPlr > plr \(\ge\) ahccMinFsldPlr
Power input in this region is constant at the value for the low end of the compressor unloading region, i.e. pydxEirUl(ahccMinUnldPlr).
cycling regionahccMinFsldPlr > plr \(\ge\) 0
In this region the compressor runs at the low end of the false loading region for the necessary fraction of the time, and the power input is the false loading value correspondingly prorated, i.e. pydxEirUl(ahccMinUnldPlr) * plr / ahccMinFsldPlr.

The default values for the following three members are the DOE2 PTAC (Window air conditioner) values.

ahccEirR=float

DX compressor energy input ratio (EIR) at full load under rated conditions; defined as the full-load electric energy input divided by the rated capacity, both in Btuh; same as the reciprocal of the Coefficient Of Performance (COP). Polynomials given below are used by CSE to adjust the energy input for part load and for off rated flow and temperature conditions. The default value includes outdoor (condenser) fan energy, but not indoor (air handler supply) fan energy.

UnitsLegal RangeDefaultRequiredVariability
0.438Noconstant

ahccMinUnldPlr=float

Compressor part load ratio (total current load/current capacity) at/above which “Compressor unloading” is used and pydxEirUl (below) is used to adjust the full-load power input to get the current part load power input.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 11 (no unloading)Noconstant

ahccMinFsldPlr=float

“False Loading” is used between this compressor part load ratio and the plr where unloading is activated (ahccMinUnldPlr). In this region, input remains at pydxEirUl(ahccMinUnldPlr).For plr’s less than ahccMinFsldPlr, cycling is used, and the power input goes to 0 in a straight line.

UnitsLegal RangeDefaultRequired**Variability
0 \(\le\) x \(\le\) ahccMinUnldPlrahccMinUnldPlr (no false loading)Noconstant

The following four inputs specify polynomials to approximate functions giving DX coil capacity and power (energy) input as functions of entering temperatures, relative (to ahccVfR) flow, and relative load (plr). In each case several float values may be given, for use as coefficients of the polynomial. The values are ordered from constant to coefficient of highest power. If fewer than the maximum number of values are given, zeroes are used for the trailing (high order) coefficients.

Examples:

    pydxCaptT = 2.686, -0.01667, 0, 0.006, 0, 0;

    pydxCaptT = 2.686, -0.01667, 0, 0.006; // same

    pydxEirUl = .9, 1.11, .023, -.00345;

If the polynomial does not evaluate to 1.0 when its inputs are equal to the rating conditions (1.0 for relative flows and plr), CSE will normalize your coefficients by dividing them by the non-1.0 value.

Some of the polynomials are biquadratic polynomials whose variables are the entering air wetbulb and drybulb temperatures. These are of the form

\[z = a + bx + cx^2 + dy + ey^2 + fxy\]

where a through f are user-inputtable coefficients, x is the entering wetbulb temperature, y is the entering drybulb temperature, and the polynomial value, z, is a factor by which the coil’s capacity, power input, etc. at rated conditions is multiplied to adjust it for the actual entering air temperatures.

Other polynomials are cubic polynomials whose variable is the air flow or load as a fraction of full flow or load.. These are of the form

\[z = a + bx + cx^2+ dx^3\]

where a, b, c, and d are user-inputtable coefficients, \(x\) is the variable, and the value \(z\) is a factor by which the coil’s capacity, power input, etc. at rated conditions is multiplied to adjust it for the actual flow or load.

The default values for the polynomial coefficients are the DOE2 PTAC values.

pydxCaptT=a, b, c, d, e, f

Coefficients of biquadratic polynomial function of entering air wetbulb and condenser temperatures whose value is used to adjust ahccCaptRat for the actual entering air temperatures. The condenser temperature is the outdoor drybulb, but not less than 70. See discussion in preceding paragraphs.

UnitsLegal RangeDefaultRequiredVariability
1.1839345, -0.0081087, 0.00021104, -0.0061425, 0.00000161, -0.0000030Noconstant

pydxCaptF=a=a, b, c, d

Coefficients of cubic polynomial function of relative flow (entering air cfm/ahccVfR) whose value is used to adjust ahccCaptRat for the actual flow. See discussion in preceding paragraphs.

UnitsLegal RangeDefaultRequiredVariability
0.8, 0.2, 0.0, 0.0Noconstant

pydxCaptFLim=float

Upper limit for value of pydxCaptF.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 01.05Noconstant

pydxEirT=a, b, c, d, e, f

Coefficients of biquadratic polynomial function of entering air wetbulb and condenser temperatures whose value is used to adjust ahccEirR for the actual entering air temperatures. The condenser temperature is the outdoor air drybulb, but not less than 70. If the entering air wetbulb is less than 60, 60 is used, in this function only. See discussion in preceding paragraphs.

UnitsLegal RangeDefaultRequiredVariability
-0.6550461, 0.03889096, -0.0001925, 0.00130464, 0.00013517, -0.0002247Noconstant

pydxEirUl=a, b, c, d

Coefficients of cubic polynomial function of part load ratio used to adjust energy input to part load conditions, in the compressor unloading part load region (1 \(\ge\) plr \(\ge\) ahccMinUnldPlr) as described above. See discussion of polynomials in preceding paragraphs.

This polynomial adjusts the full load energy input to part load, not the ratio of input to output, despite the “Eir” in its name.

UnitsLegal RangeDefaultRequiredVariability
0.125, 0.875, 0.0, 0.0Noconstant

The following four members are used only with CHW coils. In addition, ahccK1, described above, is used.

ahccCoolplant=name

name of COOLPLANT supporting CHW coil. COOLPLANTs contain CHILLERs, and are described in Section 5.21.

UnitsLegal RangeDefaultRequiredVariability
name of a COOLPLANTnonefor CHW coilconstant

ahccGpmDs=float

Design (i.e. maximum) water flow through CHW coil.

UnitsLegal RangeDefaultRequiredVariability
gpmx \(\ge\) 0noneYes, for CHW coilconstant

ahccNtuoDs=float

CHW coil outside number of transfer units at design air flow (ahccVfR, below). SeeahccK1* above with regard to transfer units at other air flows.

UnitsLegal RangeDefaultRequiredVariability
x \(\gt\) 02Noconstant

ahccNtuiDs=float

CHW coil inside number of transfer units at design water flow (ahccGpmDs, above).

UnitsLegal RangeDefaultRequiredVariability
x \(\gt\) 02Noconstant

The following four members let you give the specification conditions for the cooling coil: the rating conditions, design conditions, or other test conditions under which the coil’s performance is known. The defaults are AHRI (Air-Conditioning and Refrigeration Institute) standard rating conditions.

ahccDsTDbEn=float

Design (rating) entering air dry bulb temperature, used with DX and CHW cooling coils. With CHW coils, this input is used only as the temperature at which to convert ahccVfR from volume to mass.

UnitsLegal RangeDefaultRequiredVariability
oFx \(\gt\) 080oF (AHRI)Noconstant

ahccDsTWbEn=float

Design (rating) entering air wet bulb temperature, for CHW coils.

UnitsLegal RangeDefaultRequiredVariability
oFx \(\gt\) 067oF (AHRI)Noconstant

ahccDsTDbCnd=float

Design (rating) condenser temperature (outdoor air temperature) for DX coils.

UnitsLegal RangeDefaultRequiredVariability
oFx \(\gt\) 095oF (AHRI)Noconstant

ahccVfR=float

Design (rating) (volumetric) air flow rate for DX or CHW cooling coil. The AHRI specification for this test condition for CHW coils is “450 cfm/ton or less”, right??

UnitsLegal RangeDefaultRequiredVariability
cfmx \(\gt\) 0DX coil: ahccVfRperTon CHW coil: sfanVfDsNoconstant

The following four members permit specification of auxiliary input power use associated with the cooling coil under the conditions indicated.

ahccVfRperTon=float

Design default ahccVfR per ton (12000 Btuh) of ahhcCapTRat.

UnitsLegal RangeDefaultRequiredVariability
x \(>\) 0400.0Noconstant

ahccAux=float

Auxiliary energy used by the cooling coil.

UnitsLegal RangeDefaultRequiredVariability
Btu/hrx \(\ge\) 00Nohourly

ahccAuxMtr=mtrName

Specifies a meter for recording auxiliary energy use. End use category “Aux” is used.

UnitsLegal RangeDefaultRequiredVariability
name of a METERnot recordedNoconstant

4.44.6 AIRHANDLER Outside Air

Outside air introduced into the air hander supply air can be controlled on two levels. First, a minimumfraction or volume of outside air may be specified. By default, a minimum volume of .15 cfm per square foot of zone area is used. Second, an economizer may be specified. The simulated economizer increases the outside air above the minimum when the outside air is cooler or has lower enthalpy than the return air, in order to reduce cooling coil energy usage. By default, there is no economizer.

oaMnCtrl=choice

Minimum outside air flow control method choice, VOLUME or FRACTION. Both computations are based on the minimum outside air flow, oaVfDsMn; if the control method is FRACTION, the outside air flow is pro-rated when the air handler is supplying less than its design cfm. In both cases the computed minimum cfm is multiplied by a schedulable fraction, oaMnFrac, to let you vary the outside air or turn in off when none is desired.

VOLUMEVolume (cfm) of outside air is regulated:
min_oa_flow = oaMnFrac * oaVfDsMn
FRACTIONFraction of outside air in supply air is regulated. The fraction is oaVfDsMn divided by sfanVfDs, the air handler supply fan design flow. The minimum cfm of outside air is thus computed as
min_oa_flow = oaMnFrac * curr_flow * oaVfDsMn / sfanVfDs
where curr_flow is the current air handler cfm.

If the minimum outside air flow is greater than the total requested by the terminals served by the air handler, then 100% outside air at the latter flow is used. To insure minimum outside air cfm to the zones, use suitable terminal minimum flows (tuVfMn) as well as air handler minimum outside air specifications.

UnitsLegal RangeDefaultRequiredVariability
VOLUME, FRACTIONVOLUMENoconstant

oaVfDsMn=float

Design minimum outside air flow. If oaMnCtrl is FRACTION, then this is the minimum outside air flow at full air handler flow. See formulas in oaMnCtrl description, just above.

UnitsLegal RangeDefaultRequiredVariability
cfmx \(\ge\) 00.15 times total area of zones servedNoconstant

oaMnFrac=float

Fraction of minimum outside air to use this hour, normally 1.0. Use a CSE expression that evaluates to 0 for hours you wish to disable the minimum outside air flow, for example to suppress ventilation during the night or during warm-up hours. Intermediate values may be used for intermediate outside air minima. See formulas in oaMnCtrl description, above.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 11.0Nohourly

CAUTION: the minimum outside air flow only applies when the supply fan is running; it won’t assure meeting minimum ventilation requirements when used with ahFanCycles = YES (constant volume, fan cycling).

oaZoneLeak=float

For the purposes of airnet zone pressure modeling ONLY, oaZoneLeak specifies the fraction of supply air that is assumed to leak from zone(s) (as opposed to returning to the airhandler via the return duct). For example, if the supply air volume is 500 cfm and oaZoneLeak is 0.4, the values passed to airnet are 500 cfm inflow and 300 cfm outflow. The 200 cfm difference is distributed to other zone leaks according to their pressure/flow characteristics.

The default assumption is that airhandlers with return or relief fans provide balanced zone flows while half the supply flow leaks from zones served by supply-fan-only airhandlers.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 1no return/relief fan: 0.5 else 0Nohourly

If an oaEcoType choice other than NONE is given, an economizer will be simulated. The economizer will be enabled when the outside temperature is below oaLimT AND the outside air enthalpy is below oaLimE. When enabled, the economizer adjusts the economizer dampers to increase the outside air mixed with the return air until the mixture is cooler than the air handler supply temperature setpoint, if possible, or to maximum outside air if the outside air is not cool enough.

CAUTIONS: the simulated economizer is just as dumb as the hardware being simulated. Two considerations particularly require attention. First, if enabled when the outside air is warmer than the return air, it will do the worst possible thing: use 100% outside air. Prevent this by being sure your oaLimT or oaLimE input disables the economizer when the outside air is too warm – or leave the oaLimT = RA default in effect.

Second, the economizer will operate even if the air handler is heating, resulting in use of more than minimum outside air should the return air get above the supply temperature setpoint. Economizers are intended for cooling air handlers; if you heat and cool with the same air handler, consider disabling the economizer when heating by scheduling a very low oaLimT or oaLimE.

oaEcoType=choice

Type of economizer. Choice of:

NONENo economizer; outside air flow is the minimum.
INTEGRATEDCoil and economizer operate independently.
NONINTEGRATEDCoil does not run when economizer is using all outside air: simulates interlock in some equipment designed to prevent coil icing due to insufficient load, right?
TWO_STAGEEconomizer is disabled when coil cycles on. NOT IMPLEMENTED as of July 1992.

oaLimT=float or RA

Economizer outside air temperature high limit. The economizer is disabled (outside air flow is reduced to a minimum) when the outside air temperature is greater than oaLimT. A number may be entered, or “RA” to specify the current Return Air temperature. OaLimT may be scheduled to a low value, for example -99, if desired to disable the economizer at certain times.

UnitsLegal RangeDefaultRequiredVariability
oFnumber or RARA (return air temperature)Nohourly

oaLimE=float or RA

Economizer outside air enthalpy high limit. The economizer is disabled (outside air flow is reduced to a minimum) when the outside air enthalpy is greater than oaLimE. A number may be entered, or “RA” to specify the current Return Air enthalpy. OaLimE may be scheduled to a low value, for example -99, if desired to disable the economizer at certain times.

UnitsLegal RangeDefaultRequiredVariability
Btu/oFnumber or RA999 (enthalpy limit disabled)Nohourly

oaOaLeak and oaRaLeak specify leakages in the economizer dampers, when present. The leaks are constant-cfm flows, expressed as fractions of the maximum possible flow. Thus, when the current flow is less than the maximum possible, the range of operation of the economizer is reduced. When the two damper leakages add up to more than the current air handler flow, outside and return air are used in the ratio of the two leakages and the economizer, if enabled, is ineffective.

oaOaLeak=float

Outside air damper leakage to mixed air. Puts a minimum on return air flow and thus a maximum on outside air flow, to mixed air. If an economizer is present, oaOaLeak is a fraction of the supply fan design cfm, sfanVfDs. Otherwise, oaOaLeak is a fraction of the design minimum outside air flow oaVfDsMn.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 1.00.1Noconstant

oaRaLeak=float

Return air damper leakage to mixed air. Puts a minimum on return air flow and thus a maximum on outside air flow, to mixed air. Expressed as a fraction of the supply fan design cfm, sfanVfDs. Not used when no economizer is being modeled.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 1.00.1Noconstant

4.44.7 AIRHANDLER Heat Recovery

The following data members are used to describe a heat exchanger for recovering heat from exhaust air. Heat recovery added to the model when a value for oaHXSenEffHDs is provided.

oaHXVfDs=float

Heat exchanger design or rated flow.

UnitsLegal RangeDefaultRequiredVariability
cfmx \(\gt\) 0oaVfDsMnNoconstant

oaHXf2=float

Heat exchanger flow fraction (of design flow) used for second set of effectivenesses.

UnitsLegal RangeDefaultRequiredVariability
0 \(\lt\) x \(\lt\) 1.00.75Noconstant

oaHXSenEffHDs=float

Heat exchanger sensible effectiveness in heating mode at the design flow rate. Specifying input triggers modeling of heat recovery.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 1.0when modeling heat recoveryconstant

oaHXSenEffHf2=float

Heat exchanger sensible effectiveness in heating mode at the second flow rate (oaHXf2).

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 1.00Noconstant

oaHXLatEffHDs=float

Heat exchanger latent effectiveness in heating mode at the design flow rate.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 1.00Noconstant

oaHXLatEffHf2=float

Heat exchanger latent effectiveness in heating mode at the second flow rate (oaHXf2).

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 1.00Noconstant

oaHXSenEffCDs=float

Heat exchanger sensible effectiveness in cooling mode at the design flow rate.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 1.00Noconstant

oaHXSenEffCf2=float

Heat exchanger sensible effectiveness in cooling mode at the second flow rate (oaHXf2).

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 1.00Noconstant

oaHXLatEffCDs=float

Heat exchanger latent effectiveness in cooling mode at the design flow rate.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 1.00Noconstant

oaHXLatEffCf2=float

Heat exchanger latent effectiveness in cooling mode at the second flow rate (oaHXf2).

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 1.00Noconstant

oaHXBypass=choice

Yes/No choice for enabling heat exchanger bypass. If selected, the outdoor air will bypass the heat exchanger when otherwise the heat exchanger would require more heating or cooling energy to meet the respective setpoints.

UnitsLegal RangeDefaultRequiredVariability
NO, YESNONoconstant

oaHXAuxPwr=float

Auxiliary power required to operate the heat recovery device (e.g., wheel motor, contorls).

UnitsLegal RangeDefaultRequiredVariability
Wx \(\ge\) 00Nosubhourly

oaHXAuxMtr=mtrName

Name of meter, if any, to record energy used by auxiliary components of the heat recovery system.

UnitsLegal RangeDefaultRequiredVariability
name of a METERnot recordedNoconstant

4.44.8 AIRHANDLER Leaks and Losses

AhSOLeak and ahRoLeak express air leaks in the common supply and return ducts, if any, that connect the air handler to the conditioned space. For leakage after the point where a duct branches off to an individual zone, see TERMINAL member tuSRLeak. These inputs model leaks in constant pressure (or vacuum) areas nearer the supply fan than the terminal VAV dampers; thus, they are constant volume regardless of flow to the zones. Hence, unless 0 leakage flows are specified, the air handler cfm is greater than the sum of the terminal cfm’s, and the air handler cfm is non-0 even when all terminal flows are 0. Any heating or cooling energy applied to the excess cfm is lost to the outdoors.

If unequal leaks are specified, at present (July 1992) CSE will use the average of the two specifications for both leaks, as the modeled supply and return flows must be equal. A future version may allow unequal flows, making up the difference in exfiltration or infiltration to the zones.

ahSOLeak=float

Supply duct leakage to outdoors, expressed as a fraction of supply fan design flow (sfanVfDs). Use 0 if the duct is indoors. A constant-cfm leak is modeled, as the pressure is constant when the fan is on.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 10.01Noconstant

ahROLeak=float

Return duct leakage FROM outdoors, expressed as a fraction of sfanVfDs. Use 0 if the duct is indoors.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 10.01Noconstant

AhSOLoss and ahROLoss represent conductive losses from the common supply and return ducts to the outdoors. For an individual zone’s conductive duct loss, see TERMINAL member tuSRLoss. Losses here are expressed as a fraction of the temperature difference which is lost. For example, if the supply air temperature is 120, the outdoor temperature is 60, and the pertinent loss is .1, the effect of the loss as modeled will be to reduce the supply air temperature by 6 degrees ( .1 * (120 - 60) ) to 114 degrees. CSE currently models these losses a constant TEMPERATURE LOSSes regardless of cfm.

ahSOLoss=float

Supply duct loss/gain to the outdoors.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 10.1Noconstant

ahROLoss=float

Return duct heat loss/gain to the outdoors.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 10.1Noconstant

4.44.9 AIRHANDLER Crankcase Heater

A “crankcase heater” is an electric resistance heater in the crankcase of the compressor of heat pumps and dx cooling coils. The function of the crankcase heater is to keep the compressor’s oil warmer than the refrigerant when the compressor is not operating, in order to prevent refrigerant from condensing into and remaining in the oil, which impairs its lubricating properties and shortens the life of the compressor. Manufacturers have come up with a number of different methods for controlling the crankcase heater. The crankcase heater can consume a significant part of the heat pump’s energy input; thus, it is important to model it.

In CSE a heat pump is modeled as though it were separate heating and cooling coils. However, the crankcase heater may operate (or not, according to its control method) whether the heat pump is heating, or cooling, or, in particular, doing neither, so it is modeled as a separate part of the air handler, not associated particularly with heating or cooling.

When modeling an air source heat pump (ahhcType = AHP), these variables should be used to specify the crankcase heater, insofar as non-default inputs are desired.

Appropriateness of use of these inputs when specifying a DX system without associated heat pump heating is not clear to me (Rob) as of 10-23-92; on the one hand, the DX compressor probably has a crankcase heater; on the other hand, the rest of the DX model is supposed to be complete in itself, and adding a crankcase heater here might produce excessive energy input; on the third hand, the DX model does not include any energy input when the compressor is idle; … .

cchCM=choice

Crankcase heater presence and control method. Choice of:

NONENo crankcase heater present
CONSTANTCrankcase heater input always cchPMx (below).
PTCProportional control based on oil temp when compressor does not run in subhour (see cchTMx, cchMn, and cchDT). If compressor runs at all in subhour, the oil is assumed to be hotter than cchTMn and crankcase heater input is cchPMn. (PTC stands for ‘Positive Temperature Coefficient’ or ‘Proportional Temperature Control’.)
TSTATControl based on outdoor temperature, with optional differential, during subhours when compressor is off; crankcase heater does not operate if compressor runs at all in subhour. See cchTOn, cchTOff.
CONSTANT_CLO
PTC_CLOSame as corresponding choices above except zero crankcase heater input during fraction of time compressor is on (‘Compressor Lock Out’). There is no TSTAT_CLO because under TSTAT the crankcase heater does not operate anyway when the compressor is on.
UnitsLegal RangeDefaultRequiredVariability
CONSTANT CONSTANT_CLO PTC PTC_CLO TSTAT NONEPTC_CLO if ahhcType is AHP else NONENoconstant

cchPMx=float

Crankcase resistance heater input power; maximum power if cchCM is PTC or PTC_CLO.

UnitsLegal RangeDefaultRequiredVariability
kWx \(\gt\) 0.4 kWNoconstant

cchPMn=float

Crankcase heater minimum input power if cchCM is PTC or PTC_CLO, disallowed for other cchCM’s. > 0.

UnitsLegal RangeDefaultRequiredVariability
kWx \(\gt\) 0.04 kWNoconstant

cchTMx=float

cchTMn=float

For cchCM = PTC or PTC_CLO, the low temperature (max power) and high temperature (min power) setpoints. In subhours when the compressor does not run, crankcase heater input is cchPMx when oil temperature is at or below cchTMx, cchPMn when oil temp is at or above cchTMn, and varies linearly (proportionally) in between. cchTMn must be \(\ge\) cchTMx. See cchDT (next).

(Note that actual thermostat setpoints probably cannot be used for cchTMx and cchTMn inputs, because the model assumes the difference between the oil temperature and the outdoor temperature is constant (cchDT) regardless of the heater power.

UnitsLegal RangeDefaultRequiredVariability
oFcchTMn: 0; cchTMx: 150Noconstant

cchDT=float

For cchCM = PTC or PTC_CLO, how much warmer than the outdoor temp CSE assumes the crankcase oil to be in subhours when the compressor does not run. If the compressor runs at all in the subhour, the oil is assumed to be warmer than cchTMn.

UnitsLegal RangeDefaultRequiredVariability
oF20oFNoconstant

cchTOn=float

cchTOff=float

For cchCM = TSTAT, in subhours when compressor does not run, the crankcase heater turn-on and turn-off outdoor temperatures, respectively. Unequal values may be given to simulate thermostat differential. When the compressor runs at all in a subhour, the crankcase heater is off for the entire subhour.

UnitsLegal RangeDefaultRequiredVariability
oFcchTOff \(\ge\) cchTOncchTOn: 72oF; chcTOff: chcTOnNoconstant

cchMtr=name of a METER

METER to record crankcase heater energy use, category “Aux”; not recorded if not given.

UnitsLegal RangeDefaultRequiredVariability
name of a METERnot recordedNoconstant

endAirHandler

Indicates the end of the air handler definition. Alternatively, the end of the air handler definition can be indicated by the declaration of another object.

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

Related Probes:

4.45 HEATPLANT

A HEATPLANT contains one or more BOILER subobjects (Section 5.20.1) and supports one or more Hot Water (HW) coils in TERMINALs and/or AIRHANDLERs, and/or heat exchangers in HPLOOPs (HPLOOPs are not implemented as of September 1992.). There can be more than one HEATPLANT in a simulation.

BOILERs, HW coils, and heat exchangers are modeled with simple heat-injection models. There is no explicit modeling of circulating hot water temperatures and flows; it is always assumed the temperature and flow at each load (HW coil or heat exchanger) are sufficient to allow the load to transfer any desired amount of heat up to its capacity. When the total heat demand exceeds the plant’s capacity, the model reduces the capacity of each load until the plant is not overloaded. The reduced capacity is the same fraction of rated capacity for all loads on the HEATPLANT; any loads whose requested heat is less than the reduced capacity are unaffected.

The BOILERs in the HEATPLANT can be grouped into STAGES of increasing capacity. The HEATPLANT uses the first stage that can meet the load. The load is distributed among the BOILERs in the stage so that each operates at the same fraction of its rated capacity.

For each HEATPLANT, piping loss is modeled, as a constant fraction of the BOILER capacity of the heatPlant’s most powerful stage. This heat loss is added to the load whenever the plant is operating; as modeled, the heat loss is independent of load, weather, or any other variables.

heatplantName

Name of HEATPLANT object, given immediately after the word HEATPLANT. This name is used to refer to the heatPlant in tuhcHeatplant and ahhcHeatplant commands.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneYesconstant

hpSched=choice

Heat plant schedule: hourly variable choice of OFF, AVAIL, or ON.

OFFHEATPLANT will not supply hot water regardless of demand. All loads (HW coils and heat exchangers) should be scheduled off when the plant is off; an error will occur if a coil calls for heat when its plant is off.
AVAILHEATPLANT will operate when one or more loads demand heat.
ONHEATPLANT runs unconditionally. When no load wants heat, least powerful (first) stage runs.
UnitsLegal RangeDefaultRequiredVariability
OFF, AVAIL, or ONAVAILNohourly

hpPipeLossF=float

Heat plant pipe loss: heat assumed lost from piping connecting boilers to loads whenever the HEATPLANT is operating, expressed as a fraction of the boiler capacity of the plant’s most powerful stage.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 10.01Noconstant

hpStage1=boilerName, boilerName, boilerName, …

hpStage1=ALL_BUT, boilerName, boilerName, boilerName, …

hpStage2 through hpStage7 same

The commands hpStage1 through hpStage7 allow specification of up to seven STAGES in which BOILERs are activated as the load increases. Each stage may be specified with a list of up to seven names of BOILERs in the HEATPLANT, or with the word ALL, meaning all of the HEATPLANT’s BOILERs, or with the word ALL_BUT and a list of up to six names of BOILERs. Each stage should be more powerful than the preceding one. If you have less than seven stages, you may skip some of the commands hpStage1 through hpStage7 – the used stage numbers need not be contiguous.

If none of hpStage1 through hpStage7 are given, CSE supplies a single default stage containing all boilers.

A comma must be entered between boiler names and after the word ALL_BUT.

UnitsLegal RangeDefaultRequiredVariability
1 to 7 names;ALL_BUT and 1 to 6 names;ALLhpStage1 = ALLNoconstant

endHeatplant

Optionally indicates the end of the HEATPLANT definition. Alternatively, the end of the definition can be indicated by END or by beginning another object.

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

Related Probes:

4.46 BOILER

BOILERs are subObjects of HEATPLANTs (preceding Section 5.20). BOILERs supply heat, through their associated HEATPLANT, to HW coils and heat exchangers.

Each boiler has a pump. The pump operates whenever the boiler is in use; the pump generates heat in the water, which is added to the boiler’s output. The pump heat is independent of load – the model assumes a bypass valve keeps the water flow constant when the loads are using less than full flow – except that the heat is assumed never to exceed the load.

boilerName

Name of BOILER object, given immediately after the word BOILER. The name is used to refer to the boiler in heat plant stage commands.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneYesconstant

blrCap=float

Heat output capacity of this BOILER.

UnitsLegal RangeDefaultRequiredVariability
Btuhx \(\gt\) 0noneYesconstant

blrEffR=float

Boiler efficiency at steady-state full load, as a fraction. 1.0 may be specified to model a 100% efficient boiler.

UnitsLegal RangeDefaultRequiredVariability
0 \(\lt\) x \(\le\) 1.00.8Noconstant

blrEirR=float

Boiler Energy Input Ratio: alternate method of specifying efficiency.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 1.01/blrEffRNoconstant

blrPyEi=a, b, c, d

Coefficients of cubic polynomial function of part load ratio (load/capacity) to adjust full-load energy input for part load operation. Up to four floats may be given, separated by commas, lowest order (i.e. constant term) coefficient first. If the given coefficients result in a polynomial whose value is not 1.0 when the input variable, part load ratio, is 1.0, a warning message will be printed and the coefficients will be normalized to produce value 1.0 at input 1.0.

UnitsLegal RangeDefaultRequiredVariability
.082597, .996764, 0.79361, 0.Noconstant

blrMtr=name of a METER

Meter to which Boiler’s input energy is accumulated; if omitted, input energy is not recorded.

UnitsLegal RangeDefaultRequiredVariability
name of a METERnoneNoconstant

blrpGpm=float

Boiler pump flow in gallons per minute: amount of water pumped from this boiler through the hot water loop supplying the HEATPLANT’s loads (HW coils and heat exchangers) whenever boiler is operating.

UnitsLegal RangeDefaultRequiredVariability
gpmx \(\gt\) 0blrCap/10000Noconstant

blrpHdloss=float

Boiler pump head loss (pressure). 0 may be specified to eliminate pump heat and pump energy input.

UnitsLegal RangeDefaultRequiredVariability
ft H2Ox \(\ge\) 0114.45*Noconstant

* may be temporary value for 10-31-92 version; prior value of 35 may be restored.

blrpMotEff=float

Boiler pump motor efficiency.

UnitsLegal RangeDefaultRequiredVariability
0 \(\lt\) x \(\le\) 1.0.88Noconstant

blrpHydEff=float

Boiler pump hydraulic efficiency

UnitsLegal RangeDefaultRequiredVariability
0 \(\lt\) x \(\le\) 1.0.70Noconstant

blrpMtr=name of a METER

Meter to which pump electrical input energy is accumulated. If omitted, pump input energy use is not recorded.

UnitsLegal RangeDefaultRequiredVariability
name of a METERnoneNoconstant

The following four members permit specification of auxiliary input power use associated with the boiler under the conditions indicated.

blrAuxOn=floatAuxiliary power used when boiler is running, in proportion to its subhour average part load ratio (plr).
blrAuxOff=floatAuxiliary power used when boiler is not running, in proportion to 1 - plr.
blrAuxFullOff=floatAuxiliary power used only when boiler is off for entire subhour; not used if the boiler is on at all during the subhour.
blrAuxOnAtAll=floatAuxiliary power used in full value if boiler is on for any fraction of subhour.
UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 00Nohourly

The following four allow specification of meters to record boiler auxiliary energy use through blrAuxOn, blrAuxOff, blrFullOff, and blrAuxOnAtAll, respectively. End use category “Aux” is used.

blrAuxOn=float

Additional input energy used in proportion to part load ratio when coil on, as for induced draft fan, hourly variable for unforeseen applications.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 00.0Nohourly

blrAuxOnMtr=mtrName

Meter to which to charge auxOn.

UnitsLegal RangeDefaultRequiredVariability
name of a METERnot recordedNoconstant

blrAuxOff=float

Additional input energy when off for part or all of subhour.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 00.0Nohourly

blrAuxOffMtr=mtrName

Meter to which to charge auxOff.

UnitsLegal RangeDefaultRequiredVariability
name of a METERnot recordedNoconstant

blrAuxFullOff=float

Additional input energy when off for an entire subhour.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 00.0Nohourly

blrAuxFullOffMtr=mtrName

Meter to which to charge blrAuxFullOff.

UnitsLegal RangeDefaultRequiredVariability
name of a METERnot recordedNoconstant

blrAuxOnAtall=float

Additional input energy used in coil on for any part of subhour, for unforeseen uses.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 00.0Nohourly

blrAuxOnAtAllMtr=mtrName

MTR for “auxOnAtall”

UnitsLegal RangeDefaultRequiredVariability
name of a METERnot recordedNoconstant

endBoiler

Optionally indicates the end of the boiler definition. Alternatively, the end of the definition can be indicated by END or by beginning another object.

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

Related Probes:

4.47 COOLPLANT

A COOLPLANT contains one or more CHILLER subobjects (Section 5.21.1). Each COOLPLANT supports one or more CHilled Water (CHW) cooling coils in AIRHANDLERs, and is supported by a TOWERPLANT (Section 5.22). The piping circuit connecting the cold-water (evaporator) side of the CHILLERs to the CHW coils is referred to as the primary loop; the piping connecting the warm-water (condenser) side of the CHILLERs to the cooling towers in the TOWERPLANT is referred to as the secondary loop. Flows in these loops are established primary and secondary (or heat rejection) by pumps in each CHILLER; these pumps operate when the CHILLER operates.

The modeling of the CHW coils, COOLPLANTs, and CHILLERs includes modeling the supply temperature of the water in the primary loop, that is, the water supplied from the COOLPLANT’s operating CHILLER(s) to the CHW coils. If the (negative) heat demanded by the connected coils exceeds the plant’s capacity, the temperature rises and the available power is distributed among the AIRHANDLERs according to the operation of the CHW coil model.

The primary water flow through each CHILLER is always at least that CHILLER’s specified primary pump capacity – it is assumed that any flow in excess of that used by the coils goes through a bypass value. When the coils request more flow than the pump’s capacity, it is assumed the pressure drops and the pump can deliver the greater flow at the same power input and while imparting the same heat to the water. The primary water flow is not simulated during the run, but an error occurs before the run if the total design flow of the CHW coils connected to a COOLPLANT exceeds the pumping capacity of the CHILLERs in the plant’s most powerful stage.

The CHILLERs in the COOLPLANT can be grouped into STAGES of increasing capacity. The COOLPLANT uses the first stage that can meet the load. The load is distributed amoung the CHILLERs in the active stage so that each operates at the same fraction of its capacity; CHILLERs not in the active stage are turned off.

For each COOLPLANT, primary loop piping loss is modeled, as a heat gain equal to a constant fraction of the CHILLER capacity of the COOLPLANT’s most powerful stage. This heat gain is added to the load whenever the plant is operating; as modeled, the heat gain is independent of load, weather, which stage is operating, or any other variables. No secondary loop piping loss is modeled.

coolplantName

Name of COOLPLANT object, given immediately after the word COOLPLANT. This name is used to refer to the coolPlant in ahhcCoolplant commands.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneYesconstant

cpSched=choice

Coolplant schedule: hourly variable choice of OFF, AVAIL, or ON.

OFFCOOLPLANT will not supply chilled water regardless of demand. All loads (CHW coils) should be scheduled off when the plant is off; an error will occur if a coil calls for chilled water when its plant is off.
AVAILCOOLPLANT will operate when one or more loads demand chilled water.
ONCOOLPLANT runs unconditionally. When no load wants chilled water, least powerful (first) stage runs anyway.
UnitsLegal RangeDefaultRequiredVariability
OFF, AVAIL, or ONAVAILNohourly

cpTsSp=float

Coolplant primary loop supply temperature setpoint: setpoint temperature for chilled water supplied to coils.

UnitsLegal RangeDefaultRequiredVariability
oFx \(\gt\) 044Nohourly

cpPipeLossF=float

Coolplant pipe loss: heat assumed gained from primary loop piping connecting chillers to loads whenever the COOLPLANT is operating, expressed as a fraction of the chiller capacity of the plant’s most powerful stage.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 1.01Noconstant

cpTowerplant=name

TOWERPLANT that cools the condenser water for the chillers in this COOLPLANT.

UnitsLegal RangeDefaultRequiredVariability
name of a TOWERPLANTnoneYesconstant

cpStage1=chillerName, chillerName, chillerName, …

cpStage1=ALL_BUT, chillerName, chillerName, chillerName, …

cpStage2 through cpStage7 same

The commands cpStage1 through cpStage7 allow specification of up to seven STAGES in which chillers are activated as the load increases. CSE will use the first stage that can meet the load; if no stage will meet the load (output the heat requested by the coils at cpTsSp), the last COOLPLANT stage is used.

Each stage may be specified with a list of up to seven names of CHILLERs in the COOLPLANT, or with the word ALL, meaning all of the COOLPLANT’s CHILLERs, or with the word ALL_BUT and a list of up to six names of CHILLERs. Each stage should be more powerful than the preceding one. If you have less than seven stages, you may skip some of the commands cpStage1 through cpStage7 – the used stage numbers need not be contiguous.

If none of cpStage1 through cpStage7 are given, CSE supplies a single default stage containing all chillers.

A comma must be entered between chiller names and after the word ALL_BUT.

UnitsLegal RangeDefaultRequiredVariability
1 to 7 names; ALL_BUT and 1 to 6 names; ALLcpStage1 = ALLNoconstant

endCoolplant

Optionally indicates the end of the COOLPLANT definition. Alternatively, the end of the definition can be indicated by END or by beginning another object.

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

Related Probes:

4.48 CHILLER

CHILLERs are subobjects of COOLPLANTs (Section 5.21). CHILLERs supply coldness, in the form of chilled water, via their COOLPLANT, to CHW (CHilled Water) cooling coils in AIRHANDLERs. CHILLERs exhaust heat through the cooling towers in their COOLPLANT’s TOWERPLANT. Each COOLPLANT can contain multiple CHILLERs; chiller operation is controlled by the scheduling and staging logic of the COOLPLANT, as described in the previous section.

Each chiller has primary and secondary pumps that operate when the chiller is on. The pumps add heat to the primary and secondary loop water respectively; this heat is considered in the modeling of the loop’s water temperature.

chillerName

Name of CHILLER object, given immediately after the word CHILLER. This name is used to refer to the chiller in cpStage commands.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneYesconstant

The next four inputs allow specification of the CHILLER’s capacity (amount of heat it can remove from the primary loop water) and how this capacity varies with the supply (leaving) temperature of the primary loop water and the entering temperature of the condenser (secondary loop) water. The chiller capacity at any supply and condenser temperatures is chCapDs times the value of chPyCapT at those temperatures.

chCapDs=float

Chiller design capacity, that is, the capacity at chTsDs and chTcndDs (next).

UnitsLegal RangeDefaultRequiredVariability
Btuhx \(\neq\) 0noneYesconstant

chTsDs=float

Design supply temperature: temperature of primary water leaving chiller at which capacity is chCapDs.

UnitsLegal RangeDefaultRequiredVariability
oFx \(\gt\) 044Noconstant

chTcndDs=float

Design condenser temperature: temperature of secondary water entering chiller condenser at which capacity is chCapDs.

UnitsLegal RangeDefaultRequiredVariability
oFx \(\gt\) 085Noconstant

chPyCapT=a, b, c, d, e, f

Coefficients of bi-quadratic polynomial function of supply (ts) and condenser (tcnd) temperatures that specifies how capacity varies with these temperatures. This polynomial is of the form

\[a + b \cdot ts + c \cdot ts^2 + d \cdot tcnd + e \cdot tcnd^2 + f \cdot ts \cdot tcnd\]

Up to six float values may be entered, separated by commas; CSE will use zero for omitted trailing values. If the polynomial does not evaluate to 1.0 when ts is chTsDs and tcnd is chTcndDs, a warning message will be issued and the coefficients will be adjusted (normalized) to make the value 1.0.

UnitsLegal RangeDefaultRequiredVariability
-1.742040, .029292, .000067, .048054, .000291, -.000106Noconstant

The next three inputs allow specification of the CHILLER’s full-load energy input and how it varies with supply and condenser temperature. Only one of chCop and chEirDs should be given. The full-load energy input at any supply and condenser temperatures is the chiller’s capacity at these temperatures, times chEirDs (or 1/chCop), times the value of chPyEirT at these temperatures.

chCop=float

Chiller full-load COP (Coefficient Of Performance) at chTsDsand chTcndDs. This is the output energy divided by the electrical input energy (in the same units) and reflects both motor and compressor efficiency.

UnitsLegal RangeDefaultRequiredVariability
x \(\gt\) 04.2Noconstant

chEirDs=float

Alternate input for COP: Full-load Energy Input Ratio (electrical input energy divided by output energy) at design temperatures; the reciprocal of chCop.

UnitsLegal RangeDefaultRequiredVariability
x \(\gt\) 0chCop is defaultedNoconstant

chPyEirT=a, b, c, d, e, f

Coefficients of bi-quadratic polynomial function of supply (ts) and condenser (tcnd) temperatures that specifies how energy input varies with these temperatures. This polynomial is of the form

\[a + b \cdot ts + c \cdot ts^2 + d \cdot tcnd + e \cdot tcnd^2 + f \cdot ts \cdot tcnd\]

Up to six float values may be entered, separated by commas; CSE will use zero for omitted trailing values. If the polynomial does not evaluate to 1.0 when ts is chTsDs and tcnd is chTcndDs, a warning message will be issued and the coefficients will be adjusted (normalized) to make the value 1.0.

UnitsLegal RangeDefaultRequiredVariability
3.117600, -.109236, .001389, .003750, .000150, -.000375Noconstant

The next three inputs permit specification of the CHILLER’s part load energy input. In the following the part load ratio (plr) is defined as the actual load divided by the capacity at the current supply and condenser temperatures. The energy input is defined as follows for four different plr ranges:

fullloadplr (part load ratio) = 1.0
Power input is full-load input, as described above.
compressor unloading region1.0 > plr \(\ge\) chMinUnldPlr
Power input is the full-load input times the value of the chPyEirUl polynomial for the current plr, that is, chPyEirUl(plr).
false loading regionchMinUnldPlr > plr > chMinFsldPlr
Power input in this region is constant at the value for the low end of the compressor unloading region, i.e. chPyEirUl(chMinUnldPlr).
cycling regionchMinFsldPlr > plr \(\ge\) 0
In this region the chiller runs at the low end of the false loading region for the necessary fraction of the time, and the power input is the false loading value correspondingly prorated, i.e. chPyEirUl(chMinUnldPlr) plr / chMinFsldPlr.

These plr regions are similar to those for a DX coil & compressor in an AIRHANDLER, Section 0.

chPyEirUl=a, b, c, d

Coefficients of cubic polynomial function of part load ratio (plr) that specifies how energy input varies with plr in the compressor unloading region (see above). This polynomial is of the form

\[a + b \cdot plr + c \cdot plr^2 + d \cdot plr^3\]

Up to four float values may be entered, separated by commas; CSE will use zero for omitted trailing values. If the polynomial does not evaluate to 1.0 when plr is 1.0, a warning message will be issued and the coefficients will be adjusted (normalized) to make the value 1.0.

UnitsLegal RangeDefaultRequiredVariability
.222903, .313387, .463710, 0.Noconstant

chMinUnldPlr=float

Minimum compressor unloading part load ratio (plr); maximum false loading plr. See description above.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 10.1Noconstant

chMinFsldPlr=float

Minimum compressor false loading part load ratio (plr); maximum cycling plr. See description above.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) chMinFsldPlr0.1Noconstant

chMotEff=float

Fraction of CHILLER compressor motor input power which goes to the condenser. For an open-frame motor and compressor, where the motor’s waste heat goes to the air, enter the motor’s efficiency: a fraction around .8 or .9. For a hermetic compressor, where the motor’s waste heat goes to the refrigerant and thence to the condenser, use 1.0.

UnitsLegal RangeDefaultRequiredVariability
0 < x \(\le\) 11.0Noconstant

chMtr=name

Name of METER to which to accumulate CHILLER’s electrical input energy. Category “Clg” is used. Note that two additional commands, chppMtr and chcpMtr, are used to specify meters for recording chiller pump input energy.

UnitsLegal RangeDefaultRequiredVariability
name of a METERnot recordedNoconstant

The next six inputs specify this CHILLER’s PRIMARY PUMP, which pumps chilled water from the chiller through the CHW coils connected to the chiller’s COOLPLANT.

chppGpm=float

Chiller primary pump flow in gallons per minute: amount of water pumped from this chiller through the primary loop supplying the COOLPLANT’s loads (CHW coils) whenever chiller is operating. Any excess flow over that demanded by coils is assumed to go through a bypass valve. If coil flows exceed chppGpm, CSE assumes the pressure drops and the pump “overruns” to deliver the extra flow with the same energy input. The default is one gallon per minute for each 5000 Btuh of chiller design capacity.

UnitsLegal RangeDefaultRequiredVariability
gpmx \(\gt\) 0chCapDs / 5000Noconstant

chppHdloss=float

Chiller primary pump head loss (pressure). 0 may be specified to eliminate pump heat and pump energy input.

UnitsLegal RangeDefaultRequiredVariability
ft H2Ox \(\ge\) 057.22*Noconstant

* May be temporary default for 10-31-92 version; prior value (65) may be restored.

chppMotEff=float

Chiller primary pump motor efficiency.

UnitsLegal RangeDefaultRequiredVariability
0 < x \(\le\) 1.0.88Noconstant

chppHydEff=float

Chiller primary pump hydraulic efficiency

UnitsLegal RangeDefaultRequiredVariability
0 < x \(\le\) 1.00.7Noconstant

chppOvrunF=float

Chiller primary pump maximum overrun: factor by which flow demanded by coils can exceed chppGpm. The primary flow is not simulated in detail; chppOvrun is currently used only to issue an error message if the sum of the design flows of the coils connected to a COOLPLANT exceeds the sum of the products of chppGpm and chppOvrun for the chiller’s in the plants most powerful stage.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 1.01.3Noconstant

chppMtr=name of a METER

Meter to which primary pump electrical input energy is accumulated. If omitted, pump input energy use is not recorded.

UnitsLegal RangeDefaultRequiredVariability
name of a METERnoneNoconstant

The next five inputs specify this CHILLER’s CONDENSER PUMP, also known as the SECONDARY PUMP or the HEAT REJECTION PUMP. This pump pumps water from the chiller’s condenser through the cooling towers in the COOLPLANT’s TOWERPLANT.

chcpGpm=float

Chiller condenser pump flow in gallons per minute: amount of water pumped from this chiller through the cooling towers when chiller is operating.

UnitsLegal RangeDefaultRequiredVariability
gpmx \(\gt\) 0chCapDs / 4000Noconstant

chcpHdloss=float

Chiller condenser pump head loss (pressure). 0 may be specified to eliminate pump heat and pump energy input.

UnitsLegal RangeDefaultRequiredVariability
ft H2Ox \(\ge\) 045.78*Noconstant

* May be temporary default for 10-31-92 version; prior value (45) may be restored.

chcpMotEff=float

Chiller condenser pump motor efficiency.

UnitsLegal RangeDefaultRequiredVariability
0 < x \(\le\) 1.0.88Noconstant

chcpHydEff=float

Chiller condenser pump hydraulic efficiency

UnitsLegal RangeDefaultRequiredVariability
0 < x \(\le\) 1.00.7Noconstant

chcpMtr=name of a METER

Meter to which condenser pump electrical input energy is accumulated. If omitted, pump input energy use is not recorded.

UnitsLegal RangeDefaultRequiredVariability
name of a METERnoneNoconstant

The following four members permit specification of auxiliary input power use associated with the chiller under the conditions indicated.

chAuxOn=float

Auxiliary power used when chiller is running, in proportion to its subhour average part load ratio (plr).

chAuxOff=float

Auxiliary power used when chiller is not running, in proportion to 1 - plr.

chAuxFullOff=float

Auxiliary power used only when chiller is off for entire subhour; not used if the chiller is on at all during the subhour.

chAuxOnAtAll=float

Auxiliary power used in full value if chiller is on for any fraction of subhour.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 00Noconstant

The following four allow specification of meters to record chiller auxiliary energy use through chAuxOn, chAuxOff, chFullOff, and chAuxOnAtAll, respectively. End use category “Aux” is used.

chAuxOnMtr=mtrName

chAuxOffMtr=mtrName

chAuxFullOffMtr=mtrName

chAuxOnAtAllMtr=mtrName

UnitsLegal RangeDefaultRequiredVariability
name of a METERnoneNoconstant

endChiller

Optionally indicates the end of the CHILLER definition. Alternatively, the end of the definition can be indicated by END or by beginning another object.

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

Related Probes:

4.49 TOWERPLANT

A TOWERPLANT object simulates a group of cooling towers which operate together to cool water for one or more CHILLERs and/or HPLOOP heat exchangers. There can be more than one TOWERPLANT in a simulation. Each CHILLER or hploop heat exchanger contains a pump (the “heat rejection pump”) to circulate water through its associated TOWERPLANT. The circulating water is cooled by evaporation and conduction to the air; cooling is increased by operating fans in the cooling towers as necessary. These fans are the only energy consuming devices simulated in the TOWERPLANT.

The TOWERPLANT models the leaving water temperature as a function of the entering water temperature, flow, outdoor air temperature, and humidity. The fans are operated as necessary to achieve a specified leaving water temperature setpoint, or as close to it as achievable.

Two methods of staging the cooling tower fans in a TOWERPLANT are supported: “TOGETHER”, under which all the tower fans operate together, at the same speed or cycling on and off at once, and “LEAD”, in which a single “lead” tower’s fan modulates for fine control of leaving water temperature, and as many additional towers fans as necessary operate at fixed speed. The water flows through all towers even when their fans are off; sometimes this will cool the water below setpoint with no fans operating.

All the towers in a TOWERPLANT are identical, except that under LEAD staging, the towers other than the lead tower have one-speed fans. The group of towers can thus be described by giving the description of one tower, the number of towers, and the type of staging to be used. All of this information is given by TOWERPLANT members, so there is no need for individual TOWER objects.

There is no provision for scheduling a TOWERPLANT: it operates whenever the heat rejection pump in one or more of its associated CHILLERs or HPLOOP heat exchangers operates. However, the setpoint for the water leaving the TOWERPLANT is hourly schedulable.

towerplantName

Name of TOWERPLANT object, given immediately after the word TOWERPLANT to begin the object’s input. The name is used to refer to the TOWERPLANT in COOLPLANTs and HPLOOPs.

UnitsLegal RangeDefaultRequiredVariability
63 charactersYesconstant

tpTsSp=float

Setpoint temperature for water leaving towers.

UnitsLegal RangeDefaultRequiredVariability
oFx > 085Nohourly

tpMtr=name of a METER

METER object by which TOWERPLANT’s fan input energy is to be recorded, in category “Aux”. If omitted, energy use is not recorded, and thus cannot be reported. Towerplants have no modeled input energy other than for their fans (the heat rejection pumps are part of the CHILLER and HPLOOP objects).

UnitsLegal RangeDefaultRequiredVariability
name of a METERnoneNoconstant

tpStg=choice

How tower fans are staged to meet the load:

TOGETHERAll fans operate at the same speed or cycle on and off together.
LEADA single “Lead” tower’s fan is modulated as required and as many additional fans as necessary run at their (single) full speed.

Whenever the heat rejection pump in a CHILLER or HPLOOP heat exchanger is on, the water flows through all towers in the TOWERPLANT, regardless of the number of fans operating.

UnitsLegal RangeDefaultRequiredVariability
TOGETHER, LEADTOGETHERNoconstant

ctN=integer

Number of towers in the TOWERPLANT.

UnitsLegal RangeDefaultRequiredVariability
x > 01Noconstant

ctType=choice

Cooling tower fan control type: ONESPEED, TWOSPEED, or VARIABLE. This applies to all towers under TOGETHER staging. For LEAD staging, ctType applies only to the lead tower; additional towers have ONESPEED fans.

UnitsLegal RangeDefaultRequiredVariability
ONESPEED, TWOSPEED, VARIABLEONESPEEDNoconstant

ctLoSpd=float

Low speed for TWOSPEED fan, as a fraction of full speed cfm.

UnitsLegal RangeDefaultRequiredVariability
0 < x \(\le\) 10.5Noconstant

Note: full speed fan cfm is given by ctVfDs, below.

The rest of the input variables apply to each tower in the group; the towers are identical except for the single-speed fan on non-lead towers when tpStg is LEAD.

The following two inputs permit computation of the tower fan electrical energy consumption:

ctShaftBhp=float

Shaft brake horsepower of each tower fan motor.

The default value is the sum of the rejected (condenser) heats (including pump heat) at design conditions of the most powerful stage of each connected COOLPLANT, plus the design capacity of each connected HPLOOP heat exchanger, all divided by 290,000 and by the number of cooling towers in the TOWERPLANT.

UnitsLgl RangeDefaultReq’dVariability
Bhpx > 0(sum of loads)/290000/cTnNoconstant

ctMotEff=float

Motor (and drive, if any) efficiency for tower fans.

UnitsLegal RangeDefaultRequiredVariability
x > 0.88Noconstant

The next four items specify the coefficients of polynomial curves relating fan power consumption to average speed (cfm) for the various fan types. For the non-variable speed cases CSE uses linear polynomials of the form

\[p = a + b \cdot \text{spd}\]

where p is the power consumption as a fraction of full speed power consumption, and spd is the average speed as a fraction of full speed. The linear relationship reflects the fact that the fans cycle to match partial loads. A non-0 value may be given for the constant part a to reflect start-stop losses. For the two speed fan, separate polynomials are used for low and high speed operation; the default coefficients assume power input varies with the cube of speed, that is, at low speed (ctLoSpd) the relative power input is ctLoSpd3. For the variable speed case a cubic polynomial is used.

For each linear polynomial, two float expressions are given, separated by a comma. The first expression is the constant, a. The second expression is the coefficient of the average speed, b. Except for ctFcLo, a and b should add up to 1, to make the relative power consumption 1 when spd is 1; otherwise, CSE will issue a warning message and normalize them.

ctFcOne=a, b

Coefficients of linear fan power consumption polynomial \(p = a + b \cdot \text{spd}\) for ONESPEED fan. For the one-speed case, the relative average speed spd is the fraction of the time the fan is on.

UnitsLegal RangeDefaultRequiredVariability
a + b = 1.00, 1Noconstant

ctFcLo=a, b

Coefficients of linear fan power consumption polynomial \(p = a + b \cdot \text{spd}\) for low speed of TWOSPEED fan, when spd \(\le\) ctLoSpd.

UnitsLegal RangeDefaultRequiredVariability
a + b = 1.00, ctLoSpd2Noconstant

ctFcHi=a, b

Coefficients of linear fan power consumption polynomial \(p = a + b \cdot \text{spd}\) for high speed of TWOSPEED fan, when spd > ctLoSpd.

UnitsLegal RangeDefaultRequiredVariability
a + b = 1.0-ctLoSpd2 - ctLoSpd, ctLoSpd2 + ctLoSpd + 1Noconstant

ctFcVar=a, b, c, d

For VARIABLE speed fan, four float values for coefficients of cubic fan power consumption polynomial of the form \(p = a + b \cdot \text{spd} + c \cdot \text{spd}^2 + d \cdot \text{spd}^3\).

UnitsLegal RangeDefaultRequiredVariability
a + b + c + d = 1.00, 0, 0, 1Noconstant

The next six items specify the tower performance under one set of conditions, the “design conditions”. The conditions should be chosen to be representative of full load operating conditions.

ctCapDs=float

Design capacity: amount of heat extracted from water under design conditions by one tower.

The default value is the sum of the rejected (condenser) heats (including pump heat) at design conditions of the most powerful stage of each connected COOLPLANT, plus the design capacity of each connected HPLOOP heat exchanger, all divided by the number of towers.

UnitsLegal RangeDefaultRequiredVariability
Btuhx \(\neq\) 0(sum of loads)/ctNNoconstant

ctVfDs=float

Design air flow, per tower; also the fan full-speed cfm specification.

The default value is the sum of the loads (computed as for ctCapDs, just above) divided by 51, divided by the number of cooling towers.

UnitsLegal RangeDefaultRequiredVariability
cfmx > 0(sum of loads)/51/ctNNoconstant

ctGpmDs=float

Design water flow, per tower.

The default is the sum of the flows of the connected heat rejection pumps, using the largest stage for COOLPLANTs, divided by the number of towers.

UnitsLegal RangeDefaultRequiredVariability
gpmx > 0(sum of pumps)/ctNNoconstant

ctTDbODs=float

Design outdoor drybulb temperature (needed to convert ctVfDs from cfm to lb/hr).

UnitsLegal RangeDefaultRequiredVariability
oFx > 093.5Noconstant

ctTWbODs=float

Design outdoor wetbulb temperature.

UnitsLegal RangeDefaultRequiredVariability
oFx > 078Noconstant

ctTwoDs=float

Design leaving water temperature.

UnitsLegal RangeDefaultRequiredVariability
oFx > 085Noconstant

The following six items allow optional specification of tower performance under another set of conditions, the “off design” conditions. If given, they allow CSE to compute the tower’s relation between flows and heat transfer; in this case, ctK (below) may not be given.

ctCapOd=float

Off-design capacity, per tower.

UnitsLegal RangeDefaultRequiredVariability
Btuhx \(\neq\) 0(sum of loads)/ctNNoconstant

ctVfOd=float

Off-design air flow, per tower. Must differ from design air flow; thus ctVfDs and ctVfOd cannot both be defaulted if off-design conditions are being given. The off-design air and water flows must be chosen so that maOd/mwOd \(\neq\) maDs/mwDs.

UnitsLegal RangeDefaultRequiredVariability
cfmx > 0; x \(\neq\) ctVfDs(sum of loads)/51/ctNNoconstant

ctGpmOd=float

Off-design water flow, per tower. Must differ from design water flow; thus, both cannot be defaulted if off-design conditions are being given. Value must be chosen so that maOd/mwOd \(\neq\) maDs/mwDs.

UnitsLegal RangeDefaultRequiredVariability
gpmx > 0; x \(\neq\) ctGpmDs(sum of pumps)/ctNNoconstant

ctTDbOOd=float

Off-design outdoor drybulb temperature.

UnitsLegal RangeDefaultRequiredVariability
oFx > 093.5Noconstant

ctTWbOOd=float

Off-design outdoor wetbulb temperature.

UnitsLegal RangeDefaultRequiredVariability
oFx > 078Noconstant

ctTwoOd=float

Off-design leaving water temperature.

UnitsLegal RangeDefaultRequiredVariability
oFx > 085Noconstant

The following item allows explicit specification of the relationship between flows and heat transfer, when the preceding “off design” inputs are not given. If omitted, it will be computed from the “off design” inputs if given, else the default value of 0.4 will be used.

ctK=float

Optional. Exponent in the formula

\[\text{ntuA} = k \cdot (mwi/ma)^{ctK}\]

where ntuA is the number of transfer units on the air side, mwi and ma are the water and air flows respectively, and k is a constant.

UnitsLegal RangeDefaultRequiredVariability
0 < x < 1from “Od” members if given, else 0.4Noconstant

ctStkFlFr=float

Fraction of air flow which occurs when tower fan is off, due to stack effect (convection). Cooling due to this air flow occurs in all towers whenever the water flow is on, and may, by itself, cool the water below the setpoint tpTsSp. Additional flow, when fan is on, is proportional to fan speed.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 1.18Noconstant

The following items allow CSE to compute the effect of makeup water on the leaving water temperature.

ctBldn=float

Blowdown rate: fraction of inflowing water that is bled from the sump down the drain, to reduce the buildup of impurities that don’t evaporate.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 1.01Noconstant

ctDrft=float

Drift rate: fraction of inflowing water that is blown out of tower as droplets without evaporating.

UnitsLegal RangeDefaultRequiredVariability
0 \(\le\) x \(\le\) 10Noconstant

ctTWm=float

Temperature of makeup water from mains, used to replace water lost by blowdown, drift, and evaporation. Blowdown and drift are given by the preceding two inputs; evaporation is computed.

UnitsLegal RangeDefaultRequiredVariability
oFx > 060Noconstant

endTowerplant

Optionally indicates the end of the TOWERPLANT definition. Alternatively, the end of the definition can be indicated by END or by beginning another object.

UnitsLegal RangeDefaultRequiredVariability
N/ANoconstant

Related Probes:

4.50 REPORTFILE

REPORTFILE allows optional specification of different or additional files to receive CSE reports.

By default, CSE generates several “reports” on each run showing the simulated HVAC energy use, the input statements specifying the run, any error or warning messages, etc. Different or additional reports can be specified using the REPORT object, described in Section 5.25, next.

All CSE reports are written to text files as plain ASCII text. The files may be printed (on most printers other than postscript printers) by copying them to your printer with the COPY command. Since many built-in reports are over 80 characters wide; you may want to set your printer for “compressed” characters or a small font first. You may wish to examine the report file with a text editor or LIST program before printing it. (?? Improve printing discussion)

By default, the reports are output to a file with the same name as the input file and extension .REP, in the same directory as the input file. By default, this file is formatted into pages, and overwrites any existing file of the same name without warning. CSE automatically generates a REPORTFILE object called “Primary” for this report file, as though the following input had been given:

    REPORTFILE "Primary"
        rfFileName = <inputFile>.REP;
        // other members defaulted: rfFileStat=OVERWRITE; rfPageFmt=YES.

Using REPORTFILE, you can specify additional report files. REPORTs specified within a REPORTFILE object definition are output by default to that file; REPORTs specified elsewhere may be directed to a specific report file with the REPORT member rpReportFile. Any number of REPORTFILEs and REPORTs may be used in a run or session. Any number of REPORTs can be directed to each REPORTFILE.

Using ALTER (Section 4.5.1.2) with REPORTFILE, you can change the characteristics of the Primary report output file. For example:

    ALTER REPORTFILE Primary
        rfPageFmt = NO;     // do not format into pages
        rfFileStat = NEW;   // error if file exists

rfName

Name of REPORTFILE object, given immediately after the word REPORTFILE. Note that this name, not the fileName of the report file, is used to refer to the REPORTFILE in REPORTs.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneNoconstant

rfFileName=path

path name of file to be written. If no path is specified, the file is written in the current directory. The default extension is .REP.

UnitsLegal RangeDefaultRequiredVariability
file name, path and extension optionalnoneYesconstant

rfFileStat=choice

Choice indicating what CSE should do if the file specified by rfFileNamealready exists:

OVERWRITEOverwrite pre-existing file.
NEWIssue error message if file exists at beginning of session. If there are several runs in session using same file, output from runs after the first will append.
APPENDAppend new output to present contents of existing file.

If the specified file does not exist, it is created and rfFileStat has no effect.

UnitsLegal RangeDefaultRequiredVariability
OVERWRITE, NEW, APPENDOVERWRITENoconstant

rfPageFmt=Choice

Choice controlling page formatting. Page formatting consists of dividing the output into pages (with form feed characters), starting a new page before each report too long to fit on the current page, and putting headers and footers on each page. Page formatting makes attractive printed output but is a distraction when examining the output on the screen and may inappropriate if you are going to further process the output with another program.

YesDo page formatting in this report file.
NoSuppress page formatting. Output is continuous, uninterrupted by page headers and footers or large blank spaces.
UnitsLegal RangeDefaultRequiredVariability
YES, NONoNoconstant

Unless page formatting is suppressed, the page formats for all report files are controlled by the TOP members repHdrL, repHdrR, repLPP, repTopM, repBotM,and repCPL, described in Section 5.1.

Each page header shows the repHdrL and repHdrR text, if given.

Each page footer shows the input file name, run serial number within session (see runSerial in Section 5.1), user-input runTitle (see Section 5.1), date and time of run, and page number in file.

Vertical page layout is controlled by repLPP, repTopM, and repBotM (Section 5.1). The width of each header and footer is controlled by repCPL. Since many built-in reports are now over 80 columns wide, you may want to use repCPL=120 or repCPL=132 to make the headers and footers match the text better.

In addition to report file page headers and footers, individual REPORTs have REPORT headers and footers related to the report content. These are described under REPORT, Section 5.25.

endReportFile

Optionally indicates the end of the report file definition. Alternatively, the end of the report file definition can be indicated by END or by beginning another object.

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

Related Probes:

4.51 REPORT

REPORT generates a report object to specify output of specific textual information about the results of the run, the input data, the error messages, etc. The various report types available are enumerated in the description of rpType in this section, and may be described at greater length in Section 6.

REPORTs are output by CSE to files, via the REPORTFILE object (previous section). After CSE has completed, you may print the report file(s), examine them with a text editor or by TYPEing, process them with another program, etc., as desired.

REPORTs that you do not direct to a different file are written to the automatically-supplied “Primary” report file, whose file name is (by default) the input file name with the extension changed to .REP.

Each report consists of a report header, one or more data rows, and a report footer. The header gives the report type (as specified with rpType, described below), the frequency (as specified with rpFreq), the month or date where appropriate, and includes headings for the report’s columns where appropriate.

Usually a report has one data row for each interval being reported. For example, a daily report has a row for each day, with the day of the month shown in the first column.

The report footer usually contains a line showing totals for the rows in the report.

The header-data-footer sequence is repeated as necessary. For example, a daily report extending over more than one month has a header-data-footer sequence for each month. The header shows the month name; the data rows show the day of the month; the footer contains totals for the month.

In addition to the headers and footers of individual reports, the report file has (by default) page headers and footers, described in the preceding section.

Default Reports: CSE generates the following reports by default for each run, in the order shown. They are output by default to the “Primary” report file. They may be ALTERed or DELETEd as desired, using the object names shown.

rpNamerpTypeAdditional members
ErrERR
ebZEBrpFreq=MONTH; rpZone=SUM;
LogLOG
InpINP

Any reports specified by the user and not assigned to another file appear in the Primary report file between the default reports “eb” and “Log”, in the order in which the REPORT objects are given in the input file.

Because of the many types of reports supported, the members required for each REPORT depend on the report type and frequency in a complex manner. When in doubt, testing is helpful: try your proposed REPORT specification; if it is incomplete or overspecified, CSE will issue specific error messages telling you what additional members are required or what inappropriate members have been given and why.

rpName

Name of report. Give after the word REPORT.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneNoconstant

rpReportfile=rfname

Name of report file to which current report will be written. If omitted, if REPORT is within a REPORTFILE object, report will be written to that report file, or else to REPORTFILE “Primary”, which (as described in previous section) is automatically supplied and by default uses the file name of the input file with the extension .REP.

UnitsLegal RangeDefaultRequiredVariability
name of a REPORTFILEcurrent REPORTFILE, if any, else PrimaryNoconstant

rpType=choice

Choice indicating report type. Report types may be described at greater length, with examples, in Section 6.

ERRError and warning messages. If there are any such messages, they are also displayed on the screen AND written to a file with the same name as the input file and extension .ERR. Furthermore, * *many error messages are repeated in the INP report.
LOGRun ‘log’. As of July 1992, contains only CSE version number; should be enhanced or deleted.??
INPInput echo: shows the portion of the input file used to specify this run. Does not repeat descriptions of objects left from prior runs in the same session when CLEAR is not used. Error and warning messages relating to specific lines of the input are repeated after or near the line to which they relate, prefixed with ‘?’. Lines not used due to a preprocessor #if command (Section 4.4.4) with a false expression are prefixed with a ‘0’ in the leftmost column; all preprocessor command lines are prefixed with a ‘#’ in that column.
SUMRun summary. As of July 1992, NOT IMPLEMENTED: generates no output and no error message. Should be defined and implemented, or else deleted??.
ZDDZone data dump. Detailed dump of internal simulation values, useful for verifying that your input is as desired. Should be made less cryptic (July 1992)??. Requires rpZone.
ZSTZone statistics. Requires rpZone.
ZEBZone energy balance. Requires rpZone.
MTRMeter report. Requires rpMeter.
DHWMTRDHW meter report. Requires rpDHWMeter
AFMTRAir flow meter report. Requires rpAFMeter
UDTUser-defined table. Data items are specified with REPORTCOL commands (next section). Allows creating almost any desired report by using CSE expressions to specify numeric or string values to tabulate; ‘Probes’ may be used in the expressions to access CSE internal data.
UnitsLegal RangeDefaultRequiredVariability
see abovenoneYesconstant

The next three members specify how frequently values are reported and the start and end dates for the REPORT. They are not allowed with rpTypes ERR, LOG, INP, SUM, and ZDD, which involve no time-varying data.

rpFreq=choice

Report Frequency: specifies interval for generating rows of report data:

YEARat run completion
MONTHat end of each month (and at run completion if mid-month)
DAYat end of each day
HOURat end of each hour
HOURANDSUBat end of each subhour and at end of hour
SUBHOURat end of each subhour

rpFreq values of HOURANDSUB and SUBHOUR are not supported in some combinations with data selection of ALL or SUM.

We recommend using HOURly and more frequent reports sparingly, to report on only a few typical or extreme days, or to explore a problem once it is known what day(s) it occurs on. Specifying such reports for a full-year run will generate a huge amount of output and cause extremely slow CSE execution.

UnitsLegal RangeDefaultRequiredVariability
choices abovenoneper rpTypeconstant

rpDayBeg=date

Initial day of period to be reported. Reports for which rpFreq = YEAR do not allow specification of rpDayBeg and rpDayEnd; for MONTH reports, these members default to include all months in the run; for DAY and shorter-interval reports, rpDayBeg is required and rpDayEnd defaults to rpDayBeg.

UnitsLegal RangeDefaultRequiredVariability
datefirst day of simulation if rpFreq = MONTHRequired for rpTypes ZEB, ZST, MTR, AH, and UDT if rpFreq is DAY, HOUR, HOURANDSUB, or SUBHOURconstant

rpDayEnd=date

Final day of period to be reported, except for YEAR reports.

UnitsLegal RangeDefaultRequiredVariability
datelast day of simulation if rpFreq= MONTH, else rpDayBegNoconstant

rpZone=znName

Name of ZONE for which a ZEB, ZST, or ZDD report is being requested. For rpType ZEB or ZST, you may use rpZone=SUM to obtain a report showing only the sum of the data for all zones, or rpZone=ALL to obtain a report showing, for each time interval, a row of data for each zone plus a sum-of-zones row.

UnitsLegal RangeDefaultRequiredVariability
name of a ZONE, ALL, SUMnoneRequired for rpTypes ZDD, ZEB, and ZST.constant

rpMeter=mtrName

Specifies meter(s) to be reported, for rpType=MTR.

UnitsLegal RangeDefaultRequiredVariability
name of a METER, ALL, SUMnoneRequired for rpType=MTRconstant

rpDHWMeter=dhwMtrName

Specifies DHW meter(s) to be reported, for rpType=DHWMTR.

UnitsLegal RangeDefaultRequiredVariability
name of a DHWMETER, ALL, SUMnoneRequired for rpType=DHWMTRconstant

rpAFMeter=afMtrName

Specifies air flow meter(s) to be reported, for rpType=AFMTR.

UnitsLegal RangeDefaultRequiredVariability
name of a DHWMETER, ALL, SUMnoneRequired for rpType=AFMTRconstant

rpAh=ahName

Specifies air handler(s) to be reported, for rpType=AH, AHSIZE, or AHLOAD.

UnitsLegal RangeDefaultRequiredVariability
name of an AIRHANDLER, ALL, SUMnoneRequired for rpType=AH, AHSIZE, or AHLOADconstant

rpTu=tuName

Specifies air handler(s) to be reported, for rpType=TUSIZE or TULOAD.

UnitsLegal RangeDefaultRequiredVariability
name of a TERMINAL, ALL, SUMnoneRequired for rpTypeconstant

rpBtuSf=float

Scale factor to be used when reporting energy values. Internally, all energy values are represented in Btu. This member allows scaling to more convenient units for output. rpBtuSf is not shown in the output, so if you change it, be sure the readers of the report know the energy units being used. rpBtuSf is not applied in UDT reports, but column values can be scaled as needed with expressions.

UnitsLegal RangeDefaultRequiredVariability
any multiple of ten1,000,000: energy reported in MBtu.Noconstant

rpCond=expression

Conditional reporting flag. If given, report rows are printed only when value of expression is non-0. Permits selective reporting according to any condition that can be expressed as a CSE expression. Such conditional reporting can be used to shorten output and make it easy to find data of interest when you are only interested in the information under exceptional conditions, such as excessive zone temperature. Allowed with rpTypes ZEB, ZST, MTR, AH, and UDT.

UnitsLegal RangeDefaultRequiredVariability
any numeric expression1 (reporting enabled)Nosubhour end of interval

rpCPL=int

Characters per line for a UDT (user-defined report). If widths specified in REPORTCOLs add up to more than this, a message occurs; if they total substantially less, additional whitespace is inserted between columns to make the report more readable. If rpCPL = -1, the report width determined based on required space with a single space between columns. rpCPL=0 uses the Top level repCPL. rpCPL is not allowed if rpType is not UDT.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) -1-1 (as wide as needed)Noconstant

rpTitle=string

Title for use in report header of User-Defined report. Disallowed if rpType is not UDT.

UnitsLegal RangeDefaultRequiredVariability
User-defined ReportNoconstant

rpHeader=choice

Use NO to suppress the report header which gives the report type, zone, meter, or air handler being reported, time interval, column headings, etc. One reason to do this might be if you are putting only a single report in a report file and intend to later embed the report in a document or process it with some other program (but for the latter, see also EXPORT, below).

Use with caution, as the header contains much of the identification of the data. For example, in an hourly report, only the hour of the day is shown in each data row; the day and month are shown in the header, which is repeated for each 24 data rows.

See REPORTFILE member rfPageFmt, above, to control report FILE page headers and footers, as opposed to REPORT headers and footers.

UnitsLegal RangeDefaultRequiredVariability
YES, NOYESNoconstant

rpFooter=choice

Use NO to suppress the report footers. The report footer is usually a row which sums hourly data for the day, daily data for the month, or monthly data for the year. For a report with rpZone, rpMeter,or rpAh = ALL, the footer row shows sums for all zones, meters, or air handlers. Sometimes the footer is merely a blank line.

UnitsLegal RangeDefaultRequiredVariability
YES, NOYESNoconstant

endReport

Optionally indicates the end of the report definition. Alternatively, the end of the report definition can be indicated by END or by beginning another object.

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

Related Probes:

4.52 REPORTCOL

Each REPORTCOL defines a single column of a User Defined Table (UDT) report. REPORTCOLs are not used with report types other than UDT.

Use as many REPORTCOLs as there are values to be shown in each row of the user-defined report. The values will appear in columns, ordered from left to right in the order defined. Be sure to include any necessary values to identify the row, such as the day of month, hour of day, etc. CSE supplies NO columns automatically.

colName

Name of REPORTCOL.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneNoconstant

colReport=rpName

Name of report to which current report column belongs. If REPORTCOL is given within a REPORT object, then colReport defaults to that report.

UnitsLegal RangeDefaultRequiredVariability
name of a REPORTcurrent report, if anyUnless in a REPORTconstant

colVal=expression

Value to show in this column of report.

UnitsLegal RangeDefaultRequiredVariability
any numeric or string expressionnoneYessubhour /end interval

colHead=string

Text used for column head.

UnitsLegal RangeDefaultRequiredVariability
colName or blankNoconstant

colGap=int

Space between (to left of) column, in character positions. Allows you to space columns unequally, to emphasize relations among columns or to improve readability. If the total of the colGaps and colWids in the report’s REPORTCOLs is substantially less than the REPORT’s rpCPL (characters per line, see REPORT), CSE will insert additional spaces between columns. To suppress these spaces, use a smaller rpCPL or use rpCPL = -1.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 01Noconstant

colWid=int

Column width.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 010Noconstant

colDec=int

Number of digits after decimal point.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 0flexible formatNoconstant

colJust=choice

Specifies positioning of data within column:

LeftLeft justified
RightRight justified

endReportCol

Optionally indicates the end of the report column definition. Alternatively, the end of the report column definition can be indicated by END or by beginning another REPORTCOL or other object.

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

Related Probes:

4.53 EXPORTFILE

EXPORTFILE allows optional specification of different or additional files to receive CSE EXPORTs.

EXPORTs contain the same information as reports, but formatted for reading by other programs rather than by people. By default, CSE generates no exports. Exports are specified via the EXPORT object, described in Section 5.28 (next). As for REPORTs, CSE automatically supplies a primary export file; it has the same name and path as the input file, and extension .csv.

Input for EXPORTFILEs and EXPORTs is similar to that for REPORTFILEs and REPORTs, except that there is no page formatting. Refer to their preceding descriptions (Sections 5.24 and 5.25) for more additional discussion.

xfName

Name of EXPORTFILE object.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneNoconstant

xfFileName=string

path name of file to be written. If no path is specified, the file is written in the current directory. If no extension is specified, .csv is used.

UnitsLegal RangeDefaultRequiredVariability
file name, path and extension optionalnoneYesconstant

xfFileStat=choice

What CSE should do if file xfFileName already exists:

OVERWRITEOverwrite pre-existing file.
NEWIssue error message if file exists.
APPENDAppend new output to present contents of existing file.

If the specified file does not exist, it is created and xfFileStat has no effect.

UnitsLegal RangeDefaultRequiredVariability
OVERWRITE, NEW, APPENDOVERWRITENoconstant

endExportFile

Optionally indicates the end of the export file definition. Alternatively, the end of the Export file definition can be indicated by END or by beginning another object.

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

Related Probes:

4.54 EXPORT

Exports contain the same information as CSE reports, but in a “comma-quote” format intended for reading into a spreadsheet or other program for further processing, plotting, special print formatting, etc.

No exports are generated by default; each desired export must be specified with an EXPORT object.

Each row of an export contains several values, separated by commas, with quotes around string values. The row is terminated with a carriage return/line feed character pair. The first fields of the row identify the data. Multiple fields are used as necessary to identify the data. For example, the rows of an hourly ZEB export begin with the month, day of month, and hour of day. In contrast, reports, being subject to a width limitation, use only a single column of each row to identify the data; additional identification is put in the header. For example, an hourly ZEB Report shows the hour in a column and the day and month in the header; the header is repeated at the start of each day. The header of an export is never repeated.

Depending on your application, if you specify multiple exports, you may need to place each in a separate file. Generate these files with EXPORTFILE, preceding section. You may also need to suppress the export header and/or footer, with exHeader and/or exFooter, described in this section.

Input for EXPORTs is similar to input for REPORTs; refer to the REPORT description in Section 5.25 for further discussion of the members shown here.

exName

Name of export. Give after the word EXPORT.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneNoconstant

exExportfile=fname

Name of export file to which current export will be written. If omitted, if EXPORT is within an EXPORTFILE object, report will be written to that export file, or else to the automatically-supplied EXPORTFILE “Primary”, which by default uses the name of the input file with the extension .csv.

UnitsLegal RangeDefaultRequiredVariability
name of an EXPORTFILEcurrent EXPORTFILE, if any, else ‘Primary’Noconstant

exType=choice

Choice indicating export type. See descriptions in Section 5.22, REPORT. While not actually disallowed, use of exType = ERR, LOG, INP, or ZDD is unexpected.

UnitsLegal RangeDefaultRequiredVariability
ZEB, ZST, MTR, DHWMTR, AH, UDT, or SUMnoneYesconstant

exFreq=choice

Export Frequency: specifies interval for generating rows of export data:

UnitsLegal RangeDefaultRequiredVariability
YEAR, MONTH, DAY, HOUR, HOURANDSUB, SUBHOURnoneYesconstant

exDayBeg=date

Initial day of export. Exports for which exFreq = YEAR do not allow specification of exDayBeg and exDayEnd; for MONTH exports, these members are optional and default to include the entire run; for DAY and shorter-interval exports, exDayBeg is required and exDayEnd defaults to exDayBeg.

UnitsLegal RangeDefaultRequiredVariability
datefirst day of simulation if exFreq = MONTHRequired for exTypes ZEB, ZST, MTR, AH, and UDT if exFreq is DAY, HOUR, HOURANDSUB, or SUBHOURconstant

exDayEnd=date

Final day of export period, except for YEAR exports.

UnitsLegal RangeDefaultRequiredVariability
datelast day of simulation if exFreq= MONTH, else exDayBegNoconstant

exZone=znName

Name of ZONE for which a ZEB, ZST, or ZDD export is being requested; ALL and SUM are also allowed except with exType = ZST.

UnitsLegal RangeDefaultRequiredVariability
name of a ZONE, ALL, SUMnoneRequired for exTypes ZDD, ZEB, and ZST.constant

exMeter=mtrName

Specifies meter(s) whose data is to be exported, for exType=MTR.

UnitsLegal RangeDefaultRequiredVariability
name of a METER, ALL, SUMnonefor exType=MTRconstant

exTu=tuName

Specifies air handler(s) to be reported, for rpType=TUSIZE or TULOAD.

UnitsLegal RangeDefaultRequiredVariability
name of a TERMINAL, ALL, SUMRequired for rpTypeconstant

exDHWMeter=dhwMtrName

Specifies DHW meter(s) whose data is to be exported, for exType=DHWMTR.

UnitsLegal RangeDefaultRequiredVariability
name of a DHWMETER, ALL, SUMnonefor exType=DHWMTRconstant

exAFMeter=afMtrName

Air flow meter report.

UnitsLegal RangeDefaultRequiredVariability
Name of AFMETER0Norunly

exAh=ahName

Specifies air handler(s) to be exported, for exType=AH.

UnitsLegal RangeDefaultRequiredVariability
name of an AIRHANDLER, ALL, SUMnonefor exType=AHconstant

exBtuSf=float

Scale factor used for exported energy values.

UnitsLegal RangeDefaultRequiredVariability
any multiple of ten1,000,000: energy exported in MBtu.Noconstant

exCond=expression

Conditional exporting flag. If given, export rows are generated only when value of expression is non-0. Allowed with exTypes ZEB, ZST, MTR, AH, and UDT.

UnitsLegal RangeDefaultRequiredVariability
any numeric expression1 (exporting enabled)Nosubhour /end of interval

exTitle=string

Title for use in export header of User-Defined export. Disallowed if exType is not UDT.

UnitsLegal RangeDefaultRequiredVariability
User-defined ExportNoconstant

exHeader=choice

Use NO to suppress the export header which gives the export type, zone, meter, or air handler being exported, time interval, column headings, etc. You might do this if the export is to be subsequently imported to a program that is confused by the header information. Alternatively, one may use COLUMNSONLY to print only the column headings. This can be useful when plotting CSV data in a spreadsheet tool or DView.

The choices YESIFNEW and COLUMNSONLYIFNEW cause header generation when the associated EXPORTFILE is being created but suppress headers when appending to an existing file. This is useful for accumulating results from a set of runs where typically column headings are desired only once.

If not suppressed, the export header shows, in four lines:

runTitle and runSerial (see Section 5.1);the run date and time the export type (“Energy Balance”, “Statistics”, etc., or exTitle if given)and frequency (“year”, “day”, etc.)a list of field names in the order they will be shown in the data rows(“Mon”, “Day”, “Tair”, etc.)

The specific month, day, etc. is NOT shown in the export header (as it is shown in the report header), because it is shown in each export row.

The field names may be used by a program reading the export to identify the data in the rows which follow; if the program does this, it will not require modification when fields are added to or rearranged in the export in a future version of CSE.

UnitsLegal RangeDefaultRequiredVariability
YES, YESIFNEW, NO, COLUMNSONLY, COLUMNSONLYIFNEWYESNoconstant

exFooter=choice

Use NO to suppress the blank line otherwise output as an export “footer”. (Exports do not receive the total lines that most reports receive as footers.)

UnitsLegal RangeDefaultRequiredVariability
YES, NOYESNoconstant

endExport

Optionally indicates the end of the export definition. Alternatively, the end of the export definition can be indicated by END or by beginning another object.

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

Related Probes:

4.55 EXPORTCOL

Each EXPORTCOL defines a single datum of a User Defined Table (UDT) export; EXPORTCOLs are not used with other export types.

Use as many EXPORTCOLs as there are values to be shown in each row of the user-defined export. The values will appear in the order defined in each data row output. Be sure to include values needed to identify the data, such as the month, day, and hour, as appropriate – these are NOT automatically supplied in user-defined exports.

EXPORTCOL members are similar to the corresponding REPORTCOL members. See Section 5.265.1.5 for further discussion.

colName

Name of EXPORTCOL.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneNoconstant

colExport=exName

Name of export to which this column belongs. If the EXPORTCOL is given within an EXPORT object, then colExport defaults to that export.

UnitsLegal RangeDefaultRequiredVariability
name of an EXPORTcurrent export, if anyUnless in an EXPORTconstant

colVal=expression

Value to show in this position in each row of export.

UnitsLegal RangeDefaultRequiredVariability
any numeric or string expressionnoneYessubhour /end interval

colHead=string

Text used for field name in export header.

UnitsLegal RangeDefaultRequiredVariability
colName or blankNoconstant

colWid=int

Maximum width. Leading and trailing spaces and non-significant zeroes are removed from export data to save file space. Specifying a colWid less than the default may reduce the maximum number of significant digits output.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 013Noconstant

colDec=int

Number of digits after decimal point.

UnitsLegal RangeDefaultRequiredVariability
x \(\ge\) 0flexible formatNoconstant

colJust=choice

Specifies positioning of data within column:

LeftLeft justified
RightRight justified

endExportCol

Optionally indicates the end of the EXPORTCOL. Alternatively, the end of the definition can be indicated by END or by beginning another object.

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

Related Probes:

4.56 IMPORTFILE

IMPORTFILE allows specification of a file from which external data can be accessed using the import() and importStr() functions. This allows external values to be referenced in expressions. Any number of IMPORTFILEs can be defined and any number of import()/importStr() references can be made to a give IMPORTFILE.

Import files are text files containing an optional header and comma-separated data fields. With the header present, the structure of an import file matches that of an EXPORT file. This makes it convenient to import unmodified files EXPORTed from prior runs. The file structure is as follows (noting that the header in lines 1-4 should not be present when imHeader=NO) –

LineContentsNotes
1runTitle, runNumberread but not checked
2timestampin quotes, read but not checked
3title, freqshould match imTitle and imFreq (see below)
4colName1, colName2, …comma separated column names optionally in quotes
5 ..val1, val2, …comma separated values (string values optionally in quotes)

Example import file imp1.csv

    "Test run",001
    "Fri 04-Nov-16  10:54:37 am"
    "Daily Data","Day"
    Mon,Day,Tdb,Twb
    1,1,62.2263,53.2278
    1,2,61.3115,52.8527
    1,3,60.4496,52.4993
    1,4,60.2499,52.4174
    1,5,60.9919,52.7216
    1,6,61.295,52.8459
    1,7,62.3178,53.2654
    1,8,62.8282,53.4747
    (... continues for 365 data lines ...)

Example IMPORTFILE use (reading from imp1.csv)

    // ... various input statements ...

    IMPORTFILE Example imFileName="imp1.csv" imFreq=Day imTitle="Daily Data"
    ...
    // Compute internal gain based on temperature read from import file.
    // result is 3000 W per degree temperature is above 60.
    // Note gnPower can have hourly variability, but here varies daily.
    GAIN gnPower = 3000 * max( 0, import(Example,"Tdb") - 60) / 3.412
    ...

Notes

imName

Name of IMPORTFILE object (for reference from Import()).

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneNoconstant

imFileName=string

Gives path name of file to be read. If directory is specified, CSE first looks for the file the current directory and searches include paths specified by the -I command line parameter (if any).

UnitsLegal RangeDefaultRequiredVariability
file name, path optionalnoneYesconstant

imTitle=string

Title expected to be found on line 3 of the import file. A warning is issued if a non-blank imTitle does not match the import file title.

UnitsLegal RangeDefaultRequiredVariability
Text stringnoneNoconstant

imFreq=choice

Specifies the interval at which CSE reads from the import file. Data is read at the beginning of the indicated interval and buffered in memory for access in expressions via import() or importStr().

UnitsLegal RangeDefaultRequiredVariability
YEAR, MONTH, DAY, HOUR, or SUBHOURnoneYesconstant

imHeader=choice

Indicates whether the import file include a 4 line header, as described above. If NO, the import file should contain only comma-separated data rows and data items can be referenced only by 1-based column number.

UnitsLegal RangeDefaultRequiredVariability
YES NOYESNoconstant

imBinary=choice

Adds the possibility to output the file as a binary option.

UnitsLegal RangeDefaultRequiredVariability
YES NONoNoconstant

endImportFile

Optionally indicates the end of the import file definition. Alternatively, the end of the import file definition can be indicated by END or by beginning another object.

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

Related Probes:

5 Output Reports

CSE report data is accumulated during simulation and written to the report file at the end of the run. Some reports are generated by default and cannot be turned off. There are a set of predefined reports which may be requested in the input. The user may also define custom reports which include many CSE internal variables. Reports may accumulate data on an a variety of frequencies including subhourly, hourly, daily, monthly, and annual (run) intervals.

5.1 Units

The default units for CSE reports are:

EnergymBtu, millions of Btu (to convert to kWh divide by 292)
Temperaturedegrees Farenheit
Air Flowcfm (cubic feet per minute)

5.2 Time

Hourly reports show hour 1 through 24 where hour 1 includes the time period from midnight to 1 AM. By default, CSE specifies that January first is a Thursday and the simulation occurs on a non-leap year. Daylight savings is in effect from the second Sunday of March on which CSE skips hour 3 until the first Sunday of November when CSE simulates 25 hours. These calendar defaults can be modified as required.

5.3 METER Reports

A Meter Report displays the energy use of a METER object, a user-defined “device” that records energy consumption of equipment as simulated by CSE. CSE allows the user to define as many meters as desired and to assign any energy using device to any meter.

Meters account for energy use in pre-defined categories, called end uses, that are documented with METER.

5.4 Air Flow Meter Report

An Air Flow Meter Report displays air flow values accumulated by an AFMETER that is associated with one or more ZONEs. The report provides insight into the results of the AirNet pressure model.

AFMETER maintains values for subhour, hour, day, month, and year intervals. Values are standard cfm (0.075 lb/ft3). Values for intervals longer than subhour are averages.

Flows are categorized by 1) direction of flow (+ = into zone(s), - = out of zone(s)); IZXFER izAFCat tags; and 3) type of source or sink of the flow (ambient, unconditioned zone, conditioned zone).

The following items are displayed (using the abbreviations shown in the report headings). The “+/-” notation indicates that two columns are included, one for each direction of flow. For example, “InfX+/-” means the report includes columns “InfX+” (infiltration flows into the zone) and “InfX-” (infiltration flows out of the zone).

Tot+/-Total flows
Unkn+/-Uncategorized flows (generally this shows 0)
InfX+/-Infiltration flows from/to ambient (izAFCat = InfilEx)
VntX+/-Natural vent exchanges from/to ambient (izAFCat = VentEx)
FanX+/-Forced vent and DOAS flows to/from ambient (izAFCat = FanEx)
InfU+/-Infiltration flows from/to unconditioned zones (izAFCat = InfilIz)
VntU+/-Natural vent flows from/to unconditioned zones (izAFCat = VentIz)
FanU+/-Forced vent flows from/to unconditioned zones (izAFCat = FanIz)
InfC+/-Infiltration flows from/to conditioned zones (izAFCat = InfilIz)
VntC+/-Natural vent flows from/to conditioned zones (izAFCat = VentIz)
FanC+/-Forced vent flows from/to conditioned zones (izAFCat = FanIz)
Duct+/-Duct leakage flows
HVAC+/-HVAC air flows at zone (i.e. at registers)

5.5 Energy Balance Report

The Energy Balance Report displays the temperature and sensible and latent heat flows into and out of the air of a single zone. Sign conventions assume that a positive flow increases the air temperature. Heat flow from a warm mass element such as a concrete wall into the zone air is defined as a positive flow, heat flow from air into mass is negative. Solar gain into the zone is defined as a positive heat flow. Solar gain that is incident on and absorbed directly into a mass element is shown as both a positve in the SOLAR column (gain to the zone) and a negative in the MASS column (lost from the zone to the mass).

In a real building zone energy and moisture flows must balance due to the laws of physics. CSE uses approximate solutions for the energy and moisture balances and displays the net balance which is a measure of internal calculation error.

The following items are displayed (using the abbreviations shown in the report headings):

TairAir temperature in the zone (since CSE uses combined films this is technically the effective temperature and includes radiant effects).
WBairWet Bulb temperature in the zone.
CondHeat flow through light weight surfaces from or to the outdoors.
InfSSensible infiltration heat flow from outdoors.
SlrSolar gain through glazing (net) and solar gains absorbed by light surfaces and transmitted into the zone air.
IgnSSensible internal gains from lights, equipment, people, etc.
MassNet heat flow to (negative) and from (positive) the mass elements of the zone.
IzoneNet heat flows to other zones in the building.
MechSNet heat flows from heating, cooling and ventilation.
BALSThe balance (error) calculated by summing the sensible gains and losses.
InfLLatent infiltration heat flow.
IgnLLatent internal gains.
AirLLatent heat absorbed (negative) or released (positive) by changes in the room air moisture content.
MechLLatent heat added or removed by cooling or ventilation.
BalLThe balance (error) calculated by summing the sensible gains and losses.

5.6 Air Handler Load Report

The Air Handler Load Report displays conditions and loads at the peak load hours for the air handler for a single zone. The following items are displayed:

PkVfPeak flow (cfm) at supply fan
VfDsSupply fan design flow (same as peak for E10 systems)
PkQHPeak heat output from heating coil.
HcaptRated capacity of heat coil

The rest are about the cooling coil. Most of the columns are values at the time of peak part load ratio (plr). Note that, for example, the peak sensible load is the sensible load at the time of peak part load ratio, even if there was a higher sensible load at another time when the part load ratio was smaller.

PkMoMonth of cooling coil peak plr, 1-12
DyDay of month 1-31 of peak
HrHour of day 1-24 of cooling coil peak plr.
ToutOutdoor drybulb temperature at time of cooling coil peak plr.
WbouOutdoor wetbulb similarly
TenCooling coil entering air temperature at time of peak plr.
WbenEntering wetbulb similarly
TexExiting air temperature at plr peak
WbexExiting air wetbulb similarly
-PkQsSensible load at time of peak plr, shown positive.
-PkQlLatent load likewise
-PkQCTotal load – sum of PkQs and PkQl
CPlrPeak part load ratio: highest fraction of coil’s capacity used, reflecting both fraction of maximum output under current conditions used when on and fraction of the time the fan is on. The maximum output under actual conditions can vary considerably from the rated capacity for DX coils. The fraction of maximum output used can only be 1.0 if the sensible and total loads happen to occur in the same ratio as the sensible and total capacities. The time the fan is on can be less than 1.0 for residential systems in which the fan cycles on with the compressor. For example, if at the cooling peak the coil ran at .8 power with the fan on .9 of the time, a CPlr of .72 would be reported. The preceding 12 columns are values at the time this peak occured.
CcaptCooling coil rated total capacity
CcapsRated sensible capacity.

5.7 Air Handler Report

The Air Handler Load Report displays conditions and heat flows in the air handler for the time period specified. It is important to note that the air handler report only accumulates data if the air handler is on during an hour. The daily and monthly values are averages of the hours the air handler was on and DO NOT INCLUDE OFF HOUR VALUES. The following items are displayed:

ToutOutdoor drybulb temperature during hours the air handler was on.
WbouOutdoor wetbulb temperature similarly.
TretReturn air dry bulb temperature during hours the air handler was on before return duct losses or leaks.
WbreReturn air wetbulb similarly
poFraction outside air including economizer damper leakage, but not return duct leakage.
TmixMixed air dry bulb temperature – after return air combined with outside air; after return fan, but before supply fan and coil(s).
WbmiMixed air wet bulb temperature, similarly.
TsupSupply air dry bulb temperature to zone terminals – after coil(s) and air handler supply duct leak and loss; (without in zone duct losses after terminals).
WBsuSupply air wet bulb temperature similarly.
HrsOnHours during which the fan operated at least part of the time.
FOnFraction of the time the fan was on during the hours it operated (HrsOn). CHECK FOR VAV, IS IT FLOW OR TIME
VFVolumetric flow, measured at mix point/supply fan/coils; includes air that leaks out of supply duct and is thus non-0 even when zone terminals are taking no flow
QheatHeat energy added to air stream by heat coil, if any, MEASURED AT COIL not as delivered to zones (see Qload).
Qsens, Qlat and QcoolSensible, latent, and total heat added to air stream (negative values) by cooling coil, MEASURED AT COIL, including heat cancelled by fan heat and duct losses, and heat added to air lost through supply duct leak.
QoutNet heat taken from outdoor air. Sum of sensible and latent, measured RELATIVE TO CURRENT RETURN AIR CONDITIONS.
QfanHeat added to air stream by supply fan, plus return fan if any – but not relief fan..
QlossHeat added to air stream by supply and return duct leaks and conductive loss. Computed in each case as the sensible and latent heat in the air stream relative to return air conditions after the leak or loss, less the same value before the leak or loss.
QloadNet energy delivered to the terminals – Sensible and latent energy, measured relative to return air conditions. INCLUDES DUCT LOSSES after terminals; thus will differ from sum of zone qMech’s + qMecLat’s.
QbalSum of all the ‘Q’ columns, primarily a development aid. Zero indicates consistent and accurate computation; the normal printout is something like .0000, indicating that the value was too small to print in the space alloted, but not precisely zero, due to computational tolerances and internal round-off errors.

6 Probe Definitions

6.1 AFMETER

@AFMETER[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
Y[0].totalXXnumberend of run (of each phase, autoSize or simulate)
Y[0].unknownXXnumberend of run (of each phase, autoSize or simulate)
Y[0].infExXXnumberend of run (of each phase, autoSize or simulate)
Y[0].vntExXXnumberend of run (of each phase, autoSize or simulate)
Y[0].fanExXXnumberend of run (of each phase, autoSize or simulate)
Y[0].infUzXXnumberend of run (of each phase, autoSize or simulate)
Y[0].vntUzXXnumberend of run (of each phase, autoSize or simulate)
Y[0].fanUzXXnumberend of run (of each phase, autoSize or simulate)
Y[0].infCzXXnumberend of run (of each phase, autoSize or simulate)
Y[0].vntCzXXnumberend of run (of each phase, autoSize or simulate)
Y[0].fanCzXXnumberend of run (of each phase, autoSize or simulate)
Y[0].ductLkXXnumberend of run (of each phase, autoSize or simulate)
Y[0].hvacXXnumberend of run (of each phase, autoSize or simulate)
Y[1].totalXXnumberend of run (of each phase, autoSize or simulate)
Y[1].unknownXXnumberend of run (of each phase, autoSize or simulate)
Y[1].infExXXnumberend of run (of each phase, autoSize or simulate)
Y[1].vntExXXnumberend of run (of each phase, autoSize or simulate)
Y[1].fanExXXnumberend of run (of each phase, autoSize or simulate)
Y[1].infUzXXnumberend of run (of each phase, autoSize or simulate)
Y[1].vntUzXXnumberend of run (of each phase, autoSize or simulate)
Y[1].fanUzXXnumberend of run (of each phase, autoSize or simulate)
Y[1].infCzXXnumberend of run (of each phase, autoSize or simulate)
Y[1].vntCzXXnumberend of run (of each phase, autoSize or simulate)
Y[1].fanCzXXnumberend of run (of each phase, autoSize or simulate)
Y[1].ductLkXXnumberend of run (of each phase, autoSize or simulate)
Y[1].hvacXXnumberend of run (of each phase, autoSize or simulate)
M[0].totalXXnumberend of each month
M[0].unknownXXnumberend of each month
M[0].infExXXnumberend of each month
M[0].vntExXXnumberend of each month
M[0].fanExXXnumberend of each month
M[0].infUzXXnumberend of each month
M[0].vntUzXXnumberend of each month
M[0].fanUzXXnumberend of each month
M[0].infCzXXnumberend of each month
M[0].vntCzXXnumberend of each month
M[0].fanCzXXnumberend of each month
M[0].ductLkXXnumberend of each month
M[0].hvacXXnumberend of each month
M[1].totalXXnumberend of each month
M[1].unknownXXnumberend of each month
M[1].infExXXnumberend of each month
M[1].vntExXXnumberend of each month
M[1].fanExXXnumberend of each month
M[1].infUzXXnumberend of each month
M[1].vntUzXXnumberend of each month
M[1].fanUzXXnumberend of each month
M[1].infCzXXnumberend of each month
M[1].vntCzXXnumberend of each month
M[1].fanCzXXnumberend of each month
M[1].ductLkXXnumberend of each month
M[1].hvacXXnumberend of each month
D[0].totalXXnumberend of each day
D[0].unknownXXnumberend of each day
D[0].infExXXnumberend of each day
D[0].vntExXXnumberend of each day
D[0].fanExXXnumberend of each day
D[0].infUzXXnumberend of each day
D[0].vntUzXXnumberend of each day
D[0].fanUzXXnumberend of each day
D[0].infCzXXnumberend of each day
D[0].vntCzXXnumberend of each day
D[0].fanCzXXnumberend of each day
D[0].ductLkXXnumberend of each day
D[0].hvacXXnumberend of each day
D[1].totalXXnumberend of each day
D[1].unknownXXnumberend of each day
D[1].infExXXnumberend of each day
D[1].vntExXXnumberend of each day
D[1].fanExXXnumberend of each day
D[1].infUzXXnumberend of each day
D[1].vntUzXXnumberend of each day
D[1].fanUzXXnumberend of each day
D[1].infCzXXnumberend of each day
D[1].vntCzXXnumberend of each day
D[1].fanCzXXnumberend of each day
D[1].ductLkXXnumberend of each day
D[1].hvacXXnumberend of each day
H[0].totalXXnumberend of each hour
H[0].unknownXXnumberend of each hour
H[0].infExXXnumberend of each hour
H[0].vntExXXnumberend of each hour
H[0].fanExXXnumberend of each hour
H[0].infUzXXnumberend of each hour
H[0].vntUzXXnumberend of each hour
H[0].fanUzXXnumberend of each hour
H[0].infCzXXnumberend of each hour
H[0].vntCzXXnumberend of each hour
H[0].fanCzXXnumberend of each hour
H[0].ductLkXXnumberend of each hour
H[0].hvacXXnumberend of each hour
H[1].totalXXnumberend of each hour
H[1].unknownXXnumberend of each hour
H[1].infExXXnumberend of each hour
H[1].vntExXXnumberend of each hour
H[1].fanExXXnumberend of each hour
H[1].infUzXXnumberend of each hour
H[1].vntUzXXnumberend of each hour
H[1].fanUzXXnumberend of each hour
H[1].infCzXXnumberend of each hour
H[1].vntCzXXnumberend of each hour
H[1].fanCzXXnumberend of each hour
H[1].ductLkXXnumberend of each hour
H[1].hvacXXnumberend of each hour
S[0].totalXXnumberend of each subhour
S[0].unknownXXnumberend of each subhour
S[0].infExXXnumberend of each subhour
S[0].vntExXXnumberend of each subhour
S[0].fanExXXnumberend of each subhour
S[0].infUzXXnumberend of each subhour
S[0].vntUzXXnumberend of each subhour
S[0].fanUzXXnumberend of each subhour
S[0].infCzXXnumberend of each subhour
S[0].vntCzXXnumberend of each subhour
S[0].fanCzXXnumberend of each subhour
S[0].ductLkXXnumberend of each subhour
S[0].hvacXXnumberend of each subhour
S[1].totalXXnumberend of each subhour
S[1].unknownXXnumberend of each subhour
S[1].infExXXnumberend of each subhour
S[1].vntExXXnumberend of each subhour
S[1].fanExXXnumberend of each subhour
S[1].infUzXXnumberend of each subhour
S[1].vntUzXXnumberend of each subhour
S[1].fanUzXXnumberend of each subhour
S[1].infCzXXnumberend of each subhour
S[1].vntCzXXnumberend of each subhour
S[1].fanCzXXnumberend of each subhour
S[1].ductLkXXnumberend of each subhour
S[1].hvacXXnumberend of each subhour

6.2 ahRes

@ahRes[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXstringconstant
Y.tDbOXnumberend of run (of each phase, autoSize or simulate)
Y.wOXnumberend of run (of each phase, autoSize or simulate)
Y.trXnumberend of run (of each phase, autoSize or simulate)
Y.wrXnumberend of run (of each phase, autoSize or simulate)
Y.thxXnumberend of run (of each phase, autoSize or simulate)
Y.whxXnumberend of run (of each phase, autoSize or simulate)
Y.fhxXnumberend of run (of each phase, autoSize or simulate)
Y.tmixXnumberend of run (of each phase, autoSize or simulate)
Y.wmixXnumberend of run (of each phase, autoSize or simulate)
Y.tsXnumberend of run (of each phase, autoSize or simulate)
Y.wsXnumberend of run (of each phase, autoSize or simulate)
Y.poXnumberend of run (of each phase, autoSize or simulate)
Y.frFanOnXnumberend of run (of each phase, autoSize or simulate)
Y.vfXnumberend of run (of each phase, autoSize or simulate)
Y.qhXnumberend of run (of each phase, autoSize or simulate)
Y.qcXnumberend of run (of each phase, autoSize or simulate)
Y.qsXnumberend of run (of each phase, autoSize or simulate)
Y.qlXnumberend of run (of each phase, autoSize or simulate)
Y.qOXnumberend of run (of each phase, autoSize or simulate)
Y.qFanXnumberend of run (of each phase, autoSize or simulate)
Y.qLossXnumberend of run (of each phase, autoSize or simulate)
Y.qLoadXnumberend of run (of each phase, autoSize or simulate)
Y.qBalXnumberend of run (of each phase, autoSize or simulate)
Y.phXnumberend of run (of each phase, autoSize or simulate)
Y.pcXnumberend of run (of each phase, autoSize or simulate)
Y.pAuxHXnumberend of run (of each phase, autoSize or simulate)
Y.pAuxCXnumberend of run (of each phase, autoSize or simulate)
Y.pFanXnumberend of run (of each phase, autoSize or simulate)
Y.hrsOnXnumberend of run (of each phase, autoSize or simulate)
M.tDbOXnumberend of each month
M.wOXnumberend of each month
M.trXnumberend of each month
M.wrXnumberend of each month
M.thxXnumberend of each month
M.whxXnumberend of each month
M.fhxXnumberend of each month
M.tmixXnumberend of each month
M.wmixXnumberend of each month
M.tsXnumberend of each month
M.wsXnumberend of each month
M.poXnumberend of each month
M.frFanOnXnumberend of each month
M.vfXnumberend of each month
M.qhXnumberend of each month
M.qcXnumberend of each month
M.qsXnumberend of each month
M.qlXnumberend of each month
M.qOXnumberend of each month
M.qFanXnumberend of each month
M.qLossXnumberend of each month
M.qLoadXnumberend of each month
M.qBalXnumberend of each month
M.phXnumberend of each month
M.pcXnumberend of each month
M.pAuxHXnumberend of each month
M.pAuxCXnumberend of each month
M.pFanXnumberend of each month
M.hrsOnXnumberend of each month
D.tDbOXnumberend of each day
D.wOXnumberend of each day
D.trXnumberend of each day
D.wrXnumberend of each day
D.thxXnumberend of each day
D.whxXnumberend of each day
D.fhxXnumberend of each day
D.tmixXnumberend of each day
D.wmixXnumberend of each day
D.tsXnumberend of each day
D.wsXnumberend of each day
D.poXnumberend of each day
D.frFanOnXnumberend of each day
D.vfXnumberend of each day
D.qhXnumberend of each day
D.qcXnumberend of each day
D.qsXnumberend of each day
D.qlXnumberend of each day
D.qOXnumberend of each day
D.qFanXnumberend of each day
D.qLossXnumberend of each day
D.qLoadXnumberend of each day
D.qBalXnumberend of each day
D.phXnumberend of each day
D.pcXnumberend of each day
D.pAuxHXnumberend of each day
D.pAuxCXnumberend of each day
D.pFanXnumberend of each day
D.hrsOnXnumberend of each day
H.tDbOXnumberend of each hour
H.wOXnumberend of each hour
H.trXnumberend of each hour
H.wrXnumberend of each hour
H.thxXnumberend of each hour
H.whxXnumberend of each hour
H.fhxXnumberend of each hour
H.tmixXnumberend of each hour
H.wmixXnumberend of each hour
H.tsXnumberend of each hour
H.wsXnumberend of each hour
H.poXnumberend of each hour
H.frFanOnXnumberend of each hour
H.vfXnumberend of each hour
H.qhXnumberend of each hour
H.qcXnumberend of each hour
H.qsXnumberend of each hour
H.qlXnumberend of each hour
H.qOXnumberend of each hour
H.qFanXnumberend of each hour
H.qLossXnumberend of each hour
H.qLoadXnumberend of each hour
H.qBalXnumberend of each hour
H.phXnumberend of each hour
H.pcXnumberend of each hour
H.pAuxHXnumberend of each hour
H.pAuxCXnumberend of each hour
H.pFanXnumberend of each hour
H.hrsOnXnumberend of each hour
S.tDbOXnumberend of each subhour
S.wOXnumberend of each subhour
S.trXnumberend of each subhour
S.wrXnumberend of each subhour
S.thxXnumberend of each subhour
S.whxXnumberend of each subhour
S.fhxXnumberend of each subhour
S.tmixXnumberend of each subhour
S.wmixXnumberend of each subhour
S.tsXnumberend of each subhour
S.wsXnumberend of each subhour
S.poXnumberend of each subhour
S.frFanOnXnumberend of each subhour
S.vfXnumberend of each subhour
S.qhXnumberend of each subhour
S.qcXnumberend of each subhour
S.qsXnumberend of each subhour
S.qlXnumberend of each subhour
S.qOXnumberend of each subhour
S.qFanXnumberend of each subhour
S.qLossXnumberend of each subhour
S.qLoadXnumberend of each subhour
S.qBalXnumberend of each subhour
S.phXnumberend of each subhour
S.pcXnumberend of each subhour
S.pAuxHXnumberend of each subhour
S.pAuxCXnumberend of each subhour
S.pFanXnumberend of each subhour
S.hrsOnXnumberend of each subhour

6.3 airHandler

@airHandler[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
ahTsDsHXXnumberhourlyHeating design supply temperature, for sizing coil vs fan. defaulted hourly to ahtsmx.
ahTsDsCXXnumberhourlyCooling design supply temperature, for sizing coil vs fan. defaulted hourly to ahtsmn.
fxCapHXXnumberautosize and simulate phase start timeCapacity factor for autosized heat coils (default 1.1 = 10% oversized)
fxCapCXXnumberautosize and simulate phase start timeCapacity factor for autosized cool coils (default 1.1 = 10% oversized)
fxVfFanXXnumberautosize and simulate phase start timeVolume flow factor for autosized fan(s) (default 1.1 = 10% oversized)
asRfanXXinteger numberrun start time (of each phase, autoSize or simulate)True to autosize return/relief fan (to same capacity as supply fan)
asFlowXXinteger numberrun start time (of each phase, autoSize or simulate)True if autosizing supply fan and/or flow of any connected terminal:
hcAs.az_activeXXinteger numberrun start time (of each phase, autoSize or simulate)
hcAs.az_aXXnumberend of each subhour
hcAs.az_bXXnumberend of each subhour
hcAs.ldPkXXnumberend of each subhour
hcAs.ldPkAsXXnumberend of each day
hcAs.ldPkAs1XXnumberend of each day
hcAs.plrPkXXnumberend of each subhour
hcAs.plrPkAsXXnumberend of each day
hcAs.xPkXXnumberend of each subhour
hcAs.xPkAsXXnumberend of each day
hcAs.az_notDoneXXinteger numberend of each day
ccAs.az_activeXXinteger numberrun start time (of each phase, autoSize or simulate)
ccAs.az_aXXnumberend of each subhour
ccAs.az_bXXnumberend of each subhour
ccAs.ldPkXXnumberend of each subhour
ccAs.ldPkAsXXnumberend of each day
ccAs.ldPkAs1XXnumberend of each day
ccAs.plrPkXXnumberend of each subhour
ccAs.plrPkAsXXnumberend of each day
ccAs.xPkXXnumberend of each subhour
ccAs.xPkAsXXnumberend of each day
ccAs.az_notDoneXXinteger numberend of each day
fanAs.az_activeXXinteger numberrun start time (of each phase, autoSize or simulate)
fanAs.az_aXXnumberend of each subhour
fanAs.az_bXXnumberend of each subhour
fanAs.ldPkXXnumberend of each subhour
fanAs.ldPkAsXXnumberend of each day
fanAs.ldPkAs1XXnumberend of each day
fanAs.plrPkXXnumberend of each subhour
fanAs.plrPkAsXXnumberend of each day
fanAs.xPkXXnumberend of each subhour
fanAs.xPkAsXXnumberend of each day
fanAs.az_notDoneXXinteger numberend of each day
bVfDsXXnumberend of each subhourSfan.vfds. see coil::bcaptrat for ahhc and ahcc.
qcPkSXXnumberend of each subhourSensible load @ peak total load
qcPkLXXnumberend of each subhourLatent cool coil load ditto
qcPkHXXinteger numberend of each subhourHour 1-24 of peak total cool coil load
qcPkDXXinteger numberend of each subhourDay of month 1-31 of peak load, not used for autosizing
qcPkMXXinteger numberend of each subhourMonth 1-12 of peak load, or 0 for heat design month
qcPkTDbOXXnumberend of each subhourOutdoor temp at time of peak load
qcPkWOXXnumberend of each subhourOutdoor hum rat at time of peak load. w’s must follow t’s for reports.
qcPkTenXXnumberend of each subhourEntering air temp
qcPkWenXXnumberend of each subhourHum rat
qcPkTexXXnumberend of each subhourExiting air temp (b4 remix w bypass air)
qcPkWexXXnumberend of each subhourHum rat (b4 remix w bypass air)
qcPkSAsXXnumberend of each subhourSensible load @ peak total load
qcPkLAsXXnumberend of each subhourLatent cool coil load ditto
qcPkHAsXXinteger numberend of each subhourHour 1-24 of peak total cool coil load
qcPkDAsXXinteger numberend of each subhourDay of month 1-31 of peak load, not used for autosizing
qcPkMAsXXinteger numberend of each subhourMonth 1-12 of peak load, or 0 for heat design month
qcPkTDbOAsXXnumberend of each subhourOutdoor temp at time of peak load
qcPkWOAsXXnumberend of each subhourOutdoor hum rat at time of peak load. w’s must follow t’s for reports.
qcPkTenAsXXnumberend of each subhourEntering air temp
qcPkWenAsXXnumberend of each subhourHum rat
qcPkTexAsXXnumberend of each subhourExiting air temp (b4 remix w bypass air)
qcPkWexAsXXnumberend of each subhourHum rat (b4 remix w bypass air)
ahTsSpXXunrecognizedhourlySupply temperature setpoint or control method: ra, wz, cz, zn, zn2, or number, hourly,
ahFanCyclesXXunrecognizedhourlyYes if fan (and coil) cycles with zone thermostat; hourly;
ahTsMnXXnumberhourlyHourly, default 40.
ahTsMxXXnumberhourlyHourly, default 250.
ahTsRaMnXXnumberhourlyReturn air temp at which tssp is at ahtsmx. hourly.
ahTsRaMxXXnumberhourly.. ahtsmn. hourly. if return air moves outside this range, tssp does not change further.
ahCtuXXinteger numberrun start time (of each phase, autoSize or simulate)Terminal for determining whether to heat or cool under zn, zn2 tsu sp control.
ahWzCzns[0]XXinteger numberautosize and simulate phase start timeZone names monitored for warmest zone and coolest zone ts sp control, respectively.
ahWzCzns[1]XXinteger numberautosize and simulate phase start timeZone names monitored for warmest zone and coolest zone ts sp control, respectively.
ahWzCzns[2]XXinteger numberautosize and simulate phase start timeZone names monitored for warmest zone and coolest zone ts sp control, respectively.
ahWzCzns[3]XXinteger numberautosize and simulate phase start timeZone names monitored for warmest zone and coolest zone ts sp control, respectively.
ahWzCzns[4]XXinteger numberautosize and simulate phase start timeZone names monitored for warmest zone and coolest zone ts sp control, respectively.
ahWzCzns[5]XXinteger numberautosize and simulate phase start timeZone names monitored for warmest zone and coolest zone ts sp control, respectively.
ahWzCzns[6]XXinteger numberautosize and simulate phase start timeZone names monitored for warmest zone and coolest zone ts sp control, respectively.
ahWzCzns[7]XXinteger numberautosize and simulate phase start timeZone names monitored for warmest zone and coolest zone ts sp control, respectively.
ahWzCzns[8]XXinteger numberautosize and simulate phase start timeZone names monitored for warmest zone and coolest zone ts sp control, respectively.
ahWzCzns[9]XXinteger numberautosize and simulate phase start timeZone names monitored for warmest zone and coolest zone ts sp control, respectively.
ahWzCzns[10]XXinteger numberautosize and simulate phase start timeZone names monitored for warmest zone and coolest zone ts sp control, respectively.
ahWzCzns[11]XXinteger numberautosize and simulate phase start timeZone names monitored for warmest zone and coolest zone ts sp control, respectively.
ahWzCzns[12]XXinteger numberautosize and simulate phase start timeZone names monitored for warmest zone and coolest zone ts sp control, respectively.
ahWzCzns[13]XXinteger numberautosize and simulate phase start timeZone names monitored for warmest zone and coolest zone ts sp control, respectively.
ahWzCzns[14]XXinteger numberautosize and simulate phase start timeZone names monitored for warmest zone and coolest zone ts sp control, respectively.
ahWzCzns[15]XXinteger numberautosize and simulate phase start timeZone names monitored for warmest zone and coolest zone ts sp control, respectively.
ahCzCzns[0]XXinteger numberautosize and simulate phase start timeEach input may be all, all_but, and/or zone names, comma-separated. default all.
ahCzCzns[1]XXinteger numberautosize and simulate phase start timeEach input may be all, all_but, and/or zone names, comma-separated. default all.
ahCzCzns[2]XXinteger numberautosize and simulate phase start timeEach input may be all, all_but, and/or zone names, comma-separated. default all.
ahCzCzns[3]XXinteger numberautosize and simulate phase start timeEach input may be all, all_but, and/or zone names, comma-separated. default all.
ahCzCzns[4]XXinteger numberautosize and simulate phase start timeEach input may be all, all_but, and/or zone names, comma-separated. default all.
ahCzCzns[5]XXinteger numberautosize and simulate phase start timeEach input may be all, all_but, and/or zone names, comma-separated. default all.
ahCzCzns[6]XXinteger numberautosize and simulate phase start timeEach input may be all, all_but, and/or zone names, comma-separated. default all.
ahCzCzns[7]XXinteger numberautosize and simulate phase start timeEach input may be all, all_but, and/or zone names, comma-separated. default all.
ahCzCzns[8]XXinteger numberautosize and simulate phase start timeEach input may be all, all_but, and/or zone names, comma-separated. default all.
ahCzCzns[9]XXinteger numberautosize and simulate phase start timeEach input may be all, all_but, and/or zone names, comma-separated. default all.
ahCzCzns[10]XXinteger numberautosize and simulate phase start timeEach input may be all, all_but, and/or zone names, comma-separated. default all.
ahCzCzns[11]XXinteger numberautosize and simulate phase start timeEach input may be all, all_but, and/or zone names, comma-separated. default all.
ahCzCzns[12]XXinteger numberautosize and simulate phase start timeEach input may be all, all_but, and/or zone names, comma-separated. default all.
ahCzCzns[13]XXinteger numberautosize and simulate phase start timeEach input may be all, all_but, and/or zone names, comma-separated. default all.
ahCzCzns[14]XXinteger numberautosize and simulate phase start timeEach input may be all, all_but, and/or zone names, comma-separated. default all.
ahCzCzns[15]XXinteger numberautosize and simulate phase start timeEach input may be all, all_but, and/or zone names, comma-separated. default all.
oaMnCmXXunrecognizedautosize and simulate phase start timeMin oa flow control method, choice of vol or frac, default vol, constant.
oaMnFracXXnumberhourlyFraction 0-1 of minimum oa to use now, hourly, default 1.0. eg to shut off oa during warmup.
oaVfDsMnXXnumberrun start time (of each phase, autoSize or simulate)Design minimum outside air flow (cfm actual air), constant, dfl .15 * area.
oaEcoTyXXunrecognizedautosize and simulate phase start timeChoice of none, nonintegrated, two_stage, integrated. constant. default none.
oaLimTXXunrecognizedhourlyEconomizer oa temp hi limit: number -50 to 999, or ra for current return air temp,
oaLimEXXunrecognizedhourlyEconomizer oa enthalpy hi limit: number or ra, constant, dfl 999 (enth limit disabled).
oaOaLeakXXnumberautosize and simulate phase start timeOutside air damper leakage to mixed air, fraction of supply fan design cfm if have economizer,
oaRaLeakXXnumberautosize and simulate phase start timeReturn air damper leakage to mixed air, fraction supply fan design cfm,
oaZoneLeakFXXnumberhourlyAssumed zone leakage fraction; for zone airnet only
oaHx.VfDsXXnumberrun start time (of each phase, autoSize or simulate)
oaHx.f2XXnumberrun start time (of each phase, autoSize or simulate)
oaHx.senEffH[0]XXnumberrun start time (of each phase, autoSize or simulate)
oaHx.senEffH[1]XXnumberrun start time (of each phase, autoSize or simulate)
oaHx.latEffH[0]XXnumberrun start time (of each phase, autoSize or simulate)
oaHx.latEffH[1]XXnumberrun start time (of each phase, autoSize or simulate)
oaHx.senEffC[0]XXnumberrun start time (of each phase, autoSize or simulate)
oaHx.senEffC[1]XXnumberrun start time (of each phase, autoSize or simulate)
oaHx.latEffC[0]XXnumberrun start time (of each phase, autoSize or simulate)
oaHx.latEffC[1]XXnumberrun start time (of each phase, autoSize or simulate)
oaHx.bypassXXinteger numberrun start time (of each phase, autoSize or simulate)
oaHx.auxPwrXXnumbersubhourly
oaHx.auxMtriXXinteger numberrun start time (of each phase, autoSize or simulate)Meter for auxiliary energy
oaHx.supInAF.tdbXXnumberend of each subhour
oaHx.supInAF.wXXnumberend of each subhour
oaHx.supInAF.amfXXnumberend of each subhour
oaHx.hxInAF.tdbXXnumberend of each subhour
oaHx.hxInAF.wXXnumberend of each subhour
oaHx.hxInAF.amfXXnumberend of each subhour
oaHx.hxOutAF.tdbXXnumberend of each subhour
oaHx.hxOutAF.wXXnumberend of each subhour
oaHx.hxOutAF.amfXXnumberend of each subhour
oaHx.bypassAF.tdbXXnumberend of each subhour
oaHx.bypassAF.wXXnumberend of each subhour
oaHx.bypassAF.amfXXnumberend of each subhour
oaHx.exhInAF.tdbXXnumberend of each subhour
oaHx.exhInAF.wXXnumberend of each subhour
oaHx.exhInAF.amfXXnumberend of each subhour
oaHx.supOutAF.tdbXXnumberend of each subhour
oaHx.supOutAF.wXXnumberend of each subhour
oaHx.supOutAF.amfXXnumberend of each subhour
oaHx.bypassFracXXnumberend of each subhour
oaHx.tSetXXnumberend of each subhour
oaHx.sensEffXXnumberend of each subhour
oaHx.latEffXXnumberend of each subhour
ahSOLeakXXnumberautosize and simulate phase start timeSupply duct leakage to outdoors, 0-.1 of sfanvfds, default .01. use 0 if duct indoors.
ahROLeakXXnumberautosize and simulate phase start timeReturn duct leakage from outdoors, 0-.1, of sfanvfds, default .01, use 0 if duct indoors.
ahSOLossXXnumberautosize and simulate phase start timeSupply duct loss/gain to outdoors, 0-.1, default .02? (taylor 0.5f), use 0 if duct indoors.
ahROLossXXnumberautosize and simulate phase start timeReturn duct heat loss/gain to outdoors, 0-.1, default .02? (ditto), use 0 if duct indoors.
ahSchXXunrecognizedhourlySupply fan and thus air handler schedule: choice of on or off, hourly variable; default on.
sfan.fanTyXXunrecognizedautosize and simulate phase start time
sfan.vfDsXXnumberend of each subhour
sfan.vfDs_AsXXnumberautosize and simulate phase start time
sfan.vfDs_AsNovXXnumberautosize and simulate phase start time
sfan.vfMxFXXnumberautosize and simulate phase start time
sfan.pressXXnumberrun start time (of each phase, autoSize or simulate)
sfan.effXXnumberrun start time (of each phase, autoSize or simulate)
sfan.shaftPwrXXnumberrun start time (of each phase, autoSize or simulate)
sfan.elecPwrXXnumberrun start time (of each phase, autoSize or simulate)
sfan.motTyXXunrecognizedrun start time (of each phase, autoSize or simulate)
sfan.motEffXXnumberautosize and simulate phase start time
sfan.motPosXXunrecognizedautosize and simulate phase start time
sfan.curvePy.k[0]XXnumberautosize and simulate phase start time
sfan.curvePy.k[1]XXnumberautosize and simulate phase start time
sfan.curvePy.k[2]XXnumberautosize and simulate phase start time
sfan.curvePy.k[3]XXnumberautosize and simulate phase start time
sfan.curvePy.k[4]XXnumberautosize and simulate phase start time
sfan.curvePy.k[5]XXnumberautosize and simulate phase start time
sfan.mtriXXinteger numberautosize and simulate phase start time
sfan.endUseXXinteger numberautosize and simulate phase start time
sfan.auszXXinteger numberrun start time (of each phase, autoSize or simulate)
sfan.outPowerXXnumbersubhourly
sfan.airPowerXXnumbersubhourly
sfan.cMxXXnumberend of each subhour
sfan.cXXnumberend of each subhour
sfan.tXXnumberend of each subhour
sfan.frOnXXnumberend of each subhour
sfan.pXXnumberend of each subhour
sfan.qXXnumberend of each subhourAverage (not fan-on) output power level for subhour
sfan.dTXXnumberend of each subhourHow much warmer than outdoor temp crankcase oil is assumed to be, in subhrs when compr does not run.
sfan.qAroundXXnumberend of each subhour
rfan.fanTyXXunrecognizedautosize and simulate phase start time
rfan.vfDsXXnumberend of each subhour
rfan.vfDs_AsXXnumberautosize and simulate phase start time
rfan.vfDs_AsNovXXnumberautosize and simulate phase start time
rfan.vfMxFXXnumberautosize and simulate phase start time
rfan.pressXXnumberrun start time (of each phase, autoSize or simulate)
rfan.effXXnumberrun start time (of each phase, autoSize or simulate)
rfan.shaftPwrXXnumberrun start time (of each phase, autoSize or simulate)
rfan.elecPwrXXnumberrun start time (of each phase, autoSize or simulate)
rfan.motTyXXunrecognizedrun start time (of each phase, autoSize or simulate)
rfan.motEffXXnumberautosize and simulate phase start time
rfan.motPosXXunrecognizedautosize and simulate phase start time
rfan.curvePy.k[0]XXnumberautosize and simulate phase start time
rfan.curvePy.k[1]XXnumberautosize and simulate phase start time
rfan.curvePy.k[2]XXnumberautosize and simulate phase start time
rfan.curvePy.k[3]XXnumberautosize and simulate phase start time
rfan.curvePy.k[4]XXnumberautosize and simulate phase start time
rfan.curvePy.k[5]XXnumberautosize and simulate phase start time
rfan.mtriXXinteger numberautosize and simulate phase start time
rfan.endUseXXinteger numberautosize and simulate phase start time
rfan.auszXXinteger numberrun start time (of each phase, autoSize or simulate)
rfan.outPowerXXnumbersubhourly
rfan.airPowerXXnumbersubhourly
rfan.cMxXXnumberend of each subhour
rfan.cXXnumberend of each subhour
rfan.tXXnumberend of each subhour
rfan.frOnXXnumberend of each subhour
rfan.pXXnumberend of each subhour
rfan.qXXnumberend of each subhourAverage (not fan-on) output power level for subhour
rfan.dTXXnumberend of each subhourHow much warmer than outdoor temp crankcase oil is assumed to be, in subhrs when compr does not run.
rfan.qAroundXXnumberend of each subhour
cch.cchCMXXunrecognizedrun start time (of each phase, autoSize or simulate)Crankcase heater presence and control method choice. niles cchctlmtd.
cch.pMxXXnumberautosize and simulate phase start timeCrankcase resistance heater input power; maximum power if cchcm is ptc or ptc_clo.
cch.pMnXXnumberautosize and simulate phase start timeMin cch input power. default .04kw. entered in kw, internally in btuh. niles pcchmn.
cch.tMxXXnumberautosize and simulate phase start timeLow temp (max power) setpoint… default 0 f. niles tcchptcmx.
cch.tMnXXnumberautosize and simulate phase start timeHigh temp (min power) setpoint for cchcm = ptc or ptc_clo. default 150 f. niles tcchptcmn.
cch.dtXXnumberautosize and simulate phase start timeHow much warmer than outdoor temp crankcase oil is assumed to be, in subhrs when compr does not run.
cch.tOnXXnumberautosize and simulate phase start time
cch.tOffXXnumberrun start time (of each phase, autoSize or simulate)
cch.mtriXXinteger numberautosize and simulate phase start time
cch.p47OffXXnumberrun start time (of each phase, autoSize or simulate)Power input during off part of one cycle of ari 47 degree cycling test, kwh.
cch.p17XXnumberrun start time (of each phase, autoSize or simulate)Power input to crankcase heater in ari 17 degree continuous operation test, kw. niles pcch17.
cch.p47XXnumberrun start time (of each phase, autoSize or simulate)Ditto 47 degree test. niles pcch47. p17 and p47 always the same; p47 may be used in code as
cch.frCprOnXXnumberend of each subhour
cch.tStateXXinteger numberend of each subhourThermostat state for cchcm = tstat: must remember to implement hysteresis
cch.pXXnumberend of each subhour
ahhc.coilTyXXunrecognizedrun start time (of each phase, autoSize or simulate)Coil type choice according to application, as follows. constant.
ahhc.schedXXunrecognizedhourlyAvail when coil available, off when disabled, hourly, default avail.
ahhc.captRatXXnumberend of each subhour
ahhc.captRat_AsXXnumberautosize and simulate phase start time
ahhc.captRat_AsNovXXnumberautosize and simulate phase start time
ahhc.bCaptRatXXnumberend of each subhourStart-subhr captrat, to undo size increases not in use as converged at end subhr (ahhc,ahcc).
ahhc.eirRatXXnumberhourlyRated load energy input ratio===heat input ratio===input/output===1/efficiency for dx,gas,oil at least.
ahhc.mtriXXinteger numberautosize and simulate phase start time
ahhc.auxXXnumberhourlyAdditional input energy used by auxiliary controls and devices.
ahhc.auxMtriXXinteger numberautosize and simulate phase start timeMeter for auxiliary energy
ahhc.qXXnumberend of each subhourAverage (not fan-on) output power level for subhour
ahhc.qPrXXnumberend of each subhourOutput at which coil’s plant last computed, for call-flagging plant. set: cnhp.cpp. used: cncoil.cpp
ahhc.pXXnumberend of each subhour
ahhc.plrXXnumberend of each subhourCurrent fan-on (or furnace-on) relative load (part load ratio)
ahhc.plrAvXXnumberend of each subhourCurrent average relative load (plr * frfanon)
ahhc.eirXXnumberend of each subhourEnergy input ratio: current input/output, fan on===average. rob’s addition, for probes, 5-92.
ahhc.capMaxXXnumberend of each subhourMaximum capacity this subhour, used to calculate tpossh/c.
ahhc.pAuxXXnumberend of each subhourAux power this subhour
ahhc.effRatXXnumberautosize and simulate phase start timeEfficiency @ rated load: alternate eir input, converted into eirrat in setup.
ahhc.pyEi.k[0]XXnumberautosize and simulate phase start time
ahhc.pyEi.k[1]XXnumberautosize and simulate phase start time
ahhc.pyEi.k[2]XXnumberautosize and simulate phase start time
ahhc.pyEi.k[3]XXnumberautosize and simulate phase start time
ahhc.pyEi.k[4]XXnumberautosize and simulate phase start time
ahhc.stackEffectXXnumberhourlyFraction of unused capacity that must be used (increasing plr) to make up for increased
ahhc.hpiXXinteger numberautosize and simulate phase start timeSubscript of heatplant serving hw coil
ahhc.nxTu4hpXXinteger numberrun start time (of each phase, autoSize or simulate)Tub subscr of next tu with hw coil on same heatplant. 1st is heatplant.tu1.
ahhc.nxAh4hpXXinteger numberrun start time (of each phase, autoSize or simulate)Ahb subscr of next ah with hw coil on same heatplant. 1st is heatplant.ah1.
ahhc.flueLossXXnumberend of each subhourPart-load flue loss this subhour, gas and oil only
ahhc.qWantXXnumberend of each subhourHw: desired output===input, dohwcoil to hpcompute, used in determining capf.
ahhc.cap17XXnumberautosize and simulate phase start timeAri steady state rated cap @ 17 out, 70 indoor (return) air, btuh, rqd for ahp, niles pcapss17.
ahhc.capRat1747XXnumberrun start time (of each phase, autoSize or simulate)Cap17 / cap47 ratio (re autosizing)
ahhc.capRat9547XXnumberrun start time (of each phase, autoSize or simulate)Total net cap95 (cooling) / net cap47 (heating)
ahhc.cap35XXnumberrun start time (of each phase, autoSize or simulate)Ari steady state rated cap @ 35f outdoor, btuh, default per fd35df, niles pcapss35.
ahhc.fd35DfXXnumberautosize and simulate phase start timeDefault frost/defrost degradation factor at 35 f, default .85, niles fdf35dft.
ahhc.capIaXXnumberautosize and simulate phase start timeCapacity correction factor for indoor (return) air temperature, default .004, niles iaccap.
ahhc.capSupHeatXXnumberautosize and simulate phase start timeOutput of supplemental coil, btu/h.
ahhc.effSupHeatXXnumberhourlySupplemental heat efficiency
ahhc.supHeatMtriXXinteger numberautosize and simulate phase start timeMeter for supplemental heat energy use
ahhc.tFrMnXXnumberautosize and simulate phase start timeLowest temp for frost buildup & defrost effects, default 17f, niles tfrstmn.
ahhc.tFrMxXXnumberautosize and simulate phase start timeHighest temp for frost buildup & defrost effects, default 47f, niles tfrstmx.
ahhc.tFrPkXXnumberautosize and simulate phase start timeTemp for peak frost buildup & defrost effects, default 42f, niles tfrstpk.
ahhc.dfrFMnXXnumberautosize and simulate phase start timeMin frac time in reverse cycle cooling, default .0222 (2/90 min), niles tmfrcdefmn.
ahhc.dfrFMxXXnumberautosize and simulate phase start timeMax frac time in reverse cycle cooling, default .0889 (8/90 min), niles tmfrcdefmx.
ahhc.dfrCapXXnumberrun start time (of each phase, autoSize or simulate)Cooling capacity (to ah supply air) during defrosting, default 2 * cap17, niles pdefcool.
ahhc.tOffXXnumberautosize and simulate phase start time
ahhc.tOnXXnumberautosize and simulate phase start time
ahhc.COP17XXnumberautosize and simulate phase start timeCop input @ 17 outdoor, 70 indoor (return). rqd for ahp. niles pinss17.
ahhc.COP47XXnumberautosize and simulate phase start timeCop input @ 47 outdoor, 70 indoor (return). rqd for ahp. niles pinss47.
ahhc.inIaXXnumberautosize and simulate phase start timeIndoor (return) air temp power input correction factor, default .004, niles iacin.
ahhc.cdXXnumberautosize and simulate phase start timeAri cycling degradation coefficient, default .25, niles cd.
ahhc.in17XXnumberrun start time (of each phase, autoSize or simulate)Steady state power @ 17 outdoor, 70 indoor (return). rqd for ahp. niles pinss17.
ahhc.in47XXnumberrun start time (of each phase, autoSize or simulate)Steady state power @ 47 outdoor, 70 indoor (return). rqd for ahp. niles pinss47.
ahhc.in17cXXnumberrun start time (of each phase, autoSize or simulate)Compressor input power @ 17 degrees out, 70 in: in17 with cch power removed. niles pinss17.
ahhc.in47cXXnumberrun start time (of each phase, autoSize or simulate)Ditto 47 degrees. niles pinss47.
ahhc.cdmXXnumberrun start time (of each phase, autoSize or simulate)Modified cd: cycling degradation coefficient adjusted to remove cch. niles cdm.
ahhc.tIaXXnumberend of each subhourIndoor air temp: copy of tmix or whatever ah variable is chosen
ahhc.qSupLimXXnumberend of each subhourCaller-set heat output limit for when suppl heat in use: kludge when fan cycling
ahhc.frFanOnXXnumberend of each subhour
ahhc.loTLockoutXXinteger numberend of each subhourTrue if compressor locked out due to low outdoor temp (see toff, ton)
ahhc.supOnXXinteger numberend of each subhourTrue if supplementary heat enabled (frfanon is ~1.0, with hysterisis to keep ah stable).
ahhc.capConXXnumberend of each subhourContinuous cpr capac incl frost/defrost @ actual indoor temp, excl def & reg rh. niles pcapmx.
ahhc.qDfrhConXXnumberend of each subhourContinuous avg heat ouput to defrost heater @ outdoor temp (not cycling). niles pdefrhmx.
ahhc.frCprOnXXnumberend of each subhour
ahhc.pCprXXnumberend of each subhourPower input to compressor (niles pincomp): copy to .p in coilsendsubhr.
ahhc.qShXXnumberend of each subhourOutput of reg (not defrost) supplemental heaters. included in q of coil.
ahhc.pShXXnumberend of each subhourInput of reg & dfr supplemental resistance heaters.
ahccBypassXXnumberautosize and simulate phase start timeFraction of air flow which bypasses cool coil (for better humidity control), constant, dfl 0.
ahcc.coilTyXXunrecognizedrun start time (of each phase, autoSize or simulate)Coil type choice according to application, as follows. constant.
ahcc.schedXXunrecognizedhourlyAvail when coil available, off when disabled, hourly, default avail.
ahcc.captRatXXnumberend of each subhour
ahcc.captRat_AsXXnumberautosize and simulate phase start time
ahcc.captRat_AsNovXXnumberautosize and simulate phase start time
ahcc.bCaptRatXXnumberend of each subhourStart-subhr captrat, to undo size increases not in use as converged at end subhr (ahhc,ahcc).
ahcc.eirRatXXnumberhourlyRated load energy input ratio===heat input ratio===input/output===1/efficiency for dx,gas,oil at least.
ahcc.mtriXXinteger numberautosize and simulate phase start time
ahcc.auxXXnumberhourlyAdditional input energy used by auxiliary controls and devices.
ahcc.auxMtriXXinteger numberautosize and simulate phase start timeMeter for auxiliary energy
ahcc.qXXnumberend of each subhourAverage (not fan-on) output power level for subhour
ahcc.qPrXXnumberend of each subhourOutput at which coil’s plant last computed, for call-flagging plant. set: cnhp.cpp. used: cncoil.cpp
ahcc.pXXnumberend of each subhour
ahcc.plrXXnumberend of each subhourCurrent fan-on (or furnace-on) relative load (part load ratio)
ahcc.plrAvXXnumberend of each subhourCurrent average relative load (plr * frfanon)
ahcc.eirXXnumberend of each subhourEnergy input ratio: current input/output, fan on===average. rob’s addition, for probes, 5-92.
ahcc.capMaxXXnumberend of each subhourMaximum capacity this subhour, used to calculate tpossh/c.
ahcc.pAuxXXnumberend of each subhourAux power this subhour
ahcc.capsRatXXnumberend of each subhourDx: sensible rated capacity <= captrat btu/hr, const for input, *s cuz varies during autosize.
ahcc.capsRat_AsXXnumberautosize and simulate phase start time
ahcc.capsRat_AsNovXXnumberautosize and simulate phase start time
ahcc.SHRRatXXnumberautosize and simulate phase start timeSensible heat ratio (caps/capt) for cooling coil
ahcc.minTEvapXXnumberautosize and simulate phase start timeDx: min evaporator (effective surface) temp (below which compressor cuts out), default 35f. (40f til 8-95)
ahcc.k1XXnumberautosize and simulate phase start timeDx, chw: power of relative air flow to which outside number of transfer units is proportional.
ahcc.dsTDbCndXXnumberautosize and simulate phase start timeDesign (rating) (dx) condenser temp (outdoor temp pending water option), default = ari = 95f.
ahcc.dsTDbEnXXnumberautosize and simulate phase start timeDesign (rating) (dx,chw) entering air dry bulb temp, default = ari = 80f.
ahcc.dsTWbEnXXnumberautosize and simulate phase start timeDesign (rating) (dx) entering air wet bulb temp, default = ari = 67f. replaces taylor’s dseawb.
ahcc.vfRXXnumberrun start time (of each phase, autoSize or simulate)Rating (dx,chw) air flow (cfm). default: dx: per vfrperton. chw: sfan.vfds.
ahcc.vfRperTonXXnumberrun start time (of each phase, autoSize or simulate)Dx default vfr per ton (12000 btuh) of captrat. default: 400.
ahcc.minUnldPlrXXnumberautosize and simulate phase start timePart load ratio (fraction of full load) at/above which “compressor unloading” is used. dfl 1.
ahcc.minFsldPlrXXnumberautosize and simulate phase start timePlr above which “false loading” is used (up to minunldplr). dfl minunldplr: no false loading.
ahcc.pydxCaptT.k[0]XXnumberautosize and simulate phase start time
ahcc.pydxCaptT.k[1]XXnumberautosize and simulate phase start time
ahcc.pydxCaptT.k[2]XXnumberautosize and simulate phase start time
ahcc.pydxCaptT.k[3]XXnumberautosize and simulate phase start time
ahcc.pydxCaptT.k[4]XXnumberautosize and simulate phase start time
ahcc.pydxCaptT.k[5]XXnumberautosize and simulate phase start time
ahcc.pydxCaptT.k[6]XXnumberautosize and simulate phase start time
ahcc.pydxCaptF.k[0]XXnumberautosize and simulate phase start time
ahcc.pydxCaptF.k[1]XXnumberautosize and simulate phase start time
ahcc.pydxCaptF.k[2]XXnumberautosize and simulate phase start time
ahcc.pydxCaptF.k[3]XXnumberautosize and simulate phase start time
ahcc.pydxCaptF.k[4]XXnumberautosize and simulate phase start time
ahcc.pydxCaptFLimXXnumberautosize and simulate phase start timeUpper limit for value of pydxcaptf, 8-28-95
ahcc.pydxEirT.k[0]XXnumberautosize and simulate phase start time
ahcc.pydxEirT.k[1]XXnumberautosize and simulate phase start time
ahcc.pydxEirT.k[2]XXnumberautosize and simulate phase start time
ahcc.pydxEirT.k[3]XXnumberautosize and simulate phase start time
ahcc.pydxEirT.k[4]XXnumberautosize and simulate phase start time
ahcc.pydxEirT.k[5]XXnumberautosize and simulate phase start time
ahcc.pydxEirT.k[6]XXnumberautosize and simulate phase start time
ahcc.pydxEirUl.k[0]XXnumberautosize and simulate phase start time
ahcc.pydxEirUl.k[1]XXnumberautosize and simulate phase start time
ahcc.pydxEirUl.k[2]XXnumberautosize and simulate phase start time
ahcc.pydxEirUl.k[3]XXnumberautosize and simulate phase start time
ahcc.pydxEirUl.k[4]XXnumberautosize and simulate phase start time
ahcc.cpiXXinteger numberautosize and simulate phase start timeSubscript of coolplant serving chw coil, rqd for chw.
ahcc.gpmDsXXnumberautosize and simulate phase start timeDesign (i.e. maximum) chilled water flow, gpm, rqd for chw. niles mwd[g].
ahcc.ntuoDsXXnumberautosize and simulate phase start timeOutside number of transfer units at design air flow (vfr), default 2. niles ntuod.
ahcc.ntuiDsXXnumberautosize and simulate phase start timeInside number of transfer units at design water flow (gpmds), default 2. niles ntuid.
ahcc.wsatMinTEvapXXnumberrun start time (of each phase, autoSize or simulate)Hum ratio of saturated air at mintevap (minimum evaporator temp)
ahcc.hsatMinTEvapXXnumberrun start time (of each phase, autoSize or simulate)Enthalpy of saturated air at mintevap
ahcc.efecORXXnumberrun start time (of each phase, autoSize or simulate)(outside) effectiveness at rated conditions (in record for probing only)
ahcc.ntuRXXnumberrun start time (of each phase, autoSize or simulate)Number of trasfer units (like time constants) at rated conditions
ahcc.eirMinUnldPlrXXnumberrun start time (of each phase, autoSize or simulate)Pydxeirul(minunldplr): precomputed dx input correction for falseloading; prorate for cycling.
ahcc.menRXXnumberrun start time (of each phase, autoSize or simulate)Chw/dx coil rating air flow (lb/hr) (for chw, niles ‘mad’)
ahcc.nxAh4cpXXinteger numberrun start time (of each phase, autoSize or simulate)0 or subscr of next ah with chw coil served by same coolplant. 1st is coolplant.ah1.
ahcc.mwDsXXnumberrun start time (of each phase, autoSize or simulate)
ahcc.wantQflagXXinteger numberend of each subhourNz if cooling desired (texwant < ten) regardless of sched, etc. docoils–>cpestimate.
ahcc.tewdXXnumberend of each subhour
ahcc.chwQXXnumberend of each subhour
ahcc.trXXnumberend of each subhour
ahcc.cpTsPrXXnumberend of each subhourCp ts for which coil last computed, re compute-flagging coil from plant
ahcc.trPrXXnumberend of each subhourCoil tr at last coil compute, re call-flagging cp from coil model
ahcc.fullLoadWetXXinteger numberend of each subhourTrue if chw coil wet @ full load,
ahcc.frCprOnXXnumberend of each subhour
ahcc.tWbEnXXnumberend of each subhour
ahcc.henXXnumberend of each subhour
ahcc.tDbCndXXnumberend of each subhour
ahcc.efecOXXnumberend of each subhour
ahcc.captXXnumberend of each subhour
ahcc.capsXXnumberend of each subhour
ahcc.plrVfXXnumberend of each subhour
ahcc.plrSensXXnumberend of each subhour
ahcc.qsXXnumberend of each subhour
ahcc.qlXXnumberend of each subhour
ahcc.xLGainXXnumberend of each subhourCondensation heat added to air (const enthalpy) to fix supersaturated wen, this subhr.
ahcc.xLGainYrXXnumberend of each subhour.. cumulative over run, for message at end run.
ahcc.minTLtdXXinteger numberend of each subhourOutput limited by mintevap b4 reaching ahtsmn (dx, 7-95)
ahcc.cfm2FewXXinteger numberend of each subhourToo little flow to permit sizing coil to meet load at min temp (dx, 7-95)
tu1XXinteger numberrun start time (of each phase, autoSize or simulate)Chain head: tub ss of 1st terminal for air handler. next is tu.nxtu4a.
zhx1XXinteger numberrun start time (of each phase, autoSize or simulate)Chain head of ah’s zhx’s (zone hvac xfers): 0 or zhxb subscript of first. next: zhx.nxzhx4a.
ahModeXXunrecognizedend of each subhourWhat ah is doing: set to: ahoff/ahfan/ahheating/ahcooling/ahon(normal).
tSupXXnumberend of each subhour
wSupXXnumberend of each subhour
wSupLsXXnumbersubhourly
airxTsXXnumberend of each subhour
tsMnFoXXnumberend of each subhour
tsMnFoOkXXinteger numberend of each subhourTrue if tsmnfo has been calc’d since last ahestimate/ahcompute. set/used in gettsmnfo().
tsMxFoXXnumberend of each subhour
tsMxFoOkXXinteger numberend of each subhourTrue if tsmxfo has been calc’d since last ahestimate/ahcompute. set/used in gettsmxfo().
trXXnumberend of each subhour
wrXXnumberend of each subhour
crXXnumberend of each subhour
cMxfccXXnumberend of each subhour
frFanOnXXnumberend of each subhour
leakCOnXXnumberend of each subhour
tr1XXnumberend of each subhour
wr1XXnumberend of each subhour
cr1XXnumberend of each subhour
tr2XXnumberend of each subhour
rfanQXXnumberend of each subhourReturn fan power copied at commitment to this iteration (rfan.q is next iter)
tmixXXnumberend of each subhour
wenXXnumberend of each subhour
cmixXXnumberend of each subhour
dtMixEnXXnumberend of each subhour
tenXXnumberend of each subhour
cenXXnumberend of each subhour
menXXnumberend of each subhour
texXXnumberend of each subhour
wexXXnumberend of each subhour
tex1XXnumberend of each subhour
dtExSenXXnumberend of each subhour
tSenXXnumberend of each subhour
dtSenSXXnumberend of each subhour
aTsXXnumberend of each subhour
aWsXXnumberend of each subhour
trNxXXnumberend of each subhour
wrNxXXnumberend of each subhour
crNxXXnumberend of each subhour
cMxnxXXnumberend of each subhour
frFanOnNxXXnumberend of each subhour
leakCOnNxXXnumberend of each subhour
tr1NxXXnumberend of each subhour
wr1NxXXnumberend of each subhour
cr1NxXXnumberend of each subhour
tr2NxXXnumberend of each subhour
uUseArXXunrecognizedend of each subhour‘or’ of tu.usear’s at refine() entry, for detecting pegged terminals, set in zrat, tentative.
fccXXinteger numberend of each hourTrue if fan cycles: fan runs only fraction of subhour requested by control terminal, else off.
isZNorZN2XXinteger numberend of each hourTrue if ahtssp is zn or zn2 this hour. 5-95.
tsSp1XXnumberend of each subhour
tsFullFlowXXnumberend of each subhour
ecoEnabledXXinteger numberend of each subhourTrue if economizer present and currently enabled
coilLockoutXXinteger numberend of each subhourTrue if cooling coil disabled by full-open non-integrated economizer
poXXnumberend of each subhourCurrent fraction outside air
coilUsedXXunrecognizedend of each subhourCoil in use, docoils to coilsendsubhr: cunone, cuheat, or cucool. 12-3-92.
fanFXXnumberend of each subhour“fan factor” used in determining current max flows. reduce when fan overloads.
fanFMaxXXnumberend of each subhourFanf value for full flow: max tu vfmx/vfds, reflecting both vfmxh’s & vfmxc’s.
fanLimitedXXinteger numberend of each subhourTrue if using full capacity of fan without getting desired flow
coilLimitedXXinteger numberend of each subhourTrue if using full capacity of available coil without getting desired delta-t
tPossHXXnumberend of each subhour
tPossCXXnumberend of each subhour
ahClfXXinteger numberend of each subhourCall-flag: set nz if must call ahcompute so it can test tr,cr etc to see if computation needed.
ahPtfXXinteger numberend of each subhourCompute-flag: set if must call ahcompute and it should unconditionally recompute this ah:
ahPtf2XXinteger numberend of each subhourSecondary flag for compute only after zones computed again, for non-convergence.

6.4 Battery

@Battery[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
meterXXinteger numberinput timeMeter for system electricity production
endUseXXinteger numberautosize and simulate phase start timeEnd use of energy. defaults to “bt”
useUsrChgXXinteger numberrun start time (of each phase, autoSize or simulate)Yes: user specifies charge request;
controlAlgXXunrecognizedhourlyControl algorithm choice
maxCapXXnumberrun start time (of each phase, autoSize or simulate)Maximum (usable) battery capacity in kwh
initSOEXXnumberrun start time (of each phase, autoSize or simulate)Initial state of energy (0 <= soe <= 1)
initCyclesXXnumberrun start time (of each phase, autoSize or simulate)Initial number of cycles on battery (>= 0)
chgEffXXnumberhourlyBattery efficiency while charging
dschgEffXXnumberhourlyBattery efficiency while discharging (fraction)
maxChgPwrXXnumberhourlyMaximum allowable charging power (kw)
maxDschgPwrXXnumberhourlyMaximum discharge power (kw)
chgReqXXnumberend of each hourBattery charge request (kw) +=charge;-=discharge
soeBegIvlXXnumberhourlyBattery soe at beginning of interval
loadSeenXXnumberend of each hourThe adjusted load seen by the battery for current hour (kw)
soeXXnumberend of each hourBattery state of energy (soe) (0 <= soe <= 1)
soelhXXnumberhourlyBattery state of energy (soe) at end of prior hour
cyclesXXnumberend of each hourAccumulated battery cycles
cycleslhXXnumberhourlyAccumulated battery cycles, end of prior hour
energyXXnumberend of each hourCurrent amount of energy in battery (kwh)
energylhXXnumberhourlyAmount of energy in battery (kwh)

6.5 boiler (owner: heatPlant)

@boiler[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
blrCapXXnumberautosize and simulate phase start timeCapacity (btuh). required input.
blrEffRXXnumberautosize and simulate phase start timeEfficiency at steady-state full load, default .80.
blrEirRXXnumberautosize and simulate phase start timeEnergy input ratio (1/eff): alternate input; used internally.
blrPyEi.k[0]XXnumberautosize and simulate phase start time
blrPyEi.k[1]XXnumberautosize and simulate phase start time
blrPyEi.k[2]XXnumberautosize and simulate phase start time
blrPyEi.k[3]XXnumberautosize and simulate phase start time
blrPyEi.k[4]XXnumberautosize and simulate phase start time
mtriXXinteger numberinput timeSubscript of mtr to which to charge boiler input power, default none
blrp.gpmXXnumberrun start time (of each phase, autoSize or simulate)
blrp.hdLossXXnumberautosize and simulate phase start time
blrp.motEffXXnumberautosize and simulate phase start time
blrp.hydEffXXnumberautosize and simulate phase start time
blrp.ovrunFXXnumberrun start time (of each phase, autoSize or simulate)
blrp.mtriXXinteger numberautosize and simulate phase start timeSubscript of mtr to which to charge boiler input power, default none
blrp.mwXXnumberrun start time (of each phase, autoSize or simulate)
blrp.qXXnumberrun start time (of each phase, autoSize or simulate)Current output power level (excluding pump heat), share of total of connected coils & hx’s
blrp.pXXnumberrun start time (of each phase, autoSize or simulate)Current input power
auxOnXXnumberhourlyAddl input energy used in proportion to plr when on, default 0, hourly vbl for future flexblty.
auxOnMtriXXinteger numberinput timeMtr to which to charge “auxon”
auxOffXXnumberhourlyAddl input energy when off for part or all of subhr (proportional to 1-plr), for unforseen uses.
auxOffMtriXXinteger numberinput timeMtr for “auxoff”
auxOnAtallXXnumberhourlyAddl input energy used in toto when blr on for any part of subhour, for unforseen uses.
auxOnAtallMtriXXinteger numberinput timeMtr for “auzonatall”
auxFullOffXXnumberhourlyAdditional input energy when off for entire subhour (as opposed to in proportion to 1-plr).
auxFullOffMtriXXinteger numberinput timeMtr to which auxfulloff is charged, default c.mtri.
nxBlr4hpXXinteger numberrun start time (of each phase, autoSize or simulate)0 or subscript of next boiler for same heatplant. 1st is heatplant.blr1.
usedXXinteger numberrun start time (of each phase, autoSize or simulate)During input checking (cncult6.cpp), true if a stage uses this boiler
blrModeXXunrecognizedend of each subhourMode this subhour: off or on. can be on with 0 q if in heatplant’s 1st stage.
plrXXnumberend of each subhourPart load ratio
qXXnumberend of each subhourCurrent output power level (excluding pump heat), share of total of connected coils & hx’s
pXXnumberend of each subhourCurrent input power
pAuxOnXXnumberend of each subhourBlr-on proporotinal aux power this subhour
pAuxOffXXnumberend of each subhourBlr-off proportional aux power this subhour
pAuxOnAtallXXnumberend of each subhourBlr on-at-all aux power this subhour
pAuxFullOffXXnumberend of each subhourAuxfulloff power this subhour

6.6 chiller (owner: coolPlant)

@chiller[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
chCapDsXXnumberautosize and simulate phase start timeCapacity at chdsts,chdstcnd, btuh. required. negative internally. niles capdsn.
chTsDsXXnumberautosize and simulate phase start timeTemp leaving chiller at which chcapds applies, default 44. niles twsudsn.
chTcndDsXXnumberautosize and simulate phase start timeTemp entering condenser (twodel value) for chcapds, default 85. niles twcnddsn.
chPyCapT.k[0]XXnumberrun start time (of each phase, autoSize or simulate)
chPyCapT.k[1]XXnumberrun start time (of each phase, autoSize or simulate)
chPyCapT.k[2]XXnumberrun start time (of each phase, autoSize or simulate)
chPyCapT.k[3]XXnumberrun start time (of each phase, autoSize or simulate)
chPyCapT.k[4]XXnumberrun start time (of each phase, autoSize or simulate)
chPyCapT.k[5]XXnumberrun start time (of each phase, autoSize or simulate)
chPyCapT.k[6]XXnumberrun start time (of each phase, autoSize or simulate)
chCopXXnumberautosize and simulate phase start timeFull-load coefficient of performance (output btu/input btu) @ chtsds/chtcndds, reflecting
chEirDsXXnumberrun start time (of each phase, autoSize or simulate)Full-load eir (energy input ratio) @ chtsds/chtcndds, relecting motor and chiller efficiency.
chPyEirT.k[0]XXnumberrun start time (of each phase, autoSize or simulate)
chPyEirT.k[1]XXnumberrun start time (of each phase, autoSize or simulate)
chPyEirT.k[2]XXnumberrun start time (of each phase, autoSize or simulate)
chPyEirT.k[3]XXnumberrun start time (of each phase, autoSize or simulate)
chPyEirT.k[4]XXnumberrun start time (of each phase, autoSize or simulate)
chPyEirT.k[5]XXnumberrun start time (of each phase, autoSize or simulate)
chPyEirT.k[6]XXnumberrun start time (of each phase, autoSize or simulate)
chPyEirUl.k[0]XXnumberrun start time (of each phase, autoSize or simulate)
chPyEirUl.k[1]XXnumberrun start time (of each phase, autoSize or simulate)
chPyEirUl.k[2]XXnumberrun start time (of each phase, autoSize or simulate)
chPyEirUl.k[3]XXnumberrun start time (of each phase, autoSize or simulate)
chPyEirUl.k[4]XXnumberrun start time (of each phase, autoSize or simulate)
chMinUnldPlrXXnumberautosize and simulate phase start timeMin unloading loading part load ratio, default 0.1. niles minunldplr.
chMinFsldPlrXXnumberautosize and simulate phase start timeMin false loading part load ratio, default 0.1. niles minfsldplr. must be <= chminunldplr.
chMotEffXXnumberautosize and simulate phase start timeMotor efficiency (poorly named), default 1.0, niles motoreff, used only to determine
mtriXXinteger numberinput timeMeter name (“chmtr”) for accumulating compressor energy used by chiller,
chpp.gpmXXnumberrun start time (of each phase, autoSize or simulate)
chpp.hdLossXXnumberautosize and simulate phase start time
chpp.motEffXXnumberautosize and simulate phase start time
chpp.hydEffXXnumberautosize and simulate phase start time
chpp.ovrunFXXnumberrun start time (of each phase, autoSize or simulate)
chpp.mtriXXinteger numberautosize and simulate phase start timeMeter name (“chmtr”) for accumulating compressor energy used by chiller,
chpp.mwXXnumberrun start time (of each phase, autoSize or simulate)
chpp.qXXnumberrun start time (of each phase, autoSize or simulate)This chiller’s current primary output power to pri loop
chpp.pXXnumberrun start time (of each phase, autoSize or simulate)Compressor power input. also see chpp.p, chcp.p. (niles cndpmppwrin, prmpmppwrin, totpwrin)
chcp.gpmXXnumberrun start time (of each phase, autoSize or simulate)
chcp.hdLossXXnumberautosize and simulate phase start time
chcp.motEffXXnumberautosize and simulate phase start time
chcp.hydEffXXnumberautosize and simulate phase start time
chcp.ovrunFXXnumberrun start time (of each phase, autoSize or simulate)
chcp.mtriXXinteger numberautosize and simulate phase start timeMeter name (“chmtr”) for accumulating compressor energy used by chiller,
chcp.mwXXnumberrun start time (of each phase, autoSize or simulate)
chcp.qXXnumberrun start time (of each phase, autoSize or simulate)This chiller’s current primary output power to pri loop
chcp.pXXnumberrun start time (of each phase, autoSize or simulate)Compressor power input. also see chpp.p, chcp.p. (niles cndpmppwrin, prmpmppwrin, totpwrin)
auxOnXXnumberhourlyAddl input energy used in proportion to plr when on, default 0, hourly vbl for future flexblty.
auxOnMtriXXinteger numberinput timeMtr to which to charge “auxon”
auxOffXXnumberhourlyAddl input energy when off for part or all of subhr (proportional to 1-plr), for unforseen uses.
auxOffMtriXXinteger numberinput timeMtr for “auxoff”
auxOnAtallXXnumberhourlyAddl input energy used in toto when chiller on for any part of subhour, for unforseen uses.
auxOnAtallMtriXXinteger numberinput timeMtr for “auxonatall”
auxFullOffXXnumberhourlyAdditional input energy when off for entire subhour (as opposed to in proportion to 1-plr).
auxFullOffMtriXXinteger numberinput timeMtr to which auxfulloff is charged, default c.mtri.
nxCh4cpXXinteger numberrun start time (of each phase, autoSize or simulate)0 or subscript of next chiller in same coolplant. 1st is coolplant.ch1.
usedXXinteger numberrun start time (of each phase, autoSize or simulate)Non-0 if a coolplant uses this chiller – else warning
eirMinUnldPlrXXnumberrun start time (of each phase, autoSize or simulate)Chpyeirul(minunldplr): precomputed energy input corr for false loading, prorate for cycling
chModeXXunrecognizedend of each subhourC_offonch_off or _on: whether this chiller is running, set by staging code.
capXXnumberend of each subhour
qXXnumberend of each subhourThis chiller’s current primary output power to pri loop
pXXnumberend of each subhourCompressor power input. also see chpp.p, chcp.p. (niles cndpmppwrin, prmpmppwrin, totpwrin)
pAuxOnXXnumberend of each subhourChiller-on proporotinal aux power this subhour
pAuxOffXXnumberend of each subhourChiller-off proportional aux power this subhour
pAuxOnAtallXXnumberend of each subhourChiller on-at-all aux power this subhour
pAuxFullOffXXnumberend of each subhourAuxfulloff power this subhour

6.7 construction

@construction[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXstringconstant
conUXnumberinput timeU-value. entered by user or calculated from associated layers (lrs). 0 allowed.
nLrXinteger numberrun start time (of each phase, autoSize or simulate)0 or number of layers (in lr rat). layers are entered in order from inside out.
nFrmLrXinteger numberrun start time (of each phase, autoSize or simulate)# framed layers: error if > 1; is-framed flag.
rXnumberrun start time (of each phase, autoSize or simulate)Thermal resistance of layers accumulated here for conu
hcXnumberrun start time (of each phase, autoSize or simulate)Accumulated heat capacity per square foot
rNomXnumberrun start time (of each phase, autoSize or simulate)Nominal r value

6.8 coolPlant

@coolPlant[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
cpSchedXXunrecognizedhourlySchedule, hourly choice of off, avail (default), on.
cpTsSpXXnumberhourlySupply temp cooling setpoint, hourly variable, default 44.
cpPipeLossFXXnumberautosize and simulate phase start timePipe “loss”: heat gain equal to this fraction of largest stage <– change **
cpTowiXXinteger numberinput timeSubscript of towerplant supporting this coolplant. input as name “cptowerplant”. rqd.
cpStage1[0]XXinteger numberautosize and simulate phase start time
cpStage1[1]XXinteger numberautosize and simulate phase start time
cpStage1[2]XXinteger numberautosize and simulate phase start time
cpStage1[3]XXinteger numberautosize and simulate phase start time
cpStage1[4]XXinteger numberautosize and simulate phase start time
cpStage1[5]XXinteger numberautosize and simulate phase start time
cpStage1[6]XXinteger numberautosize and simulate phase start time
cpStage1[7]XXinteger numberautosize and simulate phase start time
cpStage2[0]XXinteger numberautosize and simulate phase start timeDefaulted by code, if no cpstage values entered:
cpStage2[1]XXinteger numberautosize and simulate phase start timeDefaulted by code, if no cpstage values entered:
cpStage2[2]XXinteger numberautosize and simulate phase start timeDefaulted by code, if no cpstage values entered:
cpStage2[3]XXinteger numberautosize and simulate phase start timeDefaulted by code, if no cpstage values entered:
cpStage2[4]XXinteger numberautosize and simulate phase start timeDefaulted by code, if no cpstage values entered:
cpStage2[5]XXinteger numberautosize and simulate phase start timeDefaulted by code, if no cpstage values entered:
cpStage2[6]XXinteger numberautosize and simulate phase start timeDefaulted by code, if no cpstage values entered:
cpStage2[7]XXinteger numberautosize and simulate phase start timeDefaulted by code, if no cpstage values entered:
cpStage3[0]XXinteger numberautosize and simulate phase start time
cpStage3[1]XXinteger numberautosize and simulate phase start time
cpStage3[2]XXinteger numberautosize and simulate phase start time
cpStage3[3]XXinteger numberautosize and simulate phase start time
cpStage3[4]XXinteger numberautosize and simulate phase start time
cpStage3[5]XXinteger numberautosize and simulate phase start time
cpStage3[6]XXinteger numberautosize and simulate phase start time
cpStage3[7]XXinteger numberautosize and simulate phase start time
cpStage4[0]XXinteger numberautosize and simulate phase start time… stage 1: ti_all. stages 2-7: none(0).
cpStage4[1]XXinteger numberautosize and simulate phase start time… stage 1: ti_all. stages 2-7: none(0).
cpStage4[2]XXinteger numberautosize and simulate phase start time… stage 1: ti_all. stages 2-7: none(0).
cpStage4[3]XXinteger numberautosize and simulate phase start time… stage 1: ti_all. stages 2-7: none(0).
cpStage4[4]XXinteger numberautosize and simulate phase start time… stage 1: ti_all. stages 2-7: none(0).
cpStage4[5]XXinteger numberautosize and simulate phase start time… stage 1: ti_all. stages 2-7: none(0).
cpStage4[6]XXinteger numberautosize and simulate phase start time… stage 1: ti_all. stages 2-7: none(0).
cpStage4[7]XXinteger numberautosize and simulate phase start time… stage 1: ti_all. stages 2-7: none(0).
cpStage5[0]XXinteger numberautosize and simulate phase start time
cpStage5[1]XXinteger numberautosize and simulate phase start time
cpStage5[2]XXinteger numberautosize and simulate phase start time
cpStage5[3]XXinteger numberautosize and simulate phase start time
cpStage5[4]XXinteger numberautosize and simulate phase start time
cpStage5[5]XXinteger numberautosize and simulate phase start time
cpStage5[6]XXinteger numberautosize and simulate phase start time
cpStage5[7]XXinteger numberautosize and simulate phase start time
cpStage6[0]XXinteger numberautosize and simulate phase start time
cpStage6[1]XXinteger numberautosize and simulate phase start time
cpStage6[2]XXinteger numberautosize and simulate phase start time
cpStage6[3]XXinteger numberautosize and simulate phase start time
cpStage6[4]XXinteger numberautosize and simulate phase start time
cpStage6[5]XXinteger numberautosize and simulate phase start time
cpStage6[6]XXinteger numberautosize and simulate phase start time
cpStage6[7]XXinteger numberautosize and simulate phase start time
cpStage7[0]XXinteger numberautosize and simulate phase start time
cpStage7[1]XXinteger numberautosize and simulate phase start time
cpStage7[2]XXinteger numberautosize and simulate phase start time
cpStage7[3]XXinteger numberautosize and simulate phase start time
cpStage7[4]XXinteger numberautosize and simulate phase start time
cpStage7[5]XXinteger numberautosize and simulate phase start time
cpStage7[6]XXinteger numberautosize and simulate phase start time
cpStage7[7]XXinteger numberautosize and simulate phase start time
ch1XXinteger numberrun start time (of each phase, autoSize or simulate)Subscript of 1st chiller in this coolplant. next is chiller.nxch4cp.
ah1XXinteger numberrun start time (of each phase, autoSize or simulate)Subscript of 1st ah with chw coil served by this coolplant. next is ah.ahcc.nxah4cp.
nxCp4tpXXinteger numberrun start time (of each phase, autoSize or simulate)Subscript of next coolplant using same towerplant. 1st is towerplant.c1.
mwDsCoilsXXnumberrun start time (of each phase, autoSize or simulate)
stgPPQ[0]XXnumberrun start time (of each phase, autoSize or simulate)
stgPPQ[1]XXnumberrun start time (of each phase, autoSize or simulate)
stgPPQ[2]XXnumberrun start time (of each phase, autoSize or simulate)
stgPPQ[3]XXnumberrun start time (of each phase, autoSize or simulate)
stgPPQ[4]XXnumberrun start time (of each phase, autoSize or simulate)
stgPPQ[5]XXnumberrun start time (of each phase, autoSize or simulate)
stgPPQ[6]XXnumberrun start time (of each phase, autoSize or simulate)
stgCPQ[0]XXnumberrun start time (of each phase, autoSize or simulate)
stgCPQ[1]XXnumberrun start time (of each phase, autoSize or simulate)
stgCPQ[2]XXnumberrun start time (of each phase, autoSize or simulate)
stgCPQ[3]XXnumberrun start time (of each phase, autoSize or simulate)
stgCPQ[4]XXnumberrun start time (of each phase, autoSize or simulate)
stgCPQ[5]XXnumberrun start time (of each phase, autoSize or simulate)
stgCPQ[6]XXnumberrun start time (of each phase, autoSize or simulate)
stgPMw[0]XXnumberrun start time (of each phase, autoSize or simulate)
stgPMw[1]XXnumberrun start time (of each phase, autoSize or simulate)
stgPMw[2]XXnumberrun start time (of each phase, autoSize or simulate)
stgPMw[3]XXnumberrun start time (of each phase, autoSize or simulate)
stgPMw[4]XXnumberrun start time (of each phase, autoSize or simulate)
stgPMw[5]XXnumberrun start time (of each phase, autoSize or simulate)
stgPMw[6]XXnumberrun start time (of each phase, autoSize or simulate)
stgCMw[0]XXnumberrun start time (of each phase, autoSize or simulate)
stgCMw[1]XXnumberrun start time (of each phase, autoSize or simulate)
stgCMw[2]XXnumberrun start time (of each phase, autoSize or simulate)
stgCMw[3]XXnumberrun start time (of each phase, autoSize or simulate)
stgCMw[4]XXnumberrun start time (of each phase, autoSize or simulate)
stgCMw[5]XXnumberrun start time (of each phase, autoSize or simulate)
stgCMw[6]XXnumberrun start time (of each phase, autoSize or simulate)
stgNXXinteger numberrun start time (of each phase, autoSize or simulate)Max+1 used stage subscript 1-7 (used stages need not be contiguous)
stgMxCapXXinteger numberrun start time (of each phase, autoSize or simulate)Subscript 0-6 of stage with most design power
mxCapDsXXnumberrun start time (of each phase, autoSize or simulate)
mxPMwXXnumberrun start time (of each phase, autoSize or simulate)
mxPMwOvXXnumberrun start time (of each phase, autoSize or simulate)
mxCondQXXnumberrun start time (of each phase, autoSize or simulate)
mxCondGpmXXnumberrun start time (of each phase, autoSize or simulate)
qPipeLossXXnumberrun start time (of each phase, autoSize or simulate)
cpTsXXnumberend of each subhour
qXXnumberend of each subhour
qTowXXnumberend of each subhour
tTowXXnumberend of each subhour
mwTowXXnumberend of each subhour
tCndXXnumberend of each subhour
cpClfXXinteger numberend of each subhourCall-flag: set nz if must call cpcompute so it can test tr, etc to see if computation needed.
cpPtfXXinteger numberend of each subhourCompute-flag: set if must call cpcompute and it should unconditionally recompute this plant
cpModeXXunrecognizedend of each subhourMode this subhour: off or on: per cpsched; per demand for avail. set in cpestimate, cpcompute.
qLoadNxXXnumberend of each subhour
qLoadXXnumberend of each subhour
trXXnumberend of each subhour
stgiXXinteger numberend of each subhourStage in use, 0-6 for cpstage1-7.
qNeedXXnumberend of each subhour
capXXnumberend of each subhour
plrXXnumberend of each subhour
puteTsXXnumberend of each subhour
cpTsSpPrXXnumberend of each subhourFor cpestimate
cpTsEstPrXXnumberend of each subhourFor cpestimate
cpModePrXXunrecognizedend of each subhourFor cpcompute
trMxPrXXnumberend of each subhourFor cpcompute: tr-assuming-max-flow when last computed
qLoadPrXXnumberend of each subhourFor cpcompute
mwTowPrXXnumberend of each subhourFor cpcompute, set by tpcompute
tTowPrXXnumberend of each subhourFor cpcompute, set by tpcompute

6.9 DESCOND

@DESCOND[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
doyXXinteger numberinput timeCalc date for this descond (1-365)
DBXXnumberinput timeDesign dry-bulb temp, f
MCDBRXXnumberinput timeCoincident daily db range, f
MCWBXXnumberinput timeCoincident wet-bulb temp, f
MCWBRXXnumberinput timeCoincident daily wb range, f
wndSpdXXnumberinput timeWind speed, mph
tauBXXnumberinput timeBeam tau
tauDXXnumberinput timeDiffuse tau
ebnSlrNoonXXnumberinput timeSolar noon beam normal, btuh/ft2
edhSlrNoonXXnumberinput timeSolar noon diffuse horiz, btuh/ft2

6.10 DHWDayUse

@DHWDayUse[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
multXXnumberhourlyMultiplier applied to all child dhwuse wuflows
wuSsBegXXinteger numberrun start time (of each phase, autoSize or simulate)Initial ss
wuSsEndXXinteger numberrun start time (of each phase, autoSize or simulate)Last ss+1

6.11 DHWHeater (owner: DHWSYS)

@DHWHeater[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
multXXnumberrun start time (of each phase, autoSize or simulate)Count of identical water heaters (default 1)
heatSrcXXunrecognizedinput timeHeat source
typeXXunrecognizedinput timeHeater type
descXXstringinput timeProbe-able description text
ashpTyXXunrecognizedinput timeAir source heat pump (hpwh) type, required iff wh_heatsrc=ashpx, else ignored
resTyXXunrecognizedinput timeResistance heater type, used iff wh_heatsrc=_elresx, else ignored
znTiXXinteger numberinput timeDhwheater location zone re tank loss
tExXXnumbersubhourly
ashpSrcZnTiXXinteger numberinput timeAshp source zone
ashpTSrcXXnumbersubhourlyAshp source temperature, f
ashpResUseXXnumberinput timeResistance heat parameter for
tankTInit[0]XXnumberrun start time (of each phase, autoSize or simulate)
tankTInit[1]XXnumberrun start time (of each phase, autoSize or simulate)
tankTInit[2]XXnumberrun start time (of each phase, autoSize or simulate)
tankTInit[3]XXnumberrun start time (of each phase, autoSize or simulate)
tankTInit[4]XXnumberrun start time (of each phase, autoSize or simulate)
tankTInit[5]XXnumberrun start time (of each phase, autoSize or simulate)
tankTInit[6]XXnumberrun start time (of each phase, autoSize or simulate)
tankTInit[7]XXnumberrun start time (of each phase, autoSize or simulate)
tankTInit[8]XXnumberrun start time (of each phase, autoSize or simulate)
tankTInit[9]XXnumberrun start time (of each phase, autoSize or simulate)
tankTInit[10]XXnumberrun start time (of each phase, autoSize or simulate)
tankTInit[11]XXnumberrun start time (of each phase, autoSize or simulate)
tankTInit[12]XXnumberrun start time (of each phase, autoSize or simulate)
tankCountXXnumberrun start time (of each phase, autoSize or simulate)# of storage tanks per dhwheater, re built-up whtype=builtup (default=1)
heatingCapXXnumberrun start time (of each phase, autoSize or simulate)Nominal heating capacity, btuh
volXXnumberrun start time (of each phase, autoSize or simulate)Total storage vol, gal (actual, not rated; not per tank)
volRunningXXnumberinput timeRunning storage volume = vol above aquastat, gal
UAXXnumberrun start time (of each phase, autoSize or simulate)Hpwh-type total ua, btuh/f (not per tank)
insulRXXnumberrun start time (of each phase, autoSize or simulate)Hpwh-type tank insulation resistance, hr-f/btuh
inHtSupplyXXnumberinput timeFractional tank height of supply inlet (0=bottom, 1=top)
inHtLoopRetXXnumberinput timeFractional tank height of loop return inlet(s) (0=bottom, 1=top)
EFXXnumberinput timeRated energy factor
LDEFXXnumberinput timeLoad-dependent energy factor
UEFXXnumberinput timeRated uniform energy factor
ratedFlowXXnumberinput timeMax rated flow per uef test, gpm
annualFuelXXnumberinput timeAnnual fuel use per uef method, therms/yr
annualElecXXnumberinput timeAnnual electricity use per uef method, kwh/yr
cycLossFuelXXnumberrun start time (of each phase, autoSize or simulate)Derived startup fuel use (=cyclic loss) for instuef, btu/cycle
cycLossElecXXnumberrun start time (of each phase, autoSize or simulate)Derived startup electricity use (=cyclic loss) for instuef, btu/cycle
maxFlowXXXnumberrun start time (of each phase, autoSize or simulate)Derived max flow for instuef, gal-f/tick
maxInpXXXnumberrun start time (of each phase, autoSize or simulate)Input at max flow, btu/tick
effXXnumberinput timeEfficiency (aka recovery efficiency)
SBLXXnumberinput timeStandby loss, btuh
pilotPwrXXnumberhourlyPilot light power, btuh
parElecXXnumberhourlyParasitic electric use, w
tHWOutNoMixXXnumberend of each subhourMost recent unmodified hot water temp, f
tHWOutXXnumberend of each subhour
loadCFwdFXXnumberinput timeLoad carry-forward allowed (user input frac of capacity)
loadCFwdMaxXXnumberinput timeMax load carry-forward energy (from wh_loadcfwdf), btu
loadCFwdXXnumbersubhourlyCurrent load carry forward, btu
nTickFullLoadXXnumberend of each subhourInstuef: current subhour equiv full load ticks (fractional)
nColdStartsXXnumbersubhourlyInstuef: current subhour # of cold startups
effShXXnumberend of each subhourCurrent subhour efficiency, used to support former hourly
operElecXXnumberrun start time (of each phase, autoSize or simulate)Electrical power during operation at rating conditions, btuh
stbyElecXXnumberrun start time (of each phase, autoSize or simulate)Electrical power during standby, w
resHtPwrXXnumberinput timeUpper element resistance heating power, w
resHtPwr2XXnumberinput timeLower element resistance heating power, w
HPWH.tExXXnumberend of each subhour
HPWH.tASHPSrcXXnumberend of each subhourTemp of heat pump air source, f
HPWH.fMixUseXXnumberend of each subhourFactor for draw adjustment re hpwh setpoint > dhwsys::ws_tuse
HPWH.fMixRLXXnumberend of each subhourFactor for loop return flow adjustment re hpwh setpoint > dhwsys::ws_tuse
HPWH.inElec[0]XXnumberend of each subhour
HPWH.inElec[1]XXnumberend of each subhour
HPWH.heatAdded[0]XXnumberend of each subhourCurrent subhr hpwh heat added to water, kwh
HPWH.heatAdded[1]XXnumberend of each subhourCurrent subhr hpwh heat added to water, kwh
HPWH.tOutXXnumberend of each subhourLast tick hpwh outlet temp, c
HPWH.tOutCHDHWXXnumberend of each subhourLast tick output temp available to chdhw, f
HPWH.HPWHxBUXXnumberend of each subhourCurrent subhr hpwh add’l backup resistance heat, btu
HPWH.qEnvXXnumberend of each subhour
HPWH.qLossXXnumberend of each subhour
HPWH.qHWXXnumberend of each subhour
HPWH.qTXXXnumberend of each subhourCurrent subhr extra heat tank heat added, kwh (not btu)
HPWH.tankHCNominalXXnumberend of each subhourNominal hpwh tank heat content, kwh (at 40 c)
HPWH.tankHCBegXXnumberend of each subhourCurrent step beginning tank heat content, kwh
HPWH.tankHCEndXXnumberend of each subhourCurrent step end tank heat content, kwh
HPWH.tHWOutFXXnumberend of each subhourCurrent substep working total re calc of hw_thwout
HPWH.tHWOutXXnumberend of each subhour
HPWH.qBalXXnumberend of each subhourCurrent step hpwh heat balance, kwh (s/b 0)
HPWH.balErrMaxXXnumberend of each subhourMaximum substep energy balance error for run, kwh
qXBUXXnumberend of each subhourCurrent step hpwh add’l backup resistance heat, btu
qEnvXXnumberend of each subhour
qLossXXnumberend of each subhour
qHWXXnumberend of each subhour
totHARLXXnumberend of each hourCumulative (year to date) recovery load at heater, btu
totOutXXnumberend of each hourCumulative (year to date) total heat delivered to hot water, btu
fAdjElecXXnumbersubhourlyElectricity use adjustment factor
fAdjFuelXXnumbersubhourlyFuel use adjment factor
inElecShXXnumberend of each subhourPrimary electricity (including wh_parelec) (note not kwh)
inElecBUShXXnumberend of each subhourBackup electricity (>0 only for hpwh resistance heat)
inElecXBUShXXnumberend of each subhourXbu “extra” backup (reheating to maintain ws_tuse)
inFuelShXXnumberend of each subhourFuel (including wh_pilotpwr)
inElecXXnumberend of each hour
inElecBUXXnumberend of each hourBackup electricity (>0 only for hpwh resistance heat)
inElecXBUXXnumberend of each hourXbu “extra” backup (reheating to maintain ws_tuse)
inFuelXXnumberend of each hourFuel (including wh_pilotpwr)
inElecTotXXnumberend of run (of each phase, autoSize or simulate)Annual total electricity, btu
inFuelTotXXnumberend of run (of each phase, autoSize or simulate)Annual total fuel, btu
elecMtriXXinteger numberinput timeMeter for system electricity use (default = parent ws_elecmtri)
fuelMtriXXinteger numberinput timeMeter for system fuel use (default = parent ws_fuelmtri)
xBUEndUseXXinteger numberinput timeWh_elecmtri end use for separate accounting of wh_hpwhxbu
tInletXXnumberend of each hourHour avg inlet temp, f
drawXXnumberend of each hourHour total draw seen by this dhwheater, gal

6.12 DHWHeatRec (owner: DHWSYS)

@DHWHeatRec[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
multXXinteger numberinput timeMultiplier
hwEndUseXXinteger numberinput timeEnd use source for this device
typeXXunrecognizedinput timeType: c_dwhrtych_
nFXDrainXXinteger numberinput timeNumber of fixtures (of type wr_whenduse) draining
nFXColdXXinteger numberinput timeNumber of fixtures (of type wr_whenduse) draining
feedsWHXXinteger numberinput timeIff c_noyesch_yes, potable output is plumbed to water heater
effRatedXXnumberhourlyRated effectiveness (generally csa rating value)
tdInDiffXXnumberhourlyDrain-side inlet water temp drop from fixture mixed temp, f
tdInWarmupXXnumberhourlyDrain-side inlet temp during warmup portion of draw
effXXnumberend of each subhourEffectiveness under current conditions
tpOXXnumberend of each subhourMost recent potable-side output temp, f
vpXXnumberend of each subhourMost recent potable-side flow, gpm

6.13 DHWLoop (owner: DHWSYS)

@DHWLoop[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
multXXinteger numberinput timeMultiplier: number of identical loops
wlpCountXXinteger numberrun start time (of each phase, autoSize or simulate)Total # of child dhwlooppumps
flowXXnumberhourlyCurrent loop recirculation max flow, gpm
runFXXnumberhourlyCurrent hour recirculation operation fraction
tIn1XXnumberhourlyEntering temperature at 1st dhwloopseg
fUAXXnumberinput timeUa adjustment factor for child dhwloopsegs
lossMakeupPwrXXnumberhourlyLoss makeup heating (electrical) power, w
lossMakeupEffXXnumberhourlyLoss makeup heating efficiency
elecMtriXXinteger numberinput timeMeter for loop electricity use (default = parent ws_elecmtri)
segTotals.countXXnumberrun start time (of each phase, autoSize or simulate)
segTotals.lenXXnumberrun start time (of each phase, autoSize or simulate)
segTotals.volXXnumberrun start time (of each phase, autoSize or simulate)
segTotals.exAreaXXnumberrun start time (of each phase, autoSize or simulate)
segTotals.UAXXnumberrun start time (of each phase, autoSize or simulate)
branchTotals.countXXnumberrun start time (of each phase, autoSize or simulate)
branchTotals.lenXXnumberrun start time (of each phase, autoSize or simulate)
branchTotals.volXXnumberrun start time (of each phase, autoSize or simulate)
branchTotals.exAreaXXnumberrun start time (of each phase, autoSize or simulate)
branchTotals.UAXXnumberrun start time (of each phase, autoSize or simulate)
volRLXXnumberend of each hourCurrent hour volume returned to water heater, gal
qLiqLPXXnumberend of each hourHeat added to liquid by dhwlooppump(s), btu
HRLLXXnumberend of each hourCurrent hour loop seg pipe losses, btu
HRLLnetXXnumberend of each hourWl_hrll adjusted for pump by pump heat and
HRBLXXnumberend of each hourCurrent hour branch pipe loss, btu
t24WLXXnumberend of each hourCurrent hour branch waste loss volume, gal
tRLXXnumberend of each hourCurrent hour average return temp, f

6.14 DHWLoopBranch (owner: DHWLoopSeg)

@DHWLoopBranch[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
lenXXnumberinput time
sizeXXnumberinput time
insulKXXnumberinput time
insulThkXXnumberinput time
exHXXnumberinput time
absSlrXXnumbersubhourly
awAbsSlrXXnumbersubhourly
epsLWXXnumbersubhourly
ziXXinteger numbersubhourly
FXXnumbersubhourly
FpXXnumbersubhourly
frRadXXnumbersubhourly
fSkyXXnumbersubhourly
fAirXXnumbersubhourly
hcNatXXnumberend of each subhour
hcFrcXXnumberend of each subhour
hcMultXXnumberend of each subhour
hxaXXnumberend of each subhour
hxrXXnumberend of each subhour
hxtotXXnumberend of each subhour
uRatXXnumberend of each subhour
fRatXXnumberend of each subhour
cxXXnumberend of each subhour
sgTarg.bmXXnumberend of each subhour
sgTarg.dfXXnumberend of each subhour
sgTarg.totXXnumberend of each subhour
sgXXnumberend of each subhour
tSrfXXnumberend of each subhour
tSrflsXXnumbersubhourly
qrAbsXXnumberend of each subhour
txaXXnumberend of each subhour
txrXXnumberend of each subhour
txeXXnumberend of each subhour
wXXnumberend of each subhour
qSrfXXnumberend of each subhour
pPSXXunrecognizedsubhourly
exCndXXinteger numberinput time
exTXXnumberhourly
totals.countXXnumberrun start time (of each phase, autoSize or simulate)
totals.lenXXnumberrun start time (of each phase, autoSize or simulate)
totals.volXXnumberrun start time (of each phase, autoSize or simulate)
totals.exAreaXXnumberrun start time (of each phase, autoSize or simulate)
totals.UAXXnumberrun start time (of each phase, autoSize or simulate)
fRhoCpXXXnumberrun start time (of each phase, autoSize or simulate)
fvfXXnumberend of each hour
tInXXnumberend of each hour
tOutXXnumberend of each hour
PLWFXXnumberend of each hour
PLCDXXnumberend of each hour
PLXXnumberend of each hour
multXXnumberinput time# of identical branches
fUAXXnumberinput timeUa adjustment factor for this branch
fWasteXXnumberhourlyWaste fraction
flowXXnumberhourlyAssumed flow during use, gpm
HBULXXnumberend of each hour… when water in use
HBWLXXnumberend of each hour… waste loss
t24WLXXnumberend of each hour… waste loss volume, gal

6.15 DHWLoopHeater (owner: DHWSYS)

@DHWLoopHeater[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
multXXnumberrun start time (of each phase, autoSize or simulate)
heatSrcXXunrecognizedinput time
typeXXunrecognizedinput time
descXXstringinput time
ashpTyXXunrecognizedinput time
resTyXXunrecognizedinput time
znTiXXinteger numberinput time
tExXXnumbersubhourly
ashpSrcZnTiXXinteger numberinput time
ashpTSrcXXnumbersubhourly
ashpResUseXXnumberinput time
tankTInit[0]XXnumberrun start time (of each phase, autoSize or simulate)
tankTInit[1]XXnumberrun start time (of each phase, autoSize or simulate)
tankTInit[2]XXnumberrun start time (of each phase, autoSize or simulate)
tankTInit[3]XXnumberrun start time (of each phase, autoSize or simulate)
tankTInit[4]XXnumberrun start time (of each phase, autoSize or simulate)
tankTInit[5]XXnumberrun start time (of each phase, autoSize or simulate)
tankTInit[6]XXnumberrun start time (of each phase, autoSize or simulate)
tankTInit[7]XXnumberrun start time (of each phase, autoSize or simulate)
tankTInit[8]XXnumberrun start time (of each phase, autoSize or simulate)
tankTInit[9]XXnumberrun start time (of each phase, autoSize or simulate)
tankTInit[10]XXnumberrun start time (of each phase, autoSize or simulate)
tankTInit[11]XXnumberrun start time (of each phase, autoSize or simulate)
tankTInit[12]XXnumberrun start time (of each phase, autoSize or simulate)
tankCountXXnumberrun start time (of each phase, autoSize or simulate)
heatingCapXXnumberrun start time (of each phase, autoSize or simulate)
volXXnumberrun start time (of each phase, autoSize or simulate)
volRunningXXnumberinput time
UAXXnumberrun start time (of each phase, autoSize or simulate)
insulRXXnumberrun start time (of each phase, autoSize or simulate)
inHtSupplyXXnumberinput time
inHtLoopRetXXnumberinput time
EFXXnumberinput time
LDEFXXnumberinput time
UEFXXnumberinput time
ratedFlowXXnumberinput time
annualFuelXXnumberinput time
annualElecXXnumberinput time
cycLossFuelXXnumberrun start time (of each phase, autoSize or simulate)
cycLossElecXXnumberrun start time (of each phase, autoSize or simulate)
maxFlowXXXnumberrun start time (of each phase, autoSize or simulate)
maxInpXXXnumberrun start time (of each phase, autoSize or simulate)
effXXnumberinput time
SBLXXnumberinput time
pilotPwrXXnumberhourly
parElecXXnumberhourly
tHWOutNoMixXXnumberend of each subhour
tHWOutXXnumberend of each subhour
loadCFwdFXXnumberinput time
loadCFwdMaxXXnumberinput time
loadCFwdXXnumbersubhourly
nTickFullLoadXXnumberend of each subhour
nColdStartsXXnumbersubhourly
effShXXnumberend of each subhour
operElecXXnumberrun start time (of each phase, autoSize or simulate)
stbyElecXXnumberrun start time (of each phase, autoSize or simulate)
resHtPwrXXnumberinput time
resHtPwr2XXnumberinput time
HPWH.tExXXnumberend of each subhour
HPWH.tASHPSrcXXnumberend of each subhour
HPWH.fMixUseXXnumberend of each subhour
HPWH.fMixRLXXnumberend of each subhour
HPWH.inElec[0]XXnumberend of each subhour
HPWH.inElec[1]XXnumberend of each subhour
HPWH.heatAdded[0]XXnumberend of each subhour
HPWH.heatAdded[1]XXnumberend of each subhour
HPWH.tOutXXnumberend of each subhour
HPWH.tOutCHDHWXXnumberend of each subhour
HPWH.HPWHxBUXXnumberend of each subhour
HPWH.qEnvXXnumberend of each subhour
HPWH.qLossXXnumberend of each subhour
HPWH.qHWXXnumberend of each subhour
HPWH.qTXXXnumberend of each subhour
HPWH.tankHCNominalXXnumberend of each subhour
HPWH.tankHCBegXXnumberend of each subhour
HPWH.tankHCEndXXnumberend of each subhour
HPWH.tHWOutFXXnumberend of each subhour
HPWH.tHWOutXXnumberend of each subhour
HPWH.qBalXXnumberend of each subhour
HPWH.balErrMaxXXnumberend of each subhour
qXBUXXnumberend of each subhour
qEnvXXnumberend of each subhour
qLossXXnumberend of each subhour
qHWXXnumberend of each subhour
totHARLXXnumberend of each hour
totOutXXnumberend of each hour
fAdjElecXXnumbersubhourly
fAdjFuelXXnumbersubhourly
inElecShXXnumberend of each subhour
inElecBUShXXnumberend of each subhour
inElecXBUShXXnumberend of each subhour
inFuelShXXnumberend of each subhour
inElecXXnumberend of each hour
inElecBUXXnumberend of each hour
inElecXBUXXnumberend of each hour
inFuelXXnumberend of each hour
inElecTotXXnumberend of run (of each phase, autoSize or simulate)
inFuelTotXXnumberend of run (of each phase, autoSize or simulate)
elecMtriXXinteger numberinput time
fuelMtriXXinteger numberinput time
xBUEndUseXXinteger numberinput time
tInletXXnumberend of each hour
drawXXnumberend of each hour

6.16 DHWLoopPump (owner: DHWLoop)

@DHWLoopPump[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
multXXinteger numberinput time
elecMtriXXinteger numberinput time
pwrXXnumberhourly
liqHeatFXXnumberhourly
inElecXXnumberend of each hour

6.17 DHWLoopSeg (owner: DHWLoop)

@DHWLoopSeg[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
lenXXnumberinput time
sizeXXnumberinput time
insulKXXnumberinput time
insulThkXXnumberinput time
exHXXnumberinput time
absSlrXXnumbersubhourly
awAbsSlrXXnumbersubhourly
epsLWXXnumbersubhourly
ziXXinteger numbersubhourly
FXXnumbersubhourly
FpXXnumbersubhourly
frRadXXnumbersubhourly
fSkyXXnumbersubhourly
fAirXXnumbersubhourly
hcNatXXnumberend of each subhour
hcFrcXXnumberend of each subhour
hcMultXXnumberend of each subhour
hxaXXnumberend of each subhour
hxrXXnumberend of each subhour
hxtotXXnumberend of each subhour
uRatXXnumberend of each subhour
fRatXXnumberend of each subhour
cxXXnumberend of each subhour
sgTarg.bmXXnumberend of each subhour
sgTarg.dfXXnumberend of each subhour
sgTarg.totXXnumberend of each subhour
sgXXnumberend of each subhour
tSrfXXnumberend of each subhour
tSrflsXXnumbersubhourly
qrAbsXXnumberend of each subhour
txaXXnumberend of each subhour
txrXXnumberend of each subhour
txeXXnumberend of each subhour
wXXnumberend of each subhour
qSrfXXnumberend of each subhour
pPSXXunrecognizedsubhourly
exCndXXinteger numberinput time
exTXXnumberhourly
totals.countXXnumberrun start time (of each phase, autoSize or simulate)
totals.lenXXnumberrun start time (of each phase, autoSize or simulate)
totals.volXXnumberrun start time (of each phase, autoSize or simulate)
totals.exAreaXXnumberrun start time (of each phase, autoSize or simulate)
totals.UAXXnumberrun start time (of each phase, autoSize or simulate)
fRhoCpXXXnumberrun start time (of each phase, autoSize or simulate)
fvfXXnumberend of each hour
tInXXnumberend of each hour
tOutXXnumberend of each hour
PLWFXXnumberend of each hour
PLCDXXnumberend of each hour
PLXXnumberend of each hour
tyXXunrecognizedinput timeType: c_dhwlsegtych_sup / _ret
wbCountXXnumberrun start time (of each phase, autoSize or simulate)Total # of child dhwloopbranchs
fNoDrawXXnumberhourlyFraction of hour when there is no draw
LLXXnumberend of each hourCurrent hour loop loss, btu
BLXXnumberend of each hourCurrent hour child dhwloopbranch losses, btu
t24WLXXnumberend of each hourCurrent hour child dhwloopbranch waste loss volume, gal

6.18 DHWMETER

@DHWMETER[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
Y.totalXXnumberend of run (of each phase, autoSize or simulate)
Y.unknownXXnumberend of run (of each phase, autoSize or simulate)
Y.faucetXXnumberend of run (of each phase, autoSize or simulate)
Y.showerXXnumberend of run (of each phase, autoSize or simulate)
Y.bathXXnumberend of run (of each phase, autoSize or simulate)
Y.cwashrXXnumberend of run (of each phase, autoSize or simulate)
Y.dwashrXXnumberend of run (of each phase, autoSize or simulate)
M.totalXXnumberend of each month
M.unknownXXnumberend of each month
M.faucetXXnumberend of each month
M.showerXXnumberend of each month
M.bathXXnumberend of each month
M.cwashrXXnumberend of each month
M.dwashrXXnumberend of each month
D.totalXXnumberend of each day
D.unknownXXnumberend of each day
D.faucetXXnumberend of each day
D.showerXXnumberend of each day
D.bathXXnumberend of each day
D.cwashrXXnumberend of each day
D.dwashrXXnumberend of each day
H.totalXXnumberend of each hour
H.unknownXXnumberend of each hour
H.faucetXXnumberend of each hour
H.showerXXnumberend of each hour
H.bathXXnumberend of each hour
H.cwashrXXnumberend of each hour
H.dwashrXXnumberend of each hour
prior.Y.totalXXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.unknownXXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.faucetXXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.showerXXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.bathXXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.cwashrXXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.dwashrXXnumberrun start time (of each phase, autoSize or simulate)
prior.M.totalXXnumbermonthly
prior.M.unknownXXnumbermonthly
prior.M.faucetXXnumbermonthly
prior.M.showerXXnumbermonthly
prior.M.bathXXnumbermonthly
prior.M.cwashrXXnumbermonthly
prior.M.dwashrXXnumbermonthly
prior.D.totalXXnumberdaily
prior.D.unknownXXnumberdaily
prior.D.faucetXXnumberdaily
prior.D.showerXXnumberdaily
prior.D.bathXXnumberdaily
prior.D.cwashrXXnumberdaily
prior.D.dwashrXXnumberdaily
prior.H.totalXXnumberhourly
prior.H.unknownXXnumberhourly
prior.H.faucetXXnumberhourly
prior.H.showerXXnumberhourly
prior.H.bathXXnumberhourly
prior.H.cwashrXXnumberhourly
prior.H.dwashrXXnumberhourly

6.19 DHWPump (owner: DHWSYS)

@DHWPump[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
multXXinteger numberinput timeCount of identical dhw pumps (default 1)
elecMtriXXinteger numberinput timeMeter for pump electricity use (default = parent ws_elecmtri)
pwrXXnumberhourlyPump power, w
liqHeatFXXnumberhourlyFraction of wp_pwr added to liquid stream
inElecXXnumberend of each hourElectricity (note not kwh)

6.20 DHWSolarCollector (owner: DHWSolarSys)

@DHWSolarCollector[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
multXXnumberinput timeMultiplier (for multiple panels). default 1.
multLRXXnumberend of run (of each phase, autoSize or simulate)Last run multiplier, re probing in chained runs
areaXXnumberinput timeSrcc collector area, ft2
tiltXXnumberinput timeArray tilt, radians (input as degrees)
azmXXnumberinput timeArray azimuth, radians (input as degrees)
testFRULXXnumberinput timeSrcc test (rated) slope, btuh/f-ft2
testFRTAXXnumberinput timeSrcc test (rated) intercept
testMassFlowXXnumberinput timeCollector loop srcc rating mass flow rate, lb/h-ft2
oprMassFlowXXnumberinput timeCollector loop operating mass flow rate, lb/h-ft2
kta60XXnumberinput timeIncidence angle modifier at 60 deg (from srcc rating)
piping.lenXXnumberrun start time (of each phase, autoSize or simulate)
piping.sizeXXnumberrun start time (of each phase, autoSize or simulate)
piping.insulKXXnumberrun start time (of each phase, autoSize or simulate)
piping.insulThkXXnumberrun start time (of each phase, autoSize or simulate)
piping.exHXXnumberrun start time (of each phase, autoSize or simulate)
piping.countXXnumberrun start time (of each phase, autoSize or simulate)
piping.lenXXnumberrun start time (of each phase, autoSize or simulate)
piping.volXXnumberrun start time (of each phase, autoSize or simulate)
piping.exAreaXXnumberrun start time (of each phase, autoSize or simulate)
piping.UAXXnumberrun start time (of each phase, autoSize or simulate)
piping.betaXXnumbersubhourly
pipingTExXXnumberend of each hourCollector piping surround temp
areaTotXXnumberrun start time (of each phase, autoSize or simulate)Total area, ft2 (=sc_area*sc_mult)
flowCorrectionXXnumberrun start time (of each phase, autoSize or simulate)Flow correction factor
oprFRULXXnumberrun start time (of each phase, autoSize or simulate)Operating (flow-corrected) collector slope, btuh/f-ft2
oprFRTAXXnumberrun start time (of each phase, autoSize or simulate)Operating (flow-corrected) collector intercept
oprMCpXXnumberrun start time (of each phase, autoSize or simulate)Operating heat capacity flow rate, btuh/f (not per ft2)
oprVolFlowXXnumberrun start time (of each phase, autoSize or simulate)Nominal collector loop volume flow rate, gpm (not gpm/ft2)
b0XXnumberrun start time (of each phase, autoSize or simulate)Incidence angle modifier coefficient
ktaDSXXnumberrun start time (of each phase, autoSize or simulate)Tau-alpha modifier (kta) for sky diffuse radiation
ktaDGXXnumberrun start time (of each phase, autoSize or simulate)Tau-alpha modifier (kta) ground-reflected diffuse radiation
incAXXnumberend of each hourBeam angle of incidence, radians (pi/2 if no beam)
ktaDBXXnumberend of each hourTau-alpha modifier (kta) for beam (varies by hour)
poaRadDBXXnumberend of each hourBeam
poaRadDSXXnumberend of each hourDiffuse from sky
poaRadDGXXnumberend of each hourDiffuse from ground
poaRadTotXXnumberend of each hourTotal
poaRadIAMXXnumberend of each hourComponent-weighted iam factor
pumpPwrXXnumberrun start time (of each phase, autoSize or simulate)Pump power, w
tickPumpQXXnumberrun start time (of each phase, autoSize or simulate)Pump input energy per tick, btu
pumpLiqHeatFXXnumberrun start time (of each phase, autoSize or simulate)Fraction of sc_pumppwr added to liquid stream
pumpDTXXnumberrun start time (of each phase, autoSize or simulate)Fluid temp increase due to pump, f
pumpOnDeltaTXXnumberrun start time (of each phase, autoSize or simulate)Temperature difference between the
pumpOffDeltaTXXnumberrun start time (of each phase, autoSize or simulate)Temperature difference between the
tOutletMXXnumberend of each hour
tOutletBXXnumberend of each hour
effMXXnumberend of each hour
effBXXnumberend of each hour
tInletXXnumberend of each subhourTick inlet temp, f (at tank / before to-collector piping)
effXXnumberend of each hourFraction of incident heat added to the fluid
tickQFluidXXnumberend of each subhourTick heat added to the fluid, btu
hrQFluidXXnumberend of each hourHour total heat added to fluid, btu
totQFluidXXnumberend of run (of each phase, autoSize or simulate)Run total sc_qfluid total, btu
tOutletPXXnumberend of each hourTick potential outlet temp, f
tOutletXXnumberend of each hourTick outlet temp, f (at tank / after from-collector piping)
tickVolXXnumberend of each subhourVolume moved during this tick, gal
pumpInElecXXnumberend of each hourActual electricity use (note not kwh)

6.21 DHWSolarSys

@DHWSolarSys[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
elecMtriXXinteger numberinput timeMeter for pump and parasitic electricity use
endUseXXinteger numberinput timeEnd use of pump energy. defaults to “dhw”
parElecXXnumberhourlyParasitic electricity use, w
scAreaTotXXnumberrun start time (of each phase, autoSize or simulate)Total of child dhwsolarcollectors, ft2
scCountXXnumberrun start time (of each phase, autoSize or simulate)# of child dhwsolarcollectors (not necessarily # of panels)
tank.tExXXnumberend of each subhour
tank.tASHPSrcXXnumberend of each subhour
tank.fMixUseXXnumberend of each subhour
tank.fMixRLXXnumberend of each subhour
tank.inElec[0]XXnumberend of each subhour
tank.inElec[1]XXnumberend of each subhour
tank.heatAdded[0]XXnumberend of each subhour
tank.heatAdded[1]XXnumberend of each subhour
tank.tOutXXnumberend of each subhour
tank.tOutCHDHWXXnumberend of each subhour
tank.HPWHxBUXXnumberend of each subhour
tank.qEnvXXnumberend of each subhour
tank.qLossXXnumberend of each subhour
tank.qHWXXnumberend of each subhour
tank.qTXXXnumberend of each subhour
tank.tankHCNominalXXnumberend of each subhour
tank.tankHCBegXXnumberend of each subhour
tank.tankHCEndXXnumberend of each subhour
tank.tHWOutFXXnumberend of each subhour
tank.tHWOutXXnumberend of each subhour
tank.qBalXXnumberend of each subhour
tank.balErrMaxXXnumberend of each subhour
tankVolXXnumberrun start time (of each phase, autoSize or simulate)Tank volume, gal
tankUAXXnumberrun start time (of each phase, autoSize or simulate)Tank water-to-air ua, btuh/f
tankInsulRXXnumberrun start time (of each phase, autoSize or simulate)Total tank insulation resistance, hr-f/btuh
tankZnTiXXinteger numberinput timeTank location zone re tank loss
tankTExXXnumberhourlySurrounding temperature, f for tank loss
tankTAvgXXnumberend of each hourHour average tank temp, f (check figure)
tankQLossXXnumberend of each hourCurrent hour’s total tank loss, btu
tankHXEffXXnumberhourlyTank heat exchanger effectiveness
tankTHxLimitXXnumberinput timeTank temp limit, f; collector heat
tickVolXXnumberend of each subhourCurrent tick draw to dhwsyss, gal
tickVolTXXnumberend of each subhourCurrent tick (vol * inlet temp), gal-f
tickTankTOutletXXnumberend of each subhourCurrent tick tank outlet temp
drawVolXXnumberend of each hourCurrent hour total draw, gal
tankQGainXXnumberend of each hourCurrent hour total gain from solar hx (all collectors), btu
tankQGainTotXXnumberend of run (of each phase, autoSize or simulate)Sw_tankqgain annual total, btu
tankTInletXXnumberend of each hourTank inlet temperature, f
tankTOutletXXnumberend of each hourCurrent hour average tank outlet temperature, f
tankTHxXXnumberend of each hourNominal tank heat exchange temp, f
totOutXXnumberend of each hourCurrent hour total dhwsolarsys output, btu
scFluidSpHtXXnumberinput timeCollector working fluid specific heat, btu/lbm-f
scFluidDensXXnumberinput timeCollector working fluid density, lb/ft3
scFluidVHCXXnumberrun start time (of each phase, autoSize or simulate)Collector working fluid volumetric heat capacity, btu/gal-f
scTInletXXnumberend of each hourMixed collector inlet temperature, f
scTOutletXXnumberend of each hourMixed collector outlet temperature, f
overHeatHrCountXXinteger numberend of run (of each phase, autoSize or simulate)Number of hours during which collector did not
SSFAnnualXXnumberend of run (of each phase, autoSize or simulate)Annual solar savings fraction

6.22 DHWSYS

@DHWSYS[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
calcModeXXunrecognizedinput timeCalculation mode
centralDHWSYSiXXinteger numberinput timeIndex of central (parent) dhwsys, 0 if none
multXXnumberinput timeMultiplier: model as ws_mult identical systems
elecMtriXXinteger numberinput timeMeter for system electricity use
fuelMtriXXinteger numberinput timeMeter for system fuel use
inElecXXnumberend of each hourElectricity (note not kwh)
inFuelXXnumberend of each hourFuel (for generality, always 0?)
swTiXXinteger numberinput timeDhwsolarsys providing preheated water to this system
qSlrXXnumberend of each hourHour total water heating energy provided by
SSFAnnualSolarXXnumberend of run (of each phase, autoSize or simulate)Annual solar heat added (numerator to calculate ssf), btu
SSFAnnualReqXXnumberend of run (of each phase, autoSize or simulate)Annual heat required (denominator to calculate ssf), btu
SSFAnnualXXnumberend of run (of each phase, autoSize or simulate)Annual solar savings fraction
tInletXXnumberend of each hourCurrent hour cold water inlet temp for this dhwsys, f
tInletTestXXnumbersubhourlyCurrent subhour cold water inlet temp for this dhwsys, f
tInletXXXnumberend of each hourHour average adjusted cold water temp, f
hwUseXXnumberhourlyCurrent hour hot water use (at fixtures), gal
hwUseTestXXnumbersubhourlyCurrent subhour additional hot water use (at fixtures), gal/subhour
tRLTestXXnumbersubhourlyCurrent subour dhwloop return temp, f
volRLTestXXnumbersubhourlyCurrent subour recirc loop flow, gal (per subhr)
qDWHRXXnumberend of each hourHour all dhwheatrec total heat to fixtures and water heaters, btu
qDWHRWHXXnumberend of each hourHour all dhwheatrec total heat to water heater(s), btu
WHhwMtriXXinteger numberinput timeDhwmtr for hot water use at water heater(s) (= ws_whuse), gal
FXhwMtriXXinteger numberinput timeDhwmtr for hot water use at fixtures (= ws_fxusemix), gal
whUseNoHRXXnumberend of each hourCurrent hour virtual hot water use w/o heat recovery, gal
fxUseMix.totalXXnumberend of each hour
fxUseMix.unknownXXnumberend of each hour
fxUseMix.faucetXXnumberend of each hour
fxUseMix.showerXXnumberend of each hour
fxUseMix.bathXXnumberend of each hour
fxUseMix.cwashrXXnumberend of each hour
fxUseMix.dwashrXXnumberend of each hour
fxUseMixTot[0]XXnumberend of run (of each phase, autoSize or simulate)Annual total (mixed) water use at fixtures by end use, gal
fxUseMixTot[1]XXnumberend of run (of each phase, autoSize or simulate)Annual total (mixed) water use at fixtures by end use, gal
fxUseMixTot[2]XXnumberend of run (of each phase, autoSize or simulate)Annual total (mixed) water use at fixtures by end use, gal
fxUseMixTot[3]XXnumberend of run (of each phase, autoSize or simulate)Annual total (mixed) water use at fixtures by end use, gal
fxUseMixTot[4]XXnumberend of run (of each phase, autoSize or simulate)Annual total (mixed) water use at fixtures by end use, gal
fxUseMixTot[5]XXnumberend of run (of each phase, autoSize or simulate)Annual total (mixed) water use at fixtures by end use, gal
fxUseMixTot[6]XXnumberend of run (of each phase, autoSize or simulate)Annual total (mixed) water use at fixtures by end use, gal
fxUseMixTot[7]XXnumberend of run (of each phase, autoSize or simulate)Annual total (mixed) water use at fixtures by end use, gal
fxUseMixLH.totalXXnumberhourly
fxUseMixLH.unknownXXnumberhourly
fxUseMixLH.faucetXXnumberhourly
fxUseMixLH.showerXXnumberhourly
fxUseMixLH.bathXXnumberhourly
fxUseMixLH.cwashrXXnumberhourly
fxUseMixLH.dwashrXXnumberhourly
whUse.totalXXnumberend of each hour
whUse.unknownXXnumberend of each hour
whUse.faucetXXnumberend of each hour
whUse.showerXXnumberend of each hour
whUse.bathXXnumberend of each hour
whUse.cwashrXXnumberend of each hour
whUse.dwashrXXnumberend of each hour
whUseTot[0]XXnumberend of run (of each phase, autoSize or simulate)Annual total hot water use by end use (at ws_tuse), gal
whUseTot[1]XXnumberend of run (of each phase, autoSize or simulate)Annual total hot water use by end use (at ws_tuse), gal
whUseTot[2]XXnumberend of run (of each phase, autoSize or simulate)Annual total hot water use by end use (at ws_tuse), gal
whUseTot[3]XXnumberend of run (of each phase, autoSize or simulate)Annual total hot water use by end use (at ws_tuse), gal
whUseTot[4]XXnumberend of run (of each phase, autoSize or simulate)Annual total hot water use by end use (at ws_tuse), gal
whUseTot[5]XXnumberend of run (of each phase, autoSize or simulate)Annual total hot water use by end use (at ws_tuse), gal
whUseTot[6]XXnumberend of run (of each phase, autoSize or simulate)Annual total hot water use by end use (at ws_tuse), gal
whUseTot[7]XXnumberend of run (of each phase, autoSize or simulate)Annual total hot water use by end use (at ws_tuse), gal
drawMaxDurXXinteger numberinput timeDraw duration window, hr (user input, default 4)
drawMaxXXnumberinput timeLargest draw total in any conseq ws_drawmaxdur hrs, gal
loadMaxDurXXinteger numberinput timeLoad duration window, hr (user input, default 12)
loadMaxXXnumberinput timeLargest load total in any conseq ws_loadmaxdur hrs, btu
tSetpointDesXXnumberinput timeDesign (sizing) set point temp, f (constant)
tInletDesXXnumberinput timeDesign (sizing) cold water inlet temp, f
ashpTSrcDesXXnumberend of run (of each phase, autoSize or simulate)Design (sizing) hpwh source air temperature, f
heatingCapDesTopN[0]XXnumberend of run (of each phase, autoSize or simulate)Top n design heating capacities
heatingCapDesTopN[1]XXnumberend of run (of each phase, autoSize or simulate)Top n design heating capacities
heatingCapDesTopN[2]XXnumberend of run (of each phase, autoSize or simulate)Top n design heating capacities
heatingCapDesTopN[3]XXnumberend of run (of each phase, autoSize or simulate)Top n design heating capacities
heatingCapDesTopN[4]XXnumberend of run (of each phase, autoSize or simulate)Top n design heating capacities
heatingCapDesTopN[5]XXnumberend of run (of each phase, autoSize or simulate)Top n design heating capacities
heatingCapDesTopN[6]XXnumberend of run (of each phase, autoSize or simulate)Top n design heating capacities
heatingCapDesTopN[7]XXnumberend of run (of each phase, autoSize or simulate)Top n design heating capacities
heatingCapDesTopN[8]XXnumberend of run (of each phase, autoSize or simulate)Top n design heating capacities
heatingCapDesTopN[9]XXnumberend of run (of each phase, autoSize or simulate)Top n design heating capacities
heatingCapDesXXnumberinput timeDesign heating capacity, btuh
volRunningDesXXnumberinput timeDesign running volume, gal
fxDesXXnumberinput timeDhw design excess size factor, default 1
tUseXXnumberrun start time (of each phase, autoSize or simulate)Hot water use temp, f
tUseTestXXnumbersubhourlyCurrent subhour test hot water use temp, f
tSetpointXXnumberhourlyDhwheater set point (for all dhwheaters using hpwh model), f
tSetpointLHXXnumberhourlyDhwloopheater set point (for all child dhwloopheaters using hpwh model), f
drMethodXXunrecognizedrun start time (of each phase, autoSize or simulate)Dhw demand response control method
drSignalXXunrecognizedhourlyDhw demand response control signal
targetSoCXXnumberhourlyTarget state of charge (soc)
tOutPrimLTXXnumberend of each subhourPrimary water heater outlet temp, f
dayUseiXXinteger numberdailyIdx of dhwdayuse
dayUseNameXXstringdailyName of dhwdayuse (resolved at runtime)
parElecXXnumberhourlyElectrical parasitic power, w
SDLMXXnumberinput timeStandard distribution loss multiplier
DSMXXnumberinput timeDistribution system multiplier (appe table re-2)
SSFXXnumberhourlyUser input solar savings fraction
WFXXnumberhourlyWaste factor applied to ws_hwuse and dhwuses
drawsPerDay[0]XXnumberrun start time (of each phase, autoSize or simulate)
drawsPerDay[1]XXnumberrun start time (of each phase, autoSize or simulate)
drawsPerDay[2]XXnumberrun start time (of each phase, autoSize or simulate)
drawsPerDay[3]XXnumberrun start time (of each phase, autoSize or simulate)
drawsPerDay[4]XXnumberrun start time (of each phase, autoSize or simulate)
drawsPerDay[5]XXnumberrun start time (of each phase, autoSize or simulate)
drawDurF[0]XXnumberend of each hourWater heater draw duration factors by end use
drawDurF[1]XXnumberend of each hourWater heater draw duration factors by end use
drawDurF[2]XXnumberend of each hourWater heater draw duration factors by end use
drawDurF[3]XXnumberend of each hourWater heater draw duration factors by end use
drawDurF[4]XXnumberend of each hourWater heater draw duration factors by end use
drawDurF[5]XXnumberend of each hourWater heater draw duration factors by end use
branchModelXXunrecognizedinput timeBranch model selection
drawWaste[0]XXnumberhourlyWater waste per draw, gal
drawWaste[1]XXnumberhourlyWater waste per draw, gal
drawWaste[2]XXnumberhourlyWater waste per draw, gal
drawWaste[3]XXnumberhourlyWater waste per draw, gal
drawWaste[4]XXnumberhourlyWater waste per draw, gal
drawWaste[5]XXnumberhourlyWater waste per draw, gal
dayWasteDrawF[0]XXnumberinput timeRelative draw for day waste scheme
dayWasteDrawF[1]XXnumberinput timeRelative draw for day waste scheme
dayWasteDrawF[2]XXnumberinput timeRelative draw for day waste scheme
dayWasteDrawF[3]XXnumberinput timeRelative draw for day waste scheme
dayWasteDrawF[4]XXnumberinput timeRelative draw for day waste scheme
dayWasteDrawF[5]XXnumberinput timeRelative draw for day waste scheme
dayWasteVolXXnumberinput timeBase daily total draw waste, gal/day
dayWasteBranchVolFXXnumberinput timeAdditional daily draw waste, discards/day
dayWasteXXnumberrun start time (of each phase, autoSize or simulate)Daily draw waste, gal/day
dayWasteScaleXXnumberend of run (of each phase, autoSize or simulate)
childDHWSYSCountXXnumberrun start time (of each phase, autoSize or simulate)# of child dhwsyss iff central system (else 0)
whCountXXnumberrun start time (of each phase, autoSize or simulate)# of (primary) dhwheaters serving this dhwsys
wlhCountXXnumberrun start time (of each phase, autoSize or simulate)# of dhwloopheaters in this dhwsys
whCountUseTSXXnumberrun start time (of each phase, autoSize or simulate)# of dhwheaters serving this dhwsys that respond to ws_tsetpoint
wlhCountUseTSXXnumberrun start time (of each phase, autoSize or simulate)# of dhwloopheaters serving this dhwsys that respond to ws_tsetpointlh
loopSegTotals.countXXnumberrun start time (of each phase, autoSize or simulate)# of segments included in totals
loopSegTotals.lenXXnumberrun start time (of each phase, autoSize or simulate)Length, ft
loopSegTotals.volXXnumberrun start time (of each phase, autoSize or simulate)Volume, gal
loopSegTotals.exAreaXXnumberrun start time (of each phase, autoSize or simulate)Outside surface area (at insulation surface), ft2
loopSegTotals.UAXXnumberrun start time (of each phase, autoSize or simulate)Fluid-to-surround loss, btuh/f-hr
branchTotals.countXXnumberrun start time (of each phase, autoSize or simulate)# of segments included in totals
branchTotals.lenXXnumberrun start time (of each phase, autoSize or simulate)Length, ft
branchTotals.volXXnumberrun start time (of each phase, autoSize or simulate)Volume, gal
branchTotals.exAreaXXnumberrun start time (of each phase, autoSize or simulate)Outside surface area (at insulation surface), ft2
branchTotals.UAXXnumberrun start time (of each phase, autoSize or simulate)Fluid-to-surround loss, btuh/f-hr
fxCount[0]XXinteger numberrun start time (of each phase, autoSize or simulate)
fxCount[1]XXinteger numberrun start time (of each phase, autoSize or simulate)
fxCount[2]XXinteger numberrun start time (of each phase, autoSize or simulate)
fxCount[3]XXinteger numberrun start time (of each phase, autoSize or simulate)
fxCount[4]XXinteger numberrun start time (of each phase, autoSize or simulate)
fxCount[5]XXinteger numberrun start time (of each phase, autoSize or simulate)
loadShareDHWSYSiXXinteger numberinput timeIndex of dhwsys with which this dhwsys shares load
drawCSVXXinteger numberinput timeIff c_noyesch_yes, write tick-level draw data to
HHWOXXnumberend of each hourCurrent total recovery load (at water heater), btu
DLMXXnumberend of each hourDistribution loss multiplier (calc’d)
volRLXXnumberend of each hourCurrent hour all-dhwloop return volume, gal
tRLXXnumberend of each hourCurrent hour all-dhwloop return temp, f
HRBLXXnumberend of each hourCurrent hour all-dhwloopbranch losses, btu
t24WLXXnumberend of each hourCurrent hour all-dhwloopbranch waste loss volume, gal
t24WLTotXXnumberend of run (of each phase, autoSize or simulate)Annual total ws_t24wl, gal
volCHDHWXXnumberend of each subhourCurrent subhour all-rsys combined heat/dhw (chdhw) draw, gal
tRCHDHWXXnumberend of each subhourCurrent subhour average combined heat/dhw (chdhw) return temp, f
CHDHWHtgFractSHXXnumberend of each subhourCurrent subhour fraction of dhwsys output that
CHDHWHtgFractAvgXXnumberend of each subhourFraction of dhwsys output that supplied chdhw load(s)
HRDLXXnumberend of each hourCurrent hour recirculation loss, btu
HJLshXXnumberend of each subhourCurrent subhour jacket losses (from dhwtanks), btu
HJLXXnumberend of each hourHour total jacket losses (from dhwtanks), btu
HARLXXnumberend of each hourHour total adjusted recovery load, btu

6.23 DHWSYSRES

@DHWSYSRES[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXstringconstant
Y.qOutDHWXnumberend of run (of each phase, autoSize or simulate)Hot water energy delivered to fixtures, btu (>=0, + = from dhwsys)
Y.qOutHtgXnumberend of run (of each phase, autoSize or simulate)Space heating (chdhw) energy delivered, btu (>=0, + = from dhwsys)
Y.qLossMiscXnumberend of run (of each phase, autoSize or simulate)Misc non-loop losses, btu (dhwtank losses, t24dhw branch losses, <= 0)
Y.qLossLoopXnumberend of run (of each phase, autoSize or simulate)Dhwloop/dhwloopbranch losses, btu (+ = to dhwsys, typically <= 0)
Y.qDWHRXnumberend of run (of each phase, autoSize or simulate)Heat added via drain water heat recovery (dwhr), btu (+ = to dhwsys, >= 0)
Y.qSSFXnumberend of run (of each phase, autoSize or simulate)Implied energy contribution from ws_ssf, btu (+ = to dhwsys, >= 0)
Y.qSolarXnumberend of run (of each phase, autoSize or simulate)Dhwsolarsys contribution, btu (+ = to dhwsys, >= 0)
Y.qPrimary[0]Xnumberend of run (of each phase, autoSize or simulate)Dhwheater [0] or dhwloopheater [1] primary heat added, btu
Y.qPrimary[1]Xnumberend of run (of each phase, autoSize or simulate)Dhwheater [0] or dhwloopheater [1] primary heat added, btu
Y.qAux[0]Xnumberend of run (of each phase, autoSize or simulate)Dhwheater [0] or dhwloopheater [1] in-tank aux heat added, btu
Y.qAux[1]Xnumberend of run (of each phase, autoSize or simulate)Dhwheater [0] or dhwloopheater [1] in-tank aux heat added, btu
Y.qLoss[0]Xnumberend of run (of each phase, autoSize or simulate)Dhwheater [0] or dhwloopheater [1] tank loss, btu
Y.qLoss[1]Xnumberend of run (of each phase, autoSize or simulate)Dhwheater [0] or dhwloopheater [1] tank loss, btu
Y.qStorage[0]Xnumberend of run (of each phase, autoSize or simulate)Dhwheater [0] or dhwloopheater [1] change in tank heat content, btu
Y.qStorage[1]Xnumberend of run (of each phase, autoSize or simulate)Dhwheater [0] or dhwloopheater [1] change in tank heat content, btu
Y.qError[0]Xnumberend of run (of each phase, autoSize or simulate)Dhwheater [0] or dhwloopheater [1] hpwh internal heat balance error, btu
Y.qError[1]Xnumberend of run (of each phase, autoSize or simulate)Dhwheater [0] or dhwloopheater [1] hpwh internal heat balance error, btu
Y.qXBUDHWXnumberend of run (of each phase, autoSize or simulate)Extra backup heating allocated to dhw, btu (+ = to dhwsys, >= 0)
Y.qXBUHtgXnumberend of run (of each phase, autoSize or simulate)Extra backup heating allocated to space heating, btu (+ = to dhwsys, >= 0)
Y.qBalXnumberend of run (of each phase, autoSize or simulate)Sum of energy flows, btu = (qoutdhw + qouthtg) - sum( everything else)
M.qOutDHWXnumberend of each monthHot water energy delivered to fixtures, btu (>=0, + = from dhwsys)
M.qOutHtgXnumberend of each monthSpace heating (chdhw) energy delivered, btu (>=0, + = from dhwsys)
M.qLossMiscXnumberend of each monthMisc non-loop losses, btu (dhwtank losses, t24dhw branch losses, <= 0)
M.qLossLoopXnumberend of each monthDhwloop/dhwloopbranch losses, btu (+ = to dhwsys, typically <= 0)
M.qDWHRXnumberend of each monthHeat added via drain water heat recovery (dwhr), btu (+ = to dhwsys, >= 0)
M.qSSFXnumberend of each monthImplied energy contribution from ws_ssf, btu (+ = to dhwsys, >= 0)
M.qSolarXnumberend of each monthDhwsolarsys contribution, btu (+ = to dhwsys, >= 0)
M.qPrimary[0]Xnumberend of each monthDhwheater [0] or dhwloopheater [1] primary heat added, btu
M.qPrimary[1]Xnumberend of each monthDhwheater [0] or dhwloopheater [1] primary heat added, btu
M.qAux[0]Xnumberend of each monthDhwheater [0] or dhwloopheater [1] in-tank aux heat added, btu
M.qAux[1]Xnumberend of each monthDhwheater [0] or dhwloopheater [1] in-tank aux heat added, btu
M.qLoss[0]Xnumberend of each monthDhwheater [0] or dhwloopheater [1] tank loss, btu
M.qLoss[1]Xnumberend of each monthDhwheater [0] or dhwloopheater [1] tank loss, btu
M.qStorage[0]Xnumberend of each monthDhwheater [0] or dhwloopheater [1] change in tank heat content, btu
M.qStorage[1]Xnumberend of each monthDhwheater [0] or dhwloopheater [1] change in tank heat content, btu
M.qError[0]Xnumberend of each monthDhwheater [0] or dhwloopheater [1] hpwh internal heat balance error, btu
M.qError[1]Xnumberend of each monthDhwheater [0] or dhwloopheater [1] hpwh internal heat balance error, btu
M.qXBUDHWXnumberend of each monthExtra backup heating allocated to dhw, btu (+ = to dhwsys, >= 0)
M.qXBUHtgXnumberend of each monthExtra backup heating allocated to space heating, btu (+ = to dhwsys, >= 0)
M.qBalXnumberend of each monthSum of energy flows, btu = (qoutdhw + qouthtg) - sum( everything else)
D.qOutDHWXnumberend of each dayHot water energy delivered to fixtures, btu (>=0, + = from dhwsys)
D.qOutHtgXnumberend of each daySpace heating (chdhw) energy delivered, btu (>=0, + = from dhwsys)
D.qLossMiscXnumberend of each dayMisc non-loop losses, btu (dhwtank losses, t24dhw branch losses, <= 0)
D.qLossLoopXnumberend of each dayDhwloop/dhwloopbranch losses, btu (+ = to dhwsys, typically <= 0)
D.qDWHRXnumberend of each dayHeat added via drain water heat recovery (dwhr), btu (+ = to dhwsys, >= 0)
D.qSSFXnumberend of each dayImplied energy contribution from ws_ssf, btu (+ = to dhwsys, >= 0)
D.qSolarXnumberend of each dayDhwsolarsys contribution, btu (+ = to dhwsys, >= 0)
D.qPrimary[0]Xnumberend of each dayDhwheater [0] or dhwloopheater [1] primary heat added, btu
D.qPrimary[1]Xnumberend of each dayDhwheater [0] or dhwloopheater [1] primary heat added, btu
D.qAux[0]Xnumberend of each dayDhwheater [0] or dhwloopheater [1] in-tank aux heat added, btu
D.qAux[1]Xnumberend of each dayDhwheater [0] or dhwloopheater [1] in-tank aux heat added, btu
D.qLoss[0]Xnumberend of each dayDhwheater [0] or dhwloopheater [1] tank loss, btu
D.qLoss[1]Xnumberend of each dayDhwheater [0] or dhwloopheater [1] tank loss, btu
D.qStorage[0]Xnumberend of each dayDhwheater [0] or dhwloopheater [1] change in tank heat content, btu
D.qStorage[1]Xnumberend of each dayDhwheater [0] or dhwloopheater [1] change in tank heat content, btu
D.qError[0]Xnumberend of each dayDhwheater [0] or dhwloopheater [1] hpwh internal heat balance error, btu
D.qError[1]Xnumberend of each dayDhwheater [0] or dhwloopheater [1] hpwh internal heat balance error, btu
D.qXBUDHWXnumberend of each dayExtra backup heating allocated to dhw, btu (+ = to dhwsys, >= 0)
D.qXBUHtgXnumberend of each dayExtra backup heating allocated to space heating, btu (+ = to dhwsys, >= 0)
D.qBalXnumberend of each daySum of energy flows, btu = (qoutdhw + qouthtg) - sum( everything else)
H.qOutDHWXnumberend of each hourHot water energy delivered to fixtures, btu (>=0, + = from dhwsys)
H.qOutHtgXnumberend of each hourSpace heating (chdhw) energy delivered, btu (>=0, + = from dhwsys)
H.qLossMiscXnumberend of each hourMisc non-loop losses, btu (dhwtank losses, t24dhw branch losses, <= 0)
H.qLossLoopXnumberend of each hourDhwloop/dhwloopbranch losses, btu (+ = to dhwsys, typically <= 0)
H.qDWHRXnumberend of each hourHeat added via drain water heat recovery (dwhr), btu (+ = to dhwsys, >= 0)
H.qSSFXnumberend of each hourImplied energy contribution from ws_ssf, btu (+ = to dhwsys, >= 0)
H.qSolarXnumberend of each hourDhwsolarsys contribution, btu (+ = to dhwsys, >= 0)
H.qPrimary[0]Xnumberend of each hourDhwheater [0] or dhwloopheater [1] primary heat added, btu
H.qPrimary[1]Xnumberend of each hourDhwheater [0] or dhwloopheater [1] primary heat added, btu
H.qAux[0]Xnumberend of each hourDhwheater [0] or dhwloopheater [1] in-tank aux heat added, btu
H.qAux[1]Xnumberend of each hourDhwheater [0] or dhwloopheater [1] in-tank aux heat added, btu
H.qLoss[0]Xnumberend of each hourDhwheater [0] or dhwloopheater [1] tank loss, btu
H.qLoss[1]Xnumberend of each hourDhwheater [0] or dhwloopheater [1] tank loss, btu
H.qStorage[0]Xnumberend of each hourDhwheater [0] or dhwloopheater [1] change in tank heat content, btu
H.qStorage[1]Xnumberend of each hourDhwheater [0] or dhwloopheater [1] change in tank heat content, btu
H.qError[0]Xnumberend of each hourDhwheater [0] or dhwloopheater [1] hpwh internal heat balance error, btu
H.qError[1]Xnumberend of each hourDhwheater [0] or dhwloopheater [1] hpwh internal heat balance error, btu
H.qXBUDHWXnumberend of each hourExtra backup heating allocated to dhw, btu (+ = to dhwsys, >= 0)
H.qXBUHtgXnumberend of each hourExtra backup heating allocated to space heating, btu (+ = to dhwsys, >= 0)
H.qBalXnumberend of each hourSum of energy flows, btu = (qoutdhw + qouthtg) - sum( everything else)
S.qOutDHWXnumberend of each subhourHot water energy delivered to fixtures, btu (>=0, + = from dhwsys)
S.qOutHtgXnumberend of each subhourSpace heating (chdhw) energy delivered, btu (>=0, + = from dhwsys)
S.qLossMiscXnumberend of each subhourMisc non-loop losses, btu (dhwtank losses, t24dhw branch losses, <= 0)
S.qLossLoopXnumberend of each subhourDhwloop/dhwloopbranch losses, btu (+ = to dhwsys, typically <= 0)
S.qDWHRXnumberend of each subhourHeat added via drain water heat recovery (dwhr), btu (+ = to dhwsys, >= 0)
S.qSSFXnumberend of each subhourImplied energy contribution from ws_ssf, btu (+ = to dhwsys, >= 0)
S.qSolarXnumberend of each subhourDhwsolarsys contribution, btu (+ = to dhwsys, >= 0)
S.qPrimary[0]Xnumberend of each subhourDhwheater [0] or dhwloopheater [1] primary heat added, btu
S.qPrimary[1]Xnumberend of each subhourDhwheater [0] or dhwloopheater [1] primary heat added, btu
S.qAux[0]Xnumberend of each subhourDhwheater [0] or dhwloopheater [1] in-tank aux heat added, btu
S.qAux[1]Xnumberend of each subhourDhwheater [0] or dhwloopheater [1] in-tank aux heat added, btu
S.qLoss[0]Xnumberend of each subhourDhwheater [0] or dhwloopheater [1] tank loss, btu
S.qLoss[1]Xnumberend of each subhourDhwheater [0] or dhwloopheater [1] tank loss, btu
S.qStorage[0]Xnumberend of each subhourDhwheater [0] or dhwloopheater [1] change in tank heat content, btu
S.qStorage[1]Xnumberend of each subhourDhwheater [0] or dhwloopheater [1] change in tank heat content, btu
S.qError[0]Xnumberend of each subhourDhwheater [0] or dhwloopheater [1] hpwh internal heat balance error, btu
S.qError[1]Xnumberend of each subhourDhwheater [0] or dhwloopheater [1] hpwh internal heat balance error, btu
S.qXBUDHWXnumberend of each subhourExtra backup heating allocated to dhw, btu (+ = to dhwsys, >= 0)
S.qXBUHtgXnumberend of each subhourExtra backup heating allocated to space heating, btu (+ = to dhwsys, >= 0)
S.qBalXnumberend of each subhourSum of energy flows, btu = (qoutdhw + qouthtg) - sum( everything else)

6.24 DHWTank (owner: DHWSYS)

@DHWTank[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
multXXinteger numberinput timeCount of identical dhw tanks (default 1)
UAXXnumberinput timeTank water-to-air ua, btuh/f
volXXnumberinput timeTank volume, gal
insulRXXnumberinput timeTotal tank insulation resistance, hr-f/btuh
tTankXXnumberhourlyAssumed tank water temperature, f
znTiXXinteger numberinput timeDhwtank location zone re tank loss
tExXXnumberhourlySurrounding temperature, f for tank loss
xLossXXnumberhourlyOther tank temp-independent losses, btuh
qLossShXXnumberend of each subhourCurrent subhr loss rate, btuh
qLossXXnumberend of each hourCurrent hour’s total loss, btu

6.25 DHWUse (owner: DHWDayUse)

@DHWUse[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
hwEndUseXXinteger numberinput timeHot water end use
eventIDXXinteger numberinput timeUser-defined index that identifies dhwuses belonging to a single
startXXnumberhourlyDraw starting hour of day, 0 - 23.999
durXXnumberhourlyFlow duration, min
flowXXnumberhourlyMixed flow rate, gpm
hotFXXnumberhourlyFraction hot water, default = 1
tempXXnumberhourlyUse temperature, f. if given,
heatRecEFXXnumberhourlyHeat recovery effectiveness

6.26 doas

@doas[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
supFan.fanTyXXunrecognizedautosize and simulate phase start time
supFan.vfDsXXnumberend of each subhourDesign supply volumetric flow rate of the heat exchanger
supFan.vfDs_AsXXnumberautosize and simulate phase start time
supFan.vfDs_AsNovXXnumberautosize and simulate phase start time
supFan.vfMxFXXnumberautosize and simulate phase start time
supFan.pressXXnumberrun start time (of each phase, autoSize or simulate)
supFan.effXXnumberrun start time (of each phase, autoSize or simulate)
supFan.shaftPwrXXnumberrun start time (of each phase, autoSize or simulate)
supFan.elecPwrXXnumberrun start time (of each phase, autoSize or simulate)
supFan.motTyXXunrecognizedrun start time (of each phase, autoSize or simulate)
supFan.motEffXXnumberautosize and simulate phase start time
supFan.motPosXXunrecognizedautosize and simulate phase start time
supFan.curvePy.k[0]XXnumberautosize and simulate phase start time
supFan.curvePy.k[1]XXnumberautosize and simulate phase start time
supFan.curvePy.k[2]XXnumberautosize and simulate phase start time
supFan.curvePy.k[3]XXnumberautosize and simulate phase start time
supFan.curvePy.k[4]XXnumberautosize and simulate phase start time
supFan.curvePy.k[5]XXnumberautosize and simulate phase start time
supFan.mtriXXinteger numberinput time
supFan.endUseXXinteger numberautosize and simulate phase start time
supFan.auszXXinteger numberrun start time (of each phase, autoSize or simulate)
supFan.outPowerXXnumbersubhourly
supFan.airPowerXXnumbersubhourly
supFan.cMxXXnumberend of each subhour
supFan.cXXnumberend of each subhour
supFan.tXXnumberend of each subhour
supFan.frOnXXnumberend of each subhour
supFan.pXXnumberend of each subhour
supFan.qXXnumberend of each subhour
supFan.dTXXnumberend of each subhour
supFan.qAroundXXnumberend of each subhour
exhFan.fanTyXXunrecognizedautosize and simulate phase start time
exhFan.vfDsXXnumberend of each subhourDesign supply volumetric flow rate of the heat exchanger
exhFan.vfDs_AsXXnumberautosize and simulate phase start time
exhFan.vfDs_AsNovXXnumberautosize and simulate phase start time
exhFan.vfMxFXXnumberautosize and simulate phase start time
exhFan.pressXXnumberrun start time (of each phase, autoSize or simulate)
exhFan.effXXnumberrun start time (of each phase, autoSize or simulate)
exhFan.shaftPwrXXnumberrun start time (of each phase, autoSize or simulate)
exhFan.elecPwrXXnumberrun start time (of each phase, autoSize or simulate)
exhFan.motTyXXunrecognizedrun start time (of each phase, autoSize or simulate)
exhFan.motEffXXnumberautosize and simulate phase start time
exhFan.motPosXXunrecognizedautosize and simulate phase start time
exhFan.curvePy.k[0]XXnumberautosize and simulate phase start time
exhFan.curvePy.k[1]XXnumberautosize and simulate phase start time
exhFan.curvePy.k[2]XXnumberautosize and simulate phase start time
exhFan.curvePy.k[3]XXnumberautosize and simulate phase start time
exhFan.curvePy.k[4]XXnumberautosize and simulate phase start time
exhFan.curvePy.k[5]XXnumberautosize and simulate phase start time
exhFan.mtriXXinteger numberinput time
exhFan.endUseXXinteger numberautosize and simulate phase start time
exhFan.auszXXinteger numberrun start time (of each phase, autoSize or simulate)
exhFan.outPowerXXnumbersubhourly
exhFan.airPowerXXnumbersubhourly
exhFan.cMxXXnumberend of each subhour
exhFan.cXXnumberend of each subhour
exhFan.tXXnumberend of each subhour
exhFan.frOnXXnumberend of each subhour
exhFan.pXXnumberend of each subhour
exhFan.qXXnumberend of each subhour
exhFan.dTXXnumberend of each subhour
exhFan.qAroundXXnumberend of each subhour
supTHXXnumbersubhourlySupply temperature heating setpoint
EIRHXXnumbersubhourlyHeating coil energy input ratio (1/efficiency (or 1/cop)
coilHMtriXXinteger numberinput timeMeter for heating coil
supTCXXnumbersubhourlySupply temperature cooling setpoint
EIRCXXnumbersubhourlyCooling coil energy input ratio (1/efficiency (or 1/cop)
SHRtargetXXnumbersubhourlyTarget cooling coil shr. could be overriden by oa_shr.
coilCMtriXXinteger numberinput timeMeter for heating coil
loadMtriXXinteger numberinput timeLoadmtr idx for accumulation of coil output
tExXXnumbersubhourlyDoas exterior air drybulb temp, f
wExXXnumbersubhourlyDoas exterior air humidity ratio, lb/lb
hx.VfDsXXnumberrun start time (of each phase, autoSize or simulate)Design supply volumetric flow rate of the heat exchanger
hx.f2XXnumberrun start time (of each phase, autoSize or simulate)Flow fraction for second set of inputs (default 0.75)
hx.senEffH[0]XXnumberrun start time (of each phase, autoSize or simulate)Heat exchanger heating sensible effectiveness
hx.senEffH[1]XXnumberrun start time (of each phase, autoSize or simulate)Heat exchanger heating sensible effectiveness
hx.latEffH[0]XXnumberrun start time (of each phase, autoSize or simulate)Heat exchanger heating latent effectiveness
hx.latEffH[1]XXnumberrun start time (of each phase, autoSize or simulate)Heat exchanger heating latent effectiveness
hx.senEffC[0]XXnumberrun start time (of each phase, autoSize or simulate)Heat exchanger cooling sensible effectiveness
hx.senEffC[1]XXnumberrun start time (of each phase, autoSize or simulate)Heat exchanger cooling sensible effectiveness
hx.latEffC[0]XXnumberrun start time (of each phase, autoSize or simulate)Heat exchanger cooling latent effectiveness
hx.latEffC[1]XXnumberrun start time (of each phase, autoSize or simulate)Heat exchanger cooling latent effectiveness
hx.bypassXXinteger numberrun start time (of each phase, autoSize or simulate)Hx can be bypassed when not adventatgeous
hx.auxPwrXXnumbersubhourlyAuxiliary power, w
hx.auxMtriXXinteger numberrun start time (of each phase, autoSize or simulate)Meter for auxiliary power
hx.supInAF.tdbXXnumberend of each subhour
hx.supInAF.wXXnumberend of each subhour
hx.supInAF.amfXXnumberend of each subhour
hx.hxInAF.tdbXXnumberend of each subhour
hx.hxInAF.wXXnumberend of each subhour
hx.hxInAF.amfXXnumberend of each subhour
hx.hxOutAF.tdbXXnumberend of each subhour
hx.hxOutAF.wXXnumberend of each subhour
hx.hxOutAF.amfXXnumberend of each subhour
hx.bypassAF.tdbXXnumberend of each subhour
hx.bypassAF.wXXnumberend of each subhour
hx.bypassAF.amfXXnumberend of each subhour
hx.exhInAF.tdbXXnumberend of each subhour
hx.exhInAF.wXXnumberend of each subhour
hx.exhInAF.amfXXnumberend of each subhour
hx.supOutAF.tdbXXnumberend of each subhour
hx.supOutAF.wXXnumberend of each subhour
hx.supOutAF.amfXXnumberend of each subhour
hx.bypassFracXXnumberend of each subhourFraction of supply inlet air bypassing heat exchanger
hx.tSetXXnumberend of each subhourSetpoint temperature for air exiting heat exchanger
hx.sensEffXXnumberend of each subhourSensible efficacy
hx.latEffXXnumberend of each subhourLatent efficacy
supAF.tdbXXnumberend of each subhour
supAF.wXXnumberend of each subhour
supAF.amfXXnumberend of each subhour
exhAF.tdbXXnumberend of each subhour
exhAF.wXXnumberend of each subhour
exhAF.amfXXnumberend of each subhour
supQSenXXnumberend of each subhourSensible heat added (+) or removed (-) from the supply for tempering
supQLatXXnumberend of each subhourLatent heat added (+) or removed (-) from the supply for tempering
SHRXXnumberend of each subhourActual cooling coil shr. same as oa_shrtarget unless adjusted for humidity limits.

6.27 door (owner: surface)

@door[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXstringconstant
tyXinteger numberinput time
areaXnumberrun start time (of each phase, autoSize or simulate)
azmXnumberrun start time (of each phase, autoSize or simulate)
tiltXnumberrun start time (of each phase, autoSize or simulate)
dircos[0]Xnumberrun start time (of each phase, autoSize or simulate)
dircos[1]Xnumberrun start time (of each phase, autoSize or simulate)
dircos[2]Xnumberrun start time (of each phase, autoSize or simulate)
depthBGXnumberrun start time (of each phase, autoSize or simulate)
heightXnumberrun start time (of each phase, autoSize or simulate)… and to compute area b4 mutliplier.
modelXinteger numberinput time
modelrXinteger numberrun start time (of each phase, autoSize or simulate)
lThkFXnumberrun start time (of each phase, autoSize or simulate)
gtiXinteger numberrun start time (of each phase, autoSize or simulate)
scoXnumbermonthly-hourly
sccXnumbermonthly-hourly
sbcI.absSlrXnumbermonthly-hourly
sbcI.awAbsSlrXnumbermonthly-hourly
sbcI.epsLWXnumberrun start time (of each phase, autoSize or simulate)
sbcI.ziXinteger numberrun start time (of each phase, autoSize or simulate)
sbcI.FXnumberrun start time (of each phase, autoSize or simulate)
sbcI.FpXnumberrun start time (of each phase, autoSize or simulate)
sbcI.frRadXnumberrun start time (of each phase, autoSize or simulate)
sbcI.fSkyXnumberrun start time (of each phase, autoSize or simulate)
sbcI.fAirXnumberrun start time (of each phase, autoSize or simulate)
sbcI.hcNatXnumberend of each subhour
sbcI.hcFrcXnumberend of each subhour
sbcI.hcMultXnumberend of each subhour
sbcI.hxaXnumberend of each subhour
sbcI.hxrXnumberend of each subhour
sbcI.hxtotXnumberend of each subhour
sbcI.uRatXnumberend of each subhour
sbcI.fRatXnumberend of each subhour
sbcI.cxXnumberend of each subhour
sbcI.sgTarg.bmXnumberend of each subhour
sbcI.sgTarg.dfXnumberend of each subhour
sbcI.sgTarg.totXnumberend of each subhour
sbcI.sgXnumberend of each subhour
sbcI.tSrfXnumberend of each subhour
sbcI.tSrflsXnumbersubhourly
sbcI.qrAbsXnumberend of each subhour
sbcI.txaXnumberend of each subhour
sbcI.txrXnumberend of each subhour
sbcI.txeXnumberend of each subhour
sbcI.wXnumberend of each subhour
sbcI.qSrfXnumberend of each subhour
sbcI.pXSXunrecognizedrun start time (of each phase, autoSize or simulate)
sbcI.fcWindXnumberrun start time (of each phase, autoSize or simulate)
sbcI.fcWind2Xnumberrun start time (of each phase, autoSize or simulate)
sbcI.etaXnumberend of each subhour
sbcI.widNomXnumberrun start time (of each phase, autoSize or simulate)
sbcI.lenNomXnumberrun start time (of each phase, autoSize or simulate)
sbcI.lenCharNatXnumberrun start time (of each phase, autoSize or simulate)
sbcI.lenEffWinkXnumberrun start time (of each phase, autoSize or simulate)
sbcI.cosTiltXnumberrun start time (of each phase, autoSize or simulate)
sbcI.atvDegXnumberrun start time (of each phase, autoSize or simulate)
sbcI.cosAtvXnumberrun start time (of each phase, autoSize or simulate)
sbcI.hcModelXunrecognizedrun start time (of each phase, autoSize or simulate)
sbcI.hcLCharXnumberrun start time (of each phase, autoSize or simulate)
sbcI.hcConst[0]Xnumberrun start time (of each phase, autoSize or simulate)
sbcI.hcConst[1]Xnumberrun start time (of each phase, autoSize or simulate)
sbcI.hcConst[2]Xnumberrun start time (of each phase, autoSize or simulate)
sbcI.groundModelXunrecognizedrun start time (of each phase, autoSize or simulate)
sbcI.cTaDbAvgYrXnumberrun start time (of each phase, autoSize or simulate)
sbcI.cTaDbAvg31Xnumberrun start time (of each phase, autoSize or simulate)
sbcI.cTaDbAvg14Xnumberrun start time (of each phase, autoSize or simulate)
sbcI.cTaDbAvg07Xnumberrun start time (of each phase, autoSize or simulate)
sbcI.cTGrndXnumberrun start time (of each phase, autoSize or simulate)
sbcI.rGrndXnumberrun start time (of each phase, autoSize or simulate)
sbcI.rConGrndXnumberrun start time (of each phase, autoSize or simulate)
sbcO.absSlrXnumbermonthly-hourly
sbcO.awAbsSlrXnumbermonthly-hourly
sbcO.epsLWXnumberrun start time (of each phase, autoSize or simulate)
sbcO.ziXinteger numberrun start time (of each phase, autoSize or simulate)
sbcO.FXnumberrun start time (of each phase, autoSize or simulate)
sbcO.FpXnumberrun start time (of each phase, autoSize or simulate)
sbcO.frRadXnumberrun start time (of each phase, autoSize or simulate)
sbcO.fSkyXnumberrun start time (of each phase, autoSize or simulate)
sbcO.fAirXnumberrun start time (of each phase, autoSize or simulate)
sbcO.hcNatXnumberend of each subhour
sbcO.hcFrcXnumberend of each subhour
sbcO.hcMultXnumberend of each subhour
sbcO.hxaXnumberend of each subhour
sbcO.hxrXnumberend of each subhour
sbcO.hxtotXnumberend of each subhour
sbcO.uRatXnumberend of each subhour
sbcO.fRatXnumberend of each subhour
sbcO.cxXnumberend of each subhour
sbcO.sgTarg.bmXnumberend of each subhour
sbcO.sgTarg.dfXnumberend of each subhour
sbcO.sgTarg.totXnumberend of each subhour
sbcO.sgXnumberend of each subhour
sbcO.tSrfXnumberend of each subhour
sbcO.tSrflsXnumbersubhourly
sbcO.qrAbsXnumberend of each subhour
sbcO.txaXnumberend of each subhour
sbcO.txrXnumberend of each subhour
sbcO.txeXnumberend of each subhour
sbcO.wXnumberend of each subhour
sbcO.qSrfXnumberend of each subhour
sbcO.pXSXunrecognizedrun start time (of each phase, autoSize or simulate)
sbcO.fcWindXnumberrun start time (of each phase, autoSize or simulate)
sbcO.fcWind2Xnumberrun start time (of each phase, autoSize or simulate)
sbcO.etaXnumberend of each subhour
sbcO.widNomXnumberrun start time (of each phase, autoSize or simulate)
sbcO.lenNomXnumberrun start time (of each phase, autoSize or simulate)
sbcO.lenCharNatXnumberrun start time (of each phase, autoSize or simulate)
sbcO.lenEffWinkXnumberrun start time (of each phase, autoSize or simulate)
sbcO.cosTiltXnumberrun start time (of each phase, autoSize or simulate)
sbcO.atvDegXnumberrun start time (of each phase, autoSize or simulate)
sbcO.cosAtvXnumberrun start time (of each phase, autoSize or simulate)
sbcO.hcModelXunrecognizedrun start time (of each phase, autoSize or simulate)
sbcO.hcLCharXnumberrun start time (of each phase, autoSize or simulate)
sbcO.hcConst[0]Xnumberrun start time (of each phase, autoSize or simulate)
sbcO.hcConst[1]Xnumberrun start time (of each phase, autoSize or simulate)
sbcO.hcConst[2]Xnumberrun start time (of each phase, autoSize or simulate)
sbcO.groundModelXunrecognizedrun start time (of each phase, autoSize or simulate)
sbcO.cTaDbAvgYrXnumberrun start time (of each phase, autoSize or simulate)
sbcO.cTaDbAvg31Xnumberrun start time (of each phase, autoSize or simulate)
sbcO.cTaDbAvg14Xnumberrun start time (of each phase, autoSize or simulate)
sbcO.cTaDbAvg07Xnumberrun start time (of each phase, autoSize or simulate)
sbcO.cTGrndXnumberrun start time (of each phase, autoSize or simulate)
sbcO.rGrndXnumberrun start time (of each phase, autoSize or simulate)
sbcO.rConGrndXnumberrun start time (of each phase, autoSize or simulate)
fenModelXunrecognizedinput time
SHGCXnumberinput time
fMultXnumberrun start time (of each phase, autoSize or simulate)
UNFRCXnumberinput time
NGlzXinteger numberinput time
exShdXunrecognizedinput time
inShdXunrecognizedinput time
dirtLossXnumberrun start time (of each phase, autoSize or simulate)
sfExCndXinteger numberrun start time (of each phase, autoSize or simulate)
sfExTXnumbersubhourly
sfAdjZiXinteger numberinput time
uIXnumberrun start time (of each phase, autoSize or simulate)
uCXnumberrun start time (of each phase, autoSize or simulate)
uXXnumberrun start time (of each phase, autoSize or simulate)
RfXnumberrun start time (of each phase, autoSize or simulate)
grndReflXnumbermonthly-hourly
vfSkyDfXnumbermonthly-hourly
vfGrndDfXnumbermonthly-hourly
vfSkyLWXnumberrun start time (of each phase, autoSize or simulate)
vfGrndLWXnumberrun start time (of each phase, autoSize or simulate)
uvalXnumberrun start time (of each phase, autoSize or simulate)
UNomXnumberrun start time (of each phase, autoSize or simulate)
UANomXnumberrun start time (of each phase, autoSize or simulate)
rSrfNom[0]Xnumberrun start time (of each phase, autoSize or simulate)
rSrfNom[1]Xnumberrun start time (of each phase, autoSize or simulate)
hSrfNom[0]Xnumberrun start time (of each phase, autoSize or simulate)
hSrfNom[1]Xnumberrun start time (of each phase, autoSize or simulate)
cFctrXnumberrun start time (of each phase, autoSize or simulate)
iwshadXinteger numberrun start time (of each phase, autoSize or simulate)
msiXinteger numberrun start time (of each phase, autoSize or simulate)0 or msrat msr subscr which will be used if delayed model
tLrB[0]Xnumberend of each hour
tLrB[1]Xnumberend of each hour
tLrB[2]Xnumberend of each hour
tLrB[3]Xnumberend of each hour
tLrB[4]Xnumberend of each hour
tLrB[5]Xnumberend of each hour
tLrB[6]Xnumberend of each hour
tLrB[7]Xnumberend of each hour
tLrB[8]Xnumberend of each hour
tLrB[9]Xnumberend of each hour
nsgdistXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[0].targTyXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[0].targTiXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[0].FSOXnumbermonthly-hourly
sgdist[0].FSCXnumbermonthly-hourly
sgdist[1].targTyXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[1].targTiXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[1].FSOXnumbermonthly-hourly
sgdist[1].FSCXnumbermonthly-hourly
sgdist[2].targTyXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[2].targTiXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[2].FSOXnumbermonthly-hourly
sgdist[2].FSCXnumbermonthly-hourly
sgdist[3].targTyXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[3].targTiXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[3].FSOXnumbermonthly-hourly
sgdist[3].FSCXnumbermonthly-hourly
sgdist[4].targTyXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[4].targTiXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[4].FSOXnumbermonthly-hourly
sgdist[4].FSCXnumbermonthly-hourly
sgdist[5].targTyXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[5].targTiXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[5].FSOXnumbermonthly-hourly
sgdist[5].FSCXnumbermonthly-hourly
sgdist[6].targTyXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[6].targTiXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[6].FSOXnumbermonthly-hourly
sgdist[6].FSCXnumbermonthly-hourly
sgdist[7].targTyXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[7].targTiXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[7].FSOXnumbermonthly-hourly
sgdist[7].FSCXnumbermonthly-hourly
sfAreaXnumberinput timeSurface: gross area, net in x.xs_area.
sfUXnumberinput timeUval input if no sfcon given (excl surf films)
sfConXinteger numberinput timeSurface construction (optional)
sfTyXinteger numberconstantWall/floor/ceil/[intmass1/2]: for input cking.
sfFndXinteger numberinput timeSurface foundation object (floors only, optional)
sfFndFloorXinteger numberinput timeSurface foundation floor object (walls only, optional)
sfExpPerimXnumberinput timeFoundation floor exposed perimeter (floors only)
widthXnumberinput timeWidth and height: used to compute shading,
heightXnumberinput time… and to compute area b4 mutliplier.
multXnumberinput timeArea multiplier (for multiple identical windows)
xiXinteger numberrun start time (of each phase, autoSize or simulate)Subscript in runtime xsrat, to facilitate access by probers 1-92
msiXinteger numberrun start time (of each phase, autoSize or simulate)0 or msrat msr subscr which will be used if delayed model

6.28 DuctSeg (owner: RSYS)

@DuctSeg[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
tyXXunrecognizedinput timeType: c_ducttych_ret / _sup
absSlrXXnumbersubhourly
awAbsSlrXXnumbersubhourly
epsLWXXnumbersubhourly
ziXXinteger numbersubhourly
FXXnumbersubhourly
FpXXnumbersubhourly
frRadXXnumbersubhourly
fSkyXXnumbersubhourly
fAirXXnumbersubhourly
hcNatXXnumberend of each subhour
hcFrcXXnumberend of each subhour
hcMultXXnumberend of each subhour
hxaXXnumberend of each subhour
hxrXXnumberend of each subhour
hxtotXXnumberend of each subhour
uRatXXnumberend of each subhour
fRatXXnumberend of each subhour
cxXXnumberend of each subhour
sgTarg.bmXXnumberend of each subhour
sgTarg.dfXXnumberend of each subhour
sgTarg.totXXnumberend of each subhour
sgXXnumberend of each subhour
tSrfXXnumberend of each subhour
tSrflsXXnumbersubhourly
qrAbsXXnumberend of each subhour
txaXXnumberend of each subhour
txrXXnumberend of each subhour
txeXXnumberend of each subhour
wXXnumberend of each subhour
qSrfXXnumberend of each subhour
pDSXXunrecognizedsubhourlyPointer to parent ductseg
exAreaXXnumberinput timeExterior heat transfer surface area, ft2 (outside of insulation)
diamXXnumberinput timeDuct diameter (w/o insulation), ft
lenXXnumberinput timeTotal length (all branches), ft
branchLenXXnumberrun start time (of each phase, autoSize or simulate)Average branch length, ft
branchCountXXinteger numberinput time# of branches
branchCFAXXnumberinput timeFloor area served per per branch, ft2
airVelDsXXnumberinput timeDesign air velocity, fpm
inAreaXXnumberinput timeInterior surface area, ft2
insulRXXnumberinput timeRated insulation resistance, ft2-f/btuh
insulMatiXXinteger numberinput timeInsulation material, 0 if none
insulKAXXnumberrun start time (of each phase, autoSize or simulate)Constants for insul conductivity: kinsul = ka + kb*t
insulKBXXnumberrun start time (of each phase, autoSize or simulate)
insulThkXXnumberrun start time (of each phase, autoSize or simulate)Insulation actual thickness, ft
insulThkEffXXnumberrun start time (of each phase, autoSize or simulate)Effective insulation thickness, ft
RconvInXXnumberautosize and simulate phase start timeInside surfce convection resistance, ft2-f/btuh
RductXXnumberend of each hourTotal resistance from duct air to exterior surface of insulation
UductXXnumberend of each hour1/ds_rduct
insulREffXXnumberend of each hourEffective insulation resistance, ft2-f/btuh
exCndXXinteger numberinput timeAdjacent cond: adiabatic/ambient/spect/adjzn.
leakFXXnumberinput timeLeakage fraction, 0-1
uaTotXXnumberend of each subhourCur step total conductance between duct air
betaXXnumberend of each subhourCur step conduction loss parameter (1 - effectiveness)
air[0].tdbXXnumberend of each subhour
air[0].wXXnumberend of each subhour
air[1].tdbXXnumberend of each subhour
air[1].wXXnumberend of each subhour
air[2].tdbXXnumberend of each subhour
air[2].wXXnumberend of each subhour
air[3].tdbXXnumberend of each subhour
air[3].wXXnumberend of each subhour
amfFLXXnumberend of each subhourDry air mass flow rate at full load, lbm/hr
qCondFLXXnumberend of each subhourFull load total conduction losses to surround (+ = out of duct), btuh
qCondXXnumberend of each subhourTotal conduction loss rate to surround (+ = out of duct), btuh
qCondAirXXnumberend of each subhour… to txa (air)
qCondRadXXnumberend of each subhour… to txr (radiant)
qLeakSenXXnumberend of each subhourLeakage sensible heat loss rate, btuh (+ = out of duct)
qLeakLatXXnumberend of each subhourLeakage latent heat loss rate, btuh (+ = out of duct)

6.29 DUCTSEGRes

@DUCTSEGRes[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXstringconstant
Y.qhCondXnumberend of run (of each phase, autoSize or simulate)
Y.qhLeakSenXnumberend of run (of each phase, autoSize or simulate)
Y.qhTotSenXnumberend of run (of each phase, autoSize or simulate)
Y.qcCondXnumberend of run (of each phase, autoSize or simulate)
Y.qcLeakSenXnumberend of run (of each phase, autoSize or simulate)
Y.qcTotSenXnumberend of run (of each phase, autoSize or simulate)
Y.qcLeakLatXnumberend of run (of each phase, autoSize or simulate)
M.qhCondXnumberend of each month
M.qhLeakSenXnumberend of each month
M.qhTotSenXnumberend of each month
M.qcCondXnumberend of each month
M.qcLeakSenXnumberend of each month
M.qcTotSenXnumberend of each month
M.qcLeakLatXnumberend of each month
D.qhCondXnumberend of each day
D.qhLeakSenXnumberend of each day
D.qhTotSenXnumberend of each day
D.qcCondXnumberend of each day
D.qcLeakSenXnumberend of each day
D.qcTotSenXnumberend of each day
D.qcLeakLatXnumberend of each day
H.qhCondXnumberend of each hour
H.qhLeakSenXnumberend of each hour
H.qhTotSenXnumberend of each hour
H.qcCondXnumberend of each hour
H.qcLeakSenXnumberend of each hour
H.qcTotSenXnumberend of each hour
H.qcLeakLatXnumberend of each hour
S.qhCondXnumberend of each subhour
S.qhLeakSenXnumberend of each subhour
S.qhTotSenXnumberend of each subhour
S.qcCondXnumberend of each subhour
S.qcLeakSenXnumberend of each subhour
S.qcTotSenXnumberend of each subhour
S.qcLeakLatXnumberend of each subhour

6.30 export (owner: exportFile)

@export[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXstringconstant
ziXinteger numberinput timeZone for zone-specific reports. can be ti_sum, ti_all.
mtriXinteger numberinput timeMeter to report/export for meter-specific reports. can be ti_sum, ti_all.
ahiXinteger numberinput timeAir handler to report/export for air-handler-specific reports. can be ti_sum, ti_all.
tuiXinteger numberinput timeTerminal to report/export for terminal-specific reports. can be ti_all
dhwMtriXinteger numberinput timeDhw meter to report/export for dhw meter-specific reports. can be ti_all.
afMtriXinteger numberinput timeAir flow meter to report/export for af meter-specific reports. can be ti_all.
isExportXinteger numberinput time1 if export not report, so same fcns can be used with rib and xib records
rpTyXinteger numberconstantReport/export type c_rptych_eb etc
rpFreqXinteger numberconstantR/xport frequency c_ivlch_m etc
rpDayBegXinteger numberinput timeStart 1-based julian day of year, where applicable
rpDayEndXinteger numberinput timeEnd ..
rpBtuSfXnumberinput timeEnergy (btu) scale factor
rpTitleXstringinput timeTitle, for udt, in dm
rpCplXinteger numberinput timeChars per line, inputtable re udt’s (default -1=“as wide as needed”)
rpHeaderXunrecognizedinput timeTable header or export header yes/no (default yes)
rpFooterXinteger numberinput timeTable footer (summary line) or export footer (just blank line?) yes/no (default yes)
coliXinteger numberrun start time (of each phase, autoSize or simulate)Rcolb/xcolb subscript of first column (thence linked by .nxcoli).
nColXinteger numberrun start time (of each phase, autoSize or simulate)# columns
widXinteger numberrun start time (of each phase, autoSize or simulate)Total col width for user-defined report

6.31 exportCol (owner: export)

@exportCol[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
colHeadXXstringinput timeColumn head string, in dm. *i cuz veoi in cncult.cpp:rpcolt[].
colGapXXinteger numberinput timeSpace to left of column, default 1
colWidXXinteger numberinput timeColumn width
colDecXXinteger numberinput timeColdecimals: max digits after point
colJustXXinteger numberinput timeJustification: c_justch_l or _r
colValXXun-probe-ableend of each subhourValue vt_val and data type vt_dt (tyfl/tystr in input, dtfloat/dtculstr in run), used at end report interval.
nxColiXXinteger numberconstantFor runtime: col subscript of next column in this report, 0 if last one

6.32 exportFile

@exportFile[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXstringconstant
fileNameXstringinput timeFile name, path optional. *i cuz veoi in cncult.
fileStatXinteger numberrun start time (of each phase, autoSize or simulate)Fresh(overwrite,default)/new(err if exists)/append
pageFmtXinteger numberinput timePage formatting on no/yes
fileStatCheckedXinteger numberrun start time (of each phase, autoSize or simulate)Check filestat only once to prevent “file exists” error or re-setting “overwrite” on later run
overWriteXinteger numberrun start time (of each phase, autoSize or simulate)Append if 0. set by filestat=fresh, cleared on use, so addl runs do not erase earlier output.
wasNotEmptyXinteger numberrun start time (of each phase, autoSize or simulate)Nz if existed and size > 0 at filestat check

6.33 foundation

@foundation[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXstringconstant
wlHtAbvGrdXnumberinput timeHeight of foundation wall above grade
wlDpBlwSlbXnumberinput timeDepth of foundation wall below the slab
ftWlConiXinteger numberinput timeFoundation wall construction (con subscript) rqd if

6.34 foundationBlock (owner: foundation)

@foundationBlock[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXstringconstant
matiXinteger numberinput timeMaterial (mat subscript) for this component
x1RefXunrecognizedinput timePoint 1 x reference
z1RefXunrecognizedinput timePoint 1 z reference
x1Xnumberinput timePoint 1 x value (relative to reference)
z1Xnumberinput timePoint 1 x value (relative to reference)
x2RefXunrecognizedinput timePoint 2 x reference
z2RefXunrecognizedinput timePoint 2 z reference
x2Xnumberinput timePoint 2 x value (relative to reference)
z2Xnumberinput timePoint 2 x value (relative to reference)

6.35 gain (owner: zone)

@gain[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
gnPowerXXnumberhourlyAmount of gain (demand – b4 reduction by gndlfrpow), btuh, hourly expression
mtriXXinteger numberinput timeMeter to which gain is charged
gnEndUseXXinteger numberautosize and simulate phase start timeEnd use of energy: cooling, heating, receptacles, etc. reqd if gnmeter != none, else disallowed.
gnFrLatXXnumberhourlyFraction of gain which is latent (0 - 1, hourly expression)
gnFrRadXXnumberhourlyFraction of gain which is radiant, added 11-95
gnFrZnXXnumberhourlyFraction of gain going to zone (0 - 1, hourly expression)
gnFrPlXXnumberhourlyFraction of gain going to plenum (0 - 1, hourly expression)
gnFrRtnXXnumberhourlyFraction of gain going to return (0 - 1, hourly expression)
gnDlFrPowXXnumberhourlyFraction power on for daylighting, 0-1, default 1.0, hourly expression
dhwsysiXXinteger numberinput timeControlling dhwsys, 0 if none ()
dhwmtriXXinteger numberinput timeControlling dhwmeter, 0 if none
dhwEndUseXXinteger numberinput timeWith gn_dhwsysi, specifies controlling hw end use

6.36 glazeType

@glazeType[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
gtSHGCXXnumberinput timeRated shgc of assembly
gtSMSOXXnumbermonthly-hourlyOptional solar heat gain coef multiplier, shades open, used if not spec’d in window, dflt 1.0.
gtSMSCXXnumbermonthly-hourlyDitto shades closed, defaults at window level.
gtFMultXXnumberinput timeOptional frame/mullion multiplier for use when not spec’d in window. constant.
gtPySHGC.k[0]XXnumberautosize and simulate phase start time
gtPySHGC.k[1]XXnumberautosize and simulate phase start time
gtPySHGC.k[2]XXnumberautosize and simulate phase start time
gtPySHGC.k[3]XXnumberautosize and simulate phase start time
gtPySHGC.k[4]XXnumberautosize and simulate phase start time
gtPySHGC.k[5]XXnumberautosize and simulate phase start time
gtDMSHGCXXnumberinput timeDiffuse shgc multiplier used (in place of polynomial). rqd. constant.
gtDMRBSolXXnumberinput timeReflectance for diffuse solar on inside of glass, for cavity absorptance calc’ns (cgsolar.cpp).
gtUXXnumberinput timeOptional u-value for use when not spec’d in window. contant.
gtUNFRCXXnumberinput timeOverall u-factor evaluated under per nfrc heating conditions
gtNGlzXXinteger numberinput time# of glazings bare-glass assembly
gtFenModelXXunrecognizedinput timeFenestration model: user input
gtExShdXXunrecognizedinput timeExterior shade (ashwat only)
gtInShdXXunrecognizedinput timeInterior shade (ditto)
gtDirtLossXXnumberinput timeDirt loss fraction (all solar gain reduced by this factor

6.37 heatPlant

@heatPlant[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
hpSchedXXunrecognizedhourlyHourly choice of off, avail (default; plant runs on demand), or on (at least 1st stage runs).
hpPipeLossFXXnumberautosize and simulate phase start timePipe loss, default .01, fraction of largest stage boiler capac whenever any boiler running
hpStage1[0]XXinteger numberautosize and simulate phase start time
hpStage1[1]XXinteger numberautosize and simulate phase start time
hpStage1[2]XXinteger numberautosize and simulate phase start time
hpStage1[3]XXinteger numberautosize and simulate phase start time
hpStage1[4]XXinteger numberautosize and simulate phase start time
hpStage1[5]XXinteger numberautosize and simulate phase start time
hpStage1[6]XXinteger numberautosize and simulate phase start time
hpStage1[7]XXinteger numberautosize and simulate phase start time
hpStage2[0]XXinteger numberautosize and simulate phase start timeDefaulted by code, if no hpstage values entered:
hpStage2[1]XXinteger numberautosize and simulate phase start timeDefaulted by code, if no hpstage values entered:
hpStage2[2]XXinteger numberautosize and simulate phase start timeDefaulted by code, if no hpstage values entered:
hpStage2[3]XXinteger numberautosize and simulate phase start timeDefaulted by code, if no hpstage values entered:
hpStage2[4]XXinteger numberautosize and simulate phase start timeDefaulted by code, if no hpstage values entered:
hpStage2[5]XXinteger numberautosize and simulate phase start timeDefaulted by code, if no hpstage values entered:
hpStage2[6]XXinteger numberautosize and simulate phase start timeDefaulted by code, if no hpstage values entered:
hpStage2[7]XXinteger numberautosize and simulate phase start timeDefaulted by code, if no hpstage values entered:
hpStage3[0]XXinteger numberautosize and simulate phase start time
hpStage3[1]XXinteger numberautosize and simulate phase start time
hpStage3[2]XXinteger numberautosize and simulate phase start time
hpStage3[3]XXinteger numberautosize and simulate phase start time
hpStage3[4]XXinteger numberautosize and simulate phase start time
hpStage3[5]XXinteger numberautosize and simulate phase start time
hpStage3[6]XXinteger numberautosize and simulate phase start time
hpStage3[7]XXinteger numberautosize and simulate phase start time
hpStage4[0]XXinteger numberautosize and simulate phase start time… stage 1: ti_all. stages 2-7: none (0).
hpStage4[1]XXinteger numberautosize and simulate phase start time… stage 1: ti_all. stages 2-7: none (0).
hpStage4[2]XXinteger numberautosize and simulate phase start time… stage 1: ti_all. stages 2-7: none (0).
hpStage4[3]XXinteger numberautosize and simulate phase start time… stage 1: ti_all. stages 2-7: none (0).
hpStage4[4]XXinteger numberautosize and simulate phase start time… stage 1: ti_all. stages 2-7: none (0).
hpStage4[5]XXinteger numberautosize and simulate phase start time… stage 1: ti_all. stages 2-7: none (0).
hpStage4[6]XXinteger numberautosize and simulate phase start time… stage 1: ti_all. stages 2-7: none (0).
hpStage4[7]XXinteger numberautosize and simulate phase start time… stage 1: ti_all. stages 2-7: none (0).
hpStage5[0]XXinteger numberautosize and simulate phase start time
hpStage5[1]XXinteger numberautosize and simulate phase start time
hpStage5[2]XXinteger numberautosize and simulate phase start time
hpStage5[3]XXinteger numberautosize and simulate phase start time
hpStage5[4]XXinteger numberautosize and simulate phase start time
hpStage5[5]XXinteger numberautosize and simulate phase start time
hpStage5[6]XXinteger numberautosize and simulate phase start time
hpStage5[7]XXinteger numberautosize and simulate phase start time
hpStage6[0]XXinteger numberautosize and simulate phase start time
hpStage6[1]XXinteger numberautosize and simulate phase start time
hpStage6[2]XXinteger numberautosize and simulate phase start time
hpStage6[3]XXinteger numberautosize and simulate phase start time
hpStage6[4]XXinteger numberautosize and simulate phase start time
hpStage6[5]XXinteger numberautosize and simulate phase start time
hpStage6[6]XXinteger numberautosize and simulate phase start time
hpStage6[7]XXinteger numberautosize and simulate phase start time
hpStage7[0]XXinteger numberautosize and simulate phase start time
hpStage7[1]XXinteger numberautosize and simulate phase start time
hpStage7[2]XXinteger numberautosize and simulate phase start time
hpStage7[3]XXinteger numberautosize and simulate phase start time
hpStage7[4]XXinteger numberautosize and simulate phase start time
hpStage7[5]XXinteger numberautosize and simulate phase start time
hpStage7[6]XXinteger numberautosize and simulate phase start time
hpStage7[7]XXinteger numberautosize and simulate phase start time
blr1XXinteger numberrun start time (of each phase, autoSize or simulate)Subscript of 1st boiler for this heatplant. next is boiler.nxblr4hp.
tu1XXinteger numberrun start time (of each phase, autoSize or simulate)Subscript of 1st tu with hw coil served by this heatplant. next is tu.tuhc.nxtu4hp.
ah1XXinteger numberrun start time (of each phase, autoSize or simulate)Subscript of 1st ah with hw coil served by this heatplant. next is ah.ahhc.nxah4hp.
hl1XXinteger numberrun start time (of each phase, autoSize or simulate)Subscript of 1st hploop with hx for this heatplant
qPipeLossXXnumberrun start time (of each phase, autoSize or simulate)
stgCap[0]XXnumberrun start time (of each phase, autoSize or simulate)
stgCap[1]XXnumberrun start time (of each phase, autoSize or simulate)
stgCap[2]XXnumberrun start time (of each phase, autoSize or simulate)
stgCap[3]XXnumberrun start time (of each phase, autoSize or simulate)
stgCap[4]XXnumberrun start time (of each phase, autoSize or simulate)
stgCap[5]XXnumberrun start time (of each phase, autoSize or simulate)
stgCap[6]XXnumberrun start time (of each phase, autoSize or simulate)
stgPQ[0]XXnumberrun start time (of each phase, autoSize or simulate)
stgPQ[1]XXnumberrun start time (of each phase, autoSize or simulate)
stgPQ[2]XXnumberrun start time (of each phase, autoSize or simulate)
stgPQ[3]XXnumberrun start time (of each phase, autoSize or simulate)
stgPQ[4]XXnumberrun start time (of each phase, autoSize or simulate)
stgPQ[5]XXnumberrun start time (of each phase, autoSize or simulate)
stgPQ[6]XXnumberrun start time (of each phase, autoSize or simulate)
stgNXXinteger numberrun start time (of each phase, autoSize or simulate)Max+1 used stage subscript 1-7 (used stages need not be contiguous)
stgMxQXXinteger numberrun start time (of each phase, autoSize or simulate)Most powerful stage subscript 0-6
hpClfXXinteger numberend of each subhourCall-flag: set nz if must call hpcompute so it can test tr, etc to see if computation needed.
hpPtfXXinteger numberend of each subhourCompute-flag: set if must call hpcompute and it should unconditionally recompute this plant.
hpModeXXunrecognizedend of each subhourMode this subhour: off or on: per hpsched; per demand for avail. set in hpestimate, hpcompute.
capFXXnumberend of each subhour
stgiXXinteger numberend of each subhourStage in use, 0-6 for hpstage1-7.
qNxXXnumberend of each subhour
qXXnumberend of each subhour
qPkXXnumberend of each subhourPeak load re error autosizing overload message
qPkAsXXnumberend of each subhourPeak load on a converged autosizing design day re error autosizing overload message
hpModePrXXunrecognizedend of each subhour
qPrXXnumberend of each subhour
capFPrXXnumberend of each subhour

6.38 holiday

@holiday[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXstringconstant
hdDateTrueXinteger numberinput timeTrue date of holiday, 1-365
hdDateObsXinteger numberinput timeDay holiday is observed, 1-365
hdOnMondayXinteger numberinput timeYes if holiday that falls on weekend is observed on monday
hdCaseXunrecognizedinput timeCase: c_holicasech_first, _second, _third, _fourth, _last
hdDowXinteger numberinput timeDay of week, sun=1. subtract 1 before using.
hdMonXunrecognizedinput timeMonth 1-12

6.39 impFileFldNames

@impFileFldNames[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXstringconstant
impfiXinteger numberinput time0 or subscript of impf record for file in impfib/impfb
fnmiNXinteger numberinput timeNumber of named fields seen for this file / max fnmi (+ 1 if 0-based)

6.40 importFile

@importFile[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
fileNameXXstringautosize and simulate phase start timeFile name, path optional, in heap or pseudocode. *i cuz veoi in cncult. rqd.
titleXXstringautosize and simulate phase start timeTitle string. if given, file’s must match.
imFreqXXinteger numberinput timeFrequency of record reads, y m d h; hs and subhour not allowed. rqd.
hasHeaderXXinteger numberautosize and simulate phase start timeFile has header no/yes, default yes.
iffnmiXXinteger numberrun start time (of each phase, autoSize or simulate)Subscript of import file field record in iffnmb. holds used names b4 file opened;
bufSzXXinteger numberrun start time (of each phase, autoSize or simulate)0 or allocated size of buffer (actually 1 larger to hold 0)
bufNXXinteger numberhourlyNumber of characters in buffer === subscript of 1st unused byte
bufI1XXinteger numberhourlyBuffer subscript 1: start or next unscanned field in current record
bufI2XXinteger numberhourlyBuffer subscript 2: end current record. ==bufi1 if no current record.
nFieldsScannedXXinteger numberend of each hour0 or number of fields already scanned in current record

6.41 Inverse

@Inverse[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXstringconstant
freqXinteger numberrun start time (of each phase, autoSize or simulate)
X0Xnumberrun start time (of each phase, autoSize or simulate)
Y0Xnumberrun start time (of each phase, autoSize or simulate)
YTargXnumberrun start time (of each phase, autoSize or simulate)
XXnumberend of each subhour
YXnumberend of each subhour
XEstXnumberinput time

6.42 izXfer

@izXfer[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
zi1XXinteger numberrun start time (of each phase, autoSize or simulate)Subscripts of zones involved (air flow > 0 = into zone 1)
zi2XXinteger numberrun start time (of each phase, autoSize or simulate)Iz_zi2 = -1 iff not interzone
doasXXinteger numberrun start time (of each phase, autoSize or simulate)Subscript of doas where air is supplied from (air flow > 0), or exhausting to (airflow < 0)
uaXXnumberhourlyAir-to-air coupling const (btuh/f) thru walls etc.
nvcntrlXXinteger numberinput timeControl type for nat vents:
afCatIXXunrecognizedrun start time (of each phase, autoSize or simulate)Air flow input category (accounting only) c_afcat_xxx
afMtrCat1XXinteger numberrun start time (of each phase, autoSize or simulate)… for iz_pafmtr1
afMtrCat2XXinteger numberrun start time (of each phase, autoSize or simulate)… for iz_pafmtr2
a1XXnumberhourlyVent area 1, ft2
a2XXnumberhourlyVent area 2, ft2
L1XXnumberinput timeOpening dim 1, ft (_anhoriz)
L2XXnumberinput timeOpening dim 2, ft
hzXXnumberinput time_an (non fan): height of iz_a1 relative to arbitrary 0 (ft)
stairAngleXXnumberinput timeStair angle, deg (_anhoriz) (90 = vert)
cdXXnumberinput timeOrifice coefficient, dimless (user input, default 0.8)
expXXnumberrun start time (of each phase, autoSize or simulate)Power law exponent, (user input, default 0.5)
cprXXnumberinput timeWind pressure coefficient (ignored if not _anext)
vfMinXXnumbersubhourlyMin vent flow rate, cfm (for fixed flow types)
vfMaxXXnumbersubhourlyMax vent flow rate, cfm (for fixed flow types)
tExXXnumbersubhourlyVent exterior air drybulb temp for anext, anextfan, anextflow, and anextherv, f
wExXXnumbersubhourlyVent exterior air humidity ratio, lb/lb
windSpeedXXnumbersubhourlyWindspeed seen by this vent, mph
linkedFlowMultXXnumberinput timeMultiplier for flow to/from linked zone or doas or …
ASEFXXnumbersubhourlyApparent sensible effectiveness (for _anherv)
LEFXXnumbersubhourlyLatent effectiveness (for _anherv)
SREXXnumbersubhourlyHvi sensible recovery efficiency (for _anherv)
ASREXXnumbersubhourlyHvi adjusted sensible recovery efficiency (for _anherv)
RVFanHeatFXXnumbersubhourlyFraction of herv fan power that heats supply air (experimental)
vfExhRatXXnumbersubhourlyExhaust ratio (for _anherv) = (vfgross exhaust)/(vfgross supply)
EATRXXnumbersubhourlyExhaust air transfer ratio (for _anherv)
fan.fanTyXXunrecognizedautosize and simulate phase start time
fan.vfDsXXnumberend of each subhour
fan.vfDs_AsXXnumberautosize and simulate phase start time
fan.vfDs_AsNovXXnumberautosize and simulate phase start time
fan.vfMxFXXnumberautosize and simulate phase start time
fan.pressXXnumberrun start time (of each phase, autoSize or simulate)
fan.effXXnumberrun start time (of each phase, autoSize or simulate)
fan.shaftPwrXXnumberrun start time (of each phase, autoSize or simulate)
fan.elecPwrXXnumberrun start time (of each phase, autoSize or simulate)
fan.motTyXXunrecognizedrun start time (of each phase, autoSize or simulate)
fan.motEffXXnumberautosize and simulate phase start time
fan.motPosXXunrecognizedautosize and simulate phase start time
fan.curvePy.k[0]XXnumberautosize and simulate phase start time
fan.curvePy.k[1]XXnumberautosize and simulate phase start time
fan.curvePy.k[2]XXnumberautosize and simulate phase start time
fan.curvePy.k[3]XXnumberautosize and simulate phase start time
fan.curvePy.k[4]XXnumberautosize and simulate phase start time
fan.curvePy.k[5]XXnumberautosize and simulate phase start time
fan.mtriXXinteger numberinput time
fan.endUseXXinteger numberautosize and simulate phase start time
fan.auszXXinteger numberrun start time (of each phase, autoSize or simulate)
fan.outPowerXXnumbersubhourly
fan.airPowerXXnumbersubhourly
fan.cMxXXnumberend of each subhour
fan.cXXnumberend of each subhour
fan.tXXnumberend of each subhour
fan.frOnXXnumberend of each subhour
fan.pXXnumberend of each subhour
fan.qXXnumberend of each subhour
fan.dTXXnumberend of each subhour
fan.qAroundXXnumberend of each subhour
nvcoeffXXnumberrun start time (of each phase, autoSize or simulate)Nat vent overall coeff btuh/(dt^.5). set by izxsetup().
air1.tdbXXnumberend of each subhour
air1.wXXnumberend of each subhour
air2.tdbXXnumberend of each subhour
air2.wXXnumberend of each subhour
rho1XXnumbersubhourlyZ1 moist air density, lb/cf
rho2XXnumbersubhourlyZ2 moist air density, lb/cf (may be ambient or from doas)
ad[0].AeXXnumberend of each subhour
ad[0].AeLinXXnumberend of each subhour
ad[0].pres1XXnumberend of each subhour
ad[0].pres2XXnumberend of each subhour
ad[0].delPXXnumberend of each subhour
ad[0].mdotPXXnumberend of each subhour
ad[0].dmdpXXnumberend of each subhour
ad[0].mdotBXXnumberend of each subhour
ad[0].mdotXXXnumberend of each subhour
ad[0].xDelpFXXnumberend of each subhour
ad[0].xMbmXXnumberend of each subhour
ad[0].tdFanXXnumberend of each subhour
ad[0].pFanXXnumberend of each subhour
ad[1].AeXXnumberend of each subhour
ad[1].AeLinXXnumberend of each subhour
ad[1].pres1XXnumberend of each subhour
ad[1].pres2XXnumberend of each subhour
ad[1].delPXXnumberend of each subhour
ad[1].mdotPXXnumberend of each subhour
ad[1].dmdpXXnumberend of each subhour
ad[1].mdotBXXnumberend of each subhour
ad[1].mdotXXXnumberend of each subhour
ad[1].xDelpFXXnumberend of each subhour
ad[1].xMbmXXnumberend of each subhour
ad[1].tdFanXXnumberend of each subhour
ad[1].pFanXXnumberend of each subhour
amfNomXXnumberend of each subhourNominal air mass flow, lbm/sec

6.43 kiva

@kiva[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXstringconstant
floorXinteger numberrun start time (of each phase, autoSize or simulate)Floor reference
perimWeightXnumberrun start time (of each phase, autoSize or simulate)Weight of this kiva instance for results of corresponding floor

6.44 layer (owner: construction)

@layer[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXstringconstant
thkXnumberinput timeThickness of layer, ft. dfl mt_thk else rqd. *i cuz veoi in cncult:lrt[].
matiXinteger numberinput timePrimary material (mat subscript). rqd.
frmMatiXinteger numberinput timeFraming material in layer, 0 if unframed layer
frmFracXnumberinput timeFraction framing in layer. rqd if lrfrmmati nz.
uvyXnumberrun start time (of each phase, autoSize or simulate)Conductivity: weighted combo of pri & framing; not specific to thickness.
rXnumberrun start time (of each phase, autoSize or simulate)Layer r-value (for thk, per ft2)
vhcXnumberrun start time (of each phase, autoSize or simulate)Volumetric heat capac (dens*spht, framing-weighted)

6.45 LOADMETER

@LOADMETER[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
subMtri[0]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[1]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[2]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[3]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[4]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[5]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[6]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[7]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[8]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[9]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[10]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[11]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[12]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[13]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[14]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[15]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[16]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[17]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[18]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[19]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[20]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[21]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[22]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[23]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[24]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[25]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[26]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[27]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[28]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[29]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[30]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[31]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[32]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[33]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[34]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[35]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[36]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[37]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[38]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[39]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[40]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[41]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[42]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[43]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[44]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[45]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[46]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[47]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[48]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[49]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[50]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtrMult[0]XXnumbersubhourlySubmeter multipliers
subMtrMult[1]XXnumbersubhourlySubmeter multipliers
subMtrMult[2]XXnumbersubhourlySubmeter multipliers
subMtrMult[3]XXnumbersubhourlySubmeter multipliers
subMtrMult[4]XXnumbersubhourlySubmeter multipliers
subMtrMult[5]XXnumbersubhourlySubmeter multipliers
subMtrMult[6]XXnumbersubhourlySubmeter multipliers
subMtrMult[7]XXnumbersubhourlySubmeter multipliers
subMtrMult[8]XXnumbersubhourlySubmeter multipliers
subMtrMult[9]XXnumbersubhourlySubmeter multipliers
subMtrMult[10]XXnumbersubhourlySubmeter multipliers
subMtrMult[11]XXnumbersubhourlySubmeter multipliers
subMtrMult[12]XXnumbersubhourlySubmeter multipliers
subMtrMult[13]XXnumbersubhourlySubmeter multipliers
subMtrMult[14]XXnumbersubhourlySubmeter multipliers
subMtrMult[15]XXnumbersubhourlySubmeter multipliers
subMtrMult[16]XXnumbersubhourlySubmeter multipliers
subMtrMult[17]XXnumbersubhourlySubmeter multipliers
subMtrMult[18]XXnumbersubhourlySubmeter multipliers
subMtrMult[19]XXnumbersubhourlySubmeter multipliers
subMtrMult[20]XXnumbersubhourlySubmeter multipliers
subMtrMult[21]XXnumbersubhourlySubmeter multipliers
subMtrMult[22]XXnumbersubhourlySubmeter multipliers
subMtrMult[23]XXnumbersubhourlySubmeter multipliers
subMtrMult[24]XXnumbersubhourlySubmeter multipliers
subMtrMult[25]XXnumbersubhourlySubmeter multipliers
subMtrMult[26]XXnumbersubhourlySubmeter multipliers
subMtrMult[27]XXnumbersubhourlySubmeter multipliers
subMtrMult[28]XXnumbersubhourlySubmeter multipliers
subMtrMult[29]XXnumbersubhourlySubmeter multipliers
subMtrMult[30]XXnumbersubhourlySubmeter multipliers
subMtrMult[31]XXnumbersubhourlySubmeter multipliers
subMtrMult[32]XXnumbersubhourlySubmeter multipliers
subMtrMult[33]XXnumbersubhourlySubmeter multipliers
subMtrMult[34]XXnumbersubhourlySubmeter multipliers
subMtrMult[35]XXnumbersubhourlySubmeter multipliers
subMtrMult[36]XXnumbersubhourlySubmeter multipliers
subMtrMult[37]XXnumbersubhourlySubmeter multipliers
subMtrMult[38]XXnumbersubhourlySubmeter multipliers
subMtrMult[39]XXnumbersubhourlySubmeter multipliers
subMtrMult[40]XXnumbersubhourlySubmeter multipliers
subMtrMult[41]XXnumbersubhourlySubmeter multipliers
subMtrMult[42]XXnumbersubhourlySubmeter multipliers
subMtrMult[43]XXnumbersubhourlySubmeter multipliers
subMtrMult[44]XXnumbersubhourlySubmeter multipliers
subMtrMult[45]XXnumbersubhourlySubmeter multipliers
subMtrMult[46]XXnumbersubhourlySubmeter multipliers
subMtrMult[47]XXnumbersubhourlySubmeter multipliers
subMtrMult[48]XXnumbersubhourlySubmeter multipliers
subMtrMult[49]XXnumbersubhourlySubmeter multipliers
subMtrMult[50]XXnumbersubhourlySubmeter multipliers
Y.qHtgXXnumberend of run (of each phase, autoSize or simulate)Heating energy, btu (assumed to be first float)
Y.qClgXXnumberend of run (of each phase, autoSize or simulate)Cooling energy, btu
M.qHtgXXnumberend of each monthHeating energy, btu (assumed to be first float)
M.qClgXXnumberend of each monthCooling energy, btu
D.qHtgXXnumberend of each dayHeating energy, btu (assumed to be first float)
D.qClgXXnumberend of each dayCooling energy, btu
H.qHtgXXnumberend of each hourHeating energy, btu (assumed to be first float)
H.qClgXXnumberend of each hourCooling energy, btu
S.qHtgXXnumberend of each subhourHeating energy, btu (assumed to be first float)
S.qClgXXnumberend of each subhourCooling energy, btu

6.46 mass

@mass[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXstringconstant
sfiXinteger numberrun start time (of each phase, autoSize or simulate)Associated surface subscript
xriXinteger numberrun start time (of each phase, autoSize or simulate)Xsrat subscript: ditto
areaXnumberrun start time (of each phase, autoSize or simulate)Area, ft2
isSubhrlyXinteger numberrun start time (of each phase, autoSize or simulate)True iff this mass simulated subhourly (else hourly)
isFDXinteger numberrun start time (of each phase, autoSize or simulate)True iff this mass used forward-difference model (always subhourly)
inside.msiXinteger numberrun start time (of each phase, autoSize or simulate)Parent mass subscr
inside.tyXinteger numberrun start time (of each phase, autoSize or simulate)Bound cond type: msbcadiabatic, msbcambient, msbcground, msbczone, or msbcspect.
inside.ziXinteger numberrun start time (of each phase, autoSize or simulate)Zone sbscr if .bc_ty == msbczone.
inside.exTaXnumberhourlyAdjacent air temp, f
inside.exTrXnumberhourlyAdjacent radiant temp, f
inside.rsurfXnumberrun start time (of each phase, autoSize or simulate)Extra surf resis, from masstype, for “light” surf lyrs eg carpet: res for solar to 1st hvy lyr.
inside.hXnumberrun start time (of each phase, autoSize or simulate)Combined surface conductance, air to 1st “heavy” layer (btuh/ft2-f)
inside.haXnumberrun start time (of each phase, autoSize or simulate)Bc_h * area, btuh/f
inside.rIgXunrecognizedhourlyRadiant internal gain target (float) (btuh). pointed to by znr.rigdist; set/used in cnloads. 11-95
inside.qxhnetXnumberend of each hourNet heat xfer for hour (btu, + = into mass): signed sum of all transfers.
inside.qxdnetXnumberend of each day… ditto current day
inside.qxmnetXnumberend of each month… ditto current month
inside.qxhtotXnumberend of each hourTotal xfer for hour (btu): sum of abs(xfer). used as divisor for determining relative error.
inside.qxdtotXnumberend of each day… ditto current day
inside.qxmtotXnumberend of each month… ditto current month
inside.surfTempXnumberend of each subhourProbe-able duplicate copy of inside or outside layer surface temp, set in loadssurfaces.
outside.msiXinteger numberrun start time (of each phase, autoSize or simulate)Parent mass subscr
outside.tyXinteger numberrun start time (of each phase, autoSize or simulate)Bound cond type: msbcadiabatic, msbcambient, msbcground, msbczone, or msbcspect.
outside.ziXinteger numberrun start time (of each phase, autoSize or simulate)Zone sbscr if .bc_ty == msbczone.
outside.exTaXnumberhourlyAdjacent air temp, f
outside.exTrXnumberhourlyAdjacent radiant temp, f
outside.rsurfXnumberrun start time (of each phase, autoSize or simulate)Extra surf resis, from masstype, for “light” surf lyrs eg carpet: res for solar to 1st hvy lyr.
outside.hXnumberrun start time (of each phase, autoSize or simulate)Combined surface conductance, air to 1st “heavy” layer (btuh/ft2-f)
outside.haXnumberrun start time (of each phase, autoSize or simulate)Bc_h * area, btuh/f
outside.rIgXunrecognizedhourlyRadiant internal gain target (float) (btuh). pointed to by znr.rigdist; set/used in cnloads. 11-95
outside.qxhnetXnumberend of each hourNet heat xfer for hour (btu, + = into mass): signed sum of all transfers.
outside.qxdnetXnumberend of each day… ditto current day
outside.qxmnetXnumberend of each month… ditto current month
outside.qxhtotXnumberend of each hourTotal xfer for hour (btu): sum of abs(xfer). used as divisor for determining relative error.
outside.qxdtotXnumberend of each day… ditto current day
outside.qxmtotXnumberend of each month… ditto current month
outside.surfTempXnumberend of each subhourProbe-able duplicate copy of inside or outside layer surface temp, set in loadssurfaces.
UNomXnumberrun start time (of each phase, autoSize or simulate)Overall uval incl nominal surface films, btuh/ft2-f
tcXnumberrun start time (of each phase, autoSize or simulate)Time constant (con->hc/sfinh) as used to default sfmodel & issubhrly, for reporting, 1-95
pMMXun-probe-ablerun start time (of each phase, autoSize or simulate)Pointer to runtime mass model for this mass (type determined per input)

6.47 material

@material[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXstringconstant
thkXnumberinput time-1 or optional default thickness, ft
condXnumberinput timeConductivity, btuh-ft/ft2-f (at mt_condtrat)
condTRatXnumberinput timeRating temp for mt_cond, f (typically 70 f)
condCTXnumberinput timeConductivity temp coefficient, 1/f
spHtXnumberinput timeSpecific heat, btu/lb-f
densXnumberinput time0 (massless) or density, lb/ft3
rNomXnumberinput timeNominal r of insulation, ft2-f/btuh-ft
vhcXnumberrun start time (of each phase, autoSize or simulate)Volumetric heat capac (btu/ft3-f): mt_spht*mt_dens

6.48 meter

@meter[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
rateXXnumberinput timeCost per btu of use
dmdRateXXnumberinput timeDmdcost per btu of demand, for a month
subMtri[0]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[1]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[2]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[3]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[4]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[5]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[6]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[7]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[8]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[9]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[10]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[11]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[12]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[13]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[14]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[15]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[16]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[17]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[18]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[19]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[20]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[21]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[22]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[23]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[24]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[25]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[26]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[27]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[28]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[29]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[30]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[31]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[32]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[33]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[34]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[35]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[36]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[37]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[38]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[39]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[40]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[41]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[42]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[43]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[44]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[45]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[46]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[47]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[48]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[49]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtri[50]XXinteger numberrun start time (of each phase, autoSize or simulate)Submeters
subMtrMult[0]XXnumberhourlySubmeter multipliers
subMtrMult[1]XXnumberhourlySubmeter multipliers
subMtrMult[2]XXnumberhourlySubmeter multipliers
subMtrMult[3]XXnumberhourlySubmeter multipliers
subMtrMult[4]XXnumberhourlySubmeter multipliers
subMtrMult[5]XXnumberhourlySubmeter multipliers
subMtrMult[6]XXnumberhourlySubmeter multipliers
subMtrMult[7]XXnumberhourlySubmeter multipliers
subMtrMult[8]XXnumberhourlySubmeter multipliers
subMtrMult[9]XXnumberhourlySubmeter multipliers
subMtrMult[10]XXnumberhourlySubmeter multipliers
subMtrMult[11]XXnumberhourlySubmeter multipliers
subMtrMult[12]XXnumberhourlySubmeter multipliers
subMtrMult[13]XXnumberhourlySubmeter multipliers
subMtrMult[14]XXnumberhourlySubmeter multipliers
subMtrMult[15]XXnumberhourlySubmeter multipliers
subMtrMult[16]XXnumberhourlySubmeter multipliers
subMtrMult[17]XXnumberhourlySubmeter multipliers
subMtrMult[18]XXnumberhourlySubmeter multipliers
subMtrMult[19]XXnumberhourlySubmeter multipliers
subMtrMult[20]XXnumberhourlySubmeter multipliers
subMtrMult[21]XXnumberhourlySubmeter multipliers
subMtrMult[22]XXnumberhourlySubmeter multipliers
subMtrMult[23]XXnumberhourlySubmeter multipliers
subMtrMult[24]XXnumberhourlySubmeter multipliers
subMtrMult[25]XXnumberhourlySubmeter multipliers
subMtrMult[26]XXnumberhourlySubmeter multipliers
subMtrMult[27]XXnumberhourlySubmeter multipliers
subMtrMult[28]XXnumberhourlySubmeter multipliers
subMtrMult[29]XXnumberhourlySubmeter multipliers
subMtrMult[30]XXnumberhourlySubmeter multipliers
subMtrMult[31]XXnumberhourlySubmeter multipliers
subMtrMult[32]XXnumberhourlySubmeter multipliers
subMtrMult[33]XXnumberhourlySubmeter multipliers
subMtrMult[34]XXnumberhourlySubmeter multipliers
subMtrMult[35]XXnumberhourlySubmeter multipliers
subMtrMult[36]XXnumberhourlySubmeter multipliers
subMtrMult[37]XXnumberhourlySubmeter multipliers
subMtrMult[38]XXnumberhourlySubmeter multipliers
subMtrMult[39]XXnumberhourlySubmeter multipliers
subMtrMult[40]XXnumberhourlySubmeter multipliers
subMtrMult[41]XXnumberhourlySubmeter multipliers
subMtrMult[42]XXnumberhourlySubmeter multipliers
subMtrMult[43]XXnumberhourlySubmeter multipliers
subMtrMult[44]XXnumberhourlySubmeter multipliers
subMtrMult[45]XXnumberhourlySubmeter multipliers
subMtrMult[46]XXnumberhourlySubmeter multipliers
subMtrMult[47]XXnumberhourlySubmeter multipliers
subMtrMult[48]XXnumberhourlySubmeter multipliers
subMtrMult[49]XXnumberhourlySubmeter multipliers
subMtrMult[50]XXnumberhourlySubmeter multipliers
Y.totXXnumberend of run (of each phase, autoSize or simulate)Total of following specific end uses. code assumes precedes them.
Y.clgXXnumberend of run (of each phase, autoSize or simulate)Space cooling. code assumes 1st member.
Y.htgXXnumberend of run (of each phase, autoSize or simulate)Space heating incl heat pump compressor
Y.hpBUXXnumberend of run (of each phase, autoSize or simulate)Heat pump resistance heating (backup and defrost)
Y.dhwXXnumberend of run (of each phase, autoSize or simulate)Domestic (service) hot water heating
Y.dhwBUXXnumberend of run (of each phase, autoSize or simulate)Domestic (service) hot water backup
Y.dhwMFLXXnumberend of run (of each phase, autoSize or simulate)Domestic (service) multi-family loop energy
Y.fanCXXnumberend of run (of each phase, autoSize or simulate)Fans - cooling and cooling ventilation
Y.fanHXXnumberend of run (of each phase, autoSize or simulate)Fans - heating
Y.fanVXXnumberend of run (of each phase, autoSize or simulate)Fans - iaq ventilation
Y.fanXXnumberend of run (of each phase, autoSize or simulate)Fans - other
Y.auxXXnumberend of run (of each phase, autoSize or simulate)Hvac auxiliaries and parasitics, not including fans
Y.procXXnumberend of run (of each phase, autoSize or simulate)Process energy
Y.litXXnumberend of run (of each phase, autoSize or simulate)Lighting
Y.rcpXXnumberend of run (of each phase, autoSize or simulate)Receptacles
Y.extXXnumberend of run (of each phase, autoSize or simulate)External – outdoor lights, etc
Y.refrXXnumberend of run (of each phase, autoSize or simulate)Refrigeration
Y.dishXXnumberend of run (of each phase, autoSize or simulate)Dish washing
Y.dryXXnumberend of run (of each phase, autoSize or simulate)Clothes drying
Y.washXXnumberend of run (of each phase, autoSize or simulate)Clothes washing
Y.cookXXnumberend of run (of each phase, autoSize or simulate)Cooking
Y.usr1XXnumberend of run (of each phase, autoSize or simulate)User-defined end use 1
Y.usr2XXnumberend of run (of each phase, autoSize or simulate)User-defined end use 2
Y.btXXnumberend of run (of each phase, autoSize or simulate)Battery output (negative)
Y.pvXXnumberend of run (of each phase, autoSize or simulate)Photovoltaic array output (negative)
Y.allEUXXnumberend of run (of each phase, autoSize or simulate)Subtotal, clg .. usr2 (= load w/o bt and pv)
Y.costXXnumberend of run (of each phase, autoSize or simulate)Accumulated tot*rate
Y.dmdCostXXnumberend of run (of each phase, autoSize or simulate)Largest dmd*dmdrate to month level, then accumulates (mtr_accum)
Y.dmdXXnumberend of run (of each phase, autoSize or simulate)Peak use in interval; hourly value same as .tot.
Y.dmdShoyXXunrecognizedend of run (of each phase, autoSize or simulate)Peak time as subhour of year, subhr unused: 4(hr+24jday).
M.totXXnumberend of each monthTotal of following specific end uses. code assumes precedes them.
M.clgXXnumberend of each monthSpace cooling. code assumes 1st member.
M.htgXXnumberend of each monthSpace heating incl heat pump compressor
M.hpBUXXnumberend of each monthHeat pump resistance heating (backup and defrost)
M.dhwXXnumberend of each monthDomestic (service) hot water heating
M.dhwBUXXnumberend of each monthDomestic (service) hot water backup
M.dhwMFLXXnumberend of each monthDomestic (service) multi-family loop energy
M.fanCXXnumberend of each monthFans - cooling and cooling ventilation
M.fanHXXnumberend of each monthFans - heating
M.fanVXXnumberend of each monthFans - iaq ventilation
M.fanXXnumberend of each monthFans - other
M.auxXXnumberend of each monthHvac auxiliaries and parasitics, not including fans
M.procXXnumberend of each monthProcess energy
M.litXXnumberend of each monthLighting
M.rcpXXnumberend of each monthReceptacles
M.extXXnumberend of each monthExternal – outdoor lights, etc
M.refrXXnumberend of each monthRefrigeration
M.dishXXnumberend of each monthDish washing
M.dryXXnumberend of each monthClothes drying
M.washXXnumberend of each monthClothes washing
M.cookXXnumberend of each monthCooking
M.usr1XXnumberend of each monthUser-defined end use 1
M.usr2XXnumberend of each monthUser-defined end use 2
M.btXXnumberend of each monthBattery output (negative)
M.pvXXnumberend of each monthPhotovoltaic array output (negative)
M.allEUXXnumberend of each monthSubtotal, clg .. usr2 (= load w/o bt and pv)
M.costXXnumberend of each monthAccumulated tot*rate
M.dmdCostXXnumberend of each monthLargest dmd*dmdrate to month level, then accumulates (mtr_accum)
M.dmdXXnumberend of each monthPeak use in interval; hourly value same as .tot.
M.dmdShoyXXunrecognizedend of each monthPeak time as subhour of year, subhr unused: 4(hr+24jday).
D.totXXnumberend of each dayTotal of following specific end uses. code assumes precedes them.
D.clgXXnumberend of each daySpace cooling. code assumes 1st member.
D.htgXXnumberend of each daySpace heating incl heat pump compressor
D.hpBUXXnumberend of each dayHeat pump resistance heating (backup and defrost)
D.dhwXXnumberend of each dayDomestic (service) hot water heating
D.dhwBUXXnumberend of each dayDomestic (service) hot water backup
D.dhwMFLXXnumberend of each dayDomestic (service) multi-family loop energy
D.fanCXXnumberend of each dayFans - cooling and cooling ventilation
D.fanHXXnumberend of each dayFans - heating
D.fanVXXnumberend of each dayFans - iaq ventilation
D.fanXXnumberend of each dayFans - other
D.auxXXnumberend of each dayHvac auxiliaries and parasitics, not including fans
D.procXXnumberend of each dayProcess energy
D.litXXnumberend of each dayLighting
D.rcpXXnumberend of each dayReceptacles
D.extXXnumberend of each dayExternal – outdoor lights, etc
D.refrXXnumberend of each dayRefrigeration
D.dishXXnumberend of each dayDish washing
D.dryXXnumberend of each dayClothes drying
D.washXXnumberend of each dayClothes washing
D.cookXXnumberend of each dayCooking
D.usr1XXnumberend of each dayUser-defined end use 1
D.usr2XXnumberend of each dayUser-defined end use 2
D.btXXnumberend of each dayBattery output (negative)
D.pvXXnumberend of each dayPhotovoltaic array output (negative)
D.allEUXXnumberend of each daySubtotal, clg .. usr2 (= load w/o bt and pv)
D.costXXnumberend of each dayAccumulated tot*rate
D.dmdCostXXnumberend of each dayLargest dmd*dmdrate to month level, then accumulates (mtr_accum)
D.dmdXXnumberend of each dayPeak use in interval; hourly value same as .tot.
D.dmdShoyXXunrecognizedend of each dayPeak time as subhour of year, subhr unused: 4(hr+24jday).
H.totXXnumberend of each hourTotal of following specific end uses. code assumes precedes them.
H.clgXXnumberend of each hourSpace cooling. code assumes 1st member.
H.htgXXnumberend of each hourSpace heating incl heat pump compressor
H.hpBUXXnumberend of each hourHeat pump resistance heating (backup and defrost)
H.dhwXXnumberend of each hourDomestic (service) hot water heating
H.dhwBUXXnumberend of each hourDomestic (service) hot water backup
H.dhwMFLXXnumberend of each hourDomestic (service) multi-family loop energy
H.fanCXXnumberend of each hourFans - cooling and cooling ventilation
H.fanHXXnumberend of each hourFans - heating
H.fanVXXnumberend of each hourFans - iaq ventilation
H.fanXXnumberend of each hourFans - other
H.auxXXnumberend of each hourHvac auxiliaries and parasitics, not including fans
H.procXXnumberend of each hourProcess energy
H.litXXnumberend of each hourLighting
H.rcpXXnumberend of each hourReceptacles
H.extXXnumberend of each hourExternal – outdoor lights, etc
H.refrXXnumberend of each hourRefrigeration
H.dishXXnumberend of each hourDish washing
H.dryXXnumberend of each hourClothes drying
H.washXXnumberend of each hourClothes washing
H.cookXXnumberend of each hourCooking
H.usr1XXnumberend of each hourUser-defined end use 1
H.usr2XXnumberend of each hourUser-defined end use 2
H.btXXnumberend of each hourBattery output (negative)
H.pvXXnumberend of each hourPhotovoltaic array output (negative)
H.allEUXXnumberend of each hourSubtotal, clg .. usr2 (= load w/o bt and pv)
H.costXXnumberend of each hourAccumulated tot*rate
H.dmdCostXXnumberend of each hourLargest dmd*dmdrate to month level, then accumulates (mtr_accum)
H.dmdXXnumberend of each hourPeak use in interval; hourly value same as .tot.
H.dmdShoyXXunrecognizedend of each hourPeak time as subhour of year, subhr unused: 4(hr+24jday).

6.49 perimeter (owner: zone)

@perimeter[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXstringconstant
prLenXnumberinput timeLength. input.
prF2Xnumberinput timeConduction per unit length. input.
xiXinteger numberrun start time (of each phase, autoSize or simulate)Subscript in runtime xsurf rat, to facilitate access by probers 1-92

6.50 PVArray

@PVArray[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
mountingXXunrecognizedinput time
areaXXnumberinput time
fBeamXXnumberend of each hour
vrtInp[0]XXnumberinput time
vrtInp[1]XXnumberinput time
vrtInp[2]XXnumberinput time
vrtInp[3]XXnumberinput time
vrtInp[4]XXnumberinput time
vrtInp[5]XXnumberinput time
vrtInp[6]XXnumberinput time
vrtInp[7]XXnumberinput time
vrtInp[8]XXnumberinput time
vrtInp[9]XXnumberinput time
vrtInp[10]XXnumberinput time
vrtInp[11]XXnumberinput time
vrtInp[12]XXnumberinput time
vrtInp[13]XXnumberinput time
vrtInp[14]XXnumberinput time
vrtInp[15]XXnumberinput time
vrtInp[16]XXnumberinput time
vrtInp[17]XXnumberinput time
vrtInp[18]XXnumberinput time
vrtInp[19]XXnumberinput time
vrtInp[20]XXnumberinput time
vrtInp[21]XXnumberinput time
vrtInp[22]XXnumberinput time
vrtInp[23]XXnumberinput time
vrtInp[24]XXnumberinput time
vrtInp[25]XXnumberinput time
vrtInp[26]XXnumberinput time
vrtInp[27]XXnumberinput time
vrtInp[28]XXnumberinput time
vrtInp[29]XXnumberinput time
vrtInp[30]XXnumberinput time
vrtInp[31]XXnumberinput time
vrtInp[32]XXnumberinput time
vrtInp[33]XXnumberinput time
vrtInp[34]XXnumberinput time
vrtInp[35]XXnumberinput time
vrtInp[36]XXnumberinput time
elecMtriXXinteger numberinput timeMeter for system electricity production
endUseXXinteger numberinput timeEnd use of energy. defaults to “pv”
dcCapXXnumberinput timeSystem capacity/size (dc nameplate), kw
moduleTypeXXunrecognizedinput timeType of module (standard, premium, thinfilm)
tempCoeffXXnumberinput timeTemperature coefficient, 1/f
covRefrIndXXnumberinput timeRefraction index for coating applied to cover
arrayTypeXXunrecognizedinput timeType of array (fixed, fixedroof, 1axis, backtracked, 2axis)
tiltXXnumberhourlyArray tilt, radians (input as degrees)
azmXXnumberhourlyArray azimuth, radians (input as degrees)
grndReflXXnumberhourlyGround reflectance
gcrXXnumberinput timeGround coverage ratio (what fraction of the ground is covered by the array). 1.0 implies no spacing.
dcacRatXXnumberinput timeDc to ac ratio
sifXXnumberhourlyShading impact factor
invEffXXnumberinput timeInverter efficiency at rated power
sysLossXXnumberhourlySystem losses
tCellXXnumberend of each hourCell temperature, f
aoiXXnumberend of each hourAngle of incidence (radians)
panelTiltXXnumberend of each hourTilt of pv panel (different from array tilt for tracking systems), radians
panelAzmXXnumberend of each hourAzimuth of pv panel (different from array tilt for tracking systems), radians
panelRotXXnumberend of each hourRotation of pv panel for 1-axis tracking systems, radians clockwise from vertical
poaXXnumberend of each hourPlane of array incidence (before shading), btu/h-ft2
poaBeamXXnumberend of each hourPlane of array beam incidence (before shading), btu/h-ft2
radIBeamXXnumberend of each hourBeam radiation incident on array, btu/h-ft2
radIBeamEffXXnumberend of each hourEffective beam radiation incident on array (accounts for shading impact factor), btu/h-ft2
radIXXnumberend of each hourTotal radiation incident on array, btu/h-ft2
radIEffXXnumberend of each hourEffective total radiation incident on array (accounts for shading impact factor), btu/h-ft2
radTransXXnumberend of each hourTransmitted radiation (after accounting for shading impact), btu/h-ft2
dcOutXXnumberend of each hourDc power output, btu
acOutXXnumberend of each hourAc power output, btu
tauNormXXnumberrun start time (of each phase, autoSize or simulate)Transmittance at normal incidence
inoctXXnumberrun start time (of each phase, autoSize or simulate)Installed nominal operating cell temperature, f
convRatioXXnumberrun start time (of each phase, autoSize or simulate)Ratio of back convection to front convection
tGrndRatioXXnumberrun start time (of each phase, autoSize or simulate)Ratio of ground-cell temperature diff. to air-cell temperature diff.
radILsXXnumberend of each hourLast step (curently hour) total radiation incident on array, btu/h-ft2
tCellLsXXnumberend of each hourLast step (curently hour) cell temperature, f

6.51 report (owner: reportFile)

@report[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXstringconstant
ziXinteger numberinput timeZone for zone-specific reports. can be ti_sum, ti_all.
mtriXinteger numberinput timeMeter to report/export for meter-specific reports. can be ti_sum, ti_all.
ahiXinteger numberinput timeAir handler to report/export for air-handler-specific reports. can be ti_sum, ti_all.
tuiXinteger numberinput timeTerminal to report/export for terminal-specific reports. can be ti_all
dhwMtriXinteger numberinput timeDhw meter to report/export for dhw meter-specific reports. can be ti_all.
afMtriXinteger numberinput timeAir flow meter to report/export for af meter-specific reports. can be ti_all.
isExportXinteger numberinput time1 if export not report, so same fcns can be used with rib and xib records
rpTyXinteger numberconstantReport/export type c_rptych_eb etc
rpFreqXinteger numberconstantR/xport frequency c_ivlch_m etc
rpDayBegXinteger numberinput timeStart 1-based julian day of year, where applicable
rpDayEndXinteger numberinput timeEnd ..
rpBtuSfXnumberinput timeEnergy (btu) scale factor
rpTitleXstringinput timeTitle, for udt, in dm
rpCplXinteger numberinput timeChars per line, inputtable re udt’s (default -1=“as wide as needed”)
rpHeaderXunrecognizedinput timeTable header or export header yes/no (default yes)
rpFooterXinteger numberinput timeTable footer (summary line) or export footer (just blank line?) yes/no (default yes)
coliXinteger numberrun start time (of each phase, autoSize or simulate)Rcolb/xcolb subscript of first column (thence linked by .nxcoli).
nColXinteger numberrun start time (of each phase, autoSize or simulate)# columns
widXinteger numberrun start time (of each phase, autoSize or simulate)Total col width for user-defined report

6.52 reportCol (owner: report)

@reportCol[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
colHeadXXstringinput timeColumn head string, in dm. *i cuz veoi in cncult.cpp:rpcolt[].
colGapXXinteger numberinput timeSpace to left of column, default 1
colWidXXinteger numberinput timeColumn width
colDecXXinteger numberinput timeColdecimals: max digits after point
colJustXXinteger numberinput timeJustification: c_justch_l or _r
colValXXun-probe-ableend of each subhourValue vt_val and data type vt_dt (tyfl/tystr in input, dtfloat/dtculstr in run), used at end report interval.
nxColiXXinteger numberconstantFor runtime: col subscript of next column in this report, 0 if last one

6.53 reportFile

@reportFile[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXstringconstant
fileNameXstringinput timeFile name, path optional. *i cuz veoi in cncult.
fileStatXinteger numberrun start time (of each phase, autoSize or simulate)Fresh(overwrite,default)/new(err if exists)/append
pageFmtXinteger numberinput timePage formatting on no/yes
fileStatCheckedXinteger numberrun start time (of each phase, autoSize or simulate)Check filestat only once to prevent “file exists” error or re-setting “overwrite” on later run
overWriteXinteger numberrun start time (of each phase, autoSize or simulate)Append if 0. set by filestat=fresh, cleared on use, so addl runs do not erase earlier output.
wasNotEmptyXinteger numberrun start time (of each phase, autoSize or simulate)Nz if existed and size > 0 at filestat check

6.54 RSYS

@RSYS[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
typeXXunrecognizedinput timeSystem type (acfurn, acres, ashp, ac, furn, res)
descXXstringinput timeOptional description string (e.g. model #)
perfMapXXinteger numberinput timeIf yes, make performance map (development aid)
areaServedXXnumberrun start time (of each phase, autoSize or simulate)Total zone floor area served by this rsys, ft2
elecMtriXXinteger numberinput timeMeter for system electricity use
fuelMtriXXinteger numberinput timeMeter for system fuel use
loadMtriXXinteger numberinput timeIdx of loadmeter that accumulates of primary (coil) output
htgLoadMtriXXinteger numberinput timeIdx of loadmeter that accumulates only primary (coil) heating output
clgLoadMtriXXinteger numberinput timeIdx of loadmeter that accumulates only primary (coil) cooling output
srcSideLoadMtriXXinteger numberinput timeIdx of loadmeter that accumulation of source-side heat transfer
htgSrcSideLoadMtriXXinteger numberinput timeIdx of loadmeter for accumulation of source-side heating
clgSrcSideLoadMtriXXinteger numberinput timeIdx of loadmeter for accumulation of source-side cooling
parElecXXnumberhourlyElectrical parasitic power, w
parFuelXXnumberhourlyFuel parasitic consumption, btuh
capNomHXXnumberdailyNominal heating capacity, btuh. default=rs_caph or rs_cap47
capNomCXXnumberdailyNominal cooling capacity, btuh. default=rs_cap95
fan.fanTyXXunrecognizedrun start time (of each phase, autoSize or simulate)
fan.vfDsXXnumberend of each subhour
fan.vfDs_AsXXnumberrun start time (of each phase, autoSize or simulate)
fan.vfDs_AsNovXXnumberrun start time (of each phase, autoSize or simulate)
fan.vfMxFXXnumberrun start time (of each phase, autoSize or simulate)
fan.pressXXnumberrun start time (of each phase, autoSize or simulate)
fan.effXXnumberrun start time (of each phase, autoSize or simulate)
fan.shaftPwrXXnumberrun start time (of each phase, autoSize or simulate)
fan.elecPwrXXnumberrun start time (of each phase, autoSize or simulate)
fan.motTyXXunrecognizedrun start time (of each phase, autoSize or simulate)
fan.motEffXXnumberrun start time (of each phase, autoSize or simulate)
fan.motPosXXunrecognizedrun start time (of each phase, autoSize or simulate)
fan.curvePy.k[0]XXnumberrun start time (of each phase, autoSize or simulate)
fan.curvePy.k[1]XXnumberrun start time (of each phase, autoSize or simulate)
fan.curvePy.k[2]XXnumberrun start time (of each phase, autoSize or simulate)
fan.curvePy.k[3]XXnumberrun start time (of each phase, autoSize or simulate)
fan.curvePy.k[4]XXnumberrun start time (of each phase, autoSize or simulate)
fan.curvePy.k[5]XXnumberrun start time (of each phase, autoSize or simulate)
fan.mtriXXinteger numberrun start time (of each phase, autoSize or simulate)
fan.endUseXXinteger numberrun start time (of each phase, autoSize or simulate)
fan.auszXXinteger numberrun start time (of each phase, autoSize or simulate)
fan.outPowerXXnumbersubhourly
fan.airPowerXXnumbersubhourly
fan.cMxXXnumberend of each subhour
fan.cXXnumberend of each subhour
fan.tXXnumberend of each subhour
fan.frOnXXnumberend of each subhour
fan.pXXnumberend of each subhour
fan.qXXnumberend of each subhour
fan.dTXXnumberend of each subhour
fan.qAroundXXnumberend of each subhour
adjForFanHtXXinteger numberrun start time (of each phase, autoSize or simulate)Yes: fanhtrtd derived from rs_fan.motty
asRet.tdbXXnumberend of each subhour
asRet.wXXnumberend of each subhour
asIn.tdbXXnumberend of each subhour
asIn.wXXnumberend of each subhour
twbInXXnumberend of each subhourEntering air wet bulb (after return ducts), f
asOut.tdbXXnumberend of each subhour
asOut.wXXnumberend of each subhour
asOutAux.tdbXXnumberend of each subhour
asOutAux.wXXnumberend of each subhour
asSup.tdbXXnumberend of each subhour
asSup.wXXnumberend of each subhour
asSupAux.tdbXXnumberend of each subhour
asSupAux.wXXnumberend of each subhour
tSupLsXXnumbersubhourly… supply dry-bulb at last step, f
DSEHXXnumberhourlyHeating
DSECXXnumberhourlyCooling
tdDesHXXnumberrun start time (of each phase, autoSize or simulate)Design temperature difference (rise) across rsys for heating
tdDesCXXnumberrun start time (of each phase, autoSize or simulate)Design temperature difference (fall) across rsys for cooling
fxCap[0]XXnumberend of each subhourCurrent step excess capacity factor = amfavailable / max( amfrequest)
fxCap[1]XXnumberend of each subhourCurrent step excess capacity factor = amfavailable / max( amfrequest)
fxCapCDayXXnumberend of each hourCurrent day excess cooling capacity factor
fxCapHDayXXnumberend of each hourDitto heating
fxCapHTargXXnumberrun start time (of each phase, autoSize or simulate)Target excess capacity factor for heating autosize
fxCapHAsFXXnumberrun start time (of each phase, autoSize or simulate)Working excess capacity factor for heating autosize
fxCapCTargXXnumberrun start time (of each phase, autoSize or simulate)Target excess capacity factor for cooling autosize
fxCapCAsFXXnumberrun start time (of each phase, autoSize or simulate)Working excess capacity factor for cooling autosize
fxCapAuxHTargXXnumberautosize and simulate phase start timeTarget excess capacity factor for auxh autosize
auszH.az_activeXXinteger numberrun start time (of each phase, autoSize or simulate)
auszH.az_aXXnumberend of each subhour
auszH.az_bXXnumberend of each subhour
auszH.ldPkXXnumberend of each subhour
auszH.ldPkAsXXnumberend of each day
auszH.ldPkAs1XXnumberend of each day
auszH.plrPkXXnumberend of each subhour
auszH.plrPkAsXXnumberend of each day
auszH.xPkXXnumberend of each subhour
auszH.xPkAsXXnumberend of each day
auszH.az_notDoneXXinteger numberend of each day
auszC.az_activeXXinteger numberrun start time (of each phase, autoSize or simulate)
auszC.az_aXXnumberend of each subhour
auszC.az_bXXnumberend of each subhour
auszC.ldPkXXnumberend of each subhour
auszC.ldPkAsXXnumberend of each day
auszC.ldPkAs1XXnumberend of each day
auszC.plrPkXXnumberend of each subhour
auszC.plrPkAsXXnumberend of each day
auszC.xPkXXnumberend of each subhour
auszC.xPkAsXXnumberend of each day
auszC.az_notDoneXXinteger numberend of each day
HSPFXXnumberrun start time (of each phase, autoSize or simulate)Rated hspf, btuh/w
cap47XXnumberend of each phase (autosize or simulate)Full speed net heating capacity at odb=47 f
COP47XXnumberend of each phase (autosize or simulate)Cop at odb=47 f
cap35XXnumberend of each phase (autosize or simulate)Full speed net heating capacity at odb=35 f
COP35XXnumberend of each phase (autosize or simulate)Cop at odb=35 f
cap17XXnumberend of each phase (autosize or simulate)Full speed net heating capacity at odb=17 f
COP17XXnumberend of each phase (autosize or simulate)Cop at odb=17 f
cap05XXnumberend of each phase (autosize or simulate)Full speed net heating capacity at odb=5 f
COP05XXnumberend of each phase (autosize or simulate)Cop at odb=5 f
capRat1747XXnumberrun start time (of each phase, autoSize or simulate)Cap17 / cap47 ratio (re autosizing)
capRat0547XXnumberrun start time (of each phase, autoSize or simulate)Cap05 / cap47 ratio (re autosizing)
capRat9547XXnumberrun start time (of each phase, autoSize or simulate)Total net cap95 (cooling) / net cap47 (heating)
loadFMin47XXnumberend of each phase (autosize or simulate)Htg min load fract at 47 f (cycles below this)
loadFMin17XXnumberend of each phase (autosize or simulate)Htg min load fract at 17 f (cycles below this)
loadFMin05XXnumberend of each phase (autosize or simulate)Htg min load fract at 5 f (cycles below this)
COPMin47XXnumberend of each phase (autosize or simulate)Cop at odb=47 f, min speed
COPMin35XXnumberend of each phase (autosize or simulate)Cop at odb=35 f, min speed
COPMin17XXnumberend of each phase (autosize or simulate)Cop at odb=17 f, min speed
COPMin05XXnumberend of each phase (autosize or simulate)Cop at odb=5 f, min speed
CdHXXnumberend of each phase (autosize or simulate)Heating cycling degradation factor
inp47XXnumberend of each phase (autosize or simulate)Input power at odb=47 f, btuh (w/ rated fan power)
inp35XXnumberend of each phase (autosize or simulate)Input power at odb=35 f, btuh (w/ rated fan power)
inp17XXnumberend of each phase (autosize or simulate)Input power at odb=17 f, btuh (w/ rated fan power)
inp05XXnumberend of each phase (autosize or simulate)Input power at odb=5 f, btuh (w/ rated fan power)
ASHPCapF[0]XXnumberrun start time (of each phase, autoSize or simulate)Capacity slope: cap(t) = cap17 + capf*(t - 17)
ASHPCapF[1]XXnumberrun start time (of each phase, autoSize or simulate)Capacity slope: cap(t) = cap17 + capf*(t - 17)
ASHPInpF[0]XXnumberrun start time (of each phase, autoSize or simulate)Input slope: inp(t) = inp17 + inpf*(t - 17)
ASHPInpF[1]XXnumberrun start time (of each phase, autoSize or simulate)Input slope: inp(t) = inp17 + inpf*(t - 17)
typeAuxHXXunrecognizedrun start time (of each phase, autoSize or simulate)Type of auxiliary heat (c_auxheatty_none, _res, _furn)
ctrlAuxHXXunrecognizedrun start time (of each phase, autoSize or simulate)Auxiliary heating control
capAuxHXXnumberend of each phase (autosize or simulate)Auxiliary heating capacity (not including fan heat), btuh
capAuxHInpXXnumberend of each phase (autosize or simulate)Rs_capauxh as input (may be autosize)
AFUEAuxHXXnumberautosize and simulate phase start timeAuxiliary furnace heating afue (assumed constant), default 0.9
effAuxHXXnumberautosize and simulate phase start timeAux heat efficiency (= rs_afueauxh or 1)
ASHPLockOutTXXnumberhourlyAir source heat pump compressor lockout temp, f
defrostModelXXunrecognizedrun start time (of each phase, autoSize or simulate)Defrost model
AFUEXXnumberautosize and simulate phase start timeHeating system rated afue, 0 < afue <= 1
capHXXnumberend of each phase (autosize or simulate)Rated net heating output (including fan), btuh
capH_AsXXnumberend of each phase (autosize or simulate)
capH_AsNovXXnumberend of each phase (autosize or simulate)
fanHRtdHXXnumberautosize and simulate phase start timeFan heat included in ashp rated cap/cop/hspf, btuh
fanPwrHXXnumberrun start time (of each phase, autoSize or simulate)Operating heating fan power, w/cfm
fanHeatHXXnumberend of each phase (autosize or simulate)Operating heating fan electrical power at cfm, btuh
amfHXXnumberend of each phase (autosize or simulate)Heating full speed dry air mass flow rate, lbm/hr
effHtXXnumberend of each subhourCurrent step full load heating efficiency, dimless
capHtXXnumberend of each subhourCurrent step full speed primary heating capacity, btuh
inpHtXXnumberend of each subhourCurrent step full speed compressor input power
capDfHtXXnumberend of each subhourCurrent step defrost heating capacity, btuh
capHtMinXXnumberend of each subhourCurrent step min speed heating capacity (including fan and ashp defrost heat), btuh
inpHtMinXXnumberend of each subhourCurrent min speed compressor input power
capDfHtMinXXnumberend of each subhourCurrent step min speed defrost heating capacity, btuh
COPHtAdjXXnumberend of each subhourCurrent step adjusted heating compressor cop (reflecting all adjustments)
capRatCHXXnumberautosize and simulate phase start timeTotal net capc (aka rs_cap95) (cooling) / net caph (heating)
CHDHWSYSiXXinteger numberinput timeIndex of dhwsys supplying hot water for combined heat/dwh chdhw coil
tCoilEWXXnumberend of each subhourChdhw heating coil entering water temp, f
cap95XXnumberend of each phase (autosize or simulate)Rated full speed net total cooling capacity at 95 f (>= 0), btuh
cap95_AsXXnumberend of each phase (autosize or simulate)
cap95_AsNovXXnumberend of each phase (autosize or simulate)
COP95XXnumberend of each phase (autosize or simulate)Cop at 95 f (= rs_eer95 / 3.412)
EER95XXnumberend of each phase (autosize or simulate)Eer at 95 f, btuh/w (=rs_cop95 * 3.412)
SEERXXnumberend of each phase (autosize or simulate)Cooling ahri rated seer, btuh/w
cap115XXnumberend of each phase (autosize or simulate)Total full speed net cooling capacity at 115 f (>= 0), btuh
COP115XXnumberend of each phase (autosize or simulate)Full speed cooling cop at 115f
capRat11595XXnumberrun start time (of each phase, autoSize or simulate)Cap115 / cap95 (re autosizing)
cap82XXnumberend of each phase (autosize or simulate)Total full speed net cooling capacity at 82 f (>= 0), btuh
COP82XXnumberend of each phase (autosize or simulate)Full speed cooling cop at 82f
capRat8295XXnumberrun start time (of each phase, autoSize or simulate)Cap82 / cap95 ratio (re autosizing)
loadFMin115XXnumberend of each phase (autosize or simulate)Clg min load fract at 115 f (cycles below this)
loadFMin95XXnumberend of each phase (autosize or simulate)Clg min load fract at 95 f (cycles below this)
loadFMin82XXnumberend of each phase (autosize or simulate)Clg min load fract at 82 f (cycles below this)
COPMin115XXnumberend of each phase (autosize or simulate)Cop at odb=115 f, min speed
COPMin95XXnumberend of each phase (autosize or simulate)Cop at odb=95 f, min speed
COPMin82XXnumberend of each phase (autosize or simulate)Cop at odb=82 f, min speed
vfPerTonXXnumberautosize and simulate phase start timeAir flow ratio, cfm/ton (= cfm/(rs_cap95/12000))
fanPwrCXXnumberautosize and simulate phase start timeCooling fan operating power ratio, w/cfm (default 0.365)
fanHeatCXXnumberend of each phase (autosize or simulate)Cooling fan full speed operating electrical power, btuh
fanDeltaTCXXnumberend of each phase (autosize or simulate)Cooling fan heat temperature rise, f
amfCXXnumberend of each phase (autosize or simulate)Cooling dry air mass flow rate, lbm/hr
CdCXXnumberend of each phase (autosize or simulate)Cooling cycling degradation factor
rhInTestXXnumberend of each hourSpecified entering air relnum (for testing), 0-1
rhInXXnumberend of each subhourPlenum entering air relnum, 0-1
twbCoilInXXnumberend of each subhourCoil entering wet bulb, f (after blow-thru fan if any)
tdbCoilInXXnumberend of each subhourCoil entering dry bulb, f (ditto)
SHRXXnumberend of each subhourCooling sensible heat ratio (sensible capacity / total capacity)
SHRtargetXXnumbersubhourlyInputable nominal sensible heat ratio (for fancoil)
fChgXXnumberautosize and simulate phase start timeRefrigerant charge factor (default 1, 0.9 or 0.96 for ca compliance)
fanHRtdCXXnumberautosize and simulate phase start timeFan heat included in rated rs_cap95, btuh
capnfXXXnumberautosize and simulate phase start timeConstant for rs_capxxxct calc
SEERnfXXXnumberend of each phase (autosize or simulate)Constant for rs_seernf calc
EERnfXXXnumberend of each phase (autosize or simulate)Constant for rs_eernfcalc
fCondCapXXnumberend of each subhourConditions factor, capacity
fCondSEERXXnumberend of each subhourConditions factor, seer
fCondEERXXnumberend of each subhourConditions factor, eer
SEERnfXXnumberend of each subhourSeer w/o fan power
EERnfXXnumberend of each subhourEer w/o fan power
EERtXXnumberend of each subhourCompressor eer, btuh/w (temperature weighted mix of
effCtXXnumberend of each subhourTemp adjusted compressor efficiency (= cet in acm)
capTotCtXXnumberend of each subhourCoil total cooling capacity at current conditions and speed, btuh (<0)
capLatCtXXnumberend of each subhourCoil latent cooling capacity at current conditions and speed, btuh (<0)
capSenCtXXnumberend of each subhourCoil sensible cooling capacity at current conditions and speed, btuh (<0)
OAVTypeXXunrecognizedinput timeType: none, fixedflow (aka smartvent), varflow (aka smartbreeze)
OAVReliefZiXXinteger numberinput timeOav relief zone index
OAVTdbInletXXnumbersubhourlyOav inlet dry-bulb temp, f
OAVTdiffXXnumberhourlyOav temperature differential, f
OAVAvfDsXXnumberinput timeOav design air flow rate, cfm actual air
OAVFanPwrXXnumberinput timeOav design fan power (based on rs_oavvfds), w/cfm
OAVAvfMinFXXnumberinput timeOav minimum volume flow (rs_avfoav always >= rs_oavavfminf *rs_oavavfds)
avfOAVXXnumberdailyOav current air volume flow, cfm (set at beg of each day)
fanHeatOAVXXnumberdailyDitto fan power, btuh
amfOAVXXnumberdailyDitto air mass flow, lbm/hr
fEffHXXnumbersubhourlyHeating efficiency adjustment factor (applied to substep efficency), default=1
fEffAuxHBackupXXnumbersubhourlyAuxiliary heating backup mode efficiency adjustment factor (applied to substep efficency), default=1
fEffAuxHDefrostXXnumbersubhourlyAuxiliary heating defrost mode efficiency adjustment factor (applied to substep efficency), default=1
fEffCXXnumbersubhourlyCooling efficiency adjustment factor (applied to substep efficency), default=1
tdbOutXXnumbersubhourlyOutdoor dry-bulb temp at condensor or other outdoor components, f
modeCtrlXXunrecognizedhourlyMode control (off, heat, cool, auto }
modeXXinteger numberend of each subhourMode (rsmoff, rsmheat, rsmcool, rsmoav )
modeLsXXinteger numbersubhourlyLast step mode (rsmoff, rsmheat, rsmcool, rsmoav )
modeLastActiveXXinteger numbersubhourlyLast active mode (rsmoff, rsmheat, rsmcool, rsmoav )
amfReq[0]XXnumberend of each subhourTotal amf (at system) requested by zones, lbm/hr
amfReq[1]XXnumberend of each subhourTotal amf (at system) requested by zones, lbm/hr
znLoad[0]XXnumberend of each subhourTotal load to hold zone(s) at setpoint, btuh
znLoad[1]XXnumberend of each subhourTotal load to hold zone(s) at setpoint, btuh
capSenNetFSXXnumberend of each subhourNet sensible capacity at full speed, btuh
amfXXnumberend of each subhourCurrent dry air mass flow rate, lbm/hr
PLFXXnumberend of each subhourEfficiency degradation due to cycling
PLRXXnumberend of each subhourCurrent step part load ratio = sensible load / full-speed sensible capacity
loadFXXnumberend of each subhourCurrent step load fraction = sensible load / current-speed sensible capacity
loadFLsXXnumbersubhourlyLast step loadf (for probe access at step beg)
runFXXnumberend of each subhourPrimary (e.g. compressor) run fraction
speedFXXnumberend of each subhourPrimary (compressor) current speed fraction
speedFMinXXnumberend of each subhourPrimary (compressor) current minimum speed fraction
runFAuxXXnumberend of each subhourAuxiliary run fraction
outSenXXnumberend of each subhourAverage primary (compressor, burner, coil, ) sensible heat delivery rate for last subhr, btuh
outLatXXnumberend of each subhourAverage latent heat delivery rate, btuh
outFanXXnumberend of each subhourAverage fan heat added to air stream, btuh
outDefrostXXnumberend of each subhourAverate defrost heat, btuh
outAuxXXnumberend of each subhourAverage auxiliary heat added to air stream, btuh (for ashp)
outSenTotXXnumberend of each subhourAverage total sensible heat delivery rate for last subhr, btuh
inPrimaryXXnumberend of each subhourPrimary input, btuh (compressor, burner, )
inFanXXnumberend of each subhourFan electricity input, btuh (not kwh)
inDefrostXXnumberend of each subhourDefrost heating input, btuh (ashp only)
inAuxXXnumberend of each subhourAuxiliary heating input, btuh

6.55 RSYSRes

@RSYSRes[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXstringconstant
Y.hrsOnXnumberend of run (of each phase, autoSize or simulate)
Y.hrsOnAuxXnumberend of run (of each phase, autoSize or simulate)
Y.qhPrimaryXnumberend of run (of each phase, autoSize or simulate)
Y.qhDefrostXnumberend of run (of each phase, autoSize or simulate)
Y.qhAuxXnumberend of run (of each phase, autoSize or simulate)
Y.qhFanXnumberend of run (of each phase, autoSize or simulate)
Y.qhNetXnumberend of run (of each phase, autoSize or simulate)
Y.qcSenXnumberend of run (of each phase, autoSize or simulate)
Y.qcLatXnumberend of run (of each phase, autoSize or simulate)
Y.qcFanXnumberend of run (of each phase, autoSize or simulate)
Y.qcSenNetXnumberend of run (of each phase, autoSize or simulate)
Y.qvFanXnumberend of run (of each phase, autoSize or simulate)
Y.fhPrimaryXnumberend of run (of each phase, autoSize or simulate)
Y.fhDefrostXnumberend of run (of each phase, autoSize or simulate)
Y.fhAuxXnumberend of run (of each phase, autoSize or simulate)
Y.fhParasiticXnumberend of run (of each phase, autoSize or simulate)
Y.fhTotXnumberend of run (of each phase, autoSize or simulate)
Y.ehPrimaryXnumberend of run (of each phase, autoSize or simulate)
Y.ehDefrostXnumberend of run (of each phase, autoSize or simulate)
Y.ehAuxXnumberend of run (of each phase, autoSize or simulate)
Y.ehFanXnumberend of run (of each phase, autoSize or simulate)
Y.ehParasiticXnumberend of run (of each phase, autoSize or simulate)
Y.ehTotXnumberend of run (of each phase, autoSize or simulate)
Y.ecPrimaryXnumberend of run (of each phase, autoSize or simulate)
Y.ecFanXnumberend of run (of each phase, autoSize or simulate)
Y.ecParasiticXnumberend of run (of each phase, autoSize or simulate)
Y.ecTotXnumberend of run (of each phase, autoSize or simulate)
Y.evFanXnumberend of run (of each phase, autoSize or simulate)
Y.evParasiticXnumberend of run (of each phase, autoSize or simulate)
Y.evTotXnumberend of run (of each phase, autoSize or simulate)
Y.qhZoneSenXnumberend of run (of each phase, autoSize or simulate)
Y.qhZoneLatXnumberend of run (of each phase, autoSize or simulate)
Y.qcZoneSenXnumberend of run (of each phase, autoSize or simulate)
Y.qcZoneLatXnumberend of run (of each phase, autoSize or simulate)
Y.qvZoneSenXnumberend of run (of each phase, autoSize or simulate)
Y.qvZoneLatXnumberend of run (of each phase, autoSize or simulate)
M.hrsOnXnumberend of each month
M.hrsOnAuxXnumberend of each month
M.qhPrimaryXnumberend of each month
M.qhDefrostXnumberend of each month
M.qhAuxXnumberend of each month
M.qhFanXnumberend of each month
M.qhNetXnumberend of each month
M.qcSenXnumberend of each month
M.qcLatXnumberend of each month
M.qcFanXnumberend of each month
M.qcSenNetXnumberend of each month
M.qvFanXnumberend of each month
M.fhPrimaryXnumberend of each month
M.fhDefrostXnumberend of each month
M.fhAuxXnumberend of each month
M.fhParasiticXnumberend of each month
M.fhTotXnumberend of each month
M.ehPrimaryXnumberend of each month
M.ehDefrostXnumberend of each month
M.ehAuxXnumberend of each month
M.ehFanXnumberend of each month
M.ehParasiticXnumberend of each month
M.ehTotXnumberend of each month
M.ecPrimaryXnumberend of each month
M.ecFanXnumberend of each month
M.ecParasiticXnumberend of each month
M.ecTotXnumberend of each month
M.evFanXnumberend of each month
M.evParasiticXnumberend of each month
M.evTotXnumberend of each month
M.qhZoneSenXnumberend of each month
M.qhZoneLatXnumberend of each month
M.qcZoneSenXnumberend of each month
M.qcZoneLatXnumberend of each month
M.qvZoneSenXnumberend of each month
M.qvZoneLatXnumberend of each month
D.hrsOnXnumberend of each day
D.hrsOnAuxXnumberend of each day
D.qhPrimaryXnumberend of each day
D.qhDefrostXnumberend of each day
D.qhAuxXnumberend of each day
D.qhFanXnumberend of each day
D.qhNetXnumberend of each day
D.qcSenXnumberend of each day
D.qcLatXnumberend of each day
D.qcFanXnumberend of each day
D.qcSenNetXnumberend of each day
D.qvFanXnumberend of each day
D.fhPrimaryXnumberend of each day
D.fhDefrostXnumberend of each day
D.fhAuxXnumberend of each day
D.fhParasiticXnumberend of each day
D.fhTotXnumberend of each day
D.ehPrimaryXnumberend of each day
D.ehDefrostXnumberend of each day
D.ehAuxXnumberend of each day
D.ehFanXnumberend of each day
D.ehParasiticXnumberend of each day
D.ehTotXnumberend of each day
D.ecPrimaryXnumberend of each day
D.ecFanXnumberend of each day
D.ecParasiticXnumberend of each day
D.ecTotXnumberend of each day
D.evFanXnumberend of each day
D.evParasiticXnumberend of each day
D.evTotXnumberend of each day
D.qhZoneSenXnumberend of each day
D.qhZoneLatXnumberend of each day
D.qcZoneSenXnumberend of each day
D.qcZoneLatXnumberend of each day
D.qvZoneSenXnumberend of each day
D.qvZoneLatXnumberend of each day
H.hrsOnXnumberend of each hour
H.hrsOnAuxXnumberend of each hour
H.qhPrimaryXnumberend of each hour
H.qhDefrostXnumberend of each hour
H.qhAuxXnumberend of each hour
H.qhFanXnumberend of each hour
H.qhNetXnumberend of each hour
H.qcSenXnumberend of each hour
H.qcLatXnumberend of each hour
H.qcFanXnumberend of each hour
H.qcSenNetXnumberend of each hour
H.qvFanXnumberend of each hour
H.fhPrimaryXnumberend of each hour
H.fhDefrostXnumberend of each hour
H.fhAuxXnumberend of each hour
H.fhParasiticXnumberend of each hour
H.fhTotXnumberend of each hour
H.ehPrimaryXnumberend of each hour
H.ehDefrostXnumberend of each hour
H.ehAuxXnumberend of each hour
H.ehFanXnumberend of each hour
H.ehParasiticXnumberend of each hour
H.ehTotXnumberend of each hour
H.ecPrimaryXnumberend of each hour
H.ecFanXnumberend of each hour
H.ecParasiticXnumberend of each hour
H.ecTotXnumberend of each hour
H.evFanXnumberend of each hour
H.evParasiticXnumberend of each hour
H.evTotXnumberend of each hour
H.qhZoneSenXnumberend of each hour
H.qhZoneLatXnumberend of each hour
H.qcZoneSenXnumberend of each hour
H.qcZoneLatXnumberend of each hour
H.qvZoneSenXnumberend of each hour
H.qvZoneLatXnumberend of each hour
S.hrsOnXnumberend of each subhour
S.hrsOnAuxXnumberend of each subhour
S.qhPrimaryXnumberend of each subhour
S.qhDefrostXnumberend of each subhour
S.qhAuxXnumberend of each subhour
S.qhFanXnumberend of each subhour
S.qhNetXnumberend of each subhour
S.qcSenXnumberend of each subhour
S.qcLatXnumberend of each subhour
S.qcFanXnumberend of each subhour
S.qcSenNetXnumberend of each subhour
S.qvFanXnumberend of each subhour
S.fhPrimaryXnumberend of each subhour
S.fhDefrostXnumberend of each subhour
S.fhAuxXnumberend of each subhour
S.fhParasiticXnumberend of each subhour
S.fhTotXnumberend of each subhour
S.ehPrimaryXnumberend of each subhour
S.ehDefrostXnumberend of each subhour
S.ehAuxXnumberend of each subhour
S.ehFanXnumberend of each subhour
S.ehParasiticXnumberend of each subhour
S.ehTotXnumberend of each subhour
S.ecPrimaryXnumberend of each subhour
S.ecFanXnumberend of each subhour
S.ecParasiticXnumberend of each subhour
S.ecTotXnumberend of each subhour
S.evFanXnumberend of each subhour
S.evParasiticXnumberend of each subhour
S.evTotXnumberend of each subhour
S.qhZoneSenXnumberend of each subhour
S.qhZoneLatXnumberend of each subhour
S.qcZoneSenXnumberend of each subhour
S.qcZoneLatXnumberend of each subhour
S.qvZoneSenXnumberend of each subhour
S.qvZoneLatXnumberend of each subhour
prior.Y.hrsOnXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.hrsOnAuxXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.qhPrimaryXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.qhDefrostXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.qhAuxXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.qhFanXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.qhNetXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.qcSenXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.qcLatXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.qcFanXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.qcSenNetXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.qvFanXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.fhPrimaryXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.fhDefrostXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.fhAuxXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.fhParasiticXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.fhTotXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.ehPrimaryXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.ehDefrostXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.ehAuxXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.ehFanXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.ehParasiticXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.ehTotXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.ecPrimaryXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.ecFanXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.ecParasiticXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.ecTotXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.evFanXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.evParasiticXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.evTotXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.qhZoneSenXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.qhZoneLatXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.qcZoneSenXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.qcZoneLatXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.qvZoneSenXnumberrun start time (of each phase, autoSize or simulate)
prior.Y.qvZoneLatXnumberrun start time (of each phase, autoSize or simulate)
prior.M.hrsOnXnumbermonthly
prior.M.hrsOnAuxXnumbermonthly
prior.M.qhPrimaryXnumbermonthly
prior.M.qhDefrostXnumbermonthly
prior.M.qhAuxXnumbermonthly
prior.M.qhFanXnumbermonthly
prior.M.qhNetXnumbermonthly
prior.M.qcSenXnumbermonthly
prior.M.qcLatXnumbermonthly
prior.M.qcFanXnumbermonthly
prior.M.qcSenNetXnumbermonthly
prior.M.qvFanXnumbermonthly
prior.M.fhPrimaryXnumbermonthly
prior.M.fhDefrostXnumbermonthly
prior.M.fhAuxXnumbermonthly
prior.M.fhParasiticXnumbermonthly
prior.M.fhTotXnumbermonthly
prior.M.ehPrimaryXnumbermonthly
prior.M.ehDefrostXnumbermonthly
prior.M.ehAuxXnumbermonthly
prior.M.ehFanXnumbermonthly
prior.M.ehParasiticXnumbermonthly
prior.M.ehTotXnumbermonthly
prior.M.ecPrimaryXnumbermonthly
prior.M.ecFanXnumbermonthly
prior.M.ecParasiticXnumbermonthly
prior.M.ecTotXnumbermonthly
prior.M.evFanXnumbermonthly
prior.M.evParasiticXnumbermonthly
prior.M.evTotXnumbermonthly
prior.M.qhZoneSenXnumbermonthly
prior.M.qhZoneLatXnumbermonthly
prior.M.qcZoneSenXnumbermonthly
prior.M.qcZoneLatXnumbermonthly
prior.M.qvZoneSenXnumbermonthly
prior.M.qvZoneLatXnumbermonthly
prior.D.hrsOnXnumberdaily
prior.D.hrsOnAuxXnumberdaily
prior.D.qhPrimaryXnumberdaily
prior.D.qhDefrostXnumberdaily
prior.D.qhAuxXnumberdaily
prior.D.qhFanXnumberdaily
prior.D.qhNetXnumberdaily
prior.D.qcSenXnumberdaily
prior.D.qcLatXnumberdaily
prior.D.qcFanXnumberdaily
prior.D.qcSenNetXnumberdaily
prior.D.qvFanXnumberdaily
prior.D.fhPrimaryXnumberdaily
prior.D.fhDefrostXnumberdaily
prior.D.fhAuxXnumberdaily
prior.D.fhParasiticXnumberdaily
prior.D.fhTotXnumberdaily
prior.D.ehPrimaryXnumberdaily
prior.D.ehDefrostXnumberdaily
prior.D.ehAuxXnumberdaily
prior.D.ehFanXnumberdaily
prior.D.ehParasiticXnumberdaily
prior.D.ehTotXnumberdaily
prior.D.ecPrimaryXnumberdaily
prior.D.ecFanXnumberdaily
prior.D.ecParasiticXnumberdaily
prior.D.ecTotXnumberdaily
prior.D.evFanXnumberdaily
prior.D.evParasiticXnumberdaily
prior.D.evTotXnumberdaily
prior.D.qhZoneSenXnumberdaily
prior.D.qhZoneLatXnumberdaily
prior.D.qcZoneSenXnumberdaily
prior.D.qcZoneLatXnumberdaily
prior.D.qvZoneSenXnumberdaily
prior.D.qvZoneLatXnumberdaily
prior.H.hrsOnXnumberhourly
prior.H.hrsOnAuxXnumberhourly
prior.H.qhPrimaryXnumberhourly
prior.H.qhDefrostXnumberhourly
prior.H.qhAuxXnumberhourly
prior.H.qhFanXnumberhourly
prior.H.qhNetXnumberhourly
prior.H.qcSenXnumberhourly
prior.H.qcLatXnumberhourly
prior.H.qcFanXnumberhourly
prior.H.qcSenNetXnumberhourly
prior.H.qvFanXnumberhourly
prior.H.fhPrimaryXnumberhourly
prior.H.fhDefrostXnumberhourly
prior.H.fhAuxXnumberhourly
prior.H.fhParasiticXnumberhourly
prior.H.fhTotXnumberhourly
prior.H.ehPrimaryXnumberhourly
prior.H.ehDefrostXnumberhourly
prior.H.ehAuxXnumberhourly
prior.H.ehFanXnumberhourly
prior.H.ehParasiticXnumberhourly
prior.H.ehTotXnumberhourly
prior.H.ecPrimaryXnumberhourly
prior.H.ecFanXnumberhourly
prior.H.ecParasiticXnumberhourly
prior.H.ecTotXnumberhourly
prior.H.evFanXnumberhourly
prior.H.evParasiticXnumberhourly
prior.H.evTotXnumberhourly
prior.H.qhZoneSenXnumberhourly
prior.H.qhZoneLatXnumberhourly
prior.H.qcZoneSenXnumberhourly
prior.H.qcZoneLatXnumberhourly
prior.H.qvZoneSenXnumberhourly
prior.H.qvZoneLatXnumberhourly
prior.S.hrsOnXnumbersubhourly
prior.S.hrsOnAuxXnumbersubhourly
prior.S.qhPrimaryXnumbersubhourly
prior.S.qhDefrostXnumbersubhourly
prior.S.qhAuxXnumbersubhourly
prior.S.qhFanXnumbersubhourly
prior.S.qhNetXnumbersubhourly
prior.S.qcSenXnumbersubhourly
prior.S.qcLatXnumbersubhourly
prior.S.qcFanXnumbersubhourly
prior.S.qcSenNetXnumbersubhourly
prior.S.qvFanXnumbersubhourly
prior.S.fhPrimaryXnumbersubhourly
prior.S.fhDefrostXnumbersubhourly
prior.S.fhAuxXnumbersubhourly
prior.S.fhParasiticXnumbersubhourly
prior.S.fhTotXnumbersubhourly
prior.S.ehPrimaryXnumbersubhourly
prior.S.ehDefrostXnumbersubhourly
prior.S.ehAuxXnumbersubhourly
prior.S.ehFanXnumbersubhourly
prior.S.ehParasiticXnumbersubhourly
prior.S.ehTotXnumbersubhourly
prior.S.ecPrimaryXnumbersubhourly
prior.S.ecFanXnumbersubhourly
prior.S.ecParasiticXnumbersubhourly
prior.S.ecTotXnumbersubhourly
prior.S.evFanXnumbersubhourly
prior.S.evParasiticXnumbersubhourly
prior.S.evTotXnumbersubhourly
prior.S.qhZoneSenXnumbersubhourly
prior.S.qhZoneLatXnumbersubhourly
prior.S.qcZoneSenXnumbersubhourly
prior.S.qcZoneLatXnumbersubhourly
prior.S.qvZoneSenXnumbersubhourly
prior.S.qvZoneLatXnumbersubhourly

6.56 sgdist (owner: window)

@sgdist[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXstringconstant
sgSideXinteger numberinput timeC_sidech_interior or _exterior - side rcving gain
targTyXinteger numberrun start time (of each phase, autoSize or simulate)
targTiXinteger numberinput time
FSOXnumbermonthly-hourly
FSCXnumbermonthly-hourly

6.57 shade (owner: window)

@shade[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
wWidthXXnumberrun start time (of each phase, autoSize or simulate)Window width. *r: set (from window) by input check/setup (topckf).
wHeightXXnumberrun start time (of each phase, autoSize or simulate)Window height
ohDepthXXnumbermonthly-hourlyDepth of overhang. *mh: may change monthly-hourly: m-h user exprs accepted.
ohDistUpXXnumbermonthly-hourlyDistance from top of window to bot of oh
ohExLXXnumbermonthly-hourlyOverhang extension beyond left edge of window
ohExRXXnumbermonthly-hourlyDitto right edge
ohFlapXXnumbermonthly-hourlyLen of flap hanging down from front of overhang
lfDepthXXnumbermonthly-hourlyLeft fin depth
lfTopUpXXnumbermonthly-hourlyLeft fin top of window to top of fin
lfDistLXXnumbermonthly-hourlyLeft fin distance to left edge of window
lfBotUpXXnumbermonthly-hourlyLeft fin bottom to window bottom distance
rfDepthXXnumbermonthly-hourlyRight fin values analogous to left
rfTopUpXXnumbermonthly-hourly
rfDistRXXnumbermonthly-hourly
rfBotUpXXnumbermonthly-hourly

6.58 SHADEX

@SHADEX[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
mountingXXunrecognizedinput timeMounting
areaXXnumberinput timeArea derived from polygon, ft2
fBeamXXnumberend of each hourFraction of area receiving direct beam
vrtInp[0]XXnumberinput timeInput vertices (x, y, z), ft
vrtInp[1]XXnumberinput timeInput vertices (x, y, z), ft
vrtInp[2]XXnumberinput timeInput vertices (x, y, z), ft
vrtInp[3]XXnumberinput timeInput vertices (x, y, z), ft
vrtInp[4]XXnumberinput timeInput vertices (x, y, z), ft
vrtInp[5]XXnumberinput timeInput vertices (x, y, z), ft
vrtInp[6]XXnumberinput timeInput vertices (x, y, z), ft
vrtInp[7]XXnumberinput timeInput vertices (x, y, z), ft
vrtInp[8]XXnumberinput timeInput vertices (x, y, z), ft
vrtInp[9]XXnumberinput timeInput vertices (x, y, z), ft
vrtInp[10]XXnumberinput timeInput vertices (x, y, z), ft
vrtInp[11]XXnumberinput timeInput vertices (x, y, z), ft
vrtInp[12]XXnumberinput timeInput vertices (x, y, z), ft
vrtInp[13]XXnumberinput timeInput vertices (x, y, z), ft
vrtInp[14]XXnumberinput timeInput vertices (x, y, z), ft
vrtInp[15]XXnumberinput timeInput vertices (x, y, z), ft
vrtInp[16]XXnumberinput timeInput vertices (x, y, z), ft
vrtInp[17]XXnumberinput timeInput vertices (x, y, z), ft
vrtInp[18]XXnumberinput timeInput vertices (x, y, z), ft
vrtInp[19]XXnumberinput timeInput vertices (x, y, z), ft
vrtInp[20]XXnumberinput timeInput vertices (x, y, z), ft
vrtInp[21]XXnumberinput timeInput vertices (x, y, z), ft
vrtInp[22]XXnumberinput timeInput vertices (x, y, z), ft
vrtInp[23]XXnumberinput timeInput vertices (x, y, z), ft
vrtInp[24]XXnumberinput timeInput vertices (x, y, z), ft
vrtInp[25]XXnumberinput timeInput vertices (x, y, z), ft
vrtInp[26]XXnumberinput timeInput vertices (x, y, z), ft
vrtInp[27]XXnumberinput timeInput vertices (x, y, z), ft
vrtInp[28]XXnumberinput timeInput vertices (x, y, z), ft
vrtInp[29]XXnumberinput timeInput vertices (x, y, z), ft
vrtInp[30]XXnumberinput timeInput vertices (x, y, z), ft
vrtInp[31]XXnumberinput timeInput vertices (x, y, z), ft
vrtInp[32]XXnumberinput timeInput vertices (x, y, z), ft
vrtInp[33]XXnumberinput timeInput vertices (x, y, z), ft
vrtInp[34]XXnumberinput timeInput vertices (x, y, z), ft
vrtInp[35]XXnumberinput timeInput vertices (x, y, z), ft
vrtInp[36]XXnumberinput timeInput vertices (x, y, z), ft

6.59 surface (owner: zone)

@surface[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXstringconstant
tyXinteger numberinput time
areaXnumberrun start time (of each phase, autoSize or simulate)
azmXnumberrun start time (of each phase, autoSize or simulate)
tiltXnumberrun start time (of each phase, autoSize or simulate)
dircos[0]Xnumberrun start time (of each phase, autoSize or simulate)
dircos[1]Xnumberrun start time (of each phase, autoSize or simulate)
dircos[2]Xnumberrun start time (of each phase, autoSize or simulate)
depthBGXnumberrun start time (of each phase, autoSize or simulate)
heightXnumberrun start time (of each phase, autoSize or simulate)… and to compute area b4 mutliplier.
modelXinteger numberinput time
modelrXinteger numberrun start time (of each phase, autoSize or simulate)
lThkFXnumberrun start time (of each phase, autoSize or simulate)
gtiXinteger numberrun start time (of each phase, autoSize or simulate)
scoXnumbermonthly-hourly
sccXnumbermonthly-hourly
sbcI.absSlrXnumbermonthly-hourly
sbcI.awAbsSlrXnumbermonthly-hourly
sbcI.epsLWXnumberrun start time (of each phase, autoSize or simulate)
sbcI.ziXinteger numberrun start time (of each phase, autoSize or simulate)
sbcI.FXnumberrun start time (of each phase, autoSize or simulate)
sbcI.FpXnumberrun start time (of each phase, autoSize or simulate)
sbcI.frRadXnumberrun start time (of each phase, autoSize or simulate)
sbcI.fSkyXnumberrun start time (of each phase, autoSize or simulate)
sbcI.fAirXnumberrun start time (of each phase, autoSize or simulate)
sbcI.hcNatXnumberend of each subhour
sbcI.hcFrcXnumberend of each subhour
sbcI.hcMultXnumberend of each subhour
sbcI.hxaXnumberend of each subhour
sbcI.hxrXnumberend of each subhour
sbcI.hxtotXnumberend of each subhour
sbcI.uRatXnumberend of each subhour
sbcI.fRatXnumberend of each subhour
sbcI.cxXnumberend of each subhour
sbcI.sgTarg.bmXnumberend of each subhour
sbcI.sgTarg.dfXnumberend of each subhour
sbcI.sgTarg.totXnumberend of each subhour
sbcI.sgXnumberend of each subhour
sbcI.tSrfXnumberend of each subhour
sbcI.tSrflsXnumbersubhourly
sbcI.qrAbsXnumberend of each subhour
sbcI.txaXnumberend of each subhour
sbcI.txrXnumberend of each subhour
sbcI.txeXnumberend of each subhour
sbcI.wXnumberend of each subhour
sbcI.qSrfXnumberend of each subhour
sbcI.pXSXunrecognizedrun start time (of each phase, autoSize or simulate)
sbcI.fcWindXnumberrun start time (of each phase, autoSize or simulate)
sbcI.fcWind2Xnumberrun start time (of each phase, autoSize or simulate)
sbcI.etaXnumberend of each subhour
sbcI.widNomXnumberrun start time (of each phase, autoSize or simulate)
sbcI.lenNomXnumberrun start time (of each phase, autoSize or simulate)
sbcI.lenCharNatXnumberrun start time (of each phase, autoSize or simulate)
sbcI.lenEffWinkXnumberrun start time (of each phase, autoSize or simulate)
sbcI.cosTiltXnumberrun start time (of each phase, autoSize or simulate)
sbcI.atvDegXnumberrun start time (of each phase, autoSize or simulate)
sbcI.cosAtvXnumberrun start time (of each phase, autoSize or simulate)
sbcI.hcModelXunrecognizedrun start time (of each phase, autoSize or simulate)
sbcI.hcLCharXnumberrun start time (of each phase, autoSize or simulate)
sbcI.hcConst[0]Xnumberrun start time (of each phase, autoSize or simulate)
sbcI.hcConst[1]Xnumberrun start time (of each phase, autoSize or simulate)
sbcI.hcConst[2]Xnumberrun start time (of each phase, autoSize or simulate)
sbcI.groundModelXunrecognizedrun start time (of each phase, autoSize or simulate)
sbcI.cTaDbAvgYrXnumberrun start time (of each phase, autoSize or simulate)
sbcI.cTaDbAvg31Xnumberrun start time (of each phase, autoSize or simulate)
sbcI.cTaDbAvg14Xnumberrun start time (of each phase, autoSize or simulate)
sbcI.cTaDbAvg07Xnumberrun start time (of each phase, autoSize or simulate)
sbcI.cTGrndXnumberrun start time (of each phase, autoSize or simulate)
sbcI.rGrndXnumberrun start time (of each phase, autoSize or simulate)
sbcI.rConGrndXnumberrun start time (of each phase, autoSize or simulate)
sbcO.absSlrXnumbermonthly-hourly
sbcO.awAbsSlrXnumbermonthly-hourly
sbcO.epsLWXnumberrun start time (of each phase, autoSize or simulate)
sbcO.ziXinteger numberrun start time (of each phase, autoSize or simulate)
sbcO.FXnumberrun start time (of each phase, autoSize or simulate)
sbcO.FpXnumberrun start time (of each phase, autoSize or simulate)
sbcO.frRadXnumberrun start time (of each phase, autoSize or simulate)
sbcO.fSkyXnumberrun start time (of each phase, autoSize or simulate)
sbcO.fAirXnumberrun start time (of each phase, autoSize or simulate)
sbcO.hcNatXnumberend of each subhour
sbcO.hcFrcXnumberend of each subhour
sbcO.hcMultXnumberend of each subhour
sbcO.hxaXnumberend of each subhour
sbcO.hxrXnumberend of each subhour
sbcO.hxtotXnumberend of each subhour
sbcO.uRatXnumberend of each subhour
sbcO.fRatXnumberend of each subhour
sbcO.cxXnumberend of each subhour
sbcO.sgTarg.bmXnumberend of each subhour
sbcO.sgTarg.dfXnumberend of each subhour
sbcO.sgTarg.totXnumberend of each subhour
sbcO.sgXnumberend of each subhour
sbcO.tSrfXnumberend of each subhour
sbcO.tSrflsXnumbersubhourly
sbcO.qrAbsXnumberend of each subhour
sbcO.txaXnumberend of each subhour
sbcO.txrXnumberend of each subhour
sbcO.txeXnumberend of each subhour
sbcO.wXnumberend of each subhour
sbcO.qSrfXnumberend of each subhour
sbcO.pXSXunrecognizedrun start time (of each phase, autoSize or simulate)
sbcO.fcWindXnumberrun start time (of each phase, autoSize or simulate)
sbcO.fcWind2Xnumberrun start time (of each phase, autoSize or simulate)
sbcO.etaXnumberend of each subhour
sbcO.widNomXnumberrun start time (of each phase, autoSize or simulate)
sbcO.lenNomXnumberrun start time (of each phase, autoSize or simulate)
sbcO.lenCharNatXnumberrun start time (of each phase, autoSize or simulate)
sbcO.lenEffWinkXnumberrun start time (of each phase, autoSize or simulate)
sbcO.cosTiltXnumberrun start time (of each phase, autoSize or simulate)
sbcO.atvDegXnumberrun start time (of each phase, autoSize or simulate)
sbcO.cosAtvXnumberrun start time (of each phase, autoSize or simulate)
sbcO.hcModelXunrecognizedrun start time (of each phase, autoSize or simulate)
sbcO.hcLCharXnumberrun start time (of each phase, autoSize or simulate)
sbcO.hcConst[0]Xnumberrun start time (of each phase, autoSize or simulate)
sbcO.hcConst[1]Xnumberrun start time (of each phase, autoSize or simulate)
sbcO.hcConst[2]Xnumberrun start time (of each phase, autoSize or simulate)
sbcO.groundModelXunrecognizedrun start time (of each phase, autoSize or simulate)
sbcO.cTaDbAvgYrXnumberrun start time (of each phase, autoSize or simulate)
sbcO.cTaDbAvg31Xnumberrun start time (of each phase, autoSize or simulate)
sbcO.cTaDbAvg14Xnumberrun start time (of each phase, autoSize or simulate)
sbcO.cTaDbAvg07Xnumberrun start time (of each phase, autoSize or simulate)
sbcO.cTGrndXnumberrun start time (of each phase, autoSize or simulate)
sbcO.rGrndXnumberrun start time (of each phase, autoSize or simulate)
sbcO.rConGrndXnumberrun start time (of each phase, autoSize or simulate)
fenModelXunrecognizedinput time
SHGCXnumberinput time
fMultXnumberrun start time (of each phase, autoSize or simulate)
UNFRCXnumberinput time
NGlzXinteger numberinput time
exShdXunrecognizedinput time
inShdXunrecognizedinput time
dirtLossXnumberrun start time (of each phase, autoSize or simulate)
sfExCndXinteger numberrun start time (of each phase, autoSize or simulate)
sfExTXnumbersubhourly
sfAdjZiXinteger numberinput time
uIXnumberrun start time (of each phase, autoSize or simulate)
uCXnumberrun start time (of each phase, autoSize or simulate)
uXXnumberrun start time (of each phase, autoSize or simulate)
RfXnumberrun start time (of each phase, autoSize or simulate)
grndReflXnumbermonthly-hourly
vfSkyDfXnumbermonthly-hourly
vfGrndDfXnumbermonthly-hourly
vfSkyLWXnumberrun start time (of each phase, autoSize or simulate)
vfGrndLWXnumberrun start time (of each phase, autoSize or simulate)
uvalXnumberrun start time (of each phase, autoSize or simulate)
UNomXnumberrun start time (of each phase, autoSize or simulate)
UANomXnumberrun start time (of each phase, autoSize or simulate)
rSrfNom[0]Xnumberrun start time (of each phase, autoSize or simulate)
rSrfNom[1]Xnumberrun start time (of each phase, autoSize or simulate)
hSrfNom[0]Xnumberrun start time (of each phase, autoSize or simulate)
hSrfNom[1]Xnumberrun start time (of each phase, autoSize or simulate)
cFctrXnumberrun start time (of each phase, autoSize or simulate)
iwshadXinteger numberrun start time (of each phase, autoSize or simulate)
msiXinteger numberrun start time (of each phase, autoSize or simulate)0 or msrat msr subscr which will be used if delayed model
tLrB[0]Xnumberend of each hour
tLrB[1]Xnumberend of each hour
tLrB[2]Xnumberend of each hour
tLrB[3]Xnumberend of each hour
tLrB[4]Xnumberend of each hour
tLrB[5]Xnumberend of each hour
tLrB[6]Xnumberend of each hour
tLrB[7]Xnumberend of each hour
tLrB[8]Xnumberend of each hour
tLrB[9]Xnumberend of each hour
nsgdistXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[0].targTyXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[0].targTiXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[0].FSOXnumbermonthly-hourly
sgdist[0].FSCXnumbermonthly-hourly
sgdist[1].targTyXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[1].targTiXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[1].FSOXnumbermonthly-hourly
sgdist[1].FSCXnumbermonthly-hourly
sgdist[2].targTyXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[2].targTiXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[2].FSOXnumbermonthly-hourly
sgdist[2].FSCXnumbermonthly-hourly
sgdist[3].targTyXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[3].targTiXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[3].FSOXnumbermonthly-hourly
sgdist[3].FSCXnumbermonthly-hourly
sgdist[4].targTyXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[4].targTiXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[4].FSOXnumbermonthly-hourly
sgdist[4].FSCXnumbermonthly-hourly
sgdist[5].targTyXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[5].targTiXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[5].FSOXnumbermonthly-hourly
sgdist[5].FSCXnumbermonthly-hourly
sgdist[6].targTyXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[6].targTiXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[6].FSOXnumbermonthly-hourly
sgdist[6].FSCXnumbermonthly-hourly
sgdist[7].targTyXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[7].targTiXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[7].FSOXnumbermonthly-hourly
sgdist[7].FSCXnumbermonthly-hourly
sfAreaXnumberinput timeSurface: gross area, net in x.xs_area.
sfUXnumberinput timeUval input if no sfcon given (excl surf films)
sfConXinteger numberinput timeSurface construction (optional)
sfTyXinteger numberconstantWall/floor/ceil/[intmass1/2]: for input cking.
sfFndXinteger numberinput timeSurface foundation object (floors only, optional)
sfFndFloorXinteger numberinput timeSurface foundation floor object (walls only, optional)
sfExpPerimXnumberinput timeFoundation floor exposed perimeter (floors only)
widthXnumberinput timeWidth and height: used to compute shading,
heightXnumberinput time… and to compute area b4 mutliplier.
multXnumberinput timeArea multiplier (for multiple identical windows)
xiXinteger numberrun start time (of each phase, autoSize or simulate)Subscript in runtime xsrat, to facilitate access by probers 1-92
msiXinteger numberrun start time (of each phase, autoSize or simulate)0 or msrat msr subscr which will be used if delayed model

6.60 terminal (owner: zone)

@terminal[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
tuVfMxHCXXunrecognizedautosize and simulate phase start timeAutosize tuvfmxh and -c same or (default) different.
fxCapHXXnumberautosize and simulate phase start timeCapacity factor for autosized heat coil (default 1.1 = 10% oversized)
fxVfHCXXnumberautosize and simulate phase start timeAir flow factor for autosized air flow (default 1.1 = 10% oversized)
asHcSameXXinteger numberrun start time (of each phase, autoSize or simulate)True to autosize tuvfmxh and -c the same – specified with “tuvfmxhc = same”
asKVolXXinteger numberrun start time (of each phase, autoSize or simulate)True to autosize for constant volume – specified with “autosize tuvfmn” (implies ashcsame).
hcAs.az_activeXXinteger numberrun start time (of each phase, autoSize or simulate)
hcAs.az_aXXnumberend of each subhour
hcAs.az_bXXnumberend of each subhour
hcAs.ldPkXXnumberend of each subhour
hcAs.ldPkAsXXnumberend of each day
hcAs.ldPkAs1XXnumberend of each day
hcAs.plrPkXXnumberend of each subhour
hcAs.plrPkAsXXnumberend of each day
hcAs.xPkXXnumberend of each subhour
hcAs.xPkAsXXnumberend of each day
hcAs.az_notDoneXXinteger numberend of each day
vhAs.az_activeXXinteger numberrun start time (of each phase, autoSize or simulate)
vhAs.az_aXXnumberend of each subhour
vhAs.az_bXXnumberend of each subhour
vhAs.ldPkXXnumberend of each subhour
vhAs.ldPkAsXXnumberend of each day
vhAs.ldPkAs1XXnumberend of each day
vhAs.plrPkXXnumberend of each subhour
vhAs.plrPkAsXXnumberend of each day
vhAs.xPkXXnumberend of each subhour
vhAs.xPkAsXXnumberend of each day
vhAs.az_notDoneXXinteger numberend of each day
vcAs.az_activeXXinteger numberrun start time (of each phase, autoSize or simulate)
vcAs.az_aXXnumberend of each subhour
vcAs.az_bXXnumberend of each subhour
vcAs.ldPkXXnumberend of each subhour
vcAs.ldPkAsXXnumberend of each day
vcAs.ldPkAs1XXnumberend of each day
vcAs.plrPkXXnumberend of each subhour
vcAs.plrPkAsXXnumberend of each day
vcAs.xPkXXnumberend of each subhour
vcAs.xPkAsXXnumberend of each day
vcAs.az_notDoneXXinteger numberend of each day
qhPkXXnumberend of each subhour
qcPkXXnumberend of each subhourPeak values of qh and qc, for load reports and -pkas’s. qc negative.
qhPkAsXXnumberend of each subhour
qcPkAsXXnumberend of each subhourPeak values for all autosize converged design days, for size reports
bVfMnXXnumberend of each subhour
bVfMxHXXnumberend of each subhour
bVfMxCXXnumberend of each subhour
dtLoHShXXinteger numberend of each subhour
dtLoCShXXinteger numberend of each subhour.. this subhr, set in cnztu.cpp:ztumode, cleared in ztuabs.
aDtLoHShXXinteger numberend of each subhour
aDtLoCShXXinteger numberend of each subhour.. this subhr, set at end of cnah1.cpp:ahcompute
aDtLoTemXXinteger numberend of each subhourCnah2:antratts to ahcompute temp flag re adtlohsh, csh
dtLoHXXinteger numberend of each subhour
dtLoCXXinteger numberend of each subhour.. on this autosizing design day iteration (or poss run)
dtLoHAsXXinteger numberend of each day
dtLoCAsXXinteger numberend of each subhour.. on any converged pass 2 design day: invokes endautosizing() message.
tuTLhXXnumberhourlyLocal heating set point for tstat control. hourly. default: no tstat control.
tuQMnLhXXnumberhourlyDesired continuous output (btuh) if no setpoint, or minimum if tutlh given, hourly, default 0.
tuQMxLhXXnumberhourlyMax desired power, subject to plant limits, btuh, hourly, rqd if tutlh given, else disallowed.
tuPriLhXXinteger numberautosize and simulate phase start timePriority if setpoint equals another, low #’s used first, dfl 100, disallowed if tutlh not given.
tuLhNeedsFlowXXinteger numberautosize and simulate phase start timeYes to disable lh when tu fan off and central fan off or vav flow 0 (coil in terminal).
tuhc.coilTyXXunrecognizedrun start time (of each phase, autoSize or simulate)
tuhc.schedXXunrecognizedhourly
tuhc.captRatXXnumberend of each subhour
tuhc.captRat_AsXXnumberautosize and simulate phase start time
tuhc.captRat_AsNovXXnumberautosize and simulate phase start time
tuhc.bCaptRatXXnumberend of each subhour
tuhc.eirRatXXnumberhourly
tuhc.mtriXXinteger numberautosize and simulate phase start time
tuhc.auxXXnumberhourly
tuhc.auxMtriXXinteger numberautosize and simulate phase start time
tuhc.qXXnumberend of each subhour
tuhc.qPrXXnumberend of each subhour
tuhc.pXXnumberend of each subhour
tuhc.plrXXnumberend of each subhour
tuhc.plrAvXXnumberend of each subhour
tuhc.eirXXnumberend of each subhour
tuhc.capMaxXXnumberend of each subhour
tuhc.pAuxXXnumberend of each subhour
tuhc.effRatXXnumberautosize and simulate phase start time
tuhc.pyEi.k[0]XXnumberautosize and simulate phase start time
tuhc.pyEi.k[1]XXnumberautosize and simulate phase start time
tuhc.pyEi.k[2]XXnumberautosize and simulate phase start time
tuhc.pyEi.k[3]XXnumberautosize and simulate phase start time
tuhc.pyEi.k[4]XXnumberautosize and simulate phase start time
tuhc.stackEffectXXnumberhourly
tuhc.hpiXXinteger numberautosize and simulate phase start time
tuhc.nxTu4hpXXinteger numberrun start time (of each phase, autoSize or simulate)
tuhc.nxAh4hpXXinteger numberrun start time (of each phase, autoSize or simulate)
tuhc.flueLossXXnumberend of each subhour
tuhc.qWantXXnumberend of each subhour
tuTHXXnumberhourlyAir heating set point (f). hourly. default: no tstat-controlled air heating.
tuTCXXnumberhourlyAir cooling set point (f). hourly. default: no tstat-controlled air cooling.
tuVfMnXXnumberend of each subhourMin flow (cfm actual air); if no setpoints given, this is “specified output”. hourly, dlf 0.
tuVfMn_AsXXnumberautosize and simulate phase start time
tuVfMn_AsNovXXnumberautosize and simulate phase start time
aiXXinteger numberinput time0 or ah ss (subscript) for air handler serving tu (input as air handler name). rqd if sp or mn given.
tuVfMxHXXnumberend of each subhourHeating max flow (cfm actual air) b4 ah limits, hourly, rqd if tuth given else disallowed
tuVfMxH_AsXXnumberautosize and simulate phase start time
tuVfMxH_AsNovXXnumberautosize and simulate phase start time
tuVfMxCXXnumberend of each subhourCooling max flow (cfm actual air) b4 ah limits, hourly, rqd if tutc given else disallowed
tuVfMxC_AsXXnumberautosize and simulate phase start time
tuVfMxC_AsNovXXnumberautosize and simulate phase start time
tuVfDsXXnumberrun start time (of each phase, autoSize or simulate)Design flow (cfm actual air), constant, to apportion flow when ah fan overloads.
tuPriHXXinteger numberautosize and simulate phase start timeHeat setpoint priority: lowest # used first when equal setpoints in zone. const. default: 1.
tuPriCXXinteger numberautosize and simulate phase start timeCool likewise. … rqd if corress sp given, else disallowed.
tuSRLeakXXnumberautosize and simulate phase start timeLeakage 0-.5 of supply air to return, increasing supply vol and return temp. constant; dfl .05.
tuSRLossXXnumberrun start time (of each phase, autoSize or simulate)Supply air to return plenum heat loss as a fraction 0 - .5 of supply air to return air
tfanSchXXunrecognizedrun start time (of each phase, autoSize or simulate)Terminal fan schedule, choice of off, on, heating, or vav, hourly, rqd if tfantype not none.
tfanOffLeakXXnumberrun start time (of each phase, autoSize or simulate)Backdraft leakage when fan off, 0 to .25 of tfanvfds, constant, dfl .1, or 0 if no fan.
tfan.fanTyXXunrecognizedautosize and simulate phase start time
tfan.vfDsXXnumberend of each subhour
tfan.vfDs_AsXXnumberautosize and simulate phase start time
tfan.vfDs_AsNovXXnumberautosize and simulate phase start time
tfan.vfMxFXXnumberautosize and simulate phase start time
tfan.pressXXnumberrun start time (of each phase, autoSize or simulate)
tfan.effXXnumberrun start time (of each phase, autoSize or simulate)
tfan.shaftPwrXXnumberrun start time (of each phase, autoSize or simulate)
tfan.elecPwrXXnumberrun start time (of each phase, autoSize or simulate)
tfan.motTyXXunrecognizedrun start time (of each phase, autoSize or simulate)
tfan.motEffXXnumberautosize and simulate phase start time
tfan.motPosXXunrecognizedautosize and simulate phase start time
tfan.curvePy.k[0]XXnumberautosize and simulate phase start time
tfan.curvePy.k[1]XXnumberautosize and simulate phase start time
tfan.curvePy.k[2]XXnumberautosize and simulate phase start time
tfan.curvePy.k[3]XXnumberautosize and simulate phase start time
tfan.curvePy.k[4]XXnumberautosize and simulate phase start time
tfan.curvePy.k[5]XXnumberautosize and simulate phase start time
tfan.mtriXXinteger numberinput time
tfan.endUseXXinteger numberautosize and simulate phase start time
tfan.auszXXinteger numberrun start time (of each phase, autoSize or simulate)
tfan.outPowerXXnumbersubhourly
tfan.airPowerXXnumbersubhourly
tfan.cMxXXnumberend of each subhour
tfan.cXXnumberend of each subhour
tfan.tXXnumberend of each subhour
tfan.frOnXXnumberend of each subhour
tfan.pXXnumberend of each subhour
tfan.qXXnumberend of each subhour
tfan.dTXXnumberend of each subhour
tfan.qAroundXXnumberend of each subhour
nxTu4zXXinteger numberrun start time (of each phase, autoSize or simulate)Chain: 0 or ss (subscript) of next tu in zone chain. head is znr.tu1.
nxTu4aXXinteger numberrun start time (of each phase, autoSize or simulate)Chain: 0 or ss (subscript) of next tu in air handler chain. head is ah.tu1.
xiLhXXinteger numberrun start time (of each phase, autoSize or simulate)Subscript of zhx for terminal’s local heat capability
xiArHXXinteger numberrun start time (of each phase, autoSize or simulate)Ss of zhx for cmso air heat/cool or cmsth air heat capability
xiArCXXinteger numberrun start time (of each phase, autoSize or simulate)Ss of zhx for tu’s cmstc air cool, if any
cmLhXXunrecognizedrun start time (of each phase, autoSize or simulate)Local heat: cmnone=0; cmstxx: tstat-controlled (setpoint given); or cmso (only output/flow given).
cmArXXunrecognizedrun start time (of each phase, autoSize or simulate)Air heat and cool: cmnone=0,cmso=1,cmsth=2,cmstc=4,cmstboth=6.
ctrlsAiXXinteger numberrun start time (of each phase, autoSize or simulate)Ss of ah ctrl’d by this tu under zn/zn2 control method, this hour (setup time).
wantMdXXunrecognizedend of each subhourTerminal request to ctrl’d ah: heating, cooling, off. set in tu::estimate, ztucompute, ah::wzczxxxx.
lhMnXXnumberend of each subhour
lhMxXXnumberend of each subhour
lhMxMxXXnumberend of each subhour
cMnXXnumberend of each subhour
cMxHXXnumberend of each subhour
cMxCXXnumberend of each subhour
useLhXXunrecognizedend of each subhourLocal heat use this subhour: unone(0)/uso/umn/usth/umxh.
useArXXunrecognizedend of each subhourAir cool/heat use this subhour, same plus ustc/umxc.
qLhWantXXnumberend of each subhour
cvXXnumberend of each subhour
czXXnumberend of each subhour
aCvXXnumberend of each subhour
tfanRunningXXinteger numberend of each subhourTrue if terminal fan running this subhour (no backflow).
tfanBkCXXnumberend of each subhour

6.61 top

@top.

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
bAutoSizeCmdXXinteger numberinput timeNon-0 if any autosize commands seen in input, set via arg to cul() from cse.cpp. 6-95.
chAutoSizeXXinteger numberrun start time (of each phase, autoSize or simulate)Whether to do autosizing, default per bautosizecmd
chSimulateXXinteger numberinput timeWhether to do main simulation, default true, can input false for autosizing only. 6-95.
begDayXXinteger numberinput time1st 1-based julian day of year of run
endDayXXinteger numberinput timeLast ditto, inclusive
nDaysXXinteger numberrun start time (of each phase, autoSize or simulate)Derived: # days in run
jan1DoWXXinteger numberinput timeJanuary 1 day of week, sun=1 subtract 1 for most internal uses
yearXXinteger numberrun start time (of each phase, autoSize or simulate)Derived: tdpak generic non-leap year, -1 = jan 1 is monday … -7 = jan 1 is sunday.
wuDaysXXinteger numberinput timeNumber of warmup days
nSubStepsXXinteger numberinput time# subhours per hour, determines subhour duration.
wfNameXXstringautosize and simulate phase start timeWeather file path string
TDVfNameXXstringautosize and simulate phase start timeTdv (time dependent value) file path string
elevationXXnumberrun start time (of each phase, autoSize or simulate)Site elevation (for determining air density) (ft). defaults from weather file 1-95.
refTempXXnumberautosize and simulate phase start timeTemp for computing the hum ratio (w) used in air-density calculations, default 70 f
refRHXXnumberautosize and simulate phase start timeRelative humidity (as fraction) ditto, default .6 (60%).
grndReflXXnumbermonthly-hourlyGround surface reflectivity, re solar gain.
grndEmitXXnumberinput timeGround surface emittance, re long wave exchange in kiva. dflt .8.
grndRfXXnumberinput timeGround surface roughnes, ft, re exterior convection in kiva. dflt 0.1.
soilDiffXXnumberinput timeLocal soil diffusivity, ft2/hr, re annual deep ground temp cycle estimation
soilCondXXnumberinput timeLocal soil conductivity, btuh-ft/ft2-f, re kiva calcs. dflt=1.0.
soilSpHtXXnumberinput timeLocal soil specific heat, btu/lb-f, re kiva calcs. dflt=0.1.
soilDensXXnumberinput timeLocal soil density, lb/ft3, re kiva calcs. dflt=115.
farFieldWidthXXnumberinput timeFar-field boundary distance, ft, re kiva calcs. dflt=130.
deepGrndCndXXunrecognizedinput timeDeep ground boundary type
deepGrndDepthXXnumberinput timeDeep-ground boundary distance, ft, re kiva calcs. dflt=130.
deepGrndTXXnumberinput timeDeep-ground boundary temperature, f, re kiva calcs. dflt=annual average db.
tolXXnumberinput time(relative) tolerance used in many hvac calculations, default .001f or as changed
humTolFXXnumberinput timeW change to consider as important as 1f temp re convergedness
ebTolMonXXnumberinput timeMonthly tolerance
ebTolDayXXnumberinput timeDaily ..
ebTolHourXXnumberinput timeHourly ..
ebTolSubhrXXnumberinput timeSubhourly ..
unMetTzTolXXnumberinput timeUnmet zone air temp tolerance, f (default = 1 f)
unMetTzTolWarnHrsXXnumberinput time
grndMinDimXXnumberinput timeMinimum cell dimension in kiva, ft, default .066f
grndMaxGrthCoeffXXnumberinput timeMaximum cell growth in kiva, default 1.5f
grndTimeStepXXunrecognizedinput timeKiva time step
AWTrigTXXnumberinput timeInside or outside environmental temperature, f (default = 1)
AWTrigSlrXXnumberinput timeIncident solar, fraction (default = .05)
AWTrigHXXnumberinput timeTotal surface coefficient (conv+rad), fraction (default=.1)
ANTolAbsXXnumberinput timeAbsolute tolerance, lbm/sec, dflt=.00125 (about 1 cfm)
ANTolRelXXnumberinput timeRelative tolerance, dflt = .0001
ANPressWarnXXnumberinput timeAirnet pressure that triggers a warning, lb/ft2
ANPressErrXXnumberinput timeAirnet pressure that triggers a run-ending error, lb/ft2
bldgAzmXXnumberinput timeAngle to add to all zone/surface azms
skyModelXXinteger numberinput timeSky model: c_.._iso or _aniso
skyModelLWXXunrecognizedinput timeLong-wave sky model
exShadeModelXXunrecognizedinput timeExterior shading model (other than overhang/fins)
slrInterpMethXXunrecognizedinput timeSolar interpolation method
humMethXXunrecognizedinput timeHumidity calculation method: rob (w = wa/wb) or phil (central difference), 6-92
dflExHXXnumberinput timeDefault ext (air film) cond for os & gz. 2-91
workDayMaskXXinteger numberinput timeMask with bits set for “work” days, clear for “non-work” days, default mon..fri, 5-95.
DTXXinteger numberinput timeYes (default) to enable daylight saving time
DTBegDayXXinteger numberrun start time (of each phase, autoSize or simulate)Daylight saving start day, 1-365, default 1st sun (sun after 1st sat?) in april
DTEndDayXXinteger numberrun start time (of each phase, autoSize or simulate)Daylight saving end day, 1-365, defaulted by cncult2.cpp code to last sun in october
windSpeedMinXXnumberinput timeMinimum, mph (default=.5)
windFXXnumberinput timeFactor (default=1)
terrainClassXXinteger numberinput timeTerrain class (1-5) re wind speed adjustment
radBeamFXXnumberinput timeBeam radiation fctr. appl sees aniso( ) * radbeamf. cgwthr.cpp.
radDiffFXXnumberinput timeDiffuse radiation fctr. appl sees aniso( ) * raddifff.
ventAvailXXunrecognizedhourlyAll-zone ventilation availability (default=c_ventavailch_wholehouse)
fVentXXnumberend of each subhourConsensus whole building vent fraction (if not rsysoav)
hConvModXXinteger numberrun start time (of each phase, autoSize or simulate)Enable/disable convection convective coefficient pressure modification factor (tp_hconvf below)
verboseXXinteger numberautosize and simulate phase start timeScreen messages: autosizing: 0 none, 1 some (dflt?), 2-5 more
doCoverageXXinteger numberinput timeTrack expression processing code coverage / report to log
auszTolXXnumberinput timeAutosizing result tolerance, dfl .005
heatDsTDbOXXnumberhourlyHeat design outdoor temp, dfl per et1 wthr file hdr.
heatDsTWbOXXnumberhourlyHeating design outdoor wetbulb temp, dfl for 70% rh @ heatdstdbo.
coolDsMo[0]XXinteger numberinput timeSi[13] cooling design month(s) 1-12 + 0 terminator. default per et1 wthr file hdr.
coolDsMo[1]XXinteger numberinput timeSi[13] cooling design month(s) 1-12 + 0 terminator. default per et1 wthr file hdr.
coolDsMo[2]XXinteger numberinput timeSi[13] cooling design month(s) 1-12 + 0 terminator. default per et1 wthr file hdr.
coolDsMo[3]XXinteger numberinput timeSi[13] cooling design month(s) 1-12 + 0 terminator. default per et1 wthr file hdr.
coolDsMo[4]XXinteger numberinput timeSi[13] cooling design month(s) 1-12 + 0 terminator. default per et1 wthr file hdr.
coolDsMo[5]XXinteger numberinput timeSi[13] cooling design month(s) 1-12 + 0 terminator. default per et1 wthr file hdr.
coolDsMo[6]XXinteger numberinput timeSi[13] cooling design month(s) 1-12 + 0 terminator. default per et1 wthr file hdr.
coolDsMo[7]XXinteger numberinput timeSi[13] cooling design month(s) 1-12 + 0 terminator. default per et1 wthr file hdr.
coolDsMo[8]XXinteger numberinput timeSi[13] cooling design month(s) 1-12 + 0 terminator. default per et1 wthr file hdr.
coolDsMo[9]XXinteger numberinput timeSi[13] cooling design month(s) 1-12 + 0 terminator. default per et1 wthr file hdr.
coolDsMo[10]XXinteger numberinput timeSi[13] cooling design month(s) 1-12 + 0 terminator. default per et1 wthr file hdr.
coolDsMo[11]XXinteger numberinput timeSi[13] cooling design month(s) 1-12 + 0 terminator. default per et1 wthr file hdr.
coolDsMo[12]XXinteger numberinput timeSi[13] cooling design month(s) 1-12 + 0 terminator. default per et1 wthr file hdr.
coolDsDay[0]XXinteger numberinput timeDoy[13] design day(s) read from weather file + 0 terminator
coolDsDay[1]XXinteger numberinput timeDoy[13] design day(s) read from weather file + 0 terminator
coolDsDay[2]XXinteger numberinput timeDoy[13] design day(s) read from weather file + 0 terminator
coolDsDay[3]XXinteger numberinput timeDoy[13] design day(s) read from weather file + 0 terminator
coolDsDay[4]XXinteger numberinput timeDoy[13] design day(s) read from weather file + 0 terminator
coolDsDay[5]XXinteger numberinput timeDoy[13] design day(s) read from weather file + 0 terminator
coolDsDay[6]XXinteger numberinput timeDoy[13] design day(s) read from weather file + 0 terminator
coolDsDay[7]XXinteger numberinput timeDoy[13] design day(s) read from weather file + 0 terminator
coolDsDay[8]XXinteger numberinput timeDoy[13] design day(s) read from weather file + 0 terminator
coolDsDay[9]XXinteger numberinput timeDoy[13] design day(s) read from weather file + 0 terminator
coolDsDay[10]XXinteger numberinput timeDoy[13] design day(s) read from weather file + 0 terminator
coolDsDay[11]XXinteger numberinput timeDoy[13] design day(s) read from weather file + 0 terminator
coolDsDay[12]XXinteger numberinput timeDoy[13] design day(s) read from weather file + 0 terminator
coolDsCond[0]XXinteger numberinput timeTi[ 13] descond idx(s) + 0 terminator
coolDsCond[1]XXinteger numberinput timeTi[ 13] descond idx(s) + 0 terminator
coolDsCond[2]XXinteger numberinput timeTi[ 13] descond idx(s) + 0 terminator
coolDsCond[3]XXinteger numberinput timeTi[ 13] descond idx(s) + 0 terminator
coolDsCond[4]XXinteger numberinput timeTi[ 13] descond idx(s) + 0 terminator
coolDsCond[5]XXinteger numberinput timeTi[ 13] descond idx(s) + 0 terminator
coolDsCond[6]XXinteger numberinput timeTi[ 13] descond idx(s) + 0 terminator
coolDsCond[7]XXinteger numberinput timeTi[ 13] descond idx(s) + 0 terminator
coolDsCond[8]XXinteger numberinput timeTi[ 13] descond idx(s) + 0 terminator
coolDsCond[9]XXinteger numberinput timeTi[ 13] descond idx(s) + 0 terminator
coolDsCond[10]XXinteger numberinput timeTi[ 13] descond idx(s) + 0 terminator
coolDsCond[11]XXinteger numberinput timeTi[ 13] descond idx(s) + 0 terminator
coolDsCond[12]XXinteger numberinput timeTi[ 13] descond idx(s) + 0 terminator
exePathXXstringrun start time (of each phase, autoSize or simulate)Full path to current .exe
exeInfoXXstringrun start time (of each phase, autoSize or simulate)Info about current .exe (from header)
progVersionXXstringrun start time (of each phase, autoSize or simulate)Program version identifier as string (for probing); set from ::progversion
HPWHVersionXXstringrun start time (of each phase, autoSize or simulate)Ecotope hpwh (heat pump water heater) model version
cmdLineArgsXXstringrun start time (of each phase, autoSize or simulate)Command line args for current input file
runSerialXXinteger numberinput timeRun #, 000-999, per (future 11-91) status file (meanwhile, see cnguts:cnrunserial 7-92).
runTitleXXstringinput timeUser text for report titles, footers, export title 11-22-91.
runDateTimeXXstringrun start time (of each phase, autoSize or simulate)Run date & time string, set by cncult2.cpp:topstarprf2(), used in reports & bin res file, 9-94.
brsXXinteger numberrun start time (of each phase, autoSize or simulate)Yes to generate basic binary results file, default no. from input file or cmd line switch.
brHrlyXXinteger numberrun start time (of each phase, autoSize or simulate)Yes to generate hourly binary results file, default no. from input file or cmd line.
brFileNameXXstringinput timeFile name for binary results, extension .brs and/or .bhr added. default: input file name.
brMemXXinteger numberrun start time (of each phase, autoSize or simulate)Put binary results in windows global memory and return handles; do not write file.
brDiscardableXXinteger numberrun start time (of each phase, autoSize or simulate)Put binary results in discardable memory as well as file, return handles. overrides brfmem.
repHdrLXXstringinput timeUser-spec’d text for left end of report header line
repHdrRXXstringinput time.. right
repCplXXinteger numberinput timeReport characters per line
repLppXXinteger numberinput timeTotal number of lines per page (paper size)
repTopMXXinteger numberinput timeTop margin in lines; # newlines written above header
repBotMXXinteger numberinput timeBottom margin in lines; not actually output
repTestPfxXXstringinput timePrefix pre-pended to e.g. footer lines re hiding lines re automated testing
latitudeXXnumberrun start time (of each phase, autoSize or simulate)Degrees north
longitudeXXnumberrun start time (of each phase, autoSize or simulate)Degress west
timeZoneXXnumberrun start time (of each phase, autoSize or simulate)Hours west (fraction ok)
presAtmXXnumberrun start time (of each phase, autoSize or simulate)Nominal atmospheric pressure at top.elevation (in hg)
refWXXnumberrun start time (of each phase, autoSize or simulate)Humidity ratio for reftemp, refrh (ratio)
refWXXXnumberrun start time (of each phase, autoSize or simulate)1/(1.+rp_refw)
airSHXXnumberrun start time (of each phase, autoSize or simulate)Air specific heat (btu/lbdryair-f) @ tp_refw
airVKXXnumberrun start time (of each phase, autoSize or simulate)Specific volume per temp(ft3/lb-f): multiply by abs temp.
airRhoKXXnumberrun start time (of each phase, autoSize or simulate)Density*temp (lb-f/ft3): divide by abs temp to get density.
airVshKXXnumberrun start time (of each phase, autoSize or simulate)Volumetric specific heat/temp (btu/ft3-f): div by abs temp for heat capacity per ft3
airXKXXnumberrun start time (of each phase, autoSize or simulate)Divide by abs temp for specific heat of flow (btuh/cfm-f)
hConvFXXnumberrun start time (of each phase, autoSize or simulate)Convective coefficient pressure modification factor
auszSmTolXXnumberrun start time (of each phase, autoSize or simulate)Autosizing small tolerance, eg ausztol/10 (.001)
auszTol2XXnumberrun start time (of each phase, autoSize or simulate)Half of given tolerance – added to values; used in convergence tests.
auszHiTol2XXnumberrun start time (of each phase, autoSize or simulate)1 + half of tolerance, eg 1 + ausztol/2.
dvriYXXinteger numberdaily0 or dvrib subscript of 1st rpfreq=year report or export
dvriMXXinteger numberdaily.. month report/export currently active
dvriDXXinteger numberdaily.. day report/export to write to today
dvriHXXinteger numberdaily.. hourly ..
dvriSXXinteger numberdaily.. subhourly ..
dvriHSXXinteger numberdaily.. hourly and subhourly. a vr can only be in one list, so this list is
hrxFlgXXinteger numberdailyNz if any hour reporting or exporting today: dvrih | -hs
shrxFlgXXinteger numberdailyNz if any subhour reporting or exporting today: dvris | -hs
tmrInputXXnumberend of each dayInput processing time, sec
tmrAuszXXnumberend of each dayAutosizing time, sec
tmrRunXXnumberend of each dayMain simulation time, sec
tmrTotalXXnumberend of each dayTotal execution time (not including reports), sec
tmrAirNetXXnumberend of each dayAdd’l timers active iff detailed_timing
tmrAirNetSolveXXnumberend of each day
tmrAWTotXXnumberend of each day
tmrAWCalcXXnumberend of each day
tmrCondXXnumberend of each day
tmrKivaXXnumberend of each day
tmrBCXXnumberend of each day
tmrZoneXXnumberend of each day
subhrDurXXnumberrun start time (of each phase, autoSize or simulate)Duration of subhour, hr (= 1/tp_nsubsteps)
nSubhrTicksXXinteger numberrun start time (of each phase, autoSize or simulate)# of subhour ticks for e.g. hpwh simulation
tickDurMinXXnumberrun start time (of each phase, autoSize or simulate)Duration of subhr tick, min
tickDurHrXXnumberrun start time (of each phase, autoSize or simulate)Duration of subhr tick, hr
monStrXXstringmonthlyMonth being simulated
dateStrXXstringdailyDate being simulated as string
dateXXun-probe-abledailyDate: .month is 1-12, .mday 1-31, .wday 0-6. set/used: cnguts. used:cuparse;cgsolar;cgresult;cgenbal.
jDayXXinteger numberdailyDay of year now simulating, 1..365. set: tp_mainsimi; used:cnguts;cuparse;cgwthr;cgsolar;cgresult.
xJDayXXinteger numberdailyExtended jday: same for main sim, 512 heat autosizing, 529-540 cooling autosizing.
iHrXXinteger numberhourlyHour of day, 0-23. set/used: tp_mainsim()
iSubhrXXinteger numbersubhourlySubhour of hour being simulated, 0.. . set cnguts.cpp
shoyXXunrecognizedsubhourlyExtended subhour of year, for reporting peaks: subhr + 4 * (hr + 24*xjday). set/used: cnguts.
isDTXXinteger numberhourly1 if daylight saving time in effect, 0 if not. unspecified time/date variables are daylight.
iHrSTXXinteger numberhourlyStandard time hour of day now simulating, 0-23. set/used cnguts, used cgsolar.cpp.
jDaySTXXinteger numberhourlyStandard time day of year, 1..365. changes @ 1am –>*h. set/used cnguts, used cgsolar.cpp.
autoSizingXXinteger numberautosize and simulate phase start timeTrue if setting up for or doing autosizing, 0 for main simulation setup/run
pass1XXinteger numberdailyTrue autosizing pass 1 (a or b) thru dsn days: find big-enuf sizes with open-ended models
pass1AXXinteger numberdailyTrue for pass 1a of each dsn day: use idealized const-supply-temp models
pass1BXXinteger numberdailyTrue for pass 1b of each dsn day: use real models
pass2XXinteger numberdailyTrue autosizing for pass 2 thru dsn days: determine loads, reduce oversize sizes.
sizingXXinteger numberdailyTrue when can increase sizes. eg false during pass 2: warming up.
dsDayXXinteger numberdaily0 main sim, 1 heating autosize design day, 2 cooling ausz
auszMonXXinteger numberdailyCool design day month 1-12 or generic month 0 for heat. 6-95.
ivlXXinteger numbersubhourlyInterval now starting or ending (c_ivlch_y, _m, etc),
isBegOfXXinteger numbersubhourly0 or interval now starting (for exprssion eval) (c_ivlch_y, _m, etc; 0 except during expr eval) …
isEndOfXXinteger numbersubhourlyDitto ending. … set in cnguts.cpp, tested in cueval.cpp.
isBegRunXXinteger numbersubhourly1st subhr of warmup, not set for run unless no warmup.
isBegMainSimXXinteger numbersubhourly1st subhr of main sim (not warmup, not autosize)
isFirstMonXXinteger numbermonthlyTrue if 1st month of main sim. set: dobeg/endivl. used: doivlaccum.
isLastDayXXinteger numberdailyLast day of main sim
isLastWarmupDayXXinteger numberdailyTrue iff last day of main sim warmup. set: cgmainsimi. used: cgwthr.cpp. 1-95.
isBegHourXXinteger numbersubhourlyTrue if subhour 0 of hour. set cnztu.cpp/cnguts.cpp, used cnguts.cpp, .
isEndHourXXinteger numbersubhourlyTrue if last subhour of hour. set cnguts.cpp, used cnguts, cgresult.cpp.
isBegDayXXinteger numberhourlyTrue if hour 0. set: dobegivl. used: dobegivl,doivlaccum; cgresult.cpp
isEndDayXXinteger numberhourlyTrue if hour 23. set: dobegivl. used: doendivl,doivlaccum; cgresult.cpp
isBegMonthXXinteger numberdaily1st day of month/run/warmup or 1st rep of dsn day.
isEndMonthXXinteger numberdailyMon/run, not warmup, last day.
isSolarCalcDayXXinteger numberdailyTrue if 1st day of month/run or 1st rep of dsn day: do 24 hours of solar calcs today. cnguts.
isWarmupXXinteger numberdailyTrue if main sim warmup. set/used: cgmainsimi. used: dobegivl,doendivl,doivlaccum,doivlreports; exman,impf.
dowhXXinteger numberdailyAutosizing: 8 heat 9 cool, else 7 if observed holiday, else day of week 0-6, for $dowh.
isHolidayXXinteger numberdailyTrue on observed holiday: monday after certain true holidays on weekend. same as old isholiobs, 7-92.
isHoliTrueXXinteger numberdailyTrue (non-0) on true date of holiday
isWeHolXXinteger numberdailyWeekend or holiday
isWeekendXXinteger numberdailySaturday or sunday
isBegWeekXXinteger numberdailyNon-wehol after wehol
isWeekdayXXinteger numberdailyMon-fri
isWorkDayXXinteger numberdailyWorkday per top.workdaymask (default mon-fri), 5-95
isNonWorkDayXXinteger numberdailyNon-workday ditto 5-95
isBegWorkWeekXXinteger numberdailyWorkday after non-workday ditto 5-95
auszNotDoneXXinteger numberdailyCombined results of autosize pass endtests
radBeamHrAvXXnumberhourlyBeam irradiance on tracking surface, hour energy = average power, from weather file
radDiffHrAvXXnumberhourlyDiffuse irradiance on horizontal surface, hour energy = average power, from weather file
radBeamShAvXXnumbersubhourly.. current beam subhour average power, interpolated, btuh/ft2
radDiffShAvXXnumbersubhourly.. current diffuse subhour power, interpolated by cgwthr.cpp, btuh/ft2
tDbOHrXXnumberhourlyOutdoor dry bulb temp at end of hour, from wthr file, deg f.
tDbOPvHrXXnumberhourly.. previous hour (used to compute -hrav and -sh)
tDbOHrAvXXnumberhourly.. average over hour (used re hourly masses, bin res files, $variable)
tDbOShXXnumbersubhourly.. end subhour, interpolated (used re zone temp heat balance)
tDbOPvShXXnumbersubhourly.. end previous subhr (used to compute -shav)
tDbOShAvXXnumbersubhourly.. average over subhour (used re subhourly masses)
tWbOHrXXnumberhourlyOutdoor wet bulb temp at end of hour, from wthr file wb depression, deg f.
tWbOPvHrXXnumberhourly.. previous hour (used to compute -hrav, -sh)
tWbOHrAvXXnumberhourly.. hour average (for $ variable)
tWbOShXXnumbersubhourly.. end subhour, interpolated (used re zone temp heat balance)
tDpOHrXXnumberhourlyOutdoor dew point temp at end of hour, from wthr file
tDpOPvHrXXnumberhourly.. previous hour (used to compute -hrav)
tDpOHrAvXXnumberhourly.. hour average
tDpOShXXnumbersubhourly.. end subhour (derived from tdbosh and wosh)
tSkyHrXXnumberhourlySky temperature, f
tSkyPvHrXXnumberhourly.. previous hour (used to compute -sh)
tSkyShXXnumbersubhourly.. end subhr, interpolated)
windSpeedHrXXnumberhourlyWind speed, mph, at end hour
windSpeedPvHrXXnumberhourly.. previous hour (used to compute -hrav, -sh)
windSpeedHrAvXXnumberhourly.. hour average (for $ variable)
windSpeedShXXnumbersubhourly.. end subhour, mph, interpolated: for $variable and ..
windSpeedSquaredShXXnumbersubhourly.. end subhour squared (re zone infiltration), mph^2
windSpeedSqrtShXXnumbersubhourly.. end subhour sqrt (re outside surface convection), mph^.5
windSpeedPt8ShXXnumbersubhourly.. end subhour ^.8 (re outside surface convection), mph^.8
windDirDegHrXXnumberhourlyWind direction at end hour from wthr file, degrees, 0=n, 90=e. (used for $variable)
wOHrXXnumberhourlyOutdoor humidity ratio at end current hour, computed from tdbo and twbo (used for $ variable)
wOPvHrXXnumberhourly.. previous hour (used to compute -hrav)
wOHrAvXXnumberhourly.. hour average (for $ variable)
wOShXXnumbersubhourly.. at end current subhour: used throughout zones and systems models in program
wOShChangeBaseXXnumbersubhourlyOutdoor humidity ratio saved for tp_woshchange detection
hOShXXnumbersubhourlyOutdoor enthalpy at end subhour. used at in ah::doeco, towerplant::towmodel. 9-92.
airxOShXXnumbersubhourlyAir flow heat transfer @tdbosh (vhc*60) (btuh/cfm-f).
rhoMoistOShXXnumbersubhourlyOutdoor moist air density at end of subhour, lbm/ft3
rhoDryOShXXnumbersubhourlyOutdoor dry air density at end of subhour, lbm/ft3
wOShChangeXXinteger numbersubhourlyTrue iff non-negligible change in outdoor humidity ratio
iterXXinteger numbersubhourlyHvac terminal / air handler / plant iteration counter for cnztu.cpp:hvacitersubhr.
qcPeakXXnumberhourlyMaximum cooling load for an hour for entire building. negative (if not 0).
qcPeakHXXinteger numberhourlyHour 1-24 of peak cooling load
qcPeakDXXinteger numberhourlyDay of month 1-31 of peak load
qcPeakMXXinteger numberhourlyMonth 1-12 of peak load
qhPeakXXnumberhourlyMaximum heating load for entire building during an hour
qhPeakHXXinteger numberhourlyHour 1-24 of peak heating load
qhPeakDXXinteger numberhourlyDay of month 1-31 of peak load
qhPeakMXXinteger numberhourlyMonth 1-12 of peak load
airNetActiveXXinteger numberautosize and simulate phase start timeTrue iff airnet is active (calcs s/b done)
ck5aa5XXinteger numberrun start time (of each phase, autoSize or simulate)Stuffed with 0x5aa5 from topcult for verifying initialization & matching versions

6.62 towerPlant

@towerPlant[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
ctNXXinteger numberautosize and simulate phase start timeNumber of towers. niles’ ctno. default 1.
tpStgXXunrecognizedautosize and simulate phase start timeStaging choice, default together. niles’ stgop.
tpTsSpXXnumberhourlyTowers delivered water setpoint temperature (niles’ twosp). degrees f, hourly, default 85f.
tpMtrXXinteger numberinput timeSubscript of meter object to which tower fan energy input will be posted,
ctTyXXunrecognizedautosize and simulate phase start timeCooling tower fan control type choice: onespeed (default), twospeed, or variable.
ctLoSpdXXnumberautosize and simulate phase start timeLow speed for a twospeed fan, as a fraction of full cfm. default 0.5.
ctShaftPwrXXnumberautosize and simulate phase start timeShaft power of one tower fan motor. rqd. user name ‘shaftbhp’.
ctMotEffXXnumberautosize and simulate phase start timeMotor (and drive, if any) efficiency, default 0.88
ctFcOne.k[0]XXnumberrun start time (of each phase, autoSize or simulate)
ctFcOne.k[1]XXnumberrun start time (of each phase, autoSize or simulate)
ctFcOne.k[2]XXnumberrun start time (of each phase, autoSize or simulate)
ctFcLo.k[0]XXnumberrun start time (of each phase, autoSize or simulate)
ctFcLo.k[1]XXnumberrun start time (of each phase, autoSize or simulate)
ctFcLo.k[2]XXnumberrun start time (of each phase, autoSize or simulate)
ctFcHi.k[0]XXnumberrun start time (of each phase, autoSize or simulate)
ctFcHi.k[1]XXnumberrun start time (of each phase, autoSize or simulate)
ctFcHi.k[2]XXnumberrun start time (of each phase, autoSize or simulate)
ctFcVar.k[0]XXnumberrun start time (of each phase, autoSize or simulate)
ctFcVar.k[1]XXnumberrun start time (of each phase, autoSize or simulate)
ctFcVar.k[2]XXnumberrun start time (of each phase, autoSize or simulate)
ctFcVar.k[3]XXnumberrun start time (of each phase, autoSize or simulate)
ctFcVar.k[4]XXnumberrun start time (of each phase, autoSize or simulate)
ctCapDsXXnumberrun start time (of each phase, autoSize or simulate)Design capacity, btuh. (replaces niles’ design water inlet temperature.)
ctVfDsXXnumberautosize and simulate phase start timeDesign air flow volume rate through tower / full speed fan flow??, cfm, rqd.
ctGpmDsXXnumberrun start time (of each phase, autoSize or simulate)Design water flow rate, gpm. default: sum of connected heat rejection pump capacities / ctn.
ctTDbODsXXnumberautosize and simulate phase start timeDesign outdoor drybulb temperature, f, rqd. (only needed to convert ctvfds from cfm to lb/hr).
ctTWbODsXXnumberautosize and simulate phase start timeDesign outdoor wetbulb temperature, f, rqd.
ctTwoDsXXnumberautosize and simulate phase start timeDesign leaving water temperature, f, default 85.
ctCapOdXXnumberrun start time (of each phase, autoSize or simulate)Off-design capacity, btuh. (replaces niles’ design water inlet temperature.)
ctVfOdXXnumberautosize and simulate phase start timeOff-design air flow volume rate through one tower, cfm, must != ctvfds.
ctGpmOdXXnumberrun start time (of each phase, autoSize or simulate)Off-design water flow rate, gpm. default: sum of connected heat rejection pump capacities/ ctn.
ctTDbOOdXXnumberautosize and simulate phase start timeOff-design outdoor drybulb temperature, f. (only needed to convert ctvfod from cfm to lb/hr).
ctTWbOOdXXnumberautosize and simulate phase start timeOff-design outdoor wetbulb temperature, f.
ctTwoOdXXnumberautosize and simulate phase start timeOff-design leaving water temperature, f, default 85.
ctKXXnumberrun start time (of each phase, autoSize or simulate)Exponent in formula ntua = const * (mw/ma)^ctk, as alternative to “off design” inputs.
ctStkFlFrXXnumberautosize and simulate phase start timeStack effect flow: air flow that occurs thru tower when fan is off, as a fraction of ctvfds.
ctBldnXXnumberautosize and simulate phase start timeBlowdown rate: frac inflowing water bled down drain, to reduce impurities buildup. default .01.
ctDrftXXnumberautosize and simulate phase start timeDrift rate: frac inflowing water blown out of tower as droplets, w/o evaporating. default 0.
ctTWmXXnumberautosize and simulate phase start timeTemperature of water in mains, for makeup water. default 60.
cp1XXinteger numberrun start time (of each phase, autoSize or simulate)Subscript of 1st coolplant served by this towerplant. next is coolplant.nxcp4tp.
hl1XXinteger numberrun start time (of each phase, autoSize or simulate)Subscript of 1st hploop with hx served by this towerplant. next is hploop.nxhl4tp.
oneFanPXXnumberrun start time (of each phase, autoSize or simulate)
maDsXXnumberrun start time (of each phase, autoSize or simulate)
maOdXXnumberrun start time (of each phase, autoSize or simulate)
mwDsXXnumberrun start time (of each phase, autoSize or simulate)
mwOdXXnumberrun start time (of each phase, autoSize or simulate)
maOverMwDsXXnumberrun start time (of each phase, autoSize or simulate)Mads/mwds, precomputed in setup.
ntuADsXXnumberrun start time (of each phase, autoSize or simulate)Number of transfer units for air side at design conditions (niles ntuad)
ntuAOdXXnumberrun start time (of each phase, autoSize or simulate).. at off-design conditions, if given. member only as debug aid.
tpTsXXnumberend of each subhour
tpClfXXinteger numberend of each subhourCall-flag: set nz if must call tpcompute so it can test tr, etc to see if computation needed.
tpPtfXXinteger numberend of each subhourCompute-flag: set if must call tpcompute and it should unconditionally recompute.
trNxXXnumberend of each subhour
mwAllNxXXnumberend of each subhour
qLoadNxXXnumberend of each subhour
trXXnumberend of each subhour
mwAllXXnumberend of each subhour
qLoadXXnumberend of each subhour
mwi1XXnumberend of each subhour
qNeedXXnumberend of each subhour
qMax1XXnumberend of each subhour
qMin1XXnumberend of each subhour
towldCaseXXunrecognizedend of each subhourTower load case, tpcompute to endsubhr: facilitates deferring fan power calc
qMaxGuessXXnumberend of each subhourFor internal values for towmodel initial guess at next call for various towmodel calls.
qMinGuessXXnumberend of each subhour..
qLoGuessXXnumberend of each subhour..
qVarGuessXXnumberend of each subhour.., used via varspeedf
qVarTemXXnumberend of each subhour
puteTsXXnumberend of each subhour
nCtOpXXinteger numberend of each subhourNumber of tower fans operating
fXXnumberend of each subhourFraction of full speed (fraction on for one speed fan), for lead tower only if lead.
fanPXXnumberend of each subhourPlant’s fan input pwr this subhour (btuh!)
qXXnumberend of each subhourPower imparted to water, for change detection/probes/reports 10-19-92
tpTsSpPrXXnumberend of each subhourFor tpestimate
tpTsEstPrXXnumberend of each subhourFor tpestimate
tpTsPrXXnumberend of each subhourLeaving water temp at last tpcompute, f (unused?)
tDbOShPrXXnumberend of each subhourOutdoor drybulb temp at last tpcompute, f
wOShPrXXnumberend of each subhourOutdoor humidity ratio at last tpcompute, f

6.63 weather

@weather.

NameInput?Runtime?TypeVariabilityDescription
nameXstringconstant
sunupfXnumberhourlyFraction of hour if sun is up
slAzmXnumberhourlyAzimuth, radians (0=n, +clockwise)
slAltXnumberhourlyAltitude, radians (0=horizon, +upwards)
dbXnumberhourlyAir dry bulb temp, deg f
wbXnumberhourlyAir wet bulb temp, deg f
DNIXnumberhourlyDirect normal irradiance from weather file (integrated value for hour, btu/ft2)
DHIXnumberhourlyDiffuse horizontal irradiance from weather file (integrated value for hour, btu/ft2)
bmradXnumberhourlyDni as adjusted per anisotropic sky, top.radbeamf, etc (integrated value for hour, btu/ft2)
dfradXnumberhourlyDhi as adjusted per anisotropic sky, top.raddifff, etc (integrated value for hour, btu/ft2)
wndDirXnumberhourlyWind direction, deg, 0=n, 90=e
wndSpdXnumberhourlyWind speed, mph
glradXnumberhourlyGlobal irradiance on horizontal surface, for daylighting calculations
cldCvrXnumberhourlyTotal cloud cover in tenths, 0-11, or 15 for missing data
tSkyXnumberhourlySky temperature, f from weather file or calcskytemp() (berdahl-martin)
tGrndXnumberhourlyGround temperature, f
taDpXnumberhourlyAir dew point temp, f
tMainsXnumberhourlyCold water mains temp, f
tdvElecXnumberhourlyElectricity
tdvFuelXnumberhourlyFuel
taDbPkXnumberhourlyCurrent day peak db (includes future hours), f
taDbAvgXnumberhourlyCurrent day average db (includes future hours), f
taDbPvPkXnumberhourlyPrevious-day peak db, f
taDbAvg01XnumberhourlyPrevious-day avg db (not including current day), f
taDbAvg07XnumberhourlyTrailing 7-day avg db (not including current day), f
taDbAvg14XnumberhourlyTrailing 14-day avg db (not including current day), f
taDbAvg31XnumberhourlyTrailing 31-day avg db (not including current day), f
tdvElecPkXnumberhourlyCurrent day peak tdvelec (includes future hours)
tdvElecPkRankXinteger numberhourlyCurrent day wd_tdvelecpk rank within year (1-365/366)
tdvElecAvgXnumberhourlyCurrent day avg tdvelec (includes future hours)
tdvElecPvPkXnumberhourlyPrevious-day peak tdvelec
tdvElecAvg01XnumberhourlyPrevious-day avg tdvelec (not including current day)
tdvElecHrRank[0]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[1]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[2]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[3]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[4]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[5]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[6]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[7]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[8]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[9]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[10]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[11]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[12]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[13]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[14]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[15]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[16]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[17]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[18]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[19]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[20]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[21]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[22]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[23]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[24]Xinteger numberhourlyHour ranking of tdv values for current day

6.64 weatherFile

@weatherFile.

NameInput?Runtime?TypeVariabilityDescription
nameXstringconstant
wFileFormatXinteger numberrun start time (of each phase, autoSize or simulate)File format enum: unk, bsgs, et1, etc.
locXstringrun start time (of each phase, autoSize or simulate)Char loc[] location (for et, is loc 1 only: city etc).
lidXstringrun start time (of each phase, autoSize or simulate)Char lid[] location id
yrXinteger numberrun start time (of each phase, autoSize or simulate)Year of weather data (00 - 99, -1 if n/a)
jd1Xinteger numberrun start time (of each phase, autoSize or simulate)Julian day of first weather record (-1 if not known)
jdlXinteger numberrun start time (of each phase, autoSize or simulate)Julian day of last weather record (ditto)
latXnumberrun start time (of each phase, autoSize or simulate)Latitude, degrees n (-90.0 to 90.0)
lonXnumberrun start time (of each phase, autoSize or simulate)Longitude, degrees w (-180. to 180.0). us locations are >0, note non-standard
tzXnumberrun start time (of each phase, autoSize or simulate)Time zone, hours w of greenwich (est = +5, note non-standard
elevXnumberrun start time (of each phase, autoSize or simulate)Elevation of locn in ft (-9999. to 99999.)
taDbAvgYrXnumberrun start time (of each phase, autoSize or simulate)Annual average dry-bulb temp, f
tMainsAvgYrXnumberautosize and simulate phase start timeAnnual average cold water temp, f
tMainsMinYrXnumberautosize and simulate phase start timeAnnual minimum cold water temp, f
solartimeXinteger numberrun start time (of each phase, autoSize or simulate)True if file is in solar time
loc2Xstringrun start time (of each phase, autoSize or simulate)Char[] location 2 (state or country, etc)
isLeapXinteger numberrun start time (of each phase, autoSize or simulate)Non-0 if weather file is for a leap year (feb 29 counted in dates) – possible future use
firstDdmXinteger numberrun start time (of each phase, autoSize or simulate)Month 1-12 of first design day in file
lastDdmXinteger numberrun start time (of each phase, autoSize or simulate)Month 1-12 of last design day in file
winMOEXinteger numberrun start time (of each phase, autoSize or simulate)Winter median of extremes (deg f)
win99TDbXinteger numberrun start time (of each phase, autoSize or simulate)Winter 99% design temp (deg f)
win97TDbXinteger numberrun start time (of each phase, autoSize or simulate)Winter 97.5% design temp (deg f)
sum1TDbXinteger numberrun start time (of each phase, autoSize or simulate)Summer 1% design temp (deg f)
sum1TWbXinteger numberrun start time (of each phase, autoSize or simulate)Summer 1% design coincident wb (deg f)
sum2TDbXinteger numberrun start time (of each phase, autoSize or simulate)Summer 2.5% design temp (deg f)
sum2TWbXinteger numberrun start time (of each phase, autoSize or simulate)Summer 2.5% design coincident wb (deg f)
sum5TDbXinteger numberrun start time (of each phase, autoSize or simulate)Summer 5% design temp (deg f)
sum5TWbXinteger numberrun start time (of each phase, autoSize or simulate)Summer 5% design coincident wb (deg f)
rangeXinteger numberrun start time (of each phase, autoSize or simulate)Mean daily range (deg f)
sumMonHiXinteger numberrun start time (of each phase, autoSize or simulate)Month of hottest design day, 1-12
TDVFileTimeStampXstringautosize and simulate phase start timeTimestamp string
TDVFileTitleXstringautosize and simulate phase start timeTitle string (identifies file cz, fuel, vintage, )

6.65 weatherNextHour

@weatherNextHour.

NameInput?Runtime?TypeVariabilityDescription
nameXstringconstant
sunupfXnumberhourlyFraction of hour if sun is up
slAzmXnumberhourlyAzimuth, radians (0=n, +clockwise)
slAltXnumberhourlyAltitude, radians (0=horizon, +upwards)
dbXnumberhourlyAir dry bulb temp, deg f
wbXnumberhourlyAir wet bulb temp, deg f
DNIXnumberhourlyDirect normal irradiance from weather file (integrated value for hour, btu/ft2)
DHIXnumberhourlyDiffuse horizontal irradiance from weather file (integrated value for hour, btu/ft2)
bmradXnumberhourlyDni as adjusted per anisotropic sky, top.radbeamf, etc (integrated value for hour, btu/ft2)
dfradXnumberhourlyDhi as adjusted per anisotropic sky, top.raddifff, etc (integrated value for hour, btu/ft2)
wndDirXnumberhourlyWind direction, deg, 0=n, 90=e
wndSpdXnumberhourlyWind speed, mph
glradXnumberhourlyGlobal irradiance on horizontal surface, for daylighting calculations
cldCvrXnumberhourlyTotal cloud cover in tenths, 0-11, or 15 for missing data
tSkyXnumberhourlySky temperature, f from weather file or calcskytemp() (berdahl-martin)
tGrndXnumberhourlyGround temperature, f
taDpXnumberhourlyAir dew point temp, f
tMainsXnumberhourlyCold water mains temp, f
tdvElecXnumberhourlyElectricity
tdvFuelXnumberhourlyFuel
taDbPkXnumberhourlyCurrent day peak db (includes future hours), f
taDbAvgXnumberhourlyCurrent day average db (includes future hours), f
taDbPvPkXnumberhourlyPrevious-day peak db, f
taDbAvg01XnumberhourlyPrevious-day avg db (not including current day), f
taDbAvg07XnumberhourlyTrailing 7-day avg db (not including current day), f
taDbAvg14XnumberhourlyTrailing 14-day avg db (not including current day), f
taDbAvg31XnumberhourlyTrailing 31-day avg db (not including current day), f
tdvElecPkXnumberhourlyCurrent day peak tdvelec (includes future hours)
tdvElecPkRankXinteger numberhourlyCurrent day wd_tdvelecpk rank within year (1-365/366)
tdvElecAvgXnumberhourlyCurrent day avg tdvelec (includes future hours)
tdvElecPvPkXnumberhourlyPrevious-day peak tdvelec
tdvElecAvg01XnumberhourlyPrevious-day avg tdvelec (not including current day)
tdvElecHrRank[0]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[1]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[2]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[3]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[4]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[5]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[6]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[7]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[8]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[9]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[10]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[11]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[12]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[13]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[14]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[15]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[16]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[17]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[18]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[19]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[20]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[21]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[22]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[23]Xinteger numberhourlyHour ranking of tdv values for current day
tdvElecHrRank[24]Xinteger numberhourlyHour ranking of tdv values for current day

6.66 window (owner: surface)

@window[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXstringconstant
tyXinteger numberinput time
areaXnumberrun start time (of each phase, autoSize or simulate)
azmXnumberrun start time (of each phase, autoSize or simulate)
tiltXnumberrun start time (of each phase, autoSize or simulate)
dircos[0]Xnumberrun start time (of each phase, autoSize or simulate)
dircos[1]Xnumberrun start time (of each phase, autoSize or simulate)
dircos[2]Xnumberrun start time (of each phase, autoSize or simulate)
depthBGXnumberrun start time (of each phase, autoSize or simulate)
heightXnumberrun start time (of each phase, autoSize or simulate)… and to compute area b4 mutliplier.
modelXinteger numberinput time
modelrXinteger numberrun start time (of each phase, autoSize or simulate)
lThkFXnumberrun start time (of each phase, autoSize or simulate)
gtiXinteger numberrun start time (of each phase, autoSize or simulate)
scoXnumbermonthly-hourly
sccXnumbermonthly-hourly
sbcI.absSlrXnumbermonthly-hourly
sbcI.awAbsSlrXnumbermonthly-hourly
sbcI.epsLWXnumberrun start time (of each phase, autoSize or simulate)
sbcI.ziXinteger numberrun start time (of each phase, autoSize or simulate)
sbcI.FXnumberrun start time (of each phase, autoSize or simulate)
sbcI.FpXnumberrun start time (of each phase, autoSize or simulate)
sbcI.frRadXnumberrun start time (of each phase, autoSize or simulate)
sbcI.fSkyXnumberrun start time (of each phase, autoSize or simulate)
sbcI.fAirXnumberrun start time (of each phase, autoSize or simulate)
sbcI.hcNatXnumberend of each subhour
sbcI.hcFrcXnumberend of each subhour
sbcI.hcMultXnumberend of each subhour
sbcI.hxaXnumberend of each subhour
sbcI.hxrXnumberend of each subhour
sbcI.hxtotXnumberend of each subhour
sbcI.uRatXnumberend of each subhour
sbcI.fRatXnumberend of each subhour
sbcI.cxXnumberend of each subhour
sbcI.sgTarg.bmXnumberend of each subhour
sbcI.sgTarg.dfXnumberend of each subhour
sbcI.sgTarg.totXnumberend of each subhour
sbcI.sgXnumberend of each subhour
sbcI.tSrfXnumberend of each subhour
sbcI.tSrflsXnumbersubhourly
sbcI.qrAbsXnumberend of each subhour
sbcI.txaXnumberend of each subhour
sbcI.txrXnumberend of each subhour
sbcI.txeXnumberend of each subhour
sbcI.wXnumberend of each subhour
sbcI.qSrfXnumberend of each subhour
sbcI.pXSXunrecognizedrun start time (of each phase, autoSize or simulate)
sbcI.fcWindXnumberrun start time (of each phase, autoSize or simulate)
sbcI.fcWind2Xnumberrun start time (of each phase, autoSize or simulate)
sbcI.etaXnumberend of each subhour
sbcI.widNomXnumberrun start time (of each phase, autoSize or simulate)
sbcI.lenNomXnumberrun start time (of each phase, autoSize or simulate)
sbcI.lenCharNatXnumberrun start time (of each phase, autoSize or simulate)
sbcI.lenEffWinkXnumberrun start time (of each phase, autoSize or simulate)
sbcI.cosTiltXnumberrun start time (of each phase, autoSize or simulate)
sbcI.atvDegXnumberrun start time (of each phase, autoSize or simulate)
sbcI.cosAtvXnumberrun start time (of each phase, autoSize or simulate)
sbcI.hcModelXunrecognizedrun start time (of each phase, autoSize or simulate)
sbcI.hcLCharXnumberrun start time (of each phase, autoSize or simulate)
sbcI.hcConst[0]Xnumberrun start time (of each phase, autoSize or simulate)
sbcI.hcConst[1]Xnumberrun start time (of each phase, autoSize or simulate)
sbcI.hcConst[2]Xnumberrun start time (of each phase, autoSize or simulate)
sbcI.groundModelXunrecognizedrun start time (of each phase, autoSize or simulate)
sbcI.cTaDbAvgYrXnumberrun start time (of each phase, autoSize or simulate)
sbcI.cTaDbAvg31Xnumberrun start time (of each phase, autoSize or simulate)
sbcI.cTaDbAvg14Xnumberrun start time (of each phase, autoSize or simulate)
sbcI.cTaDbAvg07Xnumberrun start time (of each phase, autoSize or simulate)
sbcI.cTGrndXnumberrun start time (of each phase, autoSize or simulate)
sbcI.rGrndXnumberrun start time (of each phase, autoSize or simulate)
sbcI.rConGrndXnumberrun start time (of each phase, autoSize or simulate)
sbcO.absSlrXnumbermonthly-hourly
sbcO.awAbsSlrXnumbermonthly-hourly
sbcO.epsLWXnumberrun start time (of each phase, autoSize or simulate)
sbcO.ziXinteger numberrun start time (of each phase, autoSize or simulate)
sbcO.FXnumberrun start time (of each phase, autoSize or simulate)
sbcO.FpXnumberrun start time (of each phase, autoSize or simulate)
sbcO.frRadXnumberrun start time (of each phase, autoSize or simulate)
sbcO.fSkyXnumberrun start time (of each phase, autoSize or simulate)
sbcO.fAirXnumberrun start time (of each phase, autoSize or simulate)
sbcO.hcNatXnumberend of each subhour
sbcO.hcFrcXnumberend of each subhour
sbcO.hcMultXnumberend of each subhour
sbcO.hxaXnumberend of each subhour
sbcO.hxrXnumberend of each subhour
sbcO.hxtotXnumberend of each subhour
sbcO.uRatXnumberend of each subhour
sbcO.fRatXnumberend of each subhour
sbcO.cxXnumberend of each subhour
sbcO.sgTarg.bmXnumberend of each subhour
sbcO.sgTarg.dfXnumberend of each subhour
sbcO.sgTarg.totXnumberend of each subhour
sbcO.sgXnumberend of each subhour
sbcO.tSrfXnumberend of each subhour
sbcO.tSrflsXnumbersubhourly
sbcO.qrAbsXnumberend of each subhour
sbcO.txaXnumberend of each subhour
sbcO.txrXnumberend of each subhour
sbcO.txeXnumberend of each subhour
sbcO.wXnumberend of each subhour
sbcO.qSrfXnumberend of each subhour
sbcO.pXSXunrecognizedrun start time (of each phase, autoSize or simulate)
sbcO.fcWindXnumberrun start time (of each phase, autoSize or simulate)
sbcO.fcWind2Xnumberrun start time (of each phase, autoSize or simulate)
sbcO.etaXnumberend of each subhour
sbcO.widNomXnumberrun start time (of each phase, autoSize or simulate)
sbcO.lenNomXnumberrun start time (of each phase, autoSize or simulate)
sbcO.lenCharNatXnumberrun start time (of each phase, autoSize or simulate)
sbcO.lenEffWinkXnumberrun start time (of each phase, autoSize or simulate)
sbcO.cosTiltXnumberrun start time (of each phase, autoSize or simulate)
sbcO.atvDegXnumberrun start time (of each phase, autoSize or simulate)
sbcO.cosAtvXnumberrun start time (of each phase, autoSize or simulate)
sbcO.hcModelXunrecognizedrun start time (of each phase, autoSize or simulate)
sbcO.hcLCharXnumberrun start time (of each phase, autoSize or simulate)
sbcO.hcConst[0]Xnumberrun start time (of each phase, autoSize or simulate)
sbcO.hcConst[1]Xnumberrun start time (of each phase, autoSize or simulate)
sbcO.hcConst[2]Xnumberrun start time (of each phase, autoSize or simulate)
sbcO.groundModelXunrecognizedrun start time (of each phase, autoSize or simulate)
sbcO.cTaDbAvgYrXnumberrun start time (of each phase, autoSize or simulate)
sbcO.cTaDbAvg31Xnumberrun start time (of each phase, autoSize or simulate)
sbcO.cTaDbAvg14Xnumberrun start time (of each phase, autoSize or simulate)
sbcO.cTaDbAvg07Xnumberrun start time (of each phase, autoSize or simulate)
sbcO.cTGrndXnumberrun start time (of each phase, autoSize or simulate)
sbcO.rGrndXnumberrun start time (of each phase, autoSize or simulate)
sbcO.rConGrndXnumberrun start time (of each phase, autoSize or simulate)
fenModelXunrecognizedinput time
SHGCXnumberinput time
fMultXnumberrun start time (of each phase, autoSize or simulate)
UNFRCXnumberinput time
NGlzXinteger numberinput time
exShdXunrecognizedinput time
inShdXunrecognizedinput time
dirtLossXnumberrun start time (of each phase, autoSize or simulate)
sfExCndXinteger numberrun start time (of each phase, autoSize or simulate)
sfExTXnumbersubhourly
sfAdjZiXinteger numberinput time
uIXnumberrun start time (of each phase, autoSize or simulate)
uCXnumberrun start time (of each phase, autoSize or simulate)
uXXnumberrun start time (of each phase, autoSize or simulate)
RfXnumberrun start time (of each phase, autoSize or simulate)
grndReflXnumbermonthly-hourly
vfSkyDfXnumbermonthly-hourly
vfGrndDfXnumbermonthly-hourly
vfSkyLWXnumberrun start time (of each phase, autoSize or simulate)
vfGrndLWXnumberrun start time (of each phase, autoSize or simulate)
uvalXnumberrun start time (of each phase, autoSize or simulate)
UNomXnumberrun start time (of each phase, autoSize or simulate)
UANomXnumberrun start time (of each phase, autoSize or simulate)
rSrfNom[0]Xnumberrun start time (of each phase, autoSize or simulate)
rSrfNom[1]Xnumberrun start time (of each phase, autoSize or simulate)
hSrfNom[0]Xnumberrun start time (of each phase, autoSize or simulate)
hSrfNom[1]Xnumberrun start time (of each phase, autoSize or simulate)
cFctrXnumberrun start time (of each phase, autoSize or simulate)
iwshadXinteger numberrun start time (of each phase, autoSize or simulate)
msiXinteger numberrun start time (of each phase, autoSize or simulate)0 or msrat msr subscr which will be used if delayed model
tLrB[0]Xnumberend of each hour
tLrB[1]Xnumberend of each hour
tLrB[2]Xnumberend of each hour
tLrB[3]Xnumberend of each hour
tLrB[4]Xnumberend of each hour
tLrB[5]Xnumberend of each hour
tLrB[6]Xnumberend of each hour
tLrB[7]Xnumberend of each hour
tLrB[8]Xnumberend of each hour
tLrB[9]Xnumberend of each hour
nsgdistXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[0].targTyXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[0].targTiXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[0].FSOXnumbermonthly-hourly
sgdist[0].FSCXnumbermonthly-hourly
sgdist[1].targTyXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[1].targTiXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[1].FSOXnumbermonthly-hourly
sgdist[1].FSCXnumbermonthly-hourly
sgdist[2].targTyXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[2].targTiXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[2].FSOXnumbermonthly-hourly
sgdist[2].FSCXnumbermonthly-hourly
sgdist[3].targTyXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[3].targTiXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[3].FSOXnumbermonthly-hourly
sgdist[3].FSCXnumbermonthly-hourly
sgdist[4].targTyXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[4].targTiXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[4].FSOXnumbermonthly-hourly
sgdist[4].FSCXnumbermonthly-hourly
sgdist[5].targTyXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[5].targTiXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[5].FSOXnumbermonthly-hourly
sgdist[5].FSCXnumbermonthly-hourly
sgdist[6].targTyXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[6].targTiXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[6].FSOXnumbermonthly-hourly
sgdist[6].FSCXnumbermonthly-hourly
sgdist[7].targTyXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[7].targTiXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[7].FSOXnumbermonthly-hourly
sgdist[7].FSCXnumbermonthly-hourly
sfAreaXnumberinput timeSurface: gross area, net in x.xs_area.
sfUXnumberinput timeUval input if no sfcon given (excl surf films)
sfConXinteger numberinput timeSurface construction (optional)
sfTyXinteger numberconstantWall/floor/ceil/[intmass1/2]: for input cking.
sfFndXinteger numberinput timeSurface foundation object (floors only, optional)
sfFndFloorXinteger numberinput timeSurface foundation floor object (walls only, optional)
sfExpPerimXnumberinput timeFoundation floor exposed perimeter (floors only)
widthXnumberinput timeWidth and height: used to compute shading,
heightXnumberinput time… and to compute area b4 mutliplier.
multXnumberinput timeArea multiplier (for multiple identical windows)
xiXinteger numberrun start time (of each phase, autoSize or simulate)Subscript in runtime xsrat, to facilitate access by probers 1-92
msiXinteger numberrun start time (of each phase, autoSize or simulate)0 or msrat msr subscr which will be used if delayed model

6.67 xsurf

@xsurf[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXstringconstant
nxXsurfXinteger numberrun start time (of each phase, autoSize or simulate)0 or xsrat subscr of next record for zone. chain head is znr.xsurf1.
nxXsSpecTXinteger numberrun start time (of each phase, autoSize or simulate)Addl chain of records w/ x.sfexcnd==c_excndch_spect: used hourly. head is znr.xsspect1.
tyXinteger numberrun start time (of each phase, autoSize or simulate)
areaXnumberrun start time (of each phase, autoSize or simulate)
azmXnumberrun start time (of each phase, autoSize or simulate)
tiltXnumberrun start time (of each phase, autoSize or simulate)
dircos[0]Xnumberrun start time (of each phase, autoSize or simulate)
dircos[1]Xnumberrun start time (of each phase, autoSize or simulate)
dircos[2]Xnumberrun start time (of each phase, autoSize or simulate)
depthBGXnumberrun start time (of each phase, autoSize or simulate)
heightXnumberrun start time (of each phase, autoSize or simulate)
modelXinteger numberrun start time (of each phase, autoSize or simulate)
modelrXinteger numberrun start time (of each phase, autoSize or simulate)
lThkFXnumberrun start time (of each phase, autoSize or simulate)
gtiXinteger numberrun start time (of each phase, autoSize or simulate)
scoXnumbermonthly-hourly
sccXnumbermonthly-hourly
sbcI.absSlrXnumbermonthly-hourly
sbcI.awAbsSlrXnumbermonthly-hourly
sbcI.epsLWXnumberrun start time (of each phase, autoSize or simulate)
sbcI.ziXinteger numberrun start time (of each phase, autoSize or simulate)
sbcI.FXnumberrun start time (of each phase, autoSize or simulate)
sbcI.FpXnumberrun start time (of each phase, autoSize or simulate)
sbcI.frRadXnumberrun start time (of each phase, autoSize or simulate)
sbcI.fSkyXnumberrun start time (of each phase, autoSize or simulate)
sbcI.fAirXnumberrun start time (of each phase, autoSize or simulate)
sbcI.hcNatXnumberend of each subhour
sbcI.hcFrcXnumberend of each subhour
sbcI.hcMultXnumberend of each subhour
sbcI.hxaXnumberend of each subhour
sbcI.hxrXnumberend of each subhour
sbcI.hxtotXnumberend of each subhour
sbcI.uRatXnumberend of each subhour
sbcI.fRatXnumberend of each subhour
sbcI.cxXnumberend of each subhour
sbcI.sgTarg.bmXnumberend of each subhour
sbcI.sgTarg.dfXnumberend of each subhour
sbcI.sgTarg.totXnumberend of each subhour
sbcI.sgXnumberend of each subhour
sbcI.tSrfXnumberend of each subhour
sbcI.tSrflsXnumbersubhourly
sbcI.qrAbsXnumberend of each subhour
sbcI.txaXnumberend of each subhour
sbcI.txrXnumberend of each subhour
sbcI.txeXnumberend of each subhour
sbcI.wXnumberend of each subhour
sbcI.qSrfXnumberend of each subhour
sbcI.pXSXunrecognizedrun start time (of each phase, autoSize or simulate)
sbcI.fcWindXnumberrun start time (of each phase, autoSize or simulate)
sbcI.fcWind2Xnumberrun start time (of each phase, autoSize or simulate)
sbcI.etaXnumberend of each subhour
sbcI.widNomXnumberrun start time (of each phase, autoSize or simulate)
sbcI.lenNomXnumberrun start time (of each phase, autoSize or simulate)
sbcI.lenCharNatXnumberrun start time (of each phase, autoSize or simulate)
sbcI.lenEffWinkXnumberrun start time (of each phase, autoSize or simulate)
sbcI.cosTiltXnumberrun start time (of each phase, autoSize or simulate)
sbcI.atvDegXnumberrun start time (of each phase, autoSize or simulate)
sbcI.cosAtvXnumberrun start time (of each phase, autoSize or simulate)
sbcI.hcModelXunrecognizedrun start time (of each phase, autoSize or simulate)
sbcI.hcLCharXnumberrun start time (of each phase, autoSize or simulate)
sbcI.hcConst[0]Xnumberrun start time (of each phase, autoSize or simulate)
sbcI.hcConst[1]Xnumberrun start time (of each phase, autoSize or simulate)
sbcI.hcConst[2]Xnumberrun start time (of each phase, autoSize or simulate)
sbcI.groundModelXunrecognizedrun start time (of each phase, autoSize or simulate)
sbcI.cTaDbAvgYrXnumberrun start time (of each phase, autoSize or simulate)
sbcI.cTaDbAvg31Xnumberrun start time (of each phase, autoSize or simulate)
sbcI.cTaDbAvg14Xnumberrun start time (of each phase, autoSize or simulate)
sbcI.cTaDbAvg07Xnumberrun start time (of each phase, autoSize or simulate)
sbcI.cTGrndXnumberrun start time (of each phase, autoSize or simulate)
sbcI.rGrndXnumberrun start time (of each phase, autoSize or simulate)
sbcI.rConGrndXnumberrun start time (of each phase, autoSize or simulate)
sbcO.absSlrXnumbermonthly-hourly
sbcO.awAbsSlrXnumbermonthly-hourly
sbcO.epsLWXnumberrun start time (of each phase, autoSize or simulate)
sbcO.ziXinteger numberrun start time (of each phase, autoSize or simulate)
sbcO.FXnumberrun start time (of each phase, autoSize or simulate)
sbcO.FpXnumberrun start time (of each phase, autoSize or simulate)
sbcO.frRadXnumberrun start time (of each phase, autoSize or simulate)
sbcO.fSkyXnumberrun start time (of each phase, autoSize or simulate)
sbcO.fAirXnumberrun start time (of each phase, autoSize or simulate)
sbcO.hcNatXnumberend of each subhour
sbcO.hcFrcXnumberend of each subhour
sbcO.hcMultXnumberend of each subhour
sbcO.hxaXnumberend of each subhour
sbcO.hxrXnumberend of each subhour
sbcO.hxtotXnumberend of each subhour
sbcO.uRatXnumberend of each subhour
sbcO.fRatXnumberend of each subhour
sbcO.cxXnumberend of each subhour
sbcO.sgTarg.bmXnumberend of each subhour
sbcO.sgTarg.dfXnumberend of each subhour
sbcO.sgTarg.totXnumberend of each subhour
sbcO.sgXnumberend of each subhour
sbcO.tSrfXnumberend of each subhour
sbcO.tSrflsXnumbersubhourly
sbcO.qrAbsXnumberend of each subhour
sbcO.txaXnumberend of each subhour
sbcO.txrXnumberend of each subhour
sbcO.txeXnumberend of each subhour
sbcO.wXnumberend of each subhour
sbcO.qSrfXnumberend of each subhour
sbcO.pXSXunrecognizedrun start time (of each phase, autoSize or simulate)
sbcO.fcWindXnumberrun start time (of each phase, autoSize or simulate)
sbcO.fcWind2Xnumberrun start time (of each phase, autoSize or simulate)
sbcO.etaXnumberend of each subhour
sbcO.widNomXnumberrun start time (of each phase, autoSize or simulate)
sbcO.lenNomXnumberrun start time (of each phase, autoSize or simulate)
sbcO.lenCharNatXnumberrun start time (of each phase, autoSize or simulate)
sbcO.lenEffWinkXnumberrun start time (of each phase, autoSize or simulate)
sbcO.cosTiltXnumberrun start time (of each phase, autoSize or simulate)
sbcO.atvDegXnumberrun start time (of each phase, autoSize or simulate)
sbcO.cosAtvXnumberrun start time (of each phase, autoSize or simulate)
sbcO.hcModelXunrecognizedrun start time (of each phase, autoSize or simulate)
sbcO.hcLCharXnumberrun start time (of each phase, autoSize or simulate)
sbcO.hcConst[0]Xnumberrun start time (of each phase, autoSize or simulate)
sbcO.hcConst[1]Xnumberrun start time (of each phase, autoSize or simulate)
sbcO.hcConst[2]Xnumberrun start time (of each phase, autoSize or simulate)
sbcO.groundModelXunrecognizedrun start time (of each phase, autoSize or simulate)
sbcO.cTaDbAvgYrXnumberrun start time (of each phase, autoSize or simulate)
sbcO.cTaDbAvg31Xnumberrun start time (of each phase, autoSize or simulate)
sbcO.cTaDbAvg14Xnumberrun start time (of each phase, autoSize or simulate)
sbcO.cTaDbAvg07Xnumberrun start time (of each phase, autoSize or simulate)
sbcO.cTGrndXnumberrun start time (of each phase, autoSize or simulate)
sbcO.rGrndXnumberrun start time (of each phase, autoSize or simulate)
sbcO.rConGrndXnumberrun start time (of each phase, autoSize or simulate)
fenModelXunrecognizedrun start time (of each phase, autoSize or simulate)
SHGCXnumberrun start time (of each phase, autoSize or simulate)
fMultXnumberrun start time (of each phase, autoSize or simulate)
UNFRCXnumberrun start time (of each phase, autoSize or simulate)
NGlzXinteger numberrun start time (of each phase, autoSize or simulate)
exShdXunrecognizedrun start time (of each phase, autoSize or simulate)
inShdXunrecognizedrun start time (of each phase, autoSize or simulate)
dirtLossXnumberrun start time (of each phase, autoSize or simulate)
sfExCndXinteger numberrun start time (of each phase, autoSize or simulate)
sfExTXnumbersubhourly
sfAdjZiXinteger numberrun start time (of each phase, autoSize or simulate)
uIXnumberrun start time (of each phase, autoSize or simulate)
uCXnumberrun start time (of each phase, autoSize or simulate)
uXXnumberrun start time (of each phase, autoSize or simulate)
RfXnumberrun start time (of each phase, autoSize or simulate)
grndReflXnumbermonthly-hourly
vfSkyDfXnumbermonthly-hourly
vfGrndDfXnumbermonthly-hourly
vfSkyLWXnumberrun start time (of each phase, autoSize or simulate)
vfGrndLWXnumberrun start time (of each phase, autoSize or simulate)
uvalXnumberrun start time (of each phase, autoSize or simulate)
UNomXnumberrun start time (of each phase, autoSize or simulate)
UANomXnumberrun start time (of each phase, autoSize or simulate)
rSrfNom[0]Xnumberrun start time (of each phase, autoSize or simulate)
rSrfNom[1]Xnumberrun start time (of each phase, autoSize or simulate)
hSrfNom[0]Xnumberrun start time (of each phase, autoSize or simulate)
hSrfNom[1]Xnumberrun start time (of each phase, autoSize or simulate)
cFctrXnumberrun start time (of each phase, autoSize or simulate)
iwshadXinteger numberrun start time (of each phase, autoSize or simulate)
msiXinteger numberrun start time (of each phase, autoSize or simulate)
tLrB[0]Xnumberend of each hour
tLrB[1]Xnumberend of each hour
tLrB[2]Xnumberend of each hour
tLrB[3]Xnumberend of each hour
tLrB[4]Xnumberend of each hour
tLrB[5]Xnumberend of each hour
tLrB[6]Xnumberend of each hour
tLrB[7]Xnumberend of each hour
tLrB[8]Xnumberend of each hour
tLrB[9]Xnumberend of each hour
nsgdistXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[0].targTyXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[0].targTiXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[0].FSOXnumbermonthly-hourly
sgdist[0].FSCXnumbermonthly-hourly
sgdist[1].targTyXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[1].targTiXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[1].FSOXnumbermonthly-hourly
sgdist[1].FSCXnumbermonthly-hourly
sgdist[2].targTyXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[2].targTiXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[2].FSOXnumbermonthly-hourly
sgdist[2].FSCXnumbermonthly-hourly
sgdist[3].targTyXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[3].targTiXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[3].FSOXnumbermonthly-hourly
sgdist[3].FSCXnumbermonthly-hourly
sgdist[4].targTyXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[4].targTiXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[4].FSOXnumbermonthly-hourly
sgdist[4].FSCXnumbermonthly-hourly
sgdist[5].targTyXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[5].targTiXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[5].FSOXnumbermonthly-hourly
sgdist[5].FSCXnumbermonthly-hourly
sgdist[6].targTyXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[6].targTiXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[6].FSOXnumbermonthly-hourly
sgdist[6].FSCXnumbermonthly-hourly
sgdist[7].targTyXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[7].targTiXinteger numberrun start time (of each phase, autoSize or simulate)
sgdist[7].FSOXnumbermonthly-hourly
sgdist[7].FSCXnumbermonthly-hourly

6.68 zhx (owner: zone)

@zhx[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXstringconstant
zhxTyXunrecognizedrun start time (of each phase, autoSize or simulate)Zhx type (cndtypes.def): lhso, lhsth, arso, arsth, arstc, or (future) nv.
spXnumberhourlySetpoint if heat xfer is tstat controlled (settmp), else unused (hourly variability)
spPriXinteger numberrun start time (of each phase, autoSize or simulate)Setpoint priority: low #’s used first if setpoints equal, so can eg peg air heat b4 using local heat.
uiXinteger numberrun start time (of each phase, autoSize or simulate)Terminal tu subscript if a term cap type
ziXinteger numberrun start time (of each phase, autoSize or simulate)Zone znr subscript always – for term cap or vent zhx. when stable, just use ownti?
aiXinteger numberrun start time (of each phase, autoSize or simulate)0 or ah ss (subscript) of air handler supplying ar zhx (copied from tu).
xiLhXinteger numberrun start time (of each phase, autoSize or simulate)Subscr of local heat zhx for same terminal if any, else 0; not set for self.
xiArHXinteger numberrun start time (of each phase, autoSize or simulate)Was xiheat. subscr of air heat or air set output zhx for same terminal, if any, else 0
xiArCXinteger numberrun start time (of each phase, autoSize or simulate)Xicool. subscr of air cool zhx for same terminal, if any, else 0
nxZhx4zXinteger numberrun start time (of each phase, autoSize or simulate)Chain: 0 or subscript of next terminal zhx for this zone; 0?? if vent; head znr.zhx1.
nxZhxSt4zXinteger numberhourlyChain: 0 or ss of next settmp zhx for this zone; head znr.zhx1st; kept sorted on sp/pri at runtime.
nxZhx4aXinteger numberrun start time (of each phase, autoSize or simulate)Chain: 0 or subscript of next terminal zhx for this air handler; head ah.zhx1.
mdaXinteger numberhourlyFor settmp, mode (mdseq[] subscr) in which this is active (ctrl’d by its sp) zhx.

6.69 znRes

@znRes[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXstringconstant
Y.nHrHeatXinteger numberend of run (of each phase, autoSize or simulate)# of hours in which any heating occurred; 1st “# of hours”
Y.nHrCoolXinteger numberend of run (of each phase, autoSize or simulate)Ditto cooling
Y.nHrFanvXinteger numberend of run (of each phase, autoSize or simulate)Ditto fan vent
Y.nHrNatvXinteger numberend of run (of each phase, autoSize or simulate)Ditto natural vent
Y.nHrCeilFanXinteger numberend of run (of each phase, autoSize or simulate)Ditto ceiling fan operation; last “# of hours”
Y.tAirXnumberend of run (of each phase, autoSize or simulate)Zone air temp; must be 1st float, is first float to average (see cnguts.h)
Y.tRadXnumberend of run (of each phase, autoSize or simulate)Zone radiant temp; meaningful iff convective/radiant model active for this zone
Y.PMV7730Xnumberend of run (of each phase, autoSize or simulate)Iso7730 predicted mean vote = predicted comfort per ashrae thermal sensation scale
Y.PPD7730Xnumberend of run (of each phase, autoSize or simulate)Iso7730 predicted percent dissatisfied = % of people not satisfied with conditions
Y.ivAirXXnumberend of run (of each phase, autoSize or simulate)Zone air exchange rate not including hvac or ducts, ach
Y.pz0Xnumberend of run (of each phase, autoSize or simulate)Zone air pressure relative to patm at nominal z=0, lbf/sf (from zn_pz0)
Y.wAirXnumberend of run (of each phase, autoSize or simulate)Zone air humidity ratio; last float to average
Y.qCondXnumberend of run (of each phase, autoSize or simulate)Zone wall conduction gain, btu; 1st heat flow and first float to sum
Y.qsInfilXnumberend of run (of each phase, autoSize or simulate)Zone infiltration sensible gain, btu
Y.qSlrXnumberend of run (of each phase, autoSize or simulate)Zone solar gain, btu
Y.qsIgXnumberend of run (of each phase, autoSize or simulate)Zone internal sensible gain, btu
Y.qMassXnumberend of run (of each phase, autoSize or simulate)Zone net sensible transfer from mass, btu. see qlair for moisture.
Y.qsIzXnumberend of run (of each phase, autoSize or simulate)Interzone gain to zone, btu
Y.qsMechXnumberend of run (of each phase, autoSize or simulate)Zone total sensible mechanical heat gain, btu
Y.eqfVentHrXnumberend of run (of each phase, autoSize or simulate)Equivalent full vent hours = sum( zn_fvent)
Y.qlInfilXnumberend of run (of each phase, autoSize or simulate)Zone infiltration latent gain, btu
Y.qlIgXnumberend of run (of each phase, autoSize or simulate)Zone internal latent gain, btu
Y.qlIzXnumberend of run (of each phase, autoSize or simulate)Zone izxfer latent gain (infil, vent, duct leakage)
Y.qlAirXnumberend of run (of each phase, autoSize or simulate)Latent heat of moisture removed from zone air: moisture analog of zncair.
Y.qlMechXnumberend of run (of each phase, autoSize or simulate)Zone latent mechanical heat gain, btu; last heat flow and last float to sum
Y.qsBalXnumberend of run (of each phase, autoSize or simulate)Sensible balance: sum of sensible heats, should be near 0. set in cnguts.cpp.
Y.qlBalXnumberend of run (of each phase, autoSize or simulate)Latent balance similarly. consider removing bals after development.
Y.qlXXnumberend of run (of each phase, autoSize or simulate)Latent gain rejected to prevent zone supersaturation === heat of condensation.
Y.unMetHrDH[0]Xnumberend of run (of each phase, autoSize or simulate)End-of-hour tz excursion below/above setpoint, deg-hr
Y.unMetHrDH[1]Xnumberend of run (of each phase, autoSize or simulate)End-of-hour tz excursion below/above setpoint, deg-hr
Y.unMetShDH[0]Xnumberend of run (of each phase, autoSize or simulate)Subhour tz excursion below/above setpoint, deg-hr
Y.unMetShDH[1]Xnumberend of run (of each phase, autoSize or simulate)Subhour tz excursion below/above setpoint, deg-hr
Y.unMetHrs[0]Xnumberend of run (of each phase, autoSize or simulate)Unmet hours (accumulated subhourly, tz excursion > 0)
Y.unMetHrs[1]Xnumberend of run (of each phase, autoSize or simulate)Unmet hours (accumulated subhourly, tz excursion > 0)
Y.unMetHrsTol[0]Xnumberend of run (of each phase, autoSize or simulate)Unmet hours (accumulated subhourly, tz excursion > tp_unmettztol)
Y.unMetHrsTol[1]Xnumberend of run (of each phase, autoSize or simulate)Unmet hours (accumulated subhourly, tz excursion > tp_unmettztol)
Y.qscHvacXnumberend of run (of each phase, autoSize or simulate)Zone accumulated hvac sensible cooling, btu (<=0) (oav not included)
Y.qshHvacXnumberend of run (of each phase, autoSize or simulate)Zone accumulated hvac sensible heating, btu (>=0)
Y.qcMechXnumberend of run (of each phase, autoSize or simulate)Zone accumulated total mechanical (sensible + latent) cooling (including hpwh heat extraction), btu (< 0)
Y.qhMechXnumberend of run (of each phase, autoSize or simulate)Zone accumulated total mechanical (sensible + latent) heating (including hpwh heat extraction), btu (>0)
Y.qvMechXnumberend of run (of each phase, autoSize or simulate)Zone accumulated mechanical (oav) total (sensible + latent) heat gains, btu (< 0)
Y.litDmdXnumberend of run (of each phase, autoSize or simulate)Zone lighting demand and energy use, …
Y.litEuXnumberend of run (of each phase, autoSize or simulate)… from gains, in addition to posting eu to meter, re daylighting for nrel. 9-94.
Y.unMetMaxTD[0]Xnumberend of run (of each phase, autoSize or simulate)Maximum tz excursion below/above setpoint, f
Y.unMetMaxTD[1]Xnumberend of run (of each phase, autoSize or simulate)Maximum tz excursion below/above setpoint, f
M.nHrHeatXinteger numberend of each month# of hours in which any heating occurred; 1st “# of hours”
M.nHrCoolXinteger numberend of each monthDitto cooling
M.nHrFanvXinteger numberend of each monthDitto fan vent
M.nHrNatvXinteger numberend of each monthDitto natural vent
M.nHrCeilFanXinteger numberend of each monthDitto ceiling fan operation; last “# of hours”
M.tAirXnumberend of each monthZone air temp; must be 1st float, is first float to average (see cnguts.h)
M.tRadXnumberend of each monthZone radiant temp; meaningful iff convective/radiant model active for this zone
M.PMV7730Xnumberend of each monthIso7730 predicted mean vote = predicted comfort per ashrae thermal sensation scale
M.PPD7730Xnumberend of each monthIso7730 predicted percent dissatisfied = % of people not satisfied with conditions
M.ivAirXXnumberend of each monthZone air exchange rate not including hvac or ducts, ach
M.pz0Xnumberend of each monthZone air pressure relative to patm at nominal z=0, lbf/sf (from zn_pz0)
M.wAirXnumberend of each monthZone air humidity ratio; last float to average
M.qCondXnumberend of each monthZone wall conduction gain, btu; 1st heat flow and first float to sum
M.qsInfilXnumberend of each monthZone infiltration sensible gain, btu
M.qSlrXnumberend of each monthZone solar gain, btu
M.qsIgXnumberend of each monthZone internal sensible gain, btu
M.qMassXnumberend of each monthZone net sensible transfer from mass, btu. see qlair for moisture.
M.qsIzXnumberend of each monthInterzone gain to zone, btu
M.qsMechXnumberend of each monthZone total sensible mechanical heat gain, btu
M.eqfVentHrXnumberend of each monthEquivalent full vent hours = sum( zn_fvent)
M.qlInfilXnumberend of each monthZone infiltration latent gain, btu
M.qlIgXnumberend of each monthZone internal latent gain, btu
M.qlIzXnumberend of each monthZone izxfer latent gain (infil, vent, duct leakage)
M.qlAirXnumberend of each monthLatent heat of moisture removed from zone air: moisture analog of zncair.
M.qlMechXnumberend of each monthZone latent mechanical heat gain, btu; last heat flow and last float to sum
M.qsBalXnumberend of each monthSensible balance: sum of sensible heats, should be near 0. set in cnguts.cpp.
M.qlBalXnumberend of each monthLatent balance similarly. consider removing bals after development.
M.qlXXnumberend of each monthLatent gain rejected to prevent zone supersaturation === heat of condensation.
M.unMetHrDH[0]Xnumberend of each monthEnd-of-hour tz excursion below/above setpoint, deg-hr
M.unMetHrDH[1]Xnumberend of each monthEnd-of-hour tz excursion below/above setpoint, deg-hr
M.unMetShDH[0]Xnumberend of each monthSubhour tz excursion below/above setpoint, deg-hr
M.unMetShDH[1]Xnumberend of each monthSubhour tz excursion below/above setpoint, deg-hr
M.unMetHrs[0]Xnumberend of each monthUnmet hours (accumulated subhourly, tz excursion > 0)
M.unMetHrs[1]Xnumberend of each monthUnmet hours (accumulated subhourly, tz excursion > 0)
M.unMetHrsTol[0]Xnumberend of each monthUnmet hours (accumulated subhourly, tz excursion > tp_unmettztol)
M.unMetHrsTol[1]Xnumberend of each monthUnmet hours (accumulated subhourly, tz excursion > tp_unmettztol)
M.qscHvacXnumberend of each monthZone accumulated hvac sensible cooling, btu (<=0) (oav not included)
M.qshHvacXnumberend of each monthZone accumulated hvac sensible heating, btu (>=0)
M.qcMechXnumberend of each monthZone accumulated total mechanical (sensible + latent) cooling (including hpwh heat extraction), btu (< 0)
M.qhMechXnumberend of each monthZone accumulated total mechanical (sensible + latent) heating (including hpwh heat extraction), btu (>0)
M.qvMechXnumberend of each monthZone accumulated mechanical (oav) total (sensible + latent) heat gains, btu (< 0)
M.litDmdXnumberend of each monthZone lighting demand and energy use, …
M.litEuXnumberend of each month… from gains, in addition to posting eu to meter, re daylighting for nrel. 9-94.
M.unMetMaxTD[0]Xnumberend of each monthMaximum tz excursion below/above setpoint, f
M.unMetMaxTD[1]Xnumberend of each monthMaximum tz excursion below/above setpoint, f
D.nHrHeatXinteger numberend of each day# of hours in which any heating occurred; 1st “# of hours”
D.nHrCoolXinteger numberend of each dayDitto cooling
D.nHrFanvXinteger numberend of each dayDitto fan vent
D.nHrNatvXinteger numberend of each dayDitto natural vent
D.nHrCeilFanXinteger numberend of each dayDitto ceiling fan operation; last “# of hours”
D.tAirXnumberend of each dayZone air temp; must be 1st float, is first float to average (see cnguts.h)
D.tRadXnumberend of each dayZone radiant temp; meaningful iff convective/radiant model active for this zone
D.PMV7730Xnumberend of each dayIso7730 predicted mean vote = predicted comfort per ashrae thermal sensation scale
D.PPD7730Xnumberend of each dayIso7730 predicted percent dissatisfied = % of people not satisfied with conditions
D.ivAirXXnumberend of each dayZone air exchange rate not including hvac or ducts, ach
D.pz0Xnumberend of each dayZone air pressure relative to patm at nominal z=0, lbf/sf (from zn_pz0)
D.wAirXnumberend of each dayZone air humidity ratio; last float to average
D.qCondXnumberend of each dayZone wall conduction gain, btu; 1st heat flow and first float to sum
D.qsInfilXnumberend of each dayZone infiltration sensible gain, btu
D.qSlrXnumberend of each dayZone solar gain, btu
D.qsIgXnumberend of each dayZone internal sensible gain, btu
D.qMassXnumberend of each dayZone net sensible transfer from mass, btu. see qlair for moisture.
D.qsIzXnumberend of each dayInterzone gain to zone, btu
D.qsMechXnumberend of each dayZone total sensible mechanical heat gain, btu
D.eqfVentHrXnumberend of each dayEquivalent full vent hours = sum( zn_fvent)
D.qlInfilXnumberend of each dayZone infiltration latent gain, btu
D.qlIgXnumberend of each dayZone internal latent gain, btu
D.qlIzXnumberend of each dayZone izxfer latent gain (infil, vent, duct leakage)
D.qlAirXnumberend of each dayLatent heat of moisture removed from zone air: moisture analog of zncair.
D.qlMechXnumberend of each dayZone latent mechanical heat gain, btu; last heat flow and last float to sum
D.qsBalXnumberend of each daySensible balance: sum of sensible heats, should be near 0. set in cnguts.cpp.
D.qlBalXnumberend of each dayLatent balance similarly. consider removing bals after development.
D.qlXXnumberend of each dayLatent gain rejected to prevent zone supersaturation === heat of condensation.
D.unMetHrDH[0]Xnumberend of each dayEnd-of-hour tz excursion below/above setpoint, deg-hr
D.unMetHrDH[1]Xnumberend of each dayEnd-of-hour tz excursion below/above setpoint, deg-hr
D.unMetShDH[0]Xnumberend of each daySubhour tz excursion below/above setpoint, deg-hr
D.unMetShDH[1]Xnumberend of each daySubhour tz excursion below/above setpoint, deg-hr
D.unMetHrs[0]Xnumberend of each dayUnmet hours (accumulated subhourly, tz excursion > 0)
D.unMetHrs[1]Xnumberend of each dayUnmet hours (accumulated subhourly, tz excursion > 0)
D.unMetHrsTol[0]Xnumberend of each dayUnmet hours (accumulated subhourly, tz excursion > tp_unmettztol)
D.unMetHrsTol[1]Xnumberend of each dayUnmet hours (accumulated subhourly, tz excursion > tp_unmettztol)
D.qscHvacXnumberend of each dayZone accumulated hvac sensible cooling, btu (<=0) (oav not included)
D.qshHvacXnumberend of each dayZone accumulated hvac sensible heating, btu (>=0)
D.qcMechXnumberend of each dayZone accumulated total mechanical (sensible + latent) cooling (including hpwh heat extraction), btu (< 0)
D.qhMechXnumberend of each dayZone accumulated total mechanical (sensible + latent) heating (including hpwh heat extraction), btu (>0)
D.qvMechXnumberend of each dayZone accumulated mechanical (oav) total (sensible + latent) heat gains, btu (< 0)
D.litDmdXnumberend of each dayZone lighting demand and energy use, …
D.litEuXnumberend of each day… from gains, in addition to posting eu to meter, re daylighting for nrel. 9-94.
D.unMetMaxTD[0]Xnumberend of each dayMaximum tz excursion below/above setpoint, f
D.unMetMaxTD[1]Xnumberend of each dayMaximum tz excursion below/above setpoint, f
H.nHrHeatXinteger numberend of each hour# of hours in which any heating occurred; 1st “# of hours”
H.nHrCoolXinteger numberend of each hourDitto cooling
H.nHrFanvXinteger numberend of each hourDitto fan vent
H.nHrNatvXinteger numberend of each hourDitto natural vent
H.nHrCeilFanXinteger numberend of each hourDitto ceiling fan operation; last “# of hours”
H.tAirXnumberend of each hourZone air temp; must be 1st float, is first float to average (see cnguts.h)
H.tRadXnumberend of each hourZone radiant temp; meaningful iff convective/radiant model active for this zone
H.PMV7730Xnumberend of each hourIso7730 predicted mean vote = predicted comfort per ashrae thermal sensation scale
H.PPD7730Xnumberend of each hourIso7730 predicted percent dissatisfied = % of people not satisfied with conditions
H.ivAirXXnumberend of each hourZone air exchange rate not including hvac or ducts, ach
H.pz0Xnumberend of each hourZone air pressure relative to patm at nominal z=0, lbf/sf (from zn_pz0)
H.wAirXnumberend of each hourZone air humidity ratio; last float to average
H.qCondXnumberend of each hourZone wall conduction gain, btu; 1st heat flow and first float to sum
H.qsInfilXnumberend of each hourZone infiltration sensible gain, btu
H.qSlrXnumberend of each hourZone solar gain, btu
H.qsIgXnumberend of each hourZone internal sensible gain, btu
H.qMassXnumberend of each hourZone net sensible transfer from mass, btu. see qlair for moisture.
H.qsIzXnumberend of each hourInterzone gain to zone, btu
H.qsMechXnumberend of each hourZone total sensible mechanical heat gain, btu
H.eqfVentHrXnumberend of each hourEquivalent full vent hours = sum( zn_fvent)
H.qlInfilXnumberend of each hourZone infiltration latent gain, btu
H.qlIgXnumberend of each hourZone internal latent gain, btu
H.qlIzXnumberend of each hourZone izxfer latent gain (infil, vent, duct leakage)
H.qlAirXnumberend of each hourLatent heat of moisture removed from zone air: moisture analog of zncair.
H.qlMechXnumberend of each hourZone latent mechanical heat gain, btu; last heat flow and last float to sum
H.qsBalXnumberend of each hourSensible balance: sum of sensible heats, should be near 0. set in cnguts.cpp.
H.qlBalXnumberend of each hourLatent balance similarly. consider removing bals after development.
H.qlXXnumberend of each hourLatent gain rejected to prevent zone supersaturation === heat of condensation.
H.unMetHrDH[0]Xnumberend of each hourEnd-of-hour tz excursion below/above setpoint, deg-hr
H.unMetHrDH[1]Xnumberend of each hourEnd-of-hour tz excursion below/above setpoint, deg-hr
H.unMetShDH[0]Xnumberend of each hourSubhour tz excursion below/above setpoint, deg-hr
H.unMetShDH[1]Xnumberend of each hourSubhour tz excursion below/above setpoint, deg-hr
H.unMetHrs[0]Xnumberend of each hourUnmet hours (accumulated subhourly, tz excursion > 0)
H.unMetHrs[1]Xnumberend of each hourUnmet hours (accumulated subhourly, tz excursion > 0)
H.unMetHrsTol[0]Xnumberend of each hourUnmet hours (accumulated subhourly, tz excursion > tp_unmettztol)
H.unMetHrsTol[1]Xnumberend of each hourUnmet hours (accumulated subhourly, tz excursion > tp_unmettztol)
H.qscHvacXnumberend of each hourZone accumulated hvac sensible cooling, btu (<=0) (oav not included)
H.qshHvacXnumberend of each hourZone accumulated hvac sensible heating, btu (>=0)
H.qcMechXnumberend of each hourZone accumulated total mechanical (sensible + latent) cooling (including hpwh heat extraction), btu (< 0)
H.qhMechXnumberend of each hourZone accumulated total mechanical (sensible + latent) heating (including hpwh heat extraction), btu (>0)
H.qvMechXnumberend of each hourZone accumulated mechanical (oav) total (sensible + latent) heat gains, btu (< 0)
H.litDmdXnumberend of each hourZone lighting demand and energy use, …
H.litEuXnumberend of each hour… from gains, in addition to posting eu to meter, re daylighting for nrel. 9-94.
H.unMetMaxTD[0]Xnumberend of each hourMaximum tz excursion below/above setpoint, f
H.unMetMaxTD[1]Xnumberend of each hourMaximum tz excursion below/above setpoint, f
S.nHrHeatXinteger numberend of each subhour# of hours in which any heating occurred; 1st “# of hours”
S.nHrCoolXinteger numberend of each subhourDitto cooling
S.nHrFanvXinteger numberend of each subhourDitto fan vent
S.nHrNatvXinteger numberend of each subhourDitto natural vent
S.nHrCeilFanXinteger numberend of each subhourDitto ceiling fan operation; last “# of hours”
S.tAirXnumberend of each subhourZone air temp; must be 1st float, is first float to average (see cnguts.h)
S.tRadXnumberend of each subhourZone radiant temp; meaningful iff convective/radiant model active for this zone
S.PMV7730Xnumberend of each subhourIso7730 predicted mean vote = predicted comfort per ashrae thermal sensation scale
S.PPD7730Xnumberend of each subhourIso7730 predicted percent dissatisfied = % of people not satisfied with conditions
S.ivAirXXnumberend of each subhourZone air exchange rate not including hvac or ducts, ach
S.pz0Xnumberend of each subhourZone air pressure relative to patm at nominal z=0, lbf/sf (from zn_pz0)
S.wAirXnumberend of each subhourZone air humidity ratio; last float to average
S.qCondXnumberend of each subhourZone wall conduction gain, btu; 1st heat flow and first float to sum
S.qsInfilXnumberend of each subhourZone infiltration sensible gain, btu
S.qSlrXnumberend of each subhourZone solar gain, btu
S.qsIgXnumberend of each subhourZone internal sensible gain, btu
S.qMassXnumberend of each subhourZone net sensible transfer from mass, btu. see qlair for moisture.
S.qsIzXnumberend of each subhourInterzone gain to zone, btu
S.qsMechXnumberend of each subhourZone total sensible mechanical heat gain, btu
S.eqfVentHrXnumberend of each subhourEquivalent full vent hours = sum( zn_fvent)
S.qlInfilXnumberend of each subhourZone infiltration latent gain, btu
S.qlIgXnumberend of each subhourZone internal latent gain, btu
S.qlIzXnumberend of each subhourZone izxfer latent gain (infil, vent, duct leakage)
S.qlAirXnumberend of each subhourLatent heat of moisture removed from zone air: moisture analog of zncair.
S.qlMechXnumberend of each subhourZone latent mechanical heat gain, btu; last heat flow and last float to sum
S.qsBalXnumberend of each subhourSensible balance: sum of sensible heats, should be near 0. set in cnguts.cpp.
S.qlBalXnumberend of each subhourLatent balance similarly. consider removing bals after development.
S.qlXXnumberend of each subhourLatent gain rejected to prevent zone supersaturation === heat of condensation.
S.unMetHrDH[0]Xnumberend of each subhourEnd-of-hour tz excursion below/above setpoint, deg-hr
S.unMetHrDH[1]Xnumberend of each subhourEnd-of-hour tz excursion below/above setpoint, deg-hr
S.unMetShDH[0]Xnumberend of each subhourSubhour tz excursion below/above setpoint, deg-hr
S.unMetShDH[1]Xnumberend of each subhourSubhour tz excursion below/above setpoint, deg-hr
S.unMetHrs[0]Xnumberend of each subhourUnmet hours (accumulated subhourly, tz excursion > 0)
S.unMetHrs[1]Xnumberend of each subhourUnmet hours (accumulated subhourly, tz excursion > 0)
S.unMetHrsTol[0]Xnumberend of each subhourUnmet hours (accumulated subhourly, tz excursion > tp_unmettztol)
S.unMetHrsTol[1]Xnumberend of each subhourUnmet hours (accumulated subhourly, tz excursion > tp_unmettztol)
S.qscHvacXnumberend of each subhourZone accumulated hvac sensible cooling, btu (<=0) (oav not included)
S.qshHvacXnumberend of each subhourZone accumulated hvac sensible heating, btu (>=0)
S.qcMechXnumberend of each subhourZone accumulated total mechanical (sensible + latent) cooling (including hpwh heat extraction), btu (< 0)
S.qhMechXnumberend of each subhourZone accumulated total mechanical (sensible + latent) heating (including hpwh heat extraction), btu (>0)
S.qvMechXnumberend of each subhourZone accumulated mechanical (oav) total (sensible + latent) heat gains, btu (< 0)
S.litDmdXnumberend of each subhourZone lighting demand and energy use, …
S.litEuXnumberend of each subhour… from gains, in addition to posting eu to meter, re daylighting for nrel. 9-94.
S.unMetMaxTD[0]Xnumberend of each subhourMaximum tz excursion below/above setpoint, f
S.unMetMaxTD[1]Xnumberend of each subhourMaximum tz excursion below/above setpoint, f
prior.Y.nHrHeatXinteger numberrun start time (of each phase, autoSize or simulate)# of hours in which any heating occurred; 1st “# of hours”
prior.Y.nHrCoolXinteger numberrun start time (of each phase, autoSize or simulate)Ditto cooling
prior.Y.nHrFanvXinteger numberrun start time (of each phase, autoSize or simulate)Ditto fan vent
prior.Y.nHrNatvXinteger numberrun start time (of each phase, autoSize or simulate)Ditto natural vent
prior.Y.nHrCeilFanXinteger numberrun start time (of each phase, autoSize or simulate)Ditto ceiling fan operation; last “# of hours”
prior.Y.tAirXnumberrun start time (of each phase, autoSize or simulate)Zone air temp; must be 1st float, is first float to average (see cnguts.h)
prior.Y.tRadXnumberrun start time (of each phase, autoSize or simulate)Zone radiant temp; meaningful iff convective/radiant model active for this zone
prior.Y.PMV7730Xnumberrun start time (of each phase, autoSize or simulate)Iso7730 predicted mean vote = predicted comfort per ashrae thermal sensation scale
prior.Y.PPD7730Xnumberrun start time (of each phase, autoSize or simulate)Iso7730 predicted percent dissatisfied = % of people not satisfied with conditions
prior.Y.ivAirXXnumberrun start time (of each phase, autoSize or simulate)Zone air exchange rate not including hvac or ducts, ach
prior.Y.pz0Xnumberrun start time (of each phase, autoSize or simulate)Zone air pressure relative to patm at nominal z=0, lbf/sf (from zn_pz0)
prior.Y.wAirXnumberrun start time (of each phase, autoSize or simulate)Zone air humidity ratio; last float to average
prior.Y.qCondXnumberrun start time (of each phase, autoSize or simulate)Zone wall conduction gain, btu; 1st heat flow and first float to sum
prior.Y.qsInfilXnumberrun start time (of each phase, autoSize or simulate)Zone infiltration sensible gain, btu
prior.Y.qSlrXnumberrun start time (of each phase, autoSize or simulate)Zone solar gain, btu
prior.Y.qsIgXnumberrun start time (of each phase, autoSize or simulate)Zone internal sensible gain, btu
prior.Y.qMassXnumberrun start time (of each phase, autoSize or simulate)Zone net sensible transfer from mass, btu. see qlair for moisture.
prior.Y.qsIzXnumberrun start time (of each phase, autoSize or simulate)Interzone gain to zone, btu
prior.Y.qsMechXnumberrun start time (of each phase, autoSize or simulate)Zone total sensible mechanical heat gain, btu
prior.Y.eqfVentHrXnumberrun start time (of each phase, autoSize or simulate)Equivalent full vent hours = sum( zn_fvent)
prior.Y.qlInfilXnumberrun start time (of each phase, autoSize or simulate)Zone infiltration latent gain, btu
prior.Y.qlIgXnumberrun start time (of each phase, autoSize or simulate)Zone internal latent gain, btu
prior.Y.qlIzXnumberrun start time (of each phase, autoSize or simulate)Zone izxfer latent gain (infil, vent, duct leakage)
prior.Y.qlAirXnumberrun start time (of each phase, autoSize or simulate)Latent heat of moisture removed from zone air: moisture analog of zncair.
prior.Y.qlMechXnumberrun start time (of each phase, autoSize or simulate)Zone latent mechanical heat gain, btu; last heat flow and last float to sum
prior.Y.qsBalXnumberrun start time (of each phase, autoSize or simulate)Sensible balance: sum of sensible heats, should be near 0. set in cnguts.cpp.
prior.Y.qlBalXnumberrun start time (of each phase, autoSize or simulate)Latent balance similarly. consider removing bals after development.
prior.Y.qlXXnumberrun start time (of each phase, autoSize or simulate)Latent gain rejected to prevent zone supersaturation === heat of condensation.
prior.Y.unMetHrDH[0]Xnumberrun start time (of each phase, autoSize or simulate)End-of-hour tz excursion below/above setpoint, deg-hr
prior.Y.unMetHrDH[1]Xnumberrun start time (of each phase, autoSize or simulate)End-of-hour tz excursion below/above setpoint, deg-hr
prior.Y.unMetShDH[0]Xnumberrun start time (of each phase, autoSize or simulate)Subhour tz excursion below/above setpoint, deg-hr
prior.Y.unMetShDH[1]Xnumberrun start time (of each phase, autoSize or simulate)Subhour tz excursion below/above setpoint, deg-hr
prior.Y.unMetHrs[0]Xnumberrun start time (of each phase, autoSize or simulate)Unmet hours (accumulated subhourly, tz excursion > 0)
prior.Y.unMetHrs[1]Xnumberrun start time (of each phase, autoSize or simulate)Unmet hours (accumulated subhourly, tz excursion > 0)
prior.Y.unMetHrsTol[R numberrun start time (of each phase, autoSize or simulate)
prior.Y.unMetHrsTol[R numberrun start time (of each phase, autoSize or simulate)
prior.Y.qscHvacXnumberrun start time (of each phase, autoSize or simulate)Zone accumulated hvac sensible cooling, btu (<=0) (oav not included)
prior.Y.qshHvacXnumberrun start time (of each phase, autoSize or simulate)Zone accumulated hvac sensible heating, btu (>=0)
prior.Y.qcMechXnumberrun start time (of each phase, autoSize or simulate)Zone accumulated total mechanical (sensible + latent) cooling (including hpwh heat extraction), btu (< 0)
prior.Y.qhMechXnumberrun start time (of each phase, autoSize or simulate)Zone accumulated total mechanical (sensible + latent) heating (including hpwh heat extraction), btu (>0)
prior.Y.qvMechXnumberrun start time (of each phase, autoSize or simulate)Zone accumulated mechanical (oav) total (sensible + latent) heat gains, btu (< 0)
prior.Y.litDmdXnumberrun start time (of each phase, autoSize or simulate)Zone lighting demand and energy use, …
prior.Y.litEuXnumberrun start time (of each phase, autoSize or simulate)… from gains, in addition to posting eu to meter, re daylighting for nrel. 9-94.
prior.Y.unMetMaxTD[0R numberrun start time (of each phase, autoSize or simulate)
prior.Y.unMetMaxTD[1R numberrun start time (of each phase, autoSize or simulate)
prior.M.nHrHeatXinteger numbermonthly# of hours in which any heating occurred; 1st “# of hours”
prior.M.nHrCoolXinteger numbermonthlyDitto cooling
prior.M.nHrFanvXinteger numbermonthlyDitto fan vent
prior.M.nHrNatvXinteger numbermonthlyDitto natural vent
prior.M.nHrCeilFanXinteger numbermonthlyDitto ceiling fan operation; last “# of hours”
prior.M.tAirXnumbermonthlyZone air temp; must be 1st float, is first float to average (see cnguts.h)
prior.M.tRadXnumbermonthlyZone radiant temp; meaningful iff convective/radiant model active for this zone
prior.M.PMV7730XnumbermonthlyIso7730 predicted mean vote = predicted comfort per ashrae thermal sensation scale
prior.M.PPD7730XnumbermonthlyIso7730 predicted percent dissatisfied = % of people not satisfied with conditions
prior.M.ivAirXXnumbermonthlyZone air exchange rate not including hvac or ducts, ach
prior.M.pz0XnumbermonthlyZone air pressure relative to patm at nominal z=0, lbf/sf (from zn_pz0)
prior.M.wAirXnumbermonthlyZone air humidity ratio; last float to average
prior.M.qCondXnumbermonthlyZone wall conduction gain, btu; 1st heat flow and first float to sum
prior.M.qsInfilXnumbermonthlyZone infiltration sensible gain, btu
prior.M.qSlrXnumbermonthlyZone solar gain, btu
prior.M.qsIgXnumbermonthlyZone internal sensible gain, btu
prior.M.qMassXnumbermonthlyZone net sensible transfer from mass, btu. see qlair for moisture.
prior.M.qsIzXnumbermonthlyInterzone gain to zone, btu
prior.M.qsMechXnumbermonthlyZone total sensible mechanical heat gain, btu
prior.M.eqfVentHrXnumbermonthlyEquivalent full vent hours = sum( zn_fvent)
prior.M.qlInfilXnumbermonthlyZone infiltration latent gain, btu
prior.M.qlIgXnumbermonthlyZone internal latent gain, btu
prior.M.qlIzXnumbermonthlyZone izxfer latent gain (infil, vent, duct leakage)
prior.M.qlAirXnumbermonthlyLatent heat of moisture removed from zone air: moisture analog of zncair.
prior.M.qlMechXnumbermonthlyZone latent mechanical heat gain, btu; last heat flow and last float to sum
prior.M.qsBalXnumbermonthlySensible balance: sum of sensible heats, should be near 0. set in cnguts.cpp.
prior.M.qlBalXnumbermonthlyLatent balance similarly. consider removing bals after development.
prior.M.qlXXnumbermonthlyLatent gain rejected to prevent zone supersaturation === heat of condensation.
prior.M.unMetHrDH[0]XnumbermonthlyEnd-of-hour tz excursion below/above setpoint, deg-hr
prior.M.unMetHrDH[1]XnumbermonthlyEnd-of-hour tz excursion below/above setpoint, deg-hr
prior.M.unMetShDH[0]XnumbermonthlySubhour tz excursion below/above setpoint, deg-hr
prior.M.unMetShDH[1]XnumbermonthlySubhour tz excursion below/above setpoint, deg-hr
prior.M.unMetHrs[0]XnumbermonthlyUnmet hours (accumulated subhourly, tz excursion > 0)
prior.M.unMetHrs[1]XnumbermonthlyUnmet hours (accumulated subhourly, tz excursion > 0)
prior.M.unMetHrsTol[R numbermonthly
prior.M.unMetHrsTol[R numbermonthly
prior.M.qscHvacXnumbermonthlyZone accumulated hvac sensible cooling, btu (<=0) (oav not included)
prior.M.qshHvacXnumbermonthlyZone accumulated hvac sensible heating, btu (>=0)
prior.M.qcMechXnumbermonthlyZone accumulated total mechanical (sensible + latent) cooling (including hpwh heat extraction), btu (< 0)
prior.M.qhMechXnumbermonthlyZone accumulated total mechanical (sensible + latent) heating (including hpwh heat extraction), btu (>0)
prior.M.qvMechXnumbermonthlyZone accumulated mechanical (oav) total (sensible + latent) heat gains, btu (< 0)
prior.M.litDmdXnumbermonthlyZone lighting demand and energy use, …
prior.M.litEuXnumbermonthly… from gains, in addition to posting eu to meter, re daylighting for nrel. 9-94.
prior.M.unMetMaxTD[0R numbermonthly
prior.M.unMetMaxTD[1R numbermonthly
prior.D.nHrHeatXinteger numberdaily# of hours in which any heating occurred; 1st “# of hours”
prior.D.nHrCoolXinteger numberdailyDitto cooling
prior.D.nHrFanvXinteger numberdailyDitto fan vent
prior.D.nHrNatvXinteger numberdailyDitto natural vent
prior.D.nHrCeilFanXinteger numberdailyDitto ceiling fan operation; last “# of hours”
prior.D.tAirXnumberdailyZone air temp; must be 1st float, is first float to average (see cnguts.h)
prior.D.tRadXnumberdailyZone radiant temp; meaningful iff convective/radiant model active for this zone
prior.D.PMV7730XnumberdailyIso7730 predicted mean vote = predicted comfort per ashrae thermal sensation scale
prior.D.PPD7730XnumberdailyIso7730 predicted percent dissatisfied = % of people not satisfied with conditions
prior.D.ivAirXXnumberdailyZone air exchange rate not including hvac or ducts, ach
prior.D.pz0XnumberdailyZone air pressure relative to patm at nominal z=0, lbf/sf (from zn_pz0)
prior.D.wAirXnumberdailyZone air humidity ratio; last float to average
prior.D.qCondXnumberdailyZone wall conduction gain, btu; 1st heat flow and first float to sum
prior.D.qsInfilXnumberdailyZone infiltration sensible gain, btu
prior.D.qSlrXnumberdailyZone solar gain, btu
prior.D.qsIgXnumberdailyZone internal sensible gain, btu
prior.D.qMassXnumberdailyZone net sensible transfer from mass, btu. see qlair for moisture.
prior.D.qsIzXnumberdailyInterzone gain to zone, btu
prior.D.qsMechXnumberdailyZone total sensible mechanical heat gain, btu
prior.D.eqfVentHrXnumberdailyEquivalent full vent hours = sum( zn_fvent)
prior.D.qlInfilXnumberdailyZone infiltration latent gain, btu
prior.D.qlIgXnumberdailyZone internal latent gain, btu
prior.D.qlIzXnumberdailyZone izxfer latent gain (infil, vent, duct leakage)
prior.D.qlAirXnumberdailyLatent heat of moisture removed from zone air: moisture analog of zncair.
prior.D.qlMechXnumberdailyZone latent mechanical heat gain, btu; last heat flow and last float to sum
prior.D.qsBalXnumberdailySensible balance: sum of sensible heats, should be near 0. set in cnguts.cpp.
prior.D.qlBalXnumberdailyLatent balance similarly. consider removing bals after development.
prior.D.qlXXnumberdailyLatent gain rejected to prevent zone supersaturation === heat of condensation.
prior.D.unMetHrDH[0]XnumberdailyEnd-of-hour tz excursion below/above setpoint, deg-hr
prior.D.unMetHrDH[1]XnumberdailyEnd-of-hour tz excursion below/above setpoint, deg-hr
prior.D.unMetShDH[0]XnumberdailySubhour tz excursion below/above setpoint, deg-hr
prior.D.unMetShDH[1]XnumberdailySubhour tz excursion below/above setpoint, deg-hr
prior.D.unMetHrs[0]XnumberdailyUnmet hours (accumulated subhourly, tz excursion > 0)
prior.D.unMetHrs[1]XnumberdailyUnmet hours (accumulated subhourly, tz excursion > 0)
prior.D.unMetHrsTol[R numberdaily
prior.D.unMetHrsTol[R numberdaily
prior.D.qscHvacXnumberdailyZone accumulated hvac sensible cooling, btu (<=0) (oav not included)
prior.D.qshHvacXnumberdailyZone accumulated hvac sensible heating, btu (>=0)
prior.D.qcMechXnumberdailyZone accumulated total mechanical (sensible + latent) cooling (including hpwh heat extraction), btu (< 0)
prior.D.qhMechXnumberdailyZone accumulated total mechanical (sensible + latent) heating (including hpwh heat extraction), btu (>0)
prior.D.qvMechXnumberdailyZone accumulated mechanical (oav) total (sensible + latent) heat gains, btu (< 0)
prior.D.litDmdXnumberdailyZone lighting demand and energy use, …
prior.D.litEuXnumberdaily… from gains, in addition to posting eu to meter, re daylighting for nrel. 9-94.
prior.D.unMetMaxTD[0R numberdaily
prior.D.unMetMaxTD[1R numberdaily
prior.H.nHrHeatXinteger numberhourly# of hours in which any heating occurred; 1st “# of hours”
prior.H.nHrCoolXinteger numberhourlyDitto cooling
prior.H.nHrFanvXinteger numberhourlyDitto fan vent
prior.H.nHrNatvXinteger numberhourlyDitto natural vent
prior.H.nHrCeilFanXinteger numberhourlyDitto ceiling fan operation; last “# of hours”
prior.H.tAirXnumberhourlyZone air temp; must be 1st float, is first float to average (see cnguts.h)
prior.H.tRadXnumberhourlyZone radiant temp; meaningful iff convective/radiant model active for this zone
prior.H.PMV7730XnumberhourlyIso7730 predicted mean vote = predicted comfort per ashrae thermal sensation scale
prior.H.PPD7730XnumberhourlyIso7730 predicted percent dissatisfied = % of people not satisfied with conditions
prior.H.ivAirXXnumberhourlyZone air exchange rate not including hvac or ducts, ach
prior.H.pz0XnumberhourlyZone air pressure relative to patm at nominal z=0, lbf/sf (from zn_pz0)
prior.H.wAirXnumberhourlyZone air humidity ratio; last float to average
prior.H.qCondXnumberhourlyZone wall conduction gain, btu; 1st heat flow and first float to sum
prior.H.qsInfilXnumberhourlyZone infiltration sensible gain, btu
prior.H.qSlrXnumberhourlyZone solar gain, btu
prior.H.qsIgXnumberhourlyZone internal sensible gain, btu
prior.H.qMassXnumberhourlyZone net sensible transfer from mass, btu. see qlair for moisture.
prior.H.qsIzXnumberhourlyInterzone gain to zone, btu
prior.H.qsMechXnumberhourlyZone total sensible mechanical heat gain, btu
prior.H.eqfVentHrXnumberhourlyEquivalent full vent hours = sum( zn_fvent)
prior.H.qlInfilXnumberhourlyZone infiltration latent gain, btu
prior.H.qlIgXnumberhourlyZone internal latent gain, btu
prior.H.qlIzXnumberhourlyZone izxfer latent gain (infil, vent, duct leakage)
prior.H.qlAirXnumberhourlyLatent heat of moisture removed from zone air: moisture analog of zncair.
prior.H.qlMechXnumberhourlyZone latent mechanical heat gain, btu; last heat flow and last float to sum
prior.H.qsBalXnumberhourlySensible balance: sum of sensible heats, should be near 0. set in cnguts.cpp.
prior.H.qlBalXnumberhourlyLatent balance similarly. consider removing bals after development.
prior.H.qlXXnumberhourlyLatent gain rejected to prevent zone supersaturation === heat of condensation.
prior.H.unMetHrDH[0]XnumberhourlyEnd-of-hour tz excursion below/above setpoint, deg-hr
prior.H.unMetHrDH[1]XnumberhourlyEnd-of-hour tz excursion below/above setpoint, deg-hr
prior.H.unMetShDH[0]XnumberhourlySubhour tz excursion below/above setpoint, deg-hr
prior.H.unMetShDH[1]XnumberhourlySubhour tz excursion below/above setpoint, deg-hr
prior.H.unMetHrs[0]XnumberhourlyUnmet hours (accumulated subhourly, tz excursion > 0)
prior.H.unMetHrs[1]XnumberhourlyUnmet hours (accumulated subhourly, tz excursion > 0)
prior.H.unMetHrsTol[R numberhourly
prior.H.unMetHrsTol[R numberhourly
prior.H.qscHvacXnumberhourlyZone accumulated hvac sensible cooling, btu (<=0) (oav not included)
prior.H.qshHvacXnumberhourlyZone accumulated hvac sensible heating, btu (>=0)
prior.H.qcMechXnumberhourlyZone accumulated total mechanical (sensible + latent) cooling (including hpwh heat extraction), btu (< 0)
prior.H.qhMechXnumberhourlyZone accumulated total mechanical (sensible + latent) heating (including hpwh heat extraction), btu (>0)
prior.H.qvMechXnumberhourlyZone accumulated mechanical (oav) total (sensible + latent) heat gains, btu (< 0)
prior.H.litDmdXnumberhourlyZone lighting demand and energy use, …
prior.H.litEuXnumberhourly… from gains, in addition to posting eu to meter, re daylighting for nrel. 9-94.
prior.H.unMetMaxTD[0R numberhourly
prior.H.unMetMaxTD[1R numberhourly
prior.S.nHrHeatXinteger numbersubhourly# of hours in which any heating occurred; 1st “# of hours”
prior.S.nHrCoolXinteger numbersubhourlyDitto cooling
prior.S.nHrFanvXinteger numbersubhourlyDitto fan vent
prior.S.nHrNatvXinteger numbersubhourlyDitto natural vent
prior.S.nHrCeilFanXinteger numbersubhourlyDitto ceiling fan operation; last “# of hours”
prior.S.tAirXnumbersubhourlyZone air temp; must be 1st float, is first float to average (see cnguts.h)
prior.S.tRadXnumbersubhourlyZone radiant temp; meaningful iff convective/radiant model active for this zone
prior.S.PMV7730XnumbersubhourlyIso7730 predicted mean vote = predicted comfort per ashrae thermal sensation scale
prior.S.PPD7730XnumbersubhourlyIso7730 predicted percent dissatisfied = % of people not satisfied with conditions
prior.S.ivAirXXnumbersubhourlyZone air exchange rate not including hvac or ducts, ach
prior.S.pz0XnumbersubhourlyZone air pressure relative to patm at nominal z=0, lbf/sf (from zn_pz0)
prior.S.wAirXnumbersubhourlyZone air humidity ratio; last float to average
prior.S.qCondXnumbersubhourlyZone wall conduction gain, btu; 1st heat flow and first float to sum
prior.S.qsInfilXnumbersubhourlyZone infiltration sensible gain, btu
prior.S.qSlrXnumbersubhourlyZone solar gain, btu
prior.S.qsIgXnumbersubhourlyZone internal sensible gain, btu
prior.S.qMassXnumbersubhourlyZone net sensible transfer from mass, btu. see qlair for moisture.
prior.S.qsIzXnumbersubhourlyInterzone gain to zone, btu
prior.S.qsMechXnumbersubhourlyZone total sensible mechanical heat gain, btu
prior.S.eqfVentHrXnumbersubhourlyEquivalent full vent hours = sum( zn_fvent)
prior.S.qlInfilXnumbersubhourlyZone infiltration latent gain, btu
prior.S.qlIgXnumbersubhourlyZone internal latent gain, btu
prior.S.qlIzXnumbersubhourlyZone izxfer latent gain (infil, vent, duct leakage)
prior.S.qlAirXnumbersubhourlyLatent heat of moisture removed from zone air: moisture analog of zncair.
prior.S.qlMechXnumbersubhourlyZone latent mechanical heat gain, btu; last heat flow and last float to sum
prior.S.qsBalXnumbersubhourlySensible balance: sum of sensible heats, should be near 0. set in cnguts.cpp.
prior.S.qlBalXnumbersubhourlyLatent balance similarly. consider removing bals after development.
prior.S.qlXXnumbersubhourlyLatent gain rejected to prevent zone supersaturation === heat of condensation.
prior.S.unMetHrDH[0]XnumbersubhourlyEnd-of-hour tz excursion below/above setpoint, deg-hr
prior.S.unMetHrDH[1]XnumbersubhourlyEnd-of-hour tz excursion below/above setpoint, deg-hr
prior.S.unMetShDH[0]XnumbersubhourlySubhour tz excursion below/above setpoint, deg-hr
prior.S.unMetShDH[1]XnumbersubhourlySubhour tz excursion below/above setpoint, deg-hr
prior.S.unMetHrs[0]XnumbersubhourlyUnmet hours (accumulated subhourly, tz excursion > 0)
prior.S.unMetHrs[1]XnumbersubhourlyUnmet hours (accumulated subhourly, tz excursion > 0)
prior.S.unMetHrsTol[R numbersubhourly
prior.S.unMetHrsTol[R numbersubhourly
prior.S.qscHvacXnumbersubhourlyZone accumulated hvac sensible cooling, btu (<=0) (oav not included)
prior.S.qshHvacXnumbersubhourlyZone accumulated hvac sensible heating, btu (>=0)
prior.S.qcMechXnumbersubhourlyZone accumulated total mechanical (sensible + latent) cooling (including hpwh heat extraction), btu (< 0)
prior.S.qhMechXnumbersubhourlyZone accumulated total mechanical (sensible + latent) heating (including hpwh heat extraction), btu (>0)
prior.S.qvMechXnumbersubhourlyZone accumulated mechanical (oav) total (sensible + latent) heat gains, btu (< 0)
prior.S.litDmdXnumbersubhourlyZone lighting demand and energy use, …
prior.S.litEuXnumbersubhourly… from gains, in addition to posting eu to meter, re daylighting for nrel. 9-94.
prior.S.unMetMaxTD[0R numbersubhourly
prior.S.unMetMaxTD[1R numbersubhourly

6.70 zone

@zone[1..].

NameInput?Runtime?TypeVariabilityDescription
nameXXstringconstant
znModelXXinteger numberinput time
znAreaXXnumberinput time
znVolXXnumberinput time
floorZXXnumberinput time
ceilingHtXXnumberrun start time (of each phase, autoSize or simulate)
znCAirXXnumberinput time
HIRatioXXnumberrun start time (of each phase, autoSize or simulate)
znAzmXXnumberinput time
plenumRetXXinteger numberinput time
znSCXXnumberhourly
znTHXXnumbersubhourly
znTDXXnumbersubhourly
znTCXXnumbersubhourly
znQMxHXXnumberhourly
znQMxHRatedXXnumberrun start time (of each phase, autoSize or simulate)
znQMxCXXnumberhourly
znQMxCRatedXXnumberrun start time (of each phase, autoSize or simulate)
loadMtriXXinteger numberrun start time (of each phase, autoSize or simulate)
rsiXXinteger numberrun start time (of each phase, autoSize or simulate)
hcFrcFXXnumberhourly
hcAirXXXnumberend of each subhour
xfanFOnXXnumberhourly
xfan.fanTyXXunrecognizedautosize and simulate phase start time
xfan.vfDsXXnumberend of each subhour
xfan.vfDs_AsXXnumberautosize and simulate phase start time
xfan.vfDs_AsNovXXnumberautosize and simulate phase start time
xfan.vfMxFXXnumberautosize and simulate phase start time
xfan.pressXXnumberrun start time (of each phase, autoSize or simulate)
xfan.effXXnumberrun start time (of each phase, autoSize or simulate)
xfan.shaftPwrXXnumberrun start time (of each phase, autoSize or simulate)
xfan.elecPwrXXnumberrun start time (of each phase, autoSize or simulate)
xfan.motTyXXunrecognizedrun start time (of each phase, autoSize or simulate)
xfan.motEffXXnumberautosize and simulate phase start time
xfan.motPosXXunrecognizedautosize and simulate phase start time
xfan.curvePy.k[0]XXnumberautosize and simulate phase start time
xfan.curvePy.k[1]XXnumberautosize and simulate phase start time
xfan.curvePy.k[2]XXnumberautosize and simulate phase start time
xfan.curvePy.k[3]XXnumberautosize and simulate phase start time
xfan.curvePy.k[4]XXnumberautosize and simulate phase start time
xfan.curvePy.k[5]XXnumberautosize and simulate phase start time
xfan.mtriXXinteger numberinput time
xfan.endUseXXinteger numberautosize and simulate phase start time
xfan.auszXXinteger numberrun start time (of each phase, autoSize or simulate)
xfan.outPowerXXnumbersubhourly
xfan.airPowerXXnumbersubhourly
xfan.cMxXXnumberend of each subhour
xfan.cXXnumberend of each subhour
xfan.tXXnumberend of each subhour
xfan.frOnXXnumberend of each subhour
xfan.pXXnumberend of each subhour
xfan.qXXnumberend of each subhour
xfan.dTXXnumberend of each subhour
xfan.qAroundXXnumberend of each subhour
infACXXnumberhourly
infELAXXnumberhourly
infShldXXinteger numberinput time
infStoriesXXinteger numberinput time
eaveZXXnumberrun start time (of each phase, autoSize or simulate)
windFLkgXXnumbersubhourly
afMtriXXinteger numberrun start time (of each phase, autoSize or simulate)
xsurf1Xinteger numberrun start time (of each phase, autoSize or simulate)Chain head (xsrat subscr) of zone’s xsurfs: surface/window/perim/masswall info. next: xsrat.nxxsurf.
xsSpecT1Xinteger numberrun start time (of each phase, autoSize or simulate)0 or chain head of zn’s xsurfs with .sfexcnd==c_excndch_spect: used hourly. next: xsrat.nxxsspect.
tu1Xinteger numberrun start time (of each phase, autoSize or simulate)Head of chain of zone’s terminals: 0 or tub subscript. next: tu.nxtu.
zhx1Xinteger numberrun start time (of each phase, autoSize or simulate)Chain head of zone’s zhx’s (zone hvac xfers): 0 or zhxb subscript. next: zhx.nxzhx4z.
zhx1StXinteger numberrun start time (of each phase, autoSize or simulate)… zone’s cmstxx (tstat-ctrl’d) zhx’s. next: zhx.nxzhzst4z.
airTerminalCountXinteger numberrun start time (of each phase, autoSize or simulate)# of terminals serving this zone that can supply air
anPathLenToAmbientXinteger numberrun start time (of each phase, autoSize or simulate)Zone shortest path length to ambient pressure
anVentCount[0]Xinteger numberrun start time (of each phase, autoSize or simulate)Count of airnet vents connected to this zone
anVentCount[1]Xinteger numberrun start time (of each phase, autoSize or simulate)Count of airnet vents connected to this zone
anVentCount[2]Xinteger numberrun start time (of each phase, autoSize or simulate)Count of airnet vents connected to this zone
znSCFXinteger numberrun start time (of each phase, autoSize or simulate)Non-0 if i.znsc given by user; 0 to default shade closure in cnloads.cpp
stackcXnumberrun start time (of each phase, autoSize or simulate)Stack coefficient for zone height (sherman-grimsrud model)
windcXnumberrun start time (of each phase, autoSize or simulate)Wind coefficient for zone height and shielding (sherman-grimsrud model)
rIgDistNAlXinteger numberrun start time (of each phase, autoSize or simulate)0 or number of allocated entries in…
rIgDistNXinteger numberrun start time (of each phase, autoSize or simulate)0 or number of used entries in…
rIgDistXunrecognizedrun start time (of each phase, autoSize or simulate)Null or ptr to heap array of distrubution info for rad int gain originating in zone.
surfAXnumberrun start time (of each phase, autoSize or simulate)Total surface area in zone, ft2 (surfaces, doors, windows, ducts)
surfASlrXnumberrun start time (of each phase, autoSize or simulate)Total “short wave” surface area in zone, ft2
ductAXnumberrun start time (of each phase, autoSize or simulate)Total duct surface area in zone, ft2 (included in zn_surfa)
surfEpsLWAvgXnumberrun start time (of each phase, autoSize or simulate)Area-weighted surface lw emissivity = sum( surfarea * surfepslw) / zn_surfa
airRadXC1Xnumberrun start time (of each phase, autoSize or simulate)Constants re zn_airradxarea calc
airRadXC2Xnumberrun start time (of each phase, autoSize or simulate)
airRadXAreaXnumberrun start time (of each phase, autoSize or simulate)Area of air “surface”, ft2
FAirXnumberrun start time (of each phase, autoSize or simulate)Air f “view factor” (constant during simulation)
airCxFXnumberend of each hourAir factor for zn_cxsh re lw exchange
airCxXnumberend of each subhourAir contribution to zn_cxsh, btuh/f
rmTrans[0]Xnumberend of each hour on 1st day of month/runArea-weighted summed diffuse transmissivity of windows in zone,
rmTrans[1]Xnumberend of each hour on 1st day of month/runArea-weighted summed diffuse transmissivity of windows in zone,
rmAbsXnumberend of each hour on 1st day of month/runSum of area-weighted solar (sw) absorptivity for opaque room surfaces (dimensionless).
adjRmAbs[0]Xnumberend of each hour on 1st day of month/runRmabs adjusted for reflected energy that goes out windows (m-h):
adjRmAbs[1]Xnumberend of each hour on 1st day of month/runRmabs adjusted for reflected energy that goes out windows (m-h):
rmAbsCAirXnumberend of each hour on 1st day of month/runSum of area-weighted absorptivity for non-massive room surfaces
cavAbsCAir[0]Xnumberend of each hour on 1st day of month/runZone cair cavity absorptance === portion insolation to no particular surface
cavAbsCAir[1]Xnumberend of each hour on 1st day of month/runZone cair cavity absorptance === portion insolation to no particular surface
sgfCavBm[0]Xnumberend of each hour on 1st day of month/runZone’s solar gain factors from its windows not explicitly targeted for hour,
sgfCavBm[1]Xnumberend of each hour on 1st day of month/runZone’s solar gain factors from its windows not explicitly targeted for hour,
sgfCavDf[0]Xnumberend of each hour on 1st day of month/run.. to be distributed amoung surface and cair sgr entries after accumulation.
sgfCavDf[1]Xnumberend of each hour on 1st day of month/run.. to be distributed amoung surface and cair sgr entries after accumulation.
sgSaBm[0]Xnumberend of each hour on 1st day of month/runCair adjustments to above for gains getting to other side of (quick) surface or
sgSaBm[1]Xnumberend of each hour on 1st day of month/runCair adjustments to above for gains getting to other side of (quick) surface or
sgSaDf[0]Xnumberend of each hour on 1st day of month/run.. lost to outdoors due to surface film vs conductance thru (quick) surface
sgSaDf[1]Xnumberend of each hour on 1st day of month/run.. lost to outdoors due to surface film vs conductance thru (quick) surface
sgfCAirBm[0]Xnumberend of each hour on 1st day of month/runBeam solar gain factor this hour to zone cair
sgfCAirBm[1]Xnumberend of each hour on 1st day of month/runBeam solar gain factor this hour to zone cair
sgfCAirDf[0]Xnumberend of each hour on 1st day of month/runDiffuse .. these are multipliers for wthr data, later, via sgr
sgfCAirDf[1]Xnumberend of each hour on 1st day of month/runDiffuse .. these are multipliers for wthr data, later, via sgr
uaSpecTXnumberrun start time (of each phase, autoSize or simulate)Ua to specified temps (excnd=spect surfaces), for zn_bcon. set/used only in cnguts.cpp.
uaXnumberrun start time (of each phase, autoSize or simulate)Overall loss to ambient (sum uval*area), constant for run, for zn_bcon and zn_aqldhr. btuh/f.
UANomXnumberrun start time (of each phase, autoSize or simulate)Ua to ambient based on surface unom (derived with default surf conductances), btuh/f
ductCondUANomXnumberrun start time (of each phase, autoSize or simulate)Nominal total ua of ducts in zone, btuh/f (due to conduction, not air leakage)
haMassXnumberrun start time (of each phase, autoSize or simulate)Total ha (surf conductance * area) to mass (btuh/f)
BGWallPerimXnumberrun start time (of each phase, autoSize or simulate)Total below grade wall perimeter, ft
BGWallPA4Xnumberrun start time (of each phase, autoSize or simulate)Sum (perim*a4)
BGWallPA5Xnumberrun start time (of each phase, autoSize or simulate)Sum (perim*a5)
qSgTotXnumberend of each hourHour total solar gain to some
sgTotTarg.bmXnumberend of each subhour
sgTotTarg.dfXnumberend of each subhour
sgTotTarg.totXnumberend of each subhour
qrIgTotXunrecognizedend of each hourTotal originating in this zone: redundant total for energy balance check only.
qrIgTotOXunrecognizedend of each hourSubtotal lost to outdoors thru light surfaces, to show in zeb rpt as -cond.
qrIgTotIzXunrecognizedend of each hourNet subtotal to other zones thru light surfaces, to show in zeb rpt as -izone.
qrIgAirXunrecognizedend of each hourRad int gain to this zone’s cair (for light surfaces/windows), for zn_aqldhr. 11-95.
qrIgMsXnumberend of each hourRad int gain to mass sides in this zone, for energy balance, set in cnloads. 11-95.
znSGainXnumberend of each hour
znLGainXnumberend of each hour
znLitDmdXnumberend of each hour
znLitEuXnumberend of each hour
znXLGainXnumberend of each subhour
znXLGainLsXnumberend of each subhour
bconXnumberrun start time (of each phase, autoSize or simulate)Portion of b constant for run: ua + uaspect. setup time.
qMsSgXnumberend of each subhour
qSgAirXnumberend of each subhourSubhour’s solar gain rate (btuh) to air
sgAirTarg.bmXnumberend of each subhour
sgAirTarg.dfXnumberend of each subhour
sgAirTarg.totXnumberend of each subhour
qSgTotShXnumberend of each subhour
sgTotShTarg.bmXnumberend of each subhour
sgTotShTarg.dfXnumberend of each subhour
sgTotShTarg.totXnumberend of each subhour
qIzXAnShXnumberend of each subhourSubhourly gain due to non-airnet izxfers (btuh, +=into zone)
qIzShXnumberend of each subhourSubhourly part of interzone gain rate (btuh, +=into zone)
pz0W[0]Xnumberend of each subhourWorking zone pressures relative to patm at nominal z=0, lbf/sf
pz0W[1]Xnumberend of each subhourWorking zone pressures relative to patm at nominal z=0, lbf/sf
pz0Xnumberend of each subhourFinal zone pressure relative to patm at nominal z=0, lbf/sf
ventUtXinteger numberend of each subhourVent utility for this substep
qDuctCondAirXnumberend of each subhourTo ta (convection)
qDuctCondRadXnumberend of each subhourTo tr (radiation)
qDuctCondXnumberend of each subhourSum from last step (else energy balance trouble)
qDHWLossAirXnumberend of each subhourTo ta (convection)
qDHWLossRadXnumberend of each subhourTo tr (radiation)
qDHWLossXnumberend of each subhourSum
qHPWHXnumberend of each subhourHeat extracted from zone by heat pump dhwheater(s)
hpwhAirXXnumberend of each subhourApproximate zone air change rate due to
anVentEffectXinteger numberend of each hour# of izxrats that could impact airnet
airNetI[0].tdbXnumberend of each subhour
airNetI[0].wXnumberend of each subhour
airNetI[0].amfXnumberend of each subhour
airNetI[1].tdbXnumberend of each subhour
airNetI[1].wXnumberend of each subhour
airNetI[1].amfXnumberend of each subhour
fVentPrfXnumberend of each subhourPreferred vent fraction for this zone in isolation
tzVentXnumberend of each subhourZone air temp with full vent, f (debug aid)
fVentXnumberend of each subhourVent fraction actual; venting used to hold zone at zn_tzspd
anAmfCpVentXnumberend of each subhourVent flow (in excess of zn_airneti[ 0]), btuh/f
anAmfCpTVentXnumberend of each subhourVent flow*temp (in excess of zn_airneti[ 0]), btuh
ductLkI.tdbXnumberend of each subhour
ductLkI.wXnumberend of each subhour
ductLkI.amfXnumberend of each subhour
ductLkO.tdbXnumberend of each subhour
ductLkO.wXnumberend of each subhour
ductLkO.amfXnumberend of each subhour
sysAirI.tdbXnumberend of each subhour
sysAirI.wXnumberend of each subhour
sysAirI.amfXnumberend of each subhour
sysAirO.tdbXnumberend of each subhour
sysAirO.wXnumberend of each subhour
sysAirO.amfXnumberend of each subhour
OAVRlfO.tdbXnumberend of each subhour
OAVRlfO.wXnumberend of each subhour
OAVRlfO.amfXnumberend of each subhour
sysDepAirIls.tdbXnumberend of each subhour
sysDepAirIls.wXnumberend of each subhour
sysDepAirIls.amfXnumberend of each subhour
qCondQSXnumberend of each subhourTotal quick surface conduction, btuh (+ = into zone)
qCondMSXnumberend of each subhourTotal mass exterior surface conduction, btuh (+ = into zone)
rsAmfSysReq[0]Xnumberend of each subhourRequested rsys air mass flow (at system) to hold current step set point, lbm/hr
rsAmfSysReq[1]Xnumberend of each subhourRequested rsys air mass flow (at system) to hold current step set point, lbm/hr
rsFSizeXnumberend of each subhourFraction of requested air that rsys could provide
rsAmfSupXnumberend of each subhourFinal rsys supply air mass flow (at register, +=in), lbm/hr
rsAmfRetXnumberend of each subhourFinal rsys return air mass flow (out of zone at grille, +=out), lbm/hr
rsAmfRetLsXnumbersubhourlyLast step zn_rsamfret (+ = out)
tzspXnumberend of each subhourCurrent step controlling set point, f
tzspHXnumberend of each subhourCurrent step heating set point, f
tzspDXnumberend of each subhourCurrent step desired temp set point, f
tzspCXnumberend of each subhourCurrent step cooling set point, f
tzspHlhXnumberhourlyEnd-of-last-hour heating set point (re autosize setpoint ramping), f
tzspDlhXnumberhourlyEnd-of-last-hour desired temp set point (re autosize setpoint ramping), f
tzspClhXnumberhourlyEnd-of-last-hour cooling set point (re autosize setpoint ramping), f
hcModeXinteger numberend of each subhourHeating / cooling mode required per set point (rsmheat, rsmcool, )
fConvHXnumbersubhourlyHeating
fConvCXnumbersubhourlyCooling
fConvXnumbersubhourlyCurrent step
qsHvacXnumberend of each subhourSubhour total (sensible) power of all hvac, btuh
qlHvacXnumberend of each subhourSubhour total latent power (btuh) (moisture * 1061) likewise
qlIzXnumberend of each subhourLatent gain from izxfer sources (infil, vent, and duct leakage), btuh
rhoXnumberend of each subhourZone moist air density at nominal w=tp_refw, lb/cf
rho0lsXnumbersubhourlyPrior step zone moist air density at nominal z=0, lb/cf; computed from tzls and zn_pz0[ 0]
dryAirMassXnumberend of each subhourTotal mass of dry air in zone, lbm
dryAirMassEffXnumberend of each subhourEffective dry air mass in zone, lbm
ivAirXXnumberend of each subhourZone infiltration/ventilation air change rate (changes/hr)
airXXnumberend of each subhourOverall zone air change rate (changes/hr)
hcAirXlsXnumbersubhourlyPrior subhour value of i.zn_hcairx
hcFrcXnumbersubhourlyInside surface forced convection coefficient, btuh/ft2-f
windPresVXnumbersubhourlyWind velocity pressure, lbf/ft2
tzXnumberend of each subhour
aTzXnumberend of each subhour
wzXnumberend of each subhour
relHumXnumberend of each subhourZone relative humidity, 0 - 1
relHumlsXnumbersubhourlyZone relative humidity, end last subhour, 0 - 1
relHumlhXnumberhourlyZone relative humidity, end last hour, 0 - 1
twbXnumberend of each subhourZone wet bulb temp, f
aWzXnumberend of each subhour
tzlsXnumbersubhourly
wzlsXnumbersubhourly
tzlhXnumberhourly
tzlsDeltaXnumberconstant
wzlsDeltaXnumberconstant
trXnumberend of each subhour
trlsXnumberend of each subhour
trlhXnumberhourly
mdXinteger numberend of each subhourCurrent hvac mode: subscript of mdseq