Wake-added turbulence in FAST.Farm

docs/source/user/api_change.rst

@@ -17,18 +17,30 @@ The HydroDyn module was split into HydroDyn and SeaState.  This results in a
 completely new input file for SeaState, and complete revision of the HydroDyn
 input file.  See examples in the regression tests for the new formats.
 
-============================================= ==== ==================== ========================================================================================================================================================================================================
+============================================= ======= ==================== ========================================================================================================================================================================================================
 Modified in OpenFAST `dev`
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-Module                                        Line  Flag Name           Example Value
-============================================= ==== ==================== ========================================================================================================================================================================================================
-HydroDyn                                       all                      Complete restructuring of input file
-SeaState                                       all                      New module (split from HydroDyn, so contains some inputs previously found in HydroDyn)
-SubDyn                                        56\*                                            ----------------------- SPRING ELEMENT PROPERTIES -------------------------------------
-SubDyn                                        57\* NSpringPropSets  0                         - Number of spring properties
-SubDyn                                        58\*                                            PropSetID   k11     k12     k13     k14     k15     k16     k22     k23     k24     k25     k26     k33     k34     k35     k36     k44      k45      k46      k55      k56      k66
-SubDyn                                        59\*                                            (-)      (N/m)   (N/m)   (N/m)  (N/rad) (N/rad) (N/rad)  (N/m)   (N/m)  (N/rad) (N/rad) (N/rad)  (N/m)  (N/rad) (N/rad) (N/rad) (Nm/rad) (Nm/rad) (Nm/rad) (Nm/rad) (Nm/rad) (Nm/rad)   
-============================================= ==== ==================== ========================================================================================================================================================================================================
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+Module                                        Line    Flag Name            Example Value
+============================================= ======= ==================== ========================================================================================================================================================================================================
+HydroDyn                                       all                         Complete restructuring of input file
+SeaState                                       all                         New module (split from HydroDyn, so contains some inputs previously found in HydroDyn)
+SubDyn                                        56\*                                             ----------------------- SPRING ELEMENT PROPERTIES -------------------------------------
+SubDyn                                        57\*    NSpringPropSets  0                         - Number of spring properties
+SubDyn                                        58\*                                             PropSetID   k11     k12     k13     k14     k15     k16     k22     k23     k24     k25     k26     k33     k34     k35     k36     k44      k45      k46      k55      k56      k66
+SubDyn                                        59\*                                             (-)      (N/m)   (N/m)   (N/m)  (N/rad) (N/rad) (N/rad)  (N/m)   (N/m)  (N/rad) (N/rad) (N/rad)  (N/m)  (N/rad) (N/rad) (N/rad) (Nm/rad) (Nm/rad) (Nm/rad) (Nm/rad) (Nm/rad) (Nm/rad)  
+FAST.Farm                                     47      RotorDiamRef         125           RotorDiamRef       - Reference turbine rotor diameter for wake calculations (m) [>0.0]
+FAST.Farm                                     57      k_vAmb               DEFAULT       k_vAmb        - Calibrated parameters for the influence of the ambient turbulence in the eddy viscosity (set of 5 parameters: k, FMin, DMin, DMax, Exp) (-) [>=0.0, >=0.0 and <=1.0, >=0.0, >DMin, >0.0] or DEFAULT [DEFAULT=0.05, 1.0, 0.0, 1.0, 0.01]
+FAST.Farm                                     58      kvShr                DEFAULT       k_vShr        - Calibrated parameters for the influence of the shear layer in the eddy viscosity (set of 5 parameters: k, FMin, DMin, DMax, Exp) (-) [>=0.0, >=0.0 and <=1.0, >=0.0, >DMin, >0.0] or DEFAULT [DEFAULT=0.016, 0.2, 3.0, 25.0, 0.1]
+FAST.Farm                                     59-66   --removed--
+FAST.Farm                                     71                           --- WAKE-ADDED TURBULENCE ---
+FAST.Farm                                     72       WAT                 2                  WAT                - Switch between wake-added turbulence box options {0: no wake added turbulence, 1: predefined turbulence box, 2: user defined turbulence box} (switch)
+FAST.Farm                                     73       WAT_BoxFile         "../WAT_MannBoxDB/FFDB_D100_512x512x64.u" WAT_BoxFile  - Filepath to the file containing the u-component of the turbulence box (either predefined or user-defined) (quoted string)
+FAST.Farm                                     74       WAT_NxNyNz          512, 512, 64       WAT_NxNyNz         - Number of points in the x, y, and z directions of the WAT_BoxFile [used only if WAT=2, derived value if WAT=1] (-)
+FAST.Farm                                     75       WAT_DxDyDz          5.0, 5.0, 5.0      WAT_DxDyDz         - Distance (in meters) between points in the x, y, and z directions of the WAT_BoxFile [used only if WAT=2, derived value if WAT=1] (m)
+FAST.Farm                                     76       WAT_ScaleBox        default            WAT_ScaleBox       - Flag to scale the input turbulence box to zero mean and unit standard deviation at every node [DEFAULT=False] (flag)
+FAST.Farm                                     77       WAT_k_Def           default            WAT_k_Def          - Calibrated parameters for the influence of the maximum wake deficit on wake-added turbulence (set of 5 parameters: k_Def, FMin, DMin, DMax, Exp) (-) [>=0.0, >=0.0 and <=1.0, >=0.0, >DMin, >0.0] or DEFAULT [DEFAULT=[0.6, 0.0, 0.0, 2.0, 1.0 ]]
+FAST.Farm                                     78       WAT_k_Grad          default            WAT_k_Grad         - Calibrated parameters for the influence of the radial velocity gradient of the wake deficit on wake-added turbulence (set of 5 parameters: k_Grad, FMin, DMin, DMax, Exp) (-) [>=0.0, >=0.0 and <=1.0, >=0.0, >DMin, >0.0] or DEFAULT [DEFAULT=[3.0, 0.0, 0.0, 12.0, 0.65]                   
+============================================= ======= ==================== ========================================================================================================================================================================================================
 
 \*Exact line number depends on number of entries in various preceeding tables.