.. _parameters:

Parameters
===================

Input
-------------------

* **deltat** (float [s]): time step (defult: 1.0)
* **t_start** (float [s]): start time (default: 0.0)
* **t_end** (float [s]: end time (default:172800.0)
* **V_init** (float [m/s]: initial (or steady-state) wind speed (default: 8.3)
* **Vdir_init** (float [deg]): initial (or steady-state) wind direction (default: 286.6)
* **VTI_init** (float [-]): initial (or steady-state) turbulence intensity (default: 0.068)
* **ti_flag** (bool [-]): synthetic turbulence [0: off, 1: on] (defalut: 0)
* **inflow_data_flag** (bool [-]): use inflow data [0: off, 1: on] (default: 1)
* **inflow_data_file** (str [-]): inflow data file [if 'inflow_data_flag' = 1] (default: 'inflow_data_turb_1Hz.dat')
* **P_wpp_base** (float [W]): total plant power (default: 60.0e+06)
* **n_wt** (int [-]): number of wind turbines in plant (default: 4)
* **wt_x** (float [m], size [n_wt]): x position of wind turbines (default: [0.0 1200.0 2400.0 3600.0])
* **wt_y** (float [m], size [n_wt]): y position of wind turbines (default: [0.0 0.0 0.0 0.0])
* **Kp_wpp** (float [-]): proportional gain for power plant controller (default: 0.05)
* **Ki_wpp** (float [-]): integral gain for power plant controller (default: 2.00)
* **P_wpp_ref** (float [-]: power setpoint (controls de-rating of rated power) (default: 1.0)
* **deltaP_wpp_ref** (float [-]): delta power setpoint (controls derating of available power) (default: 0.0)
* **yaw_ref** (float [deg]): yaw misalignment setpoint (default: 0.0)
* **dP_wpp_refmax** (float [-]): max power rate (default: 0.2)
* **dP_wpp_refmin** (float [-]): min power rate (default: -0.2)
* **P_wpp_refmax** (float [-]): max power setpoint (default: 1.0)
* **P_wpp_refmin** (float [-]): min power setpoint (default: 0.3)
* **P_wpp_errmax** (float [-]): max power setpoint error (default: 1.0)
* **P_wpp_errmin** (float [-]): min power setpoint error (default: -1.0)
* **P_wpp_kimax** (float[-]): max integral power  (default: 1.0)
* **P_wpp_kimin** (float [-]): min integral power (default: -1.0))
* **dP_wpp_kimax** (float [-]): max integral power rate (default: 0.01)
* **dP_wpp_kimin** (float [-]): min integral power rate (default: -0.01)
* **Kaw** (float [-]): anti-windup gain (default: 1.0
* **n_wt_per_string** (int [-]): number of wind turbines per string (default: 4)
* **n_string** (int [-]): number of strings(default: 1)
* **area_cross** (float [mm^2], size [n_wt-1]): cable cross-sectional area (default: [400.0, 185.0, 95.0])
* **l_space** (float [m], size [n_wt-1]): wind turbine cable spacing (default: [1200.0, 1200.0, 1200.0])
* **rho_Al** (float [kg/mm^3]): cable material density (default: 2.65e-8)
* **Vbase** (float [V]): base voltage (default: 66.0e+03)
* **wt_data_file** (str [-]): Cp/Ct=f(erosion,yaw,tsr,pitch) filename (default: 'wt_data.h5')
* **J** (float [kg*m^2]): drivetrain inertia (default: 0.342155e+09)
* **r** (float [m]): rotor radius (default: 120.0)
* **hh** (float [m]): hub height (default: 150.0)
* **rho** (float [kg/m^3]): air density (default: 1.225)
* **neff** (float [-]): drivetrain efficiency (should be 1.0 if already included in the Cp data) (default: 1.0)
* **Cp_max** (float [-]): max power coefficient (default: 0.4892)
* **Ct_init** (float [-]): initial thrust coefficient (default: 0.9300)
* **omega_init** (float [rad/s]): initial rotor speed (default: 0.5236)
* **pitch_init** (float [deg]): initial pitch (default: 0.0)
* **WTdir_init** (float [deg]): initial wind turbine nacelle orientation (default: 286.6)
* **region_init** (int [-]): initial controller region [2: partial power, 3: rated power] (default: 2)
* **Q_gen_init** (float [-]): (default: 1.3248e+06)
* **erosion** (float [Nm]): initial generator torque (default: 0.0)
* **pitch_file** (str [-]): min pitch settings filenmae [used when 'pitch_min_in' > 90.0] (default: 'wpdata.100')
* **wt_data_dr_file** (str [-]): pitch/TSR settings [when 'deratingMode' = 3] (default: 'drdata.dat')
* **Prated** (float [W]): rated generator power (default: 15.0e+06)
* **omega_min** (float [rad/s]): min rotor speed (default: 0.5236)
* **omega_rated** (float [rad/s]): rated rotor speed (default: 0.7917)
* **f_omega** (float [rad/s]): frequency of 2nd order filter on rotor speed (default: 6.283185307179586)
* **zeta_omega** (float [-]): damping ratio of 2nd order filter on rotor speed (default: 0.7)
* **pitch_min_in** (float [deg]): min pitch angle [if >90 settings from 'pitch_file' are used] (default: 100.0)
* **pitch_max** (float [deg]): max pitch angle (default: 90.0)
* **Kopt** (float [Nm/(rad/s)^2]): region 2 optimal TSR generator gain (default: 0.292257e+08)
* **Kp_torque** (float [Nm/(rad/s)]): region 2 generator proportional gain (default: 0.120390e+09)
* **Ki_torque** (float [Nm/rad]): region 2 generator integral gain (default: 0.216124e+08)
* **Kp_pitch** (float [rad/(rad/s)]): region 3 pitch proportional gain (default: 0.103558e+01)
* **Ki_pitch** (float [rad/rad]): region 3 pitch integral gain (default: 0.154171e+00)
* **KK1** (float [deg]): gain scheduling linear term constant (default: 12.00082)
* **KK2** (float [deg^2]): gain scheduling quadratic term constant (default: 700.20585)
* **tau_vf** (float [s]): time constant of 1nd order filter on wind speed and yaw (default: 1.0472)
* **tau_pitch** (float [s]): time constant of 1nd order filter on pitch (default: 0.5236)
* **rel_sp_open_Qg** (int [-]): generator control switch [1=constant power, 0=constant torque, or interpolation between the two] (default: 0.95)
* **TorqueCtrlRatio** (float [-]): percentage of the rated speed when the torque limits are fully opened (default: 0.9)
* **pitch_lim** (float [deg]): angle above lowest minimum pitch angle for switch to full load (default: 2.0)
* **deratingMode** (int [-]): derating strategy [1 = constant speed, 2 = max speed, 3 = 'wt_data_dr_file' (default: 1)
* **f_gen** (float [rad/s]): frequency of 2nd order generator servo (default: 125.66370614359172)            
* **zeta_gen** (float [-]): damping ratio of 2nd order generator servo (default: 0.9)
* **f_pitch** (float [rad/s]): frequency of 2nd order pitch servo (default: 6.283185307179586)
* **zeta_pitch** (float [-]): damping ratio of 2nd order pitch servo (default: 0.7)
* **f_yaw** (float [[rad/s]): frequency of 2nd order yaw servo (default: 1.2566370614359172)
* **zeta_yaw** (float [-]): damping ratio of 2nd order yaw servo (default: 0.7)
* **yaw_thres_start** (float [deg]): yaw error limit start (default: 1.0)
* **yaw_thres_end** (float [deg]): yaw error limit end (default: 0.5)
* **yaw_rate** (float [deg/s]): yaw rate (default: 0.4)
* **dP_wt_ref_max** (float [-]): max power rate (default: 0.2)
* **dP_wt_ref_min** (float [-]): min power rate (default: -0.2)

Output
-------------------

* **V** (float [m/s], size [n_wt n_ts]): local wind speed (undisturbed)
* **Vdir** (float [deg], size [n_wt n_ts]): local wind direction (undisturbed)
* **VTI** (float [-], size [n_wt n_ts]): local turbulence intensity (undisturbed)
* **Veff_adv** (float [m/s], size [n_wt n_ts]): advected effective local wind speed
* **Vdireff_adv** (float [deg], size [n_wt n_ts]): advected effective local wind direction
* **V_turb** (float [m/s], size [n_wt n_ts]): local wind speed including synthetic turbulence
* **Vdir_turb** (float [deg], size [n_wt n_ts]): local wind direction including synthetic turbulence
* **Q_gen** (float [W], size [n_wt n_ts]): generator torque
* **P_gen** (float [W], size [n_wt n_ts]): generator electrical power
* **P_avail** (float [W], size [n_wt n_ts]): available generator electrical power
* **omega** (float [rad/s], size [n_wt n_ts]): rotor speed
* **pitch** (float [deg], size [n_wt n_ts]): blade pitch angle
* **yaw** (float [deg], size [n_wt n_ts]): yaw misalignment angle
* **WTdir_ctrl** (float [deg], size [n_wt n_ts]): nacelle orientation
* **Ct** (float [-], size [n_wt n_ts]): rotor thrust coefficient
* **P_wpp_mea** (float [-], size [n_ts]): total power plant electrical power
* **P_wpp_ava** (float [-], size [n_ts]): total power plant available electrical power
* **P_wpp_loss** (float [-], size [n_ts]): total power plant electrical losses
* **pwt_ref_disp** (float [-], size [n_wt n_ts]): power setpoint
* **yaw_ref_disp** (float [-], size [n_wt n_ts]): yaw setpoint

Parameters
-------------------

* **yaml_filename** (str [-]): yaml input filename
* **load_input_data** (dict [-]): dictionary of loaded yaml input
* **Cp_data** (float [-], size [n_erosion n_yaw n_tsr n_pitch]): 4D numpy array of input Cp data f(erosion,yaw,tsr,pitch)
* **Ct_data** (float, size [n_erosion n_yaw n_tsr n_pitch] [-]): 4D numpy array of input Cp data f(erosion,yaw,tsr,pitch)
* **erosion_data** (float, size [n_erosion]): numpy array of erosion level input data
* **pitch_data** (float, size [n_pitch]): numpy array of pitch input data
* **tsr_data** (float, size [n_tsr]): numpy array of tip speed ratio input data
* **yaw_data** (float, size [n_yaw]): numpy array of yaw input data
* **wpdata** (float, size [n_V_in n_pitch_min_in]): 2D numpy array of V, pitch_min input data
* **wt_data_dr** (float, size [n_pitch_min_in 5]): 2D numpy array of pitch_min, tsr, CT, CP, dCp
* **wtg** (object [-]): py wake wind turbine object
* ...+more

Variables
-------------------

* **wake_dt_i** (int [s], size [n_wt n_ts]): number of time steps for the wake advection delay
* **region** (int [-], size [n_wt n_ts]): controller region
* **errSpeed_int** (float [rad], size [n_wt n_ts]): integrated rotor speed error
* ...+more