Skip to main content

Solve the Fokker-Planck equation in N dimensions

Project description

Build Status PyPi Version Conda Version

FPlanck

FPlanck is a Python library for numerically solving the Fokker-Planck partial differential equation (also known as the Smoluchowski equation) in N dimensions using a matrix numerical method:

The method is based on the paper "Physically consistent numerical solver for time-dependent Fokker-Planck equations" by V. Holubec, K. Kroy, and S. Steffenoni, available on arXiv and published in APS.

Features

  • Can specify an external potential (conservative) and force field (non-conservative) in N-dimensions
  • Solve for the steady-state probability distribution and probability currents
  • Propagate any initial probability distribution to the solution at any later time
  • Periodic and reflecting boundary conditions (can be mixed along different dimensions)

Installation

FPlanck can be installed with pip

pip install fplanck

or conda

conda install -c japarker fplanck

Examples

On the left: a single particle in a titled periodic potential with periodic boundary conditions. The animation shows the time evolution of the probability distribution for the particle location. The PDF is driven in the positive direction due to the tilted potential.

On the right: a single particle in a 2D harmonic potential. The particle is initially away from the center of the harmonic well, and over time is restored to the center.

Usage

See the examples folder for how to use FPlanck.

License

FPlanck is licensed under the terms of the MIT license.


References

[1] Wikipedia contributors, "Fokker–Planck equation," Wikipedia, The Free Encyclopedia, https://en.wikipedia.org/w/index.php?title=Fokker%E2%80%93Planck_equation&oldid=906834519

[2] Holubec, V., Kroy, K. and Steffenoni, S., 2019. Physically consistent numerical solver for time-dependent Fokker-Planck equations. Physical Review E, 99(3), p.032117.

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

fplanck-0.2.2.tar.gz (6.3 kB view details)

Uploaded Source

Built Distribution

fplanck-0.2.2-py3-none-any.whl (8.7 kB view details)

Uploaded Python 3

File details

Details for the file fplanck-0.2.2.tar.gz.

File metadata

  • Download URL: fplanck-0.2.2.tar.gz
  • Upload date:
  • Size: 6.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.25.1 setuptools/52.0.0.post20210125 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.7.6

File hashes

Hashes for fplanck-0.2.2.tar.gz
Algorithm Hash digest
SHA256 907f38867e02b5b97c0a1aac94fe3fc71d0627c98b6f53f9b1e4c5578d01bfa0
MD5 0b8d9d213533462eb085fec1510d7dc0
BLAKE2b-256 4ef0fbc7fada445bc91c070f234cdcbb7e85bc5f2b053cd10938ab0c4d231026

See more details on using hashes here.

File details

Details for the file fplanck-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: fplanck-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 8.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.25.1 setuptools/52.0.0.post20210125 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.7.6

File hashes

Hashes for fplanck-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 5576ce9fa875fd604a386f33a5ba2ef10a7f16456a19df8a55f283c219507369
MD5 cb0f7a27adf9ccb189ab840163fcec03
BLAKE2b-256 5b96774e424fd97b2d935070dfdae4f239b857e1764f4d1966e8b525cd310e8b

See more details on using hashes here.

Supported by

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