[GRASS-SVN] r63282 - in grass/branches/releasebranch_7_0: lib/gis raster/r.sim/r.sim.sediment raster/r.sim/r.sim.water
svn_grass at osgeo.org
svn_grass at osgeo.org
Fri Nov 28 19:20:03 PST 2014
Author: annakrat
Date: 2014-11-28 19:20:03 -0800 (Fri, 28 Nov 2014)
New Revision: 63282
Modified:
grass/branches/releasebranch_7_0/lib/gis/renamed_options
grass/branches/releasebranch_7_0/raster/r.sim/r.sim.sediment/main.c
grass/branches/releasebranch_7_0/raster/r.sim/r.sim.sediment/r.sim.sediment.html
grass/branches/releasebranch_7_0/raster/r.sim/r.sim.water/main.c
grass/branches/releasebranch_7_0/raster/r.sim/r.sim.water/r.sim.water.html
Log:
r.sim: change option names (merge from trunk, r63281)
Modified: grass/branches/releasebranch_7_0/lib/gis/renamed_options
===================================================================
--- grass/branches/releasebranch_7_0/lib/gis/renamed_options 2014-11-29 03:18:27 UTC (rev 63281)
+++ grass/branches/releasebranch_7_0/lib/gis/renamed_options 2014-11-29 03:20:03 UTC (rev 63282)
@@ -226,11 +226,21 @@
r.sim.sediment|elevin:elevation
r.sim.sediment|dxin:dx
r.sim.sediment|dyin:dy
-r.sim.sediment|detin:det
-r.sim.sediment|tranin:tran
-r.sim.sediment|tauin:tau
+r.sim.sediment|wdepth:water_depth
+r.sim.sediment|detin:detachment_coeff
+r.sim.sediment|tranin:transport_coeff
+r.sim.sediment|tauin:shear_stress
r.sim.sediment|manin:man
r.sim.sediment|maninval:man_value
+r.sim.sediment|outwalk:walkers_output
+r.sim.sediment|tc:sedflow_capacity
+r.sim.sediment|et:tlimit_erosion_deposition
+r.sim.sediment|conc:concentration
+r.sim.sediment|erdep:erosion_deposition
+r.sim.sediment|nwalk:nwalkers
+r.sim.sediment|niter:niterations
+r.sim.sediment|outiter:output_step
+r.sim.sediment|diffc:diffusion_coeff
# r.sim.water
r.sim.water|elevin:elevation
r.sim.water|dxin:dx
@@ -240,6 +250,14 @@
r.sim.water|infil_val:infil_value
r.sim.water|manin:man
r.sim.water|manin_val:man_value
+r.sim.water|traps:flow_control
+r.sim.water|disch:discharge
+r.sim.water|err:error
+r.sim.water|outwalk:walkers_output
+r.sim.water|nwalk:nwalkers
+r.sim.water|niter:niterations
+r.sim.water|outiter:output_step
+r.sim.water|diffc:diffusion_coeff
# r.sun
r.sun|elevin:elevation
r.sun|aspin:aspect
Modified: grass/branches/releasebranch_7_0/raster/r.sim/r.sim.sediment/main.c
===================================================================
--- grass/branches/releasebranch_7_0/raster/r.sim/r.sim.sediment/main.c 2014-11-29 03:18:27 UTC (rev 63281)
+++ grass/branches/releasebranch_7_0/raster/r.sim/r.sim.sediment/main.c 2014-11-29 03:20:03 UTC (rev 63282)
@@ -119,7 +119,7 @@
parm.elevin = G_define_standard_option(G_OPT_R_ELEV);
parm.wdepth = G_define_standard_option(G_OPT_R_INPUT);
- parm.wdepth->key = "wdepth";
+ parm.wdepth->key = "water_depth";
parm.wdepth->description = _("Name of water depth raster map [m]");
parm.dxin = G_define_standard_option(G_OPT_R_INPUT);
@@ -131,17 +131,17 @@
parm.dyin->description = _("Name of y-derivatives raster map [m/m]");
parm.detin = G_define_standard_option(G_OPT_R_INPUT);
- parm.detin->key = "det";
+ parm.detin->key = "detachment_coeff";
parm.detin->description =
_("Name of detachment capacity coefficient raster map [s/m]");
parm.tranin = G_define_standard_option(G_OPT_R_INPUT);
- parm.tranin->key = "tran";
+ parm.tranin->key = "transport_coeff";
parm.tranin->description =
_("Name of transport capacity coefficient raster map [s]");
parm.tauin = G_define_standard_option(G_OPT_R_INPUT);
- parm.tauin->key = "tau";
+ parm.tauin->key = "shear_stress";
parm.tauin->description =
_("Name of critical shear stress raster map [Pa]");
@@ -160,7 +160,7 @@
parm.maninval->guisection = _("Input");
parm.outwalk = G_define_standard_option(G_OPT_V_OUTPUT);
- parm.outwalk->key = "outwalk";
+ parm.outwalk->key = "walkers_output";
parm.outwalk->required = NO;
parm.outwalk->description =
_("Base name of the output walkers vector points map");
@@ -181,20 +181,20 @@
parm.logfile->guisection = _("Output");
parm.tc = G_define_standard_option(G_OPT_R_OUTPUT);
- parm.tc->key = "tc";
+ parm.tc->key = "sedflow_capacity";
parm.tc->required = NO;
parm.tc->description = _("Name for output transport capacity raster map [kg/ms]");
parm.tc->guisection = _("Output");
parm.et = G_define_standard_option(G_OPT_R_OUTPUT);
- parm.et->key = "et";
+ parm.et->key = "tlimit_erosion_deposition";
parm.et->required = NO;
parm.et->description =
_("Name for output transport limited erosion-deposition raster map [kg/m2s]");
parm.et->guisection = _("Output");
parm.conc = G_define_standard_option(G_OPT_R_OUTPUT);
- parm.conc->key = "conc";
+ parm.conc->key = "concentration";
parm.conc->required = NO;
parm.conc->description =
_("Name for output sediment concentration raster map [particle/m3]");
@@ -207,21 +207,21 @@
parm.flux->guisection = _("Output");
parm.erdep = G_define_standard_option(G_OPT_R_OUTPUT);
- parm.erdep->key = "erdep";
+ parm.erdep->key = "erosion_deposition";
parm.erdep->required = NO;
parm.erdep->description =
_("Name for output erosion-deposition raster map [kg/m2s]");
parm.erdep->guisection = _("Output");
parm.nwalk = G_define_option();
- parm.nwalk->key = "nwalk";
+ parm.nwalk->key = "nwalkers";
parm.nwalk->type = TYPE_INTEGER;
parm.nwalk->required = NO;
parm.nwalk->description = _("Number of walkers");
parm.nwalk->guisection = _("Parameters");
parm.niter = G_define_option();
- parm.niter->key = "niter";
+ parm.niter->key = "niterations";
parm.niter->type = TYPE_INTEGER;
parm.niter->answer = NITER;
parm.niter->required = NO;
@@ -229,7 +229,7 @@
parm.niter->guisection = _("Parameters");
parm.outiter = G_define_option();
- parm.outiter->key = "outiter";
+ parm.outiter->key = "output_step";
parm.outiter->type = TYPE_INTEGER;
parm.outiter->answer = ITEROUT;
parm.outiter->required = NO;
@@ -248,7 +248,7 @@
*/
parm.diffc = G_define_option();
- parm.diffc->key = "diffc";
+ parm.diffc->key = "diffusion_coeff";
parm.diffc->type = TYPE_DOUBLE;
parm.diffc->answer = DIFFC;
parm.diffc->required = NO;
Modified: grass/branches/releasebranch_7_0/raster/r.sim/r.sim.sediment/r.sim.sediment.html
===================================================================
--- grass/branches/releasebranch_7_0/raster/r.sim/r.sim.sediment/r.sim.sediment.html 2014-11-29 03:18:27 UTC (rev 63281)
+++ grass/branches/releasebranch_7_0/raster/r.sim/r.sim.sediment/r.sim.sediment.html 2014-11-29 03:20:03 UTC (rev 63282)
@@ -9,12 +9,12 @@
function Monte Carlo method, to provide robustness necessary for
spatially variable conditions and high resolutions (Mitas and Mitasova
1998). Key inputs of the model include the following raster maps:
- elevation (<i> elevin</i> [m]), flow gradient given by the first-order partial
-derivatives of elevation field (<i> dxin</i> and <i>dyin</i>),
-overland flow water depth (<i> wdepth</i> [m]), detachment capacity coefficient
-(<i>detin</i> [s/m]), transport capacity coefficient (<i>tranin</i> [s]),
-critical shear stress (<i>tauin</i> [Pa])
-and surface roughness coefficient called Manning's n (<i>manin</i> raster map).
+ elevation (<i>elevation</i> [m]), flow gradient given by the first-order partial
+derivatives of elevation field (<i> dx</i> and <i>dy</i>),
+overland flow water depth (<i>water_depth</i> [m]), detachment capacity coefficient
+(<i>detachment_coeff</i> [s/m]), transport capacity coefficient (<i>transport_coeff</i> [s]),
+critical shear stress (<i>shear_stress</i> [Pa])
+and surface roughness coefficient called Manning's n (<i>man</i> raster map).
Partial derivatives can be computed by <a href="v.surf.rst.html">v.surf.rst</a>
or <a href="r.slope.aspect.html">r.slope.aspect</a>
module. The data are automatically converted from feet to metric
@@ -24,20 +24,20 @@
reference literature (see suggested values in Notes and References). <br>
<p>
-Output includes transport capacity raster map <i>tc</i> in [kg/ms],
+Output includes transport capacity raster map <i>sedflow_capacity</i> in [kg/ms],
transport capacity limited erosion/deposition raster map
-<i>et</i> [kg/m<sup>2</sup>s]i that are output almost immediately and
+<i>tlimit_erosion_deposition</i> [kg/m<sup>2</sup>s]i that are output almost immediately and
can be viewed while the simulation continues. Sediment flow rate raster map
<i>flux</i> [kg/ms], and net erosion/deposition raster map [kg/m<sup>2</sup>s]
can take longer time depending on time step and simulation time.
-Simulation time is controled by <i> niter</i> [minutes] parameter.
+Simulation time is controled by <i>niterations</i> [minutes] parameter.
<!-- Output files can be saved during simulation using <i>outiter</i> parameter
defining simulation time step for writing output files. This option requires
time series flag <i>-t</i>. Files are saved with suffix containing
iteration number (e.g. name.500, name.1000, etc.) representing time in seconds.
-->
If the resulting erosion/deposition map is noisy, higher number of walkers,
-given by <i>nwalk</i> should be used.
+given by <i>nwalkers</i> should be used.
<br>
<h2>NOTES</h2>
Modified: grass/branches/releasebranch_7_0/raster/r.sim/r.sim.water/main.c
===================================================================
--- grass/branches/releasebranch_7_0/raster/r.sim/r.sim.water/main.c 2014-11-29 03:18:27 UTC (rev 63281)
+++ grass/branches/releasebranch_7_0/raster/r.sim/r.sim.water/main.c 2014-11-29 03:20:03 UTC (rev 63282)
@@ -169,7 +169,7 @@
parm.maninval->guisection = _("Input");
parm.traps = G_define_standard_option(G_OPT_R_INPUT);
- parm.traps->key = "traps";
+ parm.traps->key = "flow_control";
parm.traps->required = NO;
parm.traps->description =
_("Name of flow controls raster map (permeability ratio 0-1)");
@@ -196,26 +196,26 @@
parm.depth->guisection = _("Output");
parm.disch = G_define_standard_option(G_OPT_R_OUTPUT);
- parm.disch->key = "disch";
+ parm.disch->key = "discharge";
parm.disch->required = NO;
parm.disch->description = _("Name for output water discharge raster map [m3/s]");
parm.disch->guisection = _("Output");
parm.err = G_define_standard_option(G_OPT_R_OUTPUT);
- parm.err->key = "err";
+ parm.err->key = "error";
parm.err->required = NO;
parm.err->description = _("Name for output simulation error raster map [m]");
parm.err->guisection = _("Output");
parm.outwalk = G_define_standard_option(G_OPT_V_OUTPUT);
- parm.outwalk->key = "outwalk";
+ parm.outwalk->key = "walkers_output";
parm.outwalk->required = NO;
parm.outwalk->description =
_("Base name of the output walkers vector points map");
parm.outwalk->guisection = _("Output options");
parm.nwalk = G_define_option();
- parm.nwalk->key = "nwalk";
+ parm.nwalk->key = "nwalkers";
parm.nwalk->type = TYPE_INTEGER;
parm.nwalk->required = NO;
parm.nwalk->description =
@@ -223,7 +223,7 @@
parm.nwalk->guisection = _("Parameters");
parm.niter = G_define_option();
- parm.niter->key = "niter";
+ parm.niter->key = "niterations";
parm.niter->type = TYPE_INTEGER;
parm.niter->answer = NITER;
parm.niter->required = NO;
@@ -231,7 +231,7 @@
parm.niter->guisection = _("Parameters");
parm.outiter = G_define_option();
- parm.outiter->key = "outiter";
+ parm.outiter->key = "output_step";
parm.outiter->type = TYPE_INTEGER;
parm.outiter->answer = ITEROUT;
parm.outiter->required = NO;
@@ -250,7 +250,7 @@
*/
parm.diffc = G_define_option();
- parm.diffc->key = "diffc";
+ parm.diffc->key = "diffusion_coeff";
parm.diffc->type = TYPE_DOUBLE;
parm.diffc->answer = DIFFC;
parm.diffc->required = NO;
Modified: grass/branches/releasebranch_7_0/raster/r.sim/r.sim.water/r.sim.water.html
===================================================================
--- grass/branches/releasebranch_7_0/raster/r.sim/r.sim.water/r.sim.water.html 2014-11-29 03:18:27 UTC (rev 63281)
+++ grass/branches/releasebranch_7_0/raster/r.sim/r.sim.water/r.sim.water.html 2014-11-29 03:20:03 UTC (rev 63282)
@@ -8,11 +8,11 @@
the modeled quantity. Green's function Monte Carlo method, used to solve the equation,
provides robustness necessary for spatially variable conditions and high
resolutions (Mitas and Mitasova 1998). The key inputs of the model include
-elevation (<i>elevin</i> raster map), flow gradient vector given by
-first-order partial derivatives of elevation field (<i>dxin</i> and <i>dyin</i>
-raster maps), rainfall excess rate (<i>rain</i> raster map or <i>rain_val</i> single
+elevation (<i>elevation</i> raster map), flow gradient vector given by
+first-order partial derivatives of elevation field (<i>dx</i> and <i>dy</i>
+raster maps), rainfall excess rate (<i>rain</i> raster map or <i>rain_value</i> single
value) and a surface roughness coefficient given by Manning's n
-(<i>manin</i> raster map or <i>manin_val</i> single value). Partial
+(<i>man</i> raster map or <i>man_value</i> single value). Partial
derivatives raster maps can be computed along with interpolation of a DEM using
the -d option in <a href="v.surf.rst.html">v.surf.rst</a> module. If elevation raster
map is already provided, partial derivatives can be computed using
@@ -39,19 +39,19 @@
saturated hydraulic conductivity rates based on field measurements or using
reference values which can be found in literature.
Optionally, user can provide an overland flow infiltration rate map
-<i>infil</i> or a single value <i>infil_val</i> in [mm/hr] that control the rate of
+<i>infil</i> or a single value <i>infil_value</i> in [mm/hr] that control the rate of
infiltration for the already flowing water, effectively reducing the flow depth and
discharge.
Overland flow can be further controled by permeable check dams or similar type of structures,
the user can provide a map of these structures and their permeability ratio
-in the map <i>traps</i> that defines the probability of particles to pass
+in the map <i>flow_control</i> that defines the probability of particles to pass
through the structure (the values will be 0-1).
<p>
Output includes a water depth raster map <i>depth</i> in [m], and a water discharge
-raster map <i>disch</i> in [m3/s]. Error of the numerical solution can be analyzed using
-the <i>err</i> raster map (the resulting water depth is an average, and err is its RMSE).
-The output vector points map <i>outwalk</i> can be used to analyze and visualize
+raster map <i>discharge</i> in [m3/s]. Error of the numerical solution can be analyzed using
+the <i>error</i> raster map (the resulting water depth is an average, and err is its RMSE).
+The output vector points map <i>output_walkers</i> can be used to analyze and visualize
spatial distribution of walkers at different simulation times (note that
the resulting water depth is based on the density of these walkers).
<!--Number of the output walkers is controled by the <i>density</i> parameter, which controls
@@ -62,13 +62,13 @@
The spatial distribution of numerical error associated with path sampling solution can be
analysed using the output error raster file [m]. This error is a function of the number
of particles used in the simulation and can be reduced by increasing the number of walkers
-given by parameter <i>nwalk</i>.
+given by parameter <i>nwalkers</i>.
<!--(<font color="#ff0000"> toto treba upresnit/zmenit, lebo nwalk ide prec</font>). -->
-Duration of simulation is controled by the <i>niter</i> parameter. The default value
+Duration of simulation is controled by the <i>niterations</i> parameter. The default value
is 10 minutes, reaching the steady-state may require much longer time,
depending on the time step, complexity of terrain, land cover and size of the area.
Output walker, water depth and discharge maps can be saved during simulation using
-the time series flag <i>-t</i> and <i>outiter</i> parameter
+the time series flag <i>-t</i> and <i>output_step</i> parameter
defining the time step in minutes for writing output files.
Files are saved with a suffix representing time since the start of simulation in minutes
(e.g. wdepth.05, wdepth.10).
@@ -82,7 +82,7 @@
<p>
Overland flow is routed based on partial derivatives of elevation
field or other landscape features influencing water flow. Simulation
-equations include a diffusion term (<i>diffc</i> parameter) which enables
+equations include a diffusion term (<i>diffusion_coeff</i> parameter) which enables
water flow to overcome elevation depressions or obstacles when water depth exceeds
a threshold water depth value (<i>hmax)</i>, given in [m]. When it is reached,
diffusion term increases as given by <i>halpha</i> and advection term
@@ -151,7 +151,7 @@
# simulate
r.sim.water elevation=elevation.10m dx=elev_dx dy=elev_dy \
rain=rain man=manning infil=infilt \
- nwalk=5000000 depth=depth
+ nwalkers=5000000 depth=depth
</pre></div>
<p>
@@ -169,7 +169,7 @@
ERROR: nwalk (7000001) > maxw (7000000)!
</pre></div>
-then a lower <em>nwalk</em> parameter value has to be selected.
+then a lower <em>nwalkers</em> parameter value has to be selected.
<h2>SEE ALSO</h2>
More information about the grass-commit
mailing list