pywr.parameters.FlowDelayParameter¶
-
class
pywr.parameters.FlowDelayParameter(model, node, *args, **kwargs)¶ Parameter that returns the delayed flow for a node after a given number of timesteps or days
- Parameters
- modelpywr.model.Model
- node: Node
The node to delay for.
- timesteps: int
Number of timesteps to delay the flow.
- days: int
Number of days to delay the flow. Specifying a number of days (instead of a number of timesteps) is only valid if the number of days is exactly divisible by the model timestep length.
- initial_flow: float
Flow value to return for initial model timesteps prior to any delayed flow being available. This value is constant across all delayed timesteps and any model scenarios. Default is 0.0.
-
__init__(*args, **kwargs)¶ Initialize self. See help(type(self)) for accurate signature.
Methods
__init__(*args, **kwargs)Initialize self.
after(self)before(self)finish(self)get_all_values(self)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
childrencommentcomment: unicode
daysdays: ‘int’
double_sizedouble_size: ‘int’
initial_flowinitial_flow: ‘double’
integer_sizeinteger_size: ‘int’
is_variableis_variable: ‘bool’
modelnamenodenode: pywr._core.AbstractNode
parentssizetimestepstimesteps: ‘int’