Skip to content

docs(examples): decks and end-to-end tests for VIV, axial damping, MoorDyn-C files, shared cables and more - #141

Merged
SMI-Lab-Inha merged 3 commits into
devfrom
feat/examples-042
Nov 9, 2026
Merged

SMI-Lab-Inha merged 3 commits into
devfrom
feat/examples-042

Conversation

@SMI-Lab-Inha

Copy link
Copy Markdown
Owner

This PR adds examples and end-to-end tests for features that had none. There are no solver changes.

Examples

Ten decks. Each has a header in the house style, is listed in doc/examples.rst and examples/README.md, and runs as an example_* CTest (0.04–2.3 s in Release).

Deck Shows
viv_taut_line_crossflow cross-flow VIV lock-in; mid-span A/D 0.659 against MoorDyn-F's 0.662
composite_axial_damping_mode1 axialDampingRatio mode1 on a chain–polyester–chain line
moordynC_currents/chain_wavekin3_currents2 MoorDyn-C WaveKin 3 with Currents 2
moordynC_currents/chain_currents5_grid MoorDyn-C Currents 5 (with a generator for the files)
composite_ve_syrope_jonswap viscoelastic and Syrope legs on one RAO-driven floater in a JONSWAP sea
shared_cable_two_floaters a cable clamped at two moving floaters
lazy_wave_modules_stiffener buoyancy modules, a bend stiffener, vessel motion, current, friction and a range graph
chain_sloped_bathymetry_friction a seabed grid with friction
torsion_free_end_armoured_cable `GJ
composite_chain_poly_chain_modes modes of a composite line

Coverage gaps closed

  • Ten shipped decks that CTest never ran: composite_chain_wire, nylon_taut_mooring, semitaut_chain_polyester, spread_4line_chain, taut_chain_steep, ve_nylon_loaddependent_mooring, wd0050_chain, wire_catenary_mooring, rigid6_buoy and rod_moored_spar are now example_* tests.
  • The moordynC_* folders were skipped by the fallback scan, the examples catalogue test and the Python deck-validator parity test. All three now cover them, and the scanner's self-test checks that each deck is collected exactly once.

End-to-end tests (numpy only)

  • wave_input_equivalence: one sea written three ways: deck airy/wavetrain rows, a WaveKin 7 table and a WaveKin 3 record. Cases: a regular wave, two components, and a wave at 30° to the line. Tensions and node motion agree to the output digits. The gate is shown to work: a quarter-period phase error moves the tension by 79 % of its range, a wrong heading by 19 %.
  • composite_string_modes: nModes frequencies of a two-section taut line against the roots of the two-section string's frequency equation, added mass included. The error is second order with the mesh (1.05e-3 → 2.6e-4), and a uniform-line control gives kL = nπ.
  • stiffener_section_equivalence: a cylindrical STIFFENERS sleeve against an explicit SECTIONS row built from the manual's closed forms, in statics and in an 18 s heave march (7.5e-8). Checks:
    • BendMom + StfMom equals the section moment;
    • the cable's share is EI_c/EI of it;
    • a clamped root moment is within 0.6 % of a√(EI·T).

Tests

  • Full Release CTest: 395/395 on the default and Prescott kernels.
  • Python: pytest 2911 passed; ruff is clean.
  • Docs: Sphinx -W is clean.
  • Debug: every new test runs in at most 23 s.
  • Fallback scan: clean on all 65 decks.

The CHANGELOG entries go into the batch CHANGELOG PR.

… cables and more

New example decks, each documented in its header, catalogued in doc/examples.rst and run to
completion by an example_* CTest:

- viv_taut_line_crossflow: cross-flow VIV lock-in of a taut line (Cl dF cF, VIVphaseSeed,
  VIVrmsWindow, the V lift file); mid-span A/D 0.66, as MoorDyn-F on this line.
- composite_axial_damping_mode1: axialDampingRatio mode1 on a chain-polyester-chain line in an
  Airy wave.
- moordynC_currents/chain_wavekin3_currents2 and chain_currents5_grid: MoorDyn-C WaveKin 3
  (wave_elevation.txt), Currents 2 and Currents 5 files, with the script that writes them.
- composite_ve_syrope_jonswap: viscoelastic and Syrope composite legs of one floater moved by
  an RAO table in a JONSWAP sea.
- shared_cable_two_floaters: a finite-EI cable between two moving, clamped hang-offs.
- lazy_wave_modules_stiffener: discrete buoyancy modules and a bend stiffener on a vessel in a
  current, with the finite-EI range graph.
- chain_sloped_bathymetry_friction: a bathymetryFile seabed sloping along and across the line,
  with as-laid static friction.
- torsion_free_end_armoured_cable: torque-tension coupling and torsional damping (GJ|K|Bt) on a
  line restrained in torsion at one end only.
- composite_chain_poly_chain_modes: the modes of a three-section composite line.

The example fallback scan, the catalogue check and the Python deck-validator parity test now
take the decks of the moordynC_* folders too, and the ten shipped decks no test ran by name run
as example_* CTests.

Signed-off-by: Jae Hoon Seo <jaehoon.seo@inha.ac.kr>
… bend stiffeners

- wave_input_equivalence: one linear sea written as deck wave rows, as a MoorDyn-C WaveKin 7
  table and as a WaveKin 3 elevation record (a regular wave, two components, and a wave at
  30 deg to the line) gives the same line response to the output digits; a wave a quarter
  period out of phase and a wrong heading part by 79 % and 19 % of a tension range.
- composite_string_modes: the nModes frequencies of a two-section taut line are the roots of
  the closed-form frequency equation of the two-section string, each twice, within 2.6e-4 on
  0.25 m elements and converging at second order; the uniform line meets k L = n pi.
- stiffener_section_equivalence: a cylindrical STIFFENERS sleeve and the equivalent SECTIONS
  row of cable and sleeve give the same statics and dynamics, the root moment splits into the
  cable's and the sleeve's shares by EI, and a bare cable clamped 5 deg off its tangent carries
  the root moment a sqrt(EI T) within 0.6 %.

Signed-off-by: Jae Hoon Seo <jaehoon.seo@inha.ac.kr>
The [Unreleased] entries of the open changes are added together in one
change, so that they do not conflict with each other.

Signed-off-by: Jae Hoon Seo <jaehoon.seo@inha.ac.kr>
@SMI-Lab-Inha

Copy link
Copy Markdown
Owner Author

@codex review

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 8, 2026 •

Copy link
Copy Markdown
Codex Review Summary: ✅ Completed

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-08T22:52:51.626303Z ffe2800 Manual request
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 CableDyn | 🛠️ Build #35740883 | 📁 Comparing ffe2800 against latest (e8f88f5)

  🔍 Preview build  

11 files changed · ± 11 modified

± Modified

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. 🚀

Reviewed commit: ffe280022f

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@SMI-Lab-Inha
SMI-Lab-Inha merged commit d9165ba into dev Nov 9, 2026
22 checks passed
@SMI-Lab-Inha
SMI-Lab-Inha deleted the feat/examples-042 branch November 9, 2026 08:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant