tidy3d.plugins.smatrix.ModalComponentModelerData

tidy3d.plugins.smatrix.ModalComponentModelerData#

class ModalComponentModelerData[source]#

Bases: AbstractComponentModelerData

A data container for the results of a ModalComponentModeler run.

Parameters:

  • attrs (dict = {}) – Dictionary storing arbitrary metadata for a Tidy3D object. This dictionary can be freely used by the user for storing data without affecting the operation of Tidy3D as it is not used internally. Note that, unlike regular Tidy3D fields, attrs are mutable. For example, the following is allowed for setting an attr obj.attrs['foo'] = bar. Also note that Tidy3D will raise a TypeError if attrs contain objects that can not be serialized. One can check if attrs are serializable by calling obj.json().

  • 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.

  • obtained (This class stores the original modeler and the simulation data)

  • to (from running the simulations it defines. It also provides a method)

  • data. (compute the S-matrix from the simulation)

Attributes

data

attrs

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

__hash__()#

Hash method.