Handler for the wake growth parameter k

Attributes¶

k_var: str

The name of the k variable

ti_var: str

The name of the TI variable

Public members¶

WakeK(k=None, ka=None, kb=None, k_var='k', ti_var='TI')[source]

Constructor.

repr()[source]

Provides the representative string

property is_kTI

Flag for ka != 0

property all_none

Flag for k=ka=kb=None

property use_amb_ti

Flag for using ambient ti

__call__(*args, lookup_ti='w', lookup_k='sw', ti=None, ...)[source]

Gets the k value

__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.

sub_models()[source]

List of all sub-models

load_data(algo, verbosity=0)[source]

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

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

Initializes the model.

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