Skip to main content

Differential Equation System Solver

Project description

DESolver

Build Status Documentation Status codecov BCH compliance

This is a python package for solving Initial Value Problems using various numerical integrators. Many integration routines are included ranging from fixed step to symplectic to adaptive integrators.

Documentation

Documentation is now available at desolver docs! This will be updated with new examples as they are written, currently the examples show the use of pyaudi.

Latest Release

4.2.0 - Improved performance of implicit methods, added embedded implicit methods following Kroulíková (2017) for fully implicit adaptive integration.

4.1.0 - Initial release of implicit integration schemes that use a basic newton-raphson algorithm to solve for the intermediate states.

3.0.0 - PyAudi support has been finalised. It is now possible to do numerical integrations using gdual variables such as gdual_double, gdual_vdouble and gdual_real128 (only on select platforms, refer to pyaudi docs for more information). Install desolver with pyaudi support using pip install desolver[pyaudi]. Documentation has also been added and is available at desolver docs.

2.5.0 - Event detection has been added to the module. It is now possible to do numerical integration with terminal and non-terminal events.

2.2.0 - PyTorch backend is now implemented. It is now possible to numerically integrate a system of equations that use pytorch tensors and then compute gradients from these.

Use of PyTorch backend requires installation of PyTorch from here.

To Install:

Just type

pip install desolver

Implemented Integration Methods

Explicit Methods

Adaptive Methods
  1. Runge-Kutta 14(12) (Feagin, 2009)

  2. Runge-Kutta 10(8) (Feagin, 2009)

  3. Runge-Kutta 8(7) (Dormand & Prince, 1980)

  4. Runge-Kutta 4(5) with Cash-Karp Coefficients

  5. Adaptive Heun-Euler Method

Fixed Step Methods
  1. Symplectic BABs9o7H Method (Mads & Nielsen, 2015, BAB’s9o7H)

  2. Symplectic ABAs5o6HA Method (Mads & Nielsen, 2015, ABAs5o6H)

  3. Runge-Kutta 5 - The 5th order integrator from RK45 with Cash-Karp Coefficients.

  4. Runge-Kutta 4 - The classic RK4 integrator

  5. Midpoint Method

  6. Heun’s Method

  7. Euler’s Method

  8. Euler-Trapezoidal Method

Implicit Methods [NEW]

Adaptive Methods
  1. Lobatto IIIC 4(2) (Kroulíková, 2017)

  2. Radau IIA 5(2) (Kroulíková, 2017)

Fixed Step Methods
  1. Backward Euler

  2. Implicit Midpoint

  3. Crank-Nicolson

  4. Lobatto IIIA 2

  5. Lobatto IIIB 2

  6. Lobatto IIIC 2

  7. Radau IA 3

  8. Radau IIA 3

  9. Lobatto IIIA 4

  10. Lobatto IIIB 4

  11. Gauss-Legendre 4

  12. Radau IA 5

  13. Radau IIA 6

Minimal Working Example

This example shows the integration of a harmonic oscillator using DESolver.

import desolver as de
import desolver.backend as D

def rhs(t, state, k, m, **kwargs):
    return D.array([[0.0, 1.0], [-k/m,  0.0]])@state

y_init = D.array([1., 0.])

a = de.OdeSystem(rhs, y0=y_init, dense_output=True, t=(0, 2*D.pi), dt=0.01, rtol=1e-9, atol=1e-9, constants=dict(k=1.0, m=1.0))

print(a)

a.integrate()

print(a)

print("If the integration was successful and correct, a[0].y and a[-1].y should be near identical.")
print("a[0].y  = {}".format(a[0].y))
print("a[-1].y = {}".format(a[-1].y))

print("Maximum difference from initial state after one oscillation cycle: {}".format(D.max(D.abs(a[0].y-a[-1].y))))

References

Feagin, T. (2009). High-Order Explicit Runge-Kutta Methods. Retrieved from https://sce.uhcl.edu/rungekutta/

Dormand, J. R. and Prince, P. J. (1980) A family of embedded Runge-Kutta formulae. Journal of Computational and Applied Mathematics, 6(1), 19-26. https://doi.org/10.1016/0771-050X(80)90013-3

Mads, K. and Nielsen, E. (2015). Efficient fourth order symplectic integrators for near-harmonic separable Hamiltonian systems. Retrieved from https://arxiv.org/abs/1501.04345

Kroulíková, T. (2017). RUNGE-KUTTA METHODS (Master’s thesis, BRNO UNIVERSITY OF TECHNOLOGY, Brno, Czechia). Retrieved from https://www.vutbr.cz/www_base/zav_prace_soubor_verejne.php?file_id=174714

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

desolver-4.3.1.tar.gz (60.5 kB view details)

Uploaded Source

Built Distribution

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

desolver-4.3.1-py3-none-any.whl (62.2 kB view details)

Uploaded Python 3

File details

Details for the file desolver-4.3.1.tar.gz.

File metadata

  • Download URL: desolver-4.3.1.tar.gz
  • Upload date:
  • Size: 60.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.3.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5

File hashes

Hashes for desolver-4.3.1.tar.gz
Algorithm Hash digest
SHA256 b5e75c851a772022c0f0982a0505a1449a54c1757de0975dfd4522c559018df8
MD5 fea81d97dc62b492b6c6b29e95bbe041
BLAKE2b-256 efe9df309a67b07c0ec34d2df90f6aa7b3e852da580f272d47cb4e6d3d05e26d

See more details on using hashes here.

File details

Details for the file desolver-4.3.1-py3-none-any.whl.

File metadata

  • Download URL: desolver-4.3.1-py3-none-any.whl
  • Upload date:
  • Size: 62.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.3.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5

File hashes

Hashes for desolver-4.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 70766df5b852e2a83e7febd0ac0cbab9497f6a93982d2f3c954839b6419abced
MD5 b3696bdb7adb164822a8a42fbb757540
BLAKE2b-256 5d9120a264139ad60c6cd3d0e9e7c88c1b53aa437eabc48e97053eeff509c1b7

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