Model:PotentialityFlowRouter

From CSDMS


PotentialityFlowRouter


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
Model domain Terrestrial, Hydrology
One-line model description Multidirectional flow routing using a novel method.
Extended model description This class implements Voller, Hobley, and Paola’s experimental matrix solutions for flow routing. The method works by solving for a potential field at all nodes on the grid, which enforces both mass conservation and flow downhill along topographic gradients. It is order n and highly efficient, but does not return any information about flow connectivity.

Options are permitted to allow “abstract” routing (flow enforced downslope, but no particular assumptions are made about the governing equations), or routing according to the Chezy or Manning equations. This routine assumes that water is distributed evenly over the surface of the cell in deriving the depth, and does not assume channelization. You will need to back- calculate channel depths for yourself using known widths at each node if that is what you want.

Keywords:

flow path, flow routing,

Name Daniel Hobley
Type of contact
Institute / Organization
Postal address 1
Postal address 2
Town / City Boulder
Postal code 80309
State Colorado
Country United States
Email address daniel.hobley@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 2015
Does model development still take place? Yes
If above answer is no, provide end year model development
Code development status Active
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.

method : {'D8', 'D4'}, optional
Routing method ('D8' is the default). This keyword has no effect for a Voronoi-based grid.

flow_equation : {'default', 'Manning', 'Chezy'}, optional
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
Required if flow_equation == 'Chezy'.

Mannings_n : float, optional
Required if flow_equation == 'Manning'.

Input format ASCII
Other input format
Describe output parameters "flow__potential":

{ "dtype": float, "intent": "out", "optional": False, "units": "m**3/s", "mapping": "node", "doc": "Value of the hypothetical field 'K', used to force water flux to flow downhill", }

"surface_water__depth": { "dtype": float, "intent": "out", "optional": False, "units": "m", "mapping": "node", "doc": "Depth of water on the surface", }

"surface_water__discharge": { "dtype": float, "intent": "out", "optional": False, "units": "m**3/s", "mapping": "node", "doc": "Volumetric discharge of surface water", }

"topographic__elevation": { "dtype": float, "intent": "in", "optional": False, "units": "m", "mapping": "node", "doc": "Land surface topographic elevation", }

"water__unit_flux_in": { "dtype": float, "intent": "in", "optional": False, "units": "m/s", "mapping": "node", "doc": "External volume water per area per time input to each node (e.g., rainfall rate)", }

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
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 PotentialityFlowRouter

Issues

Help

Input Files

Output Files