pywr.nodes.Input

class pywr.nodes.Input(*args, **kwargs)

A general input at any point in the network

__init__(*args, **kwargs)

Initialise a new Input node

Parameters
min_flowfloat (optional)

A simple minimum flow constraint for the input. Defaults to None

max_flowfloat (optional)

A simple maximum flow constraint for the input. Defaults to 0.0

Methods

__init__(*args, **kwargs)

Initialise a new Input node

after(self, Timestep ts)

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’