floris.core.wake

floris.core.wake#

Classes

WakeModelManager(model_strings, ...[, ...])

WakeModelManager is a container class for the wake velocity, deflection, turbulence, and combination models.
class floris.core.wake.WakeModelManager(model_strings, enable_secondary_steering, enable_yaw_added_recovery, enable_active_wake_mixing, enable_transverse_velocities, wake_deflection_parameters, wake_turbulence_parameters, wake_velocity_parameters=NOTHING)[source]#

WakeModelManager is a container class for the wake velocity, deflection, turbulence, and combination models.

Args:
wake (dict): The wake's properties input dictionary

  • velocity_model (str): The name of the velocity model to be instantiated.

  • turbulence_model (str): The name of the turbulence model to be instantiated.

  • deflection_model (str): The name of the deflection model to be instantiated.

  • combination_model (str): The name of the combination model to be instantiated.

Parameters:

  • model_strings (dict)

  • enable_secondary_steering (bool)

  • enable_yaw_added_recovery (bool)

  • enable_active_wake_mixing (bool)

  • enable_transverse_velocities (bool)

  • wake_deflection_parameters (dict)

  • wake_turbulence_parameters (dict)

  • wake_velocity_parameters (dict)

model_strings: dict#
enable_secondary_steering: bool#
enable_yaw_added_recovery: bool#
enable_active_wake_mixing: bool#
enable_transverse_velocities: bool#
wake_deflection_parameters: dict#
wake_turbulence_parameters: dict#
wake_velocity_parameters: dict#
combination_model: BaseModel#
deflection_model: BaseModel#
turbulence_model: BaseModel#
velocity_model: BaseModel#
validate_model_strings(instance, value)[source]#
Return type:

None

Parameters:

  • instance (Attribute)

  • value (dict)

property deflection_function#
property velocity_function#
property turbulence_function#
property combination_function#