tidy3d.components.source.DirectionalSource

class DirectionalSource

Bases: FieldSource, ABC

A Field source that propagates in a given direction.

Parameters:

• name (Attribute: name) –

  Type	Optional[str]
  Default	= None
  Description	Optional name for the source.

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

• source_time (Attribute: source_time) –

  Type	Union[GaussianPulse, ContinuousWave, CustomSourceTime]
  Default
  Description	Specification of the source time-dependence.

• direction (Attribute: direction) –

  Type	Literal[‘+’, ‘-‘]
  Default
  Description	Specifies propagation in the positive or negative direction of the injection axis.

Attributes

Methods

direction

__hash__()

Hash method.