tidy3d.plugins.smatrix.ModalComponentModelerData

tidy3d.plugins.smatrix.ModalComponentModelerData#

class ModalComponentModelerData[source]#

Bases: AbstractComponentModelerData

A data container for the results of a ModalComponentModeler run.

Parameters:

  • modeler (ModalComponentModeler) – The original ModalComponentModeler object that defines the simulation setup and from which this data was generated.

  • data (SimulationDataMap) – A mapping from task names to SimulationData objects, containing the results of each simulation run.

  • log (Optional[str] = None) – A string containing the log information from the modeler post-processing run.

Notes

This class stores the original modeler and the simulation data obtained from running the simulations it defines. It also provides a method to compute the S-matrix from the simulation data.

Attributes

modeler

data

log

Methods

smatrix()

Computes and returns the scattering matrix (S-matrix).

Inherited Common Usage

modeler#
smatrix()[source]#

Computes and returns the scattering matrix (S-matrix).

The S-matrix is computed from the simulation data using the modal_construct_smatrix() function.

Returns:

The computed S-matrix.

Return type:

ModalPortDataArray