Merge pull request #1386 from OpenFAST/dev

OpenFAST v3.4.0

.github/actions/tests-module-aerodyn/action.yml

@@ -18,7 +18,7 @@ runs:
         fi
 
         if [[ ${{ inputs.test-target }} == "regression" ]] || [[ ${{ inputs.test-target }} == "all" ]]; then
-          ctest -VV -R ad_  #  -j7  do not run these tests in parallel due to a bug in accessing shared files
+          ctest -VV -R ad_ -LE python  #  -j7  do not run these tests in parallel due to a bug in accessing shared files
         fi
 
       working-directory: ${{runner.workspace}}/openfast/build

.github/actions/tests-module-moordyn/action.yml

@@ -0,0 +1,21 @@
+name: 'MoorDyn module tests'
+description: 'Run tests specific to the MoorDyn module'
+author: 'Andy Platt https://github.com/andrew-platt'
+
+
+inputs:
+  test-target:
+    description: 'Which tests to run: unit | regression | all'
+    default: 'all'
+
+runs:
+  using: "composite"
+  steps: 
+    - run: |
+
+        if [[ ${{ inputs.test-target }} == "regression" ]] || [[ ${{ inputs.test-target }} == "all" ]]; then
+          ctest -VV -j7 -R md_ -LE python
+        fi
+
+      working-directory: ${{runner.workspace}}/openfast/build
+      shell: bash

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

@@ -46,7 +46,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install numpy "Bokeh>=2.4"
+          pip install numpy "Bokeh>=2.4,!=3.0.0,!=3.0.1,!=3.0.2,!=3.0.3"
       - name: Setup workspace
         run: cmake -E make_directory ${{runner.workspace}}/openfast/build
       - name: Configure build
@@ -100,7 +100,6 @@ jobs:
             -DVARIABLE_TRACKING=OFF \
             -DDOUBLE_PRECISION:BOOL=OFF \
             ${GITHUB_WORKSPACE}
-            # -DDOUBLE_PRECISION=OFF \
       - name: Build all
         working-directory: ${{runner.workspace}}/openfast/build
         run: |
@@ -123,7 +122,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install numpy "Bokeh>=2.4"
+          pip install numpy "Bokeh>=2.4,!=3.0.0,!=3.0.1,!=3.0.2,!=3.0.3"
       - name: Setup workspace
         run: cmake -E make_directory ${{runner.workspace}}/openfast/build
       - name: Configure build
@@ -165,7 +164,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install numpy "Bokeh>=2.4"
+          pip install numpy "Bokeh>=2.4,!=3.0.0,!=3.0.1,!=3.0.2,!=3.0.3"
           sudo apt-get update -y
           sudo apt-get install -y libhdf5-dev libopenmpi-dev libyaml-cpp-dev  # gcovr
       - name: Setup workspace
@@ -215,7 +214,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install numpy "Bokeh>=2.4"
+          pip install numpy "Bokeh>=2.4,!=3.0.0,!=3.0.1,!=3.0.2,!=3.0.3"
           sudo apt-get update -y
           sudo apt-get install -y libhdf5-dev libopenmpi-dev libyaml-cpp-dev
       - name: Build OpenFAST C-Interfaces
@@ -224,6 +223,8 @@ jobs:
           cmake --build . --target openfastlib -- -j ${{env.NUM_PROCS}}
           cmake --build . --target openfast_cpp -- -j ${{env.NUM_PROCS}}
           cmake --build . --target openfastcpp -- -j ${{env.NUM_PROCS}}
+          cmake --build . --target aerodyn_inflow_c_binding -- -j ${{env.NUM_PROCS}}
+          cmake --build . --target moordyn_c_binding -- -j ${{env.NUM_PROCS}}
           cmake --build . --target ifw_c_binding -- -j ${{env.NUM_PROCS}}
           cmake --build . --target hydrodyn_c_binding -- -j ${{env.NUM_PROCS}}
           cmake --build . --target regression_test_controllers -- -j ${{env.NUM_PROCS}}
@@ -251,7 +252,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install numpy "Bokeh>=2.4"
+          pip install numpy "Bokeh>=2.4,!=3.0.0,!=3.0.1,!=3.0.2,!=3.0.3"
           sudo apt-get update -y
           sudo apt-get install -y libhdf5-dev libopenmpi-dev libyaml-cpp-dev
       - name: Build OpenFAST glue-code
@@ -282,7 +283,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install numpy "Bokeh>=2.4"
+          pip install numpy "Bokeh>=2.4,!=3.0.0,!=3.0.1,!=3.0.2,!=3.0.3"
           sudo apt-get update -y
           sudo apt-get install -y libhdf5-dev libopenmpi-dev libyaml-cpp-dev
       - name: Build FAST.Farm
@@ -296,6 +297,65 @@ jobs:
           key: build-fastfarm-release-${{ github.sha }}
 
 
+
+  ### BUILD AND TEST JOBS
+
+  build-test-uadriver-debug:
+    # UA driver requires -DUA_OUTS, cannot be compiled with other
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@main
+        with:
+          submodules: recursive
+      - name: Setup Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: '3.9'
+          cache: 'pip'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install numpy "Bokeh>=2.4,!=3.0.0,!=3.0.1,!=3.0.2,!=3.0.3"
+      - name: Setup workspace
+        run: cmake -E make_directory ${{runner.workspace}}/openfast/build
+      - name: Configure build
+        working-directory: ${{runner.workspace}}/openfast/build
+        run: |
+          cmake \
+            -DCMAKE_INSTALL_PREFIX:PATH=${{runner.workspace}}/openfast/install \
+            -DCMAKE_Fortran_COMPILER:STRING=${{env.FORTRAN_COMPILER}} \
+            -DCMAKE_CXX_COMPILER:STRING=${{env.CXX_COMPILER}} \
+            -DCMAKE_C_COMPILER:STRING=${{env.C_COMPILER}} \
+            -DCMAKE_BUILD_TYPE:STRING=DEBUG \
+            -DBUILD_SHARED_LIBS:BOOL=OFF \
+            -DGENERATE_TYPES=ON \
+            -DVARIABLE_TRACKING=OFF \
+            -DBUILD_TESTING:BOOL=ON \
+            -DCTEST_PLOT_ERRORS:BOOL=ON \
+            -DCMAKE_Fortran_FLAGS="-DUA_OUTS=ON" \
+            ${GITHUB_WORKSPACE}
+      - name: Build all
+        working-directory: ${{runner.workspace}}/openfast/build
+        run: |
+          cmake --build . --target unsteadyaero_driver -- -j ${{env.NUM_PROCS}}
+
+      - name: Run UnsteadyAero tests
+        working-directory: ${{runner.workspace}}/openfast/build
+        shell: bash
+        run: |
+          ctest -VV -R "^ua_" 
+
+      - name: Failing test artifacts
+        uses: actions/upload-artifact@v3
+        if: failure()
+        with:
+          name: rtest-uadriver
+          path: |
+            ${{runner.workspace}}/openfast/build/reg_tests/modules/unsteadyaero
+
+
+
   ### TEST JOBS
 
   rtest-module-drivers:
@@ -315,7 +375,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install numpy "Bokeh>=2.4"
+          pip install numpy "Bokeh>=2.4,!=3.0.0,!=3.0.1,!=3.0.2,!=3.0.3"
           sudo apt-get update -y
           sudo apt-get install -y libhdf5-dev libopenmpi-dev libyaml-cpp-dev
       - name: Run AeroDyn tests
@@ -332,6 +392,8 @@ jobs:
         uses: ./.github/actions/tests-module-inflowwind
         with:
           test-target: regression
+      - name: Run MoorDyn tests
+        uses: ./.github/actions/tests-module-moordyn
       - name: Run SubDyn tests
         uses: ./.github/actions/tests-module-subdyn
       - name: Failing test artifacts
@@ -360,7 +422,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install numpy "Bokeh>=2.4"
+          pip install numpy "Bokeh>=2.4,!=3.0.0,!=3.0.1,!=3.0.2,!=3.0.3"
           sudo apt-get update -y
           sudo apt-get install -y libhdf5-dev libopenmpi-dev libyaml-cpp-dev
       - name: Configure Tests
@@ -382,6 +444,8 @@ jobs:
         uses: ./.github/actions/tests-module-hydrodyn
       - name: Run InflowWind tests
         uses: ./.github/actions/tests-module-inflowwind
+      - name: Run MoorDyn tests
+        uses: ./.github/actions/tests-module-moordyn
       - name: Run NWTC Library tests
         uses: ./.github/actions/tests-module-nwtclibrary
       - name: Run SubDyn tests
@@ -415,7 +479,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install numpy "Bokeh>=2.4"
+          pip install numpy "Bokeh>=2.4,!=3.0.0,!=3.0.1,!=3.0.2,!=3.0.3" vtk
           sudo apt-get update -y
           sudo apt-get install -y libhdf5-dev libopenmpi-dev libyaml-cpp-dev
       - name: Run Interface / API tests
@@ -430,6 +494,8 @@ jobs:
           path: |
             ${{runner.workspace}}/openfast/build/reg_tests/glue-codes/openfast-cpp
             ${{runner.workspace}}/openfast/build/reg_tests/glue-codes/python
+            ${{runner.workspace}}/openfast/build/reg_tests/modules/aerodyn
+            ${{runner.workspace}}/openfast/build/reg_tests/modules/moordyn
             ${{runner.workspace}}/openfast/build/reg_tests/modules/inflowwind
             ${{runner.workspace}}/openfast/build/reg_tests/modules/hydrodyn
             !${{runner.workspace}}/openfast/build/reg_tests/glue-codes/openfast-cpp/5MW_Baseline
@@ -452,7 +518,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install numpy "Bokeh>=2.4"
+          pip install numpy "Bokeh>=2.4,!=3.0.0,!=3.0.1,!=3.0.2,!=3.0.3"
           sudo apt-get update -y
           sudo apt-get install -y libhdf5-dev libopenmpi-dev libyaml-cpp-dev
       - name: Configure Tests
@@ -499,7 +565,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install numpy "Bokeh>=2.4"
+          pip install numpy "Bokeh>=2.4,!=3.0.0,!=3.0.1,!=3.0.2,!=3.0.3"
           sudo apt-get update -y
           sudo apt-get install -y libhdf5-dev libopenmpi-dev libyaml-cpp-dev
       - name: Configure Tests
@@ -543,7 +609,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install numpy "Bokeh>=2.4"
+          pip install numpy "Bokeh>=2.4,!=3.0.0,!=3.0.1,!=3.0.2,!=3.0.3"
           sudo apt-get update -y
           sudo apt-get install -y libhdf5-dev libopenmpi-dev libyaml-cpp-dev
       - name: Configure Tests
@@ -587,7 +653,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install numpy "Bokeh>=2.4"
+          pip install numpy "Bokeh>=2.4,!=3.0.0,!=3.0.1,!=3.0.2,!=3.0.3"
           sudo apt-get update -y
           sudo apt-get install -y libhdf5-dev libopenmpi-dev libyaml-cpp-dev
       - name: Configure Tests
@@ -631,7 +697,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install numpy "Bokeh>=2.4"
+          pip install numpy "Bokeh>=2.4,!=3.0.0,!=3.0.1,!=3.0.2,!=3.0.3"
           sudo apt-get update -y
           sudo apt-get install -y libhdf5-dev libopenmpi-dev libyaml-cpp-dev
       - name: Configure Tests
@@ -675,7 +741,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install numpy "Bokeh>=2.4"
+          pip install numpy "Bokeh>=2.4,!=3.0.0,!=3.0.1,!=3.0.2,!=3.0.3"
           sudo apt-get update -y
           sudo apt-get install -y libhdf5-dev libopenmpi-dev libyaml-cpp-dev
       - name: Configure Tests
@@ -719,7 +785,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install numpy "Bokeh>=2.4"
+          pip install numpy "Bokeh>=2.4,!=3.0.0,!=3.0.1,!=3.0.2,!=3.0.3"
           sudo apt-get update -y
           sudo apt-get install -y libhdf5-dev libopenmpi-dev libyaml-cpp-dev
       - name: Configure Tests
@@ -763,7 +829,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install numpy "Bokeh>=2.4"
+          pip install numpy "Bokeh>=2.4,!=3.0.0,!=3.0.1,!=3.0.2,!=3.0.3"
           sudo apt-get update -y
           sudo apt-get install -y libhdf5-dev libopenmpi-dev libyaml-cpp-dev
       - name: Configure Tests
@@ -774,11 +840,12 @@ jobs:
         working-directory: ${{runner.workspace}}/openfast/build
         shell: bash
         run: |
-          ctest -VV -L fastfarm -j ${{env.NUM_PROCS}}
+          set OMP_NUM_THREADS=2
+          ctest -VV -L fastfarm -j ${{env.NUM_PROCS}} --verbose
       - name: Failing test artifacts
         uses: actions/upload-artifact@v3
         if: failure()
         with:
           name: rtest-FF
           path: |
-            ${{runner.workspace}}/openfast/build/reg_tests/glue-codes/fastfarm
+            ${{runner.workspace}}/openfast/build/reg_tests/glue-codes/fast-farm

docs/OtherSupporting/OpenFAST_Algorithms/OpenFAST_Algorithms.tex

@@ -215,6 +215,7 @@ \section{Input-Output Relationships}
                                       & \mathit{y\_SD},  \mathit{u\_SD\_tmp},  \\  
                                       & \mathit{y\_MAP}, \mathit{u\_MAP\_tmp}, \\ 
                                       & \mathit{y\_FEAM},\mathit{u\_FEAM\_tmp},\\
+                                      & \mathit{y\_AD},  \mathit{u\_AD\_tmp}\footnote{Only if AD buoyancy at of hub enabled.},  \\  
                                       & \mathit{y\_SrvD},\mathit{u\_SrvD\_tmp}\footnote{Only if using ServoDyn Structural control.} )    % SrvD%PtfmStC only
                      \end{aligned}$
 

docs/conf.py

@@ -120,17 +120,17 @@ def runDoxygen(sourcfile, doxyfileIn, doxyfileOut):
 
 # General information about the project.
 project = u'OpenFAST'
-copyright = u'2022, National Renewable Energy Laboratory'
+copyright = u'2023, National Renewable Energy Laboratory'
 author = u'OpenFAST Team'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = u'3.3'
+version = u'3.4'
 # The full version, including alpha/beta/rc tags.
-release = u'v3.3.0'
+release = u'v3.4.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -274,4 +274,24 @@ def setup(app):
         objname="CMake configuration value",
         indextemplate="pair: %s; CMake configuration"
     )
+# --- Prolog that will be included at the top of every rst file
+# Here: defining the role :red: for html and latex
+rst_prolog = r"""
+
+.. raw:: html
+
+    <style> .red {color:#ff0000} </style>
+
+.. raw:: latex
+
+
+    \makeatletter
+     \@ifundefined{DUrolered}{%
+       \newcommand{\DUrolered}[1]{{\color{red}{#1}}}
+     }{}
+    \makeatother
+
+.. role:: red
+
+"""
 

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

@@ -5,11 +5,12 @@ Using the Aeroacoustics Model in AeroDyn
 
 A live version of this documentation is available at
 https://openfast.readthedocs.io/. To run the aeroacoustics model, the
-flag **CompAA** needs to be set to **True** at line 13 of the AeroDyn15 main
+flag **CompAA** needs to be set to **True** at line 14 of the AeroDyn15 main
 input file in the inputs block **General Options**. When the flag is set to
 **True**, the following line must include the name of the file containing
 the inputs to the aeroacoustics model, which is discussed in
-:numref:`aa-sec-BLinputs`.
+:numref:`aa-sec-MainInput`. Currently, this module cannot be used with an MHK
+turbine.
 
 
 .. container::

docs/source/user/aerodyn-aeroacoustics/example/AD15.ipt

@@ -2,17 +2,18 @@
 IEA Wind Task 37 land-based reference wind turbine
 ====== General Options ===================================================
 False          Echo        - Echo the input to "<rootname>.AD.ech"? (flag)
-"default"      DT_AA       - Time interval for aerodynamic calculations {or "default"} (s)
+"default"      DTAero      - Time interval for aerodynamic calculations {or "default"} (s)
 1              WakeMod     - Type of wake/induction model (switch) {0=none, 1=BEMT}
 2              AFAeroMod   - Type of blade airfoil aerodynamics model (switch
 0              TwrPotent   - Type of tower influence on wind around the tower (switch)
 0              TwrShadow   - Type of tower influence on wind based on downstream tower shadow (switch) {0=none, 1=Powles model, 2=Eames model}
 False          TwrAero     - Calculate tower aerodynamic loads? (flag)
 False          FrozenWake  - Assume frozen wake during linearization? (flag
 False          CavitCheck  - Perform cavitation check? (flag)
+False          Buoyancy    - Include buoyancy effects? (flag)
 True           CompAA      - Flag to compute AeroAcoustics calculation
 "AeroAcousticsInput.dat"   AA_InputFile
 ====== Environmental Conditions ==========================================
-1.225.         AirDens     - Air density (kg/m^3)
+"default"      AirDens     - Air density (kg/m^3)
 
 File continues...