Examples
The examples/ folder ships ready-to-run input decks. It is part of the source archive —
download Source code (zip) from the release page (Installation); the executables do not
contain it. Every standalone deck below was run with CableDyn_driver.exe for this release;
the run time is the wall time on an ordinary desktop.
New-Item -ItemType Directory -Force results | Out-Null # the driver does not create it
.\CableDyn_driver.exe .\examples\<deck>.dat .\results\<root>
Use the closest deck as a template, copy it under a new name, and keep every file it references (motion, Syrope, bathymetry) in the same relative location. The deck grammar is in Deck format reference (.dat), every option in OPTIONS reference and defaults, and every output in Output files and channels.
Route is the solver path the deck exercises: cable (EI = 0 element), Hermite
(finite-EI bending element), points/bodies (EI = 0 lines coupled to dynamic points, bodies,
or rods), or mixed (both elements in one deck). Static decks stop at the equilibrium;
dynamic decks march in time from it; modal decks compute natural periods and mode shapes
about it.
Start here
Deck |
What it shows |
Route |
Run time |
|---|---|---|---|
|
270 m R4 chain in 30 m of water, mostly grounded — the Quickstart: first result in five minutes deck |
cable, static |
< 1 s |
|
550 m R3 chain in 100 m, classic grounded catenary — Tutorial 1 — A grounded catenary chain |
cable, static |
< 1 s |
|
410 m chain in 50 m with a long grounded length, fairlead at the surface, plus point-position channels |
cable, static |
< 1 s |
|
a runnable 30 m chain whose active rows show every common default; commented rows show each alternative form of current, waves, WaterKin, motion, and bathymetry |
cable, static |
< 1 s |
|
the 12 lowest natural periods and mode shapes ( |
cable, modal |
< 1 s |
Mooring configurations
Deck |
What it shows |
Route |
Run time |
|---|---|---|---|
|
IEA-15MW VolturnUS-S three-line chain spread, 200 m — Tutorial 2 — A spread mooring and its output channels |
cable, static |
< 1 s |
|
symmetric four-line spread and multi-line output selection |
cable, static |
< 1 s |
|
one line of the VolturnUS-S spread, for single-line comparisons |
cable, static |
< 1 s |
|
steep, near-taut chain with almost no grounded length |
cable, static |
< 1 s |
|
steel-wire catenary with wire mass, stiffness, and drag |
cable, static |
< 1 s |
|
chain + wire composite on a penalty seabed: one line, two sections |
cable, static |
< 1 s |
|
chain–polyester–chain: one line, three ordered sections |
cable, static |
< 1 s |
|
Lozon et al. (2025) Gulf of Maine 200 m semi-taut composite (chain at the anchor, polyester above) |
cable, static |
< 1 s |
|
the single-line moorings of the three Lozon sites (80, 200, 800 m); the 200 m and 800 m
decks use the viscoelastic |
cable, static |
< 1 s |
Synthetic ropes
A rope’s EA and BA tokens select the constitutive model; see Tutorial 6 — Synthetic ropes and,
for the equations, the viscoelastic (series-Kelvin) and Syrope sections of Theory.
polyester_linear 0.1438 22.42 1.424e8 -0.8 0.0 1.2 0.2 1.0 0.0
polyester_ve 0.1438 22.42 1.424e8|2.50e8 4.0e9|1.1e7 0.0 1.2 0.2 1.0 0.0
nylon_mean_load 0.1500 24.00 6.0e7|1.00e8|0.4 4.0e9|1.1e7 0.0 1.2 0.2 1.0 0.0
polyester_syrope 0.1438 22.42 "SYROPE:data/syrope/syrope_settings.dat|1.53e8|23.12" 5.0e10|1.0e5 0.0 1.0 0.0 1.0 0.0
Deck |
What it shows |
Route |
Run time |
|---|---|---|---|
|
690 m semi-taut polyester leg with a single linear |
cable, static |
< 1 s |
|
taut nylon leg with a single linear |
cable, static |
< 1 s |
|
the polyester leg with the viscoelastic (series-Kelvin) model, constant dynamic stiffness
(MoorDyn |
cable, static |
< 1 s |
|
viscoelastic nylon with mean-load-dependent dynamic stiffness ( |
cable, static |
< 1 s |
|
the viscoelastic polyester leg under a 1.5 m, 10 s Airy wave for 10 s |
cable, dynamic |
< 1 s |
|
Syrope working-curve polyester with a |
cable, dynamic |
< 1 s |
Dynamic environment
Deck |
What it shows |
Route |
Run time |
|---|---|---|---|
|
10 s still-water march from equilibrium; the tension must not drift — Tutorial 5 — Current, waves, and convergence |
cable, dynamic |
< 1 s |
|
the same line in a 1 m/s uniform current |
cable, dynamic |
< 1 s |
|
the same line under a 2 m, 8 s Airy wave (Morison, Froude–Krylov, wetting) |
cable, dynamic |
< 1 s |
|
the same chain in a short-crested Torsethaugen sea (Hs 5 m, Tp 11 s, cos-2s
|
cable, dynamic |
~1 s |
|
a two-train sea: a spread JONSWAP wind sea plus a long-crested swell from 60°
( |
cable, dynamic |
~1 s |
|
MoorDyn-C water kinematics: |
cable, dynamic |
< 1 s |
|
the 30 m R4 chain under a steep Dean stream-function wave (H 8 m, T 10 s,
|
cable, dynamic |
< 1 s |
|
the same chain, wave height and period with linear Airy theory, for comparison |
cable, dynamic |
< 1 s |
|
a 410 m chain in 50 m whose fairlead surges 5 m at 30 s under a 6 m, 10 s Airy wave: range
graph ( |
cable, dynamic |
< 1 s |
|
a laid cable in a 1.2 m/s cross current held by anisotropic seabed friction
( |
cable, dynamic |
< 1 s |
Points, buoys, bodies, and rods
Deck |
What it shows |
Route |
Run time |
|---|---|---|---|
|
a chain ending in a 20 t clump weight modelled as a |
points, dynamic |
< 1 s |
|
two lines meeting at a force-balanced weighted |
points, dynamic |
< 1 s |
|
a submerged 6-DOF |
bodies, dynamic |
< 1 s |
|
a buoyant free rigid rod held by four polyester legs in current, with rod end-position output |
rods, dynamic |
< 1 s |
|
a floating |
bodies, dynamic |
~6 s |
|
a free |
bodies, dynamic |
~2 s |
|
one march over a |
mixed, dynamic |
~3 s |
Line failure (accidental limit state)
A FAILURE row detaches a line from its fairlead mid-run, by time or by tension; the
examples README.md reports the transient on the remaining lines.
Deck |
What it shows |
Route |
Run time |
|---|---|---|---|
|
the IEA-15MW VolturnUS-S as a free |
bodies, dynamic |
~30 s |
|
the same platform; line 1 breaks when its fairlead tension first reaches 3.0 MN |
bodies, dynamic |
~30 s |
Dynamic power cables
The Lozon et al. (2025) installed lazy-wave cables at three reference sites. CableDyn finds each touchdown and lazy-wave shape from the geometry alone; there is no initial-shape input.
Deck |
What it shows |
Route |
Run time |
|---|---|---|---|
|
Gulf of Mexico, 80 m: bare/buoyant/bare lazy wave with a grounded tail — Tutorial 3 — A lazy-wave power cable |
Hermite, static |
< 1 s |
|
Gulf of Maine, 200 m |
Hermite, static |
< 1 s |
|
Humboldt, 800 m |
Hermite, static |
< 1 s |
|
the 80 m cable driven 36 s by a 3 m, 12 s hang-off heave from
|
Hermite, dynamic |
< 1 s |
|
the 80 m cable with a clamped ( |
Hermite, dynamic |
~4 s |
|
the same clamped cable on a vessel driven by the illustrative RAO table
|
Hermite, dynamic |
~9 s |
|
the 80 m cable in a 0.5 m/s current with its buoyant stretch built from ten discrete
buoyancy modules ( |
Hermite, static |
< 1 s |
|
the same cable with the stretch smeared as one |
Hermite, static |
< 1 s |
|
the 10 lowest natural periods and mode shapes ( |
Hermite, modal |
~2 s |
|
the 80 m cable with an illustrative |
Hermite, dynamic |
~2 s |
The first three set TMax = 0 (static only). The motion file holds absolute position,
velocity, and acceleration at every dtM and is regenerated by
data/lozon/generate_gomex80_heave.py.
OpenFAST coupling
These files run CableDyn inside OpenFAST, maintained by NLR (National Laboratory of the Rockies, formerly NREL).
File |
What it is |
|---|---|
|
IEA-15MW VolturnUS-S template with |
|
its CableDyn |
|
the same model with stock MoorDyn ( |
|
its stock MoorDyn v2 deck (also readable by CableDyn, see Migrating from MoorDyn or OrcaFlex) |
|
lines 1 and 2 hung from the ends of a |
|
the |
|
file roles and where to obtain the turbine sub-models |
|
three chains plus a finite-EI lazy-wave power cable with a grounded tail (mixed route).
As a |
|
an OpenFAST-only |
The turbine model itself (ElastoDyn, SeaState, HydroDyn, WAMIT data) comes from OpenFAST’s
r-test; Tutorial 9 — A floating wind turbine in OpenFAST gives the exact steps.
Auxiliary data
These files are inputs referenced by decks, not decks:
data/syrope/syrope_settings.dat— Syrope settings (names the OWC table, curve type, and shape parameters);data/syrope/syrope_owc.dat— the original working-curve table. Paths are relative to the referring file; copy all three Syrope files together.data/lozon/gomex80_heave_3m_12s_dt005.txt— the prescribed hang-off motion;data/lozon/generate_gomex80_heave.py— the script that writes it.data/vessel/vessel_surge_heave_pitch_12s_dt005.txt— the 6-DOF vessel record oflazy_wave_vessel_motion.dat;data/vessel/generate_vessel_motion.pywrites it;data/vessel/sample_rao.txt— the illustrative RAO table oflazy_wave_vessel_rao.dat.data/range_tdp/chain_surge_5m_30s_dt005.txt— the fairlead surge ofchain_range_tdp.dat;data/range_tdp/generate_chain_surge.pywrites it.data/torsion/hangoff_roll_2turns_60s_dt01.txt— the held hang-off with its roll column oftorsion_lazy_wave_hangoff_twist.dat;data/torsion/generate_hangoff_roll.pywrites it.moordynC_wavekin/wave_frequencies.txtandmoordynC_wavekin/current_profile.txt— the MoorDyn-C kinematics files, read from the folder of the deck beside them.plot_range_envelope.py— plots the tension envelope of a range-graph file.