Model:SinkFiller

SinkFiller

Also known as
Model type	Tool
Model part of larger framework	LandLab
Note on status model
Date note status model

Incorporated models or components:

Spatial dimensions	2D
Spatial extent	Regional-Scale, Landscape-Scale
Model domain	Terrestrial, Hydrology
One-line model description	Fill sinks in a landscape to the brim, following the Barnes et al. (2014) algorithms.
Extended model description	Uses the Barnes et al (2014) algorithms to replace pits in a topography with flats, or optionally with very shallow gradient surfaces to allow continued draining. This component is NOT intended for use iteratively as a model runs; rather, it is to fill in an initial topography. If you want to repeatedly fill pits as a landscape develops, you are after the LakeMapperBarnes component. If you want flow paths on your filled landscape, manually run a FlowDirector and FlowAccumulator for yourself. The locations and depths etc. of the fills will be tracked, and properties are provided to access this information.

Keywords:	depressions, flow routing,

Supported platforms	Unix, Linux, Mac OS, Windows
Other platform
Programming language	Python
Other program language
Code optimized	Single Processor
Multiple processors implemented
Nr of distributed processors
Nr of shared processors
Start year development	2018
Does model development still take place?	No
If above answer is no, provide end year model development	2020
Code development status	Only maintenance
When did you indicate the 'code development status'?	2020
Model availability	As code
Source code availability (Or provide future intension)	Through web repository
Source web address	https://github.com/landlab/landlab/tree/master/landlab
Source csdms web address
Program license type	BSD or MIT X11
Program license type other
Memory requirements
Typical run time

Describe input parameters	grid : ModelGrid A grid. surface : field name at node or array of length node The surface to fill. method : {'Steepest', 'D8'} Whether or not to recognise diagonals as valid flow paths, if a raster. Otherwise, no effect. fill_flat : bool 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 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.
Input format	ASCII
Other input format
Describe output parameters	"sediment_fill__depth": { "dtype": float, "intent": "out", "optional": False, "units": "m", "mapping": "node", "doc": "Depth of sediment added at eachnode", } "topographic__elevation": { "dtype": float, "intent": "inout", "optional": False, "units": "m", "mapping": "node", "doc": "Land surface topographic elevation", }
Output format	ASCII
Other output format
Pre-processing software needed?	No
Describe pre-processing software
Post-processing software needed?	No
Describe post-processing software
Visualization software needed?	No
If above answer is yes
Other visualization software

Describe processes represented by the model
Describe key physical parameters and equations
Describe length scale and resolution constraints
Describe time scale and resolution constraints
Describe any numerical limitations and issues

Describe available calibration data sets
Upload calibration data sets if available:
Describe available test data sets
Upload test data sets if available:
Describe ideal data for testing

Do you have current or future plans for collaborating with other researchers?

Is there a manual available?	No
Upload manual if available:
Model website if any	https://landlab.github.io
Model forum / discussion board	https://github.com/landlab/landlab/issues

Comments

This part will be filled out by CSDMS staff

OpenMI compliant	Not yet"Not yet" is not in the list (Yes, No but planned, No but possible, No not possible) of allowed values for the "Code openmi compliant or not" property.
BMI compliant	Not yet"Not yet" is not in the list (Yes, No but planned, No but possible, No not possible) of allowed values for the "Code IRF or not" property.
WMT component	Not yet"Not yet" is not in the list (Yes, In progress, No but possible, No not possible) of allowed values for the "Code CMT compliant or not" property.
PyMT component	Not yet"Not yet" is not in the list (Yes, In progress, No but possible, No not possible) of allowed values for the "Code PyMT compliant or not" property.
Is this a data component

Can be coupled with:

Model info

Authors

Source code

Model citations

QR-code

Link to this page

Other models by author