Skip to content

StateDMI / Command / SetDiversionAggregate

Overview

The SetDiversionAggregate command (for StateCU and StateMod) sets diversion aggregate part identifier data for a diversion:

  • a CU Location that corresponds to a diversion or D&W node
  • a StateMod diversion station

Diversion aggregates are specified using a list of ditch identifiers, and the aggregation information applies for the full model period (does not vary by year). To facilitate processing, it is often best to use list files to specific aggregates (see SetDiversionAggregateFromList). Aggregates by convention have their water rights grouped into classes. Alternatively, to represent all water rights at a location, use a system (see the similar SetDiversionSystem) command. See also the StateDMI Introduction chapter, which provides additional information about aggregates and other modeling conventions. Aggregate information should be specified after diversion locations are defined and before their use in other processing, such as reading data from HydroBase.

Command Editor

The following dialog is used to edit the command and illustrates the command syntax.

SetDiversionAggregate command editor

SetDiversionAggregate Command Editor (see also the full-size image)

Command Syntax

The command syntax is as follows:

SetDiversionAggregate(Parameter="Value",...)

Command Parameters

Parameter             Description Default          
ID
required		 The diversion identifier to associate with the collection of individual diversions. None – must be specified.
PartIDs
required		 The list of part identifiers to comprise the aggregate, for example ditch WDIDs that will be found in HydroBase. The part identifiers are by default of type Ditch. None – must be specified.
IfNotFound Used for error handling, one of the following:
  • Fail – generate a failure message if the identifier is not matched
  • Ignore – ignore (don’t add and don’t generate a message) if the identifier is not matched
  • Warn – generate a warning message if the identifier is not matched
 Warn

Examples

See the automated tests.

Troubleshooting

See the main troubleshooting documentation

See Also