5.2 Comprehensive List of Setup Arguments

-verbose=
  Normally setup prints summary messages indicating its progress. Use the -verbose to make the messages more or less verbose. The different levels (in order of increasing verbosity) are ERROR,IMPINFO,WARN,INFO,DEBUG. The default is WARN.
-auto
  Normally, setup requires that the user supply a plain text file called Units (in the object directory 5.2) that specifies the units to include. A sample Units file appears in Figure 5.1. Each line is either a comment (preceded by a hash mark (#)) or the name of a an include statement of the form INCLUDE unit. Specific implementations of a unit may be selected by specifying the complete path to the implementation in question; If no specific implementation is requested, setup picks the default listed in the unit's Config file.
  The -auto option enables setup to generate a “rough draft” of a Units file for the user. The Config file for each problem setup specifies its requirements in terms of other units it requires. For example, a problem may require the perfect-gas equation of state (physics/Eos/EosMain/Gamma) and an unspecified hydro solver (physics/Hydro). With -auto, setup creates a Units file by converting these requirements into unit include statements. Most users configuring a problem for the first time will want to run setup with -auto to generate a Units file and then to edit it directly to specify alternate implementations of certain units. After editing the Units file, the user must re-run setup without -auto in order to incorporate his/her changes into the code configuration. The user may also use the command-line option -with-unit= in conjunction with the -auto option, in order to pick a specific implementation of a unit, and thus eliminate the need to hand-edit the Units file.
-cmake
  This option will enable setup to configure the object directory for a build using cmake to compile and configure dependencies of FLASH.
-[123]d
  By default, setup creates a makefile which produces a FLASH executable capable of solving two-dimensional problems (equivalent to -2d). To generate a makefile with options appropriate to three-dimensional problems, use -3d. To generate a one-dimensional code, use -1d. These options are mutually exclusive and cause setup to add the appropriate compilation option to the makefile it generates.
-maxblocks=#
  This option is also used by setup in constructing the makefile compiler options. It determines the amount of memory allocated at runtime to the adaptive mesh refinement (AMR) block data structure. For example, to allocate enough memory on each processor for 500 blocks, use -maxblocks=500. If the default block buffer size is too large for your system, you may wish to try a smaller number here; the default value depends upon the dimensionality of the simulation and the grid type. Alternatively, you may wish to experiment with larger buffer sizes, if your system has enough memory. A common cause of aborted simulations occurs when the AMR grid creates greater than maxblocks during refinement. Resetup the simulation using a larger value of this option.
-nxb=# -nyb=# -nzb=#
  These options are used by setup in constructing the makefile compiler options. The mesh on which the problem is solved is composed of blocks, and each block contains some number of cells. The -nxb, -nyb, and -nzb options determine how many cells each block contains (not counting guard cells). The default value for each is 8. These options do not have any effect when running in Uniform Grid non-fixed block size mode.
[-debug|-opt|-test]
  The default Makefile built by setup will use the optimized setting (-opt) for compilation and linking. Using -debug will force setup to use the flags relevant for debugging (e.g., including -g in the compilation line). The user may use the option -test to experiment with different combinations of compiler and linker options. Exactly which compiler and linker options are associated with each of these flags is specified in sites//Makefile* where is the hostname of the machine on which FLASH is running.

For example, to tell an Intel Fortran compiler to use real numbers of size 64 when the -test option is specified, the user might add the following line to his/her Makefile.h:  

FFLAGS_TEST = -real_size 64
-objdir=
  Overrides the default object directory with . Using this option allows you to have different simulations configured simultaneously in the FLASH4 distribution directory.
-with-unit=, -unit=
  Use the specified in setting up the problem.

Figure 5.1: Example of the Units file used by setup to determine which Units to include
 
#Units file for Sod generated by setup


INCLUDE Driver/DriverMain/Split
INCLUDE Grid/GridBoundaryConditions
INCLUDE Grid/GridMain/paramesh/interpolation/Paramesh4/prolong
INCLUDE Grid/GridMain/paramesh/interpolation/prolong
INCLUDE Grid/GridMain/paramesh/paramesh4/Paramesh4.0/PM4_package/headers
INCLUDE Grid/GridMain/paramesh/paramesh4/Paramesh4.0/PM4_package/mpi_source
INCLUDE Grid/GridMain/paramesh/paramesh4/Paramesh4.0/PM4_package/source
INCLUDE Grid/GridMain/paramesh/paramesh4/Paramesh4.0/PM4_package/utilities/multigrid
INCLUDE Grid/localAPI
INCLUDE IO/IOMain/hdf5/serial/PM
INCLUDE IO/localAPI
INCLUDE PhysicalConstants/PhysicalConstantsMain
INCLUDE RuntimeParameters/RuntimeParametersMain
INCLUDE Simulation/SimulationMain/Sod
INCLUDE flashUtilities/contiguousConversion
INCLUDE flashUtilities/general
INCLUDE flashUtilities/interpolation/oneDim
INCLUDE flashUtilities/nameValueLL
INCLUDE monitors/Logfile/LogfileMain
INCLUDE monitors/Timers/TimersMain/MPINative
INCLUDE physics/Eos/EosMain/Gamma
INCLUDE physics/Hydro/HydroMain/split/PPM/PPMKernel

-curvilinear
Enable code in PARAMESH 4 that implements geometrically correct data restriction for curvilinear coordinates. This setting is automatically enabled if a non-cartesian geometry is chosen with the -geometry flag; so specifying -curvilinear only has an effect in the Cartesian case.
-defines=[,]...
is of the form SYMBOL or SYMBOL=value. This causes the specified pre-processor symbols to be defined when the code is being compiled. This is mainly useful for debugging the code. For e.g., -defines=DEBUG_ALL turns on all debugging messages. Each unit may have its own DEBUG_UNIT flag which you can selectively turn on.
[-fbs|-nofbs]
  Causes the code to be compiled in fixed-block or non-fixed-block size mode. Fixed-block mode is the default. In non-fixed block size mode, all storage space is allocated at runtime. This mode is available only with Uniform Grid.
-geometry=
Choose one of the supported geometries cartesian, cylindrical, spherical, or polar. Some Grid implementations require the geometry to be known at compile-time while others don't. This setup option can be used in either case; it is a good idea to specify the geometry here if it is known at setup-time. Choosing a non-Cartesian geometry here automatically sets the -gridinterpolation=monotonic option below.
-gridinterpolation=
Select a scheme for Grid interpolation. Two schemes are currently supported:
  • monotonic
    This scheme attempts to ensure that monotonicity is preserved in interpolation, so that interpolation does not introduce small-scale non-monotonicity in the data.
    The monotonic scheme is required for curvilinear coordinates and is automatically enabled if a non-cartesian geometry is chosen with the -geometry flag. For AMR Grid implementations, This flag will automatically add additional directories so that appropriate data interpolation methods are compiled it. The monotonic scheme is the default (by way of the +default shortcut), unlike in FLASH2.

  • native
    Enable the interpolation that is native to the AMR Grid implementation (PARAMESH 2 or PARAMESH 4) by default. This option is only appropriate for Cartesian geometries.

Change in Interpolation: Note that the default interpolation behavior has changed as of the FLASH3 beta release: the native interpolation used to be default.

When to use native Grid interpolation: The monotonic interpolation method requires more layers of coarse guard cells next to a coarse guard cell in which interpolation is to be applied. It may therefore be necessary to use the native method if a simulation is set up to include fewer than four layers of guard cells.

-makefile=
setup normally uses the Makefile.h from the directory determined by the hostname of the machine and the -site and -os options. If you have multiple compilers on your machine you can create Makefile.h. for different compilers. e.g., you can have a Makefile.h and Makefile.h.intel and Makefile.h.lahey for the three different compilers. setup will still use the Makefile.h file by default, but supplying -makefile=intel on the command-line causes setup to use Makefile.h.intel instead.
-index-reorder
  Instructs setup that indexing of unk and related arrays should be changed. This may be needed in FLASH4 for compatibility with alternative grids. This is supported by both the Uniform Grid as well as PARAMESH, and is currently required for the Chombo grid.
-makehide
Ordinarily, the commands being executed during compilation of the FLASH executable are sent to standard out. It may be that you find this distracting, or that your terminal is not able to handle these long lines of display. Using the option -makehide causes setup to generate a Makefile so that GNU make only displays the names of the files being compiled and not the exact compiler call and flags. This information remains available in setup_flags in the object/ directory.
-noclobber
setup normally removes all code in the object directory before linking in files for a simulation. The ensuing make must therefore compile all source files anew each time setup is run. The -noclobber option prevents setup from removing compiled code which has not changed from the previous setup in the same directory. This can speed up the make process significantly.
-os=
If setup is unable to find a correct sites/ directory it picks the Makefile based on the operating system. This option instructs setup to use the default Makefile corresponding to the specified operating system.
-parfile=
This causes setup to copy the specified runtime-parameters file in the simulation directory to the object directory with the new name flash.par .
-pyparfile=
This causes setup to copy the specified runtime-parameters file in the simulation directory to the object directory with the new name flashParm.py .
-append-parfiles=[location1/][,[location2/]]...
This option takes a comma-separated list of names of parameter files and combines them into one flash.par file in the object directory. File names without an absolute path are taken to be relative to the simulation directory, as for the -parfile option.

To use such a combined flash.par in case of runtime parameters occurring more than once, note that when FLASH reads a parameter file, the last instance of a runtime parameter supersedes previous ones.

If both -append-parfiles and -parfile are used, the files from the list are appended to the single parfile given by the latter in the order listed. If used with -parfile, -append-parfiles can append one or more parfiles to the one given by -parfile. If you only use -append-parfiles and not -parfile and give it fewer than two paths, an error will result. If more than one -append-parfiles option appears, the lists are concatenated in the order given.

-particlemethods=TYPE=[,INIT=][,MAP=][,ADV=]
This option instructs setup to adjust the particle methods for a particular particle type. It can only be used when a particle type has already been registered with a PARTICLETYPE line in a Config file (see Sec:FlashHparttypes). A possible scenario for using this option involves the user wanting to use a different passive particle initialization method without modifying the PARTICLETYPE line in the simulation Config file. In this case, an additional -particlemethods=TYPE=passive,INIT=cellmass adjusts the initialization method associated with passive particles in the setup generated Particles_specifyMethods() subroutine. Since the specification of a method for mapping and initialization requires inclusions of appropriate implementations of ParticlesMapping and ParticlesInitialization subunits, and the specification of a method for time advancement requires inclusion of an appropriate implementation under ParticlesMain, it is the user's responsibility to adjust the included units appropriately. For example a user may want want to override Config file defined particle type passive using lattice initialization CellMassBins density based distribution method using the setup command line. Here the user must first specify -without-unit=Particles/ParticlesInitialization/Lattice to exclude the lattice initialization, followed by -with-unit=Particles/ParticlesInitialization/WithDensity/CellMassBins specification to include the appropriate implementation. In general, using command line overrides of -particlemethods are not recommended, as this option increases the chance of creating an inconsistent simulation setup. More information on multiple particle types can be found in Chp:Particles, especially Sec:ParticlesUsing.
-portable
  This option causes setup to create a portable object directory by copying instead of linking to the source files. The resulting object directory can be tarred and sent to another machine for actual compilation.
-site=
setup searches the sites/ directory for a directory whose name is the hostname of the machine on which setup is being run. This option tells setup to use the Makefile of the specified site. This option is useful if setup is unable to find the right hostname (which can happen on multiprocessor or laptop machines). Also useful when combined with the -portable option.
-unitsfile=
This causes setup to copy the specified file to the object directory as Units before setting up the problem. This option can be used when -auto is not used, to specify an alternate Units file.
-with-library=[,args], -library=[,args]
This option instructs setup to link in the specified library when building the final executable. A library is a piece of code which is independent of FLASH. Internal libraries are those libraries whose code is included with FLASH. The setup script supports external as well as internal libraries. Information about external libraries is usually found in the site specific Makefile. The additional args if any are library-specific and may be used to select among multiple implementations. For more information see Library-HOWTO.
-tau=
This option causes the inclusion of an additional Makefile necessary for the operation of Tau, which may be used by the user to profile the code. More information on Tau can be found at http://acts.nersc.gov/tau/
-without-library=
Negates a previously specified -with-library=[,args]
-without-unit=
This removes all units specified in the command line so far, which are children of the specified unit (including the unit itself). It also negates any REQUESTS keyword found in a Config file for units which are children of the specified unit. However it does not negate a REQUIRES keyword found in a Config file.
+default
This shortcut specifies using basic default settings and is equivalent to the following:
-with-library=mpi +io +grid-gridinterpolation=monotonic
+noio
This shortcut specifies a simulation without IO and is equivalent to the following:
-without-unit=physics/sourceTerms/EnergyDeposition/EnergyDepositionMain/Laser/LaserIO -without-unit=IO
+io
This shortcut specifies a simulation with basic IO and is equivalent to the following:
-with-unit=IO
+serialIO
This shortcut specifies a simulation using serial IO, it has the effect of setting the setup variable
parallelIO = False
+parallelIO
This shortcut specifies a simulation using serial IO, it has the effect of setting the setup variable
parallelIO = True
+hdf5
This shortcut specifies a simulation using hdf5 for compatible binary IO output, it has the effect of setting the setup variable
IO = hdf5
+pnetcdf
This shortcut specifies a simulation using pnetcdf for compatible binary IO output, it has the effect of setting the setup variable
IO = pnetcdf
+hdf5TypeIO
This shortcut specifies a simulation using hdf5, with parallel io capability for compatible binary IO output, and is equivalent to the following:
+io +parallelIO +hdf5 typeIO=True
+pnetTypeIO
This shortcut specifies a simulation using pnetcdf, with parallel io capability for compatible binary IO output, and is equivalent to the following:
+io +parallelIO +pnetcdf typeIO=True
+nolog
This shortcut specifies a simulation without log capability it is equivalent to the following:
-without-unit=monitors/Logfile
+grid
This shortcut specifies a simulation with the Grid unit, it is equivalent to the following:
-unit=Grid
+ug
This shortcut specifies a simulation using a uniform grid, it is equivalent to the following:
+grid Grid=UG
+pm2
This shortcut specifies a simulation using Paramesh2 for the grid, it is equivalent to the following:
+grid Grid=PM2
+pm40
This shortcut specifies a simulation using Paramesh4.0 for the grid, it is equivalent to the following:
+grid Grid=PM40
+pm3
This shortcut (for backward compatibility) specifies a simulation using Paramesh4.0 for the grid, it is equivalent to the following:
+pm40
+chombo_ug
This shortcut specifies a simulation using a Chombo uniform grid, it is equivalent to the following:
-unit=Grid/GridMain/Chombo/UG -index-reorder Grid=Chombo -maxblocks=1 -nofbs -makefile=chombo chomboCompatibleHydro=True
+chombo_amr
This shortcut specifies a simulation using a Chombo amr grid, it is equivalent to the following:
-unit=Grid/GridMain/Chombo/AMR -index-reorder Grid=Chombo -nofbs -makefile=chombo chomboCompatibleHydro=True
+pm4dev_clean
This shortcut specifies a simulation using a version of Paramesh 4 that is closer to the version available on sourceforge. It is equivalent to:
+grid Grid=PM4DEV ParameshLibraryMode=True
+pm4dev
This shortcut specifies a simulation using a modified version of Paramesh 4 that includes a more scalable way of filling the surr_blks array. It is equivalent to:
+pm4dev_clean FlashAvoidOrrery=True
+8wave
This shortcut specifies a MHD simulation using the 8wave mhd solver, which only works with the native interpolation. It is equivalent to:
-with-unit=physics/Hydro/HydroMain/split/MHD_8Wave +grid -gridinterpolation=native
+usm
This shortcut specifies a MHD simulation using the unsplit staggered mesh hydro solver, if pure hydro mode is used with the USM solver add +pureHydro in the setup line. It is equivalent to:
-with-unit=physics/Hydro/HydroMain/unsplit/MHD_StaggeredMesh -without-unit=physics/Hydro/HydroMain/split/MHD_8Wave
+pureHydro
This shortcut specifies using pure hydro mode, it is equivalent to:
physicsMode=hydro
+splitHydro
This shortcut specifies a simulation using a split hydro solver and is equivalent to:
-unit=physics/Hydro/HydroMain/split -without-unit=physics/Hydro/HydroMain/unsplit SplitDriver=True
+unsplitHydro
This shortcut specifies a simulation using the unsplit hydro solver and is equivalent to:
-with-unit=physics/Hydro/HydroMain/unsplit/Hydro_Unsplit
+uhd
This shortcut specifies a simulation using the unsplit hydro solver and is equivalent to:
-with-unit=physics/Hydro/HydroMain/unsplit/Hydro_Unsplit
+supportPPMUpwind
This shortcut specifies a simulation using a specific Hydro method that requires an increased number of guard cells, this may need to be combined with -nxb=... -nyb=... etc. where the specified blocksize is greater than or equal to 12 (==2*GUARDCELLS). It is equivalent to:
SupportPpmUpwind=True
+cube64
This shortcut specifies a simulation with a block size of 64**3, it is equivalent to:
-nxb=64 -nyb=64 -nzb=64
+cube32
This shortcut specifies a simulation with a block size of 32**3, it is equivalent to:
-nxb=32 -nyb=32 -nzb=32
+cube16
This shortcut specifies a simulation with a block size of 16**3, it is equivalent to:
-nxb=16 -nyb=16 -nzb=16
+ptio
This shortcut specifies a simulation using particles and IO for uniform grid, it is equivalent to:
+ug -with-unit=Particles
+rnf
This shortcut is used for checking FLASH with rectangular block sizes and non-fixed block size. It is equivalent to:
-3d -nxb=8 -nyb=16 -nzb=32 -nofbs +ug
+nofbs
This shortcut specifies a simulation using a uniform grid with a non-fixed block size. It is equivalent to:
-nofbs +ug parallelIO=True
+curvilinear
This shortcut specifies a simulation using curvilinear geometry. It is equivalent to:
-curvilinear
+cartesian
This shortcut specifies a simulation using cartesian geometry. It is equivalent to:
-geometry=cartesian
+spherical
This shortcut specifies a simulation using spherical geometry. It is equivalent to:
-geometry=spherical
+polar
This shortcut specifies a simulation using polar geometry. It is equivalent to:
-geometry=polar
+cylindrical
This shortcut specifies a simulation using cylindrical geometry. It is equivalent to:
-geometry=cylindrical
+curv-pm2
This shortcut specifies a simulation using curvilinear coordinates along with Paramesh2, it is equivalent to:
+pm2 -unit=Grid/GridMain/paramesh/Paramesh2
-with-unit=Grid/GridMain/paramesh/Paramesh2/monotonic
+spherical-pm2
This shortcut specifies a simulation using spherical coordinates along with Paramesh2, it is equivalent to:
+pm2 +spherical
+ptdens
This shortcut specifies a simulation using passive particles initialized by density. It is equivalent to:
-without-unit=Particles/ParticlesInitialization/Lattice
-without-unit=Particles/ParticlesInitialization/WithDensity/CellMassBins
-unit=Particles/ParticlesMain
-unit=Particles/ParticlesInitialization/WithDensity
-particlemethods=TYPE=passive,INIT=With_Density
+npg
This shortcut specifies a simulation using NO_PERMANENT_GUARDCELLS mode in Paramesh4. It is equivalent to:
npg=True
+mpole
This shortcut specifies a smilulation using multipole gravity, it is equivalent to:
-with-unit=physics/Gravity/GravityMain/Poisson/Multipole
+longrange
This shortcut specifies a simulation using long range active particles. It is equivalent to:
-with-unit=Particles/ParticlesMain/active/longRange/gravity/ParticleMesh
+gravPfftNofbs
This shortcut specifies a simulation using FFT based gravity solve on a uniform grid with no fixed block size. It is equivalent to:
+ug +nofbs -with-unit=physics/Gravity/GravityMain/Poisson/Pfft
+gravMgrid
This shortcut specifies a simulation using a multigrid based gravity solve. It is equivalent to:
+pm40 -with-unit=physics/Gravity/GravityMain/Poisson/Multigrid
+gravMpole
This shortcut specifies a smilulation using multipole gravity, it is equivalent to:
-with-unit=physics/Gravity/GravityMain/Poisson/Multipole
+noDefaultMpole
This shortcut specifies a simulation *not* using the multipole based gravity solve. It is equivalent to:
-without-unit=Grid/GridSolvers/Multipole
+noMgrid
This shortcut specifies a simulation *not* using the multigrid based gravity solve. It is equivalent to:
-without-unit=physics/Gravity/GravityMain/Poisson/Multigrid
+newMpole
This shortcut specifies a simulation using the new multipole based gravity solve. It is equivalent to:
+noMgrid +noDefaultMpole +gravMpole -with-unit=Grid/GridSolvers/Multipole_new
+mpi1
This shortcut specifies a simulation using the MPI-1 standard. It is equivalent to:
mpi1=True -defines=FLASH_MPI1
+mpi2
This shortcut specifies a simulation using the MPI-2 standard. It is equivalent to:
mpi2=True -defines=FLASH_MPI2
+mtmmmt
This shortcut specifies use of the MultiTemp/MultiType and Tabulated EOSes (for HEDP simulations). It is equivalent to:
-unit=physics/Eos/EosMain/multiTemp/Multitype -unit=physics/Eos/EosMain/Tabulated Mtmmmt=1
+3t
This shortcut sets a variable and a preprocessor symbol to request MultiTemp implementations of some units. It is equivalent to:
ThreeT=1 -defines=FLASH_3T
+uhd3t
This shortcut specifies a simulation using unsplit hydro with MultiTemp EOS. It is equivalent to:
+3t -without-unit=physics/Hydro/HydroMain/split
-with-unit=physics/Hydro/HydroMain/unsplit/Hydro_Unsplit
+usm3t
This shortcut specifies a simulation using unsplit MHD with MultiTemp EOS. It is equivalent to:
+3t -without-unit=physics/Hydro/HydroMain/split
-with-unit=physics/Hydro/HydroMain/unsplit/MHD_StaggeredMesh -without-unit=physics/Hydro/HydroMain/split/MHD_8Wave
+mgd
This shortcut specifies a simulation using the MGD (magneto gas dynamic) radiative transfer module. It is equivalent to:
-unit=physics/materialProperties/Opacity -unit=physics/RadTrans/RadTransMain/MGD
+laser
This shortcut specifies use of source terms for energy deposition. It is equivalent to:
-unit=physics/sourceTerms/EnergyDeposition/EnergyDepositionMain/Laser -without-unit=Particles
+pic
This shortcut specifies use of proper particle units to perform PIC (particle in cell) method. It is equivalent to:
+ug -unit=Grid/GridParticles/GridParticlesMove
-without-unit=Grid/GridParticles/GridParticlesMove/UG
-without-unit=Grid/GridParticles/GridParticlesMove/UG/Directional
+cppapi
  This shortcut requests the C++ API bindings to the FLASH units that implement a CppAPI subunit. It is equivalent to:
cppAPI=1 -cppapi -with-unit=source/Cpp/CppMain
+python
  This shortcut requests the bindings to the pybind11 python module pyFlash4 as well as the bindings to the embedded python interpreter allowing for runtime parameters to be specified from a python script flashParm.py. It is equivalent to:
python=1 -pyflash -with-unit=source/Python/PythonMain +cppapi
Grid
This setup variable can be used to specify which gridding package to use in a simulation:
Name: Grid
Type: String
Values: PM4DEV, PM40, UG, PM2, Chombo
IO
This setup variable can be used to specify which IO package to use in a simulation:
Name: IO
Type: String
Values: hdf5, pnetcdf, MPIHybrid, MPIDump, direct
parallelIO
This setup variable can be used to specify which type of IO strategy will be used. A “parallel” strategy will be used if the value is true, a “serial” strategy otherwise.
Name: parallelIO
Type: Boolean
Values: True, False
fixedBlockSize
This setup variable indicates whether or not a fixed block size is to be used. This variable should not be assigned explicitly on the command line. It defaults to True, and the setup options -nofbs and -fbs modify the value of this variable.
Name: fixedBlockSize
Type: Boolean
Values: True, False
nDim
This setup variable gives the dimensionality of a simulation. This variable should not be set explicitly on the command line, it is automatically set by the setup options -1d, -2d, and -3d.
Name: nDim
Type: integer
Values: 1,2,3
GridIndexOrder
This setup variable indicates whether the -index-reorder setup option is in effect. This variable should not be assigned explicitly on the command line.
Name: GridIndexOrder
Type: Boolean
Values: True, False
nxb
This setup variable gives the number of zones in a block in the X direction. This variable should not be assigned explicitly on the command line, it is automatically set by the setup option -nxb.
Name: nxb
Type: integer
nyb
This setup variable gives the number of zones in a block in the Y direction. This variable should not be assigned explicitly on the command line, it is automatically set by the setup option -nyb.
Name: nyb
Type: integer
nzb
This setup variable gives the number of zones in a block in the Z direction. This variable should not be assigned explicitly on the command line, it is automatically set by the setup option -nzb.
Name: nzb
Type: integer
maxBlocks
This setup variable gives the maximum number of blocks per processor. This variable should not be assigned explicitly on the command line, it is automatically set by the setup option -maxblocks.
Name: maxBlocks
Type: integer
ParameshLibraryMode
If true, the setup script will generate file amr_runtime_parameters from template amr_runtime_parameters.tpl found in either the object directory (preferred) or the setup script (bin) directory. Selects whether Paramesh4 should be compiled in LIBRARY mode, i.e., with the preprocessor symbol LIBRARY defined.
Name: ParameshLibraryMode
Type: Boolean
Values: True, False
PfftSolver
PfftSolver selects a PFFT solver variant when the hybrid (i.e., Multigrid with PFFT) Poisson solver is used.
Name: PfftSolver
Type: String
Values: DirectSolver (default), HomBcTrigSolver, others (unsupported) if recognized in source/Grid/GridSolvers/Multigrid/PfftTopLevelSolve/Config
SplitDriver
If True, a Split Driver implementation is requested.
Name: SplitDriver
Type: Boolean
Mtmmmt
Automatically set True by +mtmmmt shortcut. When true, this option activates the MTMMMT EOS.
Name: Mtmmmt
Type: Boolean
mgd_meshgroups
mgd_meshgroups * meshCopyCount sets the MAXIMUM number of radiation groups that can be used in a simulation. The ACTUAL number of groups (which must be less than mgd_meshgroups * meshCopyCount) is set by the rt_mgdNumGroups runtime parameter.
Name: mgd_meshgroups
Type: Integer
species
This setup variable can be used as an alternative specifying species using the SPECIES Config file directive by listing the species in the setup command. Some units, like the Multispecies Opacity unit, will ONLY work when the species setup variable is set. This is because they use the species name to automatically create runtime paramters which include the species names.
Name: species
Type: String, comma seperated list of strings (e.g., species=air,sf6)
ed_maxPulses

Name: ed_maxPulses
Type: integer
Remark: Maximum number of laser pulses (defaults to 5)
ed_maxBeams

Name: ed_maxBeams
Type: integer
Remark: Maximum number of laser beams (defaults to 6)
threadHydroBlockList
This is used to turn on block list OPENMP threading of hydro routines.
Name: threadHydroBlockList
Type: Boolean
Values: True, False
threadMpoleBlockList
This is used to turn on block list OPENMP threading of the multipole routine.
Name: threadMpoleBlockList
Type: Boolean
Values: True, False
threadRayTrace
This is used to turn on block list OPENMP threading of Enery Deposition source term routines.
Name: threadRayTrace
Type: Boolean
Values: True, False
threadHydroWithinBlock
This is used to turn on within block OPENMP threading of hydro routines.
Name: threadHydroWithinBlock
Type: Boolean
Values: True, False
threadEosWithinBlock
This is used to turn on within block OPENMP threading of Eos routines.
Name: threadEosWithinBlock
Type: Boolean
Values: True, False
threadMpoleWithinBlock
This is used to turn on within block OPENMP threading of then multipole routine.
Name: threadMpoleWithinBlock
Type: Boolean
Values: True, False

Dependencies among libraries: If you have some libraries which depend on other libraries, create a lib//Config which declares the dependencies. Libraries can have their own Config files, but the format is a little different. For details see Library-HOWTO.