Ctrl+K

tidy3d.EMEModeSolverData

tidy3d.EMEModeSolverData#

class EMEModeSolverData[source]#

Bases: ElectromagneticFieldData, EMEModeSolverDataset

Data associated with an EME mode solver monitor.

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().

  • Ex (Union[ScalarFieldDataArray, ScalarFieldTimeDataArray, ScalarModeFieldDataArray, EMEScalarModeFieldDataArray, EMEScalarFieldDataArray] = None) – Spatial distribution of the x-component of the electric field.

  • Ey (Union[ScalarFieldDataArray, ScalarFieldTimeDataArray, ScalarModeFieldDataArray, EMEScalarModeFieldDataArray, EMEScalarFieldDataArray] = None) – Spatial distribution of the y-component of the electric field.

  • Ez (Union[ScalarFieldDataArray, ScalarFieldTimeDataArray, ScalarModeFieldDataArray, EMEScalarModeFieldDataArray, EMEScalarFieldDataArray] = None) – Spatial distribution of the z-component of the electric field.

  • Hx (Union[ScalarFieldDataArray, ScalarFieldTimeDataArray, ScalarModeFieldDataArray, EMEScalarModeFieldDataArray, EMEScalarFieldDataArray] = None) – Spatial distribution of the x-component of the magnetic field.

  • Hy (Union[ScalarFieldDataArray, ScalarFieldTimeDataArray, ScalarModeFieldDataArray, EMEScalarModeFieldDataArray, EMEScalarFieldDataArray] = None) – Spatial distribution of the y-component of the magnetic field.

  • Hz (Union[ScalarFieldDataArray, ScalarFieldTimeDataArray, ScalarModeFieldDataArray, EMEScalarModeFieldDataArray, EMEScalarFieldDataArray] = None) – Spatial distribution of the z-component of the magnetic field.

  • n_complex (EMEModeIndexDataArray) – Complex-valued effective propagation constants associated with the mode.

  • monitor (EMEModeSolverMonitor) – EME mode solver monitor associated with this data.

  • symmetry (Tuple[Literal[0, -1, 1], Literal[0, -1, 1], Literal[0, -1, 1]] = (0, 0, 0)) – Symmetry eigenvalues of the original simulation in x, y, and z.

  • symmetry_center (Optional[Tuple[float, float, float]] = None) – Center of the symmetry planes of the original simulation in x, y, and z. Required only if any of the symmetry field are non-zero.

  • grid_expanded (Optional[Grid] = None) – Grid discretization of the associated monitor in the simulation which created the data. Required if symmetries are present, as well as in order to use some functionalities like getting Poynting vector and flux.

  • grid_primal_correction (Union[float, FreqDataArray, TimeDataArray, FreqModeDataArray, EMEFreqModeDataArray] = 1.0) – Correction factor that needs to be applied for data corresponding to a 2D monitor to take into account the finite grid in the normal direction in the simulation in which the data was computed. The factor is applied to fields defined on the primal grid locations along the normal direction.

  • grid_dual_correction (Union[float, FreqDataArray, TimeDataArray, FreqModeDataArray, EMEFreqModeDataArray] = 1.0) – Correction factor that needs to be applied for data corresponding to a 2D monitor to take into account the finite grid in the normal direction in the simulation in which the data was computed. The factor is applied to fields defined on the dual grid locations along the normal direction.

Attributes

attrs

Methods

Inherited Common Usage

monitor#
__hash__()#

Hash method.