RHMS (version 1.3)

createReach.default: default function for class of createReach

Description

instantiates an object from class of createReach

Usage

# S3 method for default
createReach(name="Unttitled",routingMethod="muskingum",inflow=NA,
                              routingParams=list(k=3,x=0.2,bedWith=NULL,
                                                 sideSlope=2,channelSlope=NULL,
                                                 manningRoughness=0.025,riverLength=NULL),
                              delayInflow=1,label,downstream=NA)

Arguments

name

a string: the name of reach to be instantiated

routingMethod

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

inflow

a vector (optional): a time series of direct inflow rather than flows comming from upstream (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

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 createReach

See Also

addObjectToBasin