Merge pull request #494 from danieljprice/v2024

v2024

AUTHORS

@@ -32,8 +32,8 @@ Sergei Biriukov <svbiriukov@gmail.com>
 Cristiano Longarini <cristiano.longarini@unimi.it>
 Giovanni Dipierro <giovanni.dipierro@leicester.ac.uk>
 Roberto Iaconi <robertoiaconi1@gmail.com>
-Amena Faruqi <Amena.Faruqi@warwick.ac.uk>
 Hauke Worpel <hworpel@aip.de>
+Amena Faruqi <Amena.Faruqi@warwick.ac.uk>
 Alison Young <alison.young@ed.ac.uk>
 Stephen Neilson <36410751+s-neilson@users.noreply.github.com>
 Martina Toscani <mtoscani94@gmail.com>
@@ -43,26 +43,26 @@ Simon Glover <glover@uni-heidelberg.de>
 Thomas Reichardt <thomas.reichardt@students.mq.edu.au>
 Jean-François Gonzalez <Jean-Francois.Gonzalez@ens-lyon.fr>
 Christopher Russell <crussell@udel.edu>
+Phantom benchmark bot <ubuntu@phantom-benchmarks.novalocal>
 Alessia Franchini <alessia.franchini@unlv.edu>
-Alex Pettitt <alex@astro1.sci.hokudai.ac.jp>
 Jolien Malfait <jolien.malfait@kuleuven.be>
-Phantom benchmark bot <ubuntu@phantom-benchmarks.novalocal>
-Kieran Hirsh <kieran.hirsh1@monash.edu>
+Alex Pettitt <alex@astro1.sci.hokudai.ac.jp>
 Nicole Rodrigues <nicole.rodrigues@monash.edu>
+Kieran Hirsh <kieran.hirsh1@monash.edu>
 David Trevascus <dtre10@student.monash.edu>
-Farzana Meru <f.meru@warwick.ac.uk>
 Nicolás Cuello <cuello.nicolas@gmail.com>
+Farzana Meru <f.meru@warwick.ac.uk>
 Chris Nixon <cjn@leicester.ac.uk>
 Miguel Gonzalez-Bolivar <miguelgb@astro.unam.mx>
+Mike Lau <mike.lau@h-its.org>
 Benoit Commercon <benoit.commercon@gmail.com>
+Orsola De Marco <orsola.demarco@mq.edu.au>
 Giulia Ballabio <giulia.ballabio2@studenti.unimi.it>
-Joe Fisher <jwfis1@student.monash.edu>
 Maxime Lombart <maxime.lombart@ens-lyon.fr>
-Mike Lau <mike.lau@h-its.org>
-Orsola De Marco <orsola.demarco@mq.edu.au>
+Joe Fisher <jwfis1@student.monash.edu>
 Zachary Pellow <zpel1@student.monash.edu>
 s-neilson <36410751+s-neilson@users.noreply.github.com>
 Cox, Samuel <sc676@leicester.ac.uk>
-Jorge Cuadra <jcuadra@astro.puc.cl>
 Steven Rieder <steven@rieder.nl>
 Stéven Toupin <steven.toupin@gmail.com>
+Jorge Cuadra <jcuadra@astro.puc.cl>

Makefile

@@ -4,9 +4,8 @@
 #
 #   See build/Makefile for the main Makefile
 #
-#   (c) 2007-2023 The Authors (see AUTHORS)
+#   (c) 2007-2024 The Authors (see AUTHORS)
 #
-#  $Id: Makefile,v 98b9fad01f38 2013/03/25 23:02:49 daniel $
 #----------------------------------------------------------------
 
 .PHONY: phantom

build/Makefile

@@ -1,6 +1,6 @@
 #--------------------------------------------------------------------------!
 # The Phantom Smoothed Particle Hydrodynamics code, by Daniel Price et al. !
-# Copyright (c) 2007-2023 The Authors (see AUTHORS)                        !
+# Copyright (c) 2007-2024 The Authors (see AUTHORS)                        !
 # See LICENCE file for usage and distribution conditions                   !
 # http://users.monash.edu.au/~dprice/phantom                               !
 #--------------------------------------------------------------------------!
@@ -14,14 +14,12 @@
 #   the SETUP variable
 #
 #  OWNER: Daniel Price
-#
-#  $Id: 2788b71b1c08e560e77dce9849c5cb24a668f4b9 $
 #+
 #--------------------------------------------------------------------------
 
 .KEEP_STATE:
 
-PHANTOM_VERSION_MAJOR=2023
+PHANTOM_VERSION_MAJOR=2024
 PHANTOM_VERSION_MINOR=0
 PHANTOM_VERSION_MICRO=0
 VERSION=$(PHANTOM_VERSION_MAJOR).$(PHANTOM_VERSION_MINOR).$(PHANTOM_VERSION_MICRO)

docs/conf.py

@@ -20,13 +20,13 @@
 # -- Project information -----------------------------------------------------
 
 project = 'Phantom'
-copyright = '2023 The Authors'
+copyright = '2024 The Authors'
 author = 'Daniel Price'
 
 # The short X.Y version
-version = '2023.0'
+version = '2024.0'
 # The full version, including alpha/beta/rc tags
-release = '2023.0.0'
+release = '2024.0.0'
 
 
 # -- General configuration ---------------------------------------------------

docs/eos-list.rst

@@ -7,8 +7,8 @@
 |           |                                                                                  |
 |           | where :math:`c_s^2 \equiv K` is a constant stored in the dump file header        |
 |           |                                                                                  |
-+-----------+----------------------------------------------------------------------------------+
-| 2         | **Adiabatic equation of state (code default)**                                   |
+|           |                                                                                  |
+|           | Adiabatic equation of state (code default)                                       |
 |           |                                                                                  |
 |           | :math:`P = (\gamma - 1) \rho u`                                                  |
 |           |                                                                                  |

docs/releasenotes.rst

@@ -1,6 +1,50 @@
 Release notes
 =============
 
+v2024.0.0 - 29th Jan 2024
+-------------------------
+
+Physics
+~~~~~~~
+- ability to use numerical relativity backend with phantom (`Magnall et al. 2023 <https://ui.adsabs.harvard.edu/abs/2023PhRvD.108j3534M/abstract>`__; #480)
+- further improvements to implicit radiation scheme (thanks to Mike Lau and Ryosuke Hirai; #406,#438,#441,#452,#455,#458,#474)
+- further improvements to wind injection and cooling modules (thanks to Lionel Siess, Mats Esseldeurs, Silke Maes and Jolien Malfait; #392,)
+- J2 potential due to oblateness implemented for sink particles (#289)
+- external potential implemented for geopotential model, to test J2 potential (#289)
+- implemented Loren/Bate implicit scheme for drag with dust-as-particles (thanks to Stephane Michoulier, #428,#436)
+- dynamic boundary conditions, allowing box with expanding boundaries (thanks to James Wurster; #416)
+- bug fix in generalised Farris equation of state (thanks to Nicolas Cuello; #433)
+
+Setup
+~~~~~
+- major reorganisation of star setup into separate module, can now setup and relax one or more stars in several different setups, allowing one-shot-setup-and-relax for common envelopes, binary stars and tidal disruption events (#405,#407,#413)
+- new hierarchical system setup: can now setup an arbitrary number of point masses or stars in hierarchical systems (thanks to Simone Ceppi; #401,#426; see `Ceppi et al. 2022 <https://ui.adsabs.harvard.edu/abs/2022MNRAS.514..906C/abstract>`__)
+- relaxation process for stars is restartable, works automatically (#414, #417)
+- can setup unbound parabolic and hyperbolic orbits using the standard 6-parameter orbital elements (#443,#448; #302)
+- use m1 and m2 in the binary disc setup instead of primary mass and mass ratio (#431)
+- new "wind tunnel" setup and injection module (thanks to Mike Lau; #470)
+- new "solar system" setup for placing solar system planets and minor bodies by downloading their published orbital elements (#430)
+- bugs fixed with asteroid wind setup (#463)
+- bug fix with units in GR tidal disruption event setup (#432)
+- bug fix with initial velocities in disc setup with self-gravity and dust, properly compute enclosed mass for both gas and dust (thanks to Cristiano Longarini; #427)
+- bug fix with turbulent stirring setup (thanks to Terry Tricco; #449)
+
+Analysis/moddump utilities
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+- cleanup and further enhancements to common envelope analysis routines (thanks to Miguel Gonzalez-Bolivar; #467,#462)
+- moddump_sink displays correct value of sink luminosity (#439)
+- analysis routine for radio emission from tidal disruption events (thanks to Fitz Hu; #472)
+- new analysis routine to compute time of dust formation (`Bermudez-Bustamante et al. 2023 <https://ui.adsabs.harvard.edu/abs/2024arXiv240103644B/abstract>`__)
+
+Other
+~~~~~
+- github actions workflow now checks that running phantom on the .in file for one timestep succeeds following setup procedure
+- github actions workflow checks compilation of phantom+mcfost
+- phantom is now enforced to compile without any compiler warnings with gfortran on the master branch
+- further work to reduce ugly ifdefs in phantom codebase (#55)
+- various bugs with uninitialised variables fixed; all setups now checked with DEBUG=yes
+
+
 v2023.0.0 - 10th Mar 2023
 -------------------------
 

docs/running-first-calculation.rst

@@ -110,8 +110,8 @@ The basic physics that is controllable at runtime (any physics that affects memo
 
    # options controlling hydrodynamics, artificial dissipation
                    ieos =           2    ! eqn of state (1=isoth; 2=adiab; 3/4=locally iso (sphere/cyl); 5=two phase)
-                  alpha =      1.0000    ! MINIMUM art. viscosity parameter (max = 1.0)
-                 alphau =      1.0000    ! art. conductivity parameter
+                  alpha =      0.0000    ! MINIMUM shock viscosity parameter (max = 1.0)
+                 alphau =      1.0000    ! shock conductivity parameter
                    beta =      2.0000    ! beta viscosity
            avdecayconst =      0.1000    ! decay time constant for viscosity switches
                    damp =      0.0000    ! artificial damping of velocities (if on, v=0 initially)
@@ -168,6 +168,6 @@ The .ev files can be visualised using any standard plotting tool. For example yo
 
    splash -e blast*.ev
 
-where column labels should be read automatically from the header of the .ev file
+where column labels should be read automatically from the header of the .ev file.
 
 For more detailed analysis of :doc:`Phantom dump files <dumpfile>`, write yourself an analysis module for the :doc:`phantomanalysis <analysis>` utility. Analysis modules exist for many common tasks, including interpolating to a 3D grid (both fixed and AMR), computing PDFs, structure functions and power spectra, getting disc surface density profiles, and converting to other formats.