Skip to main content

a class to integrate ordinary differential equation

Project description

Simulate

Using simulatetraj, initial value problems can be solved numerically. In the backend, an adaptive numerical integration is performed using CVODES from the SUNDIALS suite.

Given initial state $x(t_0)=x_0$ and control inputs $u(t)$ on $t \in [t_0,t_f]$, the state trajectory $x(t)$ is computed for the explicit differential equation $\dot{x}=f(x,u,t,p)$.

Symbol Description Dimensions
$x(t)$ State vector $\mathbb{R}^{n_x}$
$u(t)$ Control vector $\mathbb{R}^{n_u}$
$p$ Parameter vector $\mathbb{R}^{n_p}$
$t$ time $\mathbb{R}^{1}$

Dependencies

  • casadi==3.6.4
  • matplotlib==3.8.2

Installation

At the moment, the package is tested and run on Windows 10.

pip install simulatetraj

venv

  • Create virtual environment using venv
  • All dependencies and package will be installed automatically

conda

  • create conda environment with python >=3.1
  • type pip install poetry
  • from the directory containing the toml file, type poetry install
  • all dependencies and package will be installed

Run the python notebooks from examples folder to verify the installation.

Limitations

  • casadi based limitaions apply

Usage

Consider the initial value problem given below where the behaviour of the system is studied with respect to given set of inputs and initial condition. Lets make it parameteric by adding a scalar parameter to the ode and setting its value to zero.

ODE 1

$$ \begin{aligned} (t_0,t_f,N)&=(0,10,25)\ x(t_0)&=\begin{bmatrix} 0\ 0 \end{bmatrix} \ u(t)&=0.2t-1\ p&=0\ \begin{bmatrix} \dot{x}_0\ \dot{x}_1 \end{bmatrix}&= \begin{bmatrix} (1-x_1^2)x_0-x_1+u\ x_0 \end{bmatrix}+p \end{aligned} $$

The problem can be solved in 2 ways using Simulate.

  1. eliminate controls from the ode
  2. supply controls evaluated on the grid points

Elimination

Define the number of states and parameter by calling the constructor of the Simulate class. Both the methods are equivalent. Skipping an argument simply sets it to zero.

a=Simulate(n_x=cs.MX(2),n_p=cs.MX(1))
a=Simulate(n_x=cs.MX(2),n_u=cs.MX(0),n_p=cs.MX(1))

Once the states, controls and parameters are defined, set the numerical grid for integration. The state vector will be computed at these time points. tini, tfin and N are the initial time, final time and number of intervals, respectively.

a.set_grid(tini=cs.MX(0),tfin=cs.MX(10),N=cs.MX(25))

The Simulate class has symbolic attributes for the state, control and parameter vector (t,x,u,p) which can be used to define the dynamics of the system. These are MX symbolics offered by casadi. If nonlinear functions like trignometric function are to be applied, they must be imported from the casadi namespace.

f=cs.vertcat((1-a.x[1]**2)*a.x[0]-a.x[1]+0.2*a.t-1,a.x[0])+a.p
a.set_ode(f)

Set the initial condition and parameter value and solve the initial value problem. t is the time grid and a.r['xf'] has the state values at the grid point except for the initial time.

x0=cs.DM([0,0])
a.start(X0=cs.horzcat(x0),P=cs.DM(0))
r=a.r
t=a.t_grid

Plot the state and control time histories.

a.plot_sol()

alt text alt text

without control elimination

The control input is approximated as a piecewise constant function.

a=Simulate(n_x=cs.MX(2),n_u=cs.MX(1),n_p=cs.MX(1))
a.set_grid(cs.MX(0),cs.MX(10),cs.MX(25))
f=cs.vertcat((1-a.x[1]**2)*a.x[0]-a.x[1]+a.u,a.x[0])+a.p
a.set_ode(f)
x0=cs.DM([0,0])
a.start(X0=cs.horzcat(x0),U=cs.linspace(-1,1,25).T,P=cs.DM(0))
r=a.r
t=a.t_grid
a.plot_sol()

alt text alt text alt text

$t^2$

$$ \begin{aligned} (t_0,t_f,N)&=(0,10,100000)\ x(t_0)&=0\ \dot{x}&=2t \end{aligned} $$

b=Simulate(cs.MX(1))
b.set_grid(tini=cs.MX(0),tfin=cs.MX(10),N=cs.MX(100000))
f=2*b.t
b.set_ode(f)
x0=cs.DM([0])
b.start(x0)
b.plot_sol()
print('Global error x(N+1) for xdot=2t:',cs.evalf(b.r['xf'][-1]-100))
Global error x(N+1) for xdot=2t: 0.0016011

alt text

The default values for cvodes is 0.001 and 0.1 for absolute and relative tolerance, respectively. By increasing the tolerance global error can be reduced.

 b.start(x0,tol=1e-12)
Global error x(N+1) for xdot=2t: 4.81748e-12

Lotka voltera/prey-predator model

$$ \begin{aligned} (t_0,t_f,N)&=(0,15,1000)\ (\alpha,\beta)&=(0.01,0.02)\ x(t_0)&=\begin{bmatrix} 20\ 20 \end{bmatrix}\ \begin{bmatrix} \dot{x}_0\ \dot{x}_1 \end{bmatrix}&= \begin{bmatrix} x_0-\alpha x_0 x_1\ -x_1+\beta x_0 x_1 \end{bmatrix} \end{aligned} $$

d=Simulate(n_x=cs.MX(2),n_p=cs.MX(2))
d.set_grid(cs.MX(0),cs.MX(15),cs.MX(1000))
f=cs.vertcat(d.x[0]-d.p[0]*d.x[0]*d.x[1],-d.x[1]+d.p[1]*d.x[0]*d.x[1])
d.set_ode(f)
x0=cs.DM([20,20])
p=cs.DM([0.01,0.02])
d.start(X0=x0,P=p,tol=1e-8)
#d.plot_sol()
plt.plot(cs.evalf(d.r['xf'][0,:]),cs.evalf(d.r['xf'][1,:]),'o')
plt.show()

alt text

Advanced

The integrator class can be used in conjunction with trajectory optimization, where the symbolic primitives can be passed for initial state and control inputs. This can be embedded in an optimization problem and solved for the optimal control input vector. See examples folder where single and multiple shooting methods have been implemented and solved.

c=Simulate(cs.MX(1),cs.MX(1))
c.set_grid(cs.MX.sym('tf',1,1),cs.MX.sym('tf',1,1),cs.MX(10))
f=2*c.t+c.u
c.set_ode(f)
x0=cs.DM([0])
c.start(x0,cs.MX.sym('u',1,10))  

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

simulatetraj-0.0.2.tar.gz (18.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

simulatetraj-0.0.2-py3-none-any.whl (18.9 kB view details)

Uploaded Python 3

File details

Details for the file simulatetraj-0.0.2.tar.gz.

File metadata

  • Download URL: simulatetraj-0.0.2.tar.gz
  • Upload date:
  • Size: 18.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.11.4 Windows/10

File hashes

Hashes for simulatetraj-0.0.2.tar.gz
Algorithm Hash digest
SHA256 9473fef661fcc91972c2d109b83325f671c9723682eb6f0465810677ae1148ae
MD5 cc23a516893aed5f54793e2951b5c2ed
BLAKE2b-256 2fb64e6eff4df9f54125fb13c3da575153737de74ee2dcb13b6ad8e1f4313063

See more details on using hashes here.

File details

Details for the file simulatetraj-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: simulatetraj-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 18.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.11.4 Windows/10

File hashes

Hashes for simulatetraj-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0dd3c6ba6321ca958b8ca8421bf3d7171580a9458c1a6f15d9299ec515c93748
MD5 b0cb79c5de8188c495a14aac054d5de8
BLAKE2b-256 1623b21ada74012f7718782480d3ea3d893d80b168ade4fcd76e2c1e1d68d45c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page