tidy3d.plugins.smatrix.Port

tidy3d.plugins.smatrix.Port#

class Port[source]#

Bases: Box

Specifies a port in the scattering matrix.

Parameters:
  • center (Tuple[float, float, float] = (0.0, 0.0, 0.0)) – [units = um]. Center of object in x, y, and z.

  • size (Tuple[NonNegativeFloat, NonNegativeFloat, NonNegativeFloat]) – [units = um]. Size in x, y, and z directions.

  • direction (Literal['+', '-']) – ‘+’ or ‘-’, defining which direction is considered ‘input’.

  • mode_spec (ModeSpec = ModeSpec(num_modes=1, target_neff=None, num_pml=(0,, 0), filter_pol=None, angle_theta=0.0, angle_phi=0.0, precision='single', bend_radius=None, bend_axis=None, track_freq='central', group_index_step=False, type='ModeSpec')) – Specifies how the mode solver will solve for the modes of the port.

  • name (ConstrainedStrValue) – Unique name for the port.

Attributes

Methods

Inherited Common Usage

direction#
mode_spec#
name#
__hash__()#

Hash method.