StateDMI / Command / CalculateWellStationEfficiencies

Overview
Command Editor
Command Syntax
Examples
Troubleshooting
See Also

Overview

This command is generally not used with current modeling procedures. Instead, a variable efficiency approach is used where monthly average efficiencies are computed in StateCU and are set in well stations using a SetWellStationsFromList(...,EffMonthlyCol=...) command. This command is retained to duplicate previous work.

The CalculateWellStationEfficiencies command (for StateMod) calculates average monthly efficiencies for well stations and updates the well station information in memory. Efficiencies are calculated as irrigation water requirement divided by historical well pumping time series. The detailed results of calculations can optionally be printed to a report file. The well historical pumping time series (monthly) and irrigation water requirement time series (monthly) should be read or created with other commands, and should be filled before efficiency calculations, if appropriate. Only StateMod well stations with demand type of 1 (monthly total demand) will be processed. The output year type must be specified correctly because efficiencies are stored in diversion stations according to the year type for the StateMod data set. A WriteWellStationsToStateMod command must be executed to actually write the updated efficiency data.

Command Editor

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

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

Command Syntax

The command syntax is as follows:

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

Command Parameters

Parameter	Description	Default
`ID` required	A single well station identifier to match or a pattern using wildcards (e.g., `20*`).	None – must be specified.
`EffMin`	Minimum efficiency to allow, percent. Calculated efficiencies less than this value will be set to the minimum.	Do not constrain the efficiency.
`EffMax`	Maximum efficiency to allow, percent. Calculated efficiencies greater than this value will be set to the maximum.	Do not constrain the efficiency.
`EffCalcStart`	The start date (e.g., `YYYY-MM`) for efficiency calculations. Use this to limit the period for data considered in calculations.	Use the full period.
`EffCalcEnd`	The end date (e.g., `YYYY-MM`) for efficiency calculations. Use this to limit the period for data considered in calculations.	Use the full period.
`LEZeroInAverage`	If true, values less than or equal to zero will be considered when computing monthly time series averages. If false, values less than or equal to zero will be excluded from the averages.	`True`
`EffReportFile`	If specified, a high-detail report will be created, listing for each well station the irrigation water requirement, historical well pumping, and resulting efficiency values. Creating the report slows processing.	If blank, no report is generated.
`IfNotFound`	Used for error handling, one of the following: `Fail` – generate a failure message if the `ID` is not matched `Ignore` – ignore (don’t add and don’t generate a message) if the `ID` is not matched `Warn` – generate a warning message if the `ID` is not matched	`Warn`

Examples

See the automated tests.

Troubleshooting

See the main troubleshooting documentation