pywr.parameters.UniformDrawdownProfileParameter

class pywr.parameters.UniformDrawdownProfileParameter(model, reset_day=1, reset_month=1, residual_days=0, **kwargs)

Parameter which provides a uniformly reducing value from one to zero.

This parameter is intended to be used with an AnnualVirtualStorage node to provide a profile that represents perfect average utilisation of the annual volume. It returns a value of 1 on the reset day, and subsequently reduces by 1/366 every day afterward.

Parameters
reset_day: int

The day of the month (1-31) to reset the volume to the initial value.

reset_month: int

The month of the year (1-12) to reset the volume to the initial value.

residual_days: int

The number of days of residual licence to target for the end of the year.

See also

AnnualVirtualStorage
__init__(*args, **kwargs)

Methods

__init__(*args, **kwargs)

after(self)

before(self)

finish(self)

get_all_values(self)

get_constant_value(self)

Return a constant value.

get_double_lower_bounds(self)

get_double_upper_bounds(self)

get_double_variables(self)

get_integer_lower_bounds(self)

get_integer_upper_bounds(self)

get_integer_variables(self)

get_value(self, ScenarioIndex scenario_index)

load(type cls, model, data)

register(type cls)

reset(self)

set_double_variables(self, double[)

set_integer_variables(self, int[)

setup(self)

unregister(type cls)

value(self, Timestep ts, ...)

Attributes

children

comment

comment: unicode

double_size

double_size: 'int'

integer_size

integer_size: 'int'

is_constant

is_variable

is_variable: 'bool'

model

name

parents

reset_day

reset_day: 'int'

reset_month

reset_month: 'int'

residual_days

residual_days: 'int'

size

tags

tags: dict