diff --git a/CHANGELOG.md b/CHANGELOG.md index 4ed0bbc1..406d1636 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -46,6 +46,10 @@ All notable changes to CableDyn are recorded in this file. The format follows numbers them from 0, so a MoorDyn deck's `N` is CableDyn's `N`, or `N` on a line written anchor-first. The numbering itself is unchanged; the outputs and migration pages state it. +- The run banner, README, manual, citation and package descriptions call CableDyn what it is: a + geometrically exact finite-element solver for the statics and dynamics of mooring lines and + dynamic power cables (its strain and curvature are the exact large-deformation measures), in + place of "geometrically nonlinear cable & mooring dynamics". ### Fixed diff --git a/CITATION.cff b/CITATION.cff index f2786fe1..da0c3bda 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -3,11 +3,12 @@ message: >- If you use CableDyn in academic work, please cite the journal article given as the preferred citation. To identify the exact software release used, also cite this software entry with its version. -title: "CableDyn: A cable and mooring dynamics solver for floating offshore wind" +title: "CableDyn: Geometrically exact finite-element statics and dynamics of mooring lines and dynamic power cables for floating offshore wind" type: software abstract: >- - CableDyn is an open-source finite-element solver for the static and dynamic - analysis of offshore mooring lines and dynamic power cables. It combines + CableDyn is an open-source, geometrically exact finite-element solver for the + static and dynamic analysis of offshore mooring lines and dynamic power cables. + Its strain and curvature are the exact large-deformation measures. It combines tension-only elements for moorings with cubic-Hermite finite-bending elements for power cables, solves the static equilibrium by Newton's method, and integrates the dynamics with the implicit generalised-alpha scheme. It runs as diff --git a/CMakeLists.txt b/CMakeLists.txt index 5911ec2c..a3680b28 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -9,7 +9,7 @@ cmake_minimum_required(VERSION 3.20) # VERSION is a bare numeric triple matching the release version. project(CableDynCore VERSION 0.3.0 LANGUAGES C Fortran - DESCRIPTION "CableDyn geometrically nonlinear cable/mooring solver — Fortran core") + DESCRIPTION "CableDyn geometrically exact cable/mooring solver — Fortran core") option(CABLEDYN_ENABLE_COVERAGE "Instrument the GNU Fortran core for gcov/gcovr source coverage" OFF) option(CABLEDYN_ENABLE_OPENMP "Enable OpenMP acceleration when the compiler provides it" ON) diff --git a/README.md b/README.md index c5d2048d..cafb45b1 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,11 @@ [![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE) [![DOI](https://img.shields.io/badge/DOI-10.1016%2Fj.oceaneng.2026.128332-blue.svg)](https://doi.org/10.1016/j.oceaneng.2026.128332) -CableDyn is an open-source finite-element solver for the static and dynamic -analysis of offshore mooring lines and dynamic power cables. It is written in +CableDyn is an open-source, geometrically exact finite-element solver for the +static and dynamic analysis of offshore mooring lines and dynamic power cables. +Its strain and curvature are the exact large-deformation measures, never +linearised, so large displacements and rotations, slack and snap, and a line +lifting off the seabed lie inside the formulation. It is written in Fortran 2018 and runs as a standalone program, as a mooring module of OpenFAST, maintained by NLR (National Laboratory of the Rockies, formerly NREL) (`CompMooring = 5`), through a C interface, or from Python. It reads input decks diff --git a/doc/citing.rst b/doc/citing.rst index d3d89e60..bde7a978 100644 --- a/doc/citing.rst +++ b/doc/citing.rst @@ -36,14 +36,16 @@ Incheon, Republic of Korea. Software release ---------------- -Seo, J. H. (2026). *CableDyn: A cable and mooring dynamics solver for floating offshore -wind* (version 0.3.0) [Computer software]. https://github.com/SMI-Lab-Inha/CableDyn +Seo, J. H. (2026). *CableDyn: Geometrically exact finite-element statics and dynamics of +mooring lines and dynamic power cables for floating offshore wind* (version 0.3.0) [Computer +software]. https://github.com/SMI-Lab-Inha/CableDyn .. code-block:: bibtex - @software{CableDyn_0_1_1, + @software{CableDyn_0_3_0, author = {Seo, Jae Hoon}, - title = {{CableDyn}: A cable and mooring dynamics solver for floating offshore wind}, + title = {{CableDyn}: Geometrically exact finite-element statics and dynamics of mooring + lines and dynamic power cables for floating offshore wind}, version = {0.3.0}, year = {2026}, url = {https://github.com/SMI-Lab-Inha/CableDyn}, diff --git a/doc/index.rst b/doc/index.rst index a56a337a..37d9dfb6 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -3,9 +3,11 @@ CableDyn ======== -**CableDyn** is an open-source (`Apache-2.0 `_) -cable and mooring dynamics solver for floating offshore wind turbines and substations, written -in modern **Fortran 2018**. It targets dynamic power cables in the lazy-wave configuration and +**CableDyn** is an open-source (`Apache-2.0 `_), +geometrically exact finite-element solver for the statics and dynamics of mooring lines and +dynamic power cables of floating offshore wind turbines and substations, written in modern +**Fortran 2018**. Its strain and curvature are the exact large-deformation measures, never +linearised (:doc:`theory`). It targets dynamic power cables in the lazy-wave configuration and taut, semi-taut, and catenary moorings. It reads MoorDyn v2 input decks and has been compared with MoorDyn-C, MoorDyn-F, and OrcaFlex on common reference cases. diff --git a/doc/installation.rst b/doc/installation.rst index c0d87a03..77c5f1cc 100644 --- a/doc/installation.rst +++ b/doc/installation.rst @@ -121,8 +121,8 @@ Check that it runs =================================================================== CableDyn v0.3.0 - Geometrically nonlinear cable & mooring dynamics for floating wind - (lazy-wave power cables and taut / semi-taut / catenary moorings) + Geometrically exact finite-element statics and dynamics of + mooring lines and dynamic power cables for floating offshore wind ------------------------------------------------------------------- Author Prof. Jae Hoon Seo Affil. Inha University, Republic of Korea diff --git a/doc/quickstart.rst b/doc/quickstart.rst index 2f950838..8d35cbed 100644 --- a/doc/quickstart.rst +++ b/doc/quickstart.rst @@ -39,8 +39,8 @@ The run takes well under a second: =================================================================== CableDyn v0.3.0 - Geometrically nonlinear cable & mooring dynamics for floating wind - (lazy-wave power cables and taut / semi-taut / catenary moorings) + Geometrically exact finite-element statics and dynamics of + mooring lines and dynamic power cables for floating offshore wind ------------------------------------------------------------------- Author Prof. Jae Hoon Seo Affil. Inha University, Republic of Korea diff --git a/doc/tutorial_openfast.rst b/doc/tutorial_openfast.rst index 50c2e217..156ce2f6 100644 --- a/doc/tutorial_openfast.rst +++ b/doc/tutorial_openfast.rst @@ -169,7 +169,7 @@ The CableDyn part of the console (other modules' lines trimmed): .. code-block:: text Running CableDyn (v0.3.0, 2026-10-23). - CableDyn: geometrically nonlinear cable & mooring dynamics for floating wind. + CableDyn: geometrically exact finite-element statics and dynamics of mooring lines and dynamic power cables. ... CableDyn time step dtM = 2.50000E-02 s (1 x glue DT; deck dtM) Parsing CableDyn input file: .\CableDyn_UMaine.dat diff --git a/pyproject.toml b/pyproject.toml index af814b55..4b6ea160 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -13,7 +13,7 @@ build-backend = "scikit_build_core.build" [project] name = "cabledyn" version = "0.3.0" -description = "Python APIs for the CableDyn standalone driver and native coupling library" +description = "Python tools for CableDyn, a geometrically exact finite-element solver for mooring lines and dynamic power cables" readme = "python/README.md" requires-python = ">=3.10" license = "Apache-2.0" diff --git a/python/cabledyn/__init__.py b/python/cabledyn/__init__.py index 7916bbcb..fd926e14 100644 --- a/python/cabledyn/__init__.py +++ b/python/cabledyn/__init__.py @@ -1,5 +1,5 @@ # SPDX-License-Identifier: Apache-2.0 -"""Python interfaces for the CableDyn cable and mooring dynamics solver. +"""Python interfaces for CableDyn, the geometrically exact cable and mooring solver. The standalone-driver API works with the statically linked release executable. The in-process :class:`CableDyn` class, and the ``abi_version``, ``abi_minor``, diff --git a/python/pyproject.toml b/python/pyproject.toml index 9d9a0a83..9d12e9f6 100644 --- a/python/pyproject.toml +++ b/python/pyproject.toml @@ -8,7 +8,7 @@ build-backend = "setuptools.build_meta" [project] name = "cabledyn" version = "0.3.0" -description = "Python APIs for the CableDyn standalone driver and native coupling library" +description = "Python tools for CableDyn, a geometrically exact finite-element solver for mooring lines and dynamic power cables" readme = "README.md" requires-python = ">=3.10" license = "Apache-2.0" diff --git a/src/CableDyn_Banner.f90 b/src/CableDyn_Banner.f90 index 4c69e862..b5a86dfb 100644 --- a/src/CableDyn_Banner.f90 +++ b/src/CableDyn_Banner.f90 @@ -27,9 +27,9 @@ PURE FUNCTION CD_Banner_Line(i) RESULT(s) CASE (2) s = ' CableDyn v0.3.0' CASE (3) - s = ' Geometrically nonlinear cable & mooring dynamics for floating wind' + s = ' Geometrically exact finite-element statics and dynamics of' CASE (4) - s = ' (lazy-wave power cables and taut / semi-taut / catenary moorings)' + s = ' mooring lines and dynamic power cables for floating offshore wind' CASE (5) s = ' -------------------------------------------------------------------' CASE (6) diff --git a/src/openfast/CableDyn_OF.f90 b/src/openfast/CableDyn_OF.f90 index 9fc90ee1..8b26f507 100644 --- a/src/openfast/CableDyn_OF.f90 +++ b/src/openfast/CableDyn_OF.f90 @@ -543,7 +543,8 @@ SUBROUTINE CD_Init(InitInp, u, p, x, xd, z, other, y, m, DTcoupling, InitOut, Er ! ------------------------------------------------------------------------------ CALL DispNVD( CableDyn_ProgDesc ) InitOut%Ver = CableDyn_ProgDesc - CALL WrScr( ' CableDyn: geometrically nonlinear cable & mooring dynamics for floating wind.' ) + CALL WrScr( ' CableDyn: geometrically exact finite-element statics and dynamics of mooring lines '// & + 'and dynamic power cables.' ) CALL WrScr( ' Author Prof. Jae Hoon Seo, Inha University. License Apache-2.0.' ) CALL WrScr( ' CompMooring = 5: mooring and dynamic power-cable loads are computed by CableDyn,' ) CALL WrScr( ' an OpenFAST mooring module alongside MoorDyn (CompMooring = 3) in this binary.' )