Abstract base class for top-hat wake models.

Parameters¶

induction: foxes.core.AxialInductionModel or str

The induction model

Public members¶

TopHatWakeModel(*args, induction='Betz', **kwargs)[source]

Constructor.

sub_models()[source]

List of all sub-models

initialize(algo, verbosity=0, force=False)[source]

Initializes the model.

new_wake_deltas(algo, mdata, fdata, tdata)[source]

Creates new empty wake delta arrays.

abstractmethod calc_wake_radius(algo, mdata, fdata, tdata, ...)[source]

Calculate the wake radius, depending on x only (not r).

abstractmethod calc_centreline(algo, mdata, fdata, tdata, ...)[source]

Calculate centre line results of wake deltas.

calc_wakes_x_r(algo, mdata, fdata, tdata, downwind_index, x, r)[source]

Calculate wake deltas.

calc_wakes_x_yz(algo, mdata, fdata, tdata, downwind_index, x, yz)[source]

Calculate wake deltas.

contribute(algo, mdata, fdata, tdata, downwind_index, ...)[source]

Modifies wake deltas at target points by contributions from the specified wake source turbines.

property has_vector_wind_superp

This model uses a wind vector superposition

finalize_wake_deltas(algo, mdata, fdata, tdata, wake_deltas)[source]

Finalize the wake calculation.

property affects_ws

Flag for wind speed wake models

property affects_downwind

Flag for downwind or upwind effects on other turbines

property has_uv

This model uses wind vector data

classmethod new(wmodel_type, *args, **kwargs)[source]

Run-time wake model factory.

__repr__()[source]

Return repr(self).

property model_id

Unique id based on the model type.

var(v)[source]

Creates a model specific variable name.

property initialized

Initialization flag.

load_data(algo, verbosity=0)[source]

Load and/or create all model data that is subject to chunking.

property running

Flag for currently running models

set_running(algo, data_stash, sel=None, isel=None, verbosity=0)[source]

Sets this model status to running, and moves all large data to stash.

unset_running(algo, data_stash, sel=None, isel=None, verbosity=0)[source]

Sets this model status to not running, recovering large data from stash

finalize(algo, verbosity=0)[source]

Finalizes the model.

get_data(variable, target, lookup='smfp', mdata=None, ...)[source]

Getter for a data entry in the model object or provided data sources