MPC

class mpcpy.MPC(emulator, control, disturbances, emulationtime=604800, resulttimestep=600, nextstepcalculator=None, plotfunction=None)[source]

initialize an MPC object

Parameters:

emulator : mpcpy.Emulator

The emulator object to be used.

control : mpcpy.Control

The control object to be used.

disturbances : mpcpy.Disturbances

The disturbances object to be used.

emulationtime : number

The total time of the simulation.

resulttimestep : number

The timestep for which the results are returned.

nextstepcalculator : function

Function returning an integer representing the number of receding timesteps to skip. When not specified, no steps are skipped and the next step is 1.

plotfunction : function

A function which creates or updates a plot for live viewing of results, probably broken, untested.

__call__(verbose=0)[source]

Runs the mpc simulation

Parameters:

verbose: optional, int

Controls the amount of print output

Returns:

dict

A dictionary with results, also stored in the res attribute.