Merge pull request #2572 from OpenFAST/rc-3.5.5

Release 3.5.5

Author: andrew-platt

.github/workflows/automated-dev-tests.yml

@@ -198,6 +198,7 @@ jobs:
             -DVARIABLE_TRACKING=OFF \
             -DBUILD_FASTFARM:BOOL=ON \
             -DBUILD_OPENFAST_CPP_API:BOOL=ON \
+            -DBUILD_OPENFAST_LIB_DRIVER:BOOL=ON \
             -DBUILD_OPENFAST_CPP_DRIVER:BOOL=ON \
             -DBUILD_SHARED_LIBS:BOOL=OFF \
             -DBUILD_TESTING:BOOL=ON \
@@ -242,7 +243,7 @@ jobs:
       - name: Build OpenFAST C-Interfaces
         working-directory: ${{runner.workspace}}/openfast/build
         run: |
-          cmake --build . --target openfastlib openfast_cpp_driver openfastcpp aerodyn_inflow_c_binding moordyn_c_binding ifw_c_binding hydrodyn_c_binding regression_test_controllers
+          cmake --build . --target openfastlib openfast_lib_driver openfastcpp aerodyn_inflow_c_binding moordyn_c_binding ifw_c_binding hydrodyn_c_binding regression_test_controllers
       - name: Cache the workspace
         uses: actions/cache@v4
         with:

.github/workflows/build-docker-image-manual.yml

@@ -20,9 +20,9 @@ jobs:
     timeout-minutes: 300
     env:
       DOCKERFILE_PATH: share/docker/Dockerfile
-      DOCKERFILE_PERMALINK: https://raw.githubusercontent.com/OpenFAST/openfast/main/share/docker/Dockerfile
+      DOCKERFILE_PERMALINK: https://raw.githubusercontent.com/openfast/openfast/main/share/docker/Dockerfile
       DOCKERHUB_REPOSITORY: nrel/openfast
-      GH_REGISTRY: ghcr.io/OpenFAST/openfast
+      GH_REGISTRY: ghcr.io/openfast/openfast
     permissions:
       contents: read
       packages: write

.github/workflows/deploy.yml

@@ -41,7 +41,7 @@ jobs:
     env:
       DOCKERFILE_PATH: share/docker/Dockerfile
       DOCKERHUB_REPOSITORY: nrel/openfast
-      GH_REGISTRY: ghcr.io/OpenFAST/openfast
+      GH_REGISTRY: ghcr.io/openfast/openfast
     permissions:
       contents: read
       packages: write
@@ -68,7 +68,11 @@ jobs:
 
       - name: Extract tag from release candidate branch name
         id: extract-tag
-        run: echo "openfast-tag=$(expr substr "${{ github.head_ref }}" 4 100)" >> $GITHUB_OUTPUT
+        run: |
+          TAG="${{ github.event.release.tag_name }}"
+          CLEAN_TAG="${TAG#v}"
+          echo "openfast-tag=$CLEAN_TAG" >> $GITHUB_OUTPUT
+          echo "Extracted tag  $CLEAN_TAG"
 
       - name: Build and push to registry
         uses: docker/build-push-action@v5
@@ -77,7 +81,7 @@ jobs:
           file: ${{ env.DOCKERFILE_PATH }}
           platforms: linux/amd64,linux/aarch64
           tags: |
-            ${{ env.GH_REGISTRY }}:${{ steps.extract-tag.outputs.openfast-tag }},${{ env.DOCKERHUB_REPOSITORY }}:latest
+            ${{ env.GH_REGISTRY }}:${{ steps.extract-tag.outputs.openfast-tag }},${{ env.GH_REGISTRY }}:latest
 # ${{ env.DOCKERHUB_REPOSITORY }}:${{ steps.extract-tag.outputs.openfast-tag }},${{ env.DOCKERHUB_REPOSITORY }}:latest
           push: true
           cache-from: type=gha

CMakeLists.txt

@@ -44,7 +44,8 @@ option(FPE_TRAP_ENABLED "Enable FPE trap in compiler options" off)
 option(ORCA_DLL_LOAD "Enable OrcaFlex Library Load" on)
 option(BUILD_FASTFARM "Enable building FAST.Farm" off)
 option(BUILD_OPENFAST_CPP_API "Enable building OpenFAST - C++ API" off)
-option(BUILD_OPENFAST_CPP_DRIVER "Enable building OpenFAST C++ driver using C++ API" off)
+option(BUILD_OPENFAST_CPP_DRIVER "Enable building OpenFAST C++ driver using C++ CFD API" off)
+option(BUILD_OPENFAST_LIB_DRIVER "Enable building OpenFAST driver using C++ Library API" off)
 option(BUILD_OPENFAST_SIMULINK_API "Enable building OpenFAST for use with Simulink" off)
 option(OPENMP "Enable OpenMP support" off)
 option(USE_LOCAL_STATIC_LAPACK "Enable downloading and building static LAPACK and BLAS libs" off)
@@ -232,8 +233,8 @@ endforeach(IDIR IN ITEMS ${OPENFAST_MODULES})
 add_subdirectory(glue-codes)
 
 # Install fortran .mod files also to installation directory
-install(DIRECTORY ${CMAKE_Fortran_MODULE_DIRECTORY}/
-  DESTINATION ${CMAKE_INSTALL_PREFIX}/include/openfast/
+install(DIRECTORY ${CMAKE_Fortran_MODULE_DIRECTORY}
+  DESTINATION include/openfast/
   FILES_MATCHING PATTERN "*.mod"
 )
 

docs/changelogs/v3.5.5.md

@@ -0,0 +1,107 @@
+**Feature or improvement description**
+Pull request to merge `rc-3.5.5` into `main` and create a tagged release for v3.5.5.
+
+See the milestone and project pages for additional information
+
+    https://github.com/OpenFAST/openfast/milestone/15
+
+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 multiple small bug-fixes for compilation with CMake, compilation with the IFX compilers, file opening issues when OpenMP is used, and a couple of infrequent segmentation faults from improper usage.  One minor feature improvement is the increase in the number of output planes available in _FAST.Farm_ from 99 to 999.
+
+We recommend all users currently using any 3.5.x version to update to this version. There are no input files changes or API changes for calling from other codes since version 3.5.0.
+
+
+
+## General
+
+### Build systems
+
+#2497 `CMAKE_INSTALL_PREFIX` was incorrectly being prepended to the install direcotry (@deslaughter) Derek Slaughter
+
+#2564 Create `BUILD_OPENFAST_LIB_DRIVER` flag for the OpenFAST C++ Library Interface (not CFD) (@deslaughter)
+
+
+### Docker
+
+#2498 Docker: typo was preventing docker build upload to GH (@andrew-platt)
+
+
+
+## Solvers
+
+### FAST.Farm
+
+#2536 FAST.Farm: increase number of output planes to 999 (@andrew-platt)
+
+#2554 Add `!$OMP critical` directives around some `GetNewUnit/Open*File` to reduce probability of file unit conflicts (@andrew-platt)
+
+#2569 Disable LiDAR in IfW at FAST.Farm level (@andrew-platt)
+
+
+## Module changes
+
+### AeroDyn
+
+#2501 Remove `$OMP` directives from `AeroDyn_Inflow` due to Intel compiler bug (@deslaughter)
+
+#2516 AD bugfix: Segmentation fault with ifx compiler (@andrew-platt)
+
+
+### InflowWind
+
+#2518, #2530 ADI bugfix: BoxExceed was not enabled for OLAF with ADI (@andrew-platt)
+
+#2532 bugfix: IfW rotor points for disk average incorrect (@andrew-platt)
+
+
+### NWTC-Library
+
+#2558 Allow ParseVar to parse file paths containing spaces. (@deslaughter)
+
+
+
+
+## Input file changes
+
+No input files change with this release as this only includes minor bugfixes (input files are identical across all 3.5.x releases).
+
+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.5 (example input files from the regression testing)
+

docs/conf.py

@@ -130,7 +130,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.4'
+release = u'v3.5.5'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/source/user/api_change.rst

@@ -9,6 +9,12 @@ 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 v3.5.4 to OpenFAST v3.5.5 
+----------------------------------
+
+No input file changes were made.
+
+
 OpenFAST v3.5.3 to OpenFAST v3.5.4 
 ----------------------------------
 

glue-codes/fast-farm/src/FAST_Farm_Subs.f90

@@ -44,7 +44,7 @@ MODULE FAST_Farm_Subs
 
 
    integer, parameter :: maxOutputPoints = 9
-   integer, parameter :: maxOutputPlanes = 99      ! Allow up to 99 outpt planes
+   integer, parameter :: maxOutputPlanes = 999     ! Allow up to 999 outpt planes
 
    CONTAINS
 
@@ -1140,7 +1140,7 @@ SUBROUTINE Farm_ReadPrimaryFile( InputFile, p, WD_InitInp, AWAE_InitInp, SC_Init
       end if
 
       ! NOutDisWindXY - Number of XY planes for output of disturbed wind data across the low-resolution domain to <OutFileRoot>.Low.DisXY.<n_out>.t<n/n_low-out>.vtk (-) [0 to 9]:
-   CALL ReadVar( UnIn, InputFile, AWAE_InitInp%NOutDisWindXY, "NOutDisWindXY", "Number of XY planes for output of disturbed wind data across the low-resolution domain to <OutFileRoot>.Low.DisXY.<n_out>.t<n/n_low-out>.vtk (-) [0 to 99]", ErrStat2, ErrMsg2, UnEc)
+   CALL ReadVar( UnIn, InputFile, AWAE_InitInp%NOutDisWindXY, "NOutDisWindXY", "Number of XY planes for output of disturbed wind data across the low-resolution domain to <OutFileRoot>.Low.DisXY.<n_out>.t<n/n_low-out>.vtk (-) [0 to 999]", ErrStat2, ErrMsg2, UnEc)
       CALL SetErrStat( ErrStat2, ErrMsg2, ErrStat, ErrMsg, RoutineName)
       if ( ErrStat >= AbortErrLev ) then
          call cleanup()
@@ -1163,7 +1163,7 @@ SUBROUTINE Farm_ReadPrimaryFile( InputFile, p, WD_InitInp, AWAE_InitInp, SC_Init
       end if
 
       ! NOutDisWindYZ - Number of YZ planes for output of disturbed wind data across the low-resolution domain to <OutFileRoot>.Low.DisYZ.<n_out>.t<n/n_low-out>.vtk (-) [0 to 9]:
-   CALL ReadVar( UnIn, InputFile, AWAE_InitInp%NOutDisWindYZ, "NOutDisWindYZ", "Number of YZ planes for output of disturbed wind data across the low-resolution domain to <OutFileRoot>.Low.DisYZ.<n_out>.t<n/n_low-out>.vtk (-) [0 to 99]", ErrStat2, ErrMsg2, UnEc)
+   CALL ReadVar( UnIn, InputFile, AWAE_InitInp%NOutDisWindYZ, "NOutDisWindYZ", "Number of YZ planes for output of disturbed wind data across the low-resolution domain to <OutFileRoot>.Low.DisYZ.<n_out>.t<n/n_low-out>.vtk (-) [0 to 999]", ErrStat2, ErrMsg2, UnEc)
       CALL SetErrStat( ErrStat2, ErrMsg2, ErrStat, ErrMsg, RoutineName)
       if ( ErrStat >= AbortErrLev ) then
          call cleanup()
@@ -1186,7 +1186,7 @@ SUBROUTINE Farm_ReadPrimaryFile( InputFile, p, WD_InitInp, AWAE_InitInp, SC_Init
       end if      
 
       ! NOutDisWindXZ - Number of XZ planes for output of disturbed wind data across the low-resolution domain to <OutFileRoot>.Low/DisXZ.<n_out>.t<n/n_low-out>.vtk (-) [0 to 9]:
-   CALL ReadVar( UnIn, InputFile, AWAE_InitInp%NOutDisWindXZ, "NOutDisWindXZ", "Number of XZ planes for output of disturbed wind data across the low-resolution domain to <OutFileRoot>.Low/DisXZ.<n_out>.t<n/n_low-out>.vtk (-) [0 to 99]", ErrStat2, ErrMsg2, UnEc)
+   CALL ReadVar( UnIn, InputFile, AWAE_InitInp%NOutDisWindXZ, "NOutDisWindXZ", "Number of XZ planes for output of disturbed wind data across the low-resolution domain to <OutFileRoot>.Low/DisXZ.<n_out>.t<n/n_low-out>.vtk (-) [0 to 999]", ErrStat2, ErrMsg2, UnEc)
       CALL SetErrStat( ErrStat2, ErrMsg2, ErrStat, ErrMsg, RoutineName)
       if ( ErrStat >= AbortErrLev ) then
          call cleanup()
@@ -1546,9 +1546,9 @@ SUBROUTINE Farm_ValidateInput( p, WD_InitInp, AWAE_InitInp, SC_InitInp, ErrStat,
    AWAE_InitInp%WrDisDT =  p%DT_low * n_disDT_dt
 
 
-   if (AWAE_InitInp%NOutDisWindXY < 0 .or. AWAE_InitInp%NOutDisWindXY > maxOutputPlanes ) CALL SetErrStat( ErrID_Fatal, 'NOutDisWindXY must be in the range [0, 99].', ErrStat, ErrMsg, RoutineName )
-   if (AWAE_InitInp%NOutDisWindYZ < 0 .or. AWAE_InitInp%NOutDisWindYZ > maxOutputPlanes ) CALL SetErrStat( ErrID_Fatal, 'NOutDisWindYZ must be in the range [0, 99].', ErrStat, ErrMsg, RoutineName )
-   if (AWAE_InitInp%NOutDisWindXZ < 0 .or. AWAE_InitInp%NOutDisWindXZ > maxOutputPlanes ) CALL SetErrStat( ErrID_Fatal, 'NOutDisWindXZ must be in the range [0, 99].', ErrStat, ErrMsg, RoutineName )
+   if (AWAE_InitInp%NOutDisWindXY < 0 .or. AWAE_InitInp%NOutDisWindXY > maxOutputPlanes ) CALL SetErrStat( ErrID_Fatal, 'NOutDisWindXY must be in the range [0, 999].', ErrStat, ErrMsg, RoutineName )
+   if (AWAE_InitInp%NOutDisWindYZ < 0 .or. AWAE_InitInp%NOutDisWindYZ > maxOutputPlanes ) CALL SetErrStat( ErrID_Fatal, 'NOutDisWindYZ must be in the range [0, 999].', ErrStat, ErrMsg, RoutineName )
+   if (AWAE_InitInp%NOutDisWindXZ < 0 .or. AWAE_InitInp%NOutDisWindXZ > maxOutputPlanes ) CALL SetErrStat( ErrID_Fatal, 'NOutDisWindXZ must be in the range [0, 999].', ErrStat, ErrMsg, RoutineName )
    if (p%NOutDist < 0 .or. p%NOutDist > maxOutputPoints ) then
       CALL SetErrStat( ErrID_Fatal, 'NOutDist must be in the range [0, 9].', ErrStat, ErrMsg, RoutineName )
    else

glue-codes/openfast/CMakeLists.txt

@@ -33,11 +33,11 @@ endif()
 install(TARGETS openfast
   RUNTIME DESTINATION bin)
 
-if(BUILD_OPENFAST_CPP_DRIVER)
-  add_executable(openfast_cpp_driver src/FAST_Prog.cpp src/FastLibAPI.cpp)
-  target_link_libraries(openfast_cpp_driver openfastlib)
+if(BUILD_OPENFAST_LIB_DRIVER)
+  add_executable(openfast_lib_driver src/FAST_Prog.cpp src/FastLibAPI.cpp)
+  target_link_libraries(openfast_lib_driver openfastlib)
 
-  install(TARGETS openfast_cpp_driver
+  install(TARGETS openfast_lib_driver
     RUNTIME DESTINATION bin)
 endif()