createReach.default: default function for class of 'createReach'

In RHMS: Hydrologic Modelling System for R Users

Description

instantiates an object from class of createReach

Usage

## Default S3 method:
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,downstream=NA)

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 direct/lateral (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 time series
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

RHMS documentation built on Sept. 27, 2021, 5:06 p.m.