COMMAND LINE PARAMETERS


BHAC can be invoked with command line parameters, for example:
./bhac --help
will print a welcome message:
 -----------------------------------------------------------------------------
 -----------------------------------------------------------------------------
                          ____  _    _          _____                         
                         |  _ \| |  | |   /\   / ____|                        
                         | |_) | |__| |  /  \ | |                             
                         |  _ <|  __  | / /\ \| |                             
                         | |_) | |  | |/ ____ \ |____                         
                         |____/|_|  |_/_/    \_\_____|                        
                         -----------------------------                        
                         The Black Hole Accretion Code                        
 -----------------------------------------------------------------------------
 -----------------------------------------------------------------------------
 calling example:                                         
 ./bhac -i parameterfile -restart 100 -convert -if output/data
 default parameterfile is amrvac.par                            
 Note that parameterfile parameters overwrite the commandline   
 -----------------------------------------------------------------------------
 Available options are:
 -i parfile
 -if filenameout
 -restart #snapshot
 -convert
 -slice #slicenext
 -collapse #collapsenext
 -shell #shellnext
 --help 	Prints the help message
 -----------------------------------------------------------------------------
With the command line, it is possible to initiate a restart or convert. This has the advantage that the par file does not need to be modified. To restart a run, type
./bhac -restart 10 -if output/data
This will restart from output/data0010.dat. The next output number is automatically set to 11. Note that the values assigned in the par-file will overwrite the command line parameters.

In order to initiate a convert, consider the following example

./bhac -restart 10 -if output/data -convert

With the option -i inifile it is also possible to prescribe an alternative par-file, instead of the default amrvac.par. You can also omit the flag -if filenameini in which case the snapshot name is just taken from the parameter-file.

An overview of the current command line parameters is given in the following table.

Command line parameters
Command Sets variable default
-i parfile inifile amrvac.par
-if filename filenameini 'unavailable'
-restart n snapshotini -1
-convert convert F
-slice n slicenext 0
-collapse n collapsenext 0
-shell n shellnext 0
--help Prints the help message F