appopen

A MATLAB command that opens a session of selected Lumerical tool via the Matlab interoperability API. Once the session is opened, Lumerical can be called from Matlab to execute Lumerical script command(s) and execute them. Opened Lumerical session also allows Matlab to get variables from Lumerical workspace.

FDTD STACK MODE DGTD CHARGE HEAT FEEM INTERCONNECT

Syntax

Description

h=appopen(tool, option);

When executed in Matlab, this command will open a session of FDTD via the interoperability API.

Accepted tool parameters:

'fdtd'

'mode'

'device'

'interconnect'

Accepted option parameter (optional):

'-hide': runs the interoperability in non-graphical mode

Example

The following Matlab code example opens FDTD session, loads an existing simulation file "MySimulation.fsp", runs the simulation, retrieves transmission from the monitor into Matlab workspace and closes FDTD.

Step 1 (only in 2020R2): Before launching MATLAB set the path; in powershell/cmd set PATH=C:\Program Files\Lumerical\v202\bin;%PATH%

Step 2:

%add Lumerical API path to Matlab; path(path,'C:\Program Files\Lumerical\FDTD\api\matlab');h=appopen('fdtd');appevalscript(h,'load("MySimulation.fsp");');appevalscript(h,'run;');appevalscript(h,'T=transmission("monitor");');appevalscript(h,'T=T.T;');x=appgetvar(h,'T');appclose(h);

Example

Associated files

Related articles