Merge remote-tracking branch 'OpenFAST/dev' into f/ifw_driver_XYslice

andrew-platt · Nov 10, 2024 · c9d5bd5 · c9d5bd5
2 parents 627c93e + 024dbc1
commit c9d5bd5
Show file tree

Hide file tree

Showing 46 changed files with 1,266 additions and 759 deletions.
diff --git a/cmake/OpenfastFortranOptions.cmake b/cmake/OpenfastFortranOptions.cmake
@@ -158,7 +158,9 @@ endmacro(set_fast_intel_fortran)
 # arch
 #
 macro(set_fast_intel_fortran_posix)
-  set(CMAKE_Fortran_FLAGS "${CMAKE_Fortran_FLAGS} -fpic -fpp")
+  # Set size where temporary are stored on heap instead of stack
+  #   1000: size in kB (1 MB)
+  set(CMAKE_Fortran_FLAGS "${CMAKE_Fortran_FLAGS} -fpic -fpp -heap-arrays 1000")
 
   # debug flags
   if(CMAKE_BUILD_TYPE MATCHES Debug)
@@ -201,7 +203,9 @@ macro(set_fast_intel_fortran_windows)
   # Turn off specific warnings
   # - 5199: too many continuation lines
   # - 5268: 132 column limit
-  set(CMAKE_Fortran_FLAGS "${CMAKE_Fortran_FLAGS} /Qdiag-disable:5199,5268 /fpp")
+  # Set size where temporary are stored on heap instead of stack
+  #   1000: size in kB (1 MB)
+  set(CMAKE_Fortran_FLAGS "${CMAKE_Fortran_FLAGS} /Qdiag-disable:5199,5268 /fpp /heap-arrays:1000")
 
   # If double precision, make constants double precision
   if (DOUBLE_PRECISION)

diff --git a/docs/changelogs/v3.5.4.md b/docs/changelogs/v3.5.4.md
@@ -0,0 +1,96 @@
+**Feature or improvement description**
+Pull request to merge `rc-3.5.4` into `main` and create a tagged release for v3.5.4.
+
+See the milestone and project pages for additional information
+
+    https://github.com/OpenFAST/openfast/milestone/14
+
+Test results, if applicable
+See GitHub Actions
+
+### Release checklist:
+- [ ] Update the documentation version in docs/conf.py
+- [ ] Update the versions in docs/source/user/api_change.rst
+- [ ] Verify readthedocs builds correctly
+- [ ] Create a tag in OpenFAST
+- [ ] Create a merge commit in r-test and add a corresponding annotated tag
+- [ ] Compile executables for Windows builds
+    - [ ] AeroDyn_Driver_x64.exe
+    - [ ] AeroDyn_Driver_x64_OpenMP.exe
+    - [ ] AeroDyn_Inflow_C_Binding_x64.dll
+    - [ ] AeroDyn_Inflow_C_Binding_x64_OpenMP.dll
+    - [ ] BeamDyn_Driver_x64.exe
+    - [ ] DISCON.dll (x64)
+    - [ ] DISCON_ITIBarge.dll (x64)
+    - [ ] DISCON_OC3Hywind.dll (x64)
+    - [ ] DISCON_SC.dll (x64)
+    - [ ] FAST.Farm_x64.exe
+    - [ ] FAST.Farm_x64_OMP.exe
+    - [ ] FAST_SFunc.mexw64
+    - [ ] HydroDynDriver_x64.exe
+    - [ ] HydroDyn_C_Binding_x64.dll
+    - [ ] IfW_C_Binding_x64.dll
+    - [ ] InflowWind_Driver_x64.exe
+    - [ ] InflowWind_Driver_x64_OpenMP.exe
+    - [ ] MoorDyn_Driver_x64.exe
+    - [ ] MoorDyn_C_Binding_x64.dll
+    - [ ] OpenFAST-Simulink_x64.dll
+    - [ ] openfast_x64.exe
+    - [ ] Turbsim_x64.exe
+
+# Changelog
+
+## Overview
+
+This release includes performance improvements for BeamDyn (up to 30% speed increase), python file readers and writers from WEIS, and a fix for stack overflows with FAST.Farm (Intel compilation).  A few other minor updates are included as outlined below.
+
+Anyone using BeamDyn will want to update to this version.
+
+
+## General
+
+### Build systems
+
+#2311 Always build `openfastcpplib` as shared. Use `BUILD_OPENFAST_CPP_DRIVER` to disable `openfastcpp` executable (@deslaughter)
+#2173 Fix crash in `MAP_End` when using Intel's new icx compiler and disable caching in setup-python GH action (@deslaughter)
+
+
+### Python file readers/writers
+
+#2188 Add WEIS file readers and writers (@cortadocodes and @mayankchetan)
+
+
+## Solvers
+
+### FAST.Farm
+
+#2452  Fix for some stack overflow issues with FAST.Farm when copying large amounts of wind data (closes #2053) (@andrew-platt)
+#2340  Add `!$ OMP critical` around file opening for VTK to prevent file collision (@andrew-platt)
+
+
+## Module changes
+
+### BeamDyn
+
+#2399 BeamDyn performance improvements (@deslaughter)
+
+
+### ElastoDyn
+
+#2321 Backport of #2317: Explicitly initialize `ED` `RtHS` to zero -- corrects issue with inccorect linearization results (@andrew-platt)
+
+
+### HydroDyn
+#2397 HD bug fix: prevent array index out-of-bound error in `HDOut_MapOutputs` when more than 9 potential-flow bodies are present (@luwang00)
+
+### NWTC-Library
+#2389 FileInfoType: increase line length allowed (@andrew-platt)
+
+## Input file changes
+
+No input files change with this release, as this only includes minor bugfixes.
+
+Full list of changes: https://openfast.readthedocs.io/en/main/source/user/api_change.html
+
+Full input file sets: https://github.com/OpenFAST/r-test/tree/v3.5.4 (example input files from the regression testing)
+
diff --git a/docs/conf.py b/docs/conf.py
@@ -138,7 +138,7 @@ def runDoxygen(sourcfile, doxyfileIn, doxyfileOut):
 # The short X.Y version.
 version = u'3.5'
 # The full version, including alpha/beta/rc tags.
-release = u'v3.5.3'
+release = u'v3.5.4'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/docs/source/install/index.rst b/docs/source/install/index.rst
@@ -162,7 +162,7 @@ containing the executables, and running a simple test command:
 
 Running OpenFAST with docker
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-OpenFAST is avilable to be run on docker starting with version 3.5.3. Three approaches are shared below.
+OpenFAST is available to be run on docker starting with version 3.5.3. Three approaches are shared below.
 
 Using a docker image from Docker hub
 ------------------------------------

diff --git a/docs/source/user/api_change.rst b/docs/source/user/api_change.rst
@@ -11,7 +11,7 @@ Thus, be sure to implement each in order so that subsequent line numbers are cor
 
 
 
-OpenFAST v3.5.3 to OpenFAST dev
+OpenFAST v3.5.4 to OpenFAST dev
 ----------------------------------
 
 The HydroDyn module was split into HydroDyn and SeaState.  This results in a
@@ -106,6 +106,10 @@ Old inputs                  Corresponding new inputs
 
 
 
+OpenFAST v3.5.3 to OpenFAST v3.5.4 
+----------------------------------
+
+No input file changes were made.
 
 
 OpenFAST v3.5.2 to OpenFAST v3.5.3 

diff --git a/docs/source/user/hydrodyn/appendix.rst b/docs/source/user/hydrodyn/appendix.rst
@@ -12,9 +12,13 @@ structure::
       False            Echo           - Echo the input file data (flag)
       ---------------------- FLOATING PLATFORM --------------------------------------- [unused with WaveMod=6]
                    1   PotMod         - Potential-flow model {0: none=no potential flow, 1: frequency-to-time-domain transforms based on WAMIT output, 2: fluid-impulse theory (FIT)} (switch)
-                   1   ExctnMod       - Wave-excitation model {0: no wave-excitation calculation, 1: DFT, 2: state-space} (switch) [only used when PotMod=1; STATE-SPACE REQUIRES *.ssexctn INPUT FILE]
+                   1   ExctnMod       - Wave-excitation model {0: no wave-excitation calculation, 1: DFT, 2: state-space} (switch) [only used when PotMod=1; STATE-SPACE REQUIRES *.ssexctn INPUT FILE; if PtfmYMod=1, need ExctnMod=0 or 1]
                    0   ExctnDisp      - Method of computing Wave Excitation {0: use undisplaced position, 1: use displaced position, 2: use low-pass filtered displaced position) [only used when PotMod=1 and ExctnMod>0 and SeaState's WaveMod>0]} (switch)
                   10   ExctnCutOff    - Cutoff (corner) frequency of the low-pass time-filtered displaced position (Hz) [>0.0] [used only when PotMod=1, ExctnMod>0, and ExctnDisp=2]) [only used when PotMod=1 and ExctnMod>0 and SeaState's WaveMod>0]} (switch)
+                   0   PtfmYMod       - Model for large platform yaw offset {0: Static reference yaw offset based on PtfmRefY, 1: dynamic reference yaw offset based on low-pass filtering the PRP yaw motion with cutoff frequency PtfmYCutOff} (switch)
+                   0   PtfmRefY       - Constant (if PtfmYMod=0) or initial (if PtfmYMod=1) platform reference yaw offset (deg)
+                0.01   PtfmYCutOff    - Cutoff frequency for the low-pass filtering of PRP yaw motion when PtfmYMod=1 [>0.0; unused when PtfmYMod=0] (Hz)
+                  36   NExctnHdg      - Number of evenly distributed platform yaw/heading angles over the range of [-180, 180) deg for which the wave excitation shall be computed [>=2; unused when PtfmYMod=0] (-)
                    1   RdtnMod        - Radiation memory-effect model {0: no memory-effect calculation, 1: convolution, 2: state-space} (switch) [only used when PotMod=1; STATE-SPACE REQUIRES *.ss INPUT FILE]
                   60   RdtnTMax       - Analysis time for wave radiation kernel calculations (sec) [only used when PotMod=1 and RdtnMod>0; determines RdtnDOmega=Pi/RdtnTMax in the cosine transform; MAKE SURE THIS IS LONG ENOUGH FOR THE RADIATION IMPULSE RESPONSE FUNCTIONS TO DECAY TO NEAR-ZERO FOR THE GIVEN PLATFORM!]
               0.0125   RdtnDT         - Time step for wave radiation kernel calculations (sec) [only used when PotMod=1 and ExctnMod>0 or RdtnMod>0; DT<=RdtnDT<=0.1 recommended; determines RdtnOmegaMax=Pi/RdtnDT in the cosine transform]
@@ -32,8 +36,8 @@ structure::
       ---------------------- 2ND-ORDER FLOATING PLATFORM FORCES ---------------------- [unused with WaveMod=0 or 6, or PotMod=0 or 2]
                    0   MnDrift        - Mean-drift 2nd-order forces computed                                       {0: None; [7, 8, 9, 10, 11, or 12]: WAMIT file to use} [Only one of MnDrift, NewmanApp, or DiffQTF can be non-zero. If NBody>1, MnDrift  /=8]
                    0   NewmanApp      - Mean- and slow-drift 2nd-order forces computed with Newman's approximation {0: None; [7, 8, 9, 10, 11, or 12]: WAMIT file to use} [Only one of MnDrift, NewmanApp, or DiffQTF can be non-zero. If NBody>1, NewmanApp/=8. Used only when WaveDirMod=0]
-                   0   DiffQTF        - Full difference-frequency 2nd-order forces computed with full QTF          {0: None; [10, 11, or 12]: WAMIT file to use}          [Only one of MnDrift, NewmanApp, or DiffQTF can be non-zero]
-                   0   SumQTF         - Full summation -frequency 2nd-order forces computed with full QTF          {0: None; [10, 11, or 12]: WAMIT file to use}
+                   0   DiffQTF        - Full difference-frequency 2nd-order forces computed with full QTF          {0: None; [10, 11, or 12]: WAMIT file to use}          [Only one of MnDrift, NewmanApp, or DiffQTF can be non-zero. If PtfmYMod=1, need DiffQTF=0]
+                   0   SumQTF         - Full summation -frequency 2nd-order forces computed with full QTF          {0: None; [10, 11, or 12]: WAMIT file to use}          [If PtfmYMod=1, need SumQTF=0]
       ---------------------- PLATFORM ADDITIONAL STIFFNESS AND DAMPING  -------------- [unused with PotMod=0 or 2]
                    0   AddF0    - Additional preload (N, N-m)  [If NBodyMod=1, one size 6*NBody x 1 vector; if NBodyMod>1, NBody size 6 x 1 vectors]
                    0
@@ -60,7 +64,7 @@ structure::
                    0             0             0             0             0             0
                    0             0             0             0             0             0
       ---------------------- STRIP THEORY OPTIONS --------------------------------------
-                   0   WaveDisp       - Method of computing Wave Kinematics {0: use undisplaced position, 1: use displaced position) } (switch)
+                   0   WaveDisp       - Method of computing Wave Kinematics {0: use undisplaced position, 1: use displaced position) } (switch) [If PtfmYMod=1, need WaveDisp=1]
                    0   AMMod          - Method of computing distributed added-mass force. (0: Only and always on nodes below SWL at the undisplaced position. 2: Up to the instantaneous free surface) [overwrite to 0 when WaveMod = 0 or 6 or when WaveStMod = 0 in SeaState]
       ---------------------- AXIAL COEFFICIENTS --------------------------------------
                    2   NAxCoef        - Number of axial coefficients (-)