# This file defines of shortcuts for the setup script.
# Each line starting with '#' is a comment line.

# each line is of the form
# shortcut:arg1:arg2:...:
#
# For example, the shortcut ug is defined as:
# ug:--with-unit=Grid/GridMain/:Grid=UG:
#
# To use the ug shortcut ad +ug to the setup line ie: ./setup Sod -auto +ug
# this is equivalent to typing in unit options with -unit=Grid/GridMain/UG 
# -unit=IO/IOMain/hdf5/serial/UG (because the appropriate IO is included by default)
# 
# These shortcuts can refer to each other. 
#
# The name of this file is hard coded into the setup script. But dont worry.
# You can define an environment variable SETUP_SHORTCUTS and set it to a
# ":" delimited set of filenames. Then the setup script will process those
# files (in that order) to define the shortcuts
#

# These options are always assumed to be given at beginning of command line,
# most of these can be overridden later.
default:--with-library=mpi:+io:+grid:-gridinterpolation=monotonic

# io choices
noio:--without-unit=physics/sourceTerms/EnergyDeposition/EnergyDepositionMain/Laser/LaserIO:--without-unit=IO:
io:--with-unit=IO:
serialIO:parallelIO=False:
parallelIO:parallelIO=True:
hdf5:IO=hdf5:
pnetcdf:IO=pnetcdf:
hdf5TypeIO:+io:+parallelIO:+hdf5:typeIO=True
pnetTypeIO:+io:+parallelIO:+pnetcdf:typeIO=True

# other optional but useful stuff
nolog:-without-unit=monitors/Logfile:

# Choice of Grid
grid:-unit=Grid:
ug:+grid:Grid=UG:
pm2:+grid:Grid=PM2:
pm40:+grid:Grid=PM40:
pm3:+pm40
chombo_ug:-unit=Grid/GridMain/Chombo/UG:-index-reorder:Grid=Chombo:-maxblocks=1:-nofbs:-makefile=chombo:chomboCompatibleHydro=True
chombo_amr:-unit=Grid/GridMain/Chombo/AMR:-index-reorder:Grid=Chombo:-nofbs:-makefile=chombo:chomboCompatibleHydro=True

# pm4dev_clean indicates a version of Paramesh closer to the one
# that can be downloaded from sourceforge.  pm4dev indicates a 
# modified version of Paramesh that includes a more scalable way
# of filling the surr_blks array.
pm4dev_clean:+grid:Grid=PM4DEV:ParameshLibraryMode=True
pm4dev:+pm4dev_clean:FlashAvoidOrrery=True


# Choice of MHD solver
# NOTE: The 8wave mhd solver only works with the native interpolation.
8wave:--with-unit=physics/Hydro/HydroMain/split/MHD_8Wave:+grid:-gridinterpolation=native

# NOTE: If pure hydro mode used with the USM solver, add +pureHydro in setup
usm:--with-unit=physics/Hydro/HydroMain/unsplit/MHD_StaggeredMesh:--without-unit=physics/Hydro/HydroMain/split/MHD_8Wave
pureHydro:physicsMode=hydro
unsplitHydro:--with-unit=physics/Hydro/HydroMain/unsplit/Hydro_Unsplit
uhd:--with-unit=physics/Hydro/HydroMain/unsplit/Hydro_Unsplit

# Support specific Hydro methods, which require an increased number of guard cells.
# Note that these may need to be combined with -nxb=... -nyb=... etc.,
# where the specified blocksize is greater than or equal to 12 (==2*GUARDCELLS).
supportWENO:SupportWeno=True
supportPPMUpwind:SupportPpmUpwind=True

cube64:-nxb=64:-nyb=64:-nzb=64:
cube16:-nxb=16:-nyb=16:-nzb=16:
cube32:-nxb=32:-nyb=32:-nzb=32:
# include Particles and IO for uniform grid
ptio:+ug:-with-unit=Particles:
# The following shortcut is used for checking FLASH with rectangular block
# sizes and non-fixed block size
rnf:-3d:-nxb=8:-nyb=16:-nzb=32:-nofbs:+ug:
nofbs:-nofbs:+ug:parallelIO=True:
# PM40 with arrays allocated at runtime, compiled with LIBRARY defined.
# Not yet officially supported. - KW
dynamicmem-pm40:+pm40:ParameshLibraryMode=True
dynamicmem-pm3:+dynamicmem-pm40


###### Shortcuts to achieve setup script support for geometry-related
###### choices.  These shortcut now translate directly to setup options
###### newly created for curvilinear coordinate support in F3.0 alpha.
curvilinear:-curvilinear
cartesian:-geometry=cartesian
spherical:-geometry=spherical
polar:-geometry=polar
cylindrical:-geometry=cylindrical


# Some alternative combined shortcuts to request support for curvilinear coordinates.
# These specify necessary directories
# directly rather than relying on the -gridinterpolation=monotonic option. - KW
curv-pm2:+pm2:-unit=Grid/GridMain/paramesh/Paramesh2:-with-unit=Grid/GridMain/paramesh/Paramesh2/monotonic:
spherical-pm2:+pm2:+spherical

# short cut to get passive particles initialization with density
ptdens:-without-unit=Particles/ParticlesInitialization/Lattice:-without-unit=Particles/ParticlesInitialization/WithDensity/CellMassBins:-unit=Particles/ParticlesMain:-unit=Particles/ParticlesInitialization/WithDensity:-particlemethods=TYPE=passive,INIT=With_Density

# a shortcut for requesting NO_PERMANENT_GUARDCELLS mode
npg:npg=True

# short cut to request multipole gravity
mpole:-with-unit=physics/Gravity/GravityMain/Poisson/Multipole

#short cut toe request longrange active particles
longrange:-with-unit=Particles/ParticlesMain/active/longRange/gravity/ParticleMesh

gravPfftNofbs:+ug:+nofbs:-with-unit=physics/Gravity/GravityMain/Poisson/Pfft:

gravMgrid:+pm40:-with-unit=physics/Gravity/GravityMain/Poisson/Multigrid:

#make sure that the new implementation of the multipole is included
gravMpole:-with-unit=physics/Gravity/GravityMain/Poisson/Multipole:
noDefaultMpole:-without-unit=Grid/GridSolvers/Multipole
noMgrid:-without-unit=physics/Gravity/GravityMain/Poisson/Multigrid:
newMpole:+noMgrid:+noDefaultMpole:+gravMpole:-with-unit=Grid/GridSolvers/Multipole_new

mpi1:mpi1=True:-defines=FLASH_MPI1
mpi2:mpi2=True:-defines=FLASH_MPI2

# HEDP stuff
mtmmmt:-unit=physics/Eos/EosMain/multiTemp/Multitype:-unit=physics/Eos/EosMain/Tabulated:Mtmmmt=1
# The following shortcut (+usm3t) is not implemented in the released FLASH4-beta code.
usm3t:-without-unit=physics/Hydro/HydroMain/split:-with-unit=physics/Hydro/HydroMain/unsplit/MHD_StaggeredMesh/multiTemp
uhd3t:-without-unit=physics/Hydro/HydroMain/split:-with-unit=physics/Hydro/HydroMain/unsplit/Hydro_Unsplit/multiTemp
mgd:-unit=physics/materialProperties/Opacity:-unit=physics/RadTrans/RadTransMain/MGD
laser:-unit=physics/sourceTerms/EnergyDeposition/EnergyDepositionMain/Laser:-without-unit=Particles

#PIC stuff
pic:+ug:-unit=Grid/GridParticles/GridParticlesMove:-without-unit=Grid/GridParticles/GridParticlesMove/UG:-without-unit=Grid/GridParticles/GridParticlesMove/UG/Directional