MPC

class mpcpy.MPC(emulator, control, boundaryconditions, 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.

boundaryconditions : mpcpy.Boundaryconditions

The boundaryconditions 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.