ard.farm_aero.floris

ard.farm_aero.floris#

Classes

`FLORISAEP`(**kwargs)	Component class for computing an AEP analysis using FLORIS.
`FLORISBatchPower`(**kwargs)	Component class for computing a batch power analysis using FLORIS.
`FLORISFarmComponent`()	Secondary-inherit component for managing FLORIS for farm simulations.

class ard.farm_aero.floris.FLORISFarmComponent[source]#

Secondary-inherit component for managing FLORIS for farm simulations.

This is a base class for farm aerodynamics simulations using FLORIS, which should cover all the necessary configuration, reproducibility config file saving, and output directory management.

It is not a child class of an OpenMDAO components, but it is designed to mirror the form of the OM component, so that FLORIS activities are separated to have run times that correspond to the similarly-named OM component methods. It is intended to be a second-inherit base class for FLORIS-based OpenMDAO components, and will not work unless the calling object is a specialized class that _also_ specializes openmdao.api.Component.

Options#

case_titlestr: a "title" for the case, used to disambiguate runs in practice

initialize()[source]#: Initialization-time FLORIS management.

setup()[source]#: Setup-time FLORIS management.

compute(inputs)[source]#

Compute-time FLORIS management.

Compute-time FLORIS management should be specialized based on use case. If the base class is not specialized, an error will be raised.

setup_partials()[source]#: Derivative setup for OM component.

get_AEP_farm()[source]#: Get the AEP of a FLORIS farm.

get_power_farm()[source]#: Get the farm power of a FLORIS farm at each wind condition.

get_power_turbines()[source]#: Get the turbine powers of a FLORIS farm at each wind condition.

get_thrust_turbines()[source]#: Get the turbine thrusts of a FLORIS farm at each wind condition.

dump_floris_yamlfile(dir_output=None)[source]#: Export the current FLORIS inputs to a YAML file file for reproducibility of the analysis. The file will be saved in the dir_output directory, or in the current working directory if dir_output is None.

class ard.farm_aero.floris.FLORISBatchPower(**kwargs)[source]#

Component class for computing a batch power analysis using FLORIS.

A component class that evaluates a series of farm power and associated quantities using FLORIS. Inherits the interface from templates.BatchFarmPowerTemplate and the computational guts from FLORISFarmComponent.

Options#

case_titlestr: a "title" for the case, used to disambiguate runs in practice (inherited from FLORISFarmComponent)
modeling_optionsdict: a modeling options dictionary (inherited via templates.BatchFarmPowerTemplate)
wind_queryfloris.wind_data.WindRose: a WindQuery objects that specifies the wind conditions that are to be computed (inherited from templates.BatchFarmPowerTemplate)

Inputs#

x_turbinesnp.ndarray: a 1D numpy array indicating the x-dimension locations of the turbines, with length N_turbines (inherited via templates.BatchFarmPowerTemplate)
y_turbinesnp.ndarray: a 1D numpy array indicating the y-dimension locations of the turbines, with length N_turbines (inherited via templates.BatchFarmPowerTemplate)
yaw_turbinesnp.ndarray: a numpy array indicating the yaw angle to drive each turbine to with respect to the ambient wind direction, with length N_turbines (inherited via templates.BatchFarmPowerTemplate)

Outputs#

power_farmnp.ndarray: an array of the farm power for each of the wind conditions that have been queried (inherited from templates.BatchFarmPowerTemplate)
power_turbinesnp.ndarray: an array of the farm power for each of the turbines in the farm across all of the conditions that have been queried on the wind rose (N_turbines, N_wind_conditions) (inherited from templates.BatchFarmPowerTemplate)
thrust_turbinesnp.ndarray: an array of the wind turbine thrust for each of the turbines in the farm across all of the conditions that have been queried on the wind rose (N_turbines, N_wind_conditions) (inherited from templates.BatchFarmPowerTemplate)

initialize()[source]#: Initialization of OM component.

setup()[source]#: Setup of OM component.

setup_partials()[source]#: Derivative setup for OM component.

compute(inputs, outputs)[source]#

Computation for the OM component.

For a template class this is not implemented and raises an error!

class ard.farm_aero.floris.FLORISAEP(**kwargs)[source]#

Component class for computing an AEP analysis using FLORIS.

A component class that evaluates a series of farm power and associated quantities using FLORIS with a wind rose to make an AEP estimate. Inherits the interface from templates.FarmAEPTemplate and the computational guts from FLORISFarmComponent.

Options#

case_titlestr: a "title" for the case, used to disambiguate runs in practice (inherited from FLORISFarmComponent)
modeling_optionsdict: a modeling options dictionary (inherited via templates.FarmAEPTemplate)
wind_queryfloris.wind_data.WindRose: a WindQuery objects that specifies the wind conditions that are to be computed (inherited from templates.FarmAEPTemplate)

Inputs#

x_turbinesnp.ndarray: a 1D numpy array indicating the x-dimension locations of the turbines, with length N_turbines (inherited via templates.FarmAEPTemplate)
y_turbinesnp.ndarray: a 1D numpy array indicating the y-dimension locations of the turbines, with length N_turbines (inherited via templates.FarmAEPTemplate)
yaw_turbinesnp.ndarray: a numpy array indicating the yaw angle to drive each turbine to with respect to the ambient wind direction, with length N_turbines (inherited via templates.FarmAEPTemplate)

Outputs#

AEP_farmfloat: the AEP of the farm given by the analysis (inherited from templates.FarmAEPTemplate)
power_farmnp.ndarray: an array of the farm power for each of the wind conditions that have been queried (inherited from templates.FarmAEPTemplate)
power_turbinesnp.ndarray: an array of the farm power for each of the turbines in the farm across all of the conditions that have been queried on the wind rose (N_turbines, N_wind_conditions) (inherited from templates.FarmAEPTemplate)
thrust_turbinesnp.ndarray: an array of the wind turbine thrust for each of the turbines in the farm across all of the conditions that have been queried on the wind rose (N_turbines, N_wind_conditions) (inherited from templates.FarmAEPTemplate)

initialize()[source]#: Initialization of OM component.

setup()[source]#: Setup of OM component.

compute(inputs, outputs)[source]#

Computation for the OM component.

For a template class this is not implemented and raises an error!

setup_partials()[source]#: Derivative setup for OM component.

ard.farm_aero.floris

Contents

ard.farm_aero.floris#

Options#

Options#

Inputs#

Outputs#

Options#

Inputs#

Outputs#