RHMS (version 1.2)

createReservoir.default: default function for class of createReservoir

Description

instantiates an object from class of createReservoir

Usage

# S3 method for default
createReservoir(name = "Unttitled", inflow = NA, ratingCurve,
                                  dischargeCurve, initialStorage, capacity,
                                  delayInflow = 1, label, downstream = NA)

Arguments

name

a string: the name of reservoir to be instantiated

inflow

a vector (optional): a time series of direct inflow rather than flows comming from upstream (cms)

ratingCurve

a data frame: a data frame at which its first collumn includes height (masl) and second collums presents equivalant volume to the height at first collumn (MCM)

dischargeCurve

a data frame: a data frame at which its first collumn includes height (masl) and second collums presents equivalant discharge rate to the height at first collumn (cms)

initialStorage

the initial storage of reservoir at the first time step of simulation (MCM)

capacity

the maximum volume of reservoir capacity (MCM)

delayInflow

an integer (optional): presenting the time steps to delay direct inflow time series

label

an integer: a unique number, as label

downstream

an integer: the code of downstream object

Value

a list: an object from class of createReservoir

See Also

addObjectToBasin