Abstract base class for top-hat wake models.

Parameters¶

induction: foxes.core.AxialInductionModel or str

The induction model

Public members¶

TopHatWakeModel(superpositions, induction='Betz')[source]

Constructor.

sub_models()[source]

List of all sub-models

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

Initializes the model.

abstract calc_wake_radius(algo, mdata, fdata, pdata, ...)[source]

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

abstract calc_centreline_wake_deltas(algo, mdata, fdata, pdata, ...)[source]

Calculate centre line results of wake deltas.

calc_wakes_spsel_x_r(algo, mdata, fdata, pdata, ...)[source]

Calculate wake deltas.

calc_wakes_spsel_x_yz(algo, mdata, fdata, pdata, ...)[source]

Calculate wake deltas.

contribute_to_wake_deltas(algo, mdata, fdata, pdata, ...)[source]

Calculate the contribution to the wake deltas by this wake model.

finalize_wake_deltas(algo, mdata, fdata, pdata, amb_results, ...)[source]

Finalize the wake calculation.

abstract init_wake_deltas(algo, mdata, fdata, pdata, wake_deltas)[source]

Initialize wake delta storage.

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.

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

data_to_store(name, algo, data)[source]

Adds data from mdata to the local store, intended for iterative runs.

from_data_or_store(name, algo, data, ret_dims=False, safe=False)[source]

Get data from mdata or local store