createDiversion.default: default function for class of 'createDiversion'

Description Usage Arguments Value Author(s) See Also

View source: R/createDiversion.default.R

Description

instantiates an object from class of createDiversion

Usage

1
2
## Default S3 method:
createDiversion(name="Unttitled",downstream=NA,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 list instantiated by createDiversion

Author(s)

Rezgar Arabzadeh

See Also

addObjectToBasin


RHMS documentation built on May 1, 2019, 9:08 p.m.