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