Internal program variables in thresh.f90

[Math symbols are explained at the end of the table]
Variable NameTypeExplanation
INTEGER
AWICompOffset Integer Offset used to shift location in computing AWI
AWIExceedCtr Integer Counter for exceedance of antecedent water index threshold
AWIIntensCtr Integer Counter for combined exceedance of intensity duration threshold and antecedent water index
ctr Integer Counter for number of lines in rainfall data files
ctr_recent_antecedent Integer Counter for exceedance of R1-day recent and previous A2-day antecedent threshold
ctra Integer Counter for number of possible values of running average intensity
ctri Integer Counter for number of possible values of storm-average intensity (I3) or constant-duration intensity(IFD4)
ctrira Integer Counter for combined exceedance of recent-antecedent threshold and running average rainfall intensity threshold
ctria Integer Counter for exceedance of running average rainfall intensity threshold, IE5
ctrid Integer Counter for exceedance of storm-duration average intensity, (Intensity-Duration) threshold
cumAntecedentRainfallCtr Integer Counter for number of possible values of A-day cumulative antecedent precipitation
diffPtrOffset Integer Difference between minutes on local system (sysMin) and minutes in time stamp of recent data, used to set pointer to most recent data
ev_recent_antecedent Integer Number of continuous periods of threshold exceedance for the R-day and A-day antecedent precipitation threshold
evawid Integer Number of continuous periods of combined exceedance for the Intensity-Duration threshold and Antecedent Water Index
evira Integer Holds number of contiguous rows in an array that exceed the threshold
evia Integer Number of continuous periods of threshold exceedance for the Df6-hour running average intensity threshold
evid Integer Number of continuous periods of threshold exceedance for the intensity duration threshold
fmins Integer Minutes of latest time at last station listed in thresh_in.txt, used in setting latestTime
i Integer Loop index, mainly used for stepping through station numbers
imid Integer Integer used to extract numerical values from time and date strings
intervals Integer Number of linear interpolating intervals chosen by the user
lineCtr Integer Line counter used for reading thresh_in.txt and reporting errors
maxDataGap Integer Maximum length in number of lines for data gaps, used to initialize array ctrHolder
maxLines Integer Used to set length of arrays for time-series input and output data
midnightVal Integer Flag to compensate for differences in timestamp conventions
nlo20 Integer Used to set length of pointer arrays for instances of threshold exceedance.
numNewLines Integer Number of lines of new data since last run of program (i.e. number of lines between last and newest)
numPlotPoints Integer Number of values saved to a text file formatted for use by plotting routines
numPlotPoints2 Integer Number of values saved to a second text file formatted for use by plotting routines
numStations Integer Number of rainfall stations to be analyzed
resetAntDay Integer The day to start annual antecedent rainfall running total
resetAntMonth Integer The month to start annual antecedent rainfall running total
rph Integer Number of readings per hour
sumTintensity Integer Sum of integer precipitation values used in computing rainfall intensity as determined by value of Tintensity.
sysMonth Integer System month
sysDay Integer System day of the month
sysHour Integer System hour
sysMin Integer System minute
sysSec Integer System second
sysYear Integer System year
Tantecedent Integer Number of hours of precipitation input data to compute the antecedent rainfall
timezoneOffset Integer Number of hours difference between data logger clock and UTC or local time
tptr Integer Auxiliary pointer used in computing precipitation sums for various time periods
tRainfallBegan Integer Beginning time for rainfall for beginning of latest (or current) storm
tRainfallEnd Integer Ending time for rainfall for latest (or current) storm
Trecent Integer Number of hours of precipitation input data to compute the recent rainfall
tStormGap Integer Holds running count of hours since end of most recent storm
xptr Integer Auxiliary pointer used in computing various cumulative values (sumPrecip, sumTintensity, etc)
year Integer Current year or the year of the data being analyzed
INTEGER ARRAYS
da Integer array Day of month value from timestamp in rain gage input file
hr Integer array Hour value from timestamp in rain gage input file
lastDayofMonth Integer array List of number of days in each month, corrects for months without 31 days
latestDay Integer array Day of month of latest data in rain gage input file
latestHour Integer array Hour of latest data in rain gage input file
latestMinute Integer array Minutes of latest data in rain gage input file
latestMonth Integer array Month of latest data in rain gage input file
latestYear Integer array Year of latest data in rain gage input file
mins Integer array Minute value from timestamp in rain gage input file
timestampMonth Integer array Month value from timestamp in rain gage input file
precip Integer array Precipitation value (hundredths of an inch or tenths of millimeter) from rain gage input file
pt_recent_antecedent Integer array Pointer used in tracking exceedance of the R-day and A-day cumulative rainfall amounts
ptawid Integer array Pointer used in tracking combined exceedance of the AWI and intensity-duration threshold
ptira Integer array Pointer used in tracking combined exceedance of the running average intensity and recent-antecedent precipitation threshold
ptia Integer array Pointer used in tracking exceedance of the running average rainfall intensity, IE
ptid Integer array Pointer used in tracking exceedance of the running storm-duration average rainfall intensity, I
stationPtr Integer array Pointer for each station
ctrHolder Integer array Holds counter values for each station
tlenx Integer array Holds a value twice the length of the plotting window, twin, provided sufficient data exist and used to manage starting point for computations in real-time operations, at end of program run, values are saved in last column of Thlast.txt
numTimestampsHolder Integer array Holds time stamps for last data as listed in the file 'Thlast.txt'
tempStatNum Integer array Station number of corresponding data file (initialization data)
timestampYear Integer array Year value from timestamp in rain gage input file
unitNumber Integer array Unit number(s) of files connected to the program
CHARACTER
pathThlast Character Path name of file Thlast.txt
outputFolder Character Path name to folder where results will be stored
junk Character Descriptive text at beginning of most lines in thresh_in.txt
archiveFile Character Used in constructing names of station archive files
defaultOutputFile Character Holds name of default output file, which uses tab-text format with most recent conditions at all stations
dgOutputFile Character Holds name output file, which uses tab-text format with most recent conditions at all stations suitable for plotting using interactive spreadsheet or graphing software.
updateFile Character Holds name of update file which contains date and time data were last updated; the contents of this file are used in labeling charts.
latestDate Character Latest date in data file of last station listed in thresh_in.txt, (2-digit day, 3-letter month, 4-digit year format)
revdat Character Date of latest revision to program thresh
psn Character Position in file (append or rewind)
fdat Character Latest date in data file of last station listed in thresh_in.txt (MMDDYYYY format)
timeSeriesPlotFile Character Used in constructing names of time-series plot files
sysDate Character Today's date, from the system clock
vrsn Character Current version of computer program thresh
timeSeriesExceedFile Character Used in constructing names of time-series files of threshold exceedance
latestTime Character The latest time at the last station listed in thresh_in.txt
plotFormat Character Output format
fcUnit Character Units for antecedent wetness index, used to select correct conversion factor
powerUnit Character Units for intensity duration threshold, used to select correct conversion factor
precipUnit Character Units for precipitation data in input files
pd Character Pound sign
cm Character Comma
CHARACTER ARRAYS
datim Character array Holds time and date formatted for output to text file
datimb Character array Holds time and date formatted for output to html file, with html line break between time and date
dataLocation Character array Path names of rain gage data files read from thresh_in.txt
stationNumber Character array Rain gage station numbers
stationLocation Character array Geographic names of rain gage stations
LOGICAL
flagRealtime Logical Used to disable real-time mode (flagRealtime=.false.) when statistics output is selected (stats=.true.); the default is flagRealTime=.true.
powerSwitch Logical If powerSwitch==.true. (and other options are false), the power law will be chosen to calculate intensity-duration thresholds
polySwitch Logical If polySwitch==.true (and other options are false), a fifth degree polynomial will be chosen to calculate intensity-duration thresholds
interSwitch Logical If interSwitch==true. (and other options are false), linear interpolating points will be chosen to calculate intensity-duration thresholds
stats Logical If stats==.true., provides extra output for comparing data over long periods of time
REAL
AWIconversion Real Conversion factor for AWI
Awimx Real Maximum computed value of AWI at a station for time period covered by the rain gage data file
AWIThresh Real Holds last computed value of antecedent wetness index from Thlast.txt
decayFactor Real Exponential decay factor for computing antecedent wetness index
drainConst Real Drainage constant for antecedent wetness index
fieldCap Real Field Capacity, Cf7, for computing AWI
in2mm Real Conversion factor for antecedent wetness index
intercept Real Recent-precipitation-(vertical-) axis intercept of R-day Recent/A-day Antecedent threshold
lowLim Real Lower duration limit for applying precipitation intensity duration threshold
minTStormGap Real Number of hours of no rainfall needed to separate storms in computing the intensity-duration threshold
polynomArr Real Coefficients of the fifth degree polynomial used to represent rainfall intensity and duration thresholds that are not adequately modeled by a power function
powerCoeff Real Coefficient of power-law-defined intensity-duration threshold
powerExp Real Exponent of power-law-defined intensity-duration threshold
rntsymx Real Maximum TavgIntensity-hour computed rainfall intensity at a station for time period covered by the rain gage data file
runningIntens Real Running average intensity threshold, IE
seasonalAntThresh Real Threshold value for defining wet conditions using the AWI
slope Real Slope of R-day Recent/A-day Antecedent precipitation threshold
TavgIntensity Real Number of hours used in computing a running-average rainfall intensity
Tintensity Real Number of hours used in computing a running-average (mean) intensity, if Tintensity>0; or compute storm-average intensity for duration of current storm, if Tintensity==0.
upLim Real Upper duration limit for applying precipitation intensity duration threshold
REAL ARRAYS
AWI Real array Antecedent Water Index (AWI)
AWI_0 Real array Starting value of AWI retrieved from Thlast.txt
deficit_recent_antecedent Real array All values of deficit or surplus of the R-day recent and prev. A-day antecedent precipitation threshold at current station
deficit_recent_antecedent_s Real array Current (or latest) deficit or surplus of the R-day recent and prev. A-day antecedent precipitation threshold at each station
dur Real array Storm duration at each line in the current data file
durs Real array Current or latest storm duration at each station
evapConsts Real array Monthly average evapotranspiration in terms of hourly rates (Divide monthly amount of evapotranspiration by number of hours in the month.)
intensity Real array Storm-average rainfall intensity at each line in the current data file
intsys Real array Current of latest value of storm-average rainfall intensity at each station
runIntensity Real array Running average TavgIntensity-hourly rainfall intensity at each line in the current data file
srunIntensity Real array Current or latest value of running average TavgIntensity-hourly rainfall intensity at each station
sumTantecedent Real array Cumulative A-day (Tantededent-hour) antecedent precipitation at each line in the current data file
sumAntecedent_s Real array Current or latest value of cumulative A-day (Tantededent-hour) antecedent precipitation at each station
sumTrecent Real array Cumulative R-day (Trecent-hour) precipitation at each line in the current data file
sumRecent_s Real array Current of latest value of cumulative R-day (Trecent-hour) precipitation at each station
sthreshIntensityDuration Real array Current or latest value of intensity-duration threshold exceedance index, EID8, at each station
threshAvgExceed Real array Running average (over duration TavgIntensity) intensity exceedance index, EID,f9, at each line in the current data file
srunIntensity Real array Current or latest value of running average (over duration TavgIntensity) intensity exceedance index at each station
threshIntensityDuration Real array Intensity-duration threshold exceedance index, EID, at each line in the current data file
DOUBLE PRECISION
trfbeg Double Precision Determines the starting time of a storm in the track_storm subroutine
trfend Double Precision Determines the ending time of a storm in the track_storm subroutine
dgap Double Precision Hours between storms in the track_storm subroutine
DOUBLE PRECISION ARRAYS
These arrays represent the date using days since January 1, 1904, with time since midnight as a decimal fraction, for example, 11:59:00 a.m. January 31, 2017 is 41304.499305555556 (1904 date serial number format)
eachDate1904 Double Precision array Time and date in 1904 date serial number format for each line of data read from the current rain gage file
last1904 Double Precision array Time and date in 1904 date serial number format for the last value from each rain gage (i.e. imported from Thlast.txt)
newest1904 Double Precision array Time and date in 1904 date serial number format for the last value from most recent data (i.e. imported from the rain gage data file)
tstormBeg1904 Double Precision array Time and date in 1904 date serial number format for the beginning of the current or most recent storm at each rain gage (i.e. imported from Thlast.txt or computed from recent data)
tstormEnd1904 Double Precision array Time and date in 1904 date serial number format for the beginning of the current or most recent storm at each rain gage (i.e. imported from Thlast.txt or computed from recent data)
  1. R : Number of days to compute recent precipitation
  2. A : Number of days to compute antecedent precipitation
  3. I : Storm-average precipitation Intensity
  4. IFD : Constant- or fixed-duration precipitation intensity
  5. IE : Running-average precipitation intensity threshold
  6. Df : Duration, in hours, for computing the running-average intensity
  7. Cf : Field capacity, amount of water held by a column of soil after gravity drainage
  8. EID : Index for exceedance of the Intensity-Duration (ID) threshold
  9. EID,f : Index for exceedance of the Running-Average Intensity (ID) threshold of duration Df