Skip to content

Commit

Permalink
Update documentation with list of input file changes
Browse files Browse the repository at this point in the history
  • Loading branch information
@hkross
hkross committed Oct 27, 2021
1 parent 3f1dc15 commit 61b673e
Showing 1 changed file with 44 additions and 5 deletions.
49 changes: 44 additions & 5 deletions docs/source/user/api_change.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,55 @@ Added in OpenFAST dev
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Module Line Flag Name Example Value
============================================= ==== =============== ========================================================================================================================================================================================================
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]
AirFoilTables 12\* alphaUpper 5.0 alphaUpper ! Angle of attack at upper boundary of fully-attached region. (deg) [used only when UAMod=5] ! THIS IS AN OPTIONAL LINE; if omitted, it will be calculated from the polar data
AirFoilTables 13\* alphaLower \-3.0 alphaLower ! Angle of attack at lower boundary of fully-attached region. (deg) [used only when UAMod=5] ! THIS IS AN OPTIONAL LINE; if omitted, it will be calculated from the polar data
AirFoilTables 42\* UACutout_delta "DEFAULT" UACutout_delta ! Delta angle of attack below UACutout where unsteady aerodynamics begin to turn off (blend with steady solution) (deg) [Specifying the string "Default" sets UACutout_delta to 5 degrees] ! THIS IS AN OPTIONAL LINE; if omitted, it will be set to its default value
HydroDyn driver 6 WtrDens 1025 WtrDens - Water density (kg/m^3)
HydroDyn driver 7 WtrDpth 200 WtrDpth - Water depth (m)
HydroDyn driver 8 MSL2SWL 0 MSL2SWL - Offset between still-water level and mean sea level (m) [positive upward]
OpenFAST 21 MHK 0 MHK - MHK turbine type (switch) {0=Not an MHK turbine; 1=Fixed MHK turbine; 2=Floating MHK turbine}
OpenFAST 22 N/A ---------------------- ENVIRONMENTAL CONDITIONS --------------------------------
OpenFAST 23 Gravity 9.80665 Gravity - Gravitational acceleration (m/s^2)
OpenFAST 24 AirDens 1.225 AirDens - Air density (kg/m^3)
OpenFAST 25 WtrDens 1025 WtrDens - Water density (kg/m^3)
OpenFAST 26 KinVisc 1.464E-05 KinVisc - Kinematic viscosity of working fluid (m^2/s)
OpenFAST 27 SpdSound 335 SpdSound - Speed of sound in air (m/s)
OpenFAST 28 Patm 103500 Patm - Atmospheric pressure (Pa) [used only for an MHK turbine cavitation check]
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]
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]
AirFoilTables 12\* alphaUpper 5.0 alphaUpper ! Angle of attack at upper boundary of fully-attached region. (deg) [used only when UAMod=5] ! THIS IS AN OPTIONAL LINE; if omitted, it will be calculated from the polar data
AirFoilTables 13\* alphaLower \-3.0 alphaLower ! Angle of attack at lower boundary of fully-attached region. (deg) [used only when UAMod=5] ! THIS IS AN OPTIONAL LINE; if omitted, it will be calculated from the polar data
AirFoilTables 42\* UACutout_delta "DEFAULT" UACutout_delta ! Delta angle of attack below UACutout where unsteady aerodynamics begin to turn off (blend with steady solution) (deg) [Specifying the string "Default" sets UACutout_delta to 5 degrees] ! THIS IS AN OPTIONAL LINE; if omitted, it will be set to its default value
============================================= ==== =============== ========================================================================================================================================================================================================

\*non-comment line count, excluding lines contained if NumCoords is not 0, and including all OPTIONAL lines in the UA coefficients table.

============================================= ==== =============== ========================================================================================================================================================================================================
Modified in OpenFAST dev
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Module Line Flag Name Example Value
============================================= ==== =============== ========================================================================================================================================================================================================
AeroDyn 16 AirDens "default" AirDens - Air density (kg/m^3)
AeroDyn 17 KinVisc "default" KinVisc - Kinematic viscosity of working fluid (m^2/s)
AeroDyn 18 SpdSound "default" SpdSound - Speed of sound in air (m/s)
AeroDyn 19 Patm "default" Patm - Atmospheric pressure (Pa) [used only when CavitCheck=True]
AeroDyn 20 Pvap "default" Pvap - Vapour pressure of working fluid (Pa) [used only when CavitCheck=True]
HydroDyn 5 WtrDens "default" WtrDens - Water density (kg/m^3)
HydroDyn 6 WtrDpth "default" WtrDpth - Water depth (meters)
HydroDyn 7 MSL2SWL "default" MSL2SWL - Offset between still-water level and mean sea level (meters) [positive upward; unused when WaveMod = 6; must be zero if PotMod=1 or 2]
============================================= ==== =============== ========================================================================================================================================================================================================

============================================= ==== =============== ========================================================================================================================================================================================================
Removed in OpenFAST dev
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Module Line Flag Name Example Value
============================================= ==== =============== ========================================================================================================================================================================================================
AeroDyn 21 FluidDepth 0.5 FluidDepth - Water depth above mid-hub height (m) [used only when CavitCheck=True]
ElastoDyn 7 N/A ---------------------- ENVIRONMENTAL CONDITION ---------------------------------
ElastoDyn 8 Gravity 9.80665 Gravity - Gravitational acceleration (m/s^2)
============================================= ==== =============== ========================================================================================================================================================================================================

- The AeroDyn driver input file was completely rewritten. You may consult the following examples for a :download:`single rotor <./aerodyn/examples/ad_driver_example.dvr>`: and :download:`multiple rotors <./aerodyn/examples/ad_driver_multiple.dvr>`: in addition to the :ref:`AeroDyn driver documentation<ad_driver>`.

- SubDyn

Expand Down

0 comments on commit 61b673e

Please sign in to comment.