Skip to content

Commit 7b30b3a

Browse files
committed
A couple more fixes to the docs
1 parent a142e58 commit 7b30b3a

1 file changed

Lines changed: 12 additions & 2 deletions

File tree

src/rompy_xbeach/components/physics/friction.py

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,11 @@ class BedFriction(FrictionModifiers):
150150

151151
bedfriccoef: Optional[float] = Field(
152152
default=None,
153-
description="Bed friction coefficient (XBeach default: 0.01)",
153+
description=(
154+
"Bed friction coefficient. The default value depends on the formulation: "
155+
"chezy=55 m^(1/2)/s, cf=0.003 (-), manning=0.02 s/m^(1/3), "
156+
"white-colebrook=0.01 m."
157+
),
154158
ge=0.0,
155159
)
156160
bedfricfile: Optional[XBeachDataBlob] = Field(
@@ -194,7 +198,8 @@ class Cf(BedFriction):
194198
"""Dimensionless friction coefficient formulation.
195199
196200
Uses a constant dimensionless friction coefficient (c_f) to calculate
197-
bed shear stress.
201+
bed shear stress. XBeach default bedfriccoef: 0.003 (range: 0.001-0.1).
202+
198203
"""
199204

200205
model_type: Literal["cf"] = Field(
@@ -208,6 +213,7 @@ class Chezy(BedFriction):
208213
209214
Uses the Chezy coefficient (C) to calculate bed shear stress.
210215
A typical Chezy value is in the order of 55 m^(1/2)/s.
216+
XBeach default bedfriccoef: 55 m^(1/2)/s (range: 20-100).
211217
"""
212218

213219
model_type: Literal["chezy"] = Field(
@@ -222,6 +228,9 @@ class Manning(BedFriction):
222228
Uses the Manning coefficient (n) to calculate bed shear stress.
223229
Manning can be seen as a depth-dependent Chezy value.
224230
A typical Manning value is in the order of 0.02 s/m^(1/3).
231+
XBeach default bedfriccoef: 0.02 s/m^(1/3) (range: 0.01-0.05).
232+
233+
This is the **default XBeach bed friction formulation**.
225234
"""
226235

227236
model_type: Literal["manning"] = Field(
@@ -253,6 +262,7 @@ class WhiteColebrook(BedFriction):
253262
Uses the geometrical roughness of Nikuradse (k_s) to calculate bed shear stress.
254263
The White-Colebrook formulation has a log relation with the water depth.
255264
A typical k_s value is in the order of 0.01 - 0.15 m.
265+
XBeach default bedfriccoef: 0.01 m (range: 3.5e-5-0.9).
256266
"""
257267

258268
model_type: Literal["white-colebrook"] = Field(

0 commit comments

Comments
 (0)