electricpy.sim.statespace

electricpy.sim.statespace(A, B, x=None, func=None, C=None, D=None, simpts=9999, NN=10000, dt=0.01, xlim=False, ylim=False, title='', ret=False, plotstate=True, plotforcing=None, plotresult=None, filename=None)[source]

State-Space Simulation Plotter.

Parameters:
  • A (array_like) – Matrix A of State-Space Formulation

  • B (array_like) – Matrix B of State-Space Formulation

  • x (array_like, optional) – Initial Condition Matrix, if not provided, will assume initial conditions of zero.

  • f (function, optional) – State-Space Forcing Function; callable function that will return any/all forcing function Arguments needed as array-like object. Forcing function(s) can be provided as tuple of function handles, system will automatically concatenate their output to a matrix that can be handled.

  • simpts (int, optional) – Changes the range of simulation; defualt=9999

  • NN (int, optional) – Number of descrete points; default=10,000

  • dt (float, optional) – Time-step-size; default=0.01

  • xlim (list of float, optional) – Limit in x-axis for graph plot.

  • ylim (list of float, optional) – Limit in y-axis for graph plot.

  • title (str, optional) – Additional String for Plot Title

  • ret (bool, optional) – Control value to specify whether the state space terms should be returned.

  • plot (bool, optional) – Control value to enable/disable all plotting capabilities.

  • plotforcing (bool, optional) – Control value to enable plotting of the forcing function(s)

  • plotresult (bool, optional) – Control value to enable plotting of the final (combined) result.

  • **Figures**

  • Functions (Forcing) –

  • Variables (State) –

  • Output (Combined) –