Absolute value operator

NUMERIC

Type

Meaning

NUMERIC

value to evaluate

Determines the absolute value of the numeric argument

none

Given a string representing an account’s full name (object^account), returns a list containing the account’s attributes, i.e., the account’s water type, water owner, and account type.

LIST {STRING, STRING, STRING}

Type

Meaning

STRING

The name of the account.

 

This function returns the name of the account having the specified priority date.

STRING

Type

Meaning

DATETIME

The priority date.

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

Priority dates are a property of Accounts.

It’s an error if no account has the specified priority date.

This function returns a list of names of Accounts on a specified Object having the indicated Account type, sorted in ascending Account priority date order. Accounts which don’t have a priority date are at the end of the list, sorted in ascending name order.

LIST {STRING}

Type

Meaning

OBJECT

The Object.

STRING

Account type name (currently, one of Diversion, Storage, or PassThrough) or ALL.

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.

Priority dates are properties of Accounts.

This function returns a list of names of Accounts on a specified Object having the indicated WaterOwner, sorted in ascending Account priority date order. Accounts which don’t have a priority date are at the end of the list, sorted in ascending name order.

LIST {STRING}

Type

Meaning

OBJECT

The Object.

STRING

WaterOwner name or NONE or ALL

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.

WaterOwners and priority dates are properties of Accounts.

This function returns a list of names of Accounts on a specified Object having the indicated WaterType, sorted in ascending Account priority date order. Accounts which don’t have a priority date are at the end of the list, sorted in ascending name order.

LIST {STRING}

Type

Meaning

OBJECT

The Object.

STRING

WaterType name or NONE or ALL

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.

WaterTypes and priority dates are properties of Accounts.

This function returns a list of names of Accounts on a specified Object where the attributes of the outflow Supplies of the Accounts match the given ReleaseType and Destination. The list is sorted in ascending Account priority date order; Accounts which don’t have a priority date are at the end of the list, sorted in ascending name order.

LIST {STRING}

Type

Meaning

OBJECT

The Object.

STRING

ReleaseType name or NONE or ALL

STRING

Destination name or NONE or ALL

The set of Accounts on the Object are examined. The outflow Supplies on those Accounts are then examined. The names of the Accounts with Supplies that meet the following requirements 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.

ReleaseTypes and Destinations are properties of Supplies; priority dates are properties of Accounts.

This function returns the priority date of the Account, on the specified object, having the specified name.

DATETIME

Type

Meaning

OBJECT

The Object

STRING

The Account name

The Object’s accounts are examined.

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

Priority dates are a property of Accounts.

It’s an error if either the Object doesn’t have an Account with the specified name or the Account doesn’t have a priority date.

For the specified slot, compute the aggregated values using the specified function at the specified timestep size.

LIST of {DATETIME, NUMERIC}

Type

Meaning

SLOT

The slot to aggregate. This slot has the smaller timestep size.

DATETIME

Begin timestep of the returned (larger timestep) values

DATETIME

End timestep of the returned (larger timestep) values

STRING

Timestep to which to aggregate, "6 hours", "1 days", etc. This is the size of the larger timestep.

STRING

Aggregation function or filter to use. It must be one of the following: "SUM", "AVG", "MIN", "MAX", "FIRST", "LAST".

STRING

How to treat NaN values in the slot that is being aggregated. It must be one of the following:

For the specified slot, compute the aggregated values using the specified function at the specified timestep size.

This function can be used to aggregate a series slot to return a list of larger timestep values. A use example from an initialization rule is shown:

Return the number of events which occurred on a slot in a given period.

NUMERIC

Type

Meaning

SLOT

a slot

DATETIME

analysis period start date

DATETIME

analysis period end date

DATETIME

event period start date

DATETIME

event period end date

NUMERIC

value threshold

BOOLEAN

value threshold is upper bound

NUMERIC

event threshold

BOOLEAN

event threshold is upper bound

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.

 

Return the number of event periods which occurred after the last event on a slot.

NUMERIC

Type

Meaning

SLOT

a slot

DATETIME

analysis period start date

DATETIME

analysis period end date

DATETIME

event period start date

DATETIME

event period end date

NUMERIC

value threshold

BOOLEAN

value threshold is upper bound

NUMERIC

event threshold

BOOLEAN

event threshold is upper bound

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.

 

Collects and returns statistics on annual events occurring on a slot.

LIST

Type

Meaning

SLOT

a slot

DATETIME

analysis period start date

DATETIME

analysis period end date

DATETIME

event period start date

DATETIME

event period end date

NUMERIC

value threshold

BOOLEAN

value threshold is upper bound

NUMERIC

event threshold

BOOLEAN

event threshold is upper bound

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.

The return list contains the following items (listed in order):

The number of event periods which occurred after the last event. If no events occurred, then this is the number of event periods.

As defined above, the first and last event periods might be of shorter duration than the other event periods. For example, if the analysis period is July 1, 1980 through June 30, 1989 and the event period is May 1 through September 30, then the first event period will be July 1, 1980 through September 30, 1980; subsequent event periods will be from May 1 through September 30, until the last event period, which will be from May 1, 1989, through June 30, 1989.

If the event period contains the end of February, then event periods during leap years will also have a different duration. It is an error for the start or end date of the event period to be February 29, which does not exist in each year.

Event periods can span year boundaries. For example, if the event period begin is December and the event period end is January, then each event period will be from December of one year to January of the next.

One can leave the year field of the event period start or end date unspecified, if one is using a format which contains that component, such as the month/day/year format. E.g., one could specify the event start as @"6:00 May 1". The year component of the event period start and end date is ignored whether or not it is specified.

Any missing value in the slot’s series is treated as a non-subevent.

The comparison with the value threshold is done to within 0.01% of the threshold’s value. That is, values which are within 0.01% of the threshold’s value are considered to have exceeded the threshold.

Aggregates several objects’ values, each of which is the result of aggregating a slot’s values over time.

NUMERIC

Type

Meaning

STRING

Subbasin name

STRING

slot name

STRING

aggregation function (SUM, AVG, MIN, or MAX)

STRING

aggregation filter (INPUT, OUTPUT, or ALL)

BOOLEAN

time conversion option (TRUE or FALSE)

DATETIME

start date

DATETIME

end date

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.

If the time conversion option argument is TRUE, but the unit of the slot values is not FLOW, RiverWare aborts the run with an error.

If none of the values for a slot satisfy the aggregation filter argument, the SUM aggregation function yields an aggregated value of 0.0 for that slot, while the AVG, MIN, and MAX aggregation functions abort RiverWare with an error.

Average several object’s slot values, for each timestep in a range.

LIST{LIST{DATETIME, NUMERIC}}

Type

Meaning

STRING

Subbasin name

STRING

slot name

STRING

aggregation filter (INPUT, OUTPUT, or ALL)

BOOLEAN

time conversion option (TRUE or FALSE)

DATETIME

start date

DATETIME

end date

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.

If the time conversion option argument is TRUE, but the unit of the slot values is not FLOW, RiverWare aborts the run with an error.

If none of the values for a slot satisfy the aggregation filter argument, the SUM aggregation function yields an aggregated value of 0.0 for that slot, while the AVG, MIN, and MAX aggregation functions abort RiverWare with an error.

Aggregate over a timeseries of values, each of which is the result of aggregating several objects’ slot values.

NUMERIC

Type

Meaning

STRING

Subbasin name

STRING

slot name

STRING

aggregation function (SUM, AVG, MIN, or MAX)

STRING

aggregation filter (INPUT, OUTPUT, or ALL)

BOOLEAN

time conversion option (TRUE or FALSE)

DATETIME

start datetime

DATETIME

end datetime

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.

If the time conversion option argument is TRUE, but the unit of the slot values is not FLOW, RiverWare aborts the run with an error.

If none of the values for a slot satisfy the aggregation filter argument, the SUM aggregation function yields an aggregated value of 0.0 for that slot, while the AVG, MIN, and MAX aggregation functions abort RiverWare with an error.

Average a slot’s values over a time range, for each object in a subbasin.

LIST {LIST {OBJECT, NUMERIC}}

Type

Meaning

STRING

Subbasin name

STRING

slot name

STRING

aggregation filter (INPUT, OUTPUT, or ALL)

BOOLEAN

time conversion option (TRUE or FALSE)

DATETIME

start datetime

DATETIME

end datetime

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.

If the time conversion option argument is TRUE, but the unit of the slot values is not FLOW, this function aborts the run with an error. If none of the values for a slot satisfy the aggregation filter argument, this function also aborts RiverWare with an error.

The ceiling numeric operation, to a multiple of a factor.

NUMERIC

Type

Meaning

NUMERIC

the value

NUMERIC

the factor

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.

If the scalar portion of the factor is 1.0, then this function simply returns the ceiling of the value expressed in the units of the factor.

If the two arguments are of a different unit type, this function aborts the run with an error.

See also “RoundToFactor” and “Floor”.

Returns the label associated with a given column of a table slot or aggregate series slot.

STRING

Type

Meaning

SLOT

A table slot or agg series slot.

NUMERIC

The column index (0-based).

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

It is an error to provide an illegal index (e.g., an index of 4 with a table which has only 4 columns). If the column index is legal but there is no label for that column, then the empty string is returned: " ".

Returns a list containing the labels of the columns of a given table slot or agg. series slot, in order.

LIST of STRING values

Type

Meaning

SLOT

A table slot or agg. series slot

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

It is an error if the input slot has a type other than table slot or agg. series slot. For each column, if no label exists the empty string is returned.

Fill in the missing components of a partially specified date/time.

DATETIME

Type

Meaning

DATETIME

a partially specified date/time.

DATETIME

a source date/time, used to complete the other date.

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 following syntax examples. See “PreviousDate” and “NextDate” for details on related functions.

The behavior is not defined if the resulting date is not valid; for example, if the day of month is not valid for the month and year.

Used to meet multiple water user demands using multiple reservoir diversions

LIST{LIST {SLOT, NUMERIC, OBJECT}}

Type

Meaning

STRING

The computational subbasin used for the calculations

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:

The computational subbasin specified as the argument to this function must contain all the objects relevant to these calculations (Water Users, Diversion Objects, Reservoirs, etc.)

The computational subbasin must have a method selected in the Diversions from Reservoirs category. Please consult the help file for the Computational Subbasin object (under Simulation Objects) for more details on this method category.

The use of this function requires a specific configuration of objects and method selections. The schematic diagram below displays the required object and link configurations.

See “Reservoir Diversions” in USACE‑SWD Modeling Techniques for details on using this function for USACE-SWD.

Compare two dates and return that which is chronologically greater.

DATETIME

Type

Meaning

DATETIME

a date

DATETIME

another date

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

 

Compare two dates and return that which is chronologically lesser.

DATETIME

Type

Meaning

DATETIME

a date

DATETIME

another date

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

 

Given a periodic slot and a date, this function returns an ordered list of dates representing the beginning time of each interval which begins in the specific period containing the input (reference) date.

LIST {DATETIME}

Type

Meaning

SLOT

a periodic slot

DATETIME

a reference date

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.

When the beginning of an interval occurs exactly at a period boundary (e.g., an interval beginning at "0:00 January 1" with an 1 Year period), then we consider that interval to begin in the period occurring after midnight, not the one before.

Not all time intervals (rows) defined in a Periodic Slot will correspond to intervals in a specific period. For example, for a period of Month, an interval might be defined which begins at "12:00 Day 30". This interval does not exist in all months and so for example if the reference date is 12:00 February 1, 2003, then the list returned by this function would not include the date 12:00 February 30, 2003.

Given a Date/Time value, returns that date encoded as a numeric value of the type used by slots to containing date/time values.

NUMERIC

Type

Meaning

DATETIME

The date/time value to encode as a numeric value.

Slots representing date/time values have unit type DateTime.

The date/time value need not be fully specified, but the return value should only be assigned to a slot with appropriate units. For example, if the value @"January 1" should only be assigned to a slot with units "MonthAndDay".

This function returns a list of the names of all Destinations defined in the Water Accounting System Configuration.

LIST {STRING}

Type

Meaning

 

Destinations are properties of Supplies. The returned list does not include the default (NONE) Destination.

This function returns a list of unique names of Destination Type of Supplies which represent outflows from a specified Object, and which have the indicated Release Type.

LIST {STRING}

Type

Meaning

OBJECT

The Object.

STRING

Release Type name or NONE or ALL

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.

Destination Type and Release Types are properties of Supplies. The returned list can include the default (NONE) Destination Type. Supplies which represent internal flows between two Accounts on the Object are not considered.

Returns the number of dispatch method executions that have occurred since the beginning of the current run.

NUMERIC

None

Meaning

Returns the number of dispatch method executions that have occurred since the beginning of the current run, if called during a dispatching run (Simulation or Rulebased Simulation). Otherwise, returns the total number of dispatch executions in the previous dispatching run.

The last dispatch timestep.

DATETIME

Type

Meaning

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.

The Number of Post-Run Dispatch Timesteps is set on the Run Control Parameters dialog for Simulation or Rulebased Simulation. See “Number of Post-Run Dispatch Timesteps” in User Interface for details on changing the Number of Post-Run Dispatch Timesteps.

Returns the accumulated time spent executing dispatch methods since the beginning of the current run.

NUMERIC

None

Meaning

Returns the accumulated time spent executing dispatch methods since the beginning of the current run, if called during a dispatching run (Simulation or Rulebased Simulation). Otherwise, returns the total time spent executing dispatch methods in the previous dispatching run

Integer division of two numbers.

NUMERIC

Type

Meaning

NUMERIC

the numerator

NUMERIC

the units to which to convert the numerator

NUMERIC

the denominator

NUMERIC

the units to which to convert the denominator

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:

If the denominator is equal to zero, this function aborts the run with an error.

Each of the units arguments must have units which are compatible with the value with which they are associated, otherwise the run is aborted with an error.

This function does not use the scalar portion of either of the units arguments.

Find the surface area corresponding to a reservoir’s elevation.

NUMERIC

Type

Meaning

OBJECT

reservoir object

NUMERIC

pool elevation

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.

If the object is not a reservoir, or the reservoir does not have an Elevation Area Table, the function aborts the run with an error (CRSSEvaporationCalc, DailyEvaporationCalc, PanAndIceEvaporation, or InputEvaporation must be selected as the Evaporation and Precipitation Category selected Method.

This function will issue an error if the Time Varying Elevation Area method is selected (see “Time Varying Elevation Area” in Objects and Methods). Instead, use the ElevationToAreaAtDate function (see “ElevationToAreaAtDate”).

Find the surface area corresponding to a reservoir’s elevation.

NUMERIC

Type

Meaning

OBJECT

reservoir object

NUMERIC

pool elevation

DATETIME

the datetime at which to do the conversion

On the specified reservoir object argument, if the Time Varying Elevation Area method is selected (see “Time Varying Elevation Area” in Objects and Methods), the function will reference the Elevation Area Table Time Varying table (see “Elevation Area Table Time Varying” in Objects and Methods). 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.

If the object is not a reservoir, or the reservoir does not have an Elevation Area Table or Elevation Area Table Time Varying, the function aborts the run with an error (i.e. a method must be selected in the Evaporation and Precipitation Category).

Find the maximum regulated spill at a given reservoir elevation.

NUMERIC

Type

Meaning

OBJECT

reservoir object

NUMERIC

pool elevation

DATETIME

datetime context for unit conversions

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.

If the object is not a reservoir, or the reservoir does not have a Regulated Spill Table, the function aborts the run with an error (Regulated; Regulated and Unregulated; Regulated and Bypass; Regulated, Bypass and Unregulated; or Bypass, Regulated and Unregulated must be the Spill category selected method).

Find the reservoir storage at a given elevation.

NUMERIC

Type

Meaning

OBJECT

reservoir object

NUMERIC

pool elevation

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.

If the object is not a reservoir, the function aborts the run with an error.

If the reservoir is a Slope Power Reservoir, the calculation is based only on level storage and does not include any wedge storage effects.

This function will issue an error if the Time Varying Elevation Volume method is selected (see “Time Varying Elevation Volume” in Objects and Methods). Instead, use the ElevationToStorageAtDate function described next.

Find the volume corresponding to a reservoir’s elevation.

NUMERIC

Type

Meaning

OBJECT

reservoir object

NUMERIC

pool elevation

DATETIME

the datetime at which to do the conversion

On the specified reservoir object argument, if the Time Varying Elevation Volume method is selected, 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.

If the object is not a reservoir, or the reservoir does not have an Elevation Volume Table or Elevation Volume Table Time Varying, the function aborts the run with an error.

Find the unregulated spill at a given reservoir elevation.

NUMERIC

Type

Meaning

OBJECT

reservoir object

NUMERIC

pool elevation

DATETIME

datetime context for unit conversions

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.

If the object is not a reservoir, or the reservoir does not have an Unregulated Spill Table, the function aborts the run with an error (Unregulated; Regulated and Unregulated; Regulated, Bypass and Unregulated; or Bypass, Regulated and Unregulated must be the Spill selected method).

Exponentiation of a dimensionless quantity.

NUMERIC

Type

Meaning

NUMERIC

the operand

NUMERIC

the exponent

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

The exponent is not restricted to being an integer (as with the "^" operator), but it is an error for the operand to have units.

Filter a list of objects to include only objects of the specified types.

LIST {OBJECT}

Type

Meaning

LIST

list of objects

LIST

list of object types to include, where each object type is expressed as a STRING.

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.

The order of objects is preserved from the argument object list to the returned object list. The list arguments may contain any number of items. If either of the arguments is an empty list, the function evaluates to an empty list.

This function takes a list and replaces any lists contained within that list with the individual items from those lists.

NUMERIC

Type

Meaning

LIST

the list to be flattened

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.

 

Invokes computational subbasin’s selected Flood Control method.

LIST { LIST { SLOT, NUMERIC, OBJECT } }

Type

Meaning

STRING

the name of the computational subbasin

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.

The calling rule is expected to make the assignments of the values to the slots. Typically, this function should be called only once per timestep. To constrain this, use the following as an execution constraint: NOT(HasRuleFiredSucessfully("Rule Name") )

See “Low-flow Releases” in USACE‑SWD Modeling Techniques for details on using this function for USACE-SWD.

The floor numeric operation, to a multiple of a factor.

NUMERIC

Type

Meaning

NUMERIC

the value

NUMERIC

the factor

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.

If the scalar portion of the factor is 1.0, then this function simply returns the floor of the value expressed in the units of the factor.

If the two arguments are of a different unit type, this function aborts the run with an error.

See also “Ceiling” and “RoundToFactor”.

The volume of water resulting from a steady flow over a timestep.

NUMERIC

Type

Meaning

NUMERIC

constant flow to be converted

DATETIME

timestep over which to convert

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.

If the flow argument is entered in units containing a "/month" component, it is scaled to reflect the length of the month indicated by the timestep argument before being multiplied by this timestep length.

The fractional remainder after division.

NUMERIC

Type

Meaning

NUMERIC

the numerator

NUMERIC

the denominator

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.

If the scalar portion of the denominator is 1.0, then this function simply returns the fractional portion of the first argument when it is expressed in the units of the denominator.

If the values are of a different unit type, this function aborts the run with an error.

Return the contents of a Table Slot that is structured for 3D table interpolation.

LIST{LIST {NUMERIC LIST{NUMERIC} LIST{NUMERIC}}}

Type

Meaning

SLOT

the table slot whose values are to be returned.

NUMERIC

z column index (zero-based)

NUMERIC

x column index (zero-based)

NUMERIC

y column index (zero-based)

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

Units are not required for row and column indices and, if provided, will be ignored.

In the context of rulebased simulation, if one of the slot’s values is NaN, the function exits the rule with an early termination.

320

0.00

0

320

120.32

470

340

5.00

10

340

127.32

500

Return the contents of a Table Slot that is structured for 3D table interpolation.

LIST{LIST {NUMERIC LIST{NUMERIC} LIST{NUMERIC}}}

Type

Meaning

SLOT

the table slot whose values are to be returned.

NUMERIC

z column index (zero-based)

NUMERIC

x column index (zero-based)

NUMERIC

y column index (zero-based)

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

Units are not required for row and column indices and, if provided, will be ignored.

In the context of rulebased simulation, if one of the slot’s values is NaN, all values in that row and rows below it are ignored.

320

0.00

0

320

120.32

470

340

5.00

10

340

127.32

500

NaN

NaN

NaN

Return the name of a slot’s account.

STRING

 

Meaning

SLOT

The slot whose account is returned.

It is an error if the slot is not on an account.

The names of all user defined subbasins in the current model, expressed as strings.

LIST {STRING}

none

Meaning

 

 

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 there are no user defined subbasins in the model, this function evaluates to an empty list.

Get a column map value from a periodic slot given a date and a value. This is the inverse of the way values are usually accessed in periodic slots with column maps (i.e., given a date and column map value, find the corresponding slot value).

NUMERIC

Type

Meaning

SLOT

The periodic slot to be accessed.

DATETIME

The date to be used to index into the time dimension of the Periodic Slot (its row map).

NUMERIC

The value to use for the lookup, having the same type of units as the values in the periodic slot itself.

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 input slot must be a periodic slot with a column map, the numeric value must have units compatible with the units of the periodic slot, for the relevant time intervals, the slot values must be either a monotonically non-decreasing or monotonically non-increasing function of the column map values, and the input value must fall within the domain of that function. If there are multiple possible return values, i.e., if the input value appears for multiple columns, then the largest column map value is returned.

The index of the table slot or agg. series slot column whose name matches a string.

NUMERIC

Type

Meaning

SLOT

the table slot or agg. series slot in which to find a column

STRING

the name of the column to match

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

Slot column and row indices are zero based and have units of type [NONE]. If the specified slot is not a table slot or agg. series slot, or the specified string is not the label of a column on the slot, this function aborts the run with an error. If several columns of the slot match the string argument, this function evaluates to the index of the left-most matching column.

The matching process treats sequences of white space characters as a blank; for example, the input string “ ab c “ will match a column with the label “ab c.” This allows the method to match labels that are displayed on multiple lines because they contain a carriage return character.

Interpret a string as a date.

DATETIME

Type

Meaning

STRING

Textual representation of a date/time.

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".

Generate a list of datetimes between two datetimes at a given interval.

LIST {DATETIME}

Type

Meaning

DATETIME

starting datetime

DATETIME

ending datetime

STRING

string representation of a datetime interval expressed as an integer, a space, and a time unit.

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.

If the ending date is before the starting date, the function evaluates to an empty list. If the ending date is equal to the starting date, or if the time interval is larger than the interval between the starting and ending dates, the function evaluates to a list which only contains the start date.

Generate a list of datetimes separated by a given interval, and centered at a given date. If desired, dates not within the run duration are filtered out of the list.

LIST {DATETIME}

Type

Meaning

DATETIME

center datetime

NUMERIC

number of dates to return in the list

STRING

string representation of a datetime interval expressed as an integer, a space, and a time unit

BOOLEAN

whether to limit return dates to those within the run

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 accepted datetime interval units are:

The day of the month as a unit of time.

NUMERIC

Type

Meaning

DATETIME

the datetime whose day of month to determine

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.

When displayed, the return value will be displayed according to the active unit scheme’s time unit type rule. For example, if the active unit scheme displays Time values as Hours, then the return value for @”January 2” will be displayed as 48 “hours”.

To convert the return value into a dimensionless value representing the number of days, divide it by 1 “day”.

As elsewhere in RiverWare 24:00 hours is considered to be the day which is ending, and 00:00 hours is considered to be the day which is just beginning.

The day of the year as a one-based integer in units of time.

NUMERIC

Type

Meaning

DATETIME

the datetime whose day of the year to determine

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.

When displayed, the return value will be displayed according to the active unit scheme’s time unit type rule. For example, if the active unit scheme displays Time values as Hours, then the return value for @”January 2” will be displayed as 48 “hours”.

To convert the return value into a dimensionless value representing the number of days, divide it by 1 “day”.

As elsewhere in RiverWare, 24:00 hours is considered to be the day which is ending, and 00:00 hours is considered to be the day which is just beginning.

The number of days in the month in units of time.

NUMERIC

Type

Meaning

DATETIME

the datetime of any time within the month

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.

When displayed, the return value will be displayed according to the active unit scheme’s time unit type rule. For example, if the active unit scheme displays Time values as Hours, then the return value for @”January 2” will be displayed as 744 “hours”.

To convert the return value into a dimensionless value representing the number of days, divide it by 1 “day”.

As elsewhere in RiverWare, 24:00 hours is considered to be the day which is ending, and 00:00 hours is considered to be the day which is just beginning.

This function takes a series or periodic slot and a date and returns the value of the slot at the given date, in units based on the display scale and units for that slot.

NUMERIC

Type

Meaning

SLOT

the series or periodic slot whose value is to be returned

DATETIME

the datetime of the value to be returned

 

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

This function takes an agg series slot or periodic slot, a date, and a column, and returns the value of the slot in the given column and at the given date, in units based on the display scale and units for that slot.

NUMERIC

Type

Meaning

SLOT

the series or periodic slot whose value is to be returned

DATETIME

the datetime of the value to be returned

NUMERIC

the column, interpreted as a 0-based integral index

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.

Return the name of an element in an aggregate object, without the name of the object’s name prepended.

STRING

Type

Meaning

OBJECT

the element of an aggregate object (e.g., a WaterUser within an AggDiversionSite) whose name is to be returned.

The function returns the name of the element object.

This function returns only the name of the element itself, without the name of the parent aggregate object. If the full name is desired, then one may use the built-in RPL operation STRINGIFY.

If the object argument is not an element of an aggregate object, then the run is aborted with an error.

Return the value for a trace keyword for the current trace executing in a run.

STRING

Type

Meaning

STRING

the name of a trace metadata keyword.

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

If the function is called outside of a run or if the trace metadata keyword cannot be found, then the function fails.

This function would typically be called during a multiple run when input ensembles are used in the MRM configuration. If a single trace is configured for an ensemble dataset to use outside of a multiple run and a DMI with this dataset is invoked during a single run, the metadata for that trace would also be available to query.

Return the value for an ensemble keyword for the current run.

STRING

Type

Meaning

STRING

the name of an ensemble metadata keyword.

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

If the function is called outside of a run or if the ensemble metadata keyword cannot be found, then the function fails.

This function would typically be called during a multiple run when input ensembles are used in the MRM configuration. If a single trace is configured for an ensemble dataset to use outside of a multiple run and a DMI with this dataset is invoked during a single run, the metadata for that ensemble would also be available to query.

The Julian date of the timestep in units of NONE.

NUMERIC

Type

Meaning

DATETIME

the datetime whose Julian date to evaluate to

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.

Julian Dates are represented as the number of days from noon GMT on January 1, 4713 B.C. (47120101 12:00 P.M. GMT). Julian Dates in RiverWare also include the decimal fraction of the day down to 0.00001, the equivalent of 1 second.

Given a slot, returns a list of the Objects which contain the slots to which the input slot is linked.

LIST {OBJECT}

Type

Meaning

SLOT

the slots whose links are to be explored

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.

It is considered an error if the input slot is not a Series Slot.

Returns the lower bound for the specified series slot

NUMERIC

Type

Meaning

SLOT

the slot whose bound is to be returned.

 

It is considered an error if the specified slot is not a Series Slot with a valid lower bound. The lower bound is specified in the slot configuration.

Returns the lower bound for the column of the specified agg series slot.

NUMERIC

Type

Meaning

SLOT

the agg series slot whose bound is to be returned.

NUMERIC

the column index (0-based).

 

It is considered an error if the input slot is not an Agg Series Slot with a valid lower bound for the given column. The lower bound is specified in the slot configuration.

The maximum combined outflow of a reservoir, including outlet works or turbine release, and any possible regulated, unregulated, and/or bypass spills.

NUMERIC

Type

Meaning

OBJECT

the reservoir object for which to calculate

NUMERIC

the end of timestep pool elevation

DATETIME

the timestep at which to calculate

The individual outflows are then summed to calculate the maximum outflow.

The Tailwater Base Value is automatically added as a dependency to the calling rule.

The maximum combined outflow of a reservoir, including outlet works or turbine release, and any possible regulated, unregulated, and/or bypass spills.

NUMERIC

Type

Meaning

OBJECT

the reservoir object for which to calculate

NUMERIC

the average inflow over the timestep

DATETIME

the timestep at which to calculate

A convergence algorithm is used in this function; see “Reservoir Convergence” in Objects and Methods for details. The function iterates to convergence by computing the end of timestep storage and pool elevation, the average pool elevation over the timestep, and the following outflows:

Once the iteration has converged on an ending storage and pool elevation, all of the individual outflows are summed to calculate the maximum outflow

This function takes into account the following sources and sinks automatically, and thus they should not be included in the inflow value for Argument 2.

These slots in addition to Tailwater Base Value are automatically added as dependencies to the calling rule.

The maximum combined outflow of a reservoir, including outlet works or turbine release, and any possible regulated, unregulated, and/or bypass spills.

NUMERIC

Type

Meaning

OBJECT

the reservoir object for which to calculate

NUMERIC

the end of timestep storage

DATETIME

the timestep at which to calculate

The ending pool elevation is determined from the ending storage in argument 2 and is averaged with the previous timestep’s ending Pool Elevation to yield an average pool elevation over the timestep. The average pool elevation is then used to compute the following outflows:

The individual outflows are summed to calculate the maximum outflow.

The Tailwater Base Value is automatically added as a dependency to the calling rule.

This function will issue an error if the Time Varying Elevation Volume method is selected (see “Time Varying Elevation Volume” in Objects and Methods) and the specified timestep is a modification date on the table.

The maximum release of a reservoir, through outlet works or turbine release.

NUMERIC

Type

Meaning

OBJECT

the reservoir object for which to calculate

NUMERIC

the average inflow over the timestep

DATETIME

the timestep at which to calculate

A convergence algorithm is used in this function; see “Reservoir Convergence” in Objects and Methods for details. The function iterates to convergence by computing the end of timestep storage and pool elevation, the average pool elevation over the timestep, and the release:

This function takes into account the following sources and sinks automatically, and thus they should not be included in the inflow value for Argument 2.

These slots in addition to Tailwater Base Value are automatically added as dependencies to the calling rule.

The minimum required spill through unregulated and regulated spillways.

NUMERIC

Type

Meaning

OBJECT

the reservoir object for which to calculate

NUMERIC

the average inflow over the timestep

NUMERIC

the average release over the timestep

DATETIME

the timestep at which to calculate

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; see “Reservoir Convergence” in Objects and Methods for details. The function iterates to convergence by computing the end of timestep storage and pool elevation, the average HW over the timestep, and the spill:

This function takes into account the following sources and sinks automatically, and thus they should not be included in the inflow value for Argument 2.

These slots in addition to the previous timestep’s Pool Elevation and Storage are automatically added as dependencies to the calling rule. Since the function evaluation depends on these slots, any change to their values at the indicated timestep, may impact the function result.

The month number, base 1, in units of NONE.

NUMERIC

Type

Meaning

DATETIME

the datetime of any time within the month

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.

As elsewhere in RiverWare, 24:00 hours is considered to be the day which is ending, and 00:00 hours is considered to be the day which is just beginning.

The month name.

STRING

Type

Meaning

DATETIME

the datetime of any time within the month

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.

As elsewhere in RiverWare, 24:00 hours is considered to be the day which is ending, and 00:00 hours is considered to be the day which is just beginning.

Returns a sequence of values in a given range with a given offset.

LIST

Type

Meaning

NUMERIC

the start value

NUMERIC

the end value

NUMERIC

the offset

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 units of all values must be compatible. If the offset is positive and the start value is greater than the end value, the return list is empty; similarly, if the offset is negative and the start value is less than the end value, the return list is empty.

Return the object with a given name.

OBJECT

Type

Meaning

STRING

the name of the object for which to search.

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

If no object with the given name exists on the global workspace, then the run is aborted with an error.

The total debt which can be paid by this object.

NUMERIC

Type

Meaning

OBJECT

the object who’s debt to calculate

DATETIME

the timestep at which to calculate the debt

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.

If the debt slot of a payback supply at the given timestep is not known, its debt is assumed to be zero. If there are no payback supplies on the given object, the total debt is zero.

Return a slot’s parent object.

OBJECT

 

Meaning

SLOT

The slot whose object is returned.

It is an error if the slot is not on a Simulation Object or an account (which is on an Object).

The debt at a payback source.

NUMERIC

Type

Meaning

STRING

the payback source supply whose debt to calculate

DATETIME

the timestep at which to calculate the debt

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.

If the string argument is not a valid supply, or the supply is not a payback source, this function aborts the run with an error. If the debt slot of the payback for which this supply is a source does not contain a value at the given timestep, the function evaluates to zero.

The index of the table slot row whose name matches a string.

NUMERIC

Type

Meaning

SLOT

the table slot in which to find a row

STRING

the name of the row to match

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

Table row and column indices are zero based and have units of type [NONE]. If the specified slot is not a table slot or the specified string is not the label of a row on the slot, this function aborts the run with an error. If several rows of the table slot match the string argument, this function evaluates to the index of the topmost matching row.

Given a slot with rows indexed by date, this function returns the 0-based

index corresponding to a given date.

NUMERIC

Type

Meaning

SLOT

the slot in which to find a row

DATETIME

date of the row to match

The value -1 is returned if the given date is not within the date range of the slot.

This function is applicable to the following types of slot:

It is considered an error if the slot is not indexed by date (i.e, not one of these types).

Returns the 1-based index of the current cycle through the timesteps in the run time range, in units of NONE.

NUMERIC

Type

Meaning

 

 

Rulebased simulations can cycle through the run timesteps more than once each run (see “Run Cycles” in Solution Approaches). This function provides access to the current run cycle, which can be used, for example, within execution constraints to control the cycle on which a rule should execute. If called from outside of a run or when the controller is not Rulebased Simulation or Inline Rulebased Simulation and Accounting, the behavior of this function is undefined.

The number of the currently executing model run, base 1, in units of NONE.

NUMERIC

Type

Meaning

 

 

If the current run is not a Multiple Run Management run, this function evaluates to 1. If called from within a pre-MRM run rule of an iterative MRM run, this function evaluates to 1. If called from within a post-run rule of an iterative MRM, this function evaluates to the index of the run which just completed.

Given an object and a user method category name, return the name of the selected method.

STRING

Type

Meaning

OBJECT

the simulation object

STRING

name of the user method category

An error is issued if the object or the category name is not found.

Returns a list of all of the visible Series Slots on an object.

LIST{SLOT}

Type

Meaning

OBJECT

The object whose Series Slots are to be returned.

If no object with the given name exists on the global workspace, then the run is aborted with an error.

Return the slot with a given name.

SLOT

Type

Meaning

STRING

the name of the slot for which to search.

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

If no slot with the given name exists on the global workspace, then the run is aborted with an error.

Return the slot name portion of a slot’s full name.

STRING

 

Meaning

SLOT

The slot whose name is returned.

If the slot is a column of an aggregate series slot and if it is the first column, then the agg series slot name is returned. If the input slot is a column of an aggregate series slot other than the first column, the column label is returned.

For example, assume that data.Agg is a two column aggregate series slot series slot with columns labeled 'zero' and 'one.' Then:

See also “GetSlotNameAndCol”, which behaves differently when the input slot is an aggregate series slot.

Given a slot, return the slot name portion of the full name, combined with the column label when the input slot is an aggregate series slot or a column of an aggregate series slot.

STRING

 

Meaning

SLOT

The desired aggregate series slot.

For example, assume that data.Agg is a two column aggregate series slot with columns labeled 'zero' and 'one.' Then:

See also “GetSlotName”, which behaves differently when the input slot is an agg. series slot.'

This function evaluates to a list composed of the values of a given series slot within a time range. GetSlotVals can also be used on a periodic slot, while GetSlotValsNaNToZero, cannot.

LIST{NUMERIC}

Type

Meaning

SLOT

the series (or periodic slot) whose values to get

DATETIME

start datetime

DATETIME

end datetime

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.

If the start datetime or end datetime does not match one of the slot’s values’, or if the start datetime is after the end datetime, this function aborts the run with an error. For GetSlotVals, if one of the slot values within the desired time range is a NaN, the function exits the rule with an early termination. For GetSlotValsNaNToZero, it converts any NaNs into zero.

For periodic slots and GetSlotVals, the dates used are those within the range and falling on a run timestep; the column used is the first (column 0).

This function evaluates to a list composed of the values in a column of a given Agg Series Slots (or for GetSlotValsByCol, it could be a periodic slot) within a time range.

LIST{NUMERIC}

Type

Meaning

SLOT

the agg series slot (or for GetSlotValsByCol, it could be a periodic slot) whose values to get

DATETIME

start datetime

DATETIME

end datetime

NUMERIC

the column (interpreted as a 0-based integral index)

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.

If the slot is an Agg Series Slot and the start datetime or end datetime does not match one of the slot’s values’, or if the start datetime is after the end datetime, this function aborts the run with an error. For GetSlotValsByCol, if one of the slot values within the desired time range is a NaN, the function exits the rule with an early termination. For GetSlotValsByColNaNToZero, it converts any NaNs into zero.

For periodic slots and GetSlotValsByCol, the dates used are those within the range and falling on a run timestep.

All of the values of a table slot column between two rows.

LIST{NUMERIC}

Type

Meaning

SLOT

the table slot whose values to get

NUMERIC

column

NUMERIC

start row

NUMERIC

end row

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.

Units are not required for row and column indices and, if provided, will be ignored. If the column, start row, or end row does not exist in the slot, or if the start row is greater than the end row, this function aborts the run with an error.

For the GetTableColumnVals function, if one of the slot values within the desired time range is a NaN, the function exits the rule with an early termination. For the GetTableColumnValsSkipNaN variation of this function, these values are just omitted from the return list.

All of the values of a table slot column between two columns.

LIST{NUMERIC}

Type

Meaning

SLOT

the table slot whose values to get

NUMERIC

row

NUMERIC

start column

NUMERIC

end column

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.

Units are not required for row and column indices and, if provided, will be ignored. If the row, start column, or end column do not exist in the slot, or if the start column is greater than the end column, this function aborts the run with an error.

For the GetTableRowVals function, if one of the slot values within the desired time range is a NaN, the function exits the rule with an early termination. For the GetTableRowValsSkipNaN variation of this function, these values are just omitted from the return list.

Returns the Text Series Slot value as a STRING

STRING

Type

Meaning

SLOT

The text series slot

DATETIME

The timestep at which to lookup

Text Series Slots store text as a number encoded on the slot. See “Text Series Slots” in User Interface.

This function returns the value of the specified Text Series Slot at the specified date as a STRING.

An error will be issued if the slot is not a Text Series Slot or the DATETIME is not fully specified.

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

See “TextSlotNumericToString” for a similar function. See “StringToTextSlotNumeric” for the opposite conversion function.

The length of a timestep, in units of "sec".

NUMERIC

Type

Meaning

DATETIME

the datetime of the end of the timestep

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.

If the given datetime corresponds to the moment when one timestep ends and another begins, this function evaluates to the length of the timestep which is ending. As elsewhere in RiverWare, 24:00 hours is considered to be the day which is ending, and 00:00 hours is considered to be the day which is just beginning.

Returns the upper bound for the given series slot.

NUMERIC

Type

Meaning

SLOT

the slot whose bound is to be returned.

 

It is considered an error if the specified slot is not a series slot with a valid upper bound. The upper bound is specified in the slot configuration under the view menu.

Returns the upper bound for the specified column of the given aggregate series slot.

NUMERIC

Type

Meaning

SLOT

the agg slot whose bound is to be returned.

NUMERIC

the column index (0-based).

 

It is considered an error if the input slot is not an Agg. Series Slot with a valid upper bound for the given column. The upper bound is specified in the slot configuration under the view menu.

The year, expressed as a number in units of NONE.

NUMERIC

Type

Meaning

DATETIME

the datetime

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.

As elsewhere in RiverWare, 24:00 hours is considered to be the day which is ending, and 00:00 hours is considered to be the day which is just beginning.

The year as a string.

STRING

Type

Meaning

DATETIME

the datetime

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.

As elsewhere in RiverWare, 24:00 hours is considered to be the day which is ending, and 00:00 hours is considered to be the day which is just beginning.

Use to test the flag status of a slot at a given datetime.

BOOLEAN

Type

Meaning

SLOT

The slot to test

DATETIME

The datetime at which to test

STRING

The flag to test. The flag is specified by string, which can be the single letter version of the flag or the full flag name:

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

An error is returned if the slot is not a Series Slot or if the date is not a legal timestep for that slot.

Returns whether or not the rule with a given name has successfully executed (with or without effect) during the current timestep of a rulebased simulation.

BOOLEAN

Type

Meaning

STRING

The name of the rule. The special string "Current Rule" or “ThisRule” (not case sensitive) is interpreted as a reference to the currently executing rule.

This function returns TRUE if:

The function returns FALSE if

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

HasRuleFiredSuccessfully behave as follows for the various RPL Sets:

Calculates the additional outflow necessary to meet an unmet load, if any exists. The function limits the additional release to ensure that additional downstream flooding does not occur.

LIST { LIST { SLOT, NUMERIC, OBJECT } }

Type

Meaning

STRING

the name of the computational subbasin

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.

2. Runs the selected Additional Hydropower Release method on the each power reservoir in the subbasin to calculate the proposed additional release required to meet the load within outflow constraints.

3. In order of priority, hypothetically makes the additional release, visits downstream control points until it reaches a tandem reservoir or the end of the subbasin, whichever comes first. If the release causes (additional) flooding at a control point, it reduces the release until flooding is not caused or the release becomes zero. Resulting releases are then hypothetically routed to downstream control points to make adjustments to their available space hydrographs.

A control point’s available space hydrograph (in units of flow projected into the future based on the routing coefficients on the control point) is calculated as:

Inflow includes the value of the Inflow slot (at the time of the last dispatch) and the additional inflow resulting from the hypothetical additional releases from upstream reservoirs. It also contains the proposed flood control release hydrograph from the last pass of the flood control method.

Once all power reservoirs have been visited (in priority order), the HydropowerRelease function returns to the calling rule. For each reservoir in the subbasin, three triplets may be returned:

The calling rule is expected to make the assignments of the values to the slots.

This function is dependent on having executed the predefined function FloodControl() on a computational subbasin using the Operating Level Balancing method. This flood control method operation sets up the network topology and necessary data. HydropowerRelease requires that the reservoirs in the subbasin have already dispatched and have valid values in the Regulation Discharge, Outflow, Energy, and Load slots.

See “HydropowerRelease Function—Detailed Description of Logic” in USACE‑SWD Modeling Techniques for details on using this function for USACE-SWD.

Hypothetically simulate a portion of the workspace with user input values and return requested result values.

LIST {NUMERIC}

Type

Meaning

STRING

Subbasin name over which to perform the hypothetical simulation.

If there is no Subbasin with the given name, the string is taken to be the name of an object and a temporary Subbasin is created containing only that object.

An error will be issued if this subbasin contains a Data Object.

LIST { LIST { SLOT, NUMERIC, DATETIME } }

Fixed values the user would like to set in each hypothetical simulation. Each item in the list is a list itself containing a slot, the value to set, and the timestep at which to set it.

LIST { LIST { SLOT, DATETIME } }

Outputs to get back from the simulation - each output must specify the slot and the timestep from which to return a value

NUMERIC

The minimum number of timesteps before and after the current timestep which might be involved in the simulation. As part of hypothetical simulation RiverWare makes copies of the objects in the subbasin and this input is used to determine how much data should be copied from each object. One can usually set this value to 0 and RiverWare will use a heuristic to determine the range over which to copy data. If this function fails because there was not enough data on some object, then input a higher value.

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.

This simulation is hypothetical in that none of the actual values on any objects in the workspace will be modified by hypothetical simulation within a rule. HypSim does not support accounting or optimization functionality.

See “Hypothetical Simulations”; all comments mentioned there apply here as well.

Given a control slot and a limit slot, limit date/time, and limit value, this function uses hypothetical simulation (see description of the predefined function HypSim) to find a value x such that if the control slot were set to x at all timesteps in the range [current date, target date], then the limit slot’s maximum value in this range would equal the target value. If the value x exceeds the physical constraint for that slot at a particular timestep (max outflow on a reservoir for example), then the constrained value is used instead of the x value for that timestep.

NUMERIC

Type

Meaning

STRING

The name of the Subbasin over which to perform the hypothetical simulations. This should include the objects on which the control and limit slot exist as well as all other objects necessary to compute the limit slot’s value.

If there is no Subbasin with the given name, the string is taken to be the name of an object and a temporary Subbasin is created containing only that object.

An error will be issued if this subbasin contains a Data Object.

SLOT

The control slot, the slot with which you desire to control the target slot’s value.

NUMERIC

The minimum control slot value. A value less than this is not considered a legal return value.

NUMERIC

The maximum control slot value. A value greater than this is not considered a legal return value.

LIST { LIST { SLOT, NUMERIC, DATETIME } }

Fixed values the user would like to set in each hypothetical simulation. Each item in the list is a list itself containing a slot, the value to set, and the timestep at which to set it.

SLOT

The limit slot, the slot whose value you would like to attain a certain value.

DATETIME

The end limit date/time, the end of the time range during which you are concerned with the limit slot’s value.

NUMERIC

The limit value, the value which you would like the limit slot to achieve but not exceed during the limiting time range.

NUMERIC

The tolerance or desired accuracy of the returned value. If the function is successful, it indicates that setting the control slot to the returned value will lead to a maximum limit slot value which differs by no more than the tolerance from the desired limit value.

NUMERIC

The maximum number of iterations of hypothetical simulations allowed. If this number is reached without finding an return value within the tolerance, then the function fails.

NUMERIC

The minimum number of timesteps before and after the current timestep which might be involved in the simulation. As part of hypothetical simulation RiverWare makes copies of the objects in the subbasin and this input is used to determine how much data should be copied from each object. One can usually set this value to 0 and RiverWare will use a heuristic to determine the range over which to copy data. If this function fails because there was not enough data on some object, then input a higher value.

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

RiverWare assumes that the target value range (computed using the minimum and maximum control slot values) includes the target value itself. For example, if the control slot minimum of 100 cfs leads to a simulated target value of 100 cfs. the control slot maximum of 1000 cfs leads to a simulated target slot value of 200 cfs, and the target value is 300 cfs, then the function would fail because the target value is not in the range implied by the input control slot minimum and maximum values (100-200 cfs). Mathematically, this is the assumption that limit slot’s value is a monotonic function of the control slot’s value.

See “Hypothetical Simulations”; all comments mentioned there apply here as well.

Given a control slot and a limit slot, limit end date/time, and limit value, this function uses hypothetical simulation (see description of the predefined function HypSim) to find a value x such that if the control slot were set to x at all timesteps in the range [current date, end limit date], then the limit slot’s maximum value in this range would equal the target value. If the value x exceeds the physical constraint for that slot at a particular timestep (max outflow on a reservoir for example), then the constrained value is used instead of the x value for that timestep.

A four-item list is returned. The first item in the list is a boolean TRUE value if a satisfying control slot value was found, FALSE otherwise. If the first item is TRUE, then the second item is the satisfying control slot value, otherwise this value is as close as the function could get to finding such a value. The third item is a list of the control slot values used in the solution. These values will all be the same as the second item, except if some of the values were constrained due to physical limitations. The fourth item is a list of the limit slot values that correspond to the control slot values given in the previous list.

LIST {BOOLEAN, NUMERIC, LIST, LIST}

Type

Meaning

STRING

The name of the Subbasin over which to perform the hypothetical simulations. This should include the objects on which the control and limit slot exist as well as all other objects necessary to compute the limit slot’s value.

If there is no Subbasin with the given name, the string is taken to be the name of an object and a temporary Subbasin is created containing only that object.

An error will be issued if this subbasin contains a Data Object.

SLOT

The control slot, the slot with which you desire to control the target slot’s value.

NUMERIC

The minimum control slot value. A value less than this is not considered a legal return value.

NUMERIC

The maximum control slot value. A value greater than this is not considered a legal return value.

LIST { LIST { SLOT, NUMERIC, DATETIME } }

Fixed values the user would like to set in each hypothetical simulation. Each item in the list is a list itself containing a slot, the value to set, and the timestep at which to set it.

SLOT

The limit slot, the slot whose value you would like to attain a certain value.

DATETIME

The end limit date/time, the end of the time range during which you are concerned with the limit slot’s value.

NUMERIC

The limit value, the value which you would like the limit slot to achieve but not exceed during the limiting time range.

NUMERIC

The tolerance or desired accuracy of the returned value. If the function is successful, it indicates that setting the control slot to the returned value will lead to a maximum limit slot value which differs by no more than the tolerance from the desired limit value.

NUMERIC

The maximum number of iterations of hypothetical simulations allowed. If this number is reached without finding an return value within the tolerance, then the function fails.

NUMERIC

The minimum number of timesteps before and after the current timestep which might be involved in the simulation. As part of hypothetical simulation RiverWare makes copies of the objects in the subbasin and this input is used to determine how much data should be copied from each object. One can usually set this value to 0 and RiverWare will use a heuristic to determine the range over which to copy data. If this function fails because there was not enough data on some object, then input a higher value.

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

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.

See also documentation for HypLimitSim for more details; the differences between these two functions are how problems are dealt with, this function is more flexible (as described in the Evaluation section).

See “Hypothetical Simulations”; all comments mentioned there apply here as well.

Given a control slot and a target slot, target date/time, and target value, this function uses hypothetical simulation (see description of the predefined function HypSim) to find a value x such that if the control slot were set to x at all timesteps in the range [current date, target date], then the target slot’s value would equal the target value. If the value x exceeds the physical constraint for that slot at a particular timestep (max outflow on a reservoir for example), then the constrained value is used instead of the x value for that timestep.

NUMERIC

Type

Meaning

STRING

The name of the Subbasin over which to perform the hypothetical simulations. This should include the objects on which the control and target slot exist as well as all other objects necessary to compute the target slot’s value.

If there is no Subbasin with the given name, the string is taken to be the name of an object and a temporary Subbasin is created containing only that object.

An error will be issued if this subbasin contains a Data Object.

SLOT

The control slot, the slot with which you desire to control the target slot’s value.

NUMERIC

The minimum control slot value. A value less than this is not considered a legal return value.

NUMERIC

The maximum control slot value. A value greater than this is not considered a legal return value.

LIST { LIST { SLOT, NUMERIC, DATETIME } }

Fixed values the user would like to set in each hypothetical simulation. Each item in the list is a list itself containing a slot, the value to set, and the timestep at which to set it.

SLOT

The target slot, the slot whose value you would like to attain a certain value.

DATETIME

The target date/time, the timestep at which you would like the target slot to attain the desired value.

NUMERIC

The target value, the value which you would like the target slot to achieve at the target date/time.

NUMERIC

The tolerance or desired accuracy of the returned value. If the function is successful, it indicates that setting the control slot to the returned value will lead to a value which differs by no more than the tolerance from the desired target value.

NUMERIC

The maximum number of iterations of hypothetical simulations allowed. If this number is reached without finding an return value within the tolerance, then the function fails.

NUMERIC

The minimum number of timesteps before and after the current timestep which might be involved in the simulation. As part of hypothetical simulation RiverWare makes copies of the objects in the subbasin and this input is used to determine how much data should be copied from each object. One can usually set this value to 0 and RiverWare will use a heuristic to determine the range over which to copy data. If this function fails because there was not enough data on some object, then input a higher value.

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.

RiverWare assumes that the target value range (computed using the minimum and maximum control slot values) includes the target value itself. For example, if the control slot minimum of 100 cfs leads to a simulated target value of 100 cfs. the control slot maximum of 1000 cfs leads to a simulated target slot value of 200 cfs, and the target value is 300 cfs, then the function would fail because the target value is not in the range implied by the input control slot minimum and maximum values (100-200 cfs). Mathematically, this is the assumption that target slot’s value is a monotonic function of the control slot’s value.

See “Hypothetical Simulations”; all comments mentioned there apply here as well.

Given a control slot and a target slot, target date/time, and target value, this function uses hypothetical simulation (see description of the predefined function HypSim) to find a value x such that if the control slot were set to x at all timesteps in the range [current date, target date], then the target slot’s value would equal the target value. If the value x exceeds the physical constraint for that slot at a particular timestep (max outflow on a reservoir for example), then the constrained value is used instead of the x value for that timestep.

A three-item list is returned. The first item in the list is a boolean TRUE value if a satisfying control slot value was found, FALSE otherwise. If the first item is TRUE, then the second item is the satisfying control slot value, otherwise this value is as close as the function could get to finding such a value. The third item is a list of the control slot values used in the solution. These values will all be the same as the second item, except if some of the values were constrained due to physical limitations.

LIST {BOOLEAN, NUMERIC, LIST}

Type

Meaning

STRING

The name of the Subbasin over which to perform the hypothetical simulations. This should include the objects on which the control and target slot exist as well as all other objects necessary to compute the target slot’s value.

If there is no Subbasin with the given name, the string is taken to be the name of an object and a temporary Subbasin is created containing only that object.

An error will be issued if this subbasin contains a Data Object.

SLOT

The control slot, the slot with which you desire to control the target slot’s value.

NUMERIC

The minimum control slot value. A value less than this is not considered a legal return value.

NUMERIC

The maximum control slot value. A value greater than this is not considered a legal return value.

LIST { LIST { SLOT, NUMERIC, DATETIME } }

Fixed values the user would like to set in each hypothetical simulation. Each item in the list is a list itself containing a slot, the value to set, and the timestep at which to set it.

SLOT

The target slot, the slot whose value you would like to attain a certain value.

DATETIME

The target date/time, the timestep at which you would like the target slot to attain the desired value.

NUMERIC

The target value, the value which you would like the target slot to achieve at the target date/time.

NUMERIC

The tolerance or desired accuracy of the returned value. If the function is successful, it indicates that setting the control slot to the returned value will lead to a value which differs by no more than the tolerance from the desired target value.

NUMERIC

The maximum number of iterations of hypothetical simulations allowed. If this number is reached without finding an return value within the tolerance, then the function fails.

NUMERIC

The minimum number of timesteps before and after the current timestep which might be involved in the simulation. As part of hypothetical simulation RiverWare makes copies of the objects in the subbasin and this input is used to determine how much data should be copied from each object. One can usually set this value to 0 and RiverWare will use a heuristic to determine the range over which to copy data. If this function fails because there was not enough data on some object, then input a higher value.

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

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.

See also documentation for HypTargetSim for more details; the differences between these two functions are how problems are dealt with, this function is more flexible (as described in the Evaluation section).

See “Hypothetical Simulations”; all comments mentioned there apply here as well.

Returns a string representation of a numeric value interpreted as an integer.

STRING

Type

Meaning

NUMERIC

a value

Given a numeric value, IntegerToString returns a string representation of that value rounded to the nearest integer and with the units removed.

This function uses the RPL units of the specified NUMERIC. In the example, below, the RPL units are cfs as it is a literal value. But, if you reference a slot value, it will return the string using the relevant RPL units, which are often, but not always, internal units, cms, m, etc...

For more flexibility with units, see “IntegerWithUnitsToString”.

Returns a string representation of a numeric value interpreted as an integer after the specified value is converted to the given units.

STRING

Type

Meaning

NUMERIC

a value to convert and truncate

NUMERIC

a value whose units are those to which the first value should be converted

Given a numeric value, IntegerWithUnitsToString converts that value to the display units of a second input value, and then returns a string representation of the converted value with the fractional part of the value and the units removed.

It is an error if the two numeric input values do not have compatible units (i.e., are not of the same unit type).

For the second argument, only its display units are involved in the computation; the scalar portion of this value is ignored. This value should typically be specified as a literal value, not the result of computation or lookup on a slot, so that the units of this value will be known with certainty.

Returns true if and only if the current controller is Optimization.

BOOLEAN

 

Meaning

 

 

Returns true if and only if the current controller is Rulebased Simulation (RBS) or Inline Rulebased Simulation and Accounting.

BOOLEAN

 

Meaning

 

 

Returns true if and only if the current controller is Simulation or Inline Simulation and Accounting.

BOOLEAN

 

Meaning

 

 

Returns true if and only if the input value (rounded down) is even.

BOOLEAN

Type

Meaning

NUMERIC

a value

NUMERIC

the units in which to determine evenness.

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

 

The input status of a slot at a given datetime.

BOOLEAN

Type

Meaning

SLOT

the series slot

DATETIME

the datetime

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 “HasFlag”, which is a similar but more general function.

Returns true if and only if the input value (rounded down) is odd.

BOOLEAN

Type

Meaning

NUMERIC

a value

NUMERIC

the units in which to determine oddness.

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

 

Whether or not a given datetime is in a leap year (containing 366 days instead of 365).

BOOLEAN

Type

Meaning

DATETIME

the datetime

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.

 

This function evaluates to a list of linked downstream objects that are between two specified objects, inclusive.

LIST {OBJECT}

Type

Meaning

OBJECT

The upstream object at which to start the search

OBJECT

The downstream object at which to finish the search

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.

Notes / Limitations to this function:

Agg Diversion Site

Total Outflow

Agg Distribution Canal

Total Return Flow

Agg Reach,

Confluence,

Control Point,

Distribution Canal,

Groundwater,

Inline Power,

Inline Pump,

Pipeline,

Reach,

Reservoir

Outflow

Bifurcation

Outflow1, Outflow2

Diversion Object,

NONE

Pipe Junction

Flow 1, Flow 2

Stream Gage

Gage Outflow

Water User

NONE

The slots in the given Slot Set.

LIST {SLOTS}

Type

Meaning

STRING

The name of a Slot Set defined in the model.

The Slot Sets in the model are searched for a match to the given string. Then, a list is generated from the member slots of that set.

Both static and dynamic Slot Sets may be referenced. Dynamic Slot Sets are resolved when the function is called. Member slots are listed in the order in which they appear in the Slot Set Manager dialog (from the Workspace, use the Workspace->Slots->Slot Set Management...). If there is no Slot Set with the given name in the model, this function aborts the run with an error.

The objects in the given subbasin.

LIST {OBJECT}

Type

Meaning

STRING

the name of the subbasin

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.

Both predefined and user defined subbasins may be referenced. Member objects are listed in the order in which they appear in the Edit Subbasins dialog. If there is no subbasin with the given name in the model, this function aborts the run with an error.

The natural logarithm of a number.

NUMERIC

Type

Meaning

NUMERIC

the value

NUMERIC

the units in which to compute the logarithm

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.

The natural logarithm may only be evaluated for values greater than zero. This function aborts the run with an error, if it is evaluated with a value less than or equal to zero.

The two arguments must have compatible units, otherwise the run is aborted with an error.

This function does not use the scalar portion of the units argument.

The base10 logarithm of a number.

NUMERIC

Type

Meaning

NUMERIC

the value

NUMERIC

the units in which to compute the logarithm

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 base10 logarithm may only be evaluated for values greater than zero. This function aborts the run with an error, if it is evaluated with a value less than or equal to zero.

The two arguments must have compatible units, otherwise the run is aborted with an error.

This function does not use the scalar portion of the units argument.

The greater value.

NUMERIC

Type

Meaning

NUMERIC

the first value

NUMERIC

the second value

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

If the values are of a different unit type, this function aborts the run with an error.

The greatest value.

NUMERIC

Type

Meaning

LIST

the list of values