This page contains the documentation of the main functions related to the static analysis.
The TrapStructure contains all the fundamental results from running
spillanalysis. This includes the identified traps, their volumes,
footprints, how they are connected, and the associated watersheds and spill point
locations. TrapStructure also contains the spillfield (how flow is directed
between gridcells), as well as a copy of the topography, buildings and sinks
that went into the analysis.
Modules = [SurfaceWaterIntegratedModeling]
Pages = ["TrapStructure.jl"]
The function spillanalysis runs a complete analysis on a provided terrain grid
and associated buildings and sinks, and returns a TrapStructure as
output. This is the central function for static topographic analysis in SWIM.
Modules = [SurfaceWaterIntegratedModeling]
Pages = ["spillanalysis.jl"]
The functions listed below are used by the spillanalysis
function. They can however also be run independently.
The spillfield function computes the basic gravity-driven flow pattern
on a terrain. For each cell, it determines the direction of flow and the
correpsonding neighbor downstream cell, using either a 4-element or 8-element stencil.
Modules=[SurfaceWaterIntegratedModeling]
Pages = ["spillfield.jl"]
For a given spillfield (as computed by the spillfield function), the
spillregions function separates the terain into individual watersheds,
each associated with a local minimum in the terrain surface.
Modules=[SurfaceWaterIntegratedModeling]
Pages = ["spillregions.jl"]
The Spillpoint struct contains the information for a particular spill
point, i.e. the point where a trap/lake spills over. Spillpoint contains
the index of the downstream region, the location of the spillpoint itself, as
well as its vertical elevation.
The spillpoints function is used to compute all the spillpoints
associated with a set of spill regions (which has been previously computed
using spillregions).
Modules=[SurfaceWaterIntegratedModeling]
Pages = ["spillpoints.jl"]
The sshierarchy! identifies higher-level traps from a set of
subtraps. In other words, it identifies those traps that emerges when smaller
traps coalesce as they fill up. It requires the output of
spillregions and spillpoints as part of it input.
Modules=[SurfaceWaterIntegratedModeling]
Pages = ["sshierarchy.jl"]
The function [trapvolumes][@ref] is used to compute the volumes of all traps
and subtraps identified on an analysed surface. It requires the result of
spillregions and spillpoints as input parameters.
Modules=[SurfaceWaterIntegratedModeling]
Pages = ["trapvolumes.jl"]
The Domain2D struct represent a rectangular subpart of a terrain grid. It is
mainly used to specify subsets of a terrain that should be updated or processed
in parallel.
Modules=[SurfaceWaterIntegratedModeling]
Pages = ["domain.jl"]