Turbine Input File Reference#
The turbine input file is an optional input used to define a custom turbine type. The file must be YAML format with either "yaml" or "yml" extension. See for more information on inspecting and creating the turbine definition.
- turbine_type
An ID for this type of turbine definition. This is used to uniquely identify different turbines in the simulation, so should be different for each different turbine definition being used in the same simulation. String type.
- hub_height
Turbine hub height in meters. Float type.
- rotor_diameter
Turbine rotor diameter in meters. Float type.
- TSR
Nominal wind turbine tip-speed ratio for below-rated operation. Only used in some wake models. Float type.
- operation_model
Model for power and thrust curve interpretation. See floris.core.turbine.operation_models for details. String type.
- power_thrust_table
- ref_air_density
Air density at which the power and thrust_coefficient curves are defined (kg / m^3). Float type.
- ref_tilt
Tilt angle at which the power and thrust_coefficient curves are defined (degrees). Used to capture the effects of a floating platform on a turbine's power and wake. Float type.
- cosine_loss_exponent_tilt
Cosine exponent for power loss due to tilt. Float type.
- cosine_loss_exponent_yaw
Cosine exponent for power loss due to yaw misalignment. Float type.
- helix_a
Helix parameter a. See documentation for details. Float type.
- helix_power_b
Helix parameter b for power calculation. See documentation for details. Float type.
- helix_power_c
Helix parameter c for power calculation. See documentation for details. Float type.
- helix_thrust_b
Helix parameter b for thrust calculation. See documentation for details. Float type.
- helix_thrust_c
Helix parameter c for thrust calculation. See documentation for details. Float type.
- peak_shaving_fraction
Fraction of peak thrust by which to reduce (specified as a decimal). Float type.
- peak_shaving_TI_threshold
Threshold turbulence intensity above which to apply peak shaving (specified as a decimal). Float tpe.
- controller_dependent_turbine_parameters
Parameters for the 'controller-dependenter-dependent' operation model. See floris.core.turbine.controller_dependent_operation_model and documentation for details.
- wind_speed
Wind speeds for look-up tables of power and thrust_coefficient. List of float type.
- power
Power values (specified in kW) for lookup by wind speed. List of float type.
- thrust_coefficient
Thrust coefficient values (unitless) for lookup by wind speed. List of float type.
Group of parameters needed to evaluate the power and thrust produced by the turbine.
- multi_dimensional_cp_ct
Boolean flag used when the user wants FLORIS to use the user-supplied multi-dimensional power/thrust coefficient information information. Boolean type.
- power_thrust_data_file
Path to the .csv file that contains the multi-dimensional power/thrust coefficient data. The format of this file is such that any external conditions, such as wave height or wave period, that the power/thrust data is dependent on come first, in column format. The last three columns of the .csv file must be
ws
,power
, andthrust_coefficient
, in that order. An example of fictional data is given infloris/turbine_library/iea_15MW_multi_dim_Tp_Hs.csv
. String type.- floating_tilt_table
- wind_speed
Wind speeds at which steady tilt angles are defined (m/s). List of float type.
- tilt
Tilt angle for each wind speed (degrees, positive "tilted back"). List of float type.
Group of parameters needed to evaluate the tilt angle of a floating turbine across wind speeds.
- correct_cp_ct_for_tilt
Flag for whether to apply the floating tilt table to correct turbine power and thrust curves. Boolean type.