OPTIONS reference and defaults
This page lists every keyword the OPTIONS section accepts, with every alias. Each keyword is
described with the same fields: value type and unit, default, valid values, the route that
consumes it, and an example record. The runnable examples/cabledyn_options_reference.dat
shows every syntax form, including commented mutually exclusive alternatives. Every maintained
example repeats the common defaults that affect its route and links back to this page. A value
labelled absent is not represented by a magic number: omission itself is meaningful.
Record syntax
Scalar records use the OpenFAST order
value keyword. Anything after the keyword is commentary, so0.05 dtM - Time step (s)and0.05 dtM time stepare both valid.Positional records (
current,waves) put the model name first and the keyword last:airy 2.0 8.0 0.0 waves. Thedynamic_solverrecord puts its keyword first.Descriptions. In every OPTIONS record, the first
-that has whitespace on both sides starts a description; it and everything after it are ignored. Negative numbers such as-1.0are unaffected.Keywords are case-insensitive. An unknown keyword is fatal (
unknown OPTION keyword "<name>"); CableDyn never silently ignores a misspelling.Repeated keywords. Records are applied in order, so the last record for a keyword wins (for example, a subsequent
0 motionFilerow disables an earlier path).Numbers. Every numeric value must be one plain number with a
.decimal point (1e-3,0.05,-50). A value containing/,,or;, or written as a repeat count such as2*0, is rejected with the deck line number instead of being read partially;1/20 dtMis an error, neverdtM = 1. Integer-valued options (for examplerecovery_max_substeps, the quadrature orders,nModes,StreamOrderandWaveSeed) reject non-integral values.Logical values (for example
modified_newton,adaptive_mesh,alpha_force_blendandcable_load_feedback) accept, case-insensitively,True/T/yes/y/on/1andFalse/F/no/n/off/0. Any other spelling is an error.File paths are single whitespace-free tokens, optionally quoted, resolved relative to the deck’s directory. They may contain
/or\separators and may be longer than the 64-character identifier limit. A#or!starts a comment even inside a path.
In the tables, Standalone means CableDyn_driver.exe; OpenFAST means a CompMooring = 5
(or Mod_SharedMooring = 5) coupled run in OpenFAST, maintained by NLR (National Laboratory of
the Rockies, formerly NREL).
Environment and seabed
Keyword and aliases |
Type, unit |
Default |
Valid values and rules |
Route |
Example |
|---|---|---|---|---|---|
|
real, m/s² |
|
finite, > 0 |
both; OpenFAST host |
|
|
real, kg/m³ |
|
finite, > 0; also used by |
both; OpenFAST host |
|
|
real, m |
absent: no flat seabed |
finite, > 0; flat seabed at |
both; OpenFAST uses host |
|
|
path |
absent |
non-empty. The file holds |
standalone static |
|
|
real, Pa/m (N/m³) |
|
finite, > 0 when a seabed is present. Mapped to each line node and rod contact station by local diameter × tributary length; a Rigid6 reference point uses a fixed 1 m² area |
both |
|
|
real, Pa·s/m (N·s/m³) |
|
finite, ≥ 0 when a seabed is present; scaled like |
both |
|
|
real, – |
|
finite, ≥ 0, or |
both, within the limits in this row |
|
|
real, – |
|
finite, ≥ 0. Anisotropic seabed friction of line nodes (the axial/normal pair of
OrcaFlex, by Orcina): the coefficient along the line and across it. A row omitted takes
|
both, within the limits of |
|
Clock and initial condition
Keyword and aliases |
Type, unit |
Default |
Valid values and rules |
Route |
Example |
|---|---|---|---|---|---|
|
text |
|
|
both |
|
|
text |
|
|
both |
|
|
text |
|
|
both |
|
|
text |
|
|
both |
|
|
text |
|
|
standalone |
|
|
text |
|
|
standalone |
|
|
real, s |
absent (static-only) |
finite, > 0. In the standalone driver |
standalone step; OpenFAST targets |
|
|
real, s |
absent (static-only) |
finite, ≥ 0 and an integer multiple of |
standalone only; OpenFAST uses the host |
|
|
real, s |
|
finite, ≥ 0 and ≤ |
standalone only |
|
Nonlinear solver
Static-solver tolerances are built in and are not deck options; keys such as staticRelTol are
rejected as unknown. The dynamic Newton controls are set with dynamic_solver.
Keyword and aliases |
Type, unit |
Default |
Valid values and rules |
Route |
Example |
|---|---|---|---|---|---|
|
real, – |
|
finite, in |
both |
|
|
real, – |
|
finite, ≥ 0; |
both ( |
|
|
keyword-first record: two reals, two integers, optional real |
|
|
both (see rules) |
|
|
logical |
|
|
both |
|
|
integer, – |
|
integer from 4 to 65536. Maximum internal subdivisions after a stalled tension-only step or a failed or under-resolved finite-bending interval. The nominal host time grid and output times are unchanged; prescribed position, velocity, and acceleration follow one C2 quintic trajectory inside the interval. The standalone completion summary reports the recovered intervals and the largest subdivision count used |
both |
|
Finite-EI cable controls
Keyword and aliases |
Type, unit |
Default |
Valid values and rules |
Route |
Example |
|---|---|---|---|---|---|
|
logical |
|
Permits finite-EI refinement when the static curvature diagnosis or mesh-scale contact
chatter is fragile. Multiple adequately sampled grounded runs are allowed and are not
treated as chatter merely because the contact topology has several islands. |
both (finite-EI lines) |
|
|
logical |
|
Generalised-α blend of the finite-EI dynamics. |
standalone and coupled (finite-EI lines) |
|
|
mode |
|
|
both (finite-EI lines) |
|
|
integer, – |
|
integer from 1 to 6; Gauss order for the finite-EI axial energy. A value different from the bending order gives selective integration |
both (finite-EI lines) |
|
|
integer, – |
|
integer from 1 to 6; Gauss order for the finite-EI curvature energy |
both (finite-EI lines) |
|
|
mode |
|
|
both (finite-EI lines) |
|
|
real, – |
|
finite, ≥ 0; strain band used by the tensile audit. Changes require an engineering basis and should be recorded with the run settings |
both (finite-EI lines) |
|
|
logical |
|
|
OpenFAST (coupled finite-EI cables) |
|
Ambient fluid and prescribed motion
Keyword and aliases |
Type, unit |
Default |
Valid values and rules |
Route |
Example |
|---|---|---|---|---|---|
|
positional record, m and m/s |
|
|
standalone; in OpenFAST, a single-turbine pure |
|
|
positional record, m, s, deg |
|
|
standalone only; always rejected in a coupled OpenFAST or FAST.Farm deck, because the host SeaState supplies the waves |
|
|
integer, – |
|
|
standalone |
|
|
integer, – |
|
integer from 0 to 1000. Modal analysis of every line about its static equilibrium: the
|
standalone |
|
|
integer, – |
|
integer from 1 to 2147483646. Seed of the |
standalone spectral waves and wave trains (train i uses seed + 7919 (i − 1)) |
|
|
positional record, m, s, deg, – |
none |
one wave train of a multi-train sea; the rows add up (at most 16):
|
standalone; in OpenFAST rejected like |
|
|
real, – |
|
cos-2s exponent in [0, 1000] of the spectral |
standalone spectral |
|
|
integer, – |
|
integer ≥ 1; equal-angle direction bins of a spread train (each with its own frequency set). Long-crested trains use one direction |
standalone spread seas |
|
|
integer, – |
|
integer ≥ 2; frequency components per train and direction. A |
standalone spectral waves |
|
|
real, s |
|
finite, ≥ 0; |
standalone |
|
|
path, or |
absent |
an active path requires |
standalone |
|
|
path, or |
absent |
a 6-DOF vessel record (19 values per row with roll/pitch/yaw, or 20 with a unit
quaternion) on the |
standalone line decks accepted with a |
|
|
path, or |
absent |
a displacement RAO table (amplitude and phase lag per DOF, per period and relative
heading). The vessel motion is the RAO response to the deck linear waves ( |
as |
|
|
|
|
three finite values: the vessel reference point at its reference pose, which is the
rotation centre of |
|
|
|
|
|
|
|
|
|
positive number [s] |
|
the step at which |
standalone |
|
|
|
|
|
standalone |
|
MoorDyn compatibility-only keywords
These names exist so a migrated MoorDyn deck fails less often at the syntax boundary. They do not tune CableDyn physics and should not be added to a new CableDyn model.
Keyword |
Value |
CableDyn behaviour |
|---|---|---|
|
any token |
Accepted and ignored; CableDyn always uses implicit generalised-alpha. |
|
plain number |
Parsed strictly and ignored; CableDyn uses a Newton static initial condition rather than MoorDyn dynamic relaxation. |
|
plain number |
Parsed strictly and ignored; reporting uses the normal CableDyn/OpenFAST diagnostics. |
|
plain number |
Parsed strictly and ignored. Standalone output follows |
|
any |
Rejected by name: the MoorDyn-F seabed friction coefficients map to |
|
any |
Rejected by name: CableDyn applies one regularised Coulomb friction set by
|
Other MoorDyn constructs that fail by name rather than as unknown input: CoupledPinned and
VesselPinned rods, and CoupledPinned bodies. Line-node output channels start at node 1
(N0 is rejected), and a number with a sign inside its mantissa (such as 1+2) is rejected
instead of being read up to the sign.
Water-kinematics sources
A WaterKin file keeps its independent WaveKinMod and CurrentMod selectors. Host modes
require the OpenFAST aggregate and a compatible SeaState field; the standalone driver rejects them
with WaterKin WaveKinMod 2/SEASTATE is coupled-only. The detailed supported matrix is in
MoorDyn-F WaterKin file modes in Deck format reference (.dat).
With no WaterKin policy, OpenFAST uses its complete SeaState field when one exists. Explicit file
selectors are authoritative: for example, file WaveKinMod=0 and CurrentMod=1 means no host
waves and only the file current profile. A coupled deck cannot carry inline waves or
wavetrain rows: the host SeaState supplies the waves, so such a deck is rejected at
initialisation. An inline current row is kept as a steady current only on a single-turbine,
pure EI = 0 deck without Rigid6 bodies or rods whose SeaState carries no waves or current; it
is rejected when SeaState carries waves or current, in FAST.Farm, and on a deck with finite-EI
cables, Rigid6 bodies or rods.
Standalone versus OpenFAST checklist
For a standalone static calculation, omit both dtM and TMax or set a deliberate pair with
TMax=0 when exercising the dynamic initialisation route. For standalone dynamics, provide
both and ensure TMax/dtM is integral. current, waves, motionFile, a positive
frictionMu, rods, bodies, Connect/Free points, and finite-EI sections (outside a mixed
deck) all need the dtM/TMax pair. File paths are resolved relative to the deck and may use
ordinary nested paths longer than the 64-character deck-identifier limit.
For CompMooring = 5, OpenFAST owns gravity, density, flat depth, platform motion, run duration,
and its output clock. The CableDyn deck owns line properties, mesh, contact coefficients,
rhoInf, Newton policy, optional dtM, and CableDyn output channels. The console prints the
actual dtM and its integer ratio to glue DT; archive that line with production results.