Skip to content

Commit 2522f26

Browse files
authored
[FXC-1921] Added example for roughness height to the Wall docstring (#1674)
1 parent 48a8860 commit 2522f26

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

flow360/component/simulation/models/surface_models.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -317,6 +317,7 @@ class WallRotation(Flow360BaseModel):
317317
class Wall(BoundaryBase):
318318
"""
319319
:class:`Wall` class defines the wall boundary condition based on the inputs.
320+
Refer :ref:`here <wall_formulations>` for formulation details.
320321
321322
Example
322323
-------
@@ -365,6 +366,14 @@ class Wall(BoundaryBase):
365366
... ),
366367
... )
367368
369+
- Define roughness height on entities
370+
with the naming pattern :code:`"fluid/Roughness-*"`:
371+
372+
>>> fl.Wall(
373+
... entities=volume_mesh["fluid/Roughness-*"],
374+
... roughness_height=0.1 * fl.u.mm,
375+
... )
376+
368377
====
369378
"""
370379

0 commit comments

Comments
 (0)