Property:Describe input parameters model
From CSDMS
This is a property of type Text.
S
The input file is a DEM in .flt format. A driver text file is also required which contains the parameters used for the extraction. +
D
The input file is a DEM in .flt format. A driver text file is also required which contains the parameters used for the extraction. Information on the parameters needed in the driver file is available in the documentation (http://www.geos.ed.ac.uk/~smudd/LSDTT_docs/html/channel_heads.html). +
G
The input file is a text file and users are required to input:
Time (in model years)
dT (the time step in fractions of a year)
tauc (Critical Shear stress for portions of the channel that are vegetated in Pascals)
taucWepp (Critical Shear stress for portions of the channel that are soil in Pascals)
lenzone (the length of channel that is bare soil in Meters)
Pmmphr (Rainfall to be used for erosion in Millimeters per Hour)
tval (this is the number of loop iterations before a profile is saved as output)
Immphr (Infiltration to be used for erosion in Millimeters per Hour)
One additional input:
One must supply the input length of the channel as a matlab data array called xcell.mat +
A
The input file is required for each run and provides the basic simulation parameters. It must conform to the ACADIA.inp standard format as described below
Line1: should read the character string 'Comment�:' which is the label for the next line and is ignored during data input
Line2: inputs a comment of maximum 72 characters about the current simulation
Line3: should read 'Case name', which is the label for the next line and is ignored during data input
Line4: specifes the case name (including the directory location if it is not soft-linked to the current directory). The code will append the suffixes '.nod',
'.ele',and '.bat' to this string in order to know where to find the NML standard files
Line5: should read 'Simulation Parameters', which is the label for the next line and is ignored during data input
Line6: inputs the number of transport variables
Line7: inputs the number of �uid layers
Line8: inputs the degrees latitude of the center of the mesh
Line9: inputs the time step in seconds
Line10: inputs the starting date (day, month, year), time (in seconds after midnight). The value of time can be greater than 8.64E4 (equivalent of 1 day) as the code will automatically adjust the day and time accordingly
Last Line: inputs the quitting criteria for the code as day, month, year and time in seconds after midnight. Again the value of time can be greater than 8.64E4. This allows the user to specify an overall length of the simulation instead of the exact date and time of the end of the simulation +
H
The input files are a DEM in .flt format, a channel heads file generated using the DrEICH algorithm (https://csdms.colorado.edu/wiki/Model:DrEICH_algorithm) and an optional floodplain mask in .flt format. Input parameters are also supplied at the command line. Information on the parameters is available in the documentation (http://www.geos.ed.ac.uk/~smudd/LSDTT_docs/html/channel_heads.html). +
R
The input includes file names for output, subgrid information, physical parameters and wave conditions. Water depth is obtained from the master program though a file name for water depth input is still kept in "indat.dat". +
C
The input is a 'channel file' and a 'driver file'. The channel file contains data on channel profiles within a channel network composed of a main stem and tributaries flowing into that main stem (that is, there are no tributaries of tributaries). The driver file contains parameters for the model run. The format of these files is described in the documentation that accompanies the model source code. +
The input parameters to a model run consist of an initial shoreline, a wave file, and a set of configuration parameters. The initial shoreline is stored within a custom binary formatted-file. Since CEM has been used for abstract simulations of coastline evolution, the initial model condition consists either of a mostly-smooth shoreline with initial perturbations to the shoreline position (generated by a tool provided with the model), or using a shoreline that resulted from a previous model run. The wave file consists of a set of wave approach angles and wave heights that are used during the model run. This wave file is also generated by a tool provided with the model, and takes as input the statistical distribution of wave-approach angles. Finally, basic model parameters (e.g. number of time steps to simulate, etc.) are specified within an XML-formatted text file. An example is provided with the model. +
T
The input variables for modeling the net flux of shortwave radiation are defined as follows:
Tair = air temperature (deg C)
RH = relative humidity (unitless) (in (0,1))
albedo = surface albedo (unitless) (in (0,1))
dust att. = dust attenuation factor (unitless) (in (0,1))
factor = cloud or canopy cover factor (unitless) (in (0,1))
slope = topographic slope (unitless, m/m) (in (0,Infinity))
aspect = aspect angle (radians) (in (0,1))
The behavior of this component is controlled with a configuration (CFG) file, which may point to other files that contain input data. Here is a sample configuration (CFG) file for this component:
Method code: 1
Method name: Standard
Time step: Scalar 3600.0 (sec)
rho_H2O: Scalar 1000.00000000 (kg/m^3)
Cp_air: Scalar 1005.70001221 (J/kg/K)
rho_air: Scalar 1.26139998 (kg/m^3)
P: Time_series Case5_rain_rates.txt (mm/hr)
T_air: Scalar 20.00000000 (deg C)
T_surf: Scalar -5.00000000 (deg C)
RH: Scalar 0.50000000 (none)
p0: Scalar 1000.00000000 (mbar)
uz: Scalar 3.00000000 (m/s)
z: Scalar 10.00000000 (m)
z0_air: Scalar 0.02000000 (m)
Qn_SW: Scalar 100.00000000 (W/m^2)
Qn_LW: Scalar 10.00000000 (W/m^2)
Save grid timestep: Scalar 60.00000000 (sec)
Save ea grids: 0 Case5_2D-ea.rts (mbar)
Save es grids: 0 Case5_2D-es.rts (mbar)
Save pixels timestep: Scalar 60.00000000 (sec)
Save ea pixels: 0 Case5_0D-ea.txt (mbar)
Save es pixels: 0 Case5_0D-es.txt (mbar)
The input variables for the Energy Balance method of estimating losses due to evaporation are defined as follows:
Q_SW = net shortwave radiation (W / m^2)
Q_LW = net longwave radiation (W / m^2)
T_air = air temperature (deg C)
T_surf = surface (snow) temperature (deg C)
T_soil_x = soil temperature at depth x (deg C)
x = reference depth in soil (m)
K_soil = thermal conductivity of soil (W / (m deg_C))
u_z = wind velocity at height z (m / s)
z = reference height for wind (m) (above land surface)
z_0 = surface roughness height (m) (with no snow)
h0_snow = initial snow depth (m)
ρ_air = density of the air (kg / m^3)
c_air = specific heat capacity of air (J / (kg deg_C))
L_v = latent heat of vaporization, water (J / kg) (2500000)
g = gravitational constant, Earth = 9.81 (m / s^2)
κ = von Karman's constant = 0.41 (unitless)
The behavior of this component is controlled with a configuration (CFG) file, which may point to other files that contain input data. Here is a sample configuration (CFG) file for this component:
Method code: 2
Method name: Energy_Balance
Time step: Scalar 3600.00000000 (sec)
alpha: Scalar 1.20000000 (none)
K_soil: Scalar 0.44999999 (W/m/deg_C)
soil_x: Scalar 0.05000000 (m)
T_soil_x: Scalar 0.00000000 (deg C)
Save grid timestep: Scalar 60.00000000 (sec)
Save er grids: 0 Case5_2D-ETrate.rts (m/s)
Save pixels timestep: Scalar 60.00000000 (sec)
Save er pixels: 0 Case5_0D-ETrate.txt (m/s) +
The input variables for the Energy Balance method of estimating runoff due to snowmelt are defined as follows:
Q_SW = net shortwave radiation (W / m^2)
Q_LW = net longwave radiation (W / m^2)
T_air = air temperature (deg C)
T_surf = surface (snow) temperature (deg C)
RH = relative humidity (none) (in (0,1))
p_0 = atmospheric pressure (mbar)
u_z = wind velocity at height z (m / s)
z = reference height for wind (m)
z0_air = surface roughness height (m)
h0_snow = initial snow depth (m)
h0_swe = initial depth, snow water equivalent (m)
ρ_snow = density of the snow (kg / m^3)
c_snow = specific heat capacity of snow (J / (kg deg_C))
ρ_air = density of the air (kg / m^3)
c_air = specific heat capacity of air (J / (kg deg_C))
L_f = latent heat of fusion, water (J / kg) (334000)
L_v = latent heat of vaporization, water (J / kg) (2500000)
e_air = air vapor pressure at height z (mbar)
e_surf = vapor pressure at the surface (mbar)
g = gravitational constant = 9.81 (m / s^2)
κ = von Karman's constant = 0.41 (unitless)
The behavior of this component is controlled with a configuration (CFG) file, which may point to other files that contain input data. Here is a sample configuration (CFG) file for this component:
Method code: 2
Method name: Energy_Balance
Time step: Scalar 3600.00000000 (sec)
Cp_snow: Scalar 2090.00000000 (J/kg/K)
rho_snow: Scalar 300.00000000 (kg/m^3)
c0: Scalar 2.70000005 (mm/day/deg C)
T0: Scalar -0.20000000 (deg C)
h0_snow: Scalar 0.50000000 (m)
h0_swe: Scalar 0.15000000 (m)
Save grid timestep: Scalar 60.00000000 (sec)
Save mr grids: 0 Case5_2D-SMrate.rts (m/s)
Save hs grids: 0 Case5_2D-hsnow.rts (m)
Save sw grids: 0 Case5_2D-hswe.rts (m)
Save cc grids: 0 Case5_2D-Ecc.rts (J/m^2)
Save pixels timestep: Scalar 60.00000000 (sec)
Save mr pixels: 0 Case5_0D-SMrate.txt (m/s)
Save hs pixels: 0 Case5_0D-hsnow.txt (m)
Save sw pixels: 0 Case5_0D-hswe.txt (m)
Save cc pixels: 0 Case5_0D-Ecc.txt (J/m^2)
The input variables for the Priestley-Taylor method of estimating losses due to evaporation are defined as follows:
Q_SW = net shortwave radiation (W / m^2)
Q_LW = net longwave radiation (W / m^2)
T_air = air temperature (deg C)
T_surf = surface (snow) temperature (deg C)
T_soil_x = soil temperature at depth x (deg C)
x = reference depth in soil (m)
K_soil = thermal conductivity of soil (W / (m deg_C))
α = coefficient (unitless)
L_v = latent heat of vaporization, water (J / kg) (2500000)
The behavior of this component is controlled with a configuration (CFG) file, which may point to other files that contain input data. Here is a sample configuration (CFG) file for this component:
Method code: 0
Method name: Priestley-Taylor
Time step: Scalar 3600.00000000 (sec)
alpha: Scalar 1.20000000 (none)
K_soil: Scalar 0.44999999 (W/m/deg_C)
soil_x: Scalar 0.05000000 (m)
T_soil_x: Scalar 0.00000000 (deg C)
Save grid timestep: Scalar 60.00000000 (sec)
Save er grids: 0 Case5_2D-ETrate.rts (m/s)
Save pixels timestep: Scalar 60.00000000 (sec)
Save er pixels: 0 Case5_0D-ETrate.txt (m/s) +
The input variables used by the Smith-Parlange 3-parameter method for modeling infiltration are defined as follows:
K_s = saturated hydraulic conductivity (m / s)
K_i = initial hydraulic conductivity (m / s) (typically much less than K_s)
θ_s = soil water content at ψ=0 (unitless) (typically set to the porosity, φ)
θ_i = initial soil water content (unitless)
G = capillary length scale (meters)
= integral over all ψ of K(ψ) / K_s
= (almost always between ψ_B and 2*ψ_B)
P = precipitation rate (mm / sec)
M = snowmelt rate (mm / sec)
γ = Smith-Parlange method parameter (between 0 and 1, near 0.8)
The behavior of this component is controlled with a configuration (CFG) file, which may point to other files that contain input data. Here is a sample configuration (CFG) file for this component:
Method code: 2
Method name: Smith_Parlange
Number of layers: 1
Time step: Scalar 60.0000000 (sec)
Ks: Scalar 0.00000720 (m/s)
Ki: Scalar 0.00000010 (m/s)
qs: Scalar 0.48500001 (none)
qi: Scalar 0.37580763 (none)
G: Scalar 0.72400000 (m)
gamma: Scalar 0.82000000 (none)
Closest soil_type: silt_loam
Save grid timestep: Scalar 60.00000000 (sec)
Save v0 grids: 0 Case5_2D-v0.rts (m/s)
Save I grids: 0 Case5_2D-I.rts (m)
Save pixels timestep: Scalar 60.00000000 (sec)
Save v0 pixels: 0 Case5_0D-v0.txt (m/s)
Save I pixels: 0 Case5_0D-I.txt (m) +
The input variables used by the simple Green-Ampt method for modeling infiltration are defined as follows:
K_s = saturated hydraulic conductivity (m / s)
K_i = initial hydraulic conductivity (m / s) (typically much less than Ks)
θ_s = soil water content at ψ=0 (unitless) (typically set to the porosity, φ)
θ_i = initial soil water content (unitless)
G = capillary length scale (meters)
= integral over all ψ of K(ψ) / K_s
= (almost always between ψ_B and 2*ψ_B)
P = precipitation rate (mm / sec)
M = snowmelt rate (mm / sec)
The behavior of this component is controlled with a configuration (CFG) file, which may point to other files that contain input data. Here is a sample configuration (CFG) file for this component:
Method code: 0
Method name: Green_Ampt
Number of layers: 1
Time step: Scalar 60.0000000 (sec)
Ks: Scalar 0.00000720 (m/s)
Ki: Scalar 0.00000010 (m/s)
qs: Scalar 0.48500001 (none)
qi: Scalar 0.37580763 (none)
G: Scalar 0.72400000 (m)
Closest soil_type: silt_loam
Save grid timestep: Scalar 60.00000000 (sec)
Save v0 grids: 0 Case5_2D-v0.rts (m/s)
Save I grids: 0 Case5_2D-I.rts (m)
Save pixels timestep: Scalar 60.00000000 (sec)
Save v0 pixels: 0 Case5_0D-v0.txt (m/s)
Save I pixels: 0 Case5_0D-I.txt (m) +
The input variables used for modeling horizontal subsurface flow in the saturated zone via Darcy's Law are defined as follows:
K_s = saturated hydraulic conductivity (m / s)
S_y = specific yield or drainable porosity (unitless)
(less than or equal to the porosity, φ, see Notes)
thickness = soil layer thickness (meters) +
The input variables used for modeling infiltration and unsaturated vertical flow with the 1D Richard's equation are defined as follows:
K_s = saturated hydraulic conductivity (m / s)
K_i = initial hydraulic conductivity (m / s) (typically much less than K_s)
θ_s = soil water content at ψ = 0 (unitless) (often set to the soil porosity, φ)
θ_i = initial soil water content (unitless)
θ_r = residual soil water content (unitless) (must be < θ_i)
ψ_B = bubbling pressure head (meters) (also called air-entry pressure, ψ_ae)
ψ_A = pressure head offset parameter (meters)
λ = pore-size distribution parameter (unitless) (alt. notation = 1/b )
η = 2 + (3 * λ) (unitless) (see Notes)
c = transitional Brooks-Corey curvature parameter (unitless) (see Notes)
dznodes = vertical distance between nodes (meters)
nnodes = number of subsurface vertical nodes
The behavior of this component is controlled with a configuration (CFG) file, which may point to other files that contain input data. +
The input variables used for the Degree-Day method of estimating runoff due to snowmelt are defined as follows:
c_0 = coefficient
T_0 = threshold temperature (deg C)
T_air = air temperature (deg C)
ρ_snow = density of the snow (kg / m^3)
ρ_water = density of liquid water, 1000 (kg / m^3)
h0_snow = initial snow depth (m)
h0_swe = initial depth, snow water equivalent (m)
The behavior of this component is controlled with a configuration (CFG) file, which may point to other files that contain input data. Here is a sample configuration (CFG) file for this component:
Method code: 0
Method name: Degree-Day
Time step: Scalar 3600.00000000 (sec)
Cp_snow: Scalar 2090.00000000 (J/kg/K)
rho_snow: Scalar 300.00000000 (kg/m^3)
c0: Scalar 2.70000005 (mm/day/deg C)
T0: Scalar -0.20000000 (deg C)
h0_snow: Scalar 0.50000000 (m)
h0_swe: Scalar 0.15000000 (m)
Save grid timestep: Scalar 60.00000000 (sec)
Save mr grids: 0 Case5_2D-SMrate.rts (m/s)
Save hs grids: 0 Case5_2D-hsnow.rts (m)
Save sw grids: 0 Case5_2D-hswe.rts (m)
Save cc grids: 0 Case5_2D-Ecc.rts (J/m^2)
Save pixels timestep: Scalar 60.00000000 (sec)
Save mr pixels: 0 Case5_0D-SMrate.txt (m/s)
Save hs pixels: 0 Case5_0D-hsnow.txt (m)
Save sw pixels: 0 Case5_0D-hswe.txt (m)
Save cc pixels: 0 Case5_0D-Ecc.txt (J/m^2) +
The input variables used for the Dynamic Wave method of routing flow in channels are defined as follows. These inputs must be provided as grids:
*flow_codes = D8 flow codes (Jenson convention), (NE,E,SE,S,SW,W,NW,N) → (1,2,4,8,16,32,64,128)
*bed_slope = slope of the channel bed or hillslope (m / m)
*Manning_n = Manning roughness parameter (s / m1/3)
*bed_width = bed width for trapezoidal cross-section (m)
*bank_angle = bank angle for trapezoid (deg) (from vertical)
*sinuosity = channel sinuosity (unitless) (along-channel / straight length)
*init_depth = initial water depth (m) (See Notes below)
These inputs can be provided as scalars or grids:
*sinuosity = channel sinuosity (m/m) (along-channel / straight length)
*init_depth = initial water depth (m) (See HTML help)
Grids must be saved in binary files with no header. All variables should be stored as 4-byte, floating-point numbers (IEEE standard) except flow codes, which are unsigned, 1-byte integers.
The behavior of this component is controlled with a configuration (CFG) file, which may point to other files that contain input data. Here is a sample configuration (CFG) file for this component:
Method code: 3
Method name: Dynamic_Wave
Manning flag: 1
Law of Wall flag: 0
Time step: Scalar 6.00000000 (sec)
D8 flow code: Grid Treynor_flow.rtg (none)
D8 slope: Grid Treynor_slope.rtg (m/m)
Manning N: Grid Treynor_chan-n.rtg (s/m^(1/3))
Bed width: Grid Treynor_chan-w.rtg (m)
Bank angle: Grid Treynor_chan-a.rtg (deg)
Init. depth: Scalar 0.00000000 (m)
Sinuosity: Scalar 1.00000000 (m/m)
Save grid timestep: Scalar 60.00000000 (sec)
Save Q grids: 1 Case5_2D-Q.rts (m^3/s)
Save u grids: 0 Case5_2D-u.rts (m/s)
Save d grids: 0 Case5_2D-d.rts (m)
Save f grids: 0 Case5_2D-f.rts (none)
Save pixels timestep: Scalar 60.00000000 (sec)
Save Q pixels: 1 Case5_0D-Q.txt (m^3/s)
Save u pixels: 0 Case5_0D-u.txt (m/s)
Save d pixels: 0 Case5_0D-d.txt (m)
Save f pixels: 0 Case5_0D-f.txt (none)
The input variables used for the Dynamic Wave method of routing flow in channels are defined as follows. These inputs must be provided as grids:
*flow_codes = D8 flow codes (Jenson convention), (NE,E,SE,S,SW,W,NW,N) → (1,2,4,8,16,32,64,128)
*bed_slope = slope of the channel bed or hillslope (m / m)
*Manning_n = Manning roughness parameter (s / m^1/3)
*bed_width = bed width for trapezoidal cross-section (m)
*bank_angle = bank angle for trapezoid (deg) (from vertical)
*sinuosity = channel sinuosity (unitless) (along-channel / straight length)
*init_depth = initial water depth (m) (See Notes below)
These inputs can be provided as scalars or grids:
*sinuosity = channel sinuosity (m/m) (along-channel / straight length)
*init_depth = initial water depth (m) (See HTML help)
Grids must be saved in binary files with no header. All variables should be stored as 4-byte, floating-point numbers (IEEE standard) except flow codes, which are unsigned, 1-byte integers.
The behavior of this component is controlled with a configuration (CFG) file, which may point to other files that contain input data. Here is a sample configuration (CFG) file for this component:
Method code: 1
Method name: Kinematic_Wave
Manning flag: 1
Law of Wall flag: 0
Time step: Scalar 6.00000000 (sec)
D8 flow code: Grid Treynor_flow.rtg (none)
D8 slope: Grid Treynor_slope.rtg (m/m)
Manning N: Grid Treynor_chan-n.rtg (s/m^(1/3))
Bed width: Grid Treynor_chan-w.rtg (m)
Bank angle: Grid Treynor_chan-a.rtg (deg)
Init. depth: Scalar 0.00000000 (m)
Sinuosity: Scalar 1.00000000 (m/m)
Save grid timestep: Scalar 60.00000000 (sec)
Save Q grids: 1 Case5_2D-Q.rts (m^3/s)
Save u grids: 0 Case5_2D-u.rts (m/s)
Save d grids: 0 Case5_2D-d.rts (m)
Save f grids: 0 Case5_2D-f.rts (none)
Save pixels timestep: Scalar 60.00000000 (sec)
Save Q pixels: 1 Case5_0D-Q.txt (m^3/s)
Save u pixels: 0 Case5_0D-u.txt (m/s)
Save d pixels: 0 Case5_0D-d.txt (m)
Save f pixels: 0 Case5_0D-f.txt (none)
U
The model is driven by inputs of air temperature, precipitation, wind speed, humidity and radiation at time steps sufficient to resolve the diurnal cycle (six hours or less) +
1
The model takes as input (i) p, dynamics asymmetry parameter; (ii) L, the hillslope length; (iii) H, the hillslope height; (iv) N, the number of steps of the simulation; and (v) a choice of initial hillslope profile. +
B
The use of this coupled model framework requires Barrier3D v2.0 (https://doi.org/10.5281/zenodo.7604068)
and PyBMFT-C v1.0 (https://doi.org/10.5281/zenodo.7853803).
1) barrier3d-parameters.yaml: yaml-formatted text file containing initial values for all static and dynamic variables
2) barrier3d-elevation.npy: Initial interior elevation grid
3) barrier3d-storms.npy: Stochastically generated sequence of storms
4) barrier3d-dunes.npy: Initial height of dune cells
5) barrier3d-growthparam.npy: Alongshore varying growth rates for the dune domain
6) Equilibrium Bay Depth.mat: Array of bay depths for a given combination of rate of sea level rise and external sediment supply
7) MarshStrat.mat: Initial marsh stratigraphy +
F
There are four input data files to be read by subroutine init. The first file consists of control parameters and is named funwave2d.data for 2-D programs and funwave1d.data for 1-D programs. With the use of intrinsic function NAMELIST in the program, variable name and its corresponding data can be put together. The logical device number for this file is chosen as 1 and the form of the files is ASCII.
The other three input files are water depth data, initial wave field data, and time series of source function amplitude, respectively. Their names are represented by f1n, f2n and f3n which are specified in funwave2d.data or funwave1d.data. Binary format is used for these three files to increase I/O speed for 2-D prograams while ASCII format is used for 1-D programs. Since the record length of data for binary format in SGI computer is different from other machines, a control parameter imch is used in funwave2d.data or funwave1d.data to adjust for different computers. +
R
There are hundreds of input parameters for the physical, ecosystem, and sediment models. In addition, there are input scripts for floats, stations, model coupling, and data assimilation. +
C
There are hundreds of input parameters for the physical, ecosystem, and sediment models. In addition, there are input scripts for floats, stations, model coupling, and data assimilation. +
There are hundreds of input parameters for the physical, ecosystem, and sediment models. In addition, there are input scripts for floats, stations, model coupling, and data assimilation. +
U
There are hundreds of input parameters for the physical, ecosystem, and sediment models. In addition, there are input scripts for floats, stations, model coupling, and data assimilation. +
T
These inputs must be provided as grids:
*flow_codes = D8 flow codes (Jenson 1984 convention), (NE,E,SE,S,SW,W,NW,N) → (1,2,4,8,16,32,64,128)
*bed_slope = slope of the channel bed or hillslope (m / m)
*Manning_n = Manning roughness parameter (s / m^(1/3))
*bed_width = bed width for trapezoidal cross-section (m)
*bank_angle = bank angle for trapezoid (deg) (from vertical)
These inputs can be provided as scalars or grids:
*sinuosity = channel sinuosity (m/m) (along-channel / straight length)
*init_depth = initial water depth (m) (See HTML help)
Grids must be saved in binary files with no header. All variables should be stored as 4-byte, floating-point numbers (IEEE standard) except flow codes, which are unsigned, 1-byte integers.
The behavior of this component is controlled with a configuration (CFG) file, which may point to other files that contain input data. Here is a sample configuration (CFG) file for this component:
Method code: 2
Method name: Diffusive_Wave
Manning flag: 1
Law of Wall flag: 0
Time step: Scalar 6.00000000 (sec)
D8 flow code: Grid Treynor_flow.rtg (none)
D8 slope: Grid Treynor_slope.rtg (m/m)
Manning N: Grid Treynor_chan-n.rtg (s/m^(1/3))
Bed width: Grid Treynor_chan-w.rtg (m)
Bank angle: Grid Treynor_chan-a.rtg (deg)
Init. depth: Scalar 0.00000000 (m)
Sinuosity: Scalar 1.00000000 (m/m)
Save grid timestep: Scalar 60.00000000 (sec)
Save Q grids: 1 Case5_2D-Q.rts (m^3/s)
Save u grids: 0 Case5_2D-u.rts (m/s)
Save d grids: 0 Case5_2D-d.rts (m)
Save f grids: 0 Case5_2D-f.rts (none)
Save pixels timestep: Scalar 60.00000000 (sec)
Save Q pixels: 1 Case5_0D-Q.txt (m^3/s)
Save u pixels: 0 Case5_0D-u.txt (m/s)
Save d pixels: 0 Case5_0D-d.txt (m)
Save f pixels: 0 Case5_0D-f.txt (none)
O
This component operates on a Landlab RasterModelGrid instance, and requires that the user has downloaded and installed Landlab. Parameters listed below are required. Ones noted as (optional) will revert to the prescribed default values as described in the documentation.
Input parameters include:
grid : A Landlab RasterModelGrid, representing the topography
h_init : (optional) Thickness of initial thin layer of water on the surface
alpha : (optional) Time step coeffcient, described in Bates et al., 2010 and de Almeida et al., 2012.
mannings_n : (optional) Manning's roughness coefficient.
g : (optional) Acceleration due to gravity (m/s^2).
theta : (optional) Weighting factor from de Almeida et al., 2012.
rainfall_intensity : (optional) Rainfall intensity. +
C
This data component serves as input climate data for components in the permafrost toolbox. It requires specification of time period, time step (monthly), and of grid dimensions.
To set the grid to a desired region
x=25 means 25 degrees east of the international date line
y=37 means 37 degrees south of the north pole
(30 by 23) means a grid that is "30 degrees E/W by 23 degrees N/S" +
This is a data component that serves as input to a set of components in the permafrost modeling toolkit +
S
This model expects that the user has downloaded and installed the Landlab modeling framework. It operates on a Landlab RasterModelGrid instance.
Other input parameters include:
hydraulic_conductivity
soil_bulk_density
rock_density
initial_soil_moisture_content
soil_type
volume_fraction_coarse_fragments
coarse_sed_flag
surface_water_minimum_depth
soil_pore_size_distribution_index
soil_bubbling_pressure
wetting_front_capillary_pressure_head +
A
Three input maps at ESRI ASCII format:
# Flow Direction (ArcGIS format);
# Contributing Area (Flow Accumulation-ArcGIS format);
# Slope (ArcGIS format); +
F
Tides, Winds, Heat flux, Preccipitation/Evaporation, River discharges, Groundwater, O.B. fluxes +
2
Time (s) and space (m) descretisation steps, Wind friction coefficient (dimensionless), Chezy Bed friction coefficient (units?), Wind velocity components in x and y (m/s), Coriolis parameter (1/s), Max number of grid points along x direction, Max number of grid points along y direction, Max number of time steps desired, Number of coastal and open boundary nodes, Dependent variables are saved every dat timesteps, Amplitude of the incident long waves (m), Period of the incident long waves (s), Starting node number of the computation field in the jth row, Ending node number of the computation field in the jth row. +
D
Timestep (sec.), Spacestep (m), Flow velocity at river mouth (m/s), Width and depth of river mouth (m), Bedload dumping rate (m/s), Concentration (gm/m3 of coarse and med silt, Concentration (gm/m3) of fine silt and clay) +
W
B
To generate a grid, the user should input the boundary node information, boundary segment information and hole (or island) information in form of a .poly file, as described in the Triangle manual (http://www.cs.cmu.edu/~quake/triangle.poly.html). These input nodes and segments in the .poly file are forced into the triangulation of the domain. Alternatively (and this is a strong point of BATTRI), all this information can be created from only a bathymetric dataset with the use of the editing options of BATTRI (see Option 0 in Running BATTRI section). This process may require manual deleting of unnecessary segments and nodes, closing of islands by segment adding, addition of an open ocean boundary segment, etc.
As a starting point, ordered digital coastline node data can be extracted from the National Geophysical Data Center's webpage (https://www.ngdc.noaa.gov/mgg/shorelines/) at various scales ranging from 1:70,000 to 1:5,000,000. If the coastline is very highly resolved, causing an excessive number of elements along the shoreline, the routine "xy_simplify.m" can be used to reduce the number of nodes to the desired resolution. Remember to format this data into a .poly file, consisting of nodes and segments, before inputting into BATTRI. To refine an already created grid, the user can input the above referenced information either in the form of a previously created .poly file or in the form of NML standard .nod, .ele and .bat files (see next section, Running BATTRI). +
T
Too many to list here. Please see the HTML help system and the wiki pages for all of the process components. +
Q
M
Too many to mention here, see:
http://water.usgs.gov/nrp/gwsoftware/modflow2000/modflow2000.html +
H
Topography
3D temperature and salinity field
2D sea surface height
Tidal components
River discharge
2D Meteo forcing +
C
Topography z(x,y) or parameters describing a topographic surface; rate coefficients; switches for activating options and choosing between alternative transport/erosion formulas. Uses a formatted text file for input of parameters. +
I
P
Topography, temperature, salinity, wind, heat/salt fluxes. Determine by user and application. +
Two input files, all in ESRI ASCII format:
# DEM
# Flow direction grid (D8)
To change the input files, edit lines 19 for DEM and line 20 for Flow-direction in the source code. +
O
Two text files are required as input for analysis of each vertical succession of strata in the following formats.
Vertical thickness and facies succession:
<unit thickness (m)> <facies code (integer)>
<unit thickness (m)> <facies code (integer)>
...
<unit thickness (m)> <facies code (integer)>
EOF
e.g.
0.61 9
0.05 5
0.52 1
...
1.21 3
Facies codes, colour coding and names:
<Facies code 1 (integer)> <red (float)> <green (float)> <blue (float)> <facies name (string)>
<Facies code 2 (integer)> <red (float)> <green (float)> <blue (float)> <facies name (string)>
...
<Facies code n (integer)> <red (float)> <green (float)> <blue (float)> <facies name (string)>
e.g.
1 0.55 0.32 0 clay
2 1 0.65 0 silt
3 0.93 0.91 0.8 fineSST
4 1 0.95 0.71 medSST
5 0.81 0.71 0.23 crsSST +
Two text files are required as input for analysis of each vertical succession of strata in the following formats.
Vertical thickness and facies succession: <unit thickness (m)> <facies code (integer)> <unit thickness (m)> <facies code (integer)> ... <unit thickness (m)> <facies code (integer)> EOF
e.g. 0.61 9 0.05 5 0.52 1 ... 1.21 3
Facies codes, colour coding and names: <Facies code 1 (integer)> <red (float)> <green (float)> <blue (float)> <facies name (string)> <Facies code 2 (integer)> <red (float)> <green (float)> <blue (float)> <facies name (string)> ... <Facies code n (integer)> <red (float)> <green (float)> <blue (float)> <facies name (string)>
e.g. 1 0.55 0.32 0 clay 2 1 0.65 0 silt 3 0.93 0.91 0.8 fineSST 4 1 0.95 0.71 medSST 5 0.81 0.71 0.23 crsSST +
Typical inputs of a 1D river profile model (resolution, river length, model time, rock-uplift, erodibility, grain size characteristics) +
F
USer-specified data on temperature distributions
We present the Frost model with a subsampled version of the CRU-NCEP reanalysis data for the region of Alaska. The geographical extent of this dataset has been reduced to greatly reduce the number of ocean, Aleatian Islands or Canadian pixels. The spatial resolution has been reduced by a factor of 13 in each direction, resulting in an effective pixel resolution of about 10km.
The data are monthly average temperatures for each month from January 1901 through December 2009. +
G
Upper Boundary (Air temperature)
Lower Boundary (Temperature gradient)
Initial conditions (Temperature distribution at initial time)
Thermo-physical properties +
P
Users can upload ILAMB-compatible model outputs and benchmark datasets to the PBS. More information can be found in the PBS documentation, available at https://permamodel.github.io/pbs. +
S
Various flow properties; sizes, densities and proportions of all grain fractions making up the active layer of the bed +
C
G
Water discharge inputs, sediment discharge inputs, base-level change, along-channel sources/sinks of sediment, grid of downstream distances +
D
Watershed hypsometry and detrital ages +
O
L
Width of loading element (m), value for flexural rigidity (Nm), Number of loading events, Number of loading elements for event J (position, height (m) of loading element, density (kg/m3)) +
Width of loading element (meters), value for flexural rigidity (Nm), number of nodes describing baseline position, number of loading events, number of loading elements for event, number of hidden load elements. +
P
Wind speed, storm duration, sediment characteristics, tidal currents +
B
Wind, rivers, submerged inlets, lateral open boundaries, surface heat flux, a limited number of numerical schemes can be chosen, ... +
S
X,Y coordinates of centerline, hydrologic and sedimentary parameters, as detailed in the model documentation +
B
C
You can vary the initial slope, wave periods, wave heights, and sediment fall velocity (a proxy for sediment size). +
G
You need a DEM, a watershed outline (shapefile), and a point shapefile identifying the top of the streams you are interested in. You also need to input a curvature threshold value and a drainage area threshold value. The curvature threshold is the key to identifying knickpoints (if it is too low you will not see very many knicks, and if it is too high you will identify too many). The drainage area threshold is used to exclude knickpoints that are not in the main channel you are interested in. +
S
alpha,Ua, Ub, p, Theta, k, epsilon, omega +
M
channel width (m), channel depth (m), padding (number of nodepoints along centerline), sampling distance along centerline, number of iterations, dimensionless Chezy friction factor, threshold distance at which cutoffs occur, migration rate constant (m/s), vertical slope-dependent erosion rate constant (m/s), time step (s), density of water (kg/m3), which time steps will be saved, approximate number of bends you want to model, initial slope (setting this to non-zero results in instabilities in long runs) +
R
climatology +
C
daily water discharge series;daily sediment flux series;
averaged channel cross-sectional depth, averaged channel cross-sectional width;
floodplain width;
manning coefficients of the channel and floodplain;
longitudinal channel slope;
Channel bed's super-elevation above the floodplain where sedimentation rate is close to 0;
M-coefficient for erosion rate for the bottom of crevasse splay;
M-coefficient for erosion rate for the two side slopes of crevasse splay;
critical velocity for erosion;
critical velocity for deposition;
width of dike at the root;
cross valley slope;
settling velocity of suspended load in the channel. +
W
depending on configuration, the model can be run with Air temperature and Precipitation only. In the most complex configuration, the model will also need vapor pressure, solar radiation, wind, daily minimum and maximum temperature. Built-in functions allow trading input variables (e.g. use cloud cover instead of solar radiation). +
depending on configuration, the model can be run with Air temperature and Precipitation only. In the most complex configuration, the model will also need vapor pressure, solar radiation, wind, daily minimum and maximum temperature. Built-in functions allow trading input variables (e.g. use cloud cover instead of solar radiation). +
T
describe input parameters: Initial longitudinal profile and estimated surface/subsurface grain size; sediment input, including both rate and grain size distribution, and typically at a long-term-avearged basis; and water discharge, typically daily average discharge. +
M
dissolved inorganic carbon (DIC), total alkalinity (Alk), temperature, and salinity as well as concentrations of total dissolved inorganic phosphorus and silicon concentrations. +
F
elev : array_like<br>
Elevations at nodes.
neighbors_at_node : array_like (num nodes, max neighbors at node)<br>
For each node, the link IDs of active links.
links_at_node : array_like (num nodes, max neighbors at node)<br>
link_dir_at_node: array_like (num nodes, max neighbors at node)<br>
IDs of the head node for each link.
link_slope : array_like<br>
slope of each link, defined POSITIVE DOWNHILL (i.e., a negative value means the link runs uphill from the fromnode to the tonode).
baselevel_nodes : array_like, optional<br>
IDs of open boundary (baselevel) nodes.
partition_method: string, optional<br>
Method for partitioning flow. Options include 'slope' (default) and 'square_root_of_slope'. +
T
equilibrium bed profile, sediment size, probabilities of instantaneous bed elevations and of particle entrainment, area of the patch of tracers installed on the bed, entrainment rate of particles in bedload tranport, particle step lenght +
flow forcing; sediment properties ( density, grain size, etc.); fluid properties; coefficients for carrier fluid turbulence, and parameters for kinetic theory for granular flow; model selection for kinetic theory, such as granular pressure, conductivity, and viscosity model, etc. More details are described in the user maunal. +
F
frac_spacing : int, optional<br>
Average spacing of fractures (in grid cells) (default = 10)
seed : int, optional<br>
Seed used for random number generator (default = 0) +
T
fraction of trees that move sediment when they die, # of plots to simulate, # of years to simulate, with or without growth of Chestnut. +
I
geometry of ice sheets, ice shelves, land-ice,
ocean boundaries; material parameters;
climate forcings (i.e surface mass balance); basal friction at the ice/bed interface;
flightlines; errors; boundaries; grids; preview
images +
H
grid : Landlab Model Grid instance, required<br><br>
save_full_df: bool<br>
Flag indicating whether to create the ``full_hack_dataframe``.<br>
**kwds :<br>
Values to pass to the ChannelProfiler. +
C
grid : Landlab Model Grid instance, required<br><br>
channel_definition_field : field name as string<br>
Name of field used to identify the outlet and headwater nodes of the channel network. Default is "drainage_area".
minimum_outlet_threshold : float, optional<br>
Minimum value of the *channel_definition_field* to define a watershed outlet. Default is 0.
minimum_channel_threshold : float, optional<br>
Value to use for the minimum drainage area associated with a plotted channel segment. Default values 0.
number_of_watersheds : int, optional<br>
Total number of watersheds to plot. Default value is 1. If value is greater than 1 and outlet_nodes is not specified, then the number_of_watersheds largest watersheds is based on the drainage area at the model grid boundary. If given as None, then all grid cells on the domain boundary with a stopping field (typically drainage area) greater than the minimum_outlet_threshold in area are used.
main_channel_only : Boolean, optional<br>
Flag to determine if only the main channel should be plotted, or if all stream segments with drainage area less than threshold should be plotted. Default value is True.
outlet_nodes : length number_of_watersheds iterable, optional<br>
Length number_of_watersheds iterable containing the node IDs of nodes to start the channel profiles from. If not provided, the default is the number_of_watersheds node IDs on the model grid boundary with the largest terminal drainage area.
cmap : str<br>
A valid matplotlib cmap string. Default is "viridis". +
L
grid : Landlab ModelGrid<br>
thicknesses : ndarray of shape `(n_layers, )` or `(n_layers, n_nodes)`<br>
Values of layer thicknesses from surface to depth.
Layers do not have to have constant thickness.
Layer thickness can be zero, though the entirety of Lithology must have non-zero thickness.
ids : ndarray of shape `(n_layers, )` or `(n_layers, n_nodes)`<br>
Values of rock type IDs corresponding to each layer specified in **thicknesses**.
A single layer may have multiple rock types if specified by the user
attrs : dict<br>
Rock type property dictionary.
See class docstring for example of required format.
layer_type : str, optional<br>
Type of Landlab layers object used to store the layers.
If MaterialLayers (default) is specified, then erosion removes material and does not create a layer of thickness zero.
If EventLayers is used, then erosion removes material and creates layers of thickness zero.
Thus, EventLayers may be appropriate if the user is interested in chronostratigraphy.
dz_advection : float, `(n_nodes, )` shape array, or at-node field array optional<br>
Change in rock elevation due to advection by some external process.
This can be changed using the property setter.
Dimensions are in length, not length per time.
rock_id : value or `(n_nodes, )` shape array, optional<br>
Rock type id for new material if deposited.
This can be changed using the property setter. +
S
grid : ModelGrid<br>
A Landlab ModelGrid.
initial_time : float, int, optional<br>
The initial time. The unit of time is not considered within the component, with the exception that time is logged in the record. The default value of
this parameter is 0. +
P
grid : ModelGrid<br>
A Landlab grid (optional). If provided, storm intensities will be stored as a grid scalar field as the component simulates storms.
mean_storm_duration : float<br>
Average duration of a precipitation event.
mean_interstorm_duration : float<br>
Average duration between precipitation events.
mean_storm_depth : float<br>
Average depth of precipitation events.
total_t : float, optional<br>
If generating a time series, the total amount of time.
delta_t : float or None, optional<br>
If you want to break up storms into determined subsections using yield_storm_interstorm_duration_intensity, a delta_t is needed.
random_seed : int or float, optional<br>
Seed value for random-number generator. +
L
grid : ModelGrid<br>
A Landlab grid.
surface : field name at node or array of length node<br>
The surface to direct flow across.
method : {'Steepest', 'D8'}<br>
Whether or not to recognise diagonals as valid flow paths, if a raster. Otherwise, no effect.
fill_flat : bool<br>
If True, pits will be filled to perfectly horizontal.
If False, the new surface will be slightly inclined to give steepest descent flow paths to the outlet.
fill_surface : bool<br>
Sets the field or array to fill.
If fill_surface is surface, this operation occurs in place, and is faster.
Note that the component will overwrite fill_surface if it exists; to supply an existing water level to it, supply that water level field as surface, not fill_surface.
redirect_flow_steepest_descent : bool<br>
If True, the component outputs modified versions of the 'flow__receiver_node', 'flow__link_to_receiver_node', 'flow__sink_flag', and 'topographic__steepest_slope' fields.
These are the fields output by the FlowDirector components, so set to True if you wish to pass this LakeFiller to the FlowAccumulator, or if you wish to work directly with the new, correct flow directions and slopes without rerunning these components on your new surface.
Ensure the necessary fields already exist, and have already been calculated by a FlowDirector!
This also means you need to instantiate your FlowDirector **before** you instantiate the LakeMapperBarnes.
Note that the new topographic__steepest_slope will always be set to zero, even if fill_flat=False (i.e., there is actually a miniscule gradient on the new topography, which gets ignored).
reaccumulate_flow : bool<br>
If True, and redirect_flow_steepest_descent is True, the run method will (re-)accumulate the flow after redirecting the flow.
This means the 'drainage_area', 'surface_water__discharge', 'flow__upstream_node_order', and the other various flow accumulation fields (see output field names) will now reflect the new drainage patterns without having to manually reaccumulate the discharge.
If True but redirect_flow_steepest_descent is False, raises an ValueError.
ignore_overfill : bool<br>
If True, suppresses the Error that would normally be raised during creation of a gentle incline on a fill surface (i.e., if not fill_flat).
Typically this would happen on a synthetic DEM where more than one outlet is possible at the same elevation.
If True, the was_there_overfill property can still be used to see if this has occurred.
track_lakes : bool<br>
If True, the component permits a slight hit to performance in order to explicitly track which nodes have been filled, and to enable queries on that data in retrospect.
Set to False to simply fill the surface and be done with it.
F
grid : ModelGrid<br>
A Landlab grid.
surface : field name at node or array of length node<br>
The surface to direct flow across.
flow_director : string, class, instance of class.<br>
A string of method or class name (e.g. 'D8' or 'FlowDirectorD8'), an
uninstantiated FlowDirector class, or an instance of a FlowDirector
class. This sets the method used to calculate flow directions.<br>
Default is 'FlowDirectorSteepest'
runoff_rate : field name, array, or float, optional (m/time)<br>
If provided, sets the runoff rate and will be assigned to the grid field
'water__unit_flux_in'. If a spatially and and temporally variable runoff
rate is desired, pass this field name and update the field through model
run time. If both the field and argument are present at the time of
initialization, runoff_rate will *overwrite* the field. If neither are
set, defaults to spatially constant unit input.
Both a runoff_rate array and the 'water__unit_flux_in' field are
permitted to contain negative values, in which case they mimic
transmission losses rather than e.g. rain inputs.
depression_finder : string, class, instance of class, optional<br>
A string of class name (e.g., 'DepressionFinderAndRouter'), an
uninstantiated DepressionFinder class, or an instance of a
DepressionFinder class.
This sets the method for depression finding.
**kwargs : any additional parameters to pass to a FlowDirector or
DepressionFinderAndRouter instance (e.g., partion_method for
FlowDirectorMFD). This will have no effect if an instantiated component
is passed using the flow_director or depression_finder keywords. +
S
grid : ModelGrid<br>
A Landlab model grid of any type.
number_of_years : int<br>
The number of years over which to generate storms.
orographic_scenario : {None, 'Singer', func}<br>
Whether to use no orographic rule, or to adopt S&M's 2017 calibration for Walnut Gulch. Alternatively, provide a function here that turns the provided
elevation of the storm center into a length-11 curve weighting to select which orographic scenario to apply. +
L
grid : ModelGrid<br>
A Landlab square cell raster grid object
latero_mech : string, optional (defaults to UC)<br>
Lateral erosion algorithm, choices are "UC" for undercutting-slump model and "TB" for total block erosion
alph : float, optional (defaults to 0.8)<br>
Parameter describing potential for deposition, dimensionless
Kv : float, node array, or field name<br>
Bedrock erodibility in vertical direction, 1/years
Kl_ratio : float, optional (defaults to 1.0)<br>
Ratio of lateral to vertical bedrock erodibility, dimensionless
solver : string<br>
Solver options:<br>
(1) 'basic' (default): explicit forward-time extrapolation. Simple but will become unstable if time step is too large or if bedrock erodibility is
very high.<br>
(2) 'adaptive': subdivides global time step as needed to prevent slopes from reversing.
inlet_node : integer, optional<br>
Node location of inlet (source of water and sediment)
inlet_area : float, optional<br>
Drainage area at inlet node, must be specified if inlet node is "on", m^2
qsinlet : float, optional<br>
Sediment flux supplied at inlet, optional. m3/year
flow_accumulator : Instantiated Landlab FlowAccumulator, optional<br>
When solver is set to "adaptive", then a valid Landlab FlowAccumulator must be passed. It will be run within sub-timesteps in order to update the flow
directions and drainage area. +
F
grid : ModelGrid<br>
A grid of type RasterModelGrid.
surface : field name at node or array of length node, optional<br>
The surface to direct flow across, default is field at node: topographic__elevation. +
grid : ModelGrid<br>
A grid of type Voroni.
elevs : field name at node or array of length node<br>
The surface to direct flow across.
baselevel_nodes : array_like, optional<br>
IDs of open boundary (baselevel) nodes. +
P
grid : ModelGrid<br>
A grid.
method : {'D8', 'D4'}, optional<br>
Routing method ('D8' is the default). This keyword has no effect for a Voronoi-based grid.
flow_equation : {'default', 'Manning', 'Chezy'}, optional<br>
If Manning or Chezy, flow is routed according to the Manning or Chezy equation; discharge is allocated to multiple downslope nodes proportional to the
square root of discharge; and a water__depth field is returned. If default, flow is allocated to multiple nodes linearly with slope; and the
water__depth field is not calculated.
Chezys_C : float, optional<br>
Required if flow_equation == 'Chezy'.
Mannings_n : float, optional<br>
Required if flow_equation == 'Manning'. +
F
grid : ModelGrid<br>
A grid.
surface : field name at node or array of length node, optional<br>
The surface to direct flow across, default is field at node: topographic__elevation. +
S
grid : ModelGrid<br>
A grid.
surface : field name at node or array of length node<br>
The surface to fill.
method : {'Steepest', 'D8'}<br>
Whether or not to recognise diagonals as valid flow paths, if a raster. Otherwise, no effect.
fill_flat : bool<br>
If True, pits will be filled to perfectly horizontal. If False, the new surface will be slightly inclined (at machine precision) to give steepest
descent flow paths to the outlet, once they are calculated.
ignore_overfill : bool<br>
If True, suppresses the Error that would normally be raised during creation of a gentle incline on a fill surface (i.e., if not fill_flat). Typically
this would happen on a synthetic DEM where more than one outlet is possible at the same elevation. If True, the was_there_overfill property can still
be used to see if this has occurred. +
D
grid : RasterModelGrid
A landlab grid.
K_sp : float, optional
K in the stream power equation (units vary with other parameters -
if used with the de Almeida equation it is paramount to make sure
the time component is set to *seconds*, not *years*!)
m_sp : float, optional
Stream power exponent, power on discharge
n_sp : float, optional
Stream power exponent, power on slope
uplift_rate : float, optional
changes in topographic elevation due to tectonic uplift
entrainment_threshold : float, optional
threshold for sediment movement
slope : str
Field name of an at-node field that contains the slope. +
C
grid : RasterModelGrid
A landlab RasterModelGrid.<br>
reference_concavity : float<br>
The reference concavity to use in the calculation.
min_drainage_area : float (m**2)<br>
The drainage area down to which to calculate chi.
reference_area : float or None (m**2)<br>
If None, will default to the mean core cell area on the grid. Else, provide a value to use. Essentially becomes a prefactor on the value of chi.
use_true_dx : bool (default False)<br>
If True, integration to give chi is performed using each value of node spacing along the channel (which can lead to a quantization effect, and is not preferred by Taylor & Royden). If False, the mean value of node spacing along the all channels is assumed everywhere.
clobber : bool (default False)<br>
Raise an exception if adding an already existing field. +
Z
grid : RasterModelGrid<br>
A Landlab RasterModelGrid.
zone_function : function<br>
A function that return a mask of the total zone extent. The first input parameter of this function must be `grid`.
minimum_area : float, optional<br>
The minimum area of the zones that will be created.
neighborhood_structure : {'D8', 'D4'}, optional<br>
The structure describes how zones are identified. The default, 'D8' evaluates the eight neighboring nodes. The diagonal neighboring nodes are excluded
when 'D4' is selected.
initial_time : float, int, optional<br>
The initial time. The unit of time is unspecified within the controller. The default is 0.
kwargs<br>
Keyword arguments for ``zone_function``. Do not include ``grid`` in kwargs because ``grid``, the first parameter of this method, is automatically added
to ``kwargs``. +
P
grid : RasterModelGrid<br>
A Landlab raster grid
nonlinear_diffusivity : float, array or field name<br>
The nonlinear diffusivity
S_crit : float (radians)<br>
The critical hillslope angle
rock_density : float (kg*m**-3)<br>
The density of intact rock
sed_density : float (kg*m**-3)<br>
The density of the mobile (sediment) layer +
O
grid : RasterModelGrid<br>
A grid.
dt : float, optional<br>
Time step. Either set when called or the component will do it for you. +
F
grid : RasterModelGrid<br>
A grid.
eet : float, optional<br>
Effective elastic thickness (m).
youngs : float, optional<br>
Young's modulus.
method : {'airy', 'flexure'}, optional<br>
Method to use to calculate deflections.
rho_mantle : float, optional<br>
Density of the mantle (kg / m^3).
gravity : float, optional<br>
Acceleration due to gravity (m / s^2).
n_procs : int, optional<br>
Number of processors to use for calculations. +
D
grid : RasterModelGrid<br>
A landlab RasterModelGrid.
routing : str<br>
If grid is a raster type, controls whether lake connectivity can
occur on diagonals ('D8', default), or only orthogonally ('D4').
Has no effect if grid is not a raster.
pits : array or str or None, optional<br>
If a field name, the boolean field containing True where pits.
If an array, either a boolean array of nodes of the pits, or an
array of pit node IDs. It does not matter whether or not open
boundary nodes are flagged as pits; they are never treated as such.
Default is 'flow__sink_flag', the pit field output from the
:py:mod:`FlowDirectors <landlab.components.flow_director>`.
reroute_flow : bool, optional<br>
If True (default), and the component detects the output fields in
the grid produced by the FlowAccumulator component, this component
will modify the existing flow fields to route the flow across the
lake surface(s). +
S
grid : RasterModelGrid<br>
A landlab RasterModelGrid.
reference_concavity : float<br>
The reference concavity to use in the calculation.
min_drainage_area : float (m**2; default 1.e6)<br>
The minimum drainage area above which steepness indices are
calculated. Defaults to 1.e6 m**2, per Wobus et al. 2006.
elev_step : float (m; default 0.)<br>
If >0., becomes a vertical elevation change step to use to discretize the data (per Wobus). If 0., all nodes are used and no discretization happens.
discretization_length : float (m; default 0.)<br>
If >0., becomes the lengthscale over which to segment the profiles - i.e., one different steepness index value is calculated every
discretization_length. If only one (or no) points are present in a segment, it will be lumped together with the next segment. If zero, one value is
assigned to each channel node. +
grid : a ModelGrid<br>
A grid.
K_sp : float (time unit must be *years*)<br>
K in the stream power equation; the prefactor on the erosion equation (units vary with other parameters).
g : float (m/s**2)<br>
Acceleration due to gravity.
rock_density : float (Kg m**-3)<br>
Bulk intact rock density.
sediment_density : float (Kg m**-3)<br>
Typical density of loose sediment on the bed.
fluid_density : float (Kg m**-3)<br>
Density of the fluid.
runoff_rate : float, array or field name (m/s)<br>
The rate of excess overland flow production at each node (i.e., rainfall rate less infiltration).
pseudoimplicit_repeats : int<br>
Number of loops to perform with the pseudoimplicit iterator, seeking a stable solution. Convergence is typically rapid.
return_stream_properties : bool<br>
Whether to perform a few additional calculations in order to set the additional optional output fields, 'channel__width', 'channel__depth', and
'channel__discharge' (default False).
sed_dependency_type : {'generalized_humped', 'None', 'linear_decline', 'almost_parabolic'}<br>
The shape of the sediment flux function. For definitions, see Hobley et al., 2011. 'None' gives a constant value of 1.
NB: 'parabolic' is currently not supported, due to numerical stability issues at channel heads.
Qc : {'power_law', 'MPM'}<br>
Whether to use simple stream-power-like equations for both sediment transport capacity and erosion rate, or more complex forms based directly on the
Meyer-Peter Muller equation and a shear stress based erosion model consistent with MPM (per Hobley et al., 2011).
If ``sed_dependency_type == 'generalized_humped'``...<br>
kappa_hump : float<br>
Shape parameter for sediment flux function. Primarily controls function amplitude (i.e., scales the function to a maximum of 1). Default follows Leh
valley values from Hobley et al., 2011.
nu_hump : float<br>
Shape parameter for sediment flux function. Primarily controls rate of rise of the "tools" limb. Default follows Leh valley values from Hobley et al.,
2011.
phi_hump : float<br>
Shape parameter for sediment flux function. Primarily controls rate of fall of the "cover" limb. Default follows Leh valley values from Hobley et al.,
2011.
c_hump : float<br>
Shape parameter for sediment flux function. Primarily controls degree of function asymmetry. Default follows Leh valley values from Hobley et al.,
2011.
If ``Qc == 'power_law'``...<br>
m_sp : float<br>
Power on drainage area in the erosion equation.
n_sp : float<br>
Power on slope in the erosion equation.
K_t : float (time unit must be in *years*)<br>
Prefactor in the transport capacity equation.
m_t : float<br>
Power on drainage area in the transport capacity equation.
n_t : float<br>
Power on slope in the transport capacity equation.
if ``Qc == 'MPM'``...<br>
C_MPM : float<br>
A prefactor on the MPM relation, allowing tuning to known sediment saturation conditions (leave as 1. in most cases).
a_sp : float<br>
Power on shear stress to give erosion rate.
b_sp : float<br>
Power on drainage area to give channel width.
c_sp : float<br>
Power on drainage area to give discharge.
k_w : float (unit variable with b_sp)<br>
Prefactor on A**b_sp to give channel width.
k_Q : float (unit variable with c_sp, but time unit in *seconds*)<br>
Prefactor on A**c_sp to give discharge.
mannings_n : float<br>
Manning's n for the channel.
threshold_shear_stress : None or float (Pa)<br>
The threshold shear stress in the equation for erosion rate. If None, implies that *set_threshold_from_Dchar* is True, and this parameter will get set
from the Dchar value and critical Shields number.
Dchar :None, float, array, or field name (m)<br>
The characteristic grain size on the bed, that controls the relationship between critical Shields number and critical shear stress. If None, implies
that *set_Dchar_from_threshold* is True, and this parameter will get set from the threshold_shear_stress value and critical Shields number.
set_threshold_from_Dchar : bool<br>
If True (default), threshold_shear_stress will be set based on Dchar and threshold_Shields.
set_Dchar_from_threshold : bool<br>
If True, Dchar will be set based on threshold_shear_stress and threshold_Shields. Default is False.
threshold_Shields : None or float<br>
The threshold Shields number. If None, implies that *slope_sensitive_threshold* is True.
slope_sensitive_threshold : bool<br>
If True, the threshold_Shields will be set according to 0.15 * S ** 0.25, per Lamb et al., 2008 & Hobley et al., 2011.
flooded_depths : array or field name (m)<br>
Depths of flooding at each node, zero where no lake. Note that the component will dynamically update this array as it fills nodes with sediment
(...but does NOT update any other related lake fields).
W
grid size, end time, initial slope, erodibility, climate (rainfall rate), tectonic (uplift rate and break point) +
D
grid: ModelGrid
Landlab ModelGrid object
linear_diffusivity: float, optional.
Hillslope diffusivity, m**2/yr
Default = 1.0
slope_crit: float, optional
Critical gradient parameter, m/m
Default = 1.0
soil_transport_decay_depth: float, optional
characteristic transport soil depth, m
Default = 1.0
nterms: int, optional. default = 2
number of terms in the Taylor expansion.
Two terms (default) gives the behavior
described in Ganti et al. (2012). +
grid: ModelGrid
Landlab ModelGrid object
linear_diffusivity: float
Hillslope diffusivity, m**2/yr
soil_transport_decay_depth: float
characteristic transport soil depth, m +
E
grid: ModelGrid<br>
Landlab ModelGrid object
soil_production__maximum_rate : float<br>
Maximum weathering rate for bare bedrock
soil_production__decay_depth : float<br>
Characteristic weathering depth +
T
grid: ModelGrid<br>
Landlab ModelGrid object
linear_diffusivity: float, optional<br>
Hillslope diffusivity, m**2/yr
Default = 1.0
slope_crit: float, optional<br>
Critical slope
Default = 1.0
nterms: int, optional. default = 2<br>
number of terms in the Taylor expansion.
Two terms (Default) gives the behavior described in Ganti et al. (2012).
dynamic_dt : boolean (optional, default is False)<br>
Keyword argument to turn on or off dynamic time-stepping.
if_unstable : string (optional, default is "pass")<br>
Keyword argument to determine how potential instability due to slopes that are too high is handled. Options are "pass", "warn", and "raise".
courant_factor : float (optional, default = 0.2)<br>
Factor to identify stable time-step duration when using dynamic timestepping. +
V
grid: RasterModelGrid<br>
A grid.
Blive_init: float, optional<br>
Initial value for vegetation__live_biomass. Converted to field.
Bdead_init: float, optional<br>
Initial value for vegetation__dead_biomass. Coverted to field.
ETthreshold_up: float, optional<br>
Potential Evapotranspiration (PET) threshold for growing season (mm/d).
ETthreshold_down: float, optional<br>
PET threshold for dormant season (mm/d).
Tdmax: float, optional<br>
Constant for dead biomass loss adjustment (mm/d).
w: float, optional<br>
Conversion factor of CO2 to dry biomass (Kg DM/Kg CO2).
WUE: float, optional<br>
Water Use Efficiency - ratio of water used in plant water lost by the plant through transpiration (KgCO2Kg-1H2O).
LAI_max: float, optional<br>
Maximum leaf area index (m2/m2).
cb: float, optional<br>
Specific leaf area for green/live biomass (m2 leaf g-1 DM).
cd: float, optional<br>
Specific leaf area for dead biomass (m2 leaf g-1 DM).
ksg: float, optional<br>
Senescence coefficient of green/live biomass (d-1).
kdd: float, optional<br>
Decay coefficient of aboveground dead biomass (d-1).
kws: float, optional<br>
Maximum drought induced foliage loss rate (d-1).
method: str<br>
Method name.
Tr: float, optional<br>
Storm duration (hours).
Tb: float, optional<br>
Inter-storm duration (hours).
PETthreshold_switch: int, optional<br>
Flag to indiate the PET threshold. This controls whether the threshold is for growth (1) or dormancy (any other value). +
grid: RasterModelGrid<br>
A grid.
Pemaxg: float, optional<br>
Maximal establishment probability of grass.
ING: float, optional<br>
Parameter to define allelopathic effect of creosote on grass.
ThetaGrass: float, optional<br>
Drought resistance threshold of grass.
PmbGrass: float, optional<br>
Background mortality probability of grass.
Pemaxsh: float, optional<br>
Maximal establishment probability of shrub.
ThetaShrub: float, optional<br>
Drought resistance threshold of shrub.
PmbShrub: float, optional<br>
Background mortality probability of shrub.
tpmaxShrub: float, optional<br>
Maximum age of shrub (years).
Pemaxtr: float, optional<br>
Maximal establishment probability of tree.
Thetatree: float, optional<br>
Drought resistance threshold of tree.
PmbTree: float, optional<br>
Background mortality probability of tree.
tpmaxTree: float, optional<br>
Maximum age of tree (years).
ThetaShrubSeedling: float, optional<br>
Drought resistance threshold of shrub seedling.
PmbShrubSeedling: float, optional<br>
Background mortality probability of shrub seedling.
tpmaxShrubSeedling: float, optional<br>
Maximum age of shrub seedling (years).
ThetaTreeSeedling: float, optional<br>
Drought resistance threshold of tree seedling.
PmbTreeSeedling: float, optional<br>
Background mortality probability of tree seedling.
tpmaxTreeSeedling: float, optional<br>
Maximum age of tree seedling (years).
method: str, optional<br>
Method used.
Edit_VegCov: bool, optional<br>
If Edit_VegCov=True, an optional field 'vegetation__boolean_vegetated' will be output, (i.e.) if a cell is vegetated the corresponding cell of the
field will be 1, otherwise it will be 0. +
P
grid: RasterModelGrid<br>
A grid.
method: {'Constant', 'PriestleyTaylor', 'MeasuredRadiationPT', 'Cosine'}, optional<br>
Priestley Taylor method will spit out radiation outputs too.
priestley_taylor_constant: float, optional<br>
Alpha used in Priestley Taylor method.
albedo: float, optional<br>
Albedo.
latent_heat_of_vaporization: float, optional<br>
Latent heat of vaporization for water Pwhv (Wd/(m*mm^2)).
psychometric_const: float, optional<br>
Psychometric constant (kPa (deg C)^-1).
stefan_boltzmann_const: float, optional<br>
Stefan Boltzmann's constant (W/(m^2K^-4)).
solar_const: float, optional<br>
Solar constant (W/m^2).
latitude: float, optional<br>
Latitude (radians).
elevation_of_measurement: float, optional<br>
Elevation at which measurement was taken (m).
adjustment_coeff: float, optional<br>
adjustment coeff to predict Rs from air temperature (deg C)^-0.5.
lt: float, optional<br>
lag between peak TmaxF and solar forcing (days).
nd: float, optional<br>
Number of days in year (days).
MeanTmaxF: float, optional<br>
Mean annual rate of TmaxF (mm/d).
delta_d: float, optional<br>
Calibrated difference between max & min daily TmaxF (mm/d).
current_time: float, required only for 'Cosine' method<br>
Current time (Years)
const_potential_evapotranspiration: float, optional for 'Constant' method<br>
Constant PET value to be spatially distributed.
Tmin: float, required for 'Priestley Taylor' method<br>
Minimum temperature of the day (deg C)
Tmax: float, required for 'Priestley Taylor' method<br>
Maximum temperature of the day (deg C)
Tavg: float, required for 'Priestley Taylor' and 'MeasuredRadiationPT' methods<br>
Average temperature of the day (deg C)
obs_radiation float, required for 'MeasuredRadiationPT' method<br>
Observed radiation (W/m^2) +
R
grid: RasterModelGrid<br>
A grid.
method: {'Grid'}, optional<br>
Currently, only default is available.
cloudiness: float, optional<br>
Cloudiness.
latitude: float, optional<br>
Latitude (radians).
albedo: float, optional<br>
Albedo.
solar_constant: float, optional<br>
Solar Constant (W/m^2).
clearsky_turbidity: float, optional<br>
Clear sky turbidity.
opt_airmass: float, optional<br>
Optical air mass.
current_time: float<br>
Current time (years).
hour: float, optional<br>
Hour of the day. Default is 12 (solar noon) +
S
grid: RasterModelGrid<br>
A grid.
runon: float, optional<br>
Runon from higher elevation (mm).
f_bare: float, optional<br>
Fraction to partition PET for bare soil (None).
soil_ew: float, optional<br>
Residual Evaporation after wilting (mm/day).
intercept_cap: float, optional<br>
Plant Functional Type (PFT) specific full canopy interception capacity.
zr: float, optional<br>
Root depth (m).
I_B: float, optional<br>
Infiltration capacity of bare soil (mm/h).
I_V: float, optional<br>
Infiltration capacity of vegetated soil (mm/h).
pc: float, optional<br>
Soil porosity (None).
fc: float, optional<br>
Soil saturation degree at field capacity (None).
sc: float, optional<br>
Soil saturation degree at stomatal closure (None).
wp: float, optional<br>
Soil saturation degree at wilting point (None).
hgw: float, optional<br>
Soil saturation degree at hygroscopic point (None).
beta: float, optional<br>
Deep percolation constant = 2*b+3 where b is water retention (None).
LAI_max: float, optional<br>
Maximum leaf area index (m^2/m^2).
LAIR_max: float, optional<br>
Reference leaf area index (m^2/m^2).
method: str<br>
Method used
Tr: float, optional<br>
Storm duration (hours).
Tb: float, optional<br>
Inter-storm duration (hours).
current_time: float<br>
Current time (years). +
F
grid: landlab model grid<br><br>
mean_fire_recurrence : float<br>
Average time between fires for a given location<br><br>
shape_parameter : float<br>
Describes the skew of the Weibull distribution.<br>
If shape < 3.5, data skews left.<br>
If shape == 3.5, data is normal.<br>
If shape > 3.5, data skews right.<br><br>
scale_parameter : float, optional<br>
Describes the peak of the Weibull distribution, located at the
63.5% value of the cumulative distribution function. If unknown,
it can be found using mean fire recurrence value and the
get_scale_parameter(). +
G
P
W
hundreds of physical parameters +
G
hydraulic conductivity, time resolution, rainfall intensity, the change in the moisture content, wetting front soil suction head +
S
initial basin configuration, boundary conditions for fluid flow and sediment input, conditions for carbonate producing organisms, sea level changes, temporal changes in boundary conditions +
P
C
integer - type of coordinates (1 - cartesian, otherwise-spherical)
DEM file name
number of grids enclosed in Master grid
enclosed DEMs file names if any
still sea threshold
minimal flow depth
friction coefficient
topo flag: 0-wall, otherwise - land inundation
depth to place vertical wall, if any
time step
total amount of steps
integer - apply initial deformation to bottom or sea surface
integer - flag to continue or stop after input stops (0 for interrupt)
number of steps between screenshots
number to subsample screenshots in x
number to subsample screenshots in y
number of timesteps between saving boundary feed to enclosed grids
number of steps between maxwave updates
number of virtual gages
steps between outputs in gage time histories
i,j indexes of gage locations on the grid +
D
Y
G
model_type: 'grainhill', 'block', or 'facet' (default 'grainhill')
number_of_node_rows: # rows
number_of_node_columns: # columns
cell_width: width of grid cells, m
grav_accel: gravitational acceleration, m/s2
friction_coef: dimensionless friction factor, 0 to 1
run_duration: duration of run, years
uplift_interval: time interval between uplift events, years
dissolution_rate: (facet only) rate coefficient for dissolution, 1/years
disturbance_rate: frequency parameter for soil disturbance, 1/years
weathering_rate: frequency parameter for rock weathering, 1/years
rock_state_for_uplift: type of material added at base during uplift (7=soil, 8=rock)
block_layer_dip_angle: ('block' only) dip angle for layer made of blocks
block_layer_thickness: ('block' only) thickness, in cells, of layer
layer_left_x: ('block' only) x coordinate of left edge of layer
y0_top: ('block' only) if block option selected, y coordinate of top of layer at x=0
fault_x: ('facet' only) x location of fault trace at y=0, m
baselevel_rise_interval: ('facet' only) rate of left-side baselevel rise, m/yr
opt_rock_collapse: option to have rock cells collapse when undermined
save_plots: whether to save any plots to file (True or False)
plot_filename: base name for plot files, if used
plot_filetype: filename extension for plots (default '.png')
plot_interval: interval between plots, years
output_interval: interval between file output, years
report_interval: real-time interval for reporting on screen, seconds +
M
G
R
reach averaged bankfull width, slope, grain size, shields parameter, control function parameters +
X
rectilinear grid, bathymetry, boundary spectral parameters, water levels, sediment sizes, model parameters +
P
river centerline XY coordinates +
M
river channel network, runoff, water demand, reservoir operations +
see MODFLOW 6 Description of Input/Output
at https://water.usgs.gov/water-resources/software/MODFLOW-6 +
T
see documentation along with source code, also available here:
https://sites.google.com/site/daniggcc/software/tao +
O
L
soil creep coefficient; initial topography +
F
start time step, number of time steps to run, settling velocity, Reynolds number, see more details in the user manual. +
S
water depth, current speed at height z, current direction, wave height, wave period, wave direction, median grain-size, bed slope, sediment density, salinity, temperature +
W
wind at 10m, air-sea temperature difference, ice concentration, curents and water levels (bathymetry) +
A
wind waves,
soil resistance / shear strength +
S
wind, air temperature, humidity, pressure, solar and infrared radiation. Oceanic fields from OGCM for initial and boundary conditions +
B
Z
zones : list of Zones<br>
The initial SpeciesEvolver Zones where the taxon is located.
parent : Taxon, optional<br>
A SpeciesEvolver taxon that is the parent taxon. The default value, 'None' indicates no parent.
time_to_allopatric_speciation : float, int, optional<br>
The delay in model time to speciate following taxon geographic fragmentation, indicated by multiple objects in the attribute, ``zones``. Speciation
occurs at the time step when the delay is reached or exceeded. The default value of 0 indicates speciation occurs at the same time step as geographic
fragmentation.
persists_post_speciation : boolean, optional<br>
When 'True', the default, taxon persists despite speciation. When 'False' and following speciation, the taxon is no longer extant. +
