7. ROSCO_Toolbox tuning .yaml

Definition of inputs for ROSCO tuning procedure

The inputs to the rosco tuning yaml are defined in the rosco toolbox_schema.yaml file, which is located in the rosco/toolbox/inputs folder. The following is automatically generated from that file:

ROSCO toolbox schema

ROSCO toolbox schema

Type: object

Definition of inputs for ROSCO tuning procedure

Type: object Default: {}

Type: string

Name of *.fst file

Type: string

Main OpenFAST model directory, where the *.fst lives, relative to directory of this yaml (if applicable)

Type: string

Filename for rotor performance text file (if it has been generated by ccblade already), relative to directory of this yaml

Type: object Default: {}

The following properties are required:

  • v_rated

Type: number

Rotor inertia [kg m^2], {Available in Elastodyn .sum file}

Type: number

Rated rotor speed [rad/s]

Value must be greater or equal to 0

Type: number

Cut-in wind speed of the wind turbine.

Value must be greater or equal to 0

Type: number

Cut-out wind speed of the wind turbine.

Value must be greater or equal to 0

Type: number

Maximum blade pitch rate [rad/s]

Value must be greater or equal to 0

Type: number

Maximum torque rate [Nm/s], {~1/4 VS_RtTq/s}

Value must be greater or equal to 0

Type: number

Rated Power [W]

Value must be greater or equal to 0

Type: number Default: 4.0

Blade edgewise first natural frequency [rad/s]

Value must be greater or equal to 0

Type: number Default: 0

Blade flapwise first natural frequency [rad/s]

Value must be greater or equal to 0

Type: number Default: 0

Optimal tip speed ratio, if 0 the optimal TSR will be determined by the Cp surface

Value must be greater or equal to 0

Type: number Default: 0

Reynolds number near rated speeds, used to interpolate airfoils, if provided

Value must be greater or equal to 0

Type: object

Type: number Default: 1

0- write no debug files, 1- write standard output .dbg-file, 2- write standard output .dbg-file and complete avrSWAP-array .dbg2-file

Value must be greater or equal to 0 and lesser or equal to 3

Type: number Default: 1

1- first-order low-pass filter, 2- second-order low-pass filter, [rad/s] (currently filters generator speed and pitch control signals)

Value must be greater or equal to 1 and lesser or equal to 2

Type: number Default: 0

Notch on the measured generator speed and/or tower fore-aft motion (for floating) {0- disable, 1- generator speed, 2- tower-top fore-aft motion, 3- generator speed and tower-top fore-aft motion}

Value must be greater or equal to 0 and lesser or equal to 3

Type: number Default: 0

Turn Individual Pitch Control (IPC) for fatigue load reductions (pitch contribution) (0- off, 1- 1P reductions, 2- 1P+2P reduction)

Value must be greater or equal to 0 and lesser or equal to 2

Type: number Default: 2

Generator torque control mode in above rated conditions (0- no torque control, 1- k*omega^2 with PI transitions, 2- WSE TSR Tracking, 3- Power-based TSR Tracking, 4- Torque-based TSR Tracking)

Value must be greater or equal to 0 and lesser or equal to 4

Type: number Default: 0

Do constant power torque control, where above rated torque varies, 0 for constant torque

Value must be greater or equal to 0 and lesser or equal to 1

Type: number Default: 0

Configuration for FBP mode (0- variable pitch (disabled), 1- constant power overspeed, 2- WSE-lookup reference tracking, 3- torque-lookup reference tracking)

Value must be greater or equal to 0 and lesser or equal to 3

Type: number Default: 1

Blade pitch control mode (0- No pitch, fix to fine pitch, 1- active PI blade pitch control)

Value must be greater or equal to 0 and lesser or equal to 1

Type: number Default: 0

Yaw control mode (0- no yaw control, 1- yaw rate control, 2- yaw-by-IPC)

Value must be greater or equal to 0 and lesser or equal to 2

Type: number Default: 1

Setpoint Smoother mode (0- no setpoint smoothing, 1- introduce setpoint smoothing)

Value must be greater or equal to 0 and lesser or equal to 2

Type: number Default: 2

Wind speed estimator mode (0- One-second low pass filtered hub height wind speed, 1- Immersion and Invariance Estimator (Ortega et al.)

Value must be greater or equal to 0 and lesser or equal to 2

Type: number Default: 3

Pitch saturation mode (0- no pitch saturation, 1- peak shaving, 2- Cp-maximizing pitch saturation, 3- peak shaving and Cp-maximizing pitch saturation)

Value must be greater or equal to 0 and lesser or equal to 3

Type: number Default: 0

Startup mode (0- no startup procedure, 1- startup enabled)

Value must be greater or equal to 0 and lesser or equal to 1

Type: number Default: 0

Shutdown mode (0- no shutdown procedure, 1- enable shutdown)

Value must be greater or equal to 0 and lesser or equal to 1

Type: number Default: 0

Tower damper mode (0- no tower damper, 1- feed back translational nacelle accelleration to pitch angle

Value must be greater or equal to 0 and lesser or equal to 1

Type: number Default: 0

Tower resonance avoidance mode (0- no tower resonsnace avoidance, 1- use torque control setpoints to avoid a specific frequency

Value must be greater or equal to 0 and lesser or equal to 1

Type: number Default: 0

Floating specific feedback mode (0- no nacelle velocity feedback, 1 - nacelle velocity feedback, 2 - nacelle pitching acceleration feedback)

Value must be greater or equal to 0 and lesser or equal to 2

Type: number Default: 0

Flap control mode (0- no flap control, 1- steady state flap angle, 2- Proportional flap control)

Value must be greater or equal to 0 and lesser or equal to 2

Type: number Default: 0

Active Power Control Mode (0- no active power control 1- constant active power control, 2- open loop power vs time, 3- open loop power vs. wind speed)

Value must be greater or equal to 0 and lesser or equal to 2

Type: number Default: 0

ZMQ Mode (0 - ZMQ Inteface, 1 - ZMQ for yaw control)

Value must be greater or equal to 0 and lesser or equal to 1

Type: number Default: 2

Call ZeroMQ every [x] seconds, [s]

Value must be greater or equal to 0

Type: number Default: 0

Pitch actuator mode {0 - not used, 1 - first order filter, 2 - second order filter}

Value must be greater or equal to 0 and lesser or equal to 2

Type: number Default: 0

Pitch fault mode {0 - not used, 1 - constant offset on one or more blades, 2- pitch stuck at last values}

Value must be greater or equal to 0 and lesser or equal to 1

Type: number Default: 0

Open loop control mode {0- no open loop control, 1- open loop control}

Value must be greater or equal to 0 and lesser or equal to 2

Type: number Default: 0

Active wake control mode {0 - not used, 1 - SNL method, 2 - NREL method}

Value must be greater or equal to 0 and lesser or equal to 2

Type: number Default: 0

External control mode [0 - not used, 1 - call external dynamic library]

Value must be greater or equal to 0 and lesser or equal to 1

Type: number Default: 0

Cable control mode [0- unused, 1- User defined, 2- Open loop control]

Value must be greater or equal to 0 and lesser or equal to 2

Type: number Default: 0

Structural control mode [0- unused, 1- User defined, 2- Open loop control]

Value must be greater or equal to 0 and lesser or equal to 2

Type: array of number Default: [12]

List of wind speeds to schedule pitch control zeta and omega

No Additional Items

Each item of this array must be:

Type: number

Value must be greater or equal to 0

Type: array of number or number Default: [1.0]

List of pitch controller desired damping ratio at U_pc [-]

No Additional Items

Each item of this array must be:

Type: number

Value must be greater or equal to 0

Type: array of number or number Default: [0.2]

List of pitch controller desired natural frequency at U_pc [rad/s]

No Additional Items

Each item of this array must be:

Type: number

Value must be greater or equal to 0

Type: enum (of string) Default: "sigma"

Type of interpolation between above rated tuning values (only used for multiple pitch controller tuning values)

Must be one of:

  • "sigma"
  • "linear"
  • "quadratic"
  • "cubic"

Type: number Default: 1.0

Torque controller desired damping ratio [-]

Value must be greater or equal to 0

Type: number Default: 0.2

Torque controller desired natural frequency [rad/s]

Value must be greater or equal to 0

Type: number Default: 1.57

Maximum pitch angle [rad], {default = 90 degrees}

Type: number

Minimum pitch angle [rad]

Type: number Default: 0

Minimum rotor speed [rad/s], {default = 0 rad/s}

Type: number Default: 1.0

Torque controller setpoint smoother gain bias percentage [%, <= 1 ], {default = 100%}

Type: number Default: 0.05

Pitch controller setpoint smoother gain bias percentage [%, <= 1 ], {default = 0.1%}

Type: number Default: 0.0

Decrease torque control gain by this amount (fraction)

Type: number Default: 0.8

Percent peak shaving [%, <= 1 ], {default = 80%}

Value must be lesser or equal to 1

Type: number Default: 0.1745

Maximum (and minimum) flap pitch angle [rad]

Type: number

Tower natural frequency, for floating only

Value must be greater or equal to 0

Type: number

Platform natural frequency, for floating only

Value must be greater or equal to 0

Type: number Default: 60

Number of wind speed breakpoints

Value must be greater or equal to 0

Type: number Default: 30

Number of pitch angle gain scheduling breakpoints

Value must be greater or equal to 0

Type: number or array of number

Gain(s) of floating feedback control

Type: boolean Default: true

Whether to automatically tune Kp_float

Type: array of number, string or number Default: []

List of wind speeds for tuning floating feedback, or "all" for all above-rated wind speeds

No Additional Items

Each item of this array must be:

Type: number

Type: number

Flap controller desired damping ratio [-]

Value must be greater or equal to 0

Type: number

Flap controller desired natural frequency [rad/s]

Value must be greater or equal to 0

Type: number

Flap controller normalization term for DC gain (kappa)

Value must be greater or equal to 0

Type: number

Flap controller time constant for integral gain

Value must be greater or equal to 0

Type: number Default: 1.1

Maximum torque = rated torque * maxtorquefactor

Value must be greater or equal to 0

Type: number Default: 0.0

Proportional gain for IPC, 1P [s]

Value must be greater or equal to 0

Type: number Default: 0.0

Proportional gain for IPC, 2P [-]

Value must be greater or equal to 0

Type: number Default: 0.0

Integral gain for IPC, 1P [s]

Value must be greater or equal to 0

Type: number Default: 0.0

integral gain for IPC, 2P [-]

Value must be greater or equal to 0

Type: array of number Default: [0.0, 0.0]

wind speeds for IPC cut-in sigma function [m/s]

No Additional Items

Each item of this array must be:

Type: number

Value must be greater or equal to 0.0

Type: number Default: 1

Factor on VS_Rgn2K to increase/decrease optimal torque control gain, default is 1. Sometimes environmental conditions or differences in BEM solvers necessitate this change.

Value must be greater or equal to 0

Type: number Default: 0

Interpretation mode for VSFBPP (0- scale relative to rated power, 1- absolute power)

Value must be greater or equal to 0 and lesser or equal to 1

Type: number Default: 0

Overspeed or underspeed operating schedule (0- underspeed, 1- overspeed)

Value must be greater or equal to 0 and lesser or equal to 1

Type: array of number Default: [1.0, 2.0]

List of wind speeds to schedule user-defined power curve for fixed blade pitch (FBP) control in Region 3

No Additional Items

Each item of this array must be:

Type: number

Value must be greater or equal to 0

Type: array of number or number Default: [1.0, 1.0]

List of points defining power curve for fixed blade pitch (FBP) control in Region 3, relative or absolute based on VSFBPpower_mode

No Additional Items

Each item of this array must be:

Type: number

Value must be greater or equal to 0

Type: object Default: {}

Type: number

Corner frequency (-3dB point) in the first order low pass filter of the generator speed [rad/s]

Value must be greater or equal to 0

Type: number

Damping ratio in the first order low pass filter of the generator speed [-]

Value must be greater or equal to 0

Type: number Default: 0.20944

Corner frequency (-3dB point) in the first order low pass filter for the wind speed estimate [rad/s]

Value must be greater or equal to 0

Type: number Default: 0.01042

Natural frequency of first-order high-pass filter for nacelle fore-aft motion [rad/s]

Value must be greater or equal to 0

Type: number Default: 0.6283

First order low-pass filter cornering frequency for setpoint smoother [rad/s]

Value must be greater or equal to 0

Type: number Default: 0.17952

Low pass filter corner frequency for yaw controller [rad/

Value must be greater or equal to 0

Type: number Default: 0.41888

Cutoff Frequency for first order low-pass filter for blade pitch angle for shutdown, [rad/s], {default = 0.41888 ~ time constant of 15s}

Type: number Default: 0.41888

Cutoff Frequency for first order low-pass filter for yaw error for shutdown, [rad/s], {default = 0.41888 ~ time constant of 15s}

Type: number Default: 0.41888

Cutoff Frequency for first order low-pass filter for generator speed for shutdown, [rad/s], {default = 0.41888 ~ time constant of 15s}

Type: number Default: 0.20944

Corner frequency (-3dB point) in the first order low pass filter for TSR tracking torque control [rad/s]

Value must be greater or equal to 0

Type: object Default: {}

Type: boolean Default: false

Flag to use open loop control

Type: string Default: "unused"

Filename of open loop input that ROSCO reads

Type: number Default: 0

Breakpoint mode for open loop control, 0 - indexed by time (default), 1 - indexed by wind speed

Value must be greater or equal to 0 and lesser or equal to 1

Type: number Default: 1

Index (column, 1-indexed) of breakpoint (time) in open loop index

Value must be greater or equal to 0

Type: array of number Default: [0, 0, 0]

Indices (columns, 1-indexed) of pitch (1,2,3) inputs in open loop input

No Additional Items

Each item of this array must be:

Type: number

Value must be greater or equal to 0

Type: number Default: 0

Index (column, 1-indexed) of generator torque in open loop input

Value must be greater or equal to 0

Type: number Default: 0

Index (column, 1-indexed) of nacelle yaw in open loop input

Value must be greater or equal to 0

Type: number Default: 0

The column in OLFilename that contains the desired azimuth position in rad (used if OLMode = 2)

Type: number Default: 0

Index (column, 1-indexed) of power rating via speed offset

Value must be greater or equal to 0

Type: number Default: 0

Index (column, 1-indexed) of power rating via torque offset

Value must be greater or equal to 0

Type: number Default: 0

Index (column, 1-indexed) of power rating via pitch offset

Value must be greater or equal to 0

Type: array of number Default: [0]

The column in OL_Filename that contains the cable control inputs in m

No Additional Items

Each item of this array must be:

Type: array of number Default: [0]

The column in OL_Filename that contains the structural control inputs in various units

No Additional Items

Each item of this array must be:

Type: number Default: 3.14

Pitch actuator natural frequency [rad/s]

Value must be greater or equal to 0

Type: number Default: 0.707

Pitch actuator damping ratio [-]

Value must be greater or equal to 0

Type: object Default: {}

These are pass-through parameters for the DISCON.IN file. Use with caution. Do not set defaults in schema.

Type: number

(0- write no debug files, 1- write standard output .dbg-file, 2- write standard output .dbg-file and complete avrSWAP-array .dbg2-file)

Type: number Default: 0

0 - no Echo, 1 - Echo input data to <RootName>.echo

Type: number Default: 0

Time step to output .dbg* files, or 0 to match sampling period of OpenFAST

Type: number Default: 1

0 - use standard bladed interface, 1 - Use the extened DLL interface introduced in OpenFAST 3.5.0.

Value must be greater or equal to 0 and lesser or equal to 1

Type: number

1- first-order low-pass filter, 2- second-order low-pass filter (currently filters generator speed and pitch control signals

Type: number

Generator torque control mode in above rated conditions (0- no torque control, 1- k*omega^2 with PI transitions, 2- WSE TSR Tracking, 3- Power-based TSR Tracking, 4- Torque-based TSR Tracking)

Value must be greater or equal to 0 and lesser or equal to 4

Type: number

Do constant power torque control, where above rated torque varies

Value must be greater or equal to 0 and lesser or equal to 1

Type: number

Configuration for FBP mode (0- variable pitch (disabled), 1- constant power overspeed, 2- WSE-lookup reference tracking, 3- torque-lookup reference tracking)

Value must be greater or equal to 0 and lesser or equal to 3

Type: number

Notch on the measured generator speed and/or tower fore-aft motion (for floating) (0- disable, 1- generator speed, 2- tower-top fore-aft motion, 3- generator speed and tower-top fore-aft motion)

Type: number

Turn Individual Pitch Control (IPC) for fatigue load reductions (pitch contribution) (0- off, 1- 1P reductions, 2- 1P+2P reductions)

Type: number

Blade pitch control mode (0- No pitch, fix to fine pitch, 1- active PI blade pitch control)

Type: number

Yaw control mode (0- no yaw control, 1- yaw rate control, 2- yaw-by-IPC)

Type: number

Setpoint Smoother mode (0- no setpoint smoothing, 1- introduce setpoint smoothing)

Type: number

Wind speed estimator mode (0- One-second low pass filtered hub height wind speed, 1- Immersion and Invariance Estimator, 2- Extended Kalman Filter)

Type: number

Pitch saturation mode (0- no pitch saturation, 1- implement pitch saturation)

Type: number

Startup mode (0- no startup procedure, 1- startup enabled)

Type: number

Shutdown mode (0- no shutdown procedure, 1- enable shutdown)

Type: number

Floating specific feedback mode (0- no nacelle velocity feedback, 1- feed back translational velocity, 2- feed back rotational veloicty)

Type: number

Flap control mode (0- no flap control, 1- steady state flap angle, 2- Proportional flap control)

Type: number

Open loop control mode (0 - no open-loop control, 1 - direct open loop control, 2 - rotor position control)

Type: number

Corner frequency (-3dB point) in the low-pass filters,

Type: number

Damping coefficient (used only when F_FilterType = 2 [-]

Type: number

Number of notch filters placed on sensors

Type: array of number or number

Natural frequency of the notch filters. Array with length F_NumNotchFilts

No Additional Items

Each item of this array must be:

Type: array of number or number

Damping value of numerator (determines the width of notch). Array with length F_NumNotchFilts, [-]

No Additional Items

Each item of this array must be:

Type: array of number or number

Damping value of denominator (determines the depth of notch). Array with length F_NumNotchFilts, [-]

No Additional Items

Each item of this array must be:

Type: number

Number of notch filters on generator speed

Type: number

Number of notch filters on tower top acceleration signal

Type: array of number or number

Indices of notch filters on generator speed

No Additional Items

Each item of this array must be:

Type: array of number or number

Indices of notch filters on tower top acceleration signal

No Additional Items

Each item of this array must be:

Type: number

Corner frequency (-3dB point) in the first order low pass filter for the setpoint smoother,

Type: number

Corner frequency (-3dB point) in the first order low pass filter for the wind speed estimate

Type: array of number

Natural frequency and damping in the second order low pass filter of the tower-top fore-aft motion for floating feedback control

No Additional Items

Each item of this array must be:

Type: number

Natural frequency of first-order high-pass filter for nacelle fore-aft motion

Type: array of number

Corner frequency and damping in the second order low pass filter of the blade root bending moment for flap control

No Additional Items

Each item of this array must be:

Type: number

Corner frequency (-3dB point) in the first order low pass filter of the generator speed reference used for TSR tracking torque control [rad/s].

Type: number

Amount of gain-scheduling table entries

Type: array of number

Gain-schedule table- pitch angles

No Additional Items

Each item of this array must be:

Type: array of number

Gain-schedule table- pitch controller kp gains

No Additional Items

Each item of this array must be:

Type: array of number

Gain-schedule table- pitch controller ki gains

No Additional Items

Each item of this array must be:

Type: array of number

Gain-schedule table- pitch controller kd gains

No Additional Items

Each item of this array must be:

Type: array of number

Gain-schedule table- pitch controller tf gains (derivative filter)

No Additional Items

Each item of this array must be:

Type: number

Maximum physical pitch limit,

Type: number

Minimum physical pitch limit,

Type: number

Maximum pitch rate (in absolute value) in pitch controller

Type: number

Minimum pitch rate (in absolute value) in pitch controller

Type: number

Desired (reference) HSS speed for pitch controller

Type: number

Record 5- Below-rated pitch angle set-point

Type: number

Angle above lowest minimum pitch angle for switch

Type: number

Integrator saturation (maximum signal amplitude contribution to pitch from IPC)

Type: integer

IPC Saturation method (0 - no saturation, 1 - saturate by PCMinPit, 2 - saturate by PSBldPitchMin)

Type: array of number

Proportional gain for the individual pitch controller- first parameter for 1P reductions, second for 2P reductions, [-]

No Additional Items

Each item of this array must be:

Type: array of number

Integral gain for the individual pitch controller- first parameter for 1P reductions, second for 2P reductions, [-]

No Additional Items

Each item of this array must be:

Type: array of number

Phase offset added to the azimuth angle for the individual pitch controller

No Additional Items

Each item of this array must be:

Type: number

Corner frequency of the first-order actuators model, to induce a phase lag in the IPC signal (0- Disable)

Type: number

Generator efficiency mechanical power -> electrical power, should match the efficiency defined in the generator properties

Type: number

Above rated generator torque PI control saturation

Type: number

Maximum torque rate (in absolute value) in torque controller

Type: number

Maximum generator torque in Region 3 (HSS side)

Type: number

Minimum generator torque (HSS side)

Type: number

Minimum generator speed

Type: number

Generator torque constant in Region 2 (HSS side). Only used in VS_ControlMode = 1,3,4

Type: number

Wind turbine rated power

Type: number

Rated torque

Type: number

Rated generator speed

Type: number

Number of generator PI torque controller gains

Type: number

Proportional gain for generator PI torque controller. (Only used in the transitional 2.5 region if VS_ControlMode =/ 2)

Type: number

Integral gain for generator PI torque controller (Only used in the transitional 2.5 region if VS_ControlMode =/ 2)

Type: number

Power-maximizing region 2 tip-speed-ratio. Only used in VS_ControlMode = 2.

Type: number

Variable speed torque controller setpoint smoother gain

Type: number

Collective pitch controller setpoint smoother gain

Type: number

Power reference tracking mode, 0- use standard rotor speed set points, 1- use PRC rotor speed setpoints

Type: array of number

Array of wind speeds used in rotor speed vs. wind speed lookup table [m/s]

No Additional Items

Each item of this array must be:

Type: array of number

Array of generator speeds corresponding to PRC_WindSpeeds [rad/s]

No Additional Items

Each item of this array must be:

Type: number Default: 0.078539

Frequency of the low pass filter on the wind speed estimate used to set PRC_GenSpeeds [rad/s]

Type: number

Number of elements in PRCWindSpeeds and PRCGenSpeeds array

Type: number Default: 0

Power reference communication mode when PRC_Mode = 2, 0- use constant DISCON inputs, 1- use open loop inputs, 2- use ZMQ inputs

Type: number Default: 1

Constant power rating through changing the rated torque, used if PRCMode = 2, PRCComm = 0, default is 1, effective above rated [-]

Type: number Default: 1

Constant power rating through changing the rated generator speed, used if PRCMode = 2, PRCComm = 0, default is 1, effective above rated [-]

Type: number Default: 1

Constant power rating through changing the fine pitch angle, used if PRCMode = 2, PRCComm = 0, default is 1, effective below rated [-]

Type: number Default: 20

Number of elements in PRCR to _Pitch table. Used if PRCMode = 1.

Type: array of number Default: [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]

Table of fine pitch versus PRCRTable, length should be PRCTablen [rad]. Used if PRC_Mode = 1.

No Additional Items

Each item of this array must be:

Type: array of number Default: [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1]

Table of turbine rating versus fine pitch (PRCPitchTable), length should be PRCTablen, default is 1 [-]. Used if PRC_Mode = 1.

No Additional Items

Each item of this array must be:

Type: number Default: 0.0

Rotor speed for exclusion [LSS, rad/s]

Value must be greater or equal to 0

Type: number Default: 0.0

Size of the rotor frequency exclusion band [LSS, rad/s]. Torque controller reference will be TRAExclSpeed +/- TRAExlBand/2

Value must be greater or equal to 0

Type: number Default: 0.0

Rate limit of change in rotor speed reference [LSS, rad/s]. Suggested to be VS_RefSpd/400.

Value must be greater or equal to 0

Type: number

Blade length (distance from hub center to blade tip)

Type: number

Amount of parameters in the Cp array

Type: array of number

Parameters that define the parameterized CP(lambda) function

No Additional Items

Each item of this array must be:

Type: number

Adaption gain of the wind speed estimator algorithm

Type: number

Gearbox ratio, >=1

Type: number

Total drivetrain inertia, including blades, hub and casted generator inertia to LSS

Type: number

Air density

Type: string

File containing rotor performance tables (Cp,Ct,Cq) (absolute path or relative to this file)

Type: number

Size of rotor performance tables, first number refers to number of blade pitch angles, second number referse to number of tip-speed ratios

Type: number

Number of first-order system poles used in EKF

Type: array of number

Wind speeds corresponding to first-order system poles

No Additional Items

Each item of this array must be:

Type: array of number

First order system poles

No Additional Items

Each item of this array must be:

Type: number

Yaw error threshold. Turbine begins to yaw when it passes this

Type: number

Integrator saturation (maximum signal amplitude contribution to pitch from yaw-by-IPC)

Type: number

Number of controller gains (yaw-by-IPC)

Type: number

Yaw-by-IPC proportional controller gain Kp

Type: number

Yaw-by-IPC integral controller gain Ki

Type: number

Low-pass filter corner frequency for the Yaw-by-IPC controller to filtering the yaw alignment error

Type: number

Low-pass filter damping factor for the Yaw-by-IPC controller to filtering the yaw alignment error.

Type: number

Yaw alignment error, set point

Type: number

Corner frequency fast low pass filter, 1.0

Type: number

Corner frequency slow low pass filter, 1/60

Type: number

Yaw rate

Type: number

Integral gain for the fore-aft tower damper controller, -1 = off / >0 = on

Type: number

Corner frequency (-3dB point) in the high-pass filter on the fore-aft acceleration signal

Type: number

Integrator saturation (maximum signal amplitude contribution to pitch from FA damper)

Type: number

Number of values in minimum blade pitch lookup table (should equal number of values in PSWindSpeeds and PSBldPitchMin)

Type: array of number

Wind speeds corresponding to minimum blade pitch angles

No Additional Items

Each item of this array must be:

Type: array of number

Minimum blade pitch angles

No Additional Items

Each item of this array must be:

Type: number Default: 120

Time to start startup routine [s]

Type: number Default: 200

Free-wheel minimum duration [s]

Type: number Default: 0.52

Rotor speed threshhold to switch from freewheel to loads [rad/s]

Type: number Default: 0.41888

Cutoff Frequency for first order low-pass filter for rotor speed for startup [rad/s]

Type: number Default: 2

Number of load staged for startup (should equal number of values in SULoadStages, SULoadRampDuration and SU_LoadHoldDuration)

Type: array of number Default: [0.2, 1.0]

Array containing loads as a fraction of full generator torque during startup

No Additional Items

Each item of this array must be:

Type: array of number Default: [100, 100]

Array containing ramp duration to reach the corresponding partial loads during startup [s]

No Additional Items

Each item of this array must be:

Type: array of number Default: [200, 100]

Array containing duration to hold the partial loads during startup [s]

No Additional Items

Each item of this array must be:

Type: number Default: 0

Time to acitvate shutdown modes [s]

Type: number Default: 0

Shutdown when collective blade pitch exceeds a threshold

Value must be greater or equal to 0 and lesser or equal to 1

Type: number Default: 0

Shutdown when yaw error exceeds a threshold

Value must be greater or equal to 0 and lesser or equal to 1

Type: number Default: 0

Shutdown when generator speed exceeds a threshold

Value must be greater or equal to 0 and lesser or equal to 1

Type: number Default: 0

Shutdown at a predefined time

Value must be greater or equal to 0 and lesser or equal to 1

Type: number

Maximum blade pitch angle to initiate shutdown

Type: number Default: 0.41888

Cutoff Frequency for first order low-pass filter for blade pitch angle for shutdown,

Type: number

Maximum yaw error to initiate shutdown

Type: number Default: 0.41888

Cutoff Frequency for first order low-pass filter for yaw error for shutdown

Type: number

Maximum generator speed to initiate shutdown

Type: number Default: 0.41888

Cutoff Frequency for first order low-pass filter for generator speed for shutdown

Type: number Default: 9999

Shutdown time [s]

Type: number Default: 1

Shutdown method {1- Reduce generator torque and increase blade pitch in timed stages (SDStageTime), 2- stages depend on pitch angle (SDStagePitch)}

Value must be greater or equal to 1 and lesser or equal to 2

Type: array of number

Maximum torque rate for shutdown [Nm/s]

No Additional Items

Each item of this array must be:

Type: array of number

Maximum pitch rate used for shutdown [rad/s]

No Additional Items

Each item of this array must be:

Type: array of number

Array containing the time to spend in each shutdown stage [s]

No Additional Items

Each item of this array must be:

Type: array of number

Array with pitch angles to reach in each shutdown stage [rad]. If the pitch < SDStagePitch[i], the SDStage = i. If pitch > SDStagePitch[SDStage_N], the maximum rates are used.

No Additional Items

Each item of this array must be:

Type: number

Number of shutdown stages (should equal number of values in SDMaxPitchRate and SDMaxTorqueRate) [-]

Type: number

Number of Fl_Kp gains in gain scheduling, optional with default of 1

Type: array of number

Nacelle velocity proportional feedback gain

No Additional Items

Each item of this array must be:

Type: array of number

Wind speeds for scheduling FlKp, optional if FlKp is single value [m/s]

No Additional Items

Each item of this array must be:

Type: number

Initial or steady state flap angle

Type: number

Blade root bending moment proportional gain for flap control

Type: number

Flap displacement integral gain for flap control

Type: number

Maximum (and minimum) flap pitch angle

Type: string

Input file with open loop timeseries (absolute path or relative to this file)

Type: number

Breakpoint mode for open loop control, 0 - indexed by time (default), 1 - indexed by wind speed

Type: number Default: 0

Natural frequency of 1st order filter on breakpoint for open loop control. 0 will skip filter.

Type: number

The column in OLFilename that contains the breakpoint (time if OLMode > 0)

Type: number

The column in OL_Filename that contains the blade pitch input in rad

Type: number

The column in OL_Filename that contains the generator torque in Nm

Type: number

The column in OL_Filename that contains the generator torque in Nm

Type: number

The column in OLFilename that contains the desired azimuth position in rad (used if OLMode = 2)

Type: array of number Default: [0, 0, 0, 0]

PID gains and Tf of derivative for rotor position control (used if OL_Mode = 2)

No Additional Items

Each item of this array must be:

Type: number

Index (column, 1-indexed) of power rating via speed offset

Value must be greater or equal to 0

Type: number

Index (column, 1-indexed) of power rating via torque offset

Value must be greater or equal to 0

Type: number

Index (column, 1-indexed) of power rating via pitch offset

Value must be greater or equal to 0

Type: array of number

The column in OL_Filename that contains the cable control inputs in m

No Additional Items

Each item of this array must be:

Type: array of number

The column in OL_Filename that contains the structural control inputs in various units

No Additional Items

Each item of this array must be:

Type: string Default: "unused"

Name/location of the dynamic library {.dll [Windows] or .so [Linux]} in the Bladed-DLL format

Type: string Default: "unused"

Name of input file sent to the DLL

Type: string Default: "DISCON"

Name of procedure in DLL to be called

Type: array of number Default: [0, 0, 0]

Pitch angle offsets for each blade (array with length of 3), only used if PF_Mode = 1

No Additional Items

Each item of this array must be:

Type: array of number Default: [9999, 9999, 9999]

Time pitch actuator becomes stuck at last value for each blade (array with length of 3), only used if PF_Mode = 2

No Additional Items

Each item of this array must be:

Type: number Default: 0

Number of cable control groups

Type: array of number Default: [0]

First index for cable control group, should correspond to deltaL

No Additional Items

Each item of this array must be:

Type: number Default: 20

Time constant for line actuator [s]

Type: number Default: 0

Number of cable control groups

Type: array of number Default: [0]

First index for structural control group, options specified in ServoDyn summary output

No Additional Items

Each item of this array must be:

Type: number Default: 0

Active wake control mode {0 - not used, 1 - complex number method, 2 - Coleman transformation method, 3 to 5 - Closed-loop AWC}

Value must be greater or equal to 0 and lesser or equal to 5

Type: number Default: 1

Number of AWC modes

Type: array of number Default: [1]

AWC azimuthal number (only used in complex number method)

No Additional Items

Each item of this array must be:

Type: array of integer Default: [1]

AWC Coleman transform harmonic (only used in Coleman transform method)

No Additional Items

Each item of this array must be:

Type: array of number Default: [0.05]

AWC frequency [Hz]

No Additional Items

Each item of this array must be:

Type: array of number Default: [1.0]

AWC amplitude [deg]

No Additional Items

Each item of this array must be:

Type: array of number Default: [0]

AWC clock angle [deg]

No Additional Items

Each item of this array must be:

Type: number Default: 0

Azimuth offset in the Coleman transformation [deg]

Type: array of number Default: [0.0, 0.0]

KP and KI/KR gain of the active wake controller [-]

No Additional Items

Each item of this array must be:

Type: string Default: "tcp://localhost:5555"

Communication address for ZMQ server, (e.g. "tcp://localhost:5555")

Type: number Default: 1.0

Update period at zmq interface to send measurements and wait for setpoint [sec.]

Type: number Default: 0

Integer identifier of turbine

Type: object Default: {}

Inputs used for tuning ROSCO using linear (level 2) models

Type: enum (of string) Default: "none"

Type of level 2 based tuning - robust gain scheduling (robust) or simulation based optimization (simulation)

Must be one of:

  • "none"
  • "robust"
  • "simulation"

Type: string Default: "none"

Path to OpenFAST linearization (.lin) files, if they exist

Type: string Default: "lintune_outfiles"

Path for outputs from linear model based tuning

Type: boolean Default: false

Load linearization files in parallel (True/False)

Type: number or array of number Default: 0.1

Desired maximum stability margin

Type: object Default: {}

Pitch controller bandwidth constraints