Merge pull request #373 from bjonkman/f/Linear

New Linearization and Mode-Shape Capabilities (and more)

Author: rafmudaf

.github/actions/compile-and-test/entrypoint.sh

@@ -24,7 +24,7 @@ cd /openfast
 
 # Display the differences between this commit and `dev`
 echo git-diff from ${GITHUB_REF} to dev:
-git diff dev
+git diff dev --numstat
 
 # Move into the "build" directory, remove the old reg tests, and compile
 cd /openfast/build

.gitignore

@@ -44,6 +44,7 @@ vs-build/
 
 # backup files
 *.asv
+~$*.xlsx
 
 # LaTeX compiling files
 *.aux

README.rst

@@ -29,7 +29,7 @@ FAST v8 - OpenFAST v0.1.0
 The transition from FAST v8 to OpenFAST v0.1.0 represents the effort to better
 support an open-source developer community around FAST-based aero-hydro-servo-
 elastic engineering models of wind-turbines and wind-plants. OpenFAST is the
-next generation of FAST analysis tools. More inforation is available in the
+next generation of FAST analysis tools. More information is available in the
 `transition notes <http://openfast.readthedocs.io/en/latest/source/user/fast_to_openfast.html>`_.
 
 FAST v8 is a computer-aided engineering tool for simulating the coupled dynamic
@@ -116,7 +116,7 @@ OpenFAST on Unix-based and Windows machines are available at `readthedocs <http:
 
 Help
 ----
-Please use `github issues <https://github.com/OpenFAST/OpenFAST/issues>`_ to:
+Please use `GitHub Issues <https://github.com/OpenFAST/OpenFAST/issues>`_ to:
 
 * ask usage questions
 * report bugs

docs/OtherSupporting/OutListParameters.xlsx

@@ -0,0 +1,42 @@
+.. _AD-Nodal-Outputs:
+
+Nodal Outputs
+~~~~~~~~~~~~~
+
+In addition to the named outputs in :numref:`AD-Outputs` above, AeroDyn allows
+for outputting the full set blade node motions and loads (tower nodes
+unavailable at present). Please refer to the AeroDyn_Nodes tab in the
+Excel file :download:`OutListParameters.xlsx <../../../OtherSupporting/OutListParameters.xlsx>`
+for a complete list of possible output parameters.
+
+This section follows the `END` statement from normal Outputs section described
+above, and includes a separator description line followed by the following
+optinos.
+
+**BldNd_BladesOut** specifies the number of blades to output. Possible values
+are 0 through the number of blades AeroDyn is modeling. If the value is set to
+1, only blade 1 will be output, and if the value is 2, blades 1 and 2 will be
+output.
+
+**BldNd_BlOutNd** specifies which nodes to output.  This is currently unused.
+
+The **OutList** section controls the nodal output quantities generated by
+AeroDyn. In this section, the user specifies the name of the channel family to
+output. The output name for each channel is then created internally by AeroDyn
+by combining the blade number, node number, and channel family name. For
+example, if the user specifies **AxInd** as the channel family name, the output
+channels will be named with the convention of **B**\ :math:`\mathbf{\beta}`\
+**N###AxInd** where :math:`\mathbf{\beta}` is the blade number, and **###** is
+the three digit node number.
+
+
+Sample Nodal Outputs section
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This sample includes the ``END`` statement from the regular outputs section.
+
+.. container::
+   :name: File:ADNodalOutputs
+
+   .. literalinclude:: examples/NodalOutputs.txt
+      :linenos:

docs/source/user/aerodyn/ADNodalOutputs.rst

@@ -0,0 +1,48 @@
+END of input file (the word "END" must appear in the first 3 columns of this last OutList line)
+---------------------- NODE OUTPUTS --------------------------------------------
+          3   BldNd_BladesOut  - Blades to output
+         99   BldNd_BlOutNd   - Blade nodes on each blade (currently unused)
+              OutList     - The next line(s) contains a list of output parameters.  See OutListParameters.xlsx, AeroDyn_Nodes tab for a listing of available output channels, (-)
+"VUndx"   - x-component of undisturbed wind velocity at each node
+"VUndy"   - y-component of undisturbed wind velocity at each node
+"VUndz"   - z-component of undisturbed wind velocity at each node
+"VDisx"   - x-component of disturbed wind velocity at each node
+"VDisy"   - y-component of disturbed wind velocity at each node
+"VDisz"   - z-component of disturbed wind velocity at each node
+"STVx"    - x-component of structural translational velocity at each node
+"STVy"    - y-component of structural translational velocity at each node
+"STVz"    - z-component of structural translational velocity at each node
+"VRel"    - Relvative wind speed at each node
+"DynP"    - Dynamic pressure at each node
+"Re"      - Reynolds number (in millions) at each node
+"M"       - Mach number at each node
+"Vindx"   - Axial induced wind velocity at each node
+"Vindy"   - Tangential induced wind velocity at each node
+"AxInd"   - Axial induction factor at each node
+"TnInd"   - Tangential induction factor at each node
+"Alpha"   - Angle of attack at each node
+"Theta"   - Pitch+Twist angle at each node
+"Phi"     - Inflow angle at each node
+"Curve"   - Curvature angle at each node
+"Cl"      - Lift force coefficient at each node
+"Cd"      - Drag force coefficient at each node
+"Cm"      - Pitching moment coefficient at each node
+"Cx"      - Normal force (to plane) coefficient at each node
+"Cy"      - Tangential force (to plane) coefficient at each node
+"Cn"      - Normal force (to chord) coefficient at each node
+"Ct"      - Tangential force (to chord) coefficient at each node
+"Fl"      - Lift force per unit length at each node
+"Fd"      - Drag force per unit length at each node
+"Mm"      - Pitching moment per unit length at each node
+"Fx"      - Normal force (to plane) per unit length at each node
+"Fy"      - Tangential force (to plane) per unit length at each node
+"Fn"      - Normal force (to chord) per unit length at each node
+"Ft"      - Tangential force (to chord) per unit length at each node
+"Clrnc"   - Tower clearance at each node (based on the absolute distance to the nearest point in the tower from blade node B#N# minus the local tower radius, in the deflected configuration); please note that this clearance is only approximate because the calculation assumes that the blade is a line with no volume (however, the calculation does use the local tower radius); when blade node B#N# is above the tower top (or below the tower base), the absolute distance to the tower top (or base) minus the local tower radius, in the deflected configuration, is output
+"Vx"      - Local axial velocity
+"Vy"      - Local tangential velocity
+"GeomPhi" - Geometric phi? If phi was solved using normal BEMT equations, GeomPhi = 1; otherwise, if it was solved geometrically, GeomPhi = 0.
+"Chi"     - Skew angle (used in skewed wake correction)
+"UA_Flag" - Flag indicating if UA is turned on for this node.
+END of input file (the word "END" must appear in the first 3 columns of this last OutList line)
+---------------------------------------------------------------------------------------

docs/source/user/aerodyn/examples/NodalOutputs.txt

@@ -31,7 +31,7 @@ True          TIDrag             - Include the drag term in the tangential-induc
           2   DBEMT_Mod          - Type of dynamic BEMT (DBEMT) model {1=constant tau1, 2=time-dependent tau1} (-) [used only when WakeMod=2]
           4   tau1_const         - Time constant for DBEMT (s) [used only when WakeMod=2 and DBEMT_Mod=1]
 ======  Beddoes-Leishman Unsteady Airfoil Aerodynamics Options  ===================================== [used only when AFAeroMod=2]
-          1   UAMod              - Unsteady Aero Model Switch (switch) {1=Baseline model (Original), 2=Gonzalez's variant (changes in Cn,Cc,Cm), 3=Minemma/Pierce variant (changes in Cc and Cm)} [used only when AFAeroMod=2]
+          1   UAMod              - Unsteady Aero Model Switch (switch) {1=Baseline model (Original), 2=Gonzalez's variant (changes in Cn,Cc,Cm), 3=Minnema/Pierce variant (changes in Cc and Cm)} [used only when AFAeroMod=2]
 FALSE         FLookup            - Flag to indicate whether a lookup for f' will be calculated (TRUE) or whether best-fit exponential equations will be used (FALSE); if FALSE S1-S4 must be provided in airfoil input files (flag) [used only when AFAeroMod=2]
 ======  Airfoil Information =========================================================================
           1   AFTabMod           - Interpolation method for multiple airfoil tables {1=1D interpolation on AoA (first table only); 2=2D interpolation on AoA and Re; 3=2D interpolation on AoA and UserProp} (-)
@@ -82,5 +82,19 @@ True          SumPrint            - Generate a summary file listing input option
 "B1N1AxInd, B1N2AxInd, B1N3AxInd"  
 "B1N1Alpha, B1N2Alpha, B1N3Alpha"  
 "B1N1Theta, B1N2Theta, B1N3Theta"  
-END of input file (the word "END" must appear in the first 3 columns of this last OutList line)
----------------------------------------------------------------------------------------
+END of OutList section (the word "END" must appear in the first 3 columns of the last OutList line)
+====== Outputs for all blade stations (same ending as above for B1N1.... =========================== [optional section]
+   1              BldNd_BladesOut     - Number of blades to output all node information at.  Up to number of blades on turbine. (-)
+   "All"          BldNd_BlOutNd       - Future feature will allow selecting a portion of the nodes to output.  Not implemented yet. (-)
+                  OutList             - The next line(s) contains a list of output parameters.  See OutListParameters.xlsx for a listing of available output channels, (-)
+"Fx, Fy"
+"Vx, Vy"
+Vrel
+TnInd
+AxInd
+Theta
+Phi
+Vindx
+Vindy
+Alpha
+END (the word "END" must appear in the first 3 columns of this last OutList line in the optional nodal output section)

docs/source/user/aerodyn/examples/ad_primary_example.inp

@@ -10,10 +10,11 @@ file is required. This driver file specifies initialization inputs
 normally provided to AeroDyn by OpenFAST, as well as the per-time-step
 inputs to AeroDyn.
 
-As an example,  the ``driver.dvr`` file is the main driver, the ``input.dat`` is the primary input file, the ``blade.dat`` file contains the blade
-geometry data, and the ``airfoil.dat`` file contains the airfoil
-angle of attack, lift, drag, moment coefficients, and pressure
-coefficients.  Example input files are included in :numref:`ad_appendix`.
+As an example,  the ``driver.dvr`` file is the main driver, the ``input.dat`` is
+the primary input file, the ``blade.dat`` file contains the blade geometry data,
+and the ``airfoil.dat`` file contains the airfoil angle of attack, lift, drag,
+moment coefficients, and pressure coefficients.  Example input files are
+included in :numref:`ad_appendix`.
 
 No lines should be added or removed from the input files, except in
 tables where the number of rows is specified and comment lines in the
@@ -151,11 +152,11 @@ for ``DTAero`` may be used to indicate that AeroDyn should employ the
 time step prescribed by the driver code (OpenFAST or the standalone driver
 program).
 
-Set ``WakeMod`` to 0 if you want to disable rotor wake/induction
-effects or 1 to include these effects using the (quasi-steady) BEM theory model. When
-``WakeMod`` is set to 2, a dynamic BEM theory model (DBEMT) is used (also referred to
-  as dynamic inflow or dynamic wake model). 
-``WakeMod`` cannot be set to 2 during linearization analyses.
+Set ``WakeMod`` to 0 if you want to disable rotor wake/induction effects or 1 to
+include these effects using the (quasi-steady) BEM theory model. When
+``WakeMod`` is set to 2, a dynamic BEM theory model (DBEMT) is used (also
+referred to as dynamic inflow or dynamic wake model).  ``WakeMod`` cannot be set
+to 2 during linearization analyses.
 
 Set ``AFAeroMod`` to 1 to include steady blade airfoil aerodynamics or 2
 to enable UA; ``AFAeroMod`` must be 1 during linearization analyses
@@ -361,6 +362,8 @@ specifies the local tower drag-force coefficient. ``TwrElev`` must be
 entered in monotonically increasing order—from the lowest (tower-base)
 to the highest (tower-top) elevation. See Figure 2.
 
+.. _AD-Outputs:
+
 Outputs
 ~~~~~~~
 
@@ -415,6 +418,9 @@ unknown/invalid channel name, it warns the users but will remove the
 suspect channel from the output file. Please refer to Appendix E for a
 complete list of possible output parameters.
 
+.. include:: ADNodalOutputs.rst
+
+
 .. _airfoil_data_input_file:
 
 Airfoil Data Input File