createSubbasin.base {RHMS}

base function for class of createSubbasin

Description

instantiates an object from class of createSubbasin

Usage

## S3 method for class 'base'
createSubbasin(name,precipitation,
      inflow,Area,delayInflow,downstream,
      transformMethod,lossMethod,BFSMethod,UH,
      abstractionParams,transformParams,lossParams,BFSParams)

Arguments

name

(optional): a string: the name of sub-basin to be instantiated

precipitation

a vector : a time series of precipitation hytograph (mm)

inflow

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

Area

the area of basin (Km^2)

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.

transformMethod

a string: the type of transformation method. Available types: "SCS", "snyder", and "user" for user defined unit hydrograph. default to "SCS"

lossMethod

a string: the type of loss method. Available types: "SCS" and "horton"

BFSMethod

a string: The method of base flow separation. Available methods: 'nathan', 'chapman', 'eckhardt', 'recession'

UH

a data.frame: including the ordinates of user UH. the HU first collumn indicates time (Hr) and second collumn include flow rates (cms)

abstractionParams

a list: including parameters of simple surface and simple canopy methods.

• canopyAbstaction depth of canopy abstraction in (mm)

• surfaceAbstaction depth of surface abstraction in (mm)

BFSParams

a list including parameters associated with the method coerced in 'BFSMethod'.

• alpha is in [0, 1] interval required for 'nathan', 'chapman', and 'eckhardt' methods

• BFI is in [0, 1] interval required for 'eckhardt' method

• k is in [0, 1] interval and timeInterval is in day required for 'recession' method

transformParams

a list of parameters associated to the selcted type of transformMethod:

• Tlag for "SCS" method in (Hours)

• Ct, Cp, L, and Lc for "snyder" method

lossParams

a list of parameters associated to the selcted type of lossMethod:

• CN for "SCS" method

• f0, f1, k other for "horton" method

Value

a list: a list features for the constructed sub-basin

Author(s)

Rezgar Arabzadeh

See Also

addObjectToBasin