Skip to content

Commit bc612b3

Browse files
nealkruisnealkruis
authored
Fix system variables documenation.
1 parent 26543fe commit bc612b3

File tree

1 file changed

+64
-45
lines changed

1 file changed

+64
-45
lines changed

‎doc/src/input-structure.md‎

Lines changed: 64 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -887,63 +887,82 @@ For *strings*, *object names*, and *choices*, the CSE input language currently h
887887

888888
*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](#input-data) gives the *variability*, or maximum acceptable variation, for each object member.)
889889

890-
-------------- ---------------------------------------------------------
891-
\$dayOfYear Day of year of simulation, 1 - 365; 1 corresponds to
892-
Jan-1. (Note that this is not the day of the simulation
893-
unless begDay is Jan-1.) **Variation:** daily.
894-
895-
\$month Month of year, 1 - 12. **Variation**: monthly.
896-
897-
\$dayOfMonth Day of month, 1 - 31. **Variation**: daily.
898-
899-
\$hour Hour of day, 1 - 24; 1 corresponds to midnight - 1 AM.
900-
**Variation**: hourly.
901-
902-
\$dayOfWeek Day of week, 1 - 7; 1 corresponds to Sunday, 2 to Monday,
903-
etc. **Variation:** daily.
904-
905-
\$DOWH Day of week 1-7 except 8 on every observed holiday.
906-
**Variation**: daily.
907-
908-
\$isHoliday 1 on days that a holiday is observed (regardless of the
909-
true date of the holiday); 0 on other days.
910-
**Variation**: daily.
911-
912-
\$isHoliTrue 1 on days that are the true date of a holiday, otherwise
913-
0. **Variation**: daily.
914-
915-
\$isWeHol 1 on weekend days or days that are observed as holidays.
916-
**Variation:** daily.
917-
918-
\$isWeekend 1 on Saturday and Sunday, 0 on any day from Monday to
919-
Friday. **Variation:** daily.
920-
921-
\$isWeekday 1 on Monday through Friday, 0 on Saturday and Sunday.
922-
**Variation:** daily.
923-
924-
\$isBegWeek 1 for any day immediately following a weekend day or
925-
observed holiday that is neither a weekend day or an
926-
observed holiday. **Variation:** daily.
927-
-------------- ---------------------------------------------------------
890+
---------------- ---------------------------------------------------------
891+
\$dayOfYear Day of year of simulation, 1 - 365; 1 corresponds to
892+
Jan-1. (Note that this is not the day of the simulation
893+
unless begDay is Jan-1.) **Variation:** daily.
894+
895+
\$month Month of year, 1 - 12. **Variation**: monthly.
896+
897+
\$dayOfMonth Day of month, 1 - 31. **Variation**: daily.
898+
899+
\$hour Hour of day, 1 - 24; 1 corresponds to midnight - 1 AM.
900+
**Variation**: hourly.
901+
902+
\$dayOfWeek Day of week, 1 - 7; 1 corresponds to Sunday, 2 to Monday,
903+
etc. **Variation:** daily.
904+
905+
\$DOWH Day of week 1-7 except 8 on every observed holiday.
906+
**Variation**: daily.
907+
908+
\$isHoliday 1 on days that a holiday is observed (regardless of the
909+
true date of the holiday); 0 on other days.
910+
**Variation**: daily.
911+
912+
\$isHoliTrue 1 on days that are the true date of a holiday, otherwise
913+
0. **Variation**: daily.
914+
915+
\$isWeHol 1 on weekend days or days that are observed as holidays.
916+
**Variation:** daily.
917+
918+
\$isWeekend 1 on Saturday and Sunday, 0 on any day from Monday to
919+
Friday. **Variation:** daily.
920+
921+
\$isWeekday 1 on Monday through Friday, 0 on Saturday and Sunday.
922+
**Variation:** daily.
923+
924+
\$isBegWeek 1 for any day immediately following a weekend day or
925+
observed holiday that is neither a weekend day or an
926+
observed holiday. **Variation:** daily.
927+
928+
\$isWorkDay 1 on non-holiday Monday through Friday, 0 on holidays,
929+
Saturday and Sunday. **Variation:** daily.
930+
931+
\$isNonWorkDay 1 on Saturday, Sunday and observed holidays, 0 on
932+
non-holiday Monday through Friday. **Variation:**
933+
daily.
934+
935+
\$isBegWorkWeek 1 on the first workday after a non-workday, 0 all
936+
other days. **Variation:** daily.
937+
938+
\$isDT 1 if Daylight Saving time is in effect, 0 otherwise.
939+
**Variation:** hourly.
940+
941+
\$autoSizing 1 during autosizing calculations, 0 during main
942+
simulation. **Variation:** for each phase.
943+
\$dsDay Design day type, 0 during main simulation, 1 during
944+
heating autosize, 2 during cool autosize.
945+
**Variation:** daily.
946+
---------------- ---------------------------------------------------------
928947

929948
**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.
930949

931950
----------------- ------------------------------------------------------
932-
\$radBeamSolar beam irradiance (on a sun-tracking surface) this hour
951+
\$radBeam Solar beam irradiance (on a sun-tracking surface) this hour
933952
(Btu/ft2)
934953

935-
\$radDiffSolar diffuse irradiance (on horizontal surface) this hour
954+
\$radDiff Solar diffuse irradiance (on horizontal surface) this hour
936955
(Btu/ft2)
937956

938-
\$tDbOOutdoor drybulb temperature this hour (degrees F)
957+
\$tDbO Outdoor drybulb temperature this hour (degrees F)
939958

940-
\$tWbOOutdoor wetbulb temperature this hour (degrees F)
959+
\$tWbO Outdoor wetbulb temperature this hour (degrees F)
941960

942-
\$wOOutdoor humidity ratio this hour (lb H2O/lb dry air)
961+
\$wO Outdoor humidity ratio this hour (lb H2O/lb dry air)
943962

944-
\$windDirDegWind direction (compass degrees)
963+
\$windDirDeg Wind direction (compass degrees)
945964

946-
\$windSpeedWind speed (mph)
965+
\$windSpeed Wind speed (mph)
947966
----------------- ------------------------------------------------------
948967

949968
### Built-in Functions

0 commit comments

Comments
 (0)