Dedalus: A Flexible Framework for Numerical Simulations with Spectral Methods

Abstract

Numerical solutions of partial differential equations enable a broad range of scientific research. The Dedalus Project is a flexible, open-source, parallelized computational framework for solving general partial differential equations using spectral methods. Dedalus translates plain-text strings describing partial differential equations into efficient solvers. This paper details the numerical method that enables this translation, describes the design and implementation of the codebase, and illustrates its capabilities with a variety of example problems. The numerical method is a first-order generalized tau formulation that discretizes equations into banded matrices. This method is implemented with an object-oriented design. Classes for spectral bases and domains manage the discretization and automatic parallel distribution of variables. Discretized fields and mathematical operators are symbolically manipulated with a basic computer algebra system. Initial value, boundary value, and eigenvalue problems are efficiently solved using high-performance linear algebra, transform, and parallel communication libraries. Custom analysis outputs can also be specified in plain text and stored in self-describing portable formats. The performance of the code is evaluated with a parallel scaling benchmark and a comparison to a finite-volume code. The features and flexibility of the codebase are illustrated by solving several examples: the nonlinear Schrodinger equation on a graph, a supersonic magnetohydrodynamic vortex, quasigeostrophic flow, Stokes flow in a cylindrical annulus, normal modes of a radiative atmosphere, and diamagnetic levitation. The Dedalus code and the example problems are available online at http://dedalus-project.org/.

40 pages, 18 figures. Accepted to Physical Review Research

References in corpus (62)

• SciPy 1.0--Fundamental Algorithms for Scientific Computing in Python
• Athena: A New Code for Astrophysical MHD
• Approaching the Asymptotic Regime of Rapidly Rotating Convection: Boundary Layers vs Interior Dynamics
• Anomalous price impact and the critical nature of liquidity in financial markets
• Local Radiation Hydrodynamic Simulations of Massive Star Envelopes at the Iron Opacity Peak
• A Godunov Method for Multidimensional Radiation Magnetohydrodynamics based on a variable Eddington tensor
• Black Hole Accretion Discs and Luminous Transients in Failed Supernovae from Non-Rotating Supergiants
• A Validated Nonlinear Kelvin-Helmholtz Benchmark for Numerical Hydrodynamics
• Radiative heating achieves the ultimate regime of thermal convection
• Nonlinear Schrödinger equation on graphs: recent results and open problems
• The effects of Ekman pumping on quasi-geostrophic Rayleigh-Benard convection
• A nonlinear model for rotationally constrained convection with Ekman pumping
• A fourth-order accurate finite volume method for ideal MHD via upwind constrained transport
• Stellar mixing length theory with entropy rain
• A bulk-interface correspondence for equatorial waves
• Energy conservation and gravity waves in sound-proof treatments of stellar interiors: Part II Lagrangian constrained analysis
• Constrained hyperbolic divergence cleaning in smoothed particle magnetohydrodynamics with variable cleaning speeds
• Conversion of Internal Gravity Waves into Magnetic Waves
• Low-frequency variability in massive stars: Core generation or surface phenomenon?
• A Simple System for Moist Convection: the Rainy-Benard Model
• Tensor calculus in polar coordinates using Jacobi polynomials
• Turbulent Chemical Diffusion in Convectively Bounded Carbon Flames
• Order Out of Chaos: Slowly Reversing Mean Flows Emerge from Turbulently Generated Internal Waves
• Sudden viscous dissipation of compressing turbulence
• Entrainment in Resolved, Dry Thermals
• Theory of the tertiary instability and the Dimits shift from reduced drift-wave models
• The energy flux spectrum of internal waves generated by turbulent convection
• Three-Dimensional Rotating Couette Flow Via The Generalised Quasilinear Approximation
• Buoyant Motion of a Turbulent Thermal
• High-Lundquist Number Scaling in Three-Dimensional Simulations of Parker's Model of Coronal Heating
• Dynamics of Mixed Convective--Stably-Stratified Fluids
• Anomalous chained turbulence in actively driven flows on spheres
• Conduction in low Mach number flows: Part I Linear & weakly nonlinear regimes
• Quantum hydrodynamics for supersolid crystals and quasicrystals
• Entropy Rain: Dilution and Compression of Thermals in Stratified Domains
• Strong wave-mean-flow coupling in baroclinic acoustic streaming
• Near-polytropic simulations with a radiative surface
• Chiral Maxwell waves in continuous media from Berry monopoles
• Convective dynamics and disequilibrium chemistry in the atmospheres of giant planets and brown dwarfs
• Spatial evolution of human dialects
• Compressing turbulence and sudden viscous dissipation with compression-dependent ionization state
• Convective heat transport in stratified atmospheres at low and high Mach number
• The weakly nonlinear magnetorotational instability in a local geometry
• Buoyancy-Driven Entrainment in Dry Thermals
• The magnitude of viscous dissipation in strongly stratified two-dimensional convection
• An asymptotic model for the propagation of oceanic internal tides through quasi-geostrophic flow
• Role of stable modes in driven shear-flow turbulence
• Predicting the Rossby number in convective experiments
• The weakly nonlinear magnetorotational instability in a global, cylindrical Taylor-Couette flow
• Connection between Nonlinear Energy Optimization and Instantons
• Multiple scales analysis of slow--fast quasilinear systems
• Accelerated evolution of convective simulations
• On symmetrizing the ultraspherical spectral method for self-adjoint problems
• A Vorticity-Preserving Hydrodynamical Scheme for Modeling Accretion Disk Flows
• Magnetic eddy viscosity of mean shear flows in two-dimensional magnetohydrodynamics
• Solitary zonal structures in subcritical drift waves: a minimum model
• Hybrid Chebyshev function bases for sparse spectral methods in parity-mixed PDEs on an infinite domain
• Parallel-in-time integration of Kinematic Dynamos
• Convection-driven kinematic dynamos with a self-consistent shear flow
• Generalised Quasilinear Approximation of the Interaction of Convection and Mean Flows in a Thermal Annulus
• Predicting critical ignition in slow-fast excitable models
• Energy-conserving Galerkin approximations for quasigeostrophic dynamics

Cited by in corpus (180)

• Modules for Experiments in Stellar Astrophysics (MESA): Time-Dependent Convection, Energy Conservation, Automatic Differentiation, and Infrastructure
• The Athena++ Adaptive Mesh Refinement Framework: Design and Magnetohydrodynamic Solvers
• Non-reciprocal phase transitions
• Topological Gaseous Plasmon Polariton in Realistic Plasma
• Aspect ratio affects iceberg melting
• Pattern formation by turbulent cascades
• Asteroseismic inference of the near-core magnetic field strength in the main sequence B star HD 43317
• Topography generation by melting and freezing in a turbulent shear flow
• Stellar convective penetration: parameterized theory and dynamical simulations
• Improved phase-field models of melting and dissolution in multi-component flows
• IDEFIX: a versatile performance-portable Godunov code for astrophysical flows
• Coherent structures in plane channel flow of dilute polymer solutions with vanishing inertia
• Stratified and vertically-shearing streaming instabilities in protoplanetary disks
• Experimental observation of the geostrophic turbulence regime of rapidly rotating convection
• Improving convergence of volume penalised fluid-solid interactions
• The photometric variability of massive stars due to gravity waves excited by core convection
• An extensible lattice Boltzmann method for viscoelastic flows: complex and moving boundaries in Oldroyd-B fluids
• Schwarzschild and Ledoux are equivalent on evolutionary timescales
• Stride: a flexible platform for high-performance ultrasound computed tomography
• Dynamics, scaling behavior, and control of nuclear wrinkling
• Heat transport and convective velocities in compositionally-driven convection in neutron star and white dwarf interiors
• Single-hemisphere dynamos in M-dwarf stars
• Layer formation in a stably-stratified fluid cooled from above. Towards an analog for Jupiter and other gas giants
• Wave topology brought to the coast
• Dynamical phase transitions in the nonreciprocal Ising model
• The Equatorial Jet Speed on Tidally Locked Planets: I -- Terrestrial Planets
• Nontrivial topology in the continuous spectrum of a magnetized plasma
• Dynamic flows create potentially habitable conditions in Antarctic subglacial lakes
• Exact coherent structures and phase space geometry of pre-turbulent 2D active nematic channel flow
• Global stability of fluid flows despite transient growth of energy
• Learning developmental mode dynamics from single-cell trajectories
• Finite-amplitude elastic waves in viscoelastic channel flow from large to zero Reynolds number
• Magnetohydrodynamics with Physics Informed Neural Operators
• On the Vertical Shear Instability in Magnetized Protoplanetary Disks
• Evolution of Semi-convective Staircases in Rotating Flows: Consequences for Fuzzy Cores in Giant Planets
• Buoyancy-Driven Entrainment in Dry Thermals
• On the role of the Prandtl number in convection driven by heat sources and sinks
• Exploiting self-organized criticality in strongly stratified turbulence
• Surface Manifestation of Stochastically Excited Internal Gravity Waves
• Magnetohydrodynamic Simulations of the Tayler Instability in Rotating Stellar Interiors
• Turbulent Convection in Subglacial Lakes
• Wind-Induced Changes to Surface Gravity Wave Shape in Shallow Water
• Unidirectional modes induced by nontraditional Coriolis force in stratified fluids
• High-Rayleigh-number convection in porous-fluid layers
• Coherent Solutions and Transition to Turbulence in Two-Dimensional Rayleigh-Bénard Convection
• Penetration of a cooling convective layer into a stably-stratified composition gradient: entrainment at low Prandtl number
• A spectral solver for solar inertial waves
• Active turbulence and spontaneous phase separation in inhomogeneous extensile active gels
• Spectrally Adapted Physics-Informed Neural Networks for Solving Unbounded Domain Problems
• Multidimensional Simulations of Core Convection
• Linearly forced fluid flow on a rotating sphere
• Excitations and spectra from equilibrium real-time Green's functions
• Manifestation of Berry curvature in geophysical ray tracing
• General Relativistic Hydrodynamics on a Moving-mesh I: Static Spacetimes
• Topology of rotating stratified fluids with and without background shear flow
• Linear stability analysis of purely elastic travelling wave solutions in pressure driven channel flows
• Topological modes in stellar oscillations
• Inducing exceptional points, enhancing plasmon quality and creating correlated plasmon states with modulated Floquet parametric driving
• Shape and size of large-scale vortices: A generic fluid pattern in geophysical fluid dynamics
• Multi-modal excitation to model the Quasi-Biennial Oscillation
• The Stability of Prendergast Magnetic Fields
• Non-reciprocal interactions spatially propagate fluctuations in a 2D Ising model
• Spectrally Decomposed Diffusion Models for Generative Turbulence Recovery
• Three-dimensional numerical simulations of ambipolar diffusion in NS cores in the one-fluid approximation: instability of poloidal magnetic field
• The Nusselt numbers of horizontal convection
• Remarks on compressible convection in Super-Earths
• 3D Simulations of Semiconvection in Spheres: Turbulent Mixing and Layer Formation
• The Magnetorotational Instability Prefers Three Dimensions
• Near-cancellation of up- and down-gradient momentum transport in forced magnetized shear-flow turbulence
• High-order Discontinuous Galerkin hydrodynamics with sub-cell shock capturing on GPUs
• Staircase solutions and stability in vertically confined salt-finger convection
• Adaptive Uncertainty-Guided Model Selection for Data-Driven PDE Discovery
• The impact of magnetic fields on momentum transport and saturation of shear-flow instability by stable modes
• Transport and emergent stratification in the equilibrated Eady model: the vortex gas scaling regime
• A direct derivation of the Gent-McWilliams/Redi diffusion tensor from quasi-geostrophic dynamics
• A Spectral Approach for Learning Spatiotemporal Neural Differential Equations
• Mechanism for Sequestering Magnetic Energy at Large Scales in Shear-Flow Turbulence
• Oceanic dipoles in a surface quasigeostrophic model
• Computing with functions in the ball
• Nonlinear mode coupling and energetics of driven magnetized shear-flow turbulence
• Automated differential equation solver based on the parametric approximation optimization
• A fast sparse spectral method for nonlinear integro-differential Volterra equations with general kernels
• Marginally-Stable Thermal Equilibria of Rayleigh-Bénard Convection
• Light controlled THz plasmonic time varying media: momentum gaps, entangled plasmon pairs, and pulse induced time reversal
• A systematic route to subcritical dynamo branches
• Improved assessment of the statistical stability of turbulent flows using extended Orr-Sommerfeld stability analysis
• Shear flows and their suppression at large aspect ratio. Two-dimensional simulations of a growing convection zone
• Elastoinertial turbulence: Data-driven reduced-order model based on manifold dynamics
• Mechanochemical Topological Defects in an Active Nematic
• Two-dimensional turbulence with local interactions: statistics of the condensate
• Convection in a mushy-layer along a heated wall
• Two-dimensional hydrodynamic electron flow through periodic and random potentials
• Floquet stability of oscillating boundary layers on adiabatic slopes
• Performance of parallel-in-time integration for Rayleigh Bénard Convection
• Convective dynamics with mixed temperature boundary conditions: why thermal relaxation matters and how to accelerate it
• A playground for compressible natural convection with a nearly uniform density
• Modulation-Slippage Tradeoff in Resonant Four-Wave Upconversion
• Resistive instabilities in sinusoidal shear flows with a streamwise magnetic field
• Threshold transient growth as a criterion for turbulent mean profiles
• A Discontinuous Galerkin Solver in the FLASH Multi-Physics Framework
• Do chaotic field lines cause fast reconnection in coronal loops?
• Elasticity of tangled magnetic fields
• Validating and improving two-fluid simulations of the magnetic field evolution in neutron star cores
• Self-similarity and growth of non-linear magnetic Rayleigh-Taylor instability -- Role of the magnetic field strength
• Statistics of inhomogeneous turbulence in large scale quasi-geostrophic dynamics
• Efficiency gains of a multi-scale integration method applied to a scale-separated model for rapidly rotating dynamos
• Latent assimilation with implicit neural representations for unknown dynamics
• The westward drift of Jupiter's polar cyclones explained by a center-of-mass approach
• Gyroscopic polynomials
• Learnable-Differentiable Finite Volume Solver for Accelerated Simulation of Flows
• Aspect-ratio-dependent heat transport by baroclinic acoustic streaming
• Traveling spatially localized convective structures in an inclined porous medium
• On the Linear Stability of Partially and Fully Saturated Atmospheres to Moist Convection
• Rossby wave instability in weakly ionized protoplanetary disks. II. radial B-fields
• Bathymetry reconstruction from experimental data using PDE-constrained optimisation
• Spatio-Temporal Dynamics of Nucleo-Cytoplasmic Transport
• Dynamics and Scaling of Internally Cooled Convection
• A crystallographic approach to symmetry-breaking in fluid layers
• Generation of shear flows and vortices in rotating anelastic convection
• Spontaneous generation of helical flows by salt fingers
• Conversion and Damping of Nonaxisymmetric Internal Gravity Waves in Magnetized Stellar Cores
• On the Geometry of the Near-Core Magnetic Field in Massive Stars
• The propagation and decay of a coastal vortex on a shelf
• Resonant and near-resonant internal wave triads for non-uniform stratifications. Part 2: Vertically bounded domain with mild-slope bathymetry
• Normal modes with boundary dynamics in geophysical fluids
• Exploring the probing power of gamma-Dor's inertial dip for core magnetism: case of a toroidal field
• Emergent vorticity asymmetry of one and two-layer shallow water system captured by a next-order balanced model
• Pseudo-spectral solver versus grid-based solver: A quantitative accuracy test using GMHD3D and PLUTO4.4
• Multiple scales analysis of a nonlinear timestepping instability in simulations of solitons
• Vortex line entanglement in active Beltrami flows
• Dynamical constraints on the vertical structure of Jupiter's polar cyclones
• Meridional Circulation Streamlined
• Superfluid Spin-up: 3D Simulations of Post-Glitch Dynamics in Neutron Star Cores
• Rapidly Rotating Wall-Mode Convection
• Out-of-equilibrium fluxes shape the self-organization of locally-interacting turbulence
• Assessing the validity of the anelastic and Boussinesq approximations to model solar inertial modes
• Direct Statistical Simulation of the Busse Annulus
• Variational construction of tubular and toroidal streamsurfaces for flow visualization
• Dust Growth in ALMA Rings: II. Dusty Rossby Wave Instability
• Model of deep zonal flows in giant planets
• 3D Simulations of Convective Entrainment in Gas Giants: Rotation and Decreasing Luminosity as Barriers to Mixing
• Large-Scale Dynamos Driven by Shear-Flow-Induced Jets
• A self-consistent numerical model of internal wave-induced mean flow oscillations in polar geometry
• Resolving Turbulent Magnetohydrodynamics: A Hybrid Operator-Diffusion Framework
• Non-linear saturation of gravito-inertial modes excited by tidal resonances in binary neutron stars
• Bounds on dissipation in three-dimensional planar shear flows: reduction to two-dimensional problems
• Hydrodynamic stability and pattern formation in hexatic epithelial layers
• On the applicability of the actuator line method for unsteady aerodynamics
• Uncertainty in Elastic Turbulence
• Symmetric instability in a Boussinesq fluid on a rotating planet
• Traveling vegetation-herbivore waves can sustain ecosystems threatened by droughts and population growth
• Turbulence suppression in plane Couette flow using reduced-order models
• Internally heated and fully compressible convection: flow morphology and scaling laws
• Low-Frequency Internal Gravity Waves are Pseudo-incompressible
• Model for transitional turbulence in a planar shear flow
• Boundary-Bound Reactions: Pattern Formation with and without Hydrodynamics
• Compositional Turbulence and Layering in the Gaseous Envelopes of Forming Planets
• On the stability of isothermal shocks in black hole accretion disks
• On the Discrete Normal Modes of Quasigeostrophic Theory
• The modification of turbulent thermal wind balance by non-traditional effects
• Impact of spatial coarsening on Parareal convergence for the linear advection equation
• Geometric Localization of Waves on Thin Elastic Structures
• Rational function approximation with normalized positive denominators
• Effect of insulator end cap thickness on time-dependent Hartmann flow in a rotating mirror
• Understanding long-range opposite charge repulsion in multivalent salt solutions
• Transport and mixing in control volumes through the lens of probability
• On nonlinear transitions, minimal seeds and exact solutions for the geodynamo
• Three-dimensional tearing instability of flux-tube-like magnetic fields
• Planetary Rhythms: Synchronous Circulation on Variably Irradiated Asynchronous Planets
• Active Hydrodynamic Theory of Euchromatin and Heterochromatin
• The stability of propagating plane inertial waves in rotating fluids
• The reflection-transmission problem for inertial waves on geostrophic shear layers
• Mechanisms of Superrotation in Slowly-Rotating and Tidally-Locked Planets
• Effects of the radiative interior on solar inertial modes
• Coupling between Phase Separation and Geometry on a Closed Elastic Curve: Free Energy Minimization and Dynamics
• Inefficiency of chiral dynamos in protoneutron stars and the early universe
• Towards inertial-mode helioseismology: Direct sensing of solar rotation at 75 deg latitude and 0.8 Rsun
• Fourier Neural Operators for Rayleigh-Bénard Convection
• Instability triggered by mixed convection in a thin fluid layer
• Numerical simulation of electron magnetohydrodynamics with Landau-quantized electrons in magnetar crusts