Skip to content

feat: diameter of the VIV model apart from the hydrodynamic one (VIV DIAMETER section) - #156

Merged
SMI-Lab-Inha merged 1 commit into
devfrom
feat/viv-diameter
Nov 13, 2026
Merged

SMI-Lab-Inha merged 1 commit into
devfrom
feat/viv-diameter

Conversation

@SMI-Lab-Inha

Copy link
Copy Markdown
Owner

Summary

Adds a diameter of the VIV model apart from the hydrodynamic one. A new optional VIV DIAMETER section gives a line type's VIV model its own diameter Dviv:

--------------------- VIV DIAMETER -------------------------------------
TypeName   Dviv
(-)        (m)
cable_bm   0.90

The motivating case is a lazy-wave cable. Its buoyancy modules are ATTACHMENTS rows on the bare cable, so their mass, volume and drag are point loads, and the line type keeps the cable's own diameter for drag, added mass and buoyancy. Until now its VIV took that diameter too, while the shedding of a module zone is set by the larger module diameter.

What takes which diameter

Takes Dviv Keeps Diam
Shedding frequency and synchronisation band (or the wake frequency and its coupling A/D) Morison drag
Lift, in-line and higher-harmonic force scales Added mass
Amplitude ratio A/D of a VIV AMPLITUDE table Buoyancy, contact

One row per type, Dviv > 0, and the type needs VIV (Cl > 0 or a WAKE OSCILLATOR row). A deck without the section runs as before.

The docs describe how to model a module zone: a section with a copy of the cable's type, Dviv the module diameter and its own coefficients. They also say plainly that the shedding of alternating modules and bare cable has no established model.

Implementation

  • EI = 0 lines: the diameter CD_Set_Model_VIV already takes; the driver passes Dviv in place of the hydrodynamic diameter.
  • Finite-EI cables: Set_VIV takes dviv (per element, 0 = the drag diameter). viv_diam(model, e) feeds viv_drag_terms and the amplitude-table helpers. A later Set_Drag recomputes the scales, so a 0 entry follows the new drag diameter. Rollback on a failed Set_VIV restores the previous diameters.
  • Python: the deck reader mirrors the native checks; the builder writes the row (LineType.viv_diameter).

Verification

tests/test_viv_diameter_deck.f90, on the taut gate line as an EI = 0 line and as a finite-EI cable:

Check Result
Dviv = Diam Identical to the deck without the section, bit for bit
Synchronisation lift, Dviv = Diam Locks in at 0.287 Hz
Synchronisation lift, Dviv 0.2 m Band (0.075–0.195 Hz) below the mode; the phase runs at its top, 0.196 Hz
Uncoupled wake oscillator, Dviv 0.2 m Drives the cable at 0.149 Hz against $\mathrm{St}\,U/D_{viv}$ = 0.15 Hz
Refusals 6

Python: rows read, kept and refused as natively, the builder writes them, and six native/Python parity decks agree.

Run before opening:

  • full ctest under the default and OPENBLAS_CORETYPE=Prescott kernels;
  • Debug -fcheck=all on the VIV tests;
  • pytest, ruff, mypy, Sphinx -W, pre-commit.

Docs

  • doc/driver_format.md: the section, and how to model a module zone.
  • doc/theory.rst: the VIV diameter subsection.
  • doc/capabilities.rst, CHANGELOG.md.

…DIAMETER section)

A lazy-wave cable's buoyancy modules are ATTACHMENTS rows on the bare
cable: their mass, volume and drag are point loads, and the cable's line
type keeps its own diameter for its drag, added mass and buoyancy. Its
VIV then also took that diameter, while the shedding of a module zone is
set by the larger module diameter.

An optional VIV DIAMETER section row TypeName Dviv gives the VIV model
of a line type a diameter of its own: the shedding frequency and band
(or the wake frequency and its coupling A/D), the lift, in-line and
higher-harmonic forces and the amplitude ratio of a VIV AMPLITUDE table
take Dviv, the drag, added mass, buoyancy and contact keep Diam. A
module zone is a section with a copy of the cable's type, Dviv the
module diameter and its own coefficients; the docs say how, and that the
shedding of alternating modules and bare cable has no established model.
The type needs VIV (Cl > 0 or a WAKE OSCILLATOR row); one row a type.

EI = 0 lines take it through the diameter CD_Set_Model_VIV already
has; finite-EI cables through Set_VIV dviv (per element, 0 = the drag
diameter, kept across a later Set_Drag), which viv_drag_terms and the
amplitude-table helpers read. The Python deck reader mirrors the checks,
the builder writes the row (LineType.viv_diameter).

Checks:
- tests/test_viv_diameter_deck.f90, on the taut gate line as an EI = 0
  line and a finite-EI cable: Dviv = Diam is the deck without the
  section bit for bit; with the synchronisation lift the line locks in
  at 0.287 Hz, and with Dviv 0.2 m its band (0.075-0.195 Hz) lies below
  the mode and the phase runs at its top, 0.196 Hz; an uncoupled wake
  oscillator drives the cable at 0.149 Hz against St U/Dviv = 0.15 Hz;
  six refusals;
- Python: rows read, kept and refused as natively, the builder writes
  them, six native/Python parity decks agree.
Full ctest under both BLAS kernels, Debug -fcheck=all on the VIV tests,
pytest, ruff, mypy, Sphinx -W, pre-commit.

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 13, 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-13T09:05:54.711735Z 133c1d9 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 #35863021 | 📁 Comparing 133c1d9 against latest (789cb6d)

  🔍 Preview build  

13 files changed · ± 13 modified

± Modified

@chatgpt-codex-connector

Copy link
Copy Markdown

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

Reviewed commit: 133c1d9e02

ℹ️ 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 025cbad into dev Nov 13, 2026
22 checks passed
@SMI-Lab-Inha
SMI-Lab-Inha deleted the feat/viv-diameter branch November 13, 2026 11:56
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