R/CreateGRiwrm.R
CreateGRiwrm.RdGeneration of a network description containing all hydraulic nodes and the description of their connections
CreateGRiwrm(
db,
cols = list(id = "id", down = "down", length = "length", model = "model", area =
"area"),
keep_all = FALSE
)data.frame description of the network (See details)
list or vector columns of db. By default, mandatory column
names are: id, down, length, area and model. Other names can be
handled with a named list or vector containing items defined as "required name" = "column name in db" (See details)
logical indicating if all columns of db should be kept
or if only columns defined in cols should be kept
data.frame of class GRiwrm describing the airGR semi-distributed
model network, with each line corresponding to a location on the river
network and with the following columns:
id (character): node identifier
down (character): identifier of the node downstream of the current
node (NA for the most downstream node)
length (numeric): hydraulic distance to the downstream node in km
(NA for the most downstream node)
area (numeric): total area of the basin starting from the current
node location in km2
model (character): hydrological model to use (NA for using observed
flow instead of a runoff model output)
donor (character): node used as "donor" for the the model and the
calibration parameters.
db is a data.frame which at least contains in its columns:
a node identifier (column id),
the identifier and the hydraulic distance to the downstream node
(character columns down and numeric columns length in km). The
last downstream node should have fields down and length set to NA,
the total area of the basin at the node location (numeric column area in km2).
Direct injection node can have a null area defined by NA
the model to use (character column model), see section below for details
The "model" column should be filled by one of the following:
One of the hydrological models available in the airGR package defined by its
RunModel function (i.e.: RunModel_GR4J, RunModel_GR5HCemaneige...)
Ungauged for an ungauged node. The sub-basin inherits hydrological model and
parameters from a "donor" sub-basin. By default the donor is the first gauged
node at downstream
NA for injecting (or abstracting) a flow time series at the location of the node
(direct flow injection)
Diversion for abstracting a flow time series from an existing node transfer it
to another node. As a Diversion is attached to an existing node, this node is
then described with 2 lines: one for the hydrological model and another one for the
diversion
library(airGRiwrm)
#########################################
# Network of 2 nodes distant of 150 km: #
#########################################
# - an upstream reservoir modelled as a direct flow injection (no model)
# - a gauging station downstream a catchment of 360 km² modelled with GR4J
db <- data.frame(id = c("Reservoir", "GaugingDown"),
length = c(150, NA),
down = c("GaugingDown", NA),
area = c(NA, 360),
model = c(NA, "RunModel_GR4J"),
stringsAsFactors = FALSE)
griwrm_basic <- CreateGRiwrm(db)
griwrm_basic
#> id down length model area donor
#> 1 Reservoir GaugingDown 150 <NA> NA <NA>
#> 2 GaugingDown <NA> NA RunModel_GR4J 360 GaugingDown
# Network diagram with direct flow node in red, intermediate sub-basin in green
plot(griwrm_basic)
###################################################
# GR4J semi-distributed model of the Severn River #
###################################################
data(Severn)
nodes <- Severn$BasinsInfo
nodes$model <- "RunModel_GR4J"
str(nodes)
#> 'data.frame': 6 obs. of 13 variables:
#> $ gauge_id : chr "54057" "54032" "54001" "54095" ...
#> $ gauge_name : chr "Severn at Haw Bridge" "Severn at Saxons Lode" "Severn at Bewdley" "Severn at Buildwas" ...
#> $ gauge_lat : num 52 52 52.4 52.6 52.1 ...
#> $ gauge_lon : num -2.23 -2.2 -2.32 -2.53 -1.94 -2.39
#> $ area : num 9885 6865 4330 3723 2208 ...
#> $ elev_mean : int 145 170 175 186 99 212
#> $ station_type : chr "VA" "US" "US" "US" ...
#> $ flow_period_start : chr "1971-07-01" "1970-10-01" "1970-10-01" "1984-03-01" ...
#> $ flow_period_end : chr "2015-09-30" "2015-09-30" "2015-09-30" "2015-09-30" ...
#> $ bankfull_flow : num 460 340 420 285 125 190
#> $ downstream_id : chr NA "54057" "54032" "54001" ...
#> $ distance_downstream: num NA 15 45 42 43 32
#> $ model : chr "RunModel_GR4J" "RunModel_GR4J" "RunModel_GR4J" "RunModel_GR4J" ...
# Mismatch column names are renamed to stick with GRiwrm requirements
rename_columns <- list(id = "gauge_id",
down = "downstream_id",
length = "distance_downstream")
griwrm_severn <- CreateGRiwrm(nodes, rename_columns)
griwrm_severn
#> id down length model area donor
#> 1 54057 <NA> NA RunModel_GR4J 9885.46 54057
#> 2 54032 54057 15 RunModel_GR4J 6864.88 54032
#> 3 54001 54032 45 RunModel_GR4J 4329.90 54001
#> 4 54095 54001 42 RunModel_GR4J 3722.68 54095
#> 5 54002 54057 43 RunModel_GR4J 2207.95 54002
#> 6 54029 54032 32 RunModel_GR4J 1483.65 54029
# Network diagram with upstream basin nodes in blue, intermediate sub-basin in green
plot(griwrm_severn)
####################################################################
# Severn network with an ungauged station at nodes 54029 and 54001 #
####################################################################
# By default the first gauged node at downstream is used for parameter calibration (54032)
nodes_ungauged <- nodes
nodes_ungauged$model[nodes_ungauged$gauge_id %in% c("54029", "54001")] <- "Ungauged"
griwrm_ungauged <- CreateGRiwrm(nodes_ungauged, rename_columns)
# The `donor` column define which node is used for parameter calibration
griwrm_ungauged
#> id down length model area donor
#> 1 54057 <NA> NA RunModel_GR4J 9885.46 54057
#> 2 54032 54057 15 RunModel_GR4J 6864.88 54032
#> 3 54001 54032 45 Ungauged 4329.90 54032
#> 4 54095 54001 42 RunModel_GR4J 3722.68 54095
#> 5 54002 54057 43 RunModel_GR4J 2207.95 54002
#> 6 54029 54032 32 Ungauged 1483.65 54032
# Network diagram with gauged nodes of vivid color, and ungauged nodes of dull color
plot(griwrm_ungauged)
#######################################################
# Severn network with a Diversion on the node "54029" #
# which transfer flows to the node "54001" #
#######################################################
nodes_div <- nodes[, c("gauge_id", "downstream_id", "distance_downstream", "model", "area")]
nodes_div <- rbind(nodes_div, data.frame(gauge_id = "54029",
downstream_id = "54001",
distance_downstream = 20,
model = "Diversion",
area = NA))
griwrm_div <- CreateGRiwrm(nodes_div, rename_columns)
# Network diagram figures Diversion node by a red frame and a red arrow
plot(griwrm_div)