Determines the absolute value of the numeric argument

The Accounts in the system are examined; the Account having the indicated priority date is returned.

The set of Accounts on the Object are examined. The names of the Accounts having the specified account type are added to the returned list.

If the Account type argument is "ALL," then that attribute is ignored. The returned list will contain the names of ALL Accounts on the Object.

The list is sorted as described above.

The set of Accounts on the Object are examined. The names of the Accounts having the specified WaterOwner are added to the returned list.

If the WaterOwner argument is "NONE," then only Accounts having the default (unassigned) WaterOwner are included in the returned list.

If the WaterOwner argument is "ALL," then that attribute is ignored. The returned list will contain the names of ALL Accounts on the Object.

The list is sorted as described above.

The set of Accounts on the Object are examined. The names of the Accounts having the specified WaterType are added to the returned list.

If the WaterType argument is "NONE," then only Accounts having the default (unassigned) WaterType are included in the returned list.

If the WaterType argument is "ALL," then that attribute is ignored. The returned list will contain the names of ALL Accounts on the Object.

The list is sorted as described above.

The set of Accounts on the Object are examined. The outflow Supplies on those Accounts are then examined. The names of the Accounts which have Supplies which

(1) link a different downstream Object, and

(2) have the indicated ReleaseType, and

(3) have the indicated Destination

are added to the returned list.

If the ReleaseType argument or the Destination argument is "NONE," then only Supplies having the default (unassigned) attribute of that type are considered.

If the ReleaseType argument or the Destination argument is "ALL," then that Supply attribute is ignored.

The list is sorted as described above.

The "Intra" version of the function will only look at transfer supplies that are within the object.

The Object's accounts are examined.

If an Account exists with the specified name its priority date is returned.

See the on-line documentation for AnnualEventStats, which performs identical computation, but returns more information. This function returns only the number of events which occurred in the analysis period.

See the on-line documentation for AnnualEventStats, which performs identical computation, but returns more information. This function returns only the number of event periods which occurred after the last event. If no events occurred, then this is the number of event periods.

The analysis period start and end dates define the period during which the analysis will be performed. Within the analysis period, only the timesteps which occur on or between the day and month of the event period start and end dates are considered. Each of these periods within the analysis period is called an event period. At each event period, an event can either occur or not.

An event is defined by the value threshold and comparison type and the subevent count threshold and comparison type. At each timestep within an event analysis period, the slot's value is compared to the threshold value. If the value threshold is an upper bound and the slot's value is greater than the value threshold, then a subevent is said to have occurred at that timestep; similarly, if the value comparison is a lower bound and the slot's value is less than the value threshold, then a subevent is said to have occurred. After the subevents within an event analysis period have been noted, then they are counted up and compared to the subevent count threshold. If the subevent count threshold is an upper bound and the number of subevents which occurred in an event analysis period is greater than the subevent count threshold, then an event is said to have occurred, and similarly, if the subevent count comparison is a lower bound and the number of subevents which occurred in an event analysis period is less than the subevent count threshold, then an event is said to have occurred.

A list of slots is generated by searching all of the objects in the Subbasin argument for slots which match the slot name argument. If the time conversion option argument is TRUE, and the values to be aggregated are of the FLOW unit type, the values are multiplied by their corresponding timestep length to convert them to values of the unit type VOLUME.

Next, each slot's values are aggregated according to the aggregation function argument over the time range of the datetime arguments. During each of these slot aggregations, any values which do not satisfy the aggregation filter argument are ignored.

Finally, all of the object's aggregated slot values are averaged.

A list of slots is generated by searching all of the objects in the Subbasin argument for slots which match the slot name argument. If the time conversion option argument is TRUE, and the values to be averaged are of the FLOW unit type, the values are multiplied by their corresponding timestep length to convert them to values of the unit type VOLUME.

Next, all of the object's slot values are averaged, yielding one value for each timestep in the time range of the datetime arguments. The function returns a list of two items, where the first and second items of the inner lists are the datetime and the average value, respectively.

A list of slots is generated by searching all of the objects in the Subbasin argument for slots which match the slot name argument. If the time conversion option argument is TRUE, and the values to be aggregated are of the FLOW unit type, the values are multiplied by their corresponding timestep length to convert them to values of the unit type VOLUME.

Next, all of the objects' slot values are aggregated according to the aggregation function argument for each timestep in the time range of the datetime arguments. During each of these slot aggregations, any values which do not satisfy the aggregation filter argument are ignored.

Finally, the timeseries of object aggregated slot values are averaged.

A list of slots is generated by searching all of the objects in the Subbasin argument for slots which match the slot name argument. For each object, the slot's values are averaged over every timestep in the range of the datetime arguments. Any values which do not satisfy the aggregation filter argument are ignored during the calculation. If the time conversion option argument is TRUE, and the values to be aggregated are of the FLOW unit type, the values are first multiplied by their corresponding timestep length to convert them to values of the unit type VOLUME.

Converts the value into the units of the factor, then returns the smallest integral multiple of the factor which is not less than the converted value.

The returned value has the units of the factor.

Returns the label of the column of the slot which has the given index.

Returns the label of the column of the table slot which has the given index.

Fills in the missing components of a partially specified date value. The

missing component values are taken from the second parameter, a date value which, if not fully specified, should have at least the components which are missing from the date which is being completed.

See the "Syntax Examples" section below for some examples, and see also related functions PreviousDate (Section 138)and NextDate (Section 121).

Returns a LIST of slot, value triplets. Each triplet is a LIST that contains a slot (at index zero) and the value to set on that slot (at index one). The slot, value triplets computed by this function are for the subslots on the Supply From Reservoirs slot on each Water User object and the Incoming Available Water slot on each Water User object.

For each Water User in the specified subbasin:

• A list of supply reservoirs is generated by following the links to the Supply From Reservoirs slot

• The list of reservoirs is ranked by Operating Level in descending order.

• Each reservoir makes a diversion to meet the Water User's Diversion Requested value. This value is limited by: the Maximum Delivery Rate specified on the Water User object that applies to the current reservoir, the Max Diversion specified on the Diversion object that applies to the current reservoir, and the amount of water remaining in the conservation pool.

• If the Limit by Reservoir Level method is selected (on the Water User object) a diversion cannot be made if the Demand Reservoir is in the flood pool or has a higher operating level than the supply reservoir.

• Each reservoir is visited until the Diversion Requested is met or there are no reservoirs left to consider.

• The function returns each subslot on each Supply From Reservoirs slot and the associated value. Also the Incoming Available Water slot on each Water User is returned with the value to be set on that slot. The Incoming Available Water is the sum of all the Supply From Reservoirs subslot values

The two dates are resolved and compared, the one which is chronologically greater is returned.

The two dates are resolved and compared, the one which is chronologically lesser is returned.

Every periodic slot has a period associated with it and this period is divided into intervals. Intervals are either regular (e.g., Days) or irregular (e.g., the beginning of one interval might be 8:00 July 3 of each period). One can map a period (divided into intervals) onto a time line, leading to several specific periods (divided into specific intervals). For example, the period "Year" maps onto specific periods corresponding to each year, such as the specific period which is the year 2003.

Providing a reference date serves to indicate a specific period, and this function returns the dates corresponding to the beginning of each time interval which begins in that specific period.

...

The set of Accounts on the Object are examined. The outflow Supplies on those Accounts which link a different downstream Object and which have the indicated Release Type are considered. The names of the Destination Types of those Supplies are added to the returned list -- but any given Destination Type name will appear on the list only once.

If the Release Type argument is "NONE," then only Supplies having the default (unassigned) Release Type are considered.

If the Release Type argument is "ALL," then that attribute is ignored when considering Supplies.

Returns the DATETIME that is the last timestep at which the current controller allows dispatching. If this function is called from a context in which the current controller does not have a last dispatch timestep (i.e. optimization), then the end date of the run is returned.

Converts numerator and denominator into the specified units, then returns the integral division of the converted values, where integral division of x and y is defined as:

The pool elevation argument is looked up in the Pool Elevation column, of the Elevation Area Table, of the reservoir object argument, to determine the Surface Area. If the exact elevation is not in the table, the lookup performs a linear interpolation between the two nearest bounding elevations and their corresponding surface areas.

On the specified reservoir object argument, if the "Time Varying Elevation Area" method is selected, (Objects.pdf, Section 22.1.24.2), the function will reference the Elevation Area Table Time Varying table. The function will select the appropriate column to use based on the datetime argument. On timesteps that exactly match a modification date, the previous column is used. The relationship changes only at the end of that timestep and is taken into account when the reservoir dispatches. For this algorithm the previous column relationship is used.

Otherwise, the Elevation Area Table is used and the datetime is ignored.

Then, the pool elevation argument is looked up in the Pool Elevation column to determine the Surface Area from the appropriate Surface Area column. If the exact elevation is not in the table, the lookup performs a linear interpolation between the two nearest bounding elevations and their corresponding surface areas.

The pool elevation argument is looked up in the Pool Elevation column, of the Regulated Spill Table, of the reservoir object argument, to determine the Max Regulated Spill. If the exact elevation is not in the table, the lookup performs a linear interpolation between the two nearest bounding elevations and their corresponding maximum regulated spills.

The pool elevation argument is looked up in the Pool Elevation column, of the Elevation Volume Table, of the reservoir object argument to determine the Storage. If the exact elevation is not in the table, the lookup performs a linear interpolation between the two nearest bounding elevations and their corresponding storage values.

On the specified reservoir object argument, if the "Time Varying Elevation Volume" method is selected, (Objects.pdf, Section 22.1.23.3), the function will reference the Elevation Volume Table Time Varying table. The function will select the appropriate column to use based on the datetime argument. On timesteps that exactly match a modification date, the previous column is used. The relationship changes at the end of that timestep and is taken into account when the reservoir dispatches. For this algorithm, the previous column relationship is used.

Otherwise, the Elevation Volume Table is used and the datetime is ignored.

Then, the pool elevation argument is looked up in the Pool Elevation column to determine the Volume from the appropriate column. If the exact elevation is not in the table, the lookup performs a linear interpolation between the two nearest bounding elevations and their corresponding surface areas.

The pool elevation argument is looked up in the Pool Elevation column, of the Unregulated Spill Table, of the reservoir object argument, to determine the Unregulated Spill. If the exact elevation is not in the table, the lookup performs a linear interpolation between the two nearest bounding elevations and their corresponding unregulated spills.

Returns the result of exponentiating the operand to the power given by the exponent. The return value is dimensionless (has no units).

The list of object types to include is parsed and mapped to RiverWare object types. Then, the list of objects is evaluated in order, and each object which is one of the requested object types is added to the returned list.The spellings and capitalization of objects can be found in the Subbasin Manager under the Automatic tab.

For each item in the input list, if the item is not a list, it is appended to the answer list, if it is a list, then it is flattened and then all of its items are appended to the answer list in turn.

Runs the selected Flood Control method on the subbasin. Returns a list of { slot, value, object } sets. For each reservoir in the subbasin, three sets may be returned: one for the Outflow slot, one for the Flood Control Release slot on the reservoir, and one for the Target Balance Level on the reservoir.

Converts the value into the units of the factor, then returns the largest integral multiple of the factor which is not greater than the converted value.

The returned value has the units of the factor.

The number of seconds in the timestep of the datetime argument is determined. Then, the flow argument is multiplied by this number of seconds. Returns value in units of volume.

Converts the numerator into the units of the denominator, divides the result by the denominator, then returns the fractional portion of the division. In other words:

The returned value has the units of "factor".

Returns the contents of a 3D table as a list of the table values associated with successive z value. For each distinct z value in the table slot, the returned list contains a sublist with the following values:
1) The current z value
2) The list of x values associated with the current z value
3) The list of y values associated with the current z value

The function first retrieves a list of all defined subbasins in the model, then filters out any automatic subbasins (object type basins generated by RiverWare).

If the default access method for the table is "lookup", then we first find the row whose associated time interval contains the input date. We then find the two consecutive values in that row whose values bracket the input value. We then find the column map values associated with these two values, and return a value interpolated between them according to where the input value falls between its two bracketing values.

If the default access method is "interpolation" then the procedure described above is followed for the row whose time interval follows the given date, and the return value is interpolated between the values found for the two rows.

The labels of the slot columns are compared to the string argument until a match is found.

Returns the date which corresponds to the input text. Legal text is the same as is legal for symbolic date/times. For example, the expression:

GetDate("January 1, Current Year")

is exactly equivalent to the expression:

@"January 1, Current Year".

The starting datetime and ending datetime; which may be specified symbolically, are converted into actual datetimes. The string representation of the interval is resolved into a time length. Then, a list is created beginning with the starting datetime. The time length is added to each previous datetime in the list until the resulting datetime is later than the ending datetime.

The center datetime, which may be specified symbolically, is converted into an actual datetime. The string representation of the interval is resolved into a time length. Then a list is created with the given number of dates, each separated by the given time interval. The center date is always included in this list, with an equal number of dates appearing before and after it (in the case of an odd number of dates). If their are an even number of dates, then there is one more date appearing before the center date than appear after. After the list has been created, if the user has specified that they only want dates within the run duration, then all other dates are filtered out of the return list.

The datetime argument; which may be specified symbolically, is converted into an actual datetime. Then, the day of the month in which the datetime is, is determined. This function requires that the datetime be at least partially specified with a valid month and day, E.g. @"January 1" or @"Current Month 23" will work.

The datetime argument; which may be specified symbolically, is converted into an actual datetime. Then, the day of the year in which the datetime is contained, is determined.

This function requires that the specified datetime resolve to a fully specified datetime or an error will occur.

The datetime argument; which may be specified symbolically, is converted into an actual datetime. Then, the number of days in the month in which the datetime is contained, is determined. This function requires that the specified datetime resolve to a fully specified datetime or an error will occur.

The function returns and error and aborts the run if the input slot is not of an appropriate type, if the date is not fully specified, or if the date is not contained in the series.

The function returns the name of the element object.

The function returns the value for the trace keyword for the currently executing run.

The function returns the value for the ensemble keyword for the currently executing run.

The datetime argument; which may be specified symbolically, is converted into an actual datetime. Then, the julian date of this timestep is determined.

This function requires that the specified datetime resolve to a fully specified datetime or an error will occur.

For each slot to which the input slot is linked, we determine if that slot is managed by a Objects; if so, it is added to the return list. Thus, an empty list is returned if the slot is not linked to any slots on a Objects.

This function calls the getMaxOutGivenHW() function on the given reservoir object at the given timestep, and provides it with the end of timestep pool elevation. This ending HW is averaged with the previous timestep's ending Pool Elevation to yield an average HW over the timestep. The average HW is then used to compute the following outflows:

• release (if the object is a StorageReservoir): The maximum release is determined from a table interpolation in the Max Release table using the average HW as the lookup in the Pool Elevation column.

• turbine release (if the object is a LevelPowerReservoir or SlopePowerReservoir): The maximum turbine release is determined based on the selected Power method. This calculation is iterative, since the maximum outflow impacts the reservoir tailwater elevation and operating head, which affect the maximum turbine release. The selected Tailwater method is used to determine the tailwater elevation.

• No Power Turbine Flow: The turbine release is determined from a table interpolation in the Max Flow Through Turbines table using the average HW as the lookup in the Reservoir Elevation column.

• Plant Power Coefficient: The turbine release is determined from a table interpolation in the Max Turbine Q table using the operating head as the lookup in the Operating Head column. If the average HW is less than the Minimum Power Elevation, the turbine release is zero.

• Unit Generator Power: The turbine release is the sum of the maximum releases for each available turbine, as specified in the Generators Available and Limit table. Each turbine's maximum release is determined from a table interpolation in the Full Generator Flow table using the

• unregulated spill (if an unregulated spillway Method is selected on the object): The maximum unregulated spill is determined from a table interpolation in the Unregulated Spill Table using the average HW as the Pool Elevation.

• regulated spill (if a regulated spillway Method is selected on the object): The maximum regulated spill is the user input Regulated Spill at the given timestep or is determined from a table interpolation in the Regulated Spill Table using the average HW in the Pool Elevation column. Note, if the MonthlySpill method is selected, the result of getMaxOutflowGivenHW is the value in the Maximum Controlled Release table slot.

• bypass (if a bypass spillway Method is selected on the object): The maximum bypass is the user input Bypass at the given timestep or zero, if no bypass is input.

• All of the individual outflows are then summed to calculate the maximum outflow.

This function calls the getMaxOutGivenIn() function on the given reservoir object at the given timestep, and provides it with the average inflow over the timestep. A convergence algorithm is used in this function and is detailed in (Objects.pdf, Section 26.1). The function iterates to convergence by computing the end of timestep storage and pool elevation, the average HW over the timestep, and the following outflows:

• release (if the object is a StorageReservoir): The maximum release is determined from a table interpolation in the Max Release table using the average HW as the lookup in the Pool Elevation column.

• turbine release (if the object is a LevelPowerReservoir or SlopePowerReservoir): The maximum turbine release is determined based on the selected Power method. This calculation is iterative, since the maximum outflow impacts the reservoir tailwater elevation and operating head, which affect the maximum turbine release. The selected Tailwater method is used to determine the tailwater elevation.

• No Power Turbine Flow: The turbine release is determined from a table interpolation in the Max Flow Through Turbines table using the average HW as the lookup in the Reservoir Elevation column.

• Plant Power Coefficient: The turbine release is determined from a table interpolation in the Max Turbine Q table using the operating head as the lookup in the Operating Head column. If the average HW is less than the Minimum Power Elevation, the turbine release is zero.

• Unit Generator Power: The turbine release is the sum of the maximum releases for each available turbine, as specified in the Generators Available and Limit table. Each turbine's maximum release is determined from a table interpolation in the Full Generator Flow table using the operating head as the lookup in the appropriate unit type's Head for Type n column. If the average HW is less than the Minimum Power Elevation, the turbine release is zero.

• Peak Power Equation with Off Peak Spill: The turbine release is the peak release over the entire timestep. This is calculated by iterating the selected Tailwater method and operating head calculation with a table interpolation in the Operating Head vs. Generator Capacity table.

This function calls the getMaxOutGivenStorage() function on the given reservoir object at the given timestep, and provides it with the end of timestep storage. This ending HW is determined from the ending storage, and is averaged with the previous timestep's ending Pool Elevation to yield an average HW over the timestep. The average HW is then used to compute the following outflows:

• release (if the object is a StorageReservoir): The maximum release is determined from a table interpolation in the Max Release table using the average HW as the lookup in the Pool Elevation column.

• turbine release (if the object is a LevelPowerReservoir or SlopePowerReservoir): The maximum turbine release is determined based on the selected Power method. This calculation is iterative, since the maximum outflow impacts the reservoir tailwater elevation and operating head, which affect the maximum turbine release. The selected Tailwater method is used to determine the tailwater elevation.

• No Power Turbine Flow: The turbine release is determined from a table interpolation in the Max Flow Through Turbines table using the average HW as the lookup in the Reservoir Elevation column.

• Plant Power Coefficient: The turbine release is determined from a table interpolation in the Max Turbine Q table using the operating head as the lookup in the Operating Head column. If the average HW is less than the Minimum Power Elevation, the turbine release is zero.

This function calls the getMaxRelGivenIn() function on the given reservoir object at the given timestep, and provides it with the average inflow over the timestep. A convergence algorithm is used in this function and is detailed (Objects.pdf, Section 26.1).The function iterates to convergence by computing the end of timestep storage and pool elevation, the average HW over the timestep, and the release:

• release (if the object is a StorageReservoir): The maximum release is determined from a table interpolation in the Max Release table using the average HW as the lookup in the Pool Elevation column.

This function calls the getMinSpillGivenInflowRelease() function on the given reservoir object at the given timestep, and provides it with the average inflow and release over the timestep. A convergence algorithm is used in this function and is detailed in (Objects.pdf, Section 26.1).The function iterates to convergence by computing the end of timestep storage and pool elevation, the average HW over the timestep, and the spill:

The datetime argument; which may be specified symbolically, is converted into an actual datetime. Then, the number of the month in which the datetime is contained, is determined. This function requires that the specified datetime resolve to at least a partially specified datetime in the "Month day, year" format with the month specified.

The datetime argument; which may be specified symbolically, is converted into an actual datetime. Then, the name of the month in which the datetime is in, is determined. This function requires that the specified datetime resolve to at least a partially specified datetime in the "Month day, year" format with the month specified.

The end value and offset are converted into the units of the start value. A list is created whose first item is the start value, the second item is the start value plus the offset, and so on, until the next value to be added to the list would not be in the range defined by the start and end value.

The function returns the object with the given name, if it exists.

The function loops over all supplies, on all accounts, on the given object. If a supply is an exchange payback source, the value of its debt slot at the given timestep (if known) is added to the cumulative debt of the object.

The function begins by verifying that the string argument is an accounting supply, and that this supply is a payback source. If so, the function evaluates to the value of the payback's debt slot at the given timestep.

The labels of the slot rows are compared to the string argument until a match is found.

The function returns the slot with the given name, if it exists.

A list is generated by looking up each value in the given slot, beginning with the start datetime, and ending with the end datetime. All slot values in the range are returned, regardless of the slot data's timestep resolution vis-a-vis that of the run control.

A list is generated by looking up each value in the given column of the slot, beginning with the start datetime, and ending with the end datetime. All slot values in the range are returned, regardless of the slot data's timestep resolution vis-a-vis that of the run control.

A list is generated by looking up each value in the given column of the given table slot beginning with the start row, and ending with the end row (inclusive). Rows and columns are numbered beginning with zero.

A list is generated by looking up each value in the given row, of the given table slot beginning with the start column, and ending with the end column (inclusive). Rows and columns are numbered beginning with zero.

The datetime argument; which may be specified symbolically, is converted into an actual datetime. Then, the length of the timestep within which this time is, is determined.

This function requires that the specified datetime resolve to a fully specified datetime or an error will occur.

The datetime argument; which may be specified symbolically, is converted into an actual datetime. Then, the year within which this time is, is determined. This function requires that the datetime be at least partially specified with a valid year, E.g. @"Year 2010" or @"Current Year" will work.

The datetime argument; which may be specified symbolically, is converted into an actual datetime and the year is returned as a string. This function requires that the datetime be at least partially specified with a valid year, E.g. @"Year 2010" or @"Current Year" will work.

The function returns whether or not the slot has the flag at that date.

If the slot does not have a value at the date then the function returns that an invalid value was found (which will cause the calling block to terminate early).

This function returns TRUE if:

• the rule finished successfully (i.e., at least one assignment is attempted and none fail), or

• the rule finished ineffectively (i.e., the rule is evaluated but the logic within the execution constraint or within the body of the rule decides no assignment is necessary or the rule attempts assignment but priority is junior so no assignment is made).

The function returns FALSE if

• the rule has not yet fired, or

• the rule has fired but terminated early (the rule encountered a NaN in a slot value).

Note that, as mentioned above, if the input name is "Current Rule" or "ThisRule", then this is taken to be a reference to the currently executing rule.

Using the structure NOT HasRuleFiredSuccessfully("ThisRule") will cause the that rule to only execute successfully once.

The function does the following:

1. Prioritizes the power reservoirs in the basin according to the relative Load shortage using the equation below.

If Load is unknown because the Seasonal Load Time method is selected, it is calculated. The calculated shortage then is a value less than one. The reservoirs with the highest values are first, the lowest reservoirs last.

Note: Note, if the "Releases Not Constrained by Flooding" method is selected in the "Hydropower Flooding Exception" category on the control point ( (Objects.pdf, Section 9.1.16.2), the control point is ignored, i.e. flooding is allowed at that control point.

When function is executed, a hypothetical simulation is initiated where the fixed values are set on the specified slots, the portion of the workspace specified by the Subbasin is simulated, and the values of the output slots are returned as a list.

The implementation of this function uses an iterative algorithm (the bisection algorithm) which performs an hypothetical simulation of the subbasin at each iteration.

There are two conditions in which that function will fail but this function will return false as the first item in the return list:

• The minimum and maximum control slot values lead to a range of limit values which does not include the input limit value. In this case the value returned is the minimum or maximum control slot value, which ever leads to a limit slot value closest to the input limit value.

• The tolerance is not achieved within the iteration limit. In this case, the value returned is the current best guess.

If "Hypothetical Simulation" diagnostics are turned on, then if HypLimitSimWithStatus can not find a satisfying control value, a diagnostic will be posted describing why it failed to do so.

In a sense, HypTargetSim is the inverse of HypSim. In particular,

HypTargetSim(basin, control, min, max, targetSlot, targetDate, targetValue, tolerance, maxIterations) = x

implies that

HypSim(basin,{{targetSlot, t, x}, ..., {targetSlot, targetDate, x}}, {{controlSlot, targetDate}} = targetValue

The implementation of this function uses an iterative algorithm (the bisection algorithm) which performs an hypothetical simulation of the subbasin at each iteration.

There are two conditions in which that function will fail but this function will return false as the first item in the return list:

• The minimum and maximum control slot values lead to a range of target values which does not include the input target value. In this case the value returned is the minimum or maximum control slot value, which ever leads to a target value closest to the input target value.

• The tolerance is not achieved within the iteration limit. In this case, the value returned is the current best guess.

If "Hypothetical Simulation" diagnostics are turned on, then if HypTargetSimWithStatus can not find a satisfying control value, a diagnostic will be posted describing why it failed to do so.

Given a numeric value, IntegerToString returns a string representation of that value with the fractional part of the value and the units removed.

Converts the value into the desired units, rounds down to the nearest integer, then returns whether or not this value is even.

The datetime argument; which may be specified symbolically, is converted into an actual datetime. Then, the flag of the value in the series slot at that time is compared with the user input flags. If the flag is an "I" or "Z", true is returned. An "i" is considered a user input within an iterative MRM run, but not a user input within a single run or outside of a run. The "R" flag is not considered an input.

Also, IsInput returns false if the slot[datetime] is NaN. But, this function does NOT terminate the executing rule if the value at the given datetime is a NaN.

See also the similar yet more general function HasFlag, (Section 87).

Converts the value into the desired units, rounds down to the nearest integer, then returns whether or not this value is odd.

The datetime argument; which may be specified symbolically, is converted into an actual datetime. If the date of this year is a leap year, true is returned, otherwise false.

ListDownstreamObjects searches links downstream from the first object until it finds the second object. It returns a list of all objects that it finds, inclusive of the specified objects.

The list of subbasins in the model is searched for a match to the given string. Then, a list is generated from the member objects of that subbasin.

Converts the value into the desired units, and then computes the natural logarithm of this value. The solution is this number in the units of the converted value.

Converts the value into the desired units, and then computes the base 10 logarithm of this value. The solution is this number in the units of the converted value.

The two numbers are converted to a common unit and compared. The greater of the two numbers is returned.

The numbers in the input list are converted to a common unit and compared. The greatest number is returned.

A list of slots is generated by searching all of the objects in the subbasin argument for slots which match the slot name argument. If the time conversion option argument is TRUE, and the values to be aggregated are of the FLOW unit type, the values are multiplied by their corresponding timestep length to convert them to values of the unit type VOLUME.

Next, each slot's values are aggregated according to the aggregation function argument over the time range of the datetime arguments. During each of these slot aggregations, any values which do not satisfy the aggregation filter argument are ignored.

Finally, the largest of the objects' aggregated slot values is determined. This value is returned as the first value in a list. If there is a date/time associated with this value, it is returned as the second value in the list. This will be the case if the "MIN" or "MAX" aggregation function is specified for the fifth argument.