pywr.domains.river.RiverSplitWithGauge

class pywr.domains.river.RiverSplitWithGauge(*args, **kwargs)

A split in the river network with a minimum residual flow

As per RiverSplit but by default creates another route in the underlying object

to model a MRF. This route is such that the MRF is not part of forced ratios. The intent of this object is to model the case where a proportion of flow can be abstracted above the MRF (e.g. 90% of flow above MRF).

Parameters

mrffloat

The minimum residual flow (MRF) at the gauge

mrf_costfloat

The cost of the route via the MRF

costfloat

The cost of the other (unconstrained) route

factorsiterable of floats

The factors to force on the additional splits. Number of extra_slot is assumed to be one less than the length of factors (as per MultiSplitLink documentation).

slot_namesiterable

The identifiers to refer to the slots when connect from this Node. Length must be one more than

the number of extra slots required.

__init__(model, name, mrf=0.0, cost=0.0, mrf_cost=0.0, **kwargs)

Initialise a new Node object

Parameters

modelModel

The model the node belongs to

namestring

A unique name for the node

Methods

__init__(model, name[, mrf, cost, mrf_cost])	Initialise a new Node object
after(timestep)	Set total flow on this link as sum of sublinks
before(self, Timestep ts)	Called at the beginning of the timestep
check()	Check the node is valid
commit(self, int scenario_index, double value)	Called once for each route the node is a member of
commit_all(self, double[)	Called once for each route the node is a member of
connect(node[, from_slot, to_slot])	Create an edge from this Node to another Node
disconnect([node, slot_name, all_slots])	Remove a connection from this Node to another Node
finish(self)
get_conversion_factor(self)	Get the conversion factor
get_cost(self, ScenarioIndex scenario_index)	Get the cost per unit flow at a given timestep
get_max_flow(self, ScenarioIndex scenario_index)	Get the maximum flow at a given timestep
get_min_flow(self, ScenarioIndex scenario_index)	Get the minimum flow at a given timestep
iter_slots([slot_name, is_connector])	Returns the object(s) wich should be connected to given slot_name
load(data, model)
reset(self)	Called at the beginning of a run
setup(self, model)	Called before the first run of the model

Attributes

allow_isolated	A property to flag whether this Node can be unconnected in a network.
comment	comment: basestring
component_attrs
components	Generator that returns all of the Components attached to the Node
conversion_factor	The conversion between inflow and outflow for the node
cost	The cost per unit flow via the node
domain
flow	Total flow via this node in the current timestep
fully_qualified_name
max_flow	The maximum flow constraint on the node
min_flow	The minimum flow constraint on the node
model	The recorder for the node, e.g.
name	Name of the node.
parent	The parent Node/Storage of this object.
prev_flow	Total flow via this node in the previous timestep
recorders	Returns a list of pywr.recorders.Recorder objects attached to this node.
virtual	virtual: ‘bool’