ENsettimeparam {epanet2toolkit}R Documentation

Set the value of a time parameter.

Description

ENsettimeparam sets the value of a time parameter.

Usage

ENsettimeparam(paramcode, timevalue)

Arguments

paramcode

An integer or character

timevalue

An integer or character value of the time parameters in seconds.

Details

Time parameter codes consist of the following constants:

EN_DURATION 0 Simulation duration
EN_HYDSTEP 1 Hydraulic time step
EN_QUALSTEP 2 Water quality time step
EN_PATTERNSTEP 3 Time pattern time step
EN_PATTERNSTART 4 Time pattern start time
EN_REPORTSTEP 5 Reporting time step
EN_REPORTSTART 6 Reporting starting time
EN_RULESTEP 7 Time step for evaluating rule-based controls
EN_STATISTIC 8 Type of time series post-processing to use:
EN_NONE (0) = none
EN_AVERAGE (1) = averaged
EN_MINIMUM (2) = minimums
EN_MAXIMUM (3) = maximums
EN_RANGE (4) = ranges

Do not change time parameters after calling ENinitH in a hydraulic analysis or ENinitQ in a water quality analysis

Examples

# path to Net1.inp example file included with this package 
inp <- file.path( find.package("epanet2toolkit"), "extdata","Net1.inp") 
ENopen(inp, "Net1.rpt")
ENgettimeparam("EN_HYDSTEP")
ENsettimeparam("EN_HYDSTEP", 600)
ENgettimeparam("EN_HYDSTEP")
ENclose()

[Package epanet2toolkit version 1.0.4 Index]