h2integrate.converters.wind.floris

h2integrate.converters.wind.floris#

Classes

FlorisWindPlantPerformanceConfig(...[, ...])

Configuration class for FlorisWindPlantPerformanceModel.

FlorisWindPlantPerformanceModel(**kwargs)

An OpenMDAO component that wraps a Floris model.
class h2integrate.converters.wind.floris.FlorisWindPlantPerformanceConfig(num_turbines, floris_wake_config, floris_turbine_config, default_turbulence_intensity, operational_losses, hub_height=-1, adjust_air_density_for_elevation=False, operation_model='cosine-loss', layout={}, resource_data_averaging_method='weighted_average', hybrid_turbine_design=False, *, enable_caching, cache_dir)#

Configuration class for FlorisWindPlantPerformanceModel.

Parameters:

  • num_turbines (int)

  • floris_wake_config (dict)

  • floris_turbine_config (dict)

  • default_turbulence_intensity (float)

  • operational_losses (float)

  • hub_height (float)

  • adjust_air_density_for_elevation (bool)

  • operation_model (str)

  • layout (dict)

  • resource_data_averaging_method (str)

  • hybrid_turbine_design (bool)

  • enable_caching (bool)

  • cache_dir (str | Path)

num_turbines#

number of turbines in farm

Type:

int

floris_wake_config#

dictionary containing FLORIS inputs for flow_field, wake, solver, and logging.

Type:

dict

floris_turbine_config#

dictionary containing turbine parameters formatted for FLORIS.

Type:

dict

operational_losses#

non-wake losses represented as a percentage (between 0 and 100).

Type:

float | int

hub_height#

a value of -1 indicates to use the hub-height from the floris_turbine_config. Otherwise, is the turbine hub-height in meters. Defaults to -1.

Type:

float | int, optional

operation_model#

turbine operation model. Defaults to ‘cosine-loss’.

Type:

str, optional

default_turbulence_intensity#

default turbulence intensity to use if not found in wind resource data.

Type:

float

layout#

layout parameters dictionary.

Type:

dict

resource_data_averaging_method#

string indicating what method to use to adjust or select resource data if no resource data is available at a height exactly equal to the turbine hub-height. Defaults to ‘weighted_average’. The available methods are: - ‘weighted_average’: average the resource data at the heights that most closely bound

the hub-height, weighted by the difference between the resource heights and the hub-height.

  • ‘average’: average the resource data at the heights that most closely bound

    the hub-height.

  • ‘nearest’: use the resource data at the height closest to the hub-height.

Type:

str

enable_caching#

if True, checks if the outputs have be saved to a cached file or saves outputs to a file. Defaults to True.

Type:

bool, optional

cache_dir#

folder to use for reading or writing cached results files. Only used if enable_caching is True. Defaults to “cache”.

Type:

str | Path, optional

hybrid_turbine_design#

whether multiple turbine types are included in the farm. Defaults to False. The functionality to use multiple turbine types is not yet implemented. Will result in NotImplementedError if True.

Type:

bool, optional

num_turbines: int#
floris_wake_config: dict#
floris_turbine_config: dict#
default_turbulence_intensity: float#
operational_losses: float#
hub_height: float#
adjust_air_density_for_elevation: bool#
operation_model: str#
layout: dict#
resource_data_averaging_method: str#
hybrid_turbine_design: bool#
class h2integrate.converters.wind.floris.FlorisWindPlantPerformanceModel(**kwargs)#

An OpenMDAO component that wraps a Floris model. It takes wind turbine model parameters and wind resource data as input and outputs power generation data.

setup()#

Declare inputs and outputs.

Available attributes:

name pathname comm options

format_resource_data(hub_height, wind_resource_data)#
compute(inputs, outputs, discrete_inputs, discrete_outputs)#

Computation for the OM component.

For a template class this is not implement and raises an error.

Contents