Tight-Coupling Algorithm for OpenFAST 5.0

.gitmodules

@@ -1,3 +1,4 @@
 [submodule "reg_tests/r-test"]
 	path = reg_tests/r-test
-	url = https://github.com/OpenFAST/r-test.git
+	url = https://github.com/OpenFAST/r-test.git
+	shallow = true

cmake/OpenfastFortranOptions.cmake

@@ -139,6 +139,10 @@ macro(set_fast_gfortran)
     set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS},--stack,${stack_size}")
   endif()
 
+  # Profiling
+  # set(CMAKE_Fortran_FLAGS "${CMAKE_Fortran_FLAGS} -pg")
+  # set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -pg")
+
   check_f2008_features()
 endmacro(set_fast_gfortran)
 
@@ -158,7 +162,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 +207,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)

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)
+

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.

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
 ------------------------------------

docs/source/user/aerodyn-aeroacoustics/02-noise-models.rst

@@ -151,8 +151,8 @@ The formulations of :math:`{\overline{D}}_{h}\ `\ and
 :math:`{\overline{D}}_{l}` are presented in :numref:`aa-directivity`.
 
 The current implementation offers two approaches to estimate
-:math:`I_{1}`. The first one is through a user-defined grid of
-:math:`I_{1}`; see :numref:`aa-sec-TIgrid`. The second option is to have the code
+:math:`I_{1}`. The first one is through a user-defined :math:`I_{1}`. 
+The second option is to have the code
 reconstructing :math:`I_{1}` from the turbulent wind grid, where the
 code computes the airfoil relative position of each blade section,
 :math:`i`, at every time instant and, given the rotor speed,

docs/source/user/aerodyn-aeroacoustics/App-usage.rst

@@ -56,12 +56,14 @@ models:
 
 -  **TICalcMeth** – Integer 1/2: flag to set the calculation method for the
    incident turbulence intensity. When set to 1, incident turbulence intensity is
-   defined in a user-defined grid; see :numref:`aa-sec-TIgrid`. When set to
-   2, incident turbulence intensity is estimated from the time history of the
-   incident flow.
+   user-defined. When set to 2, incident turbulence intensity is 
+   estimated from the time history of the incident flow.
 
--  **TICalcTabFile** – String: name of the text file with the user-defined
-   turbulence intensity grid; see :numref:`aa-sec-TIgrid`.
+-  **TI** – Float: user-defined value of :math:`TI`, which is the rotor-incident
+   turbulence intensity used in the Amiet model.
+
+-  **avgV** – Float: value of the average wind speed used to scale :math:`TI`
+   and convert it to a blade section incident turbulence intensity.
 
 -  **Lturb** – Float: value of :math:`L_{turb}` used to estimate the turbulent
    lengthscale used in the Amiet model.
@@ -255,32 +257,5 @@ is shown here:
       :language: none
 
 
-.. _aa-sec-TIgrid:
-
-Turbulence Grid
----------------
-
-When the flag **TICalcMeth** is set equal to 1, the grid of turbulence
-intensity of the wind :math:`TI` must be defined by the user. This is
-done by creating a file called **TIGrid_In.txt**, which mimics a TurbSim
-output file and contains a grid of turbulence intensity, which is
-defined as a fraction value. The file defines a grid centered at hub
-height and oriented with the OpenFAST global inertial frame coordinate
-system; see :numref:`aa-fig:ObsRefSys`. A user-defined number of lateral and vertical
-points equally spaced by a user-defined number of meters must be
-specified. Note that an average wind speed must be defined to convert
-the turbulence intensity of the wind to the incident turbulent intensity :math:`I_{1}`.
-An example file for a 160 (lateral) by 180 (vertical) meters
-grid looks like the following:
-
-
-.. container::
-   :name: aa-tab:TIgrid
-
-   .. literalinclude:: example/TIGrid.txt
-      :linenos:
-      :language: none
-
-
 .. [4]
    https://github.com/OpenFAST/python-toolbox

docs/source/user/aerodyn-aeroacoustics/example/AeroAcousticsInput.dat

@@ -8,8 +8,9 @@ False        Echo         - Echo the input to "<rootname>.AD.NN.ech"?  (flag)
 ======  Aeroacoustic Models  ============================================================================
 2            TIMod        - Turbulent Inflow noise model  {0: none, 1: Amiet 2: Amiet + Simplified Guidati} (switch) 
 1            TICalcMeth   - Method to estimate turbulence intensity incident to the profile {1: given table, 2: computed on the fly} (switch) [Only used if TIMod!=0]
-"TIGrid_InVerify.txt"   TICalcTabFile - Name of the file containing the table for incident turbulence intensity (-) [Only used if TiCalcMeth == 1]
-0.5          SurfRoughness- Surface roughness value used to estimate the turbulent length scale in Amiet model (m)
+0.1          TI           - Rotor-incident wind turbulence intensity (-) [Only used if TiCalcMeth == 1]
+8            avgV         - Average wind speed used to compute the section-incident turbulence intensity (m/s) [Only used if TiCalcMeth == 1]
+40           Lturb        - Turbulent length scale in Amiet model (m) [Only used if TIMod!=0]
 1            TBLTEMod     - Turbulent Boundary Layer-Trailing Edge noise calculation {0: none, 1:BPM, 2: TNO} (switch)
 1            BLMod        - Calculation method for boundary layer properties,  {1: BPM, 2: Pretabulated} (switch)
 1            TripMod      - Boundary layer trip model {0:no trip, 1: heavy trip, 2: light trip} (switch) [Only used if BLMod=1]
@@ -18,9 +19,6 @@ False        Echo         - Echo the input to "<rootname>.AD.NN.ech"?  (flag)
 True         RoundedTip   - Logical indicating rounded tip (flag) [Only used if TipMod=1]
 1.0          Alprat       - Tip lift curve slope (Default = 1.0) [Only used if TipMod=1]
 0            BluntMod     - Trailing-edge-bluntness – Vortex-shedding model {0:none, 1: BPM}  (switch)
-"AABlade1.dat"    AABlFile(1)   - Name of file containing distributed aerodynamic properties for Blade #1 (-)
-"AABlade1.dat"    AABlFile(2)   - Name of file containing distributed aerodynamic properties for Blade #2 (-)
-"AABlade1.dat"    AABlFile(3)   - Name of file containing distributed aerodynamic properties for Blade #3 (-)
 ======  Observer Input  ===================================================================
 "AA_ObserverLocations.dat"    ObserverLocations        - Name of file containing all observer locations X Y Z (-)
 ======  Outputs  ====================================================================================

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
@@ -29,6 +29,8 @@ OpenFAST                                      15      CompAero\**          2   C
 OpenFAST                                      13      CompElast            3   CompElast       - Compute structural dynamics (switch) {1=ElastoDyn; 2=ElastoDyn + BeamDyn for blades; 3=Simplified ElastoDyn}
 AeroDyn                                       40      IntegrationMethod    3   IntegrationMethod  - Switch to indicate which integration method UA uses (1=RK4, 2=AB4, 3=ABM4, 4=BDF2)
 AeroDyn                                       140\*   BldNd_BlOutNd        "All"  BldNd_BlOutNd   - Specify a portion of the nodes to output. {"ALL", "Tip", "Root", or a list of node numbers} (-)
+AeroDyn Aeroacoustics                         11\*    TI                   0.1 TI   - Rotor-incident wind turbulence intensity (-) [Only used if TiCalcMeth == 1]
+AeroDyn Aeroacoustics                         12\*    avgV                 8 avgV   - Average wind speed used to compute the section-incident turbulence intensity (m/s) [Only used if TiCalcMeth == 1]
 ElastoDyn blade file                          15                           Removal of the `PitchAxis` input column
 HydroDyn                                       all                         Complete restructuring of input file
 SeaState                                       all                         New module (split from HydroDyn, so contains some inputs previously found in HydroDyn)
@@ -104,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