Frank14f/CelerisLab
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: moving-circle docstrings — tables-attached guard, vx/vy meaning, center keyword

Browse Source 
Docstring and documentation wording only; no code change.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
Claude
2026-10-30 16:33:12 +00:00
co-authored by Claude Opus 5.5
parent 48ee0982c9
commit 7886906517
2 changed files with 9 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/moving_bodies.md
+1 -1
View File
@@ -14,7 +14,7 @@ cells (M1 `MovingCircleCells`), moving-wall Bouzidi with wall velocity
`u + omega x r`, and separate per-body diagnostics. `u + omega x r`, and separate per-body diagnostics.
*API.* *API.*
- `Simulation.add_body("circle", centre, radius, - `Simulation.add_body("circle", center=(x, y), radius=r,
translation=Translation(offset_box, max_speed))` before `initialize()`; translation=Translation(offset_box, max_speed))` before `initialize()`;
`offset_box = (x_min, x_max, y_min, y_max)` in lattice cells around the `offset_box = (x_min, x_max, y_min, y_max)` in lattice cells around the
base centre (must contain 0), `0 < max_speed ≤ .5`. base centre (must contain 0), `0 < max_speed ≤ .5`.
src/CelerisLab/simulation.py
+8 -4
View File
@@ -122,8 +122,9 @@ class Simulation:
D2Q9/FP32/unshifted/DB only; set before initialization or stage D2Q9/FP32/unshifted/DB only; set before initialization or stage
a new body. No runtime motion or amplitude setter. a new body. No runtime motion or amplitude setter.
translation: ``body.motion.Translation`` declaring a translating translation: ``body.motion.Translation`` declaring a translating
circle (before initialize only; docs/moving_bodies.md). Until circle (before initialize only; docs/moving_bodies.md).
the moving kernels exist, positive-step runs are rejected. Positive-step runs are rejected until ``initialize()`` has
attached its moving tables.
**kwargs: passed to the geometry constructor. **kwargs: passed to the geometry constructor.
Returns: Returns:
@@ -360,8 +361,11 @@ class Simulation:
Args: Args:
id: body_id from add_body(). id: body_id from add_body().
omega: rotation speed (lattice units). ``None`` = no change. omega: rotation speed (lattice units). ``None`` = no change.
vx: translation velocity x (future). ``None`` = no change. vx: translation velocity x. For a translating circle: the
vy: translation velocity y (future). ``None`` = no change. interval wall velocity of the target, only together with
``offset``; otherwise stored in the body state (not applied
to stationary walls). ``None`` = no change.
vy: translation velocity y; same rules as ``vx``.
offset: target centre offset of a translating circle; with vx/vy offset: target centre offset of a translating circle; with vx/vy
(default 0) it replaces the pending target after validation (default 0) it replaces the pending target after validation
against the applied offset (docs/moving_bodies.md, 4a). Only against the applied offset (docs/moving_bodies.md, 4a). Only