Ansys Lumerical API reference

device_sim.SimulationGeometry Defines the geometry of the electromagnetic simulation.
device_sim.SMatrixOutput Output an SMatrix.
device_sim.MacroOutput Running solver specific commands (a Macro) during the simulation phase.
device_sim.FileOutput Retrieves a file created during the setup or execution of the simulation.
device_sim.Port A combined monitor and source, for use in a physical solver
device_sim.Macro Defines a tool-specific macro which will be executed at a specified stage
device_sim.MacroFile Defines a macro to be loaded from file
device_sim.LumericalFDTDSimulation Define a simulation for use with Lumerical’s FDTD Solutions.
device_sim.LumericalEMESimulation Class to setup Lumerical EME Simulation jobs using the MODE engine.

Macros

Found under i3.device_sim.lumerical_macros.

fdtd_profile_xy Macro to create an FDTD frequency domain Z-normal field profile monitor that covers the full simulation window, at a certain height.
fdtd_mesh_accuracy Macro to set the mesh accuracy of the FDTD solver.
export_port_neff Macro to export the effective index as a function of wavelength from the specified port to a file.
eme_setup Macro to set up the spatial discretization of a simulation job in Lumerical MODE (using the EME solver).
eme_profile_xy Macro to create an EME Z-normal field profile monitor that covers the full simulation window, at a certain height.
eme_transverse_mesh Macro to set the transverse mesh in EME.
eme_wavelength Macro to set the wavelength on the EME solver and the EME Analysis