Model:FlowDirectorMFD

From CSDMS


FlowDirectorMFD


Metadata

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, Watershed-Scale, Reach-Scale
Model domain Terrestrial, Hydrology
One-line model description Multiple-path flow direction with or without out diagonals.
Extended model description Directs flow by the multiple flow direction method. Each node is assigned multiple flow directions, toward all of the N neighboring nodes that are lower than it. If none of the neighboring nodes are lower, the location is identified as a pit. Flow proportions can be calculated as proportional to slope or proportional to the square root of slope, which is the solution to a steady kinematic wave.
Keywords:

flow path, flow director,

Name Katy Barnhart
Type of contact
Institute / Organization
Postal address 1
Postal address 2
Town / City Boulder
Postal code 80309
State Colorado
Country United States
Email address katherine.barnhart@colorado.edu
Phone
Fax


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 2017
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 elev : array_like

Elevations at nodes.

neighbors_at_node : array_like (num nodes, max neighbors at node)
For each node, the link IDs of active links.

links_at_node : array_like (num nodes, max neighbors at node)

link_dir_at_node: array_like (num nodes, max neighbors at node)
IDs of the head node for each link.

link_slope : array_like
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
IDs of open boundary (baselevel) nodes.

partition_method: string, optional
Method for partitioning flow. Options include 'slope' (default) and 'square_root_of_slope'.

Input format ASCII
Other input format
Describe output parameters receivers : ndarray of size (num nodes, max neighbors at node)

For each node, the IDs of the nodes that receive its flow. For nodes that do not direct flow to all neighbors, BAD_INDEX_VALUE is given as a placeholder. The ID of the node itself is given if no other receiver is assigned.

proportions : ndarray of size (num nodes, max neighbors at node)
For each receiver, the proportion of flow (between 0 and 1) is given. A proportion of zero indicates that the link does not have flow along it.

slopes: ndarray of size (num nodes, max neighbors at node)
For each node in the array ``recievers``, the slope value (positive downhill) in the direction of flow. If no flow occurs (value of ``recievers`` is -1), then this array is set to 0.

steepest_slope : ndarray
The slope value (positive downhill) in the direction of flow.

steepest_receiver : ndarray
For each node, the node ID of the node connected by the steepest link. BAD_INDEX_VALUE is given if no flow emmanates from the node.

sink : ndarray
IDs of nodes that are flow sinks (they are their own receivers)

receiver_links : ndarray of size (num nodes, max neighbors at node)
ID of links that leads from each node to its receiver, or BAD_INDEX_VALUE if no flow occurs on this link.

steepest_link : ndarray
For each node, the link ID of the steepest link. BAD_INDEX_VALUE is given if no flow emanates from the node.

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
Katy Barnhart
Nr. of publications: --
Total citations: 0
h-index: --"--" is not a number.
m-quotient: 0

Link to this page



Introduction

History

References




Nr. of publications: --
Total citations: 0
h-index: --"--" is not a number.
m-quotient: 0


See more publications of FlowDirectorMFD

Issues

Help

Input Files

Output Files