4 Reference manual

The py-pde package provides tools for solving partial differential equations.

This package provides classes and methods for solving partial differential equations (PDEs) on various grids using different numerical methods. Key components include:

• Fields: Data structures representing scalar, vector, and tensor fields on grids

• Grids: Spatial discretizations including Cartesian and curvilinear coordinates

• PDEs: Pre-defined PDEs and a framework for defining custom PDEs

• Solvers: Time-stepping algorithms for evolving PDEs

• Trackers: Tools for monitoring and analyzing simulations

• Storage: Methods for storing simulation data

• Visualization: Functions for visualizing fields and creating movies

For detailed documentation, see the submodules.

Subpackages:

• 4.1 pde.backends package
  • 4.1.1 pde.backends.jax package
    • 4.1.1.1 pde.backends.jax.operators package
      • 4.1.1.1.1 pde.backends.jax.operators.cartesian module
      • 4.1.1.1.2 pde.backends.jax.operators.cylindrical_sym module
      • 4.1.1.1.3 pde.backends.jax.operators.polar_sym module
      • 4.1.1.1.4 pde.backends.jax.operators.spherical_sym module
    • 4.1.1.2 pde.backends.jax.backend module
    • 4.1.1.3 pde.backends.jax.config module
    • 4.1.1.4 pde.backends.jax.typing module
  • 4.1.2 pde.backends.numba package
    • 4.1.2.1 pde.backends.numba.operators package
      • 4.1.2.1.1 pde.backends.numba.operators.cartesian module
      • 4.1.2.1.2 pde.backends.numba.operators.common module
      • 4.1.2.1.3 pde.backends.numba.operators.cylindrical_sym module
      • 4.1.2.1.4 pde.backends.numba.operators.polar_sym module
      • 4.1.2.1.5 pde.backends.numba.operators.spherical_sym module
    • 4.1.2.2 pde.backends.numba.backend module
    • 4.1.2.3 pde.backends.numba.config module
    • 4.1.2.4 pde.backends.numba.grids module
    • 4.1.2.5 pde.backends.numba.overloads module
    • 4.1.2.6 pde.backends.numba.utils module
  • 4.1.3 pde.backends.numba_mpi package
    • 4.1.3.1 pde.backends.numba_mpi.backend module
    • 4.1.3.2 pde.backends.numba_mpi.overloads module
  • 4.1.4 pde.backends.numpy package
    • 4.1.4.1 pde.backends.numpy.backend module
  • 4.1.5 pde.backends.scipy package
    • 4.1.5.1 pde.backends.scipy.operators package
      • 4.1.5.1.1 pde.backends.scipy.operators.cartesian module
      • 4.1.5.1.2 pde.backends.scipy.operators.common module
      • 4.1.5.1.3 pde.backends.scipy.operators.cylindrical_sym module
      • 4.1.5.1.4 pde.backends.scipy.operators.polar_sym module
      • 4.1.5.1.5 pde.backends.scipy.operators.spherical_sym module
    • 4.1.5.2 pde.backends.scipy.backend module
  • 4.1.6 pde.backends.torch package
    • 4.1.6.1 pde.backends.torch.operators package
      • 4.1.6.1.1 pde.backends.torch.operators.cartesian module
      • 4.1.6.1.2 pde.backends.torch.operators.common module
      • 4.1.6.1.3 pde.backends.torch.operators.cylindrical_sym module
      • 4.1.6.1.4 pde.backends.torch.operators.polar_sym module
      • 4.1.6.1.5 pde.backends.torch.operators.spherical_sym module
    • 4.1.6.2 pde.backends.torch.backend module
    • 4.1.6.3 pde.backends.torch.config module
    • 4.1.6.4 pde.backends.torch.typing module
    • 4.1.6.5 pde.backends.torch.utils module
  • 4.1.7 pde.backends.base module
  • 4.1.8 pde.backends.registry module
• 4.2 pde.fields package
  • 4.2.1 pde.fields.base module
  • 4.2.2 pde.fields.collection module
  • 4.2.3 pde.fields.datafield_base module
  • 4.2.4 pde.fields.scalar module
  • 4.2.5 pde.fields.tensorial module
  • 4.2.6 pde.fields.vectorial module
• 4.3 pde.grids package
  • 4.3.1 pde.grids.boundaries package
    • 4.3.1.1 Boundary conditions
    • 4.3.1.2 Boundaries overview
    • 4.3.1.3 pde.grids.boundaries.axes module
    • 4.3.1.4 pde.grids.boundaries.axis module
    • 4.3.1.5 pde.grids.boundaries.local module
  • 4.3.2 pde.grids.coordinates package
    • 4.3.2.1 pde.grids.coordinates.base module
    • 4.3.2.2 pde.grids.coordinates.bipolar module
    • 4.3.2.3 pde.grids.coordinates.bispherical module
    • 4.3.2.4 pde.grids.coordinates.cartesian module
    • 4.3.2.5 pde.grids.coordinates.cylindrical module
    • 4.3.2.6 pde.grids.coordinates.polar module
    • 4.3.2.7 pde.grids.coordinates.spherical module
  • 4.3.3 pde.grids.base module
  • 4.3.4 pde.grids.cartesian module
  • 4.3.5 pde.grids.cylindrical module
  • 4.3.6 pde.grids.spherical module
• 4.4 pde.pdes package
  • 4.4.1 pde.pdes.allen_cahn module
  • 4.4.2 pde.pdes.base module
  • 4.4.3 pde.pdes.cahn_hilliard module
  • 4.4.4 pde.pdes.diffusion module
  • 4.4.5 pde.pdes.klein_gordon module
  • 4.4.6 pde.pdes.kpz_interface module
  • 4.4.7 pde.pdes.kuramoto_sivashinsky module
  • 4.4.8 pde.pdes.laplace module
  • 4.4.9 pde.pdes.pde module
  • 4.4.10 pde.pdes.swift_hohenberg module
  • 4.4.11 pde.pdes.wave module
• 4.5 pde.solvers package
  • 4.5.1 pde.solvers.adams_bashforth module
  • 4.5.2 pde.solvers.base module
  • 4.5.3 pde.solvers.controller module
  • 4.5.4 pde.solvers.crank_nicolson module
  • 4.5.5 pde.solvers.euler module
  • 4.5.6 pde.solvers.explicit_mpi module
  • 4.5.7 pde.solvers.implicit module
  • 4.5.8 pde.solvers.milstein module
  • 4.5.9 pde.solvers.runge_kutta module
  • 4.5.10 pde.solvers.scipy module
• 4.6 pde.storage package
  • 4.6.1 pde.storage.base module
  • 4.6.2 pde.storage.file module
  • 4.6.3 pde.storage.memory module
  • 4.6.4 pde.storage.modelrunner module
  • 4.6.5 pde.storage.movie module
• 4.7 pde.tools package
  • 4.7.1 pde.tools.cache module
  • 4.7.2 pde.tools.config module
  • 4.7.3 pde.tools.cuboid module
  • 4.7.4 pde.tools.docstrings module
  • 4.7.5 pde.tools.expressions module
  • 4.7.6 pde.tools.ffmpeg module
  • 4.7.7 pde.tools.math module
  • 4.7.8 pde.tools.misc module
  • 4.7.9 pde.tools.modelrunner module
  • 4.7.10 pde.tools.mpi module
  • 4.7.11 pde.tools.numba module
  • 4.7.12 pde.tools.output module
  • 4.7.13 pde.tools.parse_duration module
  • 4.7.14 pde.tools.plotting module
  • 4.7.15 pde.tools.spectral module
  • 4.7.16 pde.tools.typing module
• 4.8 pde.trackers package
  • 4.8.1 pde.trackers.base module
  • 4.8.2 pde.trackers.interactive module
  • 4.8.3 pde.trackers.interrupts module
  • 4.8.4 pde.trackers.trackers module
• 4.9 pde.visualization package
  • 4.9.1 pde.visualization.movies module
  • 4.9.2 pde.visualization.plotting module