pywr.recorders.TotalParameterRecorder

class pywr.recorders.TotalParameterRecorder(*args, **kwargs)

Record the total value of a Parameter during a simulation.

This recorder can be used to track the sum total of the values returned by a Parameter during a models simulation. An optional factor can be provided to apply a linear scaling of the values. If the parameter represents a flux the integrate keyword argument can be used to multiply the values by the time-step length in days.

Parameters:

modelpywr.core.Model

parampywr.parameters.Parameter

The parameter to record.

namestr (optional)

The name of the recorder

factorfloat (default=1.0)

Scaling factor for the values of param.

integratebool (default=False)

Whether to multiply by the time-step length in days during summation.

__init__(*args, **kwargs)

Methods

__init__(*args, **kwargs)
after(self)
aggregated_value(self)
before(self)
finish(self)
is_constraint_violated(self)	Returns true if the value from this Recorder violates its constraint bounds.
load(cls, model, data)
register(cls)
reset(self)
setup(self)
unregister(cls)
values(self)

Attributes

agg_func
children
comment	comment: str
constraint_lower_bounds
constraint_upper_bounds
epsilon	epsilon: 'double'
factor	factor: 'double'
ignore_nan	ignore_nan: 'bool'
integrate	integrate: 'bool'
is_constraint	Returns true if either upper or lower constraint bounds is defined.
is_double_bounded_constraint	Returns true if upper and lower constraint bounds are both defined and not-equal to one another.
is_equality_constraint	Returns true if upper and lower constraint bounds are both defined and equal to one another.
is_lower_bounded_constraint	Returns true if lower constraint bounds is defined and upper constraint bounds is not.
is_objective
is_upper_bounded_constraint	Returns true if upper constraint bounds is defined and lower constraint bounds is not.
model
name
parameter
parents
tags	tags: dict