Evaluate for Free

runsweep - Script command

FDTD MODE DGTD CHARGE HEAT FEEM INTERCONNECT

Runs a parameter sweep or optimization task.

Syntax

Description

runsweep;

Runs all sweeps and optimization tasks. In FDTD, this will run tasks in CPU mode.
runsweep("taskname");

Runs only the sweep or optimization named taskname. In FDTD, this will run the sweep or optimization in CPU mode.
runsweep(“resource_type”);

FDTD only, runs all sweeps and optimization tasks using a specified resource_type, either “GPU” or “CPU”
runsweep("taskname",”resource_type”);

FDTD only, runs the sweep or optimization named taskname using a specified resource_type, either “CPU” or “GPU”.

For Ansys Lumerical Burst,

Syntax

Description

runsweep(“taskname”,”resource_type”, “burst”, burst_settings);

Run a single parameter sweep with a specific type of resource. An error is returned in the sweep uses a solver that does not support Ansys Lumerical Burst:

  • taskname: Name of sweep to run
  • resource_type: Type of resource 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. If left empty, default settings are used.
runsweep(“type”,”burst”, burst_settings);

Run all sweeps with the specified resource type. The settings are applied to all sweeps. An error is returned if a sweep in the list does not support Ansys Lumerical Burst:

  • type: Type of resource 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. If left empty, default settings are used.

Example 

runsweep;
runsweep("thickness_sweep");

See Also

run , getsweepdata , addjob , runjobs , parameter sweeps

Associated files

Related articles