Skip to content

Commit e1225c8

Browse files
authored
Merge pull request OpenFAST#3262 from andrew-platt/r/5.0.0_releaseNotes
release notes for v5.0.0
2 parents b110881 + edb7d1f commit e1225c8

11 files changed

+401
-22
lines changed
Binary file not shown.
Binary file not shown.
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
2026.03.12
2+
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.
2 MB
Binary file not shown.
187 KB
Binary file not shown.

docs/changelogs/v5.0.0.md

Lines changed: 362 additions & 0 deletions
Large diffs are not rendered by default.

docs/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -137,9 +137,9 @@ def runDoxygen(sourcfile, doxyfileIn, doxyfileOut):
137137
# built documents.
138138
#
139139
# The short X.Y version.
140-
version = f'4.2'
140+
version = f'5.0'
141141
# The full version, including alpha/beta/rc tags.
142-
release = f'v4.2.1'
142+
release = f'v5.0.0'
143143

144144
# The language for content autogenerated by Sphinx. Refer to documentation
145145
# for a list of supported languages.

docs/source/user/api_change.rst

Lines changed: 33 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ The changes are tabulated according to the module input file, line number, and f
99
The line number corresponds to the resulting line number after all changes are implemented.
1010
Thus, be sure to implement each in order so that subsequent line numbers are correct.
1111

12-
OpenFAST v4.1.2 to OpenFAST dev
13-
----------------------------------
12+
OpenFAST v4.2.x to OpenFAST v5.0.0
13+
-----------------------------------
1414

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

3232
============================================= ======== ==================== ========================================================================================================================================================================================================
33-
Added in OpenFAST `dev`
33+
Added in OpenFAST `5.0.0`
3434
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
3535
Module Line Flag Name Example Value
3636
============================================= ======== ==================== ========================================================================================================================================================================================================
37-
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}
38-
OpenFAST 20 CompSoil 0 CompSoil - Compute soil-structural dynamics (switch) {0=None; 1=SoilDyn}
37+
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}
38+
OpenFAST 11 RhoInf 1.0 RhoInf - Numerical damping parameter for tight coupling generalized-alpha integrator (-) [0.0 to 1.0]
39+
OpenFAST 12 ConvTol 1e-4 ConvTol - Convergence iteration error tolerance for tight coupling generalized alpha integrator (-)
40+
OpenFAST 13 MaxConvIter 6 MaxConvIter - Maximum number of convergence iterations for tight coupling generalized alpha integrator (-)
3941
OpenFAST 17 NRotors 2 NRotors - Number of rotors in turbine (-)
40-
OpenFAST 28 MirrorRotor F MirrorRotor - Flag to reverse rotor rotation direction [1 to NRotors] {F=Normal, T=Mirror}
41-
OpenFAST 45 SoilFile "SoilDyn.dat" SoilFile - Name of the file containing the SoilDyn input parameters (quoted string)
42-
OpenFAST 52 ---------------------- INPUT FILES Rotor 2 -------------------------------------
43-
OpenFAST 53 EDFile "ElastoDyn.dat" EDFile - Name of file containing ElastoDyn input parameters (quoted string)
44-
OpenFAST 54 BDBldFile(1) "BeamDyn.dat" BDBldFile(1) - Name of file containing BeamDyn input parameters for blade 1 (quoted string)
45-
OpenFAST 55 BDBldFile(2) "BeamDyn.dat" BDBldFile(2) - Name of file containing BeamDyn input parameters for blade 2 (quoted string)
46-
OpenFAST 56 BDBldFile(3) "BeamDyn.dat" BDBldFile(3) - Name of file containing BeamDyn input parameters for blade 3 (quoted string)
47-
OpenFAST 57 ServoFile "ServoDyn_R2.dat" ServoFile - Name of file containing control and electrical-drive input parameters (quoted string)
42+
OpenFAST 20 CompSoil 0 CompSoil - Compute soil-structural dynamics (switch) {0=None; 1=SoilDyn}
43+
OpenFAST 29 MirrorRotor F MirrorRotor - Flag to reverse rotor rotation direction [1 to NRotors] {F=Normal, T=Mirror}
44+
OpenFAST 53 SoilFile "SoilDyn.dat" SoilFile - Name of the file containing the SoilDyn input parameters (quoted string)
45+
OpenFAST 54 ---------------------- INPUT FILES Rotor 2 -------------------------------------
46+
OpenFAST 55 EDFile "ElastoDyn.dat" EDFile - Name of file containing ElastoDyn input parameters (quoted string)
47+
OpenFAST 56 BDBldFile(1) "BeamDyn.dat" BDBldFile(1) - Name of file containing BeamDyn input parameters for blade 1 (quoted string)
48+
OpenFAST 57 BDBldFile(2) "BeamDyn.dat" BDBldFile(2) - Name of file containing BeamDyn input parameters for blade 2 (quoted string)
49+
OpenFAST 58 BDBldFile(3) "BeamDyn.dat" BDBldFile(3) - Name of file containing BeamDyn input parameters for blade 3 (quoted string)
50+
OpenFAST 59 ServoFile "ServoDyn_R2.dat" ServoFile - Name of file containing control and electrical-drive input parameters (quoted string)
4851
AeroDyn blade file t_c 0.8651 [additional column in *Blade Properties* table]
4952
AeroDyn blade file BlCpn 1.0 [additional column in *Blade Properties* table]
5053
AeroDyn blade file BlCpt 1.0 [additional column in *Blade Properties* table]
@@ -58,15 +61,17 @@ AeroDyn \* TwrCp 1.0
5861
AeroDyn \* TwrCa 1.0 [additional column in *Tower Influence and Aerodynamics* table]
5962
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)
6063
ElastoDyn 11 PitchDOF False PitchDOF - Blade pitch DOF (flag)
64+
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)
65+
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)
6166
ElastoDyn 77 PBrIner(1) 200 PBrIner(1) - Pitch bearing/actuator inertia, blade 1 (kg m^2)
6267
ElastoDyn 78 PBrIner(2) 200 PBrIner(2) - Pitch bearing/actuator inertia, blade 2 (kg m^2)
6368
ElastoDyn 79 PBrIner(3) 200 PBrIner(3) - Pitch bearing/actuator inertia, blade 3 (kg m^2) [unused for 2 blades]
6469
ElastoDyn 80 BlPIner(1) 28578 BlPIner(1) - Pitch inertia of an undeflected blade, blade 1 (kg m^2)
6570
ElastoDyn 81 BlPIner(2) 28578 BlPIner(2) - Pitch inertia of an undeflected blade, blade 2 (kg m^2)
6671
ElastoDyn 82 BlPIner(3) 28578 BlPIner(3) - Pitch inertia of an undeflected blade, blade 3 (kg m^2) [unused for 2 blades]
67-
BeamDyn 10 ------ Modal Damping [used only if damp_type=2] --------------------------------
68-
BeamDyn 11 n_modes 3 n_modes - Number of modal damping coefficients (-)
69-
BeamDyn 12 zeta 0.1, 0.2, 0.3 zeta - Damping coefficients for mode 1 through n_modes
72+
BeamDyn blade file 10 ------ Modal Damping [used only if damp_type=2] --------------------------------
73+
BeamDyn blade file 11 n_modes 3 n_modes - Number of modal damping coefficients (-)
74+
BeamDyn blade file 12 zeta 0.1, 0.2, 0.3 zeta - Damping coefficients for mode 1 through n_modes
7075
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** *]*
7176
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** *]*
7277
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]*
@@ -82,12 +87,15 @@ FAST.Farm 36 WindDirPrefix "inf
8287
FAST.Farm 37 DirStartIndex 00110 DirStartIndex - AMReX sub-volume directory suffix to consider as time=0 (quoted string)
8388
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]
8489
FAST.Farm 39 DT_High-AMReX 1.0 DT_High-AMReX - Time step for high-resolution wind data interpolation (s) [>0.0]
90+
FAST.Farm 50 NumDFull DEFAULT NumDFull - Distance of full wake propagation, expressed as a multiple of RotorDiamRef [>0.0] or DEFAULT [DEFAULT=15]
91+
FAST.Farm 51 NumDBuff DEFAULT NumDBuff - Length of wake propagation buffer region, expressed as a multiple of RotorDiamRef [>=0.0] or DEFAULT [DEFAULT=5]
92+
SoilDyn all New module
8593
============================================= ======== ==================== ========================================================================================================================================================================================================
8694

8795

8896

8997
============================================= ======== ==================== ========================================================================================================================================================================================================
90-
Modified in OpenFAST `dev`
98+
Modified in OpenFAST `5.0.0`
9199
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
92100
Module Line Flag Name Example Value
93101
============================================= ======== ==================== ========================================================================================================================================================================================================
@@ -104,7 +112,7 @@ AeroDyn \* (m)
104112

105113

106114
============================================= ======== ==================== ========================================================================================================================================================================================================
107-
Removed in OpenFAST `dev`
115+
Removed in OpenFAST `5.0.0`
108116
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
109117
Module Line Flag Name Example Value
110118
============================================= ======== ==================== ========================================================================================================================================================================================================
@@ -115,8 +123,15 @@ BeamDyn \* PitchJ 200
115123
BeamDyn \* PitchK 20000000 PitchK - Pitch actuator stiffness (kg-m^2/s^2) [used only when UsePitchAct is true]
116124
BeamDyn \* PitchC 500000 PitchC - Pitch actuator damping (kg-m^2/s) [used only when UsePitchAct is true]
117125
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
126+
FAST.Farm 50 NumPlanes 140 NumPlanes - Number of wake planes (-) [>=2]
118127
============================================= ======== ==================== ========================================================================================================================================================================================================
119128

129+
New Modules in v5.0.0
130+
~~~~~~~~~~~~~~~~~~~~~
131+
132+
- SoilDyn -- a soil interaction module specifically designed to work with the RedWin DLL from NGI for soil interaction. Documentation for this module is limited.
133+
134+
120135

121136
OpenFAST v4.2.0 to OpenFAST v4.2.1
122137
----------------------------------

glue-codes/python/pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
44

55
[project]
66
name = "pyOpenFAST"
7-
version = "4.2.1"
7+
version = "5.0.0"
88
description = "Python interface to OpenFAST FAST Library and physics modules."
99
readme = "README.md"
1010
requires-python = ">=3.9"

0 commit comments

Comments
 (0)