Main Input File Reference

In additional to reinitializing FlorisInterface, users can configure FLORIS with an input file. The file must be YAML format with either "yaml" or "yml" extension. The below definitions guide a user to the top, mid, and lower level parameterizations. A few reference input files are available in the floris/examples folder.

name

A name for this input file. This is not currently only for the user's reference.

description

A description of the contents of this input file. This is not currently only for the user's reference.

floris_version

The earliest verion of FLORIS this input file supports. This is not currently only for the user's reference.

logging

Configure the logging level and where to show the logs.

console

Settings for logging to the console (i.e. terminal).

enable

Can be "true" or "false".

level

Set the severity to show output. Messages at this level or higher will be shown. Can be one of "CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG".

file

Settings for logging to a file.

enable

Can be "true" or "false".

level

Set the severity to show output. Messages at this level or higher will be shown. Can be one of "CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG".

solver

Configure the solver for the type of simulation.

type

Select the solver type. Can be one of: "turbine_grid", "flow_field_grid", "flow_field_planar_grid".

turbine_grid_points

Options for the turbine type selected above. See the solver documentation for available parameters.

farm

Configure the turbine types and their placement within the wind farm.

layout_x

Coordinates for the turbine locations in the x-direction which is typically considered to be the streamwise direction (left, right) when the wind is out of the west. The order of the coordinates here corresponds to the index of the turbine in the primary data structures.

layout_y

Coordinates for the turbine locations in the y-direction which is typically considered to be the spanwise direction (up, down) when the wind is out of the west. The order of the coordinates here corresponds to the index of the turbine in the primary data structures.

turbine_type

Listing of turbine types for placement at the x and y coordinates given above. The list length must be 1 or the same as layout_x and layout_y. If it is a single value, all turbines are of the same type. Otherwise, the turbine type is mapped to the location at the same index in layout_x and layout_y. The types can be either a name included in the turbine_library or a full definition of a wind turbine directly.

flow_field

Configure the atmospheric conditions.

air_density

Air density.

reference_wind_height

The height to consider the "center" of the vertical wind speed profile due to shear. With a shear exponent not 1, the wind speed at this height will be the value given in wind_speeds. Above and below this height, the wind speed will change according to the shear profile; see FlowField.initialize_velocity_field(). For farms consisting of one wind turbine type, use reference_wind_height: -1 to use the hub height of the wind turbine definition. For multiple wind turbine types, the reference wind height must be given explicitly.

turbulence_intensities

The turbulence intensities to include in the simulation, specified as a decimal.

wind_directions

The wind directions to include in the simulation. 0 is north and 270 is west.

wind_shear

The exponent used to model the wind shear profile; see FlowField.initialize_velocity_field().

wind_speeds

The wind speeds to include in the simulation.

wind_veer

The wind veer as a constant value for all points in the grid.

multidim_conditions

The conditions that are specified for use with the multi-dimensional Cp/Ct capbility. These conditions are external to FLORIS and specified by the user. They are used internally through a nearest-neighbor selection process to choose the correct Cp/Ct interpolants to use.

wake

Configure the wake model.

model_strings

Select the models to use for the simulation. See wake for a list of available models and their descriptions.

combination_model

Select the wake combination model.

deflection_model

Select the wake deflection model.

turbulence_model

Select the wake turbulence model.

velocity_model

Select the wake velocity deficit model.

enable_secondary_steering

Can be "true" or "false".

enable_yaw_added_recovery

Can be "true" or "false".

enable_active_wake_mixing

Can be "true" or "false".

enable_transverse_velocities

Can be "true" or "false".

wake_deflection_parameters

Configure the parameters for the wake deflection model selected above. Additional blocks can be provided for models that are not enabled, but the enabled model must have a corresponding parameter block.

wake_velocity_parameters

Configure the parameters for the wake velocity deficit model selected above. Additional blocks can be provided for models that are not enabled, but the enabled model must have a corresponding parameter block.

wake_turbulence_parameters

Configure the parameters for the wake turbulence model selected above. Additional blocks can be provided for models that are not enabled, but the enabled model must have a corresponding parameter block.