createSubbasin.default {RHMS} | R Documentation |
default function for class of createSubbasin
Description
instantiates an object from class of createSubbasin
Usage
## Default S3 method:
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/lateral inflow (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: |
transformMethod |
a string: the type of transformation method. Available types: |
lossMethod |
a string: the type of loss method. Available types: |
BFSMethod |
a string: The method of base flow separation. Available methods: |
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.
|
BFSParams |
a list including parameters associated with the method coerced in
|
transformParams |
a list of parameters associated to the selcted type of
|
lossParams |
a list of parameters associated to the selcted type of
|
Value
a list: an object from class of createSubbasin
Author(s)
Rezgar Arabzadeh