Command Line Flags

Flags will not alter the deck. The Simulator will run with the defined parameters from the Command Line, but will not change the Simulator settings defined in the EDEM interface.

Required Flags


Switch	Description
`-f/-i <string> Input deck`	Indicates the Input deck

Processing Flags

Processing flags set the Simulator options such as simulation time, Time Step, and number of processors. You can also specify the license server to use from the command line. If you do not specify any processing flags, the value stored in the simulation deck will be used. If there is no value saved in the simulation deck, the default value will be used.


Switch	Description
`-c/--console/--script`	Run EDEM in console-only mode
`-r/--run-time <double>`	Indicates the total run time. Default value = 1.
`-w/--write-out <double>`	Indicates the Write out interval, default value = 1e-05
`-g/--cell-size <double>`	Indicates the Grid cell size (R min). Default value = 2.
`-t/--time-step <double>`	Indicates the Time step. Default value is 1.0e-06. Set to 0 to enable Auto Time Step.
`-p/--processors <int>`	Indicates the Number of processors. Default value = 1.
`-R/--rewind`	Rewinds the simulation to the beginning
`--particle-properties`	Recalculates the particle properties for all materials
`-E/--engine [0\|1\|2]`	Options are: 0=CPU Solver, and 2=GPU CUDA Solver. Default is 0.
`-D --device [0\|1\|...]`	Indicates the Device index. + can be used for multi-device, such as 0+1.
`--particle-properties`	Recalculates the particle properties (mass/inertia) for all materials. Applicable if particle properties have been modified by an external program.
`-n/--steps-total <int>`	Runs the simulation for given number of steps.
`--dyn [0\|1]`	Enables the Dynamic Domain. See example.
`--dyn-interval <double>`	Sets the Dynamic Domain check interval. Default value is 0.1 s.
`--dyn-check <int>`	Sets the Dynamic Domain number of checks. Default value is 3.
`--dyn-disp <double>`	Set the Dynamic Domain particle displacement. Default value is 10% of R_min
`--gpu-split <string>`	Sets the GPU splitting axis. Default value is X
`--wait-license-key`	Waits for license keys until they are available
`--simExport`	Exports data per write out interval. Must match the name of Text Export within the configuration file
`--compress-data`	Runs the simulation with compressed data turned On/Off 0=Disable or 1=Enable data compression. The Default is machine compression setting unless already defined in the simulation.
`--acd`	Runs the simulation with alternative contact detection method On/Off. 0=Disable or 1=Enable alternative contact detection on GPU. The Default is Off unless already defined in the simulation
`--precision`	Changes the solver precision. Options are: 0=Double, 1=Single precision, 2=Hybrid
`--fma`	Enables FMA optimizations for GPU solvers. Options are: 0=Disabled, 1=Enabled

Post-Processing Flags

You can use the post-processing flags to specify data export parameters. You can either specify the type of data to export (all, particle, Geometry, and so on) or specify your simulation’s configuration file.

If you want to export data from the command line, first select File > Export > Results Data from the Analyst to set the path and filename to export to and the queries required.


Switch	Description
`-e/--export [A\|P\|G\|C\|K] <string>`	Indicates the type of data to export and filename (.csv). Options are: A - Export all data P P - Export particle data G - Export Geometry data C - Export contact data K - Export collision data
`-e <string>`	Indicates the filename of the EDEM.dfg file which specifies the data to export

Miscellaneous Flags

EDEM contains additional flags which can be useful in certain situations.


Switch	Description
`-?/-h/--help`	Indicates the display options
`-v/--version`	Indicates the display versions
`--no-free`	<Windows> Do not free EDEM from the console in GUI mode.
`--file-logger <string>`	Prints all output logs to file
`--server-dialog`	Shows the Server Selection dialog box
`-S/--server <string>`	Sets the license server to the specified string. This is instance-specific and will not update the default license server
`--cs`	Enables the EDEM Coupling server
`--auto-grid`	Enables Auto Grid resizing
`--wait`	Prevents connection clean-up after coupled simulation
`-L/--legacy-display`	Uses legacy graphics
`-convert <string>`	Indicates the converted simulation deck destination
`--rg`	Replaces Geometry. See Command Line Example Commands.