Skip to content

release notes for v5.0.0 #3262

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
andrew-platt merged 7 commits into from
Mar 12, 2026
+401 −22
Merged

release notes for v5.0.0 #3262

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
67adc47
SoilDyn: add some development docs
andrew-platt Mar 12, 2026
78f799e
docs: api_change.rst minor corrections / missing
andrew-platt Mar 12, 2026
ecb6272
docs: update version info
andrew-platt Mar 12, 2026
2ed4de3
release notes for v5.0.0
andrew-platt Mar 12, 2026
143b735
release notes: add summary info on ExtPtfm
andrew-platt Mar 12, 2026
9d0dfc9
release notes: updates based on comments
andrew-platt Mar 12, 2026
edb7d1f
release notes formatting
andrew-platt Mar 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/OtherSupporting/SoilDyn/Compiling OpenFAST with REDWIN_V3.docx
View file
Open in desktop
Binary file not shown.
Binary file added docs/OtherSupporting/SoilDyn/OpenFAST_Prescribing_Loads_at_Tower_Top.pdf
View file
Open in desktop
Binary file not shown.
2 changes: 2 additions & 0 deletions docs/OtherSupporting/SoilDyn/README.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
2026.03.12
The files included here were generated part way through the development of the SoilDyn module to couple the RedWin DLL from NGI. They are neither complete or fully accurate with the final implementation, but may serve as a starting point for modifying the code or using the RedWin module.
Binary file added docs/OtherSupporting/SoilDyn/REDWIN_coupling.pptx
View file
Open in desktop
Binary file not shown.
Binary file added docs/OtherSupporting/SoilDyn/SoilDyn--update_20200430.pptx
View file
Open in desktop
Binary file not shown.
Binary file added ... Phase II Integration and verification of a new soil structure interaction model for.pdf
View file
Open in desktop
Binary file not shown.
362 changes: 362 additions & 0 deletions docs/changelogs/v5.0.0.md
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,9 +137,9 @@ def runDoxygen(sourcfile, doxyfileIn, doxyfileOut):
# built documents.
#
# The short X.Y version.
version = f'4.2'
version = f'5.0'
# The full version, including alpha/beta/rc tags.
release = f'v4.2.1'
release = f'v5.0.0'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
51 changes: 33 additions & 18 deletions docs/source/user/api_change.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ The changes are tabulated according to the module input file, line number, and f
The line number corresponds to the resulting line number after all changes are implemented.
Thus, be sure to implement each in order so that subsequent line numbers are correct.

OpenFAST v4.1.2 to OpenFAST dev
----------------------------------
OpenFAST v4.2.x to OpenFAST v5.0.0
-----------------------------------

Added mass and fluid inertia loads were added to the rotor blades and tower in AeroDyn.
This results in new columns in the AeroDyn blade input file and new columns in the
Expand All @@ -30,21 +30,24 @@ reverse the direction the rotor is spinning. The first rotor always spins in the
These lines are specified only if NRotors is greater than 1 and are repeated for subsequent rotors.

============================================= ======== ==================== ========================================================================================================================================================================================================
Added in OpenFAST `dev`
Added in OpenFAST `5.0.0`
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Module Line Flag Name Example Value
============================================= ======== ==================== ========================================================================================================================================================================================================
OpenFAST 8 ModCoupling 3 ModCoupling - Module coupling method (switch) {1=loose; 2=tight with fixed Jacobian updates (DT_UJac); 3=tight with automatic Jacobian updates}
OpenFAST 20 CompSoil 0 CompSoil - Compute soil-structural dynamics (switch) {0=None; 1=SoilDyn}
OpenFAST 8 ModCoupling 3 ModCoupling - Module coupling method (switch) {1=loose; 2=tight with fixed Jacobian updates (DT_UJac); 3=tight with automatic Jacobian updates}
OpenFAST 11 RhoInf 1.0 RhoInf - Numerical damping parameter for tight coupling generalized-alpha integrator (-) [0.0 to 1.0]
OpenFAST 12 ConvTol 1e-4 ConvTol - Convergence iteration error tolerance for tight coupling generalized alpha integrator (-)
OpenFAST 13 MaxConvIter 6 MaxConvIter - Maximum number of convergence iterations for tight coupling generalized alpha integrator (-)
OpenFAST 17 NRotors 2 NRotors - Number of rotors in turbine (-)
OpenFAST 28 MirrorRotor F MirrorRotor - Flag to reverse rotor rotation direction [1 to NRotors] {F=Normal, T=Mirror}
OpenFAST 45 SoilFile "SoilDyn.dat" SoilFile - Name of the file containing the SoilDyn input parameters (quoted string)
OpenFAST 52 ---------------------- INPUT FILES Rotor 2 -------------------------------------
OpenFAST 53 EDFile "ElastoDyn.dat" EDFile - Name of file containing ElastoDyn input parameters (quoted string)
OpenFAST 54 BDBldFile(1) "BeamDyn.dat" BDBldFile(1) - Name of file containing BeamDyn input parameters for blade 1 (quoted string)
OpenFAST 55 BDBldFile(2) "BeamDyn.dat" BDBldFile(2) - Name of file containing BeamDyn input parameters for blade 2 (quoted string)
OpenFAST 56 BDBldFile(3) "BeamDyn.dat" BDBldFile(3) - Name of file containing BeamDyn input parameters for blade 3 (quoted string)
OpenFAST 57 ServoFile "ServoDyn_R2.dat" ServoFile - Name of file containing control and electrical-drive input parameters (quoted string)
OpenFAST 20 CompSoil 0 CompSoil - Compute soil-structural dynamics (switch) {0=None; 1=SoilDyn}
OpenFAST 29 MirrorRotor F MirrorRotor - Flag to reverse rotor rotation direction [1 to NRotors] {F=Normal, T=Mirror}
OpenFAST 53 SoilFile "SoilDyn.dat" SoilFile - Name of the file containing the SoilDyn input parameters (quoted string)
OpenFAST 54 ---------------------- INPUT FILES Rotor 2 -------------------------------------
OpenFAST 55 EDFile "ElastoDyn.dat" EDFile - Name of file containing ElastoDyn input parameters (quoted string)
OpenFAST 56 BDBldFile(1) "BeamDyn.dat" BDBldFile(1) - Name of file containing BeamDyn input parameters for blade 1 (quoted string)
OpenFAST 57 BDBldFile(2) "BeamDyn.dat" BDBldFile(2) - Name of file containing BeamDyn input parameters for blade 2 (quoted string)
OpenFAST 58 BDBldFile(3) "BeamDyn.dat" BDBldFile(3) - Name of file containing BeamDyn input parameters for blade 3 (quoted string)
OpenFAST 59 ServoFile "ServoDyn_R2.dat" ServoFile - Name of file containing control and electrical-drive input parameters (quoted string)
AeroDyn blade file t_c 0.8651 [additional column in *Blade Properties* table]
AeroDyn blade file BlCpn 1.0 [additional column in *Blade Properties* table]
AeroDyn blade file BlCpt 1.0 [additional column in *Blade Properties* table]
Expand All @@ -58,15 +61,17 @@ AeroDyn \* TwrCp 1.0
AeroDyn \* TwrCa 1.0 [additional column in *Tower Influence and Aerodynamics* table]
SeaState 18 WvCrntMod 0 WvCrntMod - Combined wave-current modeling option {0: simple superposition, 1: include Doppler effect, 2: include both Doppler effect and wave amplitude/spectrum scaling} (switch)
ElastoDyn 11 PitchDOF False PitchDOF - Blade pitch DOF (flag)
ElastoDyn 70 PtfmRefxt 0 PtfmRefxt - Downwind distance from the ground level [onshore], MSL [offshore wind or floating MHK], or seabed [fixed MHK] to the platform reference point (meters)
ElastoDyn 71 PtfmRefyt 0 PtfmRefyt - Lateral distance from the ground level [onshore], MSL [offshore wind or floating MHK], or seabed [fixed MHK] to the platform reference point (meters)
ElastoDyn 77 PBrIner(1) 200 PBrIner(1) - Pitch bearing/actuator inertia, blade 1 (kg m^2)
ElastoDyn 78 PBrIner(2) 200 PBrIner(2) - Pitch bearing/actuator inertia, blade 2 (kg m^2)
ElastoDyn 79 PBrIner(3) 200 PBrIner(3) - Pitch bearing/actuator inertia, blade 3 (kg m^2) [unused for 2 blades]
ElastoDyn 80 BlPIner(1) 28578 BlPIner(1) - Pitch inertia of an undeflected blade, blade 1 (kg m^2)
ElastoDyn 81 BlPIner(2) 28578 BlPIner(2) - Pitch inertia of an undeflected blade, blade 2 (kg m^2)
ElastoDyn 82 BlPIner(3) 28578 BlPIner(3) - Pitch inertia of an undeflected blade, blade 3 (kg m^2) [unused for 2 blades]
BeamDyn 10 ------ Modal Damping [used only if damp_type=2] --------------------------------
BeamDyn 11 n_modes 3 n_modes - Number of modal damping coefficients (-)
BeamDyn 12 zeta 0.1, 0.2, 0.3 zeta - Damping coefficients for mode 1 through n_modes
BeamDyn blade file 10 ------ Modal Damping [used only if damp_type=2] --------------------------------
BeamDyn blade file 11 n_modes 3 n_modes - Number of modal damping coefficients (-)
BeamDyn blade file 12 zeta 0.1, 0.2, 0.3 zeta - Damping coefficients for mode 1 through n_modes
ServoDyn 9 PitNeut(1) 0 PitNeut(1) - Blade 1 neutral pitch position--pitch spring moment is zero at this position *[unused when* **PCMode>0** and **t>=TPCOn** *]*
ServoDyn 10 PitNeut(2) 0 PitNeut(2) - Blade 2 neutral pitch position--pitch spring moment is zero at this position *[unused when* **PCMode>0** and **t>=TPCOn** *]*
ServoDyn 11 PitNeut(3) 0 PitNeut(3) - Blade 3 neutral pitch position--pitch spring moment is zero at this position *[unused when* **PCMode>0** and **t>=TPCOn** *]* *[unused for 2 blades]*
Expand All @@ -82,12 +87,15 @@ FAST.Farm 36 WindDirPrefix "inf
FAST.Farm 37 DirStartIndex 00110 DirStartIndex - AMReX sub-volume directory suffix to consider as time=0 (quoted string)
FAST.Farm 38 DT_Low-AMReX 2.0 DT_Low-AMReX - Time step for low-resolution wind data interpolation; will be used as the global FAST.Farm time step (s) [>0.0]
FAST.Farm 39 DT_High-AMReX 1.0 DT_High-AMReX - Time step for high-resolution wind data interpolation (s) [>0.0]
FAST.Farm 50 NumDFull DEFAULT NumDFull - Distance of full wake propagation, expressed as a multiple of RotorDiamRef [>0.0] or DEFAULT [DEFAULT=15]
FAST.Farm 51 NumDBuff DEFAULT NumDBuff - Length of wake propagation buffer region, expressed as a multiple of RotorDiamRef [>=0.0] or DEFAULT [DEFAULT=5]
SoilDyn all New module
============================================= ======== ==================== ========================================================================================================================================================================================================



============================================= ======== ==================== ========================================================================================================================================================================================================
Modified in OpenFAST `dev`
Modified in OpenFAST `5.0.0`
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Module Line Flag Name Example Value
============================================= ======== ==================== ========================================================================================================================================================================================================
Expand All @@ -104,7 +112,7 @@ AeroDyn \* (m)


============================================= ======== ==================== ========================================================================================================================================================================================================
Removed in OpenFAST `dev`
Removed in OpenFAST `5.0.0`
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Module Line Flag Name Example Value
============================================= ======== ==================== ========================================================================================================================================================================================================
Expand All @@ -115,8 +123,15 @@ BeamDyn \* PitchJ 200
BeamDyn \* PitchK 20000000 PitchK - Pitch actuator stiffness (kg-m^2/s^2) [used only when UsePitchAct is true]
BeamDyn \* PitchC 500000 PitchC - Pitch actuator damping (kg-m^2/s) [used only when UsePitchAct is true]
ElastoDyn Blade Input File \* The PitchAxis column has been removed from the DISTRIBUTED BLADE PROPERTIES table. The table should now only have 5 columns: BlFract, StrcTwst, BMassDen, FlpStff, and EdgStff
FAST.Farm 50 NumPlanes 140 NumPlanes - Number of wake planes (-) [>=2]
============================================= ======== ==================== ========================================================================================================================================================================================================

New Modules in v5.0.0
~~~~~~~~~~~~~~~~~~~~~

- SoilDyn -- a soil interaction module specifically designed to work with the RedWin DLL from NGI for soil interaction. Documentation for this module is limited.



OpenFAST v4.2.0 to OpenFAST v4.2.1
----------------------------------
Expand Down
2 changes: 1 addition & 1 deletion glue-codes/python/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "pyOpenFAST"
version = "4.2.1"
version = "5.0.0"
description = "Python interface to OpenFAST FAST Library and physics modules."
readme = "README.md"
requires-python = ">=3.9"
Expand Down
2 changes: 1 addition & 1 deletion openfast_io/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ build-backend = "hatchling.build"
[project]
name = "openfast_io"
# dynamic = ["version"]
version = "4.2.1"
version = "5.0.0"
description = "Readers and writers for OpenFAST files."
license = {file = "../LICENSE"}
authors = [
Expand Down
Loading