readSingleResult: Read a single SWMM result

Description Usage Arguments Details Value Author(s)

View source: R/read_SWMM.r

Description

This function used internally only. Reads a single result from a SWMM outputfile.

Usage

1
readSingleResult(SWMMfile, iType, iIndex, vIndex, period)

Arguments

SWMMfile

a SWMMfile object

iType

0, 1, 2, or 3. See Detail below.

iIndex

integer, the position of the subcatch, subcatch, node, link or sys object

vIndex

integer, index of the variable. See Detail below.

period

integer, index of the period (time step)

Details

iType should be 0 for Subcatchments, 1 for nodes, 2 for links, or 3 for system variables.

vIndex should be selected from this lists below, depending on whether iType is a subcatchment, a link, or a node.

Number of subcatchment variables (currently 8 + number of pollutants). Code number of each subcatchment variable: 0 for rainfall (in/hr or mm/hr), 1 for snow depth (in or mm), 2 for evaporation losses (in/hr or mm/hr), 3 for infiltration losses (in/hr or mm/hr), 4 for runoff rate (flow units), 5 for groundwater outflow rate (flow units), 6 for groundwater water table elevation (ft or m), 7 for unsaturated zone moisture content, 8 for runoff concentration of first pollutant, 8 + N for runoff concentration of N-th pollutant.

Number of node variables (currently 6 + number of pollutants) Code number of each node variable: 0 for depth of water above invert (ft or m), 1 for hydraulic head (ft or m), 2 for volume of stored + ponded water (ft3 or m3), 3 for lateral inflow (flow units), 4 for total inflow (lateral + upstream) (flow units), 5 for flow lost to flooding (flow units), 6 for concentration of first pollutant, 5 + N for concentration of N-th pollutant.

Number of link variables (currently 5 + number of pollutants) Code number of each link variable:

0 for flow rate (flow units), 1 for flow depth (ft or m), 2 for flow velocity (ft/s or m/s), 3 for Froude number, 4 for capacity (fraction of conduit filled), 5 for concentration of first pollutant, 4 + N for concentration of N-th pollutant.

Number of system-wide variables (currently 15) Code number of each system-wide variable: 0 for air temperature (deg. F or deg. C), 1 for rainfall (in/hr or mm/hr), 2 for snow depth (in or mm), 3 for evaporation + infiltration loss rate (in/hr or mm/hr), 4 for runoff flow (flow units), 5 for dry weather inflow (flow units), 6 for groundwater inflow (flow units), 7 for RDII inflow (flow units), 8 for user supplied direct inflow (flow units), 9 for total lateral inflow (sum of variables 4 to 8) (flow units), 10 for flow lost to flooding (flow units), 11 for flow leaving through outfalls (flow units), 12 for volume of stored water (ft3 or m3), 13 for evaporation rate (in/day or mm/day) 14 Daily potential evapotranspiration (PET) (in/day or mm/day)

Value

a scalar

Author(s)

Andreas Scheidegger


scheidan/SWMMR documentation built on May 30, 2019, 8:39 a.m.