rcr_options-class: rcr Options Object

Description Fields

Description

rcr_options: A reference class to define the computational parameters and physical constants used in the rcr package. The parameters are defined with defaults when an instance of the options object is generated, however, these may be modified as needed.

Fields

g

gravitational constant (N/kg)

dx

resolution for interpolating cross-section data, defined by the horizontal space between interpolated points (m)

tolerance_cp

tolerance limit for water surface calculations in compute_profile function (m)

iteration_limit_cp

iteration limit for calculations between cross-sections in compute_profile

next_WSL_split_cp

coefficient in assigning the next iteration of water surface elevations from the difference in previous WSL to calculated WSL

tolerance_nd

tolerance limit for normal depth calculation in comparing flow to Manning's equation terms (m3/s)

iteration_limit_nd

iteration limit for normal depth calculations

next_WSL_split_nd

coefficient in assigning next water surface depth in normal depth calculation based on ratio of Manning's equation terms

silent_cp

level of output in compute_profile function; if true, minimal output is produced

silent_nd

level of output in normal_depth function; if true, minimal output is produced


rchlumsk/rcr documentation built on Oct. 3, 2019, 7:47 a.m.