FloodControl

This function invokes the selected Flood Control method on a computational subbasin .

Description

Invokes computational subbasin’s selected Flood Control method.

Type

LIST { LIST { SLOT, NUMERIC, OBJECT } }

Arguments

Type

Meaning

1

STRING

the name of the computational subbasin

Evaluation

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.

Comments

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

Use of this function for USACE-SWD is described .

 
FloodControl("Flood Basin") where "Flood Basin" contains Res1 and Res2.
 
{ {"Res1.Outflow", 6344.32 "cfs", "Res1"},
{"Res1.Flood Control Release", 6344.32 "cfs", "res1"},
{"Res1.Target Balance Level", 8.32, "res1"} ,
{"Res2.Outflow", 3243.02 "cfs", "Res2"},
{"Res2.Flood Control Release", 2312.20 "cfs", "Res2"},
{"Res2.Target Balance Level", 8.32, "Res2"} }
 
FOREACH (LIST triplet IN FloodControl( "Flood Basin" )) DO
( triplet<0> )[] = triplet<1>
ENDFOREACH