Skip to content

r.sim.water: Document flow_control as trapping probability #7971

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wenzeslaus merged 1 commit into from
Sep 29, 2026
Merged

r.sim.water: Document flow_control as trapping probability #7971

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion raster/r.sim/r.sim.water/main.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ int main(int argc, char *argv[])
parm.traps->key = "flow_control";
parm.traps->required = NO;
parm.traps->description =
_("Name of flow controls raster map (permeability ratio 0-1)");
_("Name of flow controls raster map (trapping probability 0-1)");
parm.traps->guisection = _("Input");

parm.observation = G_define_standard_option(G_OPT_V_INPUT);
Expand Down
9 changes: 5 additions & 4 deletions raster/r.sim/r.sim.water/r.sim.water.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,10 +66,11 @@ <h2>DESCRIPTION</h2>
<b>infil</b> or a single value <b>infil_value</b> 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 controlled 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 <b>flow_control</b> that defines the probability of particles to pass
through the structure (the values will be 0-1).
Overland flow can be further controlled by permeable check dams or similar types of structures.
The user can provide a map of these structures as <b>flow_control</b> with values 0-1
that give the probability of a particle being trapped by the structure at each time step.
A trapped particle is moved slightly back instead of forward, so a higher value means lower
permeability, holding back more water and increasing the flow depth at the structure.

<p>
Output includes a water depth raster map <b>depth</b> in [m], and a water discharge
Expand Down
10 changes: 6 additions & 4 deletions raster/r.sim/r.sim.water/r.sim.water.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,10 +58,12 @@ overland flow infiltration rate map **infil** or a single value
**infil_value** 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 controlled 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 **flow_control** that
defines the probability of particles to pass through the structure (the
values will be 0-1).
dams or similar types of structures. The user can provide a map of
these structures as **flow_control** with values 0-1 that give the
probability of a particle being trapped by the structure at each time
step. A trapped particle is moved slightly back instead of forward, so
a higher value means lower permeability, holding back more water and
increasing the flow depth at the structure.

Output includes a water depth raster map **depth** in \[m\], and a water
discharge raster map **discharge** in \[m3/s\]. The **error** raster map
Expand Down
Loading