controller

Base class for controllers

class Controller(net, edges, **kwargs)

Bases: object

Base class to create controllers. A controller has a global view of the network and can add new equations to the solution matrix.

Normally, a controller tries to minimize a certain function f.

__init__(net, edges, **kwargs)

Inits Controller.

Parameters:

• net (Network) – Network object. The controller stores a pointer to the network object.

• edges (array_like) – List of names of the controlled elements.

Return type:

None.

compute_der(**kwargs)

Returns the derivatives of f

compute_residuals(**kwargs)

Returns f

property control_matrix

Returns the control matrix for the controller

property edge_mask

Returns the mask of edges updated by the controller

get_control_matrix()

Returns the control matrix

get_edge()

Returns the name of controlled edges

get_edge_index()

Returns the index of controlled edges

is_initialized()

Returns True if the controller is initializated, False otherwise

property stage

Returns the stage in which the controller is used

update()

Updates the controlled parameters in the Network.