Release 4.1.0 #2871

andrew-platt · 2025-06-18T16:18:00Z

Feature or improvement description
Pull request to merge rc-4.1.0 into main and create a tagged release for v4.1.0

See the milestone and project pages for additional information

https://github.com/OpenFAST/openfast/milestone/17

Test results, if applicable
See GitHub Actions

Release checklist:

Changelog (from 4.0.5)

Overview

This release removes the SuperController from FAST.Farm and adds several important new features including direct coupling of MoorDyn to SeaState, rectangular members in HydroDyn and SubDyn, and a new pyOpenFAST module for calling c-binding libraries directly from Python.
This release also includes several bug fixes and improvements for AeroDyn, BeamDyn, MoorDyn, OpenFAST, several various c-binding libary interfaces, and GitHub actions.

General

CMake build system

#2632 Reduce optimization level for FAST*_Types.f90 with gcc (@andrew-platt)

GitHub actions

#2636 Add job to build Windows executables to deploy.yml (@deslaughter)

#2771 Update GH conda-deploy action to use Ubuntu 24.04 (@andrew-platt)

Visual Studio build system

#2866 VS build: fix MD, add SeaStateS_c_binding and update GH deploy action (@andrew-platt)

Python packages

openfast_io

#2658 openfast_IO MoorDyn compatibility (@RyanDavies19)

pyOpenFAST

This is a new python package that interfaces the c-bindings library versions of OpenFAST with Python. Users who want to call standalone OpenFAST modules from Python will want to look into using this package. Note that the documentation is limited at this time.

This package is also used in testing (see documentation on testing environments)

#2680 Refactor the Aerodyn/Inflowwind Python interface to the C-bindings interface (@faisal-bhuiyan)

#2719 Python infrastructure improvements (new pyOpenFAST package) (@rafmudaf)

Solvers

FAST.Farm

#2729 Remove supercontroller from FAST.Farm (@abhineet-gupta)

OpenFAST

#2671 Avoid ending program when called as a shared library (@bjonkman)

#2705 MoorDyn-SeaState Coupling (OpenFAST and FAST.Farm) (@RyanDavies19)

#2760 bug fix: Adjust steady-state solver small angle assumptions (@bjonkman)

Module changes

multiple modules

#2770 Bug fix for Failed0 error checking functions (@rafmudaf)

AeroDyn

#2848 Bug fix: remove spaces in OLAF's UA summary file name (@bjonkman)

BeamDyn

#2642 [BugFix] BD: variable passing in Calc_RR0mEta_rho (@bjonkman, @andrew-platt)

HydroDyn

#2646 Implementation of rectangular members in HD and SD (@luwang00)

#2663 HydroDyn C-binding: Added mass matrix (@luwang00)

#2787 HD-cbind: Add HydroDyn input files handle (@wenchaoyu, @andrew-platt)

#2865 Reduce memory requirement in HydroDyn initialization (@bjonkman)

MoorDyn

#2746 MoorDyn bugfixes (@RyanDavies19)

#2650 MoorDyn: VIV and Rk4 solver (@RyanDavies19 )

#2791 MD cbind: correction to description of mesh point mapping (@andrew-platt)

#2794 MoorDyn wave directional spreading and custom current profile if no SeaState current (@RyanDavies19)

SeaState

#2720 Adds first pass SeaState C Binding interface (@rafmudaf)

ServoDyn

#2798 Docs: correct Bladed Interface channel 63 description (@andrew-platt)

SubDyn

#2646 (see above in HydroDyn)

TurbSim

#2808 [BugFix] TurbSim calculating grid bottom location (@ptrbortolotti)

Documentation

#2867 Docs: update info on testing (with pyOpenFAST module) (@andrew-platt)

#2850 Docs Update for the New Rectangular Members in HydroDyn and SubDyn (@luwang00)

Typo fixes in code comments

There have been several "fluff" pull requests with only typo fixes and no code changes.

#2858 Fix Typos in Comments and Log Messages for Flexural and Crushing Ice Failure Initialization (@kilavvy)

Regression Testing

#2765 MHK RM1: reduce HD resolution (@andrew-platt)

Code API changes

The SuperController has been removed. This changes the interfaces for some files:

CPP interface

glue-codes/openfast-cpp/src/OpenFAST.H
- class fastInputs {
- class OpenFAST {
glue-codes/openfast-cpp/src/OpenFAST.cpp
- class fastInputs
- fast::fastInputs::fastInputs():

OpenFAST library interface

modules/openfast-library/src/FAST_Library.h
- FAST_ExtLoads_Restart - removal of SuperController arguments
- FAST_ExtLoads_Init - removal of SuperController arguments
- FAST_ExtInfw_Restart - removal of SuperController arguments
- FAST_ExtInfw_Init -removal of SuperController arguments
modules/openfast-library/src/FAST_Library.f90
- FAST_ExtLoads_Restart - removal of SuperController arguments
- FAST_ExtLoads_Init - removal of SuperController arguments
- FAST_ExtInfw_Restart - removal of SuperController arguments
- FAST_ExtInfw_Init -removal of SuperController arguments

HydroDyn c-binding library interface

modules/hydrodyn/src/HydroDyn_C_Binding.f90
- HydroDyn_C_Init - arguments
- HydroDyn_C_CalcOutput_and_AddedMass - new routine

MoorDyn c-bindings libarary interface

modules/moordyn/src/MoorDyn_C_Binding.f90
- MD_C_Init - new argument

Input file changes

This release brings several input file changes including the FAST.Farm (removal of supercontroller sections), HydroDyn (new sections for rectangular members, revised members table), SubDyn (new rectangular cross-section table, and additional columns in other tables).
A list of changes can be found here: https://openfast.readthedocs.io/en/main/source/user/api_change.html. However, we recommend that if you start by comparing to the complete set of input files found in the regression tests: https://github.com/OpenFAST/r-test/tree/v4.1.0 (example input files from the regression testing)

Known issues

There are several issues that have not been addressed in this release due to time constraints, but will be addressed in future releases. These include:

No visualization of rectangular members from HydroDyn or SubDyn through the VTK output options
Missing and broken features from several c-binding library interfaces:
- the AeroDyn_Inflow_c-binding library interface does not allow for coupling to the tower. This will require an interface update.
- the HydroDyn_c-binding library interface does not currently support vizualization. This will require an interface update.
- the InitNodePositions input to HydroDyn_c-binding library interface does not currently work with any non-zero x or y coordinates (non-zero z is ok)
- the MoorDyn_c-binding library interface does not currently support vizualization. This will require an interface update.
- error messages from c-binding library interfaces will get truncated to 1024 characters. A fix is nearly ready, but will have to wait until the next release.
There are leftover unused and incomplete files from development in the glue-codes/python directory. These will be removed later.
A glue-codes/labview/src/WaveTank.f90 file is included in this release, but it is incomplete and untested. This is a placeholder for internal development work that may be released in complete form at a later date.
The GitHub deploy action to build Windows executables does not currently catch failed builds. This might be addressed at a later date. We are manually checking these builds for now.
Documentation on the new pyOpenFAST module is incomplete. Partial documentation exists on how to use it in regression testing, but no documentation or examples exist on using it to call c-bindings modules from Python.
Documentation is incomplete for HydroDyn, SubDyn, and a few other modules.

…lar (for outputs), rectangular, and arbitrary sections

…c line damping error check

…arbitrary sections

…ormity

…spatch. PR is ready.

Add job to build Windows executables to deploy.yml

…er spin angle.

…rectangular beam sections * Added alternative torsion constant and shear coefficient estimates for solid rectangular sections in addition to thin-walled sections. * Use a more accurate formula for the shear coefficient of thin-walled rectangular sections. * Added a warning message if the section is neither solid nor thin-walled. * Other small bug fixes.

The argument RR0mEta to Calc_RR0mEta_rho was handled inconsistently. See issue #2641 for details

Co-authored-by: Derek Slaughter <[email protected]>

docs/changelogs/v4.1.0.md

andrew-platt · 2025-06-18T16:31:34Z

Documentation changes on readthedocs:

general changes

rectangular members

SuperController deprication

https://openfast.readthedocs.io/en/dev/source/user/fast.farm/AppendixC.html
https://openfast.readthedocs.io/en/dev/source/user/fast.farm/FFarmTheory.html
https://openfast.readthedocs.io/en/dev/source/user/fast.farm/InputFiles.html#shared-moorings (section before shared-moorings)
https://openfast.readthedocs.io/en/dev/source/user/fast.farm/ModelGuidance.html#farm-level-control
https://openfast.readthedocs.io/en/dev/_images/FFarmHierarchy.png (updated to move SuperController out of FF)

docs/changelogs/v4.1.0.md

andrew-platt · 2025-06-18T18:09:09Z

modules/openfast-library/src/FAST_Library.f90

@@ -530,7 +524,7 @@ end subroutine FAST_Restart
 !==================================================================================================================================
 subroutine FAST_ExtLoads_Init(iTurb_c, TMax, InputFileName_c, TurbIDforName, OutFileRoot_c, TurbPosn, AbortErrLev_c, dtDriver_c, dt_c, NumBl_c, &
     az_blend_mean_c, az_blend_delta_c, &
-     ExtLd_Input_from_FAST, ExtLd_Parameter_from_FAST, ExtLd_Output_to_FAST, SC_DX_Input_from_FAST, SC_DX_Output_to_FAST, ErrStat_c, ErrMsg_c) BIND (C, NAME='FAST_ExtLoads_Init')
+     ExtLd_Input_from_FAST, ExtLd_Parameter_from_FAST, ExtLd_Output_to_FAST, ErrStat_c, ErrMsg_c) BIND (C, NAME='FAST_ExtLoads_Init')


@mbkuhn, here are the changes for AMR-Wind coupling

andrew-platt · 2025-06-18T18:09:19Z

modules/openfast-library/src/FAST_Library.f90

@@ -620,10 +609,10 @@ subroutine FAST_ExtLoads_Init(iTurb_c, TMax, InputFileName_c, TurbIDforName, Out

 end subroutine FAST_ExtLoads_Init
 !==================================================================================================================================
-subroutine FAST_ExtInfw_Init(iTurb_c, TMax, InputFileName_c, TurbIDforName, OutFileRoot_c, NumSC2CtrlGlob, NumSC2Ctrl, NumCtrl2SC, &
-                        InitSCOutputsGlob, InitSCOutputsTurbine, NumActForcePtsBlade, NumActForcePtsTower, TurbPosn, AbortErrLev_c, &
+subroutine FAST_ExtInfw_Init(iTurb_c, TMax, InputFileName_c, TurbIDforName, OutFileRoot_c, &


@mbkuhn, here are the changes for AMR-Wind coupling

andrew-platt · 2025-06-18T18:09:37Z

modules/openfast-library/src/FAST_Library.f90

@@ -862,7 +824,7 @@ subroutine FAST_CFD_InitIOarrays_SubStep(iTurb_c, ErrStat_c, ErrMsg_c) BIND (C,
 end subroutine FAST_CFD_InitIOarrays_SubStep
 !==================================================================================================================================
 subroutine FAST_ExtInfw_Restart(iTurb_c, CheckpointRootName_c, AbortErrLev_c, dt_c, numblades_c, numElementsPerBlade_c, numElementsTower_c, n_t_global_c, &
-                      ExtInfw_Input_from_FAST, ExtInfw_Output_to_FAST, SC_DX_Input_from_FAST, SC_DX_Output_to_FAST, ErrStat_c, ErrMsg_c) BIND (C, NAME='FAST_ExtInfw_Restart')
+                      ExtInfw_Input_from_FAST, ExtInfw_Output_to_FAST, ErrStat_c, ErrMsg_c) BIND (C, NAME='FAST_ExtInfw_Restart')


@mbkuhn, here are the changes for AMR-Wind coupling

andrew-platt · 2025-06-18T18:09:45Z

modules/openfast-library/src/FAST_Library.f90


 end subroutine FAST_ExtInfw_Restart
 !==================================================================================================================================
 subroutine FAST_ExtLoads_Restart(iTurb_c, CheckpointRootName_c, AbortErrLev_c, dt_c, numblades_c, &
     n_t_global_c, ExtLd_Input_from_FAST, ExtLd_Parameter_from_FAST, ExtLd_Output_to_FAST, &
-     SC_DX_Input_from_FAST, SC_DX_Output_to_FAST, ErrStat_c, ErrMsg_c) BIND (C, NAME='FAST_ExtLoads_Restart')
+     ErrStat_c, ErrMsg_c) BIND (C, NAME='FAST_ExtLoads_Restart')


@mbkuhn, here are the changes for AMR-Wind coupling

Added info on code API changes

docs/changelogs/v4.1.0.md

Missing PR #2650

jjonkman

Thanks for pushing this release through! Please find a couple minor comments below.

docs/changelogs/v4.1.0.md

docs/source/user/api_change.rst

- Include mention of VIV in MD - Mention why SuperController has been depricated (in favor of ZeroMQ communication through ROSCO) - Include links to MD input file info for SeaState coupling and VIV

deslaughter and others added 30 commits February 13, 2025 00:06

Disable publish-to-pypi-test

de0e6fe

Get tags and ignore vs-build and types changes for version info

3f9d086

Working on getting tags without errors

c007cc0

Fix git command to init submodules

1f27e23

SD: Extend member spin angle input to all beam types, including circu…

29b88e6

…lar (for outputs), rectangular, and arbitrary sections

Debugging version info on CI

4727761

MD: cleaned up spacing, commented out timestep function, added dynami…

1f5936a

…c line damping error check

MD: removed forgotten print statement

96fd04a

Merge remote-tracking branch 'upstream/main' into f/build-windows

881846b

Just print out the git-version tag

f3eb4f0

get tags

beffecc

Update r-test pointer

c05b124

add origin

71f258b

SD: Update summary file to better support beams with rectangular and …

2621669

…arbitrary sections

Just keep trying

c2c5c63

Test with actual build

f447b6d

Merge branch 'dev' into f/RectangularMembers

d6fc259

SD: Updated variable names for beams with a circular section for unif…

6cd72b4

…ormity

Everything except matlab

2097f2b

SD: Update summary file again to support the various beam types

346d1de

Try to remove dirty from version

b341047

Version works correctly. Make deploy.yml run on release and manual di…

a86ad21

…spatch. PR is ready.

Merge pull request #2636 from deslaughter/f/build-windows

e85ee49

Add job to build Windows executables to deploy.yml

HD: If a member is flipped, we also need to flip the sign of the memb…

9fc0f03

…er spin angle.

[BugFix] Calc_RR0mEta_rho routine argument consistency

af47e72

The argument RR0mEta to Calc_RR0mEta_rho was handled inconsistently. See issue #2641 for details

typo in af47e72

44d8ff8

Co-authored-by: Derek Slaughter <[email protected]>

BD: pass mEta into Calc_RR0mEta_rho

2a3f53e

handing python 0-indexing and OpenFAST 1-indexing correctly

84d20cc

removing LICENSE file from openfast_io

1cd64ad