Initial conditions / pre-cooked configurations
How to select a pre-cooked compile-time configuration
When writing your local Makefile simply give the name of the desired SETUP variable as the argument. For example:
~/phantom/scripts/writemake.sh disc > Makefile
Alternatively you can override this manually at compile-time:
make SETUP=disc
make SETUP=disc setup
Possible values of the SETUP variable are listed below.
Well-maintained setups
The most used, well-maintained and supported options for the SETUP variable are:
SETUP= |
description |
compile-time options |
initial conditions file |
|---|---|---|---|
disc |
locally isothermal gas disc |
disc viscosity, isothermal |
|
star |
import stellar model from 1D stellar evolution code |
self-gravity |
|
binary |
binary stars |
self-gravity |
|
wind |
wind setup with dust nucleation |
||
jet |
Jet simulation from Price, Tricco & Bate (2012) |
MHD, self-gravity, isothermal, periodic |
|
turb |
driven supersonic turbulence (hydro, mhd, dusty) |
isothermal |
|
cluster |
star cluster formation |
self-gravity, isothermal |
All setups
The full list of pre-cooked configurations (taken from build/Makefile_setups) is as follows:
SETUP= |
description |
compile-time options |
initial conditions file |
|---|---|---|---|
BHL |
Bondi-Hoyle-Lyttleton setup |
||
adiabaticdisc |
adiabatic disc |
disc viscosity |
|
alfven |
MHD circularly polarised Alfven wave problem |
MHD, periodic |
|
asteroidwind |
asteroid emitting a wind (Trevascus et al. 2021) |
isothermal |
|
balsarakim |
Balsara-Kim 2004 |
MHD, periodic |
|
binary |
binary stars |
self-gravity |
|
binarydiscMFlow |
binarydiscMFlow setup |
isothermal |
|
blob |
Blob evaporation problem |
periodic |
|
bondi |
Bondi accretion flow |
isothermal |
|
cluster |
star cluster formation |
self-gravity, isothermal |
|
common |
binary setup |
||
converging |
Simulation from Wurster & Bonnell (2023) |
no, self-gravity, no, periodic |
|
default |
default setup, uniform box |
dust, periodic |
|
disc |
locally isothermal gas disc |
disc viscosity, isothermal |
|
dustsettle |
dust settling test from PL15 |
dust, isothermal, periodic |
|
dustybox |
dust in a box |
dust, isothermal, periodic |
|
dustydisc |
locally isothermal dusty discs |
dust, disc viscosity, isothermal |
|
dustyisosgdisc |
isothermal self-gravitating dustydisc |
dust, self-gravity, disc viscosity, isothermal |
|
dustysedov |
Sedov blast wave test with dust |
dust, periodic |
|
dustysgdisc |
self-gravitating dustydisc |
dust, self-gravity |
|
dustyshock |
shock tube tests with dust |
dust, periodic |
|
dustystar |
import stellar model from 1D stellar evolution code w/dust |
self-gravity |
|
dustywave |
dust in a box |
dust, periodic |
|
empty |
empty setup for external-driver simulation |
||
evrard |
Evrard collapse test problem |
self-gravity |
|
exoALMA |
exoALMA comparison of planet-disc interaction |
isothermal |
|
firehose |
injection of a stream of gas as a firehose |
||
flrw |
constant density FLRW cosmology with perturbations |
GR, et, periodic |
|
flrwpspec |
FLRW universe using a CMB powerspectrum |
GR, et, periodic |
|
galaxies |
galaxy merger using data from Wurster & Thacker (2013a,b) |
self-gravity |
|
galcen |
galactic centre |
||
galdisc |
galactic disc simulations |
||
galdiscmhd |
galactic disc simulations with magnetic fields |
MHD, isothermal |
|
gr_testparticles |
test particles in GR |
GR, kerr |
|
grbondi |
Bondi accretion flow in GR |
GR, schwarzschild |
|
grbondi-inject |
Bondi accretion flow in GR with particle injection |
GR, schwarzschild |
|
grdisc |
accretion disc around a Kerr black hole |
GR, kerr |
|
growingdisc |
locally isothermal dusty discs with growth and fragmentation |
dust, disc viscosity, isothermal |
|
growthtomulti |
transform dustgrowth dump into multi large grains dump |
dust, disc viscosity, isothermal |
|
grstar |
star in GR using Minkowski metric |
GR, minkowski, self-gravity |
|
grtde |
tidal disruption event in general relativity |
GR, kerr, self-gravity |
|
gwdisc |
disc around inspiralling binary with gravitational wave decay |
disc viscosity, isothermal |
|
hierarchical |
hierarchical system setup |
||
ismwind |
wind setup with dust nucleation and ISM cooling |
||
isosgdisc |
isothermal self-gravitating disc |
self-gravity, disc viscosity, isothermal |
|
isowind |
isothermal spherical wind |
isothermal |
|
jadvect |
MHD current loop advection problem |
MHD, periodic |
|
jet |
Jet simulation from Price, Tricco & Bate (2012) |
MHD, self-gravity, isothermal, periodic |
|
jetdusty |
dust in star formation |
no, dust, self-gravity, isothermal, periodic |
|
jetnimhd |
Simulation from Wurster, Price & Bate (2016,2017) et seq |
MHD, non-ideal, self-gravity, isothermal, periodic |
|
kh |
Kelvin-Helmholtz problem |
periodic |
|
lightcurvedisc |
adiabatic disc with lightcurve |
disc viscosity |
|
mhdblast |
MHD blast wave test |
MHD, periodic |
|
mhdrotor |
MHD rotor problem |
MHD, periodic |
|
mhdshock |
Ryu & Brio-Wu shock tube tests |
MHD, periodic |
|
mhdsine |
MHD sine wave |
MHD, periodic |
|
mhdvortex |
Balsara (2004) MHD vortex |
MHD, periodic |
|
mhdwave |
propagating isolated MHD wave |
MHD, periodic |
|
neutronstar |
isolated neutron star |
isothermal |
|
nimhdshock |
non-ideal mhd standing and C shock tests |
MHD, non-ideal, isothermal, periodic |
|
nshwdisc |
disc around a neutron star |
disc viscosity, isothermal |
|
nsmerger |
Model a neutron star merger; use option 6 |
self-gravity, isothermal |
|
orstang |
Orszag-Tang vortex |
MHD, periodic |
|
planetatm |
disc interaction with fixed planet orbit + atmosphere |
isothermal |
|
planetdisc |
planet disc interaction with fixed planet orbit |
isothermal |
|
polytrope |
single or binary polytrope test |
self-gravity, isothermal |
|
prtest |
simple test of Poynting-Robertson drag |
isothermal |
|
quebec |
Terry Tricco |
self-gravity |
|
raddisc |
adiabatic disc with radiation |
radiation, disc viscosity |
|
radiativebox |
test of radiation coupling terms |
radiation, periodic |
|
radiotde |
radio tidal disruption event in general relativity |
GR, minkowski, no |
|
radshock |
shock tube in radiation hydrodynamics |
radiation, periodic |
|
radstar |
setup a star as in the star setup but with radiation |
self-gravity, radiation |
|
radwind |
wind setup with dust nucleation |
||
sedov |
Sedov blast wave test |
periodic |
|
sgdisc |
self-gravitating disc |
self-gravity |
|
shock |
shock tube tests |
periodic |
|
solarsystem |
orbits of minor planets |
dust, isothermal |
|
sphereinbox |
sphere-in-box setup |
periodic |
|
srblast |
special relativistic blast wave test (spherical) |
GR, minkowski, periodic |
|
srpolytrope |
polytrope in special relativity |
GR, minkowski, self-gravity |
|
srshock |
special relativistic sod shock tube test |
GR, minkowski, periodic |
|
star |
import stellar model from 1D stellar evolution code |
self-gravity |
|
taylorgreen |
Taylor-Green vortex problem |
isothermal |
|
tde |
tidal disruption simulations |
self-gravity, isothermal |
|
test |
default setup for tests |
MHD, dust, radiation, periodic |
|
test2 |
default setup for tests |
disc viscosity |
|
testcyl |
default setup for tests |
disc viscosity |
|
testdust |
dust unit tests |
dust, periodic |
|
testgr |
unit tests of general relativistic code |
GR, kerr |
|
testgrav |
self-gravity unit tests |
self-gravity |
|
testgrowth |
dust growth unit tests |
dust, periodic |
|
testkd |
default setup for tests |
MHD, radiation, periodic |
|
testlum |
Lense-Thirring setup |
||
testnimhd |
non-ideal MHD (+boundary parts+super-timesteps) unit tests |
MHD, non-ideal, isothermal, periodic |
|
testparticles |
test particles |
||
tokamak |
tokamak torus setup |
isothermal |
|
torus |
MRI torus |
||
turb |
driven supersonic turbulence (hydro, mhd, dusty) |
isothermal |
|
turbdrive |
driven turbulence |
isothermal |
|
wave |
linear wave |
periodic |
|
wavedamp |
Wave damping test as per Choi et al (2009) |
MHD, non-ideal, isothermal, periodic |
|
wd |
white dwarf from stellar model |
self-gravity |
|
wddisc |
disc around a white dwarf |
dust, isothermal |
|
wind |
wind setup with dust nucleation |
||
windtunnel |
Wind tunnel setup |
self-gravity |
More information
For a fuller explanation of compile-time configuration options in Phantom, see Compile-time configuration.