createReach.base {RHMS}

base function for class of createReach

Description

instantiates an object from class of createReach

Usage

## S3 method for class 'base'
createReach(name,routingMethod,inflow,
                           routingParams,
                           delayInflow,downstream)

Arguments

name

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

routingMethod

a string: the method of channel routing. available types: "muskingum", and "muskingumcunge". default to "muskingum"

inflow

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

routingParams

a list : parameters associated to the routingMethod:

• k and x for "muskingum",

• bedWith (m), sideSlope (m/m), channelSlope (m/m), manningRoughness, riverLength (Km) for "muskingumcunge"

delayInflow

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

downstream

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

Value

a list: an object from class of createReach

Author(s)

Rezgar Arabzadeh

See Also

addObjectToBasin