SAGA-GIS Tool Library Documentation (v7.8.2)

Tool Accumulation Functions

Provides "accumulation functions" that can be used to e.g. move material over a "local drain direction" (LDD) network. The LDD net is computed for the supplied surface by MFD and D8 flow-routing algorithms. It is possible to switch from MFD to D8 as soon as a threshold is exceeded.
The input to each cell on the grid can be supplied from e.g. time series and the material can be moved over the net in several ways. All of these, except the "accuflux" operation, compute both the flux and the state for a given cell. For time series modelling (batch processing), the state of each cell at time t can be initialized with the previous state t - 1.
The capacity, fraction, threshold and trigger operations compute the fluxes and cell states at time t + 1 according to cell-specific parameters that control the way the flux is computed. The capacity function limits the cell-to-cell flux by a (channel) capacity control; the fraction function transports only a given proportion of material from cell to cell, the threshold function transports material only once a given threshold has been exceeded, and the trigger function transports nothing until a trigger value has been exceeded (at which point all accumulated material in the state of the cell is discharged to its downstream neighbour(s)).

The following operations are supported:

* ACCUFLUX: The accuflux function computes the new state of the attributes for the cell as the sum of the input cell values plus the cumulative sum of all upstream elements draining through the cell.

* ACCUCAPACITYFLUX / STATE: The operation modifies the accumulation of flow over the network by a limiting transport capacity given in absolute values.

* ACCUFRACTIONFLUX / STATE: The operation limits the flow over the network by a parameter which controls the proportion (0-1) of the material that can flow through each cell.

* ACCUTHRESHOLDFLUX / STATE: The operation modifies the accummulation of flow over the network by limiting transport to values greater than a minimum threshold value per cell. No flow occurs if the threshold is not exceeded.

* ACCUTRIGGERFLUX / STATE: The operation only allows transport (flux) to occur if a trigger value is exceeded, otherwise no transport occurs and storage accumulates.


References


Parameters

 NameTypeIdentifierDescriptionConstraints
InputSurfaceGrid, inputSURFACESurface used to derive the LDD network, e.g. a DTM.-
InputGrid, inputINPUTGrid with the input values to accumulate.-
State t (*)Grid, input, optionalSTATE_INGrid describing the state of each cell at timestep t.-
Operation Control (*)Grid, input, optionalCONTROLDepending on mode of operation either transport capacity, transport fraction, threshold value or trigger value.-
Linear Flow Control Grid (*)Grid, input, optionalCTRL_LINEARThe values of this grid are checked against the linear flow threshold to decide on the flow-routing algorithm.-
OutputFluxGrid, outputFLUXFlux out of each cell, i.e. everything accumulated so far.-
State t + 1 (*)Grid, output, optionalSTATE_OUTGrid describing the state of each cell at timestep t + 1.-
OptionsGrid SystemGrid systemPARAMETERS_GRID_SYSTEM--
OperationChoiceOPERATIONSelect a mode of operationAvailable Choices:
[0] accuflux
[1] accucapacityflux / state
[2] accufractionflux / state
[3] accuthresholdflux / state
[4] accutriggerflux / state
Default: 0
Switch to Linear FlowBooleanLINEARSwitch from MFD8 to D8 if linear flow threshold is crossed.Default: 1
Threshold Linear FlowFloating pointTHRES_LINEARThreshold for linear flow, if exceeded D8 is used.Default: 0.000000
(*) optional

Command-line

Usage: saga_cmd grid_analysis 18 [-SURFACE <str>] [-INPUT <str>] [-STATE_IN <str>] [-CONTROL <str>] [-CTRL_LINEAR <str>] [-FLUX <str>] [-STATE_OUT <str>] [-OPERATION <str>] [-LINEAR <str>] [-THRES_LINEAR <double>]
  -SURFACE:<str>        	Surface
	Grid, input
  -INPUT:<str>          	Input
	Grid, input
  -STATE_IN:<str>       	State t
	Grid, input, optional
  -CONTROL:<str>        	Operation Control
	Grid, input, optional
  -CTRL_LINEAR:<str>    	Linear Flow Control Grid
	Grid, input, optional
  -FLUX:<str>           	Flux
	Grid, output
  -STATE_OUT:<str>      	State t + 1
	Grid, output, optional
  -OPERATION:<str>      	Operation
	Choice
	Available Choices:
	[0] accuflux
	[1] accucapacityflux / state
	[2] accufractionflux / state
	[3] accuthresholdflux / state
	[4] accutriggerflux / state
	Default: 0
  -LINEAR:<str>         	Switch to Linear Flow
	Boolean
	Default: 1
  -THRES_LINEAR:<double>	Threshold Linear Flow
	Floating point
	Default: 0.000000