Property:Describe input parameters model
From CSDMS
This is a property of type Text.
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
