Docs: consolidate api modified table and add table of files using key…

…+value
OpenFAST · Mar 10, 2021 · 54f2a62 · 54f2a62
1 parent bfb01af
commit 54f2a62
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 19 deletions.
diff --git a/docs/source/user/api_change.rst b/docs/source/user/api_change.rst
@@ -139,20 +139,6 @@ InflowWind     7    VFlowAng                  0   VFlowAng    - Upflow angle (de
    -  Driver code includes ability to convert between wind types
 
 
-Modified in OpenFAST v2.4.0
----------------------------
-
-============== ==== ================== ======================================================================================================================================================= =====================
- Module        Line  New Flag Name      Example Value                                                                                                                                           Previous Flag Name
-============== ==== ================== ======================================================================================================================================================= =====================
-InflowWind     17   Filename_Uni        "unused"      Filename_Uni   - Filename of time series data for uniform wind field.      (-)                                                            Filename
-InflowWind     18   RefHt_Uni                    90   RefHt_Uni      - Reference height for horizontal wind speed                (m)                                                            RefHt
-InflowWind     35   RefHt_Hawc                   90   RefHt_Hawc     - reference height; the height (in meters) of the vertical center of the grid (m)                                          RefHt
-InflowWind     47   PLExp_Hawc                  0.2   PLExp_Hawc     - Power law exponent (-) (used for PL wind profile type only)                                                              PLExp
-InflowWind     49   XOffset                       0   XOffset         - Initial offset in +x direction (shift of wind box)                                                                      InitPosition(x)
-============== ==== ================== ======================================================================================================================================================= =====================
-
-
 OpenFAST v2.3.0 to OpenFAST v2.4.0
 ----------------------------------
 
@@ -179,11 +165,16 @@ AirFoilTables  4\*  BL_file            "unused"                BL_file
 Modified in OpenFAST v2.4.0
 ---------------------------
 
-============== ==== ================== =============================================================================================================================================================================
- Module        Line  Flag Name          Example Value
-============== ==== ================== =============================================================================================================================================================================
-AirFoilTables  40\* filtCutOff         "DEFAULT"               filtCutOff        - Reduced frequency cut-off for low-pass filtering the AoA input to UA, as well as the 1st and 2nd derivatives (-) [default = 0.5] 
-============== ==== ================== =============================================================================================================================================================================
+============== ==== ================== ======================================================================================================================================================= =========================
+ Module        Line  New Flag Name      Example Value                                                                                                                                           Previous Flag Name/Value
+============== ==== ================== ======================================================================================================================================================= =========================
+AirFoilTables  40\* filtCutOff         "DEFAULT"  filtCutOff   - Reduced frequency cut-off for low-pass filtering the AoA input to UA, as well as the 1st and 2nd deriv (-) [default = 0.5]     [default = 20]
+InflowWind     17   Filename_Uni        "unused"  Filename_Uni - Filename of time series data for uniform wind field.      (-)                                                                  Filename
+InflowWind     18   RefHt_Uni                 90  RefHt_Uni    - Reference height for horizontal wind speed                (m)                                                                  RefHt
+InflowWind     35   RefHt_Hawc                90  RefHt_Hawc   - reference height; the height (in meters) of the vertical center of the grid (m)                                                RefHt
+InflowWind     47   PLExp_Hawc               0.2  PLExp_Hawc   - Power law exponent (-) (used for PL wind profile type only)                                                                    PLExp
+InflowWind     49   XOffset                    0  XOffset      - Initial offset in +x direction (shift of wind box)                                                                             InitPosition(x)
+============== ==== ================== ======================================================================================================================================================= =========================
 
 \*non-comment line count, excluding lines contained if NumCoords is not 0.
 

diff --git a/docs/source/user/input_file_overview.rst b/docs/source/user/input_file_overview.rst
@@ -68,6 +68,26 @@ parser will return an error with information about which line it was reading
 from.
 
 
+Modules using Key + Value Format
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The following modules use the *key + value* format input files (all other
+modules use the *value column* format):
+
+============== ==========================================================
+ Module         Input file           
+============== ==========================================================
+AeroDyn         Main AD15 input file 
+AeroDyn         Airfoil files
+InflowWind      Main IfW input file
+InflowWind      Uniform wind input file
+InflowWind      Bladed wind summary file
+ServoDyn        Main ServoDyn input file
+ServoDyn        Structural control submodule input file
+ServoDyn        Structural control sumbodule prescribed force input file
+SubDyn          SubDyn SSI matrix input files
+============== ==========================================================
+
 Reasons for change
 ~~~~~~~~~~~~~~~~~~