Evaluate for Free

run - Script command

FDTD MODE DGTD CHARGE HEAT FEEM INTERCONNECT

Run the current simulation. When the simulation finishes, all simulation data will be saved to the current simulation file. The updated simulation file will then be re-loaded by the GUI. 

If an error occurs during execution, the script command raises an error. 

Different products have different syntaxes, as shown below.

This function does not return any data.

For Ansys Lumerical FDTD™,

Syntax Description

run;
 

 

 Launch the simulation using the resource set in the run simulation group of the simulator tab.
run("solver"); Launch the simulation using the specified “solver”, using the resource set in the run simulation group of the simulator tab.
run("solver", "resource_type")

Launch the simulation using solver and resource_type:

  • solver: solver name, can be “FDTD”, “RCWA”
  • resource_type: resource type, can be "CPU", "GPU" for FDTD, and “CPU” only for RCWA

This allows to use the specified resource without affecting the CPU/GPU selection set in the run simulation group of the simulator tab.
run("solver", "resource_type", "resource_name");

Launch the simulation using solver, resource_type, and with a specified resource_name:

  • solver: solver name, can be “FDTD”, “RCWA”
  • resource_type: resource type, can be "CPU", "GPU" for FDTD, and “CPU” only for RCWA
  • resource_name: resource name, must follow a resource set in the resource configuration window
run("FDTD", "GPU", "resource_name", CUDA_VISIBLE_DEVICE_values);

Launch an FDTD GPU simulation with a specified resource_name and CUDA_VISIBLE_DEVICE_values:

  • resource_name: resource name, must follow a resource set in the resource configuration window
  • CUDA_VISIBLE_DEVICE_values: GPUs to be used specified by the environment variable CUDA_VISIBLE_DEVICE, can be a single value or a matrix representing multiple GPUs

For Ansys Lumerical MODE™, Ansys Lumerical Multiphysics™,

Syntax Description
run; Launch the simulation in parallel mode as defined in the resource manager.
run(“solver”); Launch the simulation using the specified “solver” in parallel mode as defined in the resource manager.

For INTERCONNECT,

Syntax Description
run; Launch the simulation. The simulation will be run using the settings from the first active resource in the resource manager.

When using Ansys Cloud Burst Compute™ for Lumerical,

Syntax Description
run(“solver”, “resource_type”, “burst”, burst_settings);

Submits the current burst job:

  • solver: Name of the solver, currently, only “FDTD” is supported
  • resource_type: Type of simulation to run, either “CPU” or “GPU”
  • burst_settings: Optional, settings structure to use for the current job submission. The structure fields should match the results obtained from getresource.

Example

Create and run a new simulation in FDTD.

newproject;  # create a new simulation file
addfdtd;    # add the FDTD simulation region
adddipole;   # add a dipole source
run;      # run the simulation in parallel mode

Run simulation with GPU in FDTD.

newproject;  # create a new simulation file
addfdtd;    # add the FDTD simulation region
addgaussian;   # add a gaussian source
run("FDTD","GPU");      # run the simulation

Run the simulation and catch errors.

try{
    run;
}catch(errMsg);

print(errMsg);

See Also

runanalysis , addjob , runjobs , save , load, FDTD GPU Solver Information

Associated files

Related articles