rvn_rvc_res: Create initial conditions file for Reservoirs

In rchlumsk/RavenR: Raven Hydrological Modelling Framework R Support and Analysis

Create initial conditions file for Reservoirs

Description

Write an initial conditions (rvc) format file for Raven, with the calculated reservoir stages written in.

Usage

rvn_rvc_res(ff, initial_percent = 0, output = "initial_res_conditions.rvc")

Arguments

ff	full file path to the reservoir information file
initial_percent	an optional double for percentage of maximum stage to use as initial condition; default 0.0
output	file rvc lines are written to (default: initial_res_conditions.rvc)

Details

Writes an initial conditions format file for Raven with the relevant initial reservoir stages. This file can be used directly as the model rvc file, or one may copy and paste the information into a separate rvc file for use (i.e. if there is other information to be included in the model rvc file).

The supplied file in ff should be a csv file consistent with the format from the Raven-generated ReservoirStages.csv file. External observations of reservoirs may be used given that the csv file follows the same format.

The initial_percent must be between 0 and 1, so that the initial stage is not less than the dry stage or greater than the maximum.

Value

TRUE	return TRUE if the function is executed properly

See Also

rvn_res_read for reading in the ReservoirStages.csv file

Examples

ff <- system.file("extdata","ReservoirStages.csv", package="RavenR")

# set initial conditions at 40% capacity, view file
tf <- file.path(tempdir(), "modelname.rvc")
rvn_rvc_res(ff, initial_percent=0.4, output=tf)
readLines(tf)

rchlumsk/RavenR documentation built on April 19, 2024, 5:15 a.m.