eme_port_mode_selection

ipkiss3.simulation.engines.lumerical.macros.eme_port_mode_selection(mode_selection, port=None)

Macro to set the mode selection of a port in EME.

These settings correspond to the ones that can be set from the Lumerical MODE GUI, under the “Edit EME port -> EME port” tab.

Parameters:

mode_selection: str or List[int]: One of “fundamental mode”, “fundamental TE mode”, “fundamental TM mode”, “fundamental TE and TM mode” or a list of mode numbers (e.g. [1, 3, 4] for the 1st, 3rd and 4th mode in order of decreasing effective index.
port: str or None: Name of the port (IPKISS name). Set to None to apply to all ports at once

Returns:

Examples