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

Description Usage Arguments Value Author(s) See Also

View source: R/baseFlowSeparation.default.R

Description

Methods for separating baseflow for a given flow discharge

Usage

1
2
3
4
5
6
7
## Default S3 method:
baseFlowSeparation(discharge,BFSMethod='none'       ,
                                     BFSParams=list(alpha=NULL        ,
                                                    BFI=NULL          ,
                                                    k=NULL            ,
                                                    timeInterval=NULL),
                                     plot=FALSE)

Arguments

discharge

a vector of flow time series (cms) or an object inherited from class of 'transform'

BFSMethod

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

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

plot

(optional) logical statement to plot the result or not. default to FALSE

Value

a list: an object from class of baseFlowSeparation consisting matrix of results available at object$operation.

Author(s)

Rezgar Arabzadeh

See Also

createSubbasin


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