AvgHydraulics: A function to execute GIFT

In SGronsdahl/GIFT: Geomorphic instream flow tool for conducting hydraulic-habitat modelling.

Description

This function executes the hydraulic geometry simulator to evaluate reach-averaged depths and velocities generated at flows less than bankfull conditions. For more information about this model see: McParland et al. (2016) and Gronsdahl et al. (XXXX)

Usage

AvgHydraulics(S, wb, db, db_max = NULL, b_value = NULL, D84, xs_output = TRUE)

Arguments

S	channel gradient (m/m)
wb	reach averaged bankfull width (m).
db	reach averaged bankfull depth (m).
db_max	Defaults to NULL. reach averaged maximum bankfull depth (m). Specifying db_max is preferred to calculate 'b'.
D84	grain size (mm)
xs_output	Defaults to TRUE. An expression specifying whether to produce a .csv and .jpg of the simulated channel cross section.
b	User-specified b-value. Defaults to NULL and calculated within model unless specified.

Value

.csv and .jpeg of channel cross section if specified

data frame of reach-averaged hydraulics AvgHydraulics()

SGronsdahl/GIFT documentation built on Dec. 18, 2021, 11:59 a.m.