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

In WRSS: Water Resources System Simulator

default function for class of createDemandSite

Description

this function constructs an object from class of createDemandSite, which represents a demand site such as domestic, agricultural, and etc, with a specified demand time series.

Usage

## Default S3 method:
createDemandSite(name  ="Unknown",
         demandTS          =NA                     ,
         demandParams=list(waterUseRate=NULL       ,
                           waterVariation=NULL     ,
                           cropArea=NULL)          ,
         returnFlowFraction =0.0                   ,
         suppliers          = NA                   ,
         downstream         =NA                    ,
         priority           =NA)  

Arguments

name	(optional) A string: the name of the demand site
demandTS	A vector: a vector of demand time series (MCM). If demandParams is null, providing the demandTS is compulsory.
demandParams	A list: If demandTS is missing, the demandParams must be provided to establish demandTS. The demandParams includes three parts as follows: waterUseRate: The total water demand per hectare (MCM) per a given water cycle. waterVariation: A vector of the precentages for water demand distribution within a water cycle (the precentages in each interval). For instance, if the cycle is annually and the interval is 'month'ly, the waterVariation could be a vector of length of 12, for which its indices signify the monthly portion of water demand, in precentage, by the total water demand required for the whole cycle. cropArea: the area of cropping farms (in hectare).
returnFlowFraction	(optional) returnFlowFraction is fraction of total supplied water to the demand site. The return flow is computed as the product of returnFlowFraction and the amount of water the demand sites receives. returnFlowFraction must be in [0, 1] interval.
suppliers	(optional) A list of object(s) inherited from the folowing classes: createAquifer, createRiver, createReservoir, codecreateDiversion.
downstream	(optional) An object from either of classes of createAquifer , createRiver, createReservoir, createJunction, createDiversion, or createDemandSite; which return flow volume pours to it.
priority	(optional) An integer: the priority to be supplied. A value in [1, 99] interval.

Value

An object from class of createDemandSite

See Also

createDemandSite

WRSS documentation built on May 30, 2022, 1:07 a.m.