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

Docstring and documentation wording only; no code change. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-30 16:33:12 +00:00
parent 48ee0982c9
commit 7886906517
2 changed files with 9 additions and 5 deletions
@@ -14,7 +14,7 @@ cells (M1 `MovingCircleCells`), moving-wall Bouzidi with wall velocity
 `u + omega x r`, and separate per-body diagnostics.

 *API.*
- `Simulation.add_body("circle", centre, radius,
+- `Simulation.add_body("circle", center=(x, y), radius=r,
  translation=Translation(offset_box, max_speed))` before `initialize()`;
  `offset_box = (x_min, x_max, y_min, y_max)` in lattice cells around the
  base centre (must contain 0), `0 < max_speed ≤ .5`.