Learn R Programming
RHMS (version 1.6)

createSubbasin.default: default function for class of createSubbasin

Description

instantiates an object from class of createSubbasin

Usage

# S3 method for default
createSubbasin(name="Unttitled",
       precipitation,inflow=NA,Area,delayInflow=1,
       downstream=NA,
       transformMethod="SCS",
       lossMethod="none",
       BFSMethod='none',
       UH=NA,
       abstractionParams=list(canopyAbstraction=NULL,surfaceAbstraction=NULL),
       transformParams=list(Tlag=NULL,Cp=NULL,Ct=NULL,L=NULL,Lc=NULL),
       lossParams=list(CN=NULL,f0=NULL,f1=NULL,k=NULL),
       BFSParams=list(alpha=NULL,BFI=NULL,k=NULL))

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 rather than flows comming from upstream (cms)

Area

the area of basin (Km^2)

delayInflow

(optional): an integer presenting the time steps to delay direct 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: an object from class of createSubbasin

See Also

addObjectToBasin