RHMS (version 1.7)

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,
                      geometry=list(storageElevationCurve=NULL,
                                    dischargeElevationCurve=NULL,
                                    capacity=NULL),
                                  initialStorage = NA,
                                  delayInflow = 1, downstream = NA)

Arguments

name

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

inflow

(optional): a vector of direct/lateral inflow (cms)

geometry

a list of geometric specifications of the reservoir:

• storageElevationCurve: 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)

• dischargeElevationCurve: 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)

• storage: the maximum volume of reservoir capacity (MCM)

initialStorage

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

delayInflow

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

downstream

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

Value

a list: an object from class of createReservoir

See Also

addObjectToBasin