Skip to content

Commit 497d1a3

Browse files
CopilotSierd
andcommitted
Address code review feedback for avalanching documentation
Co-authored-by: Sierd <[email protected]>
1 parent 2073c8d commit 497d1a3

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

docs/user/implementation.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -816,6 +816,9 @@ updated to ensure consistency with the new bed level:
816816
\text{SWL}_{i,j} & \text{otherwise}
817817
\end{cases}
818818
819+
where :math:`\text{SWL}` [m] is the still water level above the reference
820+
datum (see :ref:`model` for details on water level definitions).
821+
819822

820823
Basic Model Interface (BMI)
821824
---------------------------

docs/user/model.rst

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -777,8 +777,9 @@ material can be piled without slumping. Two critical angles are defined:
777777
Typical values for dry sand are :math:`\theta_{\mathrm{stat}} = 34°` and
778778
:math:`\theta_{\mathrm{dyn}} = 33°`. These values can potentially vary
779779
spatially depending on factors such as moisture content and vegetation
780-
roots, though this functionality is not yet fully implemented in the
781-
current version.
780+
roots. In the current implementation, the angle of repose is set as a
781+
constant parameter; future development may include spatial variation
782+
based on local bed surface properties.
782783

783784
The critical slope is computed from the angle of repose:
784785

@@ -900,3 +901,9 @@ parameters:
900901
- ``max_iter_ava``: Maximum number of iterations for the avalanching loop
901902
(default: ``1000``)
902903

904+
.. note::
905+
906+
The relaxation factor :math:`E` (default value 0.1), which controls the
907+
rate of bed adjustment per iteration, is currently set internally in
908+
the code and is not configurable through the model configuration file.
909+

0 commit comments

Comments
 (0)