grass_r_gwflow: QGIS algorithm - r.gwflow

In JanCaha/r_package_qgis: An extension of package "qgisprocess" providing direct R functions for QGIS functions

QGIS algorithm - r.gwflow

Description

QGIS Algorithm provided by GRASS r.gwflow (grass:r.gwflow). Numerical calculation program for transient, confined and unconfined groundwater flow in two dimensions.

Usage

grass_r_gwflow(
  phead = qgisprocess:::qgis_default_value(),
  status = qgisprocess:::qgis_default_value(),
  hc_x = qgisprocess:::qgis_default_value(),
  hc_y = qgisprocess:::qgis_default_value(),
  q = qgisprocess:::qgis_default_value(),
  s = qgisprocess:::qgis_default_value(),
  recharge = qgisprocess:::qgis_default_value(),
  top = qgisprocess:::qgis_default_value(),
  bottom = qgisprocess:::qgis_default_value(),
  type = qgisprocess:::qgis_default_value(),
  river_bed = qgisprocess:::qgis_default_value(),
  river_head = qgisprocess:::qgis_default_value(),
  river_leak = qgisprocess:::qgis_default_value(),
  drain_bed = qgisprocess:::qgis_default_value(),
  drain_leak = qgisprocess:::qgis_default_value(),
  dtime = qgisprocess:::qgis_default_value(),
  maxit = qgisprocess:::qgis_default_value(),
  error = qgisprocess:::qgis_default_value(),
  solver = qgisprocess:::qgis_default_value(),
  relax = qgisprocess:::qgis_default_value(),
  .f = qgisprocess:::qgis_default_value(),
  output = qgisprocess:::qgis_default_value(),
  vx = qgisprocess:::qgis_default_value(),
  vy = qgisprocess:::qgis_default_value(),
  budget = qgisprocess:::qgis_default_value(),
  GRASS_REGION_PARAMETER = qgisprocess:::qgis_default_value(),
  GRASS_REGION_CELLSIZE_PARAMETER = qgisprocess:::qgis_default_value(),
  GRASS_RASTER_FORMAT_OPT = qgisprocess:::qgis_default_value(),
  GRASS_RASTER_FORMAT_META = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

phead	raster - The initial piezometric head in (m). Path to a raster layer.
status	raster - Boundary condition status, 0-inactive, 1-active, 2-dirichlet. Path to a raster layer.
hc_x	raster - X-part of the hydraulic conductivity tensor in (m/s). Path to a raster layer.
hc_y	raster - Y-part of the hydraulic conductivity tensor in (m/s). Path to a raster layer.
q	raster - Water sources and sinks in (m^3/s). Path to a raster layer.
s	raster - Specific yield in (1/m). Path to a raster layer.
recharge	raster - Recharge map e.g: 610^-9 per cell in (m^3/sm^2). Path to a raster layer.
top	raster - Top surface of the aquifer in (m). Path to a raster layer.
bottom	raster - Bottom surface of the aquifer in (m). Path to a raster layer.
type	enum of ⁠("confined", "unconfined")⁠ - The type of groundwater flow. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
river_bed	raster - The height of the river bed in (m). Path to a raster layer.
river_head	raster - Water level (head) of the river with leakage connection in (m). Path to a raster layer.
river_leak	raster - The leakage coefficient of the river bed in (1/s). Path to a raster layer.
drain_bed	raster - The height of the drainage bed in (m). Path to a raster layer.
drain_leak	raster - The leakage coefficient of the drainage bed in (1/s). Path to a raster layer.
dtime	number - The calculation time in seconds. A numeric value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.
maxit	number - Maximum number of iteration used to solver the linear equation system. A numeric value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.
error	number - Error break criteria for iterative solvers (jacobi, sor, cg or bicgstab). A numeric value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.
solver	enum of ⁠("cg", "pcg", "cholesky")⁠ - The type of solver which should solve the symmetric linear equation system. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
relax	string - The relaxation parameter used by the jacobi and sor solver for speedup or stabilizing. String value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.
.f	boolean - Allocate a full quadratic linear equation system, default is a sparse linear equation system. 1 for true/yes. 0 for false/no. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression. Original algorithm parameter name: -f.
output	rasterDestination - Groundwater flow. Path for new raster layer.
vx	rasterDestination - Groundwater filter velocity vector part in x direction (m/s). Path for new raster layer.
vy	rasterDestination - Groundwater filter velocity vector part in y direction (m/s). Path for new raster layer.
budget	rasterDestination - Groundwater budget for each cell (m^3/s). Path for new raster layer.
GRASS_REGION_PARAMETER	extent - GRASS GIS region extent. A comma delimited string of x min, x max, y min, y max. E.g. '4,10,101,105'. Path to a layer. The extent of the layer is used..
GRASS_REGION_CELLSIZE_PARAMETER	number - GRASS GIS region cellsize (leave 0 for default). A numeric value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.
GRASS_RASTER_FORMAT_OPT	string - Output Rasters format options (createopt). String value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.
GRASS_RASTER_FORMAT_META	string - Output Rasters format metadata options (metaopt). String value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.
...	further parameters passed to qgisprocess::qgis_run_algorithm()
.complete_output	logical specifying if complete out of qgisprocess::qgis_run_algorithm() should be used (TRUE) or first output (most likely the main) should read (FALSE). Default value is TRUE.
.quiet	logical specifying if parameter .quiet for qgisprocess::qgis_run_algorithm() Default value is TRUE.
.messages	logical specifying if messages from qgisprocess::qgis_run_algorithm() should be printed (TRUE) or not (FALSE). Default value is FALSE.

Details

Outputs description

• budget - outputRaster - Groundwater budget for each cell (m^3/s)

• output - outputRaster - Groundwater flow

• vx - outputRaster - Groundwater filter velocity vector part in x direction (m/s)

• vy - outputRaster - Groundwater filter velocity vector part in y direction (m/s)

JanCaha/r_package_qgis documentation built on Nov. 3, 2024, 5:25 p.m.