createDiversion.base {WRSS}

base function for class of createDiversion

Description

this function constructs an object from class of createDiversion, acting as a diversion dam which is able to divert water up to a specified capacity.

Usage

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

Arguments

name

(optional) A string: the name of the diversion

capacity

The maximum capacity of diversion dam (CMS).

divertObject

(optional) An object from either of classes of createAquifer , createRiver, createReservoir, createJunction, createDiversion, or createDemandSite; which recieves the diverted water volume.

downstream

(optional) An object from either of classes of createAquifer , createRiver, createReservoir, createJunction, createDiversion, or createDemandSite; which overflow volume pours to it.

priority

(optional) An integer: the supplying priority. priority is a value in [1, 99] interval. If missing, the priority is set to Inf.

Value

An object from class of list

See Also

createDiversion