Docs: update example InflowWind and FAST.Farm input files

OpenFAST · Jan 10, 2023 · caa74f4 · caa74f4
1 parent c51790c
commit caa74f4
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 7 deletions.
diff --git a/docs/source/user/fast.farm/examples/FAST.Farm--input.dat b/docs/source/user/fast.farm/examples/FAST.Farm--input.dat
@@ -15,8 +15,9 @@ False         UseSC                 - Use a super controller? (flag)
 0.04	      DT_Mooring            - Time step for farm-level mooring coupling with each turbine (s) [used only when Mod_SharedMooring > 0]
 --- AMBIENT WIND: PRECURSOR IN VTK FORMAT --- [used only for Mod_AmbWind=1]
 2.0           DT_Low-VTK            - Time step for low-resolution wind data input files; will be used as the global FAST.Farm time step (s) [>0.0]
-0.5           DT_High-VTK           - Time step for high-resolution wind data input files (s) [>0.0] "/AmbWind/steady" WindFilePath Path name to wind data files from precursor (string)
-False         ChkWndFiles           - Check all the ambient wind files for data consistency (flag)
+0.5           DT_High-VTK           - Time step for high-resolution wind data input files (s) [>0.0]
+"unused"           WindFilePath       - Path name to VTK wind data files from precursor (string)
+False         ChkWndFiles           - Check all the ambient wind files for data consistency? (flag)
 --- AMBIENT WIND: INFLOWWIND MODULE --- [used only for Mod_AmbWind=2 or 3]
 2.0           DT_Low                - Time step for low-resolution wind data interpolation; will be used as the global FAST.Farm time step (s) [>0.0]
 0.5           DT_High               - Time step for high-resolution wind data interpolation (s) [>0.0]

diff --git a/docs/source/user/inflowwind/examples/inflowwind_driver_example.inp b/docs/source/user/inflowwind/examples/inflowwind_driver_example.inp
@@ -7,6 +7,7 @@ InflowWind driver input file.
  false         WrHAWC         -- Convert all data to HAWC2 format? (flag)
  false         WrBladed       -- Convert all data to Bladed format? (flag)
  false         WrVTK          -- Convert all data to VTK format? (flag)
+ false         WrUniform      -- Convert data to Uniform wind format? (flag)
 =====================  Tests of Interpolation Options =========================
    DEFAULT     NumTSteps      -- number of timesteps to run (DEFAULT for all) (-)
    0.0         TStart         -- Start time (s)

diff --git a/docs/source/user/inflowwind/examples/inflowwind_example.dat b/docs/source/user/inflowwind/examples/inflowwind_example.dat
@@ -14,8 +14,8 @@ False         Echo           - Echo input data to <RootName>.ech (flag)
          90   RefHt          - Reference height for horizontal wind speed      (m)
         0.2   PLexp          - Power law exponent                              (-)
 ================== Parameters for Uniform wind file   [used only for WindType = 2] ============================
-"Wind/90m_12mps_twr.hh"    Filename       - Filename of time series data for uniform wind field.      (-)
-         90   RefHt          - Reference height for horizontal wind speed                (m)
+"Wind/90m_12mps_twr.hh"    FileName_Uni       - Filename of time series data for uniform wind field.      (-)
+         90   RefHt_Uni      - Reference height for horizontal wind speed                (m)
      125.88   RefLength      - Reference length for linear horizontal and vertical sheer (-)
 ================== Parameters for Binary TurbSim Full-Field files   [used only for WindType = 3] ==============
 "Wind/90m_12mps_twr.bts"    Filename       - Name of the Full field wind file to use (.bts)
@@ -32,7 +32,7 @@ False         TowerFile      - Have tower file (.twr) (flag) ignored when WindTy
          16   dx             - distance (in meters) between points in the x direction    (m)
           3   dy             - distance (in meters) between points in the y direction    (m)
           3   dz             - distance (in meters) between points in the z direction    (m)
-         90   RefHt          - reference height; the height (in meters) of the vertical center of the grid (m)
+         90   RefHt_HAWC     - reference height; the height (in meters) of the vertical center of the grid (m)
   -------------   Scaling parameters for turbulence   ---------------------------------------------------------
           2   ScaleMethod    - Turbulence scaling method   [0 = none, 1 = direct scaling, 2 = calculate scaling factor based on a desired standard deviation]
           1   SFx            - Turbulence scaling factor for the x direction (-)   [ScaleMethod=1]
@@ -44,9 +44,9 @@ False         TowerFile      - Have tower file (.twr) (flag) ignored when WindTy
   -------------   Mean wind profile parameters (added to HAWC-format files)   ---------------------------------
          12   URef           - Mean u-component wind speed at the reference height (m/s)
           2   WindProfile    - Wind profile type (0=constant;1=logarithmic,2=power law)
-        0.2   PLExp          - Power law exponent (-) (used for PL wind profile type only)
+        0.2   PLExp_HAWC     - Power law exponent (-) (used for PL wind profile type only)
        0.03   Z0             - Surface roughness length (m) (used for LG wind profile type only)
-         0    InitPosition(x) - Initial offset in +x direction (shift of wind box)
+         0    XOffset        - Initial offset in +x direction (shift of wind box)
 ====================== OUTPUT ==================================================
 False         SumPrint     - Print summary data to <RootName>.IfW.sum (flag)
               OutList      - The next line(s) contains a list of output parameters.  See OutListParameters.xlsx for a listing of available output channels, (-)