You can also run the engine directly for each solver, using the commands below.
On Windows, it may be necessary to include the .exe suffix for the executables.
| Product | Solver | Executable name |
|---|---|---|
| Ansys Lumerical FDTD™ | FDTD | fdtd-engine [options] |
| Ansys Lumerical FDTD™ | RCWA | rcwa-engine [options] |
| Ansys Lumerical MODE™ | FDE | fd-engine [options] |
| Ansys Lumerical MODE™ | EME | eme-engine [options] |
| Ansys Lumerical MODE™ | varFDTD | varfdtd-engine [options] |
| Ansys Lumerical Multiphysics™ | CHARGE | device-engine [options] |
| Ansys Lumerical Multiphysics™ | HEAT | thermal-engine [options] |
| Ansys Lumerical Multiphysics™ | DGTD | dgtd-engine[options] |
| Ansys Lumerical Multiphysics™ | FEEM | feem-engine [options] |
| Ansys Lumerical Multiphysics™ | MQW | mqw-engine [options] |
| Ansys Lumerical INTERCONNECT™ | INTERCONNECT | interconnect [options] |
Options
You cannot run the engines without a specific project file. Except the filename option, all other options are optional.
| Option Flag | Description |
|---|---|
filename |
Required. The name of the simulation or project file to run. |
-t |
Controls the number of threads used. If not used or left blank, it will use all available threads. |
-threads |
Identical to -t. Controls the number of threads used. If not used or left blank, it will use all available threads. |
-fullinfo |
Prints detailed time benchmarking information to the log file based on wall time and CPU time measurements. |
-log-stdout |
Redirects the log file data to the standard output, rather than saving it to file. This option will be ignored when the simulation runs in graphical mode. |
-gpu |
Runs the simulation using the GPU. See the Knowledge Base article Getting started with running FDTD on GPU for more information on running FDTD on the GPU. |
-remote |
Prints status and progress updates to stdout. |
-mesh-only |
Mesh the geometry without running the simulation. |
-inmaterialfile <file> |
Load simulation mesh data from a <file>. |
-outmaterialfile <file> |
Save simulation mesh data to <file> for use on another project. |
-logall |
Create a log file for each simulation or sweep. Logfiles are named as filename_p0.log, filename_p1.log, filename_p2.log, where filename is the name of the base simulation file, and the number after p describes the process number for a single simulation, and the sweep number if the simulation was a sweep. By default, only filename_p0.log is created. |
-mr |
Print a simple memory usage report for a given simulation file to the standard output. Output can be piped or saved as a text file. Note: When running on Windows, you must use the Git Bash terminal to use this. |
-o |
Change the location where log files are saved, all log files will be saved to the relative or absolute directory passed to -o. If the directory ends with .log, it will be treated as a file name. |
-resume |
Available for the FDTD solver in Ansys Lumerical FDTD™ only. Resumes the simulation from the last check point. If no checkpoint is found, the simulation will start from the beginning. You can enable checkpointing in the Advanced Options of the FDTD Solver object. |