tidy3d.EMESimulationData#

class EMESimulationData[source]#

Bases: AbstractYeeGridSimulationData

Data associated with an EME simulation.

Parameters:

Attributes

port_modes_list_sweep

Port modes as a list of tuples (port_modes_1, port_modes_2).

port_modes_tuple

Port modes as a tuple (port_modes_1, port_modes_2).

log

Custom logger to avoid the complexities of the logging module

attrs

Methods

field_in_basis(field[,ย modes,ย port_index])

Express the electromagnetic field in the provided basis.

smatrix_in_basis([modes1,ย modes2])

Express the scattering matrix in the provided basis.

Inherited Common Usage

simulation#
data#
smatrix#
port_modes#
property port_modes_tuple#

Port modes as a tuple (port_modes_1, port_modes_2).

property port_modes_list_sweep#

Port modes as a list of tuples (port_modes_1, port_modes_2). There is one entry for every sweep index if the port modes vary with sweep index.

smatrix_in_basis(modes1=None, modes2=None)[source]#

Express the scattering matrix in the provided basis. Change of basis is done by computing overlaps between provided modes and port modes.

Parameters:
  • modes1 (Union[FieldData, ModeData]) โ€“ New modal basis for port 1. If None, use port_modes.

  • modes2 (Union[FieldData, ModeData]) โ€“ New modal basis for port 2. If None, use port_modes.

Returns:

The scattering matrix of the EME simulation, but expressed in the basis of the provided modes, rather than in the basis of port_modes used in computation.

Return type:

EMESMatrixDataset

field_in_basis(field, modes=None, port_index=0)[source]#

Express the electromagnetic field in the provided basis. Change of basis is done by computing overlaps between provided modes and port modes.

Parameters:
  • field (EMEFieldData) โ€“ EME field to express in new basis.

  • modes (Union[FieldData, ModeData]) โ€“ New modal basis. If None, use port_modes.

  • port_index (Literal[0, 1]) โ€“ Port to excite.

Returns:

The propagated electromagnetic fied expressed in the basis of the provided modes, rather than in the basis of port_modes used in computation.

Return type:

EMEFieldData

__hash__()#

Hash method.