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

View source: R/createAquifer.default.R

createAquifer.defaultR Documentation

default function for class of createAquifer

Description

this function constructs an object from class of createAquifer that prescribes a simplified lupmped model of unconfined aquifer.

Usage

## Default S3 method:
createAquifer(name = "Aquifer1",
                 area                 ,
                 volume               ,
                 rechargeTS      = NA ,
                 Sy              = 0.1,
                 leakageFraction = NA ,
                 initialStorage  = NA ,
                 leakageObject   = NA ,
                 priority        = NA)

Arguments

name

(optional) A string: the name of the aquifer

area

The area of aquifer (Km^2)

volume

The aquifer volume (MCM)

rechargeTS

(optional) A vector : a vector of water flowing into the aquifer (MCM)

Sy

Specific yield (default: 0.1)

leakageFraction

(optional) The leakage coeffcient of aquifer storage. The leakage is computed as the product of leakageFraction and aquifer storage. It is in [0, 1] interval

initialStorage

(optional) The initial volume of aquifer in the first step of the simulation (MCM). If missing, the function iterates to carry over the aquifer.

leakageObject

(optional) an object; from either of classes of createAquifer , createRiver, createReservoir, createJunction, createDiversion, or createDemandSite; which leakage volume pours to it.

priority

(optional) An integer: the supplying priority. priority is a value in [1, 99] interval. If missing, the priority is set to Inf.

Value

An object from class of createAquifer

See Also

createAquifer


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