tidy3d.plugins.smatrix.Port

class Port

Bases: Box

Specifies a port in the scattering matrix.

Parameters:

• center (Attribute: center) –

  Type	Tuple[float, float, float]
  Default	= (0.0, 0.0, 0.0)
  Units	um
  Description	Center of object in x, y, and z.

• size (Attribute: size) –

  Type	Tuple[NonNegativeFloat, NonNegativeFloat, NonNegativeFloat]
  Default
  Units	um
  Description	Size in x, y, and z directions.

• direction (Attribute: direction) –

  Type	Literal[‘+’, ‘-‘]
  Default
  Description	’+’ or ‘-’, defining which direction is considered ‘input’.

• mode_spec (Attribute: mode_spec) –

  Type	ModeSpec
  Default	= ModeSpec(num_modes1, target_neffNone, num_pml(0,, 0), filter_polNone, angle_theta0.0, angle_phi0.0, precision’single’, bend_radiusNone, bend_axisNone, track_freq’central’, group_index_stepFalse, type’ModeSpec’)
  Description	Specifies how the mode solver will solve for the modes of the port.

• name (Attribute: name) –

  Type	ConstrainedStrValue
  Default
  Description	Unique name for the port.

Attributes

Methods

direction

mode_spec

name

__hash__()

Hash method.