Compile-time configuration
==========================

Phantom uses a mix of compile-time and run-time configuration. The
:doc:`run-time configuration <infile>` is specified in the input file
(blah.in).

Simple things can be changed on the command line. To change the maximum
number of particles use:

::

   make SETUP=disc
   ./phantomsetup disc.in --maxp=10000000

Setup block
-----------

The compile-time configuration of Phantom is specified using the SETUP
block in `build/Makefile_setups <https://github.com/danieljprice/phantom/blob/master/build/Makefile_setups>`__. For example the default disc setup is
“disc”::

   ifeq ($(SETUP), disc)
   #   locally isothermal gas disc
       SETUPFILE= setup_disc.f90
       ANALYSIS= analysis_disc.f90
       ISOTHERMAL=yes
       KNOWN_SETUP=yes
       MULTIRUNFILE= multirun.f90
       IND_TIMESTEPS=yes
   endif

The choice of C preprocessor flags (FPPFLAGS=) can be used to specify
particular physics. Otherwise these are specified using variables in
this block as follows:

Pre-cooked setups
-----------------
For many applications a :doc:`pre-cooked SETUP block <setups>` already exists. View the full list :doc:`here <setups>`. You can also override any of the compile-time settings manually, using the options below.

Code modules
------------

+-----------------+-----------------+-----------------------+-----------------+
| *Variable*      | *Setting*       | *Default value*       | *Description*   |
+=================+=================+=======================+=================+
| SETUPFILE       | .f90 file(s)    | setup_unifdis.F90     | The setup       |
|                 |                 |                       | routine and any |
|                 |                 |                       | auxiliary       |
|                 |                 |                       | routines needed |
|                 |                 |                       | by phantomsetup |
+-----------------+-----------------+-----------------------+-----------------+
| ANALYSIS        | .f90 file(s)    | analysis_dtheader.f90 | (optional) The  |
|                 |                 |                       | analysis        |
|                 |                 |                       | routine and any |
|                 |                 |                       | auxiliary       |
|                 |                 |                       | routines used   |
|                 |                 |                       | by the          |
|                 |                 |                       | phantomanalysis |
|                 |                 |                       | utility         |
+-----------------+-----------------+-----------------------+-----------------+
| SRCINJECT       | .f90 file(s)    | inject_rochelobe.f90  | (optional)      |
|                 |                 |                       | Module handling |
|                 |                 |                       | particle        |
|                 |                 |                       | injection       |
|                 |                 |                       | (triggers       |
|                 |                 |                       | -DINJECT_PARTIC |
|                 |                 |                       | LES)            |
+-----------------+-----------------+-----------------------+-----------------+
| MODFILE         | .f90 file(s)    | moddump.f90           | (optional)      |
|                 |                 |                       | Routine used by |
|                 |                 |                       | moddump utility |
|                 |                 |                       | (to modify an   |
|                 |                 |                       | existing dump   |
|                 |                 |                       | file)           |
+-----------------+-----------------+-----------------------+-----------------+

Code performance and accuracy
-----------------------------

+-----------------+-----------------+-----------------+-----------------+
| *Variable*      | *Setting*       | *Default value* | *Description*   |
+=================+=================+=================+=================+
| MPI             | yes/no/openmpi/ | no              | compile with    |
|                 | zen/apac        |                 | MPI             |
|                 |                 |                 | parallelisation |
+-----------------+-----------------+-----------------+-----------------+
| OPENMP          | yes/no          | yes             | compile with    |
|                 |                 |                 | openMP          |
|                 |                 |                 | parallelisation |
+-----------------+-----------------+-----------------+-----------------+
| IND_TIMESTEPS   | yes/no          | no              | use individual  |
|                 |                 |                 | timesteps or    |
|                 |                 |                 | not             |
+-----------------+-----------------+-----------------+-----------------+
| DOUBLEPRECISION | yes/no          | yes             | use 8-byte      |
|                 |                 |                 | reals (no=4     |
|                 |                 |                 | byte)           |
+-----------------+-----------------+-----------------+-----------------+
| DEBUG           | yes/no          | no              | turns on        |
|                 |                 |                 | debugging flags |
|                 |                 |                 | (slow)          |
+-----------------+-----------------+-----------------+-----------------+
| APR             | yes/no          | no              | use adaptive    |
|                 |                 |                 | particle        |
|                 |                 |                 | refinement,     |
|                 |                 |                 | (APR) from      |
|                 |                 |                 | Nealon & Price  |
|                 |                 |                 | (2025)          |
+-----------------+-----------------+-----------------+-----------------+


Memory usage
------------

+-----------------+-----------------+-----------------+-----------------+
| *Variable*      | *Setting*       | *Default value* | *Description*   |
+=================+=================+=================+=================+
| MAXPTMASS       | integer         | 1000            | maximum number  |
|                 |                 |                 | of point mass   |
|                 |                 |                 | particles       |
|                 |                 |                 | (array size)    |
+-----------------+-----------------+-----------------+-----------------+
| NCELLSMAX       | integer         | same as maxp    | maximum number  |
|                 |                 |                 | of nodes in     |
|                 |                 |                 | the kdtree      |
|                 |                 |                 | neighbour       |
|                 |                 |                 | finding         |
+-----------------+-----------------+-----------------+-----------------+

Physics
-------

+-----------------+-----------------+-----------------+-----------------+
| *Variable*      | *Setting*       | *Default value* | *Description*   |
+=================+=================+=================+=================+
| PERIODIC        | yes/no          | no              | periodic        |
|                 |                 |                 | boundaries      |
+-----------------+-----------------+-----------------+-----------------+
| ISOTHERMAL      | yes/no          | no              | determines      |
|                 |                 |                 | whether or not  |
|                 |                 |                 | to store        |
|                 |                 |                 | thermal energy  |
+-----------------+-----------------+-----------------+-----------------+
| GRAVITY         | yes/no          | no              | use             |
|                 |                 |                 | self-gravity or |
|                 |                 |                 | not             |
+-----------------+-----------------+-----------------+-----------------+
| MHD             | yes/no          | no              | use             |
|                 |                 |                 | magnetohydrodyn |
|                 |                 |                 | amics           |
|                 |                 |                 | or not          |
+-----------------+-----------------+-----------------+-----------------+
| DUST            | yes/no          | no              | use dust        |
|                 |                 |                 | algorithms or   |
|                 |                 |                 | not             |
+-----------------+-----------------+-----------------+-----------------+
| GR              | yes/no          | no              | use relativity  |
+-----------------+-----------------+-----------------+-----------------+
| RADIATION       | yes/no          | no              | use radiation   |
|                 |                 |                 | hydrodynamics   |
|                 |                 |                 | or not          |
+-----------------+-----------------+-----------------+-----------------+
| H2CHEM          | yes/no          | no              | use H2          |
|                 |                 |                 | chemistry or    |
|                 |                 |                 | not             |
+-----------------+-----------------+-----------------+-----------------+
| CONST_AV        | yes/no          | no              | use a constant  |
|                 |                 |                 | artificial      |
|                 |                 |                 | viscosity       |
|                 |                 |                 | parameter       |
|                 |                 |                 | instead of the  |
|                 |                 |                 | Cullen &        |
|                 |                 |                 | Dehnen switch |
+-----------------+-----------------+-----------------+-----------------+
| CONST_ARTRES    | yes/no          | no              | use a constant  |
|                 |                 |                 | artificial      |
|                 |                 |                 | resistivity     |
|                 |                 |                 | parameter       |
+-----------------+-----------------+-----------------+-----------------+
| DUSTGROWTH      | yes/no          | no              | use dust growth |
|                 |                 |                 | (and/or         |
|                 |                 |                 | fragmentation)  |
|                 |                 |                 | prescription    |
|                 |                 |                 | from Stepinski  |
|                 |                 |                 | & Valageas      |
|                 |                 |                 | (1997) for      |
|                 |                 |                 | two-fluid       |
|                 |                 |                 | algorithm or    |
|                 |                 |                 | not             |
+-----------------+-----------------+-----------------+-----------------+

Examples
--------

For example, to set individual timesteps on the command line:

::

   make IND_TIMESTEPS=yes

or put this in the SETUP block:

::

   ifeq ($(SETUP), disc)
       ...
       IND_TIMESTEPS=yes