Merge pull request #12 from andrew-platt/f/Linear

f/Linear -- documentation updates for nodal outputs
andrew-platt · Jun 25, 2020 · f7345f2 · f7345f2
2 parents ad1dd86 + b89ae35
commit f7345f2
Show file tree

Hide file tree

Showing 18 changed files with 955 additions and 16 deletions.
diff --git a/docs/source/install/index.rst b/docs/source/install/index.rst
@@ -35,6 +35,14 @@ All precompiled binaries can be found in the ``Assets`` dropdown in the
 `here <https://github.com/OpenFAST/openfast/releases/latest/download/windows_openfast_binaries.zip>`__
 to download the latest binaries.
 
+Note that the precompiled binaries require either the Intel fortran
+compiler or the Intel MKL redistributable libraries, which are not by
+default included with the binaries. To configure the libraries, download the
+installers from `here <https://software.intel.com/sites/default/files/managed/bb/e0/ww_ifort_redist_msi_2017.8.275.zip>`__
+and run the MSI file(s) to install the libraries. Note that if you have a
+Command Prompt open, you will need to close it after installing the libraries
+in order for the changes to take effect.
+
 Compile from source
 ~~~~~~~~~~~~~~~~~~~
 For compiling from source code, the NREL OpenFAST team has developed an

diff --git a/docs/source/user/aerodyn/ADNodalOutputs.rst b/docs/source/user/aerodyn/ADNodalOutputs.rst
@@ -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:
diff --git a/docs/source/user/aerodyn/examples/NodalOutputs.txt b/docs/source/user/aerodyn/examples/NodalOutputs.txt
@@ -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, ElastoDyn_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)
+---------------------------------------------------------------------------------------
diff --git a/docs/source/user/aerodyn/examples/ad_primary_example.inp b/docs/source/user/aerodyn/examples/ad_primary_example.inp
@@ -98,3 +98,50 @@ 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)
+---------------------- 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, ElastoDyn_Nodes tab for a listing of available output channels, (-)
+"VUndx"
+"VUndy"
+"VUndz"
+"VDisx"
+"VDisy"
+"VDisz"
+"STVx"
+"STVy"
+"STVz"
+"VRel"
+"DynP"
+"Re"
+"M"
+"Vindx"
+"Vindy"
+"AxInd"
+"TnInd"
+"Alpha"
+"Theta"
+"Phi"
+"Curve"
+"Cl"
+"Cd"
+"Cm"
+"Cx"
+"Cy"
+"Cn"
+"Ct"
+"Fl"
+"Fd"
+"Mm"
+"Fx"
+"Fy"
+"Fn"
+"Ft"
+"Clrnc"
+"Vx"
+"Vy"
+"GeomPhi"
+"Chi"
+"UA_Flag"
+END of input file (the word "END" must appear in the first 3 columns of this last OutList line)
+---------------------------------------------------------------------------------------
diff --git a/docs/source/user/aerodyn/input.rst b/docs/source/user/aerodyn/input.rst
@@ -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

diff --git a/docs/source/user/api_change.rst b/docs/source/user/api_change.rst
@@ -9,10 +9,11 @@ The changes are tabulated according to the module input file, line number, and f
 The line number corresponds to the resulting line number after all changes are implemented.
 Thus, be sure to implement each in order so that subsequent line numbers are correct.
 
-OpenFAST v2.3.0 to OpenFAST vTBD
-----------------------------------
- ============== ==== ================== =============================================================================================================================================================================
-Added in OpenFAST vTBD
+OpenFAST v2.3.0 to OpenFAST `dev`
+---------------------------------
+
+============== ==== ================== =============================================================================================================================================================================
+Added in OpenFAST `dev`
 --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
  Module        Line  Flag Name          Example Value
 ============== ==== ================== =============================================================================================================================================================================
@@ -23,8 +24,12 @@ OpenFAST       46   TrimTol            0.0001   TrimTol    - Tolerance for the r
 OpenFAST       47   TrimGain            0.001   TrimGain   - Proportional gain for the rotational speed error (>0) [used only if CalcSteady=True] (rad/(rad/s) for yaw or pitch; Nm/(rad/s) for torque)
 OpenFAST       48   Twr_Kdmp                0   Twr_Kdmp   - Damping factor for the tower [used only if CalcSteady=True] (N/(m/s))
 OpenFAST       49   Bld_Kdmp                0   Bld_Kdmp   - Damping factor for the blades [used only if CalcSteady=True] (N/(m/s))
+InflowWind     48   InitPosition(x)       0.0   InitPosition(x) - Initial offset in +x direction (shift of wind box) [Only used with WindType = 5] (m)
 ============== ==== ================== =============================================================================================================================================================================
 
+Additional nodal output channels added for :ref:`AeroDyn15<AD-Nodal-Outputs>`,
+:ref:`BeamDyn<BD-Nodal-Outputs>`, and :ref:`ElastoDyn<ED-Nodal-Outputs>`.
+
 OpenFAST v2.2.0 to OpenFAST v2.3.0
 ----------------------------------
 
@@ -45,7 +50,6 @@ Module                                        Line  Flag Name        Example Val
 AeroDyn Airfoil Input File - Airfoil Tables   2    UserProp         0   UserProp          ! User property (control) setting
 AeroDyn                                       37   AFTabMod         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} (-)
 ============================================= ==== =============== ========================================================================================================================================================================================================
-----------------------------------
 
 
 OpenFAST v2.1.0 to OpenFAST v2.2.0

diff --git a/docs/source/user/beamdyn/BDNodalOutputs.rst b/docs/source/user/beamdyn/BDNodalOutputs.rst
@@ -0,0 +1,40 @@
+.. _BD-Nodal-Outputs:
+
+Nodal Outputs
+~~~~~~~~~~~~~
+
+In addition to the named outputs in :numref:`BD-Outputs` above, BeamDyn allows
+for outputting the full set blade node motions and loads (tower nodes
+unavailable at present). Please refer to the BeamDyn_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_BlOutNd** specifies which nodes to output.  This is currently unused.
+
+The **OutList** section controls the nodal output quantities generated by
+BeamDyn. 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 BeamDyn
+by combining the blade number, node number, and channel family name. For
+example, if the user specifies **TDxr** as the channel family name, the output
+channels will be named with the convention of **B**\ :math:`\mathbf{\beta}`\
+**N###TDxr** 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:BDNodalOutputs
+
+   .. literalinclude:: examples/NodalOutputs.txt
+      :linenos:
+
+