createDiversion.base {RHMS}

base function for class of createDiversion

Description

instantiates an object from class of createDiversion

Usage

## S3 method for class 'base'
createDiversion(name,downstream,divertTo,capacity)

Arguments

name

(optional) a string: the name of diversion to be instantiated

downstream

(optional) an object from either of classes: createDiversion, createReservoir, createSubbasin, createJunction, createReach.

divertTo

an object from either of classes: createDiversion, createReservoir, createSubbasin, createJunction, createReach.

capacity

diversion capacity (cms)

Value

a list: an object from class of createDiversion

Author(s)

Rezgar Arabzadeh

See Also

addObjectToBasin