TurbSim modifications

docs/source/user/api_change.rst

@@ -12,6 +12,13 @@ Thus, be sure to implement each in order so that subsequent line numbers are cor
 
 OpenFAST v3.0.0 to OpenFAST `dev`
 ---------------------------------
+============================================= ==== =============== ========================================================================================================================================================================================================
+Removed in OpenFAST dev
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+Module                                        Line  Flag Name        Example Value
+============================================= ==== =============== ========================================================================================================================================================================================================
+TurbSim                                       14   Clockwise        True           Clockwise       - Clockwise rotation looking downwind? (used only for full-field binary files - not necessary for AeroDyn)
+============================================= ==== =============== ========================================================================================================================================================================================================
 
 No change
 
@@ -46,6 +53,7 @@ OpenFAST                                      28   Patm            103500     Pa
 OpenFAST                                      29   Pvap            1700       Pvap              - Vapour pressure of working fluid (Pa) [used only for an MHK turbine cavitation check]
 OpenFAST                                      30   WtrDpth         50         WtrDpth           - Water depth (m)
 OpenFAST                                      31   MSL2SWL         0          MSL2SWL           - Offset between still-water level and mean sea level (m) [positive upward]
+TurbSim                                       13   WrHAWCFF        False      WrHAWCFF          - Output full-field time-series data in HAWC form?  (Generates RootName-u.bin, RootName-v.bin, RootName-w.bin, RootName.hawc)
 AeroDyn 15                                    40   UAStartRad      0.25       UAStartRad        - Starting radius for dynamic stall (fraction of rotor radius) [used only when AFAeroMod=2; if line is missing UAStartRad=0]
 AeroDyn 15                                    41   UAEndRad        0.95       UAEndRad          - Ending radius for dynamic stall (fraction of rotor radius) [used only when AFAeroMod=2; if line is missing UAEndRad=1]
 AeroDyn driver                                34   Twr2Shft        3.09343    Twr2Shft          - Vertical distance from the tower-top to the rotor shaft (m)

docs/source/user/index.rst

@@ -53,6 +53,7 @@ Documentation covers usage of models, underlying theory, and in some cases modul
    InflowWind <inflowwind/index.rst>
    ServoDyn <servodyn/index.rst>
    Structural Control <servodyn-stc/StC_index.rst>
+   TurbSim <turbsim/index.rst>
    C++ API <cppapi/index.rst>
    FAST.Farm <fast.farm/index.rst>
 

docs/source/user/turbsim/appendix.rst

@@ -0,0 +1,27 @@
+.. _TurbSim_appendix:
+
+Appendix
+========
+
+.. _TurbSim_input_files:
+
+TurbSim Input Files
+-------------------
+
+
+1) Primary TurbSim Input Files:
+:download:`(TurbSim input file example) <examples/TurbSim.inp>`:
+
+This is the primary input file for TurbSim. Most simulations will require only this file. 
+
+
+2) TurbSim secondary input files for user-defined input
+
+Input files that can be specified in the primary input file to import user-defined data.
+
+:download:`(user-defined profiles example) <examples/TurbSim_User.profiles>`:
+
+:download:`(user-defined spectra example) <examples/TurbSim_User.spectra>`:
+
+:download:`(user-defined time-series example) <examples/TurbSim_User.timeSeriesInput>`: 
+

docs/source/user/turbsim/examples/TurbSim.inp

@@ -0,0 +1,74 @@
+---------TurbSim v2 (OpenFAST) Input File------------------
+for Certification Test #5 (SMOOTH Spectrum, formatted FF files, Coherent Structures).
+---------Runtime Options-----------------------------------
+False         Echo            - Echo input data to <RootName>.ech (flag)
+4433456       RandSeed1       - First random seed  (-2147483648 to 2147483647)
+"RanLux"      RandSeed2       - Second random seed (-2147483648 to 2147483647) for intrinsic pRNG, or an alternative pRNG: "RanLux" or "RNSNLW"
+False         WrBHHTP         - Output hub-height turbulence parameters in binary form?  (Generates RootName.bin)
+False         WrFHHTP         - Output hub-height turbulence parameters in formatted form?  (Generates RootName.dat)
+False         WrADHH          - Output hub-height time-series data in AeroDyn form?  (Generates RootName.hh)
+True          WrADFF          - Output full-field time-series data in TurbSim/AeroDyn form? (Generates RootName.bts)
+False         WrBLFF          - Output full-field time-series data in BLADED/AeroDyn form?  (Generates RootName.wnd)
+False         WrADTWR         - Output tower time-series data? (Generates RootName.twr)
+False         WrHAWCFF        - [Envision addition] Output full-field time-series data in HAWC form?  (Generates RootName-u.bin, RootName-v.bin, RootName-w.bin, RootName.hawc)
+False         WrFMTFF         - Output full-field time-series data in formatted (readable) form?  (Generates RootName.u, RootName.v, RootName.w)
+False         WrACT           - Output coherent turbulence time steps in AeroDyn form? (Generates RootName.cts)
+          0   ScaleIEC        - Scale IEC turbulence models to exact target standard deviation? [0=no additional scaling; 1=use hub scale uniformly; 2=use individual scales]
+
+--------Turbine/Model Specifications-----------------------
+         31   NumGrid_Z       - Vertical grid-point matrix dimension
+         31   NumGrid_Y       - Horizontal grid-point matrix dimension
+       0.05   TimeStep        - Time step [seconds]
+        600   AnalysisTime    - Length of analysis time series [seconds] (program will add time if necessary: AnalysisTime = MAX(AnalysisTime, UsableTime+GridWidth/MeanHHWS) )
+"ALL"         UsableTime      - Usable length of output time series [seconds] (program will add GridWidth/MeanHHWS seconds unless UsableTime is "ALL")
+         90   HubHt           - Hub height [m] (should be > 0.5*GridHeight)
+         70   GridHeight      - Grid height [m]
+         70   GridWidth       - Grid width [m] (should be >= 2*(RotorRadius+ShaftLength))
+          0   VFlowAng        - Vertical mean flow (uptilt) angle [degrees]
+          0   HFlowAng        - Horizontal mean flow (skew) angle [degrees]
+
+--------Meteorological Boundary Conditions-------------------
+"IECKAI"      TurbModel       - Turbulence model ("IECKAI","IECVKM","GP_LLJ","NWTCUP","SMOOTH","WF_UPW","WF_07D","WF_14D","TIDAL","API","USRINP","USRVKM","TIMESR", or "NONE")
+"TurbSim_User.spectra", "TurbSim_User.timeSeriesInput"    UserFile  - Name of the file that contains inputs for user-defined spectra or time series inputs (used only for "USRINP" and "TIMESR" models)
+          1   IECstandard     - Number of IEC 61400-x standard (x=1,2, or 3 with optional 61400-1 edition number (i.e. "1-Ed2") )
+"A"           IECturbc        - IEC turbulence characteristic ("A", "B", "C" or the turbulence intensity in percent) ("KHTEST" option with NWTCUP model, not used for other models)
+"NTM"         IEC_WindType    - IEC turbulence type ("NTM"=normal, "xETM"=extreme turbulence, "xEWM1"=extreme 1-year wind, "xEWM50"=extreme 50-year wind, where x=wind turbine class 1, 2, or 3)
+"default"     ETMc            - IEC Extreme Turbulence Model "c" parameter [m/s]
+"default"     WindProfileType - Velocity profile type ("LOG";"PL"=power law;"JET";"H2L"=Log law for TIDAL model;"API";"USR";"TS";"IEC"=PL on rotor disk, LOG elsewhere; or "default")
+"TurbSim_User.profiles"      ProfileFile     - Name of the file that contains input profiles for WindProfileType="USR" and/or TurbModel="USRVKM" [-]
+         90   RefHt           - Height of the reference velocity (URef) [m]
+         17   URef            - Mean (total) velocity at the reference height [m/s] (or "default" for JET velocity profile) [must be 1-hr mean for API model; otherwise is the mean over AnalysisTime seconds]
+        350   ZJetMax         - Jet height [m] (used only for JET velocity profile, valid 70-490 m)
+"default"     PLExp           - Power law exponent [-] (or "default")
+"default"     Z0              - Surface roughness length [m] (or "default")
+
+--------Non-IEC Meteorological Boundary Conditions------------
+"default"     Latitude        - Site latitude [degrees] (or "default")
+       0.05   RICH_NO         - Gradient Richardson number [-]
+"default"     UStar           - Friction or shear velocity [m/s] (or "default")
+"default"     ZI              - Mixing layer depth [m] (or "default")
+"default"     PC_UW           - Hub mean u'w' Reynolds stress [m^2/s^2] (or "default" or "none")
+"default"     PC_UV           - Hub mean u'v' Reynolds stress [m^2/s^2] (or "default" or "none")
+"default"     PC_VW           - Hub mean v'w' Reynolds stress [m^2/s^2] (or "default" or "none")
+
+--------Spatial Coherence Parameters----------------------------
+"default"     SCMod1           - u-component coherence model ("GENERAL","IEC","API","NONE", or "default")
+"default"     SCMod2           - v-component coherence model ("GENERAL","IEC","NONE", or "default")
+"default"     SCMod3           - w-component coherence model ("GENERAL","IEC","NONE", or "default")
+"default"     InCDec1          - u-component coherence parameters for general or IEC models [-, m^-1] (e.g. "10.0  0.3e-3" in quotes) (or "default")
+"default"     InCDec2          - v-component coherence parameters for general or IEC models [-, m^-1] (e.g. "10.0  0.3e-3" in quotes) (or "default")
+"default"     InCDec3          - w-component coherence parameters for general or IEC models [-, m^-1] (e.g. "10.0  0.3e-3" in quotes) (or "default")
+"default"     CohExp           - Coherence exponent for general model [-] (or "default")
+
+--------Coherent Turbulence Scaling Parameters------------------- [used only when WrACT=TRUE]
+".\EventData"    CTEventPath     - Name of the path where event data files are located
+"les"         CTEventFile     - Type of event files ("LES", "DNS", or "RANDOM")
+true          Randomize       - Randomize the disturbance scale and locations? (true/false)
+          1   DistScl         - Disturbance scale [-] (ratio of event dataset height to rotor disk). (Ignored when Randomize = true.)
+        0.5   CTLy            - Fractional location of tower centerline from right [-] (looking downwind) to left side of the dataset. (Ignored when Randomize = true.)
+        0.5   CTLz            - Fractional location of hub height from the bottom of the dataset. [-] (Ignored when Randomize = true.)
+         10   CTStartTime     - Minimum start time for coherent structures in RootName.cts [seconds]
+
+====================================================
+! NOTE: Do not add or remove any lines in this file!
+====================================================

docs/source/user/turbsim/examples/TurbSim_User.profiles

@@ -0,0 +1,16 @@
+---------TurbSim v2.00.* Profile Input File------------------------
+Made up profiles
+-------- User-Defined Profiles (Used only with USR wind profile or USRVKM spectral model) -------------------
+5               NumUSRz        - Number of Heights
+1.092           StdScale1      - u-component scaling factor for the input standard deviation
+1.0             StdScale2      - v-component scaling factor for the input standard deviation
+0.534           StdScale3      - w-component scaling factor for the input standard deviation
+-----------------------------------------------------------------------------------
+Height    Wind Speed       Wind --Direction--        Standard Deviation    Length Scale
+ (m)        (m/s)       (deg, cntr-clockwise )            (m/s)              (m)
+-----------------------------------------------------------------------------------
+15.0           3            00                            .100                  3
+25.0           4            00                            .200                  4
+35.0           5            00                            .300                  6
+45.0           6            00                            .100                  9
+55.0           7            00                            .500                 13