Welcome to SWIFT: SPH With Inter-dependent Fine-grained Tasking’s documentation!

Want to get started using SWIFT? Check out the on-boarding guide available here.

SWIFT is an open-source cosmological and astrophysical numerical solver designed to run efficiently on modern hardware. A comprehensive and extensive set of models for galaxy formation as well as planetary physics are provided alongside a large series of examples.

This users’ and developers’ documentation is best enjoyed with a glass of Amarone and Rachmaninoff’s second piano concerto in the background. We note that good results have also been reported using a tumbler of 16yrs old Lagavulin.

• Disclaimer, Citing SWIFT & Giving Credit
  • Licensing
  • Disclaimer
  • Acknowledgment & Citation
• Getting Started
  • Compiling SWIFT
  • Running an Example
  • Runtime Options
  • Configuration Options
  • What about MPI? Running SWIFT on more than one node
  • Running on Large Systems
  • Special modes
• Command line options
• Parameter Files
  • File format and basic information
  • Meta Data
  • Internal Unit System
  • Cosmology
  • Gravity
  • SPH
  • Stars
  • Sinks
  • Time Integration
  • Initial Conditions
  • Physical Constants
  • Snapshots
  • Line-of-sight outputs
  • Light Cone Outputs
  • Equation of State (EoS)
  • Power Spectra Calculation
  • Friends-Of-Friends (FOF)
  • Statistics
  • Restarts
  • Scheduler
  • Domain Decomposition:
  • Structure finding (VELOCIraptor)
  • Gravity Force Checks
  • Neutrinos
  • Output List
  • Output Selection
  • Combining Output Lists and Output Selection
  • Using non-regular snapshot numbers
  • Compression Filters
• Initial Conditions
  • Structure of the File
  • Necessary Components
  • Optional Components
  • Summary
  • ICs split over multiple files
• Snapshots
  • Header
  • Meta-data about the code and run
  • Unit systems
  • Used and unused run-time parameters
  • Structure of the particle arrays
  • Unit information for individual fields
  • Particle splitting metadata
  • Quick access to particles via hash-tables
  • Meta-file for distributed snapshots
• Hydrodynamics Schemes
  • Traditional (Density-Entropy) SPH
  • Minimal (Density-Energy) SPH
  • Planetary (Density-Energy, Multi-Material) SPH
  • Pressure-Entropy SPH
  • Pressure-Energy SPH
  • ANARCHY-PU SPH
  • SPHENIX
  • Gasoline-2 SPH
  • Phantom
  • Adaptive Softening
  • GIZMO-Like Scheme
  • ShadowSWIFT (moving mesh hydrodynamics)
  • Adding Hydro Schemes
• Time integration details
  • Integer time-line & time-bins
  • Time-step limiter
  • Time-step synchronization
• Galaxy Formation Subgrid Models
  • EAGLE model
  • Quick Lyman-alpha (QLA) model
  • GEAR model
  • Sink particles and star formation in GEAR model
  • Basic model (others)
  • AGN jets and black hole spin in hydrodynamical simulations
  • AGORA model
• Planetary Simulations
  • Hydro Scheme
  • Equations of State
  • Initial Conditions
  • Removed Particles
• Friends-Of-Friends (FOF) Halo Finder
  • Friends-Of-Friends Algorithm
  • Stand-Alone Friends-Of-Friends
  • On-the-fly Friends-Of-Friends and Black Hole seeding
  • On-the-fly Friends-Of-Friends for snapshot output
  • Friends-Of-Friends Parameters
• VELOCIraptor Interface
  • What is VELOCIraptor?
  • Configuring SWIFT with VELOCIraptor
  • Stand alone VELOCIraptor configuration
  • VELOCIraptor Output
  • Orphan Particle Output
• Line-of-sights outputs
• Light Cone Outputs
  • Light Cone Output Algorithm
  • Light Cone Particle Output
  • Light Cone HEALPix Maps
  • Running SWIFT with Light Cone Output
  • Adding New Types of Output
• Equations of State
  • Gas EoS
  • Planetary EoS
  • How to Implement a New Equation of State
• External Potentials
  • Implemented External Potentials
  • How to implement your own potential
• Neutrino implementation
  • Relativistic Drift
  • Generating Fermi-Dirac momenta
  • Mesh Neutrinos
  • Background Neutrinos Only
• Radiative Transfer Schemes
  • Radiative Transfer in SWIFT
  • GEAR RT
  • SPHM1 RT
  • Notes for Developers
  • Additional Tools
• General information for adding new schemes
  • How to add your sink scheme
• Task System
  • Current Task Dependencies
  • Adding a Task
  • Adding a Particle Interaction/Neighbour Loop Task
  • Adding your Task to the Dependency Plotting Tool
  • Task Locks
• Analysis Tools
  • Task dependencies
  • Task dependencies for a single cell
  • Task levels
  • Cell graph
  • Memory usage reports
  • MPI task communication reports
  • Task and Threadpool Plots and Analysis Tools
  • Live internal inspection using the dumper thread
  • Deadlock Detector
  • Neighbour search statistics
• Continuous Simulation Data Stream (CSDS)
• Implementation details
  • Random number generator
  • Generating new unique IDs